X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FChargingStation.ts;h=587ca02ff143d391c222b07ca11a9f81fdf7cb70;hb=262c47b2dbe7ad59fa523e77668dd0b994214cb2;hp=bbb5c6f290a39503092b9537e27b9a2ac8535123;hpb=8bfbc743623554d980978f90da658d7beb2e8d05;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ChargingStation.ts b/src/charging-station/ChargingStation.ts index bbb5c6f2..587ca02f 100644 --- a/src/charging-station/ChargingStation.ts +++ b/src/charging-station/ChargingStation.ts @@ -1,4 +1,4 @@ -// Partial Copyright Jerome Benoit. 2021. All Rights Reserved. +// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved. import crypto from 'crypto'; import fs from 'fs'; @@ -6,19 +6,20 @@ import path from 'path'; import { URL } from 'url'; import { parentPort } from 'worker_threads'; -import WebSocket, { Data, RawData } from 'ws'; +import WebSocket, { type RawData } from 'ws'; import BaseError from '../exception/BaseError'; import OCPPError from '../exception/OCPPError'; import PerformanceStatistics from '../performance/PerformanceStatistics'; import type { AutomaticTransactionGeneratorConfiguration } from '../types/AutomaticTransactionGenerator'; -import type ChargingStationConfiguration from '../types/ChargingStationConfiguration'; -import type ChargingStationInfo from '../types/ChargingStationInfo'; -import type ChargingStationOcppConfiguration from '../types/ChargingStationOcppConfiguration'; -import ChargingStationTemplate, { +import type { ChargingStationConfiguration } from '../types/ChargingStationConfiguration'; +import type { ChargingStationInfo } from '../types/ChargingStationInfo'; +import type { ChargingStationOcppConfiguration } from '../types/ChargingStationOcppConfiguration'; +import { + type ChargingStationTemplate, CurrentType, PowerUnits, - WsOptions, + type WsOptions, } from '../types/ChargingStationTemplate'; import { SupervisionUrlDistribution } from '../types/ConfigurationData'; import type { ConnectorStatus } from '../types/ConnectorStatus'; @@ -39,28 +40,30 @@ import { MeterValue, MeterValueMeasurand } from '../types/ocpp/MeterValues'; import { OCPPVersion } from '../types/ocpp/OCPPVersion'; import { AvailabilityType, - BootNotificationRequest, - CachedRequest, - HeartbeatRequest, - IncomingRequest, + type BootNotificationRequest, + type CachedRequest, + type ErrorCallback, + type HeartbeatRequest, + type IncomingRequest, IncomingRequestCommand, - MeterValuesRequest, + type MeterValuesRequest, RequestCommand, - StatusNotificationRequest, + type ResponseCallback, + type StatusNotificationRequest, } from '../types/ocpp/Requests'; import { - BootNotificationResponse, - ErrorResponse, - HeartbeatResponse, - MeterValuesResponse, - RegistrationStatus, - Response, - StatusNotificationResponse, + type BootNotificationResponse, + type ErrorResponse, + type HeartbeatResponse, + type MeterValuesResponse, + RegistrationStatusEnumType, + type Response, + type StatusNotificationResponse, } from '../types/ocpp/Responses'; import { StopTransactionReason, - StopTransactionRequest, - StopTransactionResponse, + type StopTransactionRequest, + type StopTransactionResponse, } from '../types/ocpp/Transaction'; import { WSError, WebSocketCloseEventStatusCode } from '../types/WebSocket'; import Configuration from '../utils/Configuration'; @@ -79,14 +82,19 @@ import OCPP16IncomingRequestService from './ocpp/1.6/OCPP16IncomingRequestServic import OCPP16RequestService from './ocpp/1.6/OCPP16RequestService'; import OCPP16ResponseService from './ocpp/1.6/OCPP16ResponseService'; import { OCPP16ServiceUtils } from './ocpp/1.6/OCPP16ServiceUtils'; +import OCPP20IncomingRequestService from './ocpp/2.0/OCPP20IncomingRequestService'; +import OCPP20RequestService from './ocpp/2.0/OCPP20RequestService'; +import OCPP20ResponseService from './ocpp/2.0/OCPP20ResponseService'; import type OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService'; import type OCPPRequestService from './ocpp/OCPPRequestService'; import SharedLRUCache from './SharedLRUCache'; export default class ChargingStation { + public readonly index: number; public readonly templateFile: string; public stationInfo!: ChargingStationInfo; public started: boolean; + public starting: boolean; public authorizedTagsCache: AuthorizedTagsCache; public automaticTransactionGenerator!: AutomaticTransactionGenerator; public ocppConfiguration!: ChargingStationOcppConfiguration; @@ -99,13 +107,14 @@ export default class ChargingStation { public bootNotificationRequest!: BootNotificationRequest; public bootNotificationResponse!: BootNotificationResponse | null; public powerDivider!: number; - private readonly index: number; + private stopping: boolean; private configurationFile!: string; private configurationFileHash!: string; private connectorsConfigurationHash!: string; private ocppIncomingRequestService!: OCPPIncomingRequestService; private readonly messageBuffer: Set; private configuredSupervisionUrl!: URL; + private configuredSupervisionUrlIndex!: number; private wsConnectionRestarted: boolean; private autoReconnectRetryCount: number; private templateFileWatcher!: fs.FSWatcher; @@ -114,6 +123,11 @@ export default class ChargingStation { private readonly chargingStationWorkerBroadcastChannel: ChargingStationWorkerBroadcastChannel; constructor(index: number, templateFile: string) { + 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(); @@ -122,9 +136,6 @@ export default class ChargingStation { this.sharedLRUCache = SharedLRUCache.getInstance(); this.authorizedTagsCache = AuthorizedTagsCache.getInstance(); this.chargingStationWorkerBroadcastChannel = new ChargingStationWorkerBroadcastChannel(this); - this.started = false; - this.wsConnectionRestarted = false; - this.autoReconnectRetryCount = 0; this.initialize(); } @@ -151,14 +162,6 @@ export default class ChargingStation { ); } - public getRandomIdTag(): string { - const authorizationFile = ChargingStationUtils.getAuthorizationFile(this.stationInfo); - const index = Math.floor( - Utils.secureRandom() * this.authorizedTagsCache.getAuthorizedTags(authorizationFile).length - ); - return this.authorizedTagsCache.getAuthorizedTags(authorizationFile)[index]; - } - public hasAuthorizedTags(): boolean { return !Utils.isEmptyArray( this.authorizedTagsCache.getAuthorizedTags( @@ -197,7 +200,7 @@ export default class ChargingStation { return this?.wsConnection?.readyState === WebSocket.OPEN; } - public getRegistrationStatus(): RegistrationStatus { + public getRegistrationStatus(): RegistrationStatusEnumType { return this?.bootNotificationResponse?.status; } @@ -206,19 +209,22 @@ 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 { @@ -475,75 +481,85 @@ export default class ChargingStation { } public start(): void { - if (this.getEnableStatistics()) { - this.performanceStatistics.start(); - } - this.openWSConnection(); - // Monitor charging station template file - this.templateFileWatcher = FileUtils.watchJsonFile( - this.logPrefix(), - FileType.ChargingStationTemplate, - this.templateFile, - null, - (event, filename): void => { - if (filename && event === 'change') { - try { - logger.debug( - `${this.logPrefix()} ${FileType.ChargingStationTemplate} ${ - this.templateFile - } file have changed, reload` - ); - this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash); - // Initialize - this.initialize(); - // Restart the ATG - this.stopAutomaticTransactionGenerator(); - if (this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable === true) { - this.startAutomaticTransactionGenerator(); - } - if (this.getEnableStatistics()) { - this.performanceStatistics.restart(); - } else { - this.performanceStatistics.stop(); + if (this.started === false) { + if (this.starting === false) { + this.starting = true; + if (this.getEnableStatistics()) { + this.performanceStatistics.start(); + } + this.openWSConnection(); + // Monitor charging station template file + this.templateFileWatcher = FileUtils.watchJsonFile( + this.logPrefix(), + FileType.ChargingStationTemplate, + this.templateFile, + null, + (event, filename): void => { + if (filename && event === 'change') { + try { + logger.debug( + `${this.logPrefix()} ${FileType.ChargingStationTemplate} ${ + this.templateFile + } file have changed, reload` + ); + this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash); + // Initialize + this.initialize(); + // Restart the ATG + this.stopAutomaticTransactionGenerator(); + if ( + this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable === true + ) { + this.startAutomaticTransactionGenerator(); + } + if (this.getEnableStatistics()) { + this.performanceStatistics.restart(); + } else { + this.performanceStatistics.stop(); + } + // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed + } catch (error) { + logger.error( + `${this.logPrefix()} ${FileType.ChargingStationTemplate} file monitoring error:`, + error + ); + } } - // 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...`); } - ); - parentPort.postMessage(MessageChannelUtils.buildStartedMessage(this)); + } else { + logger.warn(`${this.logPrefix()} Charging station is already started...`); + } } public async stop(reason?: StopTransactionReason): Promise { - await this.stopMessageSequence(reason); - for (const connectorId of this.connectors.keys()) { - if (connectorId > 0) { - await this.ocppRequestService.requestHandler< - StatusNotificationRequest, - StatusNotificationResponse - >(this, RequestCommand.STATUS_NOTIFICATION, { - connectorId, - status: ChargePointStatus.UNAVAILABLE, - errorCode: ChargePointErrorCode.NO_ERROR, - }); - this.getConnectorStatus(connectorId).status = ChargePointStatus.UNAVAILABLE; + if (this.started === true) { + if (this.stopping === false) { + this.stopping = true; + await this.stopMessageSequence(reason); + this.closeWSConnection(); + if (this.getEnableStatistics()) { + this.performanceStatistics.stop(); + } + this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash); + this.templateFileWatcher.close(); + this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash); + this.bootNotificationResponse = null; + this.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...`); } - this.closeWSConnection(); - if (this.getEnableStatistics()) { - this.performanceStatistics.stop(); - } - this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash); - this.templateFileWatcher.close(); - this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash); - this.bootNotificationResponse = null; - this.started = false; - parentPort.postMessage(MessageChannelUtils.buildStoppedMessage(this)); } public async reset(reason?: StopTransactionReason): Promise { @@ -559,37 +575,6 @@ export default class ChargingStation { } } - public setChargingProfile(connectorId: number, cp: ChargingProfile): void { - if (Utils.isNullOrUndefined(this.getConnectorStatus(connectorId).chargingProfiles)) { - logger.error( - `${this.logPrefix()} Trying to set a charging profile on connectorId ${connectorId} with an uninitialized charging profiles array attribute, applying deferred initialization` - ); - this.getConnectorStatus(connectorId).chargingProfiles = []; - } - if (Array.isArray(this.getConnectorStatus(connectorId).chargingProfiles) === false) { - logger.error( - `${this.logPrefix()} Trying to set a charging profile on connectorId ${connectorId} with an improper attribute type for the charging profiles array, applying proper type initialization` - ); - this.getConnectorStatus(connectorId).chargingProfiles = []; - } - let cpReplaced = false; - if (!Utils.isEmptyArray(this.getConnectorStatus(connectorId).chargingProfiles)) { - this.getConnectorStatus(connectorId).chargingProfiles?.forEach( - (chargingProfile: ChargingProfile, index: number) => { - if ( - chargingProfile.chargingProfileId === cp.chargingProfileId || - (chargingProfile.stackLevel === cp.stackLevel && - chargingProfile.chargingProfilePurpose === cp.chargingProfilePurpose) - ) { - this.getConnectorStatus(connectorId).chargingProfiles[index] = cp; - cpReplaced = true; - } - } - ); - } - !cpReplaced && this.getConnectorStatus(connectorId).chargingProfiles?.push(cp); - } - public resetConnectorStatus(connectorId: number): void { this.getConnectorStatus(connectorId).idTagLocalAuthorized = false; this.getConnectorStatus(connectorId).idTagAuthorized = false; @@ -605,7 +590,7 @@ export default class ChargingStation { parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this)); } - public hasFeatureProfile(featureProfile: SupportedFeatureProfiles) { + public hasFeatureProfile(featureProfile: SupportedFeatureProfiles): boolean { return ChargingStationConfigurationUtils.getConfigurationKey( this, StandardParametersKey.SupportedFeatureProfiles @@ -626,6 +611,12 @@ export default class ChargingStation { options.handshakeTimeout = options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000; params.closeOpened = params?.closeOpened ?? false; params.terminateOpened = params?.terminateOpened ?? false; + 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) @@ -638,17 +629,20 @@ export default class ChargingStation { if (params?.terminateOpened) { this.terminateWSConnection(); } + const ocppVersion = this.getOcppVersion(); let protocol: string; - switch (this.getOcppVersion()) { + switch (ocppVersion) { case OCPPVersion.VERSION_16: - protocol = 'ocpp' + OCPPVersion.VERSION_16; + case OCPPVersion.VERSION_20: + case OCPPVersion.VERSION_201: + protocol = 'ocpp' + ocppVersion; break; default: - this.handleUnsupportedVersion(this.getOcppVersion()); + this.handleUnsupportedVersion(ocppVersion); break; } - if (this.isWebSocketConnectionOpened()) { + if (this.isWebSocketConnectionOpened() === true) { logger.warn( `${this.logPrefix()} OCPP connection to URL ${this.wsConnectionUrl.toString()} is already opened` ); @@ -685,19 +679,21 @@ export default class ChargingStation { } public closeWSConnection(): void { - if (this.isWebSocketConnectionOpened()) { + if (this.isWebSocketConnectionOpened() === true) { this.wsConnection.close(); this.wsConnection = null; } } - public startAutomaticTransactionGenerator(connectorIds?: number[]): void { - if (!this.automaticTransactionGenerator) { - this.automaticTransactionGenerator = AutomaticTransactionGenerator.getInstance( + public startAutomaticTransactionGenerator( + connectorIds?: number[], + automaticTransactionGeneratorConfiguration?: AutomaticTransactionGeneratorConfiguration + ): void { + this.automaticTransactionGenerator = AutomaticTransactionGenerator.getInstance( + automaticTransactionGeneratorConfiguration ?? this.getAutomaticTransactionGeneratorConfigurationFromTemplate(), - this - ); - } + this + ); if (!Utils.isEmptyArray(connectorIds)) { for (const connectorId of connectorIds) { this.automaticTransactionGenerator.startConnector(connectorId); @@ -705,6 +701,7 @@ export default class ChargingStation { } else { this.automaticTransactionGenerator.start(); } + parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this)); } public stopAutomaticTransactionGenerator(connectorIds?: number[]): void { @@ -714,8 +711,8 @@ export default class ChargingStation { } } else { this.automaticTransactionGenerator?.stop(); - this.automaticTransactionGenerator = null; } + parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this)); } public async stopTransactionOnConnector( @@ -724,9 +721,9 @@ export default class ChargingStation { ): Promise { const transactionId = this.getConnectorStatus(connectorId).transactionId; if ( - this.getBeginEndMeterValues() && - this.getOcppStrictCompliance() && - !this.getOutOfOrderEndMeterValues() + this.getBeginEndMeterValues() === true && + this.getOcppStrictCompliance() === true && + this.getOutOfOrderEndMeterValues() === false ) { // FIXME: Implement OCPP version agnostic helpers const transactionEndMeterValue = OCPP16ServiceUtils.buildTransactionEndMeterValue( @@ -805,7 +802,7 @@ export default class ChargingStation { private getStationInfoFromTemplate(): ChargingStationInfo { const stationTemplate: ChargingStationTemplate = this.getTemplateFromFile(); if (Utils.isNullOrUndefined(stationTemplate)) { - const errorMsg = 'Failed to read charging station template file'; + const errorMsg = `Failed to read charging station template file ${this.templateFile}`; logger.error(`${this.logPrefix()} ${errorMsg}`); throw new BaseError(errorMsg); } @@ -827,6 +824,21 @@ export default class ChargingStation { 'supervisionUrl', 'supervisionUrls' ); + const firmwareVersionRegExp = stationTemplate.firmwareVersionPattern + ? new RegExp(stationTemplate.firmwareVersionPattern) + : Constants.SEMVER_REGEXP; + if ( + stationTemplate.firmwareVersion && + firmwareVersionRegExp.test(stationTemplate.firmwareVersion) === false + ) { + logger.warn( + `${this.logPrefix()} Firmware version '${ + stationTemplate.firmwareVersion + }' in template file ${ + this.templateFile + } does not match regular expression '${firmwareVersionRegExp.toString()}'` + ); + } const stationInfo: ChargingStationInfo = ChargingStationUtils.stationTemplateToStationInfo(stationTemplate); stationInfo.hashId = ChargingStationUtils.getHashId(this.index, stationTemplate); @@ -852,10 +864,8 @@ export default class ChargingStation { stationInfo.resetTime = stationTemplate.resetTime ? stationTemplate.resetTime * 1000 : Constants.CHARGING_STATION_DEFAULT_RESET_TIME; - const configuredMaxConnectors = ChargingStationUtils.getConfiguredNumberOfConnectors( - this.index, - stationTemplate - ); + const configuredMaxConnectors = + ChargingStationUtils.getConfiguredNumberOfConnectors(stationTemplate); ChargingStationUtils.checkConfiguredMaxConnectors( configuredMaxConnectors, this.templateFile, @@ -945,7 +955,6 @@ export default class ChargingStation { ); this.stationInfo = this.getStationInfo(); this.saveStationInfo(); - logger.info(`${this.logPrefix()} Charging station hashId '${this.stationInfo.hashId}'`); // Avoid duplication of connectors related information in RAM this.stationInfo?.Connectors && delete this.stationInfo.Connectors; this.configuredSupervisionUrl = this.getConfiguredSupervisionUrl(); @@ -971,15 +980,23 @@ export default class ChargingStation { 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()); break; } - if (this.stationInfo?.autoRegister) { + if (this.stationInfo?.autoRegister === true) { this.bootNotificationResponse = { - currentTime: new Date().toISOString(), + currentTime: new Date(), interval: this.getHeartbeatInterval() / 1000, - status: RegistrationStatus.ACCEPTED, + status: RegistrationStatusEnumType.ACCEPTED, }; } } @@ -1176,15 +1193,17 @@ export default class ChargingStation { // Add connector Id 0 let lastConnector = '0'; for (lastConnector in stationInfo?.Connectors) { + const connectorStatus = stationInfo?.Connectors[lastConnector]; const lastConnectorId = Utils.convertToInt(lastConnector); if ( lastConnectorId === 0 && - this.getUseConnectorId0(stationInfo) && - stationInfo?.Connectors[lastConnector] + this.getUseConnectorId0(stationInfo) === true && + connectorStatus ) { + this.checkStationInfoConnectorStatus(lastConnectorId, connectorStatus); this.connectors.set( lastConnectorId, - Utils.cloneObject(stationInfo?.Connectors[lastConnector]) + Utils.cloneObject(connectorStatus) ); this.getConnectorStatus(lastConnectorId).availability = AvailabilityType.OPERATIVE; if (Utils.isUndefined(this.getConnectorStatus(lastConnectorId)?.chargingProfiles)) { @@ -1198,10 +1217,9 @@ export default class ChargingStation { const randConnectorId = stationInfo?.randomConnectors ? Utils.getRandomInteger(Utils.convertToInt(lastConnector), 1) : index; - this.connectors.set( - index, - Utils.cloneObject(stationInfo?.Connectors[randConnectorId]) - ); + const connectorStatus = stationInfo?.Connectors[randConnectorId.toString()]; + this.checkStationInfoConnectorStatus(randConnectorId, connectorStatus); + this.connectors.set(index, Utils.cloneObject(connectorStatus)); this.getConnectorStatus(index).availability = AvailabilityType.OPERATIVE; if (Utils.isUndefined(this.getConnectorStatus(index)?.chargingProfiles)) { this.getConnectorStatus(index).chargingProfiles = []; @@ -1218,16 +1236,37 @@ export default class ChargingStation { } // Initialize transaction attributes on connectors for (const connectorId of this.connectors.keys()) { + if (connectorId > 0 && this.getConnectorStatus(connectorId).transactionStarted === true) { + logger.warn( + `${this.logPrefix()} Connector ${connectorId} at initialization has a transaction started: ${ + this.getConnectorStatus(connectorId).transactionId + }` + ); + } if ( connectorId > 0 && (this.getConnectorStatus(connectorId).transactionStarted === undefined || - this.getConnectorStatus(connectorId).transactionStarted === false) + this.getConnectorStatus(connectorId).transactionStarted === null) ) { this.initializeConnectorStatus(connectorId); } } } + private checkStationInfoConnectorStatus( + connectorId: number, + connectorStatus: ConnectorStatus + ): void { + if (!Utils.isNullOrUndefined(connectorStatus?.status)) { + logger.warn( + `${this.logPrefix()} Charging station information from template ${ + this.templateFile + } with connector ${connectorId} status configuration defined, undefine it` + ); + connectorStatus.status = undefined; + } + } + private getConfigurationFromFile(): ChargingStationConfiguration | null { let configuration: ChargingStationConfiguration = null; if (this.configurationFile && fs.existsSync(this.configurationFile)) { @@ -1313,7 +1352,7 @@ export default class ChargingStation { private getOcppConfigurationFromFile(): ChargingStationOcppConfiguration | null { let configuration: ChargingStationConfiguration = null; - if (this.getOcppPersistentConfiguration()) { + if (this.getOcppPersistentConfiguration() === true) { const configurationFromFile = this.getConfigurationFromFile(); configuration = configurationFromFile?.configurationKey && configurationFromFile; } @@ -1330,11 +1369,11 @@ export default class ChargingStation { } 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 { @@ -1344,7 +1383,7 @@ export default class ChargingStation { >(this, RequestCommand.BOOT_NOTIFICATION, this.bootNotificationRequest, { skipBufferingOnError: true, }); - if (!this.isRegistered()) { + if (this.isRegistered() === false) { this.getRegistrationMaxRetries() !== -1 && registrationRetryCount++; await Utils.sleep( this.bootNotificationResponse?.interval @@ -1353,24 +1392,22 @@ export default class ChargingStation { ); } } 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.started === false && (this.started = true); - this.autoReconnectRetryCount = 0; this.wsConnectionRestarted = false; + this.autoReconnectRetryCount = 0; parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this)); } else { logger.warn( @@ -1379,7 +1416,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: @@ -1387,7 +1424,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; @@ -1396,15 +1433,15 @@ 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 async onMessage(data: Data): Promise { + private async onMessage(data: RawData): Promise { let messageType: number; let messageId: string; let commandName: IncomingRequestCommand; @@ -1412,8 +1449,8 @@ export default class ChargingStation { let errorType: ErrorType; let errorMessage: string; let errorDetails: JsonType; - let responseCallback: (payload: JsonType, requestPayload: JsonType) => void; - let errorCallback: (error: OCPPError, requestStatistic?: boolean) => void; + let responseCallback: ResponseCallback; + let errorCallback: ErrorCallback; let requestCommandName: RequestCommand | IncomingRequestCommand; let requestPayload: JsonType; let cachedRequest: CachedRequest; @@ -1427,7 +1464,7 @@ export default class ChargingStation { // Incoming Message case MessageType.CALL_MESSAGE: [, , commandName, commandPayload] = request as IncomingRequest; - if (this.getEnableStatistics()) { + if (this.getEnableStatistics() === true) { this.performanceStatistics.addRequestStatistic(commandName, messageType); } logger.debug( @@ -1446,7 +1483,7 @@ export default class ChargingStation { // Outcome Message case MessageType.CALL_RESULT_MESSAGE: [, , commandPayload] = request as Response; - if (!this.requests.has(messageId)) { + if (this.requests.has(messageId) === false) { // Error throw new OCPPError( ErrorType.INTERNAL_ERROR, @@ -1458,7 +1495,7 @@ export default class ChargingStation { // Respond cachedRequest = this.requests.get(messageId); if (Array.isArray(cachedRequest) === true) { - [responseCallback, , requestCommandName, requestPayload] = cachedRequest; + [responseCallback, errorCallback, requestCommandName, requestPayload] = cachedRequest; } else { throw new OCPPError( ErrorType.PROTOCOL_ERROR, @@ -1469,7 +1506,7 @@ export default class ChargingStation { } logger.debug( `${this.logPrefix()} << Command '${ - requestCommandName ?? 'unknown' + requestCommandName ?? Constants.UNKNOWN_COMMAND }' received response payload: ${JSON.stringify(request)}` ); responseCallback(commandPayload, requestPayload); @@ -1477,7 +1514,7 @@ export default class ChargingStation { // Error Message case MessageType.CALL_ERROR_MESSAGE: [, , errorType, errorMessage, errorDetails] = request as ErrorResponse; - if (!this.requests.has(messageId)) { + if (this.requests.has(messageId) === false) { // Error throw new OCPPError( ErrorType.INTERNAL_ERROR, @@ -1499,7 +1536,7 @@ export default class ChargingStation { } logger.debug( `${this.logPrefix()} << Command '${ - requestCommandName ?? 'unknown' + requestCommandName ?? Constants.UNKNOWN_COMMAND }' received error payload: ${JSON.stringify(request)}` ); errorCallback(new OCPPError(errorType, errorMessage, requestCommandName, errorDetails)); @@ -1514,35 +1551,50 @@ export default class ChargingStation { parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this)); } else { throw new OCPPError(ErrorType.PROTOCOL_ERROR, 'Incoming message is not an array', null, { - payload: request, + request, }); } } catch (error) { // Log logger.error( `${this.logPrefix()} Incoming OCPP command '${ - commandName ?? requestCommandName ?? null - }' message '${data.toString()}' matching cached request '${JSON.stringify( - this.requests.get(messageId) - )}' processing error:`, + commandName ?? requestCommandName ?? Constants.UNKNOWN_COMMAND + }' message '${data.toString()}'${ + messageType !== MessageType.CALL_MESSAGE + ? ` matching cached request '${JSON.stringify(this.requests.get(messageId))}'` + : '' + } processing error:`, error ); - if (!(error instanceof OCPPError)) { + if (error instanceof OCPPError === false) { logger.warn( `${this.logPrefix()} Error thrown at incoming OCPP command '${ - commandName ?? requestCommandName ?? null + commandName ?? requestCommandName ?? Constants.UNKNOWN_COMMAND }' message '${data.toString()}' handling is not an OCPPError:`, error ); } - // Send error - messageType === MessageType.CALL_MESSAGE && - (await this.ocppRequestService.sendError( - this, - messageId, - error as OCPPError, - commandName ?? requestCommandName ?? null - )); + switch (messageType) { + case MessageType.CALL_MESSAGE: + // Send error + await this.ocppRequestService.sendError( + this, + messageId, + error as OCPPError, + commandName ?? requestCommandName ?? null + ); + break; + case MessageType.CALL_RESULT_MESSAGE: + case MessageType.CALL_ERROR_MESSAGE: + if (errorCallback) { + // 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; + } } } @@ -1563,7 +1615,7 @@ export default class ChargingStation { connectorStatus: ConnectorStatus, meterStop = false ): number { - if (this.getMeteringPerTransaction()) { + if (this.getMeteringPerTransaction() === true) { return ( (meterStop === true ? Math.round(connectorStatus?.transactionEnergyActiveImportRegisterValue) @@ -1577,7 +1629,7 @@ export default class ChargingStation { ); } - private getUseConnectorId0(stationInfo?: ChargingStationInfo): boolean | undefined { + private getUseConnectorId0(stationInfo?: ChargingStationInfo): boolean { const localStationInfo = stationInfo ?? this.stationInfo; return !Utils.isUndefined(localStationInfo.useConnectorId0) ? localStationInfo.useConnectorId0 @@ -1603,7 +1655,7 @@ export default class ChargingStation { } // 0 for disabling - private getConnectionTimeout(): number | undefined { + private getConnectionTimeout(): number { if ( ChargingStationConfigurationUtils.getConfigurationKey( this, @@ -1623,7 +1675,7 @@ export default class ChargingStation { } // -1 for unlimited, 0 for disabling - private getAutoReconnectMaxRetries(): number | undefined { + private getAutoReconnectMaxRetries(): number { if (!Utils.isUndefined(this.stationInfo.autoReconnectMaxRetries)) { return this.stationInfo.autoReconnectMaxRetries; } @@ -1634,7 +1686,7 @@ export default class ChargingStation { } // 0 for disabling - private getRegistrationMaxRetries(): number | undefined { + private getRegistrationMaxRetries(): number { if (!Utils.isUndefined(this.stationInfo.registrationMaxRetries)) { return this.stationInfo.registrationMaxRetries; } @@ -1728,7 +1780,7 @@ export default class ChargingStation { logger.error( `${this.logPrefix()} Charging profile id ${ matchingChargingProfile.chargingProfileId - } limit is greater than connector id ${connectorId} maximum, dump charging profiles' stack: %j`, + } limit ${limit} is greater than connector id ${connectorId} maximum ${connectorMaximumPower}, dump charging profiles' stack: %j`, this.getConnectorStatus(connectorId).chargingProfiles ); limit = connectorMaximumPower; @@ -1739,7 +1791,7 @@ export default class ChargingStation { } private async startMessageSequence(): Promise { - if (this.stationInfo?.autoRegister) { + if (this.stationInfo?.autoRegister === true) { await this.ocppRequestService.requestHandler< BootNotificationRequest, BootNotificationResponse @@ -1753,67 +1805,43 @@ export default class ChargingStation { this.startHeartbeat(); // Initialize connectors status for (const connectorId of this.connectors.keys()) { + let chargePointStatus: ChargePointStatus; if (connectorId === 0) { continue; } else if ( - this.started === true && !this.getConnectorStatus(connectorId)?.status && - this.getConnectorStatus(connectorId)?.bootStatus + (this.isChargingStationAvailable() === false || + this.isConnectorAvailable(connectorId) === false) ) { - // Send status in template at startup - await this.ocppRequestService.requestHandler< - StatusNotificationRequest, - StatusNotificationResponse - >(this, RequestCommand.STATUS_NOTIFICATION, { - connectorId, - status: this.getConnectorStatus(connectorId).bootStatus, - errorCode: ChargePointErrorCode.NO_ERROR, - }); - this.getConnectorStatus(connectorId).status = - this.getConnectorStatus(connectorId).bootStatus; + chargePointStatus = ChargePointStatus.UNAVAILABLE; } else if ( - this.started === false && - this.getConnectorStatus(connectorId)?.status && + !this.getConnectorStatus(connectorId)?.status && this.getConnectorStatus(connectorId)?.bootStatus ) { - // Send status in template after reset - await this.ocppRequestService.requestHandler< - StatusNotificationRequest, - StatusNotificationResponse - >(this, RequestCommand.STATUS_NOTIFICATION, { - connectorId, - status: this.getConnectorStatus(connectorId).bootStatus, - errorCode: ChargePointErrorCode.NO_ERROR, - }); - this.getConnectorStatus(connectorId).status = - this.getConnectorStatus(connectorId).bootStatus; - } else if (this.started === true && this.getConnectorStatus(connectorId)?.status) { - // Send previous status at template reload - await this.ocppRequestService.requestHandler< - StatusNotificationRequest, - StatusNotificationResponse - >(this, RequestCommand.STATUS_NOTIFICATION, { - connectorId, - status: this.getConnectorStatus(connectorId).status, - errorCode: ChargePointErrorCode.NO_ERROR, - }); + // Set boot status in template at startup + chargePointStatus = this.getConnectorStatus(connectorId).bootStatus; + } else if (this.getConnectorStatus(connectorId)?.status) { + // Set previous status at startup + chargePointStatus = this.getConnectorStatus(connectorId).status; } else { - // Send default status - await this.ocppRequestService.requestHandler< - StatusNotificationRequest, - StatusNotificationResponse - >(this, RequestCommand.STATUS_NOTIFICATION, { - connectorId, - status: ChargePointStatus.AVAILABLE, - errorCode: ChargePointErrorCode.NO_ERROR, - }); - this.getConnectorStatus(connectorId).status = ChargePointStatus.AVAILABLE; + // Set default status + chargePointStatus = ChargePointStatus.AVAILABLE; } + await this.ocppRequestService.requestHandler< + StatusNotificationRequest, + StatusNotificationResponse + >(this, RequestCommand.STATUS_NOTIFICATION, { + connectorId, + status: chargePointStatus, + errorCode: ChargePointErrorCode.NO_ERROR, + }); + this.getConnectorStatus(connectorId).status = chargePointStatus; } // Start the ATG if (this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable === true) { this.startAutomaticTransactionGenerator(); } + this.wsConnectionRestarted === true && this.flushMessageBuffer(); } private async stopMessageSequence( @@ -1829,6 +1857,19 @@ export default class ChargingStation { } else { await this.stopRunningTransactions(reason); } + for (const connectorId of this.connectors.keys()) { + if (connectorId > 0) { + await this.ocppRequestService.requestHandler< + StatusNotificationRequest, + StatusNotificationResponse + >(this, RequestCommand.STATUS_NOTIFICATION, { + connectorId, + status: ChargePointStatus.UNAVAILABLE, + errorCode: ChargePointErrorCode.NO_ERROR, + }); + this.getConnectorStatus(connectorId).status = null; + } + } } private startWebSocketPing(): void { @@ -1845,10 +1886,8 @@ export default class ChargingStation { : 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( @@ -1859,9 +1898,8 @@ export default class ChargingStation { } else if (this.webSocketPingSetInterval) { logger.info( this.logPrefix() + - ' WebSocket ping every ' + - Utils.formatDurationSeconds(webSocketPingInterval) + - ' already started' + ' WebSocket ping already started every ' + + Utils.formatDurationSeconds(webSocketPingInterval) ); } else { logger.error( @@ -1881,43 +1919,36 @@ export default class ChargingStation { } private getConfiguredSupervisionUrl(): URL { - const supervisionUrls = Utils.cloneObject( - this.stationInfo.supervisionUrls ?? Configuration.getSupervisionUrls() - ); + const supervisionUrls = this.stationInfo.supervisionUrls ?? Configuration.getSupervisionUrls(); if (!Utils.isEmptyArray(supervisionUrls)) { - let urlIndex = 0; switch (Configuration.getSupervisionUrlDistribution()) { case SupervisionUrlDistribution.ROUND_ROBIN: - urlIndex = (this.index - 1) % supervisionUrls.length; + // FIXME + this.configuredSupervisionUrlIndex = (this.index - 1) % supervisionUrls.length; break; case SupervisionUrlDistribution.RANDOM: - // Get a random url - urlIndex = Math.floor(Utils.secureRandom() * supervisionUrls.length); + this.configuredSupervisionUrlIndex = 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` - ); - } + case SupervisionUrlDistribution.CHARGING_STATION_AFFINITY: + this.configuredSupervisionUrlIndex = (this.index - 1) % supervisionUrls.length; break; default: logger.error( `${this.logPrefix()} Unknown supervision url distribution '${Configuration.getSupervisionUrlDistribution()}' from values '${SupervisionUrlDistribution.toString()}', defaulting to ${ - SupervisionUrlDistribution.ROUND_ROBIN + SupervisionUrlDistribution.CHARGING_STATION_AFFINITY }` ); - urlIndex = (this.index - 1) % supervisionUrls.length; + this.configuredSupervisionUrlIndex = (this.index - 1) % supervisionUrls.length; break; } - return new URL(supervisionUrls[urlIndex]); + return new URL(supervisionUrls[this.configuredSupervisionUrlIndex]); } return new URL(supervisionUrls as string); } - private getHeartbeatInterval(): number | undefined { + private getHeartbeatInterval(): number { const HeartbeatInterval = ChargingStationConfigurationUtils.getConfigurationKey( this, StandardParametersKey.HeartbeatInterval @@ -1932,7 +1963,7 @@ export default class ChargingStation { if (HeartBeatInterval) { return Utils.convertToInt(HeartBeatInterval.value) * 1000; } - !this.stationInfo?.autoRegister && + this.stationInfo?.autoRegister === false && logger.warn( `${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${ Constants.DEFAULT_HEARTBEAT_INTERVAL @@ -1948,7 +1979,7 @@ export default class ChargingStation { } private terminateWSConnection(): void { - if (this.isWebSocketConnectionOpened()) { + if (this.isWebSocketConnectionOpened() === true) { this.wsConnection.terminate(); this.wsConnection = null; } @@ -1960,13 +1991,13 @@ export default class ChargingStation { } } - private getReconnectExponentialDelay(): boolean | undefined { + private getReconnectExponentialDelay(): boolean { return !Utils.isUndefined(this.stationInfo.reconnectExponentialDelay) ? this.stationInfo.reconnectExponentialDelay : false; } - private async reconnect(code: number): Promise { + private async reconnect(): Promise { // Stop WebSocket ping this.stopWebSocketPing(); // Stop heartbeat @@ -1989,16 +2020,14 @@ export default class ChargingStation { ? 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 }, @@ -2007,9 +2036,9 @@ export default class ChargingStation { 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()})` ); } }