X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FChargingStation.ts;h=070707625771e3fffdc2a2fbda8bd8b5f1069561;hb=34eeb1fb097b9eda12531ff9024d2f9c0e627a28;hp=82db1976e13a1d7c05509ab12abf78bce73a877f;hpb=a68137ea157b01bb0beef177d67d7190def95e84;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ChargingStation.ts b/src/charging-station/ChargingStation.ts index 82db1976..07070762 100644 --- a/src/charging-station/ChargingStation.ts +++ b/src/charging-station/ChargingStation.ts @@ -1,173 +1,209 @@ -// Partial Copyright Jerome Benoit. 2021. All Rights Reserved. +// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved. + +import crypto from 'node:crypto'; +import fs from 'node:fs'; +import path from 'node:path'; +import { URL } from 'node:url'; +import { parentPort } from 'node:worker_threads'; + +import merge from 'just-merge'; +import WebSocket, { type RawData } from 'ws'; -import { ACElectricUtils, DCElectricUtils } from '../utils/ElectricUtils'; import { - AvailabilityType, - BootNotificationRequest, - CachedRequest, - HeartbeatRequest, - IncomingRequest, - IncomingRequestCommand, - MeterValuesRequest, - RequestCommand, - StatusNotificationRequest, -} from '../types/ocpp/Requests'; + AutomaticTransactionGenerator, + ChargingStationConfigurationUtils, + ChargingStationUtils, + ChargingStationWorkerBroadcastChannel, + IdTagsCache, + MessageChannelUtils, + SharedLRUCache, +} from './internal'; import { - BootNotificationResponse, - ErrorResponse, - HeartbeatResponse, - MeterValuesResponse, - RegistrationStatus, - Response, - StatusNotificationResponse, -} from '../types/ocpp/Responses'; + // OCPP16IncomingRequestService, + OCPP16RequestService, + // OCPP16ResponseService, + OCPP16ServiceUtils, + OCPP20IncomingRequestService, + OCPP20RequestService, + // OCPP20ResponseService, + type OCPPIncomingRequestService, + type OCPPRequestService, + // OCPPServiceUtils, +} from './ocpp'; +import { OCPP16IncomingRequestService } from './ocpp/1.6/OCPP16IncomingRequestService'; +import { OCPP16ResponseService } from './ocpp/1.6/OCPP16ResponseService'; +import { OCPP20ResponseService } from './ocpp/2.0/OCPP20ResponseService'; +import { OCPPServiceUtils } from './ocpp/OCPPServiceUtils'; +import { BaseError, OCPPError } from '../exception'; +import { PerformanceStatistics } from '../performance'; import { - ChargingProfile, - ChargingRateUnitType, - ChargingSchedulePeriod, -} from '../types/ocpp/ChargingProfile'; -import { ChargingProfileKindType, RecurrencyKindType } from '../types/ocpp/1.6/ChargingProfile'; -import ChargingStationConfiguration, { Section } from '../types/ChargingStationConfiguration'; -import ChargingStationOcppConfiguration, { - ConfigurationKey, -} from '../types/ChargingStationOcppConfiguration'; -import ChargingStationTemplate, { - AmpereUnits, + type AutomaticTransactionGeneratorConfiguration, + AvailabilityType, + type BootNotificationRequest, + type BootNotificationResponse, + type CachedRequest, + type ChargingStationConfiguration, + type ChargingStationInfo, + type ChargingStationOcppConfiguration, + type ChargingStationTemplate, + type ConnectorStatus, + ConnectorStatusEnum, CurrentType, + type ErrorCallback, + type ErrorResponse, + ErrorType, + type EvseStatus, + type EvseStatusConfiguration, + FileType, + FirmwareStatus, + type FirmwareStatusNotificationRequest, + type FirmwareStatusNotificationResponse, + type FirmwareUpgrade, + type HeartbeatRequest, + type HeartbeatResponse, + type IncomingRequest, + type IncomingRequestCommand, + type JsonType, + MessageType, + type MeterValue, + MeterValueMeasurand, + type MeterValuesRequest, + type MeterValuesResponse, + OCPPVersion, + type OutgoingRequest, PowerUnits, - Voltage, - WsOptions, -} from '../types/ChargingStationTemplate'; -import { - ConnectorPhaseRotation, + RegistrationStatusEnumType, + RequestCommand, + type Response, StandardParametersKey, + type StatusNotificationRequest, + type StatusNotificationResponse, + StopTransactionReason, + type StopTransactionRequest, + type StopTransactionResponse, + SupervisionUrlDistribution, SupportedFeatureProfiles, - VendorDefaultParametersKey, -} from '../types/ocpp/Configuration'; -import { MeterValue, MeterValueMeasurand, MeterValuePhase } from '../types/ocpp/MeterValues'; + VendorParametersKey, + type WSError, + WebSocketCloseEventStatusCode, + type WsOptions, +} from '../types'; import { - StopTransactionReason, - StopTransactionRequest, - StopTransactionResponse, -} from '../types/ocpp/Transaction'; -import { WSError, WebSocketCloseEventStatusCode } from '../types/WebSocket'; -import WebSocket, { Data, OPEN, RawData } from 'ws'; - -import AutomaticTransactionGenerator from './AutomaticTransactionGenerator'; -import BaseError from '../exception/BaseError'; -import { ChargePointErrorCode } from '../types/ocpp/ChargePointErrorCode'; -import { ChargePointStatus } from '../types/ocpp/ChargePointStatus'; -import ChargingStationInfo from '../types/ChargingStationInfo'; -import { ChargingStationWorkerMessageEvents } from '../types/ChargingStationWorker'; -import Configuration from '../utils/Configuration'; -import { ConnectorStatus } from '../types/ConnectorStatus'; -import Constants from '../utils/Constants'; -import { ErrorType } from '../types/ocpp/ErrorType'; -import { FileType } from '../types/FileType'; -import FileUtils from '../utils/FileUtils'; -import { JsonType } from '../types/JsonType'; -import { MessageType } from '../types/ocpp/MessageType'; -import OCPP16IncomingRequestService from './ocpp/1.6/OCPP16IncomingRequestService'; -import OCPP16RequestService from './ocpp/1.6/OCPP16RequestService'; -import OCPP16ResponseService from './ocpp/1.6/OCPP16ResponseService'; -import { OCPP16ServiceUtils } from './ocpp/1.6/OCPP16ServiceUtils'; -import OCPPError from '../exception/OCPPError'; -import OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService'; -import OCPPRequestService from './ocpp/OCPPRequestService'; -import { OCPPVersion } from '../types/ocpp/OCPPVersion'; -import PerformanceStatistics from '../performance/PerformanceStatistics'; -import { SampledValueTemplate } from '../types/MeasurandPerPhaseSampledValueTemplates'; -import { SupervisionUrlDistribution } from '../types/ConfigurationData'; -import { URL } from 'url'; -import Utils from '../utils/Utils'; -import crypto from 'crypto'; -import fs from 'fs'; -import logger from '../utils/Logger'; -import moment from 'moment'; -import { parentPort } from 'worker_threads'; -import path from 'path'; - -export default class ChargingStation { - public hashId!: string; + ACElectricUtils, + Configuration, + Constants, + DCElectricUtils, + FileUtils, + Utils, + logger, +} from '../utils'; + +export class ChargingStation { + public readonly index: number; public readonly templateFile: string; - public authorizedTags: string[]; public stationInfo!: ChargingStationInfo; + public started: boolean; + public starting: boolean; + public idTagsCache: IdTagsCache; + public automaticTransactionGenerator!: AutomaticTransactionGenerator | undefined; + public ocppConfiguration!: ChargingStationOcppConfiguration | undefined; + public wsConnection!: WebSocket | null; public readonly connectors: Map; - public ocppConfiguration!: ChargingStationOcppConfiguration; - public wsConnection!: WebSocket; + public readonly evses: Map; public readonly requests: Map; - public performanceStatistics!: PerformanceStatistics; + public performanceStatistics!: PerformanceStatistics | undefined; public heartbeatSetInterval!: NodeJS.Timeout; public ocppRequestService!: OCPPRequestService; - public bootNotificationResponse!: BootNotificationResponse | null; - private readonly index: number; + public bootNotificationRequest!: BootNotificationRequest; + public bootNotificationResponse!: BootNotificationResponse | undefined; + public powerDivider!: number; + private stopping: boolean; private configurationFile!: string; - private bootNotificationRequest!: BootNotificationRequest; + private configurationFileHash!: string; private connectorsConfigurationHash!: string; + private evsesConfigurationHash!: string; private ocppIncomingRequestService!: OCPPIncomingRequestService; private readonly messageBuffer: Set; - private wsConfiguredConnectionUrl!: URL; + private configuredSupervisionUrl!: URL; private wsConnectionRestarted: boolean; - private stopped: boolean; private autoReconnectRetryCount: number; - private automaticTransactionGenerator!: AutomaticTransactionGenerator; + private templateFileWatcher!: fs.FSWatcher | undefined; + private templateFileHash!: string; + private readonly sharedLRUCache: SharedLRUCache; private webSocketPingSetInterval!: NodeJS.Timeout; + private readonly chargingStationWorkerBroadcastChannel: ChargingStationWorkerBroadcastChannel; constructor(index: number, templateFile: string) { - this.index = index; - this.templateFile = templateFile; - this.stopped = false; + this.started = false; + this.starting = false; + this.stopping = false; this.wsConnectionRestarted = false; this.autoReconnectRetryCount = 0; + this.index = index; + this.templateFile = templateFile; this.connectors = new Map(); + this.evses = new Map(); this.requests = new Map(); this.messageBuffer = new Set(); + this.sharedLRUCache = SharedLRUCache.getInstance(); + this.idTagsCache = IdTagsCache.getInstance(); + this.chargingStationWorkerBroadcastChannel = new ChargingStationWorkerBroadcastChannel(this); + this.initialize(); - this.authorizedTags = this.getAuthorizedTags(); } - private get wsConnectionUrl(): URL { - return this.getSupervisionUrlOcppConfiguration() - ? new URL( - this.getConfigurationKey(this.getSupervisionUrlOcppKey()).value + - '/' + - this.stationInfo.chargingStationId - ) - : this.wsConfiguredConnectionUrl; + public get hasEvses(): boolean { + return this.connectors.size === 0 && this.evses.size > 0; } - public logPrefix(): string { - return Utils.logPrefix(` ${this.stationInfo.chargingStationId} |`); + private get wsConnectionUrl(): URL { + return new URL( + `${ + this.getSupervisionUrlOcppConfiguration() && + Utils.isNotEmptyString(this.getSupervisionUrlOcppKey()) + ? ChargingStationConfigurationUtils.getConfigurationKey( + this, + this.getSupervisionUrlOcppKey() + )?.value + : this.configuredSupervisionUrl.href + }/${this.stationInfo.chargingStationId}` + ); } - public getBootNotificationRequest(): BootNotificationRequest { - return this.bootNotificationRequest; - } + public logPrefix = (): string => { + return Utils.logPrefix( + ` ${ + (Utils.isNotEmptyString(this?.stationInfo?.chargingStationId) + ? this?.stationInfo?.chargingStationId + : ChargingStationUtils.getChargingStationId(this.index, this.getTemplateFromFile())) ?? + 'Error at building log prefix' + } |` + ); + }; - public getRandomIdTag(): string { - const index = Math.floor(Utils.secureRandom() * this.authorizedTags.length); - return this.authorizedTags[index]; + public hasIdTags(): boolean { + const idTagsFile = ChargingStationUtils.getIdTagsFile(this.stationInfo); + return Utils.isNotEmptyArray(this.idTagsCache.getIdTags(idTagsFile)); } - public hasAuthorizedTags(): boolean { - return !Utils.isEmptyArray(this.authorizedTags); + public getEnableStatistics(): boolean { + return this.stationInfo.enableStatistics ?? false; } - public getEnableStatistics(): boolean | undefined { - return !Utils.isUndefined(this.stationInfo.enableStatistics) - ? this.stationInfo.enableStatistics - : true; + public getMustAuthorizeAtRemoteStart(): boolean { + return this.stationInfo.mustAuthorizeAtRemoteStart ?? true; } - public getMayAuthorizeAtRemoteStart(): boolean | undefined { - return this.stationInfo.mayAuthorizeAtRemoteStart ?? true; + public getPayloadSchemaValidation(): boolean { + return this.stationInfo.payloadSchemaValidation ?? true; } - public getNumberOfPhases(): number | undefined { - switch (this.getCurrentOutType()) { + public getNumberOfPhases(stationInfo?: ChargingStationInfo): number | undefined { + const localStationInfo: ChargingStationInfo = stationInfo ?? this.stationInfo; + switch (this.getCurrentOutType(stationInfo)) { case CurrentType.AC: - return !Utils.isUndefined(this.stationInfo.numberOfPhases) - ? this.stationInfo.numberOfPhases + return !Utils.isUndefined(localStationInfo.numberOfPhases) + ? localStationInfo.numberOfPhases : 3; case CurrentType.DC: return 0; @@ -175,10 +211,10 @@ export default class ChargingStation { } public isWebSocketConnectionOpened(): boolean { - return this?.wsConnection?.readyState === OPEN; + return this?.wsConnection?.readyState === WebSocket.OPEN; } - public getRegistrationStatus(): RegistrationStatus { + public getRegistrationStatus(): RegistrationStatusEnumType | undefined { return this?.bootNotificationResponse?.status; } @@ -187,156 +223,246 @@ export default class ChargingStation { } public isInPendingState(): boolean { - return this?.bootNotificationResponse?.status === RegistrationStatus.PENDING; + return this?.bootNotificationResponse?.status === RegistrationStatusEnumType.PENDING; } public isInAcceptedState(): boolean { - return this?.bootNotificationResponse?.status === RegistrationStatus.ACCEPTED; + return this?.bootNotificationResponse?.status === RegistrationStatusEnumType.ACCEPTED; } public isInRejectedState(): boolean { - return this?.bootNotificationResponse?.status === RegistrationStatus.REJECTED; + return this?.bootNotificationResponse?.status === RegistrationStatusEnumType.REJECTED; } public isRegistered(): boolean { - return !this.isInUnknownState() && (this.isInAcceptedState() || this.isInPendingState()); + return ( + this.isInUnknownState() === false && + (this.isInAcceptedState() === true || this.isInPendingState() === true) + ); } public isChargingStationAvailable(): boolean { - return this.getConnectorStatus(0).availability === AvailabilityType.OPERATIVE; + return this.getConnectorStatus(0)?.availability === AvailabilityType.Operative; } - public isConnectorAvailable(id: number): boolean { - return id > 0 && this.getConnectorStatus(id).availability === AvailabilityType.OPERATIVE; + public hasConnector(connectorId: number): boolean { + if (this.hasEvses) { + for (const evseStatus of this.evses.values()) { + if (evseStatus.connectors.has(connectorId)) { + return true; + } + } + return false; + } + return this.connectors.has(connectorId); + } + + public isConnectorAvailable(connectorId: number): boolean { + return ( + connectorId > 0 && + this.getConnectorStatus(connectorId)?.availability === AvailabilityType.Operative + ); } public getNumberOfConnectors(): number { - return this.connectors.get(0) ? this.connectors.size - 1 : this.connectors.size; + if (this.hasEvses) { + if (this.evses.size === 0) { + throw new BaseError('Evses not initialized, cannot get number of connectors'); + } + let numberOfConnectors = 0; + for (const [evseId, evseStatus] of this.evses) { + if (evseId > 0) { + numberOfConnectors += evseStatus.connectors.size; + } + } + return numberOfConnectors; + } + if (this.connectors.size === 0) { + throw new BaseError('Connectors not initialized, cannot get number of connectors'); + } + return this.connectors.has(0) ? this.connectors.size - 1 : this.connectors.size; } - public getConnectorStatus(id: number): ConnectorStatus { - return this.connectors.get(id); + public getNumberOfEvses(): number { + if (this.evses.size === 0) { + throw new BaseError('Evses not initialized, cannot get number of evses'); + } + return this.evses.has(0) ? this.evses.size - 1 : this.evses.size; } - public getCurrentOutType(): CurrentType | undefined { - return this.stationInfo.currentOutType ?? CurrentType.AC; + public getConnectorStatus(connectorId: number): ConnectorStatus | undefined { + if (this.hasEvses) { + for (const evseStatus of this.evses.values()) { + if (evseStatus.connectors.has(connectorId)) { + return evseStatus.connectors.get(connectorId); + } + } + return undefined; + } + return this.connectors.get(connectorId); + } + + public getCurrentOutType(stationInfo?: ChargingStationInfo): CurrentType { + return (stationInfo ?? this.stationInfo)?.currentOutType ?? CurrentType.AC; } public getOcppStrictCompliance(): boolean { - return this.stationInfo.ocppStrictCompliance ?? false; + return this.stationInfo?.ocppStrictCompliance ?? false; } - public getVoltageOut(): number | undefined { - const errMsg = `${this.logPrefix()} Unknown ${this.getCurrentOutType()} currentOutType in template file ${ + public getVoltageOut(stationInfo?: ChargingStationInfo): number | undefined { + const defaultVoltageOut = ChargingStationUtils.getDefaultVoltageOut( + this.getCurrentOutType(stationInfo), + this.logPrefix(), this.templateFile - }, cannot define default voltage out`; - let defaultVoltageOut: number; - switch (this.getCurrentOutType()) { - case CurrentType.AC: - defaultVoltageOut = Voltage.VOLTAGE_230; - break; - case CurrentType.DC: - defaultVoltageOut = Voltage.VOLTAGE_400; - break; - default: - logger.error(errMsg); - throw new Error(errMsg); - } - return !Utils.isUndefined(this.stationInfo.voltageOut) - ? this.stationInfo.voltageOut + ); + const localStationInfo: ChargingStationInfo = stationInfo ?? this.stationInfo; + return !Utils.isUndefined(localStationInfo.voltageOut) + ? localStationInfo.voltageOut : defaultVoltageOut; } + public getMaximumPower(stationInfo?: ChargingStationInfo): number { + const localStationInfo = stationInfo ?? this.stationInfo; + return (localStationInfo['maxPower'] as number) ?? localStationInfo.maximumPower; + } + public getConnectorMaximumAvailablePower(connectorId: number): number { let connectorAmperageLimitationPowerLimit: number; if ( !Utils.isNullOrUndefined(this.getAmperageLimitation()) && - this.getAmperageLimitation() < this.stationInfo.maximumAmperage + this.getAmperageLimitation() < this.stationInfo?.maximumAmperage ) { connectorAmperageLimitationPowerLimit = (this.getCurrentOutType() === CurrentType.AC ? ACElectricUtils.powerTotal( this.getNumberOfPhases(), this.getVoltageOut(), - this.getAmperageLimitation() * this.getNumberOfConnectors() + this.getAmperageLimitation() * + (this.hasEvses ? this.getNumberOfEvses() : this.getNumberOfConnectors()) ) : DCElectricUtils.power(this.getVoltageOut(), this.getAmperageLimitation())) / - this.stationInfo.powerDivider; + this.powerDivider; } - const connectorMaximumPower = this.getMaximumPower() / this.stationInfo.powerDivider; - const connectorChargingProfilePowerLimit = this.getChargingProfilePowerLimit(connectorId); + const connectorMaximumPower = this.getMaximumPower() / this.powerDivider; + const connectorChargingProfilesPowerLimit = + ChargingStationUtils.getChargingStationConnectorChargingProfilesPowerLimit(this, connectorId); return Math.min( isNaN(connectorMaximumPower) ? Infinity : connectorMaximumPower, isNaN(connectorAmperageLimitationPowerLimit) ? Infinity : connectorAmperageLimitationPowerLimit, - isNaN(connectorChargingProfilePowerLimit) ? Infinity : connectorChargingProfilePowerLimit + isNaN(connectorChargingProfilesPowerLimit) ? Infinity : connectorChargingProfilesPowerLimit ); } public getTransactionIdTag(transactionId: number): string | undefined { - for (const connectorId of this.connectors.keys()) { - if (connectorId > 0 && this.getConnectorStatus(connectorId).transactionId === transactionId) { - return this.getConnectorStatus(connectorId).transactionIdTag; + if (this.hasEvses) { + for (const evseStatus of this.evses.values()) { + for (const connectorStatus of evseStatus.connectors.values()) { + if (connectorStatus.transactionId === transactionId) { + return connectorStatus.transactionIdTag; + } + } + } + } else { + for (const connectorId of this.connectors.keys()) { + if ( + connectorId > 0 && + this.getConnectorStatus(connectorId)?.transactionId === transactionId + ) { + return this.getConnectorStatus(connectorId)?.transactionIdTag; + } + } + } + } + + public getNumberOfRunningTransactions(): number { + let trxCount = 0; + if (this.hasEvses) { + for (const evseStatus of this.evses.values()) { + for (const connectorStatus of evseStatus.connectors.values()) { + if (connectorStatus.transactionStarted === true) { + ++trxCount; + } + } + } + } else { + for (const connectorId of this.connectors.keys()) { + if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted === true) { + ++trxCount; + } } } + return trxCount; } public getOutOfOrderEndMeterValues(): boolean { - return this.stationInfo.outOfOrderEndMeterValues ?? false; + return this.stationInfo?.outOfOrderEndMeterValues ?? false; } public getBeginEndMeterValues(): boolean { - return this.stationInfo.beginEndMeterValues ?? false; + return this.stationInfo?.beginEndMeterValues ?? false; } public getMeteringPerTransaction(): boolean { - return this.stationInfo.meteringPerTransaction ?? true; + return this.stationInfo?.meteringPerTransaction ?? true; } public getTransactionDataMeterValues(): boolean { - return this.stationInfo.transactionDataMeterValues ?? false; + return this.stationInfo?.transactionDataMeterValues ?? false; } public getMainVoltageMeterValues(): boolean { - return this.stationInfo.mainVoltageMeterValues ?? true; + return this.stationInfo?.mainVoltageMeterValues ?? true; } public getPhaseLineToLineVoltageMeterValues(): boolean { - return this.stationInfo.phaseLineToLineVoltageMeterValues ?? false; + return this.stationInfo?.phaseLineToLineVoltageMeterValues ?? false; + } + + public getCustomValueLimitationMeterValues(): boolean { + return this.stationInfo?.customValueLimitationMeterValues ?? true; } public getConnectorIdByTransactionId(transactionId: number): number | undefined { - for (const connectorId of this.connectors.keys()) { - if ( - connectorId > 0 && - this.getConnectorStatus(connectorId)?.transactionId === transactionId - ) { - return connectorId; + if (this.hasEvses) { + for (const evseStatus of this.evses.values()) { + for (const [connectorId, connectorStatus] of evseStatus.connectors) { + if (connectorStatus.transactionId === transactionId) { + return connectorId; + } + } + } + } else { + for (const connectorId of this.connectors.keys()) { + if ( + connectorId > 0 && + this.getConnectorStatus(connectorId)?.transactionId === transactionId + ) { + return connectorId; + } } } } - public getEnergyActiveImportRegisterByTransactionId(transactionId: number): number | undefined { - const transactionConnectorStatus = this.getConnectorStatus( - this.getConnectorIdByTransactionId(transactionId) + public getEnergyActiveImportRegisterByTransactionId( + transactionId: number, + rounded = false + ): number { + return this.getEnergyActiveImportRegister( + this.getConnectorStatus(this.getConnectorIdByTransactionId(transactionId)), + rounded ); - if (this.getMeteringPerTransaction()) { - return transactionConnectorStatus?.transactionEnergyActiveImportRegisterValue; - } - return transactionConnectorStatus?.energyActiveImportRegisterValue; } - public getEnergyActiveImportRegisterByConnectorId(connectorId: number): number | undefined { - const connectorStatus = this.getConnectorStatus(connectorId); - if (this.getMeteringPerTransaction()) { - return connectorStatus?.transactionEnergyActiveImportRegisterValue; - } - return connectorStatus?.energyActiveImportRegisterValue; + public getEnergyActiveImportRegisterByConnectorId(connectorId: number, rounded = false): number { + return this.getEnergyActiveImportRegister(this.getConnectorStatus(connectorId), rounded); } public getAuthorizeRemoteTxRequests(): boolean { - const authorizeRemoteTxRequests = this.getConfigurationKey( + const authorizeRemoteTxRequests = ChargingStationConfigurationUtils.getConfigurationKey( + this, StandardParametersKey.AuthorizeRemoteTxRequests ); return authorizeRemoteTxRequests @@ -345,130 +471,80 @@ export default class ChargingStation { } public getLocalAuthListEnabled(): boolean { - const localAuthListEnabled = this.getConfigurationKey( + const localAuthListEnabled = ChargingStationConfigurationUtils.getConfigurationKey( + this, StandardParametersKey.LocalAuthListEnabled ); return localAuthListEnabled ? Utils.convertToBoolean(localAuthListEnabled.value) : false; } - public restartWebSocketPing(): void { - // Stop WebSocket ping - this.stopWebSocketPing(); - // Start WebSocket ping - this.startWebSocketPing(); - } - - public getSampledValueTemplate( - connectorId: number, - measurand: MeterValueMeasurand = MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER, - phase?: MeterValuePhase - ): SampledValueTemplate | undefined { - const onPhaseStr = phase ? `on phase ${phase} ` : ''; - if (!Constants.SUPPORTED_MEASURANDS.includes(measurand)) { + public getHeartbeatInterval(): number { + const HeartbeatInterval = ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.HeartbeatInterval + ); + if (HeartbeatInterval) { + return Utils.convertToInt(HeartbeatInterval.value) * 1000; + } + const HeartBeatInterval = ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.HeartBeatInterval + ); + if (HeartBeatInterval) { + return Utils.convertToInt(HeartBeatInterval.value) * 1000; + } + this.stationInfo?.autoRegister === false && logger.warn( - `${this.logPrefix()} Trying to get unsupported MeterValues measurand '${measurand}' ${onPhaseStr}in template on connectorId ${connectorId}` + `${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${ + Constants.DEFAULT_HEARTBEAT_INTERVAL + }` ); - return; - } + return Constants.DEFAULT_HEARTBEAT_INTERVAL; + } + + public setSupervisionUrl(url: string): void { if ( - measurand !== MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER && - !this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData)?.value.includes( - measurand - ) + this.getSupervisionUrlOcppConfiguration() && + Utils.isNotEmptyString(this.getSupervisionUrlOcppKey()) ) { - logger.debug( - `${this.logPrefix()} Trying to get MeterValues measurand '${measurand}' ${onPhaseStr}in template on connectorId ${connectorId} not found in '${ - StandardParametersKey.MeterValuesSampledData - }' OCPP parameter` + ChargingStationConfigurationUtils.setConfigurationKeyValue( + this, + this.getSupervisionUrlOcppKey(), + url ); - return; - } - const sampledValueTemplates: SampledValueTemplate[] = - this.getConnectorStatus(connectorId).MeterValues; - for ( - let index = 0; - !Utils.isEmptyArray(sampledValueTemplates) && index < sampledValueTemplates.length; - index++ - ) { - if ( - !Constants.SUPPORTED_MEASURANDS.includes( - sampledValueTemplates[index]?.measurand ?? - MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER - ) - ) { - logger.warn( - `${this.logPrefix()} Unsupported MeterValues measurand '${measurand}' ${onPhaseStr}in template on connectorId ${connectorId}` - ); - } else if ( - phase && - sampledValueTemplates[index]?.phase === phase && - sampledValueTemplates[index]?.measurand === measurand && - this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData)?.value.includes( - measurand - ) - ) { - return sampledValueTemplates[index]; - } else if ( - !phase && - !sampledValueTemplates[index].phase && - sampledValueTemplates[index]?.measurand === measurand && - this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData)?.value.includes( - measurand - ) - ) { - return sampledValueTemplates[index]; - } else if ( - measurand === MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER && - (!sampledValueTemplates[index].measurand || - sampledValueTemplates[index].measurand === measurand) - ) { - return sampledValueTemplates[index]; - } - } - if (measurand === MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER) { - const errorMsg = `${this.logPrefix()} Missing MeterValues for default measurand '${measurand}' in template on connectorId ${connectorId}`; - logger.error(errorMsg); - throw new Error(errorMsg); + } else { + this.stationInfo.supervisionUrls = url; + this.saveStationInfo(); + this.configuredSupervisionUrl = this.getConfiguredSupervisionUrl(); } - logger.debug( - `${this.logPrefix()} No MeterValues for measurand '${measurand}' ${onPhaseStr}in template on connectorId ${connectorId}` - ); - } - - public getAutomaticTransactionGeneratorRequireAuthorize(): boolean { - return this.stationInfo.AutomaticTransactionGenerator.requireAuthorize ?? true; } public startHeartbeat(): void { - if ( - this.getHeartbeatInterval() && - this.getHeartbeatInterval() > 0 && - !this.heartbeatSetInterval - ) { - // eslint-disable-next-line @typescript-eslint/no-misused-promises - this.heartbeatSetInterval = setInterval(async (): Promise => { - await this.ocppRequestService.requestHandler( - RequestCommand.HEARTBEAT - ); + if (this.getHeartbeatInterval() > 0 && !this.heartbeatSetInterval) { + this.heartbeatSetInterval = setInterval(() => { + this.ocppRequestService + .requestHandler(this, RequestCommand.HEARTBEAT) + .catch((error) => { + logger.error( + `${this.logPrefix()} Error while sending '${RequestCommand.HEARTBEAT}':`, + error + ); + }); }, this.getHeartbeatInterval()); logger.info( - this.logPrefix() + - ' Heartbeat started every ' + - Utils.formatDurationMilliSeconds(this.getHeartbeatInterval()) + `${this.logPrefix()} Heartbeat started every ${Utils.formatDurationMilliSeconds( + this.getHeartbeatInterval() + )}` ); } else if (this.heartbeatSetInterval) { logger.info( - this.logPrefix() + - ' Heartbeat already started every ' + - Utils.formatDurationMilliSeconds(this.getHeartbeatInterval()) + `${this.logPrefix()} Heartbeat already started every ${Utils.formatDurationMilliSeconds( + this.getHeartbeatInterval() + )}` ); } else { logger.error( - `${this.logPrefix()} Heartbeat interval set to ${ - this.getHeartbeatInterval() - ? Utils.formatDurationMilliSeconds(this.getHeartbeatInterval()) - : this.getHeartbeatInterval() - }, not starting the heartbeat` + `${this.logPrefix()} Heartbeat interval set to ${this.getHeartbeatInterval()}, not starting the heartbeat` ); } } @@ -480,72 +556,232 @@ export default class ChargingStation { this.startHeartbeat(); } + public restartWebSocketPing(): void { + // Stop WebSocket ping + this.stopWebSocketPing(); + // Start WebSocket ping + this.startWebSocketPing(); + } + public startMeterValues(connectorId: number, interval: number): void { if (connectorId === 0) { logger.error( - `${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId.toString()}` + `${this.logPrefix()} Trying to start MeterValues on connector id ${connectorId.toString()}` ); return; } if (!this.getConnectorStatus(connectorId)) { logger.error( - `${this.logPrefix()} Trying to start MeterValues on non existing connector Id ${connectorId.toString()}` + `${this.logPrefix()} Trying to start MeterValues on non existing connector id ${connectorId.toString()}` ); return; } - if (!this.getConnectorStatus(connectorId)?.transactionStarted) { + if (this.getConnectorStatus(connectorId)?.transactionStarted === false) { logger.error( - `${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction started` + `${this.logPrefix()} Trying to start MeterValues on connector id ${connectorId} with no transaction started` ); return; } else if ( - this.getConnectorStatus(connectorId)?.transactionStarted && - !this.getConnectorStatus(connectorId)?.transactionId + this.getConnectorStatus(connectorId)?.transactionStarted === true && + Utils.isNullOrUndefined(this.getConnectorStatus(connectorId)?.transactionId) ) { logger.error( - `${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction id` + `${this.logPrefix()} Trying to start MeterValues on connector id ${connectorId} with no transaction id` ); return; } if (interval > 0) { - // eslint-disable-next-line @typescript-eslint/no-misused-promises - this.getConnectorStatus(connectorId).transactionSetInterval = setInterval( - // eslint-disable-next-line @typescript-eslint/no-misused-promises - async (): Promise => { - // FIXME: Implement OCPP version agnostic helpers - const meterValue: MeterValue = OCPP16ServiceUtils.buildMeterValue( + this.getConnectorStatus(connectorId).transactionSetInterval = setInterval(() => { + // FIXME: Implement OCPP version agnostic helpers + const meterValue: MeterValue = OCPP16ServiceUtils.buildMeterValue( + this, + connectorId, + this.getConnectorStatus(connectorId).transactionId, + interval + ); + this.ocppRequestService + .requestHandler( this, - connectorId, - this.getConnectorStatus(connectorId).transactionId, - interval - ); - await this.ocppRequestService.requestHandler( RequestCommand.METER_VALUES, { connectorId, - transactionId: this.getConnectorStatus(connectorId).transactionId, + transactionId: this.getConnectorStatus(connectorId)?.transactionId, meterValue: [meterValue], } - ); - }, - interval - ); + ) + .catch((error) => { + logger.error( + `${this.logPrefix()} Error while sending '${RequestCommand.METER_VALUES}':`, + error + ); + }); + }, interval); } else { logger.error( `${this.logPrefix()} Charging station ${ StandardParametersKey.MeterValueSampleInterval - } configuration set to ${ - interval ? Utils.formatDurationMilliSeconds(interval) : interval - }, not sending MeterValues` + } configuration set to ${interval}, not sending MeterValues` ); } } + public stopMeterValues(connectorId: number) { + if (this.getConnectorStatus(connectorId)?.transactionSetInterval) { + clearInterval(this.getConnectorStatus(connectorId)?.transactionSetInterval); + } + } + public start(): void { - if (this.getEnableStatistics()) { - this.performanceStatistics.start(); + if (this.started === false) { + if (this.starting === false) { + this.starting = true; + if (this.getEnableStatistics() === true) { + this.performanceStatistics?.start(); + } + this.openWSConnection(); + // Monitor charging station template file + this.templateFileWatcher = FileUtils.watchJsonFile( + this.templateFile, + FileType.ChargingStationTemplate, + this.logPrefix(), + undefined, + (event, filename): void => { + if (Utils.isNotEmptyString(filename) && event === 'change') { + try { + logger.debug( + `${this.logPrefix()} ${FileType.ChargingStationTemplate} ${ + this.templateFile + } file have changed, reload` + ); + this.sharedLRUCache.deleteChargingStationTemplate(this.templateFileHash); + // Initialize + this.initialize(); + // Restart the ATG + this.stopAutomaticTransactionGenerator(); + if ( + this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable === true + ) { + this.startAutomaticTransactionGenerator(); + } + if (this.getEnableStatistics() === true) { + this.performanceStatistics?.restart(); + } else { + this.performanceStatistics?.stop(); + } + // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed + } catch (error) { + logger.error( + `${this.logPrefix()} ${FileType.ChargingStationTemplate} file monitoring error:`, + error + ); + } + } + } + ); + this.started = true; + parentPort?.postMessage(MessageChannelUtils.buildStartedMessage(this)); + this.starting = false; + } else { + logger.warn(`${this.logPrefix()} Charging station is already starting...`); + } + } else { + logger.warn(`${this.logPrefix()} Charging station is already started...`); } - this.openWSConnection(); + } + + public async stop(reason?: StopTransactionReason): Promise { + if (this.started === true) { + if (this.stopping === false) { + this.stopping = true; + await this.stopMessageSequence(reason); + this.closeWSConnection(); + if (this.getEnableStatistics() === true) { + this.performanceStatistics?.stop(); + } + this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash); + this.templateFileWatcher?.close(); + this.sharedLRUCache.deleteChargingStationTemplate(this.templateFileHash); + delete this.bootNotificationResponse; + this.started = false; + parentPort?.postMessage(MessageChannelUtils.buildStoppedMessage(this)); + this.stopping = false; + } else { + logger.warn(`${this.logPrefix()} Charging station is already stopping...`); + } + } else { + logger.warn(`${this.logPrefix()} Charging station is already stopped...`); + } + } + + public async reset(reason?: StopTransactionReason): Promise { + await this.stop(reason); + await Utils.sleep(this.stationInfo.resetTime); + this.initialize(); + this.start(); + } + + public saveOcppConfiguration(): void { + if (this.getOcppPersistentConfiguration()) { + this.saveConfiguration(); + } + } + + public hasFeatureProfile(featureProfile: SupportedFeatureProfiles): boolean | undefined { + return ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.SupportedFeatureProfiles + )?.value?.includes(featureProfile); + } + + public bufferMessage(message: string): void { + this.messageBuffer.add(message); + } + + public openWSConnection( + options: WsOptions = this.stationInfo?.wsOptions ?? {}, + params: { closeOpened?: boolean; terminateOpened?: boolean } = { + closeOpened: false, + terminateOpened: false, + } + ): void { + options.handshakeTimeout = options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000; + params = { ...{ closeOpened: false, terminateOpened: false }, ...params }; + if (this.started === false && this.starting === false) { + logger.warn( + `${this.logPrefix()} Cannot open OCPP connection to URL ${this.wsConnectionUrl.toString()} on stopped charging station` + ); + return; + } + if ( + !Utils.isNullOrUndefined(this.stationInfo.supervisionUser) && + !Utils.isNullOrUndefined(this.stationInfo.supervisionPassword) + ) { + options.auth = `${this.stationInfo.supervisionUser}:${this.stationInfo.supervisionPassword}`; + } + if (params?.closeOpened) { + this.closeWSConnection(); + } + if (params?.terminateOpened) { + this.terminateWSConnection(); + } + + if (this.isWebSocketConnectionOpened() === true) { + logger.warn( + `${this.logPrefix()} OCPP connection to URL ${this.wsConnectionUrl.toString()} is already opened` + ); + return; + } + + logger.info( + `${this.logPrefix()} Open OCPP connection to URL ${this.wsConnectionUrl.toString()}` + ); + + this.wsConnection = new WebSocket( + this.wsConnectionUrl, + `ocpp${this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16}`, + options + ); + // Handle WebSocket message this.wsConnection.on( 'message', @@ -567,282 +803,102 @@ export default class ChargingStation { this.wsConnection.on('ping', this.onPing.bind(this) as (this: WebSocket, data: Buffer) => void); // Handle WebSocket pong this.wsConnection.on('pong', this.onPong.bind(this) as (this: WebSocket, data: Buffer) => void); - // Monitor authorization file - FileUtils.watchJsonFile( - this.logPrefix(), - FileType.Authorization, - this.getAuthorizationFile(), - this.authorizedTags - ); - // Monitor charging station template file - FileUtils.watchJsonFile( - this.logPrefix(), - FileType.ChargingStationTemplate, - this.templateFile, - null, - (event, filename): void => { - if (filename && event === 'change') { - try { - logger.debug( - `${this.logPrefix()} ${FileType.ChargingStationTemplate} ${ - this.templateFile - } file have changed, reload` - ); - // Initialize - this.initialize(); - // Restart the ATG - if ( - !this.stationInfo.AutomaticTransactionGenerator.enable && - this.automaticTransactionGenerator - ) { - this.automaticTransactionGenerator.stop(); - } - this.startAutomaticTransactionGenerator(); - if (this.getEnableStatistics()) { - this.performanceStatistics.restart(); - } else { - this.performanceStatistics.stop(); - } - // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed - } catch (error) { - logger.error( - `${this.logPrefix()} ${FileType.ChargingStationTemplate} file monitoring error: %j`, - error - ); - } - } - } - ); - parentPort.postMessage({ - id: ChargingStationWorkerMessageEvents.STARTED, - data: { id: this.stationInfo.chargingStationId }, - }); - } - - public async stop(reason: StopTransactionReason = StopTransactionReason.NONE): Promise { - // Stop message sequence - await this.stopMessageSequence(reason); - for (const connectorId of this.connectors.keys()) { - if (connectorId > 0) { - await this.ocppRequestService.requestHandler< - StatusNotificationRequest, - StatusNotificationResponse - >(RequestCommand.STATUS_NOTIFICATION, { - connectorId, - status: ChargePointStatus.UNAVAILABLE, - errorCode: ChargePointErrorCode.NO_ERROR, - }); - this.getConnectorStatus(connectorId).status = ChargePointStatus.UNAVAILABLE; - } - } - if (this.isWebSocketConnectionOpened()) { - this.wsConnection.close(); - } - if (this.getEnableStatistics()) { - this.performanceStatistics.stop(); - } - this.bootNotificationResponse = null; - parentPort.postMessage({ - id: ChargingStationWorkerMessageEvents.STOPPED, - data: { id: this.stationInfo.chargingStationId }, - }); - this.stopped = true; - } - - public async reset(reason?: StopTransactionReason): Promise { - await this.stop(reason); - await Utils.sleep(this.stationInfo.resetTime); - this.stationInfo = this.getStationInfo(); - this.stationInfo?.Connectors && delete this.stationInfo.Connectors; - this.start(); } - public getConfigurationKey( - key: string | StandardParametersKey, - caseInsensitive = false - ): ConfigurationKey | undefined { - return this.ocppConfiguration.configurationKey.find((configElement) => { - if (caseInsensitive) { - return configElement.key.toLowerCase() === key.toLowerCase(); - } - return configElement.key === key; - }); - } - - public addConfigurationKey( - key: string | StandardParametersKey, - value: string, - options: { readonly?: boolean; visible?: boolean; reboot?: boolean } = { - readonly: false, - visible: true, - reboot: false, - }, - params: { overwrite?: boolean; save?: boolean } = { overwrite: false, save: false } - ): void { - options = options ?? ({} as { readonly?: boolean; visible?: boolean; reboot?: boolean }); - options.readonly = options?.readonly ?? false; - options.visible = options?.visible ?? true; - options.reboot = options?.reboot ?? false; - let keyFound = this.getConfigurationKey(key); - if (keyFound && params?.overwrite) { - this.deleteConfigurationKey(keyFound.key, { save: false }); - keyFound = undefined; - } - if (!keyFound) { - this.ocppConfiguration.configurationKey.push({ - key, - readonly: options.readonly, - value, - visible: options.visible, - reboot: options.reboot, - }); - params?.save && this.saveOcppConfiguration(); - } else { - logger.error( - `${this.logPrefix()} Trying to add an already existing configuration key: %j`, - keyFound - ); + public closeWSConnection(): void { + if (this.isWebSocketConnectionOpened() === true) { + this.wsConnection?.close(); + this.wsConnection = null; } } - public setConfigurationKeyValue( - key: string | StandardParametersKey, - value: string, - caseInsensitive = false + public startAutomaticTransactionGenerator( + connectorIds?: number[], + automaticTransactionGeneratorConfiguration?: AutomaticTransactionGeneratorConfiguration ): void { - const keyFound = this.getConfigurationKey(key, caseInsensitive); - if (keyFound) { - this.ocppConfiguration.configurationKey[ - this.ocppConfiguration.configurationKey.indexOf(keyFound) - ].value = value; - this.saveOcppConfiguration(); + this.automaticTransactionGenerator = AutomaticTransactionGenerator.getInstance( + automaticTransactionGeneratorConfiguration ?? + this.getAutomaticTransactionGeneratorConfigurationFromTemplate(), + this + ); + if (Utils.isNotEmptyArray(connectorIds)) { + for (const connectorId of connectorIds) { + this.automaticTransactionGenerator?.startConnector(connectorId); + } } else { - logger.error( - `${this.logPrefix()} Trying to set a value on a non existing configuration key: %j`, - { key, value } - ); + this.automaticTransactionGenerator?.start(); } + parentPort?.postMessage(MessageChannelUtils.buildUpdatedMessage(this)); } - public deleteConfigurationKey( - key: string | StandardParametersKey, - params: { save?: boolean; caseInsensitive?: boolean } = { save: true, caseInsensitive: false } - ): ConfigurationKey[] { - const keyFound = this.getConfigurationKey(key, params?.caseInsensitive); - if (keyFound) { - const deletedConfigurationKey = this.ocppConfiguration.configurationKey.splice( - this.ocppConfiguration.configurationKey.indexOf(keyFound), - 1 - ); - params?.save && this.saveOcppConfiguration(); - return deletedConfigurationKey; + public stopAutomaticTransactionGenerator(connectorIds?: number[]): void { + if (Utils.isNotEmptyArray(connectorIds)) { + for (const connectorId of connectorIds) { + this.automaticTransactionGenerator?.stopConnector(connectorId); + } + } else { + this.automaticTransactionGenerator?.stop(); } + parentPort?.postMessage(MessageChannelUtils.buildUpdatedMessage(this)); } - public getChargingProfilePowerLimit(connectorId: number): number | undefined { - let limit: number; - let matchingChargingProfile: ChargingProfile; - let chargingProfiles: ChargingProfile[] = []; - // Get profiles for connector and sort by stack level - chargingProfiles = this.getConnectorStatus(connectorId).chargingProfiles.sort( - (a, b) => b.stackLevel - a.stackLevel - ); - // Get profiles on connector 0 - if (this.getConnectorStatus(0).chargingProfiles) { - chargingProfiles.push( - ...this.getConnectorStatus(0).chargingProfiles.sort((a, b) => b.stackLevel - a.stackLevel) + public async stopTransactionOnConnector( + connectorId: number, + reason = StopTransactionReason.NONE + ): Promise { + const transactionId = this.getConnectorStatus(connectorId)?.transactionId; + if ( + this.getBeginEndMeterValues() === true && + this.getOcppStrictCompliance() === true && + this.getOutOfOrderEndMeterValues() === false + ) { + // FIXME: Implement OCPP version agnostic helpers + const transactionEndMeterValue = OCPP16ServiceUtils.buildTransactionEndMeterValue( + this, + connectorId, + this.getEnergyActiveImportRegisterByTransactionId(transactionId) ); - } - if (!Utils.isEmptyArray(chargingProfiles)) { - const result = this.getCurrentLimitFromOCPPProfiles(chargingProfiles); - if (!Utils.isNullOrUndefined(result)) { - limit = result.limit; - matchingChargingProfile = result.matchingChargingProfile; - switch (this.getCurrentOutType()) { - case CurrentType.AC: - limit = - matchingChargingProfile.chargingSchedule.chargingRateUnit === - ChargingRateUnitType.WATT - ? limit - : ACElectricUtils.powerTotal(this.getNumberOfPhases(), this.getVoltageOut(), limit); - break; - case CurrentType.DC: - limit = - matchingChargingProfile.chargingSchedule.chargingRateUnit === - ChargingRateUnitType.WATT - ? limit - : DCElectricUtils.power(this.getVoltageOut(), limit); - } - - const connectorMaximumPower = this.getMaximumPower() / this.stationInfo.powerDivider; - if (limit > connectorMaximumPower) { - logger.error( - `${this.logPrefix()} Charging profile id ${ - matchingChargingProfile.chargingProfileId - } limit is greater than connector id ${connectorId} maximum, dump charging profiles' stack: %j`, - this.getConnectorStatus(connectorId).chargingProfiles - ); - limit = connectorMaximumPower; - } - } - } - return limit; - } - - public setChargingProfile(connectorId: number, cp: ChargingProfile): void { - // Add support for connectorID 0 - if (!Array.isArray(this.getConnectorStatus(connectorId).chargingProfiles)) { - this.getConnectorStatus(connectorId).chargingProfiles = []; - } - let cpReplaced = false; - if (!Utils.isEmptyArray(this.getConnectorStatus(connectorId).chargingProfiles)) { - this.getConnectorStatus(connectorId).chargingProfiles?.forEach( - (chargingProfile: ChargingProfile, index: number) => { - if ( - chargingProfile.chargingProfileId === cp.chargingProfileId || - (chargingProfile.stackLevel === cp.stackLevel && - chargingProfile.chargingProfilePurpose === cp.chargingProfilePurpose) - ) { - this.getConnectorStatus(connectorId).chargingProfiles[index] = cp; - cpReplaced = true; - } + await this.ocppRequestService.requestHandler( + this, + RequestCommand.METER_VALUES, + { + connectorId, + transactionId, + meterValue: [transactionEndMeterValue], } ); } - !cpReplaced && this.getConnectorStatus(connectorId).chargingProfiles?.push(cp); - } - - public resetConnectorStatus(connectorId: number): void { - this.getConnectorStatus(connectorId).idTagLocalAuthorized = false; - this.getConnectorStatus(connectorId).idTagAuthorized = false; - this.getConnectorStatus(connectorId).transactionRemoteStarted = false; - this.getConnectorStatus(connectorId).transactionStarted = false; - delete this.getConnectorStatus(connectorId).localAuthorizeIdTag; - delete this.getConnectorStatus(connectorId).authorizeIdTag; - delete this.getConnectorStatus(connectorId).transactionId; - delete this.getConnectorStatus(connectorId).transactionIdTag; - this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue = 0; - delete this.getConnectorStatus(connectorId).transactionBeginMeterValue; - this.stopMeterValues(connectorId); - } - - public hasFeatureProfile(featureProfile: SupportedFeatureProfiles) { - return this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles)?.value.includes( - featureProfile + return this.ocppRequestService.requestHandler( + this, + RequestCommand.STOP_TRANSACTION, + { + transactionId, + meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId, true), + reason, + } ); } - public bufferMessage(message: string): void { - this.messageBuffer.add(message); - } - - private flushMessageBuffer() { + private flushMessageBuffer(): void { if (this.messageBuffer.size > 0) { - this.messageBuffer.forEach((message) => { - // TODO: evaluate the need to track performance - this.wsConnection.send(message); + for (const message of this.messageBuffer.values()) { + let beginId: string; + let commandName: RequestCommand; + const [messageType] = JSON.parse(message) as OutgoingRequest | Response | ErrorResponse; + const isRequest = messageType === MessageType.CALL_MESSAGE; + if (isRequest) { + [, , commandName] = JSON.parse(message) as OutgoingRequest; + beginId = PerformanceStatistics.beginMeasure(commandName); + } + this.wsConnection?.send(message); + isRequest && PerformanceStatistics.endMeasure(commandName, beginId); + logger.debug( + `${this.logPrefix()} >> Buffered ${OCPPServiceUtils.getMessageTypeString( + messageType + )} payload sent: ${message}` + ); this.messageBuffer.delete(message); - }); + } } } @@ -851,406 +907,390 @@ export default class ChargingStation { } private getSupervisionUrlOcppKey(): string { - return this.stationInfo.supervisionUrlOcppKey ?? VendorDefaultParametersKey.ConnectionUrl; - } - - private getChargingStationId(stationTemplate: ChargingStationTemplate): string { - // In case of multiple instances: add instance index to charging station id - const instanceIndex = process.env.CF_INSTANCE_INDEX ?? 0; - const idSuffix = stationTemplate.nameSuffix ?? ''; - const idStr = '000000000' + this.index.toString(); - return stationTemplate.fixedName - ? stationTemplate.baseName - : stationTemplate.baseName + - '-' + - instanceIndex.toString() + - idStr.substring(idStr.length - 4) + - idSuffix; - } - - private getRandomSerialNumberSuffix(params?: { - randomBytesLength?: number; - upperCase?: boolean; - }): string { - const randomSerialNumberSuffix = crypto - .randomBytes(params?.randomBytesLength ?? 16) - .toString('hex'); - if (params?.upperCase) { - return randomSerialNumberSuffix.toUpperCase(); - } - return randomSerialNumberSuffix; - } - - private getTemplateFromFile(): ChargingStationTemplate | null { - let template: ChargingStationTemplate = null; + return this.stationInfo.supervisionUrlOcppKey ?? VendorParametersKey.ConnectionUrl; + } + + private getTemplateFromFile(): ChargingStationTemplate | undefined { + let template: ChargingStationTemplate; try { - const measureId = `${FileType.ChargingStationTemplate} read`; - const beginId = PerformanceStatistics.beginMeasure(measureId); - template = - (JSON.parse(fs.readFileSync(this.templateFile, 'utf8')) as ChargingStationTemplate) ?? - ({} as ChargingStationTemplate); - PerformanceStatistics.endMeasure(measureId, beginId); - template.templateHash = crypto - .createHash(Constants.DEFAULT_HASH_ALGORITHM) - .update(JSON.stringify(template)) - .digest('hex'); + if (this.sharedLRUCache.hasChargingStationTemplate(this.templateFileHash)) { + template = this.sharedLRUCache.getChargingStationTemplate(this.templateFileHash); + } else { + const measureId = `${FileType.ChargingStationTemplate} read`; + const beginId = PerformanceStatistics.beginMeasure(measureId); + template = JSON.parse( + fs.readFileSync(this.templateFile, 'utf8') + ) as ChargingStationTemplate; + PerformanceStatistics.endMeasure(measureId, beginId); + template.templateHash = crypto + .createHash(Constants.DEFAULT_HASH_ALGORITHM) + .update(JSON.stringify(template)) + .digest('hex'); + this.sharedLRUCache.setChargingStationTemplate(template); + this.templateFileHash = template.templateHash; + } } catch (error) { FileUtils.handleFileException( - this.logPrefix(), - FileType.ChargingStationTemplate, this.templateFile, - error as NodeJS.ErrnoException + FileType.ChargingStationTemplate, + error as NodeJS.ErrnoException, + this.logPrefix() ); } return template; } - private createSerialNumber( - stationInfo: ChargingStationInfo, - existingStationInfo?: ChargingStationInfo, - params: { randomSerialNumberUpperCase?: boolean; randomSerialNumber?: boolean } = { - randomSerialNumberUpperCase: true, - randomSerialNumber: true, + private getStationInfoFromTemplate(): ChargingStationInfo { + const stationTemplate: ChargingStationTemplate | undefined = this.getTemplateFromFile(); + ChargingStationUtils.checkTemplateFile(stationTemplate, this.logPrefix(), this.templateFile); + ChargingStationUtils.warnTemplateKeysDeprecation( + stationTemplate, + this.logPrefix(), + this.templateFile + ); + if (stationTemplate?.Connectors) { + ChargingStationUtils.checkConnectorsConfiguration( + stationTemplate, + this.logPrefix(), + this.templateFile + ); } - ): void { - params = params ?? {}; - params.randomSerialNumberUpperCase = params?.randomSerialNumberUpperCase ?? true; - params.randomSerialNumber = params?.randomSerialNumber ?? true; - if (!Utils.isEmptyObject(existingStationInfo)) { - existingStationInfo?.chargePointSerialNumber && - (stationInfo.chargePointSerialNumber = existingStationInfo.chargePointSerialNumber); - existingStationInfo?.chargeBoxSerialNumber && - (stationInfo.chargeBoxSerialNumber = existingStationInfo.chargeBoxSerialNumber); - existingStationInfo?.meterSerialNumber && - (stationInfo.meterSerialNumber = existingStationInfo.meterSerialNumber); + const stationInfo: ChargingStationInfo = + ChargingStationUtils.stationTemplateToStationInfo(stationTemplate); + stationInfo.hashId = ChargingStationUtils.getHashId(this.index, stationTemplate); + stationInfo.chargingStationId = ChargingStationUtils.getChargingStationId( + this.index, + stationTemplate + ); + stationInfo.ocppVersion = stationTemplate?.ocppVersion ?? OCPPVersion.VERSION_16; + ChargingStationUtils.createSerialNumber(stationTemplate, stationInfo); + if (Utils.isNotEmptyArray(stationTemplate?.power)) { + stationTemplate.power = stationTemplate.power as number[]; + const powerArrayRandomIndex = Math.floor(Utils.secureRandom() * stationTemplate.power.length); + stationInfo.maximumPower = + stationTemplate?.powerUnit === PowerUnits.KILO_WATT + ? stationTemplate.power[powerArrayRandomIndex] * 1000 + : stationTemplate.power[powerArrayRandomIndex]; } else { - const serialNumberSuffix = params?.randomSerialNumber - ? this.getRandomSerialNumberSuffix({ upperCase: params.randomSerialNumberUpperCase }) - : ''; - stationInfo.chargePointSerialNumber = - stationInfo?.chargePointSerialNumberPrefix && - stationInfo.chargePointSerialNumberPrefix + serialNumberSuffix; - stationInfo.chargeBoxSerialNumber = - stationInfo?.chargeBoxSerialNumberPrefix && - stationInfo.chargeBoxSerialNumberPrefix + serialNumberSuffix; - stationInfo.meterSerialNumber = - stationInfo?.meterSerialNumberPrefix && - stationInfo.meterSerialNumberPrefix + serialNumberSuffix; - } - } - - private getStationInfoFromTemplate(): ChargingStationInfo { - const stationInfo: ChargingStationInfo = this.getTemplateFromFile(); - if (Utils.isNullOrUndefined(stationInfo)) { - const logMsg = 'Failed to read charging station template file'; - logger.error(`${this.logPrefix()} ${logMsg}`); - throw new BaseError(logMsg); + stationTemplate.power = stationTemplate?.power as number; + stationInfo.maximumPower = + stationTemplate?.powerUnit === PowerUnits.KILO_WATT + ? stationTemplate.power * 1000 + : stationTemplate.power; } - if (Utils.isEmptyObject(stationInfo)) { + stationInfo.firmwareVersionPattern = + stationTemplate?.firmwareVersionPattern ?? Constants.SEMVER_PATTERN; + if ( + Utils.isNotEmptyString(stationInfo.firmwareVersion) && + new RegExp(stationInfo.firmwareVersionPattern).test(stationInfo.firmwareVersion) === false + ) { logger.warn( - `${this.logPrefix()} Empty charging station information from template file ${ + `${this.logPrefix()} Firmware version '${stationInfo.firmwareVersion}' in template file ${ this.templateFile - }` + } does not match firmware version pattern '${stationInfo.firmwareVersionPattern}'` ); } - const chargingStationId = this.getChargingStationId(stationInfo); - // Deprecation template keys section - this.warnDeprecatedTemplateKey( - stationInfo, - 'supervisionUrl', - chargingStationId, - "Use 'supervisionUrls' instead" + stationInfo.firmwareUpgrade = merge( + { + versionUpgrade: { + step: 1, + }, + reset: true, + }, + stationTemplate?.firmwareUpgrade ?? {} ); - this.convertDeprecatedTemplateKey(stationInfo, 'supervisionUrl', 'supervisionUrls'); - stationInfo.wsOptions = stationInfo?.wsOptions ?? {}; - if (!Utils.isEmptyArray(stationInfo.power)) { - stationInfo.power = stationInfo.power as number[]; - const powerArrayRandomIndex = Math.floor(Utils.secureRandom() * stationInfo.power.length); - stationInfo.maximumPower = - stationInfo.powerUnit === PowerUnits.KILO_WATT - ? stationInfo.power[powerArrayRandomIndex] * 1000 - : stationInfo.power[powerArrayRandomIndex]; - } else { - stationInfo.power = stationInfo.power as number; - stationInfo.maximumPower = - stationInfo.powerUnit === PowerUnits.KILO_WATT - ? stationInfo.power * 1000 - : stationInfo.power; - } - delete stationInfo.power; - delete stationInfo.powerUnit; - stationInfo.chargingStationId = chargingStationId; - stationInfo.resetTime = stationInfo.resetTime - ? stationInfo.resetTime * 1000 + stationInfo.resetTime = !Utils.isNullOrUndefined(stationTemplate?.resetTime) + ? stationTemplate.resetTime * 1000 : Constants.CHARGING_STATION_DEFAULT_RESET_TIME; + stationInfo.maximumAmperage = this.getMaximumAmperage(stationInfo); return stationInfo; } - private createStationInfoHash(stationInfo: ChargingStationInfo): ChargingStationInfo { - if (!Utils.isEmptyObject(stationInfo)) { - const previousInfoHash = stationInfo?.infoHash ?? ''; - delete stationInfo.infoHash; - const currentInfoHash = crypto - .createHash(Constants.DEFAULT_HASH_ALGORITHM) - .update(JSON.stringify(stationInfo)) - .digest('hex'); - if ( - Utils.isEmptyString(previousInfoHash) || - (!Utils.isEmptyString(previousInfoHash) && currentInfoHash !== previousInfoHash) - ) { - stationInfo.infoHash = currentInfoHash; - } else { - stationInfo.infoHash = previousInfoHash; + private getStationInfoFromFile(): ChargingStationInfo | undefined { + let stationInfo: ChargingStationInfo | undefined; + if (this.getStationInfoPersistentConfiguration()) { + stationInfo = this.getConfigurationFromFile()?.stationInfo; + if (stationInfo) { + delete stationInfo?.infoHash; } } return stationInfo; } - private getStationInfoFromFile(): ChargingStationInfo { - let stationInfo = this.getConfigurationFromFile()?.stationInfo ?? ({} as ChargingStationInfo); - stationInfo = this.createStationInfoHash(stationInfo); - return stationInfo; - } - private getStationInfo(): ChargingStationInfo { const stationInfoFromTemplate: ChargingStationInfo = this.getStationInfoFromTemplate(); - this.hashId = this.getHashId(stationInfoFromTemplate); - this.configurationFile = path.join( - path.resolve(__dirname, '../'), - 'assets', - 'configurations', - this.hashId + '.json' - ); - const stationInfoFromFile: ChargingStationInfo = this.getStationInfoFromFile(); - // Priority: charging station info from template > charging station info from configuration file > charging station info attribute + const stationInfoFromFile: ChargingStationInfo | undefined = this.getStationInfoFromFile(); + // Priority: + // 1. charging station info from template + // 2. charging station info from configuration file if (stationInfoFromFile?.templateHash === stationInfoFromTemplate.templateHash) { - if (this.stationInfo?.infoHash === stationInfoFromFile?.infoHash) { - return this.stationInfo; - } return stationInfoFromFile; } - this.createSerialNumber(stationInfoFromTemplate, stationInfoFromFile); + stationInfoFromFile && + ChargingStationUtils.propagateSerialNumber( + this.getTemplateFromFile(), + stationInfoFromFile, + stationInfoFromTemplate + ); return stationInfoFromTemplate; } private saveStationInfo(): void { - this.saveConfiguration(Section.stationInfo); + if (this.getStationInfoPersistentConfiguration()) { + this.saveConfiguration(); + } } - private getOcppVersion(): OCPPVersion { - return this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16; + private getOcppPersistentConfiguration(): boolean { + return this.stationInfo?.ocppPersistentConfiguration ?? true; } - private getOcppPersistentConfiguration(): boolean { - return this.stationInfo.ocppPersistentConfiguration ?? true; + private getStationInfoPersistentConfiguration(): boolean { + return this.stationInfo?.stationInfoPersistentConfiguration ?? true; } private handleUnsupportedVersion(version: OCPPVersion) { - const errMsg = `${this.logPrefix()} Unsupported protocol version '${version}' configured in template file ${ - this.templateFile - }`; - logger.error(errMsg); - throw new Error(errMsg); - } - - private createBootNotificationRequest(stationInfo: ChargingStationInfo): BootNotificationRequest { - return { - chargePointModel: stationInfo.chargePointModel, - chargePointVendor: stationInfo.chargePointVendor, - ...(!Utils.isUndefined(stationInfo.chargeBoxSerialNumber) && { - chargeBoxSerialNumber: stationInfo.chargeBoxSerialNumber, - }), - ...(!Utils.isUndefined(stationInfo.chargePointSerialNumber) && { - chargePointSerialNumber: stationInfo.chargePointSerialNumber, - }), - ...(!Utils.isUndefined(stationInfo.firmwareVersion) && { - firmwareVersion: stationInfo.firmwareVersion, - }), - ...(!Utils.isUndefined(stationInfo.iccid) && { iccid: stationInfo.iccid }), - ...(!Utils.isUndefined(stationInfo.imsi) && { imsi: stationInfo.imsi }), - ...(!Utils.isUndefined(stationInfo.meterSerialNumber) && { - meterSerialNumber: stationInfo.meterSerialNumber, - }), - ...(!Utils.isUndefined(stationInfo.meterType) && { - meterType: stationInfo.meterType, - }), - }; - } - - private getHashId(stationInfo: ChargingStationInfo): string { - const hashBootNotificationRequest = { - chargePointModel: stationInfo.chargePointModel, - chargePointVendor: stationInfo.chargePointVendor, - ...(!Utils.isUndefined(stationInfo.chargeBoxSerialNumberPrefix) && { - chargeBoxSerialNumber: stationInfo.chargeBoxSerialNumberPrefix, - }), - ...(!Utils.isUndefined(stationInfo.chargePointSerialNumberPrefix) && { - chargePointSerialNumber: stationInfo.chargePointSerialNumberPrefix, - }), - ...(!Utils.isUndefined(stationInfo.firmwareVersion) && { - firmwareVersion: stationInfo.firmwareVersion, - }), - ...(!Utils.isUndefined(stationInfo.iccid) && { iccid: stationInfo.iccid }), - ...(!Utils.isUndefined(stationInfo.imsi) && { imsi: stationInfo.imsi }), - ...(!Utils.isUndefined(stationInfo.meterSerialNumberPrefix) && { - meterSerialNumber: stationInfo.meterSerialNumberPrefix, - }), - ...(!Utils.isUndefined(stationInfo.meterType) && { - meterType: stationInfo.meterType, - }), - }; - return crypto - .createHash(Constants.DEFAULT_HASH_ALGORITHM) - .update(JSON.stringify(hashBootNotificationRequest) + stationInfo.chargingStationId) - .digest('hex'); + const errorMsg = `Unsupported protocol version '${version}' configured in template file ${this.templateFile}`; + logger.error(`${this.logPrefix()} ${errorMsg}`); + throw new BaseError(errorMsg); } private initialize(): void { - this.stationInfo = this.getStationInfo(); - logger.info(`${this.logPrefix()} Charging station hashId '${this.hashId}'`); - this.bootNotificationRequest = this.createBootNotificationRequest(this.stationInfo); - this.ocppConfiguration = this.getOcppConfiguration(); - this.stationInfo?.Configuration && delete this.stationInfo.Configuration; - this.wsConfiguredConnectionUrl = new URL( - this.getConfiguredSupervisionUrl().href + '/' + this.stationInfo.chargingStationId + const stationTemplate = this.getTemplateFromFile(); + ChargingStationUtils.checkTemplateFile(stationTemplate, this.logPrefix(), this.templateFile); + this.configurationFile = path.join( + path.dirname(this.templateFile.replace('station-templates', 'configurations')), + `${ChargingStationUtils.getHashId(this.index, stationTemplate)}.json` ); - // Build connectors if needed - const maxConnectors = this.getMaxNumberOfConnectors(); - this.checkMaxConnectors(maxConnectors); - const templateMaxConnectors = this.getTemplateMaxNumberOfConnectors(); - this.checkTemplateMaxConnectors(templateMaxConnectors); + this.initializeConnectorsOrEvsesFromTemplate(stationTemplate); + this.stationInfo = this.getStationInfo(); if ( - maxConnectors > - (this.stationInfo?.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) && - !this.stationInfo.randomConnectors + this.stationInfo.firmwareStatus === FirmwareStatus.Installing && + Utils.isNotEmptyString(this.stationInfo.firmwareVersion) && + Utils.isNotEmptyString(this.stationInfo.firmwareVersionPattern) ) { - logger.warn( - `${this.logPrefix()} Number of connectors exceeds the number of connector configurations in template ${ - this.templateFile - }, forcing random connector configurations affectation` - ); - this.stationInfo.randomConnectors = true; + const patternGroup: number | undefined = + this.stationInfo.firmwareUpgrade?.versionUpgrade?.patternGroup ?? + this.stationInfo.firmwareVersion?.split('.').length; + const match = this.stationInfo?.firmwareVersion + ?.match(new RegExp(this.stationInfo.firmwareVersionPattern)) + ?.slice(1, patternGroup + 1); + const patchLevelIndex = match.length - 1; + match[patchLevelIndex] = ( + Utils.convertToInt(match[patchLevelIndex]) + + this.stationInfo.firmwareUpgrade?.versionUpgrade?.step + ).toString(); + this.stationInfo.firmwareVersion = match?.join('.'); } - this.initializeConnectors(this.stationInfo, maxConnectors, templateMaxConnectors); - this.stationInfo.maximumAmperage = this.getMaximumAmperage(); - this.stationInfo = this.createStationInfoHash(this.stationInfo); this.saveStationInfo(); - // Avoid duplication of connectors related information in RAM - this.stationInfo?.Connectors && delete this.stationInfo.Connectors; - // OCPP configuration - this.initializeOcppConfiguration(); - if (this.getEnableStatistics()) { + this.configuredSupervisionUrl = this.getConfiguredSupervisionUrl(); + if (this.getEnableStatistics() === true) { this.performanceStatistics = PerformanceStatistics.getInstance( - this.hashId, + this.stationInfo.hashId, this.stationInfo.chargingStationId, - this.wsConnectionUrl + this.configuredSupervisionUrl ); } - switch (this.getOcppVersion()) { + this.bootNotificationRequest = ChargingStationUtils.createBootNotificationRequest( + this.stationInfo + ); + this.powerDivider = this.getPowerDivider(); + // OCPP configuration + this.ocppConfiguration = this.getOcppConfiguration(); + this.initializeOcppConfiguration(); + this.initializeOcppServices(); + if (this.stationInfo?.autoRegister === true) { + this.bootNotificationResponse = { + currentTime: new Date(), + interval: this.getHeartbeatInterval() / 1000, + status: RegistrationStatusEnumType.ACCEPTED, + }; + } + } + + private initializeOcppServices(): void { + const ocppVersion = this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16; + switch (ocppVersion) { case OCPPVersion.VERSION_16: this.ocppIncomingRequestService = - OCPP16IncomingRequestService.getInstance(this); + OCPP16IncomingRequestService.getInstance(); this.ocppRequestService = OCPP16RequestService.getInstance( - this, - OCPP16ResponseService.getInstance(this) + OCPP16ResponseService.getInstance() + ); + break; + case OCPPVersion.VERSION_20: + case OCPPVersion.VERSION_201: + this.ocppIncomingRequestService = + OCPP20IncomingRequestService.getInstance(); + this.ocppRequestService = OCPP20RequestService.getInstance( + OCPP20ResponseService.getInstance() ); break; default: - this.handleUnsupportedVersion(this.getOcppVersion()); + this.handleUnsupportedVersion(ocppVersion); break; } - if (this.stationInfo.autoRegister) { - this.bootNotificationResponse = { - currentTime: new Date().toISOString(), - interval: this.getHeartbeatInterval() / 1000, - status: RegistrationStatus.ACCEPTED, - }; - } - this.stationInfo.powerDivider = this.getPowerDivider(); } private initializeOcppConfiguration(): void { - if (!this.getConfigurationKey(StandardParametersKey.HeartbeatInterval)) { - this.addConfigurationKey(StandardParametersKey.HeartbeatInterval, '0'); + if ( + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.HeartbeatInterval + ) + ) { + ChargingStationConfigurationUtils.addConfigurationKey( + this, + StandardParametersKey.HeartbeatInterval, + '0' + ); } - if (!this.getConfigurationKey(StandardParametersKey.HeartBeatInterval)) { - this.addConfigurationKey(StandardParametersKey.HeartBeatInterval, '0', { visible: false }); + if ( + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.HeartBeatInterval + ) + ) { + ChargingStationConfigurationUtils.addConfigurationKey( + this, + StandardParametersKey.HeartBeatInterval, + '0', + { visible: false } + ); } if ( this.getSupervisionUrlOcppConfiguration() && - !this.getConfigurationKey(this.getSupervisionUrlOcppKey()) + Utils.isNotEmptyString(this.getSupervisionUrlOcppKey()) && + !ChargingStationConfigurationUtils.getConfigurationKey(this, this.getSupervisionUrlOcppKey()) ) { - this.addConfigurationKey( + ChargingStationConfigurationUtils.addConfigurationKey( + this, this.getSupervisionUrlOcppKey(), - this.getConfiguredSupervisionUrl().href, + this.configuredSupervisionUrl.href, { reboot: true } ); } else if ( !this.getSupervisionUrlOcppConfiguration() && - this.getConfigurationKey(this.getSupervisionUrlOcppKey()) + Utils.isNotEmptyString(this.getSupervisionUrlOcppKey()) && + ChargingStationConfigurationUtils.getConfigurationKey(this, this.getSupervisionUrlOcppKey()) ) { - this.deleteConfigurationKey(this.getSupervisionUrlOcppKey(), { save: false }); + ChargingStationConfigurationUtils.deleteConfigurationKey( + this, + this.getSupervisionUrlOcppKey(), + { save: false } + ); } if ( - this.stationInfo.amperageLimitationOcppKey && - !this.getConfigurationKey(this.stationInfo.amperageLimitationOcppKey) + Utils.isNotEmptyString(this.stationInfo?.amperageLimitationOcppKey) && + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + this.stationInfo.amperageLimitationOcppKey + ) ) { - this.addConfigurationKey( + ChargingStationConfigurationUtils.addConfigurationKey( + this, this.stationInfo.amperageLimitationOcppKey, - (this.stationInfo.maximumAmperage * this.getAmperageLimitationUnitDivider()).toString() + ( + this.stationInfo.maximumAmperage * + ChargingStationUtils.getAmperageLimitationUnitDivider(this.stationInfo) + ).toString() ); } - if (!this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles)) { - this.addConfigurationKey( + if ( + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.SupportedFeatureProfiles + ) + ) { + ChargingStationConfigurationUtils.addConfigurationKey( + this, StandardParametersKey.SupportedFeatureProfiles, `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.FirmwareManagement},${SupportedFeatureProfiles.LocalAuthListManagement},${SupportedFeatureProfiles.SmartCharging},${SupportedFeatureProfiles.RemoteTrigger}` ); } - this.addConfigurationKey( + ChargingStationConfigurationUtils.addConfigurationKey( + this, StandardParametersKey.NumberOfConnectors, this.getNumberOfConnectors().toString(), { readonly: true }, { overwrite: true } ); - if (!this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData)) { - this.addConfigurationKey( + if ( + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.MeterValuesSampledData + ) + ) { + ChargingStationConfigurationUtils.addConfigurationKey( + this, StandardParametersKey.MeterValuesSampledData, MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER ); } - if (!this.getConfigurationKey(StandardParametersKey.ConnectorPhaseRotation)) { - const connectorPhaseRotation = []; - for (const connectorId of this.connectors.keys()) { - // AC/DC - 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 (connectorId > 0 && this.getNumberOfPhases() === 1) { - connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.NotApplicable}`); - } else if (connectorId > 0 && this.getNumberOfPhases() === 3) { - connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.RST}`); + if ( + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.ConnectorPhaseRotation + ) + ) { + const connectorsPhaseRotation: string[] = []; + if (this.hasEvses) { + for (const evseStatus of this.evses.values()) { + for (const connectorId of evseStatus.connectors.keys()) { + connectorsPhaseRotation.push( + ChargingStationUtils.getPhaseRotationValue(connectorId, this.getNumberOfPhases()) + ); + } + } + } else { + for (const connectorId of this.connectors.keys()) { + connectorsPhaseRotation.push( + ChargingStationUtils.getPhaseRotationValue(connectorId, this.getNumberOfPhases()) + ); } } - this.addConfigurationKey( + ChargingStationConfigurationUtils.addConfigurationKey( + this, StandardParametersKey.ConnectorPhaseRotation, - connectorPhaseRotation.toString() + connectorsPhaseRotation.toString() ); } - if (!this.getConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests)) { - this.addConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests, 'true'); - } if ( - !this.getConfigurationKey(StandardParametersKey.LocalAuthListEnabled) && - this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles)?.value.includes( - SupportedFeatureProfiles.LocalAuthListManagement + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.AuthorizeRemoteTxRequests ) ) { - this.addConfigurationKey(StandardParametersKey.LocalAuthListEnabled, 'false'); + ChargingStationConfigurationUtils.addConfigurationKey( + this, + StandardParametersKey.AuthorizeRemoteTxRequests, + 'true' + ); + } + if ( + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.LocalAuthListEnabled + ) && + ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.SupportedFeatureProfiles + )?.value?.includes(SupportedFeatureProfiles.LocalAuthListManagement) + ) { + ChargingStationConfigurationUtils.addConfigurationKey( + this, + StandardParametersKey.LocalAuthListEnabled, + 'false' + ); } - if (!this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) { - this.addConfigurationKey( + if ( + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.ConnectionTimeOut + ) + ) { + ChargingStationConfigurationUtils.addConfigurationKey( + this, StandardParametersKey.ConnectionTimeOut, Constants.DEFAULT_CONNECTION_TIMEOUT.toString() ); @@ -1258,69 +1298,83 @@ export default class ChargingStation { this.saveOcppConfiguration(); } - private initializeConnectors( - stationInfo: ChargingStationInfo, - maxConnectors: number, - templateMaxConnectors: number - ): void { - if (!stationInfo?.Connectors && this.connectors.size === 0) { - const logMsg = `${this.logPrefix()} No already defined connectors and charging station information from template ${ - this.templateFile - } with no connectors configuration defined`; - logger.error(logMsg); - throw new BaseError(logMsg); + private initializeConnectorsOrEvsesFromTemplate(stationTemplate: ChargingStationTemplate) { + if (stationTemplate?.Connectors && !stationTemplate?.Evses) { + this.initializeConnectorsFromTemplate(stationTemplate); + } else if (stationTemplate?.Evses && !stationTemplate?.Connectors) { + this.initializeEvsesFromTemplate(stationTemplate); + } else if (stationTemplate?.Evses && stationTemplate?.Connectors) { + const errorMsg = `Connectors and evses defined at the same time in template file ${this.templateFile}`; + logger.error(`${this.logPrefix()} ${errorMsg}`); + throw new BaseError(errorMsg); + } else { + const errorMsg = `No connectors or evses defined in template file ${this.templateFile}`; + logger.error(`${this.logPrefix()} ${errorMsg}`); + throw new BaseError(errorMsg); } - if (!stationInfo?.Connectors[0]) { + } + + private initializeConnectorsFromTemplate(stationTemplate: ChargingStationTemplate): void { + if (!stationTemplate?.Connectors && this.connectors.size === 0) { + const errorMsg = `No already defined connectors and charging station information from template ${this.templateFile} with no connectors configuration defined`; + logger.error(`${this.logPrefix()} ${errorMsg}`); + throw new BaseError(errorMsg); + } + if (!stationTemplate?.Connectors[0]) { logger.warn( `${this.logPrefix()} Charging station information from template ${ this.templateFile - } with no connector Id 0 configuration` + } with no connector id 0 configuration` ); } - if (stationInfo?.Connectors) { + if (stationTemplate?.Connectors) { + const { configuredMaxConnectors, templateMaxConnectors, templateMaxAvailableConnectors } = + ChargingStationUtils.checkConnectorsConfiguration( + stationTemplate, + this.logPrefix(), + this.templateFile + ); const connectorsConfigHash = crypto .createHash(Constants.DEFAULT_HASH_ALGORITHM) - .update(JSON.stringify(stationInfo?.Connectors) + maxConnectors.toString()) + .update( + `${JSON.stringify(stationTemplate?.Connectors)}${configuredMaxConnectors.toString()}` + ) .digest('hex'); const connectorsConfigChanged = this.connectors?.size !== 0 && this.connectorsConfigurationHash !== connectorsConfigHash; if (this.connectors?.size === 0 || connectorsConfigChanged) { connectorsConfigChanged && this.connectors.clear(); this.connectorsConfigurationHash = connectorsConfigHash; - // Add connector Id 0 - let lastConnector = '0'; - for (lastConnector in stationInfo?.Connectors) { - const lastConnectorId = Utils.convertToInt(lastConnector); - if ( - lastConnectorId === 0 && - this.getUseConnectorId0() && - stationInfo?.Connectors[lastConnector] - ) { - this.connectors.set( - lastConnectorId, - Utils.cloneObject(stationInfo?.Connectors[lastConnector]) - ); - this.getConnectorStatus(lastConnectorId).availability = AvailabilityType.OPERATIVE; - if (Utils.isUndefined(this.getConnectorStatus(lastConnectorId)?.chargingProfiles)) { - this.getConnectorStatus(lastConnectorId).chargingProfiles = []; + if (templateMaxConnectors > 0) { + for (let connectorId = 0; connectorId <= configuredMaxConnectors; connectorId++) { + if ( + connectorId === 0 && + (!stationTemplate?.Connectors[connectorId] || + this.getUseConnectorId0(stationTemplate) === false) + ) { + continue; } - } - } - // Generate all connectors - if ((stationInfo?.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) > 0) { - for (let index = 1; index <= maxConnectors; index++) { - const randConnectorId = stationInfo.randomConnectors - ? Utils.getRandomInteger(Utils.convertToInt(lastConnector), 1) - : index; - this.connectors.set( - index, - Utils.cloneObject(stationInfo?.Connectors[randConnectorId]) + const templateConnectorId = + connectorId > 0 && stationTemplate?.randomConnectors + ? Utils.getRandomInteger(templateMaxAvailableConnectors, 1) + : connectorId; + const connectorStatus = stationTemplate?.Connectors[templateConnectorId]; + ChargingStationUtils.checkStationInfoConnectorStatus( + templateConnectorId, + connectorStatus, + this.logPrefix(), + this.templateFile ); - this.getConnectorStatus(index).availability = AvailabilityType.OPERATIVE; - if (Utils.isUndefined(this.getConnectorStatus(index)?.chargingProfiles)) { - this.getConnectorStatus(index).chargingProfiles = []; - } + this.connectors.set(connectorId, Utils.cloneObject(connectorStatus)); } + ChargingStationUtils.initializeConnectorsMapStatus(this.connectors, this.logPrefix()); + this.saveConnectorsStatus(); + } else { + logger.warn( + `${this.logPrefix()} Charging station information from template ${ + this.templateFile + } with no connectors configuration defined, cannot create connectors` + ); } } } else { @@ -1330,104 +1384,173 @@ export default class ChargingStation { } with no connectors configuration defined, using already defined connectors` ); } - // Initialize transaction attributes on connectors - for (const connectorId of this.connectors.keys()) { - if (connectorId > 0 && !this.getConnectorStatus(connectorId)?.transactionStarted) { - this.initializeConnectorStatus(connectorId); - } - } } - private checkMaxConnectors(maxConnectors: number): void { - if (maxConnectors <= 0) { + private initializeEvsesFromTemplate(stationTemplate: ChargingStationTemplate): void { + if (!stationTemplate?.Evses && this.evses.size === 0) { + const errorMsg = `No already defined evses and charging station information from template ${this.templateFile} with no evses configuration defined`; + logger.error(`${this.logPrefix()} ${errorMsg}`); + throw new BaseError(errorMsg); + } + if (!stationTemplate?.Evses[0]) { logger.warn( `${this.logPrefix()} Charging station information from template ${ this.templateFile - } with ${maxConnectors} connectors` + } with no evse id 0 configuration` ); } - } - - private checkTemplateMaxConnectors(templateMaxConnectors: number): void { - if (templateMaxConnectors === 0) { + if (!stationTemplate?.Evses[0]?.Connectors[0]) { logger.warn( `${this.logPrefix()} Charging station information from template ${ this.templateFile - } with empty connectors configuration` + } with evse id 0 with no connector id 0 configuration` ); - } else if (templateMaxConnectors < 0) { - logger.error( + } + if (stationTemplate?.Evses) { + const evsesConfigHash = crypto + .createHash(Constants.DEFAULT_HASH_ALGORITHM) + .update(`${JSON.stringify(stationTemplate?.Evses)}`) + .digest('hex'); + const evsesConfigChanged = + this.evses?.size !== 0 && this.evsesConfigurationHash !== evsesConfigHash; + if (this.evses?.size === 0 || evsesConfigChanged) { + evsesConfigChanged && this.evses.clear(); + this.evsesConfigurationHash = evsesConfigHash; + const templateMaxEvses = ChargingStationUtils.getMaxNumberOfEvses(stationTemplate?.Evses); + if (templateMaxEvses > 0) { + for (const evse in stationTemplate.Evses) { + const evseId = Utils.convertToInt(evse); + this.evses.set(evseId, { + connectors: ChargingStationUtils.buildConnectorsMap( + stationTemplate?.Evses[evse]?.Connectors, + this.logPrefix(), + this.templateFile + ), + availability: AvailabilityType.Operative, + }); + ChargingStationUtils.initializeConnectorsMapStatus( + this.evses.get(evseId)?.connectors, + this.logPrefix() + ); + } + this.saveEvsesStatus(); + } else { + logger.warn( + `${this.logPrefix()} Charging station information from template ${ + this.templateFile + } with no evses configuration defined, cannot create evses` + ); + } + } + } else { + logger.warn( `${this.logPrefix()} Charging station information from template ${ this.templateFile - } with no connectors configuration defined` + } with no evses configuration defined, using already defined evses` ); } } - private getConfigurationFromFile(): ChargingStationConfiguration | null { - let configuration: ChargingStationConfiguration = null; + private getConfigurationFromFile(): ChargingStationConfiguration | undefined { + let configuration: ChargingStationConfiguration | undefined; if (this.configurationFile && fs.existsSync(this.configurationFile)) { try { - const measureId = `${FileType.ChargingStationConfiguration} read`; - const beginId = PerformanceStatistics.beginMeasure(measureId); - configuration = JSON.parse( - fs.readFileSync(this.configurationFile, 'utf8') - ) as ChargingStationConfiguration; - PerformanceStatistics.endMeasure(measureId, beginId); + if (this.sharedLRUCache.hasChargingStationConfiguration(this.configurationFileHash)) { + configuration = this.sharedLRUCache.getChargingStationConfiguration( + this.configurationFileHash + ); + } else { + const measureId = `${FileType.ChargingStationConfiguration} read`; + const beginId = PerformanceStatistics.beginMeasure(measureId); + configuration = JSON.parse( + fs.readFileSync(this.configurationFile, 'utf8') + ) as ChargingStationConfiguration; + PerformanceStatistics.endMeasure(measureId, beginId); + this.sharedLRUCache.setChargingStationConfiguration(configuration); + this.configurationFileHash = configuration.configurationHash; + } } catch (error) { - FileUtils.handleFileException( - this.logPrefix(), - FileType.ChargingStationConfiguration, + FileUtils.handleFileException( this.configurationFile, - error as NodeJS.ErrnoException + FileType.ChargingStationConfiguration, + error as NodeJS.ErrnoException, + this.logPrefix() ); } } return configuration; } - private saveConfiguration(section?: Section): void { + private saveConnectorsStatus() { + this.saveConfiguration(); + } + + private saveEvsesStatus() { + this.saveConfiguration(); + } + + private saveConfiguration(): void { if (this.configurationFile) { try { - const configurationData: ChargingStationConfiguration = - this.getConfigurationFromFile() ?? {}; if (!fs.existsSync(path.dirname(this.configurationFile))) { fs.mkdirSync(path.dirname(this.configurationFile), { recursive: true }); } - switch (section) { - case Section.ocppConfiguration: - configurationData.configurationKey = this.ocppConfiguration.configurationKey; - break; - case Section.stationInfo: - if (configurationData?.stationInfo?.infoHash === this.stationInfo?.infoHash) { - logger.debug( - `${this.logPrefix()} Not saving unchanged charging station information to configuration file ${ - this.configurationFile - }` - ); - return; - } - configurationData.stationInfo = this.stationInfo; - break; - default: - configurationData.configurationKey = this.ocppConfiguration.configurationKey; - if (configurationData?.stationInfo?.infoHash !== this.stationInfo?.infoHash) { - configurationData.stationInfo = this.stationInfo; - } - break; + const configurationData: ChargingStationConfiguration = + Utils.cloneObject(this.getConfigurationFromFile()) ?? {}; + if (this.getStationInfoPersistentConfiguration() && this.stationInfo) { + configurationData.stationInfo = this.stationInfo; + } + if (this.getOcppPersistentConfiguration() && this.ocppConfiguration?.configurationKey) { + configurationData.configurationKey = this.ocppConfiguration.configurationKey; + } + if (this.connectors.size > 0) { + configurationData.connectorsStatus = [...this.connectors.values()].map( + // eslint-disable-next-line @typescript-eslint/no-unused-vars + ({ transactionSetInterval, ...connectorStatusRest }) => connectorStatusRest + ); + } + if (this.evses.size > 0) { + configurationData.evsesStatus = [...this.evses.values()].map((evseStatus) => { + const status = { + ...evseStatus, + connectorsStatus: [...evseStatus.connectors.values()].map( + // eslint-disable-next-line @typescript-eslint/no-unused-vars + ({ transactionSetInterval, ...connectorStatusRest }) => connectorStatusRest + ), + }; + delete status.connectors; + return status as EvseStatusConfiguration; + }); + } + delete configurationData.configurationHash; + const configurationHash = crypto + .createHash(Constants.DEFAULT_HASH_ALGORITHM) + .update(JSON.stringify(configurationData)) + .digest('hex'); + if (this.configurationFileHash !== configurationHash) { + configurationData.configurationHash = configurationHash; + const measureId = `${FileType.ChargingStationConfiguration} write`; + const beginId = PerformanceStatistics.beginMeasure(measureId); + const fileDescriptor = fs.openSync(this.configurationFile, 'w'); + fs.writeFileSync(fileDescriptor, JSON.stringify(configurationData, null, 2), 'utf8'); + fs.closeSync(fileDescriptor); + PerformanceStatistics.endMeasure(measureId, beginId); + this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash); + this.sharedLRUCache.setChargingStationConfiguration(configurationData); + this.configurationFileHash = configurationHash; + } else { + logger.debug( + `${this.logPrefix()} Not saving unchanged charging station configuration file ${ + this.configurationFile + }` + ); } - const measureId = `${FileType.ChargingStationConfiguration} write`; - const beginId = PerformanceStatistics.beginMeasure(measureId); - const fileDescriptor = fs.openSync(this.configurationFile, 'w'); - fs.writeFileSync(fileDescriptor, JSON.stringify(configurationData, null, 2), 'utf8'); - fs.closeSync(fileDescriptor); - PerformanceStatistics.endMeasure(measureId, beginId); } catch (error) { FileUtils.handleFileException( - this.logPrefix(), - FileType.ChargingStationConfiguration, this.configurationFile, - error as NodeJS.ErrnoException + FileType.ChargingStationConfiguration, + error as NodeJS.ErrnoException, + this.logPrefix() ); } } else { @@ -1437,88 +1560,73 @@ export default class ChargingStation { } } - private getOcppConfigurationFromTemplate(): ChargingStationOcppConfiguration { - return this.getTemplateFromFile().Configuration ?? ({} as ChargingStationOcppConfiguration); + private getOcppConfigurationFromTemplate(): ChargingStationOcppConfiguration | undefined { + return this.getTemplateFromFile()?.Configuration; } - private getOcppConfigurationFromFile(): ChargingStationOcppConfiguration | null { - let configuration: ChargingStationConfiguration = null; - if (this.getOcppPersistentConfiguration()) { + private getOcppConfigurationFromFile(): ChargingStationOcppConfiguration | undefined { + let configuration: ChargingStationConfiguration | undefined; + if (this.getOcppPersistentConfiguration() === true) { const configurationFromFile = this.getConfigurationFromFile(); configuration = configurationFromFile?.configurationKey && configurationFromFile; } - configuration && delete configuration.stationInfo; + if (!Utils.isNullOrUndefined(configuration)) { + delete configuration.stationInfo; + delete configuration.configurationHash; + } return configuration; } - private getOcppConfiguration(): ChargingStationOcppConfiguration { - let ocppConfiguration: ChargingStationOcppConfiguration = this.getOcppConfigurationFromFile(); + private getOcppConfiguration(): ChargingStationOcppConfiguration | undefined { + let ocppConfiguration: ChargingStationOcppConfiguration | undefined = + this.getOcppConfigurationFromFile(); if (!ocppConfiguration) { ocppConfiguration = this.getOcppConfigurationFromTemplate(); } return ocppConfiguration; } - private saveOcppConfiguration(): void { - if (this.getOcppPersistentConfiguration()) { - this.saveConfiguration(Section.ocppConfiguration); - } - } - private async onOpen(): Promise { - if (this.isWebSocketConnectionOpened()) { + if (this.isWebSocketConnectionOpened() === true) { logger.info( `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} succeeded` ); - if (!this.isRegistered()) { + if (this.isRegistered() === false) { // Send BootNotification let registrationRetryCount = 0; do { this.bootNotificationResponse = await this.ocppRequestService.requestHandler< BootNotificationRequest, BootNotificationResponse - >( - RequestCommand.BOOT_NOTIFICATION, - { - chargePointModel: this.bootNotificationRequest.chargePointModel, - chargePointVendor: this.bootNotificationRequest.chargePointVendor, - chargeBoxSerialNumber: this.bootNotificationRequest.chargeBoxSerialNumber, - firmwareVersion: this.bootNotificationRequest.firmwareVersion, - chargePointSerialNumber: this.bootNotificationRequest.chargePointSerialNumber, - iccid: this.bootNotificationRequest.iccid, - imsi: this.bootNotificationRequest.imsi, - meterSerialNumber: this.bootNotificationRequest.meterSerialNumber, - meterType: this.bootNotificationRequest.meterType, - }, - { skipBufferingOnError: true } - ); - if (!this.isRegistered()) { + >(this, RequestCommand.BOOT_NOTIFICATION, this.bootNotificationRequest, { + skipBufferingOnError: true, + }); + if (this.isRegistered() === false) { this.getRegistrationMaxRetries() !== -1 && registrationRetryCount++; await Utils.sleep( - this.bootNotificationResponse?.interval + this?.bootNotificationResponse?.interval ? this.bootNotificationResponse.interval * 1000 : Constants.OCPP_DEFAULT_BOOT_NOTIFICATION_INTERVAL ); } } while ( - !this.isRegistered() && + this.isRegistered() === false && (registrationRetryCount <= this.getRegistrationMaxRetries() || this.getRegistrationMaxRetries() === -1) ); } - if (this.isRegistered()) { - if (this.isInAcceptedState()) { + if (this.isRegistered() === true) { + if (this.isInAcceptedState() === true) { await this.startMessageSequence(); - this.wsConnectionRestarted && this.flushMessageBuffer(); } } else { logger.error( `${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})` ); } - this.stopped && (this.stopped = false); - this.autoReconnectRetryCount = 0; this.wsConnectionRestarted = false; + this.autoReconnectRetryCount = 0; + parentPort?.postMessage(MessageChannelUtils.buildUpdatedMessage(this)); } else { logger.warn( `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} failed` @@ -1526,7 +1634,7 @@ export default class ChargingStation { } } - private async onClose(code: number, reason: string): Promise { + private async onClose(code: number, reason: Buffer): Promise { switch (code) { // Normal close case WebSocketCloseEventStatusCode.CLOSE_NORMAL: @@ -1534,7 +1642,7 @@ export default class ChargingStation { logger.info( `${this.logPrefix()} WebSocket normally closed with status '${Utils.getWebSocketCloseEventStatusString( code - )}' and reason '${reason}'` + )}' and reason '${reason.toString()}'` ); this.autoReconnectRetryCount = 0; break; @@ -1543,211 +1651,236 @@ export default class ChargingStation { logger.error( `${this.logPrefix()} WebSocket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString( code - )}' and reason '${reason}'` + )}' and reason '${reason.toString()}'` ); - await this.reconnect(code); + this.started === true && (await this.reconnect()); break; } + parentPort?.postMessage(MessageChannelUtils.buildUpdatedMessage(this)); + } + + private getCachedRequest(messageType: MessageType, messageId: string): CachedRequest | undefined { + const cachedRequest = this.requests.get(messageId); + if (Array.isArray(cachedRequest) === true) { + return cachedRequest; + } + throw new OCPPError( + ErrorType.PROTOCOL_ERROR, + `Cached request for message id ${messageId} ${OCPPServiceUtils.getMessageTypeString( + messageType + )} is not an array`, + undefined, + cachedRequest as JsonType + ); + } + + private async handleIncomingMessage(request: IncomingRequest): Promise { + const [messageType, messageId, commandName, commandPayload] = request; + if (this.getEnableStatistics() === true) { + this.performanceStatistics?.addRequestStatistic(commandName, messageType); + } + logger.debug( + `${this.logPrefix()} << Command '${commandName}' received request payload: ${JSON.stringify( + request + )}` + ); + // Process the message + await this.ocppIncomingRequestService.incomingRequestHandler( + this, + messageId, + commandName, + commandPayload + ); + } + + private handleResponseMessage(response: Response): void { + const [messageType, messageId, commandPayload] = response; + if (this.requests.has(messageId) === false) { + // Error + throw new OCPPError( + ErrorType.INTERNAL_ERROR, + `Response for unknown message id ${messageId}`, + undefined, + commandPayload + ); + } + // Respond + const [responseCallback, , requestCommandName, requestPayload] = this.getCachedRequest( + messageType, + messageId + ); + logger.debug( + `${this.logPrefix()} << Command '${ + requestCommandName ?? Constants.UNKNOWN_COMMAND + }' received response payload: ${JSON.stringify(response)}` + ); + responseCallback(commandPayload, requestPayload); + } + + private handleErrorMessage(errorResponse: ErrorResponse): void { + const [messageType, messageId, errorType, errorMessage, errorDetails] = errorResponse; + if (this.requests.has(messageId) === false) { + // Error + throw new OCPPError( + ErrorType.INTERNAL_ERROR, + `Error response for unknown message id ${messageId}`, + undefined, + { errorType, errorMessage, errorDetails } + ); + } + const [, errorCallback, requestCommandName] = this.getCachedRequest(messageType, messageId); + logger.debug( + `${this.logPrefix()} << Command '${ + requestCommandName ?? Constants.UNKNOWN_COMMAND + }' received error response payload: ${JSON.stringify(errorResponse)}` + ); + errorCallback(new OCPPError(errorType, errorMessage, requestCommandName, errorDetails)); } - private async onMessage(data: Data): Promise { + private async onMessage(data: RawData): Promise { + let request: IncomingRequest | Response | ErrorResponse; let messageType: number; - let messageId: string; - let commandName: IncomingRequestCommand; - let commandPayload: JsonType; - let errorType: ErrorType; - let errorMessage: string; - let errorDetails: JsonType; - let responseCallback: (payload: JsonType, requestPayload: JsonType) => void; - let errorCallback: (error: OCPPError, requestStatistic?: boolean) => void; - let requestCommandName: RequestCommand | IncomingRequestCommand; - let requestPayload: JsonType; - let cachedRequest: CachedRequest; - let errMsg: string; + let errorMsg: string; try { - const request = JSON.parse(data.toString()) as IncomingRequest | Response | ErrorResponse; - if (Utils.isIterable(request)) { - [messageType, messageId] = request; + request = JSON.parse(data.toString()) as IncomingRequest | Response | ErrorResponse; + if (Array.isArray(request) === true) { + [messageType] = request; // Check the type of message switch (messageType) { // Incoming Message case MessageType.CALL_MESSAGE: - [, , commandName, commandPayload] = request as IncomingRequest; - if (this.getEnableStatistics()) { - this.performanceStatistics.addRequestStatistic(commandName, messageType); - } - logger.debug( - `${this.logPrefix()} << Command '${commandName}' received request payload: ${JSON.stringify( - request - )}` - ); - // Process the message - await this.ocppIncomingRequestService.incomingRequestHandler( - messageId, - commandName, - commandPayload - ); + await this.handleIncomingMessage(request as IncomingRequest); break; - // Outcome Message + // Response Message case MessageType.CALL_RESULT_MESSAGE: - [, , commandPayload] = request as Response; - if (!this.requests.has(messageId)) { - // Error - throw new OCPPError( - ErrorType.INTERNAL_ERROR, - `Response for unknown message id ${messageId}`, - null, - commandPayload - ); - } - // Respond - cachedRequest = this.requests.get(messageId); - if (Utils.isIterable(cachedRequest)) { - [responseCallback, , requestCommandName, requestPayload] = cachedRequest; - } else { - throw new OCPPError( - ErrorType.PROTOCOL_ERROR, - `Cached request for message id ${messageId} response is not iterable`, - null, - cachedRequest as unknown as JsonType - ); - } - logger.debug( - `${this.logPrefix()} << Command '${ - requestCommandName ?? '' - }' received response payload: ${JSON.stringify(request)}` - ); - responseCallback(commandPayload, requestPayload); + this.handleResponseMessage(request as Response); break; // Error Message case MessageType.CALL_ERROR_MESSAGE: - [, , errorType, errorMessage, errorDetails] = request as ErrorResponse; - if (!this.requests.has(messageId)) { - // Error - throw new OCPPError( - ErrorType.INTERNAL_ERROR, - `Error response for unknown message id ${messageId}`, - null, - { errorType, errorMessage, errorDetails } - ); - } - cachedRequest = this.requests.get(messageId); - if (Utils.isIterable(cachedRequest)) { - [, errorCallback, requestCommandName] = cachedRequest; - } else { - throw new OCPPError( - ErrorType.PROTOCOL_ERROR, - `Cached request for message id ${messageId} error response is not iterable`, - null, - cachedRequest as unknown as JsonType - ); - } - logger.debug( - `${this.logPrefix()} << Command '${ - requestCommandName ?? '' - }' received error payload: ${JSON.stringify(request)}` - ); - errorCallback(new OCPPError(errorType, errorMessage, requestCommandName, errorDetails)); + this.handleErrorMessage(request as ErrorResponse); break; - // Error + // Unknown Message default: // eslint-disable-next-line @typescript-eslint/restrict-template-expressions - errMsg = `${this.logPrefix()} Wrong message type ${messageType}`; - logger.error(errMsg); - throw new OCPPError(ErrorType.PROTOCOL_ERROR, errMsg); + errorMsg = `Wrong message type ${messageType}`; + logger.error(`${this.logPrefix()} ${errorMsg}`); + throw new OCPPError(ErrorType.PROTOCOL_ERROR, errorMsg); } + parentPort?.postMessage(MessageChannelUtils.buildUpdatedMessage(this)); } else { - throw new OCPPError(ErrorType.PROTOCOL_ERROR, 'Incoming message is not iterable', null, { - payload: request, + throw new OCPPError(ErrorType.PROTOCOL_ERROR, 'Incoming message is not an array', null, { + request, }); } } catch (error) { - // Log + let commandName: IncomingRequestCommand; + let requestCommandName: RequestCommand | IncomingRequestCommand; + let errorCallback: ErrorCallback; + const [, messageId] = request; + switch (messageType) { + case MessageType.CALL_MESSAGE: + [, , commandName] = request as IncomingRequest; + // Send error + await this.ocppRequestService.sendError(this, messageId, error as OCPPError, commandName); + break; + case MessageType.CALL_RESULT_MESSAGE: + case MessageType.CALL_ERROR_MESSAGE: + if (this.requests.has(messageId) === true) { + [, errorCallback, requestCommandName] = this.getCachedRequest(messageType, messageId); + // Reject the deferred promise in case of error at response handling (rejecting an already fulfilled promise is a no-op) + errorCallback(error as OCPPError, false); + } else { + // Remove the request from the cache in case of error at response handling + this.requests.delete(messageId); + } + break; + } + if (error instanceof OCPPError === false) { + logger.warn( + `${this.logPrefix()} Error thrown at incoming OCPP command '${ + commandName ?? requestCommandName ?? Constants.UNKNOWN_COMMAND + }' message '${data.toString()}' handling is not an OCPPError:`, + error + ); + } logger.error( - '%s Incoming OCPP message %j matching cached request %j processing error %j', - this.logPrefix(), - data.toString(), - this.requests.get(messageId), + `${this.logPrefix()} Incoming OCPP command '${ + commandName ?? requestCommandName ?? Constants.UNKNOWN_COMMAND + }' message '${data.toString()}'${ + messageType !== MessageType.CALL_MESSAGE + ? ` matching cached request '${JSON.stringify(this.requests.get(messageId))}'` + : '' + } processing error:`, error ); - // Send error - messageType === MessageType.CALL_MESSAGE && - (await this.ocppRequestService.sendError( - messageId, - error as OCPPError, - commandName ?? requestCommandName ?? null - )); } } private onPing(): void { - logger.debug(this.logPrefix() + ' Received a WS ping (rfc6455) from the server'); + logger.debug(`${this.logPrefix()} Received a WS ping (rfc6455) from the server`); } private onPong(): void { - logger.debug(this.logPrefix() + ' Received a WS pong (rfc6455) from the server'); + logger.debug(`${this.logPrefix()} Received a WS pong (rfc6455) from the server`); } private onError(error: WSError): void { - logger.error(this.logPrefix() + ' WebSocket error: %j', error); - } - - private getAuthorizationFile(): string | undefined { - return ( - this.stationInfo.authorizationFile && - path.join( - path.resolve(__dirname, '../'), - 'assets', - path.basename(this.stationInfo.authorizationFile) - ) - ); + this.closeWSConnection(); + logger.error(`${this.logPrefix()} WebSocket error:`, error); } - private getAuthorizedTags(): string[] { - let authorizedTags: string[] = []; - const authorizationFile = this.getAuthorizationFile(); - if (authorizationFile) { - try { - // Load authorization file - authorizedTags = JSON.parse(fs.readFileSync(authorizationFile, 'utf8')) as string[]; - } catch (error) { - FileUtils.handleFileException( - this.logPrefix(), - FileType.Authorization, - authorizationFile, - error as NodeJS.ErrnoException - ); - } - } else { - logger.info( - this.logPrefix() + ' No authorization file given in template file ' + this.templateFile + private getEnergyActiveImportRegister(connectorStatus: ConnectorStatus, rounded = false): number { + if (this.getMeteringPerTransaction() === true) { + return ( + (rounded === true + ? Math.round(connectorStatus?.transactionEnergyActiveImportRegisterValue) + : connectorStatus?.transactionEnergyActiveImportRegisterValue) ?? 0 ); } - return authorizedTags; + return ( + (rounded === true + ? Math.round(connectorStatus?.energyActiveImportRegisterValue) + : connectorStatus?.energyActiveImportRegisterValue) ?? 0 + ); } - private getUseConnectorId0(): boolean | undefined { - return !Utils.isUndefined(this.stationInfo.useConnectorId0) - ? this.stationInfo.useConnectorId0 - : true; + private getUseConnectorId0(stationTemplate?: ChargingStationTemplate): boolean { + return stationTemplate?.useConnectorId0 ?? true; } - private getNumberOfRunningTransactions(): number { - let trxCount = 0; - for (const connectorId of this.connectors.keys()) { - if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted) { - trxCount++; + private async stopRunningTransactions(reason = StopTransactionReason.NONE): Promise { + if (this.hasEvses) { + for (const evseStatus of this.evses.values()) { + for (const [connectorId, connectorStatus] of evseStatus.connectors) { + if (connectorStatus.transactionStarted === true) { + await this.stopTransactionOnConnector(connectorId, reason); + } + } + } + } else { + for (const connectorId of this.connectors.keys()) { + if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted === true) { + await this.stopTransactionOnConnector(connectorId, reason); + } } } - return trxCount; } // 0 for disabling - private getConnectionTimeout(): number | undefined { - if (this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) { + private getConnectionTimeout(): number { + if ( + ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.ConnectionTimeOut + ) + ) { return ( - parseInt(this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut).value) ?? - Constants.DEFAULT_CONNECTION_TIMEOUT + parseInt( + ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.ConnectionTimeOut + ).value + ) ?? Constants.DEFAULT_CONNECTION_TIMEOUT ); } return Constants.DEFAULT_CONNECTION_TIMEOUT; @@ -1755,198 +1888,115 @@ export default class ChargingStation { // -1 for unlimited, 0 for disabling private getAutoReconnectMaxRetries(): number | undefined { - if (!Utils.isUndefined(this.stationInfo.autoReconnectMaxRetries)) { - return this.stationInfo.autoReconnectMaxRetries; - } - if (!Utils.isUndefined(Configuration.getAutoReconnectMaxRetries())) { - return Configuration.getAutoReconnectMaxRetries(); - } - return -1; + return ( + this.stationInfo.autoReconnectMaxRetries ?? Configuration.getAutoReconnectMaxRetries() ?? -1 + ); } // 0 for disabling private getRegistrationMaxRetries(): number | undefined { - if (!Utils.isUndefined(this.stationInfo.registrationMaxRetries)) { - return this.stationInfo.registrationMaxRetries; - } - return -1; + return this.stationInfo.registrationMaxRetries ?? -1; } private getPowerDivider(): number { - let powerDivider = this.getNumberOfConnectors(); - if (this.stationInfo.powerSharedByConnectors) { + let powerDivider = this.hasEvses ? this.getNumberOfEvses() : this.getNumberOfConnectors(); + if (this.stationInfo?.powerSharedByConnectors) { powerDivider = this.getNumberOfRunningTransactions(); } return powerDivider; } - private getTemplateMaxNumberOfConnectors(): number { - if (!this.stationInfo?.Connectors) { - return -1; - } - return Object.keys(this.stationInfo?.Connectors).length; - } - - private getMaxNumberOfConnectors(): number { - let maxConnectors: number; - if (!Utils.isEmptyArray(this.stationInfo.numberOfConnectors)) { - const numberOfConnectors = this.stationInfo.numberOfConnectors as number[]; - // Distribute evenly the number of connectors - maxConnectors = numberOfConnectors[(this.index - 1) % numberOfConnectors.length]; - } else if (!Utils.isUndefined(this.stationInfo.numberOfConnectors)) { - maxConnectors = this.stationInfo.numberOfConnectors as number; - } else { - maxConnectors = this.stationInfo?.Connectors[0] - ? this.getTemplateMaxNumberOfConnectors() - 1 - : this.getTemplateMaxNumberOfConnectors(); - } - return maxConnectors; - } - - private getMaximumPower(): number { - return (this.stationInfo['maxPower'] as number) ?? this.stationInfo.maximumPower; - } - - private getMaximumAmperage(): number | undefined { - const maximumPower = this.getMaximumPower(); - switch (this.getCurrentOutType()) { + private getMaximumAmperage(stationInfo: ChargingStationInfo): number | undefined { + const maximumPower = this.getMaximumPower(stationInfo); + switch (this.getCurrentOutType(stationInfo)) { case CurrentType.AC: return ACElectricUtils.amperagePerPhaseFromPower( - this.getNumberOfPhases(), - maximumPower / this.getNumberOfConnectors(), - this.getVoltageOut() + this.getNumberOfPhases(stationInfo), + maximumPower / (this.hasEvses ? this.getNumberOfEvses() : this.getNumberOfConnectors()), + this.getVoltageOut(stationInfo) ); case CurrentType.DC: - return DCElectricUtils.amperage(maximumPower, this.getVoltageOut()); + return DCElectricUtils.amperage(maximumPower, this.getVoltageOut(stationInfo)); } } - private getAmperageLimitationUnitDivider(): number { - let unitDivider = 1; - switch (this.stationInfo.amperageLimitationUnit) { - case AmpereUnits.DECI_AMPERE: - unitDivider = 10; - break; - case AmpereUnits.CENTI_AMPERE: - unitDivider = 100; - break; - case AmpereUnits.MILLI_AMPERE: - unitDivider = 1000; - break; - } - return unitDivider; - } - private getAmperageLimitation(): number | undefined { if ( - this.stationInfo.amperageLimitationOcppKey && - this.getConfigurationKey(this.stationInfo.amperageLimitationOcppKey) + Utils.isNotEmptyString(this.stationInfo?.amperageLimitationOcppKey) && + ChargingStationConfigurationUtils.getConfigurationKey( + this, + this.stationInfo.amperageLimitationOcppKey + ) ) { return ( Utils.convertToInt( - this.getConfigurationKey(this.stationInfo.amperageLimitationOcppKey).value - ) / this.getAmperageLimitationUnitDivider() + ChargingStationConfigurationUtils.getConfigurationKey( + this, + this.stationInfo.amperageLimitationOcppKey + )?.value + ) / ChargingStationUtils.getAmperageLimitationUnitDivider(this.stationInfo) ); } } private async startMessageSequence(): Promise { - if (this.stationInfo.autoRegister) { + if (this.stationInfo?.autoRegister === true) { await this.ocppRequestService.requestHandler< BootNotificationRequest, BootNotificationResponse - >( - RequestCommand.BOOT_NOTIFICATION, - { - chargePointModel: this.bootNotificationRequest.chargePointModel, - chargePointVendor: this.bootNotificationRequest.chargePointVendor, - chargeBoxSerialNumber: this.bootNotificationRequest.chargeBoxSerialNumber, - firmwareVersion: this.bootNotificationRequest.firmwareVersion, - chargePointSerialNumber: this.bootNotificationRequest.chargePointSerialNumber, - iccid: this.bootNotificationRequest.iccid, - imsi: this.bootNotificationRequest.imsi, - meterSerialNumber: this.bootNotificationRequest.meterSerialNumber, - meterType: this.bootNotificationRequest.meterType, - }, - { skipBufferingOnError: true } - ); + >(this, RequestCommand.BOOT_NOTIFICATION, this.bootNotificationRequest, { + skipBufferingOnError: true, + }); } // Start WebSocket ping this.startWebSocketPing(); // Start heartbeat this.startHeartbeat(); // Initialize connectors status - for (const connectorId of this.connectors.keys()) { - if (connectorId === 0) { - continue; - } else if ( - !this.stopped && - !this.getConnectorStatus(connectorId)?.status && - this.getConnectorStatus(connectorId)?.bootStatus - ) { - // Send status in template at startup - await this.ocppRequestService.requestHandler< - StatusNotificationRequest, - StatusNotificationResponse - >(RequestCommand.STATUS_NOTIFICATION, { - connectorId, - status: this.getConnectorStatus(connectorId).bootStatus, - errorCode: ChargePointErrorCode.NO_ERROR, - }); - this.getConnectorStatus(connectorId).status = - this.getConnectorStatus(connectorId).bootStatus; - } else if ( - this.stopped && - this.getConnectorStatus(connectorId)?.status && - this.getConnectorStatus(connectorId)?.bootStatus - ) { - // Send status in template after reset - await this.ocppRequestService.requestHandler< - StatusNotificationRequest, - StatusNotificationResponse - >(RequestCommand.STATUS_NOTIFICATION, { - connectorId, - status: this.getConnectorStatus(connectorId).bootStatus, - errorCode: ChargePointErrorCode.NO_ERROR, - }); - this.getConnectorStatus(connectorId).status = - this.getConnectorStatus(connectorId).bootStatus; - } else if (!this.stopped && this.getConnectorStatus(connectorId)?.status) { - // Send previous status at template reload - await this.ocppRequestService.requestHandler< - StatusNotificationRequest, - StatusNotificationResponse - >(RequestCommand.STATUS_NOTIFICATION, { - connectorId, - status: this.getConnectorStatus(connectorId).status, - errorCode: ChargePointErrorCode.NO_ERROR, - }); - } else { - // Send default status - await this.ocppRequestService.requestHandler< - StatusNotificationRequest, - StatusNotificationResponse - >(RequestCommand.STATUS_NOTIFICATION, { - connectorId, - status: ChargePointStatus.AVAILABLE, - errorCode: ChargePointErrorCode.NO_ERROR, - }); - this.getConnectorStatus(connectorId).status = ChargePointStatus.AVAILABLE; + if (this.hasEvses) { + for (const [evseId, evseStatus] of this.evses) { + if (evseId > 0) { + for (const [connectorId, connectorStatus] of evseStatus.connectors) { + const connectorBootStatus = ChargingStationUtils.getBootConnectorStatus( + this, + connectorId, + connectorStatus + ); + await OCPPServiceUtils.sendAndSetConnectorStatus( + this, + connectorId, + connectorBootStatus + ); + } + } + } + } else { + for (const connectorId of this.connectors.keys()) { + if (connectorId > 0) { + const connectorBootStatus = ChargingStationUtils.getBootConnectorStatus( + this, + connectorId, + this.getConnectorStatus(connectorId) + ); + await OCPPServiceUtils.sendAndSetConnectorStatus(this, connectorId, connectorBootStatus); + } } } - // Start the ATG - this.startAutomaticTransactionGenerator(); - } + if (this.stationInfo?.firmwareStatus === FirmwareStatus.Installing) { + await this.ocppRequestService.requestHandler< + FirmwareStatusNotificationRequest, + FirmwareStatusNotificationResponse + >(this, RequestCommand.FIRMWARE_STATUS_NOTIFICATION, { + status: FirmwareStatus.Installed, + }); + this.stationInfo.firmwareStatus = FirmwareStatus.Installed; + } - private startAutomaticTransactionGenerator() { - if (this.stationInfo.AutomaticTransactionGenerator.enable) { - if (!this.automaticTransactionGenerator) { - this.automaticTransactionGenerator = AutomaticTransactionGenerator.getInstance(this); - } - if (!this.automaticTransactionGenerator.started) { - this.automaticTransactionGenerator.start(); - } + // Start the ATG + if (this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable === true) { + this.startAutomaticTransactionGenerator(); } + this.wsConnectionRestarted === true && this.flushMessageBuffer(); } private async stopMessageSequence( @@ -1956,85 +2006,85 @@ export default class ChargingStation { this.stopWebSocketPing(); // Stop heartbeat this.stopHeartbeat(); - // Stop the ATG - if ( - this.stationInfo.AutomaticTransactionGenerator.enable && - this.automaticTransactionGenerator?.started - ) { - this.automaticTransactionGenerator.stop(); + // Stop ongoing transactions + if (this.automaticTransactionGenerator?.started === true) { + this.stopAutomaticTransactionGenerator(); } else { - for (const connectorId of this.connectors.keys()) { - if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted) { - const transactionId = this.getConnectorStatus(connectorId).transactionId; - if ( - this.getBeginEndMeterValues() && - this.getOcppStrictCompliance() && - !this.getOutOfOrderEndMeterValues() - ) { - // FIXME: Implement OCPP version agnostic helpers - const transactionEndMeterValue = OCPP16ServiceUtils.buildTransactionEndMeterValue( + await this.stopRunningTransactions(reason); + } + if (this.hasEvses) { + for (const [evseId, evseStatus] of this.evses) { + if (evseId > 0) { + for (const [connectorId, connectorStatus] of evseStatus.connectors) { + await this.ocppRequestService.requestHandler< + StatusNotificationRequest, + StatusNotificationResponse + >( this, - connectorId, - this.getEnergyActiveImportRegisterByTransactionId(transactionId) - ); - await this.ocppRequestService.requestHandler( - RequestCommand.METER_VALUES, - { + RequestCommand.STATUS_NOTIFICATION, + OCPPServiceUtils.buildStatusNotificationRequest( + this, connectorId, - transactionId, - meterValue: transactionEndMeterValue, - } + ConnectorStatusEnum.Unavailable + ) ); + delete connectorStatus?.status; } + } + } + } else { + for (const connectorId of this.connectors.keys()) { + if (connectorId > 0) { await this.ocppRequestService.requestHandler< - StopTransactionRequest, - StopTransactionResponse - >(RequestCommand.STOP_TRANSACTION, { - transactionId, - meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId), - idTag: this.getTransactionIdTag(transactionId), - reason, - }); + StatusNotificationRequest, + StatusNotificationResponse + >( + this, + RequestCommand.STATUS_NOTIFICATION, + OCPPServiceUtils.buildStatusNotificationRequest( + this, + connectorId, + ConnectorStatusEnum.Unavailable + ) + ); + delete this.getConnectorStatus(connectorId)?.status; } } } } private startWebSocketPing(): void { - const webSocketPingInterval: number = this.getConfigurationKey( + const webSocketPingInterval: number = ChargingStationConfigurationUtils.getConfigurationKey( + this, StandardParametersKey.WebSocketPingInterval ) ? Utils.convertToInt( - this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval).value + ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.WebSocketPingInterval + )?.value ) : 0; if (webSocketPingInterval > 0 && !this.webSocketPingSetInterval) { this.webSocketPingSetInterval = setInterval(() => { - if (this.isWebSocketConnectionOpened()) { - this.wsConnection.ping((): void => { - /* This is intentional */ - }); + if (this.isWebSocketConnectionOpened() === true) { + this.wsConnection?.ping(); } }, webSocketPingInterval * 1000); logger.info( - this.logPrefix() + - ' WebSocket ping started every ' + - Utils.formatDurationSeconds(webSocketPingInterval) + `${this.logPrefix()} WebSocket ping started every ${Utils.formatDurationSeconds( + webSocketPingInterval + )}` ); } else if (this.webSocketPingSetInterval) { logger.info( - this.logPrefix() + - ' WebSocket ping every ' + - Utils.formatDurationSeconds(webSocketPingInterval) + - ' already started' + `${this.logPrefix()} WebSocket ping already started every ${Utils.formatDurationSeconds( + webSocketPingInterval + )}` ); } else { logger.error( - `${this.logPrefix()} WebSocket ping interval set to ${ - webSocketPingInterval - ? Utils.formatDurationSeconds(webSocketPingInterval) - : webSocketPingInterval - }, not starting the WebSocket ping` + `${this.logPrefix()} WebSocket ping interval set to ${webSocketPingInterval}, not starting the WebSocket ping` ); } } @@ -2042,150 +2092,63 @@ export default class ChargingStation { private stopWebSocketPing(): void { if (this.webSocketPingSetInterval) { clearInterval(this.webSocketPingSetInterval); - } - } - - private warnDeprecatedTemplateKey( - template: ChargingStationTemplate, - key: string, - chargingStationId: string, - logMsgToAppend = '' - ): void { - if (!Utils.isUndefined(template[key])) { - const logPrefixStr = ` ${chargingStationId} |`; - logger.warn( - `${Utils.logPrefix(logPrefixStr)} Deprecated template key '${key}' usage in file '${ - this.templateFile - }'${logMsgToAppend && '. ' + logMsgToAppend}` - ); - } - } - - private convertDeprecatedTemplateKey( - template: ChargingStationTemplate, - deprecatedKey: string, - key: string - ): void { - if (!Utils.isUndefined(template[deprecatedKey])) { - template[key] = template[deprecatedKey] as unknown; - delete template[deprecatedKey]; + delete this.webSocketPingSetInterval; } } private getConfiguredSupervisionUrl(): URL { - const supervisionUrls = Utils.cloneObject( - this.stationInfo.supervisionUrls ?? Configuration.getSupervisionUrls() - ); - if (!Utils.isEmptyArray(supervisionUrls)) { - let urlIndex = 0; + const supervisionUrls = this.stationInfo?.supervisionUrls ?? Configuration.getSupervisionUrls(); + if (Utils.isNotEmptyArray(supervisionUrls)) { + let configuredSupervisionUrlIndex: number; 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` - ); - } + configuredSupervisionUrlIndex = Math.floor(Utils.secureRandom() * supervisionUrls.length); break; + case SupervisionUrlDistribution.ROUND_ROBIN: + case SupervisionUrlDistribution.CHARGING_STATION_AFFINITY: 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; + Object.values(SupervisionUrlDistribution).includes( + Configuration.getSupervisionUrlDistribution() + ) === false && + logger.error( + `${this.logPrefix()} Unknown supervision url distribution '${Configuration.getSupervisionUrlDistribution()}' from values '${SupervisionUrlDistribution.toString()}', defaulting to ${ + SupervisionUrlDistribution.CHARGING_STATION_AFFINITY + }` + ); + configuredSupervisionUrlIndex = (this.index - 1) % supervisionUrls.length; break; } - return new URL(supervisionUrls[urlIndex]); + return new URL(supervisionUrls[configuredSupervisionUrlIndex]); } return new URL(supervisionUrls as string); } - private getHeartbeatInterval(): number | undefined { - const HeartbeatInterval = this.getConfigurationKey(StandardParametersKey.HeartbeatInterval); - if (HeartbeatInterval) { - return Utils.convertToInt(HeartbeatInterval.value) * 1000; - } - const HeartBeatInterval = this.getConfigurationKey(StandardParametersKey.HeartBeatInterval); - if (HeartBeatInterval) { - return Utils.convertToInt(HeartBeatInterval.value) * 1000; - } - !this.stationInfo.autoRegister && - logger.warn( - `${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${ - Constants.DEFAULT_HEARTBEAT_INTERVAL - }` - ); - return Constants.DEFAULT_HEARTBEAT_INTERVAL; - } - private stopHeartbeat(): void { if (this.heartbeatSetInterval) { clearInterval(this.heartbeatSetInterval); + delete this.heartbeatSetInterval; } } - private openWSConnection( - options: WsOptions = this.stationInfo.wsOptions, - forceCloseOpened = false - ): void { - options.handshakeTimeout = options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000; - if ( - !Utils.isNullOrUndefined(this.stationInfo.supervisionUser) && - !Utils.isNullOrUndefined(this.stationInfo.supervisionPassword) - ) { - options.auth = `${this.stationInfo.supervisionUser}:${this.stationInfo.supervisionPassword}`; - } - if (this.isWebSocketConnectionOpened() && forceCloseOpened) { - this.wsConnection.close(); - } - let protocol: string; - switch (this.getOcppVersion()) { - case OCPPVersion.VERSION_16: - protocol = 'ocpp' + OCPPVersion.VERSION_16; - break; - default: - this.handleUnsupportedVersion(this.getOcppVersion()); - break; - } - this.wsConnection = new WebSocket(this.wsConnectionUrl, protocol, options); - logger.info( - this.logPrefix() + ' Open OCPP connection to URL ' + this.wsConnectionUrl.toString() - ); - } - - private stopMeterValues(connectorId: number) { - if (this.getConnectorStatus(connectorId)?.transactionSetInterval) { - clearInterval(this.getConnectorStatus(connectorId).transactionSetInterval); + private terminateWSConnection(): void { + if (this.isWebSocketConnectionOpened() === true) { + this.wsConnection?.terminate(); + this.wsConnection = null; } } - private getReconnectExponentialDelay(): boolean | undefined { - return !Utils.isUndefined(this.stationInfo.reconnectExponentialDelay) - ? this.stationInfo.reconnectExponentialDelay - : false; + private getReconnectExponentialDelay(): boolean { + return this.stationInfo?.reconnectExponentialDelay ?? false; } - private async reconnect(code: number): Promise { + private async reconnect(): Promise { // Stop WebSocket ping this.stopWebSocketPing(); // Stop heartbeat this.stopHeartbeat(); // Stop the ATG if needed - if ( - this.stationInfo.AutomaticTransactionGenerator.enable && - this.stationInfo.AutomaticTransactionGenerator.stopOnConnectionFailure && - this.automaticTransactionGenerator?.started - ) { - this.automaticTransactionGenerator.stop(); + if (this.automaticTransactionGenerator?.configuration?.stopOnConnectionFailure === true) { + this.stopAutomaticTransactionGenerator(); } if ( this.autoReconnectRetryCount < this.getAutoReconnectMaxRetries() || @@ -2195,105 +2158,41 @@ export default class ChargingStation { const reconnectDelay = this.getReconnectExponentialDelay() ? Utils.exponentialDelay(this.autoReconnectRetryCount) : this.getConnectionTimeout() * 1000; - const reconnectTimeout = reconnectDelay - 100 > 0 && reconnectDelay; + const reconnectDelayWithdraw = 1000; + const reconnectTimeout = + reconnectDelay && reconnectDelay - reconnectDelayWithdraw > 0 + ? reconnectDelay - reconnectDelayWithdraw + : 0; logger.error( - `${this.logPrefix()} WebSocket: connection retry in ${Utils.roundTo( + `${this.logPrefix()} WebSocket connection retry in ${Utils.roundTo( reconnectDelay, 2 )}ms, timeout ${reconnectTimeout}ms` ); await Utils.sleep(reconnectDelay); logger.error( - this.logPrefix() + - ' WebSocket: reconnecting try #' + - this.autoReconnectRetryCount.toString() + `${this.logPrefix()} WebSocket connection retry #${this.autoReconnectRetryCount.toString()}` ); this.openWSConnection( - { ...this.stationInfo.wsOptions, handshakeTimeout: reconnectTimeout }, - true + { + ...(this.stationInfo?.wsOptions ?? {}), + handshakeTimeout: reconnectTimeout, + }, + { closeOpened: true } ); this.wsConnectionRestarted = true; } else if (this.getAutoReconnectMaxRetries() !== -1) { logger.error( - `${this.logPrefix()} WebSocket reconnect failure: maximum retries reached (${ + `${this.logPrefix()} WebSocket connection retries failure: maximum retries reached (${ this.autoReconnectRetryCount - }) or retry disabled (${this.getAutoReconnectMaxRetries()})` + }) or retries disabled (${this.getAutoReconnectMaxRetries()})` ); } } - 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; - } - - private getCurrentLimitFromOCPPProfiles(chargingProfiles: ChargingProfile[]): { - limit: number; - matchingChargingProfile: ChargingProfile; - } { - for (const chargingProfile of chargingProfiles) { - // Profiles should already be sorted by connectorID and Stack Level (highest stack level has prio) - // Set helpers - const now = moment(); - const chargingSchedule = chargingProfile.chargingSchedule; - // Check type (Recurring) and if it is already active - // Adjust the Daily Recurring Schedule to today - if ( - chargingProfile.chargingProfileKind === ChargingProfileKindType.RECURRING && - chargingProfile.recurrencyKind === RecurrencyKindType.DAILY && - now.isAfter(chargingSchedule.startSchedule) - ) { - const currentDate = new Date(); - chargingSchedule.startSchedule = new Date(chargingSchedule.startSchedule); - chargingSchedule.startSchedule.setFullYear( - currentDate.getFullYear(), - currentDate.getMonth(), - currentDate.getDate() - ); - // Check if the start of the schedule is yesterday - if (moment(chargingSchedule.startSchedule).isAfter(now)) { - chargingSchedule.startSchedule.setDate(currentDate.getDate() - 1); - } - } else if (moment(chargingSchedule.startSchedule).isAfter(now)) { - return null; - } - // Check if the Charging Profile is active - if (moment(chargingSchedule.startSchedule).add(chargingSchedule.duration, 's').isAfter(now)) { - let lastButOneSchedule: ChargingSchedulePeriod; - // Search the right Schedule Period - for (const schedulePeriod of chargingSchedule.chargingSchedulePeriod) { - // Handling of only one period - if ( - chargingSchedule.chargingSchedulePeriod.length === 1 && - schedulePeriod.startPeriod === 0 - ) { - return { limit: schedulePeriod.limit, matchingChargingProfile: chargingProfile }; - } - // Find the right Schedule Periods - if ( - moment(chargingSchedule.startSchedule).add(schedulePeriod.startPeriod, 's').isAfter(now) - ) { - // Found the schedule: Last but one is the correct one - return { limit: lastButOneSchedule.limit, matchingChargingProfile: chargingProfile }; - } - // Keep it - lastButOneSchedule = schedulePeriod; - // Handle the last schedule period - if ( - schedulePeriod.startPeriod === - chargingSchedule.chargingSchedulePeriod[ - chargingSchedule.chargingSchedulePeriod.length - 1 - ].startPeriod - ) { - return { limit: lastButOneSchedule.limit, matchingChargingProfile: chargingProfile }; - } - } - } - } - return null; + private getAutomaticTransactionGeneratorConfigurationFromTemplate(): + | AutomaticTransactionGeneratorConfiguration + | undefined { + return this.getTemplateFromFile()?.AutomaticTransactionGenerator; } }