X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FChargingStation.ts;h=f283c50da4e4549d3364074cc6eaea88fa1e6f6d;hb=ccb1d6e97cc0248cd96a9505cf5e8f037d66984c;hp=ba6fd61f106a050516d7df9b6960d7f4cdb044f5;hpb=7f7b65ca31f598cb9c2a99a6e7b4d31dc6a0acca;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ChargingStation.ts b/src/charging-station/ChargingStation.ts index ba6fd61f..f283c50d 100644 --- a/src/charging-station/ChargingStation.ts +++ b/src/charging-station/ChargingStation.ts @@ -1,28 +1,31 @@ // Partial Copyright Jerome Benoit. 2021. All Rights Reserved. +import { ACElectricUtils, DCElectricUtils } from '../utils/ElectricUtils'; import { AvailabilityType, BootNotificationRequest, CachedRequest, + HeartbeatRequest, IncomingRequest, IncomingRequestCommand, + MeterValuesRequest, RequestCommand, + StatusNotificationRequest, } from '../types/ocpp/Requests'; import { BootNotificationResponse, + ErrorResponse, HeartbeatResponse, MeterValuesResponse, RegistrationStatus, + Response, StatusNotificationResponse, } from '../types/ocpp/Responses'; +import { ChargingProfile, ChargingRateUnitType } from '../types/ocpp/ChargingProfile'; import ChargingStationConfiguration, { Section } from '../types/ChargingStationConfiguration'; -import ChargingStationOcppConfiguration, { - ConfigurationKey, -} from '../types/ChargingStationOcppConfiguration'; import ChargingStationTemplate, { CurrentType, PowerUnits, - Voltage, WsOptions, } from '../types/ChargingStationTemplate'; import { @@ -31,16 +34,23 @@ import { SupportedFeatureProfiles, VendorDefaultParametersKey, } from '../types/ocpp/Configuration'; -import { MeterValue, MeterValueMeasurand, MeterValuePhase } from '../types/ocpp/MeterValues'; -import { StopTransactionReason, StopTransactionResponse } from '../types/ocpp/Transaction'; +import { MeterValue, MeterValueMeasurand } from '../types/ocpp/MeterValues'; +import { + StopTransactionReason, + StopTransactionRequest, + StopTransactionResponse, +} from '../types/ocpp/Transaction'; import { WSError, WebSocketCloseEventStatusCode } from '../types/WebSocket'; import WebSocket, { Data, OPEN, RawData } from 'ws'; import AutomaticTransactionGenerator from './AutomaticTransactionGenerator'; +import BaseError from '../exception/BaseError'; import { ChargePointErrorCode } from '../types/ocpp/ChargePointErrorCode'; import { ChargePointStatus } from '../types/ocpp/ChargePointStatus'; -import { ChargingProfile } from '../types/ocpp/ChargingProfile'; +import { ChargingStationConfigurationUtils } from './ChargingStationConfigurationUtils'; import ChargingStationInfo from '../types/ChargingStationInfo'; +import ChargingStationOcppConfiguration from '../types/ChargingStationOcppConfiguration'; +import { ChargingStationUtils } from './ChargingStationUtils'; import { ChargingStationWorkerMessageEvents } from '../types/ChargingStationWorker'; import Configuration from '../utils/Configuration'; import { ConnectorStatus } from '../types/ConnectorStatus'; @@ -59,7 +69,6 @@ import OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService'; import OCPPRequestService from './ocpp/OCPPRequestService'; import { OCPPVersion } from '../types/ocpp/OCPPVersion'; import PerformanceStatistics from '../performance/PerformanceStatistics'; -import { SampledValueTemplate } from '../types/MeasurandPerPhaseSampledValueTemplates'; import { SupervisionUrlDistribution } from '../types/ConfigurationData'; import { URL } from 'url'; import Utils from '../utils/Utils'; @@ -111,7 +120,10 @@ export default class ChargingStation { private get wsConnectionUrl(): URL { return this.getSupervisionUrlOcppConfiguration() ? new URL( - this.getConfigurationKey(this.getSupervisionUrlOcppKey()).value + + ChargingStationConfigurationUtils.getConfigurationKey( + this, + this.getSupervisionUrlOcppKey() + ).value + '/' + this.stationInfo.chargingStationId ) @@ -119,7 +131,12 @@ export default class ChargingStation { } public logPrefix(): string { - return Utils.logPrefix(` ${this.stationInfo.chargingStationId} |`); + return Utils.logPrefix( + ` ${ + this?.stationInfo?.chargingStationId ?? + ChargingStationUtils.getChargingStationId(this.index, this.getTemplateFromFile()) + } |` + ); } public getBootNotificationRequest(): BootNotificationRequest { @@ -205,30 +222,47 @@ export default class ChargingStation { } public getOcppStrictCompliance(): boolean { - return this.stationInfo.ocppStrictCompliance ?? false; + return this.stationInfo?.ocppStrictCompliance ?? false; } public getVoltageOut(): number | undefined { - const errMsg = `${this.logPrefix()} Unknown ${this.getCurrentOutType()} currentOutType in template file ${ - this.templateFile - }, cannot define default voltage out`; - let defaultVoltageOut: number; - switch (this.getCurrentOutType()) { - case CurrentType.AC: - defaultVoltageOut = Voltage.VOLTAGE_230; - break; - case CurrentType.DC: - defaultVoltageOut = Voltage.VOLTAGE_400; - break; - default: - logger.error(errMsg); - throw new Error(errMsg); - } + const defaultVoltageOut = ChargingStationUtils.getDefaultVoltageOut( + this.getCurrentOutType(), + this.templateFile, + this.logPrefix() + ); return !Utils.isUndefined(this.stationInfo.voltageOut) ? this.stationInfo.voltageOut : defaultVoltageOut; } + public getConnectorMaximumAvailablePower(connectorId: number): number { + let connectorAmperageLimitationPowerLimit: number; + if ( + !Utils.isNullOrUndefined(this.getAmperageLimitation()) && + this.getAmperageLimitation() < this.stationInfo.maximumAmperage + ) { + connectorAmperageLimitationPowerLimit = + (this.getCurrentOutType() === CurrentType.AC + ? ACElectricUtils.powerTotal( + this.getNumberOfPhases(), + this.getVoltageOut(), + this.getAmperageLimitation() * this.getNumberOfConnectors() + ) + : DCElectricUtils.power(this.getVoltageOut(), this.getAmperageLimitation())) / + this.stationInfo.powerDivider; + } + const connectorMaximumPower = this.getMaximumPower() / this.stationInfo.powerDivider; + const connectorChargingProfilePowerLimit = this.getChargingProfilePowerLimit(connectorId); + return Math.min( + isNaN(connectorMaximumPower) ? Infinity : connectorMaximumPower, + isNaN(connectorAmperageLimitationPowerLimit) + ? Infinity + : connectorAmperageLimitationPowerLimit, + isNaN(connectorChargingProfilePowerLimit) ? Infinity : connectorChargingProfilePowerLimit + ); + } + public getTransactionIdTag(transactionId: number): string | undefined { for (const connectorId of this.connectors.keys()) { if (connectorId > 0 && this.getConnectorStatus(connectorId).transactionId === transactionId) { @@ -238,27 +272,31 @@ export default class ChargingStation { } public getOutOfOrderEndMeterValues(): boolean { - return this.stationInfo.outOfOrderEndMeterValues ?? false; + return this.stationInfo?.outOfOrderEndMeterValues ?? false; } public getBeginEndMeterValues(): boolean { - return this.stationInfo.beginEndMeterValues ?? false; + return this.stationInfo?.beginEndMeterValues ?? false; } public getMeteringPerTransaction(): boolean { - return this.stationInfo.meteringPerTransaction ?? true; + return this.stationInfo?.meteringPerTransaction ?? true; } public getTransactionDataMeterValues(): boolean { - return this.stationInfo.transactionDataMeterValues ?? false; + return this.stationInfo?.transactionDataMeterValues ?? false; } public getMainVoltageMeterValues(): boolean { - return this.stationInfo.mainVoltageMeterValues ?? true; + return this.stationInfo?.mainVoltageMeterValues ?? true; } public getPhaseLineToLineVoltageMeterValues(): boolean { - return this.stationInfo.phaseLineToLineVoltageMeterValues ?? false; + return this.stationInfo?.phaseLineToLineVoltageMeterValues ?? false; + } + + public getCustomValueLimitationMeterValues(): boolean { + return this.stationInfo?.customValueLimitationMeterValues ?? true; } public getConnectorIdByTransactionId(transactionId: number): number | undefined { @@ -291,7 +329,8 @@ export default class ChargingStation { } public getAuthorizeRemoteTxRequests(): boolean { - const authorizeRemoteTxRequests = this.getConfigurationKey( + const authorizeRemoteTxRequests = ChargingStationConfigurationUtils.getConfigurationKey( + this, StandardParametersKey.AuthorizeRemoteTxRequests ); return authorizeRemoteTxRequests @@ -300,100 +339,13 @@ export default class ChargingStation { } public getLocalAuthListEnabled(): boolean { - const localAuthListEnabled = this.getConfigurationKey( + const localAuthListEnabled = ChargingStationConfigurationUtils.getConfigurationKey( + this, StandardParametersKey.LocalAuthListEnabled ); return localAuthListEnabled ? Utils.convertToBoolean(localAuthListEnabled.value) : false; } - public restartWebSocketPing(): void { - // Stop WebSocket ping - this.stopWebSocketPing(); - // Start WebSocket ping - this.startWebSocketPing(); - } - - public getSampledValueTemplate( - connectorId: number, - measurand: MeterValueMeasurand = MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER, - phase?: MeterValuePhase - ): SampledValueTemplate | undefined { - const onPhaseStr = phase ? `on phase ${phase} ` : ''; - if (!Constants.SUPPORTED_MEASURANDS.includes(measurand)) { - logger.warn( - `${this.logPrefix()} Trying to get unsupported MeterValues measurand '${measurand}' ${onPhaseStr}in template on connectorId ${connectorId}` - ); - return; - } - if ( - measurand !== MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER && - !this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes( - measurand - ) - ) { - logger.debug( - `${this.logPrefix()} Trying to get MeterValues measurand '${measurand}' ${onPhaseStr}in template on connectorId ${connectorId} not found in '${ - StandardParametersKey.MeterValuesSampledData - }' OCPP parameter` - ); - return; - } - const sampledValueTemplates: SampledValueTemplate[] = - this.getConnectorStatus(connectorId).MeterValues; - for ( - let index = 0; - !Utils.isEmptyArray(sampledValueTemplates) && index < sampledValueTemplates.length; - index++ - ) { - if ( - !Constants.SUPPORTED_MEASURANDS.includes( - sampledValueTemplates[index]?.measurand ?? - MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER - ) - ) { - logger.warn( - `${this.logPrefix()} Unsupported MeterValues measurand '${measurand}' ${onPhaseStr}in template on connectorId ${connectorId}` - ); - } else if ( - phase && - sampledValueTemplates[index]?.phase === phase && - sampledValueTemplates[index]?.measurand === measurand && - this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes( - measurand - ) - ) { - return sampledValueTemplates[index]; - } else if ( - !phase && - !sampledValueTemplates[index].phase && - sampledValueTemplates[index]?.measurand === measurand && - this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes( - measurand - ) - ) { - return sampledValueTemplates[index]; - } else if ( - measurand === MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER && - (!sampledValueTemplates[index].measurand || - sampledValueTemplates[index].measurand === measurand) - ) { - return sampledValueTemplates[index]; - } - } - if (measurand === MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER) { - const errorMsg = `${this.logPrefix()} Missing MeterValues for default measurand '${measurand}' in template on connectorId ${connectorId}`; - logger.error(errorMsg); - throw new Error(errorMsg); - } - logger.debug( - `${this.logPrefix()} No MeterValues for measurand '${measurand}' ${onPhaseStr}in template on connectorId ${connectorId}` - ); - } - - public getAutomaticTransactionGeneratorRequireAuthorize(): boolean { - return this.stationInfo.AutomaticTransactionGenerator.requireAuthorize ?? true; - } - public startHeartbeat(): void { if ( this.getHeartbeatInterval() && @@ -402,7 +354,8 @@ export default class ChargingStation { ) { // eslint-disable-next-line @typescript-eslint/no-misused-promises this.heartbeatSetInterval = setInterval(async (): Promise => { - await this.ocppRequestService.sendMessageHandler( + await this.ocppRequestService.requestHandler( + this, RequestCommand.HEARTBEAT ); }, this.getHeartbeatInterval()); @@ -435,6 +388,13 @@ export default class ChargingStation { this.startHeartbeat(); } + public restartWebSocketPing(): void { + // Stop WebSocket ping + this.stopWebSocketPing(); + // Start WebSocket ping + this.startWebSocketPing(); + } + public startMeterValues(connectorId: number, interval: number): void { if (connectorId === 0) { logger.error( @@ -474,7 +434,8 @@ export default class ChargingStation { this.getConnectorStatus(connectorId).transactionId, interval ); - await this.ocppRequestService.sendMessageHandler( + await this.ocppRequestService.requestHandler( + this, RequestCommand.METER_VALUES, { connectorId, @@ -501,6 +462,27 @@ export default class ChargingStation { this.performanceStatistics.start(); } this.openWSConnection(); + // Handle WebSocket message + this.wsConnection.on( + 'message', + this.onMessage.bind(this) as (this: WebSocket, data: RawData, isBinary: boolean) => void + ); + // Handle WebSocket error + this.wsConnection.on( + 'error', + this.onError.bind(this) as (this: WebSocket, error: Error) => void + ); + // Handle WebSocket close + this.wsConnection.on( + 'close', + this.onClose.bind(this) as (this: WebSocket, code: number, reason: Buffer) => void + ); + // Handle WebSocket open + this.wsConnection.on('open', this.onOpen.bind(this) as (this: WebSocket) => void); + // Handle WebSocket ping + this.wsConnection.on('ping', this.onPing.bind(this) as (this: WebSocket, data: Buffer) => void); + // Handle WebSocket pong + this.wsConnection.on('pong', this.onPong.bind(this) as (this: WebSocket, data: Buffer) => void); // Monitor authorization file FileUtils.watchJsonFile( this.logPrefix(), @@ -547,27 +529,6 @@ export default class ChargingStation { } } ); - // Handle WebSocket message - this.wsConnection.on( - 'message', - this.onMessage.bind(this) as (this: WebSocket, data: RawData, isBinary: boolean) => void - ); - // Handle WebSocket error - this.wsConnection.on( - 'error', - this.onError.bind(this) as (this: WebSocket, error: Error) => void - ); - // Handle WebSocket close - this.wsConnection.on( - 'close', - this.onClose.bind(this) as (this: WebSocket, code: number, reason: Buffer) => void - ); - // Handle WebSocket open - this.wsConnection.on('open', this.onOpen.bind(this) as (this: WebSocket) => void); - // Handle WebSocket ping - this.wsConnection.on('ping', this.onPing.bind(this) as (this: WebSocket, data: Buffer) => void); - // Handle WebSocket pong - this.wsConnection.on('pong', this.onPong.bind(this) as (this: WebSocket, data: Buffer) => void); parentPort.postMessage({ id: ChargingStationWorkerMessageEvents.STARTED, data: { id: this.stationInfo.chargingStationId }, @@ -579,14 +540,14 @@ export default class ChargingStation { await this.stopMessageSequence(reason); for (const connectorId of this.connectors.keys()) { if (connectorId > 0) { - await this.ocppRequestService.sendMessageHandler( - RequestCommand.STATUS_NOTIFICATION, - { - connectorId, - status: ChargePointStatus.UNAVAILABLE, - errorCode: ChargePointErrorCode.NO_ERROR, - } - ); + await this.ocppRequestService.requestHandler< + StatusNotificationRequest, + StatusNotificationResponse + >(this, RequestCommand.STATUS_NOTIFICATION, { + connectorId, + status: ChargePointStatus.UNAVAILABLE, + errorCode: ChargePointErrorCode.NO_ERROR, + }); this.getConnectorStatus(connectorId).status = ChargePointStatus.UNAVAILABLE; } } @@ -604,88 +565,85 @@ export default class ChargingStation { this.stopped = true; } - public getConfigurationKey( - key: string | StandardParametersKey, - caseInsensitive = false - ): ConfigurationKey | undefined { - return this.ocppConfiguration.configurationKey.find((configElement) => { - if (caseInsensitive) { - return configElement.key.toLowerCase() === key.toLowerCase(); - } - return configElement.key === key; - }); + public async reset(reason?: StopTransactionReason): Promise { + await this.stop(reason); + await Utils.sleep(this.stationInfo.resetTime); + this.stationInfo = this.getStationInfo(); + this.stationInfo?.Connectors && delete this.stationInfo.Connectors; + this.start(); } - public addConfigurationKey( - key: string | StandardParametersKey, - value: string, - options: { readonly?: boolean; visible?: boolean; reboot?: boolean } = { - readonly: false, - visible: true, - reboot: false, - }, - params: { overwrite?: boolean; save?: boolean } = { overwrite: false, save: false } - ): void { - options = options ?? ({} as { readonly?: boolean; visible?: boolean; reboot?: boolean }); - options.readonly = options?.readonly ?? false; - options.visible = options?.visible ?? true; - options.reboot = options?.reboot ?? false; - let keyFound = this.getConfigurationKey(key); - if (keyFound && params?.overwrite) { - this.deleteConfigurationKey(keyFound.key, { save: false }); - keyFound = undefined; - } - if (!keyFound) { - this.ocppConfiguration.configurationKey.push({ - key, - readonly: options.readonly, - value, - visible: options.visible, - reboot: options.reboot, - }); - params?.save && this.saveOcppConfiguration(); - } else { - logger.error( - `${this.logPrefix()} Trying to add an already existing configuration key: %j`, - keyFound - ); + public saveOcppConfiguration(): void { + if (this.getOcppPersistentConfiguration()) { + this.saveConfiguration(Section.ocppConfiguration); } } - public setConfigurationKeyValue( - key: string | StandardParametersKey, - value: string, - caseInsensitive = false - ): void { - const keyFound = this.getConfigurationKey(key, caseInsensitive); - if (keyFound) { - const keyIndex = this.ocppConfiguration.configurationKey.indexOf(keyFound); - this.ocppConfiguration.configurationKey[keyIndex].value = value; - this.saveOcppConfiguration(); - } else { - logger.error( - `${this.logPrefix()} Trying to set a value on a non existing configuration key: %j`, - { key, value } + public getChargingProfilePowerLimit(connectorId: number): number | undefined { + let limit: number, matchingChargingProfile: ChargingProfile; + let chargingProfiles: ChargingProfile[] = []; + // Get charging profiles for connector and sort by stack level + chargingProfiles = this.getConnectorStatus(connectorId).chargingProfiles.sort( + (a, b) => b.stackLevel - a.stackLevel + ); + // Get profiles on connector 0 + if (this.getConnectorStatus(0).chargingProfiles) { + chargingProfiles.push( + ...this.getConnectorStatus(0).chargingProfiles.sort((a, b) => b.stackLevel - a.stackLevel) ); } - } - - public deleteConfigurationKey( - key: string | StandardParametersKey, - params: { save?: boolean; caseInsensitive?: boolean } = { save: true, caseInsensitive: false } - ): ConfigurationKey[] { - const keyFound = this.getConfigurationKey(key, params?.caseInsensitive); - if (keyFound) { - const deletedConfigurationKey = this.ocppConfiguration.configurationKey.splice( - this.ocppConfiguration.configurationKey.indexOf(keyFound), - 1 + if (!Utils.isEmptyArray(chargingProfiles)) { + const result = ChargingStationUtils.getLimitFromChargingProfiles( + chargingProfiles, + Utils.logPrefix() ); - params?.save && this.saveOcppConfiguration(); - return deletedConfigurationKey; + if (!Utils.isNullOrUndefined(result)) { + limit = result.limit; + matchingChargingProfile = result.matchingChargingProfile; + switch (this.getCurrentOutType()) { + case CurrentType.AC: + limit = + matchingChargingProfile.chargingSchedule.chargingRateUnit === + ChargingRateUnitType.WATT + ? limit + : ACElectricUtils.powerTotal(this.getNumberOfPhases(), this.getVoltageOut(), limit); + break; + case CurrentType.DC: + limit = + matchingChargingProfile.chargingSchedule.chargingRateUnit === + ChargingRateUnitType.WATT + ? limit + : DCElectricUtils.power(this.getVoltageOut(), limit); + } + + const connectorMaximumPower = this.getMaximumPower() / this.stationInfo.powerDivider; + if (limit > connectorMaximumPower) { + logger.error( + `${this.logPrefix()} Charging profile id ${ + matchingChargingProfile.chargingProfileId + } limit is greater than connector id ${connectorId} maximum, dump charging profiles' stack: %j`, + this.getConnectorStatus(connectorId).chargingProfiles + ); + limit = connectorMaximumPower; + } + } } + return limit; } public setChargingProfile(connectorId: number, cp: ChargingProfile): void { + if (Utils.isNullOrUndefined(this.getConnectorStatus(connectorId).chargingProfiles)) { + logger.error( + `${this.logPrefix()} Trying to set a charging profile on connectorId ${connectorId} with an uninitialized charging profiles array attribute, applying deferred initialization` + ); + this.getConnectorStatus(connectorId).chargingProfiles = []; + } + if (!Array.isArray(this.getConnectorStatus(connectorId).chargingProfiles)) { + logger.error( + `${this.logPrefix()} Trying to set a charging profile on connectorId ${connectorId} with an improper attribute type for the charging profiles array, applying proper type initialization` + ); + this.getConnectorStatus(connectorId).chargingProfiles = []; + } let cpReplaced = false; if (!Utils.isEmptyArray(this.getConnectorStatus(connectorId).chargingProfiles)) { this.getConnectorStatus(connectorId).chargingProfiles?.forEach( @@ -718,6 +676,13 @@ export default class ChargingStation { this.stopMeterValues(connectorId); } + public hasFeatureProfile(featureProfile: SupportedFeatureProfiles) { + return ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.SupportedFeatureProfiles + )?.value.includes(featureProfile); + } + public bufferMessage(message: string): void { this.messageBuffer.add(message); } @@ -740,37 +705,17 @@ export default class ChargingStation { return this.stationInfo.supervisionUrlOcppKey ?? VendorDefaultParametersKey.ConnectionUrl; } - private getChargingStationId(stationTemplate: ChargingStationTemplate): string { - // In case of multiple instances: add instance index to charging station id - const instanceIndex = process.env.CF_INSTANCE_INDEX ?? 0; - const idSuffix = stationTemplate.nameSuffix ?? ''; - const idStr = '000000000' + this.index.toString(); - return stationTemplate.fixedName - ? stationTemplate.baseName - : stationTemplate.baseName + - '-' + - instanceIndex.toString() + - idStr.substring(idStr.length - 4) + - idSuffix; - } - - private getRandomSerialNumberSuffix(params?: { - randomBytesLength?: number; - upperCase?: boolean; - }): string { - const randomSerialNumberSuffix = crypto - .randomBytes(params?.randomBytesLength ?? 16) - .toString('hex'); - if (params?.upperCase) { - return randomSerialNumberSuffix.toUpperCase(); - } - return randomSerialNumberSuffix; - } - - private getTemplateFromFile(): ChargingStationTemplate { + private getTemplateFromFile(): ChargingStationTemplate | null { let template: ChargingStationTemplate = null; try { + const measureId = `${FileType.ChargingStationTemplate} read`; + const beginId = PerformanceStatistics.beginMeasure(measureId); template = JSON.parse(fs.readFileSync(this.templateFile, 'utf8')) as ChargingStationTemplate; + PerformanceStatistics.endMeasure(measureId, beginId); + template.templateHash = crypto + .createHash(Constants.DEFAULT_HASH_ALGORITHM) + .update(JSON.stringify(template)) + .digest('hex'); } catch (error) { FileUtils.handleFileException( this.logPrefix(), @@ -782,78 +727,69 @@ export default class ChargingStation { return template; } - private createSerialNumber( - stationInfo: ChargingStationInfo, - params: { randomSerialNumber: boolean } = { randomSerialNumber: false } - ): void { - const serialNumberSuffix = params.randomSerialNumber - ? this.getRandomSerialNumberSuffix({ upperCase: true }) - : ''; - stationInfo.chargePointSerialNumber = - stationInfo?.chargePointSerialNumberPrefix && - stationInfo.chargePointSerialNumberPrefix + serialNumberSuffix; - delete stationInfo.chargePointSerialNumberPrefix; - stationInfo.chargeBoxSerialNumber = - stationInfo?.chargeBoxSerialNumberPrefix && - stationInfo.chargeBoxSerialNumberPrefix + serialNumberSuffix; - delete stationInfo.chargeBoxSerialNumberPrefix; - } - - private getStationInfoFromTemplate( - params: { randomSerialNumber: boolean } = { randomSerialNumber: false } - ): ChargingStationInfo { - const templateFromFile: ChargingStationTemplate = this.getTemplateFromFile(); - const stationInfo: ChargingStationInfo = templateFromFile ?? ({} as ChargingStationInfo); - stationInfo.hash = crypto - .createHash(Constants.DEFAULT_HASH_ALGORITHM) - .update(JSON.stringify(templateFromFile)) - .digest('hex'); - const chargingStationId = this.getChargingStationId(templateFromFile); + private getStationInfoFromTemplate(): ChargingStationInfo { + const stationInfo: ChargingStationInfo = this.getTemplateFromFile(); + if (Utils.isNullOrUndefined(stationInfo)) { + const errorMsg = 'Failed to read charging station template file'; + logger.error(`${this.logPrefix()} ${errorMsg}`); + throw new BaseError(errorMsg); + } + if (Utils.isEmptyObject(stationInfo)) { + const errorMsg = `Empty charging station information from template file ${this.templateFile}`; + logger.error(`${this.logPrefix()} ${errorMsg}`); + throw new BaseError(errorMsg); + } + const chargingStationId = ChargingStationUtils.getChargingStationId(this.index, stationInfo); // Deprecation template keys section - this.warnDeprecatedTemplateKey( - templateFromFile, + ChargingStationUtils.warnDeprecatedTemplateKey( + stationInfo, 'supervisionUrl', - chargingStationId, + this.templateFile, + this.logPrefix(), "Use 'supervisionUrls' instead" ); - this.convertDeprecatedTemplateKey(templateFromFile, 'supervisionUrl', 'supervisionUrls'); - this.createSerialNumber(stationInfo, params); - stationInfo.wsOptions = templateFromFile?.wsOptions ?? {}; - if (!Utils.isEmptyArray(templateFromFile.power)) { - templateFromFile.power = templateFromFile.power as number[]; - const powerArrayRandomIndex = Math.floor( - Utils.secureRandom() * templateFromFile.power.length - ); - stationInfo.maxPower = - templateFromFile.powerUnit === PowerUnits.KILO_WATT - ? templateFromFile.power[powerArrayRandomIndex] * 1000 - : templateFromFile.power[powerArrayRandomIndex]; + ChargingStationUtils.convertDeprecatedTemplateKey( + stationInfo, + 'supervisionUrl', + 'supervisionUrls' + ); + if (!Utils.isEmptyArray(stationInfo.power)) { + stationInfo.power = stationInfo.power as number[]; + const powerArrayRandomIndex = Math.floor(Utils.secureRandom() * stationInfo.power.length); + stationInfo.maximumPower = + stationInfo.powerUnit === PowerUnits.KILO_WATT + ? stationInfo.power[powerArrayRandomIndex] * 1000 + : stationInfo.power[powerArrayRandomIndex]; } else { - templateFromFile.power = templateFromFile.power as number; - stationInfo.maxPower = - templateFromFile.powerUnit === PowerUnits.KILO_WATT - ? templateFromFile.power * 1000 - : templateFromFile.power; + stationInfo.power = stationInfo.power as number; + stationInfo.maximumPower = + stationInfo.powerUnit === PowerUnits.KILO_WATT + ? stationInfo.power * 1000 + : stationInfo.power; } delete stationInfo.power; delete stationInfo.powerUnit; stationInfo.chargingStationId = chargingStationId; - stationInfo.resetTime = templateFromFile.resetTime - ? templateFromFile.resetTime * 1000 + stationInfo.resetTime = stationInfo.resetTime + ? stationInfo.resetTime * 1000 : Constants.CHARGING_STATION_DEFAULT_RESET_TIME; return stationInfo; } private getStationInfoFromFile(): ChargingStationInfo | null { - return this.getConfigurationFromFile()?.stationInfo ?? null; + let stationInfo: ChargingStationInfo = null; + if (this.getStationInfoPersistentConfiguration()) { + stationInfo = this.getConfigurationFromFile()?.stationInfo ?? null; + } + if (stationInfo) { + stationInfo = ChargingStationUtils.createStationInfoHash(stationInfo); + } + return stationInfo; } private getStationInfo(): ChargingStationInfo { const stationInfoFromTemplate: ChargingStationInfo = this.getStationInfoFromTemplate(); - this.hashId = this.getHashId( - this.createBootNotificationRequest(stationInfoFromTemplate), - stationInfoFromTemplate.chargingStationId - ); + this.hashId = ChargingStationUtils.getHashId(stationInfoFromTemplate); this.configurationFile = path.join( path.resolve(__dirname, '../'), 'assets', @@ -861,22 +797,33 @@ export default class ChargingStation { this.hashId + '.json' ); const stationInfoFromFile: ChargingStationInfo = this.getStationInfoFromFile(); - if (stationInfoFromFile?.hash === stationInfoFromTemplate.hash) { + // Priority: charging station info from template > charging station info from configuration file > charging station info attribute + if (stationInfoFromFile?.templateHash === stationInfoFromTemplate.templateHash) { + if (this.stationInfo?.infoHash === stationInfoFromFile?.infoHash) { + return this.stationInfo; + } return stationInfoFromFile; } + ChargingStationUtils.createSerialNumber(stationInfoFromTemplate, stationInfoFromFile); return stationInfoFromTemplate; } private saveStationInfo(): void { - this.saveConfiguration(Section.stationInfo); + if (this.getStationInfoPersistentConfiguration()) { + this.saveConfiguration(Section.stationInfo); + } } private getOcppVersion(): OCPPVersion { - return this.stationInfo.ocppVersion ? this.stationInfo.ocppVersion : OCPPVersion.VERSION_16; + return this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16; } private getOcppPersistentConfiguration(): boolean { - return this.stationInfo.ocppPersistentConfiguration ?? true; + return this.stationInfo?.ocppPersistentConfiguration ?? true; + } + + private getStationInfoPersistentConfiguration(): boolean { + return this.stationInfo?.stationInfoPersistentConfiguration ?? true; } private handleUnsupportedVersion(version: OCPPVersion) { @@ -887,76 +834,26 @@ export default class ChargingStation { throw new Error(errMsg); } - private createBootNotificationRequest(stationInfo: ChargingStationInfo): BootNotificationRequest { - return { - chargePointModel: stationInfo.chargePointModel, - chargePointVendor: stationInfo.chargePointVendor, - ...(!Utils.isUndefined(stationInfo.chargeBoxSerialNumber) && { - chargeBoxSerialNumber: stationInfo.chargeBoxSerialNumber, - }), - ...(!Utils.isUndefined(stationInfo.chargePointSerialNumber) && { - chargePointSerialNumber: stationInfo.chargePointSerialNumber, - }), - ...(!Utils.isUndefined(stationInfo.firmwareVersion) && { - firmwareVersion: stationInfo.firmwareVersion, - }), - ...(!Utils.isUndefined(stationInfo.iccid) && { iccid: stationInfo.iccid }), - ...(!Utils.isUndefined(stationInfo.imsi) && { imsi: stationInfo.imsi }), - ...(!Utils.isUndefined(stationInfo.meterSerialNumber) && { - meterSerialNumber: stationInfo.meterSerialNumber, - }), - ...(!Utils.isUndefined(stationInfo.meterType) && { - meterType: stationInfo.meterType, - }), - }; - } - - private getHashId( - bootNotificationRequest: BootNotificationRequest, - chargingStationId: string - ): string { - return crypto - .createHash(Constants.DEFAULT_HASH_ALGORITHM) - .update(JSON.stringify(bootNotificationRequest) + chargingStationId) - .digest('hex'); - } - private initialize(): void { this.stationInfo = this.getStationInfo(); logger.info(`${this.logPrefix()} Charging station hashId '${this.hashId}'`); - this.bootNotificationRequest = this.createBootNotificationRequest(this.stationInfo); + this.bootNotificationRequest = ChargingStationUtils.createBootNotificationRequest( + this.stationInfo + ); this.ocppConfiguration = this.getOcppConfiguration(); - delete this.stationInfo.Configuration; - this.saveStationInfo(); + this.stationInfo?.Configuration && delete this.stationInfo.Configuration; + this.wsConfiguredConnectionUrl = new URL( + this.getConfiguredSupervisionUrl().href + '/' + this.stationInfo.chargingStationId + ); // Build connectors if needed const maxConnectors = this.getMaxNumberOfConnectors(); - if (maxConnectors <= 0) { - logger.warn( - `${this.logPrefix()} Charging station template ${ - this.templateFile - } with ${maxConnectors} connectors` - ); - } + this.checkMaxConnectors(maxConnectors); const templateMaxConnectors = this.getTemplateMaxNumberOfConnectors(); - if (templateMaxConnectors <= 0) { - logger.warn( - `${this.logPrefix()} Charging station template ${ - this.templateFile - } with no connector configuration` - ); - } - if (!this.stationInfo.Connectors[0]) { - logger.warn( - `${this.logPrefix()} Charging station template ${ - this.templateFile - } with no connector Id 0 configuration` - ); - } - // Sanity check + this.checkTemplateMaxConnectors(templateMaxConnectors); if ( maxConnectors > - (this.stationInfo.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) && - !this.stationInfo.randomConnectors + (this.stationInfo?.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) && + !this.stationInfo?.randomConnectors ) { logger.warn( `${this.logPrefix()} Number of connectors exceeds the number of connector configurations in template ${ @@ -965,73 +862,29 @@ export default class ChargingStation { ); this.stationInfo.randomConnectors = true; } - const connectorsConfigHash = crypto - .createHash(Constants.DEFAULT_HASH_ALGORITHM) - .update(JSON.stringify(this.stationInfo.Connectors) + maxConnectors.toString()) - .digest('hex'); - const connectorsConfigChanged = - this.connectors?.size !== 0 && this.connectorsConfigurationHash !== connectorsConfigHash; - if (this.connectors?.size === 0 || connectorsConfigChanged) { - connectorsConfigChanged && this.connectors.clear(); - this.connectorsConfigurationHash = connectorsConfigHash; - // Add connector Id 0 - let lastConnector = '0'; - for (lastConnector in this.stationInfo.Connectors) { - const lastConnectorId = Utils.convertToInt(lastConnector); - if ( - lastConnectorId === 0 && - this.getUseConnectorId0() && - this.stationInfo.Connectors[lastConnector] - ) { - this.connectors.set( - lastConnectorId, - Utils.cloneObject(this.stationInfo.Connectors[lastConnector]) - ); - this.getConnectorStatus(lastConnectorId).availability = AvailabilityType.OPERATIVE; - if (Utils.isUndefined(this.getConnectorStatus(lastConnectorId)?.chargingProfiles)) { - this.getConnectorStatus(lastConnectorId).chargingProfiles = []; - } - } - } - // Generate all connectors - if ( - (this.stationInfo.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) > 0 - ) { - for (let index = 1; index <= maxConnectors; index++) { - const randConnectorId = this.stationInfo.randomConnectors - ? Utils.getRandomInteger(Utils.convertToInt(lastConnector), 1) - : index; - this.connectors.set( - index, - Utils.cloneObject(this.stationInfo.Connectors[randConnectorId]) - ); - this.getConnectorStatus(index).availability = AvailabilityType.OPERATIVE; - if (Utils.isUndefined(this.getConnectorStatus(index)?.chargingProfiles)) { - this.getConnectorStatus(index).chargingProfiles = []; - } - } - } - } - // Avoid duplication of connectors related information - delete this.stationInfo.Connectors; - // Initialize transaction attributes on connectors - for (const connectorId of this.connectors.keys()) { - if (connectorId > 0 && !this.getConnectorStatus(connectorId)?.transactionStarted) { - this.initializeConnectorStatus(connectorId); - } + this.initializeConnectors(this.stationInfo, maxConnectors, templateMaxConnectors); + this.stationInfo.maximumAmperage = this.getMaximumAmperage(); + if (this.stationInfo) { + this.stationInfo = ChargingStationUtils.createStationInfoHash(this.stationInfo); } - this.wsConfiguredConnectionUrl = new URL( - this.getConfiguredSupervisionUrl().href + '/' + this.stationInfo.chargingStationId - ); + this.saveStationInfo(); + // Avoid duplication of connectors related information in RAM + this.stationInfo?.Connectors && delete this.stationInfo.Connectors; // OCPP configuration this.initializeOcppConfiguration(); + if (this.getEnableStatistics()) { + this.performanceStatistics = PerformanceStatistics.getInstance( + this.hashId, + this.stationInfo.chargingStationId, + this.wsConnectionUrl + ); + } switch (this.getOcppVersion()) { case OCPPVersion.VERSION_16: this.ocppIncomingRequestService = - OCPP16IncomingRequestService.getInstance(this); + OCPP16IncomingRequestService.getInstance(); this.ocppRequestService = OCPP16RequestService.getInstance( - this, - OCPP16ResponseService.getInstance(this) + OCPP16ResponseService.getInstance() ); break; default: @@ -1046,50 +899,107 @@ export default class ChargingStation { }; } this.stationInfo.powerDivider = this.getPowerDivider(); - if (this.getEnableStatistics()) { - this.performanceStatistics = PerformanceStatistics.getInstance( - this.hashId, - this.stationInfo.chargingStationId, - this.wsConnectionUrl - ); - } } private initializeOcppConfiguration(): void { + if ( + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.HeartbeatInterval + ) + ) { + ChargingStationConfigurationUtils.addConfigurationKey( + this, + StandardParametersKey.HeartbeatInterval, + '0' + ); + } + if ( + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.HeartBeatInterval + ) + ) { + ChargingStationConfigurationUtils.addConfigurationKey( + this, + StandardParametersKey.HeartBeatInterval, + '0', + { visible: false } + ); + } if ( this.getSupervisionUrlOcppConfiguration() && - !this.getConfigurationKey(this.getSupervisionUrlOcppKey()) + !ChargingStationConfigurationUtils.getConfigurationKey(this, this.getSupervisionUrlOcppKey()) ) { - this.addConfigurationKey( + ChargingStationConfigurationUtils.addConfigurationKey( + this, this.getSupervisionUrlOcppKey(), this.getConfiguredSupervisionUrl().href, { reboot: true } ); } else if ( !this.getSupervisionUrlOcppConfiguration() && - this.getConfigurationKey(this.getSupervisionUrlOcppKey()) + ChargingStationConfigurationUtils.getConfigurationKey(this, this.getSupervisionUrlOcppKey()) ) { - this.deleteConfigurationKey(this.getSupervisionUrlOcppKey(), { save: false }); + ChargingStationConfigurationUtils.deleteConfigurationKey( + this, + this.getSupervisionUrlOcppKey(), + { save: false } + ); } - if (!this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles)) { - this.addConfigurationKey( + if ( + this.stationInfo.amperageLimitationOcppKey && + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + this.stationInfo.amperageLimitationOcppKey + ) + ) { + ChargingStationConfigurationUtils.addConfigurationKey( + this, + this.stationInfo.amperageLimitationOcppKey, + ( + this.stationInfo.maximumAmperage * + ChargingStationUtils.getAmperageLimitationUnitDivider(this.stationInfo) + ).toString() + ); + } + if ( + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.SupportedFeatureProfiles + ) + ) { + ChargingStationConfigurationUtils.addConfigurationKey( + this, StandardParametersKey.SupportedFeatureProfiles, - `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.Local_Auth_List_Management},${SupportedFeatureProfiles.Smart_Charging}` + `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.FirmwareManagement},${SupportedFeatureProfiles.LocalAuthListManagement},${SupportedFeatureProfiles.SmartCharging},${SupportedFeatureProfiles.RemoteTrigger}` ); } - this.addConfigurationKey( + ChargingStationConfigurationUtils.addConfigurationKey( + this, StandardParametersKey.NumberOfConnectors, this.getNumberOfConnectors().toString(), { readonly: true }, { overwrite: true } ); - if (!this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData)) { - this.addConfigurationKey( + if ( + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.MeterValuesSampledData + ) + ) { + ChargingStationConfigurationUtils.addConfigurationKey( + this, StandardParametersKey.MeterValuesSampledData, MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER ); } - if (!this.getConfigurationKey(StandardParametersKey.ConnectorPhaseRotation)) { + if ( + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.ConnectorPhaseRotation + ) + ) { const connectorPhaseRotation = []; for (const connectorId of this.connectors.keys()) { // AC/DC @@ -1104,24 +1014,48 @@ export default class ChargingStation { connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.RST}`); } } - this.addConfigurationKey( + ChargingStationConfigurationUtils.addConfigurationKey( + this, StandardParametersKey.ConnectorPhaseRotation, connectorPhaseRotation.toString() ); } - if (!this.getConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests)) { - this.addConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests, 'true'); - } if ( - !this.getConfigurationKey(StandardParametersKey.LocalAuthListEnabled) && - this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles).value.includes( - SupportedFeatureProfiles.Local_Auth_List_Management + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.AuthorizeRemoteTxRequests ) ) { - this.addConfigurationKey(StandardParametersKey.LocalAuthListEnabled, 'false'); + ChargingStationConfigurationUtils.addConfigurationKey( + this, + StandardParametersKey.AuthorizeRemoteTxRequests, + 'true' + ); } - if (!this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) { - this.addConfigurationKey( + if ( + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.LocalAuthListEnabled + ) && + ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.SupportedFeatureProfiles + )?.value.includes(SupportedFeatureProfiles.LocalAuthListManagement) + ) { + ChargingStationConfigurationUtils.addConfigurationKey( + this, + StandardParametersKey.LocalAuthListEnabled, + 'false' + ); + } + if ( + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.ConnectionTimeOut + ) + ) { + ChargingStationConfigurationUtils.addConfigurationKey( + this, StandardParametersKey.ConnectionTimeOut, Constants.DEFAULT_CONNECTION_TIMEOUT.toString() ); @@ -1129,13 +1063,122 @@ export default class ChargingStation { this.saveOcppConfiguration(); } + private initializeConnectors( + stationInfo: ChargingStationInfo, + maxConnectors: number, + templateMaxConnectors: number + ): void { + if (!stationInfo?.Connectors && this.connectors.size === 0) { + const logMsg = `${this.logPrefix()} No already defined connectors and charging station information from template ${ + this.templateFile + } with no connectors configuration defined`; + logger.error(logMsg); + throw new BaseError(logMsg); + } + if (!stationInfo?.Connectors[0]) { + logger.warn( + `${this.logPrefix()} Charging station information from template ${ + this.templateFile + } with no connector Id 0 configuration` + ); + } + if (stationInfo?.Connectors) { + const connectorsConfigHash = crypto + .createHash(Constants.DEFAULT_HASH_ALGORITHM) + .update(JSON.stringify(stationInfo?.Connectors) + maxConnectors.toString()) + .digest('hex'); + const connectorsConfigChanged = + this.connectors?.size !== 0 && this.connectorsConfigurationHash !== connectorsConfigHash; + if (this.connectors?.size === 0 || connectorsConfigChanged) { + connectorsConfigChanged && this.connectors.clear(); + this.connectorsConfigurationHash = connectorsConfigHash; + // Add connector Id 0 + let lastConnector = '0'; + for (lastConnector in stationInfo?.Connectors) { + const lastConnectorId = Utils.convertToInt(lastConnector); + if ( + lastConnectorId === 0 && + this.getUseConnectorId0() && + stationInfo?.Connectors[lastConnector] + ) { + this.connectors.set( + lastConnectorId, + Utils.cloneObject(stationInfo?.Connectors[lastConnector]) + ); + this.getConnectorStatus(lastConnectorId).availability = AvailabilityType.OPERATIVE; + if (Utils.isUndefined(this.getConnectorStatus(lastConnectorId)?.chargingProfiles)) { + this.getConnectorStatus(lastConnectorId).chargingProfiles = []; + } + } + } + // Generate all connectors + if ((stationInfo?.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) > 0) { + for (let index = 1; index <= maxConnectors; index++) { + const randConnectorId = stationInfo?.randomConnectors + ? Utils.getRandomInteger(Utils.convertToInt(lastConnector), 1) + : index; + this.connectors.set( + index, + Utils.cloneObject(stationInfo?.Connectors[randConnectorId]) + ); + this.getConnectorStatus(index).availability = AvailabilityType.OPERATIVE; + if (Utils.isUndefined(this.getConnectorStatus(index)?.chargingProfiles)) { + this.getConnectorStatus(index).chargingProfiles = []; + } + } + } + } + } else { + logger.warn( + `${this.logPrefix()} Charging station information from template ${ + this.templateFile + } with no connectors configuration defined, using already defined connectors` + ); + } + // Initialize transaction attributes on connectors + for (const connectorId of this.connectors.keys()) { + if (connectorId > 0 && !this.getConnectorStatus(connectorId)?.transactionStarted) { + this.initializeConnectorStatus(connectorId); + } + } + } + + private checkMaxConnectors(maxConnectors: number): void { + if (maxConnectors <= 0) { + logger.warn( + `${this.logPrefix()} Charging station information from template ${ + this.templateFile + } with ${maxConnectors} connectors` + ); + } + } + + private checkTemplateMaxConnectors(templateMaxConnectors: number): void { + if (templateMaxConnectors === 0) { + logger.warn( + `${this.logPrefix()} Charging station information from template ${ + this.templateFile + } with empty connectors configuration` + ); + } else if (templateMaxConnectors < 0) { + logger.error( + `${this.logPrefix()} Charging station information from template ${ + this.templateFile + } with no connectors configuration defined` + ); + } + } + private getConfigurationFromFile(): ChargingStationConfiguration | null { let configuration: ChargingStationConfiguration = null; if (this.configurationFile && fs.existsSync(this.configurationFile)) { try { + const measureId = `${FileType.ChargingStationConfiguration} read`; + const beginId = PerformanceStatistics.beginMeasure(measureId); configuration = JSON.parse( fs.readFileSync(this.configurationFile, 'utf8') ) as ChargingStationConfiguration; + PerformanceStatistics.endMeasure(measureId, beginId); } catch (error) { FileUtils.handleFileException( this.logPrefix(), @@ -1151,26 +1194,39 @@ export default class ChargingStation { private saveConfiguration(section?: Section): void { if (this.configurationFile) { try { - const configurationData: ChargingStationConfiguration = - this.getConfigurationFromFile() ?? {}; if (!fs.existsSync(path.dirname(this.configurationFile))) { fs.mkdirSync(path.dirname(this.configurationFile), { recursive: true }); } + const configurationData: ChargingStationConfiguration = + this.getConfigurationFromFile() ?? {}; switch (section) { case Section.ocppConfiguration: configurationData.configurationKey = this.ocppConfiguration.configurationKey; break; case Section.stationInfo: + if (configurationData?.stationInfo?.infoHash === this.stationInfo?.infoHash) { + logger.debug( + `${this.logPrefix()} Not saving unchanged charging station information to configuration file ${ + this.configurationFile + }` + ); + return; + } configurationData.stationInfo = this.stationInfo; break; default: configurationData.configurationKey = this.ocppConfiguration.configurationKey; - configurationData.stationInfo = this.stationInfo; + if (configurationData?.stationInfo?.infoHash !== this.stationInfo?.infoHash) { + configurationData.stationInfo = this.stationInfo; + } break; } + const measureId = `${FileType.ChargingStationConfiguration} write`; + const beginId = PerformanceStatistics.beginMeasure(measureId); const fileDescriptor = fs.openSync(this.configurationFile, 'w'); fs.writeFileSync(fileDescriptor, JSON.stringify(configurationData, null, 2), 'utf8'); fs.closeSync(fileDescriptor); + PerformanceStatistics.endMeasure(measureId, beginId); } catch (error) { FileUtils.handleFileException( this.logPrefix(), @@ -1181,26 +1237,26 @@ export default class ChargingStation { } } else { logger.error( - `${this.logPrefix()} Trying to save charging station configuration to undefined file` + `${this.logPrefix()} Trying to save charging station configuration to undefined configuration file` ); } } - private getOcppConfigurationFromTemplate(): ChargingStationOcppConfiguration { - return this.getTemplateFromFile().Configuration ?? ({} as ChargingStationOcppConfiguration); + private getOcppConfigurationFromTemplate(): ChargingStationOcppConfiguration | null { + return this.getTemplateFromFile()?.Configuration ?? null; } private getOcppConfigurationFromFile(): ChargingStationOcppConfiguration | null { let configuration: ChargingStationConfiguration = null; if (this.getOcppPersistentConfiguration()) { - configuration = - this.getConfigurationFromFile()?.configurationKey && this.getConfigurationFromFile(); + const configurationFromFile = this.getConfigurationFromFile(); + configuration = configurationFromFile?.configurationKey && configurationFromFile; } configuration && delete configuration.stationInfo; return configuration; } - private getOcppConfiguration(): ChargingStationOcppConfiguration { + private getOcppConfiguration(): ChargingStationOcppConfiguration | null { let ocppConfiguration: ChargingStationOcppConfiguration = this.getOcppConfigurationFromFile(); if (!ocppConfiguration) { ocppConfiguration = this.getOcppConfigurationFromTemplate(); @@ -1208,22 +1264,20 @@ export default class ChargingStation { return ocppConfiguration; } - private saveOcppConfiguration(): void { - if (this.getOcppPersistentConfiguration()) { - this.saveConfiguration(Section.ocppConfiguration); - } - } - private async onOpen(): Promise { - logger.info( - `${this.logPrefix()} Connected to OCPP server through ${this.wsConnectionUrl.toString()}` - ); - if (!this.isInAcceptedState()) { - // Send BootNotification - let registrationRetryCount = 0; - do { - this.bootNotificationResponse = - await this.ocppRequestService.sendMessageHandler( + if (this.isWebSocketConnectionOpened()) { + logger.info( + `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} succeeded` + ); + if (!this.isRegistered()) { + // Send BootNotification + let registrationRetryCount = 0; + do { + this.bootNotificationResponse = await this.ocppRequestService.requestHandler< + BootNotificationRequest, + BootNotificationResponse + >( + this, RequestCommand.BOOT_NOTIFICATION, { chargePointModel: this.bootNotificationRequest.chargePointModel, @@ -1238,33 +1292,38 @@ export default class ChargingStation { }, { skipBufferingOnError: true } ); - if (!this.isInAcceptedState()) { - this.getRegistrationMaxRetries() !== -1 && registrationRetryCount++; - await Utils.sleep( - this.bootNotificationResponse?.interval - ? this.bootNotificationResponse.interval * 1000 - : Constants.OCPP_DEFAULT_BOOT_NOTIFICATION_INTERVAL - ); + if (!this.isRegistered()) { + this.getRegistrationMaxRetries() !== -1 && registrationRetryCount++; + await Utils.sleep( + this.bootNotificationResponse?.interval + ? this.bootNotificationResponse.interval * 1000 + : Constants.OCPP_DEFAULT_BOOT_NOTIFICATION_INTERVAL + ); + } + } while ( + !this.isRegistered() && + (registrationRetryCount <= this.getRegistrationMaxRetries() || + this.getRegistrationMaxRetries() === -1) + ); + } + if (this.isRegistered()) { + if (this.isInAcceptedState()) { + await this.startMessageSequence(); + this.wsConnectionRestarted && this.flushMessageBuffer(); } - } while ( - !this.isInAcceptedState() && - (registrationRetryCount <= this.getRegistrationMaxRetries() || - this.getRegistrationMaxRetries() === -1) - ); - } - if (this.isInAcceptedState()) { - await this.startMessageSequence(); - this.stopped && (this.stopped = false); - if (this.wsConnectionRestarted && this.isWebSocketConnectionOpened()) { - this.flushMessageBuffer(); + } else { + logger.error( + `${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})` + ); } + this.stopped && (this.stopped = false); + this.autoReconnectRetryCount = 0; + this.wsConnectionRestarted = false; } else { - logger.error( - `${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})` + logger.warn( + `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} failed` ); } - this.autoReconnectRetryCount = 0; - this.wsConnectionRestarted = false; } private async onClose(code: number, reason: string): Promise { @@ -1273,7 +1332,7 @@ export default class ChargingStation { case WebSocketCloseEventStatusCode.CLOSE_NORMAL: case WebSocketCloseEventStatusCode.CLOSE_NO_STATUS: logger.info( - `${this.logPrefix()} WebSocket normally closed with status '${Utils.getWebSocketCloseEventStatusString( + `${this.logPrefix()} WebSocket normally closed with status '${ChargingStationUtils.getWebSocketCloseEventStatusString( code )}' and reason '${reason}'` ); @@ -1282,7 +1341,7 @@ export default class ChargingStation { // Abnormal close default: logger.error( - `${this.logPrefix()} WebSocket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString( + `${this.logPrefix()} WebSocket abnormally closed with status '${ChargingStationUtils.getWebSocketCloseEventStatusString( code )}' and reason '${reason}'` ); @@ -1292,100 +1351,116 @@ export default class ChargingStation { } private async onMessage(data: Data): Promise { - let [messageType, messageId, commandName, commandPayload, errorDetails]: IncomingRequest = [ - 0, - '', - '' as IncomingRequestCommand, - {}, - {}, - ]; - let responseCallback: ( - payload: JsonType | string, - requestPayload: JsonType | OCPPError - ) => void; - let rejectCallback: (error: OCPPError, requestStatistic?: boolean) => void; + let messageType: number; + let messageId: string; + let commandName: IncomingRequestCommand; + let commandPayload: JsonType; + let errorType: ErrorType; + let errorMessage: string; + let errorDetails: JsonType; + let responseCallback: (payload: JsonType, requestPayload: JsonType) => void; + let errorCallback: (error: OCPPError, requestStatistic?: boolean) => void; let requestCommandName: RequestCommand | IncomingRequestCommand; - let requestPayload: JsonType | OCPPError; + let requestPayload: JsonType; let cachedRequest: CachedRequest; let errMsg: string; try { - const request = JSON.parse(data.toString()) as IncomingRequest; + const request = JSON.parse(data.toString()) as IncomingRequest | Response | ErrorResponse; if (Utils.isIterable(request)) { - // Parse the message - [messageType, messageId, commandName, commandPayload, errorDetails] = request; - } else { - throw new OCPPError( - ErrorType.PROTOCOL_ERROR, - 'Incoming request is not iterable', - commandName - ); - } - // Check the Type of message - switch (messageType) { - // Incoming Message - case MessageType.CALL_MESSAGE: - if (this.getEnableStatistics()) { - this.performanceStatistics.addRequestStatistic(commandName, messageType); - } - // Process the call - await this.ocppIncomingRequestService.handleRequest( - messageId, - commandName, - commandPayload - ); - break; - // Outcome Message - case MessageType.CALL_RESULT_MESSAGE: - // Respond - cachedRequest = this.requests.get(messageId); - if (Utils.isIterable(cachedRequest)) { - [responseCallback, , , requestPayload] = cachedRequest; - } else { - throw new OCPPError( - ErrorType.PROTOCOL_ERROR, - `Cached request for message id ${messageId} response is not iterable`, - commandName + [messageType, messageId] = request; + // Check the type of message + switch (messageType) { + // Incoming Message + case MessageType.CALL_MESSAGE: + [, , commandName, commandPayload] = request as IncomingRequest; + if (this.getEnableStatistics()) { + this.performanceStatistics.addRequestStatistic(commandName, messageType); + } + logger.debug( + `${this.logPrefix()} << Command '${commandName}' received request payload: ${JSON.stringify( + request + )}` ); - } - if (!responseCallback) { - // Error - throw new OCPPError( - ErrorType.INTERNAL_ERROR, - `Response for unknown message id ${messageId}`, - commandName + // Process the message + await this.ocppIncomingRequestService.incomingRequestHandler( + this, + messageId, + commandName, + commandPayload ); - } - responseCallback(commandName, requestPayload); - break; - // Error Message - case MessageType.CALL_ERROR_MESSAGE: - cachedRequest = this.requests.get(messageId); - if (Utils.isIterable(cachedRequest)) { - [, rejectCallback, requestCommandName] = cachedRequest; - } else { - throw new OCPPError( - ErrorType.PROTOCOL_ERROR, - `Cached request for message id ${messageId} error response is not iterable` + break; + // Outcome Message + case MessageType.CALL_RESULT_MESSAGE: + [, , commandPayload] = request as Response; + if (!this.requests.has(messageId)) { + // Error + throw new OCPPError( + ErrorType.INTERNAL_ERROR, + `Response for unknown message id ${messageId}`, + null, + commandPayload + ); + } + // Respond + cachedRequest = this.requests.get(messageId); + if (Utils.isIterable(cachedRequest)) { + [responseCallback, , requestCommandName, requestPayload] = cachedRequest; + } else { + throw new OCPPError( + ErrorType.PROTOCOL_ERROR, + `Cached request for message id ${messageId} response is not iterable`, + null, + cachedRequest as unknown as JsonType + ); + } + logger.debug( + `${this.logPrefix()} << Command '${ + requestCommandName ?? '' + }' received response payload: ${JSON.stringify(request)}` ); - } - if (!rejectCallback) { - // Error - throw new OCPPError( - ErrorType.INTERNAL_ERROR, - `Error response for unknown message id ${messageId}`, - requestCommandName + responseCallback(commandPayload, requestPayload); + break; + // Error Message + case MessageType.CALL_ERROR_MESSAGE: + [, , errorType, errorMessage, errorDetails] = request as ErrorResponse; + if (!this.requests.has(messageId)) { + // Error + throw new OCPPError( + ErrorType.INTERNAL_ERROR, + `Error response for unknown message id ${messageId}`, + null, + { errorType, errorMessage, errorDetails } + ); + } + cachedRequest = this.requests.get(messageId); + if (Utils.isIterable(cachedRequest)) { + [, errorCallback, requestCommandName] = cachedRequest; + } else { + throw new OCPPError( + ErrorType.PROTOCOL_ERROR, + `Cached request for message id ${messageId} error response is not iterable`, + null, + cachedRequest as unknown as JsonType + ); + } + logger.debug( + `${this.logPrefix()} << Command '${ + requestCommandName ?? '' + }' received error payload: ${JSON.stringify(request)}` ); - } - rejectCallback( - new OCPPError(commandName, commandPayload.toString(), requestCommandName, errorDetails) - ); - break; - // Error - default: - // eslint-disable-next-line @typescript-eslint/restrict-template-expressions - errMsg = `${this.logPrefix()} Wrong message type ${messageType}`; - logger.error(errMsg); - throw new OCPPError(ErrorType.PROTOCOL_ERROR, errMsg); + errorCallback(new OCPPError(errorType, errorMessage, requestCommandName, errorDetails)); + break; + // Error + default: + // eslint-disable-next-line @typescript-eslint/restrict-template-expressions + errMsg = `${this.logPrefix()} Wrong message type ${messageType}`; + logger.error(errMsg); + throw new OCPPError(ErrorType.PROTOCOL_ERROR, errMsg); + } + } else { + throw new OCPPError(ErrorType.PROTOCOL_ERROR, 'Incoming message is not iterable', null, { + payload: request, + }); } } catch (error) { // Log @@ -1398,7 +1473,12 @@ export default class ChargingStation { ); // Send error messageType === MessageType.CALL_MESSAGE && - (await this.ocppRequestService.sendError(messageId, error as OCPPError, commandName)); + (await this.ocppRequestService.sendError( + this, + messageId, + error as OCPPError, + commandName ?? requestCommandName ?? null + )); } } @@ -1466,10 +1546,19 @@ export default class ChargingStation { // 0 for disabling private getConnectionTimeout(): number | undefined { - if (this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) { + if ( + ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.ConnectionTimeOut + ) + ) { return ( - parseInt(this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut).value) ?? - Constants.DEFAULT_CONNECTION_TIMEOUT + parseInt( + ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.ConnectionTimeOut + ).value + ) ?? Constants.DEFAULT_CONNECTION_TIMEOUT ); } return Constants.DEFAULT_CONNECTION_TIMEOUT; @@ -1503,7 +1592,10 @@ export default class ChargingStation { } private getTemplateMaxNumberOfConnectors(): number { - return Object.keys(this.stationInfo.Connectors).length; + if (!this.stationInfo?.Connectors) { + return -1; + } + return Object.keys(this.stationInfo?.Connectors).length; } private getMaxNumberOfConnectors(): number { @@ -1515,16 +1607,57 @@ export default class ChargingStation { } else if (!Utils.isUndefined(this.stationInfo.numberOfConnectors)) { maxConnectors = this.stationInfo.numberOfConnectors as number; } else { - maxConnectors = this.stationInfo.Connectors[0] + maxConnectors = this.stationInfo?.Connectors[0] ? this.getTemplateMaxNumberOfConnectors() - 1 : this.getTemplateMaxNumberOfConnectors(); } return maxConnectors; } + private getMaximumPower(): number { + return (this.stationInfo['maxPower'] as number) ?? this.stationInfo.maximumPower; + } + + private getMaximumAmperage(): number | undefined { + const maximumPower = this.getMaximumPower(); + switch (this.getCurrentOutType()) { + case CurrentType.AC: + return ACElectricUtils.amperagePerPhaseFromPower( + this.getNumberOfPhases(), + maximumPower / this.getNumberOfConnectors(), + this.getVoltageOut() + ); + case CurrentType.DC: + return DCElectricUtils.amperage(maximumPower, this.getVoltageOut()); + } + } + + private getAmperageLimitation(): number | undefined { + if ( + this.stationInfo.amperageLimitationOcppKey && + ChargingStationConfigurationUtils.getConfigurationKey( + this, + this.stationInfo.amperageLimitationOcppKey + ) + ) { + return ( + Utils.convertToInt( + ChargingStationConfigurationUtils.getConfigurationKey( + this, + this.stationInfo.amperageLimitationOcppKey + ).value + ) / ChargingStationUtils.getAmperageLimitationUnitDivider(this.stationInfo) + ); + } + } + private async startMessageSequence(): Promise { if (this.stationInfo.autoRegister) { - await this.ocppRequestService.sendMessageHandler( + await this.ocppRequestService.requestHandler< + BootNotificationRequest, + BootNotificationResponse + >( + this, RequestCommand.BOOT_NOTIFICATION, { chargePointModel: this.bootNotificationRequest.chargePointModel, @@ -1554,14 +1687,14 @@ export default class ChargingStation { this.getConnectorStatus(connectorId)?.bootStatus ) { // Send status in template at startup - await this.ocppRequestService.sendMessageHandler( - RequestCommand.STATUS_NOTIFICATION, - { - connectorId, - status: this.getConnectorStatus(connectorId).bootStatus, - errorCode: ChargePointErrorCode.NO_ERROR, - } - ); + await this.ocppRequestService.requestHandler< + StatusNotificationRequest, + StatusNotificationResponse + >(this, RequestCommand.STATUS_NOTIFICATION, { + connectorId, + status: this.getConnectorStatus(connectorId).bootStatus, + errorCode: ChargePointErrorCode.NO_ERROR, + }); this.getConnectorStatus(connectorId).status = this.getConnectorStatus(connectorId).bootStatus; } else if ( @@ -1570,36 +1703,36 @@ export default class ChargingStation { this.getConnectorStatus(connectorId)?.bootStatus ) { // Send status in template after reset - await this.ocppRequestService.sendMessageHandler( - RequestCommand.STATUS_NOTIFICATION, - { - connectorId, - status: this.getConnectorStatus(connectorId).bootStatus, - errorCode: ChargePointErrorCode.NO_ERROR, - } - ); + await this.ocppRequestService.requestHandler< + StatusNotificationRequest, + StatusNotificationResponse + >(this, RequestCommand.STATUS_NOTIFICATION, { + connectorId, + status: this.getConnectorStatus(connectorId).bootStatus, + errorCode: ChargePointErrorCode.NO_ERROR, + }); this.getConnectorStatus(connectorId).status = this.getConnectorStatus(connectorId).bootStatus; } else if (!this.stopped && this.getConnectorStatus(connectorId)?.status) { // Send previous status at template reload - await this.ocppRequestService.sendMessageHandler( - RequestCommand.STATUS_NOTIFICATION, - { - connectorId, - status: this.getConnectorStatus(connectorId).status, - errorCode: ChargePointErrorCode.NO_ERROR, - } - ); + await this.ocppRequestService.requestHandler< + StatusNotificationRequest, + StatusNotificationResponse + >(this, RequestCommand.STATUS_NOTIFICATION, { + connectorId, + status: this.getConnectorStatus(connectorId).status, + errorCode: ChargePointErrorCode.NO_ERROR, + }); } else { // Send default status - await this.ocppRequestService.sendMessageHandler( - RequestCommand.STATUS_NOTIFICATION, - { - connectorId, - status: ChargePointStatus.AVAILABLE, - errorCode: ChargePointErrorCode.NO_ERROR, - } - ); + await this.ocppRequestService.requestHandler< + StatusNotificationRequest, + StatusNotificationResponse + >(this, RequestCommand.STATUS_NOTIFICATION, { + connectorId, + status: ChargePointStatus.AVAILABLE, + errorCode: ChargePointErrorCode.NO_ERROR, + }); this.getConnectorStatus(connectorId).status = ChargePointStatus.AVAILABLE; } } @@ -1646,7 +1779,8 @@ export default class ChargingStation { connectorId, this.getEnergyActiveImportRegisterByTransactionId(transactionId) ); - await this.ocppRequestService.sendMessageHandler( + await this.ocppRequestService.requestHandler( + this, RequestCommand.METER_VALUES, { connectorId, @@ -1655,26 +1789,30 @@ export default class ChargingStation { } ); } - await this.ocppRequestService.sendMessageHandler( - RequestCommand.STOP_TRANSACTION, - { - transactionId, - meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId), - idTag: this.getTransactionIdTag(transactionId), - reason, - } - ); + await this.ocppRequestService.requestHandler< + StopTransactionRequest, + StopTransactionResponse + >(this, RequestCommand.STOP_TRANSACTION, { + transactionId, + meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId), + idTag: this.getTransactionIdTag(transactionId), + reason, + }); } } } } private startWebSocketPing(): void { - const webSocketPingInterval: number = this.getConfigurationKey( + const webSocketPingInterval: number = ChargingStationConfigurationUtils.getConfigurationKey( + this, StandardParametersKey.WebSocketPingInterval ) ? Utils.convertToInt( - this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval).value + ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.WebSocketPingInterval + ).value ) : 0; if (webSocketPingInterval > 0 && !this.webSocketPingSetInterval) { @@ -1714,33 +1852,6 @@ export default class ChargingStation { } } - private warnDeprecatedTemplateKey( - template: ChargingStationTemplate, - key: string, - chargingStationId: string, - logMsgToAppend = '' - ): void { - if (!Utils.isUndefined(template[key])) { - const logPrefixStr = ` ${chargingStationId} |`; - logger.warn( - `${Utils.logPrefix(logPrefixStr)} Deprecated template key '${key}' usage in file '${ - this.templateFile - }'${logMsgToAppend && '. ' + logMsgToAppend}` - ); - } - } - - private convertDeprecatedTemplateKey( - template: ChargingStationTemplate, - deprecatedKey: string, - key: string - ): void { - if (!Utils.isUndefined(template[deprecatedKey])) { - template[key] = template[deprecatedKey] as unknown; - delete template[deprecatedKey]; - } - } - private getConfiguredSupervisionUrl(): URL { const supervisionUrls = Utils.cloneObject( this.stationInfo.supervisionUrls ?? Configuration.getSupervisionUrls() @@ -1779,11 +1890,17 @@ export default class ChargingStation { } private getHeartbeatInterval(): number | undefined { - const HeartbeatInterval = this.getConfigurationKey(StandardParametersKey.HeartbeatInterval); + const HeartbeatInterval = ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.HeartbeatInterval + ); if (HeartbeatInterval) { return Utils.convertToInt(HeartbeatInterval.value) * 1000; } - const HeartBeatInterval = this.getConfigurationKey(StandardParametersKey.HeartBeatInterval); + const HeartBeatInterval = ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.HeartBeatInterval + ); if (HeartBeatInterval) { return Utils.convertToInt(HeartBeatInterval.value) * 1000; } @@ -1803,7 +1920,7 @@ export default class ChargingStation { } private openWSConnection( - options: WsOptions = this.stationInfo.wsOptions, + options: WsOptions = this.stationInfo?.wsOptions ?? {}, forceCloseOpened = false ): void { options.handshakeTimeout = options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000; @@ -1878,13 +1995,13 @@ export default class ChargingStation { this.autoReconnectRetryCount.toString() ); this.openWSConnection( - { ...this.stationInfo.wsOptions, handshakeTimeout: reconnectTimeout }, + { ...(this.stationInfo?.wsOptions ?? {}), handshakeTimeout: reconnectTimeout }, true ); this.wsConnectionRestarted = true; } else if (this.getAutoReconnectMaxRetries() !== -1) { logger.error( - `${this.logPrefix()} WebSocket reconnect failure: max retries reached (${ + `${this.logPrefix()} WebSocket reconnect failure: maximum retries reached (${ this.autoReconnectRetryCount }) or retry disabled (${this.getAutoReconnectMaxRetries()})` );