X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FChargingStation.ts;h=4ed4e600a9cd412e5f4335b648481d71a605b8a9;hb=df637b0d406ee9e6f158ee0c7c4caed7ac25ecbb;hp=f283c50da4e4549d3364074cc6eaea88fa1e6f6d;hpb=ccb1d6e97cc0248cd96a9505cf5e8f037d66984c;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ChargingStation.ts b/src/charging-station/ChargingStation.ts index f283c50d..4ed4e600 100644 --- a/src/charging-station/ChargingStation.ts +++ b/src/charging-station/ChargingStation.ts @@ -1,6 +1,42 @@ // Partial Copyright Jerome Benoit. 2021. All Rights Reserved. -import { ACElectricUtils, DCElectricUtils } from '../utils/ElectricUtils'; +import crypto from 'crypto'; +import fs from 'fs'; +import path from 'path'; +import { URL } from 'url'; +import { parentPort } from 'worker_threads'; + +import WebSocket, { Data, RawData } from 'ws'; + +import BaseError from '../exception/BaseError'; +import OCPPError from '../exception/OCPPError'; +import PerformanceStatistics from '../performance/PerformanceStatistics'; +import { AutomaticTransactionGeneratorConfiguration } from '../types/AutomaticTransactionGenerator'; +import ChargingStationConfiguration from '../types/ChargingStationConfiguration'; +import ChargingStationInfo from '../types/ChargingStationInfo'; +import ChargingStationOcppConfiguration from '../types/ChargingStationOcppConfiguration'; +import ChargingStationTemplate, { + CurrentType, + PowerUnits, + WsOptions, +} from '../types/ChargingStationTemplate'; +import { SupervisionUrlDistribution } from '../types/ConfigurationData'; +import { ConnectorStatus } from '../types/ConnectorStatus'; +import { FileType } from '../types/FileType'; +import { 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, + StandardParametersKey, + SupportedFeatureProfiles, + VendorDefaultParametersKey, +} from '../types/ocpp/Configuration'; +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, @@ -21,68 +57,38 @@ import { Response, StatusNotificationResponse, } from '../types/ocpp/Responses'; -import { ChargingProfile, ChargingRateUnitType } from '../types/ocpp/ChargingProfile'; -import ChargingStationConfiguration, { Section } from '../types/ChargingStationConfiguration'; -import ChargingStationTemplate, { - CurrentType, - PowerUnits, - WsOptions, -} from '../types/ChargingStationTemplate'; -import { - ConnectorPhaseRotation, - StandardParametersKey, - SupportedFeatureProfiles, - VendorDefaultParametersKey, -} from '../types/ocpp/Configuration'; -import { MeterValue, MeterValueMeasurand } from '../types/ocpp/MeterValues'; import { StopTransactionReason, StopTransactionRequest, StopTransactionResponse, } from '../types/ocpp/Transaction'; import { WSError, WebSocketCloseEventStatusCode } from '../types/WebSocket'; -import WebSocket, { Data, OPEN, RawData } from 'ws'; - -import AutomaticTransactionGenerator from './AutomaticTransactionGenerator'; -import BaseError from '../exception/BaseError'; -import { ChargePointErrorCode } from '../types/ocpp/ChargePointErrorCode'; -import { ChargePointStatus } from '../types/ocpp/ChargePointStatus'; -import { ChargingStationConfigurationUtils } from './ChargingStationConfigurationUtils'; -import ChargingStationInfo from '../types/ChargingStationInfo'; -import ChargingStationOcppConfiguration from '../types/ChargingStationOcppConfiguration'; -import { ChargingStationUtils } from './ChargingStationUtils'; -import { ChargingStationWorkerMessageEvents } from '../types/ChargingStationWorker'; import Configuration from '../utils/Configuration'; -import { ConnectorStatus } from '../types/ConnectorStatus'; import Constants from '../utils/Constants'; -import { ErrorType } from '../types/ocpp/ErrorType'; -import { FileType } from '../types/FileType'; +import { ACElectricUtils, DCElectricUtils } from '../utils/ElectricUtils'; import FileUtils from '../utils/FileUtils'; -import { JsonType } from '../types/JsonType'; -import { MessageType } from '../types/ocpp/MessageType'; +import logger from '../utils/Logger'; +import Utils from '../utils/Utils'; +import AuthorizedTagsCache from './AuthorizedTagsCache'; +import AutomaticTransactionGenerator from './AutomaticTransactionGenerator'; +import { ChargingStationConfigurationUtils } from './ChargingStationConfigurationUtils'; +import { ChargingStationUtils } from './ChargingStationUtils'; +import ChargingStationWorkerBroadcastChannel from './ChargingStationWorkerBroadcastChannel'; +import { MessageChannelUtils } from './MessageChannelUtils'; import OCPP16IncomingRequestService from './ocpp/1.6/OCPP16IncomingRequestService'; import OCPP16RequestService from './ocpp/1.6/OCPP16RequestService'; import OCPP16ResponseService from './ocpp/1.6/OCPP16ResponseService'; import { OCPP16ServiceUtils } from './ocpp/1.6/OCPP16ServiceUtils'; -import OCPPError from '../exception/OCPPError'; import OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService'; import OCPPRequestService from './ocpp/OCPPRequestService'; -import { OCPPVersion } from '../types/ocpp/OCPPVersion'; -import PerformanceStatistics from '../performance/PerformanceStatistics'; -import { SupervisionUrlDistribution } from '../types/ConfigurationData'; -import { URL } from 'url'; -import Utils from '../utils/Utils'; -import crypto from 'crypto'; -import fs from 'fs'; -import logger from '../utils/Logger'; -import { parentPort } from 'worker_threads'; -import path from 'path'; +import SharedLRUCache from './SharedLRUCache'; export default class ChargingStation { public hashId!: string; public readonly templateFile: string; - public authorizedTags: string[]; + public authorizedTagsCache: AuthorizedTagsCache; public stationInfo!: ChargingStationInfo; + public stopped: boolean; public readonly connectors: Map; public ocppConfiguration!: ChargingStationOcppConfiguration; public wsConnection!: WebSocket; @@ -91,18 +97,22 @@ export default class ChargingStation { public heartbeatSetInterval!: NodeJS.Timeout; public ocppRequestService!: OCPPRequestService; public bootNotificationResponse!: BootNotificationResponse | null; + public powerDivider!: number; private readonly index: number; private configurationFile!: string; + private configurationFileHash!: string; private bootNotificationRequest!: BootNotificationRequest; private connectorsConfigurationHash!: string; private ocppIncomingRequestService!: OCPPIncomingRequestService; private readonly messageBuffer: Set; - private wsConfiguredConnectionUrl!: URL; + private configuredSupervisionUrl!: URL; private wsConnectionRestarted: boolean; - private stopped: boolean; private autoReconnectRetryCount: number; + private templateFileWatcher!: fs.FSWatcher; + private readonly sharedLRUCache: SharedLRUCache; private automaticTransactionGenerator!: AutomaticTransactionGenerator; private webSocketPingSetInterval!: NodeJS.Timeout; + private readonly chargingStationWorkerBroadcastChannel: ChargingStationWorkerBroadcastChannel; constructor(index: number, templateFile: string) { this.index = index; @@ -110,24 +120,27 @@ export default class ChargingStation { this.stopped = false; this.wsConnectionRestarted = false; this.autoReconnectRetryCount = 0; + this.sharedLRUCache = SharedLRUCache.getInstance(); + this.authorizedTagsCache = AuthorizedTagsCache.getInstance(); this.connectors = new Map(); this.requests = new Map(); this.messageBuffer = new Set(); + this.chargingStationWorkerBroadcastChannel = new ChargingStationWorkerBroadcastChannel(this); + this.initialize(); - this.authorizedTags = this.getAuthorizedTags(); } private get wsConnectionUrl(): URL { - return this.getSupervisionUrlOcppConfiguration() - ? new URL( - ChargingStationConfigurationUtils.getConfigurationKey( + return new URL( + (this.getSupervisionUrlOcppConfiguration() + ? ChargingStationConfigurationUtils.getConfigurationKey( this, this.getSupervisionUrlOcppKey() - ).value + - '/' + - this.stationInfo.chargingStationId - ) - : this.wsConfiguredConnectionUrl; + ).value + : this.configuredSupervisionUrl.href) + + '/' + + this.stationInfo.chargingStationId + ); } public logPrefix(): string { @@ -144,12 +157,19 @@ export default class ChargingStation { } public getRandomIdTag(): string { - const index = Math.floor(Utils.secureRandom() * this.authorizedTags.length); - return this.authorizedTags[index]; + 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.authorizedTags); + return !Utils.isEmptyArray( + this.authorizedTagsCache.getAuthorizedTags( + ChargingStationUtils.getAuthorizationFile(this.stationInfo) + ) + ); } public getEnableStatistics(): boolean | undefined { @@ -162,11 +182,16 @@ export default class ChargingStation { return this.stationInfo.mayAuthorizeAtRemoteStart ?? true; } - public getNumberOfPhases(): number | undefined { - switch (this.getCurrentOutType()) { + public getPayloadSchemaValidation(): boolean | undefined { + return this.stationInfo.payloadSchemaValidation ?? true; + } + + public getNumberOfPhases(stationInfo?: ChargingStationInfo): number | undefined { + const localStationInfo: ChargingStationInfo = stationInfo ?? this.stationInfo; + switch (this.getCurrentOutType(stationInfo)) { case CurrentType.AC: - return !Utils.isUndefined(this.stationInfo.numberOfPhases) - ? this.stationInfo.numberOfPhases + return !Utils.isUndefined(localStationInfo.numberOfPhases) + ? localStationInfo.numberOfPhases : 3; case CurrentType.DC: return 0; @@ -174,7 +199,7 @@ export default class ChargingStation { } public isWebSocketConnectionOpened(): boolean { - return this?.wsConnection?.readyState === OPEN; + return this?.wsConnection?.readyState === WebSocket.OPEN; } public getRegistrationStatus(): RegistrationStatus { @@ -217,22 +242,23 @@ export default class ChargingStation { return this.connectors.get(id); } - public getCurrentOutType(): CurrentType | undefined { - return this.stationInfo.currentOutType ?? CurrentType.AC; + public getCurrentOutType(stationInfo?: ChargingStationInfo): CurrentType { + return (stationInfo ?? this.stationInfo).currentOutType ?? CurrentType.AC; } public getOcppStrictCompliance(): boolean { return this.stationInfo?.ocppStrictCompliance ?? false; } - public getVoltageOut(): number | undefined { + public getVoltageOut(stationInfo?: ChargingStationInfo): number | undefined { const defaultVoltageOut = ChargingStationUtils.getDefaultVoltageOut( - this.getCurrentOutType(), + this.getCurrentOutType(stationInfo), this.templateFile, this.logPrefix() ); - return !Utils.isUndefined(this.stationInfo.voltageOut) - ? this.stationInfo.voltageOut + const localStationInfo: ChargingStationInfo = stationInfo ?? this.stationInfo; + return !Utils.isUndefined(localStationInfo.voltageOut) + ? localStationInfo.voltageOut : defaultVoltageOut; } @@ -250,9 +276,9 @@ export default class ChargingStation { this.getAmperageLimitation() * this.getNumberOfConnectors() ) : DCElectricUtils.power(this.getVoltageOut(), this.getAmperageLimitation())) / - this.stationInfo.powerDivider; + this.powerDivider; } - const connectorMaximumPower = this.getMaximumPower() / this.stationInfo.powerDivider; + const connectorMaximumPower = this.getMaximumPower() / this.powerDivider; const connectorChargingProfilePowerLimit = this.getChargingProfilePowerLimit(connectorId); return Math.min( isNaN(connectorMaximumPower) ? Infinity : connectorMaximumPower, @@ -310,22 +336,22 @@ export default class ChargingStation { } } - public getEnergyActiveImportRegisterByTransactionId(transactionId: number): number | undefined { + public getEnergyActiveImportRegisterByTransactionId(transactionId: number): number { const transactionConnectorStatus = this.getConnectorStatus( this.getConnectorIdByTransactionId(transactionId) ); if (this.getMeteringPerTransaction()) { - return transactionConnectorStatus?.transactionEnergyActiveImportRegisterValue; + return transactionConnectorStatus?.transactionEnergyActiveImportRegisterValue ?? 0; } - return transactionConnectorStatus?.energyActiveImportRegisterValue; + return transactionConnectorStatus?.energyActiveImportRegisterValue ?? 0; } - public getEnergyActiveImportRegisterByConnectorId(connectorId: number): number | undefined { + public getEnergyActiveImportRegisterByConnectorId(connectorId: number): number { const connectorStatus = this.getConnectorStatus(connectorId); if (this.getMeteringPerTransaction()) { - return connectorStatus?.transactionEnergyActiveImportRegisterValue; + return connectorStatus?.transactionEnergyActiveImportRegisterValue ?? 0; } - return connectorStatus?.energyActiveImportRegisterValue; + return connectorStatus?.energyActiveImportRegisterValue ?? 0; } public getAuthorizeRemoteTxRequests(): boolean { @@ -462,36 +488,8 @@ export default class ChargingStation { this.performanceStatistics.start(); } this.openWSConnection(); - // Handle WebSocket message - this.wsConnection.on( - 'message', - this.onMessage.bind(this) as (this: WebSocket, data: RawData, isBinary: boolean) => void - ); - // Handle WebSocket error - this.wsConnection.on( - 'error', - this.onError.bind(this) as (this: WebSocket, error: Error) => void - ); - // Handle WebSocket close - this.wsConnection.on( - 'close', - this.onClose.bind(this) as (this: WebSocket, code: number, reason: Buffer) => void - ); - // Handle WebSocket open - this.wsConnection.on('open', this.onOpen.bind(this) as (this: WebSocket) => void); - // Handle WebSocket ping - this.wsConnection.on('ping', this.onPing.bind(this) as (this: WebSocket, data: Buffer) => void); - // Handle WebSocket pong - this.wsConnection.on('pong', this.onPong.bind(this) as (this: WebSocket, data: Buffer) => void); - // Monitor authorization file - FileUtils.watchJsonFile( - this.logPrefix(), - FileType.Authorization, - this.getAuthorizationFile(), - this.authorizedTags - ); // Monitor charging station template file - FileUtils.watchJsonFile( + this.templateFileWatcher = FileUtils.watchJsonFile( this.logPrefix(), FileType.ChargingStationTemplate, this.templateFile, @@ -504,15 +502,11 @@ export default class ChargingStation { this.templateFile } file have changed, reload` ); + this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash); // Initialize this.initialize(); // Restart the ATG - if ( - !this.stationInfo.AutomaticTransactionGenerator.enable && - this.automaticTransactionGenerator - ) { - this.automaticTransactionGenerator.stop(); - } + this.stopAutomaticTransactionGenerator(); this.startAutomaticTransactionGenerator(); if (this.getEnableStatistics()) { this.performanceStatistics.restart(); @@ -522,17 +516,14 @@ export default class ChargingStation { // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed } catch (error) { logger.error( - `${this.logPrefix()} ${FileType.ChargingStationTemplate} file monitoring error: %j`, + `${this.logPrefix()} ${FileType.ChargingStationTemplate} file monitoring error:`, error ); } } } ); - parentPort.postMessage({ - id: ChargingStationWorkerMessageEvents.STARTED, - data: { id: this.stationInfo.chargingStationId }, - }); + parentPort.postMessage(MessageChannelUtils.buildStartedMessage(this)); } public async stop(reason: StopTransactionReason = StopTransactionReason.NONE): Promise { @@ -551,31 +542,28 @@ export default class ChargingStation { this.getConnectorStatus(connectorId).status = ChargePointStatus.UNAVAILABLE; } } - if (this.isWebSocketConnectionOpened()) { - this.wsConnection.close(); - } + 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; - parentPort.postMessage({ - id: ChargingStationWorkerMessageEvents.STOPPED, - data: { id: this.stationInfo.chargingStationId }, - }); + parentPort.postMessage(MessageChannelUtils.buildStoppedMessage(this)); this.stopped = true; } public async reset(reason?: StopTransactionReason): Promise { await this.stop(reason); await Utils.sleep(this.stationInfo.resetTime); - this.stationInfo = this.getStationInfo(); - this.stationInfo?.Connectors && delete this.stationInfo.Connectors; + this.initialize(); this.start(); } public saveOcppConfiguration(): void { if (this.getOcppPersistentConfiguration()) { - this.saveConfiguration(Section.ocppConfiguration); + this.saveConfiguration(); } } @@ -616,7 +604,7 @@ export default class ChargingStation { : DCElectricUtils.power(this.getVoltageOut(), limit); } - const connectorMaximumPower = this.getMaximumPower() / this.stationInfo.powerDivider; + const connectorMaximumPower = this.getMaximumPower() / this.powerDivider; if (limit > connectorMaximumPower) { logger.error( `${this.logPrefix()} Charging profile id ${ @@ -708,14 +696,21 @@ export default class ChargingStation { private getTemplateFromFile(): ChargingStationTemplate | null { let template: ChargingStationTemplate = null; try { - const measureId = `${FileType.ChargingStationTemplate} read`; - const beginId = PerformanceStatistics.beginMeasure(measureId); - template = JSON.parse(fs.readFileSync(this.templateFile, 'utf8')) as ChargingStationTemplate; - PerformanceStatistics.endMeasure(measureId, beginId); - template.templateHash = crypto - .createHash(Constants.DEFAULT_HASH_ALGORITHM) - .update(JSON.stringify(template)) - .digest('hex'); + if (this.sharedLRUCache.hasChargingStationTemplate(this.stationInfo?.templateHash)) { + template = this.sharedLRUCache.getChargingStationTemplate(this.stationInfo.templateHash); + } else { + const measureId = `${FileType.ChargingStationTemplate} read`; + const beginId = PerformanceStatistics.beginMeasure(measureId); + template = JSON.parse( + fs.readFileSync(this.templateFile, 'utf8') + ) as ChargingStationTemplate; + PerformanceStatistics.endMeasure(measureId, beginId); + template.templateHash = crypto + .createHash(Constants.DEFAULT_HASH_ALGORITHM) + .update(JSON.stringify(template)) + .digest('hex'); + this.sharedLRUCache.setChargingStationTemplate(template); + } } catch (error) { FileUtils.handleFileException( this.logPrefix(), @@ -728,74 +723,99 @@ export default class ChargingStation { } private getStationInfoFromTemplate(): ChargingStationInfo { - const stationInfo: ChargingStationInfo = this.getTemplateFromFile(); - if (Utils.isNullOrUndefined(stationInfo)) { + const stationTemplate: ChargingStationTemplate = this.getTemplateFromFile(); + if (Utils.isNullOrUndefined(stationTemplate)) { const errorMsg = 'Failed to read charging station template file'; logger.error(`${this.logPrefix()} ${errorMsg}`); throw new BaseError(errorMsg); } - if (Utils.isEmptyObject(stationInfo)) { + if (Utils.isEmptyObject(stationTemplate)) { const errorMsg = `Empty charging station information from template file ${this.templateFile}`; logger.error(`${this.logPrefix()} ${errorMsg}`); throw new BaseError(errorMsg); } - const chargingStationId = ChargingStationUtils.getChargingStationId(this.index, stationInfo); // Deprecation template keys section ChargingStationUtils.warnDeprecatedTemplateKey( - stationInfo, + stationTemplate, 'supervisionUrl', this.templateFile, this.logPrefix(), "Use 'supervisionUrls' instead" ); ChargingStationUtils.convertDeprecatedTemplateKey( - stationInfo, + stationTemplate, 'supervisionUrl', 'supervisionUrls' ); - if (!Utils.isEmptyArray(stationInfo.power)) { - stationInfo.power = stationInfo.power as number[]; - const powerArrayRandomIndex = Math.floor(Utils.secureRandom() * stationInfo.power.length); + const stationInfo: ChargingStationInfo = + ChargingStationUtils.stationTemplateToStationInfo(stationTemplate); + stationInfo.chargingStationId = ChargingStationUtils.getChargingStationId( + this.index, + stationTemplate + ); + ChargingStationUtils.createSerialNumber(stationTemplate, stationInfo); + if (!Utils.isEmptyArray(stationTemplate.power)) { + stationTemplate.power = stationTemplate.power as number[]; + const powerArrayRandomIndex = Math.floor(Utils.secureRandom() * stationTemplate.power.length); stationInfo.maximumPower = - stationInfo.powerUnit === PowerUnits.KILO_WATT - ? stationInfo.power[powerArrayRandomIndex] * 1000 - : stationInfo.power[powerArrayRandomIndex]; + stationTemplate.powerUnit === PowerUnits.KILO_WATT + ? stationTemplate.power[powerArrayRandomIndex] * 1000 + : stationTemplate.power[powerArrayRandomIndex]; } else { - stationInfo.power = stationInfo.power as number; + stationTemplate.power = stationTemplate.power as number; stationInfo.maximumPower = - stationInfo.powerUnit === PowerUnits.KILO_WATT - ? stationInfo.power * 1000 - : stationInfo.power; - } - delete stationInfo.power; - delete stationInfo.powerUnit; - stationInfo.chargingStationId = chargingStationId; - stationInfo.resetTime = stationInfo.resetTime - ? stationInfo.resetTime * 1000 + stationTemplate.powerUnit === PowerUnits.KILO_WATT + ? stationTemplate.power * 1000 + : stationTemplate.power; + } + stationInfo.resetTime = stationTemplate.resetTime + ? stationTemplate.resetTime * 1000 : Constants.CHARGING_STATION_DEFAULT_RESET_TIME; + const configuredMaxConnectors = ChargingStationUtils.getConfiguredNumberOfConnectors( + this.index, + stationTemplate + ); + ChargingStationUtils.checkConfiguredMaxConnectors( + configuredMaxConnectors, + this.templateFile, + Utils.logPrefix() + ); + const templateMaxConnectors = + ChargingStationUtils.getTemplateMaxNumberOfConnectors(stationTemplate); + ChargingStationUtils.checkTemplateMaxConnectors( + templateMaxConnectors, + this.templateFile, + Utils.logPrefix() + ); + if ( + configuredMaxConnectors > + (stationTemplate?.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) && + !stationTemplate?.randomConnectors + ) { + logger.warn( + `${this.logPrefix()} Number of connectors exceeds the number of connector configurations in template ${ + this.templateFile + }, forcing random connector configurations affectation` + ); + stationInfo.randomConnectors = true; + } + // Build connectors if needed (FIXME: should be factored out) + this.initializeConnectors(stationInfo, configuredMaxConnectors, templateMaxConnectors); + stationInfo.maximumAmperage = this.getMaximumAmperage(stationInfo); + ChargingStationUtils.createStationInfoHash(stationInfo); return stationInfo; } private getStationInfoFromFile(): ChargingStationInfo | null { let stationInfo: ChargingStationInfo = null; - if (this.getStationInfoPersistentConfiguration()) { - stationInfo = this.getConfigurationFromFile()?.stationInfo ?? null; - } - if (stationInfo) { - stationInfo = ChargingStationUtils.createStationInfoHash(stationInfo); - } + this.getStationInfoPersistentConfiguration() && + (stationInfo = this.getConfigurationFromFile()?.stationInfo ?? null); + stationInfo && ChargingStationUtils.createStationInfoHash(stationInfo); return stationInfo; } private getStationInfo(): ChargingStationInfo { const stationInfoFromTemplate: ChargingStationInfo = this.getStationInfoFromTemplate(); - this.hashId = ChargingStationUtils.getHashId(stationInfoFromTemplate); - this.configurationFile = path.join( - path.resolve(__dirname, '../'), - 'assets', - 'configurations', - this.hashId + '.json' - ); const stationInfoFromFile: ChargingStationInfo = this.getStationInfoFromFile(); // Priority: charging station info from template > charging station info from configuration file > charging station info attribute if (stationInfoFromFile?.templateHash === stationInfoFromTemplate.templateHash) { @@ -804,13 +824,18 @@ export default class ChargingStation { } return stationInfoFromFile; } - ChargingStationUtils.createSerialNumber(stationInfoFromTemplate, stationInfoFromFile); + stationInfoFromFile && + ChargingStationUtils.propagateSerialNumber( + this.getTemplateFromFile(), + stationInfoFromFile, + stationInfoFromTemplate + ); return stationInfoFromTemplate; } private saveStationInfo(): void { if (this.getStationInfoPersistentConfiguration()) { - this.saveConfiguration(Section.stationInfo); + this.saveConfiguration(); } } @@ -835,50 +860,31 @@ export default class ChargingStation { } private initialize(): void { - this.stationInfo = this.getStationInfo(); + this.hashId = ChargingStationUtils.getHashId(this.index, this.getTemplateFromFile()); logger.info(`${this.logPrefix()} Charging station hashId '${this.hashId}'`); - this.bootNotificationRequest = ChargingStationUtils.createBootNotificationRequest( - this.stationInfo - ); - this.ocppConfiguration = this.getOcppConfiguration(); - this.stationInfo?.Configuration && delete this.stationInfo.Configuration; - this.wsConfiguredConnectionUrl = new URL( - this.getConfiguredSupervisionUrl().href + '/' + this.stationInfo.chargingStationId + this.configurationFile = path.join( + path.dirname(this.templateFile.replace('station-templates', 'configurations')), + this.hashId + '.json' ); - // Build connectors if needed - const maxConnectors = this.getMaxNumberOfConnectors(); - this.checkMaxConnectors(maxConnectors); - const templateMaxConnectors = this.getTemplateMaxNumberOfConnectors(); - this.checkTemplateMaxConnectors(templateMaxConnectors); - if ( - maxConnectors > - (this.stationInfo?.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) && - !this.stationInfo?.randomConnectors - ) { - logger.warn( - `${this.logPrefix()} Number of connectors exceeds the number of connector configurations in template ${ - this.templateFile - }, forcing random connector configurations affectation` - ); - this.stationInfo.randomConnectors = true; - } - this.initializeConnectors(this.stationInfo, maxConnectors, templateMaxConnectors); - this.stationInfo.maximumAmperage = this.getMaximumAmperage(); - if (this.stationInfo) { - this.stationInfo = ChargingStationUtils.createStationInfoHash(this.stationInfo); - } + this.stationInfo = this.getStationInfo(); this.saveStationInfo(); // Avoid duplication of connectors related information in RAM this.stationInfo?.Connectors && delete this.stationInfo.Connectors; - // OCPP configuration - this.initializeOcppConfiguration(); + this.configuredSupervisionUrl = this.getConfiguredSupervisionUrl(); if (this.getEnableStatistics()) { this.performanceStatistics = PerformanceStatistics.getInstance( this.hashId, this.stationInfo.chargingStationId, - this.wsConnectionUrl + this.configuredSupervisionUrl ); } + this.bootNotificationRequest = ChargingStationUtils.createBootNotificationRequest( + this.stationInfo + ); + this.powerDivider = this.getPowerDivider(); + // OCPP configuration + this.ocppConfiguration = this.getOcppConfiguration(); + this.initializeOcppConfiguration(); switch (this.getOcppVersion()) { case OCPPVersion.VERSION_16: this.ocppIncomingRequestService = @@ -891,14 +897,13 @@ export default class ChargingStation { this.handleUnsupportedVersion(this.getOcppVersion()); break; } - if (this.stationInfo.autoRegister) { + if (this.stationInfo?.autoRegister) { this.bootNotificationResponse = { currentTime: new Date().toISOString(), interval: this.getHeartbeatInterval() / 1000, status: RegistrationStatus.ACCEPTED, }; } - this.stationInfo.powerDivider = this.getPowerDivider(); } private initializeOcppConfiguration(): void { @@ -934,7 +939,7 @@ export default class ChargingStation { ChargingStationConfigurationUtils.addConfigurationKey( this, this.getSupervisionUrlOcppKey(), - this.getConfiguredSupervisionUrl().href, + this.configuredSupervisionUrl.href, { reboot: true } ); } else if ( @@ -1065,7 +1070,7 @@ export default class ChargingStation { private initializeConnectors( stationInfo: ChargingStationInfo, - maxConnectors: number, + configuredMaxConnectors: number, templateMaxConnectors: number ): void { if (!stationInfo?.Connectors && this.connectors.size === 0) { @@ -1085,7 +1090,7 @@ export default class ChargingStation { if (stationInfo?.Connectors) { const connectorsConfigHash = crypto .createHash(Constants.DEFAULT_HASH_ALGORITHM) - .update(JSON.stringify(stationInfo?.Connectors) + maxConnectors.toString()) + .update(JSON.stringify(stationInfo?.Connectors) + configuredMaxConnectors.toString()) .digest('hex'); const connectorsConfigChanged = this.connectors?.size !== 0 && this.connectorsConfigurationHash !== connectorsConfigHash; @@ -1098,7 +1103,7 @@ export default class ChargingStation { const lastConnectorId = Utils.convertToInt(lastConnector); if ( lastConnectorId === 0 && - this.getUseConnectorId0() && + this.getUseConnectorId0(stationInfo) && stationInfo?.Connectors[lastConnector] ) { this.connectors.set( @@ -1113,7 +1118,7 @@ export default class ChargingStation { } // Generate all connectors if ((stationInfo?.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) > 0) { - for (let index = 1; index <= maxConnectors; index++) { + for (let index = 1; index <= configuredMaxConnectors; index++) { const randConnectorId = stationInfo?.randomConnectors ? Utils.getRandomInteger(Utils.convertToInt(lastConnector), 1) : index; @@ -1143,42 +1148,24 @@ export default class ChargingStation { } } - private checkMaxConnectors(maxConnectors: number): void { - if (maxConnectors <= 0) { - logger.warn( - `${this.logPrefix()} Charging station information from template ${ - this.templateFile - } with ${maxConnectors} connectors` - ); - } - } - - private checkTemplateMaxConnectors(templateMaxConnectors: number): void { - if (templateMaxConnectors === 0) { - logger.warn( - `${this.logPrefix()} Charging station information from template ${ - this.templateFile - } with empty connectors configuration` - ); - } else if (templateMaxConnectors < 0) { - logger.error( - `${this.logPrefix()} Charging station information from template ${ - this.templateFile - } with no connectors configuration defined` - ); - } - } - private getConfigurationFromFile(): ChargingStationConfiguration | null { let configuration: ChargingStationConfiguration = null; if (this.configurationFile && fs.existsSync(this.configurationFile)) { try { - const measureId = `${FileType.ChargingStationConfiguration} read`; - const beginId = PerformanceStatistics.beginMeasure(measureId); - configuration = JSON.parse( - fs.readFileSync(this.configurationFile, 'utf8') - ) as ChargingStationConfiguration; - PerformanceStatistics.endMeasure(measureId, beginId); + if (this.sharedLRUCache.hasChargingStationConfiguration(this.configurationFileHash)) { + configuration = this.sharedLRUCache.getChargingStationConfiguration( + this.configurationFileHash + ); + } else { + const measureId = `${FileType.ChargingStationConfiguration} read`; + const beginId = PerformanceStatistics.beginMeasure(measureId); + configuration = JSON.parse( + fs.readFileSync(this.configurationFile, 'utf8') + ) as ChargingStationConfiguration; + PerformanceStatistics.endMeasure(measureId, beginId); + this.configurationFileHash = configuration.configurationHash; + this.sharedLRUCache.setChargingStationConfiguration(configuration); + } } catch (error) { FileUtils.handleFileException( this.logPrefix(), @@ -1191,7 +1178,7 @@ export default class ChargingStation { return configuration; } - private saveConfiguration(section?: Section): void { + private saveConfiguration(): void { if (this.configurationFile) { try { if (!fs.existsSync(path.dirname(this.configurationFile))) { @@ -1199,34 +1186,32 @@ export default class ChargingStation { } const configurationData: ChargingStationConfiguration = this.getConfigurationFromFile() ?? {}; - switch (section) { - case Section.ocppConfiguration: - configurationData.configurationKey = this.ocppConfiguration.configurationKey; - break; - case Section.stationInfo: - if (configurationData?.stationInfo?.infoHash === this.stationInfo?.infoHash) { - logger.debug( - `${this.logPrefix()} Not saving unchanged charging station information to configuration file ${ - this.configurationFile - }` - ); - return; - } - configurationData.stationInfo = this.stationInfo; - break; - default: - configurationData.configurationKey = this.ocppConfiguration.configurationKey; - if (configurationData?.stationInfo?.infoHash !== this.stationInfo?.infoHash) { - configurationData.stationInfo = this.stationInfo; - } - break; + this.ocppConfiguration?.configurationKey && + (configurationData.configurationKey = this.ocppConfiguration.configurationKey); + this.stationInfo && (configurationData.stationInfo = this.stationInfo); + delete configurationData.configurationHash; + const configurationHash = crypto + .createHash(Constants.DEFAULT_HASH_ALGORITHM) + .update(JSON.stringify(configurationData)) + .digest('hex'); + if (this.configurationFileHash !== configurationHash) { + configurationData.configurationHash = configurationHash; + const measureId = `${FileType.ChargingStationConfiguration} write`; + const beginId = PerformanceStatistics.beginMeasure(measureId); + const fileDescriptor = fs.openSync(this.configurationFile, 'w'); + fs.writeFileSync(fileDescriptor, JSON.stringify(configurationData, null, 2), 'utf8'); + fs.closeSync(fileDescriptor); + PerformanceStatistics.endMeasure(measureId, beginId); + this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash); + this.configurationFileHash = configurationHash; + this.sharedLRUCache.setChargingStationConfiguration(configurationData); + } else { + logger.debug( + `${this.logPrefix()} Not saving unchanged charging station configuration file ${ + this.configurationFile + }` + ); } - const measureId = `${FileType.ChargingStationConfiguration} write`; - const beginId = PerformanceStatistics.beginMeasure(measureId); - const fileDescriptor = fs.openSync(this.configurationFile, 'w'); - fs.writeFileSync(fileDescriptor, JSON.stringify(configurationData, null, 2), 'utf8'); - fs.closeSync(fileDescriptor); - PerformanceStatistics.endMeasure(measureId, beginId); } catch (error) { FileUtils.handleFileException( this.logPrefix(), @@ -1415,7 +1400,7 @@ export default class ChargingStation { } logger.debug( `${this.logPrefix()} << Command '${ - requestCommandName ?? '' + requestCommandName ?? 'unknown' }' received response payload: ${JSON.stringify(request)}` ); responseCallback(commandPayload, requestPayload); @@ -1445,7 +1430,7 @@ export default class ChargingStation { } logger.debug( `${this.logPrefix()} << Command '${ - requestCommandName ?? '' + requestCommandName ?? 'unknown' }' received error payload: ${JSON.stringify(request)}` ); errorCallback(new OCPPError(errorType, errorMessage, requestCommandName, errorDetails)); @@ -1457,6 +1442,7 @@ export default class ChargingStation { logger.error(errMsg); throw new OCPPError(ErrorType.PROTOCOL_ERROR, errMsg); } + parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this)); } else { throw new OCPPError(ErrorType.PROTOCOL_ERROR, 'Incoming message is not iterable', null, { payload: request, @@ -1465,12 +1451,22 @@ export default class ChargingStation { } catch (error) { // Log logger.error( - '%s Incoming OCPP message %j matching cached request %j processing error %j', + "%s Incoming OCPP '%s' message '%j' matching cached request '%j' processing error:", this.logPrefix(), + commandName ?? requestCommandName ?? null, data.toString(), this.requests.get(messageId), error ); + if (!(error instanceof OCPPError)) { + logger.warn( + "%s Error thrown at incoming OCPP '%s' message '%j' handling is not an OCPPError:", + this.logPrefix(), + commandName ?? requestCommandName ?? null, + data.toString(), + error + ); + } // Send error messageType === MessageType.CALL_MESSAGE && (await this.ocppRequestService.sendError( @@ -1491,46 +1487,14 @@ export default class ChargingStation { } private onError(error: WSError): void { - logger.error(this.logPrefix() + ' WebSocket error: %j', error); - } - - private getAuthorizationFile(): string | undefined { - return ( - this.stationInfo.authorizationFile && - path.join( - path.resolve(__dirname, '../'), - 'assets', - path.basename(this.stationInfo.authorizationFile) - ) - ); + this.closeWSConnection(); + logger.error(this.logPrefix() + ' WebSocket error:', error); } - private getAuthorizedTags(): string[] { - let authorizedTags: string[] = []; - const authorizationFile = this.getAuthorizationFile(); - if (authorizationFile) { - try { - // Load authorization file - authorizedTags = JSON.parse(fs.readFileSync(authorizationFile, 'utf8')) as string[]; - } catch (error) { - FileUtils.handleFileException( - this.logPrefix(), - FileType.Authorization, - authorizationFile, - error as NodeJS.ErrnoException - ); - } - } else { - logger.info( - this.logPrefix() + ' No authorization file given in template file ' + this.templateFile - ); - } - return authorizedTags; - } - - private getUseConnectorId0(): boolean | undefined { - return !Utils.isUndefined(this.stationInfo.useConnectorId0) - ? this.stationInfo.useConnectorId0 + private getUseConnectorId0(stationInfo?: ChargingStationInfo): boolean | undefined { + const localStationInfo = stationInfo ?? this.stationInfo; + return !Utils.isUndefined(localStationInfo.useConnectorId0) + ? localStationInfo.useConnectorId0 : true; } @@ -1585,50 +1549,28 @@ export default class ChargingStation { private getPowerDivider(): number { let powerDivider = this.getNumberOfConnectors(); - if (this.stationInfo.powerSharedByConnectors) { + if (this.stationInfo?.powerSharedByConnectors) { powerDivider = this.getNumberOfRunningTransactions(); } return powerDivider; } - private getTemplateMaxNumberOfConnectors(): number { - if (!this.stationInfo?.Connectors) { - return -1; - } - return Object.keys(this.stationInfo?.Connectors).length; + private getMaximumPower(stationInfo?: ChargingStationInfo): number { + const localStationInfo = stationInfo ?? this.stationInfo; + return (localStationInfo['maxPower'] as number) ?? localStationInfo.maximumPower; } - private getMaxNumberOfConnectors(): number { - let maxConnectors: number; - if (!Utils.isEmptyArray(this.stationInfo.numberOfConnectors)) { - const numberOfConnectors = this.stationInfo.numberOfConnectors as number[]; - // Distribute evenly the number of connectors - maxConnectors = numberOfConnectors[(this.index - 1) % numberOfConnectors.length]; - } else if (!Utils.isUndefined(this.stationInfo.numberOfConnectors)) { - maxConnectors = this.stationInfo.numberOfConnectors as number; - } else { - maxConnectors = this.stationInfo?.Connectors[0] - ? this.getTemplateMaxNumberOfConnectors() - 1 - : this.getTemplateMaxNumberOfConnectors(); - } - return maxConnectors; - } - - private getMaximumPower(): number { - return (this.stationInfo['maxPower'] as number) ?? this.stationInfo.maximumPower; - } - - private getMaximumAmperage(): number | undefined { - const maximumPower = this.getMaximumPower(); - switch (this.getCurrentOutType()) { + private getMaximumAmperage(stationInfo: ChargingStationInfo): number | undefined { + const maximumPower = this.getMaximumPower(stationInfo); + switch (this.getCurrentOutType(stationInfo)) { case CurrentType.AC: return ACElectricUtils.amperagePerPhaseFromPower( - this.getNumberOfPhases(), + this.getNumberOfPhases(stationInfo), maximumPower / this.getNumberOfConnectors(), - this.getVoltageOut() + this.getVoltageOut(stationInfo) ); case CurrentType.DC: - return DCElectricUtils.amperage(maximumPower, this.getVoltageOut()); + return DCElectricUtils.amperage(maximumPower, this.getVoltageOut(stationInfo)); } } @@ -1652,7 +1594,7 @@ export default class ChargingStation { } private async startMessageSequence(): Promise { - if (this.stationInfo.autoRegister) { + if (this.stationInfo?.autoRegister) { await this.ocppRequestService.requestHandler< BootNotificationRequest, BootNotificationResponse @@ -1741,9 +1683,12 @@ export default class ChargingStation { } private startAutomaticTransactionGenerator() { - if (this.stationInfo.AutomaticTransactionGenerator.enable) { + if (this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable) { if (!this.automaticTransactionGenerator) { - this.automaticTransactionGenerator = AutomaticTransactionGenerator.getInstance(this); + this.automaticTransactionGenerator = AutomaticTransactionGenerator.getInstance( + this.getAutomaticTransactionGeneratorConfigurationFromTemplate(), + this + ); } if (!this.automaticTransactionGenerator.started) { this.automaticTransactionGenerator.start(); @@ -1751,6 +1696,13 @@ export default class ChargingStation { } } + private stopAutomaticTransactionGenerator(): void { + if (this.automaticTransactionGenerator?.started) { + this.automaticTransactionGenerator.stop(); + this.automaticTransactionGenerator = null; + } + } + private async stopMessageSequence( reason: StopTransactionReason = StopTransactionReason.NONE ): Promise { @@ -1758,12 +1710,9 @@ export default class ChargingStation { this.stopWebSocketPing(); // Stop heartbeat this.stopHeartbeat(); - // Stop the ATG - if ( - this.stationInfo.AutomaticTransactionGenerator.enable && - this.automaticTransactionGenerator?.started - ) { - this.automaticTransactionGenerator.stop(); + // Stop ongoing transactions + if (this.automaticTransactionGenerator?.configuration?.enable) { + this.stopAutomaticTransactionGenerator(); } else { for (const connectorId of this.connectors.keys()) { if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted) { @@ -1785,7 +1734,7 @@ export default class ChargingStation { { connectorId, transactionId, - meterValue: transactionEndMeterValue, + meterValue: [transactionEndMeterValue], } ); } @@ -1904,7 +1853,7 @@ export default class ChargingStation { if (HeartBeatInterval) { return Utils.convertToInt(HeartBeatInterval.value) * 1000; } - !this.stationInfo.autoRegister && + !this.stationInfo?.autoRegister && logger.warn( `${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${ Constants.DEFAULT_HEARTBEAT_INTERVAL @@ -1921,17 +1870,25 @@ export default class ChargingStation { private openWSConnection( options: WsOptions = this.stationInfo?.wsOptions ?? {}, - forceCloseOpened = false + params: { closeOpened?: boolean; terminateOpened?: boolean } = { + closeOpened: false, + terminateOpened: false, + } ): void { options.handshakeTimeout = options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000; + params.closeOpened = params?.closeOpened ?? false; + params.terminateOpened = params?.terminateOpened ?? false; if ( !Utils.isNullOrUndefined(this.stationInfo.supervisionUser) && !Utils.isNullOrUndefined(this.stationInfo.supervisionPassword) ) { options.auth = `${this.stationInfo.supervisionUser}:${this.stationInfo.supervisionPassword}`; } - if (this.isWebSocketConnectionOpened() && forceCloseOpened) { - this.wsConnection.close(); + if (params?.closeOpened) { + this.closeWSConnection(); + } + if (params?.terminateOpened) { + this.terminateWSConnection(); } let protocol: string; switch (this.getOcppVersion()) { @@ -1942,10 +1899,48 @@ export default class ChargingStation { this.handleUnsupportedVersion(this.getOcppVersion()); break; } - this.wsConnection = new WebSocket(this.wsConnectionUrl, protocol, options); + logger.info( this.logPrefix() + ' Open OCPP connection to URL ' + this.wsConnectionUrl.toString() ); + + this.wsConnection = new WebSocket(this.wsConnectionUrl, protocol, options); + + // Handle WebSocket message + this.wsConnection.on( + 'message', + this.onMessage.bind(this) as (this: WebSocket, data: RawData, isBinary: boolean) => void + ); + // Handle WebSocket error + this.wsConnection.on( + 'error', + this.onError.bind(this) as (this: WebSocket, error: Error) => void + ); + // Handle WebSocket close + this.wsConnection.on( + 'close', + this.onClose.bind(this) as (this: WebSocket, code: number, reason: Buffer) => void + ); + // Handle WebSocket open + this.wsConnection.on('open', this.onOpen.bind(this) as (this: WebSocket) => void); + // Handle WebSocket ping + this.wsConnection.on('ping', this.onPing.bind(this) as (this: WebSocket, data: Buffer) => void); + // Handle WebSocket pong + this.wsConnection.on('pong', this.onPong.bind(this) as (this: WebSocket, data: Buffer) => void); + } + + private closeWSConnection(): void { + if (this.isWebSocketConnectionOpened()) { + this.wsConnection.close(); + this.wsConnection = null; + } + } + + private terminateWSConnection(): void { + if (this.isWebSocketConnectionOpened()) { + this.wsConnection.terminate(); + this.wsConnection = null; + } } private stopMeterValues(connectorId: number) { @@ -1966,12 +1961,8 @@ export default class ChargingStation { // Stop heartbeat this.stopHeartbeat(); // Stop the ATG if needed - if ( - this.stationInfo.AutomaticTransactionGenerator.enable && - this.stationInfo.AutomaticTransactionGenerator.stopOnConnectionFailure && - this.automaticTransactionGenerator?.started - ) { - this.automaticTransactionGenerator.stop(); + if (this.automaticTransactionGenerator?.configuration?.stopOnConnectionFailure) { + this.stopAutomaticTransactionGenerator(); } if ( this.autoReconnectRetryCount < this.getAutoReconnectMaxRetries() || @@ -1981,7 +1972,11 @@ export default class ChargingStation { const reconnectDelay = this.getReconnectExponentialDelay() ? Utils.exponentialDelay(this.autoReconnectRetryCount) : this.getConnectionTimeout() * 1000; - const reconnectTimeout = reconnectDelay - 100 > 0 && reconnectDelay; + const reconnectDelayWithdraw = 1000; + const reconnectTimeout = + reconnectDelay && reconnectDelay - reconnectDelayWithdraw > 0 + ? reconnectDelay - reconnectDelayWithdraw + : 0; logger.error( `${this.logPrefix()} WebSocket: connection retry in ${Utils.roundTo( reconnectDelay, @@ -1996,7 +1991,7 @@ export default class ChargingStation { ); this.openWSConnection( { ...(this.stationInfo?.wsOptions ?? {}), handshakeTimeout: reconnectTimeout }, - true + { closeOpened: true } ); this.wsConnectionRestarted = true; } else if (this.getAutoReconnectMaxRetries() !== -1) { @@ -2008,6 +2003,10 @@ export default class ChargingStation { } } + private getAutomaticTransactionGeneratorConfigurationFromTemplate(): AutomaticTransactionGeneratorConfiguration | null { + return this.getTemplateFromFile()?.AutomaticTransactionGenerator ?? null; + } + private initializeConnectorStatus(connectorId: number): void { this.getConnectorStatus(connectorId).idTagLocalAuthorized = false; this.getConnectorStatus(connectorId).idTagAuthorized = false;