X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FChargingStation.ts;h=3051abb7065de6382b2ffd7f2ba6d88c9bb23685;hb=98c19a0738935a04ceedd45ccd198769ef91f035;hp=75094ceb104f538d92d1882c5145b3cf18fd664e;hpb=a95873d8d308a20a7151346ac70d9a551f1a06f5;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ChargingStation.ts b/src/charging-station/ChargingStation.ts index 75094ceb..3051abb7 100644 --- a/src/charging-station/ChargingStation.ts +++ b/src/charging-station/ChargingStation.ts @@ -1,5 +1,6 @@ // Partial Copyright Jerome Benoit. 2021. All Rights Reserved. +import { ACElectricUtils, DCElectricUtils } from '../utils/ElectricUtils'; import { AvailabilityType, BootNotificationRequest, @@ -8,14 +9,28 @@ import { IncomingRequestCommand, RequestCommand, } from '../types/ocpp/Requests'; -import { BootNotificationResponse, RegistrationStatus } from '../types/ocpp/Responses'; -import ChargingStationConfiguration, { +import { + BootNotificationResponse, + HeartbeatResponse, + MeterValuesResponse, + RegistrationStatus, + StatusNotificationResponse, +} from '../types/ocpp/Responses'; +import { + ChargingProfile, + ChargingRateUnitType, + ChargingSchedulePeriod, +} from '../types/ocpp/ChargingProfile'; +import ChargingStationConfiguration, { Section } from '../types/ChargingStationConfiguration'; +import ChargingStationOcppConfiguration, { ConfigurationKey, -} from '../types/ChargingStationConfiguration'; +} from '../types/ChargingStationOcppConfiguration'; import ChargingStationTemplate, { + AmpereUnits, CurrentType, PowerUnits, Voltage, + WsOptions, } from '../types/ChargingStationTemplate'; import { ConnectorPhaseRotation, @@ -24,16 +39,15 @@ import { VendorDefaultParametersKey, } from '../types/ocpp/Configuration'; import { MeterValue, MeterValueMeasurand, MeterValuePhase } from '../types/ocpp/MeterValues'; +import { StopTransactionReason, 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 { ChargePointErrorCode } from '../types/ocpp/ChargePointErrorCode'; import { ChargePointStatus } from '../types/ocpp/ChargePointStatus'; -import { ChargingProfile } from '../types/ocpp/ChargingProfile'; import ChargingStationInfo from '../types/ChargingStationInfo'; import { ChargingStationWorkerMessageEvents } from '../types/ChargingStationWorker'; -import { ClientRequestArgs } from 'http'; import Configuration from '../utils/Configuration'; import { ConnectorStatus } from '../types/ConnectorStatus'; import Constants from '../utils/Constants'; @@ -52,7 +66,6 @@ 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'; @@ -63,21 +76,21 @@ 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; private readonly index: number; private configurationFile!: string; private bootNotificationRequest!: BootNotificationRequest; - private bootNotificationResponse!: BootNotificationResponse | null; private connectorsConfigurationHash!: string; private ocppIncomingRequestService!: OCPPIncomingRequestService; private readonly messageBuffer: Set; @@ -88,10 +101,9 @@ export default class ChargingStation { 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; @@ -102,12 +114,10 @@ export default class ChargingStation { this.authorizedTags = this.getAuthorizedTags(); } - get wsConnectionUrl(): URL { + private get wsConnectionUrl(): URL { return this.getSupervisionUrlOcppConfiguration() ? new URL( - this.getConfigurationKey( - this.stationInfo.supervisionUrlOcppKey ?? VendorDefaultParametersKey.ConnectionUrl - ).value + + this.getConfigurationKey(this.getSupervisionUrlOcppKey()).value + '/' + this.stationInfo.chargingStationId ) @@ -206,7 +216,7 @@ export default class ChargingStation { public getVoltageOut(): number | undefined { const errMsg = `${this.logPrefix()} Unknown ${this.getCurrentOutType()} currentOutType in template file ${ - this.stationTemplateFile + this.templateFile }, cannot define default voltage out`; let defaultVoltageOut: number; switch (this.getCurrentOutType()) { @@ -225,6 +235,33 @@ export default class ChargingStation { : defaultVoltageOut; } + public getConnectorMaximumAvailablePower(connectorId: number): number { + let amperageLimitationPowerLimit: number; + if (this.getAmperageLimitation() < this.stationInfo.maximumAmperage) { + amperageLimitationPowerLimit = + this.getCurrentOutType() === CurrentType.AC + ? ACElectricUtils.powerTotal( + this.getNumberOfPhases(), + this.getVoltageOut(), + this.getAmperageLimitation() * this.getNumberOfConnectors() + ) + : DCElectricUtils.power(this.getVoltageOut(), this.getAmperageLimitation()); + } + const connectorMaximumPower = + ((this.stationInfo['maxPower'] as number) ?? this.stationInfo.maximumPower) / + this.stationInfo.powerDivider; + const connectorAmperageLimitationPowerLimit = + amperageLimitationPowerLimit / this.stationInfo.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) { @@ -398,7 +435,9 @@ 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.sendMessageHandler( + RequestCommand.HEARTBEAT + ); }, this.getHeartbeatInterval()); logger.info( this.logPrefix() + @@ -468,11 +507,14 @@ 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.sendMessageHandler( + RequestCommand.METER_VALUES, + { + connectorId, + transactionId: this.getConnectorStatus(connectorId).transactionId, + meterValue: [meterValue], + } + ); }, interval ); @@ -503,14 +545,14 @@ export default class ChargingStation { FileUtils.watchJsonFile( this.logPrefix(), FileType.ChargingStationTemplate, - this.stationTemplateFile, + this.templateFile, null, (event, filename): void => { if (filename && event === 'change') { try { logger.debug( `${this.logPrefix()} ${FileType.ChargingStationTemplate} ${ - this.stationTemplateFile + this.templateFile } file have changed, reload` ); // Initialize @@ -538,12 +580,6 @@ export default class ChargingStation { } } ); - FileUtils.watchJsonFile( - this.logPrefix(), - FileType.ChargingStationConfiguration, - this.configurationFile, - this.configuration - ); // Handle WebSocket message this.wsConnection.on( 'message', @@ -576,11 +612,14 @@ 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, { - connectorId, - status: ChargePointStatus.UNAVAILABLE, - errorCode: ChargePointErrorCode.NO_ERROR, - }); + await this.ocppRequestService.sendMessageHandler( + RequestCommand.STATUS_NOTIFICATION, + { + connectorId, + status: ChargePointStatus.UNAVAILABLE, + errorCode: ChargePointErrorCode.NO_ERROR, + } + ); this.getConnectorStatus(connectorId).status = ChargePointStatus.UNAVAILABLE; } } @@ -602,7 +641,7 @@ export default class ChargingStation { key: string | StandardParametersKey, caseInsensitive = false ): ConfigurationKey | undefined { - return this.configuration.configurationKey.find((configElement) => { + return this.ocppConfiguration.configurationKey.find((configElement) => { if (caseInsensitive) { return configElement.key.toLowerCase() === key.toLowerCase(); } @@ -620,33 +659,24 @@ export default class ChargingStation { }, params: { overwrite?: boolean; save?: boolean } = { overwrite: false, save: false } ): void { - if (!options || Utils.isEmptyObject(options)) { - options = { - readonly: false, - visible: true, - reboot: false, - }; - } - const readonly = options.readonly; - const visible = options.visible; - const reboot = options.reboot; + options = options ?? ({} as { readonly?: boolean; visible?: boolean; reboot?: boolean }); + options.readonly = options?.readonly ?? false; + options.visible = options?.visible ?? true; + options.reboot = options?.reboot ?? false; let keyFound = this.getConfigurationKey(key); if (keyFound && params?.overwrite) { - this.configuration.configurationKey.splice( - this.configuration.configurationKey.indexOf(keyFound), - 1 - ); + this.deleteConfigurationKey(keyFound.key, { save: false }); keyFound = undefined; } if (!keyFound) { - this.configuration.configurationKey.push({ + this.ocppConfiguration.configurationKey.push({ key, - readonly, + readonly: options.readonly, value, - visible, - reboot, + visible: options.visible, + reboot: options.reboot, }); - params?.save && this.saveConfiguration(); + params?.save && this.saveOcppConfiguration(); } else { logger.error( `${this.logPrefix()} Trying to add an already existing configuration key: %j`, @@ -662,9 +692,10 @@ export default class ChargingStation { ): void { const keyFound = this.getConfigurationKey(key, caseInsensitive); if (keyFound) { - const keyIndex = this.configuration.configurationKey.indexOf(keyFound); - this.configuration.configurationKey[keyIndex].value = value; - this.saveConfiguration(); + this.ocppConfiguration.configurationKey[ + this.ocppConfiguration.configurationKey.indexOf(keyFound) + ].value = value; + this.saveOcppConfiguration(); } else { logger.error( `${this.logPrefix()} Trying to set a value on a non existing configuration key: %j`, @@ -673,6 +704,97 @@ export default class ChargingStation { } } + public deleteConfigurationKey( + key: string | StandardParametersKey, + params: { save?: boolean; caseInsensitive?: boolean } = { save: true, caseInsensitive: false } + ): ConfigurationKey[] { + const keyFound = this.getConfigurationKey(key, params?.caseInsensitive); + if (keyFound) { + const deletedConfigurationKey = this.ocppConfiguration.configurationKey.splice( + this.ocppConfiguration.configurationKey.indexOf(keyFound), + 1 + ); + params?.save && this.saveOcppConfiguration(); + return deletedConfigurationKey; + } + } + + public getChargingProfilePowerLimit(connectorId: number): number | undefined { + const timestamp = new Date().getTime(); + let matchingChargingProfile: ChargingProfile; + let chargingSchedulePeriods: ChargingSchedulePeriod[] = []; + if (!Utils.isEmptyArray(this.getConnectorStatus(connectorId)?.chargingProfiles)) { + const chargingProfiles: ChargingProfile[] = this.getConnectorStatus( + connectorId + ).chargingProfiles.filter( + (chargingProfile) => + timestamp >= chargingProfile.chargingSchedule?.startSchedule.getTime() && + timestamp < + chargingProfile.chargingSchedule?.startSchedule.getTime() + + chargingProfile.chargingSchedule.duration * 1000 && + chargingProfile?.stackLevel === Math.max(...chargingProfiles.map((cp) => cp?.stackLevel)) + ); + if (!Utils.isEmptyArray(chargingProfiles)) { + for (const chargingProfile of chargingProfiles) { + if (!Utils.isEmptyArray(chargingProfile.chargingSchedule.chargingSchedulePeriod)) { + chargingSchedulePeriods = + chargingProfile.chargingSchedule.chargingSchedulePeriod.filter( + (chargingSchedulePeriod, index) => { + timestamp >= + chargingProfile.chargingSchedule.startSchedule.getTime() + + chargingSchedulePeriod.startPeriod * 1000 && + ((chargingProfile.chargingSchedule.chargingSchedulePeriod[index + 1] && + timestamp < + chargingProfile.chargingSchedule.startSchedule.getTime() + + chargingProfile.chargingSchedule.chargingSchedulePeriod[index + 1] + ?.startPeriod * + 1000) || + !chargingProfile.chargingSchedule.chargingSchedulePeriod[index + 1]); + } + ); + if (!Utils.isEmptyArray(chargingSchedulePeriods)) { + matchingChargingProfile = chargingProfile; + break; + } + } + } + } + } + let limit: number; + if (!Utils.isEmptyArray(chargingSchedulePeriods)) { + switch (this.getCurrentOutType()) { + case CurrentType.AC: + limit = + matchingChargingProfile.chargingSchedule.chargingRateUnit === ChargingRateUnitType.WATT + ? chargingSchedulePeriods[0].limit + : ACElectricUtils.powerTotal( + this.getNumberOfPhases(), + this.getVoltageOut(), + chargingSchedulePeriods[0].limit + ); + break; + case CurrentType.DC: + limit = + matchingChargingProfile.chargingSchedule.chargingRateUnit === ChargingRateUnitType.WATT + ? chargingSchedulePeriods[0].limit + : DCElectricUtils.power(this.getVoltageOut(), chargingSchedulePeriods[0].limit); + } + } + const connectorMaximumPower = + ((this.stationInfo['maxPower'] as number) ?? this.stationInfo.maximumPower) / + this.stationInfo.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 { let cpReplaced = false; if (!Utils.isEmptyArray(this.getConnectorStatus(connectorId).chargingProfiles)) { @@ -724,6 +846,10 @@ export default class ChargingStation { return this.stationInfo.supervisionUrlOcppConfiguration ?? false; } + private getSupervisionUrlOcppKey(): string { + return this.stationInfo.supervisionUrlOcppKey ?? VendorDefaultParametersKey.ConnectionUrl; + } + 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; @@ -738,95 +864,211 @@ export default class ChargingStation { idSuffix; } - private buildStationInfo(): ChargingStationInfo { - let stationTemplateFromFile: ChargingStationTemplate; + private getRandomSerialNumberSuffix(params?: { + randomBytesLength?: number; + upperCase?: boolean; + }): string { + const randomSerialNumberSuffix = crypto + .randomBytes(params?.randomBytesLength ?? 16) + .toString('hex'); + if (params?.upperCase) { + return randomSerialNumberSuffix.toUpperCase(); + } + return randomSerialNumberSuffix; + } + + private getTemplateFromFile(): ChargingStationTemplate | null { + let template: ChargingStationTemplate = null; try { - // Load template file - stationTemplateFromFile = JSON.parse( - fs.readFileSync(this.stationTemplateFile, 'utf8') - ) as ChargingStationTemplate; + const measureId = `${FileType.ChargingStationTemplate} read`; + const beginId = PerformanceStatistics.beginMeasure(measureId); + template = JSON.parse(fs.readFileSync(this.templateFile, 'utf8')) as ChargingStationTemplate; + PerformanceStatistics.endMeasure(measureId, beginId); } catch (error) { FileUtils.handleFileException( this.logPrefix(), FileType.ChargingStationTemplate, - this.stationTemplateFile, + this.templateFile, error as NodeJS.ErrnoException ); } - const chargingStationId = this.getChargingStationId(stationTemplateFromFile); + return template; + } + + private createSerialNumber( + stationInfo: ChargingStationInfo, + existingStationInfo?: ChargingStationInfo, + params: { randomSerialNumberUpperCase?: boolean; randomSerialNumber?: boolean } = { + randomSerialNumberUpperCase: true, + randomSerialNumber: true, + } + ): void { + params = params ?? {}; + params.randomSerialNumberUpperCase = params?.randomSerialNumberUpperCase ?? true; + params.randomSerialNumber = params?.randomSerialNumber ?? true; + if (existingStationInfo) { + existingStationInfo?.chargePointSerialNumber && + (stationInfo.chargePointSerialNumber = existingStationInfo.chargePointSerialNumber); + existingStationInfo?.chargeBoxSerialNumber && + (stationInfo.chargeBoxSerialNumber = existingStationInfo.chargeBoxSerialNumber); + } else { + const serialNumberSuffix = params?.randomSerialNumber + ? this.getRandomSerialNumberSuffix({ upperCase: params.randomSerialNumberUpperCase }) + : ''; + stationInfo.chargePointSerialNumber = + stationInfo?.chargePointSerialNumberPrefix && + stationInfo.chargePointSerialNumberPrefix + serialNumberSuffix; + stationInfo.chargeBoxSerialNumber = + stationInfo?.chargeBoxSerialNumberPrefix && + stationInfo.chargeBoxSerialNumberPrefix + serialNumberSuffix; + } + } + + private getStationInfoFromTemplate(): ChargingStationInfo { + const stationInfo: ChargingStationInfo = + this.getTemplateFromFile() ?? ({} as ChargingStationInfo); + stationInfo.hash = crypto + .createHash(Constants.DEFAULT_HASH_ALGORITHM) + .update(JSON.stringify(stationInfo)) + .digest('hex'); + const chargingStationId = this.getChargingStationId(stationInfo); // Deprecation template keys section this.warnDeprecatedTemplateKey( - stationTemplateFromFile, + stationInfo, 'supervisionUrl', chargingStationId, "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]; + this.convertDeprecatedTemplateKey(stationInfo, 'supervisionUrl', 'supervisionUrls'); + stationInfo.wsOptions = stationInfo?.wsOptions ?? {}; + if (!Utils.isEmptyArray(stationInfo.power)) { + stationInfo.power = stationInfo.power as number[]; + const powerArrayRandomIndex = Math.floor(Utils.secureRandom() * stationInfo.power.length); + stationInfo.maximumPower = + stationInfo.powerUnit === PowerUnits.KILO_WATT + ? stationInfo.power[powerArrayRandomIndex] * 1000 + : stationInfo.power[powerArrayRandomIndex]; } else { - stationTemplateFromFile.power = stationTemplateFromFile.power as number; - stationInfo.maxPower = - stationTemplateFromFile.powerUnit === PowerUnits.KILO_WATT - ? stationTemplateFromFile.power * 1000 - : stationTemplateFromFile.power; + stationInfo.power = stationInfo.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 = stationTemplateFromFile.resetTime - ? stationTemplateFromFile.resetTime * 1000 + stationInfo.resetTime = stationInfo.resetTime + ? stationInfo.resetTime * 1000 : Constants.CHARGING_STATION_DEFAULT_RESET_TIME; return stationInfo; } + private getStationInfoFromFile(): ChargingStationInfo | null { + return this.getConfigurationFromFile()?.stationInfo ?? null; + } + + private getStationInfo(): ChargingStationInfo { + const stationInfoFromTemplate: ChargingStationInfo = this.getStationInfoFromTemplate(); + this.hashId = this.getHashId(stationInfoFromTemplate); + this.configurationFile = path.join( + path.resolve(__dirname, '../'), + 'assets', + 'configurations', + this.hashId + '.json' + ); + const stationInfoFromFile: ChargingStationInfo = this.getStationInfoFromFile(); + if (stationInfoFromFile?.hash === stationInfoFromTemplate.hash) { + return stationInfoFromFile; + } + this.createSerialNumber(stationInfoFromTemplate, stationInfoFromFile); + return stationInfoFromTemplate; + } + + private saveStationInfo(): void { + this.saveConfiguration(Section.stationInfo); + } + private getOcppVersion(): OCPPVersion { return this.stationInfo.ocppVersion ? this.stationInfo.ocppVersion : OCPPVersion.VERSION_16; } + private getOcppPersistentConfiguration(): boolean { + return this.stationInfo.ocppPersistentConfiguration ?? 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.configurationFile = path.join( - path.resolve(__dirname, '../'), - 'assets', - 'configurations', - this.stationInfo.chargingStationId + '.json' - ); - this.configuration = this.getConfiguration(); - delete this.stationInfo.Configuration; - this.bootNotificationRequest = { - chargePointModel: this.stationInfo.chargePointModel, - chargePointVendor: this.stationInfo.chargePointVendor, - ...(!Utils.isUndefined(this.stationInfo.chargeBoxSerialNumberPrefix) && { - chargeBoxSerialNumber: this.stationInfo.chargeBoxSerialNumberPrefix, + private createBootNotificationRequest(stationInfo: ChargingStationInfo): BootNotificationRequest { + return { + chargePointModel: stationInfo.chargePointModel, + chargePointVendor: stationInfo.chargePointVendor, + ...(!Utils.isUndefined(stationInfo.chargeBoxSerialNumber) && { + chargeBoxSerialNumber: stationInfo.chargeBoxSerialNumber, + }), + ...(!Utils.isUndefined(stationInfo.chargePointSerialNumber) && { + chargePointSerialNumber: stationInfo.chargePointSerialNumber, + }), + ...(!Utils.isUndefined(stationInfo.firmwareVersion) && { + firmwareVersion: stationInfo.firmwareVersion, }), - ...(!Utils.isUndefined(this.stationInfo.firmwareVersion) && { - firmwareVersion: this.stationInfo.firmwareVersion, + ...(!Utils.isUndefined(stationInfo.iccid) && { iccid: stationInfo.iccid }), + ...(!Utils.isUndefined(stationInfo.imsi) && { imsi: stationInfo.imsi }), + ...(!Utils.isUndefined(stationInfo.meterSerialNumber) && { + meterSerialNumber: stationInfo.meterSerialNumber, + }), + ...(!Utils.isUndefined(stationInfo.meterType) && { + meterType: stationInfo.meterType, }), }; + } + + private getHashId(stationInfo: ChargingStationInfo): string { + const hashBootNotificationRequest = { + chargePointModel: stationInfo.chargePointModel, + chargePointVendor: stationInfo.chargePointVendor, + ...(!Utils.isUndefined(stationInfo.chargeBoxSerialNumberPrefix) && { + chargeBoxSerialNumber: stationInfo.chargeBoxSerialNumberPrefix, + }), + ...(!Utils.isUndefined(stationInfo.chargePointSerialNumberPrefix) && { + chargePointSerialNumber: stationInfo.chargePointSerialNumberPrefix, + }), + ...(!Utils.isUndefined(stationInfo.firmwareVersion) && { + firmwareVersion: stationInfo.firmwareVersion, + }), + ...(!Utils.isUndefined(stationInfo.iccid) && { iccid: stationInfo.iccid }), + ...(!Utils.isUndefined(stationInfo.imsi) && { imsi: stationInfo.imsi }), + ...(!Utils.isUndefined(stationInfo.meterSerialNumber) && { + meterSerialNumber: stationInfo.meterSerialNumber, + }), + ...(!Utils.isUndefined(stationInfo.meterType) && { + meterType: stationInfo.meterType, + }), + }; + return crypto + .createHash(Constants.DEFAULT_HASH_ALGORITHM) + .update(JSON.stringify(hashBootNotificationRequest) + stationInfo.chargingStationId) + .digest('hex'); + } + + private initialize(): void { + this.stationInfo = this.getStationInfo(); + logger.info(`${this.logPrefix()} Charging station hashId '${this.hashId}'`); + this.bootNotificationRequest = this.createBootNotificationRequest(this.stationInfo); + this.ocppConfiguration = this.getOcppConfiguration(); + delete this.stationInfo.Configuration; // Build connectors if needed const maxConnectors = this.getMaxNumberOfConnectors(); if (maxConnectors <= 0) { logger.warn( `${this.logPrefix()} Charging station template ${ - this.stationTemplateFile + this.templateFile } with ${maxConnectors} connectors` ); } @@ -834,14 +1076,14 @@ export default class ChargingStation { if (templateMaxConnectors <= 0) { logger.warn( `${this.logPrefix()} Charging station template ${ - this.stationTemplateFile + this.templateFile } with no connector configuration` ); } if (!this.stationInfo.Connectors[0]) { logger.warn( `${this.logPrefix()} Charging station template ${ - this.stationTemplateFile + this.templateFile } with no connector Id 0 configuration` ); } @@ -853,13 +1095,13 @@ export default class ChargingStation { ) { logger.warn( `${this.logPrefix()} Number of connectors exceeds the number of connector configurations in template ${ - this.stationTemplateFile + this.templateFile }, forcing random connector configurations affectation` ); this.stationInfo.randomConnectors = true; } const connectorsConfigHash = crypto - .createHash('sha256') + .createHash(Constants.DEFAULT_HASH_ALGORITHM) .update(JSON.stringify(this.stationInfo.Connectors) + maxConnectors.toString()) .digest('hex'); const connectorsConfigChanged = @@ -905,7 +1147,10 @@ export default class ChargingStation { } } } - // Avoid duplication of connectors related information + // The connectors attribute need to be initialized + this.stationInfo.maximumAmperage = this.getMaximumAmperage(); + this.saveStationInfo(); + // Avoid duplication of connectors related information in RAM delete this.stationInfo.Connectors; // Initialize transaction attributes on connectors for (const connectorId of this.connectors.keys()) { @@ -916,6 +1161,8 @@ export default class ChargingStation { this.wsConfiguredConnectionUrl = new URL( this.getConfiguredSupervisionUrl().href + '/' + this.stationInfo.chargingStationId ); + // OCPP configuration + this.initializeOcppConfiguration(); switch (this.getOcppVersion()) { case OCPPVersion.VERSION_16: this.ocppIncomingRequestService = @@ -929,8 +1176,6 @@ export default class ChargingStation { this.handleUnsupportedVersion(this.getOcppVersion()); break; } - // OCPP parameters - this.initOcppParameters(); if (this.stationInfo.autoRegister) { this.bootNotificationResponse = { currentTime: new Date().toISOString(), @@ -941,25 +1186,37 @@ export default class ChargingStation { this.stationInfo.powerDivider = this.getPowerDivider(); if (this.getEnableStatistics()) { this.performanceStatistics = PerformanceStatistics.getInstance( - this.id, + this.hashId, this.stationInfo.chargingStationId, this.wsConnectionUrl ); } } - private initOcppParameters(): void { + private initializeOcppConfiguration(): void { if ( this.getSupervisionUrlOcppConfiguration() && - !this.getConfigurationKey( - this.stationInfo.supervisionUrlOcppKey ?? VendorDefaultParametersKey.ConnectionUrl - ) + !this.getConfigurationKey(this.getSupervisionUrlOcppKey()) ) { this.addConfigurationKey( - this.stationInfo.supervisionUrlOcppKey ?? VendorDefaultParametersKey.ConnectionUrl, + this.getSupervisionUrlOcppKey(), this.getConfiguredSupervisionUrl().href, { reboot: true } ); + } else if ( + !this.getSupervisionUrlOcppConfiguration() && + this.getConfigurationKey(this.getSupervisionUrlOcppKey()) + ) { + this.deleteConfigurationKey(this.getSupervisionUrlOcppKey(), { save: false }); + } + if ( + this.stationInfo.amperageLimitationOcppKey && + !this.getConfigurationKey(this.stationInfo.amperageLimitationOcppKey) + ) { + this.addConfigurationKey( + this.stationInfo.amperageLimitationOcppKey, + (this.stationInfo.maximumAmperage * this.getAmperageLimitationUnitDivider()).toString() + ); } if (!this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles)) { this.addConfigurationKey( @@ -1016,20 +1273,21 @@ export default class ChargingStation { Constants.DEFAULT_CONNECTION_TIMEOUT.toString() ); } - this.saveConfiguration(); - } - - private getConfigurationFromTemplate(): ChargingStationConfiguration { - return this.stationInfo.Configuration ?? ({} as ChargingStationConfiguration); + this.saveOcppConfiguration(); } 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( + `${FileType.ChargingStationConfiguration} read` + ); configuration = JSON.parse( fs.readFileSync(this.configurationFile, 'utf8') ) as ChargingStationConfiguration; + PerformanceStatistics.endMeasure(measureId, beginId); } catch (error) { FileUtils.handleFileException( this.logPrefix(), @@ -1042,15 +1300,32 @@ export default class ChargingStation { return configuration; } - private saveConfiguration(): void { + private saveConfiguration(section?: Section): void { if (this.configurationFile) { try { + const configurationData: ChargingStationConfiguration = + this.getConfigurationFromFile() ?? {}; if (!fs.existsSync(path.dirname(this.configurationFile))) { fs.mkdirSync(path.dirname(this.configurationFile), { recursive: true }); } + switch (section) { + case Section.ocppConfiguration: + configurationData.configurationKey = this.ocppConfiguration.configurationKey; + break; + case Section.stationInfo: + configurationData.stationInfo = this.stationInfo; + break; + default: + configurationData.configurationKey = this.ocppConfiguration.configurationKey; + configurationData.stationInfo = this.stationInfo; + break; + } + const measureId = `${FileType.ChargingStationConfiguration} write`; + const beginId = PerformanceStatistics.beginMeasure(measureId); const fileDescriptor = fs.openSync(this.configurationFile, 'w'); - fs.writeFileSync(fileDescriptor, JSON.stringify(this.configuration, null, 2)); + fs.writeFileSync(fileDescriptor, JSON.stringify(configurationData, null, 2), 'utf8'); fs.closeSync(fileDescriptor); + PerformanceStatistics.endMeasure(measureId, beginId); } catch (error) { FileUtils.handleFileException( this.logPrefix(), @@ -1066,14 +1341,34 @@ export default class ChargingStation { } } - private getConfiguration(): ChargingStationConfiguration { - let configuration: ChargingStationConfiguration = this.getConfigurationFromFile(); - if (!configuration) { - configuration = this.getConfigurationFromTemplate(); + private getOcppConfigurationFromTemplate(): ChargingStationOcppConfiguration { + return this.getTemplateFromFile().Configuration ?? ({} as ChargingStationOcppConfiguration); + } + + 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 { + let ocppConfiguration: ChargingStationOcppConfiguration = this.getOcppConfigurationFromFile(); + if (!ocppConfiguration) { + ocppConfiguration = this.getOcppConfigurationFromTemplate(); + } + return ocppConfiguration; + } + + private saveOcppConfiguration(): void { + if (this.getOcppPersistentConfiguration()) { + this.saveConfiguration(Section.ocppConfiguration); + } + } + private async onOpen(): Promise { logger.info( `${this.logPrefix()} Connected to OCPP server through ${this.wsConnectionUrl.toString()}` @@ -1082,21 +1377,22 @@ export default class ChargingStation { // 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; + 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 } + ); if (!this.isInAcceptedState()) { this.getRegistrationMaxRetries() !== -1 && registrationRetryCount++; await Utils.sleep( @@ -1301,9 +1597,7 @@ export default class ChargingStation { } } else { logger.info( - this.logPrefix() + - ' No authorization file given in template file ' + - this.stationTemplateFile + this.logPrefix() + ' No authorization file given in template file ' + this.templateFile ); } return authorizedTags; @@ -1383,9 +1677,52 @@ export default class ChargingStation { return maxConnectors; } + private getMaximumAmperage(): number | undefined { + const maximumPower = (this.stationInfo['maxPower'] as number) ?? this.stationInfo.maximumPower; + switch (this.getCurrentOutType()) { + case CurrentType.AC: + return ACElectricUtils.amperagePerPhaseFromPower( + this.getNumberOfPhases(), + maximumPower / this.getNumberOfConnectors(), + this.getVoltageOut() + ); + case CurrentType.DC: + return DCElectricUtils.amperage(maximumPower, this.getVoltageOut()); + } + } + + private getAmperageLimitationUnitDivider(): number { + let unitDivider = 1; + switch (this.stationInfo.amperageLimitationUnit) { + case AmpereUnits.DECI_AMPERE: + unitDivider = 10; + break; + case AmpereUnits.CENTI_AMPERE: + unitDivider = 100; + break; + case AmpereUnits.MILLI_AMPERE: + unitDivider = 1000; + break; + } + return unitDivider; + } + + private getAmperageLimitation(): number | undefined { + if ( + this.stationInfo.amperageLimitationOcppKey && + this.getConfigurationKey(this.stationInfo.amperageLimitationOcppKey) + ) { + return ( + Utils.convertToInt( + this.getConfigurationKey(this.stationInfo.amperageLimitationOcppKey).value + ) / this.getAmperageLimitationUnitDivider() + ); + } + } + private async startMessageSequence(): Promise { if (this.stationInfo.autoRegister) { - await this.ocppRequestService.sendMessageHandler( + await this.ocppRequestService.sendMessageHandler( RequestCommand.BOOT_NOTIFICATION, { chargePointModel: this.bootNotificationRequest.chargePointModel, @@ -1415,11 +1752,14 @@ export default class ChargingStation { this.getConnectorStatus(connectorId)?.bootStatus ) { // Send status in template at startup - await this.ocppRequestService.sendMessageHandler(RequestCommand.STATUS_NOTIFICATION, { - connectorId, - status: this.getConnectorStatus(connectorId).bootStatus, - errorCode: ChargePointErrorCode.NO_ERROR, - }); + await this.ocppRequestService.sendMessageHandler( + RequestCommand.STATUS_NOTIFICATION, + { + connectorId, + status: this.getConnectorStatus(connectorId).bootStatus, + errorCode: ChargePointErrorCode.NO_ERROR, + } + ); this.getConnectorStatus(connectorId).status = this.getConnectorStatus(connectorId).bootStatus; } else if ( @@ -1428,27 +1768,36 @@ export default class ChargingStation { this.getConnectorStatus(connectorId)?.bootStatus ) { // Send status in template after reset - await this.ocppRequestService.sendMessageHandler(RequestCommand.STATUS_NOTIFICATION, { - connectorId, - status: this.getConnectorStatus(connectorId).bootStatus, - errorCode: ChargePointErrorCode.NO_ERROR, - }); + await this.ocppRequestService.sendMessageHandler( + RequestCommand.STATUS_NOTIFICATION, + { + connectorId, + status: this.getConnectorStatus(connectorId).bootStatus, + errorCode: ChargePointErrorCode.NO_ERROR, + } + ); this.getConnectorStatus(connectorId).status = 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, { - connectorId, - status: this.getConnectorStatus(connectorId).status, - errorCode: ChargePointErrorCode.NO_ERROR, - }); + await this.ocppRequestService.sendMessageHandler( + RequestCommand.STATUS_NOTIFICATION, + { + connectorId, + status: this.getConnectorStatus(connectorId).status, + errorCode: ChargePointErrorCode.NO_ERROR, + } + ); } else { // Send default status - await this.ocppRequestService.sendMessageHandler(RequestCommand.STATUS_NOTIFICATION, { - connectorId, - status: ChargePointStatus.AVAILABLE, - errorCode: ChargePointErrorCode.NO_ERROR, - }); + await this.ocppRequestService.sendMessageHandler( + RequestCommand.STATUS_NOTIFICATION, + { + connectorId, + status: ChargePointStatus.AVAILABLE, + errorCode: ChargePointErrorCode.NO_ERROR, + } + ); this.getConnectorStatus(connectorId).status = ChargePointStatus.AVAILABLE; } } @@ -1495,18 +1844,24 @@ export default class ChargingStation { connectorId, this.getEnergyActiveImportRegisterByTransactionId(transactionId) ); - await this.ocppRequestService.sendMessageHandler(RequestCommand.METER_VALUES, { - connectorId, - transactionId, - meterValue: transactionEndMeterValue, - }); + await this.ocppRequestService.sendMessageHandler( + RequestCommand.METER_VALUES, + { + connectorId, + transactionId, + meterValue: transactionEndMeterValue, + } + ); } - await this.ocppRequestService.sendMessageHandler(RequestCommand.STOP_TRANSACTION, { - transactionId, - meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId), - idTag: this.getTransactionIdTag(transactionId), - reason, - }); + await this.ocppRequestService.sendMessageHandler( + RequestCommand.STOP_TRANSACTION, + { + transactionId, + meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId), + idTag: this.getTransactionIdTag(transactionId), + reason, + } + ); } } } @@ -1567,7 +1922,7 @@ export default class ChargingStation { const logPrefixStr = ` ${chargingStationId} |`; logger.warn( `${Utils.logPrefix(logPrefixStr)} Deprecated template key '${key}' usage in file '${ - this.stationTemplateFile + this.templateFile }'${logMsgToAppend && '. ' + logMsgToAppend}` ); } @@ -1646,7 +2001,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; @@ -1727,7 +2082,7 @@ export default class ChargingStation { 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()})` );