X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FChargingStation.ts;h=5bc0ec9ad24d8ae76f486f388eb86d03a2cad0b8;hb=6a4032b5d8f3cbaa18d3beddcdfe9d335c1cba90;hp=a966037dc2adaac169e025f9adc3d3511356c576;hpb=5edd8ba0f8978cfb3ca9d80f299d9748c6c5970e;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ChargingStation.ts b/src/charging-station/ChargingStation.ts index a966037d..5bc0ec9a 100644 --- a/src/charging-station/ChargingStation.ts +++ b/src/charging-station/ChargingStation.ts @@ -1,31 +1,31 @@ // Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved. import { createHash } from 'node:crypto'; -import { - type FSWatcher, - closeSync, - existsSync, - mkdirSync, - openSync, - readFileSync, - writeFileSync, -} from 'node:fs'; +import { EventEmitter } from 'node:events'; +import { type FSWatcher, existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs'; import { dirname, join } from 'node:path'; import { URL } from 'node:url'; import { parentPort } from 'node:worker_threads'; +import { millisecondsToSeconds, secondsToMilliseconds } from 'date-fns'; import merge from 'just-merge'; import { type RawData, WebSocket } from 'ws'; import { AutomaticTransactionGenerator } from './AutomaticTransactionGenerator'; import { ChargingStationWorkerBroadcastChannel } from './broadcast-channel/ChargingStationWorkerBroadcastChannel'; -import { ChargingStationConfigurationUtils } from './ChargingStationConfigurationUtils'; +import { + addConfigurationKey, + deleteConfigurationKey, + getConfigurationKey, + setConfigurationKeyValue, +} from './ConfigurationKeyUtils'; import { buildConnectorsMap, + checkChargingStation, + checkConfiguration, checkConnectorsConfiguration, checkStationInfoConnectorStatus, checkTemplate, - countReservableConnectors, createBootNotificationRequest, createSerialNumber, getAmperageLimitationUnitDivider, @@ -36,24 +36,29 @@ import { getHashId, getIdTagsFile, getMaxNumberOfEvses, + getNumberOfReservableConnectors, getPhaseRotationValue, + hasReservationExpired, initializeConnectorsMapStatus, propagateSerialNumber, stationTemplateToStationInfo, warnTemplateKeysDeprecation, -} from './ChargingStationUtils'; +} from './Helpers'; import { IdTagsCache } from './IdTagsCache'; import { OCPP16IncomingRequestService, OCPP16RequestService, OCPP16ResponseService, - OCPP16ServiceUtils, OCPP20IncomingRequestService, OCPP20RequestService, OCPP20ResponseService, type OCPPIncomingRequestService, type OCPPRequestService, - OCPPServiceUtils, + buildMeterValue, + buildStatusNotificationRequest, + buildTransactionEndMeterValue, + getMessageTypeString, + sendAndSetConnectorStatus, } from './ocpp'; import { SharedLRUCache } from './SharedLRUCache'; import { BaseError, OCPPError } from '../exception'; @@ -65,6 +70,7 @@ import { type BootNotificationResponse, type CachedRequest, type ChargingStationConfiguration, + ChargingStationEvents, type ChargingStationInfo, type ChargingStationOcppConfiguration, type ChargingStationTemplate, @@ -85,9 +91,7 @@ import { type HeartbeatResponse, type IncomingRequest, type IncomingRequestCommand, - type JsonType, MessageType, - type MeterValue, MeterValueMeasurand, type MeterValuesRequest, type MeterValuesResponse, @@ -97,7 +101,7 @@ import { RegistrationStatusEnumType, RequestCommand, type Reservation, - ReservationFilterKey, + type ReservationKey, ReservationTerminationReason, type Response, StandardParametersKey, @@ -109,7 +113,7 @@ import { type StopTransactionResponse, SupervisionUrlDistribution, SupportedFeatureProfiles, - VendorParametersKey, + Voltage, type WSError, WebSocketCloseEventStatusCode, type WsOptions, @@ -142,13 +146,15 @@ import { isUndefined, logPrefix, logger, + min, + once, roundTo, secureRandom, sleep, watchJsonFile, } from '../utils'; -export class ChargingStation { +export class ChargingStation extends EventEmitter { public readonly index: number; public readonly templateFile: string; public stationInfo!: ChargingStationInfo; @@ -157,12 +163,12 @@ export class ChargingStation { public idTagsCache: IdTagsCache; public automaticTransactionGenerator!: AutomaticTransactionGenerator | undefined; public ocppConfiguration!: ChargingStationOcppConfiguration | undefined; - public wsConnection!: WebSocket | null; + public wsConnection: WebSocket | null; public readonly connectors: Map; public readonly evses: Map; public readonly requests: Map; public performanceStatistics!: PerformanceStatistics | undefined; - public heartbeatSetInterval!: NodeJS.Timeout; + public heartbeatSetInterval?: NodeJS.Timeout; public ocppRequestService!: OCPPRequestService; public bootNotificationRequest!: BootNotificationRequest; public bootNotificationResponse!: BootNotificationResponse | undefined; @@ -172,23 +178,24 @@ export class ChargingStation { private configurationFileHash!: string; private connectorsConfigurationHash!: string; private evsesConfigurationHash!: string; + private automaticTransactionGeneratorConfiguration?: AutomaticTransactionGeneratorConfiguration; private ocppIncomingRequestService!: OCPPIncomingRequestService; private readonly messageBuffer: Set; private configuredSupervisionUrl!: URL; - private wsConnectionRestarted: boolean; private autoReconnectRetryCount: number; private templateFileWatcher!: FSWatcher | undefined; private templateFileHash!: string; private readonly sharedLRUCache: SharedLRUCache; - private webSocketPingSetInterval!: NodeJS.Timeout; + private webSocketPingSetInterval?: NodeJS.Timeout; private readonly chargingStationWorkerBroadcastChannel: ChargingStationWorkerBroadcastChannel; - private reservationExpirationSetInterval?: NodeJS.Timeout; + private flushMessageBufferSetInterval?: NodeJS.Timeout; constructor(index: number, templateFile: string) { + super(); this.started = false; this.starting = false; this.stopping = false; - this.wsConnectionRestarted = false; + this.wsConnection = null; this.autoReconnectRetryCount = 0; this.index = index; this.templateFile = templateFile; @@ -200,6 +207,16 @@ export class ChargingStation { this.idTagsCache = IdTagsCache.getInstance(); this.chargingStationWorkerBroadcastChannel = new ChargingStationWorkerBroadcastChannel(this); + this.on(ChargingStationEvents.started, () => { + parentPort?.postMessage(buildStartedMessage(this)); + }); + this.on(ChargingStationEvents.stopped, () => { + parentPort?.postMessage(buildStoppedMessage(this)); + }); + this.on(ChargingStationEvents.updated, () => { + parentPort?.postMessage(buildUpdatedMessage(this)); + }); + this.initialize(); } @@ -210,51 +227,39 @@ export class ChargingStation { private get wsConnectionUrl(): URL { return new URL( `${ - this.getSupervisionUrlOcppConfiguration() && - isNotEmptyString(this.getSupervisionUrlOcppKey()) && - isNotEmptyString( - ChargingStationConfigurationUtils.getConfigurationKey( - this, - this.getSupervisionUrlOcppKey(), - )?.value, - ) - ? ChargingStationConfigurationUtils.getConfigurationKey( - this, - this.getSupervisionUrlOcppKey(), - ).value + this.stationInfo?.supervisionUrlOcppConfiguration === true && + isNotEmptyString(this.stationInfo?.supervisionUrlOcppKey) && + isNotEmptyString(getConfigurationKey(this, this.stationInfo.supervisionUrlOcppKey!)?.value) + ? getConfigurationKey(this, this.stationInfo.supervisionUrlOcppKey!)!.value : this.configuredSupervisionUrl.href }/${this.stationInfo.chargingStationId}`, ); } public logPrefix = (): string => { - return logPrefix( - ` ${ - (isNotEmptyString(this?.stationInfo?.chargingStationId) - ? this?.stationInfo?.chargingStationId - : getChargingStationId(this.index, this.getTemplateFromFile())) ?? - 'Error at building log prefix' - } |`, - ); + if (isNotEmptyString(this?.stationInfo?.chargingStationId)) { + return logPrefix(` ${this?.stationInfo?.chargingStationId} |`); + } + let stationTemplate: ChargingStationTemplate | undefined; + try { + stationTemplate = JSON.parse( + readFileSync(this.templateFile, 'utf8'), + ) as ChargingStationTemplate; + } catch { + stationTemplate = undefined; + } + return logPrefix(` ${getChargingStationId(this.index, stationTemplate)} |`); }; public hasIdTags(): boolean { - return isNotEmptyArray(this.idTagsCache.getIdTags(getIdTagsFile(this.stationInfo))); - } - - public getEnableStatistics(): boolean { - return this.stationInfo.enableStatistics ?? false; - } - - public getMustAuthorizeAtRemoteStart(): boolean { - return this.stationInfo.mustAuthorizeAtRemoteStart ?? true; + return isNotEmptyArray(this.idTagsCache.getIdTags(getIdTagsFile(this.stationInfo)!)); } - public getNumberOfPhases(stationInfo?: ChargingStationInfo): number | undefined { + public getNumberOfPhases(stationInfo?: ChargingStationInfo): number { const localStationInfo: ChargingStationInfo = stationInfo ?? this.stationInfo; switch (this.getCurrentOutType(stationInfo)) { case CurrentType.AC: - return !isUndefined(localStationInfo.numberOfPhases) ? localStationInfo.numberOfPhases : 3; + return localStationInfo.numberOfPhases ?? 3; case CurrentType.DC: return 0; } @@ -264,10 +269,6 @@ export class ChargingStation { return this?.wsConnection?.readyState === WebSocket.OPEN; } - public getRegistrationStatus(): RegistrationStatusEnumType | undefined { - return this?.bootNotificationResponse?.status; - } - public inUnknownState(): boolean { return isNullOrUndefined(this?.bootNotificationResponse?.status); } @@ -343,54 +344,32 @@ export class ChargingStation { return this.connectors.get(connectorId); } - public getCurrentOutType(stationInfo?: ChargingStationInfo): CurrentType { - return (stationInfo ?? this.stationInfo)?.currentOutType ?? CurrentType.AC; - } - - public getOcppStrictCompliance(): boolean { - return this.stationInfo?.ocppStrictCompliance ?? true; - } - - public getVoltageOut(stationInfo?: ChargingStationInfo): number | undefined { - const defaultVoltageOut = getDefaultVoltageOut( - this.getCurrentOutType(stationInfo), - this.logPrefix(), - this.templateFile, - ); - return (stationInfo ?? this.stationInfo).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; + let connectorAmperageLimitationPowerLimit: number | undefined; if ( !isNullOrUndefined(this.getAmperageLimitation()) && - this.getAmperageLimitation() < this.stationInfo?.maximumAmperage + this.getAmperageLimitation()! < this.stationInfo.maximumAmperage! ) { connectorAmperageLimitationPowerLimit = - (this.getCurrentOutType() === CurrentType.AC + (this.stationInfo?.currentOutType === CurrentType.AC ? ACElectricUtils.powerTotal( this.getNumberOfPhases(), - this.getVoltageOut(), - this.getAmperageLimitation() * + this.stationInfo.voltageOut!, + this.getAmperageLimitation()! * (this.hasEvses ? this.getNumberOfEvses() : this.getNumberOfConnectors()), ) - : DCElectricUtils.power(this.getVoltageOut(), this.getAmperageLimitation())) / + : DCElectricUtils.power(this.stationInfo.voltageOut!, this.getAmperageLimitation()!)) / this.powerDivider; } - const connectorMaximumPower = this.getMaximumPower() / this.powerDivider; + const connectorMaximumPower = this.stationInfo.maximumPower! / this.powerDivider; const connectorChargingProfilesPowerLimit = getChargingStationConnectorChargingProfilesPowerLimit(this, connectorId); - return Math.min( + return min( isNaN(connectorMaximumPower) ? Infinity : connectorMaximumPower, - isNaN(connectorAmperageLimitationPowerLimit) + isNaN(connectorAmperageLimitationPowerLimit!) ? Infinity - : connectorAmperageLimitationPowerLimit, - isNaN(connectorChargingProfilesPowerLimit) ? Infinity : connectorChargingProfilesPowerLimit, + : connectorAmperageLimitationPowerLimit!, + isNaN(connectorChargingProfilesPowerLimit!) ? Infinity : connectorChargingProfilesPowerLimit!, ); } @@ -413,7 +392,7 @@ export class ChargingStation { } public getNumberOfRunningTransactions(): number { - let trxCount = 0; + let numberOfRunningTransactions = 0; if (this.hasEvses) { for (const [evseId, evseStatus] of this.evses) { if (evseId === 0) { @@ -421,46 +400,18 @@ export class ChargingStation { } for (const connectorStatus of evseStatus.connectors.values()) { if (connectorStatus.transactionStarted === true) { - ++trxCount; + ++numberOfRunningTransactions; } } } } else { for (const connectorId of this.connectors.keys()) { if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted === true) { - ++trxCount; + ++numberOfRunningTransactions; } } } - return trxCount; - } - - public getOutOfOrderEndMeterValues(): boolean { - return this.stationInfo?.outOfOrderEndMeterValues ?? false; - } - - public getBeginEndMeterValues(): boolean { - return this.stationInfo?.beginEndMeterValues ?? false; - } - - public getMeteringPerTransaction(): boolean { - return this.stationInfo?.meteringPerTransaction ?? true; - } - - public getTransactionDataMeterValues(): boolean { - return this.stationInfo?.transactionDataMeterValues ?? false; - } - - public getMainVoltageMeterValues(): boolean { - return this.stationInfo?.mainVoltageMeterValues ?? true; - } - - public getPhaseLineToLineVoltageMeterValues(): boolean { - return this.stationInfo?.phaseLineToLineVoltageMeterValues ?? false; - } - - public getCustomValueLimitationMeterValues(): boolean { - return this.stationInfo?.customValueLimitationMeterValues ?? true; + return numberOfRunningTransactions; } public getConnectorIdByTransactionId(transactionId: number): number | undefined { @@ -486,45 +437,43 @@ export class ChargingStation { rounded = false, ): number { return this.getEnergyActiveImportRegister( - this.getConnectorStatus(this.getConnectorIdByTransactionId(transactionId)), + this.getConnectorStatus(this.getConnectorIdByTransactionId(transactionId)!)!, rounded, ); } public getEnergyActiveImportRegisterByConnectorId(connectorId: number, rounded = false): number { - return this.getEnergyActiveImportRegister(this.getConnectorStatus(connectorId), rounded); + return this.getEnergyActiveImportRegister(this.getConnectorStatus(connectorId)!, rounded); } public getAuthorizeRemoteTxRequests(): boolean { - const authorizeRemoteTxRequests = ChargingStationConfigurationUtils.getConfigurationKey( + const authorizeRemoteTxRequests = getConfigurationKey( this, StandardParametersKey.AuthorizeRemoteTxRequests, ); - return authorizeRemoteTxRequests ? convertToBoolean(authorizeRemoteTxRequests.value) : false; + return authorizeRemoteTxRequests !== undefined + ? convertToBoolean(authorizeRemoteTxRequests.value) + : false; } public getLocalAuthListEnabled(): boolean { - const localAuthListEnabled = ChargingStationConfigurationUtils.getConfigurationKey( + const localAuthListEnabled = getConfigurationKey( this, StandardParametersKey.LocalAuthListEnabled, ); - return localAuthListEnabled ? convertToBoolean(localAuthListEnabled.value) : false; + return localAuthListEnabled !== undefined + ? convertToBoolean(localAuthListEnabled.value) + : false; } public getHeartbeatInterval(): number { - const HeartbeatInterval = ChargingStationConfigurationUtils.getConfigurationKey( - this, - StandardParametersKey.HeartbeatInterval, - ); - if (HeartbeatInterval) { - return convertToInt(HeartbeatInterval.value) * 1000; + const HeartbeatInterval = getConfigurationKey(this, StandardParametersKey.HeartbeatInterval); + if (HeartbeatInterval !== undefined) { + return secondsToMilliseconds(convertToInt(HeartbeatInterval.value)); } - const HeartBeatInterval = ChargingStationConfigurationUtils.getConfigurationKey( - this, - StandardParametersKey.HeartBeatInterval, - ); - if (HeartBeatInterval) { - return convertToInt(HeartBeatInterval.value) * 1000; + const HeartBeatInterval = getConfigurationKey(this, StandardParametersKey.HeartBeatInterval); + if (HeartBeatInterval !== undefined) { + return secondsToMilliseconds(convertToInt(HeartBeatInterval.value)); } this.stationInfo?.autoRegister === false && logger.warn( @@ -537,14 +486,10 @@ export class ChargingStation { public setSupervisionUrl(url: string): void { if ( - this.getSupervisionUrlOcppConfiguration() && - isNotEmptyString(this.getSupervisionUrlOcppKey()) + this.stationInfo?.supervisionUrlOcppConfiguration === true && + isNotEmptyString(this.stationInfo?.supervisionUrlOcppKey) ) { - ChargingStationConfigurationUtils.setConfigurationKeyValue( - this, - this.getSupervisionUrlOcppKey(), - url, - ); + setConfigurationKeyValue(this, this.stationInfo.supervisionUrlOcppKey!, url); } else { this.stationInfo.supervisionUrls = url; this.saveStationInfo(); @@ -553,7 +498,7 @@ export class ChargingStation { } public startHeartbeat(): void { - if (this.getHeartbeatInterval() > 0 && !this.heartbeatSetInterval) { + if (this.getHeartbeatInterval() > 0 && this.heartbeatSetInterval === undefined) { this.heartbeatSetInterval = setInterval(() => { this.ocppRequestService .requestHandler(this, RequestCommand.HEARTBEAT) @@ -569,7 +514,7 @@ export class ChargingStation { this.getHeartbeatInterval(), )}`, ); - } else if (this.heartbeatSetInterval) { + } else if (this.heartbeatSetInterval !== undefined) { logger.info( `${this.logPrefix()} Heartbeat already started every ${formatDurationMilliSeconds( this.getHeartbeatInterval(), @@ -577,8 +522,7 @@ export class ChargingStation { ); } else { logger.error( - `${this.logPrefix()} Heartbeat interval set to ${this.getHeartbeatInterval()}, - not starting the heartbeat`, + `${this.logPrefix()} Heartbeat interval set to ${this.getHeartbeatInterval()}, not starting the heartbeat`, ); } } @@ -600,21 +544,20 @@ export class ChargingStation { 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}`, ); return; } if (!this.getConnectorStatus(connectorId)) { logger.error( `${this.logPrefix()} Trying to start MeterValues on non existing connector id - ${connectorId.toString()}`, + ${connectorId}`, ); return; } 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 ( @@ -622,18 +565,16 @@ export class ChargingStation { 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) { - this.getConnectorStatus(connectorId).transactionSetInterval = setInterval(() => { - // FIXME: Implement OCPP version agnostic helpers - const meterValue: MeterValue = OCPP16ServiceUtils.buildMeterValue( + this.getConnectorStatus(connectorId)!.transactionSetInterval = setInterval(() => { + const meterValue = buildMeterValue( this, connectorId, - this.getConnectorStatus(connectorId).transactionId, + this.getConnectorStatus(connectorId)!.transactionId!, interval, ); this.ocppRequestService @@ -663,7 +604,7 @@ export class ChargingStation { } public stopMeterValues(connectorId: number) { - if (this.getConnectorStatus(connectorId)?.transactionSetInterval) { + if (this.getConnectorStatus(connectorId)?.transactionSetInterval !== undefined) { clearInterval(this.getConnectorStatus(connectorId)?.transactionSetInterval); } } @@ -672,12 +613,9 @@ export class ChargingStation { if (this.started === false) { if (this.starting === false) { this.starting = true; - if (this.getEnableStatistics() === true) { + if (this.stationInfo?.enableStatistics === true) { this.performanceStatistics?.start(); } - if (this.hasFeatureProfile(SupportedFeatureProfiles.Reservation)) { - this.startReservationExpirationSetInterval(); - } this.openWSConnection(); // Monitor charging station template file this.templateFileWatcher = watchJsonFile( @@ -696,13 +634,14 @@ export class ChargingStation { this.sharedLRUCache.deleteChargingStationTemplate(this.templateFileHash); // Initialize this.initialize(); - this.idTagsCache.deleteIdTags(getIdTagsFile(this.stationInfo)); + this.idTagsCache.deleteIdTags(getIdTagsFile(this.stationInfo)!); // Restart the ATG this.stopAutomaticTransactionGenerator(); - if (this.getAutomaticTransactionGeneratorConfiguration()?.enable === true) { + delete this.automaticTransactionGeneratorConfiguration; + if (this.getAutomaticTransactionGeneratorConfiguration().enable === true) { this.startAutomaticTransactionGenerator(); } - if (this.getEnableStatistics() === true) { + if (this.stationInfo?.enableStatistics === true) { this.performanceStatistics?.restart(); } else { this.performanceStatistics?.stop(); @@ -718,7 +657,7 @@ export class ChargingStation { }, ); this.started = true; - parentPort?.postMessage(buildStartedMessage(this)); + this.emit(ChargingStationEvents.started); this.starting = false; } else { logger.warn(`${this.logPrefix()} Charging station is already starting...`); @@ -728,13 +667,13 @@ export class ChargingStation { } } - public async stop(reason?: StopTransactionReason): Promise { + public async stop(reason?: StopTransactionReason, stopTransactions?: boolean): Promise { if (this.started === true) { if (this.stopping === false) { this.stopping = true; - await this.stopMessageSequence(reason); + await this.stopMessageSequence(reason, stopTransactions); this.closeWSConnection(); - if (this.getEnableStatistics() === true) { + if (this.stationInfo?.enableStatistics === true) { this.performanceStatistics?.stop(); } this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash); @@ -743,7 +682,7 @@ export class ChargingStation { delete this.bootNotificationResponse; this.started = false; this.saveConfiguration(); - parentPort?.postMessage(buildStoppedMessage(this)); + this.emit(ChargingStationEvents.stopped); this.stopping = false; } else { logger.warn(`${this.logPrefix()} Charging station is already stopping...`); @@ -755,42 +694,33 @@ export class ChargingStation { public async reset(reason?: StopTransactionReason): Promise { await this.stop(reason); - await sleep(this.stationInfo.resetTime); + await sleep(this.stationInfo.resetTime!); this.initialize(); this.start(); } public saveOcppConfiguration(): void { - if (this.getOcppPersistentConfiguration()) { + if (this.stationInfo?.ocppPersistentConfiguration === true) { 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); + this.setIntervalFlushMessageBuffer(); } public openWSConnection( - options: WsOptions = this.stationInfo?.wsOptions ?? {}, - params: { closeOpened?: boolean; terminateOpened?: boolean } = { - closeOpened: false, - terminateOpened: false, - }, + options?: WsOptions, + params?: { closeOpened?: boolean; terminateOpened?: boolean }, ): void { - options = { handshakeTimeout: this.getConnectionTimeout() * 1000, ...options }; + options = { + handshakeTimeout: secondsToMilliseconds(this.getConnectionTimeout()), + ...this.stationInfo?.wsOptions, + ...options, + }; 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`, - ); + if (!checkChargingStation(this, this.logPrefix())) { return; } if ( @@ -808,8 +738,7 @@ export class ChargingStation { if (this.isWebSocketConnectionOpened() === true) { logger.warn( - `${this.logPrefix()} OCPP connection to URL ${this.wsConnectionUrl.toString()} - is already opened`, + `${this.logPrefix()} OCPP connection to URL ${this.wsConnectionUrl.toString()} is already opened`, ); return; } @@ -820,7 +749,7 @@ export class ChargingStation { this.wsConnection = new WebSocket( this.wsConnectionUrl, - `ocpp${this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16}`, + `ocpp${this.stationInfo?.ocppVersion}`, options, ); @@ -854,28 +783,29 @@ export class ChargingStation { } } - public getAutomaticTransactionGeneratorConfiguration(): - | AutomaticTransactionGeneratorConfiguration - | undefined { - let automaticTransactionGeneratorConfiguration: - | AutomaticTransactionGeneratorConfiguration - | undefined; - const automaticTransactionGeneratorConfigurationFromFile = - this.getConfigurationFromFile()?.automaticTransactionGenerator; - if ( - this.getAutomaticTransactionGeneratorPersistentConfiguration() && - automaticTransactionGeneratorConfigurationFromFile - ) { - automaticTransactionGeneratorConfiguration = - automaticTransactionGeneratorConfigurationFromFile; - } else { - automaticTransactionGeneratorConfiguration = - this.getTemplateFromFile()?.AutomaticTransactionGenerator; + public getAutomaticTransactionGeneratorConfiguration(): AutomaticTransactionGeneratorConfiguration { + if (isNullOrUndefined(this.automaticTransactionGeneratorConfiguration)) { + let automaticTransactionGeneratorConfiguration: + | AutomaticTransactionGeneratorConfiguration + | undefined; + const stationTemplate = this.getTemplateFromFile(); + const stationConfiguration = this.getConfigurationFromFile(); + if ( + this.stationInfo?.automaticTransactionGeneratorPersistentConfiguration === true && + stationConfiguration?.stationInfo?.templateHash === stationTemplate?.templateHash && + stationConfiguration?.automaticTransactionGenerator + ) { + automaticTransactionGeneratorConfiguration = + stationConfiguration?.automaticTransactionGenerator; + } else { + automaticTransactionGeneratorConfiguration = stationTemplate?.AutomaticTransactionGenerator; + } + this.automaticTransactionGeneratorConfiguration = { + ...Constants.DEFAULT_ATG_CONFIGURATION, + ...automaticTransactionGeneratorConfiguration, + }; } - return { - ...Constants.DEFAULT_ATG_CONFIGURATION, - ...automaticTransactionGeneratorConfiguration, - }; + return this.automaticTransactionGeneratorConfiguration!; } public getAutomaticTransactionGeneratorStatuses(): Status[] | undefined { @@ -885,43 +815,42 @@ export class ChargingStation { public startAutomaticTransactionGenerator(connectorIds?: number[]): void { this.automaticTransactionGenerator = AutomaticTransactionGenerator.getInstance(this); if (isNotEmptyArray(connectorIds)) { - for (const connectorId of connectorIds) { + for (const connectorId of connectorIds!) { this.automaticTransactionGenerator?.startConnector(connectorId); } } else { this.automaticTransactionGenerator?.start(); } this.saveAutomaticTransactionGeneratorConfiguration(); - parentPort?.postMessage(buildUpdatedMessage(this)); + this.emit(ChargingStationEvents.updated); } public stopAutomaticTransactionGenerator(connectorIds?: number[]): void { if (isNotEmptyArray(connectorIds)) { - for (const connectorId of connectorIds) { + for (const connectorId of connectorIds!) { this.automaticTransactionGenerator?.stopConnector(connectorId); } } else { this.automaticTransactionGenerator?.stop(); } this.saveAutomaticTransactionGeneratorConfiguration(); - parentPort?.postMessage(buildUpdatedMessage(this)); + this.emit(ChargingStationEvents.updated); } public async stopTransactionOnConnector( connectorId: number, - reason = StopTransactionReason.NONE, + reason?: StopTransactionReason, ): Promise { const transactionId = this.getConnectorStatus(connectorId)?.transactionId; if ( - this.getBeginEndMeterValues() === true && - this.getOcppStrictCompliance() === true && - this.getOutOfOrderEndMeterValues() === false + this.stationInfo?.beginEndMeterValues === true && + this.stationInfo?.ocppStrictCompliance === true && + this.stationInfo?.outOfOrderEndMeterValues === false ) { - // FIXME: Implement OCPP version agnostic helpers - const transactionEndMeterValue = OCPP16ServiceUtils.buildTransactionEndMeterValue( + const transactionEndMeterValue = buildTransactionEndMeterValue( this, connectorId, - this.getEnergyActiveImportRegisterByTransactionId(transactionId), + this.getEnergyActiveImportRegisterByTransactionId(transactionId!), ); await this.ocppRequestService.requestHandler( this, @@ -938,67 +867,63 @@ export class ChargingStation { RequestCommand.STOP_TRANSACTION, { transactionId, - meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId, true), - reason, + meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId!, true), + ...(isNullOrUndefined(reason) && { reason }), }, ); } - public getReservationOnConnectorId0Enabled(): boolean { + public getReserveConnectorZeroSupported(): boolean { return convertToBoolean( - ChargingStationConfigurationUtils.getConfigurationKey( - this, - StandardParametersKey.ReserveConnectorZeroSupported, - ).value, + getConfigurationKey(this, StandardParametersKey.ReserveConnectorZeroSupported)!.value, ); } public async addReservation(reservation: Reservation): Promise { - const [exists, reservationFound] = this.doesReservationExists(reservation); - if (exists) { + const reservationFound = this.getReservationBy('reservationId', reservation.reservationId); + if (reservationFound !== undefined) { await this.removeReservation(reservationFound, ReservationTerminationReason.REPLACE_EXISTING); } - this.getConnectorStatus(reservation.connectorId).reservation = reservation; - await OCPPServiceUtils.sendAndSetConnectorStatus( + this.getConnectorStatus(reservation.connectorId)!.reservation = reservation; + await sendAndSetConnectorStatus( this, reservation.connectorId, ConnectorStatusEnum.Reserved, - null, + undefined, { send: reservation.connectorId !== 0 }, ); } public async removeReservation( reservation: Reservation, - reason?: ReservationTerminationReason, + reason: ReservationTerminationReason, ): Promise { - const connector = this.getConnectorStatus(reservation.connectorId); + const connector = this.getConnectorStatus(reservation.connectorId)!; switch (reason) { case ReservationTerminationReason.CONNECTOR_STATE_CHANGED: - delete connector.reservation; - break; case ReservationTerminationReason.TRANSACTION_STARTED: delete connector.reservation; break; case ReservationTerminationReason.RESERVATION_CANCELED: case ReservationTerminationReason.REPLACE_EXISTING: case ReservationTerminationReason.EXPIRED: - await OCPPServiceUtils.sendAndSetConnectorStatus( + await sendAndSetConnectorStatus( this, reservation.connectorId, ConnectorStatusEnum.Available, - null, + undefined, { send: reservation.connectorId !== 0 }, ); delete connector.reservation; break; default: - break; + // eslint-disable-next-line @typescript-eslint/restrict-template-expressions + throw new BaseError(`Unknown reservation termination reason '${reason}'`); } } public getReservationBy( - filterKey: ReservationFilterKey, + filterKey: ReservationKey, value: number | string, ): Reservation | undefined { if (this.hasEvses) { @@ -1018,137 +943,108 @@ export class ChargingStation { } } - public doesReservationExists(reservation: Partial): [boolean, Reservation] { - const foundReservation = this.getReservationBy( - ReservationFilterKey.RESERVATION_ID, - reservation?.id, - ); - return isUndefined(foundReservation) ? [false, null] : [true, foundReservation]; + public isConnectorReservable( + reservationId: number, + idTag?: string, + connectorId?: number, + ): boolean { + const reservation = this.getReservationBy('reservationId', reservationId); + const reservationExists = !isUndefined(reservation) && !hasReservationExpired(reservation!); + if (arguments.length === 1) { + return !reservationExists; + } else if (arguments.length > 1) { + const userReservation = !isUndefined(idTag) + ? this.getReservationBy('idTag', idTag!) + : undefined; + const userReservationExists = + !isUndefined(userReservation) && !hasReservationExpired(userReservation!); + const notConnectorZero = isUndefined(connectorId) ? true : connectorId! > 0; + const freeConnectorsAvailable = this.getNumberOfReservableConnectors() > 0; + return ( + !reservationExists && !userReservationExists && notConnectorZero && freeConnectorsAvailable + ); + } + return false; } - public startReservationExpirationSetInterval(customInterval?: number): void { - const interval = - customInterval ?? Constants.DEFAULT_RESERVATION_EXPIRATION_OBSERVATION_INTERVAL; - logger.info( - `${this.logPrefix()} Reservation expiration date interval is set to ${interval} - and starts on charging station now`, - ); - // eslint-disable-next-line @typescript-eslint/no-misused-promises - this.reservationExpirationSetInterval = setInterval(async (): Promise => { - const now = new Date(); - if (this.hasEvses) { - for (const evseStatus of this.evses.values()) { - for (const connectorStatus of evseStatus.connectors.values()) { - if (connectorStatus?.reservation?.expiryDate < now) { - await this.removeReservation( - connectorStatus.reservation, - ReservationTerminationReason.EXPIRED, - ); - } - } + private setIntervalFlushMessageBuffer(): void { + if (this.flushMessageBufferSetInterval === undefined) { + this.flushMessageBufferSetInterval = setInterval(() => { + if (this.isWebSocketConnectionOpened() === true && this.inAcceptedState() === true) { + this.flushMessageBuffer(); } - } else { - for (const connectorStatus of this.connectors.values()) { - if (connectorStatus?.reservation?.expiryDate < now) { - await this.removeReservation( - connectorStatus.reservation, - ReservationTerminationReason.EXPIRED, - ); - } + if (this.messageBuffer.size === 0) { + this.clearIntervalFlushMessageBuffer(); } - } - }, interval); - } - - public restartReservationExpiryDateSetInterval(): void { - this.stopReservationExpirationSetInterval(); - this.startReservationExpirationSetInterval(); - } - - public validateIncomingRequestWithReservation(connectorId: number, idTag: string): boolean { - return this.getReservationBy(ReservationFilterKey.CONNECTOR_ID, connectorId)?.idTag === idTag; + }, Constants.DEFAULT_MESSAGE_BUFFER_FLUSH_INTERVAL); + } } - public isConnectorReservable( - reservationId: number, - idTag?: string, - connectorId?: number, - ): boolean { - const [alreadyExists] = this.doesReservationExists({ id: reservationId }); - if (alreadyExists) { - return alreadyExists; + private clearIntervalFlushMessageBuffer() { + if (this.flushMessageBufferSetInterval !== undefined) { + clearInterval(this.flushMessageBufferSetInterval); + delete this.flushMessageBufferSetInterval; } - const userReservedAlready = isUndefined( - this.getReservationBy(ReservationFilterKey.ID_TAG, idTag), - ) - ? false - : true; - const notConnectorZero = isUndefined(connectorId) ? true : connectorId > 0; - const freeConnectorsAvailable = this.getNumberOfReservableConnectors() > 0; - return !alreadyExists && !userReservedAlready && notConnectorZero && freeConnectorsAvailable; } private getNumberOfReservableConnectors(): number { - let reservableConnectors = 0; + let numberOfReservableConnectors = 0; if (this.hasEvses) { for (const evseStatus of this.evses.values()) { - reservableConnectors += countReservableConnectors(evseStatus.connectors); + numberOfReservableConnectors += getNumberOfReservableConnectors(evseStatus.connectors); } } else { - reservableConnectors = countReservableConnectors(this.connectors); + numberOfReservableConnectors = getNumberOfReservableConnectors(this.connectors); } - return reservableConnectors - this.getNumberOfReservationsOnConnectorZero(); + return numberOfReservableConnectors - this.getNumberOfReservationsOnConnectorZero(); } private getNumberOfReservationsOnConnectorZero(): number { - let numberOfReservations = 0; - if (this.hasEvses && this.evses.get(0)?.connectors.get(0)?.reservation) { - ++numberOfReservations; - } else if (this.connectors.get(0)?.reservation) { - ++numberOfReservations; + if ( + // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing + (this.hasEvses && this.evses.get(0)?.connectors.get(0)?.reservation) || + (!this.hasEvses && this.connectors.get(0)?.reservation) + ) { + return 1; } - return numberOfReservations; + return 0; } private flushMessageBuffer(): void { if (this.messageBuffer.size > 0) { for (const message of this.messageBuffer.values()) { - let beginId: string; - let commandName: RequestCommand; + let beginId: string | undefined; + let commandName: RequestCommand | undefined; 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); + this.wsConnection?.send(message, (error?: Error) => { + isRequest && PerformanceStatistics.endMeasure(commandName!, beginId!); + if (isNullOrUndefined(error)) { + logger.debug( + `${this.logPrefix()} >> Buffered ${getMessageTypeString( + messageType, + )} OCPP message sent '${JSON.stringify(message)}'`, + ); + this.messageBuffer.delete(message); + } else { + logger.debug( + `${this.logPrefix()} >> Buffered ${getMessageTypeString( + messageType, + )} OCPP message '${JSON.stringify(message)}' send failed:`, + error, + ); + } + }); } } } - private getSupervisionUrlOcppConfiguration(): boolean { - return this.stationInfo.supervisionUrlOcppConfiguration ?? false; - } - - private stopReservationExpirationSetInterval(): void { - if (this.reservationExpirationSetInterval) { - clearInterval(this.reservationExpirationSetInterval); - } - } - - private getSupervisionUrlOcppKey(): string { - return this.stationInfo.supervisionUrlOcppKey ?? VendorParametersKey.ConnectionUrl; - } - private getTemplateFromFile(): ChargingStationTemplate | undefined { - let template: ChargingStationTemplate; + let template: ChargingStationTemplate | undefined; try { if (this.sharedLRUCache.hasChargingStationTemplate(this.templateFileHash)) { template = this.sharedLRUCache.getChargingStationTemplate(this.templateFileHash); @@ -1175,9 +1071,10 @@ export class ChargingStation { } private getStationInfoFromTemplate(): ChargingStationInfo { - const stationTemplate: ChargingStationTemplate | undefined = this.getTemplateFromFile(); + const stationTemplate: ChargingStationTemplate = this.getTemplateFromFile()!; checkTemplate(stationTemplate, this.logPrefix(), this.templateFile); - warnTemplateKeysDeprecation(stationTemplate, this.logPrefix(), this.templateFile); + const warnTemplateKeysDeprecationOnce = once(warnTemplateKeysDeprecation, this); + warnTemplateKeysDeprecationOnce(stationTemplate, this.logPrefix(), this.templateFile); if (stationTemplate?.Connectors) { checkConnectorsConfiguration(stationTemplate, this.logPrefix(), this.templateFile); } @@ -1186,6 +1083,7 @@ export class ChargingStation { stationInfo.chargingStationId = getChargingStationId(this.index, stationTemplate); stationInfo.ocppVersion = stationTemplate?.ocppVersion ?? OCPPVersion.VERSION_16; createSerialNumber(stationTemplate, stationInfo); + stationInfo.voltageOut = this.getVoltageOut(stationInfo); if (isNotEmptyArray(stationTemplate?.power)) { stationTemplate.power = stationTemplate.power as number[]; const powerArrayRandomIndex = Math.floor(secureRandom() * stationTemplate.power.length); @@ -1200,11 +1098,12 @@ export class ChargingStation { ? stationTemplate.power * 1000 : stationTemplate.power; } + stationInfo.maximumAmperage = this.getMaximumAmperage(stationInfo); stationInfo.firmwareVersionPattern = stationTemplate?.firmwareVersionPattern ?? Constants.SEMVER_PATTERN; if ( isNotEmptyString(stationInfo.firmwareVersion) && - new RegExp(stationInfo.firmwareVersionPattern).test(stationInfo.firmwareVersion) === false + new RegExp(stationInfo.firmwareVersionPattern).test(stationInfo.firmwareVersion!) === false ) { logger.warn( `${this.logPrefix()} Firmware version '${stationInfo.firmwareVersion}' in template file ${ @@ -1222,15 +1121,16 @@ export class ChargingStation { stationTemplate?.firmwareUpgrade ?? {}, ); stationInfo.resetTime = !isNullOrUndefined(stationTemplate?.resetTime) - ? stationTemplate.resetTime * 1000 + ? secondsToMilliseconds(stationTemplate.resetTime!) : Constants.CHARGING_STATION_DEFAULT_RESET_TIME; - stationInfo.maximumAmperage = this.getMaximumAmperage(stationInfo); return stationInfo; } - private getStationInfoFromFile(): ChargingStationInfo | undefined { + private getStationInfoFromFile( + stationInfoPersistentConfiguration = true, + ): ChargingStationInfo | undefined { let stationInfo: ChargingStationInfo | undefined; - if (this.getStationInfoPersistentConfiguration()) { + if (stationInfoPersistentConfiguration === true) { stationInfo = this.getConfigurationFromFile()?.stationInfo; if (stationInfo) { delete stationInfo?.infoHash; @@ -1240,61 +1140,53 @@ export class ChargingStation { } private getStationInfo(): ChargingStationInfo { + const defaultStationInfo = Constants.DEFAULT_STATION_INFO; const stationInfoFromTemplate: ChargingStationInfo = this.getStationInfoFromTemplate(); - const stationInfoFromFile: ChargingStationInfo | undefined = this.getStationInfoFromFile(); + const stationInfoFromFile: ChargingStationInfo | undefined = this.getStationInfoFromFile( + stationInfoFromTemplate?.stationInfoPersistentConfiguration, + ); // Priority: // 1. charging station info from template // 2. charging station info from configuration file if (stationInfoFromFile?.templateHash === stationInfoFromTemplate.templateHash) { - return stationInfoFromFile; + return { ...defaultStationInfo, ...stationInfoFromFile! }; } stationInfoFromFile && propagateSerialNumber( - this.getTemplateFromFile(), + this.getTemplateFromFile()!, stationInfoFromFile, stationInfoFromTemplate, ); - return stationInfoFromTemplate; + return { ...defaultStationInfo, ...stationInfoFromTemplate }; } private saveStationInfo(): void { - if (this.getStationInfoPersistentConfiguration()) { + if (this.stationInfo?.stationInfoPersistentConfiguration === true) { this.saveConfiguration(); } } - private getOcppPersistentConfiguration(): boolean { - return this.stationInfo?.ocppPersistentConfiguration ?? true; - } - - private getStationInfoPersistentConfiguration(): boolean { - return this.stationInfo?.stationInfoPersistentConfiguration ?? true; - } - - private getAutomaticTransactionGeneratorPersistentConfiguration(): boolean { - return this.stationInfo?.automaticTransactionGeneratorPersistentConfiguration ?? true; - } - - private handleUnsupportedVersion(version: OCPPVersion) { - const errorMsg = `Unsupported protocol version '${version}' configured - in template file ${this.templateFile}`; + private handleUnsupportedVersion(version: OCPPVersion | undefined) { + const errorMsg = `Unsupported protocol version '${version}' configured in template file ${this.templateFile}`; logger.error(`${this.logPrefix()} ${errorMsg}`); throw new BaseError(errorMsg); } private initialize(): void { - const stationTemplate = this.getTemplateFromFile(); + const stationTemplate = this.getTemplateFromFile()!; checkTemplate(stationTemplate, this.logPrefix(), this.templateFile); this.configurationFile = join( dirname(this.templateFile.replace('station-templates', 'configurations')), `${getHashId(this.index, stationTemplate)}.json`, ); - const chargingStationConfiguration = this.getConfigurationFromFile(); + const stationConfiguration = this.getConfigurationFromFile(); if ( - chargingStationConfiguration?.stationInfo?.templateHash === stationTemplate?.templateHash && - (chargingStationConfiguration?.connectorsStatus || chargingStationConfiguration?.evsesStatus) + stationConfiguration?.stationInfo?.templateHash === stationTemplate?.templateHash && + // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing + (stationConfiguration?.connectorsStatus || stationConfiguration?.evsesStatus) ) { - this.initializeConnectorsOrEvsesFromFile(chargingStationConfiguration); + checkConfiguration(stationConfiguration, this.logPrefix(), this.configurationFile); + this.initializeConnectorsOrEvsesFromFile(stationConfiguration); } else { this.initializeConnectorsOrEvsesFromTemplate(stationTemplate); } @@ -1307,22 +1199,24 @@ export class ChargingStation { 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] = ( - convertToInt(match[patchLevelIndex]) + - this.stationInfo.firmwareUpgrade?.versionUpgrade?.step - ).toString(); - this.stationInfo.firmwareVersion = match?.join('.'); + const match = new RegExp(this.stationInfo.firmwareVersionPattern!) + .exec(this.stationInfo.firmwareVersion!) + ?.slice(1, patternGroup! + 1); + if (!isNullOrUndefined(match)) { + const patchLevelIndex = match!.length - 1; + match![patchLevelIndex] = ( + convertToInt(match![patchLevelIndex]) + + this.stationInfo.firmwareUpgrade!.versionUpgrade!.step! + ).toString(); + this.stationInfo.firmwareVersion = match!.join('.'); + } } this.saveStationInfo(); this.configuredSupervisionUrl = this.getConfiguredSupervisionUrl(); - if (this.getEnableStatistics() === true) { + if (this.stationInfo?.enableStatistics === true) { this.performanceStatistics = PerformanceStatistics.getInstance( this.stationInfo.hashId, - this.stationInfo.chargingStationId, + this.stationInfo.chargingStationId!, this.configuredSupervisionUrl, ); } @@ -1332,17 +1226,22 @@ export class ChargingStation { this.ocppConfiguration = this.getOcppConfiguration(); this.initializeOcppConfiguration(); this.initializeOcppServices(); + this.once(ChargingStationEvents.accepted, () => { + this.startMessageSequence().catch((error) => { + logger.error(`${this.logPrefix()} Error while starting the message sequence:`, error); + }); + }); if (this.stationInfo?.autoRegister === true) { this.bootNotificationResponse = { currentTime: new Date(), - interval: this.getHeartbeatInterval() / 1000, + interval: millisecondsToSeconds(this.getHeartbeatInterval()), status: RegistrationStatusEnumType.ACCEPTED, }; } } private initializeOcppServices(): void { - const ocppVersion = this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16; + const ocppVersion = this.stationInfo?.ocppVersion; switch (ocppVersion) { case OCPPVersion.VERSION_16: this.ocppIncomingRequestService = @@ -1366,81 +1265,52 @@ export class ChargingStation { } private initializeOcppConfiguration(): void { - if ( - !ChargingStationConfigurationUtils.getConfigurationKey( - this, - StandardParametersKey.HeartbeatInterval, - ) - ) { - ChargingStationConfigurationUtils.addConfigurationKey( - this, - StandardParametersKey.HeartbeatInterval, - '0', - ); + if (isNullOrUndefined(getConfigurationKey(this, StandardParametersKey.HeartbeatInterval))) { + addConfigurationKey(this, StandardParametersKey.HeartbeatInterval, '0'); } - if ( - !ChargingStationConfigurationUtils.getConfigurationKey( - this, - StandardParametersKey.HeartBeatInterval, - ) - ) { - ChargingStationConfigurationUtils.addConfigurationKey( - this, - StandardParametersKey.HeartBeatInterval, - '0', - { visible: false }, - ); + if (isNullOrUndefined(getConfigurationKey(this, StandardParametersKey.HeartBeatInterval))) { + addConfigurationKey(this, StandardParametersKey.HeartBeatInterval, '0', { visible: false }); } if ( - this.getSupervisionUrlOcppConfiguration() && - isNotEmptyString(this.getSupervisionUrlOcppKey()) && - !ChargingStationConfigurationUtils.getConfigurationKey(this, this.getSupervisionUrlOcppKey()) + this.stationInfo?.supervisionUrlOcppConfiguration === true && + isNotEmptyString(this.stationInfo?.supervisionUrlOcppKey) && + isNullOrUndefined(getConfigurationKey(this, this.stationInfo.supervisionUrlOcppKey!)) ) { - ChargingStationConfigurationUtils.addConfigurationKey( + addConfigurationKey( this, - this.getSupervisionUrlOcppKey(), + this.stationInfo.supervisionUrlOcppKey!, this.configuredSupervisionUrl.href, { reboot: true }, ); } else if ( - !this.getSupervisionUrlOcppConfiguration() && - isNotEmptyString(this.getSupervisionUrlOcppKey()) && - ChargingStationConfigurationUtils.getConfigurationKey(this, this.getSupervisionUrlOcppKey()) + this.stationInfo?.supervisionUrlOcppConfiguration === false && + isNotEmptyString(this.stationInfo?.supervisionUrlOcppKey) && + !isNullOrUndefined(getConfigurationKey(this, this.stationInfo.supervisionUrlOcppKey!)) ) { - ChargingStationConfigurationUtils.deleteConfigurationKey( - this, - this.getSupervisionUrlOcppKey(), - { save: false }, - ); + deleteConfigurationKey(this, this.stationInfo.supervisionUrlOcppKey!, { save: false }); } if ( isNotEmptyString(this.stationInfo?.amperageLimitationOcppKey) && - !ChargingStationConfigurationUtils.getConfigurationKey( - this, - this.stationInfo.amperageLimitationOcppKey, - ) + isNullOrUndefined(getConfigurationKey(this, this.stationInfo.amperageLimitationOcppKey!)) ) { - ChargingStationConfigurationUtils.addConfigurationKey( + addConfigurationKey( this, - this.stationInfo.amperageLimitationOcppKey, + this.stationInfo.amperageLimitationOcppKey!, ( - this.stationInfo.maximumAmperage * getAmperageLimitationUnitDivider(this.stationInfo) + this.stationInfo.maximumAmperage! * getAmperageLimitationUnitDivider(this.stationInfo) ).toString(), ); } if ( - !ChargingStationConfigurationUtils.getConfigurationKey( - this, - StandardParametersKey.SupportedFeatureProfiles, - ) + isNullOrUndefined(getConfigurationKey(this, StandardParametersKey.SupportedFeatureProfiles)) ) { - ChargingStationConfigurationUtils.addConfigurationKey( + addConfigurationKey( this, StandardParametersKey.SupportedFeatureProfiles, `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.FirmwareManagement},${SupportedFeatureProfiles.LocalAuthListManagement},${SupportedFeatureProfiles.SmartCharging},${SupportedFeatureProfiles.RemoteTrigger}`, ); } - ChargingStationConfigurationUtils.addConfigurationKey( + addConfigurationKey( this, StandardParametersKey.NumberOfConnectors, this.getNumberOfConnectors().toString(), @@ -1448,80 +1318,54 @@ export class ChargingStation { { overwrite: true }, ); if ( - !ChargingStationConfigurationUtils.getConfigurationKey( - this, - StandardParametersKey.MeterValuesSampledData, - ) + isNullOrUndefined(getConfigurationKey(this, StandardParametersKey.MeterValuesSampledData)) ) { - ChargingStationConfigurationUtils.addConfigurationKey( + addConfigurationKey( this, StandardParametersKey.MeterValuesSampledData, MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER, ); } if ( - !ChargingStationConfigurationUtils.getConfigurationKey( - this, - StandardParametersKey.ConnectorPhaseRotation, - ) + isNullOrUndefined(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( - getPhaseRotationValue(connectorId, this.getNumberOfPhases()), + getPhaseRotationValue(connectorId, this.getNumberOfPhases())!, ); } } } else { for (const connectorId of this.connectors.keys()) { connectorsPhaseRotation.push( - getPhaseRotationValue(connectorId, this.getNumberOfPhases()), + getPhaseRotationValue(connectorId, this.getNumberOfPhases())!, ); } } - ChargingStationConfigurationUtils.addConfigurationKey( + addConfigurationKey( this, StandardParametersKey.ConnectorPhaseRotation, connectorsPhaseRotation.toString(), ); } if ( - !ChargingStationConfigurationUtils.getConfigurationKey( - this, - StandardParametersKey.AuthorizeRemoteTxRequests, - ) + isNullOrUndefined(getConfigurationKey(this, StandardParametersKey.AuthorizeRemoteTxRequests)) ) { - ChargingStationConfigurationUtils.addConfigurationKey( - this, - StandardParametersKey.AuthorizeRemoteTxRequests, - 'true', - ); + addConfigurationKey(this, StandardParametersKey.AuthorizeRemoteTxRequests, 'true'); } if ( - !ChargingStationConfigurationUtils.getConfigurationKey( - this, - StandardParametersKey.LocalAuthListEnabled, - ) && - ChargingStationConfigurationUtils.getConfigurationKey( - this, - StandardParametersKey.SupportedFeatureProfiles, - )?.value?.includes(SupportedFeatureProfiles.LocalAuthListManagement) - ) { - ChargingStationConfigurationUtils.addConfigurationKey( - this, - StandardParametersKey.LocalAuthListEnabled, - 'false', - ); - } - if ( - !ChargingStationConfigurationUtils.getConfigurationKey( - this, - StandardParametersKey.ConnectionTimeOut, + isNullOrUndefined(getConfigurationKey(this, StandardParametersKey.LocalAuthListEnabled)) && + getConfigurationKey(this, StandardParametersKey.SupportedFeatureProfiles)?.value?.includes( + SupportedFeatureProfiles.LocalAuthListManagement, ) ) { - ChargingStationConfigurationUtils.addConfigurationKey( + addConfigurationKey(this, StandardParametersKey.LocalAuthListEnabled, 'false'); + } + if (isNullOrUndefined(getConfigurationKey(this, StandardParametersKey.ConnectionTimeOut))) { + addConfigurationKey( this, StandardParametersKey.ConnectionTimeOut, Constants.DEFAULT_CONNECTION_TIMEOUT.toString(), @@ -1542,7 +1386,7 @@ export class ChargingStation { this.evses.set(evseId, { ...(evseStatus as EvseStatus), connectors: new Map( - evseStatusConfiguration.connectorsStatus.map((connectorStatus, connectorId) => [ + evseStatusConfiguration.connectorsStatus!.map((connectorStatus, connectorId) => [ connectorId, connectorStatus, ]), @@ -1582,7 +1426,7 @@ export class ChargingStation { logger.error(`${this.logPrefix()} ${errorMsg}`); throw new BaseError(errorMsg); } - if (!stationTemplate?.Connectors[0]) { + if (!stationTemplate?.Connectors?.[0]) { logger.warn( `${this.logPrefix()} Charging station information from template ${ this.templateFile @@ -1606,7 +1450,7 @@ export class ChargingStation { for (let connectorId = 0; connectorId <= configuredMaxConnectors; connectorId++) { if ( connectorId === 0 && - (!stationTemplate?.Connectors[connectorId] || + (!stationTemplate?.Connectors?.[connectorId] || this.getUseConnectorId0(stationTemplate) === false) ) { continue; @@ -1649,20 +1493,27 @@ export class ChargingStation { logger.error(`${this.logPrefix()} ${errorMsg}`); throw new BaseError(errorMsg); } - if (!stationTemplate?.Evses[0]) { + if (!stationTemplate?.Evses?.[0]) { logger.warn( `${this.logPrefix()} Charging station information from template ${ this.templateFile } with no evse id 0 configuration`, ); } - if (!stationTemplate?.Evses[0]?.Connectors[0]) { + if (!stationTemplate?.Evses?.[0]?.Connectors?.[0]) { logger.warn( `${this.logPrefix()} Charging station information from template ${ this.templateFile } with evse id 0 with no connector id 0 configuration`, ); } + if (Object.keys(stationTemplate?.Evses?.[0]?.Connectors as object).length > 1) { + logger.warn( + `${this.logPrefix()} Charging station information from template ${ + this.templateFile + } with evse id 0 with more than one connector configuration, only connector id 0 configuration will be used`, + ); + } if (stationTemplate?.Evses) { const evsesConfigHash = createHash(Constants.DEFAULT_HASH_ALGORITHM) .update(JSON.stringify(stationTemplate?.Evses)) @@ -1674,17 +1525,17 @@ export class ChargingStation { this.evsesConfigurationHash = evsesConfigHash; const templateMaxEvses = getMaxNumberOfEvses(stationTemplate?.Evses); if (templateMaxEvses > 0) { - for (const evse in stationTemplate.Evses) { - const evseId = convertToInt(evse); + for (const evseKey in stationTemplate.Evses) { + const evseId = convertToInt(evseKey); this.evses.set(evseId, { connectors: buildConnectorsMap( - stationTemplate?.Evses[evse]?.Connectors, + stationTemplate?.Evses[evseKey]?.Connectors, this.logPrefix(), this.templateFile, ), availability: AvailabilityType.Operative, }); - initializeConnectorsMapStatus(this.evses.get(evseId)?.connectors, this.logPrefix()); + initializeConnectorsMapStatus(this.evses.get(evseId)!.connectors, this.logPrefix()); } this.saveEvsesStatus(); } else { @@ -1720,7 +1571,7 @@ export class ChargingStation { ) as ChargingStationConfiguration; PerformanceStatistics.endMeasure(measureId, beginId); this.sharedLRUCache.setChargingStationConfiguration(configuration); - this.configurationFileHash = configuration.configurationHash; + this.configurationFileHash = configuration.configurationHash!; } } catch (error) { handleFileException( @@ -1735,7 +1586,7 @@ export class ChargingStation { } private saveAutomaticTransactionGeneratorConfiguration(): void { - if (this.getAutomaticTransactionGeneratorPersistentConfiguration()) { + if (this.stationInfo?.automaticTransactionGeneratorPersistentConfiguration === true) { this.saveConfiguration(); } } @@ -1754,15 +1605,19 @@ export class ChargingStation { if (!existsSync(dirname(this.configurationFile))) { mkdirSync(dirname(this.configurationFile), { recursive: true }); } - let configurationData: ChargingStationConfiguration = - cloneObject(this.getConfigurationFromFile()) ?? {}; - if (this.getStationInfoPersistentConfiguration() && this.stationInfo) { + let configurationData: ChargingStationConfiguration = this.getConfigurationFromFile() + ? cloneObject(this.getConfigurationFromFile()!) + : {}; + if (this.stationInfo?.stationInfoPersistentConfiguration === true && this.stationInfo) { configurationData.stationInfo = this.stationInfo; } else { delete configurationData.stationInfo; } - if (this.getOcppPersistentConfiguration() && this.ocppConfiguration?.configurationKey) { - configurationData.configurationKey = this.ocppConfiguration.configurationKey; + if ( + this.stationInfo?.ocppPersistentConfiguration === true && + Array.isArray(this.ocppConfiguration?.configurationKey) + ) { + configurationData.configurationKey = this.ocppConfiguration?.configurationKey; } else { delete configurationData.configurationKey; } @@ -1771,7 +1626,7 @@ export class ChargingStation { buildChargingStationAutomaticTransactionGeneratorConfiguration(this), ); if ( - !this.getAutomaticTransactionGeneratorPersistentConfiguration() || + !this.stationInfo?.automaticTransactionGeneratorPersistentConfiguration || !this.getAutomaticTransactionGeneratorConfiguration() ) { delete configurationData.automaticTransactionGenerator; @@ -1793,34 +1648,35 @@ export class ChargingStation { stationInfo: configurationData.stationInfo, configurationKey: configurationData.configurationKey, automaticTransactionGenerator: configurationData.automaticTransactionGenerator, + ...(this.connectors.size > 0 && { + connectorsStatus: configurationData.connectorsStatus, + }), + ...(this.evses.size > 0 && { evsesStatus: configurationData.evsesStatus }), } as ChargingStationConfiguration), ) .digest('hex'); if (this.configurationFileHash !== configurationHash) { - AsyncLock.acquire(AsyncLockType.configuration) - .then(() => { - configurationData.configurationHash = configurationHash; - const measureId = `${FileType.ChargingStationConfiguration} write`; - const beginId = PerformanceStatistics.beginMeasure(measureId); - const fileDescriptor = openSync(this.configurationFile, 'w'); - writeFileSync(fileDescriptor, JSON.stringify(configurationData, null, 2), 'utf8'); - closeSync(fileDescriptor); - PerformanceStatistics.endMeasure(measureId, beginId); - this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash); - this.sharedLRUCache.setChargingStationConfiguration(configurationData); - this.configurationFileHash = configurationHash; - }) - .catch((error) => { - handleFileException( - this.configurationFile, - FileType.ChargingStationConfiguration, - error as NodeJS.ErrnoException, - this.logPrefix(), - ); - }) - .finally(() => { - AsyncLock.release(AsyncLockType.configuration).catch(Constants.EMPTY_FUNCTION); - }); + AsyncLock.runExclusive(AsyncLockType.configuration, () => { + configurationData.configurationHash = configurationHash; + const measureId = `${FileType.ChargingStationConfiguration} write`; + const beginId = PerformanceStatistics.beginMeasure(measureId); + writeFileSync( + this.configurationFile, + JSON.stringify(configurationData, undefined, 2), + 'utf8', + ); + PerformanceStatistics.endMeasure(measureId, beginId); + this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash); + this.sharedLRUCache.setChargingStationConfiguration(configurationData); + this.configurationFileHash = configurationHash; + }).catch((error) => { + handleFileException( + this.configurationFile, + FileType.ChargingStationConfiguration, + error as NodeJS.ErrnoException, + this.logPrefix(), + ); + }); } else { logger.debug( `${this.logPrefix()} Not saving unchanged charging station configuration file ${ @@ -1849,7 +1705,7 @@ export class ChargingStation { private getOcppConfigurationFromFile(): ChargingStationOcppConfiguration | undefined { const configurationKey = this.getConfigurationFromFile()?.configurationKey; - if (this.getOcppPersistentConfiguration() === true && configurationKey) { + if (this.stationInfo?.ocppPersistentConfiguration === true && Array.isArray(configurationKey)) { return { configurationKey }; } return undefined; @@ -1869,9 +1725,9 @@ export class ChargingStation { logger.info( `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} succeeded`, ); + let registrationRetryCount = 0; if (this.isRegistered() === false) { // Send BootNotification - let registrationRetryCount = 0; do { this.bootNotificationResponse = await this.ocppRequestService.requestHandler< BootNotificationRequest, @@ -1880,31 +1736,32 @@ export class ChargingStation { skipBufferingOnError: true, }); if (this.isRegistered() === false) { - this.getRegistrationMaxRetries() !== -1 && ++registrationRetryCount; + this.stationInfo?.registrationMaxRetries !== -1 && ++registrationRetryCount; await sleep( this?.bootNotificationResponse?.interval - ? this.bootNotificationResponse.interval * 1000 + ? secondsToMilliseconds(this.bootNotificationResponse.interval) : Constants.DEFAULT_BOOT_NOTIFICATION_INTERVAL, ); } } while ( this.isRegistered() === false && - (registrationRetryCount <= this.getRegistrationMaxRetries() || - this.getRegistrationMaxRetries() === -1) + (registrationRetryCount <= this.stationInfo.registrationMaxRetries! || + this.stationInfo?.registrationMaxRetries === -1) ); } if (this.isRegistered() === true) { + this.emit(ChargingStationEvents.registered); if (this.inAcceptedState() === true) { - await this.startMessageSequence(); + this.emit(ChargingStationEvents.accepted); } } else { logger.error( - `${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})`, + `${this.logPrefix()} Registration failure: maximum retries reached (${registrationRetryCount}) or retry disabled (${this + .stationInfo?.registrationMaxRetries})`, ); } - this.wsConnectionRestarted = false; this.autoReconnectRetryCount = 0; - parentPort?.postMessage(buildUpdatedMessage(this)); + this.emit(ChargingStationEvents.updated); } else { logger.warn( `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} failed`, @@ -1912,7 +1769,7 @@ export class ChargingStation { } } - private async onClose(code: number, reason: Buffer): Promise { + private async onClose(code: WebSocketCloseEventStatusCode, reason: Buffer): Promise { switch (code) { // Normal close case WebSocketCloseEventStatusCode.CLOSE_NORMAL: @@ -1934,7 +1791,7 @@ export class ChargingStation { this.started === true && (await this.reconnect()); break; } - parentPort?.postMessage(buildUpdatedMessage(this)); + this.emit(ChargingStationEvents.updated); } private getCachedRequest(messageType: MessageType, messageId: string): CachedRequest | undefined { @@ -1944,17 +1801,17 @@ export class ChargingStation { } throw new OCPPError( ErrorType.PROTOCOL_ERROR, - `Cached request for message id ${messageId} ${OCPPServiceUtils.getMessageTypeString( + `Cached request for message id ${messageId} ${getMessageTypeString( messageType, )} is not an array`, undefined, - cachedRequest as JsonType, + cachedRequest, ); } private async handleIncomingMessage(request: IncomingRequest): Promise { const [messageType, messageId, commandName, commandPayload] = request; - if (this.getEnableStatistics() === true) { + if (this.stationInfo?.enableStatistics === true) { this.performanceStatistics?.addRequestStatistic(commandName, messageType); } logger.debug( @@ -1969,6 +1826,7 @@ export class ChargingStation { commandName, commandPayload, ); + this.emit(ChargingStationEvents.updated); } private handleResponseMessage(response: Response): void { @@ -1986,7 +1844,7 @@ export class ChargingStation { const [responseCallback, , requestCommandName, requestPayload] = this.getCachedRequest( messageType, messageId, - ); + )!; logger.debug( `${this.logPrefix()} << Command '${ requestCommandName ?? Constants.UNKNOWN_COMMAND @@ -2006,7 +1864,7 @@ export class ChargingStation { { errorType, errorMessage, errorDetails }, ); } - const [, errorCallback, requestCommandName] = this.getCachedRequest(messageType, messageId); + const [, errorCallback, requestCommandName] = this.getCachedRequest(messageType, messageId)!; logger.debug( `${this.logPrefix()} << Command '${ requestCommandName ?? Constants.UNKNOWN_COMMAND @@ -2016,10 +1874,11 @@ export class ChargingStation { } private async onMessage(data: RawData): Promise { - let request: IncomingRequest | Response | ErrorResponse; - let messageType: number; + let request: IncomingRequest | Response | ErrorResponse | undefined; + let messageType: MessageType | undefined; let errorMsg: string; try { + // eslint-disable-next-line @typescript-eslint/no-base-to-string request = JSON.parse(data.toString()) as IncomingRequest | Response | ErrorResponse; if (Array.isArray(request) === true) { [messageType] = request; @@ -2044,17 +1903,21 @@ export class ChargingStation { logger.error(`${this.logPrefix()} ${errorMsg}`); throw new OCPPError(ErrorType.PROTOCOL_ERROR, errorMsg); } - parentPort?.postMessage(buildUpdatedMessage(this)); } else { - throw new OCPPError(ErrorType.PROTOCOL_ERROR, 'Incoming message is not an array', null, { - request, - }); + throw new OCPPError( + ErrorType.PROTOCOL_ERROR, + 'Incoming message is not an array', + undefined, + { + request, + }, + ); } } catch (error) { - let commandName: IncomingRequestCommand; - let requestCommandName: RequestCommand | IncomingRequestCommand; + let commandName: IncomingRequestCommand | undefined; + let requestCommandName: RequestCommand | IncomingRequestCommand | undefined; let errorCallback: ErrorCallback; - const [, messageId] = request; + const [, messageId] = request!; switch (messageType) { case MessageType.CALL_MESSAGE: [, , commandName] = request as IncomingRequest; @@ -2064,7 +1927,7 @@ export class ChargingStation { case MessageType.CALL_RESULT_MESSAGE: case MessageType.CALL_ERROR_MESSAGE: if (this.requests.has(messageId) === true) { - [, errorCallback, requestCommandName] = this.getCachedRequest(messageType, messageId); + [, 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 { @@ -2077,6 +1940,7 @@ export class ChargingStation { logger.warn( `${this.logPrefix()} Error thrown at incoming OCPP command '${ commandName ?? requestCommandName ?? Constants.UNKNOWN_COMMAND + // eslint-disable-next-line @typescript-eslint/no-base-to-string }' message '${data.toString()}' handling is not an OCPPError:`, error, ); @@ -2084,6 +1948,7 @@ export class ChargingStation { logger.error( `${this.logPrefix()} Incoming OCPP command '${ commandName ?? requestCommandName ?? Constants.UNKNOWN_COMMAND + // eslint-disable-next-line @typescript-eslint/no-base-to-string }' message '${data.toString()}'${ messageType !== MessageType.CALL_MESSAGE ? ` matching cached request '${JSON.stringify(this.requests.get(messageId))}'` @@ -2108,16 +1973,16 @@ export class ChargingStation { } private getEnergyActiveImportRegister(connectorStatus: ConnectorStatus, rounded = false): number { - if (this.getMeteringPerTransaction() === true) { + if (this.stationInfo?.meteringPerTransaction === true) { return ( (rounded === true - ? Math.round(connectorStatus?.transactionEnergyActiveImportRegisterValue) + ? Math.round(connectorStatus.transactionEnergyActiveImportRegisterValue!) : connectorStatus?.transactionEnergyActiveImportRegisterValue) ?? 0 ); } return ( (rounded === true - ? Math.round(connectorStatus?.energyActiveImportRegisterValue) + ? Math.round(connectorStatus.energyActiveImportRegisterValue!) : connectorStatus?.energyActiveImportRegisterValue) ?? 0 ); } @@ -2126,7 +1991,7 @@ export class ChargingStation { return stationTemplate?.useConnectorId0 ?? true; } - private async stopRunningTransactions(reason = StopTransactionReason.NONE): Promise { + private async stopRunningTransactions(reason?: StopTransactionReason): Promise { if (this.hasEvses) { for (const [evseId, evseStatus] of this.evses) { if (evseId === 0) { @@ -2149,46 +2014,25 @@ export class ChargingStation { // 0 for disabling private getConnectionTimeout(): number { - if ( - ChargingStationConfigurationUtils.getConfigurationKey( - this, - StandardParametersKey.ConnectionTimeOut, - ) - ) { - return ( - parseInt( - ChargingStationConfigurationUtils.getConfigurationKey( - this, - StandardParametersKey.ConnectionTimeOut, - ).value, - ) ?? Constants.DEFAULT_CONNECTION_TIMEOUT + if (getConfigurationKey(this, StandardParametersKey.ConnectionTimeOut) !== undefined) { + return convertToInt( + getConfigurationKey(this, StandardParametersKey.ConnectionTimeOut)!.value! ?? + Constants.DEFAULT_CONNECTION_TIMEOUT, ); } return Constants.DEFAULT_CONNECTION_TIMEOUT; } - // -1 for unlimited, 0 for disabling - private getAutoReconnectMaxRetries(): number | undefined { - return ( - this.stationInfo.autoReconnectMaxRetries ?? Configuration.getAutoReconnectMaxRetries() ?? -1 - ); - } - - // 0 for disabling - private getRegistrationMaxRetries(): number | undefined { - return this.stationInfo.registrationMaxRetries ?? -1; - } - private getPowerDivider(): number { let powerDivider = this.hasEvses ? this.getNumberOfEvses() : this.getNumberOfConnectors(); - if (this.stationInfo?.powerSharedByConnectors) { + if (this.stationInfo?.powerSharedByConnectors === true) { powerDivider = this.getNumberOfRunningTransactions(); } return powerDivider; } - private getMaximumAmperage(stationInfo: ChargingStationInfo): number | undefined { - const maximumPower = this.getMaximumPower(stationInfo); + private getMaximumAmperage(stationInfo?: ChargingStationInfo): number | undefined { + const maximumPower = (stationInfo ?? this.stationInfo).maximumPower!; switch (this.getCurrentOutType(stationInfo)) { case CurrentType.AC: return ACElectricUtils.amperagePerPhaseFromPower( @@ -2201,20 +2045,25 @@ export class ChargingStation { } } + private getCurrentOutType(stationInfo?: ChargingStationInfo): CurrentType { + return (stationInfo ?? this.stationInfo).currentOutType ?? CurrentType.AC; + } + + private getVoltageOut(stationInfo?: ChargingStationInfo): Voltage { + return ( + (stationInfo ?? this.stationInfo).voltageOut ?? + getDefaultVoltageOut(this.getCurrentOutType(stationInfo), this.logPrefix(), this.templateFile) + ); + } + private getAmperageLimitation(): number | undefined { if ( isNotEmptyString(this.stationInfo?.amperageLimitationOcppKey) && - ChargingStationConfigurationUtils.getConfigurationKey( - this, - this.stationInfo.amperageLimitationOcppKey, - ) + getConfigurationKey(this, this.stationInfo.amperageLimitationOcppKey!) !== undefined ) { return ( convertToInt( - ChargingStationConfigurationUtils.getConfigurationKey( - this, - this.stationInfo.amperageLimitationOcppKey, - )?.value, + getConfigurationKey(this, this.stationInfo.amperageLimitationOcppKey!)?.value, ) / getAmperageLimitationUnitDivider(this.stationInfo) ); } @@ -2239,12 +2088,7 @@ export class ChargingStation { if (evseId > 0) { for (const [connectorId, connectorStatus] of evseStatus.connectors) { const connectorBootStatus = getBootConnectorStatus(this, connectorId, connectorStatus); - await OCPPServiceUtils.sendAndSetConnectorStatus( - this, - connectorId, - connectorBootStatus, - evseId, - ); + await sendAndSetConnectorStatus(this, connectorId, connectorBootStatus, evseId); } } } @@ -2254,13 +2098,13 @@ export class ChargingStation { const connectorBootStatus = getBootConnectorStatus( this, connectorId, - this.getConnectorStatus(connectorId), + this.getConnectorStatus(connectorId)!, ); - await OCPPServiceUtils.sendAndSetConnectorStatus(this, connectorId, connectorBootStatus); + await sendAndSetConnectorStatus(this, connectorId, connectorBootStatus); } } } - if (this.stationInfo?.firmwareStatus === FirmwareStatus.Installing) { + if (this.stationInfo.firmwareStatus === FirmwareStatus.Installing) { await this.ocppRequestService.requestHandler< FirmwareStatusNotificationRequest, FirmwareStatusNotificationResponse @@ -2271,25 +2115,26 @@ export class ChargingStation { } // Start the ATG - if (this.getAutomaticTransactionGeneratorConfiguration()?.enable === true) { + if (this.getAutomaticTransactionGeneratorConfiguration().enable === true) { this.startAutomaticTransactionGenerator(); } - this.wsConnectionRestarted === true && this.flushMessageBuffer(); + this.flushMessageBuffer(); } private async stopMessageSequence( - reason: StopTransactionReason = StopTransactionReason.NONE, + reason?: StopTransactionReason, + stopTransactions = this.stationInfo?.stopTransactionsOnStopped, ): Promise { // Stop WebSocket ping this.stopWebSocketPing(); // Stop heartbeat this.stopHeartbeat(); - // Stop ongoing transactions + // Stop the ATG if (this.automaticTransactionGenerator?.started === true) { this.stopAutomaticTransactionGenerator(); - } else { - await this.stopRunningTransactions(reason); } + // Stop ongoing transactions + stopTransactions && (await this.stopRunningTransactions(reason)); if (this.hasEvses) { for (const [evseId, evseStatus] of this.evses) { if (evseId > 0) { @@ -2300,7 +2145,7 @@ export class ChargingStation { >( this, RequestCommand.STATUS_NOTIFICATION, - OCPPServiceUtils.buildStatusNotificationRequest( + buildStatusNotificationRequest( this, connectorId, ConnectorStatusEnum.Unavailable, @@ -2320,11 +2165,7 @@ export class ChargingStation { >( this, RequestCommand.STATUS_NOTIFICATION, - OCPPServiceUtils.buildStatusNotificationRequest( - this, - connectorId, - ConnectorStatusEnum.Unavailable, - ), + buildStatusNotificationRequest(this, connectorId, ConnectorStatusEnum.Unavailable), ); delete this.getConnectorStatus(connectorId)?.status; } @@ -2333,29 +2174,24 @@ export class ChargingStation { } private startWebSocketPing(): void { - const webSocketPingInterval: number = ChargingStationConfigurationUtils.getConfigurationKey( - this, - StandardParametersKey.WebSocketPingInterval, - ) - ? convertToInt( - ChargingStationConfigurationUtils.getConfigurationKey( - this, - StandardParametersKey.WebSocketPingInterval, - )?.value, - ) - : 0; - if (webSocketPingInterval > 0 && !this.webSocketPingSetInterval) { + const webSocketPingInterval: number = + getConfigurationKey(this, StandardParametersKey.WebSocketPingInterval) !== undefined + ? convertToInt( + getConfigurationKey(this, StandardParametersKey.WebSocketPingInterval)?.value, + ) + : 0; + if (webSocketPingInterval > 0 && this.webSocketPingSetInterval === undefined) { this.webSocketPingSetInterval = setInterval(() => { if (this.isWebSocketConnectionOpened() === true) { this.wsConnection?.ping(); } - }, webSocketPingInterval * 1000); + }, secondsToMilliseconds(webSocketPingInterval)); logger.info( `${this.logPrefix()} WebSocket ping started every ${formatDurationSeconds( webSocketPingInterval, )}`, ); - } else if (this.webSocketPingSetInterval) { + } else if (this.webSocketPingSetInterval !== undefined) { logger.info( `${this.logPrefix()} WebSocket ping already started every ${formatDurationSeconds( webSocketPingInterval, @@ -2369,7 +2205,7 @@ export class ChargingStation { } private stopWebSocketPing(): void { - if (this.webSocketPingSetInterval) { + if (this.webSocketPingSetInterval !== undefined) { clearInterval(this.webSocketPingSetInterval); delete this.webSocketPingSetInterval; } @@ -2382,23 +2218,26 @@ export class ChargingStation { let configuredSupervisionUrlIndex: number; switch (Configuration.getSupervisionUrlDistribution()) { case SupervisionUrlDistribution.RANDOM: - configuredSupervisionUrlIndex = Math.floor(secureRandom() * supervisionUrls.length); + configuredSupervisionUrlIndex = Math.floor( + secureRandom() * (supervisionUrls as string[]).length, + ); break; case SupervisionUrlDistribution.ROUND_ROBIN: case SupervisionUrlDistribution.CHARGING_STATION_AFFINITY: default: Object.values(SupervisionUrlDistribution).includes( - Configuration.getSupervisionUrlDistribution(), + Configuration.getSupervisionUrlDistribution()!, ) === false && logger.error( + // eslint-disable-next-line @typescript-eslint/no-base-to-string `${this.logPrefix()} Unknown supervision url distribution '${Configuration.getSupervisionUrlDistribution()}' from values '${SupervisionUrlDistribution.toString()}', defaulting to ${ SupervisionUrlDistribution.CHARGING_STATION_AFFINITY }`, ); - configuredSupervisionUrlIndex = (this.index - 1) % supervisionUrls.length; + configuredSupervisionUrlIndex = (this.index - 1) % (supervisionUrls as string[]).length; break; } - configuredSupervisionUrl = supervisionUrls[configuredSupervisionUrlIndex]; + configuredSupervisionUrl = (supervisionUrls as string[])[configuredSupervisionUrlIndex]; } else { configuredSupervisionUrl = supervisionUrls as string; } @@ -2411,7 +2250,7 @@ export class ChargingStation { } private stopHeartbeat(): void { - if (this.heartbeatSetInterval) { + if (this.heartbeatSetInterval !== undefined) { clearInterval(this.heartbeatSetInterval); delete this.heartbeatSetInterval; } @@ -2424,10 +2263,6 @@ export class ChargingStation { } } - private getReconnectExponentialDelay(): boolean { - return this.stationInfo?.reconnectExponentialDelay ?? false; - } - private async reconnect(): Promise { // Stop WebSocket ping this.stopWebSocketPing(); @@ -2438,13 +2273,14 @@ export class ChargingStation { this.stopAutomaticTransactionGenerator(); } if ( - this.autoReconnectRetryCount < this.getAutoReconnectMaxRetries() || - this.getAutoReconnectMaxRetries() === -1 + this.autoReconnectRetryCount < this.stationInfo.autoReconnectMaxRetries! || + this.stationInfo?.autoReconnectMaxRetries === -1 ) { ++this.autoReconnectRetryCount; - const reconnectDelay = this.getReconnectExponentialDelay() - ? exponentialDelay(this.autoReconnectRetryCount) - : this.getConnectionTimeout() * 1000; + const reconnectDelay = + this.stationInfo?.reconnectExponentialDelay === true + ? exponentialDelay(this.autoReconnectRetryCount) + : secondsToMilliseconds(this.getConnectionTimeout()); const reconnectDelayWithdraw = 1000; const reconnectTimeout = reconnectDelay && reconnectDelay - reconnectDelayWithdraw > 0 @@ -2462,17 +2298,15 @@ export class ChargingStation { ); this.openWSConnection( { - ...(this.stationInfo?.wsOptions ?? {}), handshakeTimeout: reconnectTimeout, }, { closeOpened: true }, ); - this.wsConnectionRestarted = true; - } else if (this.getAutoReconnectMaxRetries() !== -1) { + } else if (this.stationInfo?.autoReconnectMaxRetries !== -1) { logger.error( `${this.logPrefix()} WebSocket connection retries failure: maximum retries reached (${ this.autoReconnectRetryCount - }) or retries disabled (${this.getAutoReconnectMaxRetries()})`, + }) or retries disabled (${this.stationInfo?.autoReconnectMaxRetries})`, ); } }