X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FChargingStation.ts;h=6be15b83e980656b237a7a1586078134dd17ae54;hb=caad9d6b03dbfc507da6d8e79ccbbaf74593e981;hp=10806bd295bf93134f8ec3734c597378b2788fba;hpb=36f6a92e3ab0a4a452da57aad6510bda259296ce;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ChargingStation.ts b/src/charging-station/ChargingStation.ts index 10806bd2..6be15b83 100644 --- a/src/charging-station/ChargingStation.ts +++ b/src/charging-station/ChargingStation.ts @@ -1,85 +1,99 @@ +// 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, { CurrentOutType, PowerUnits, VoltageOut } from '../types/ChargingStationTemplate'; -import { ConnectorPhaseRotation, StandardParametersKey, SupportedFeatureProfiles } from '../types/ocpp/Configuration'; -import Connectors, { Connector } from '../types/Connectors'; -import { PerformanceObserver, performance } from 'perf_hooks'; -import Requests, { AvailabilityType, BootNotificationRequest, IncomingRequest, IncomingRequestCommand } from '../types/ocpp/Requests'; -import WebSocket, { MessageEvent } from 'ws'; +import ChargingStationTemplate, { CurrentType, PowerUnits, Voltage } from '../types/ChargingStationTemplate'; +import { ConnectorPhaseRotation, StandardParametersKey, SupportedFeatureProfiles, VendorDefaultParametersKey } from '../types/ocpp/Configuration'; +import { MeterValueMeasurand, MeterValuePhase } from '../types/ocpp/MeterValues'; +import { WSError, WebSocketCloseEventStatusCode } from '../types/WebSocket'; +import WebSocket, { ClientOptions, Data, OPEN } from 'ws'; import AutomaticTransactionGenerator from './AutomaticTransactionGenerator'; import { ChargePointStatus } from '../types/ocpp/ChargePointStatus'; import { ChargingProfile } from '../types/ocpp/ChargingProfile'; import ChargingStationInfo from '../types/ChargingStationInfo'; +import { ChargingStationWorkerMessageEvents } from '../types/ChargingStationWorker'; +import { ClientRequestArgs } from 'http'; import Configuration from '../utils/Configuration'; +import { ConnectorStatus } from '../types/ConnectorStatus'; import Constants from '../utils/Constants'; +import { ErrorType } from '../types/ocpp/ErrorType'; import FileUtils from '../utils/FileUtils'; import { MessageType } from '../types/ocpp/MessageType'; -import { MeterValueMeasurand } from '../types/ocpp/MeterValues'; -import OCPP16IncomingRequestService from './ocpp/1.6/OCCP16IncomingRequestService'; +import OCPP16IncomingRequestService from './ocpp/1.6/OCPP16IncomingRequestService'; import OCPP16RequestService from './ocpp/1.6/OCPP16RequestService'; import OCPP16ResponseService from './ocpp/1.6/OCPP16ResponseService'; -import OCPPError from './OcppError'; +import OCPPError from '../exception/OCPPError'; import OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService'; import OCPPRequestService from './ocpp/OCPPRequestService'; import { OCPPVersion } from '../types/ocpp/OCPPVersion'; -import PerformanceStatistics from '../utils/PerformanceStatistics'; +import PerformanceStatistics from '../performance/PerformanceStatistics'; +import { SampledValueTemplate } from '../types/MeasurandPerPhaseSampledValueTemplates'; import { StopTransactionReason } from '../types/ocpp/Transaction'; +import { SupervisionUrlDistribution } from '../types/ConfigurationData'; +import { URL } from 'url'; import Utils from '../utils/Utils'; -import { WebSocketCloseEventStatusCode } from '../types/WebSocket'; import crypto from 'crypto'; import fs from 'fs'; import logger from '../utils/Logger'; +import { parentPort } from 'worker_threads'; 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 supervisionUrl!: string; - private wsConnectionUrl!: string; - private hasSocketRestarted: boolean; + private ocppIncomingRequestService!: OCPPIncomingRequestService; + private readonly messageBuffer: Set; + private wsConfiguredConnectionUrl!: URL; + private wsConnectionRestarted: boolean; + private stopped: boolean; private autoReconnectRetryCount: number; - private automaticTransactionGeneration!: AutomaticTransactionGenerator; - private performanceObserver!: PerformanceObserver; + 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(); } + get wsConnectionUrl(): URL { + return this.getSupervisionUrlOcppConfiguration() ? new URL(this.getConfigurationKey(this.stationInfo.supervisionUrlOcppKey ?? VendorDefaultParametersKey.ConnectionUrl).value + '/' + this.stationInfo.chargingStationId) : this.wsConfiguredConnectionUrl; + } + public logPrefix(): string { return Utils.logPrefix(` ${this.stationInfo.chargingStationId} |`); } - public getRandomTagId(): string { - const index = Math.floor(Math.random() * this.authorizedTags.length); + public getBootNotificationRequest(): BootNotificationRequest { + return this.bootNotificationRequest; + } + + public getRandomIdTag(): string { + const index = Math.floor(Utils.secureRandom() * this.authorizedTags.length); return this.authorizedTags[index]; } @@ -91,60 +105,80 @@ export default class ChargingStation { return !Utils.isUndefined(this.stationInfo.enableStatistics) ? this.stationInfo.enableStatistics : true; } + public getMayAuthorizeAtRemoteStart(): boolean | undefined { + return this.stationInfo.mayAuthorizeAtRemoteStart ?? true; + } + public getNumberOfPhases(): number | undefined { switch (this.getCurrentOutType()) { - case CurrentOutType.AC: + case CurrentType.AC: return !Utils.isUndefined(this.stationInfo.numberOfPhases) ? this.stationInfo.numberOfPhases : 3; - case CurrentOutType.DC: + case CurrentType.DC: return 0; } } - public isWebSocketOpen(): boolean { - return this.wsConnection?.readyState === WebSocket.OPEN; + public isWebSocketConnectionOpened(): boolean { + return this?.wsConnection?.readyState === OPEN; + } + + 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.isInAcceptedState() || this.isInPendingState(); } 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(): CurrentOutType | undefined { - return !Utils.isUndefined(this.stationInfo.currentOutType) ? this.stationInfo.currentOutType : CurrentOutType.AC; + public getCurrentOutType(): CurrentType | undefined { + return this.stationInfo.currentOutType ?? CurrentType.AC; } 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 CurrentOutType.AC: - defaultVoltageOut = VoltageOut.VOLTAGE_230; + case CurrentType.AC: + defaultVoltageOut = Voltage.VOLTAGE_230; break; - case CurrentOutType.DC: - defaultVoltageOut = VoltageOut.VOLTAGE_400; + case CurrentType.DC: + defaultVoltageOut = Voltage.VOLTAGE_400; break; default: logger.error(errMsg); - throw Error(errMsg); + throw new Error(errMsg); } return !Utils.isUndefined(this.stationInfo.voltageOut) ? this.stationInfo.voltageOut : defaultVoltageOut; } 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)).idTag; + for (const connectorId of this.connectors.keys()) { + if (connectorId > 0 && this.getConnectorStatus(connectorId).transactionId === transactionId) { + return this.getConnectorStatus(connectorId).transactionIdTag; } } } @@ -165,26 +199,34 @@ export default class ChargingStation { return this.stationInfo.transactionDataMeterValues ?? false; } + public getMainVoltageMeterValues(): boolean { + return this.stationInfo.mainVoltageMeterValues ?? true; + } + + public getPhaseLineToLineVoltageMeterValues(): boolean { + return this.stationInfo.phaseLineToLineVoltageMeterValues ?? false; + } + 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 { @@ -204,6 +246,39 @@ export default class ChargingStation { 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; } @@ -214,11 +289,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`); } } @@ -234,83 +309,85 @@ 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 => { - if (this.getEnableStatistics()) { - const sendMeterValues = performance.timerify(this.ocppRequestService.sendMeterValues); - this.performanceObserver.observe({ - entryTypes: ['function'], - }); - await sendMeterValues(connectorId, this.getConnector(connectorId).transactionId, interval, this.ocppRequestService); - } else { - await this.ocppRequestService.sendMeterValues(connectorId, this.getConnector(connectorId).transactionId, interval, this.ocppRequestService); - } + 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`); } } public start(): void { + if (this.getEnableStatistics()) { + this.performanceStatistics.start(); + } this.openWSConnection(); // Monitor authorization file 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)); + parentPort.postMessage({ id: ChargingStationWorkerMessageEvents.STARTED, data: { id: this.stationInfo.chargingStationId } }); } public async stop(reason: StopTransactionReason = StopTransactionReason.NONE): Promise { // Stop message sequence await this.stopMessageSequence(reason); - for (const 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.isWebSocketOpen()) { + if (this.isWebSocketConnectionOpened()) { this.wsConnection.close(); } + if (this.getEnableStatistics()) { + this.performanceStatistics.stop(); + } this.bootNotificationResponse = null; - this.hasStopped = true; + parentPort.postMessage({ id: ChargingStationWorkerMessageEvents.STOPPED, data: { id: this.stationInfo.chargingStationId } }); + this.stopped = true; } public getConfigurationKey(key: string | StandardParametersKey, caseInsensitive = false): ConfigurationKey | undefined { - const configurationKey: ConfigurationKey | undefined = this.configuration.configurationKey.find((configElement) => { + return this.configuration.configurationKey.find((configElement) => { if (caseInsensitive) { return configElement.key.toLowerCase() === key.toLowerCase(); } return configElement.key === key; }); - return configurationKey; } - public addConfigurationKey(key: string | StandardParametersKey, value: string, readonly = false, visible = true, reboot = false): void { + public addConfigurationKey(key: string | StandardParametersKey, value: string, options: { readonly?: boolean, visible?: boolean, reboot?: boolean } = { readonly: false, visible: true, reboot: false }): void { const keyFound = this.getConfigurationKey(key); + const readonly = options.readonly; + const visible = options.visible; + const reboot = options.reboot; if (!keyFound) { this.configuration.configurationKey.push({ key, @@ -334,59 +411,56 @@ export default class ChargingStation { } } - public setChargingProfile(connectorId: number, cp: ChargingProfile): boolean { - if (!Utils.isEmptyArray(this.getConnector(connectorId).chargingProfiles)) { - this.getConnector(connectorId).chargingProfiles?.forEach((chargingProfile: ChargingProfile, index: number) => { + public setChargingProfile(connectorId: number, cp: ChargingProfile): void { + let cpReplaced = false; + if (!Utils.isEmptyArray(this.getConnectorStatus(connectorId).chargingProfiles)) { + this.getConnectorStatus(connectorId).chargingProfiles?.forEach((chargingProfile: ChargingProfile, index: number) => { if (chargingProfile.chargingProfileId === cp.chargingProfileId || (chargingProfile.stackLevel === cp.stackLevel && chargingProfile.chargingProfilePurpose === cp.chargingProfilePurpose)) { - this.getConnector(connectorId).chargingProfiles[index] = cp; - return true; + this.getConnectorStatus(connectorId).chargingProfiles[index] = cp; + cpReplaced = true; } }); } - this.getConnector(connectorId).chargingProfiles?.push(cp); - return true; + !cpReplaced && this.getConnectorStatus(connectorId).chargingProfiles?.push(cp); } - public resetTransactionOnConnector(connectorId: number): void { - this.getConnector(connectorId).transactionStarted = false; - delete this.getConnector(connectorId).transactionId; - delete this.getConnector(connectorId).idTag; - 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 getSupervisionUrlOcppConfiguration(): boolean { + return this.stationInfo.supervisionUrlOcppConfiguration ?? false; + } + private getChargingStationId(stationTemplate: ChargingStationTemplate): string { // In case of multiple instances: add instance index to charging station id - let instanceIndex = process.env.CF_INSTANCE_INDEX ? process.env.CF_INSTANCE_INDEX : 0; - instanceIndex = instanceIndex > 0 ? instanceIndex : ''; - const idSuffix = stationTemplate.nameSuffix ? stationTemplate.nameSuffix : ''; + 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; } @@ -398,12 +472,17 @@ export default class ChargingStation { stationTemplateFromFile = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as ChargingStationTemplate; fs.closeSync(fileDescriptor); } catch (error) { - FileUtils.handleFileException(this.logPrefix(), 'Template', this.stationTemplateFile, error); + FileUtils.handleFileException(this.logPrefix(), 'Template', this.stationTemplateFile, error as NodeJS.ErrnoException); } + const chargingStationId = this.getChargingStationId(stationTemplateFromFile); + // Deprecation template keys section + this.warnDeprecatedTemplateKey(stationTemplateFromFile, 'supervisionUrl', chargingStationId, 'Use \'supervisionUrls\' instead'); + this.convertDeprecatedTemplateKey(stationTemplateFromFile, 'supervisionUrl', 'supervisionUrls'); const stationInfo: ChargingStationInfo = stationTemplateFromFile ?? {} as ChargingStationInfo; + stationInfo.wsOptions = stationTemplateFromFile?.wsOptions ?? {}; if (!Utils.isEmptyArray(stationTemplateFromFile.power)) { stationTemplateFromFile.power = stationTemplateFromFile.power as number[]; - const powerArrayRandomIndex = Math.floor(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]; @@ -415,12 +494,12 @@ export default class ChargingStation { } delete stationInfo.power; delete stationInfo.powerUnit; - stationInfo.chargingStationId = this.getChargingStationId(stationTemplateFromFile); + stationInfo.chargingStationId = chargingStationId; stationInfo.resetTime = stationTemplateFromFile.resetTime ? stationTemplateFromFile.resetTime * 1000 : Constants.CHARGING_STATION_DEFAULT_RESET_TIME; return stationInfo; } - private getOCPPVersion(): OCPPVersion { + private getOcppVersion(): OCPPVersion { return this.stationInfo.ocppVersion ? this.stationInfo.ocppVersion : OCPPVersion.VERSION_16; } @@ -432,15 +511,14 @@ export default class ChargingStation { private initialize(): void { this.stationInfo = this.buildStationInfo(); + this.configuration = this.getTemplateChargingStationConfiguration(); + delete this.stationInfo.Configuration; this.bootNotificationRequest = { chargePointModel: this.stationInfo.chargePointModel, chargePointVendor: this.stationInfo.chargePointVendor, ...!Utils.isUndefined(this.stationInfo.chargeBoxSerialNumberPrefix) && { chargeBoxSerialNumber: this.stationInfo.chargeBoxSerialNumberPrefix }, ...!Utils.isUndefined(this.stationInfo.firmwareVersion) && { firmwareVersion: this.stationInfo.firmwareVersion }, }; - this.configuration = this.getTemplateChargingStationConfiguration(); - this.supervisionUrl = this.getSupervisionURL(); - this.wsConnectionUrl = this.supervisionUrl + '/' + this.stationInfo.chargingStationId; // Build connectors if needed const maxConnectors = this.getMaxNumberOfConnectors(); if (maxConnectors <= 0) { @@ -459,28 +537,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 = []; } } } @@ -488,41 +568,60 @@ 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()) { + this.wsConfiguredConnectionUrl = new URL(this.getConfiguredSupervisionUrl().href + '/' + this.stationInfo.chargingStationId); + switch (this.getOcppVersion()) { case OCPPVersion.VERSION_16: this.ocppIncomingRequestService = new OCPP16IncomingRequestService(this); this.ocppRequestService = new OCPP16RequestService(this, new OCPP16ResponseService(this)); break; default: - this.handleUnsupportedVersion(this.getOCPPVersion()); + this.handleUnsupportedVersion(this.getOcppVersion()); break; } // OCPP parameters + this.initOcppParameters(); + if (this.stationInfo.autoRegister) { + this.bootNotificationResponse = { + currentTime: new Date().toISOString(), + interval: this.getHeartbeatInterval() / 1000, + 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.getSupervisionUrlOcppConfiguration() && !this.getConfigurationKey(this.stationInfo.supervisionUrlOcppKey ?? VendorDefaultParametersKey.ConnectionUrl)) { + this.addConfigurationKey(VendorDefaultParametersKey.ConnectionUrl, this.getConfiguredSupervisionUrl().href, { reboot: true }); + } 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); + this.addConfigurationKey(StandardParametersKey.NumberOfConnectors, this.getNumberOfConnectors().toString(), { readonly: true }); if (!this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData)) { this.addConfigurationKey(StandardParametersKey.MeterValuesSampledData, MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER); } 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()); @@ -531,22 +630,16 @@ 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'); } - this.stationInfo.powerDivider = this.getPowerDivider(); - if (this.getEnableStatistics()) { - this.performanceStatistics = new PerformanceStatistics(this.stationInfo.chargingStationId); - this.performanceObserver = new PerformanceObserver((list) => { - const entry = list.getEntries()[0]; - this.performanceStatistics.logPerformance(entry, Constants.ENTITY_CHARGING_STATION); - this.performanceObserver.disconnect(); - }); + if (!this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) { + this.addConfigurationKey(StandardParametersKey.ConnectionTimeOut, Constants.DEFAULT_CONNECTION_TIMEOUT.toString()); } } private async onOpen(): Promise { - logger.info(`${this.logPrefix()} Is connected to server through ${this.wsConnectionUrl}`); + logger.info(`${this.logPrefix()} Connected to OCPP server through ${this.wsConnectionUrl.toString()}`); if (!this.isRegistered()) { // Send BootNotification let registrationRetryCount = 0; @@ -559,48 +652,71 @@ export default class ChargingStation { } } while (!this.isRegistered() && (registrationRetryCount <= this.getRegistrationMaxRetries() || this.getRegistrationMaxRetries() === -1)); } - if (this.isRegistered()) { + if (this.isRegistered() && this.stationInfo.autoRegister) { + await this.ocppRequestService.sendBootNotification(this.bootNotificationRequest.chargePointModel, + this.bootNotificationRequest.chargePointVendor, this.bootNotificationRequest.chargeBoxSerialNumber, this.bootNotificationRequest.firmwareVersion); + } + if (this.isInAcceptedState()) { + await this.startMessageSequence(); + this.stopped && (this.stopped = false); + if (this.wsConnectionRestarted && this.isWebSocketConnectionOpened()) { + this.flushMessageBuffer(); + } + } else if (this.isInPendingState()) { + // The central server shall issue a TriggerMessage to the charging station for the boot notification at the end of its configuration process + while (!this.isInAcceptedState()) { + await Utils.sleep(Constants.CHARGING_STATION_DEFAULT_START_SEQUENCE_DELAY); + } await this.startMessageSequence(); - this.hasStopped && (this.hasStopped = false); - if (this.hasSocketRestarted && this.isWebSocketOpen()) { - 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 { - // Parse the message - [messageType, messageId, commandName, commandPayload, errorDetails] = 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; + } 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.addMessage(commandName, messageType); + this.performanceStatistics.addRequestStatistic(commandName, messageType); } // Process the call await this.ocppIncomingRequestService.handleRequest(messageId, commandName, commandPayload); @@ -608,65 +724,65 @@ 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 Error(`Response request for message id ${messageId} is not iterable`); + throw new OCPPError(ErrorType.PROTOCOL_ERROR, `Cached request for message id ${messageId} response is not iterable`, commandName); } if (!responseCallback) { // Error - throw new Error(`Response request for unknown message id ${messageId}`); + 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 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 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(), 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: errMsg = `${this.logPrefix()} Wrong message type ${messageType}`; logger.error(errMsg); - throw new Error(errMsg); + throw new OCPPError(ErrorType.PROTOCOL_ERROR, errMsg); } } catch (error) { // Log - logger.error('%s Incoming message %j processing error %j on request 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 as OCPPError, commandName); } } private onPing(): void { - logger.debug(this.logPrefix() + ' Has received a WS ping (rfc6455) from the server'); + logger.debug(this.logPrefix() + ' Received a WS ping (rfc6455) from the server'); } private onPong(): void { - logger.debug(this.logPrefix() + ' Has received a WS pong (rfc6455) from the server'); + 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; // } } private getTemplateChargingStationConfiguration(): ChargingStationConfiguration { - return this.stationInfo.Configuration ? this.stationInfo.Configuration : {} as ChargingStationConfiguration; + return this.stationInfo.Configuration ?? {} as ChargingStationConfiguration; } private getAuthorizationFile(): string | undefined { @@ -683,7 +799,7 @@ export default class ChargingStation { authorizedTags = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as string[]; fs.closeSync(fileDescriptor); } catch (error) { - FileUtils.handleFileException(this.logPrefix(), 'Authorization', authorizationFile, error); + FileUtils.handleFileException(this.logPrefix(), 'Authorization', authorizationFile, error as NodeJS.ErrnoException); } } else { logger.info(this.logPrefix() + ' No authorization file given in template file ' + this.stationTemplateFile); @@ -697,8 +813,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++; } } @@ -707,13 +823,10 @@ export default class ChargingStation { // 0 for disabling private getConnectionTimeout(): number | undefined { - if (!Utils.isUndefined(this.stationInfo.connectionTimeout)) { - return this.stationInfo.connectionTimeout; - } - if (!Utils.isUndefined(Configuration.getConnectionTimeout())) { - return Configuration.getConnectionTimeout(); + if (this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) { + return parseInt(this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut).value) ?? Constants.DEFAULT_CONNECTION_TIMEOUT; } - return 30; + return Constants.DEFAULT_CONNECTION_TIMEOUT; } // -1 for unlimited, 0 for disabling @@ -748,7 +861,7 @@ export default class ChargingStation { } private getMaxNumberOfConnectors(): number { - let maxConnectors = 0; + let maxConnectors: number; if (!Utils.isEmptyArray(this.stationInfo.numberOfConnectors)) { const numberOfConnectors = this.stationInfo.numberOfConnectors as number[]; // Distribute evenly the number of connectors @@ -761,51 +874,43 @@ 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 this.startAutomaticTransactionGenerator(); - if (this.getEnableStatistics()) { - this.performanceStatistics.start(); - } } 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(); } } } @@ -817,13 +922,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); } @@ -837,15 +942,15 @@ export default class ChargingStation { : 0; if (webSocketPingInterval > 0 && !this.webSocketPingSetInterval) { this.webSocketPingSetInterval = setInterval(() => { - if (this.isWebSocketOpen()) { - this.wsConnection.ping((): void => { }); + if (this.isWebSocketConnectionOpened()) { + 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`); } } @@ -855,19 +960,47 @@ export default class ChargingStation { } } - private getSupervisionURL(): string { - const supervisionUrls = Utils.cloneObject(this.stationInfo.supervisionURL ? this.stationInfo.supervisionURL : Configuration.getSupervisionURLs()); - let indexUrl = 0; + private warnDeprecatedTemplateKey(template: ChargingStationTemplate, key: string, chargingStationId: string, logMsgToAppend = ''): void { + if (!Utils.isUndefined(template[key])) { + logger.warn(`${Utils.logPrefix(` ${chargingStationId} |`)} Deprecated template key '${key}' usage in file '${this.stationTemplateFile}'${logMsgToAppend && '. ' + logMsgToAppend}`); + } + } + + private convertDeprecatedTemplateKey(template: ChargingStationTemplate, deprecatedKey: string, key: string): void { + if (!Utils.isUndefined(template[deprecatedKey])) { + // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment + template[key] = template[deprecatedKey]; + delete template[deprecatedKey]; + } + } + + 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(Math.random() * 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 supervisionUrls[indexUrl]; + return new URL(supervisionUrls[urlIndex]); } - return supervisionUrls as string; + return new URL(supervisionUrls as string); } private getHeartbeatInterval(): number | undefined { @@ -879,6 +1012,8 @@ export default class ChargingStation { if (HeartBeatInterval) { return Utils.convertToInt(HeartBeatInterval.value) * 1000; } + !this.stationInfo.autoRegister && logger.warn(`${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${Constants.DEFAULT_HEARTBEAT_INTERVAL}`); + return Constants.DEFAULT_HEARTBEAT_INTERVAL; } private stopHeartbeat(): void { @@ -887,28 +1022,30 @@ export default class ChargingStation { } } - private openWSConnection(options?: WebSocket.ClientOptions, forceCloseOpened = false): void { - options ?? {} as WebSocket.ClientOptions; - options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000; - if (this.isWebSocketOpen() && forceCloseOpened) { + private openWSConnection(options: ClientOptions & ClientRequestArgs = this.stationInfo.wsOptions, forceCloseOpened = false): void { + options.handshakeTimeout = options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000; + if (!Utils.isNullOrUndefined(this.stationInfo.supervisionUser) && !Utils.isNullOrUndefined(this.stationInfo.supervisionPassword)) { + options.auth = `${this.stationInfo.supervisionUser}:${this.stationInfo.supervisionPassword}`; + } + if (this.isWebSocketConnectionOpened() && forceCloseOpened) { this.wsConnection.close(); } - let protocol; - switch (this.getOCPPVersion()) { + let protocol: string; + switch (this.getOcppVersion()) { case OCPPVersion.VERSION_16: protocol = 'ocpp' + OCPPVersion.VERSION_16; break; default: - this.handleUnsupportedVersion(this.getOCPPVersion()); + this.handleUnsupportedVersion(this.getOcppVersion()); break; } this.wsConnection = new WebSocket(this.wsConnectionUrl, protocol, options); - logger.info(this.logPrefix() + ' Will communicate through URL ' + this.supervisionUrl); + logger.info(this.logPrefix() + ' Open OCPP connection to URL ' + this.wsConnectionUrl.toString()); } private stopMeterValues(connectorId: number) { - if (this.getConnector(connectorId)?.transactionSetInterval) { - clearInterval(this.getConnector(connectorId).transactionSetInterval); + if (this.getConnectorStatus(connectorId)?.transactionSetInterval) { + clearInterval(this.getConnectorStatus(connectorId).transactionSetInterval); } } @@ -916,17 +1053,19 @@ 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) { - FileUtils.handleFileException(this.logPrefix(), 'Authorization', authorizationFile, error); + FileUtils.handleFileException(this.logPrefix(), 'Authorization', authorizationFile, error as NodeJS.ErrnoException); } } else { logger.info(this.logPrefix() + ' No authorization file given in template file ' + this.stationTemplateFile + '. Not monitoring changes'); @@ -935,26 +1074,31 @@ 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(); - // Stop the ATG - if (!this.stationInfo.AutomaticTransactionGenerator.enable && - this.automaticTransactionGeneration) { - await this.automaticTransactionGeneration.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); } - // Start the ATG - this.startAutomaticTransactionGenerator(); - // 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); + FileUtils.handleFileException(this.logPrefix(), 'Template', this.stationTemplateFile, error as NodeJS.ErrnoException); } } @@ -962,33 +1106,39 @@ export default class ChargingStation { return !Utils.isUndefined(this.stationInfo.reconnectExponentialDelay) ? this.stationInfo.reconnectExponentialDelay : false; } - private async reconnect(error: any): Promise { + private async reconnect(code: number): Promise { + // Stop WebSocket ping + this.stopWebSocketPing(); // Stop heartbeat this.stopHeartbeat(); // Stop the ATG if needed if (this.stationInfo.AutomaticTransactionGenerator.enable && this.stationInfo.AutomaticTransactionGenerator.stopOnConnectionFailure && - this.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; + 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).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; } }