X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FChargingStation.ts;h=a7a41dddcbf6dbf30a4487c0f925e54dfc1f8b25;hb=5d280aae12d6ad7367136421c8e2414a676d2c1a;hp=7078641b8837edfa55e13495b108dd0473c4de6f;hpb=b7f9e41d245e224e1a1a47010803960766dbec61;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ChargingStation.ts b/src/charging-station/ChargingStation.ts index 7078641b..a7a41ddd 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,7 +6,8 @@ import path from 'path'; import { URL } from 'url'; import { parentPort } from 'worker_threads'; -import WebSocket, { Data, RawData } from 'ws'; +import merge from 'just-merge'; +import WebSocket, { type RawData } from 'ws'; import BaseError from '../exception/BaseError'; import OCPPError from '../exception/OCPPError'; @@ -18,6 +19,7 @@ import type { ChargingStationOcppConfiguration } from '../types/ChargingStationO import { type ChargingStationTemplate, CurrentType, + type FirmwareUpgrade, PowerUnits, type WsOptions, } from '../types/ChargingStationTemplate'; @@ -25,8 +27,6 @@ import { SupervisionUrlDistribution } from '../types/ConfigurationData'; import type { ConnectorStatus } from '../types/ConnectorStatus'; import { FileType } from '../types/FileType'; import type { JsonType } from '../types/JsonType'; -import { ChargePointErrorCode } from '../types/ocpp/ChargePointErrorCode'; -import { ChargePointStatus } from '../types/ocpp/ChargePointStatus'; import { ChargingProfile, ChargingRateUnitType } from '../types/ocpp/ChargingProfile'; import { ConnectorPhaseRotation, @@ -34,34 +34,40 @@ import { SupportedFeatureProfiles, VendorDefaultParametersKey, } from '../types/ocpp/Configuration'; +import { ConnectorStatusEnum } from '../types/ocpp/ConnectorStatusEnum'; import { ErrorType } from '../types/ocpp/ErrorType'; import { MessageType } from '../types/ocpp/MessageType'; 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, + FirmwareStatus, + type FirmwareStatusNotificationRequest, + 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 FirmwareStatusNotificationResponse, + 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'; @@ -80,8 +86,12 @@ 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 { OCPPServiceUtils } from './ocpp/OCPPServiceUtils'; import SharedLRUCache from './SharedLRUCache'; export default class ChargingStation { @@ -89,6 +99,7 @@ export default class ChargingStation { public readonly templateFile: string; public stationInfo!: ChargingStationInfo; public started: boolean; + public starting: boolean; public authorizedTagsCache: AuthorizedTagsCache; public automaticTransactionGenerator!: AutomaticTransactionGenerator; public ocppConfiguration!: ChargingStationOcppConfiguration; @@ -101,7 +112,6 @@ export default class ChargingStation { public bootNotificationRequest!: BootNotificationRequest; public bootNotificationResponse!: BootNotificationResponse | null; public powerDivider!: number; - private starting: boolean; private stopping: boolean; private configurationFile!: string; private configurationFileHash!: string; @@ -165,17 +175,15 @@ export default class ChargingStation { ); } - public getEnableStatistics(): boolean | undefined { - return !Utils.isUndefined(this.stationInfo.enableStatistics) - ? this.stationInfo.enableStatistics - : true; + public getEnableStatistics(): boolean { + return this.stationInfo.enableStatistics ?? false; } - public getMustAuthorizeAtRemoteStart(): boolean | undefined { + public getMustAuthorizeAtRemoteStart(): boolean { return this.stationInfo.mustAuthorizeAtRemoteStart ?? true; } - public getPayloadSchemaValidation(): boolean | undefined { + public getPayloadSchemaValidation(): boolean { return this.stationInfo.payloadSchemaValidation ?? true; } @@ -195,7 +203,7 @@ export default class ChargingStation { return this?.wsConnection?.readyState === WebSocket.OPEN; } - public getRegistrationStatus(): RegistrationStatus { + public getRegistrationStatus(): RegistrationStatusEnumType { return this?.bootNotificationResponse?.status; } @@ -204,19 +212,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 { @@ -476,7 +487,7 @@ export default class ChargingStation { if (this.started === false) { if (this.starting === false) { this.starting = true; - if (this.getEnableStatistics()) { + if (this.getEnableStatistics() === true) { this.performanceStatistics.start(); } this.openWSConnection(); @@ -504,7 +515,7 @@ export default class ChargingStation { ) { this.startAutomaticTransactionGenerator(); } - if (this.getEnableStatistics()) { + if (this.getEnableStatistics() === true) { this.performanceStatistics.restart(); } else { this.performanceStatistics.stop(); @@ -536,8 +547,7 @@ export default class ChargingStation { this.stopping = true; await this.stopMessageSequence(reason); this.closeWSConnection(); - this.wsConnectionRestarted = false; - if (this.getEnableStatistics()) { + if (this.getEnableStatistics() === true) { this.performanceStatistics.stop(); } this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash); @@ -555,6 +565,15 @@ export default class ChargingStation { } } + public getFirmwareUpgrade(): FirmwareUpgrade { + return merge( + { + reset: true, + }, + this.stationInfo.firmwareUpgrade + ); + } + public async reset(reason?: StopTransactionReason): Promise { await this.stop(reason); await Utils.sleep(this.stationInfo.resetTime); @@ -604,6 +623,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) @@ -616,13 +641,16 @@ 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; } @@ -705,9 +733,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( @@ -786,7 +814,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); } @@ -830,6 +858,18 @@ export default class ChargingStation { ? stationTemplate.power * 1000 : stationTemplate.power; } + stationInfo.firmwareVersionPattern = + stationTemplate.firmwareVersionPattern ?? Constants.SEMVER_PATTERN; + if ( + stationInfo.firmwareVersion && + new RegExp(stationInfo.firmwareVersionPattern).test(stationInfo.firmwareVersion) === false + ) { + logger.warn( + `${this.logPrefix()} Firmware version '${stationInfo.firmwareVersion}' in template file ${ + this.templateFile + } does not match firmware version pattern '${stationInfo.firmwareVersionPattern}'` + ); + } stationInfo.resetTime = stationTemplate.resetTime ? stationTemplate.resetTime * 1000 : Constants.CHARGING_STATION_DEFAULT_RESET_TIME; @@ -927,7 +967,7 @@ export default class ChargingStation { // Avoid duplication of connectors related information in RAM this.stationInfo?.Connectors && delete this.stationInfo.Connectors; this.configuredSupervisionUrl = this.getConfiguredSupervisionUrl(); - if (this.getEnableStatistics()) { + if (this.getEnableStatistics() === true) { this.performanceStatistics = PerformanceStatistics.getInstance( this.stationInfo.hashId, this.stationInfo.chargingStationId, @@ -949,17 +989,43 @@ 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 === true) { this.bootNotificationResponse = { - currentTime: new Date().toISOString(), + currentTime: new Date(), interval: this.getHeartbeatInterval() / 1000, - status: RegistrationStatus.ACCEPTED, + status: RegistrationStatusEnumType.ACCEPTED, }; } + if ( + this.stationInfo.firmwareStatus === FirmwareStatus.Installing && + this.stationInfo.firmwareVersion && + this.stationInfo.firmwareVersionPattern + ) { + const versionStep = this.getFirmwareUpgrade()?.versionUpgrade?.step ?? 1; + const patternGroup: number = + this.getFirmwareUpgrade()?.versionUpgrade?.patternGroup ?? + this.stationInfo.firmwareVersion.split('.').length; + const match = this.stationInfo.firmwareVersion + .match(new RegExp(this.stationInfo.firmwareVersionPattern)) + .slice(1, patternGroup + 1); + const patchLevelIndex = match.length - 1; + match[patchLevelIndex] = ( + Utils.convertToInt(match[patchLevelIndex]) + versionStep + ).toString(); + this.stationInfo.firmwareVersion = match.join('.'); + } } private initializeOcppConfiguration(): void { @@ -1197,10 +1263,17 @@ 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); } @@ -1306,7 +1379,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; } @@ -1327,7 +1400,7 @@ export default class ChargingStation { 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 { @@ -1337,7 +1410,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 @@ -1346,13 +1419,13 @@ 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(); } } else { @@ -1370,7 +1443,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: @@ -1378,7 +1451,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; @@ -1387,7 +1460,7 @@ export default class ChargingStation { logger.error( `${this.logPrefix()} WebSocket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString( code - )}' and reason '${reason}'` + )}' and reason '${reason.toString()}'` ); this.started === true && (await this.reconnect()); break; @@ -1395,7 +1468,7 @@ export default class ChargingStation { 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; @@ -1403,8 +1476,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; @@ -1734,7 +1807,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; @@ -1759,39 +1832,48 @@ export default class ChargingStation { this.startHeartbeat(); // Initialize connectors status for (const connectorId of this.connectors.keys()) { - let chargePointStatus: ChargePointStatus; + let connectorStatus: ConnectorStatusEnum; if (connectorId === 0) { continue; } else if ( !this.getConnectorStatus(connectorId)?.status && (this.isChargingStationAvailable() === false || - (this.isChargingStationAvailable() === true && - this.isConnectorAvailable(connectorId) === false)) + this.isConnectorAvailable(connectorId) === false) ) { - chargePointStatus = ChargePointStatus.UNAVAILABLE; + connectorStatus = ConnectorStatusEnum.UNAVAILABLE; } else if ( !this.getConnectorStatus(connectorId)?.status && this.getConnectorStatus(connectorId)?.bootStatus ) { // Set boot status in template at startup - chargePointStatus = this.getConnectorStatus(connectorId).bootStatus; + connectorStatus = this.getConnectorStatus(connectorId).bootStatus; } else if (this.getConnectorStatus(connectorId)?.status) { // Set previous status at startup - chargePointStatus = this.getConnectorStatus(connectorId).status; + connectorStatus = this.getConnectorStatus(connectorId).status; } else { // Set default status - chargePointStatus = ChargePointStatus.AVAILABLE; + connectorStatus = ConnectorStatusEnum.AVAILABLE; } await this.ocppRequestService.requestHandler< StatusNotificationRequest, StatusNotificationResponse - >(this, RequestCommand.STATUS_NOTIFICATION, { - connectorId, - status: chargePointStatus, - errorCode: ChargePointErrorCode.NO_ERROR, + >( + this, + RequestCommand.STATUS_NOTIFICATION, + OCPPServiceUtils.buildStatusNotificationRequest(this, connectorId, connectorStatus) + ); + this.getConnectorStatus(connectorId).status = connectorStatus; + } + if (this.stationInfo?.firmwareStatus === FirmwareStatus.Installing) { + await this.ocppRequestService.requestHandler< + FirmwareStatusNotificationRequest, + FirmwareStatusNotificationResponse + >(this, RequestCommand.FIRMWARE_STATUS_NOTIFICATION, { + status: FirmwareStatus.Installed, }); - this.getConnectorStatus(connectorId).status = chargePointStatus; + this.stationInfo.firmwareStatus = FirmwareStatus.Installed; } + // Start the ATG if (this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable === true) { this.startAutomaticTransactionGenerator(); @@ -1817,11 +1899,15 @@ export default class ChargingStation { await this.ocppRequestService.requestHandler< StatusNotificationRequest, StatusNotificationResponse - >(this, RequestCommand.STATUS_NOTIFICATION, { - connectorId, - status: ChargePointStatus.UNAVAILABLE, - errorCode: ChargePointErrorCode.NO_ERROR, - }); + >( + this, + RequestCommand.STATUS_NOTIFICATION, + OCPPServiceUtils.buildStatusNotificationRequest( + this, + connectorId, + ConnectorStatusEnum.UNAVAILABLE + ) + ); this.getConnectorStatus(connectorId).status = null; } } @@ -1842,9 +1928,7 @@ export default class ChargingStation { if (webSocketPingInterval > 0 && !this.webSocketPingSetInterval) { this.webSocketPingSetInterval = setInterval(() => { if (this.isWebSocketConnectionOpened() === true) { - this.wsConnection.ping((): void => { - /* This is intentional */ - }); + this.wsConnection.ping(); } }, webSocketPingInterval * 1000); logger.info( @@ -1855,9 +1939,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( @@ -1877,9 +1960,7 @@ 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)) { switch (Configuration.getSupervisionUrlDistribution()) { case SupervisionUrlDistribution.ROUND_ROBIN: @@ -1980,16 +2061,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 }, @@ -1998,9 +2077,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()})` ); } }