X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FChargingStationUtils.ts;h=7208fb80fe383fa916836306d63c33d9405f634a;hb=cf2a5d9b1e3f929ef9805d3fb7e4022cf4f9632d;hp=26774b80c1fa08873e04f5c959ca661790061a6b;hpb=f161f950ceed9d688035f2a737e7062e635819b5;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ChargingStationUtils.ts b/src/charging-station/ChargingStationUtils.ts index 26774b80..7208fb80 100644 --- a/src/charging-station/ChargingStationUtils.ts +++ b/src/charging-station/ChargingStationUtils.ts @@ -1,17 +1,29 @@ import { ChargingProfile, ChargingSchedulePeriod } from '../types/ocpp/ChargingProfile'; import { ChargingProfileKindType, RecurrencyKindType } from '../types/ocpp/1.6/ChargingProfile'; -import ChargingStationTemplate, { AmpereUnits } from '../types/ChargingStationTemplate'; +import ChargingStationTemplate, { + AmpereUnits, + CurrentType, + Voltage, +} from '../types/ChargingStationTemplate'; +import { MeterValueMeasurand, MeterValuePhase } from '../types/ocpp/MeterValues'; +import BaseError from '../exception/BaseError'; import { BootNotificationRequest } from '../types/ocpp/Requests'; +import ChargingStation from './ChargingStation'; +import { ChargingStationConfigurationUtils } from './ChargingStationConfigurationUtils'; import ChargingStationInfo from '../types/ChargingStationInfo'; import Configuration from '../utils/Configuration'; import Constants from '../utils/Constants'; +import { SampledValueTemplate } from '../types/MeasurandPerPhaseSampledValueTemplates'; +import { StandardParametersKey } from '../types/ocpp/Configuration'; import Utils from '../utils/Utils'; import { WebSocketCloseEventStatusString } from '../types/WebSocket'; import { WorkerProcessType } from '../types/Worker'; import crypto from 'crypto'; +import { fileURLToPath } from 'url'; import logger from '../utils/Logger'; import moment from 'moment'; +import path from 'path'; export class ChargingStationUtils { public static getChargingStationId( @@ -22,7 +34,7 @@ export class ChargingStationUtils { const instanceIndex = process.env.CF_INSTANCE_INDEX ?? 0; const idSuffix = stationTemplate.nameSuffix ?? ''; const idStr = '000000000' + index.toString(); - return stationTemplate.fixedName + return stationTemplate?.fixedName ? stationTemplate.baseName : stationTemplate.baseName + '-' + @@ -31,34 +43,92 @@ export class ChargingStationUtils { idSuffix; } - public static getHashId(stationInfo: ChargingStationInfo): string { + public static getHashId(index: number, stationTemplate: ChargingStationTemplate): string { const hashBootNotificationRequest = { - chargePointModel: stationInfo.chargePointModel, - chargePointVendor: stationInfo.chargePointVendor, - ...(!Utils.isUndefined(stationInfo.chargeBoxSerialNumberPrefix) && { - chargeBoxSerialNumber: stationInfo.chargeBoxSerialNumberPrefix, + chargePointModel: stationTemplate.chargePointModel, + chargePointVendor: stationTemplate.chargePointVendor, + ...(!Utils.isUndefined(stationTemplate.chargeBoxSerialNumberPrefix) && { + chargeBoxSerialNumber: stationTemplate.chargeBoxSerialNumberPrefix, }), - ...(!Utils.isUndefined(stationInfo.chargePointSerialNumberPrefix) && { - chargePointSerialNumber: stationInfo.chargePointSerialNumberPrefix, + ...(!Utils.isUndefined(stationTemplate.chargePointSerialNumberPrefix) && { + chargePointSerialNumber: stationTemplate.chargePointSerialNumberPrefix, }), - ...(!Utils.isUndefined(stationInfo.firmwareVersion) && { - firmwareVersion: stationInfo.firmwareVersion, + ...(!Utils.isUndefined(stationTemplate.firmwareVersion) && { + firmwareVersion: stationTemplate.firmwareVersion, }), - ...(!Utils.isUndefined(stationInfo.iccid) && { iccid: stationInfo.iccid }), - ...(!Utils.isUndefined(stationInfo.imsi) && { imsi: stationInfo.imsi }), - ...(!Utils.isUndefined(stationInfo.meterSerialNumberPrefix) && { - meterSerialNumber: stationInfo.meterSerialNumberPrefix, + ...(!Utils.isUndefined(stationTemplate.iccid) && { iccid: stationTemplate.iccid }), + ...(!Utils.isUndefined(stationTemplate.imsi) && { imsi: stationTemplate.imsi }), + ...(!Utils.isUndefined(stationTemplate.meterSerialNumberPrefix) && { + meterSerialNumber: stationTemplate.meterSerialNumberPrefix, }), - ...(!Utils.isUndefined(stationInfo.meterType) && { - meterType: stationInfo.meterType, + ...(!Utils.isUndefined(stationTemplate.meterType) && { + meterType: stationTemplate.meterType, }), }; return crypto .createHash(Constants.DEFAULT_HASH_ALGORITHM) - .update(JSON.stringify(hashBootNotificationRequest) + stationInfo.chargingStationId) + .update( + JSON.stringify(hashBootNotificationRequest) + + ChargingStationUtils.getChargingStationId(index, stationTemplate) + ) .digest('hex'); } + public static getTemplateMaxNumberOfConnectors(stationTemplate: ChargingStationTemplate): number { + const templateConnectors = stationTemplate?.Connectors; + if (!templateConnectors) { + return -1; + } + return Object.keys(templateConnectors).length; + } + + public static checkTemplateMaxConnectors( + templateMaxConnectors: number, + templateFile: string, + logPrefix: string + ): void { + if (templateMaxConnectors === 0) { + logger.warn( + `${logPrefix} Charging station information from template ${templateFile} with empty connectors configuration` + ); + } else if (templateMaxConnectors < 0) { + logger.error( + `${logPrefix} Charging station information from template ${templateFile} with no connectors configuration defined` + ); + } + } + + public static getConfiguredNumberOfConnectors( + index: number, + stationTemplate: ChargingStationTemplate + ): number { + let configuredMaxConnectors: number; + if (!Utils.isEmptyArray(stationTemplate.numberOfConnectors)) { + const numberOfConnectors = stationTemplate.numberOfConnectors as number[]; + // Distribute evenly the number of connectors + configuredMaxConnectors = numberOfConnectors[(index - 1) % numberOfConnectors.length]; + } else if (!Utils.isUndefined(stationTemplate.numberOfConnectors)) { + configuredMaxConnectors = stationTemplate.numberOfConnectors as number; + } else { + configuredMaxConnectors = stationTemplate?.Connectors[0] + ? ChargingStationUtils.getTemplateMaxNumberOfConnectors(stationTemplate) - 1 + : ChargingStationUtils.getTemplateMaxNumberOfConnectors(stationTemplate); + } + return configuredMaxConnectors; + } + + public static checkConfiguredMaxConnectors( + configuredMaxConnectors: number, + templateFile: string, + logPrefix: string + ): void { + if (configuredMaxConnectors <= 0) { + logger.warn( + `${logPrefix} Charging station information from template ${templateFile} with ${configuredMaxConnectors} connectors` + ); + } + } + public static createBootNotificationRequest( stationInfo: ChargingStationInfo ): BootNotificationRequest { @@ -87,12 +157,12 @@ export class ChargingStationUtils { public static workerPoolInUse(): boolean { return [WorkerProcessType.DYNAMIC_POOL, WorkerProcessType.STATIC_POOL].includes( - Configuration.getWorkerProcess() + Configuration.getWorker().processType ); } public static workerDynamicPoolInUse(): boolean { - return Configuration.getWorkerProcess() === WorkerProcessType.DYNAMIC_POOL; + return Configuration.getWorker().processType === WorkerProcessType.DYNAMIC_POOL; } /** @@ -148,30 +218,35 @@ export class ChargingStationUtils { } } - public static createStationInfoHash(stationInfo: ChargingStationInfo): ChargingStationInfo { - if (!Utils.isEmptyObject(stationInfo)) { - const previousInfoHash = stationInfo?.infoHash ?? ''; - delete stationInfo.infoHash; - const currentInfoHash = crypto - .createHash(Constants.DEFAULT_HASH_ALGORITHM) - .update(JSON.stringify(stationInfo)) - .digest('hex'); - if ( - Utils.isEmptyString(previousInfoHash) || - (!Utils.isEmptyString(previousInfoHash) && currentInfoHash !== previousInfoHash) - ) { - stationInfo.infoHash = currentInfoHash; - } else { - stationInfo.infoHash = previousInfoHash; - } - } - return stationInfo; + public static stationTemplateToStationInfo( + stationTemplate: ChargingStationTemplate + ): ChargingStationInfo { + stationTemplate = Utils.cloneObject(stationTemplate); + delete stationTemplate.power; + delete stationTemplate.powerUnit; + delete stationTemplate.Configuration; + delete stationTemplate.AutomaticTransactionGenerator; + delete stationTemplate.chargeBoxSerialNumberPrefix; + delete stationTemplate.chargePointSerialNumberPrefix; + delete stationTemplate.meterSerialNumberPrefix; + return stationTemplate; + } + + public static createStationInfoHash(stationInfo: ChargingStationInfo): void { + delete stationInfo.infoHash; + stationInfo.infoHash = crypto + .createHash(Constants.DEFAULT_HASH_ALGORITHM) + .update(JSON.stringify(stationInfo)) + .digest('hex'); } public static createSerialNumber( - stationInfo: ChargingStationInfo, - existingStationInfo?: ChargingStationInfo, - params: { randomSerialNumberUpperCase?: boolean; randomSerialNumber?: boolean } = { + stationTemplate: ChargingStationTemplate, + stationInfo: ChargingStationInfo = {} as ChargingStationInfo, + params: { + randomSerialNumberUpperCase?: boolean; + randomSerialNumber?: boolean; + } = { randomSerialNumberUpperCase: true, randomSerialNumber: true, } @@ -179,29 +254,41 @@ export class ChargingStationUtils { params = params ?? {}; params.randomSerialNumberUpperCase = params?.randomSerialNumberUpperCase ?? true; params.randomSerialNumber = params?.randomSerialNumber ?? true; - if (!Utils.isEmptyObject(existingStationInfo)) { - existingStationInfo?.chargePointSerialNumber && - (stationInfo.chargePointSerialNumber = existingStationInfo.chargePointSerialNumber); - existingStationInfo?.chargeBoxSerialNumber && - (stationInfo.chargeBoxSerialNumber = existingStationInfo.chargeBoxSerialNumber); - existingStationInfo?.meterSerialNumber && - (stationInfo.meterSerialNumber = existingStationInfo.meterSerialNumber); - } else { - const serialNumberSuffix = params?.randomSerialNumber - ? ChargingStationUtils.getRandomSerialNumberSuffix({ - upperCase: params.randomSerialNumberUpperCase, - }) - : ''; - stationInfo.chargePointSerialNumber = - stationInfo?.chargePointSerialNumberPrefix && - stationInfo.chargePointSerialNumberPrefix + serialNumberSuffix; - stationInfo.chargeBoxSerialNumber = - stationInfo?.chargeBoxSerialNumberPrefix && - stationInfo.chargeBoxSerialNumberPrefix + serialNumberSuffix; - stationInfo.meterSerialNumber = - stationInfo?.meterSerialNumberPrefix && - stationInfo.meterSerialNumberPrefix + serialNumberSuffix; + const serialNumberSuffix = params?.randomSerialNumber + ? ChargingStationUtils.getRandomSerialNumberSuffix({ + upperCase: params.randomSerialNumberUpperCase, + }) + : ''; + stationInfo.chargePointSerialNumber = + stationTemplate?.chargePointSerialNumberPrefix && + stationTemplate.chargePointSerialNumberPrefix + serialNumberSuffix; + stationInfo.chargeBoxSerialNumber = + stationTemplate?.chargeBoxSerialNumberPrefix && + stationTemplate.chargeBoxSerialNumberPrefix + serialNumberSuffix; + stationInfo.meterSerialNumber = + stationTemplate?.meterSerialNumberPrefix && + stationTemplate.meterSerialNumberPrefix + serialNumberSuffix; + } + + public static propagateSerialNumber( + stationTemplate: ChargingStationTemplate, + stationInfoSrc: ChargingStationInfo, + stationInfoDst: ChargingStationInfo = {} as ChargingStationInfo + ) { + if (!stationInfoSrc || !stationTemplate) { + throw new BaseError( + 'Missing charging station template or existing configuration to propagate serial number' + ); } + stationTemplate?.chargePointSerialNumberPrefix && stationInfoSrc?.chargePointSerialNumber + ? (stationInfoDst.chargePointSerialNumber = stationInfoSrc.chargePointSerialNumber) + : stationInfoDst?.chargePointSerialNumber && delete stationInfoDst.chargePointSerialNumber; + stationTemplate?.chargeBoxSerialNumberPrefix && stationInfoSrc?.chargeBoxSerialNumber + ? (stationInfoDst.chargeBoxSerialNumber = stationInfoSrc.chargeBoxSerialNumber) + : stationInfoDst?.chargeBoxSerialNumber && delete stationInfoDst.chargeBoxSerialNumber; + stationTemplate?.meterSerialNumberPrefix && stationInfoSrc?.meterSerialNumber + ? (stationInfoDst.meterSerialNumber = stationInfoSrc.meterSerialNumber) + : stationInfoDst?.meterSerialNumber && delete stationInfoDst.meterSerialNumber; } public static getAmperageLimitationUnitDivider(stationInfo: ChargingStationInfo): number { @@ -325,6 +412,119 @@ export class ChargingStationUtils { return null; } + public static getDefaultVoltageOut( + currentType: CurrentType, + templateFile: string, + logPrefix: string + ): Voltage { + const errMsg = `${logPrefix} Unknown ${currentType} currentOutType in template file ${templateFile}, cannot define default voltage out`; + let defaultVoltageOut: number; + switch (currentType) { + 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 defaultVoltageOut; + } + + public static getSampledValueTemplate( + chargingStation: ChargingStation, + 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( + `${chargingStation.logPrefix()} Trying to get unsupported MeterValues measurand '${measurand}' ${onPhaseStr}in template on connectorId ${connectorId}` + ); + return; + } + if ( + measurand !== MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER && + !ChargingStationConfigurationUtils.getConfigurationKey( + chargingStation, + StandardParametersKey.MeterValuesSampledData + )?.value.includes(measurand) + ) { + logger.debug( + `${chargingStation.logPrefix()} Trying to get MeterValues measurand '${measurand}' ${onPhaseStr}in template on connectorId ${connectorId} not found in '${ + StandardParametersKey.MeterValuesSampledData + }' OCPP parameter` + ); + return; + } + const sampledValueTemplates: SampledValueTemplate[] = + chargingStation.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( + `${chargingStation.logPrefix()} Unsupported MeterValues measurand '${measurand}' ${onPhaseStr}in template on connectorId ${connectorId}` + ); + } else if ( + phase && + sampledValueTemplates[index]?.phase === phase && + sampledValueTemplates[index]?.measurand === measurand && + ChargingStationConfigurationUtils.getConfigurationKey( + chargingStation, + StandardParametersKey.MeterValuesSampledData + )?.value.includes(measurand) + ) { + return sampledValueTemplates[index]; + } else if ( + !phase && + !sampledValueTemplates[index].phase && + sampledValueTemplates[index]?.measurand === measurand && + ChargingStationConfigurationUtils.getConfigurationKey( + chargingStation, + 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 = `${chargingStation.logPrefix()} Missing MeterValues for default measurand '${measurand}' in template on connectorId ${connectorId}`; + logger.error(errorMsg); + throw new Error(errorMsg); + } + logger.debug( + `${chargingStation.logPrefix()} No MeterValues for measurand '${measurand}' ${onPhaseStr}in template on connectorId ${connectorId}` + ); + } + + public static getAuthorizationFile(stationInfo: ChargingStationInfo): string | undefined { + return ( + stationInfo.authorizationFile && + path.join( + path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../'), + 'assets', + path.basename(stationInfo.authorizationFile) + ) + ); + } + private static getRandomSerialNumberSuffix(params?: { randomBytesLength?: number; upperCase?: boolean;