X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FChargingStation.ts;h=b555e528f5e40ad75ee0b39aa4b98638ecec2c70;hb=cd8dd45729bcb9838f1f3c7b82596b8b30f8ce4d;hp=e3dd077d6eeac26a03b3eaf75df7d1a84f193d3f;hpb=802cfa135dad14f8b15401685c3429395cb3e6e1;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ChargingStation.ts b/src/charging-station/ChargingStation.ts index e3dd077d..b555e528 100644 --- a/src/charging-station/ChargingStation.ts +++ b/src/charging-station/ChargingStation.ts @@ -1,11 +1,14 @@ +// 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 Connectors, { Connector, SampledValueTemplate } from '../types/Connectors'; +import { ConnectorStatus, SampledValueTemplate } from '../types/Connectors'; import { MeterValueMeasurand, MeterValuePhase } from '../types/ocpp/MeterValues'; -import Requests, { AvailabilityType, BootNotificationRequest, IncomingRequest, IncomingRequestCommand } from '../types/ocpp/Requests'; -import WebSocket, { ClientOptions, MessageEvent } from 'ws'; +import { WSError, WebSocketCloseEventStatusCode } from '../types/WebSocket'; +import WebSocket, { ClientOptions, Data, OPEN } from 'ws'; import AutomaticTransactionGenerator from './AutomaticTransactionGenerator'; import { ChargePointStatus } from '../types/ocpp/ChargePointStatus'; @@ -28,48 +31,47 @@ import PerformanceStatistics from '../performance/PerformanceStatistics'; import { StopTransactionReason } from '../types/ocpp/Transaction'; import { URL } from 'url'; import Utils from '../utils/Utils'; -import { WebSocketCloseEventStatusCode } from '../types/WebSocket'; import crypto from 'crypto'; import fs from 'fs'; import logger from '../utils/Logger'; import path from 'path'; export default class ChargingStation { - public stationTemplateFile: string; + public readonly stationTemplateFile: string; public authorizedTags: string[]; public stationInfo!: ChargingStationInfo; - public connectors: Connectors; + public readonly connectors: Map; public configuration!: ChargingStationConfiguration; - public hasStopped: boolean; public wsConnection!: WebSocket; - public requests: Requests; - public messageQueue: string[]; + public readonly requests: Map; public performanceStatistics!: PerformanceStatistics; public heartbeatSetInterval!: NodeJS.Timeout; - public ocppIncomingRequestService!: OCPPIncomingRequestService; public ocppRequestService!: OCPPRequestService; - private index: number; + private readonly index: number; private bootNotificationRequest!: BootNotificationRequest; private bootNotificationResponse!: BootNotificationResponse | null; private connectorsConfigurationHash!: string; + private ocppIncomingRequestService!: OCPPIncomingRequestService; + private readonly messageBuffer: Set; private wsConnectionUrl!: URL; - private hasSocketRestarted: boolean; + private wsConnectionRestarted: boolean; + private stopped: boolean; private autoReconnectRetryCount: number; - private automaticTransactionGeneration!: AutomaticTransactionGenerator; + private automaticTransactionGenerator!: AutomaticTransactionGenerator; private webSocketPingSetInterval!: NodeJS.Timeout; constructor(index: number, stationTemplateFile: string) { this.index = index; this.stationTemplateFile = stationTemplateFile; - this.connectors = {} as Connectors; + this.connectors = new Map(); this.initialize(); - this.hasStopped = false; - this.hasSocketRestarted = false; + this.stopped = false; + this.wsConnectionRestarted = false; this.autoReconnectRetryCount = 0; - this.requests = {} as Requests; - this.messageQueue = [] as string[]; + this.requests = new Map(); + this.messageBuffer = new Set(); this.authorizedTags = this.getAuthorizedTags(); } @@ -82,8 +84,8 @@ export default class ChargingStation { return this.bootNotificationRequest; } - public getRandomTagId(): string { - const index = Math.floor(Math.random() * this.authorizedTags.length); + public getRandomIdTag(): string { + const index = Math.floor(Utils.secureRandom() * this.authorizedTags.length); return this.authorizedTags[index]; } @@ -109,7 +111,7 @@ export default class ChargingStation { } public isWebSocketConnectionOpened(): boolean { - return this.wsConnection?.readyState === WebSocket.OPEN; + return this.wsConnection?.readyState === OPEN; } public isRegistered(): boolean { @@ -117,15 +119,19 @@ export default class ChargingStation { } public isChargingStationAvailable(): boolean { - return this.getConnector(0).availability === AvailabilityType.OPERATIVE; + return this.getConnectorStatus(0).availability === AvailabilityType.OPERATIVE; } public isConnectorAvailable(id: number): boolean { - return this.getConnector(id).availability === AvailabilityType.OPERATIVE; + return this.getConnectorStatus(id).availability === AvailabilityType.OPERATIVE; + } + + public getNumberOfConnectors(): number { + return this.connectors.get(0) ? this.connectors.size - 1 : this.connectors.size; } - public getConnector(id: number): Connector { - return this.connectors[id]; + public getConnectorStatus(id: number): ConnectorStatus { + return this.connectors.get(id); } public getCurrentOutType(): CurrentType | undefined { @@ -150,9 +156,9 @@ export default class ChargingStation { } public getTransactionIdTag(transactionId: number): string | undefined { - for (const connector in this.connectors) { - if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) { - return this.getConnector(Utils.convertToInt(connector)).transactionIdTag; + for (const connectorId of this.connectors.keys()) { + if (connectorId > 0 && this.getConnectorStatus(connectorId).transactionId === transactionId) { + return this.getConnectorStatus(connectorId).transactionIdTag; } } } @@ -183,24 +189,24 @@ export default class ChargingStation { public getEnergyActiveImportRegisterByTransactionId(transactionId: number): number | undefined { if (this.getMeteringPerTransaction()) { - for (const connector in this.connectors) { - if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) { - return this.getConnector(Utils.convertToInt(connector)).transactionEnergyActiveImportRegisterValue; + for (const connectorId of this.connectors.keys()) { + if (connectorId > 0 && this.getConnectorStatus(connectorId).transactionId === transactionId) { + return this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue; } } } - for (const connector in this.connectors) { - if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) { - return this.getConnector(Utils.convertToInt(connector)).energyActiveImportRegisterValue; + for (const connectorId of this.connectors.keys()) { + if (connectorId > 0 && this.getConnectorStatus(connectorId).transactionId === transactionId) { + return this.getConnectorStatus(connectorId).energyActiveImportRegisterValue; } } } public getEnergyActiveImportRegisterByConnectorId(connectorId: number): number | undefined { if (this.getMeteringPerTransaction()) { - return this.getConnector(connectorId).transactionEnergyActiveImportRegisterValue; + return this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue; } - return this.getConnector(connectorId).energyActiveImportRegisterValue; + return this.getConnectorStatus(connectorId).energyActiveImportRegisterValue; } public getAuthorizeRemoteTxRequests(): boolean { @@ -223,35 +229,34 @@ export default class ChargingStation { 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}`); + 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`); + 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.getConnector(connectorId).MeterValues; + 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}`); - continue; + 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)) { + && 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)) { + && 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)) { + && (!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}`; + 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}`); + logger.debug(`${this.logPrefix()} No MeterValues for measurand '${measurand}' ${phase ? `on phase ${phase} ` : ''}in template on connectorId ${connectorId}`); } public getAutomaticTransactionGeneratorRequireAuthorize(): boolean { @@ -264,11 +269,11 @@ export default class ChargingStation { this.heartbeatSetInterval = setInterval(async (): Promise => { await this.ocppRequestService.sendHeartbeat(); }, this.getHeartbeatInterval()); - logger.info(this.logPrefix() + ' Heartbeat started every ' + Utils.milliSecondsToHHMMSS(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.milliSecondsToHHMMSS(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.milliSecondsToHHMMSS(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`); } } @@ -284,24 +289,24 @@ export default class ChargingStation { logger.error(`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId.toString()}`); return; } - if (!this.getConnector(connectorId)) { + if (!this.getConnectorStatus(connectorId)) { logger.error(`${this.logPrefix()} Trying to start MeterValues on non existing connector Id ${connectorId.toString()}`); return; } - if (!this.getConnector(connectorId)?.transactionStarted) { + if (!this.getConnectorStatus(connectorId)?.transactionStarted) { logger.error(`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction started`); return; - } else if (this.getConnector(connectorId)?.transactionStarted && !this.getConnector(connectorId)?.transactionId) { + } else if (this.getConnectorStatus(connectorId)?.transactionStarted && !this.getConnectorStatus(connectorId)?.transactionId) { logger.error(`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction id`); return; } if (interval > 0) { // eslint-disable-next-line @typescript-eslint/no-misused-promises - this.getConnector(connectorId).transactionSetInterval = setInterval(async (): Promise => { - await this.ocppRequestService.sendMeterValues(connectorId, this.getConnector(connectorId).transactionId, interval); + this.getConnectorStatus(connectorId).transactionSetInterval = setInterval(async (): Promise => { + await this.ocppRequestService.sendMeterValues(connectorId, this.getConnectorStatus(connectorId).transactionId, interval); }, interval); } else { - logger.error(`${this.logPrefix()} Charging station ${StandardParametersKey.MeterValueSampleInterval} configuration set to ${interval ? Utils.milliSecondsToHHMMSS(interval) : interval}, not sending MeterValues`); + logger.error(`${this.logPrefix()} Charging station ${StandardParametersKey.MeterValueSampleInterval} configuration set to ${interval ? Utils.formatDurationMilliSeconds(interval) : interval}, not sending MeterValues`); } } @@ -314,27 +319,27 @@ export default class ChargingStation { this.startAuthorizationFileMonitoring(); // Monitor station template file this.startStationTemplateFileMonitoring(); - // Handle Socket incoming messages + // Handle WebSocket message this.wsConnection.on('message', this.onMessage.bind(this)); - // Handle Socket error + // Handle WebSocket error this.wsConnection.on('error', this.onError.bind(this)); - // Handle Socket close + // Handle WebSocket close this.wsConnection.on('close', this.onClose.bind(this)); - // Handle Socket opening connection + // Handle WebSocket open this.wsConnection.on('open', this.onOpen.bind(this)); - // Handle Socket ping + // Handle WebSocket ping this.wsConnection.on('ping', this.onPing.bind(this)); - // Handle Socket pong + // Handle WebSocket pong this.wsConnection.on('pong', this.onPong.bind(this)); } public async stop(reason: StopTransactionReason = StopTransactionReason.NONE): Promise { // Stop message sequence await this.stopMessageSequence(reason); - for (const connector in this.connectors) { - if (Utils.convertToInt(connector) > 0) { - await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), ChargePointStatus.UNAVAILABLE); - this.getConnector(Utils.convertToInt(connector)).status = ChargePointStatus.UNAVAILABLE; + for (const connectorId of this.connectors.keys()) { + if (connectorId > 0) { + await this.ocppRequestService.sendStatusNotification(connectorId, ChargePointStatus.UNAVAILABLE); + this.getConnectorStatus(connectorId).status = ChargePointStatus.UNAVAILABLE; } } if (this.isWebSocketConnectionOpened()) { @@ -344,7 +349,7 @@ export default class ChargingStation { this.performanceStatistics.stop(); } this.bootNotificationResponse = null; - this.hasStopped = true; + this.stopped = true; } public getConfigurationKey(key: string | StandardParametersKey, caseInsensitive = false): ConfigurationKey | undefined { @@ -383,59 +388,49 @@ export default class ChargingStation { public setChargingProfile(connectorId: number, cp: ChargingProfile): void { let cpReplaced = false; - if (!Utils.isEmptyArray(this.getConnector(connectorId).chargingProfiles)) { - this.getConnector(connectorId).chargingProfiles?.forEach((chargingProfile: ChargingProfile, index: number) => { + 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.getConnector(connectorId).chargingProfiles[index] = cp; + || (chargingProfile.stackLevel === cp.stackLevel && chargingProfile.chargingProfilePurpose === cp.chargingProfilePurpose)) { + this.getConnectorStatus(connectorId).chargingProfiles[index] = cp; cpReplaced = true; } }); } - !cpReplaced && this.getConnector(connectorId).chargingProfiles?.push(cp); + !cpReplaced && this.getConnectorStatus(connectorId).chargingProfiles?.push(cp); } - public resetTransactionOnConnector(connectorId: number): void { - this.getConnector(connectorId).authorized = false; - this.getConnector(connectorId).transactionStarted = false; - delete this.getConnector(connectorId).authorizeIdTag; - delete this.getConnector(connectorId).transactionId; - delete this.getConnector(connectorId).transactionIdTag; - this.getConnector(connectorId).transactionEnergyActiveImportRegisterValue = 0; - delete this.getConnector(connectorId).transactionBeginMeterValue; + public resetConnectorStatus(connectorId: number): void { + this.getConnectorStatus(connectorId).idTagLocalAuthorized = false; + this.getConnectorStatus(connectorId).idTagAuthorized = false; + this.getConnectorStatus(connectorId).transactionRemoteStarted = false; + this.getConnectorStatus(connectorId).transactionStarted = false; + delete this.getConnectorStatus(connectorId).localAuthorizeIdTag; + delete this.getConnectorStatus(connectorId).authorizeIdTag; + delete this.getConnectorStatus(connectorId).transactionId; + delete this.getConnectorStatus(connectorId).transactionIdTag; + this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue = 0; + delete this.getConnectorStatus(connectorId).transactionBeginMeterValue; this.stopMeterValues(connectorId); } - public 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; - break; - } - } - if (!dups) { - // Queue message - this.messageQueue.push(message); - } + public bufferMessage(message: string): void { + this.messageBuffer.add(message); } - private flushMessageQueue() { - if (!Utils.isEmptyArray(this.messageQueue)) { - this.messageQueue.forEach((message, index) => { - this.messageQueue.splice(index, 1); + private flushMessageBuffer() { + 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 - let instanceIndex = process.env.CF_INSTANCE_INDEX ?? 0; - instanceIndex = instanceIndex > 0 ? instanceIndex : ''; + 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; } @@ -451,9 +446,12 @@ export default class ChargingStation { FileUtils.handleFileException(this.logPrefix(), 'Template', this.stationTemplateFile, error); } const stationInfo: ChargingStationInfo = stationTemplateFromFile ?? {} as ChargingStationInfo; + stationInfo.wsOptions = stationTemplateFromFile?.wsOptions ?? {}; + stationInfo.wsOptions.origin = stationTemplateFromFile?.wsOptions?.origin ?? 'http://localhost'; + stationInfo.wsOptions.handshakeTimeout = stationTemplateFromFile?.wsOptions?.handshakeTimeout ?? this.getConnectionTimeout() * 1000; if (!Utils.isEmptyArray(stationTemplateFromFile.power)) { stationTemplateFromFile.power = stationTemplateFromFile.power as number[]; - const powerArrayRandomIndex = Math.floor(Math.random() * stationTemplateFromFile.power.length); + const powerArrayRandomIndex = Math.floor(Utils.secureRandom() * stationTemplateFromFile.power.length); stationInfo.maxPower = stationTemplateFromFile.powerUnit === PowerUnits.KILO_WATT ? stationTemplateFromFile.power[powerArrayRandomIndex] * 1000 : stationTemplateFromFile.power[powerArrayRandomIndex]; @@ -508,28 +506,30 @@ export default class ChargingStation { this.stationInfo.randomConnectors = true; } const connectorsConfigHash = crypto.createHash('sha256').update(JSON.stringify(this.stationInfo.Connectors) + maxConnectors.toString()).digest('hex'); - // FIXME: Handle shrinking the number of connectors - if (!this.connectors || (this.connectors && this.connectorsConfigurationHash !== connectorsConfigHash)) { + const connectorsConfigChanged = this.connectors?.size !== 0 && this.connectorsConfigurationHash !== connectorsConfigHash; + if (this.connectors?.size === 0 || connectorsConfigChanged) { + connectorsConfigChanged && (this.connectors.clear()); this.connectorsConfigurationHash = connectorsConfigHash; // Add connector Id 0 let lastConnector = '0'; for (lastConnector in this.stationInfo.Connectors) { - if (Utils.convertToInt(lastConnector) === 0 && this.getUseConnectorId0() && this.stationInfo.Connectors[lastConnector]) { - this.connectors[lastConnector] = Utils.cloneObject(this.stationInfo.Connectors[lastConnector]); - this.connectors[lastConnector].availability = AvailabilityType.OPERATIVE; - if (Utils.isUndefined(this.connectors[lastConnector]?.chargingProfiles)) { - this.connectors[lastConnector].chargingProfiles = []; + 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.getRandomInt(Utils.convertToInt(lastConnector), 1) : index; - this.connectors[index] = Utils.cloneObject(this.stationInfo.Connectors[randConnectorId]); - this.connectors[index].availability = AvailabilityType.OPERATIVE; - if (Utils.isUndefined(this.connectors[lastConnector]?.chargingProfiles)) { - this.connectors[index].chargingProfiles = []; + 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 = []; } } } @@ -537,9 +537,9 @@ export default class ChargingStation { // Avoid duplication of connectors related information delete this.stationInfo.Connectors; // Initialize transaction attributes on connectors - for (const connector in this.connectors) { - if (Utils.convertToInt(connector) > 0 && !this.getConnector(Utils.convertToInt(connector)).transactionStarted) { - this.initTransactionAttributesOnConnector(Utils.convertToInt(connector)); + for (const connectorId of this.connectors.keys()) { + if (connectorId > 0 && !this.getConnectorStatus(connectorId)?.transactionStarted) { + this.initializeConnectorStatus(connectorId); } } switch (this.getOCPPVersion()) { @@ -576,17 +576,17 @@ export default class ChargingStation { } if (!this.getConfigurationKey(StandardParametersKey.ConnectorPhaseRotation)) { const connectorPhaseRotation = []; - for (const connector in this.connectors) { + for (const connectorId of this.connectors.keys()) { // AC/DC - if (Utils.convertToInt(connector) === 0 && this.getNumberOfPhases() === 0) { - connectorPhaseRotation.push(`${connector}.${ConnectorPhaseRotation.RST}`); - } else if (Utils.convertToInt(connector) > 0 && this.getNumberOfPhases() === 0) { - connectorPhaseRotation.push(`${connector}.${ConnectorPhaseRotation.NotApplicable}`); + if (connectorId === 0 && this.getNumberOfPhases() === 0) { + connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.RST}`); + } else if (connectorId > 0 && this.getNumberOfPhases() === 0) { + connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.NotApplicable}`); // AC - } else if (Utils.convertToInt(connector) > 0 && this.getNumberOfPhases() === 1) { - connectorPhaseRotation.push(`${connector}.${ConnectorPhaseRotation.NotApplicable}`); - } else if (Utils.convertToInt(connector) > 0 && this.getNumberOfPhases() === 3) { - connectorPhaseRotation.push(`${connector}.${ConnectorPhaseRotation.RST}`); + } 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()); @@ -595,7 +595,7 @@ export default class ChargingStation { this.addConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests, 'true'); } if (!this.getConfigurationKey(StandardParametersKey.LocalAuthListEnabled) - && this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles).value.includes(SupportedFeatureProfiles.Local_Auth_List_Management)) { + && this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles).value.includes(SupportedFeatureProfiles.Local_Auth_List_Management)) { this.addConfigurationKey(StandardParametersKey.LocalAuthListEnabled, 'false'); } if (!this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) { @@ -619,39 +619,43 @@ export default class ChargingStation { } if (this.isRegistered()) { await this.startMessageSequence(); - this.hasStopped && (this.hasStopped = false); - if (this.hasSocketRestarted && this.isWebSocketConnectionOpened()) { - this.flushMessageQueue(); + this.stopped && (this.stopped = false); + if (this.wsConnectionRestarted && this.isWebSocketConnectionOpened()) { + this.flushMessageBuffer(); } } else { logger.error(`${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})`); } this.autoReconnectRetryCount = 0; - this.hasSocketRestarted = false; + this.wsConnectionRestarted = false; } - private async onClose(closeEvent: any): Promise { - switch (closeEvent) { - case WebSocketCloseEventStatusCode.CLOSE_NORMAL: // Normal close + private async onClose(code: number, reason: string): Promise { + switch (code) { + // Normal close + case WebSocketCloseEventStatusCode.CLOSE_NORMAL: case WebSocketCloseEventStatusCode.CLOSE_NO_STATUS: - logger.info(`${this.logPrefix()} Socket normally closed with status '${Utils.getWebSocketCloseEventStatusString(closeEvent)}'`); + logger.info(`${this.logPrefix()} WebSocket normally closed with status '${Utils.getWebSocketCloseEventStatusString(code)}' and reason '${reason}'`); this.autoReconnectRetryCount = 0; break; - default: // Abnormal close - logger.error(`${this.logPrefix()} Socket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString(closeEvent)}'`); - await this.reconnect(closeEvent); + // Abnormal close + default: + logger.error(`${this.logPrefix()} WebSocket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString(code)}' and reason '${reason}'`); + await this.reconnect(code); break; } } - private async onMessage(messageEvent: MessageEvent): Promise { + 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 rejectCallback: (error: OCPPError, requestStatistic?: boolean) => void; + let requestCommandName: RequestCommand | IncomingRequestCommand; let requestPayload: Record; + let cachedRequest: CachedRequest; let errMsg: string; try { - const request = JSON.parse(messageEvent.toString()) as IncomingRequest; + const request = JSON.parse(data.toString()) as IncomingRequest; if (Utils.isIterable(request)) { // Parse the message [messageType, messageId, commandName, commandPayload, errorDetails] = request; @@ -671,31 +675,31 @@ export default class ChargingStation { // Outcome Message case MessageType.CALL_RESULT_MESSAGE: // Respond - if (Utils.isIterable(this.requests[messageId])) { - [responseCallback, , requestPayload] = this.requests[messageId]; + cachedRequest = this.requests.get(messageId); + if (Utils.isIterable(cachedRequest)) { + [responseCallback, , , requestPayload] = cachedRequest; } else { - throw new OCPPError(ErrorType.PROTOCOL_ERROR, `Response request for message id ${messageId} is not iterable`, commandName); + throw new OCPPError(ErrorType.PROTOCOL_ERROR, `Cached request for message id ${messageId} response is not iterable`, commandName); } if (!responseCallback) { // Error - throw new OCPPError(ErrorType.INTERNAL_ERROR, `Response request for unknown message id ${messageId}`, commandName); + throw new OCPPError(ErrorType.INTERNAL_ERROR, `Response for unknown message id ${messageId}`, commandName); } - delete this.requests[messageId]; responseCallback(commandName, requestPayload); break; // Error Message case MessageType.CALL_ERROR_MESSAGE: - if (!this.requests[messageId]) { - // Error - throw new OCPPError(ErrorType.INTERNAL_ERROR, `Error request for unknown message id ${messageId}`); - } - if (Utils.isIterable(this.requests[messageId])) { - [, rejectCallback] = this.requests[messageId]; + cachedRequest = this.requests.get(messageId); + if (Utils.isIterable(cachedRequest)) { + [, rejectCallback, requestCommandName] = cachedRequest; } else { - throw new OCPPError(ErrorType.PROTOCOL_ERROR, `Error request for message id ${messageId} is not iterable`); + throw new OCPPError(ErrorType.PROTOCOL_ERROR, `Cached request for message id ${messageId} error response is not iterable`); } - delete this.requests[messageId]; - rejectCallback(new OCPPError(commandName, commandPayload.toString(), null, errorDetails)); + 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: @@ -705,9 +709,9 @@ export default class ChargingStation { } } catch (error) { // Log - logger.error('%s Incoming request message %j processing error %j on content type %j', this.logPrefix(), messageEvent, error, this.requests[messageId]); + logger.error('%s Incoming OCPP message %j matching cached request %j processing error %j', this.logPrefix(), data.toString(), this.requests.get(messageId), error); // Send error - messageType !== MessageType.CALL_ERROR_MESSAGE && await this.ocppRequestService.sendError(messageId, error, commandName); + messageType === MessageType.CALL_MESSAGE && await this.ocppRequestService.sendError(messageId, error, commandName); } } @@ -719,11 +723,11 @@ export default class ChargingStation { logger.debug(this.logPrefix() + ' Received a WS pong (rfc6455) from the server'); } - private async onError(errorEvent: any): Promise { - logger.error(this.logPrefix() + ' Socket error: %j', errorEvent); - // switch (errorEvent.code) { + private async onError(error: WSError): Promise { + logger.error(this.logPrefix() + ' WebSocket error: %j', error); + // switch (error.code) { // case 'ECONNREFUSED': - // await this._reconnect(errorEvent); + // await this.reconnect(error); // break; // } } @@ -760,8 +764,8 @@ export default class ChargingStation { private getNumberOfRunningTransactions(): number { let trxCount = 0; - for (const connector in this.connectors) { - if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionStarted) { + for (const connectorId of this.connectors.keys()) { + if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted) { trxCount++; } } @@ -821,34 +825,30 @@ export default class ChargingStation { return maxConnectors; } - private getNumberOfConnectors(): number { - return this.connectors[0] ? Object.keys(this.connectors).length - 1 : Object.keys(this.connectors).length; - } - private async startMessageSequence(): Promise { // Start WebSocket ping this.startWebSocketPing(); // Start heartbeat this.startHeartbeat(); // Initialize connectors status - for (const connector in this.connectors) { - if (Utils.convertToInt(connector) === 0) { + for (const connectorId of this.connectors.keys()) { + if (connectorId === 0) { continue; - } else if (!this.hasStopped && !this.getConnector(Utils.convertToInt(connector))?.status && this.getConnector(Utils.convertToInt(connector))?.bootStatus) { + } else if (!this.stopped && !this.getConnectorStatus(connectorId)?.status && this.getConnectorStatus(connectorId)?.bootStatus) { // Send status in template at startup - await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).bootStatus); - this.getConnector(Utils.convertToInt(connector)).status = this.getConnector(Utils.convertToInt(connector)).bootStatus; - } else if (this.hasStopped && this.getConnector(Utils.convertToInt(connector))?.bootStatus) { + 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) { // Send status in template after reset - await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).bootStatus); - this.getConnector(Utils.convertToInt(connector)).status = this.getConnector(Utils.convertToInt(connector)).bootStatus; - } else if (!this.hasStopped && this.getConnector(Utils.convertToInt(connector))?.status) { + 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) { // Send previous status at template reload - await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).status); + await this.ocppRequestService.sendStatusNotification(connectorId, this.getConnectorStatus(connectorId).status); } else { // Send default status - await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), ChargePointStatus.AVAILABLE); - this.getConnector(Utils.convertToInt(connector)).status = ChargePointStatus.AVAILABLE; + await this.ocppRequestService.sendStatusNotification(connectorId, ChargePointStatus.AVAILABLE); + this.getConnectorStatus(connectorId).status = ChargePointStatus.AVAILABLE; } } // Start the ATG @@ -857,12 +857,11 @@ export default class ChargingStation { private startAutomaticTransactionGenerator() { if (this.stationInfo.AutomaticTransactionGenerator.enable) { - if (!this.automaticTransactionGeneration) { - this.automaticTransactionGeneration = new AutomaticTransactionGenerator(this); + if (!this.automaticTransactionGenerator) { + this.automaticTransactionGenerator = new AutomaticTransactionGenerator(this); } - if (this.automaticTransactionGeneration.timeToStop) { - // The ATG might sleep - void this.automaticTransactionGeneration.start(); + if (!this.automaticTransactionGenerator.started) { + this.automaticTransactionGenerator.start(); } } } @@ -874,13 +873,13 @@ export default class ChargingStation { this.stopHeartbeat(); // Stop the ATG if (this.stationInfo.AutomaticTransactionGenerator.enable && - this.automaticTransactionGeneration && - !this.automaticTransactionGeneration.timeToStop) { - await this.automaticTransactionGeneration.stop(reason); + this.automaticTransactionGenerator && + this.automaticTransactionGenerator.started) { + this.automaticTransactionGenerator.stop(); } else { - for (const connector in this.connectors) { - if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionStarted) { - const transactionId = this.getConnector(Utils.convertToInt(connector)).transactionId; + 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); } @@ -895,14 +894,14 @@ export default class ChargingStation { if (webSocketPingInterval > 0 && !this.webSocketPingSetInterval) { this.webSocketPingSetInterval = setInterval(() => { if (this.isWebSocketConnectionOpened()) { - this.wsConnection.ping((): void => { }); + this.wsConnection.ping((): void => { /* This is intentional */ }); } }, webSocketPingInterval * 1000); - logger.info(this.logPrefix() + ' WebSocket ping started every ' + Utils.secondsToHHMMSS(webSocketPingInterval)); + logger.info(this.logPrefix() + ' WebSocket ping started every ' + Utils.formatDurationSeconds(webSocketPingInterval)); } else if (this.webSocketPingSetInterval) { - logger.info(this.logPrefix() + ' WebSocket ping every ' + Utils.secondsToHHMMSS(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.secondsToHHMMSS(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`); } } @@ -920,7 +919,7 @@ export default class ChargingStation { indexUrl = this.index % supervisionUrls.length; } else { // Get a random url - indexUrl = Math.floor(Math.random() * supervisionUrls.length); + indexUrl = Math.floor(Utils.secureRandom() * supervisionUrls.length); } return new URL(supervisionUrls[indexUrl]); } @@ -946,9 +945,7 @@ export default class ChargingStation { } } - private openWSConnection(options?: ClientOptions & ClientRequestArgs, forceCloseOpened = false): void { - options = options ?? {}; - options.handshakeTimeout = options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000; + private openWSConnection(options: ClientOptions & ClientRequestArgs = this.stationInfo.wsOptions, forceCloseOpened = false): void { if (!Utils.isNullOrUndefined(this.stationInfo.supervisionUser) && !Utils.isNullOrUndefined(this.stationInfo.supervisionPassword)) { options.auth = `${this.stationInfo.supervisionUser}:${this.stationInfo.supervisionPassword}`; } @@ -969,8 +966,8 @@ export default class ChargingStation { } private stopMeterValues(connectorId: number) { - if (this.getConnector(connectorId)?.transactionSetInterval) { - clearInterval(this.getConnector(connectorId).transactionSetInterval); + if (this.getConnectorStatus(connectorId)?.transactionSetInterval) { + clearInterval(this.getConnectorStatus(connectorId).transactionSetInterval); } } @@ -978,13 +975,15 @@ export default class ChargingStation { const authorizationFile = this.getAuthorizationFile(); if (authorizationFile) { try { - fs.watch(authorizationFile).on('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); + 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) { @@ -997,26 +996,27 @@ export default class ChargingStation { private startStationTemplateFileMonitoring(): void { try { - // eslint-disable-next-line @typescript-eslint/no-misused-promises - fs.watch(this.stationTemplateFile).on('change', async (): Promise => { - try { - logger.debug(this.logPrefix() + ' Template file ' + this.stationTemplateFile + ' have changed, reload'); - // Initialize - this.initialize(); - // Restart the ATG - if (!this.stationInfo.AutomaticTransactionGenerator.enable && - this.automaticTransactionGeneration) { - await this.automaticTransactionGeneration.stop(); - } - this.startAutomaticTransactionGenerator(); - if (this.getEnableStatistics()) { - this.performanceStatistics.restart(); - } else { - this.performanceStatistics.stop(); + 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); } - // 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) { @@ -1028,7 +1028,7 @@ export default class ChargingStation { return !Utils.isUndefined(this.stationInfo.reconnectExponentialDelay) ? this.stationInfo.reconnectExponentialDelay : false; } - private async reconnect(error: unknown): Promise { + private async reconnect(code: number): Promise { // Stop WebSocket ping this.stopWebSocketPing(); // Stop heartbeat @@ -1036,28 +1036,31 @@ export default class ChargingStation { // Stop the ATG if needed if (this.stationInfo.AutomaticTransactionGenerator.enable && this.stationInfo.AutomaticTransactionGenerator.stopOnConnectionFailure && - this.automaticTransactionGeneration && - !this.automaticTransactionGeneration.timeToStop) { - await this.automaticTransactionGeneration.stop(); + this.automaticTransactionGenerator && + this.automaticTransactionGenerator.started) { + this.automaticTransactionGenerator.stop(); } if (this.autoReconnectRetryCount < this.getAutoReconnectMaxRetries() || this.getAutoReconnectMaxRetries() === -1) { this.autoReconnectRetryCount++; const reconnectDelay = (this.getReconnectExponentialDelay() ? Utils.exponentialDelay(this.autoReconnectRetryCount) : this.getConnectionTimeout() * 1000); - logger.error(`${this.logPrefix()} Socket: connection retry in ${Utils.roundTo(reconnectDelay, 2)}ms, timeout ${reconnectDelay - 100}ms`); + const reconnectTimeout = (reconnectDelay - 100) > 0 ? reconnectDelay : 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() + ' Socket: reconnecting try #' + this.autoReconnectRetryCount.toString()); - this.openWSConnection({ handshakeTimeout: reconnectDelay - 100 }); - this.hasSocketRestarted = true; + logger.error(this.logPrefix() + ' WebSocket: reconnecting try #' + this.autoReconnectRetryCount.toString()); + this.openWSConnection({ ...this.stationInfo.wsOptions, handshakeTimeout: reconnectTimeout }, true); + this.wsConnectionRestarted = true; } else if (this.getAutoReconnectMaxRetries() !== -1) { - logger.error(`${this.logPrefix()} Socket reconnect failure: max retries reached (${this.autoReconnectRetryCount}) or retry disabled (${this.getAutoReconnectMaxRetries()})`); + logger.error(`${this.logPrefix()} WebSocket reconnect failure: max retries reached (${this.autoReconnectRetryCount}) or retry disabled (${this.getAutoReconnectMaxRetries()})`); } } - private initTransactionAttributesOnConnector(connectorId: number): void { - this.getConnector(connectorId).authorized = false; - this.getConnector(connectorId).transactionStarted = false; - this.getConnector(connectorId).energyActiveImportRegisterValue = 0; - this.getConnector(connectorId).transactionEnergyActiveImportRegisterValue = 0; + 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; } }