X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FChargingStation.ts;h=82aaa25cacd759c62caa45393ae4cabb16a3560e;hb=44eb6026079c8dc2c77b10a96a42d0c0b2da7c8f;hp=e8122d18688243acb8f876946e96e41cb4ad027d;hpb=25f5a959c137b7d302485e8ef6ca9d4a2f1cb6f6;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ChargingStation.ts b/src/charging-station/ChargingStation.ts index e8122d18..7fdc9a95 100644 --- a/src/charging-station/ChargingStation.ts +++ b/src/charging-station/ChargingStation.ts @@ -1,149 +1,197 @@ -// Partial Copyright Jerome Benoit. 2021. All Rights Reserved. +// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved. +import fs from 'fs'; +import crypto from 'node:crypto'; +import path from 'path'; +import { URL } from 'url'; +import { parentPort } from 'worker_threads'; + +import merge from 'just-merge'; +import WebSocket, { type RawData } from 'ws'; + +import AuthorizedTagsCache from './AuthorizedTagsCache'; +import AutomaticTransactionGenerator from './AutomaticTransactionGenerator'; +import { ChargingStationConfigurationUtils } from './ChargingStationConfigurationUtils'; +import { ChargingStationUtils } from './ChargingStationUtils'; +import ChargingStationWorkerBroadcastChannel from './ChargingStationWorkerBroadcastChannel'; +import { MessageChannelUtils } from './MessageChannelUtils'; +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 OCPP20IncomingRequestService from './ocpp/2.0/OCPP20IncomingRequestService'; +import OCPP20RequestService from './ocpp/2.0/OCPP20RequestService'; +import OCPP20ResponseService from './ocpp/2.0/OCPP20ResponseService'; +import type OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService'; +import type OCPPRequestService from './ocpp/OCPPRequestService'; +import { OCPPServiceUtils } from './ocpp/OCPPServiceUtils'; +import SharedLRUCache from './SharedLRUCache'; +import BaseError from '../exception/BaseError'; +import OCPPError from '../exception/OCPPError'; +import PerformanceStatistics from '../performance/PerformanceStatistics'; +import type { AutomaticTransactionGeneratorConfiguration } from '../types/AutomaticTransactionGenerator'; +import type { ChargingStationConfiguration } from '../types/ChargingStationConfiguration'; +import type { ChargingStationInfo } from '../types/ChargingStationInfo'; +import type { ChargingStationOcppConfiguration } from '../types/ChargingStationOcppConfiguration'; 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, { + type ChargingStationTemplate, CurrentType, PowerUnits, - Voltage, + type WsOptions, } from '../types/ChargingStationTemplate'; +import { SupervisionUrlDistribution } from '../types/ConfigurationData'; +import type { ConnectorStatus } from '../types/ConnectorStatus'; +import { FileType } from '../types/FileType'; +import type { JsonType } from '../types/JsonType'; import { ConnectorPhaseRotation, StandardParametersKey, SupportedFeatureProfiles, VendorDefaultParametersKey, } from '../types/ocpp/Configuration'; -import { MeterValue, MeterValueMeasurand, MeterValuePhase } from '../types/ocpp/MeterValues'; +import { ConnectorStatusEnum } from '../types/ocpp/ConnectorStatusEnum'; +import { ErrorType } from '../types/ocpp/ErrorType'; +import { MessageType } from '../types/ocpp/MessageType'; +import { MeterValue, MeterValueMeasurand } from '../types/ocpp/MeterValues'; +import { OCPPVersion } from '../types/ocpp/OCPPVersion'; +import { + AvailabilityType, + type BootNotificationRequest, + type CachedRequest, + type ErrorCallback, + FirmwareStatus, + type FirmwareStatusNotificationRequest, + type HeartbeatRequest, + type IncomingRequest, + IncomingRequestCommand, + type MeterValuesRequest, + type OutgoingRequest, + RequestCommand, + type ResponseCallback, + type StatusNotificationRequest, +} from '../types/ocpp/Requests'; +import { + type BootNotificationResponse, + type ErrorResponse, + type FirmwareStatusNotificationResponse, + type HeartbeatResponse, + type MeterValuesResponse, + RegistrationStatusEnumType, + type Response, + type StatusNotificationResponse, +} from '../types/ocpp/Responses'; +import { + StopTransactionReason, + type StopTransactionRequest, + type StopTransactionResponse, +} from '../types/ocpp/Transaction'; import { WSError, WebSocketCloseEventStatusCode } from '../types/WebSocket'; -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 { ACElectricUtils, DCElectricUtils } from '../utils/ElectricUtils'; 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'; -import fs from 'fs'; import logger from '../utils/Logger'; -import { parentPort } from 'worker_threads'; -import path from 'path'; +import Utils from '../utils/Utils'; export default class ChargingStation { - public readonly id: string; - public readonly stationTemplateFile: string; - public authorizedTags: string[]; + public readonly index: number; + public readonly templateFile: string; public stationInfo!: ChargingStationInfo; - public readonly connectors: Map; - public configuration!: ChargingStationConfiguration; + public started: boolean; + public starting: boolean; + public authorizedTagsCache: AuthorizedTagsCache; + public automaticTransactionGenerator!: AutomaticTransactionGenerator; + public ocppConfiguration!: ChargingStationOcppConfiguration; public wsConnection!: WebSocket; + public readonly connectors: Map; public readonly requests: Map; public performanceStatistics!: PerformanceStatistics; public heartbeatSetInterval!: NodeJS.Timeout; public ocppRequestService!: OCPPRequestService; - private readonly index: number; + public bootNotificationRequest!: BootNotificationRequest; + public bootNotificationResponse!: BootNotificationResponse | null; + public powerDivider!: number; + private stopping: boolean; private configurationFile!: string; - private bootNotificationRequest!: BootNotificationRequest; - private bootNotificationResponse!: BootNotificationResponse | null; + private configurationFileHash!: string; private connectorsConfigurationHash!: string; private ocppIncomingRequestService!: OCPPIncomingRequestService; private readonly messageBuffer: Set; - private wsConfiguredConnectionUrl!: URL; + private configuredSupervisionUrl!: URL; + private configuredSupervisionUrlIndex!: number; private wsConnectionRestarted: boolean; - private stopped: boolean; private autoReconnectRetryCount: number; - private automaticTransactionGenerator!: AutomaticTransactionGenerator; + private templateFileWatcher!: fs.FSWatcher; + private readonly sharedLRUCache: SharedLRUCache; private webSocketPingSetInterval!: NodeJS.Timeout; + private readonly chargingStationWorkerBroadcastChannel: ChargingStationWorkerBroadcastChannel; - constructor(index: number, stationTemplateFile: string) { - this.id = Utils.generateUUID(); - this.index = index; - this.stationTemplateFile = stationTemplateFile; - this.stopped = false; + constructor(index: number, templateFile: string) { + this.started = false; + this.starting = false; + this.stopping = false; this.wsConnectionRestarted = false; this.autoReconnectRetryCount = 0; + this.index = index; + this.templateFile = templateFile; this.connectors = new Map(); this.requests = new Map(); this.messageBuffer = new Set(); + this.sharedLRUCache = SharedLRUCache.getInstance(); + this.authorizedTagsCache = AuthorizedTagsCache.getInstance(); + this.chargingStationWorkerBroadcastChannel = new ChargingStationWorkerBroadcastChannel(this); + this.initialize(); - this.authorizedTags = this.getAuthorizedTags(); } private get wsConnectionUrl(): URL { - return this.getSupervisionUrlOcppConfiguration() - ? new URL( - this.getConfigurationKey(this.getSupervisionUrlOcppKey()).value + - '/' + - this.stationInfo.chargingStationId - ) - : this.wsConfiguredConnectionUrl; + return new URL( + `${ + this.getSupervisionUrlOcppConfiguration() + ? ChargingStationConfigurationUtils.getConfigurationKey( + this, + this.getSupervisionUrlOcppKey() + ).value + : this.configuredSupervisionUrl.href + }/${this.stationInfo.chargingStationId}` + ); } public logPrefix(): string { - return Utils.logPrefix(` ${this.stationInfo.chargingStationId} |`); + return Utils.logPrefix( + ` ${ + this?.stationInfo?.chargingStationId ?? + ChargingStationUtils.getChargingStationId(this.index, this.getTemplateFromFile()) + } |` + ); } - public getBootNotificationRequest(): BootNotificationRequest { - return this.bootNotificationRequest; + public hasAuthorizedTags(): boolean { + return !Utils.isEmptyArray( + this.authorizedTagsCache.getAuthorizedTags( + ChargingStationUtils.getAuthorizationFile(this.stationInfo) + ) + ); } - public getRandomIdTag(): string { - const index = Math.floor(Utils.secureRandom() * this.authorizedTags.length); - return this.authorizedTags[index]; + public getEnableStatistics(): boolean { + return this.stationInfo.enableStatistics ?? false; } - public hasAuthorizedTags(): boolean { - return !Utils.isEmptyArray(this.authorizedTags); + public getMustAuthorizeAtRemoteStart(): boolean { + return this.stationInfo.mustAuthorizeAtRemoteStart ?? true; } - public getEnableStatistics(): boolean | undefined { - return !Utils.isUndefined(this.stationInfo.enableStatistics) - ? this.stationInfo.enableStatistics - : true; + public getPayloadSchemaValidation(): boolean { + return this.stationInfo.payloadSchemaValidation ?? true; } - public getMayAuthorizeAtRemoteStart(): boolean | undefined { - return this.stationInfo.mayAuthorizeAtRemoteStart ?? true; - } - - public getNumberOfPhases(): number | undefined { - switch (this.getCurrentOutType()) { + public getNumberOfPhases(stationInfo?: ChargingStationInfo): number | undefined { + const localStationInfo: ChargingStationInfo = stationInfo ?? this.stationInfo; + switch (this.getCurrentOutType(stationInfo)) { case CurrentType.AC: - return !Utils.isUndefined(this.stationInfo.numberOfPhases) - ? this.stationInfo.numberOfPhases + return !Utils.isUndefined(localStationInfo.numberOfPhases) + ? localStationInfo.numberOfPhases : 3; case CurrentType.DC: return 0; @@ -151,10 +199,10 @@ export default class ChargingStation { } public isWebSocketConnectionOpened(): boolean { - return this?.wsConnection?.readyState === OPEN; + return this?.wsConnection?.readyState === WebSocket.OPEN; } - public getRegistrationStatus(): RegistrationStatus { + public getRegistrationStatus(): RegistrationStatusEnumType { return this?.bootNotificationResponse?.status; } @@ -163,19 +211,22 @@ export default class ChargingStation { } public isInPendingState(): boolean { - return this?.bootNotificationResponse?.status === RegistrationStatus.PENDING; + return this?.bootNotificationResponse?.status === RegistrationStatusEnumType.PENDING; } public isInAcceptedState(): boolean { - return this?.bootNotificationResponse?.status === RegistrationStatus.ACCEPTED; + return this?.bootNotificationResponse?.status === RegistrationStatusEnumType.ACCEPTED; } public isInRejectedState(): boolean { - return this?.bootNotificationResponse?.status === RegistrationStatus.REJECTED; + return this?.bootNotificationResponse?.status === RegistrationStatusEnumType.REJECTED; } public isRegistered(): boolean { - return !this.isInUnknownState() && (this.isInAcceptedState() || this.isInPendingState()); + return ( + this.isInUnknownState() === false && + (this.isInAcceptedState() === true || this.isInPendingState() === true) + ); } public isChargingStationAvailable(): boolean { @@ -190,39 +241,63 @@ export default class ChargingStation { return this.connectors.get(0) ? this.connectors.size - 1 : this.connectors.size; } - public getConnectorStatus(id: number): ConnectorStatus { + public getConnectorStatus(id: number): ConnectorStatus | undefined { return this.connectors.get(id); } - public getCurrentOutType(): CurrentType | undefined { - return this.stationInfo.currentOutType ?? CurrentType.AC; + public getCurrentOutType(stationInfo?: ChargingStationInfo): CurrentType { + return (stationInfo ?? this.stationInfo).currentOutType ?? CurrentType.AC; } 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.stationTemplateFile - }, 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); - } - return !Utils.isUndefined(this.stationInfo.voltageOut) - ? this.stationInfo.voltageOut + public getVoltageOut(stationInfo?: ChargingStationInfo): number | undefined { + const defaultVoltageOut = ChargingStationUtils.getDefaultVoltageOut( + this.getCurrentOutType(stationInfo), + this.templateFile, + this.logPrefix() + ); + const localStationInfo: ChargingStationInfo = stationInfo ?? this.stationInfo; + return !Utils.isUndefined(localStationInfo.voltageOut) + ? localStationInfo.voltageOut : defaultVoltageOut; } + public getMaximumPower(stationInfo?: ChargingStationInfo): number { + const localStationInfo = stationInfo ?? this.stationInfo; + return (localStationInfo['maxPower'] as number) ?? localStationInfo.maximumPower; + } + + 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.powerDivider; + } + const connectorMaximumPower = this.getMaximumPower() / this.powerDivider; + const connectorChargingProfilesPowerLimit = + ChargingStationUtils.getChargingStationConnectorChargingProfilesPowerLimit(this, connectorId); + return Math.min( + isNaN(connectorMaximumPower) ? Infinity : connectorMaximumPower, + isNaN(connectorAmperageLimitationPowerLimit) + ? Infinity + : connectorAmperageLimitationPowerLimit, + isNaN(connectorChargingProfilesPowerLimit) ? Infinity : connectorChargingProfilesPowerLimit + ); + } + public getTransactionIdTag(transactionId: number): string | undefined { for (const connectorId of this.connectors.keys()) { if (connectorId > 0 && this.getConnectorStatus(connectorId).transactionId === transactionId) { @@ -232,27 +307,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 { @@ -266,26 +345,23 @@ export default class ChargingStation { } } - public getEnergyActiveImportRegisterByTransactionId(transactionId: number): number | undefined { - const transactionConnectorStatus = this.getConnectorStatus( - this.getConnectorIdByTransactionId(transactionId) + public getEnergyActiveImportRegisterByTransactionId( + transactionId: number, + rounded = false + ): number { + return this.getEnergyActiveImportRegister( + this.getConnectorStatus(this.getConnectorIdByTransactionId(transactionId)), + rounded ); - if (this.getMeteringPerTransaction()) { - return transactionConnectorStatus?.transactionEnergyActiveImportRegisterValue; - } - return transactionConnectorStatus?.energyActiveImportRegisterValue; } - public getEnergyActiveImportRegisterByConnectorId(connectorId: number): number | undefined { - const connectorStatus = this.getConnectorStatus(connectorId); - if (this.getMeteringPerTransaction()) { - return connectorStatus?.transactionEnergyActiveImportRegisterValue; - } - return connectorStatus?.energyActiveImportRegisterValue; + public getEnergyActiveImportRegisterByConnectorId(connectorId: number, rounded = false): number { + return this.getEnergyActiveImportRegister(this.getConnectorStatus(connectorId), rounded); } public getAuthorizeRemoteTxRequests(): boolean { - const authorizeRemoteTxRequests = this.getConfigurationKey( + const authorizeRemoteTxRequests = ChargingStationConfigurationUtils.getConfigurationKey( + this, StandardParametersKey.AuthorizeRemoteTxRequests ); return authorizeRemoteTxRequests @@ -294,120 +370,39 @@ 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() && this.getHeartbeatInterval() > 0 && !this.heartbeatSetInterval ) { - // eslint-disable-next-line @typescript-eslint/no-misused-promises - this.heartbeatSetInterval = setInterval(async (): Promise => { - await this.ocppRequestService.sendMessageHandler(RequestCommand.HEARTBEAT); + this.heartbeatSetInterval = setInterval(() => { + this.ocppRequestService + .requestHandler(this, RequestCommand.HEARTBEAT) + .catch((error) => { + logger.error( + `${this.logPrefix()} Error while sending '${RequestCommand.HEARTBEAT}':`, + error + ); + }); }, this.getHeartbeatInterval()); logger.info( - this.logPrefix() + - ' Heartbeat started every ' + - Utils.formatDurationMilliSeconds(this.getHeartbeatInterval()) + `${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()) + `${this.logPrefix()} Heartbeat already started every ${Utils.formatDurationMilliSeconds( + this.getHeartbeatInterval() + )}` ); } else { logger.error( @@ -427,6 +422,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( @@ -440,13 +442,13 @@ export default class ChargingStation { ); return; } - if (!this.getConnectorStatus(connectorId)?.transactionStarted) { + if (this.getConnectorStatus(connectorId)?.transactionStarted === false) { 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)?.transactionStarted === true && !this.getConnectorStatus(connectorId)?.transactionId ) { logger.error( @@ -455,25 +457,31 @@ export default class ChargingStation { return; } if (interval > 0) { - // eslint-disable-next-line @typescript-eslint/no-misused-promises - 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.getConnectorStatus(connectorId).transactionSetInterval = setInterval(() => { + // FIXME: Implement OCPP version agnostic helpers + const meterValue: MeterValue = OCPP16ServiceUtils.buildMeterValue( + this, + connectorId, + this.getConnectorStatus(connectorId).transactionId, + interval + ); + this.ocppRequestService + .requestHandler( this, - connectorId, - this.getConnectorStatus(connectorId).transactionId, - interval - ); - await this.ocppRequestService.sendMessageHandler(RequestCommand.METER_VALUES, { - connectorId, - transactionId: this.getConnectorStatus(connectorId).transactionId, - meterValue: [meterValue], + RequestCommand.METER_VALUES, + { + connectorId, + transactionId: this.getConnectorStatus(connectorId).transactionId, + meterValue: [meterValue], + } + ) + .catch((error) => { + logger.error( + `${this.logPrefix()} Error while sending '${RequestCommand.METER_VALUES}':`, + error + ); }); - }, - interval - ); + }, interval); } else { logger.error( `${this.logPrefix()} Charging station ${ @@ -486,56 +494,180 @@ export default class ChargingStation { } public start(): void { - if (this.getEnableStatistics()) { - this.performanceStatistics.start(); - } - this.openWSConnection(); - // Monitor authorization file - 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(); + if (this.started === false) { + if (this.starting === false) { + this.starting = true; + if (this.getEnableStatistics() === true) { + this.performanceStatistics.start(); + } + this.openWSConnection(); + // Monitor charging station template file + this.templateFileWatcher = FileUtils.watchJsonFile( + this.logPrefix(), + FileType.ChargingStationTemplate, + this.templateFile, + null, + (event, filename): void => { + if (filename && event === 'change') { + try { + logger.debug( + `${this.logPrefix()} ${FileType.ChargingStationTemplate} ${ + this.templateFile + } file have changed, reload` + ); + this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash); + // Initialize + this.initialize(); + // Restart the ATG + this.stopAutomaticTransactionGenerator(); + if ( + this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable === true + ) { + this.startAutomaticTransactionGenerator(); + } + if (this.getEnableStatistics() === true) { + 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:`, + error + ); + } } - // 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 - ); } + ); + this.started = true; + parentPort.postMessage(MessageChannelUtils.buildStartedMessage(this)); + this.starting = false; + } else { + logger.warn(`${this.logPrefix()} Charging station is already starting...`); + } + } else { + logger.warn(`${this.logPrefix()} Charging station is already started...`); + } + } + + public async stop(reason?: StopTransactionReason): Promise { + if (this.started === true) { + if (this.stopping === false) { + this.stopping = true; + await this.stopMessageSequence(reason); + this.closeWSConnection(); + if (this.getEnableStatistics() === true) { + this.performanceStatistics.stop(); } + this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash); + this.templateFileWatcher.close(); + this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash); + this.bootNotificationResponse = null; + this.started = false; + parentPort.postMessage(MessageChannelUtils.buildStoppedMessage(this)); + this.stopping = false; + } else { + logger.warn(`${this.logPrefix()} Charging station is already stopping...`); } + } else { + logger.warn(`${this.logPrefix()} Charging station is already stopped...`); + } + } + + public async reset(reason?: StopTransactionReason): Promise { + await this.stop(reason); + await Utils.sleep(this.stationInfo.resetTime); + this.initialize(); + this.start(); + } + + public saveOcppConfiguration(): void { + if (this.getOcppPersistentConfiguration()) { + this.saveConfiguration(); + } + } + + public resetConnectorStatus(connectorId: number): void { + this.getConnectorStatus(connectorId).idTagLocalAuthorized = false; + this.getConnectorStatus(connectorId).idTagAuthorized = false; + this.getConnectorStatus(connectorId).transactionRemoteStarted = false; + this.getConnectorStatus(connectorId).transactionStarted = false; + delete this.getConnectorStatus(connectorId).localAuthorizeIdTag; + delete this.getConnectorStatus(connectorId).authorizeIdTag; + delete this.getConnectorStatus(connectorId).transactionId; + delete this.getConnectorStatus(connectorId).transactionIdTag; + this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue = 0; + delete this.getConnectorStatus(connectorId).transactionBeginMeterValue; + this.stopMeterValues(connectorId); + parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this)); + } + + public hasFeatureProfile(featureProfile: SupportedFeatureProfiles): boolean { + return ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.SupportedFeatureProfiles + )?.value.includes(featureProfile); + } + + public bufferMessage(message: string): void { + this.messageBuffer.add(message); + } + + public openWSConnection( + options: WsOptions = this.stationInfo?.wsOptions ?? {}, + params: { closeOpened?: boolean; terminateOpened?: boolean } = { + closeOpened: false, + terminateOpened: false, + } + ): void { + options.handshakeTimeout = options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000; + params.closeOpened = params?.closeOpened ?? false; + params.terminateOpened = params?.terminateOpened ?? false; + if (this.started === false && this.starting === false) { + logger.warn( + `${this.logPrefix()} Cannot open OCPP connection to URL ${this.wsConnectionUrl.toString()} on stopped charging station` + ); + return; + } + if ( + !Utils.isNullOrUndefined(this.stationInfo.supervisionUser) && + !Utils.isNullOrUndefined(this.stationInfo.supervisionPassword) + ) { + options.auth = `${this.stationInfo.supervisionUser}:${this.stationInfo.supervisionPassword}`; + } + if (params?.closeOpened) { + this.closeWSConnection(); + } + if (params?.terminateOpened) { + this.terminateWSConnection(); + } + const ocppVersion = this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16; + let protocol: string; + switch (ocppVersion) { + case OCPPVersion.VERSION_16: + case OCPPVersion.VERSION_20: + case OCPPVersion.VERSION_201: + protocol = `ocpp${ocppVersion}`; + break; + default: + this.handleUnsupportedVersion(ocppVersion); + break; + } + + if (this.isWebSocketConnectionOpened() === true) { + logger.warn( + `${this.logPrefix()} OCPP connection to URL ${this.wsConnectionUrl.toString()} is already opened` + ); + return; + } + + logger.info( + `${this.logPrefix()} Open OCPP connection to URL ${this.wsConnectionUrl.toString()}` ); + + this.wsConnection = new WebSocket(this.wsConnectionUrl, protocol, options); + // Handle WebSocket message this.wsConnection.on( 'message', @@ -557,168 +689,100 @@ export default class ChargingStation { 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 }, - }); } - public async stop(reason: StopTransactionReason = StopTransactionReason.NONE): Promise { - // Stop message sequence - 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, - }); - this.getConnectorStatus(connectorId).status = ChargePointStatus.UNAVAILABLE; - } - } - if (this.isWebSocketConnectionOpened()) { + public closeWSConnection(): void { + if (this.isWebSocketConnectionOpened() === true) { this.wsConnection.close(); + this.wsConnection = null; } - if (this.getEnableStatistics()) { - this.performanceStatistics.stop(); - } - this.bootNotificationResponse = null; - parentPort.postMessage({ - id: ChargingStationWorkerMessageEvents.STOPPED, - data: { id: this.stationInfo.chargingStationId }, - }); - this.stopped = true; } - public getConfigurationKey( - key: string | StandardParametersKey, - caseInsensitive = false - ): ConfigurationKey | undefined { - return this.configuration.configurationKey.find((configElement) => { - if (caseInsensitive) { - return configElement.key.toLowerCase() === key.toLowerCase(); - } - return configElement.key === 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 } + public startAutomaticTransactionGenerator( + connectorIds?: number[], + automaticTransactionGeneratorConfiguration?: AutomaticTransactionGeneratorConfiguration ): 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, - readonly, - value, - visible, - reboot, - }); - params?.save && this.saveConfiguration(); + this.automaticTransactionGenerator = AutomaticTransactionGenerator.getInstance( + automaticTransactionGeneratorConfiguration ?? + this.getAutomaticTransactionGeneratorConfigurationFromTemplate(), + this + ); + if (!Utils.isEmptyArray(connectorIds)) { + for (const connectorId of connectorIds) { + this.automaticTransactionGenerator.startConnector(connectorId); + } } else { - logger.error( - `${this.logPrefix()} Trying to add an already existing configuration key: %j`, - keyFound - ); + this.automaticTransactionGenerator.start(); } + parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this)); } - 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(); + public stopAutomaticTransactionGenerator(connectorIds?: number[]): void { + if (!Utils.isEmptyArray(connectorIds)) { + for (const connectorId of connectorIds) { + this.automaticTransactionGenerator?.stopConnector(connectorId); + } } else { - logger.error( - `${this.logPrefix()} Trying to set a value on a non existing configuration key: %j`, - { key, value } - ); + this.automaticTransactionGenerator?.stop(); } + parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this)); } - 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 + public async stopTransactionOnConnector( + connectorId: number, + reason = StopTransactionReason.NONE + ): Promise { + const transactionId = this.getConnectorStatus(connectorId).transactionId; + if ( + this.getBeginEndMeterValues() === true && + this.getOcppStrictCompliance() === true && + this.getOutOfOrderEndMeterValues() === false + ) { + // FIXME: Implement OCPP version agnostic helpers + const transactionEndMeterValue = OCPP16ServiceUtils.buildTransactionEndMeterValue( + this, + connectorId, + this.getEnergyActiveImportRegisterByTransactionId(transactionId) ); - 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; - } + await this.ocppRequestService.requestHandler( + this, + RequestCommand.METER_VALUES, + { + connectorId, + transactionId, + meterValue: [transactionEndMeterValue], } ); } - !cpReplaced && this.getConnectorStatus(connectorId).chargingProfiles?.push(cp); - } - - public resetConnectorStatus(connectorId: number): void { - this.getConnectorStatus(connectorId).idTagLocalAuthorized = false; - this.getConnectorStatus(connectorId).idTagAuthorized = false; - this.getConnectorStatus(connectorId).transactionRemoteStarted = false; - this.getConnectorStatus(connectorId).transactionStarted = false; - delete this.getConnectorStatus(connectorId).localAuthorizeIdTag; - delete this.getConnectorStatus(connectorId).authorizeIdTag; - delete this.getConnectorStatus(connectorId).transactionId; - delete this.getConnectorStatus(connectorId).transactionIdTag; - this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue = 0; - delete this.getConnectorStatus(connectorId).transactionBeginMeterValue; - this.stopMeterValues(connectorId); - } - - public bufferMessage(message: string): void { - this.messageBuffer.add(message); + return this.ocppRequestService.requestHandler( + this, + RequestCommand.STOP_TRANSACTION, + { + transactionId, + meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId, true), + reason, + } + ); } - private flushMessageBuffer() { + private flushMessageBuffer(): void { if (this.messageBuffer.size > 0) { this.messageBuffer.forEach((message) => { - // TODO: evaluate the need to track performance + let beginId: string; + let commandName: RequestCommand; + const [messageType] = JSON.parse(message) as OutgoingRequest | Response | ErrorResponse; + const isRequest = messageType === MessageType.CALL_MESSAGE; + if (isRequest) { + [, , commandName] = JSON.parse(message) as OutgoingRequest; + beginId = PerformanceStatistics.beginMeasure(commandName); + } this.wsConnection.send(message); + isRequest && PerformanceStatistics.endMeasure(commandName, beginId); + logger.debug( + `${this.logPrefix()} >> Buffered ${OCPPServiceUtils.getMessageTypeString( + messageType + )} payload sent: ${message}` + ); this.messageBuffer.delete(message); }); } @@ -732,268 +796,355 @@ 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 buildStationInfo(): ChargingStationInfo { - let stationTemplateFromFile: ChargingStationTemplate; + private getTemplateFromFile(): ChargingStationTemplate | null { + let template: ChargingStationTemplate = null; try { - // Load template file - stationTemplateFromFile = JSON.parse( - fs.readFileSync(this.stationTemplateFile, 'utf8') - ) as ChargingStationTemplate; + if (this.sharedLRUCache.hasChargingStationTemplate(this.stationInfo?.templateHash)) { + template = this.sharedLRUCache.getChargingStationTemplate(this.stationInfo.templateHash); + } else { + 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'); + this.sharedLRUCache.setChargingStationTemplate(template); + } } catch (error) { FileUtils.handleFileException( this.logPrefix(), FileType.ChargingStationTemplate, - this.stationTemplateFile, + this.templateFile, error as NodeJS.ErrnoException ); } - const chargingStationId = this.getChargingStationId(stationTemplateFromFile); + return template; + } + + private getStationInfoFromTemplate(): ChargingStationInfo { + const stationTemplate: ChargingStationTemplate = this.getTemplateFromFile(); + if (Utils.isNullOrUndefined(stationTemplate)) { + const errorMsg = `Failed to read charging station template file ${this.templateFile}`; + logger.error(`${this.logPrefix()} ${errorMsg}`); + throw new BaseError(errorMsg); + } + if (Utils.isEmptyObject(stationTemplate)) { + const errorMsg = `Empty charging station information from template file ${this.templateFile}`; + logger.error(`${this.logPrefix()} ${errorMsg}`); + throw new BaseError(errorMsg); + } // Deprecation template keys section - this.warnDeprecatedTemplateKey( - stationTemplateFromFile, + ChargingStationUtils.warnDeprecatedTemplateKey( + stationTemplate, 'supervisionUrl', - chargingStationId, + this.templateFile, + this.logPrefix(), "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]; + ChargingStationUtils.convertDeprecatedTemplateKey( + stationTemplate, + 'supervisionUrl', + 'supervisionUrls' + ); + const stationInfo: ChargingStationInfo = + ChargingStationUtils.stationTemplateToStationInfo(stationTemplate); + stationInfo.hashId = ChargingStationUtils.getHashId(this.index, stationTemplate); + stationInfo.chargingStationId = ChargingStationUtils.getChargingStationId( + this.index, + stationTemplate + ); + stationInfo.ocppVersion = stationTemplate.ocppVersion ?? OCPPVersion.VERSION_16; + ChargingStationUtils.createSerialNumber(stationTemplate, stationInfo); + if (!Utils.isEmptyArray(stationTemplate.power)) { + stationTemplate.power = stationTemplate.power as number[]; + const powerArrayRandomIndex = Math.floor(Utils.secureRandom() * stationTemplate.power.length); + stationInfo.maximumPower = + stationTemplate.powerUnit === PowerUnits.KILO_WATT + ? stationTemplate.power[powerArrayRandomIndex] * 1000 + : stationTemplate.power[powerArrayRandomIndex]; } else { - stationTemplateFromFile.power = stationTemplateFromFile.power as number; - stationInfo.maxPower = - stationTemplateFromFile.powerUnit === PowerUnits.KILO_WATT - ? stationTemplateFromFile.power * 1000 - : stationTemplateFromFile.power; - } - delete stationInfo.power; - delete stationInfo.powerUnit; - stationInfo.chargingStationId = chargingStationId; - stationInfo.resetTime = stationTemplateFromFile.resetTime - ? stationTemplateFromFile.resetTime * 1000 + stationTemplate.power = stationTemplate.power as number; + stationInfo.maximumPower = + stationTemplate.powerUnit === PowerUnits.KILO_WATT + ? stationTemplate.power * 1000 + : stationTemplate.power; + } + stationInfo.firmwareVersionPattern = + stationTemplate.firmwareVersionPattern ?? Constants.SEMVER_PATTERN; + if ( + stationInfo.firmwareVersion && + new RegExp(stationInfo.firmwareVersionPattern).test(stationInfo.firmwareVersion) === false + ) { + logger.warn( + `${this.logPrefix()} Firmware version '${stationInfo.firmwareVersion}' in template file ${ + this.templateFile + } does not match firmware version pattern '${stationInfo.firmwareVersionPattern}'` + ); + } + stationInfo.firmwareUpgrade = merge( + { + reset: true, + }, + stationTemplate.firmwareUpgrade ?? {} + ); + stationInfo.resetTime = stationTemplate.resetTime + ? stationTemplate.resetTime * 1000 : Constants.CHARGING_STATION_DEFAULT_RESET_TIME; + const configuredMaxConnectors = + ChargingStationUtils.getConfiguredNumberOfConnectors(stationTemplate); + ChargingStationUtils.checkConfiguredMaxConnectors( + configuredMaxConnectors, + this.templateFile, + this.logPrefix() + ); + const templateMaxConnectors = + ChargingStationUtils.getTemplateMaxNumberOfConnectors(stationTemplate); + ChargingStationUtils.checkTemplateMaxConnectors( + templateMaxConnectors, + this.templateFile, + this.logPrefix() + ); + if ( + configuredMaxConnectors > + (stationTemplate?.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) && + !stationTemplate?.randomConnectors + ) { + logger.warn( + `${this.logPrefix()} Number of connectors exceeds the number of connector configurations in template ${ + this.templateFile + }, forcing random connector configurations affectation` + ); + stationInfo.randomConnectors = true; + } + // Build connectors if needed (FIXME: should be factored out) + this.initializeConnectors(stationInfo, configuredMaxConnectors, templateMaxConnectors); + stationInfo.maximumAmperage = this.getMaximumAmperage(stationInfo); + ChargingStationUtils.createStationInfoHash(stationInfo); return stationInfo; } - private getOcppVersion(): OCPPVersion { - return this.stationInfo.ocppVersion ? this.stationInfo.ocppVersion : OCPPVersion.VERSION_16; + private getStationInfoFromFile(): ChargingStationInfo | null { + let stationInfo: ChargingStationInfo = null; + this.getStationInfoPersistentConfiguration() && + (stationInfo = this.getConfigurationFromFile()?.stationInfo ?? null); + stationInfo && ChargingStationUtils.createStationInfoHash(stationInfo); + return stationInfo; + } + + private getStationInfo(): ChargingStationInfo { + const stationInfoFromTemplate: ChargingStationInfo = this.getStationInfoFromTemplate(); + const stationInfoFromFile: ChargingStationInfo = this.getStationInfoFromFile(); + // 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; + } + stationInfoFromFile && + ChargingStationUtils.propagateSerialNumber( + this.getTemplateFromFile(), + stationInfoFromFile, + stationInfoFromTemplate + ); + return stationInfoFromTemplate; + } + + private saveStationInfo(): void { + if (this.getStationInfoPersistentConfiguration()) { + this.saveConfiguration(); + } } 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) { - const errMsg = `${this.logPrefix()} Unsupported protocol version '${version}' configured in template file ${ - this.stationTemplateFile - }`; - logger.error(errMsg); - throw new Error(errMsg); + const errMsg = `Unsupported protocol version '${version}' configured in template file ${this.templateFile}`; + logger.error(`${this.logPrefix()} ${errMsg}`); + throw new BaseError(errMsg); } private initialize(): void { - this.stationInfo = this.buildStationInfo(); this.configurationFile = path.join( - path.resolve(__dirname, '../'), - 'assets/configurations', - this.stationInfo.chargingStationId + '.json' + path.dirname(this.templateFile.replace('station-templates', 'configurations')), + `${ChargingStationUtils.getHashId(this.index, this.getTemplateFromFile())}.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, - }), - }; - // Build connectors if needed - const maxConnectors = this.getMaxNumberOfConnectors(); - if (maxConnectors <= 0) { - 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` - ); - } - if (!this.stationInfo.Connectors[0]) { - 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` + this.stationInfo = this.getStationInfo(); + this.saveStationInfo(); + // Avoid duplication of connectors related information in RAM + this.stationInfo?.Connectors && delete this.stationInfo.Connectors; + this.configuredSupervisionUrl = this.getConfiguredSupervisionUrl(); + if (this.getEnableStatistics() === true) { + this.performanceStatistics = PerformanceStatistics.getInstance( + this.stationInfo.hashId, + this.stationInfo.chargingStationId, + this.configuredSupervisionUrl ); - 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; - 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.wsConfiguredConnectionUrl = new URL( - this.getConfiguredSupervisionUrl().href + '/' + this.stationInfo.chargingStationId + this.bootNotificationRequest = ChargingStationUtils.createBootNotificationRequest( + this.stationInfo ); - switch (this.getOcppVersion()) { + this.powerDivider = this.getPowerDivider(); + // OCPP configuration + this.ocppConfiguration = this.getOcppConfiguration(); + this.initializeOcppConfiguration(); + const ocppVersion = this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16; + switch (ocppVersion) { case OCPPVersion.VERSION_16: this.ocppIncomingRequestService = - OCPP16IncomingRequestService.getInstance(this); + OCPP16IncomingRequestService.getInstance(); this.ocppRequestService = OCPP16RequestService.getInstance( - this, - OCPP16ResponseService.getInstance(this) + OCPP16ResponseService.getInstance() + ); + break; + case OCPPVersion.VERSION_20: + case OCPPVersion.VERSION_201: + this.ocppIncomingRequestService = + OCPP20IncomingRequestService.getInstance(); + this.ocppRequestService = OCPP20RequestService.getInstance( + OCPP20ResponseService.getInstance() ); break; default: - this.handleUnsupportedVersion(this.getOcppVersion()); + this.handleUnsupportedVersion(ocppVersion); break; } - // OCPP parameters - this.initOcppParameters(); - if (this.stationInfo.autoRegister) { + if (this.stationInfo?.autoRegister === true) { this.bootNotificationResponse = { - currentTime: new Date().toISOString(), + currentTime: new Date(), interval: this.getHeartbeatInterval() / 1000, - status: RegistrationStatus.ACCEPTED, + status: RegistrationStatusEnumType.ACCEPTED, }; } - this.stationInfo.powerDivider = this.getPowerDivider(); - if (this.getEnableStatistics()) { - this.performanceStatistics = PerformanceStatistics.getInstance( - this.id, - this.stationInfo.chargingStationId, - this.wsConnectionUrl + if ( + this.stationInfo.firmwareStatus === FirmwareStatus.Installing && + this.stationInfo.firmwareVersion && + this.stationInfo.firmwareVersionPattern + ) { + const versionStep = this.stationInfo.firmwareUpgrade?.versionUpgrade?.step ?? 1; + const patternGroup: number = + this.stationInfo.firmwareUpgrade?.versionUpgrade?.patternGroup ?? + this.stationInfo.firmwareVersion.split('.').length; + const match = this.stationInfo.firmwareVersion + .match(new RegExp(this.stationInfo.firmwareVersionPattern)) + .slice(1, patternGroup + 1); + const patchLevelIndex = match.length - 1; + match[patchLevelIndex] = ( + Utils.convertToInt(match[patchLevelIndex]) + versionStep + ).toString(); + this.stationInfo.firmwareVersion = match.join('.'); + } + } + + 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 } ); } - } - - private initOcppParameters(): void { if ( this.getSupervisionUrlOcppConfiguration() && - !this.getConfigurationKey(this.getSupervisionUrlOcppKey()) + !ChargingStationConfigurationUtils.getConfigurationKey(this, this.getSupervisionUrlOcppKey()) ) { - this.addConfigurationKey( + ChargingStationConfigurationUtils.addConfigurationKey( + this, this.getSupervisionUrlOcppKey(), - this.getConfiguredSupervisionUrl().href, + this.configuredSupervisionUrl.href, { reboot: true } ); } else if ( !this.getSupervisionUrlOcppConfiguration() && - this.getConfigurationKey(this.getSupervisionUrlOcppKey()) + ChargingStationConfigurationUtils.getConfigurationKey(this, this.getSupervisionUrlOcppKey()) + ) { + ChargingStationConfigurationUtils.deleteConfigurationKey( + this, + this.getSupervisionUrlOcppKey(), + { save: false } + ); + } + if ( + this.stationInfo.amperageLimitationOcppKey && + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + this.stationInfo.amperageLimitationOcppKey + ) ) { - this.deleteConfigurationKey(this.getSupervisionUrlOcppKey(), { save: false }); + ChargingStationConfigurationUtils.addConfigurationKey( + this, + this.stationInfo.amperageLimitationOcppKey, + ( + this.stationInfo.maximumAmperage * + ChargingStationUtils.getAmperageLimitationUnitDivider(this.stationInfo) + ).toString() + ); } - if (!this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles)) { - this.addConfigurationKey( + 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 @@ -1008,46 +1159,177 @@ 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 ( + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.LocalAuthListEnabled + ) && + ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.SupportedFeatureProfiles + )?.value.includes(SupportedFeatureProfiles.LocalAuthListManagement) + ) { + ChargingStationConfigurationUtils.addConfigurationKey( + this, + StandardParametersKey.LocalAuthListEnabled, + 'false' + ); } - if (!this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) { - this.addConfigurationKey( + if ( + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.ConnectionTimeOut + ) + ) { + ChargingStationConfigurationUtils.addConfigurationKey( + this, StandardParametersKey.ConnectionTimeOut, Constants.DEFAULT_CONNECTION_TIMEOUT.toString() ); } - this.saveConfiguration(); + this.saveOcppConfiguration(); + } + + private initializeConnectors( + stationInfo: ChargingStationInfo, + configuredMaxConnectors: number, + templateMaxConnectors: number + ): void { + if (!stationInfo?.Connectors && this.connectors.size === 0) { + const logMsg = `No already defined connectors and charging station information from template ${this.templateFile} with no connectors configuration defined`; + logger.error(`${this.logPrefix()} ${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) + configuredMaxConnectors.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 connectorStatus = stationInfo?.Connectors[lastConnector]; + const lastConnectorId = Utils.convertToInt(lastConnector); + if ( + lastConnectorId === 0 && + this.getUseConnectorId0(stationInfo) === true && + connectorStatus + ) { + this.checkStationInfoConnectorStatus(lastConnectorId, connectorStatus); + this.connectors.set( + lastConnectorId, + Utils.cloneObject(connectorStatus) + ); + 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 <= configuredMaxConnectors; index++) { + const randConnectorId = stationInfo?.randomConnectors + ? Utils.getRandomInteger(Utils.convertToInt(lastConnector), 1) + : index; + const connectorStatus = stationInfo?.Connectors[randConnectorId.toString()]; + this.checkStationInfoConnectorStatus(randConnectorId, connectorStatus); + this.connectors.set(index, Utils.cloneObject(connectorStatus)); + 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 === true) { + logger.warn( + `${this.logPrefix()} Connector ${connectorId} at initialization has a transaction started: ${ + this.getConnectorStatus(connectorId).transactionId + }` + ); + } + if ( + connectorId > 0 && + (this.getConnectorStatus(connectorId).transactionStarted === undefined || + this.getConnectorStatus(connectorId).transactionStarted === null) + ) { + this.initializeConnectorStatus(connectorId); + } + } } - private getConfigurationFromTemplate(): ChargingStationConfiguration { - return this.stationInfo.Configuration ?? ({} as ChargingStationConfiguration); + private checkStationInfoConnectorStatus( + connectorId: number, + connectorStatus: ConnectorStatus + ): void { + if (!Utils.isNullOrUndefined(connectorStatus?.status)) { + logger.warn( + `${this.logPrefix()} Charging station information from template ${ + this.templateFile + } with connector ${connectorId} status configuration defined, undefine it` + ); + connectorStatus.status = undefined; + } } private getConfigurationFromFile(): ChargingStationConfiguration | null { let configuration: ChargingStationConfiguration = null; - if ( - this.getOcppPersistentConfiguration() && - this.configurationFile && - fs.existsSync(this.configurationFile) - ) { + if (this.configurationFile && fs.existsSync(this.configurationFile)) { try { - configuration = JSON.parse( - fs.readFileSync(this.configurationFile, 'utf8') - ) as ChargingStationConfiguration; + if (this.sharedLRUCache.hasChargingStationConfiguration(this.configurationFileHash)) { + configuration = this.sharedLRUCache.getChargingStationConfiguration( + this.configurationFileHash + ); + } else { + const measureId = `${FileType.ChargingStationConfiguration} read`; + const beginId = PerformanceStatistics.beginMeasure(measureId); + configuration = JSON.parse( + fs.readFileSync(this.configurationFile, 'utf8') + ) as ChargingStationConfiguration; + PerformanceStatistics.endMeasure(measureId, beginId); + this.configurationFileHash = configuration.configurationHash; + this.sharedLRUCache.setChargingStationConfiguration(configuration); + } } catch (error) { FileUtils.handleFileException( this.logPrefix(), @@ -1061,92 +1343,125 @@ export default class ChargingStation { } 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 }); - } + if (this.configurationFile) { + try { + if (!fs.existsSync(path.dirname(this.configurationFile))) { + fs.mkdirSync(path.dirname(this.configurationFile), { recursive: true }); + } + const configurationData: ChargingStationConfiguration = + this.getConfigurationFromFile() ?? {}; + this.ocppConfiguration?.configurationKey && + (configurationData.configurationKey = this.ocppConfiguration.configurationKey); + this.stationInfo && (configurationData.stationInfo = this.stationInfo); + delete configurationData.configurationHash; + const configurationHash = crypto + .createHash(Constants.DEFAULT_HASH_ALGORITHM) + .update(JSON.stringify(configurationData)) + .digest('hex'); + if (this.configurationFileHash !== configurationHash) { + configurationData.configurationHash = configurationHash; + const measureId = `${FileType.ChargingStationConfiguration} write`; + const beginId = PerformanceStatistics.beginMeasure(measureId); const fileDescriptor = fs.openSync(this.configurationFile, 'w'); - fs.writeFileSync(fileDescriptor, JSON.stringify(this.configuration, null, 2)); + fs.writeFileSync(fileDescriptor, JSON.stringify(configurationData, null, 2), 'utf8'); fs.closeSync(fileDescriptor); - } catch (error) { - FileUtils.handleFileException( - this.logPrefix(), - FileType.ChargingStationConfiguration, - this.configurationFile, - error as NodeJS.ErrnoException + PerformanceStatistics.endMeasure(measureId, beginId); + this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash); + this.configurationFileHash = configurationHash; + this.sharedLRUCache.setChargingStationConfiguration(configurationData); + } else { + logger.debug( + `${this.logPrefix()} Not saving unchanged charging station configuration file ${ + this.configurationFile + }` ); } - } else { - logger.error( - `${this.logPrefix()} Trying to save charging station configuration to undefined file` + } 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 configuration file` + ); } } - private getConfiguration(): ChargingStationConfiguration { - let configuration: ChargingStationConfiguration = this.getConfigurationFromFile(); - if (!configuration) { - configuration = this.getConfigurationFromTemplate(); + private getOcppConfigurationFromTemplate(): ChargingStationOcppConfiguration | null { + return this.getTemplateFromFile()?.Configuration ?? null; + } + + private getOcppConfigurationFromFile(): ChargingStationOcppConfiguration | null { + let configuration: ChargingStationConfiguration = null; + if (this.getOcppPersistentConfiguration() === true) { + const configurationFromFile = this.getConfigurationFromFile(); + configuration = configurationFromFile?.configurationKey && configurationFromFile; } + configuration && delete configuration.stationInfo; return configuration; } + private getOcppConfiguration(): ChargingStationOcppConfiguration | null { + let ocppConfiguration: ChargingStationOcppConfiguration = this.getOcppConfigurationFromFile(); + if (!ocppConfiguration) { + ocppConfiguration = this.getOcppConfigurationFromTemplate(); + } + return 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( - 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.isInAcceptedState() && - (registrationRetryCount <= this.getRegistrationMaxRetries() || - this.getRegistrationMaxRetries() === -1) + if (this.isWebSocketConnectionOpened() === true) { + logger.info( + `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} succeeded` ); - } - if (this.isInAcceptedState()) { - await this.startMessageSequence(); - this.stopped && (this.stopped = false); - if (this.wsConnectionRestarted && this.isWebSocketConnectionOpened()) { - this.flushMessageBuffer(); + if (this.isRegistered() === false) { + // Send BootNotification + let registrationRetryCount = 0; + do { + this.bootNotificationResponse = await this.ocppRequestService.requestHandler< + BootNotificationRequest, + BootNotificationResponse + >(this, RequestCommand.BOOT_NOTIFICATION, this.bootNotificationRequest, { + skipBufferingOnError: true, + }); + if (this.isRegistered() === false) { + this.getRegistrationMaxRetries() !== -1 && registrationRetryCount++; + await Utils.sleep( + this.bootNotificationResponse?.interval + ? this.bootNotificationResponse.interval * 1000 + : Constants.OCPP_DEFAULT_BOOT_NOTIFICATION_INTERVAL + ); + } + } while ( + this.isRegistered() === false && + (registrationRetryCount <= this.getRegistrationMaxRetries() || + this.getRegistrationMaxRetries() === -1) + ); + } + if (this.isRegistered() === true) { + if (this.isInAcceptedState() === true) { + await this.startMessageSequence(); + } + } else { + logger.error( + `${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})` + ); } + this.wsConnectionRestarted = false; + this.autoReconnectRetryCount = 0; + parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this)); } 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 { + private async onClose(code: number, reason: Buffer): Promise { switch (code) { // Normal close case WebSocketCloseEventStatusCode.CLOSE_NORMAL: @@ -1154,7 +1469,7 @@ export default class ChargingStation { logger.info( `${this.logPrefix()} WebSocket normally closed with status '${Utils.getWebSocketCloseEventStatusString( code - )}' and reason '${reason}'` + )}' and reason '${reason.toString()}'` ); this.autoReconnectRetryCount = 0; break; @@ -1163,201 +1478,246 @@ export default class ChargingStation { logger.error( `${this.logPrefix()} WebSocket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString( code - )}' and reason '${reason}'` + )}' and reason '${reason.toString()}'` ); - await this.reconnect(code); + this.started === true && (await this.reconnect()); break; } + parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this)); } - 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; + private async onMessage(data: RawData): Promise { + let messageType: number; + let messageId: string; + let commandName: IncomingRequestCommand; + let commandPayload: JsonType; + let errorType: ErrorType; + let errorMessage: string; + let errorDetails: JsonType; + let responseCallback: ResponseCallback; + let errorCallback: ErrorCallback; 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; - if (Utils.isIterable(request)) { - // Parse the message - [messageType, messageId, commandName, commandPayload, errorDetails] = request; + const request = JSON.parse(data.toString()) as IncomingRequest | Response | ErrorResponse; + if (Array.isArray(request) === true) { + [messageType, messageId] = request; + // Check the type of message + switch (messageType) { + // Incoming Message + case MessageType.CALL_MESSAGE: + [, , commandName, commandPayload] = request as IncomingRequest; + if (this.getEnableStatistics() === true) { + this.performanceStatistics.addRequestStatistic(commandName, messageType); + } + logger.debug( + `${this.logPrefix()} << Command '${commandName}' received request payload: ${JSON.stringify( + request + )}` + ); + // Process the message + await this.ocppIncomingRequestService.incomingRequestHandler( + this, + messageId, + commandName, + commandPayload + ); + break; + // Outcome Message + case MessageType.CALL_RESULT_MESSAGE: + [, , commandPayload] = request as Response; + if (this.requests.has(messageId) === false) { + // Error + throw new OCPPError( + ErrorType.INTERNAL_ERROR, + `Response for unknown message id ${messageId}`, + null, + commandPayload + ); + } + // Respond + cachedRequest = this.requests.get(messageId); + if (Array.isArray(cachedRequest) === true) { + [responseCallback, errorCallback, requestCommandName, requestPayload] = cachedRequest; + } else { + throw new OCPPError( + ErrorType.PROTOCOL_ERROR, + `Cached request for message id ${messageId} response is not an array`, + null, + cachedRequest as unknown as JsonType + ); + } + logger.debug( + `${this.logPrefix()} << Command '${ + requestCommandName ?? Constants.UNKNOWN_COMMAND + }' received response payload: ${JSON.stringify(request)}` + ); + responseCallback(commandPayload, requestPayload); + break; + // Error Message + case MessageType.CALL_ERROR_MESSAGE: + [, , errorType, errorMessage, errorDetails] = request as ErrorResponse; + if (this.requests.has(messageId) === false) { + // Error + throw new OCPPError( + ErrorType.INTERNAL_ERROR, + `Error response for unknown message id ${messageId}`, + null, + { errorType, errorMessage, errorDetails } + ); + } + cachedRequest = this.requests.get(messageId); + if (Array.isArray(cachedRequest) === true) { + [, errorCallback, requestCommandName] = cachedRequest; + } else { + throw new OCPPError( + ErrorType.PROTOCOL_ERROR, + `Cached request for message id ${messageId} error response is not an array`, + null, + cachedRequest as unknown as JsonType + ); + } + logger.debug( + `${this.logPrefix()} << Command '${ + requestCommandName ?? Constants.UNKNOWN_COMMAND + }' received error response payload: ${JSON.stringify(request)}` + ); + errorCallback(new OCPPError(errorType, errorMessage, requestCommandName, errorDetails)); + break; + // Error + default: + // eslint-disable-next-line @typescript-eslint/restrict-template-expressions + errMsg = `Wrong message type ${messageType}`; + logger.error(`${this.logPrefix()} ${errMsg}`); + throw new OCPPError(ErrorType.PROTOCOL_ERROR, errMsg); + } + parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this)); } else { - throw new OCPPError( - ErrorType.PROTOCOL_ERROR, - 'Incoming request is not iterable', - commandName + throw new OCPPError(ErrorType.PROTOCOL_ERROR, 'Incoming message is not an array', null, { + request, + }); + } + } catch (error) { + // Log + logger.error( + `${this.logPrefix()} Incoming OCPP command '${ + commandName ?? requestCommandName ?? Constants.UNKNOWN_COMMAND + }' message '${data.toString()}'${ + messageType !== MessageType.CALL_MESSAGE + ? ` matching cached request '${JSON.stringify(this.requests.get(messageId))}'` + : '' + } processing error:`, + error + ); + if (error instanceof OCPPError === false) { + logger.warn( + `${this.logPrefix()} Error thrown at incoming OCPP command '${ + commandName ?? requestCommandName ?? Constants.UNKNOWN_COMMAND + }' message '${data.toString()}' handling is not an OCPPError:`, + error ); } - // 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( + // Send error + await this.ocppRequestService.sendError( + this, messageId, - commandName, - commandPayload + error as OCPPError, + commandName ?? requestCommandName ?? null ); 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 - ); - } - if (!responseCallback) { - // Error - throw new OCPPError( - ErrorType.INTERNAL_ERROR, - `Response for unknown message id ${messageId}`, - commandName - ); - } - responseCallback(commandName, requestPayload); - break; - // Error Message case MessageType.CALL_ERROR_MESSAGE: - cachedRequest = this.requests.get(messageId); - if (Utils.isIterable(cachedRequest)) { - [, rejectCallback, requestCommandName] = cachedRequest; + if (errorCallback) { + // Reject the deferred promise in case of error at response handling (rejecting an already fulfilled promise is a no-op) + errorCallback(error as OCPPError, false); } else { - 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 - ); + // Remove the request from the cache in case of error at response handling + this.requests.delete(messageId); } - 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 - ); - // Send error - messageType === MessageType.CALL_MESSAGE && - (await this.ocppRequestService.sendError(messageId, error as OCPPError, commandName)); } } private onPing(): void { - logger.debug(this.logPrefix() + ' Received a WS ping (rfc6455) from the server'); + logger.debug(`${this.logPrefix()} Received a WS ping (rfc6455) from the server`); } private onPong(): void { - logger.debug(this.logPrefix() + ' Received a WS pong (rfc6455) from the server'); + logger.debug(`${this.logPrefix()} Received a WS pong (rfc6455) from the server`); } private onError(error: WSError): void { - logger.error(this.logPrefix() + ' WebSocket error: %j', error); - } - - private getAuthorizationFile(): string | undefined { - return ( - this.stationInfo.authorizationFile && - path.join( - path.resolve(__dirname, '../'), - 'assets', - path.basename(this.stationInfo.authorizationFile) - ) - ); + this.closeWSConnection(); + logger.error(`${this.logPrefix()} WebSocket error:`, error); } - private getAuthorizedTags(): string[] { - let authorizedTags: string[] = []; - const authorizationFile = this.getAuthorizationFile(); - if (authorizationFile) { - try { - // Load authorization file - authorizedTags = JSON.parse(fs.readFileSync(authorizationFile, 'utf8')) as string[]; - } catch (error) { - 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 + private getEnergyActiveImportRegister(connectorStatus: ConnectorStatus, rounded = false): number { + if (this.getMeteringPerTransaction() === true) { + return ( + (rounded === true + ? Math.round(connectorStatus?.transactionEnergyActiveImportRegisterValue) + : connectorStatus?.transactionEnergyActiveImportRegisterValue) ?? 0 ); } - return authorizedTags; + return ( + (rounded === true + ? Math.round(connectorStatus?.energyActiveImportRegisterValue) + : connectorStatus?.energyActiveImportRegisterValue) ?? 0 + ); } - private getUseConnectorId0(): boolean | undefined { - return !Utils.isUndefined(this.stationInfo.useConnectorId0) - ? this.stationInfo.useConnectorId0 + private getUseConnectorId0(stationInfo?: ChargingStationInfo): boolean { + const localStationInfo = stationInfo ?? this.stationInfo; + return !Utils.isUndefined(localStationInfo.useConnectorId0) + ? localStationInfo.useConnectorId0 : true; } private getNumberOfRunningTransactions(): number { let trxCount = 0; for (const connectorId of this.connectors.keys()) { - if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted) { + if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted === true) { trxCount++; } } return trxCount; } + private async stopRunningTransactions(reason = StopTransactionReason.NONE): Promise { + for (const connectorId of this.connectors.keys()) { + if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted === true) { + await this.stopTransactionOnConnector(connectorId, reason); + } + } + } + // 0 for disabling - private getConnectionTimeout(): number | undefined { - if (this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) { + private getConnectionTimeout(): number { + 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; } // -1 for unlimited, 0 for disabling - private getAutoReconnectMaxRetries(): number | undefined { + private getAutoReconnectMaxRetries(): number { if (!Utils.isUndefined(this.stationInfo.autoReconnectMaxRetries)) { return this.stationInfo.autoReconnectMaxRetries; } @@ -1368,7 +1728,7 @@ export default class ChargingStation { } // 0 for disabling - private getRegistrationMaxRetries(): number | undefined { + private getRegistrationMaxRetries(): number { if (!Utils.isUndefined(this.stationInfo.registrationMaxRetries)) { return this.stationInfo.registrationMaxRetries; } @@ -1377,49 +1737,53 @@ export default class ChargingStation { private getPowerDivider(): number { let powerDivider = this.getNumberOfConnectors(); - if (this.stationInfo.powerSharedByConnectors) { + if (this.stationInfo?.powerSharedByConnectors) { powerDivider = this.getNumberOfRunningTransactions(); } return powerDivider; } - private getTemplateMaxNumberOfConnectors(): number { - return Object.keys(this.stationInfo.Connectors).length; + private getMaximumAmperage(stationInfo: ChargingStationInfo): number | undefined { + const maximumPower = this.getMaximumPower(stationInfo); + switch (this.getCurrentOutType(stationInfo)) { + case CurrentType.AC: + return ACElectricUtils.amperagePerPhaseFromPower( + this.getNumberOfPhases(stationInfo), + maximumPower / this.getNumberOfConnectors(), + this.getVoltageOut(stationInfo) + ); + case CurrentType.DC: + return DCElectricUtils.amperage(maximumPower, this.getVoltageOut(stationInfo)); + } } - private getMaxNumberOfConnectors(): number { - let maxConnectors: number; - if (!Utils.isEmptyArray(this.stationInfo.numberOfConnectors)) { - const numberOfConnectors = this.stationInfo.numberOfConnectors as number[]; - // Distribute evenly the number of connectors - maxConnectors = numberOfConnectors[(this.index - 1) % numberOfConnectors.length]; - } else if (!Utils.isUndefined(this.stationInfo.numberOfConnectors)) { - maxConnectors = this.stationInfo.numberOfConnectors as number; - } else { - maxConnectors = this.stationInfo.Connectors[0] - ? this.getTemplateMaxNumberOfConnectors() - 1 - : this.getTemplateMaxNumberOfConnectors(); + 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) + ); } - 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 } - ); + if (this.stationInfo?.autoRegister === true) { + await this.ocppRequestService.requestHandler< + BootNotificationRequest, + BootNotificationResponse + >(this, RequestCommand.BOOT_NOTIFICATION, this.bootNotificationRequest, { + skipBufferingOnError: true, + }); } // Start WebSocket ping this.startWebSocketPing(); @@ -1427,64 +1791,53 @@ export default class ChargingStation { this.startHeartbeat(); // Initialize connectors status for (const connectorId of this.connectors.keys()) { + let connectorStatus: ConnectorStatusEnum; if (connectorId === 0) { continue; } else if ( - !this.stopped && !this.getConnectorStatus(connectorId)?.status && - this.getConnectorStatus(connectorId)?.bootStatus + (this.isChargingStationAvailable() === false || + this.isConnectorAvailable(connectorId) === false) ) { - // Send status in template at startup - 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; + connectorStatus = ConnectorStatusEnum.UNAVAILABLE; } else if ( - this.stopped && - this.getConnectorStatus(connectorId)?.status && + !this.getConnectorStatus(connectorId)?.status && 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, - }); - 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, - }); + // Set boot status in template at startup + connectorStatus = this.getConnectorStatus(connectorId).bootStatus; + } else if (this.getConnectorStatus(connectorId)?.status) { + // Set previous status at startup + connectorStatus = this.getConnectorStatus(connectorId).status; } else { - // Send default status - await this.ocppRequestService.sendMessageHandler(RequestCommand.STATUS_NOTIFICATION, { - connectorId, - status: ChargePointStatus.AVAILABLE, - errorCode: ChargePointErrorCode.NO_ERROR, - }); - this.getConnectorStatus(connectorId).status = ChargePointStatus.AVAILABLE; + // Set default status + connectorStatus = ConnectorStatusEnum.AVAILABLE; } + await this.ocppRequestService.requestHandler< + StatusNotificationRequest, + StatusNotificationResponse + >( + this, + RequestCommand.STATUS_NOTIFICATION, + OCPPServiceUtils.buildStatusNotificationRequest(this, connectorId, connectorStatus) + ); + this.getConnectorStatus(connectorId).status = connectorStatus; + } + if (this.stationInfo?.firmwareStatus === FirmwareStatus.Installing) { + await this.ocppRequestService.requestHandler< + FirmwareStatusNotificationRequest, + FirmwareStatusNotificationResponse + >(this, RequestCommand.FIRMWARE_STATUS_NOTIFICATION, { + status: FirmwareStatus.Installed, + }); + this.stationInfo.firmwareStatus = FirmwareStatus.Installed; } - // Start the ATG - this.startAutomaticTransactionGenerator(); - } - private startAutomaticTransactionGenerator() { - if (this.stationInfo.AutomaticTransactionGenerator.enable) { - if (!this.automaticTransactionGenerator) { - this.automaticTransactionGenerator = AutomaticTransactionGenerator.getInstance(this); - } - if (!this.automaticTransactionGenerator.started) { - this.automaticTransactionGenerator.start(); - } + // Start the ATG + if (this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable === true) { + this.startAutomaticTransactionGenerator(); } + this.wsConnectionRestarted === true && this.flushMessageBuffer(); } private async stopMessageSequence( @@ -1494,71 +1847,59 @@ export default class ChargingStation { this.stopWebSocketPing(); // Stop heartbeat this.stopHeartbeat(); - // Stop the ATG - if ( - this.stationInfo.AutomaticTransactionGenerator.enable && - this.automaticTransactionGenerator?.started - ) { - this.automaticTransactionGenerator.stop(); + // Stop ongoing transactions + if (this.automaticTransactionGenerator?.started === true) { + this.stopAutomaticTransactionGenerator(); } else { - for (const connectorId of this.connectors.keys()) { - if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted) { - const transactionId = this.getConnectorStatus(connectorId).transactionId; - 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, - }); - } + await this.stopRunningTransactions(reason); + } + for (const connectorId of this.connectors.keys()) { + if (connectorId > 0) { + await this.ocppRequestService.requestHandler< + StatusNotificationRequest, + StatusNotificationResponse + >( + this, + RequestCommand.STATUS_NOTIFICATION, + OCPPServiceUtils.buildStatusNotificationRequest( + this, + connectorId, + ConnectorStatusEnum.UNAVAILABLE + ) + ); + this.getConnectorStatus(connectorId).status = null; } } } 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) { this.webSocketPingSetInterval = setInterval(() => { - if (this.isWebSocketConnectionOpened()) { - this.wsConnection.ping((): void => { - /* This is intentional */ - }); + if (this.isWebSocketConnectionOpened() === true) { + this.wsConnection.ping(); } }, webSocketPingInterval * 1000); logger.info( - this.logPrefix() + - ' WebSocket ping started every ' + - Utils.formatDurationSeconds(webSocketPingInterval) + `${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' + `${this.logPrefix()} WebSocket ping already started every ${Utils.formatDurationSeconds( + webSocketPingInterval + )}` ); } else { logger.error( @@ -1577,80 +1918,52 @@ 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.supervisionUrls ?? Configuration.getSupervisionUrls() - ); + const supervisionUrls = this.stationInfo.supervisionUrls ?? Configuration.getSupervisionUrls(); if (!Utils.isEmptyArray(supervisionUrls)) { - let urlIndex = 0; switch (Configuration.getSupervisionUrlDistribution()) { case SupervisionUrlDistribution.ROUND_ROBIN: - urlIndex = (this.index - 1) % supervisionUrls.length; + // FIXME + this.configuredSupervisionUrlIndex = (this.index - 1) % supervisionUrls.length; break; case SupervisionUrlDistribution.RANDOM: - // Get a random url - urlIndex = Math.floor(Utils.secureRandom() * supervisionUrls.length); + this.configuredSupervisionUrlIndex = 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` - ); - } + case SupervisionUrlDistribution.CHARGING_STATION_AFFINITY: + this.configuredSupervisionUrlIndex = (this.index - 1) % supervisionUrls.length; break; default: logger.error( `${this.logPrefix()} Unknown supervision url distribution '${Configuration.getSupervisionUrlDistribution()}' from values '${SupervisionUrlDistribution.toString()}', defaulting to ${ - SupervisionUrlDistribution.ROUND_ROBIN + SupervisionUrlDistribution.CHARGING_STATION_AFFINITY }` ); - urlIndex = (this.index - 1) % supervisionUrls.length; + this.configuredSupervisionUrlIndex = (this.index - 1) % supervisionUrls.length; break; } - return new URL(supervisionUrls[urlIndex]); + return new URL(supervisionUrls[this.configuredSupervisionUrlIndex]); } return new URL(supervisionUrls as string); } - private getHeartbeatInterval(): number | undefined { - const HeartbeatInterval = this.getConfigurationKey(StandardParametersKey.HeartbeatInterval); + private getHeartbeatInterval(): number { + 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; } - !this.stationInfo.autoRegister && + this.stationInfo?.autoRegister === false && logger.warn( `${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${ Constants.DEFAULT_HEARTBEAT_INTERVAL @@ -1665,33 +1978,11 @@ export default class ChargingStation { } } - 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) - ) { - options.auth = `${this.stationInfo.supervisionUser}:${this.stationInfo.supervisionPassword}`; - } - if (this.isWebSocketConnectionOpened() && forceCloseOpened) { - this.wsConnection.close(); - } - let protocol: string; - switch (this.getOcppVersion()) { - case OCPPVersion.VERSION_16: - protocol = 'ocpp' + OCPPVersion.VERSION_16; - break; - default: - this.handleUnsupportedVersion(this.getOcppVersion()); - break; + private terminateWSConnection(): void { + if (this.isWebSocketConnectionOpened() === true) { + this.wsConnection.terminate(); + this.wsConnection = null; } - this.wsConnection = new WebSocket(this.wsConnectionUrl, protocol, options); - logger.info( - this.logPrefix() + ' Open OCPP connection to URL ' + this.wsConnectionUrl.toString() - ); } private stopMeterValues(connectorId: number) { @@ -1700,24 +1991,20 @@ export default class ChargingStation { } } - private getReconnectExponentialDelay(): boolean | undefined { + private getReconnectExponentialDelay(): boolean { return !Utils.isUndefined(this.stationInfo.reconnectExponentialDelay) ? this.stationInfo.reconnectExponentialDelay : false; } - private async reconnect(code: number): Promise { + private async reconnect(): Promise { // Stop WebSocket ping this.stopWebSocketPing(); // Stop heartbeat this.stopHeartbeat(); // Stop the ATG if needed - if ( - this.stationInfo.AutomaticTransactionGenerator.enable && - this.stationInfo.AutomaticTransactionGenerator.stopOnConnectionFailure && - this.automaticTransactionGenerator?.started - ) { - this.automaticTransactionGenerator.stop(); + if (this.automaticTransactionGenerator?.configuration?.stopOnConnectionFailure === true) { + this.stopAutomaticTransactionGenerator(); } if ( this.autoReconnectRetryCount < this.getAutoReconnectMaxRetries() || @@ -1727,33 +2014,39 @@ export default class ChargingStation { const reconnectDelay = this.getReconnectExponentialDelay() ? Utils.exponentialDelay(this.autoReconnectRetryCount) : this.getConnectionTimeout() * 1000; - const reconnectTimeout = reconnectDelay - 100 > 0 && reconnectDelay; + const reconnectDelayWithdraw = 1000; + const reconnectTimeout = + reconnectDelay && reconnectDelay - reconnectDelayWithdraw > 0 + ? reconnectDelay - reconnectDelayWithdraw + : 0; logger.error( - `${this.logPrefix()} WebSocket: connection retry in ${Utils.roundTo( + `${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.logPrefix()} WebSocket connection retry #${this.autoReconnectRetryCount.toString()}` ); this.openWSConnection( - { ...this.stationInfo.wsOptions, handshakeTimeout: reconnectTimeout }, - true + { ...(this.stationInfo?.wsOptions ?? {}), handshakeTimeout: reconnectTimeout }, + { closeOpened: true } ); this.wsConnectionRestarted = true; } else if (this.getAutoReconnectMaxRetries() !== -1) { logger.error( - `${this.logPrefix()} WebSocket reconnect failure: max retries reached (${ + `${this.logPrefix()} WebSocket connection retries failure: maximum retries reached (${ this.autoReconnectRetryCount - }) or retry disabled (${this.getAutoReconnectMaxRetries()})` + }) or retries disabled (${this.getAutoReconnectMaxRetries()})` ); } } + private getAutomaticTransactionGeneratorConfigurationFromTemplate(): AutomaticTransactionGeneratorConfiguration | null { + return this.getTemplateFromFile()?.AutomaticTransactionGenerator ?? null; + } + private initializeConnectorStatus(connectorId: number): void { this.getConnectorStatus(connectorId).idTagLocalAuthorized = false; this.getConnectorStatus(connectorId).idTagAuthorized = false;