X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FChargingStation.ts;h=8240e5b0521a1ec80ab093d9646997daed6bbc11;hb=1984f1944eeb7468c2f3adbf03b83fbc98910dff;hp=6900cdc3c67e2ec9a1d83da627fa99262d39c525;hpb=734d790d9983a43c20f9ffa728f18825625e8119;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ChargingStation.ts b/src/charging-station/ChargingStation.ts index 6900cdc3..d7b67e6a 100644 --- a/src/charging-station/ChargingStation.ts +++ b/src/charging-station/ChargingStation.ts @@ -1,121 +1,224 @@ // Partial Copyright Jerome Benoit. 2021. All Rights Reserved. -import { AvailabilityType, BootNotificationRequest, CachedRequest, IncomingRequest, IncomingRequestCommand, RequestCommand } from '../types/ocpp/Requests'; -import { BootNotificationResponse, RegistrationStatus } from '../types/ocpp/Responses'; -import ChargingStationConfiguration, { ConfigurationKey } from '../types/ChargingStationConfiguration'; -import ChargingStationTemplate, { CurrentType, PowerUnits, Voltage } from '../types/ChargingStationTemplate'; -import { ConnectorPhaseRotation, StandardParametersKey, SupportedFeatureProfiles } from '../types/ocpp/Configuration'; -import { ConnectorStatus, SampledValueTemplate } from '../types/Connectors'; -import { MeterValueMeasurand, MeterValuePhase } from '../types/ocpp/MeterValues'; -import { WSError, WebSocketCloseEventStatusCode } from '../types/WebSocket'; -import WebSocket, { ClientOptions, Data, OPEN } from 'ws'; +import crypto from 'crypto'; +import fs from 'fs'; +import path from 'path'; +import { URL } from 'url'; +import { parentPort } from 'worker_threads'; -import AutomaticTransactionGenerator from './AutomaticTransactionGenerator'; +import WebSocket, { Data, RawData } from 'ws'; + +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 ChargingStationTemplate, { + CurrentType, + PowerUnits, + 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 { ChargePointErrorCode } from '../types/ocpp/ChargePointErrorCode'; import { ChargePointStatus } from '../types/ocpp/ChargePointStatus'; -import { ChargingProfile } from '../types/ocpp/ChargingProfile'; -import ChargingStationInfo from '../types/ChargingStationInfo'; -import { ClientRequestArgs } from 'http'; +import { ChargingProfile, ChargingRateUnitType } from '../types/ocpp/ChargingProfile'; +import { + ConnectorPhaseRotation, + StandardParametersKey, + SupportedFeatureProfiles, + VendorDefaultParametersKey, +} from '../types/ocpp/Configuration'; +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, + BootNotificationRequest, + CachedRequest, + HeartbeatRequest, + IncomingRequest, + IncomingRequestCommand, + MeterValuesRequest, + RequestCommand, + StatusNotificationRequest, +} from '../types/ocpp/Requests'; +import { + BootNotificationResponse, + ErrorResponse, + HeartbeatResponse, + MeterValuesResponse, + RegistrationStatus, + Response, + StatusNotificationResponse, +} from '../types/ocpp/Responses'; +import { + StopTransactionReason, + StopTransactionRequest, + StopTransactionResponse, +} from '../types/ocpp/Transaction'; +import { WSError, WebSocketCloseEventStatusCode } from '../types/WebSocket'; import Configuration from '../utils/Configuration'; import Constants from '../utils/Constants'; -import { ErrorType } from '../types/ocpp/ErrorType'; +import { ACElectricUtils, DCElectricUtils } from '../utils/ElectricUtils'; import FileUtils from '../utils/FileUtils'; -import { MessageType } from '../types/ocpp/MessageType'; +import logger from '../utils/Logger'; +import Utils from '../utils/Utils'; +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 OCPPError from './ocpp/OCPPError'; -import OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService'; -import OCPPRequestService from './ocpp/OCPPRequestService'; -import { OCPPVersion } from '../types/ocpp/OCPPVersion'; -import PerformanceStatistics from '../performance/PerformanceStatistics'; -import { StopTransactionReason } from '../types/ocpp/Transaction'; -import { URL } from 'url'; -import Utils from '../utils/Utils'; -import crypto from 'crypto'; -import fs from 'fs'; -import logger from '../utils/Logger'; -import path from 'path'; +import { OCPP16ServiceUtils } from './ocpp/1.6/OCPP16ServiceUtils'; +import type OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService'; +import type OCPPRequestService from './ocpp/OCPPRequestService'; +import SharedLRUCache from './SharedLRUCache'; export default class ChargingStation { - public stationTemplateFile: string; - public authorizedTags: string[]; + public readonly templateFile: string; public stationInfo!: ChargingStationInfo; - public connectors: Map; - public configuration!: ChargingStationConfiguration; + public started: boolean; + public authorizedTagsCache: AuthorizedTagsCache; + public automaticTransactionGenerator!: AutomaticTransactionGenerator; + public ocppConfiguration!: ChargingStationOcppConfiguration; public wsConnection!: WebSocket; - public requests: Map; + public readonly connectors: Map; + public readonly requests: Map; public performanceStatistics!: PerformanceStatistics; public heartbeatSetInterval!: NodeJS.Timeout; public ocppRequestService!: OCPPRequestService; - private index: number; - private bootNotificationRequest!: BootNotificationRequest; - private bootNotificationResponse!: BootNotificationResponse | null; + public bootNotificationRequest!: BootNotificationRequest; + public bootNotificationResponse!: BootNotificationResponse | null; + public powerDivider!: number; + private readonly index: number; + private configurationFile!: string; + private configurationFileHash!: string; private connectorsConfigurationHash!: string; private ocppIncomingRequestService!: OCPPIncomingRequestService; - private messageQueue: string[]; - private wsConnectionUrl!: URL; + private readonly messageBuffer: Set; + private configuredSupervisionUrl!: URL; 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) { + constructor(index: number, templateFile: string) { this.index = index; - this.stationTemplateFile = stationTemplateFile; + this.templateFile = templateFile; this.connectors = new Map(); - this.initialize(); - - this.stopped = false; + this.requests = new Map(); + this.messageBuffer = new Set(); + this.sharedLRUCache = SharedLRUCache.getInstance(); + this.authorizedTagsCache = AuthorizedTagsCache.getInstance(); + this.chargingStationWorkerBroadcastChannel = new ChargingStationWorkerBroadcastChannel(this); + this.started = false; this.wsConnectionRestarted = false; this.autoReconnectRetryCount = 0; - this.requests = new Map(); - this.messageQueue = new Array(); - - this.authorizedTags = this.getAuthorizedTags(); + this.initialize(); } - public logPrefix(): string { - return Utils.logPrefix(` ${this.stationInfo.chargingStationId} |`); + private get wsConnectionUrl(): URL { + return new URL( + (this.getSupervisionUrlOcppConfiguration() + ? ChargingStationConfigurationUtils.getConfigurationKey( + this, + this.getSupervisionUrlOcppKey() + ).value + : this.configuredSupervisionUrl.href) + + '/' + + this.stationInfo.chargingStationId + ); } - public getBootNotificationRequest(): BootNotificationRequest { - return this.bootNotificationRequest; + public logPrefix(): string { + return Utils.logPrefix( + ` ${ + this?.stationInfo?.chargingStationId ?? + ChargingStationUtils.getChargingStationId(this.index, this.getTemplateFromFile()) + } |` + ); } public getRandomIdTag(): string { - const index = Math.floor(Utils.secureRandom() * this.authorizedTags.length); - return this.authorizedTags[index]; + const authorizationFile = ChargingStationUtils.getAuthorizationFile(this.stationInfo); + const index = Math.floor( + Utils.secureRandom() * this.authorizedTagsCache.getAuthorizedTags(authorizationFile).length + ); + return this.authorizedTagsCache.getAuthorizedTags(authorizationFile)[index]; } public hasAuthorizedTags(): boolean { - return !Utils.isEmptyArray(this.authorizedTags); + return !Utils.isEmptyArray( + this.authorizedTagsCache.getAuthorizedTags( + ChargingStationUtils.getAuthorizationFile(this.stationInfo) + ) + ); } public getEnableStatistics(): boolean | undefined { - return !Utils.isUndefined(this.stationInfo.enableStatistics) ? this.stationInfo.enableStatistics : true; + return !Utils.isUndefined(this.stationInfo.enableStatistics) + ? this.stationInfo.enableStatistics + : true; + } + + public getMustAuthorizeAtRemoteStart(): boolean | undefined { + return this.stationInfo.mustAuthorizeAtRemoteStart ?? true; } - public getMayAuthorizeAtRemoteStart(): boolean | undefined { - return this.stationInfo.mayAuthorizeAtRemoteStart ?? true; + public getPayloadSchemaValidation(): boolean | undefined { + return this.stationInfo.payloadSchemaValidation ?? 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 : 3; + return !Utils.isUndefined(localStationInfo.numberOfPhases) + ? localStationInfo.numberOfPhases + : 3; case CurrentType.DC: return 0; } } public isWebSocketConnectionOpened(): boolean { - return this.wsConnection?.readyState === OPEN; + return this?.wsConnection?.readyState === WebSocket.OPEN; + } + + public getRegistrationStatus(): RegistrationStatus { + return this?.bootNotificationResponse?.status; + } + + public isInUnknownState(): boolean { + return Utils.isNullOrUndefined(this?.bootNotificationResponse?.status); + } + + public isInPendingState(): boolean { + return this?.bootNotificationResponse?.status === RegistrationStatus.PENDING; + } + + public isInAcceptedState(): boolean { + return this?.bootNotificationResponse?.status === RegistrationStatus.ACCEPTED; + } + + public isInRejectedState(): boolean { + return this?.bootNotificationResponse?.status === RegistrationStatus.REJECTED; } public isRegistered(): boolean { - return this.bootNotificationResponse?.status === RegistrationStatus.ACCEPTED; + return !this.isInUnknownState() && (this.isInAcceptedState() || this.isInPendingState()); } public isChargingStationAvailable(): boolean { @@ -123,32 +226,62 @@ export default class ChargingStation { } public isConnectorAvailable(id: number): boolean { - return this.getConnectorStatus(id).availability === AvailabilityType.OPERATIVE; + return id > 0 && this.getConnectorStatus(id).availability === AvailabilityType.OPERATIVE; } - public getConnectorStatus(id: number): ConnectorStatus { - return this.connectors.get(id); + public getNumberOfConnectors(): number { + return this.connectors.get(0) ? this.connectors.size - 1 : this.connectors.size; } - public getCurrentOutType(): CurrentType | undefined { - return this.stationInfo.currentOutType ?? CurrentType.AC; + public getConnectorStatus(id: number): ConnectorStatus | undefined { + return this.connectors.get(id); } - 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 : defaultVoltageOut; + public getCurrentOutType(stationInfo?: ChargingStationInfo): CurrentType { + return (stationInfo ?? this.stationInfo).currentOutType ?? CurrentType.AC; + } + + public getOcppStrictCompliance(): boolean { + return this.stationInfo?.ocppStrictCompliance ?? false; + } + + 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 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 connectorChargingProfilePowerLimit = this.getChargingProfilePowerLimit(connectorId); + return Math.min( + isNaN(connectorMaximumPower) ? Infinity : connectorMaximumPower, + isNaN(connectorAmperageLimitationPowerLimit) + ? Infinity + : connectorAmperageLimitationPowerLimit, + isNaN(connectorChargingProfilePowerLimit) ? Infinity : connectorChargingProfilePowerLimit + ); } public getTransactionIdTag(transactionId: number): string | undefined { @@ -160,116 +293,108 @@ 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 getEnergyActiveImportRegisterByTransactionId(transactionId: number): number | undefined { - if (this.getMeteringPerTransaction()) { - for (const connectorId of this.connectors.keys()) { - if (connectorId > 0 && this.getConnectorStatus(connectorId).transactionId === transactionId) { - return this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue; - } - } - } + public getCustomValueLimitationMeterValues(): boolean { + return this.stationInfo?.customValueLimitationMeterValues ?? true; + } + + public getConnectorIdByTransactionId(transactionId: number): number | undefined { for (const connectorId of this.connectors.keys()) { - if (connectorId > 0 && this.getConnectorStatus(connectorId).transactionId === transactionId) { - return this.getConnectorStatus(connectorId).energyActiveImportRegisterValue; + if ( + connectorId > 0 && + this.getConnectorStatus(connectorId)?.transactionId === transactionId + ) { + return connectorId; } } } - public getEnergyActiveImportRegisterByConnectorId(connectorId: number): number | undefined { - if (this.getMeteringPerTransaction()) { - return this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue; - } - return this.getConnectorStatus(connectorId).energyActiveImportRegisterValue; + public getEnergyActiveImportRegisterByTransactionId( + transactionId: number, + meterStop = false + ): number { + return this.getEnergyActiveImportRegister( + this.getConnectorStatus(this.getConnectorIdByTransactionId(transactionId)), + meterStop + ); + } + + public getEnergyActiveImportRegisterByConnectorId(connectorId: number): number { + return this.getEnergyActiveImportRegister(this.getConnectorStatus(connectorId)); } public getAuthorizeRemoteTxRequests(): boolean { - const authorizeRemoteTxRequests = this.getConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests); - return authorizeRemoteTxRequests ? Utils.convertToBoolean(authorizeRemoteTxRequests.value) : false; + const authorizeRemoteTxRequests = ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.AuthorizeRemoteTxRequests + ); + return authorizeRemoteTxRequests + ? Utils.convertToBoolean(authorizeRemoteTxRequests.value) + : false; } public getLocalAuthListEnabled(): boolean { - const localAuthListEnabled = this.getConfigurationKey(StandardParametersKey.LocalAuthListEnabled); + 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 { - if (!Constants.SUPPORTED_MEASURANDS.includes(measurand)) { - logger.warn(`${this.logPrefix()} Trying to get unsupported MeterValues measurand '${measurand}' ${phase ? `on phase ${phase} ` : ''}in template on connectorId ${connectorId}`); - return; - } - if (measurand !== MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER && !this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes(measurand)) { - logger.debug(`${this.logPrefix()} Trying to get MeterValues measurand '${measurand}' ${phase ? `on phase ${phase} ` : ''}in template on connectorId ${connectorId} not found in '${StandardParametersKey.MeterValuesSampledData}' OCPP parameter`); - return; - } - const sampledValueTemplates: SampledValueTemplate[] = this.getConnectorStatus(connectorId).MeterValues; - for (let index = 0; !Utils.isEmptyArray(sampledValueTemplates) && index < sampledValueTemplates.length; index++) { - if (!Constants.SUPPORTED_MEASURANDS.includes(sampledValueTemplates[index]?.measurand ?? MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER)) { - logger.warn(`${this.logPrefix()} Unsupported MeterValues measurand '${measurand}' ${phase ? `on phase ${phase} ` : ''}in template on connectorId ${connectorId}`); - } else if (phase && sampledValueTemplates[index]?.phase === phase && sampledValueTemplates[index]?.measurand === measurand - && this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes(measurand)) { - 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}' ${phase ? `on phase ${phase} ` : ''}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) { + if ( + this.getHeartbeatInterval() && + this.getHeartbeatInterval() > 0 && + !this.heartbeatSetInterval + ) { // eslint-disable-next-line @typescript-eslint/no-misused-promises this.heartbeatSetInterval = setInterval(async (): Promise => { - await this.ocppRequestService.sendHeartbeat(); + await this.ocppRequestService.requestHandler( + this, + RequestCommand.HEARTBEAT + ); }, this.getHeartbeatInterval()); - logger.info(this.logPrefix() + ' Heartbeat started every ' + Utils.formatDurationMilliSeconds(this.getHeartbeatInterval())); + logger.info( + this.logPrefix() + + ' Heartbeat started every ' + + Utils.formatDurationMilliSeconds(this.getHeartbeatInterval()) + ); } else if (this.heartbeatSetInterval) { - logger.info(this.logPrefix() + ' Heartbeat already started every ' + Utils.formatDurationMilliSeconds(this.getHeartbeatInterval())); + logger.info( + this.logPrefix() + + ' Heartbeat already started every ' + + Utils.formatDurationMilliSeconds(this.getHeartbeatInterval()) + ); } else { - logger.error(`${this.logPrefix()} Heartbeat interval set to ${this.getHeartbeatInterval() ? Utils.formatDurationMilliSeconds(this.getHeartbeatInterval()) : this.getHeartbeatInterval()}, not starting the heartbeat`); + logger.error( + `${this.logPrefix()} Heartbeat interval set to ${ + this.getHeartbeatInterval() + ? Utils.formatDurationMilliSeconds(this.getHeartbeatInterval()) + : this.getHeartbeatInterval() + }, not starting the heartbeat` + ); } } @@ -280,29 +405,72 @@ 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(`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId.toString()}`); + logger.error( + `${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId.toString()}` + ); return; } if (!this.getConnectorStatus(connectorId)) { - logger.error(`${this.logPrefix()} Trying to start MeterValues on non existing connector Id ${connectorId.toString()}`); + logger.error( + `${this.logPrefix()} Trying to start MeterValues on non existing connector Id ${connectorId.toString()}` + ); return; } - if (!this.getConnectorStatus(connectorId)?.transactionStarted) { - logger.error(`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction started`); + 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)?.transactionId) { - logger.error(`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction id`); + } else if ( + this.getConnectorStatus(connectorId)?.transactionStarted === true && + !this.getConnectorStatus(connectorId)?.transactionId + ) { + logger.error( + `${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction id` + ); return; } if (interval > 0) { // eslint-disable-next-line @typescript-eslint/no-misused-promises - this.getConnectorStatus(connectorId).transactionSetInterval = setInterval(async (): Promise => { - await this.ocppRequestService.sendMeterValues(connectorId, this.getConnectorStatus(connectorId).transactionId, interval); - }, interval); + this.getConnectorStatus(connectorId).transactionSetInterval = setInterval( + // eslint-disable-next-line @typescript-eslint/no-misused-promises + async (): Promise => { + // FIXME: Implement OCPP version agnostic helpers + const meterValue: MeterValue = OCPP16ServiceUtils.buildMeterValue( + this, + connectorId, + this.getConnectorStatus(connectorId).transactionId, + interval + ); + await this.ocppRequestService.requestHandler( + this, + RequestCommand.METER_VALUES, + { + connectorId, + transactionId: this.getConnectorStatus(connectorId).transactionId, + meterValue: [meterValue], + } + ); + }, + interval + ); } else { - logger.error(`${this.logPrefix()} Charging station ${StandardParametersKey.MeterValueSampleInterval} configuration set to ${interval ? Utils.formatDurationMilliSeconds(interval) : interval}, not sending MeterValues`); + logger.error( + `${this.logPrefix()} Charging station ${ + StandardParametersKey.MeterValueSampleInterval + } configuration set to ${ + interval ? Utils.formatDurationMilliSeconds(interval) : interval + }, not sending MeterValues` + ); } } @@ -311,272 +479,610 @@ export default class ChargingStation { this.performanceStatistics.start(); } this.openWSConnection(); - // Monitor authorization file - this.startAuthorizationFileMonitoring(); - // Monitor station template file - this.startStationTemplateFileMonitoring(); - // Handle WebSocket message - this.wsConnection.on('message', this.onMessage.bind(this)); - // Handle WebSocket error - this.wsConnection.on('error', this.onError.bind(this)); - // Handle WebSocket close - this.wsConnection.on('close', this.onClose.bind(this)); - // Handle WebSocket open - this.wsConnection.on('open', this.onOpen.bind(this)); - // Handle WebSocket ping - this.wsConnection.on('ping', this.onPing.bind(this)); - // Handle WebSocket pong - this.wsConnection.on('pong', this.onPong.bind(this)); + // 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()) { + 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 + ); + } + } + } + ); + parentPort.postMessage(MessageChannelUtils.buildStartedMessage(this)); } - public async stop(reason: StopTransactionReason = StopTransactionReason.NONE): Promise { - // Stop message sequence + public async stop(reason?: StopTransactionReason): Promise { await this.stopMessageSequence(reason); for (const connectorId of this.connectors.keys()) { if (connectorId > 0) { - await this.ocppRequestService.sendStatusNotification(connectorId, ChargePointStatus.UNAVAILABLE); + await this.ocppRequestService.requestHandler< + StatusNotificationRequest, + StatusNotificationResponse + >(this, RequestCommand.STATUS_NOTIFICATION, { + connectorId, + status: ChargePointStatus.UNAVAILABLE, + errorCode: ChargePointErrorCode.NO_ERROR, + }); this.getConnectorStatus(connectorId).status = ChargePointStatus.UNAVAILABLE; } } - if (this.isWebSocketConnectionOpened()) { - this.wsConnection.close(); - } + this.closeWSConnection(); if (this.getEnableStatistics()) { this.performanceStatistics.stop(); } + this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash); + this.templateFileWatcher.close(); + this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash); this.bootNotificationResponse = null; - this.stopped = true; + this.started = false; + parentPort.postMessage(MessageChannelUtils.buildStoppedMessage(this)); } - 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, readonly = false, visible = true, reboot = false): void { - const keyFound = this.getConfigurationKey(key); - if (!keyFound) { - this.configuration.configurationKey.push({ - key, - readonly, - value, - visible, - reboot, - }); - } else { - logger.error(`${this.logPrefix()} Trying to add an already existing configuration key: %j`, keyFound); - } + public async reset(reason?: StopTransactionReason): Promise { + await this.stop(reason); + await Utils.sleep(this.stationInfo.resetTime); + this.initialize(); + this.start(); } - public setConfigurationKeyValue(key: string | StandardParametersKey, value: string): void { - const keyFound = this.getConfigurationKey(key); - if (keyFound) { - const keyIndex = this.configuration.configurationKey.indexOf(keyFound); - this.configuration.configurationKey[keyIndex].value = value; - } else { - logger.error(`${this.logPrefix()} Trying to set a value on a non existing configuration key: %j`, { key, value }); + public saveOcppConfiguration(): void { + if (this.getOcppPersistentConfiguration()) { + this.saveConfiguration(); } } public setChargingProfile(connectorId: number, cp: ChargingProfile): void { + if (Utils.isNullOrUndefined(this.getConnectorStatus(connectorId).chargingProfiles)) { + logger.error( + `${this.logPrefix()} Trying to set a charging profile on connectorId ${connectorId} with an uninitialized charging profiles array attribute, applying deferred initialization` + ); + this.getConnectorStatus(connectorId).chargingProfiles = []; + } + if (Array.isArray(this.getConnectorStatus(connectorId).chargingProfiles) === false) { + logger.error( + `${this.logPrefix()} Trying to set a charging profile on connectorId ${connectorId} with an improper attribute type for the charging profiles array, applying proper type initialization` + ); + this.getConnectorStatus(connectorId).chargingProfiles = []; + } let cpReplaced = false; if (!Utils.isEmptyArray(this.getConnectorStatus(connectorId).chargingProfiles)) { - this.getConnectorStatus(connectorId).chargingProfiles?.forEach((chargingProfile: ChargingProfile, index: number) => { - if (chargingProfile.chargingProfileId === cp.chargingProfileId - || (chargingProfile.stackLevel === cp.stackLevel && chargingProfile.chargingProfilePurpose === cp.chargingProfilePurpose)) { - this.getConnectorStatus(connectorId).chargingProfiles[index] = cp; - cpReplaced = true; + this.getConnectorStatus(connectorId).chargingProfiles?.forEach( + (chargingProfile: ChargingProfile, index: number) => { + if ( + chargingProfile.chargingProfileId === cp.chargingProfileId || + (chargingProfile.stackLevel === cp.stackLevel && + chargingProfile.chargingProfilePurpose === cp.chargingProfilePurpose) + ) { + this.getConnectorStatus(connectorId).chargingProfiles[index] = cp; + cpReplaced = true; + } } - }); + ); } !cpReplaced && this.getConnectorStatus(connectorId).chargingProfiles?.push(cp); } - public resetTransactionOnConnector(connectorId: number): void { - this.getConnectorStatus(connectorId).authorized = false; + 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 addToMessageQueue(message: string): void { - let dups = false; - // Handle dups in message queue - for (const bufferedMessage of this.messageQueue) { - // Message already in the queue - if (message === bufferedMessage) { - dups = true; + public hasFeatureProfile(featureProfile: SupportedFeatureProfiles) { + 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 ( + !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(); + } + let protocol: string; + switch (this.getOcppVersion()) { + case OCPPVersion.VERSION_16: + protocol = 'ocpp' + OCPPVersion.VERSION_16; break; - } + default: + this.handleUnsupportedVersion(this.getOcppVersion()); + break; + } + + if (this.isWebSocketConnectionOpened()) { + 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', + this.onMessage.bind(this) as (this: WebSocket, data: RawData, isBinary: boolean) => void + ); + // Handle WebSocket error + this.wsConnection.on( + 'error', + this.onError.bind(this) as (this: WebSocket, error: Error) => void + ); + // Handle WebSocket close + this.wsConnection.on( + 'close', + this.onClose.bind(this) as (this: WebSocket, code: number, reason: Buffer) => void + ); + // Handle WebSocket open + this.wsConnection.on('open', this.onOpen.bind(this) as (this: WebSocket) => void); + // Handle WebSocket ping + this.wsConnection.on('ping', this.onPing.bind(this) as (this: WebSocket, data: Buffer) => void); + // Handle WebSocket pong + this.wsConnection.on('pong', this.onPong.bind(this) as (this: WebSocket, data: Buffer) => void); + } + + public closeWSConnection(): void { + if (this.isWebSocketConnectionOpened()) { + this.wsConnection.close(); + this.wsConnection = null; } - if (!dups) { - // Queue message - this.messageQueue.push(message); + } + + public startAutomaticTransactionGenerator(connectorIds?: number[]): void { + if (!this.automaticTransactionGenerator) { + this.automaticTransactionGenerator = AutomaticTransactionGenerator.getInstance( + this.getAutomaticTransactionGeneratorConfigurationFromTemplate(), + this + ); } + if (!Utils.isEmptyArray(connectorIds)) { + for (const connectorId of connectorIds) { + this.automaticTransactionGenerator.startConnector(connectorId); + } + } else { + this.automaticTransactionGenerator.start(); + } + } + + public stopAutomaticTransactionGenerator(connectorIds?: number[]): void { + if (!Utils.isEmptyArray(connectorIds)) { + for (const connectorId of connectorIds) { + this.automaticTransactionGenerator?.stopConnector(connectorId); + } + } else { + this.automaticTransactionGenerator?.stop(); + this.automaticTransactionGenerator = null; + } + } + + public async stopTransactionOnConnector( + connectorId: number, + reason = StopTransactionReason.NONE + ): Promise { + 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.requestHandler( + this, + RequestCommand.METER_VALUES, + { + connectorId, + transactionId, + meterValue: [transactionEndMeterValue], + } + ); + } + return this.ocppRequestService.requestHandler( + this, + RequestCommand.STOP_TRANSACTION, + { + transactionId, + meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId, true), + reason, + } + ); } - private flushMessageQueue() { - if (!Utils.isEmptyArray(this.messageQueue)) { - this.messageQueue.forEach((message, index) => { - this.messageQueue.splice(index, 1); + private flushMessageBuffer(): void { + if (this.messageBuffer.size > 0) { + this.messageBuffer.forEach((message) => { // TODO: evaluate the need to track performance this.wsConnection.send(message); + this.messageBuffer.delete(message); }); } } - private getChargingStationId(stationTemplate: ChargingStationTemplate): string { - // In case of multiple instances: add instance index to charging station id - const instanceIndex = process.env.CF_INSTANCE_INDEX ?? 0; - const idSuffix = stationTemplate.nameSuffix ?? ''; - return stationTemplate.fixedName ? stationTemplate.baseName : stationTemplate.baseName + '-' + instanceIndex.toString() + ('000000000' + this.index.toString()).substr(('000000000' + this.index.toString()).length - 4) + idSuffix; + private getSupervisionUrlOcppConfiguration(): boolean { + return this.stationInfo.supervisionUrlOcppConfiguration ?? false; + } + + private getSupervisionUrlOcppKey(): string { + return this.stationInfo.supervisionUrlOcppKey ?? VendorDefaultParametersKey.ConnectionUrl; } - private buildStationInfo(): ChargingStationInfo { - let stationTemplateFromFile: ChargingStationTemplate; + private getTemplateFromFile(): ChargingStationTemplate | null { + let template: ChargingStationTemplate = null; try { - // Load template file - const fileDescriptor = fs.openSync(this.stationTemplateFile, 'r'); - stationTemplateFromFile = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as ChargingStationTemplate; - fs.closeSync(fileDescriptor); + 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(), 'Template', this.stationTemplateFile, error); - } - const stationInfo: ChargingStationInfo = stationTemplateFromFile ?? {} as ChargingStationInfo; - 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]; + FileUtils.handleFileException( + this.logPrefix(), + FileType.ChargingStationTemplate, + this.templateFile, + error as NodeJS.ErrnoException + ); + } + return template; + } + + private getStationInfoFromTemplate(): ChargingStationInfo { + const stationTemplate: ChargingStationTemplate = this.getTemplateFromFile(); + if (Utils.isNullOrUndefined(stationTemplate)) { + const errorMsg = 'Failed to read charging station template file'; + 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 + ChargingStationUtils.warnDeprecatedTemplateKey( + stationTemplate, + 'supervisionUrl', + this.templateFile, + this.logPrefix(), + "Use 'supervisionUrls' instead" + ); + 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 + ); + 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 = this.getChargingStationId(stationTemplateFromFile); - stationInfo.resetTime = stationTemplateFromFile.resetTime ? stationTemplateFromFile.resetTime * 1000 : Constants.CHARGING_STATION_DEFAULT_RESET_TIME; + stationTemplate.power = stationTemplate.power as number; + stationInfo.maximumPower = + stationTemplate.powerUnit === PowerUnits.KILO_WATT + ? stationTemplate.power * 1000 + : stationTemplate.power; + } + stationInfo.resetTime = stationTemplate.resetTime + ? stationTemplate.resetTime * 1000 + : Constants.CHARGING_STATION_DEFAULT_RESET_TIME; + const configuredMaxConnectors = ChargingStationUtils.getConfiguredNumberOfConnectors( + this.index, + 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 getStationInfoFromFile(): ChargingStationInfo | null { + let stationInfo: ChargingStationInfo = null; + this.getStationInfoPersistentConfiguration() && + (stationInfo = this.getConfigurationFromFile()?.stationInfo ?? null); + stationInfo && ChargingStationUtils.createStationInfoHash(stationInfo); return stationInfo; } - private getOCPPVersion(): OCPPVersion { - return this.stationInfo.ocppVersion ? this.stationInfo.ocppVersion : OCPPVersion.VERSION_16; + 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 getOcppVersion(): OCPPVersion { + return this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16; + } + + private getOcppPersistentConfiguration(): boolean { + 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.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 }, - }; - this.configuration = this.getTemplateChargingStationConfiguration(); - this.wsConnectionUrl = new URL(this.getSupervisionURL().href + '/' + this.stationInfo.chargingStationId); - // 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.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 || 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.initTransactionAttributesOnConnector(connectorId); - } - } - switch (this.getOCPPVersion()) { + this.configurationFile = path.join( + path.dirname(this.templateFile.replace('station-templates', 'configurations')), + ChargingStationUtils.getHashId(this.index, this.getTemplateFromFile()) + '.json' + ); + this.stationInfo = this.getStationInfo(); + this.saveStationInfo(); + logger.info(`${this.logPrefix()} Charging station hashId '${this.stationInfo.hashId}'`); + // Avoid duplication of connectors related information in RAM + this.stationInfo?.Connectors && delete this.stationInfo.Connectors; + this.configuredSupervisionUrl = this.getConfiguredSupervisionUrl(); + if (this.getEnableStatistics()) { + this.performanceStatistics = PerformanceStatistics.getInstance( + this.stationInfo.hashId, + this.stationInfo.chargingStationId, + this.configuredSupervisionUrl + ); + } + this.bootNotificationRequest = ChargingStationUtils.createBootNotificationRequest( + this.stationInfo + ); + this.powerDivider = this.getPowerDivider(); + // OCPP configuration + this.ocppConfiguration = this.getOcppConfiguration(); + this.initializeOcppConfiguration(); + switch (this.getOcppVersion()) { case OCPPVersion.VERSION_16: - this.ocppIncomingRequestService = new OCPP16IncomingRequestService(this); - this.ocppRequestService = new OCPP16RequestService(this, new OCPP16ResponseService(this)); + this.ocppIncomingRequestService = + OCPP16IncomingRequestService.getInstance(); + this.ocppRequestService = OCPP16RequestService.getInstance( + OCPP16ResponseService.getInstance() + ); break; default: - this.handleUnsupportedVersion(this.getOCPPVersion()); + this.handleUnsupportedVersion(this.getOcppVersion()); break; } - // OCPP parameters - this.initOCPPParameters(); - if (this.stationInfo.autoRegister) { + if (this.stationInfo?.autoRegister) { this.bootNotificationResponse = { currentTime: new Date().toISOString(), interval: this.getHeartbeatInterval() / 1000, - status: RegistrationStatus.ACCEPTED + status: RegistrationStatus.ACCEPTED, }; } - this.stationInfo.powerDivider = this.getPowerDivider(); - if (this.getEnableStatistics()) { - this.performanceStatistics = new PerformanceStatistics(this.stationInfo.chargingStationId, this.wsConnectionUrl); - } } - private initOCPPParameters(): void { - if (!this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles)) { - this.addConfigurationKey(StandardParametersKey.SupportedFeatureProfiles, `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.Local_Auth_List_Management},${SupportedFeatureProfiles.Smart_Charging}`); - } - this.addConfigurationKey(StandardParametersKey.NumberOfConnectors, this.getNumberOfConnectors().toString(), true); - if (!this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData)) { - this.addConfigurationKey(StandardParametersKey.MeterValuesSampledData, MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER); - } - if (!this.getConfigurationKey(StandardParametersKey.ConnectorPhaseRotation)) { + private initializeOcppConfiguration(): void { + if ( + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.HeartbeatInterval + ) + ) { + ChargingStationConfigurationUtils.addConfigurationKey( + this, + StandardParametersKey.HeartbeatInterval, + '0' + ); + } + if ( + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.HeartBeatInterval + ) + ) { + ChargingStationConfigurationUtils.addConfigurationKey( + this, + StandardParametersKey.HeartBeatInterval, + '0', + { visible: false } + ); + } + if ( + this.getSupervisionUrlOcppConfiguration() && + !ChargingStationConfigurationUtils.getConfigurationKey(this, this.getSupervisionUrlOcppKey()) + ) { + ChargingStationConfigurationUtils.addConfigurationKey( + this, + this.getSupervisionUrlOcppKey(), + this.configuredSupervisionUrl.href, + { reboot: true } + ); + } else if ( + !this.getSupervisionUrlOcppConfiguration() && + ChargingStationConfigurationUtils.getConfigurationKey(this, this.getSupervisionUrlOcppKey()) + ) { + ChargingStationConfigurationUtils.deleteConfigurationKey( + this, + this.getSupervisionUrlOcppKey(), + { save: false } + ); + } + if ( + this.stationInfo.amperageLimitationOcppKey && + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + this.stationInfo.amperageLimitationOcppKey + ) + ) { + ChargingStationConfigurationUtils.addConfigurationKey( + this, + this.stationInfo.amperageLimitationOcppKey, + ( + this.stationInfo.maximumAmperage * + ChargingStationUtils.getAmperageLimitationUnitDivider(this.stationInfo) + ).toString() + ); + } + if ( + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.SupportedFeatureProfiles + ) + ) { + ChargingStationConfigurationUtils.addConfigurationKey( + this, + StandardParametersKey.SupportedFeatureProfiles, + `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.FirmwareManagement},${SupportedFeatureProfiles.LocalAuthListManagement},${SupportedFeatureProfiles.SmartCharging},${SupportedFeatureProfiles.RemoteTrigger}` + ); + } + ChargingStationConfigurationUtils.addConfigurationKey( + this, + StandardParametersKey.NumberOfConnectors, + this.getNumberOfConnectors().toString(), + { readonly: true }, + { overwrite: true } + ); + if ( + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.MeterValuesSampledData + ) + ) { + ChargingStationConfigurationUtils.addConfigurationKey( + this, + StandardParametersKey.MeterValuesSampledData, + MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER + ); + } + if ( + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.ConnectorPhaseRotation + ) + ) { const connectorPhaseRotation = []; for (const connectorId of this.connectors.keys()) { // AC/DC @@ -584,52 +1090,306 @@ export default class ChargingStation { connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.RST}`); } else if (connectorId > 0 && this.getNumberOfPhases() === 0) { connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.NotApplicable}`); - // AC + // AC } else if (connectorId > 0 && this.getNumberOfPhases() === 1) { connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.NotApplicable}`); } else if (connectorId > 0 && this.getNumberOfPhases() === 3) { connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.RST}`); } } - this.addConfigurationKey(StandardParametersKey.ConnectorPhaseRotation, connectorPhaseRotation.toString()); + ChargingStationConfigurationUtils.addConfigurationKey( + this, + StandardParametersKey.ConnectorPhaseRotation, + connectorPhaseRotation.toString() + ); + } + if ( + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.AuthorizeRemoteTxRequests + ) + ) { + 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 ( + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.ConnectionTimeOut + ) + ) { + ChargingStationConfigurationUtils.addConfigurationKey( + this, + StandardParametersKey.ConnectionTimeOut, + Constants.DEFAULT_CONNECTION_TIMEOUT.toString() + ); + } + 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 lastConnectorId = Utils.convertToInt(lastConnector); + if ( + lastConnectorId === 0 && + this.getUseConnectorId0(stationInfo) && + stationInfo?.Connectors[lastConnector] + ) { + this.connectors.set( + lastConnectorId, + Utils.cloneObject(stationInfo?.Connectors[lastConnector]) + ); + this.getConnectorStatus(lastConnectorId).availability = AvailabilityType.OPERATIVE; + if (Utils.isUndefined(this.getConnectorStatus(lastConnectorId)?.chargingProfiles)) { + this.getConnectorStatus(lastConnectorId).chargingProfiles = []; + } + } + } + // Generate all connectors + if ((stationInfo?.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) > 0) { + for (let index = 1; index <= configuredMaxConnectors; index++) { + const randConnectorId = stationInfo?.randomConnectors + ? Utils.getRandomInteger(Utils.convertToInt(lastConnector), 1) + : index; + this.connectors.set( + index, + Utils.cloneObject(stationInfo?.Connectors[randConnectorId]) + ); + this.getConnectorStatus(index).availability = AvailabilityType.OPERATIVE; + if (Utils.isUndefined(this.getConnectorStatus(index)?.chargingProfiles)) { + this.getConnectorStatus(index).chargingProfiles = []; + } + } + } + } + } else { + logger.warn( + `${this.logPrefix()} Charging station information from template ${ + this.templateFile + } with no connectors configuration defined, using already defined connectors` + ); + } + // Initialize transaction attributes on connectors + for (const connectorId of this.connectors.keys()) { + if ( + connectorId > 0 && + (this.getConnectorStatus(connectorId).transactionStarted === undefined || + this.getConnectorStatus(connectorId).transactionStarted === false) + ) { + this.initializeConnectorStatus(connectorId); + } + } + } + + private getConfigurationFromFile(): ChargingStationConfiguration | null { + let configuration: ChargingStationConfiguration = null; + if (this.configurationFile && fs.existsSync(this.configurationFile)) { + try { + 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(), + FileType.ChargingStationConfiguration, + this.configurationFile, + error as NodeJS.ErrnoException + ); + } } - if (!this.getConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests)) { - this.addConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests, 'true'); + return configuration; + } + + private saveConfiguration(): void { + 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(configurationData, null, 2), 'utf8'); + fs.closeSync(fileDescriptor); + 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 + }` + ); + } + } 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` + ); } - if (!this.getConfigurationKey(StandardParametersKey.LocalAuthListEnabled) - && this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles).value.includes(SupportedFeatureProfiles.Local_Auth_List_Management)) { - this.addConfigurationKey(StandardParametersKey.LocalAuthListEnabled, 'false'); + } + + private getOcppConfigurationFromTemplate(): ChargingStationOcppConfiguration | null { + return this.getTemplateFromFile()?.Configuration ?? null; + } + + private getOcppConfigurationFromFile(): ChargingStationOcppConfiguration | null { + let configuration: ChargingStationConfiguration = null; + if (this.getOcppPersistentConfiguration()) { + const configurationFromFile = this.getConfigurationFromFile(); + configuration = configurationFromFile?.configurationKey && configurationFromFile; } - if (!this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) { - this.addConfigurationKey(StandardParametersKey.ConnectionTimeOut, Constants.DEFAULT_CONNECTION_TIMEOUT.toString()); + 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.isRegistered()) { - // Send BootNotification - let registrationRetryCount = 0; - do { - this.bootNotificationResponse = await this.ocppRequestService.sendBootNotification(this.bootNotificationRequest.chargePointModel, - this.bootNotificationRequest.chargePointVendor, this.bootNotificationRequest.chargeBoxSerialNumber, this.bootNotificationRequest.firmwareVersion); - if (!this.isRegistered()) { - registrationRetryCount++; - await Utils.sleep(this.bootNotificationResponse?.interval ? this.bootNotificationResponse.interval * 1000 : Constants.OCPP_DEFAULT_BOOT_NOTIFICATION_INTERVAL); + if (this.isWebSocketConnectionOpened()) { + logger.info( + `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} succeeded` + ); + if (!this.isRegistered()) { + // Send BootNotification + let registrationRetryCount = 0; + do { + this.bootNotificationResponse = await this.ocppRequestService.requestHandler< + BootNotificationRequest, + BootNotificationResponse + >( + this, + RequestCommand.BOOT_NOTIFICATION, + { + chargePointModel: this.bootNotificationRequest.chargePointModel, + 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.isRegistered()) { + this.getRegistrationMaxRetries() !== -1 && registrationRetryCount++; + await Utils.sleep( + this.bootNotificationResponse?.interval + ? this.bootNotificationResponse.interval * 1000 + : Constants.OCPP_DEFAULT_BOOT_NOTIFICATION_INTERVAL + ); + } + } while ( + !this.isRegistered() && + (registrationRetryCount <= this.getRegistrationMaxRetries() || + this.getRegistrationMaxRetries() === -1) + ); + } + if (this.isRegistered()) { + if (this.isInAcceptedState()) { + await this.startMessageSequence(); + this.wsConnectionRestarted && this.flushMessageBuffer(); } - } while (!this.isRegistered() && (registrationRetryCount <= this.getRegistrationMaxRetries() || this.getRegistrationMaxRetries() === -1)); - } - if (this.isRegistered()) { - await this.startMessageSequence(); - this.stopped && (this.stopped = false); - if (this.wsConnectionRestarted && this.isWebSocketConnectionOpened()) { - this.flushMessageQueue(); + } else { + logger.error( + `${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})` + ); } + this.started === false && (this.started = true); + this.autoReconnectRetryCount = 0; + this.wsConnectionRestarted = false; + 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 { @@ -637,83 +1397,165 @@ export default class ChargingStation { // Normal close case WebSocketCloseEventStatusCode.CLOSE_NORMAL: case WebSocketCloseEventStatusCode.CLOSE_NO_STATUS: - logger.info(`${this.logPrefix()} WebSocket normally closed with status '${Utils.getWebSocketCloseEventStatusString(code)}' and reason '${reason}'`); + logger.info( + `${this.logPrefix()} WebSocket normally closed with status '${Utils.getWebSocketCloseEventStatusString( + code + )}' and reason '${reason}'` + ); this.autoReconnectRetryCount = 0; break; // Abnormal close default: - logger.error(`${this.logPrefix()} WebSocket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString(code)}' and reason '${reason}'`); + logger.error( + `${this.logPrefix()} WebSocket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString( + code + )}' and reason '${reason}'` + ); await this.reconnect(code); break; } + parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this)); } private async onMessage(data: Data): Promise { - let [messageType, messageId, commandName, commandPayload, errorDetails]: IncomingRequest = [0, '', '' as IncomingRequestCommand, {}, {}]; - let responseCallback: (payload: Record | string, requestPayload: Record) => void; - let rejectCallback: (error: OCPPError) => void; + let messageType: number; + let messageId: string; + let commandName: IncomingRequestCommand; + let commandPayload: JsonType; + let errorType: ErrorType; + let errorMessage: string; + let errorDetails: JsonType; + let responseCallback: (payload: JsonType, requestPayload: JsonType) => void; + let errorCallback: (error: OCPPError, requestStatistic?: boolean) => void; let requestCommandName: RequestCommand | IncomingRequestCommand; - let requestPayload: Record; + 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()) { + 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)) { + // 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, , 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 ?? 'unknown' + }' 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)) { + // 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 ?? 'unknown' + }' received error 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); - } - // Check the Type of message - switch (messageType) { - // Incoming Message - case MessageType.CALL_MESSAGE: - if (this.getEnableStatistics()) { - this.performanceStatistics.addRequestStatistic(commandName, messageType); - } - // Process the call - await this.ocppIncomingRequestService.handleRequest(messageId, commandName, commandPayload); - break; - // Outcome Message - case MessageType.CALL_RESULT_MESSAGE: - // Respond - cachedRequest = this.requests.get(messageId); - if (Utils.isIterable(cachedRequest)) { - [responseCallback, , , requestPayload] = cachedRequest; - } else { - throw new OCPPError(ErrorType.PROTOCOL_ERROR, `Cached request for message id ${messageId} response is not iterable`, commandName); - } - 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; - } 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); - } - rejectCallback(new OCPPError(commandName, commandPayload.toString(), requestCommandName, errorDetails)); - break; - // Error - default: - errMsg = `${this.logPrefix()} Wrong message type ${messageType}`; - logger.error(errMsg); - throw new OCPPError(ErrorType.PROTOCOL_ERROR, errMsg); + throw new OCPPError(ErrorType.PROTOCOL_ERROR, 'Incoming message is not an array', null, { + payload: request, + }); } } catch (error) { // Log - logger.error('%s Incoming OCPP message %j matching cached request %j processing error %j', this.logPrefix(), data, this.requests.get(messageId), error); + logger.error( + `${this.logPrefix()} Incoming OCPP command '${ + commandName ?? requestCommandName ?? null + }' message '${data.toString()}' matching cached request '${JSON.stringify( + this.requests.get(messageId) + )}' processing error:`, + error + ); + if (!(error instanceof OCPPError)) { + logger.warn( + `${this.logPrefix()} Error thrown at incoming OCPP command '${ + commandName ?? requestCommandName ?? null + }' message '${data.toString()}' handling is not an OCPPError:`, + error + ); + } // Send error - messageType === MessageType.CALL_MESSAGE && await this.ocppRequestService.sendError(messageId, error, commandName); + messageType === MessageType.CALL_MESSAGE && + (await this.ocppRequestService.sendError( + this, + messageId, + error as OCPPError, + commandName ?? requestCommandName ?? null + )); } } @@ -725,59 +1567,70 @@ export default class ChargingStation { logger.debug(this.logPrefix() + ' Received a WS pong (rfc6455) from the server'); } - private async onError(error: WSError): Promise { - logger.error(this.logPrefix() + ' WebSocket error: %j', error); - // switch (error.code) { - // case 'ECONNREFUSED': - // await this.reconnect(error); - // break; - // } + private onError(error: WSError): void { + this.closeWSConnection(); + logger.error(this.logPrefix() + ' WebSocket error:', error); } - private getTemplateChargingStationConfiguration(): ChargingStationConfiguration { - return this.stationInfo.Configuration ?? {} as ChargingStationConfiguration; - } - - private getAuthorizationFile(): string | undefined { - return this.stationInfo.authorizationFile && path.join(path.resolve(__dirname, '../'), 'assets', path.basename(this.stationInfo.authorizationFile)); - } - - private getAuthorizedTags(): string[] { - let authorizedTags: string[] = []; - const authorizationFile = this.getAuthorizationFile(); - if (authorizationFile) { - try { - // Load authorization file - const fileDescriptor = fs.openSync(authorizationFile, 'r'); - authorizedTags = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as string[]; - fs.closeSync(fileDescriptor); - } catch (error) { - FileUtils.handleFileException(this.logPrefix(), 'Authorization', authorizationFile, error); - } - } else { - logger.info(this.logPrefix() + ' No authorization file given in template file ' + this.stationTemplateFile); + private getEnergyActiveImportRegister( + connectorStatus: ConnectorStatus, + meterStop = false + ): number { + if (this.getMeteringPerTransaction()) { + return ( + (meterStop === true + ? Math.round(connectorStatus?.transactionEnergyActiveImportRegisterValue) + : connectorStatus?.transactionEnergyActiveImportRegisterValue) ?? 0 + ); } - return authorizedTags; + return ( + (meterStop === true + ? Math.round(connectorStatus?.energyActiveImportRegisterValue) + : connectorStatus?.energyActiveImportRegisterValue) ?? 0 + ); } - private getUseConnectorId0(): boolean | undefined { - return !Utils.isUndefined(this.stationInfo.useConnectorId0) ? this.stationInfo.useConnectorId0 : true; + private getUseConnectorId0(stationInfo?: ChargingStationInfo): boolean | undefined { + 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)) { - return parseInt(this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut).value) ?? Constants.DEFAULT_CONNECTION_TIMEOUT; + if ( + ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.ConnectionTimeOut + ) + ) { + return ( + parseInt( + ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.ConnectionTimeOut + ).value + ) ?? Constants.DEFAULT_CONNECTION_TIMEOUT + ); } return Constants.DEFAULT_CONNECTION_TIMEOUT; } @@ -803,35 +1656,123 @@ 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 getMaximumPower(stationInfo?: ChargingStationInfo): number { + const localStationInfo = stationInfo ?? this.stationInfo; + return (localStationInfo['maxPower'] as number) ?? localStationInfo.maximumPower; } - private getMaxNumberOfConnectors(): number { - let maxConnectors = 0; - 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 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 getAmperageLimitation(): number | undefined { + if ( + this.stationInfo.amperageLimitationOcppKey && + ChargingStationConfigurationUtils.getConfigurationKey( + this, + this.stationInfo.amperageLimitationOcppKey + ) + ) { + return ( + Utils.convertToInt( + ChargingStationConfigurationUtils.getConfigurationKey( + this, + this.stationInfo.amperageLimitationOcppKey + ).value + ) / ChargingStationUtils.getAmperageLimitationUnitDivider(this.stationInfo) + ); + } + } + + private getChargingProfilePowerLimit(connectorId: number): number | undefined { + let limit: number, matchingChargingProfile: ChargingProfile; + let chargingProfiles: ChargingProfile[] = []; + // Get charging profiles for connector and sort by stack level + chargingProfiles = this.getConnectorStatus(connectorId).chargingProfiles.sort( + (a, b) => b.stackLevel - a.stackLevel + ); + // Get profiles on connector 0 + if (this.getConnectorStatus(0).chargingProfiles) { + chargingProfiles.push( + ...this.getConnectorStatus(0).chargingProfiles.sort((a, b) => b.stackLevel - a.stackLevel) + ); + } + if (!Utils.isEmptyArray(chargingProfiles)) { + const result = ChargingStationUtils.getLimitFromChargingProfiles( + chargingProfiles, + this.logPrefix() + ); + if (!Utils.isNullOrUndefined(result)) { + limit = result.limit; + matchingChargingProfile = result.matchingChargingProfile; + switch (this.getCurrentOutType()) { + case CurrentType.AC: + limit = + matchingChargingProfile.chargingSchedule.chargingRateUnit === + ChargingRateUnitType.WATT + ? limit + : ACElectricUtils.powerTotal(this.getNumberOfPhases(), this.getVoltageOut(), limit); + break; + case CurrentType.DC: + limit = + matchingChargingProfile.chargingSchedule.chargingRateUnit === + ChargingRateUnitType.WATT + ? limit + : DCElectricUtils.power(this.getVoltageOut(), limit); + } + const connectorMaximumPower = this.getMaximumPower() / this.powerDivider; + if (limit > connectorMaximumPower) { + logger.error( + `${this.logPrefix()} Charging profile id ${ + matchingChargingProfile.chargingProfileId + } limit is greater than connector id ${connectorId} maximum, dump charging profiles' stack: %j`, + this.getConnectorStatus(connectorId).chargingProfiles + ); + limit = connectorMaximumPower; + } + } } - return maxConnectors; - } - - private getNumberOfConnectors(): number { - return this.connectors.get(0) ? this.connectors.size - 1 : this.connectors.size; + return limit; } private async startMessageSequence(): Promise { + if (this.stationInfo?.autoRegister) { + await this.ocppRequestService.requestHandler< + BootNotificationRequest, + BootNotificationResponse + >( + this, + RequestCommand.BOOT_NOTIFICATION, + { + chargePointModel: this.bootNotificationRequest.chargePointModel, + chargePointVendor: this.bootNotificationRequest.chargePointVendor, + chargeBoxSerialNumber: this.bootNotificationRequest.chargeBoxSerialNumber, + firmwareVersion: this.bootNotificationRequest.firmwareVersion, + chargePointSerialNumber: this.bootNotificationRequest.chargePointSerialNumber, + iccid: this.bootNotificationRequest.iccid, + imsi: this.bootNotificationRequest.imsi, + meterSerialNumber: this.bootNotificationRequest.meterSerialNumber, + meterType: this.bootNotificationRequest.meterType, + }, + { skipBufferingOnError: true } + ); + } // Start WebSocket ping this.startWebSocketPing(); // Start heartbeat @@ -840,74 +1781,122 @@ export default class ChargingStation { for (const connectorId of this.connectors.keys()) { if (connectorId === 0) { continue; - } else if (!this.stopped && !this.getConnectorStatus(connectorId)?.status && this.getConnectorStatus(connectorId)?.bootStatus) { + } else if ( + this.started === true && + !this.getConnectorStatus(connectorId)?.status && + this.getConnectorStatus(connectorId)?.bootStatus + ) { // Send status in template at startup - await this.ocppRequestService.sendStatusNotification(connectorId, this.getConnectorStatus(connectorId).bootStatus); - this.getConnectorStatus(connectorId).status = this.getConnectorStatus(connectorId).bootStatus; - } else if (this.stopped && this.getConnectorStatus(connectorId)?.status && this.getConnectorStatus(connectorId)?.bootStatus) { + await this.ocppRequestService.requestHandler< + StatusNotificationRequest, + StatusNotificationResponse + >(this, RequestCommand.STATUS_NOTIFICATION, { + connectorId, + status: this.getConnectorStatus(connectorId).bootStatus, + errorCode: ChargePointErrorCode.NO_ERROR, + }); + this.getConnectorStatus(connectorId).status = + this.getConnectorStatus(connectorId).bootStatus; + } else if ( + this.started === false && + this.getConnectorStatus(connectorId)?.status && + this.getConnectorStatus(connectorId)?.bootStatus + ) { // Send status in template after reset - await this.ocppRequestService.sendStatusNotification(connectorId, this.getConnectorStatus(connectorId).bootStatus); - this.getConnectorStatus(connectorId).status = this.getConnectorStatus(connectorId).bootStatus; - } else if (!this.stopped && this.getConnectorStatus(connectorId)?.status) { + await this.ocppRequestService.requestHandler< + StatusNotificationRequest, + StatusNotificationResponse + >(this, RequestCommand.STATUS_NOTIFICATION, { + connectorId, + status: this.getConnectorStatus(connectorId).bootStatus, + errorCode: ChargePointErrorCode.NO_ERROR, + }); + this.getConnectorStatus(connectorId).status = + this.getConnectorStatus(connectorId).bootStatus; + } else if (this.started === true && this.getConnectorStatus(connectorId)?.status) { // Send previous status at template reload - await this.ocppRequestService.sendStatusNotification(connectorId, this.getConnectorStatus(connectorId).status); + await this.ocppRequestService.requestHandler< + StatusNotificationRequest, + StatusNotificationResponse + >(this, RequestCommand.STATUS_NOTIFICATION, { + connectorId, + status: this.getConnectorStatus(connectorId).status, + errorCode: ChargePointErrorCode.NO_ERROR, + }); } else { // Send default status - await this.ocppRequestService.sendStatusNotification(connectorId, ChargePointStatus.AVAILABLE); + await this.ocppRequestService.requestHandler< + StatusNotificationRequest, + StatusNotificationResponse + >(this, RequestCommand.STATUS_NOTIFICATION, { + connectorId, + status: ChargePointStatus.AVAILABLE, + errorCode: ChargePointErrorCode.NO_ERROR, + }); this.getConnectorStatus(connectorId).status = ChargePointStatus.AVAILABLE; } } // Start the ATG - this.startAutomaticTransactionGenerator(); - } - - private startAutomaticTransactionGenerator() { - if (this.stationInfo.AutomaticTransactionGenerator.enable) { - if (!this.automaticTransactionGenerator) { - this.automaticTransactionGenerator = new AutomaticTransactionGenerator(this); - } - if (!this.automaticTransactionGenerator.started) { - this.automaticTransactionGenerator.start(); - } + if (this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable === true) { + this.startAutomaticTransactionGenerator(); } } - private async stopMessageSequence(reason: StopTransactionReason = StopTransactionReason.NONE): Promise { + private async stopMessageSequence( + reason: StopTransactionReason = StopTransactionReason.NONE + ): Promise { // Stop WebSocket ping this.stopWebSocketPing(); // Stop heartbeat this.stopHeartbeat(); - // Stop the ATG - if (this.stationInfo.AutomaticTransactionGenerator.enable && - this.automaticTransactionGenerator && - this.automaticTransactionGenerator.started) { - 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; - await this.ocppRequestService.sendStopTransaction(transactionId, this.getEnergyActiveImportRegisterByTransactionId(transactionId), - this.getTransactionIdTag(transactionId), reason); - } - } + await this.stopRunningTransactions(reason); } } private startWebSocketPing(): void { - const webSocketPingInterval: number = this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval) - ? Utils.convertToInt(this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval).value) + const webSocketPingInterval: number = ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.WebSocketPingInterval + ) + ? Utils.convertToInt( + 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 */ }); + this.wsConnection.ping((): void => { + /* This is intentional */ + }); } }, webSocketPingInterval * 1000); - logger.info(this.logPrefix() + ' WebSocket ping started every ' + Utils.formatDurationSeconds(webSocketPingInterval)); + logger.info( + this.logPrefix() + + ' WebSocket ping started every ' + + Utils.formatDurationSeconds(webSocketPingInterval) + ); } else if (this.webSocketPingSetInterval) { - logger.info(this.logPrefix() + ' WebSocket ping every ' + Utils.formatDurationSeconds(webSocketPingInterval) + ' already started'); + logger.info( + this.logPrefix() + + ' WebSocket ping every ' + + Utils.formatDurationSeconds(webSocketPingInterval) + + ' already started' + ); } else { - logger.error(`${this.logPrefix()} WebSocket ping interval set to ${webSocketPingInterval ? Utils.formatDurationSeconds(webSocketPingInterval) : webSocketPingInterval}, not starting the WebSocket ping`); + logger.error( + `${this.logPrefix()} WebSocket ping interval set to ${ + webSocketPingInterval + ? Utils.formatDurationSeconds(webSocketPingInterval) + : webSocketPingInterval + }, not starting the WebSocket ping` + ); } } @@ -917,31 +1906,64 @@ export default class ChargingStation { } } - private getSupervisionURL(): URL { - const supervisionUrls = Utils.cloneObject(this.stationInfo.supervisionURL ? this.stationInfo.supervisionURL : Configuration.getSupervisionURLs()); - let indexUrl = 0; + private getConfiguredSupervisionUrl(): URL { + const supervisionUrls = Utils.cloneObject( + this.stationInfo.supervisionUrls ?? Configuration.getSupervisionUrls() + ); if (!Utils.isEmptyArray(supervisionUrls)) { - if (Configuration.getDistributeStationsToTenantsEqually()) { - indexUrl = this.index % supervisionUrls.length; - } else { - // Get a random url - indexUrl = Math.floor(Utils.secureRandom() * supervisionUrls.length); + let urlIndex = 0; + switch (Configuration.getSupervisionUrlDistribution()) { + case SupervisionUrlDistribution.ROUND_ROBIN: + urlIndex = (this.index - 1) % supervisionUrls.length; + break; + case SupervisionUrlDistribution.RANDOM: + // Get a random url + urlIndex = Math.floor(Utils.secureRandom() * supervisionUrls.length); + break; + case SupervisionUrlDistribution.SEQUENTIAL: + if (this.index <= supervisionUrls.length) { + urlIndex = this.index - 1; + } else { + logger.warn( + `${this.logPrefix()} No more configured supervision urls available, using the first one` + ); + } + break; + default: + logger.error( + `${this.logPrefix()} Unknown supervision url distribution '${Configuration.getSupervisionUrlDistribution()}' from values '${SupervisionUrlDistribution.toString()}', defaulting to ${ + SupervisionUrlDistribution.ROUND_ROBIN + }` + ); + urlIndex = (this.index - 1) % supervisionUrls.length; + break; } - return new URL(supervisionUrls[indexUrl]); + return new URL(supervisionUrls[urlIndex]); } return new URL(supervisionUrls as string); } private getHeartbeatInterval(): number | undefined { - const HeartbeatInterval = this.getConfigurationKey(StandardParametersKey.HeartbeatInterval); + const HeartbeatInterval = ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.HeartbeatInterval + ); if (HeartbeatInterval) { return Utils.convertToInt(HeartbeatInterval.value) * 1000; } - const HeartBeatInterval = this.getConfigurationKey(StandardParametersKey.HeartBeatInterval); + const HeartBeatInterval = ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.HeartBeatInterval + ); if (HeartBeatInterval) { return Utils.convertToInt(HeartBeatInterval.value) * 1000; } - !this.stationInfo.autoRegister && logger.warn(`${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${Constants.DEFAULT_HEARTBEAT_INTERVAL}`); + !this.stationInfo?.autoRegister && + logger.warn( + `${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${ + Constants.DEFAULT_HEARTBEAT_INTERVAL + }` + ); return Constants.DEFAULT_HEARTBEAT_INTERVAL; } @@ -951,26 +1973,11 @@ export default class ChargingStation { } } - private openWSConnection(options?: ClientOptions & ClientRequestArgs, forceCloseOpened = false): void { - options = options ?? {}; - 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; - 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()) { + 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) { @@ -979,61 +1986,10 @@ export default class ChargingStation { } } - private startAuthorizationFileMonitoring(): void { - const authorizationFile = this.getAuthorizationFile(); - if (authorizationFile) { - try { - fs.watch(authorizationFile, (event, filename) => { - if (filename && event === 'change') { - try { - logger.debug(this.logPrefix() + ' Authorization file ' + authorizationFile + ' have changed, reload'); - // Initialize authorizedTags - this.authorizedTags = this.getAuthorizedTags(); - } catch (error) { - logger.error(this.logPrefix() + ' Authorization file monitoring error: %j', error); - } - } - }); - } catch (error) { - FileUtils.handleFileException(this.logPrefix(), 'Authorization', authorizationFile, error); - } - } else { - logger.info(this.logPrefix() + ' No authorization file given in template file ' + this.stationTemplateFile + '. Not monitoring changes'); - } - } - - private startStationTemplateFileMonitoring(): void { - try { - fs.watch(this.stationTemplateFile, (event, filename): void => { - if (filename && event === 'change') { - try { - logger.debug(this.logPrefix() + ' Template file ' + this.stationTemplateFile + ' have changed, reload'); - // Initialize - this.initialize(); - // Restart the ATG - if (!this.stationInfo.AutomaticTransactionGenerator.enable && - this.automaticTransactionGenerator) { - this.automaticTransactionGenerator.stop(); - } - this.startAutomaticTransactionGenerator(); - if (this.getEnableStatistics()) { - this.performanceStatistics.restart(); - } else { - this.performanceStatistics.stop(); - } - // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed - } catch (error) { - logger.error(this.logPrefix() + ' Charging station template file monitoring error: %j', error); - } - } - }); - } catch (error) { - FileUtils.handleFileException(this.logPrefix(), 'Template', this.stationTemplateFile, error); - } - } - private getReconnectExponentialDelay(): boolean | undefined { - return !Utils.isUndefined(this.stationInfo.reconnectExponentialDelay) ? this.stationInfo.reconnectExponentialDelay : false; + return !Utils.isUndefined(this.stationInfo.reconnectExponentialDelay) + ? this.stationInfo.reconnectExponentialDelay + : false; } private async reconnect(code: number): Promise { @@ -1042,31 +1998,58 @@ export default class ChargingStation { // Stop heartbeat this.stopHeartbeat(); // Stop the ATG if needed - if (this.stationInfo.AutomaticTransactionGenerator.enable && - this.stationInfo.AutomaticTransactionGenerator.stopOnConnectionFailure && - this.automaticTransactionGenerator && - this.automaticTransactionGenerator.started) { - this.automaticTransactionGenerator.stop(); + if (this.automaticTransactionGenerator?.configuration?.stopOnConnectionFailure === true) { + this.stopAutomaticTransactionGenerator(); } - if (this.autoReconnectRetryCount < this.getAutoReconnectMaxRetries() || this.getAutoReconnectMaxRetries() === -1) { + if ( + this.autoReconnectRetryCount < this.getAutoReconnectMaxRetries() || + this.getAutoReconnectMaxRetries() === -1 + ) { this.autoReconnectRetryCount++; - const reconnectDelay = (this.getReconnectExponentialDelay() ? Utils.exponentialDelay(this.autoReconnectRetryCount) : this.getConnectionTimeout() * 1000); - const reconnectTimeout = reconnectDelay - 100; - logger.error(`${this.logPrefix()} WebSocket: connection retry in ${Utils.roundTo(reconnectDelay, 2)}ms, timeout ${reconnectTimeout}ms`); + const reconnectDelay = this.getReconnectExponentialDelay() + ? Utils.exponentialDelay(this.autoReconnectRetryCount) + : this.getConnectionTimeout() * 1000; + const reconnectDelayWithdraw = 1000; + const reconnectTimeout = + reconnectDelay && reconnectDelay - reconnectDelayWithdraw > 0 + ? reconnectDelay - reconnectDelayWithdraw + : 0; + logger.error( + `${this.logPrefix()} WebSocket: connection retry in ${Utils.roundTo( + reconnectDelay, + 2 + )}ms, timeout ${reconnectTimeout}ms` + ); await Utils.sleep(reconnectDelay); - logger.error(this.logPrefix() + ' WebSocket: reconnecting try #' + this.autoReconnectRetryCount.toString()); - this.openWSConnection({ handshakeTimeout: reconnectTimeout }, true); + logger.error( + this.logPrefix() + + ' WebSocket: reconnecting try #' + + this.autoReconnectRetryCount.toString() + ); + this.openWSConnection( + { ...(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.autoReconnectRetryCount}) or retry disabled (${this.getAutoReconnectMaxRetries()})`); + logger.error( + `${this.logPrefix()} WebSocket reconnect failure: maximum retries reached (${ + this.autoReconnectRetryCount + }) or retry disabled (${this.getAutoReconnectMaxRetries()})` + ); } } - private initTransactionAttributesOnConnector(connectorId: number): void { - this.getConnectorStatus(connectorId).authorized = false; + private getAutomaticTransactionGeneratorConfigurationFromTemplate(): AutomaticTransactionGeneratorConfiguration | null { + return this.getTemplateFromFile()?.AutomaticTransactionGenerator ?? null; + } + + private initializeConnectorStatus(connectorId: number): void { + this.getConnectorStatus(connectorId).idTagLocalAuthorized = false; + this.getConnectorStatus(connectorId).idTagAuthorized = false; + this.getConnectorStatus(connectorId).transactionRemoteStarted = false; this.getConnectorStatus(connectorId).transactionStarted = false; this.getConnectorStatus(connectorId).energyActiveImportRegisterValue = 0; this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue = 0; } } -