X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FChargingStation.ts;h=01829fdf47273797aefa980824db13282cd72862;hb=e6895390a1697376fdee9c7ebb1e775c24f1022d;hp=00cfce9f96f00014a251284a02494abe9be7d5bc;hpb=e58068fde9b27e3de6733be24fc7b3dfac37331b;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ChargingStation.ts b/src/charging-station/ChargingStation.ts index 00cfce9f..01829fdf 100644 --- a/src/charging-station/ChargingStation.ts +++ b/src/charging-station/ChargingStation.ts @@ -1,35 +1,59 @@ // Partial Copyright Jerome Benoit. 2021. All Rights Reserved. -import { AvailabilityType, BootNotificationRequest, CachedRequest, IncomingRequest, IncomingRequestCommand, RequestCommand } from '../types/ocpp/Requests'; +import { + AvailabilityType, + BootNotificationRequest, + CachedRequest, + IncomingRequest, + IncomingRequestCommand, + RequestCommand, +} from '../types/ocpp/Requests'; import { BootNotificationResponse, RegistrationStatus } from '../types/ocpp/Responses'; -import ChargingStationConfiguration, { ConfigurationKey } from '../types/ChargingStationConfiguration'; -import ChargingStationTemplate, { CurrentType, PowerUnits, Voltage } from '../types/ChargingStationTemplate'; -import { ConnectorPhaseRotation, StandardParametersKey, SupportedFeatureProfiles, VendorDefaultParametersKey } from '../types/ocpp/Configuration'; -import { ConnectorStatus, SampledValueTemplate } from '../types/Connectors'; -import { MeterValueMeasurand, MeterValuePhase } from '../types/ocpp/MeterValues'; +import ChargingStationConfiguration, { + ConfigurationKey, +} from '../types/ChargingStationConfiguration'; +import ChargingStationTemplate, { + CurrentType, + PowerUnits, + Voltage, +} from '../types/ChargingStationTemplate'; +import { + ConnectorPhaseRotation, + StandardParametersKey, + SupportedFeatureProfiles, + VendorDefaultParametersKey, +} from '../types/ocpp/Configuration'; +import { MeterValue, MeterValueMeasurand, MeterValuePhase } from '../types/ocpp/MeterValues'; import { WSError, WebSocketCloseEventStatusCode } from '../types/WebSocket'; -import WebSocket, { ClientOptions, Data, OPEN } from 'ws'; +import WebSocket, { ClientOptions, Data, OPEN, RawData } from 'ws'; import AutomaticTransactionGenerator from './AutomaticTransactionGenerator'; +import { ChargePointErrorCode } from '../types/ocpp/ChargePointErrorCode'; import { ChargePointStatus } from '../types/ocpp/ChargePointStatus'; import { ChargingProfile } from '../types/ocpp/ChargingProfile'; import ChargingStationInfo from '../types/ChargingStationInfo'; import { ChargingStationWorkerMessageEvents } from '../types/ChargingStationWorker'; import { ClientRequestArgs } from 'http'; import Configuration from '../utils/Configuration'; +import { ConnectorStatus } from '../types/ConnectorStatus'; import Constants from '../utils/Constants'; import { ErrorType } from '../types/ocpp/ErrorType'; +import { FileType } from '../types/FileType'; import FileUtils from '../utils/FileUtils'; +import { JsonType } from '../types/JsonType'; import { MessageType } from '../types/ocpp/MessageType'; import OCPP16IncomingRequestService from './ocpp/1.6/OCPP16IncomingRequestService'; import OCPP16RequestService from './ocpp/1.6/OCPP16RequestService'; import OCPP16ResponseService from './ocpp/1.6/OCPP16ResponseService'; +import { OCPP16ServiceUtils } from './ocpp/1.6/OCPP16ServiceUtils'; import OCPPError from '../exception/OCPPError'; 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 { StopTransactionReason } from '../types/ocpp/Transaction'; +import { SupervisionUrlDistribution } from '../types/ConfigurationData'; import { URL } from 'url'; import Utils from '../utils/Utils'; import crypto from 'crypto'; @@ -39,6 +63,7 @@ import { parentPort } from 'worker_threads'; import path from 'path'; export default class ChargingStation { + public readonly id: string; public readonly stationTemplateFile: string; public authorizedTags: string[]; public stationInfo!: ChargingStationInfo; @@ -50,6 +75,7 @@ export default class ChargingStation { public heartbeatSetInterval!: NodeJS.Timeout; public ocppRequestService!: OCPPRequestService; private readonly index: number; + private configurationFile!: string; private bootNotificationRequest!: BootNotificationRequest; private bootNotificationResponse!: BootNotificationResponse | null; private connectorsConfigurationHash!: string; @@ -63,23 +89,27 @@ export default class ChargingStation { private webSocketPingSetInterval!: NodeJS.Timeout; constructor(index: number, stationTemplateFile: string) { + this.id = Utils.generateUUID(); this.index = index; this.stationTemplateFile = stationTemplateFile; - this.connectors = new Map(); - this.initialize(); - this.stopped = false; this.wsConnectionRestarted = false; this.autoReconnectRetryCount = 0; - + this.connectors = new Map(); this.requests = new Map(); this.messageBuffer = new Set(); - + this.initialize(); this.authorizedTags = this.getAuthorizedTags(); } get wsConnectionUrl(): URL { - return this.getSupervisionUrlOcppConfiguration() ? new URL(this.getConfigurationKey(this.stationInfo.supervisionUrlOcppKey ?? VendorDefaultParametersKey.ConnectionUrl).value + '/' + this.stationInfo.chargingStationId) : this.wsConfiguredConnectionUrl; + return this.getSupervisionUrlOcppConfiguration() + ? new URL( + this.getConfigurationKey(this.getSupervisionUrlOcppKey()).value + + '/' + + this.stationInfo.chargingStationId + ) + : this.wsConfiguredConnectionUrl; } public logPrefix(): string { @@ -100,7 +130,9 @@ export default class ChargingStation { } public getEnableStatistics(): boolean | undefined { - return !Utils.isUndefined(this.stationInfo.enableStatistics) ? this.stationInfo.enableStatistics : true; + return !Utils.isUndefined(this.stationInfo.enableStatistics) + ? this.stationInfo.enableStatistics + : true; } public getMayAuthorizeAtRemoteStart(): boolean | undefined { @@ -110,7 +142,9 @@ export default class ChargingStation { public getNumberOfPhases(): number | undefined { switch (this.getCurrentOutType()) { case CurrentType.AC: - return !Utils.isUndefined(this.stationInfo.numberOfPhases) ? this.stationInfo.numberOfPhases : 3; + return !Utils.isUndefined(this.stationInfo.numberOfPhases) + ? this.stationInfo.numberOfPhases + : 3; case CurrentType.DC: return 0; } @@ -120,16 +154,36 @@ export default class ChargingStation { return this?.wsConnection?.readyState === OPEN; } - public isRegistered(): boolean { + public getRegistrationStatus(): RegistrationStatus { + return this?.bootNotificationResponse?.status; + } + + public isInUnknownState(): boolean { + return Utils.isNullOrUndefined(this?.bootNotificationResponse?.status); + } + + public isInPendingState(): boolean { + return this?.bootNotificationResponse?.status === RegistrationStatus.PENDING; + } + + public isInAcceptedState(): boolean { return this?.bootNotificationResponse?.status === RegistrationStatus.ACCEPTED; } + public isInRejectedState(): boolean { + return this?.bootNotificationResponse?.status === RegistrationStatus.REJECTED; + } + + public isRegistered(): boolean { + return !this.isInUnknownState() && (this.isInAcceptedState() || this.isInPendingState()); + } + public isChargingStationAvailable(): boolean { return this.getConnectorStatus(0).availability === AvailabilityType.OPERATIVE; } public isConnectorAvailable(id: number): boolean { - return this.getConnectorStatus(id).availability === AvailabilityType.OPERATIVE; + return id > 0 && this.getConnectorStatus(id).availability === AvailabilityType.OPERATIVE; } public getNumberOfConnectors(): number { @@ -144,8 +198,14 @@ export default class ChargingStation { return this.stationInfo.currentOutType ?? CurrentType.AC; } + public getOcppStrictCompliance(): boolean { + return this.stationInfo.ocppStrictCompliance ?? false; + } + public getVoltageOut(): number | undefined { - const errMsg = `${this.logPrefix()} Unknown ${this.getCurrentOutType()} currentOutType in template file ${this.stationTemplateFile}, cannot define default voltage out`; + const errMsg = `${this.logPrefix()} Unknown ${this.getCurrentOutType()} currentOutType in template file ${ + this.stationTemplateFile + }, cannot define default voltage out`; let defaultVoltageOut: number; switch (this.getCurrentOutType()) { case CurrentType.AC: @@ -158,7 +218,9 @@ export default class ChargingStation { logger.error(errMsg); throw new Error(errMsg); } - return !Utils.isUndefined(this.stationInfo.voltageOut) ? this.stationInfo.voltageOut : defaultVoltageOut; + return !Utils.isUndefined(this.stationInfo.voltageOut) + ? this.stationInfo.voltageOut + : defaultVoltageOut; } public getTransactionIdTag(transactionId: number): string | undefined { @@ -193,35 +255,48 @@ export default class ChargingStation { return this.stationInfo.phaseLineToLineVoltageMeterValues ?? false; } - public getEnergyActiveImportRegisterByTransactionId(transactionId: number): number | undefined { - if (this.getMeteringPerTransaction()) { - for (const connectorId of this.connectors.keys()) { - if (connectorId > 0 && this.getConnectorStatus(connectorId).transactionId === transactionId) { - return this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue; - } - } - } + public getConnectorIdByTransactionId(transactionId: number): number | undefined { for (const connectorId of this.connectors.keys()) { - if (connectorId > 0 && this.getConnectorStatus(connectorId).transactionId === transactionId) { - return this.getConnectorStatus(connectorId).energyActiveImportRegisterValue; + if ( + connectorId > 0 && + this.getConnectorStatus(connectorId)?.transactionId === transactionId + ) { + return connectorId; } } } + public getEnergyActiveImportRegisterByTransactionId(transactionId: number): number | undefined { + const transactionConnectorStatus = this.getConnectorStatus( + this.getConnectorIdByTransactionId(transactionId) + ); + if (this.getMeteringPerTransaction()) { + return transactionConnectorStatus?.transactionEnergyActiveImportRegisterValue; + } + return transactionConnectorStatus?.energyActiveImportRegisterValue; + } + public getEnergyActiveImportRegisterByConnectorId(connectorId: number): number | undefined { + const connectorStatus = this.getConnectorStatus(connectorId); if (this.getMeteringPerTransaction()) { - return this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue; + return connectorStatus?.transactionEnergyActiveImportRegisterValue; } - return this.getConnectorStatus(connectorId).energyActiveImportRegisterValue; + return connectorStatus?.energyActiveImportRegisterValue; } public getAuthorizeRemoteTxRequests(): boolean { - const authorizeRemoteTxRequests = this.getConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests); - return authorizeRemoteTxRequests ? Utils.convertToBoolean(authorizeRemoteTxRequests.value) : false; + const authorizeRemoteTxRequests = this.getConfigurationKey( + StandardParametersKey.AuthorizeRemoteTxRequests + ); + return authorizeRemoteTxRequests + ? Utils.convertToBoolean(authorizeRemoteTxRequests.value) + : false; } public getLocalAuthListEnabled(): boolean { - const localAuthListEnabled = this.getConfigurationKey(StandardParametersKey.LocalAuthListEnabled); + const localAuthListEnabled = this.getConfigurationKey( + StandardParametersKey.LocalAuthListEnabled + ); return localAuthListEnabled ? Utils.convertToBoolean(localAuthListEnabled.value) : false; } @@ -232,28 +307,70 @@ export default class ChargingStation { this.startWebSocketPing(); } - public getSampledValueTemplate(connectorId: number, measurand: MeterValueMeasurand = MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER, - phase?: MeterValuePhase): SampledValueTemplate | undefined { + 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}' ${phase ? `on phase ${phase} ` : ''}in template on connectorId ${connectorId}`); + 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}' ${phase ? `on phase ${phase} ` : ''}in template on connectorId ${connectorId} not found in '${StandardParametersKey.MeterValuesSampledData}' OCPP parameter`); + 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}' ${phase ? `on phase ${phase} ` : ''}in template on connectorId ${connectorId}`); - } else if (phase && sampledValueTemplates[index]?.phase === phase && sampledValueTemplates[index]?.measurand === measurand - && this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes(measurand)) { + 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)) { + } 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)) { + } else if ( + measurand === MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER && + (!sampledValueTemplates[index].measurand || + sampledValueTemplates[index].measurand === measurand) + ) { return sampledValueTemplates[index]; } } @@ -262,7 +379,9 @@ export default class ChargingStation { logger.error(errorMsg); throw new Error(errorMsg); } - logger.debug(`${this.logPrefix()} No MeterValues for measurand '${measurand}' ${phase ? `on phase ${phase} ` : ''}in template on connectorId ${connectorId}`); + logger.debug( + `${this.logPrefix()} No MeterValues for measurand '${measurand}' ${onPhaseStr}in template on connectorId ${connectorId}` + ); } public getAutomaticTransactionGeneratorRequireAuthorize(): boolean { @@ -270,16 +389,34 @@ export default class ChargingStation { } public startHeartbeat(): void { - if (this.getHeartbeatInterval() && this.getHeartbeatInterval() > 0 && !this.heartbeatSetInterval) { + if ( + this.getHeartbeatInterval() && + this.getHeartbeatInterval() > 0 && + !this.heartbeatSetInterval + ) { // eslint-disable-next-line @typescript-eslint/no-misused-promises this.heartbeatSetInterval = setInterval(async (): Promise => { - await this.ocppRequestService.sendHeartbeat(); + await this.ocppRequestService.sendMessageHandler(RequestCommand.HEARTBEAT); }, this.getHeartbeatInterval()); - logger.info(this.logPrefix() + ' Heartbeat started every ' + Utils.formatDurationMilliSeconds(this.getHeartbeatInterval())); + logger.info( + this.logPrefix() + + ' Heartbeat started every ' + + Utils.formatDurationMilliSeconds(this.getHeartbeatInterval()) + ); } else if (this.heartbeatSetInterval) { - logger.info(this.logPrefix() + ' Heartbeat already started every ' + Utils.formatDurationMilliSeconds(this.getHeartbeatInterval())); + logger.info( + this.logPrefix() + + ' Heartbeat already started every ' + + Utils.formatDurationMilliSeconds(this.getHeartbeatInterval()) + ); } else { - logger.error(`${this.logPrefix()} Heartbeat interval set to ${this.getHeartbeatInterval() ? Utils.formatDurationMilliSeconds(this.getHeartbeatInterval()) : this.getHeartbeatInterval()}, not starting the heartbeat`); + logger.error( + `${this.logPrefix()} Heartbeat interval set to ${ + this.getHeartbeatInterval() + ? Utils.formatDurationMilliSeconds(this.getHeartbeatInterval()) + : this.getHeartbeatInterval() + }, not starting the heartbeat` + ); } } @@ -292,27 +429,59 @@ export default class ChargingStation { public startMeterValues(connectorId: number, interval: number): void { if (connectorId === 0) { - logger.error(`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId.toString()}`); + logger.error( + `${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId.toString()}` + ); return; } if (!this.getConnectorStatus(connectorId)) { - logger.error(`${this.logPrefix()} Trying to start MeterValues on non existing connector Id ${connectorId.toString()}`); + logger.error( + `${this.logPrefix()} Trying to start MeterValues on non existing connector Id ${connectorId.toString()}` + ); return; } if (!this.getConnectorStatus(connectorId)?.transactionStarted) { - logger.error(`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction started`); + logger.error( + `${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction started` + ); return; - } else if (this.getConnectorStatus(connectorId)?.transactionStarted && !this.getConnectorStatus(connectorId)?.transactionId) { - logger.error(`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction id`); + } else if ( + this.getConnectorStatus(connectorId)?.transactionStarted && + !this.getConnectorStatus(connectorId)?.transactionId + ) { + logger.error( + `${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction id` + ); return; } if (interval > 0) { // eslint-disable-next-line @typescript-eslint/no-misused-promises - this.getConnectorStatus(connectorId).transactionSetInterval = setInterval(async (): Promise => { - await this.ocppRequestService.sendMeterValues(connectorId, this.getConnectorStatus(connectorId).transactionId, interval); - }, interval); + this.getConnectorStatus(connectorId).transactionSetInterval = setInterval( + // eslint-disable-next-line @typescript-eslint/no-misused-promises + async (): Promise => { + // FIXME: Implement OCPP version agnostic helpers + const meterValue: MeterValue = OCPP16ServiceUtils.buildMeterValue( + this, + connectorId, + this.getConnectorStatus(connectorId).transactionId, + interval + ); + await this.ocppRequestService.sendMessageHandler(RequestCommand.METER_VALUES, { + connectorId, + transactionId: this.getConnectorStatus(connectorId).transactionId, + meterValue: [meterValue], + }); + }, + interval + ); } else { - logger.error(`${this.logPrefix()} Charging station ${StandardParametersKey.MeterValueSampleInterval} configuration set to ${interval ? Utils.formatDurationMilliSeconds(interval) : interval}, not sending MeterValues`); + logger.error( + `${this.logPrefix()} Charging station ${ + StandardParametersKey.MeterValueSampleInterval + } configuration set to ${ + interval ? Utils.formatDurationMilliSeconds(interval) : interval + }, not sending MeterValues` + ); } } @@ -322,22 +491,85 @@ export default class ChargingStation { } this.openWSConnection(); // Monitor authorization file - this.startAuthorizationFileMonitoring(); - // Monitor station template file - this.startStationTemplateFileMonitoring(); + FileUtils.watchJsonFile( + this.logPrefix(), + FileType.Authorization, + this.getAuthorizationFile(), + this.authorizedTags + ); + // Monitor charging station template file + FileUtils.watchJsonFile( + this.logPrefix(), + FileType.ChargingStationTemplate, + this.stationTemplateFile, + null, + (event, filename): void => { + if (filename && event === 'change') { + try { + logger.debug( + `${this.logPrefix()} ${FileType.ChargingStationTemplate} ${ + this.stationTemplateFile + } file have changed, reload` + ); + // Initialize + this.initialize(); + // Restart the ATG + if ( + !this.stationInfo.AutomaticTransactionGenerator.enable && + this.automaticTransactionGenerator + ) { + this.automaticTransactionGenerator.stop(); + } + this.startAutomaticTransactionGenerator(); + if (this.getEnableStatistics()) { + this.performanceStatistics.restart(); + } else { + this.performanceStatistics.stop(); + } + // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed + } catch (error) { + logger.error( + `${this.logPrefix()} ${FileType.ChargingStationTemplate} file monitoring error: %j`, + error + ); + } + } + } + ); + // FIXME: triggered by saveConfiguration() + // if (this.getOcppPersistentConfiguration()) { + // FileUtils.watchJsonFile( + // this.logPrefix(), + // FileType.ChargingStationConfiguration, + // this.configurationFile, + // this.configuration + // ); + // } // Handle WebSocket message - this.wsConnection.on('message', this.onMessage.bind(this)); + 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)); + 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)); + 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)); + this.wsConnection.on('open', this.onOpen.bind(this) as (this: WebSocket) => void); // Handle WebSocket ping - this.wsConnection.on('ping', this.onPing.bind(this)); + 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)); - parentPort.postMessage({ id: ChargingStationWorkerMessageEvents.STARTED, data: { id: this.stationInfo.chargingStationId } }); + this.wsConnection.on('pong', this.onPong.bind(this) as (this: WebSocket, data: Buffer) => void); + parentPort.postMessage({ + id: ChargingStationWorkerMessageEvents.STARTED, + data: { id: this.stationInfo.chargingStationId }, + }); } public async stop(reason: StopTransactionReason = StopTransactionReason.NONE): Promise { @@ -345,7 +577,11 @@ export default class ChargingStation { await this.stopMessageSequence(reason); for (const connectorId of this.connectors.keys()) { if (connectorId > 0) { - await this.ocppRequestService.sendStatusNotification(connectorId, ChargePointStatus.UNAVAILABLE); + await this.ocppRequestService.sendMessageHandler(RequestCommand.STATUS_NOTIFICATION, { + connectorId, + status: ChargePointStatus.UNAVAILABLE, + errorCode: ChargePointErrorCode.NO_ERROR, + }); this.getConnectorStatus(connectorId).status = ChargePointStatus.UNAVAILABLE; } } @@ -356,11 +592,17 @@ export default class ChargingStation { this.performanceStatistics.stop(); } this.bootNotificationResponse = null; - parentPort.postMessage({ id: ChargingStationWorkerMessageEvents.STOPPED, data: { id: this.stationInfo.chargingStationId } }); + parentPort.postMessage({ + id: ChargingStationWorkerMessageEvents.STOPPED, + data: { id: this.stationInfo.chargingStationId }, + }); this.stopped = true; } - public getConfigurationKey(key: string | StandardParametersKey, caseInsensitive = false): ConfigurationKey | undefined { + public getConfigurationKey( + key: string | StandardParametersKey, + caseInsensitive = false + ): ConfigurationKey | undefined { return this.configuration.configurationKey.find((configElement) => { if (caseInsensitive) { return configElement.key.toLowerCase() === key.toLowerCase(); @@ -369,11 +611,31 @@ export default class ChargingStation { }); } - public addConfigurationKey(key: string | StandardParametersKey, value: string, options: { readonly?: boolean, visible?: boolean, reboot?: boolean } = { readonly: false, visible: true, reboot: false }): void { - const keyFound = this.getConfigurationKey(key); + 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 { + if (!options || Utils.isEmptyObject(options)) { + options = { + readonly: false, + visible: true, + reboot: false, + }; + } const readonly = options.readonly; const visible = options.visible; const reboot = options.reboot; + let keyFound = this.getConfigurationKey(key); + if (keyFound && params?.overwrite) { + this.deleteConfigurationKey(keyFound.key, { save: false }); + keyFound = undefined; + } if (!keyFound) { this.configuration.configurationKey.push({ key, @@ -382,31 +644,63 @@ export default class ChargingStation { visible, reboot, }); + params?.save && this.saveConfiguration(); } else { - logger.error(`${this.logPrefix()} Trying to add an already existing configuration key: %j`, keyFound); + logger.error( + `${this.logPrefix()} Trying to add an already existing configuration key: %j`, + keyFound + ); } } - public setConfigurationKeyValue(key: string | StandardParametersKey, value: string): void { - const keyFound = this.getConfigurationKey(key); + public setConfigurationKeyValue( + key: string | StandardParametersKey, + value: string, + caseInsensitive = false + ): void { + const keyFound = this.getConfigurationKey(key, caseInsensitive); if (keyFound) { const keyIndex = this.configuration.configurationKey.indexOf(keyFound); this.configuration.configurationKey[keyIndex].value = value; + this.saveConfiguration(); } else { - logger.error(`${this.logPrefix()} Trying to set a value on a non existing configuration key: %j`, { key, value }); + logger.error( + `${this.logPrefix()} Trying to set a value on a non existing configuration key: %j`, + { key, value } + ); + } + } + + 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.configuration.configurationKey.splice( + this.configuration.configurationKey.indexOf(keyFound), + 1 + ); + params?.save && this.saveConfiguration(); + return deletedConfigurationKey; } } public setChargingProfile(connectorId: number, cp: ChargingProfile): void { let cpReplaced = false; if (!Utils.isEmptyArray(this.getConnectorStatus(connectorId).chargingProfiles)) { - this.getConnectorStatus(connectorId).chargingProfiles?.forEach((chargingProfile: ChargingProfile, index: number) => { - if (chargingProfile.chargingProfileId === cp.chargingProfileId - || (chargingProfile.stackLevel === cp.stackLevel && chargingProfile.chargingProfilePurpose === cp.chargingProfilePurpose)) { - this.getConnectorStatus(connectorId).chargingProfiles[index] = cp; - cpReplaced = true; + this.getConnectorStatus(connectorId).chargingProfiles?.forEach( + (chargingProfile: ChargingProfile, index: number) => { + if ( + chargingProfile.chargingProfileId === cp.chargingProfileId || + (chargingProfile.stackLevel === cp.stackLevel && + chargingProfile.chargingProfilePurpose === cp.chargingProfilePurpose) + ) { + this.getConnectorStatus(connectorId).chargingProfiles[index] = cp; + cpReplaced = true; + } } - }); + ); } !cpReplaced && this.getConnectorStatus(connectorId).chargingProfiles?.push(cp); } @@ -443,41 +737,72 @@ export default class ChargingStation { return this.stationInfo.supervisionUrlOcppConfiguration ?? false; } + private getSupervisionUrlOcppKey(): string { + 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 ?? ''; - return stationTemplate.fixedName ? stationTemplate.baseName : stationTemplate.baseName + '-' + instanceIndex.toString() + ('000000000' + this.index.toString()).substr(('000000000' + this.index.toString()).length - 4) + idSuffix; + const idStr = '000000000' + this.index.toString(); + return stationTemplate.fixedName + ? stationTemplate.baseName + : stationTemplate.baseName + + '-' + + instanceIndex.toString() + + idStr.substring(idStr.length - 4) + + idSuffix; } private buildStationInfo(): ChargingStationInfo { let stationTemplateFromFile: ChargingStationTemplate; try { // Load template file - const fileDescriptor = fs.openSync(this.stationTemplateFile, 'r'); - stationTemplateFromFile = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as ChargingStationTemplate; - fs.closeSync(fileDescriptor); + stationTemplateFromFile = JSON.parse( + fs.readFileSync(this.stationTemplateFile, 'utf8') + ) as ChargingStationTemplate; } catch (error) { - FileUtils.handleFileException(this.logPrefix(), 'Template', this.stationTemplateFile, error as NodeJS.ErrnoException); - } - const stationInfo: ChargingStationInfo = stationTemplateFromFile ?? {} as ChargingStationInfo; + FileUtils.handleFileException( + this.logPrefix(), + FileType.ChargingStationTemplate, + this.stationTemplateFile, + error as NodeJS.ErrnoException + ); + } + const chargingStationId = this.getChargingStationId(stationTemplateFromFile); + // Deprecation template keys section + this.warnDeprecatedTemplateKey( + stationTemplateFromFile, + 'supervisionUrl', + chargingStationId, + "Use 'supervisionUrls' instead" + ); + this.convertDeprecatedTemplateKey(stationTemplateFromFile, 'supervisionUrl', 'supervisionUrls'); + const stationInfo: ChargingStationInfo = stationTemplateFromFile ?? ({} as ChargingStationInfo); stationInfo.wsOptions = stationTemplateFromFile?.wsOptions ?? {}; if (!Utils.isEmptyArray(stationTemplateFromFile.power)) { stationTemplateFromFile.power = stationTemplateFromFile.power as number[]; - const powerArrayRandomIndex = Math.floor(Utils.secureRandom() * stationTemplateFromFile.power.length); - stationInfo.maxPower = stationTemplateFromFile.powerUnit === PowerUnits.KILO_WATT - ? stationTemplateFromFile.power[powerArrayRandomIndex] * 1000 - : stationTemplateFromFile.power[powerArrayRandomIndex]; + const powerArrayRandomIndex = Math.floor( + Utils.secureRandom() * stationTemplateFromFile.power.length + ); + stationInfo.maxPower = + stationTemplateFromFile.powerUnit === PowerUnits.KILO_WATT + ? stationTemplateFromFile.power[powerArrayRandomIndex] * 1000 + : stationTemplateFromFile.power[powerArrayRandomIndex]; } else { stationTemplateFromFile.power = stationTemplateFromFile.power as number; - stationInfo.maxPower = stationTemplateFromFile.powerUnit === PowerUnits.KILO_WATT - ? stationTemplateFromFile.power * 1000 - : stationTemplateFromFile.power; + stationInfo.maxPower = + stationTemplateFromFile.powerUnit === PowerUnits.KILO_WATT + ? stationTemplateFromFile.power * 1000 + : stationTemplateFromFile.power; } delete stationInfo.power; delete stationInfo.powerUnit; - stationInfo.chargingStationId = this.getChargingStationId(stationTemplateFromFile); - stationInfo.resetTime = stationTemplateFromFile.resetTime ? stationTemplateFromFile.resetTime * 1000 : Constants.CHARGING_STATION_DEFAULT_RESET_TIME; + stationInfo.chargingStationId = chargingStationId; + stationInfo.resetTime = stationTemplateFromFile.resetTime + ? stationTemplateFromFile.resetTime * 1000 + : Constants.CHARGING_STATION_DEFAULT_RESET_TIME; return stationInfo; } @@ -485,50 +810,96 @@ export default class ChargingStation { return this.stationInfo.ocppVersion ? this.stationInfo.ocppVersion : OCPPVersion.VERSION_16; } + private getOcppPersistentConfiguration(): boolean { + return this.stationInfo.ocppPersistentConfiguration ?? true; + } + private handleUnsupportedVersion(version: OCPPVersion) { - const errMsg = `${this.logPrefix()} Unsupported protocol version '${version}' configured in template file ${this.stationTemplateFile}`; + const errMsg = `${this.logPrefix()} Unsupported protocol version '${version}' configured in template file ${ + this.stationTemplateFile + }`; logger.error(errMsg); throw new Error(errMsg); } private initialize(): void { this.stationInfo = this.buildStationInfo(); - this.configuration = this.getTemplateChargingStationConfiguration(); + this.configurationFile = path.join( + path.resolve(__dirname, '../'), + 'assets/configurations', + this.stationInfo.chargingStationId + '.json' + ); + this.configuration = this.getConfiguration(); delete this.stationInfo.Configuration; this.bootNotificationRequest = { chargePointModel: this.stationInfo.chargePointModel, chargePointVendor: this.stationInfo.chargePointVendor, - ...!Utils.isUndefined(this.stationInfo.chargeBoxSerialNumberPrefix) && { chargeBoxSerialNumber: this.stationInfo.chargeBoxSerialNumberPrefix }, - ...!Utils.isUndefined(this.stationInfo.firmwareVersion) && { firmwareVersion: this.stationInfo.firmwareVersion }, + ...(!Utils.isUndefined(this.stationInfo.chargeBoxSerialNumberPrefix) && { + chargeBoxSerialNumber: this.stationInfo.chargeBoxSerialNumberPrefix, + }), + ...(!Utils.isUndefined(this.stationInfo.firmwareVersion) && { + firmwareVersion: this.stationInfo.firmwareVersion, + }), }; // Build connectors if needed const maxConnectors = this.getMaxNumberOfConnectors(); if (maxConnectors <= 0) { - logger.warn(`${this.logPrefix()} Charging station template ${this.stationTemplateFile} with ${maxConnectors} connectors`); + logger.warn( + `${this.logPrefix()} Charging station template ${ + this.stationTemplateFile + } with ${maxConnectors} connectors` + ); } const templateMaxConnectors = this.getTemplateMaxNumberOfConnectors(); if (templateMaxConnectors <= 0) { - logger.warn(`${this.logPrefix()} Charging station template ${this.stationTemplateFile} with no connector configuration`); + logger.warn( + `${this.logPrefix()} Charging station template ${ + this.stationTemplateFile + } with no connector configuration` + ); } if (!this.stationInfo.Connectors[0]) { - logger.warn(`${this.logPrefix()} Charging station template ${this.stationTemplateFile} with no connector Id 0 configuration`); + logger.warn( + `${this.logPrefix()} Charging station template ${ + this.stationTemplateFile + } with no connector Id 0 configuration` + ); } // Sanity check - if (maxConnectors > (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 ${this.stationTemplateFile}, forcing random connector configurations affectation`); + if ( + maxConnectors > + (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 ${ + this.stationTemplateFile + }, forcing random connector configurations affectation` + ); this.stationInfo.randomConnectors = true; } - const connectorsConfigHash = crypto.createHash('sha256').update(JSON.stringify(this.stationInfo.Connectors) + maxConnectors.toString()).digest('hex'); - const connectorsConfigChanged = this.connectors?.size !== 0 && this.connectorsConfigurationHash !== connectorsConfigHash; + const connectorsConfigHash = crypto + .createHash('sha256') + .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()); + 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])); + 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 = []; @@ -536,10 +907,17 @@ export default class ChargingStation { } } // Generate all connectors - if ((this.stationInfo.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) > 0) { + 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])); + 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 = []; @@ -555,11 +933,17 @@ export default class ChargingStation { this.initializeConnectorStatus(connectorId); } } - this.wsConfiguredConnectionUrl = new URL(this.getConfiguredSupervisionUrl().href + '/' + this.stationInfo.chargingStationId); + this.wsConfiguredConnectionUrl = new URL( + this.getConfiguredSupervisionUrl().href + '/' + this.stationInfo.chargingStationId + ); switch (this.getOcppVersion()) { case OCPPVersion.VERSION_16: - this.ocppIncomingRequestService = new OCPP16IncomingRequestService(this); - this.ocppRequestService = new OCPP16RequestService(this, new OCPP16ResponseService(this)); + this.ocppIncomingRequestService = + OCPP16IncomingRequestService.getInstance(this); + this.ocppRequestService = OCPP16RequestService.getInstance( + this, + OCPP16ResponseService.getInstance(this) + ); break; default: this.handleUnsupportedVersion(this.getOcppVersion()); @@ -571,25 +955,52 @@ export default class ChargingStation { this.bootNotificationResponse = { currentTime: new Date().toISOString(), interval: this.getHeartbeatInterval() / 1000, - status: RegistrationStatus.ACCEPTED + status: RegistrationStatus.ACCEPTED, }; } this.stationInfo.powerDivider = this.getPowerDivider(); if (this.getEnableStatistics()) { - this.performanceStatistics = new PerformanceStatistics(this.stationInfo.chargingStationId, this.wsConnectionUrl); + this.performanceStatistics = PerformanceStatistics.getInstance( + this.id, + this.stationInfo.chargingStationId, + this.wsConnectionUrl + ); } } private initOcppParameters(): void { - if (this.getSupervisionUrlOcppConfiguration() && !this.getConfigurationKey(this.stationInfo.supervisionUrlOcppKey ?? VendorDefaultParametersKey.ConnectionUrl)) { - this.addConfigurationKey(VendorDefaultParametersKey.ConnectionUrl, this.getConfiguredSupervisionUrl().href, { reboot: true }); + if ( + this.getSupervisionUrlOcppConfiguration() && + !this.getConfigurationKey(this.getSupervisionUrlOcppKey()) + ) { + this.addConfigurationKey( + this.getSupervisionUrlOcppKey(), + this.getConfiguredSupervisionUrl().href, + { reboot: true } + ); + } else if ( + !this.getSupervisionUrlOcppConfiguration() && + this.getConfigurationKey(this.getSupervisionUrlOcppKey()) + ) { + this.deleteConfigurationKey(this.getSupervisionUrlOcppKey(), { save: false }); } if (!this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles)) { - this.addConfigurationKey(StandardParametersKey.SupportedFeatureProfiles, `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.Local_Auth_List_Management},${SupportedFeatureProfiles.Smart_Charging}`); - } - this.addConfigurationKey(StandardParametersKey.NumberOfConnectors, this.getNumberOfConnectors().toString(), { readonly: true }); + this.addConfigurationKey( + StandardParametersKey.SupportedFeatureProfiles, + `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.Local_Auth_List_Management},${SupportedFeatureProfiles.Smart_Charging}` + ); + } + this.addConfigurationKey( + StandardParametersKey.NumberOfConnectors, + this.getNumberOfConnectors().toString(), + { readonly: true }, + { overwrite: true } + ); if (!this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData)) { - this.addConfigurationKey(StandardParametersKey.MeterValuesSampledData, MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER); + this.addConfigurationKey( + StandardParametersKey.MeterValuesSampledData, + MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER + ); } if (!this.getConfigurationKey(StandardParametersKey.ConnectorPhaseRotation)) { const connectorPhaseRotation = []; @@ -599,53 +1010,146 @@ export default class ChargingStation { connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.RST}`); } else if (connectorId > 0 && this.getNumberOfPhases() === 0) { connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.NotApplicable}`); - // AC + // AC } else if (connectorId > 0 && this.getNumberOfPhases() === 1) { connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.NotApplicable}`); } else if (connectorId > 0 && this.getNumberOfPhases() === 3) { connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.RST}`); } } - this.addConfigurationKey(StandardParametersKey.ConnectorPhaseRotation, connectorPhaseRotation.toString()); + this.addConfigurationKey( + 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)) { + if ( + !this.getConfigurationKey(StandardParametersKey.LocalAuthListEnabled) && + this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles).value.includes( + SupportedFeatureProfiles.Local_Auth_List_Management + ) + ) { this.addConfigurationKey(StandardParametersKey.LocalAuthListEnabled, 'false'); } if (!this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) { - this.addConfigurationKey(StandardParametersKey.ConnectionTimeOut, Constants.DEFAULT_CONNECTION_TIMEOUT.toString()); + this.addConfigurationKey( + StandardParametersKey.ConnectionTimeOut, + Constants.DEFAULT_CONNECTION_TIMEOUT.toString() + ); } + this.saveConfiguration(); + } + + private getConfigurationFromTemplate(): ChargingStationConfiguration { + return this.stationInfo.Configuration ?? ({} as ChargingStationConfiguration); + } + + private getConfigurationFromFile(): ChargingStationConfiguration | null { + let configuration: ChargingStationConfiguration = null; + if ( + this.getOcppPersistentConfiguration() && + this.configurationFile && + fs.existsSync(this.configurationFile) + ) { + try { + configuration = JSON.parse( + fs.readFileSync(this.configurationFile, 'utf8') + ) as ChargingStationConfiguration; + } catch (error) { + FileUtils.handleFileException( + this.logPrefix(), + FileType.ChargingStationConfiguration, + this.configurationFile, + error as NodeJS.ErrnoException + ); + } + } + return configuration; + } + + private saveConfiguration(): void { + if (this.getOcppPersistentConfiguration()) { + if (this.configurationFile) { + try { + if (!fs.existsSync(path.dirname(this.configurationFile))) { + fs.mkdirSync(path.dirname(this.configurationFile), { recursive: true }); + } + const fileDescriptor = fs.openSync(this.configurationFile, 'w'); + fs.writeFileSync(fileDescriptor, JSON.stringify(this.configuration, null, 2)); + fs.closeSync(fileDescriptor); + } catch (error) { + FileUtils.handleFileException( + this.logPrefix(), + FileType.ChargingStationConfiguration, + this.configurationFile, + error as NodeJS.ErrnoException + ); + } + } else { + logger.error( + `${this.logPrefix()} Trying to save charging station configuration to undefined file` + ); + } + } + } + + private getConfiguration(): ChargingStationConfiguration { + let configuration: ChargingStationConfiguration = this.getConfigurationFromFile(); + if (!configuration) { + configuration = this.getConfigurationFromTemplate(); + } + return configuration; } private async onOpen(): Promise { - logger.info(`${this.logPrefix()} Connected to OCPP server through ${this.wsConnectionUrl.toString()}`); - if (!this.isRegistered()) { + 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.sendBootNotification(this.bootNotificationRequest.chargePointModel, - this.bootNotificationRequest.chargePointVendor, this.bootNotificationRequest.chargeBoxSerialNumber, this.bootNotificationRequest.firmwareVersion); - if (!this.isRegistered()) { - registrationRetryCount++; - await Utils.sleep(this.bootNotificationResponse?.interval ? this.bootNotificationResponse.interval * 1000 : Constants.OCPP_DEFAULT_BOOT_NOTIFICATION_INTERVAL); + this.bootNotificationResponse = (await this.ocppRequestService.sendMessageHandler( + RequestCommand.BOOT_NOTIFICATION, + { + chargePointModel: this.bootNotificationRequest.chargePointModel, + chargePointVendor: this.bootNotificationRequest.chargePointVendor, + chargeBoxSerialNumber: this.bootNotificationRequest.chargeBoxSerialNumber, + firmwareVersion: this.bootNotificationRequest.firmwareVersion, + chargePointSerialNumber: this.bootNotificationRequest.chargePointSerialNumber, + iccid: this.bootNotificationRequest.iccid, + imsi: this.bootNotificationRequest.imsi, + meterSerialNumber: this.bootNotificationRequest.meterSerialNumber, + meterType: this.bootNotificationRequest.meterType, + }, + { skipBufferingOnError: true } + )) as BootNotificationResponse; + if (!this.isInAcceptedState()) { + 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)); + } while ( + !this.isInAcceptedState() && + (registrationRetryCount <= this.getRegistrationMaxRetries() || + this.getRegistrationMaxRetries() === -1) + ); } - if (this.isRegistered() && this.stationInfo.autoRegister) { - await this.ocppRequestService.sendBootNotification(this.bootNotificationRequest.chargePointModel, - this.bootNotificationRequest.chargePointVendor, this.bootNotificationRequest.chargeBoxSerialNumber, this.bootNotificationRequest.firmwareVersion); - } - if (this.isRegistered()) { + 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()})`); + logger.error( + `${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})` + ); } this.autoReconnectRetryCount = 0; this.wsConnectionRestarted = false; @@ -656,23 +1160,40 @@ export default class ChargingStation { // Normal close case WebSocketCloseEventStatusCode.CLOSE_NORMAL: case WebSocketCloseEventStatusCode.CLOSE_NO_STATUS: - logger.info(`${this.logPrefix()} WebSocket normally closed with status '${Utils.getWebSocketCloseEventStatusString(code)}' and reason '${reason}'`); + logger.info( + `${this.logPrefix()} WebSocket normally closed with status '${Utils.getWebSocketCloseEventStatusString( + code + )}' and reason '${reason}'` + ); this.autoReconnectRetryCount = 0; break; // Abnormal close default: - logger.error(`${this.logPrefix()} WebSocket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString(code)}' and reason '${reason}'`); + logger.error( + `${this.logPrefix()} WebSocket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString( + code + )}' and reason '${reason}'` + ); await this.reconnect(code); break; } } private async onMessage(data: Data): Promise { - let [messageType, messageId, commandName, commandPayload, errorDetails]: IncomingRequest = [0, '', '' as IncomingRequestCommand, {}, {}]; - let responseCallback: (payload: Record | string, requestPayload: Record) => void; + 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 requestCommandName: RequestCommand | IncomingRequestCommand; - let requestPayload: Record; + let requestPayload: JsonType | OCPPError; let cachedRequest: CachedRequest; let errMsg: string; try { @@ -681,7 +1202,11 @@ export default class ChargingStation { // Parse the message [messageType, messageId, commandName, commandPayload, errorDetails] = request; } else { - throw new OCPPError(ErrorType.PROTOCOL_ERROR, 'Incoming request is not iterable', commandName); + throw new OCPPError( + ErrorType.PROTOCOL_ERROR, + 'Incoming request is not iterable', + commandName + ); } // Check the Type of message switch (messageType) { @@ -691,7 +1216,11 @@ export default class ChargingStation { this.performanceStatistics.addRequestStatistic(commandName, messageType); } // Process the call - await this.ocppIncomingRequestService.handleRequest(messageId, commandName, commandPayload); + await this.ocppIncomingRequestService.handleRequest( + messageId, + commandName, + commandPayload + ); break; // Outcome Message case MessageType.CALL_RESULT_MESSAGE: @@ -700,11 +1229,19 @@ export default class ChargingStation { 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); + throw new OCPPError( + ErrorType.PROTOCOL_ERROR, + `Cached request for message id ${messageId} response is not iterable`, + commandName + ); } if (!responseCallback) { // Error - throw new OCPPError(ErrorType.INTERNAL_ERROR, `Response for unknown message id ${messageId}`, commandName); + throw new OCPPError( + ErrorType.INTERNAL_ERROR, + `Response for unknown message id ${messageId}`, + commandName + ); } responseCallback(commandName, requestPayload); break; @@ -714,25 +1251,42 @@ export default class ChargingStation { 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`); + throw new OCPPError( + ErrorType.PROTOCOL_ERROR, + `Cached request for message id ${messageId} error response is not iterable` + ); } if (!rejectCallback) { // Error - throw new OCPPError(ErrorType.INTERNAL_ERROR, `Error response for unknown message id ${messageId}`, requestCommandName); + throw new OCPPError( + ErrorType.INTERNAL_ERROR, + `Error response for unknown message id ${messageId}`, + requestCommandName + ); } - rejectCallback(new OCPPError(commandName, commandPayload.toString(), requestCommandName, errorDetails)); + 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); } } catch (error) { // Log - logger.error('%s Incoming OCPP message %j matching cached request %j processing error %j', this.logPrefix(), data.toString(), this.requests.get(messageId), error); + logger.error( + '%s Incoming OCPP message %j matching cached request %j processing error %j', + this.logPrefix(), + data.toString(), + this.requests.get(messageId), + error + ); // Send error - messageType === MessageType.CALL_MESSAGE && await this.ocppRequestService.sendError(messageId, error as OCPPError, commandName); + messageType === MessageType.CALL_MESSAGE && + (await this.ocppRequestService.sendError(messageId, error as OCPPError, commandName)); } } @@ -744,21 +1298,19 @@ export default class ChargingStation { logger.debug(this.logPrefix() + ' Received a WS pong (rfc6455) from the server'); } - private async onError(error: WSError): Promise { + private onError(error: WSError): void { logger.error(this.logPrefix() + ' WebSocket error: %j', error); - // switch (error.code) { - // case 'ECONNREFUSED': - // await this.reconnect(error); - // break; - // } - } - - private getTemplateChargingStationConfiguration(): ChargingStationConfiguration { - return this.stationInfo.Configuration ?? {} as ChargingStationConfiguration; } private getAuthorizationFile(): string | undefined { - return this.stationInfo.authorizationFile && path.join(path.resolve(__dirname, '../'), 'assets', path.basename(this.stationInfo.authorizationFile)); + return ( + this.stationInfo.authorizationFile && + path.join( + path.resolve(__dirname, '../'), + 'assets', + path.basename(this.stationInfo.authorizationFile) + ) + ); } private getAuthorizedTags(): string[] { @@ -767,20 +1319,29 @@ export default class ChargingStation { if (authorizationFile) { try { // Load authorization file - const fileDescriptor = fs.openSync(authorizationFile, 'r'); - authorizedTags = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as string[]; - fs.closeSync(fileDescriptor); + authorizedTags = JSON.parse(fs.readFileSync(authorizationFile, 'utf8')) as string[]; } catch (error) { - FileUtils.handleFileException(this.logPrefix(), 'Authorization', authorizationFile, error as NodeJS.ErrnoException); + FileUtils.handleFileException( + this.logPrefix(), + FileType.Authorization, + authorizationFile, + error as NodeJS.ErrnoException + ); } } else { - logger.info(this.logPrefix() + ' No authorization file given in template file ' + this.stationTemplateFile); + logger.info( + this.logPrefix() + + ' No authorization file given in template file ' + + this.stationTemplateFile + ); } return authorizedTags; } private getUseConnectorId0(): boolean | undefined { - return !Utils.isUndefined(this.stationInfo.useConnectorId0) ? this.stationInfo.useConnectorId0 : true; + return !Utils.isUndefined(this.stationInfo.useConnectorId0) + ? this.stationInfo.useConnectorId0 + : true; } private getNumberOfRunningTransactions(): number { @@ -796,7 +1357,10 @@ export default class ChargingStation { // 0 for disabling private getConnectionTimeout(): number | undefined { if (this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) { - return parseInt(this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut).value) ?? Constants.DEFAULT_CONNECTION_TIMEOUT; + return ( + parseInt(this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut).value) ?? + Constants.DEFAULT_CONNECTION_TIMEOUT + ); } return Constants.DEFAULT_CONNECTION_TIMEOUT; } @@ -841,12 +1405,31 @@ export default class ChargingStation { } else if (!Utils.isUndefined(this.stationInfo.numberOfConnectors)) { maxConnectors = this.stationInfo.numberOfConnectors as number; } else { - maxConnectors = this.stationInfo.Connectors[0] ? this.getTemplateMaxNumberOfConnectors() - 1 : this.getTemplateMaxNumberOfConnectors(); + maxConnectors = this.stationInfo.Connectors[0] + ? this.getTemplateMaxNumberOfConnectors() - 1 + : this.getTemplateMaxNumberOfConnectors(); } return maxConnectors; } private async startMessageSequence(): Promise { + if (this.stationInfo.autoRegister) { + await this.ocppRequestService.sendMessageHandler( + RequestCommand.BOOT_NOTIFICATION, + { + chargePointModel: this.bootNotificationRequest.chargePointModel, + chargePointVendor: this.bootNotificationRequest.chargePointVendor, + chargeBoxSerialNumber: this.bootNotificationRequest.chargeBoxSerialNumber, + firmwareVersion: this.bootNotificationRequest.firmwareVersion, + chargePointSerialNumber: this.bootNotificationRequest.chargePointSerialNumber, + iccid: this.bootNotificationRequest.iccid, + imsi: this.bootNotificationRequest.imsi, + meterSerialNumber: this.bootNotificationRequest.meterSerialNumber, + meterType: this.bootNotificationRequest.meterType, + }, + { skipBufferingOnError: true } + ); + } // Start WebSocket ping this.startWebSocketPing(); // Start heartbeat @@ -855,20 +1438,46 @@ export default class ChargingStation { for (const connectorId of this.connectors.keys()) { if (connectorId === 0) { continue; - } else if (!this.stopped && !this.getConnectorStatus(connectorId)?.status && this.getConnectorStatus(connectorId)?.bootStatus) { + } else if ( + !this.stopped && + !this.getConnectorStatus(connectorId)?.status && + this.getConnectorStatus(connectorId)?.bootStatus + ) { // Send status in template at startup - await this.ocppRequestService.sendStatusNotification(connectorId, this.getConnectorStatus(connectorId).bootStatus); - this.getConnectorStatus(connectorId).status = this.getConnectorStatus(connectorId).bootStatus; - } else if (this.stopped && this.getConnectorStatus(connectorId)?.status && this.getConnectorStatus(connectorId)?.bootStatus) { + await this.ocppRequestService.sendMessageHandler(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 && + this.getConnectorStatus(connectorId)?.bootStatus + ) { // Send status in template after reset - await this.ocppRequestService.sendStatusNotification(connectorId, this.getConnectorStatus(connectorId).bootStatus); - this.getConnectorStatus(connectorId).status = this.getConnectorStatus(connectorId).bootStatus; + await this.ocppRequestService.sendMessageHandler(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.sendStatusNotification(connectorId, this.getConnectorStatus(connectorId).status); + await this.ocppRequestService.sendMessageHandler(RequestCommand.STATUS_NOTIFICATION, { + connectorId, + status: this.getConnectorStatus(connectorId).status, + errorCode: ChargePointErrorCode.NO_ERROR, + }); } else { // Send default status - await this.ocppRequestService.sendStatusNotification(connectorId, ChargePointStatus.AVAILABLE); + await this.ocppRequestService.sendMessageHandler(RequestCommand.STATUS_NOTIFICATION, { + connectorId, + status: ChargePointStatus.AVAILABLE, + errorCode: ChargePointErrorCode.NO_ERROR, + }); this.getConnectorStatus(connectorId).status = ChargePointStatus.AVAILABLE; } } @@ -879,7 +1488,7 @@ export default class ChargingStation { private startAutomaticTransactionGenerator() { if (this.stationInfo.AutomaticTransactionGenerator.enable) { if (!this.automaticTransactionGenerator) { - this.automaticTransactionGenerator = new AutomaticTransactionGenerator(this); + this.automaticTransactionGenerator = AutomaticTransactionGenerator.getInstance(this); } if (!this.automaticTransactionGenerator.started) { this.automaticTransactionGenerator.start(); @@ -887,42 +1496,87 @@ export default class ChargingStation { } } - private async stopMessageSequence(reason: StopTransactionReason = StopTransactionReason.NONE): Promise { + private async stopMessageSequence( + reason: StopTransactionReason = StopTransactionReason.NONE + ): Promise { // Stop WebSocket ping this.stopWebSocketPing(); // Stop heartbeat this.stopHeartbeat(); // Stop the ATG - if (this.stationInfo.AutomaticTransactionGenerator.enable && - this.automaticTransactionGenerator && - this.automaticTransactionGenerator.started) { + if ( + this.stationInfo.AutomaticTransactionGenerator.enable && + this.automaticTransactionGenerator?.started + ) { this.automaticTransactionGenerator.stop(); } else { for (const connectorId of this.connectors.keys()) { if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted) { const transactionId = this.getConnectorStatus(connectorId).transactionId; - await this.ocppRequestService.sendStopTransaction(transactionId, this.getEnergyActiveImportRegisterByTransactionId(transactionId), - this.getTransactionIdTag(transactionId), reason); + if ( + this.getBeginEndMeterValues() && + this.getOcppStrictCompliance() && + !this.getOutOfOrderEndMeterValues() + ) { + // FIXME: Implement OCPP version agnostic helpers + const transactionEndMeterValue = OCPP16ServiceUtils.buildTransactionEndMeterValue( + this, + connectorId, + this.getEnergyActiveImportRegisterByTransactionId(transactionId) + ); + await this.ocppRequestService.sendMessageHandler(RequestCommand.METER_VALUES, { + connectorId, + transactionId, + meterValue: transactionEndMeterValue, + }); + } + await this.ocppRequestService.sendMessageHandler(RequestCommand.STOP_TRANSACTION, { + transactionId, + meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId), + idTag: this.getTransactionIdTag(transactionId), + reason, + }); } } } } private startWebSocketPing(): void { - const webSocketPingInterval: number = this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval) - ? Utils.convertToInt(this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval).value) + const webSocketPingInterval: number = this.getConfigurationKey( + StandardParametersKey.WebSocketPingInterval + ) + ? Utils.convertToInt( + this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval).value + ) : 0; if (webSocketPingInterval > 0 && !this.webSocketPingSetInterval) { this.webSocketPingSetInterval = setInterval(() => { if (this.isWebSocketConnectionOpened()) { - this.wsConnection.ping((): void => { /* This is intentional */ }); + this.wsConnection.ping((): void => { + /* This is intentional */ + }); } }, webSocketPingInterval * 1000); - logger.info(this.logPrefix() + ' WebSocket ping started every ' + Utils.formatDurationSeconds(webSocketPingInterval)); + logger.info( + this.logPrefix() + + ' WebSocket ping started every ' + + Utils.formatDurationSeconds(webSocketPingInterval) + ); } else if (this.webSocketPingSetInterval) { - logger.info(this.logPrefix() + ' WebSocket ping every ' + Utils.formatDurationSeconds(webSocketPingInterval) + ' already started'); + logger.info( + this.logPrefix() + + ' WebSocket ping every ' + + Utils.formatDurationSeconds(webSocketPingInterval) + + ' already started' + ); } else { - logger.error(`${this.logPrefix()} WebSocket ping interval set to ${webSocketPingInterval ? Utils.formatDurationSeconds(webSocketPingInterval) : webSocketPingInterval}, not starting the WebSocket ping`); + logger.error( + `${this.logPrefix()} WebSocket ping interval set to ${ + webSocketPingInterval + ? Utils.formatDurationSeconds(webSocketPingInterval) + : webSocketPingInterval + }, not starting the WebSocket ping` + ); } } @@ -932,17 +1586,66 @@ 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.stationTemplateFile + }'${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.supervisionUrl ?? Configuration.getSupervisionUrls()); - let indexUrl = 0; + const supervisionUrls = Utils.cloneObject( + this.stationInfo.supervisionUrls ?? Configuration.getSupervisionUrls() + ); if (!Utils.isEmptyArray(supervisionUrls)) { - if (Configuration.getDistributeStationsToTenantsEqually()) { - indexUrl = this.index % supervisionUrls.length; - } else { - // Get a random url - indexUrl = Math.floor(Utils.secureRandom() * supervisionUrls.length); + let urlIndex = 0; + switch (Configuration.getSupervisionUrlDistribution()) { + case SupervisionUrlDistribution.ROUND_ROBIN: + urlIndex = (this.index - 1) % supervisionUrls.length; + break; + case SupervisionUrlDistribution.RANDOM: + // Get a random url + urlIndex = Math.floor(Utils.secureRandom() * supervisionUrls.length); + break; + case SupervisionUrlDistribution.SEQUENTIAL: + if (this.index <= supervisionUrls.length) { + urlIndex = this.index - 1; + } else { + logger.warn( + `${this.logPrefix()} No more configured supervision urls available, using the first one` + ); + } + break; + default: + logger.error( + `${this.logPrefix()} Unknown supervision url distribution '${Configuration.getSupervisionUrlDistribution()}' from values '${SupervisionUrlDistribution.toString()}', defaulting to ${ + SupervisionUrlDistribution.ROUND_ROBIN + }` + ); + urlIndex = (this.index - 1) % supervisionUrls.length; + break; } - return new URL(supervisionUrls[indexUrl]); + return new URL(supervisionUrls[urlIndex]); } return new URL(supervisionUrls as string); } @@ -956,7 +1659,12 @@ export default class ChargingStation { if (HeartBeatInterval) { return Utils.convertToInt(HeartBeatInterval.value) * 1000; } - !this.stationInfo.autoRegister && logger.warn(`${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${Constants.DEFAULT_HEARTBEAT_INTERVAL}`); + !this.stationInfo.autoRegister && + logger.warn( + `${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${ + Constants.DEFAULT_HEARTBEAT_INTERVAL + }` + ); return Constants.DEFAULT_HEARTBEAT_INTERVAL; } @@ -966,9 +1674,15 @@ export default class ChargingStation { } } - private openWSConnection(options: ClientOptions & ClientRequestArgs = this.stationInfo.wsOptions, forceCloseOpened = false): void { + private openWSConnection( + options: ClientOptions & ClientRequestArgs = this.stationInfo.wsOptions, + forceCloseOpened = false + ): void { options.handshakeTimeout = options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000; - if (!Utils.isNullOrUndefined(this.stationInfo.supervisionUser) && !Utils.isNullOrUndefined(this.stationInfo.supervisionPassword)) { + if ( + !Utils.isNullOrUndefined(this.stationInfo.supervisionUser) && + !Utils.isNullOrUndefined(this.stationInfo.supervisionPassword) + ) { options.auth = `${this.stationInfo.supervisionUser}:${this.stationInfo.supervisionPassword}`; } if (this.isWebSocketConnectionOpened() && forceCloseOpened) { @@ -984,7 +1698,9 @@ export default class ChargingStation { break; } this.wsConnection = new WebSocket(this.wsConnectionUrl, protocol, options); - logger.info(this.logPrefix() + ' Open OCPP connection to URL ' + this.wsConnectionUrl.toString()); + logger.info( + this.logPrefix() + ' Open OCPP connection to URL ' + this.wsConnectionUrl.toString() + ); } private stopMeterValues(connectorId: number) { @@ -993,61 +1709,10 @@ export default class ChargingStation { } } - private startAuthorizationFileMonitoring(): void { - const authorizationFile = this.getAuthorizationFile(); - if (authorizationFile) { - try { - fs.watch(authorizationFile, (event, filename) => { - if (filename && event === 'change') { - try { - logger.debug(this.logPrefix() + ' Authorization file ' + authorizationFile + ' have changed, reload'); - // Initialize authorizedTags - this.authorizedTags = this.getAuthorizedTags(); - } catch (error) { - logger.error(this.logPrefix() + ' Authorization file monitoring error: %j', error); - } - } - }); - } catch (error) { - FileUtils.handleFileException(this.logPrefix(), 'Authorization', authorizationFile, error as NodeJS.ErrnoException); - } - } else { - logger.info(this.logPrefix() + ' No authorization file given in template file ' + this.stationTemplateFile + '. Not monitoring changes'); - } - } - - private startStationTemplateFileMonitoring(): void { - try { - fs.watch(this.stationTemplateFile, (event, filename): void => { - if (filename && event === 'change') { - try { - logger.debug(this.logPrefix() + ' Template file ' + this.stationTemplateFile + ' have changed, reload'); - // Initialize - this.initialize(); - // Restart the ATG - if (!this.stationInfo.AutomaticTransactionGenerator.enable && - this.automaticTransactionGenerator) { - this.automaticTransactionGenerator.stop(); - } - this.startAutomaticTransactionGenerator(); - if (this.getEnableStatistics()) { - this.performanceStatistics.restart(); - } else { - this.performanceStatistics.stop(); - } - // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed - } catch (error) { - logger.error(this.logPrefix() + ' Charging station template file monitoring error: %j', error); - } - } - }); - } catch (error) { - FileUtils.handleFileException(this.logPrefix(), 'Template', this.stationTemplateFile, error as NodeJS.ErrnoException); - } - } - private getReconnectExponentialDelay(): boolean | undefined { - return !Utils.isUndefined(this.stationInfo.reconnectExponentialDelay) ? this.stationInfo.reconnectExponentialDelay : false; + return !Utils.isUndefined(this.stationInfo.reconnectExponentialDelay) + ? this.stationInfo.reconnectExponentialDelay + : false; } private async reconnect(code: number): Promise { @@ -1056,23 +1721,45 @@ export default class ChargingStation { // Stop heartbeat this.stopHeartbeat(); // Stop the ATG if needed - if (this.stationInfo.AutomaticTransactionGenerator.enable && + if ( + this.stationInfo.AutomaticTransactionGenerator.enable && this.stationInfo.AutomaticTransactionGenerator.stopOnConnectionFailure && - this.automaticTransactionGenerator && - this.automaticTransactionGenerator.started) { + this.automaticTransactionGenerator?.started + ) { this.automaticTransactionGenerator.stop(); } - if (this.autoReconnectRetryCount < this.getAutoReconnectMaxRetries() || this.getAutoReconnectMaxRetries() === -1) { + if ( + this.autoReconnectRetryCount < this.getAutoReconnectMaxRetries() || + this.getAutoReconnectMaxRetries() === -1 + ) { this.autoReconnectRetryCount++; - const reconnectDelay = (this.getReconnectExponentialDelay() ? Utils.exponentialDelay(this.autoReconnectRetryCount) : this.getConnectionTimeout() * 1000); - const reconnectTimeout = (reconnectDelay - 100) > 0 && reconnectDelay; - logger.error(`${this.logPrefix()} WebSocket: connection retry in ${Utils.roundTo(reconnectDelay, 2)}ms, timeout ${reconnectTimeout}ms`); + const reconnectDelay = this.getReconnectExponentialDelay() + ? Utils.exponentialDelay(this.autoReconnectRetryCount) + : this.getConnectionTimeout() * 1000; + const reconnectTimeout = reconnectDelay - 100 > 0 && reconnectDelay; + logger.error( + `${this.logPrefix()} WebSocket: connection retry in ${Utils.roundTo( + reconnectDelay, + 2 + )}ms, timeout ${reconnectTimeout}ms` + ); await Utils.sleep(reconnectDelay); - logger.error(this.logPrefix() + ' WebSocket: reconnecting try #' + this.autoReconnectRetryCount.toString()); - this.openWSConnection({ ...this.stationInfo.wsOptions, handshakeTimeout: reconnectTimeout }, true); + logger.error( + this.logPrefix() + + ' WebSocket: reconnecting try #' + + this.autoReconnectRetryCount.toString() + ); + this.openWSConnection( + { ...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.autoReconnectRetryCount}) or retry disabled (${this.getAutoReconnectMaxRetries()})`); + logger.error( + `${this.logPrefix()} WebSocket reconnect failure: max retries reached (${ + this.autoReconnectRetryCount + }) or retry disabled (${this.getAutoReconnectMaxRetries()})` + ); } } @@ -1085,4 +1772,3 @@ export default class ChargingStation { this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue = 0; } } -