X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FChargingStation.ts;h=01829fdf47273797aefa980824db13282cd72862;hb=e6895390a1697376fdee9c7ebb1e775c24f1022d;hp=e90bd60be551901839c5963fe5938d5fb14eef82;hpb=68c993d5b34c191022256f26d4e95e5f3b9974d4;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ChargingStation.ts b/src/charging-station/ChargingStation.ts index e90bd60b..01829fdf 100644 --- a/src/charging-station/ChargingStation.ts +++ b/src/charging-station/ChargingStation.ts @@ -23,7 +23,7 @@ import { SupportedFeatureProfiles, VendorDefaultParametersKey, } from '../types/ocpp/Configuration'; -import { MeterValueMeasurand, MeterValuePhase } from '../types/ocpp/MeterValues'; +import { MeterValue, MeterValueMeasurand, MeterValuePhase } from '../types/ocpp/MeterValues'; import { WSError, WebSocketCloseEventStatusCode } from '../types/WebSocket'; import WebSocket, { ClientOptions, Data, OPEN, RawData } from 'ws'; @@ -38,6 +38,7 @@ 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'; @@ -74,6 +75,7 @@ export default class ChargingStation { public heartbeatSetInterval!: NodeJS.Timeout; public ocppRequestService!: OCPPRequestService; private readonly index: number; + private configurationFile!: string; private bootNotificationRequest!: BootNotificationRequest; private bootNotificationResponse!: BootNotificationResponse | null; private connectorsConfigurationHash!: string; @@ -103,9 +105,7 @@ export default class ChargingStation { get wsConnectionUrl(): URL { return this.getSupervisionUrlOcppConfiguration() ? new URL( - this.getConfigurationKey( - this.stationInfo.supervisionUrlOcppKey ?? VendorDefaultParametersKey.ConnectionUrl - ).value + + this.getConfigurationKey(this.getSupervisionUrlOcppKey()).value + '/' + this.stationInfo.chargingStationId ) @@ -255,29 +255,33 @@ export default class ChargingStation { return this.stationInfo.phaseLineToLineVoltageMeterValues ?? false; } - public getEnergyActiveImportRegisterByTransactionId(transactionId: number): number | undefined { - if (this.getMeteringPerTransaction()) { - for (const connectorId of this.connectors.keys()) { - if ( - connectorId > 0 && - this.getConnectorStatus(connectorId).transactionId === transactionId - ) { - return this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue; - } - } - } + public getConnectorIdByTransactionId(transactionId: number): number | undefined { for (const connectorId of this.connectors.keys()) { - if (connectorId > 0 && this.getConnectorStatus(connectorId).transactionId === transactionId) { - return this.getConnectorStatus(connectorId).energyActiveImportRegisterValue; + if ( + connectorId > 0 && + this.getConnectorStatus(connectorId)?.transactionId === transactionId + ) { + return connectorId; } } } + public getEnergyActiveImportRegisterByTransactionId(transactionId: number): number | undefined { + const transactionConnectorStatus = this.getConnectorStatus( + this.getConnectorIdByTransactionId(transactionId) + ); + if (this.getMeteringPerTransaction()) { + return transactionConnectorStatus?.transactionEnergyActiveImportRegisterValue; + } + return transactionConnectorStatus?.energyActiveImportRegisterValue; + } + public getEnergyActiveImportRegisterByConnectorId(connectorId: number): number | undefined { + const connectorStatus = this.getConnectorStatus(connectorId); if (this.getMeteringPerTransaction()) { - return this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue; + return connectorStatus?.transactionEnergyActiveImportRegisterValue; } - return this.getConnectorStatus(connectorId).energyActiveImportRegisterValue; + return connectorStatus?.energyActiveImportRegisterValue; } public getAuthorizeRemoteTxRequests(): boolean { @@ -455,11 +459,18 @@ export default class ChargingStation { this.getConnectorStatus(connectorId).transactionSetInterval = setInterval( // eslint-disable-next-line @typescript-eslint/no-misused-promises async (): Promise => { - await this.ocppRequestService.sendMeterValues( + // FIXME: Implement OCPP version agnostic helpers + const meterValue: MeterValue = OCPP16ServiceUtils.buildMeterValue( + this, connectorId, this.getConnectorStatus(connectorId).transactionId, interval ); + await this.ocppRequestService.sendMessageHandler(RequestCommand.METER_VALUES, { + connectorId, + transactionId: this.getConnectorStatus(connectorId).transactionId, + meterValue: [meterValue], + }); }, interval ); @@ -480,9 +491,60 @@ export default class ChargingStation { } this.openWSConnection(); // Monitor authorization file - this.startAuthorizationFileMonitoring(); - // Monitor station template file - this.startStationTemplateFileMonitoring(); + FileUtils.watchJsonFile( + this.logPrefix(), + FileType.Authorization, + this.getAuthorizationFile(), + this.authorizedTags + ); + // Monitor charging station template file + FileUtils.watchJsonFile( + this.logPrefix(), + FileType.ChargingStationTemplate, + this.stationTemplateFile, + null, + (event, filename): void => { + if (filename && event === 'change') { + try { + logger.debug( + `${this.logPrefix()} ${FileType.ChargingStationTemplate} ${ + this.stationTemplateFile + } file 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()} ${FileType.ChargingStationTemplate} file monitoring error: %j`, + error + ); + } + } + } + ); + // FIXME: triggered by saveConfiguration() + // if (this.getOcppPersistentConfiguration()) { + // FileUtils.watchJsonFile( + // this.logPrefix(), + // FileType.ChargingStationConfiguration, + // this.configurationFile, + // this.configuration + // ); + // } // Handle WebSocket message this.wsConnection.on( 'message', @@ -556,12 +618,24 @@ export default class ChargingStation { readonly: false, visible: true, reboot: false, - } + }, + params: { overwrite?: boolean; save?: boolean } = { overwrite: false, save: false } ): void { - const keyFound = this.getConfigurationKey(key); + if (!options || Utils.isEmptyObject(options)) { + options = { + readonly: false, + visible: true, + reboot: false, + }; + } const readonly = options.readonly; const visible = options.visible; const reboot = options.reboot; + let keyFound = this.getConfigurationKey(key); + if (keyFound && params?.overwrite) { + this.deleteConfigurationKey(keyFound.key, { save: false }); + keyFound = undefined; + } if (!keyFound) { this.configuration.configurationKey.push({ key, @@ -570,6 +644,7 @@ export default class ChargingStation { visible, reboot, }); + params?.save && this.saveConfiguration(); } else { logger.error( `${this.logPrefix()} Trying to add an already existing configuration key: %j`, @@ -578,11 +653,16 @@ export default class ChargingStation { } } - public setConfigurationKeyValue(key: string | StandardParametersKey, value: string): void { - const keyFound = this.getConfigurationKey(key); + public setConfigurationKeyValue( + key: string | StandardParametersKey, + value: string, + caseInsensitive = false + ): void { + const keyFound = this.getConfigurationKey(key, caseInsensitive); if (keyFound) { const keyIndex = this.configuration.configurationKey.indexOf(keyFound); this.configuration.configurationKey[keyIndex].value = value; + this.saveConfiguration(); } else { logger.error( `${this.logPrefix()} Trying to set a value on a non existing configuration key: %j`, @@ -591,6 +671,21 @@ 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.configuration.configurationKey.splice( + this.configuration.configurationKey.indexOf(keyFound), + 1 + ); + params?.save && this.saveConfiguration(); + return deletedConfigurationKey; + } + } + public setChargingProfile(connectorId: number, cp: ChargingProfile): void { let cpReplaced = false; if (!Utils.isEmptyArray(this.getConnectorStatus(connectorId).chargingProfiles)) { @@ -642,18 +737,21 @@ 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; const idSuffix = stationTemplate.nameSuffix ?? ''; + const idStr = '000000000' + this.index.toString(); return stationTemplate.fixedName ? stationTemplate.baseName : stationTemplate.baseName + '-' + instanceIndex.toString() + - ('000000000' + this.index.toString()).substr( - ('000000000' + this.index.toString()).length - 4 - ) + + idStr.substring(idStr.length - 4) + idSuffix; } @@ -661,15 +759,13 @@ export default class ChargingStation { let stationTemplateFromFile: ChargingStationTemplate; try { // Load template file - const fileDescriptor = fs.openSync(this.stationTemplateFile, 'r'); stationTemplateFromFile = JSON.parse( - fs.readFileSync(fileDescriptor, 'utf8') + fs.readFileSync(this.stationTemplateFile, 'utf8') ) as ChargingStationTemplate; - fs.closeSync(fileDescriptor); } catch (error) { FileUtils.handleFileException( this.logPrefix(), - 'Template', + FileType.ChargingStationTemplate, this.stationTemplateFile, error as NodeJS.ErrnoException ); @@ -714,6 +810,10 @@ export default class ChargingStation { 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 @@ -724,7 +824,12 @@ export default class ChargingStation { private initialize(): void { this.stationInfo = this.buildStationInfo(); - this.configuration = this.getTemplateChargingStationConfiguration(); + 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, @@ -866,15 +971,18 @@ export default class ChargingStation { private initOcppParameters(): void { if ( this.getSupervisionUrlOcppConfiguration() && - !this.getConfigurationKey( - this.stationInfo.supervisionUrlOcppKey ?? VendorDefaultParametersKey.ConnectionUrl - ) + !this.getConfigurationKey(this.getSupervisionUrlOcppKey()) ) { this.addConfigurationKey( - 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.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles)) { this.addConfigurationKey( @@ -885,7 +993,8 @@ export default class ChargingStation { this.addConfigurationKey( StandardParametersKey.NumberOfConnectors, this.getNumberOfConnectors().toString(), - { readonly: true } + { readonly: true }, + { overwrite: true } ); if (!this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData)) { this.addConfigurationKey( @@ -930,6 +1039,68 @@ export default class ChargingStation { Constants.DEFAULT_CONNECTION_TIMEOUT.toString() ); } + this.saveConfiguration(); + } + + private getConfigurationFromTemplate(): ChargingStationConfiguration { + return this.stationInfo.Configuration ?? ({} as ChargingStationConfiguration); + } + + private getConfigurationFromFile(): ChargingStationConfiguration | null { + let configuration: ChargingStationConfiguration = null; + if ( + this.getOcppPersistentConfiguration() && + this.configurationFile && + fs.existsSync(this.configurationFile) + ) { + try { + configuration = JSON.parse( + fs.readFileSync(this.configurationFile, 'utf8') + ) as ChargingStationConfiguration; + } catch (error) { + FileUtils.handleFileException( + this.logPrefix(), + FileType.ChargingStationConfiguration, + this.configurationFile, + error as NodeJS.ErrnoException + ); + } + } + return configuration; + } + + private saveConfiguration(): void { + if (this.getOcppPersistentConfiguration()) { + if (this.configurationFile) { + try { + if (!fs.existsSync(path.dirname(this.configurationFile))) { + fs.mkdirSync(path.dirname(this.configurationFile), { recursive: true }); + } + const fileDescriptor = fs.openSync(this.configurationFile, 'w'); + fs.writeFileSync(fileDescriptor, JSON.stringify(this.configuration, null, 2)); + fs.closeSync(fileDescriptor); + } catch (error) { + FileUtils.handleFileException( + this.logPrefix(), + FileType.ChargingStationConfiguration, + this.configurationFile, + error as NodeJS.ErrnoException + ); + } + } else { + logger.error( + `${this.logPrefix()} Trying to save charging station configuration to undefined file` + ); + } + } + } + + private getConfiguration(): ChargingStationConfiguration { + let configuration: ChargingStationConfiguration = this.getConfigurationFromFile(); + if (!configuration) { + configuration = this.getConfigurationFromTemplate(); + } + return configuration; } private async onOpen(): Promise { @@ -947,6 +1118,11 @@ export default class ChargingStation { 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; @@ -1126,10 +1302,6 @@ 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 && @@ -1147,13 +1319,11 @@ export default class ChargingStation { if (authorizationFile) { try { // Load authorization file - const fileDescriptor = fs.openSync(authorizationFile, 'r'); - authorizedTags = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as string[]; - fs.closeSync(fileDescriptor); + authorizedTags = JSON.parse(fs.readFileSync(authorizationFile, 'utf8')) as string[]; } catch (error) { FileUtils.handleFileException( this.logPrefix(), - 'Authorization', + FileType.Authorization, authorizationFile, error as NodeJS.ErrnoException ); @@ -1251,6 +1421,11 @@ export default class ChargingStation { 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 } ); @@ -1349,11 +1524,11 @@ export default class ChargingStation { connectorId, this.getEnergyActiveImportRegisterByTransactionId(transactionId) ); - await this.ocppRequestService.sendTransactionEndMeterValues( + await this.ocppRequestService.sendMessageHandler(RequestCommand.METER_VALUES, { connectorId, transactionId, - transactionEndMeterValue - ); + meterValue: transactionEndMeterValue, + }); } await this.ocppRequestService.sendMessageHandler(RequestCommand.STOP_TRANSACTION, { transactionId, @@ -1534,89 +1709,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