X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FChargingStation.ts;h=84aa81ca649336eda64779744c87600ac5d9a098;hb=81533a206ec56709897f27edf1298e7c86d74c31;hp=7b98ed35858bd4c524cccb1af9222c0100e3922b;hpb=ed6cfcff3ef6596cdf76c68f600effcb25dece72;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ChargingStation.ts b/src/charging-station/ChargingStation.ts index 7b98ed35..84aa81ca 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,7 @@ 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'; @@ -40,28 +40,33 @@ 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,6 +85,9 @@ 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'; @@ -89,6 +97,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 +110,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 +173,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 +201,7 @@ export default class ChargingStation { return this?.wsConnection?.readyState === WebSocket.OPEN; } - public getRegistrationStatus(): RegistrationStatus { + public getRegistrationStatus(): RegistrationStatusEnumType { return this?.bootNotificationResponse?.status; } @@ -204,15 +210,15 @@ 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 { @@ -479,7 +485,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(); @@ -507,7 +513,7 @@ export default class ChargingStation { ) { this.startAutomaticTransactionGenerator(); } - if (this.getEnableStatistics()) { + if (this.getEnableStatistics() === true) { this.performanceStatistics.restart(); } else { this.performanceStatistics.stop(); @@ -539,7 +545,7 @@ export default class ChargingStation { this.stopping = true; await this.stopMessageSequence(reason); this.closeWSConnection(); - if (this.getEnableStatistics()) { + if (this.getEnableStatistics() === true) { this.performanceStatistics.stop(); } this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash); @@ -606,6 +612,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) @@ -618,13 +630,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; } @@ -707,9 +722,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( @@ -788,7 +803,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); } @@ -832,6 +847,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; @@ -929,7 +956,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, @@ -951,17 +978,37 @@ 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 match = this.stationInfo.firmwareVersion + .match(new RegExp(this.stationInfo.firmwareVersionPattern)) + .slice(1, this.stationInfo.firmwareVersion.split('.').length + 1); + const patchLevelIndex = match.length - 1; + match[patchLevelIndex] = (Utils.convertToInt(match[patchLevelIndex]) + 1).toString(); + this.stationInfo.firmwareVersion = match.join('.'); + } } private initializeOcppConfiguration(): void { @@ -1199,10 +1246,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); } @@ -1308,7 +1362,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; } @@ -1354,7 +1408,7 @@ export default class ChargingStation { ); } if (this.isRegistered() === true) { - if (this.isInAcceptedState()) { + if (this.isInAcceptedState() === true) { await this.startMessageSequence(); } } else { @@ -1372,7 +1426,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: @@ -1380,7 +1434,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; @@ -1389,7 +1443,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; @@ -1397,7 +1451,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; @@ -1405,8 +1459,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; @@ -1736,7 +1790,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; @@ -1793,6 +1847,16 @@ export default class ChargingStation { }); this.getConnectorStatus(connectorId).status = chargePointStatus; } + if (this.stationInfo?.firmwareStatus === FirmwareStatus.Installing) { + await this.ocppRequestService.requestHandler< + FirmwareStatusNotificationRequest, + FirmwareStatusNotificationResponse + >(this, RequestCommand.FIRMWARE_STATUS_NOTIFICATION, { + status: FirmwareStatus.Installed, + }); + this.stationInfo.firmwareStatus = FirmwareStatus.Installed; + } + // Start the ATG if (this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable === true) { this.startAutomaticTransactionGenerator(); @@ -1843,9 +1907,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( @@ -1877,9 +1939,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: