X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FChargingStation.ts;h=6e9a0d874080dd6f87fc1b12c1dcf1494dd826b4;hb=7c72977bb3400f474c8641fc91d9f54fba25cb64;hp=a451c5ee4668b31cbad728fa4881cf2356a812a8;hpb=cbad1217b743f0a06653689fb9c1344ac2194348;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ChargingStation.ts b/src/charging-station/ChargingStation.ts index a451c5ee..6e9a0d87 100644 --- a/src/charging-station/ChargingStation.ts +++ b/src/charging-station/ChargingStation.ts @@ -1,21 +1,31 @@ // Partial Copyright Jerome Benoit. 2021. All Rights Reserved. +import { ACElectricUtils, DCElectricUtils } from '../utils/ElectricUtils'; import { AvailabilityType, BootNotificationRequest, CachedRequest, + HeartbeatRequest, IncomingRequest, IncomingRequestCommand, + MeterValuesRequest, RequestCommand, + StatusNotificationRequest, } from '../types/ocpp/Requests'; -import { BootNotificationResponse, RegistrationStatus } from '../types/ocpp/Responses'; -import ChargingStationConfiguration, { - ConfigurationKey, -} from '../types/ChargingStationConfiguration'; +import { + BootNotificationResponse, + ErrorResponse, + HeartbeatResponse, + MeterValuesResponse, + RegistrationStatus, + Response, + StatusNotificationResponse, +} from '../types/ocpp/Responses'; +import { ChargingProfile, ChargingRateUnitType } from '../types/ocpp/ChargingProfile'; import ChargingStationTemplate, { CurrentType, PowerUnits, - Voltage, + WsOptions, } from '../types/ChargingStationTemplate'; import { ConnectorPhaseRotation, @@ -23,21 +33,32 @@ import { SupportedFeatureProfiles, VendorDefaultParametersKey, } from '../types/ocpp/Configuration'; -import { MeterValue, MeterValueMeasurand, MeterValuePhase } from '../types/ocpp/MeterValues'; +import { MeterValue, MeterValueMeasurand } from '../types/ocpp/MeterValues'; +import { + StopTransactionReason, + StopTransactionRequest, + StopTransactionResponse, +} from '../types/ocpp/Transaction'; import { WSError, WebSocketCloseEventStatusCode } from '../types/WebSocket'; -import WebSocket, { ClientOptions, Data, OPEN, RawData } from 'ws'; +import WebSocket, { Data, OPEN, RawData } from 'ws'; import AutomaticTransactionGenerator from './AutomaticTransactionGenerator'; +import { AutomaticTransactionGeneratorConfiguration } from '../types/AutomaticTransactionGenerator'; +import BaseError from '../exception/BaseError'; import { ChargePointErrorCode } from '../types/ocpp/ChargePointErrorCode'; import { ChargePointStatus } from '../types/ocpp/ChargePointStatus'; -import { ChargingProfile } from '../types/ocpp/ChargingProfile'; +import { ChargingStationCache } from './ChargingStationCache'; +import ChargingStationConfiguration from '../types/ChargingStationConfiguration'; +import { ChargingStationConfigurationUtils } from './ChargingStationConfigurationUtils'; import ChargingStationInfo from '../types/ChargingStationInfo'; +import ChargingStationOcppConfiguration from '../types/ChargingStationOcppConfiguration'; +import { ChargingStationUtils } from './ChargingStationUtils'; import { ChargingStationWorkerMessageEvents } from '../types/ChargingStationWorker'; -import { ClientRequestArgs } from 'http'; 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 FileUtils from '../utils/FileUtils'; import { JsonType } from '../types/JsonType'; import { MessageType } from '../types/ocpp/MessageType'; @@ -50,8 +71,6 @@ import OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService'; import OCPPRequestService from './ocpp/OCPPRequestService'; import { OCPPVersion } from '../types/ocpp/OCPPVersion'; import PerformanceStatistics from '../performance/PerformanceStatistics'; -import { SampledValueTemplate } from '../types/MeasurandPerPhaseSampledValueTemplates'; -import { StopTransactionReason } from '../types/ocpp/Transaction'; import { SupervisionUrlDistribution } from '../types/ConfigurationData'; import { URL } from 'url'; import Utils from '../utils/Utils'; @@ -62,58 +81,67 @@ import { parentPort } from 'worker_threads'; import path from 'path'; export default class ChargingStation { - public readonly id: string; - public readonly stationTemplateFile: string; + public hashId!: string; + public readonly templateFile: string; public authorizedTags: string[]; public stationInfo!: ChargingStationInfo; public readonly connectors: Map; - public configuration!: ChargingStationConfiguration; + public ocppConfiguration!: ChargingStationOcppConfiguration; public wsConnection!: WebSocket; public readonly requests: Map; public performanceStatistics!: PerformanceStatistics; 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 bootNotificationResponse!: BootNotificationResponse | null; 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 stopped: boolean; + private readonly cache: ChargingStationCache; private automaticTransactionGenerator!: AutomaticTransactionGenerator; private webSocketPingSetInterval!: NodeJS.Timeout; - constructor(index: number, stationTemplateFile: string) { - this.id = Utils.generateUUID(); + constructor(index: number, templateFile: string) { this.index = index; - this.stationTemplateFile = stationTemplateFile; + this.templateFile = templateFile; this.stopped = false; this.wsConnectionRestarted = false; this.autoReconnectRetryCount = 0; + this.cache = ChargingStationCache.getInstance(); this.connectors = new Map(); this.requests = new Map(); this.messageBuffer = new Set(); this.initialize(); - this.authorizedTags = this.getAuthorizedTags(); } - get wsConnectionUrl(): URL { - return this.getSupervisionUrlOcppConfiguration() - ? new URL( - this.getConfigurationKey( - this.stationInfo.supervisionUrlOcppKey ?? VendorDefaultParametersKey.ConnectionUrl - ).value + - '/' + - this.stationInfo.chargingStationId - ) - : this.wsConfiguredConnectionUrl; + private get wsConnectionUrl(): URL { + return new URL( + (this.getSupervisionUrlOcppConfiguration() + ? ChargingStationConfigurationUtils.getConfigurationKey( + this, + this.getSupervisionUrlOcppKey() + ).value + : this.configuredSupervisionUrl.href) + + '/' + + this.stationInfo.chargingStationId + ); } public logPrefix(): string { - return Utils.logPrefix(` ${this.stationInfo.chargingStationId} |`); + return Utils.logPrefix( + ` ${ + this?.stationInfo?.chargingStationId ?? + ChargingStationUtils.getChargingStationId(this.index, this.getTemplateFromFile()) + } |` + ); } public getBootNotificationRequest(): BootNotificationRequest { @@ -139,11 +167,12 @@ export default class ChargingStation { return this.stationInfo.mayAuthorizeAtRemoteStart ?? true; } - public getNumberOfPhases(): number | undefined { - switch (this.getCurrentOutType()) { + 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; @@ -194,35 +223,53 @@ 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; + return this.stationInfo?.ocppStrictCompliance ?? false; } - public getVoltageOut(): number | undefined { - const errMsg = `${this.logPrefix()} Unknown ${this.getCurrentOutType()} currentOutType in template file ${ - this.stationTemplateFile - }, cannot define default voltage out`; - let defaultVoltageOut: number; - switch (this.getCurrentOutType()) { - case CurrentType.AC: - defaultVoltageOut = Voltage.VOLTAGE_230; - break; - case CurrentType.DC: - defaultVoltageOut = Voltage.VOLTAGE_400; - break; - default: - logger.error(errMsg); - throw new Error(errMsg); - } - return !Utils.isUndefined(this.stationInfo.voltageOut) - ? this.stationInfo.voltageOut + public getVoltageOut(stationInfo?: ChargingStationInfo): number | undefined { + const defaultVoltageOut = ChargingStationUtils.getDefaultVoltageOut( + this.getCurrentOutType(stationInfo), + this.templateFile, + this.logPrefix() + ); + const localStationInfo: ChargingStationInfo = stationInfo ?? this.stationInfo; + return !Utils.isUndefined(localStationInfo.voltageOut) + ? localStationInfo.voltageOut : defaultVoltageOut; } + public getConnectorMaximumAvailablePower(connectorId: number): number { + let connectorAmperageLimitationPowerLimit: number; + if ( + !Utils.isNullOrUndefined(this.getAmperageLimitation()) && + this.getAmperageLimitation() < this.stationInfo.maximumAmperage + ) { + connectorAmperageLimitationPowerLimit = + (this.getCurrentOutType() === CurrentType.AC + ? ACElectricUtils.powerTotal( + this.getNumberOfPhases(), + this.getVoltageOut(), + this.getAmperageLimitation() * this.getNumberOfConnectors() + ) + : DCElectricUtils.power(this.getVoltageOut(), this.getAmperageLimitation())) / + this.powerDivider; + } + const connectorMaximumPower = this.getMaximumPower() / this.powerDivider; + const connectorChargingProfilePowerLimit = this.getChargingProfilePowerLimit(connectorId); + return Math.min( + isNaN(connectorMaximumPower) ? Infinity : connectorMaximumPower, + isNaN(connectorAmperageLimitationPowerLimit) + ? Infinity + : connectorAmperageLimitationPowerLimit, + isNaN(connectorChargingProfilePowerLimit) ? Infinity : connectorChargingProfilePowerLimit + ); + } + public getTransactionIdTag(transactionId: number): string | undefined { for (const connectorId of this.connectors.keys()) { if (connectorId > 0 && this.getConnectorStatus(connectorId).transactionId === transactionId) { @@ -232,27 +279,31 @@ export default class ChargingStation { } public getOutOfOrderEndMeterValues(): boolean { - return this.stationInfo.outOfOrderEndMeterValues ?? false; + return this.stationInfo?.outOfOrderEndMeterValues ?? false; } public getBeginEndMeterValues(): boolean { - return this.stationInfo.beginEndMeterValues ?? false; + return this.stationInfo?.beginEndMeterValues ?? false; } public getMeteringPerTransaction(): boolean { - return this.stationInfo.meteringPerTransaction ?? true; + return this.stationInfo?.meteringPerTransaction ?? true; } public getTransactionDataMeterValues(): boolean { - return this.stationInfo.transactionDataMeterValues ?? false; + return this.stationInfo?.transactionDataMeterValues ?? false; } public getMainVoltageMeterValues(): boolean { - return this.stationInfo.mainVoltageMeterValues ?? true; + return this.stationInfo?.mainVoltageMeterValues ?? true; } public getPhaseLineToLineVoltageMeterValues(): boolean { - return this.stationInfo.phaseLineToLineVoltageMeterValues ?? false; + return this.stationInfo?.phaseLineToLineVoltageMeterValues ?? false; + } + + public getCustomValueLimitationMeterValues(): boolean { + return this.stationInfo?.customValueLimitationMeterValues ?? true; } public getConnectorIdByTransactionId(transactionId: number): number | undefined { @@ -285,7 +336,8 @@ export default class ChargingStation { } public getAuthorizeRemoteTxRequests(): boolean { - const authorizeRemoteTxRequests = this.getConfigurationKey( + const authorizeRemoteTxRequests = ChargingStationConfigurationUtils.getConfigurationKey( + this, StandardParametersKey.AuthorizeRemoteTxRequests ); return authorizeRemoteTxRequests @@ -294,100 +346,13 @@ export default class ChargingStation { } public getLocalAuthListEnabled(): boolean { - const localAuthListEnabled = this.getConfigurationKey( + const localAuthListEnabled = ChargingStationConfigurationUtils.getConfigurationKey( + this, StandardParametersKey.LocalAuthListEnabled ); return localAuthListEnabled ? Utils.convertToBoolean(localAuthListEnabled.value) : false; } - public restartWebSocketPing(): void { - // Stop WebSocket ping - this.stopWebSocketPing(); - // Start WebSocket ping - this.startWebSocketPing(); - } - - public getSampledValueTemplate( - connectorId: number, - measurand: MeterValueMeasurand = MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER, - phase?: MeterValuePhase - ): SampledValueTemplate | undefined { - const onPhaseStr = phase ? `on phase ${phase} ` : ''; - if (!Constants.SUPPORTED_MEASURANDS.includes(measurand)) { - logger.warn( - `${this.logPrefix()} Trying to get unsupported MeterValues measurand '${measurand}' ${onPhaseStr}in template on connectorId ${connectorId}` - ); - return; - } - if ( - measurand !== MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER && - !this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes( - measurand - ) - ) { - logger.debug( - `${this.logPrefix()} Trying to get MeterValues measurand '${measurand}' ${onPhaseStr}in template on connectorId ${connectorId} not found in '${ - StandardParametersKey.MeterValuesSampledData - }' OCPP parameter` - ); - return; - } - const sampledValueTemplates: SampledValueTemplate[] = - this.getConnectorStatus(connectorId).MeterValues; - for ( - let index = 0; - !Utils.isEmptyArray(sampledValueTemplates) && index < sampledValueTemplates.length; - index++ - ) { - if ( - !Constants.SUPPORTED_MEASURANDS.includes( - sampledValueTemplates[index]?.measurand ?? - MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER - ) - ) { - logger.warn( - `${this.logPrefix()} Unsupported MeterValues measurand '${measurand}' ${onPhaseStr}in template on connectorId ${connectorId}` - ); - } else if ( - phase && - sampledValueTemplates[index]?.phase === phase && - sampledValueTemplates[index]?.measurand === measurand && - this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes( - measurand - ) - ) { - return sampledValueTemplates[index]; - } else if ( - !phase && - !sampledValueTemplates[index].phase && - sampledValueTemplates[index]?.measurand === measurand && - this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes( - measurand - ) - ) { - return sampledValueTemplates[index]; - } else if ( - measurand === MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER && - (!sampledValueTemplates[index].measurand || - sampledValueTemplates[index].measurand === measurand) - ) { - return sampledValueTemplates[index]; - } - } - if (measurand === MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER) { - const errorMsg = `${this.logPrefix()} Missing MeterValues for default measurand '${measurand}' in template on connectorId ${connectorId}`; - logger.error(errorMsg); - throw new Error(errorMsg); - } - logger.debug( - `${this.logPrefix()} No MeterValues for measurand '${measurand}' ${onPhaseStr}in template on connectorId ${connectorId}` - ); - } - - public getAutomaticTransactionGeneratorRequireAuthorize(): boolean { - return this.stationInfo.AutomaticTransactionGenerator.requireAuthorize ?? true; - } - public startHeartbeat(): void { if ( this.getHeartbeatInterval() && @@ -396,7 +361,10 @@ export default class ChargingStation { ) { // eslint-disable-next-line @typescript-eslint/no-misused-promises this.heartbeatSetInterval = setInterval(async (): Promise => { - await this.ocppRequestService.sendMessageHandler(RequestCommand.HEARTBEAT); + await this.ocppRequestService.requestHandler( + this, + RequestCommand.HEARTBEAT + ); }, this.getHeartbeatInterval()); logger.info( this.logPrefix() + @@ -427,6 +395,13 @@ export default class ChargingStation { this.startHeartbeat(); } + public restartWebSocketPing(): void { + // Stop WebSocket ping + this.stopWebSocketPing(); + // Start WebSocket ping + this.startWebSocketPing(); + } + public startMeterValues(connectorId: number, interval: number): void { if (connectorId === 0) { logger.error( @@ -466,11 +441,15 @@ export default class ChargingStation { this.getConnectorStatus(connectorId).transactionId, interval ); - await this.ocppRequestService.sendMessageHandler(RequestCommand.METER_VALUES, { - connectorId, - transactionId: this.getConnectorStatus(connectorId).transactionId, - meterValue: [meterValue], - }); + await this.ocppRequestService.requestHandler( + this, + RequestCommand.METER_VALUES, + { + connectorId, + transactionId: this.getConnectorStatus(connectorId).transactionId, + meterValue: [meterValue], + } + ); }, interval ); @@ -490,10 +469,6 @@ export default class ChargingStation { this.performanceStatistics.start(); } this.openWSConnection(); - // Monitor authorization file - this.startAuthorizationFileMonitoring(); - // Monitor station template file - this.startStationTemplateFileMonitoring(); // Handle WebSocket message this.wsConnection.on( 'message', @@ -515,6 +490,48 @@ export default class ChargingStation { 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, + ChargingStationUtils.getAuthorizationFile(this.stationInfo), + this.authorizedTags + ); + // Monitor charging station template file + 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.cache.deleteChargingStationTemplate(this.stationInfo?.templateHash); + // Initialize + this.initialize(); + // Restart the ATG + this.stopAutomaticTransactionGenerator(); + 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: %j`, + error + ); + } + } + } + ); parentPort.postMessage({ id: ChargingStationWorkerMessageEvents.STARTED, data: { id: this.stationInfo.chargingStationId }, @@ -526,7 +543,10 @@ export default class ChargingStation { await this.stopMessageSequence(reason); for (const connectorId of this.connectors.keys()) { if (connectorId > 0) { - await this.ocppRequestService.sendMessageHandler(RequestCommand.STATUS_NOTIFICATION, { + await this.ocppRequestService.requestHandler< + StatusNotificationRequest, + StatusNotificationResponse + >(this, RequestCommand.STATUS_NOTIFICATION, { connectorId, status: ChargePointStatus.UNAVAILABLE, errorCode: ChargePointErrorCode.NO_ERROR, @@ -540,6 +560,8 @@ export default class ChargingStation { if (this.getEnableStatistics()) { this.performanceStatistics.stop(); } + this.cache.deleteChargingStationConfiguration(this.configurationFileHash); + this.cache.deleteChargingStationTemplate(this.stationInfo?.templateHash); this.bootNotificationResponse = null; parentPort.postMessage({ id: ChargingStationWorkerMessageEvents.STOPPED, @@ -548,61 +570,84 @@ export default class ChargingStation { this.stopped = true; } - public getConfigurationKey( - key: string | StandardParametersKey, - caseInsensitive = false - ): ConfigurationKey | undefined { - return this.configuration.configurationKey.find((configElement) => { - if (caseInsensitive) { - return configElement.key.toLowerCase() === key.toLowerCase(); - } - return configElement.key === key; - }); + public async reset(reason?: StopTransactionReason): Promise { + await this.stop(reason); + await Utils.sleep(this.stationInfo.resetTime); + this.initialize(); + this.start(); } - public addConfigurationKey( - key: string | StandardParametersKey, - value: string, - options: { readonly?: boolean; visible?: boolean; reboot?: boolean } = { - readonly: false, - visible: true, - reboot: false, - } - ): void { - const keyFound = this.getConfigurationKey(key); - const readonly = options.readonly; - const visible = options.visible; - const reboot = options.reboot; - if (!keyFound) { - this.configuration.configurationKey.push({ - key, - readonly, - value, - visible, - reboot, - }); - } else { - logger.error( - `${this.logPrefix()} Trying to add an already existing configuration key: %j`, - keyFound - ); + public saveOcppConfiguration(): void { + if (this.getOcppPersistentConfiguration()) { + this.saveConfiguration(); } } - public setConfigurationKeyValue(key: string | StandardParametersKey, value: string): void { - const keyFound = this.getConfigurationKey(key); - if (keyFound) { - const keyIndex = this.configuration.configurationKey.indexOf(keyFound); - this.configuration.configurationKey[keyIndex].value = value; - } else { - logger.error( - `${this.logPrefix()} Trying to set a value on a non existing configuration key: %j`, - { key, value } + public getChargingProfilePowerLimit(connectorId: number): number | undefined { + let limit: number, matchingChargingProfile: ChargingProfile; + let chargingProfiles: ChargingProfile[] = []; + // Get charging profiles for connector and sort by stack level + chargingProfiles = this.getConnectorStatus(connectorId).chargingProfiles.sort( + (a, b) => b.stackLevel - a.stackLevel + ); + // Get profiles on connector 0 + if (this.getConnectorStatus(0).chargingProfiles) { + chargingProfiles.push( + ...this.getConnectorStatus(0).chargingProfiles.sort((a, b) => b.stackLevel - a.stackLevel) ); } + if (!Utils.isEmptyArray(chargingProfiles)) { + const result = ChargingStationUtils.getLimitFromChargingProfiles( + chargingProfiles, + Utils.logPrefix() + ); + if (!Utils.isNullOrUndefined(result)) { + limit = result.limit; + matchingChargingProfile = result.matchingChargingProfile; + switch (this.getCurrentOutType()) { + case CurrentType.AC: + limit = + matchingChargingProfile.chargingSchedule.chargingRateUnit === + ChargingRateUnitType.WATT + ? limit + : ACElectricUtils.powerTotal(this.getNumberOfPhases(), this.getVoltageOut(), limit); + break; + case CurrentType.DC: + limit = + matchingChargingProfile.chargingSchedule.chargingRateUnit === + ChargingRateUnitType.WATT + ? limit + : DCElectricUtils.power(this.getVoltageOut(), limit); + } + + const connectorMaximumPower = this.getMaximumPower() / this.powerDivider; + if (limit > connectorMaximumPower) { + logger.error( + `${this.logPrefix()} Charging profile id ${ + matchingChargingProfile.chargingProfileId + } limit is greater than connector id ${connectorId} maximum, dump charging profiles' stack: %j`, + this.getConnectorStatus(connectorId).chargingProfiles + ); + limit = connectorMaximumPower; + } + } + } + return limit; } 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)) { + 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( @@ -635,6 +680,13 @@ export default class ChargingStation { this.stopMeterValues(connectorId); } + public hasFeatureProfile(featureProfile: SupportedFeatureProfiles) { + return ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.SupportedFeatureProfiles + )?.value.includes(featureProfile); + } + public bufferMessage(message: string): void { this.messageBuffer.add(message); } @@ -653,257 +705,329 @@ export default class ChargingStation { return this.stationInfo.supervisionUrlOcppConfiguration ?? false; } - private getChargingStationId(stationTemplate: ChargingStationTemplate): string { - // In case of multiple instances: add instance index to charging station id - const instanceIndex = process.env.CF_INSTANCE_INDEX ?? 0; - const idSuffix = stationTemplate.nameSuffix ?? ''; - const idStr = '000000000' + this.index.toString(); - return stationTemplate.fixedName - ? stationTemplate.baseName - : stationTemplate.baseName + - '-' + - instanceIndex.toString() + - idStr.substring(idStr.length - 4) + - idSuffix; + private getSupervisionUrlOcppKey(): string { + return this.stationInfo.supervisionUrlOcppKey ?? VendorDefaultParametersKey.ConnectionUrl; } - private buildStationInfo(): ChargingStationInfo { - let stationTemplateFromFile: ChargingStationTemplate; + private getTemplateFromFile(): ChargingStationTemplate | null { + let template: ChargingStationTemplate = null; try { - // Load template file - const fileDescriptor = fs.openSync(this.stationTemplateFile, 'r'); - stationTemplateFromFile = JSON.parse( - fs.readFileSync(fileDescriptor, 'utf8') - ) as ChargingStationTemplate; - fs.closeSync(fileDescriptor); + if (this.cache.hasChargingStationTemplate(this.stationInfo?.templateHash)) { + template = this.cache.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.cache.setChargingStationTemplate(template); + } } catch (error) { FileUtils.handleFileException( this.logPrefix(), - 'Template', - this.stationTemplateFile, + FileType.ChargingStationTemplate, + this.templateFile, error as NodeJS.ErrnoException ); } - const chargingStationId = this.getChargingStationId(stationTemplateFromFile); + return template; + } + + private getStationInfoFromTemplate(): ChargingStationInfo { + 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(stationTemplate)) { + const errorMsg = `Empty charging station information from template file ${this.templateFile}`; + logger.error(`${this.logPrefix()} ${errorMsg}`); + throw new BaseError(errorMsg); + } // Deprecation template keys section - this.warnDeprecatedTemplateKey( - stationTemplateFromFile, + ChargingStationUtils.warnDeprecatedTemplateKey( + stationTemplate, 'supervisionUrl', - chargingStationId, + this.templateFile, + this.logPrefix(), "Use 'supervisionUrls' instead" ); - this.convertDeprecatedTemplateKey(stationTemplateFromFile, 'supervisionUrl', 'supervisionUrls'); - const stationInfo: ChargingStationInfo = stationTemplateFromFile ?? ({} as ChargingStationInfo); - stationInfo.wsOptions = stationTemplateFromFile?.wsOptions ?? {}; - if (!Utils.isEmptyArray(stationTemplateFromFile.power)) { - stationTemplateFromFile.power = stationTemplateFromFile.power as number[]; - const powerArrayRandomIndex = Math.floor( - Utils.secureRandom() * stationTemplateFromFile.power.length - ); - stationInfo.maxPower = - stationTemplateFromFile.powerUnit === PowerUnits.KILO_WATT - ? stationTemplateFromFile.power[powerArrayRandomIndex] * 1000 - : stationTemplateFromFile.power[powerArrayRandomIndex]; + ChargingStationUtils.convertDeprecatedTemplateKey( + stationTemplate, + 'supervisionUrl', + 'supervisionUrls' + ); + 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 = + stationTemplate.powerUnit === PowerUnits.KILO_WATT + ? stationTemplate.power[powerArrayRandomIndex] * 1000 + : stationTemplate.power[powerArrayRandomIndex]; } else { - stationTemplateFromFile.power = stationTemplateFromFile.power as number; - stationInfo.maxPower = - stationTemplateFromFile.powerUnit === PowerUnits.KILO_WATT - ? stationTemplateFromFile.power * 1000 - : stationTemplateFromFile.power; - } - delete stationInfo.power; - delete stationInfo.powerUnit; - stationInfo.chargingStationId = chargingStationId; - stationInfo.resetTime = stationTemplateFromFile.resetTime - ? stationTemplateFromFile.resetTime * 1000 + stationTemplate.power = stationTemplate.power as number; + stationInfo.maximumPower = + 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; + this.getStationInfoPersistentConfiguration() && + (stationInfo = this.getConfigurationFromFile()?.stationInfo ?? null); + stationInfo && ChargingStationUtils.createStationInfoHash(stationInfo); return stationInfo; } + private getStationInfo(): ChargingStationInfo { + const stationInfoFromTemplate: ChargingStationInfo = this.getStationInfoFromTemplate(); + 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) { + if (this.stationInfo?.infoHash === stationInfoFromFile?.infoHash) { + return this.stationInfo; + } + return stationInfoFromFile; + } + stationInfoFromFile && + ChargingStationUtils.propagateSerialNumber( + this.getTemplateFromFile(), + stationInfoFromFile, + stationInfoFromTemplate + ); + return stationInfoFromTemplate; + } + + private saveStationInfo(): void { + if (this.getStationInfoPersistentConfiguration()) { + this.saveConfiguration(); + } + } + private getOcppVersion(): OCPPVersion { - return this.stationInfo.ocppVersion ? this.stationInfo.ocppVersion : OCPPVersion.VERSION_16; + return this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16; + } + + private getOcppPersistentConfiguration(): boolean { + return this.stationInfo?.ocppPersistentConfiguration ?? true; + } + + private getStationInfoPersistentConfiguration(): boolean { + return this.stationInfo?.stationInfoPersistentConfiguration ?? true; } private handleUnsupportedVersion(version: OCPPVersion) { const errMsg = `${this.logPrefix()} Unsupported protocol version '${version}' configured in template file ${ - this.stationTemplateFile + this.templateFile }`; logger.error(errMsg); throw new Error(errMsg); } private initialize(): void { - this.stationInfo = this.buildStationInfo(); - this.configuration = this.getTemplateChargingStationConfiguration(); - delete this.stationInfo.Configuration; - this.bootNotificationRequest = { - chargePointModel: this.stationInfo.chargePointModel, - chargePointVendor: this.stationInfo.chargePointVendor, - ...(!Utils.isUndefined(this.stationInfo.chargeBoxSerialNumberPrefix) && { - chargeBoxSerialNumber: this.stationInfo.chargeBoxSerialNumberPrefix, - }), - ...(!Utils.isUndefined(this.stationInfo.firmwareVersion) && { - firmwareVersion: this.stationInfo.firmwareVersion, - }), - }; - // Build connectors if needed - const maxConnectors = this.getMaxNumberOfConnectors(); - if (maxConnectors <= 0) { - logger.warn( - `${this.logPrefix()} Charging station template ${ - this.stationTemplateFile - } with ${maxConnectors} connectors` - ); - } - const templateMaxConnectors = this.getTemplateMaxNumberOfConnectors(); - if (templateMaxConnectors <= 0) { - logger.warn( - `${this.logPrefix()} Charging station template ${ - this.stationTemplateFile - } with no connector configuration` - ); - } - if (!this.stationInfo.Connectors[0]) { - logger.warn( - `${this.logPrefix()} Charging station template ${ - this.stationTemplateFile - } with no connector Id 0 configuration` - ); - } - // Sanity check - 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.stationTemplateFile - }, forcing random connector configurations affectation` + this.hashId = ChargingStationUtils.getHashId(this.index, this.getTemplateFromFile()); + logger.info(`${this.logPrefix()} Charging station hashId '${this.hashId}'`); + this.configurationFile = path.join( + path.resolve(__dirname, '../'), + 'assets', + 'configurations', + this.hashId + '.json' + ); + this.stationInfo = this.getStationInfo(); + this.saveStationInfo(); + // Avoid duplication of connectors related information in RAM + this.stationInfo?.Connectors && delete this.stationInfo.Connectors; + this.configuredSupervisionUrl = this.getConfiguredSupervisionUrl(); + if (this.getEnableStatistics()) { + this.performanceStatistics = PerformanceStatistics.getInstance( + this.hashId, + this.stationInfo.chargingStationId, + this.configuredSupervisionUrl ); - this.stationInfo.randomConnectors = true; - } - const connectorsConfigHash = crypto - .createHash('sha256') - .update(JSON.stringify(this.stationInfo.Connectors) + maxConnectors.toString()) - .digest('hex'); - const connectorsConfigChanged = - this.connectors?.size !== 0 && this.connectorsConfigurationHash !== connectorsConfigHash; - if (this.connectors?.size === 0 || connectorsConfigChanged) { - connectorsConfigChanged && this.connectors.clear(); - this.connectorsConfigurationHash = connectorsConfigHash; - // Add connector Id 0 - let lastConnector = '0'; - for (lastConnector in this.stationInfo.Connectors) { - const lastConnectorId = Utils.convertToInt(lastConnector); - if ( - lastConnectorId === 0 && - this.getUseConnectorId0() && - this.stationInfo.Connectors[lastConnector] - ) { - this.connectors.set( - lastConnectorId, - Utils.cloneObject(this.stationInfo.Connectors[lastConnector]) - ); - this.getConnectorStatus(lastConnectorId).availability = AvailabilityType.OPERATIVE; - if (Utils.isUndefined(this.getConnectorStatus(lastConnectorId)?.chargingProfiles)) { - this.getConnectorStatus(lastConnectorId).chargingProfiles = []; - } - } - } - // Generate all connectors - if ( - (this.stationInfo.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) > 0 - ) { - for (let index = 1; index <= maxConnectors; index++) { - const randConnectorId = this.stationInfo.randomConnectors - ? Utils.getRandomInteger(Utils.convertToInt(lastConnector), 1) - : index; - this.connectors.set( - index, - Utils.cloneObject(this.stationInfo.Connectors[randConnectorId]) - ); - this.getConnectorStatus(index).availability = AvailabilityType.OPERATIVE; - if (Utils.isUndefined(this.getConnectorStatus(index)?.chargingProfiles)) { - this.getConnectorStatus(index).chargingProfiles = []; - } - } - } - } - // Avoid duplication of connectors related information - delete this.stationInfo.Connectors; - // Initialize transaction attributes on connectors - for (const connectorId of this.connectors.keys()) { - if (connectorId > 0 && !this.getConnectorStatus(connectorId)?.transactionStarted) { - this.initializeConnectorStatus(connectorId); - } } - this.wsConfiguredConnectionUrl = new URL( - this.getConfiguredSupervisionUrl().href + '/' + this.stationInfo.chargingStationId + this.bootNotificationRequest = ChargingStationUtils.createBootNotificationRequest( + this.stationInfo ); + this.authorizedTags = ChargingStationUtils.getAuthorizedTags( + this.stationInfo, + this.templateFile, + this.logPrefix() + ); + this.powerDivider = this.getPowerDivider(); + // OCPP configuration + this.ocppConfiguration = this.getOcppConfiguration(); + this.initializeOcppConfiguration(); switch (this.getOcppVersion()) { case OCPPVersion.VERSION_16: this.ocppIncomingRequestService = - OCPP16IncomingRequestService.getInstance(this); + OCPP16IncomingRequestService.getInstance(); this.ocppRequestService = OCPP16RequestService.getInstance( - this, - OCPP16ResponseService.getInstance(this) + OCPP16ResponseService.getInstance() ); break; default: this.handleUnsupportedVersion(this.getOcppVersion()); break; } - // OCPP parameters - this.initOcppParameters(); - 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(); - if (this.getEnableStatistics()) { - this.performanceStatistics = PerformanceStatistics.getInstance( - this.id, - this.stationInfo.chargingStationId, - this.wsConnectionUrl - ); - } } - private initOcppParameters(): void { + private initializeOcppConfiguration(): void { if ( - this.getSupervisionUrlOcppConfiguration() && - !this.getConfigurationKey( - this.stationInfo.supervisionUrlOcppKey ?? VendorDefaultParametersKey.ConnectionUrl + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.HeartbeatInterval ) ) { - this.addConfigurationKey( - VendorDefaultParametersKey.ConnectionUrl, - this.getConfiguredSupervisionUrl().href, + ChargingStationConfigurationUtils.addConfigurationKey( + this, + StandardParametersKey.HeartbeatInterval, + '0' + ); + } + if ( + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.HeartBeatInterval + ) + ) { + ChargingStationConfigurationUtils.addConfigurationKey( + this, + StandardParametersKey.HeartBeatInterval, + '0', + { visible: false } + ); + } + if ( + this.getSupervisionUrlOcppConfiguration() && + !ChargingStationConfigurationUtils.getConfigurationKey(this, this.getSupervisionUrlOcppKey()) + ) { + ChargingStationConfigurationUtils.addConfigurationKey( + this, + this.getSupervisionUrlOcppKey(), + this.configuredSupervisionUrl.href, { reboot: true } ); + } else if ( + !this.getSupervisionUrlOcppConfiguration() && + ChargingStationConfigurationUtils.getConfigurationKey(this, this.getSupervisionUrlOcppKey()) + ) { + ChargingStationConfigurationUtils.deleteConfigurationKey( + this, + this.getSupervisionUrlOcppKey(), + { save: false } + ); + } + if ( + this.stationInfo.amperageLimitationOcppKey && + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + this.stationInfo.amperageLimitationOcppKey + ) + ) { + ChargingStationConfigurationUtils.addConfigurationKey( + this, + this.stationInfo.amperageLimitationOcppKey, + ( + this.stationInfo.maximumAmperage * + ChargingStationUtils.getAmperageLimitationUnitDivider(this.stationInfo) + ).toString() + ); } - if (!this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles)) { - this.addConfigurationKey( + if ( + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.SupportedFeatureProfiles + ) + ) { + ChargingStationConfigurationUtils.addConfigurationKey( + this, StandardParametersKey.SupportedFeatureProfiles, - `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.Local_Auth_List_Management},${SupportedFeatureProfiles.Smart_Charging}` + `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.FirmwareManagement},${SupportedFeatureProfiles.LocalAuthListManagement},${SupportedFeatureProfiles.SmartCharging},${SupportedFeatureProfiles.RemoteTrigger}` ); } - this.addConfigurationKey( + ChargingStationConfigurationUtils.addConfigurationKey( + this, StandardParametersKey.NumberOfConnectors, this.getNumberOfConnectors().toString(), - { readonly: true } + { readonly: true }, + { overwrite: true } ); - if (!this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData)) { - this.addConfigurationKey( + if ( + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.MeterValuesSampledData + ) + ) { + ChargingStationConfigurationUtils.addConfigurationKey( + this, StandardParametersKey.MeterValuesSampledData, MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER ); } - if (!this.getConfigurationKey(StandardParametersKey.ConnectorPhaseRotation)) { + if ( + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.ConnectorPhaseRotation + ) + ) { const connectorPhaseRotation = []; for (const connectorId of this.connectors.keys()) { // AC/DC @@ -918,80 +1042,294 @@ export default class ChargingStation { connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.RST}`); } } - this.addConfigurationKey( + ChargingStationConfigurationUtils.addConfigurationKey( + this, StandardParametersKey.ConnectorPhaseRotation, connectorPhaseRotation.toString() ); } - if (!this.getConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests)) { - this.addConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests, 'true'); - } if ( - !this.getConfigurationKey(StandardParametersKey.LocalAuthListEnabled) && - this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles).value.includes( - SupportedFeatureProfiles.Local_Auth_List_Management + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.AuthorizeRemoteTxRequests ) ) { - this.addConfigurationKey(StandardParametersKey.LocalAuthListEnabled, 'false'); + ChargingStationConfigurationUtils.addConfigurationKey( + this, + StandardParametersKey.AuthorizeRemoteTxRequests, + 'true' + ); + } + if ( + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.LocalAuthListEnabled + ) && + ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.SupportedFeatureProfiles + )?.value.includes(SupportedFeatureProfiles.LocalAuthListManagement) + ) { + ChargingStationConfigurationUtils.addConfigurationKey( + this, + StandardParametersKey.LocalAuthListEnabled, + 'false' + ); } - if (!this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) { - this.addConfigurationKey( + if ( + !ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.ConnectionTimeOut + ) + ) { + ChargingStationConfigurationUtils.addConfigurationKey( + this, StandardParametersKey.ConnectionTimeOut, Constants.DEFAULT_CONNECTION_TIMEOUT.toString() ); } + this.saveOcppConfiguration(); } - private async onOpen(): Promise { - logger.info( - `${this.logPrefix()} Connected to OCPP server through ${this.wsConnectionUrl.toString()}` - ); - if (!this.isInAcceptedState()) { - // Send BootNotification - let registrationRetryCount = 0; - do { - this.bootNotificationResponse = (await this.ocppRequestService.sendMessageHandler( - RequestCommand.BOOT_NOTIFICATION, - { - chargePointModel: this.bootNotificationRequest.chargePointModel, - chargePointVendor: this.bootNotificationRequest.chargePointVendor, - chargeBoxSerialNumber: this.bootNotificationRequest.chargeBoxSerialNumber, - firmwareVersion: this.bootNotificationRequest.firmwareVersion, - chargePointSerialNumber: this.bootNotificationRequest.chargePointSerialNumber, - iccid: this.bootNotificationRequest.iccid, - imsi: this.bootNotificationRequest.imsi, - meterSerialNumber: this.bootNotificationRequest.meterSerialNumber, - meterType: this.bootNotificationRequest.meterType, - }, - { skipBufferingOnError: true } - )) as BootNotificationResponse; - if (!this.isInAcceptedState()) { - this.getRegistrationMaxRetries() !== -1 && registrationRetryCount++; - await Utils.sleep( - this.bootNotificationResponse?.interval - ? this.bootNotificationResponse.interval * 1000 - : Constants.OCPP_DEFAULT_BOOT_NOTIFICATION_INTERVAL - ); + private initializeConnectors( + stationInfo: ChargingStationInfo, + configuredMaxConnectors: number, + templateMaxConnectors: number + ): void { + if (!stationInfo?.Connectors && this.connectors.size === 0) { + const logMsg = `${this.logPrefix()} No already defined connectors and charging station information from template ${ + this.templateFile + } with no connectors configuration defined`; + logger.error(logMsg); + throw new BaseError(logMsg); + } + if (!stationInfo?.Connectors[0]) { + logger.warn( + `${this.logPrefix()} Charging station information from template ${ + this.templateFile + } with no connector Id 0 configuration` + ); + } + if (stationInfo?.Connectors) { + const connectorsConfigHash = crypto + .createHash(Constants.DEFAULT_HASH_ALGORITHM) + .update(JSON.stringify(stationInfo?.Connectors) + configuredMaxConnectors.toString()) + .digest('hex'); + const connectorsConfigChanged = + this.connectors?.size !== 0 && this.connectorsConfigurationHash !== connectorsConfigHash; + if (this.connectors?.size === 0 || connectorsConfigChanged) { + connectorsConfigChanged && this.connectors.clear(); + this.connectorsConfigurationHash = connectorsConfigHash; + // Add connector Id 0 + let lastConnector = '0'; + for (lastConnector in stationInfo?.Connectors) { + const lastConnectorId = Utils.convertToInt(lastConnector); + if ( + lastConnectorId === 0 && + this.getUseConnectorId0(stationInfo) && + stationInfo?.Connectors[lastConnector] + ) { + this.connectors.set( + lastConnectorId, + Utils.cloneObject(stationInfo?.Connectors[lastConnector]) + ); + this.getConnectorStatus(lastConnectorId).availability = AvailabilityType.OPERATIVE; + if (Utils.isUndefined(this.getConnectorStatus(lastConnectorId)?.chargingProfiles)) { + this.getConnectorStatus(lastConnectorId).chargingProfiles = []; + } + } + } + // Generate all connectors + if ((stationInfo?.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) > 0) { + for (let index = 1; index <= configuredMaxConnectors; index++) { + const randConnectorId = stationInfo?.randomConnectors + ? Utils.getRandomInteger(Utils.convertToInt(lastConnector), 1) + : index; + this.connectors.set( + index, + Utils.cloneObject(stationInfo?.Connectors[randConnectorId]) + ); + this.getConnectorStatus(index).availability = AvailabilityType.OPERATIVE; + if (Utils.isUndefined(this.getConnectorStatus(index)?.chargingProfiles)) { + this.getConnectorStatus(index).chargingProfiles = []; + } + } } - } while ( - !this.isInAcceptedState() && - (registrationRetryCount <= this.getRegistrationMaxRetries() || - this.getRegistrationMaxRetries() === -1) + } + } else { + logger.warn( + `${this.logPrefix()} Charging station information from template ${ + this.templateFile + } with no connectors configuration defined, using already defined connectors` ); } - if (this.isInAcceptedState()) { - await this.startMessageSequence(); - this.stopped && (this.stopped = false); - if (this.wsConnectionRestarted && this.isWebSocketConnectionOpened()) { - this.flushMessageBuffer(); + // Initialize transaction attributes on connectors + for (const connectorId of this.connectors.keys()) { + if (connectorId > 0 && !this.getConnectorStatus(connectorId)?.transactionStarted) { + this.initializeConnectorStatus(connectorId); + } + } + } + + private getConfigurationFromFile(): ChargingStationConfiguration | null { + let configuration: ChargingStationConfiguration = null; + if (this.configurationFile && fs.existsSync(this.configurationFile)) { + try { + if (this.cache.hasChargingStationConfiguration(this.configurationFileHash)) { + configuration = this.cache.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.cache.setChargingStationConfiguration(configuration); + } + } catch (error) { + FileUtils.handleFileException( + this.logPrefix(), + FileType.ChargingStationConfiguration, + this.configurationFile, + error as NodeJS.ErrnoException + ); + } + } + return configuration; + } + + private saveConfiguration(): void { + if (this.configurationFile) { + try { + if (!fs.existsSync(path.dirname(this.configurationFile))) { + fs.mkdirSync(path.dirname(this.configurationFile), { recursive: true }); + } + const configurationData: ChargingStationConfiguration = + this.getConfigurationFromFile() ?? {}; + 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.cache.deleteChargingStationConfiguration(this.configurationFileHash); + this.configurationFileHash = configurationHash; + this.cache.setChargingStationConfiguration(configurationData); + } else { + logger.debug( + `${this.logPrefix()} Not saving unchanged charging station configuration file ${ + this.configurationFile + }` + ); + } + } catch (error) { + FileUtils.handleFileException( + this.logPrefix(), + FileType.ChargingStationConfiguration, + this.configurationFile, + error as NodeJS.ErrnoException + ); } } else { logger.error( - `${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})` + `${this.logPrefix()} Trying to save charging station configuration to undefined configuration file` + ); + } + } + + private getOcppConfigurationFromTemplate(): ChargingStationOcppConfiguration | null { + return this.getTemplateFromFile()?.Configuration ?? null; + } + + private getOcppConfigurationFromFile(): ChargingStationOcppConfiguration | null { + let configuration: ChargingStationConfiguration = null; + if (this.getOcppPersistentConfiguration()) { + const configurationFromFile = this.getConfigurationFromFile(); + configuration = configurationFromFile?.configurationKey && configurationFromFile; + } + configuration && delete configuration.stationInfo; + return configuration; + } + + private getOcppConfiguration(): ChargingStationOcppConfiguration | null { + let ocppConfiguration: ChargingStationOcppConfiguration = this.getOcppConfigurationFromFile(); + if (!ocppConfiguration) { + ocppConfiguration = this.getOcppConfigurationFromTemplate(); + } + return ocppConfiguration; + } + + private async onOpen(): Promise { + if (this.isWebSocketConnectionOpened()) { + logger.info( + `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} succeeded` + ); + if (!this.isRegistered()) { + // Send BootNotification + let registrationRetryCount = 0; + do { + this.bootNotificationResponse = await this.ocppRequestService.requestHandler< + BootNotificationRequest, + BootNotificationResponse + >( + this, + RequestCommand.BOOT_NOTIFICATION, + { + chargePointModel: this.bootNotificationRequest.chargePointModel, + chargePointVendor: this.bootNotificationRequest.chargePointVendor, + chargeBoxSerialNumber: this.bootNotificationRequest.chargeBoxSerialNumber, + firmwareVersion: this.bootNotificationRequest.firmwareVersion, + chargePointSerialNumber: this.bootNotificationRequest.chargePointSerialNumber, + iccid: this.bootNotificationRequest.iccid, + imsi: this.bootNotificationRequest.imsi, + meterSerialNumber: this.bootNotificationRequest.meterSerialNumber, + meterType: this.bootNotificationRequest.meterType, + }, + { skipBufferingOnError: true } + ); + if (!this.isRegistered()) { + this.getRegistrationMaxRetries() !== -1 && registrationRetryCount++; + await Utils.sleep( + this.bootNotificationResponse?.interval + ? this.bootNotificationResponse.interval * 1000 + : Constants.OCPP_DEFAULT_BOOT_NOTIFICATION_INTERVAL + ); + } + } while ( + !this.isRegistered() && + (registrationRetryCount <= this.getRegistrationMaxRetries() || + this.getRegistrationMaxRetries() === -1) + ); + } + if (this.isRegistered()) { + if (this.isInAcceptedState()) { + 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.stopped && (this.stopped = false); + this.autoReconnectRetryCount = 0; + this.wsConnectionRestarted = false; + } else { + logger.warn( + `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} failed` ); } - this.autoReconnectRetryCount = 0; - this.wsConnectionRestarted = false; } private async onClose(code: number, reason: string): Promise { @@ -1000,7 +1338,7 @@ export default class ChargingStation { case WebSocketCloseEventStatusCode.CLOSE_NORMAL: case WebSocketCloseEventStatusCode.CLOSE_NO_STATUS: logger.info( - `${this.logPrefix()} WebSocket normally closed with status '${Utils.getWebSocketCloseEventStatusString( + `${this.logPrefix()} WebSocket normally closed with status '${ChargingStationUtils.getWebSocketCloseEventStatusString( code )}' and reason '${reason}'` ); @@ -1009,7 +1347,7 @@ export default class ChargingStation { // Abnormal close default: logger.error( - `${this.logPrefix()} WebSocket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString( + `${this.logPrefix()} WebSocket abnormally closed with status '${ChargingStationUtils.getWebSocketCloseEventStatusString( code )}' and reason '${reason}'` ); @@ -1019,100 +1357,116 @@ export default class ChargingStation { } private async onMessage(data: Data): Promise { - let [messageType, messageId, commandName, commandPayload, errorDetails]: IncomingRequest = [ - 0, - '', - '' as IncomingRequestCommand, - {}, - {}, - ]; - let responseCallback: ( - payload: JsonType | string, - requestPayload: JsonType | OCPPError - ) => void; - let rejectCallback: (error: OCPPError, requestStatistic?: boolean) => void; + let messageType: number; + let messageId: string; + let commandName: IncomingRequestCommand; + let commandPayload: JsonType; + let errorType: ErrorType; + let errorMessage: string; + let errorDetails: JsonType; + let responseCallback: (payload: JsonType, requestPayload: JsonType) => void; + let errorCallback: (error: OCPPError, requestStatistic?: boolean) => void; let requestCommandName: RequestCommand | IncomingRequestCommand; - let requestPayload: JsonType | OCPPError; + let requestPayload: JsonType; let cachedRequest: CachedRequest; let errMsg: string; try { - const request = JSON.parse(data.toString()) as IncomingRequest; + const request = JSON.parse(data.toString()) as IncomingRequest | Response | ErrorResponse; if (Utils.isIterable(request)) { - // Parse the message - [messageType, messageId, commandName, commandPayload, errorDetails] = request; - } else { - throw new OCPPError( - ErrorType.PROTOCOL_ERROR, - 'Incoming request is not iterable', - commandName - ); - } - // Check the Type of message - switch (messageType) { - // Incoming Message - case MessageType.CALL_MESSAGE: - if (this.getEnableStatistics()) { - this.performanceStatistics.addRequestStatistic(commandName, messageType); - } - // Process the call - await this.ocppIncomingRequestService.handleRequest( - messageId, - commandName, - commandPayload - ); - break; - // Outcome Message - case MessageType.CALL_RESULT_MESSAGE: - // Respond - cachedRequest = this.requests.get(messageId); - if (Utils.isIterable(cachedRequest)) { - [responseCallback, , , requestPayload] = cachedRequest; - } else { - throw new OCPPError( - ErrorType.PROTOCOL_ERROR, - `Cached request for message id ${messageId} response is not iterable`, - commandName + [messageType, messageId] = request; + // Check the type of message + switch (messageType) { + // Incoming Message + case MessageType.CALL_MESSAGE: + [, , commandName, commandPayload] = request as IncomingRequest; + if (this.getEnableStatistics()) { + this.performanceStatistics.addRequestStatistic(commandName, messageType); + } + logger.debug( + `${this.logPrefix()} << Command '${commandName}' received request payload: ${JSON.stringify( + request + )}` ); - } - if (!responseCallback) { - // Error - throw new OCPPError( - ErrorType.INTERNAL_ERROR, - `Response for unknown message id ${messageId}`, - commandName + // Process the message + await this.ocppIncomingRequestService.incomingRequestHandler( + this, + messageId, + commandName, + commandPayload ); - } - responseCallback(commandName, requestPayload); - break; - // Error Message - case MessageType.CALL_ERROR_MESSAGE: - cachedRequest = this.requests.get(messageId); - if (Utils.isIterable(cachedRequest)) { - [, rejectCallback, requestCommandName] = cachedRequest; - } else { - throw new OCPPError( - ErrorType.PROTOCOL_ERROR, - `Cached request for message id ${messageId} error response is not iterable` + break; + // Outcome Message + case MessageType.CALL_RESULT_MESSAGE: + [, , commandPayload] = request as Response; + if (!this.requests.has(messageId)) { + // Error + throw new OCPPError( + ErrorType.INTERNAL_ERROR, + `Response for unknown message id ${messageId}`, + null, + commandPayload + ); + } + // Respond + cachedRequest = this.requests.get(messageId); + if (Utils.isIterable(cachedRequest)) { + [responseCallback, , requestCommandName, requestPayload] = cachedRequest; + } else { + throw new OCPPError( + ErrorType.PROTOCOL_ERROR, + `Cached request for message id ${messageId} response is not iterable`, + null, + cachedRequest as unknown as JsonType + ); + } + logger.debug( + `${this.logPrefix()} << Command '${ + requestCommandName ?? '' + }' received response payload: ${JSON.stringify(request)}` ); - } - if (!rejectCallback) { - // Error - throw new OCPPError( - ErrorType.INTERNAL_ERROR, - `Error response for unknown message id ${messageId}`, - requestCommandName + responseCallback(commandPayload, requestPayload); + break; + // Error Message + case MessageType.CALL_ERROR_MESSAGE: + [, , errorType, errorMessage, errorDetails] = request as ErrorResponse; + if (!this.requests.has(messageId)) { + // Error + throw new OCPPError( + ErrorType.INTERNAL_ERROR, + `Error response for unknown message id ${messageId}`, + null, + { errorType, errorMessage, errorDetails } + ); + } + cachedRequest = this.requests.get(messageId); + if (Utils.isIterable(cachedRequest)) { + [, errorCallback, requestCommandName] = cachedRequest; + } else { + throw new OCPPError( + ErrorType.PROTOCOL_ERROR, + `Cached request for message id ${messageId} error response is not iterable`, + null, + cachedRequest as unknown as JsonType + ); + } + logger.debug( + `${this.logPrefix()} << Command '${ + requestCommandName ?? '' + }' received error payload: ${JSON.stringify(request)}` ); - } - rejectCallback( - new OCPPError(commandName, commandPayload.toString(), requestCommandName, errorDetails) - ); - break; - // Error - default: - // eslint-disable-next-line @typescript-eslint/restrict-template-expressions - errMsg = `${this.logPrefix()} Wrong message type ${messageType}`; - logger.error(errMsg); - throw new OCPPError(ErrorType.PROTOCOL_ERROR, errMsg); + errorCallback(new OCPPError(errorType, errorMessage, requestCommandName, errorDetails)); + break; + // Error + default: + // eslint-disable-next-line @typescript-eslint/restrict-template-expressions + errMsg = `${this.logPrefix()} Wrong message type ${messageType}`; + logger.error(errMsg); + throw new OCPPError(ErrorType.PROTOCOL_ERROR, errMsg); + } + } else { + throw new OCPPError(ErrorType.PROTOCOL_ERROR, 'Incoming message is not iterable', null, { + payload: request, + }); } } catch (error) { // Log @@ -1125,7 +1479,12 @@ export default class ChargingStation { ); // Send error messageType === MessageType.CALL_MESSAGE && - (await this.ocppRequestService.sendError(messageId, error as OCPPError, commandName)); + (await this.ocppRequestService.sendError( + this, + messageId, + error as OCPPError, + commandName ?? requestCommandName ?? null + )); } } @@ -1141,51 +1500,10 @@ export default class ChargingStation { logger.error(this.logPrefix() + ' WebSocket error: %j', error); } - private getTemplateChargingStationConfiguration(): ChargingStationConfiguration { - return this.stationInfo.Configuration ?? ({} as ChargingStationConfiguration); - } - - private getAuthorizationFile(): string | undefined { - return ( - this.stationInfo.authorizationFile && - path.join( - path.resolve(__dirname, '../'), - 'assets', - path.basename(this.stationInfo.authorizationFile) - ) - ); - } - - private getAuthorizedTags(): string[] { - let authorizedTags: string[] = []; - const authorizationFile = this.getAuthorizationFile(); - if (authorizationFile) { - try { - // Load authorization file - const fileDescriptor = fs.openSync(authorizationFile, 'r'); - authorizedTags = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as string[]; - fs.closeSync(fileDescriptor); - } catch (error) { - FileUtils.handleFileException( - this.logPrefix(), - 'Authorization', - authorizationFile, - error as NodeJS.ErrnoException - ); - } - } else { - logger.info( - this.logPrefix() + - ' No authorization file given in template file ' + - this.stationTemplateFile - ); - } - 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; } @@ -1201,10 +1519,19 @@ export default class ChargingStation { // 0 for disabling private getConnectionTimeout(): number | undefined { - if (this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) { + if ( + ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.ConnectionTimeOut + ) + ) { return ( - parseInt(this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut).value) ?? - Constants.DEFAULT_CONNECTION_TIMEOUT + parseInt( + ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.ConnectionTimeOut + ).value + ) ?? Constants.DEFAULT_CONNECTION_TIMEOUT ); } return Constants.DEFAULT_CONNECTION_TIMEOUT; @@ -1231,35 +1558,57 @@ 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 { - 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(); + private getMaximumAmperage(stationInfo: ChargingStationInfo): number | undefined { + const maximumPower = this.getMaximumPower(stationInfo); + switch (this.getCurrentOutType(stationInfo)) { + case CurrentType.AC: + return ACElectricUtils.amperagePerPhaseFromPower( + this.getNumberOfPhases(stationInfo), + maximumPower / this.getNumberOfConnectors(), + this.getVoltageOut(stationInfo) + ); + case CurrentType.DC: + return DCElectricUtils.amperage(maximumPower, this.getVoltageOut(stationInfo)); + } + } + + private getAmperageLimitation(): number | undefined { + if ( + this.stationInfo.amperageLimitationOcppKey && + ChargingStationConfigurationUtils.getConfigurationKey( + this, + this.stationInfo.amperageLimitationOcppKey + ) + ) { + return ( + Utils.convertToInt( + ChargingStationConfigurationUtils.getConfigurationKey( + this, + this.stationInfo.amperageLimitationOcppKey + ).value + ) / ChargingStationUtils.getAmperageLimitationUnitDivider(this.stationInfo) + ); } - return maxConnectors; } private async startMessageSequence(): Promise { - if (this.stationInfo.autoRegister) { - await this.ocppRequestService.sendMessageHandler( + if (this.stationInfo?.autoRegister) { + await this.ocppRequestService.requestHandler< + BootNotificationRequest, + BootNotificationResponse + >( + this, RequestCommand.BOOT_NOTIFICATION, { chargePointModel: this.bootNotificationRequest.chargePointModel, @@ -1289,7 +1638,10 @@ export default class ChargingStation { this.getConnectorStatus(connectorId)?.bootStatus ) { // Send status in template at startup - await this.ocppRequestService.sendMessageHandler(RequestCommand.STATUS_NOTIFICATION, { + await this.ocppRequestService.requestHandler< + StatusNotificationRequest, + StatusNotificationResponse + >(this, RequestCommand.STATUS_NOTIFICATION, { connectorId, status: this.getConnectorStatus(connectorId).bootStatus, errorCode: ChargePointErrorCode.NO_ERROR, @@ -1302,7 +1654,10 @@ export default class ChargingStation { this.getConnectorStatus(connectorId)?.bootStatus ) { // Send status in template after reset - await this.ocppRequestService.sendMessageHandler(RequestCommand.STATUS_NOTIFICATION, { + await this.ocppRequestService.requestHandler< + StatusNotificationRequest, + StatusNotificationResponse + >(this, RequestCommand.STATUS_NOTIFICATION, { connectorId, status: this.getConnectorStatus(connectorId).bootStatus, errorCode: ChargePointErrorCode.NO_ERROR, @@ -1311,14 +1666,20 @@ export default class ChargingStation { this.getConnectorStatus(connectorId).bootStatus; } else if (!this.stopped && this.getConnectorStatus(connectorId)?.status) { // Send previous status at template reload - await this.ocppRequestService.sendMessageHandler(RequestCommand.STATUS_NOTIFICATION, { + await this.ocppRequestService.requestHandler< + StatusNotificationRequest, + StatusNotificationResponse + >(this, RequestCommand.STATUS_NOTIFICATION, { connectorId, status: this.getConnectorStatus(connectorId).status, errorCode: ChargePointErrorCode.NO_ERROR, }); } else { // Send default status - await this.ocppRequestService.sendMessageHandler(RequestCommand.STATUS_NOTIFICATION, { + await this.ocppRequestService.requestHandler< + StatusNotificationRequest, + StatusNotificationResponse + >(this, RequestCommand.STATUS_NOTIFICATION, { connectorId, status: ChargePointStatus.AVAILABLE, errorCode: ChargePointErrorCode.NO_ERROR, @@ -1331,9 +1692,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(); @@ -1341,6 +1705,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 { @@ -1348,12 +1719,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) { @@ -1369,13 +1737,20 @@ export default class ChargingStation { connectorId, this.getEnergyActiveImportRegisterByTransactionId(transactionId) ); - await this.ocppRequestService.sendMessageHandler(RequestCommand.METER_VALUES, { - connectorId, - transactionId, - meterValue: transactionEndMeterValue, - }); + await this.ocppRequestService.requestHandler( + this, + RequestCommand.METER_VALUES, + { + connectorId, + transactionId, + meterValue: transactionEndMeterValue, + } + ); } - await this.ocppRequestService.sendMessageHandler(RequestCommand.STOP_TRANSACTION, { + await this.ocppRequestService.requestHandler< + StopTransactionRequest, + StopTransactionResponse + >(this, RequestCommand.STOP_TRANSACTION, { transactionId, meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId), idTag: this.getTransactionIdTag(transactionId), @@ -1387,11 +1762,15 @@ export default class ChargingStation { } private startWebSocketPing(): void { - const webSocketPingInterval: number = this.getConfigurationKey( + const webSocketPingInterval: number = ChargingStationConfigurationUtils.getConfigurationKey( + this, StandardParametersKey.WebSocketPingInterval ) ? Utils.convertToInt( - this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval).value + ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.WebSocketPingInterval + ).value ) : 0; if (webSocketPingInterval > 0 && !this.webSocketPingSetInterval) { @@ -1431,33 +1810,6 @@ export default class ChargingStation { } } - private warnDeprecatedTemplateKey( - template: ChargingStationTemplate, - key: string, - chargingStationId: string, - logMsgToAppend = '' - ): void { - if (!Utils.isUndefined(template[key])) { - const logPrefixStr = ` ${chargingStationId} |`; - logger.warn( - `${Utils.logPrefix(logPrefixStr)} Deprecated template key '${key}' usage in file '${ - this.stationTemplateFile - }'${logMsgToAppend && '. ' + logMsgToAppend}` - ); - } - } - - private convertDeprecatedTemplateKey( - template: ChargingStationTemplate, - deprecatedKey: string, - key: string - ): void { - if (!Utils.isUndefined(template[deprecatedKey])) { - template[key] = template[deprecatedKey] as unknown; - delete template[deprecatedKey]; - } - } - private getConfiguredSupervisionUrl(): URL { const supervisionUrls = Utils.cloneObject( this.stationInfo.supervisionUrls ?? Configuration.getSupervisionUrls() @@ -1496,15 +1848,21 @@ export default class ChargingStation { } private getHeartbeatInterval(): number | undefined { - const HeartbeatInterval = this.getConfigurationKey(StandardParametersKey.HeartbeatInterval); + const HeartbeatInterval = ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.HeartbeatInterval + ); if (HeartbeatInterval) { return Utils.convertToInt(HeartbeatInterval.value) * 1000; } - const HeartBeatInterval = this.getConfigurationKey(StandardParametersKey.HeartBeatInterval); + const HeartBeatInterval = ChargingStationConfigurationUtils.getConfigurationKey( + this, + StandardParametersKey.HeartBeatInterval + ); 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 @@ -1520,7 +1878,7 @@ export default class ChargingStation { } private openWSConnection( - options: ClientOptions & ClientRequestArgs = this.stationInfo.wsOptions, + options: WsOptions = this.stationInfo?.wsOptions ?? {}, forceCloseOpened = false ): void { options.handshakeTimeout = options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000; @@ -1554,89 +1912,6 @@ export default class ChargingStation { } } - private startAuthorizationFileMonitoring(): void { - const authorizationFile = this.getAuthorizationFile(); - if (authorizationFile) { - try { - fs.watch(authorizationFile, (event, filename) => { - if (filename && event === 'change') { - try { - logger.debug( - this.logPrefix() + - ' Authorization file ' + - authorizationFile + - ' have changed, reload' - ); - // Initialize authorizedTags - this.authorizedTags = this.getAuthorizedTags(); - } catch (error) { - logger.error(this.logPrefix() + ' Authorization file monitoring error: %j', error); - } - } - }); - } catch (error) { - FileUtils.handleFileException( - this.logPrefix(), - 'Authorization', - authorizationFile, - error as NodeJS.ErrnoException - ); - } - } else { - logger.info( - this.logPrefix() + - ' No authorization file given in template file ' + - this.stationTemplateFile + - '. Not monitoring changes' - ); - } - } - - private startStationTemplateFileMonitoring(): void { - try { - fs.watch(this.stationTemplateFile, (event, filename): void => { - if (filename && event === 'change') { - try { - logger.debug( - this.logPrefix() + - ' Template file ' + - this.stationTemplateFile + - ' have changed, reload' - ); - // Initialize - this.initialize(); - // Restart the ATG - if ( - !this.stationInfo.AutomaticTransactionGenerator.enable && - this.automaticTransactionGenerator - ) { - this.automaticTransactionGenerator.stop(); - } - 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() + ' Charging station template file monitoring error: %j', - error - ); - } - } - }); - } catch (error) { - FileUtils.handleFileException( - this.logPrefix(), - 'Template', - this.stationTemplateFile, - error as NodeJS.ErrnoException - ); - } - } - private getReconnectExponentialDelay(): boolean | undefined { return !Utils.isUndefined(this.stationInfo.reconnectExponentialDelay) ? this.stationInfo.reconnectExponentialDelay @@ -1649,12 +1924,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() || @@ -1678,19 +1949,23 @@ export default class ChargingStation { this.autoReconnectRetryCount.toString() ); this.openWSConnection( - { ...this.stationInfo.wsOptions, handshakeTimeout: reconnectTimeout }, + { ...(this.stationInfo?.wsOptions ?? {}), handshakeTimeout: reconnectTimeout }, true ); this.wsConnectionRestarted = true; } else if (this.getAutoReconnectMaxRetries() !== -1) { logger.error( - `${this.logPrefix()} WebSocket reconnect failure: max retries reached (${ + `${this.logPrefix()} WebSocket reconnect failure: maximum retries reached (${ this.autoReconnectRetryCount }) or retry disabled (${this.getAutoReconnectMaxRetries()})` ); } } + private getAutomaticTransactionGeneratorConfigurationFromTemplate(): AutomaticTransactionGeneratorConfiguration | null { + return this.getTemplateFromFile()?.AutomaticTransactionGenerator ?? null; + } + private initializeConnectorStatus(connectorId: number): void { this.getConnectorStatus(connectorId).idTagLocalAuthorized = false; this.getConnectorStatus(connectorId).idTagAuthorized = false;