X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FChargingStation.ts;h=5c83b7f2b9a044d456b8199156e7d09d40c26386;hb=0e7a11e1621315c9b1ae42b8bb5a8078336073a1;hp=c532eea01dc72b2a008862a61d98164ebfdbda43;hpb=3ba49ba9f96d06c09f19009dcbe9360eb172782a;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ChargingStation.ts b/src/charging-station/ChargingStation.ts index c532eea0..5c83b7f2 100644 --- a/src/charging-station/ChargingStation.ts +++ b/src/charging-station/ChargingStation.ts @@ -1,60 +1,61 @@ -import { BootNotificationResponse, RegistrationStatus } from '../types/ocpp/RequestResponses'; +import { BootNotificationResponse, RegistrationStatus } from '../types/ocpp/Responses'; import ChargingStationConfiguration, { ConfigurationKey } from '../types/ChargingStationConfiguration'; -import ChargingStationTemplate, { PowerOutType, VoltageOut } from '../types/ChargingStationTemplate'; -import Connectors, { Connector } from '../types/Connectors'; -import { PerformanceObserver, performance } from 'perf_hooks'; +import ChargingStationTemplate, { CurrentType, PowerUnits, Voltage } from '../types/ChargingStationTemplate'; +import { ConnectorPhaseRotation, StandardParametersKey, SupportedFeatureProfiles } from '../types/ocpp/Configuration'; +import Connectors, { Connector, SampledValueTemplate } from '../types/Connectors'; +import { MeterValueMeasurand, MeterValuePhase } from '../types/ocpp/MeterValues'; import Requests, { AvailabilityType, BootNotificationRequest, IncomingRequest, IncomingRequestCommand } from '../types/ocpp/Requests'; -import WebSocket, { MessageEvent } from 'ws'; +import WebSocket, { ClientOptions, MessageEvent } from 'ws'; import AutomaticTransactionGenerator from './AutomaticTransactionGenerator'; import { ChargePointStatus } from '../types/ocpp/ChargePointStatus'; import { ChargingProfile } from '../types/ocpp/ChargingProfile'; import ChargingStationInfo from '../types/ChargingStationInfo'; +import { ClientRequestArgs } from 'http'; import Configuration from '../utils/Configuration'; import Constants from '../utils/Constants'; +import FileUtils from '../utils/FileUtils'; import { MessageType } from '../types/ocpp/MessageType'; -import { MeterValueMeasurand } from '../types/ocpp/MeterValues'; -import OCPP16IncomingRequestService from './ocpp/1.6/OCCP16IncomingRequestService'; +import OCPP16IncomingRequestService from './ocpp/1.6/OCPP16IncomingRequestService'; import OCPP16RequestService from './ocpp/1.6/OCPP16RequestService'; import OCPP16ResponseService from './ocpp/1.6/OCPP16ResponseService'; -import OCPPError from './OcppError'; +import OCPPError from './OCPPError'; import OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService'; import OCPPRequestService from './ocpp/OCPPRequestService'; import { OCPPVersion } from '../types/ocpp/OCPPVersion'; -import { StandardParametersKey } from '../types/ocpp/Configuration'; -import Statistics from '../utils/Statistics'; +import PerformanceStatistics from '../utils/PerformanceStatistics'; import { StopTransactionReason } from '../types/ocpp/Transaction'; +import { URL } from 'url'; import Utils from '../utils/Utils'; import { WebSocketCloseEventStatusCode } from '../types/WebSocket'; import crypto from 'crypto'; import fs from 'fs'; import logger from '../utils/Logger'; +import path from 'path'; export default class ChargingStation { public stationTemplateFile: string; public authorizedTags: string[]; - public stationInfo: ChargingStationInfo; + public stationInfo!: ChargingStationInfo; public connectors: Connectors; - public configuration: ChargingStationConfiguration; + public configuration!: ChargingStationConfiguration; public hasStopped: boolean; - public wsConnection: WebSocket; + public wsConnection!: WebSocket; public requests: Requests; public messageQueue: string[]; - public statistics: Statistics; - public heartbeatSetInterval: NodeJS.Timeout; - public ocppIncomingRequestService: OCPPIncomingRequestService; - public ocppRequestService: OCPPRequestService; + public performanceStatistics!: PerformanceStatistics; + public heartbeatSetInterval!: NodeJS.Timeout; + public ocppIncomingRequestService!: OCPPIncomingRequestService; + public ocppRequestService!: OCPPRequestService; private index: number; - private bootNotificationRequest: BootNotificationRequest; - private bootNotificationResponse: BootNotificationResponse; - private connectorsConfigurationHash: string; - private supervisionUrl: string; - private wsConnectionUrl: string; + private bootNotificationRequest!: BootNotificationRequest; + private bootNotificationResponse!: BootNotificationResponse | null; + private connectorsConfigurationHash!: string; + private wsConnectionUrl!: URL; private hasSocketRestarted: boolean; private autoReconnectRetryCount: number; - private automaticTransactionGeneration: AutomaticTransactionGenerator; - private performanceObserver: PerformanceObserver; - private webSocketPingSetInterval: NodeJS.Timeout; + private automaticTransactionGeneration!: AutomaticTransactionGenerator; + private webSocketPingSetInterval!: NodeJS.Timeout; constructor(index: number, stationTemplateFile: string) { this.index = index; @@ -73,7 +74,7 @@ export default class ChargingStation { } public logPrefix(): string { - return Utils.logPrefix(` ${this.stationInfo.chargingStationId}:`); + return Utils.logPrefix(` ${this.stationInfo.chargingStationId} |`); } public getRandomTagId(): string { @@ -85,15 +86,19 @@ export default class ChargingStation { return !Utils.isEmptyArray(this.authorizedTags); } - public getEnableStatistics(): boolean { + public getEnableStatistics(): boolean | undefined { return !Utils.isUndefined(this.stationInfo.enableStatistics) ? this.stationInfo.enableStatistics : true; } - public getNumberOfPhases(): number { - switch (this.getPowerOutType()) { - case PowerOutType.AC: + public getMayAuthorizeAtRemoteStart(): boolean | undefined { + return this.stationInfo.mayAuthorizeAtRemoteStart ?? true; + } + + public getNumberOfPhases(): number | undefined { + switch (this.getCurrentOutType()) { + case CurrentType.AC: return !Utils.isUndefined(this.stationInfo.numberOfPhases) ? this.stationInfo.numberOfPhases : 3; - case PowerOutType.DC: + case CurrentType.DC: return 0; } } @@ -118,43 +123,81 @@ export default class ChargingStation { return this.connectors[id]; } - public getPowerOutType(): PowerOutType { - return !Utils.isUndefined(this.stationInfo.powerOutType) ? this.stationInfo.powerOutType : PowerOutType.AC; + public getCurrentOutType(): CurrentType | undefined { + return this.stationInfo.currentOutType ?? CurrentType.AC; } - public getVoltageOut(): number { - const errMsg = `${this.logPrefix()} Unknown ${this.getPowerOutType()} powerOutType in template file ${this.stationTemplateFile}, cannot define default voltage out`; + 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.getPowerOutType()) { - case PowerOutType.AC: - defaultVoltageOut = VoltageOut.VOLTAGE_230; + switch (this.getCurrentOutType()) { + case CurrentType.AC: + defaultVoltageOut = Voltage.VOLTAGE_230; break; - case PowerOutType.DC: - defaultVoltageOut = VoltageOut.VOLTAGE_400; + case CurrentType.DC: + defaultVoltageOut = Voltage.VOLTAGE_400; break; default: logger.error(errMsg); - throw Error(errMsg); + throw new Error(errMsg); } return !Utils.isUndefined(this.stationInfo.voltageOut) ? this.stationInfo.voltageOut : defaultVoltageOut; } - public getTransactionIdTag(transactionId: number): string { + public getTransactionIdTag(transactionId: number): string | undefined { for (const connector in this.connectors) { if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) { - return this.getConnector(Utils.convertToInt(connector)).idTag; + return this.getConnector(Utils.convertToInt(connector)).transactionIdTag; } } } - public getTransactionMeterStop(transactionId: number): number { + public getOutOfOrderEndMeterValues(): boolean { + return this.stationInfo.outOfOrderEndMeterValues ?? false; + } + + public getBeginEndMeterValues(): boolean { + return this.stationInfo.beginEndMeterValues ?? false; + } + + public getMeteringPerTransaction(): boolean { + return this.stationInfo.meteringPerTransaction ?? true; + } + + public getTransactionDataMeterValues(): boolean { + return this.stationInfo.transactionDataMeterValues ?? false; + } + + public getMainVoltageMeterValues(): boolean { + return this.stationInfo.mainVoltageMeterValues ?? true; + } + + public getPhaseLineToLineVoltageMeterValues(): boolean { + return this.stationInfo.phaseLineToLineVoltageMeterValues ?? false; + } + + public getEnergyActiveImportRegisterByTransactionId(transactionId: number): number | undefined { + if (this.getMeteringPerTransaction()) { + for (const connector in this.connectors) { + if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) { + return this.getConnector(Utils.convertToInt(connector)).transactionEnergyActiveImportRegisterValue; + } + } + } for (const connector in this.connectors) { if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) { - return this.getConnector(Utils.convertToInt(connector)).lastEnergyActiveImportRegisterValue; + return this.getConnector(Utils.convertToInt(connector)).energyActiveImportRegisterValue; } } } + public getEnergyActiveImportRegisterByConnectorId(connectorId: number): number | undefined { + if (this.getMeteringPerTransaction()) { + return this.getConnector(connectorId).transactionEnergyActiveImportRegisterValue; + } + return this.getConnector(connectorId).energyActiveImportRegisterValue; + } + public getAuthorizeRemoteTxRequests(): boolean { const authorizeRemoteTxRequests = this.getConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests); return authorizeRemoteTxRequests ? Utils.convertToBoolean(authorizeRemoteTxRequests.value) : false; @@ -172,14 +215,51 @@ export default class ChargingStation { this.startWebSocketPing(); } + public getSampledValueTemplate(connectorId: number, measurand: MeterValueMeasurand = MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER, + phase?: MeterValuePhase): SampledValueTemplate | undefined { + if (!Constants.SUPPORTED_MEASURANDS.includes(measurand)) { + logger.warn(`${this.logPrefix()} Trying to get unsupported MeterValues measurand ${measurand} ${phase ? `on phase ${phase} ` : ''}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} ${phase ? `on phase ${phase} ` : ''}in template on connectorId ${connectorId} not found in '${StandardParametersKey.MeterValuesSampledData}' OCPP parameter`); + return; + } + const sampledValueTemplates: SampledValueTemplate[] = this.getConnector(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} ${phase ? `on phase ${phase} ` : ''}in template on connectorId ${connectorId}`); + continue; + } 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) { + logger.error(`${this.logPrefix()} Missing MeterValues for default measurand ${measurand} in template on connectorId ${connectorId}`); + } + logger.debug(`${this.logPrefix()} No MeterValues for measurand ${measurand} ${phase ? `on phase ${phase} ` : ''}in template on connectorId ${connectorId}`); + } + + public getAutomaticTransactionGeneratorRequireAuthorize(): boolean { + return this.stationInfo.AutomaticTransactionGenerator.requireAuthorize ?? true; + } + public startHeartbeat(): void { if (this.getHeartbeatInterval() && this.getHeartbeatInterval() > 0 && !this.heartbeatSetInterval) { - this.heartbeatSetInterval = setInterval(async () => { + // eslint-disable-next-line @typescript-eslint/no-misused-promises + this.heartbeatSetInterval = setInterval(async (): Promise => { await this.ocppRequestService.sendHeartbeat(); }, this.getHeartbeatInterval()); logger.info(this.logPrefix() + ' Heartbeat started every ' + Utils.milliSecondsToHHMMSS(this.getHeartbeatInterval())); } else if (this.heartbeatSetInterval) { - logger.info(this.logPrefix() + ' Heartbeat every ' + Utils.milliSecondsToHHMMSS(this.getHeartbeatInterval()) + ' already started'); + logger.info(this.logPrefix() + ' Heartbeat already started every ' + Utils.milliSecondsToHHMMSS(this.getHeartbeatInterval())); } else { logger.error(`${this.logPrefix()} Heartbeat interval set to ${this.getHeartbeatInterval() ? Utils.milliSecondsToHHMMSS(this.getHeartbeatInterval()) : this.getHeartbeatInterval()}, not starting the heartbeat`); } @@ -209,23 +289,19 @@ export default class ChargingStation { return; } if (interval > 0) { - this.getConnector(connectorId).transactionSetInterval = setInterval(async () => { - if (this.getEnableStatistics()) { - const sendMeterValues = performance.timerify(this.ocppRequestService.sendMeterValues); - this.performanceObserver.observe({ - entryTypes: ['function'], - }); - await sendMeterValues(connectorId, this.getConnector(connectorId).transactionId, interval, this.ocppRequestService); - } else { - await this.ocppRequestService.sendMeterValues(connectorId, this.getConnector(connectorId).transactionId, interval, this.ocppRequestService); - } + // eslint-disable-next-line @typescript-eslint/no-misused-promises + this.getConnector(connectorId).transactionSetInterval = setInterval(async (): Promise => { + await this.ocppRequestService.sendMeterValues(connectorId, this.getConnector(connectorId).transactionId, interval); }, interval); } else { - logger.error(`${this.logPrefix()} Charging station ${StandardParametersKey.MeterValueSampleInterval} configuration set to ${Utils.milliSecondsToHHMMSS(interval)}, not sending MeterValues`); + logger.error(`${this.logPrefix()} Charging station ${StandardParametersKey.MeterValueSampleInterval} configuration set to ${interval ? Utils.milliSecondsToHHMMSS(interval) : interval}, not sending MeterValues`); } } public start(): void { + if (this.getEnableStatistics()) { + this.performanceStatistics.start(); + } this.openWSConnection(); // Monitor authorization file this.startAuthorizationFileMonitoring(); @@ -257,18 +333,20 @@ export default class ChargingStation { if (this.isWebSocketOpen()) { this.wsConnection.close(); } + if (this.getEnableStatistics()) { + this.performanceStatistics.stop(); + } this.bootNotificationResponse = null; this.hasStopped = true; } - public getConfigurationKey(key: string | StandardParametersKey, caseInsensitive = false): ConfigurationKey { - const configurationKey: ConfigurationKey = this.configuration.configurationKey.find((configElement) => { + 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; }); - return configurationKey; } public addConfigurationKey(key: string | StandardParametersKey, value: string, readonly = false, visible = true, reboot = false): void { @@ -296,32 +374,62 @@ export default class ChargingStation { } } - public setChargingProfile(connectorId: number, cp: ChargingProfile): boolean { + public setChargingProfile(connectorId: number, cp: ChargingProfile): void { + let cpReplaced = false; if (!Utils.isEmptyArray(this.getConnector(connectorId).chargingProfiles)) { - this.getConnector(connectorId).chargingProfiles.forEach((chargingProfile: ChargingProfile, index: number) => { + this.getConnector(connectorId).chargingProfiles?.forEach((chargingProfile: ChargingProfile, index: number) => { if (chargingProfile.chargingProfileId === cp.chargingProfileId - || (chargingProfile.stackLevel === cp.stackLevel && chargingProfile.chargingProfilePurpose === cp.chargingProfilePurpose)) { + || (chargingProfile.stackLevel === cp.stackLevel && chargingProfile.chargingProfilePurpose === cp.chargingProfilePurpose)) { this.getConnector(connectorId).chargingProfiles[index] = cp; - return true; + cpReplaced = true; } }); } - this.getConnector(connectorId).chargingProfiles.push(cp); - return true; + !cpReplaced && this.getConnector(connectorId).chargingProfiles?.push(cp); } public resetTransactionOnConnector(connectorId: number): void { - this.initTransactionOnConnector(connectorId); - if (this.getConnector(connectorId)?.transactionSetInterval) { - clearInterval(this.getConnector(connectorId).transactionSetInterval); + this.getConnector(connectorId).authorized = false; + this.getConnector(connectorId).transactionStarted = false; + delete this.getConnector(connectorId).authorizeIdTag; + delete this.getConnector(connectorId).transactionId; + delete this.getConnector(connectorId).transactionIdTag; + this.getConnector(connectorId).transactionEnergyActiveImportRegisterValue = 0; + delete this.getConnector(connectorId).transactionBeginMeterValue; + this.stopMeterValues(connectorId); + } + + public addToMessageQueue(message: string): void { + let dups = false; + // Handle dups in message queue + for (const bufferedMessage of this.messageQueue) { + // Message already in the queue + if (message === bufferedMessage) { + dups = true; + break; + } + } + if (!dups) { + // Queue message + this.messageQueue.push(message); + } + } + + private flushMessageQueue() { + if (!Utils.isEmptyArray(this.messageQueue)) { + this.messageQueue.forEach((message, index) => { + this.messageQueue.splice(index, 1); + // TODO: evaluate the need to track performance + this.wsConnection.send(message); + }); } } private getChargingStationId(stationTemplate: ChargingStationTemplate): string { // In case of multiple instances: add instance index to charging station id - let instanceIndex = process.env.CF_INSTANCE_INDEX ? process.env.CF_INSTANCE_INDEX : 0; + let instanceIndex = process.env.CF_INSTANCE_INDEX ?? 0; instanceIndex = instanceIndex > 0 ? instanceIndex : ''; - const idSuffix = stationTemplate.nameSuffix ? stationTemplate.nameSuffix : ''; + const idSuffix = stationTemplate.nameSuffix ?? ''; return stationTemplate.fixedName ? stationTemplate.baseName : stationTemplate.baseName + '-' + instanceIndex.toString() + ('000000000' + this.index.toString()).substr(('000000000' + this.index.toString()).length - 4) + idSuffix; } @@ -333,16 +441,23 @@ export default class ChargingStation { stationTemplateFromFile = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as ChargingStationTemplate; fs.closeSync(fileDescriptor); } catch (error) { - logger.error('Template file ' + this.stationTemplateFile + ' loading error: %j', error); - throw error; + FileUtils.handleFileException(this.logPrefix(), 'Template', this.stationTemplateFile, error); } - const stationInfo: ChargingStationInfo = stationTemplateFromFile || {} as ChargingStationInfo; + const stationInfo: ChargingStationInfo = stationTemplateFromFile ?? {} as ChargingStationInfo; if (!Utils.isEmptyArray(stationTemplateFromFile.power)) { stationTemplateFromFile.power = stationTemplateFromFile.power as number[]; - stationInfo.maxPower = stationTemplateFromFile.power[Math.floor(Math.random() * stationTemplateFromFile.power.length)]; + const powerArrayRandomIndex = Math.floor(Math.random() * stationTemplateFromFile.power.length); + stationInfo.maxPower = stationTemplateFromFile.powerUnit === PowerUnits.KILO_WATT + ? stationTemplateFromFile.power[powerArrayRandomIndex] * 1000 + : stationTemplateFromFile.power[powerArrayRandomIndex]; } else { - stationInfo.maxPower = stationTemplateFromFile.power as number; + 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 = this.getChargingStationId(stationTemplateFromFile); stationInfo.resetTime = stationTemplateFromFile.resetTime ? stationTemplateFromFile.resetTime * 1000 : Constants.CHARGING_STATION_DEFAULT_RESET_TIME; return stationInfo; @@ -367,8 +482,7 @@ export default class ChargingStation { ...!Utils.isUndefined(this.stationInfo.firmwareVersion) && { firmwareVersion: this.stationInfo.firmwareVersion }, }; this.configuration = this.getTemplateChargingStationConfiguration(); - this.supervisionUrl = this.getSupervisionURL(); - this.wsConnectionUrl = this.supervisionUrl + '/' + this.stationInfo.chargingStationId; + this.wsConnectionUrl = new URL(this.getSupervisionURL().href + '/' + this.stationInfo.chargingStationId); // Build connectors if needed const maxConnectors = this.getMaxNumberOfConnectors(); if (maxConnectors <= 0) { @@ -404,8 +518,8 @@ export default class ChargingStation { // 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.getRandomInt(Utils.convertToInt(lastConnector), 1) : index; - this.connectors[index] = Utils.cloneObject(this.stationInfo.Connectors[randConnectorID]); + const randConnectorId = this.stationInfo.randomConnectors ? Utils.getRandomInt(Utils.convertToInt(lastConnector), 1) : index; + this.connectors[index] = Utils.cloneObject(this.stationInfo.Connectors[randConnectorId]); this.connectors[index].availability = AvailabilityType.OPERATIVE; if (Utils.isUndefined(this.connectors[lastConnector]?.chargingProfiles)) { this.connectors[index].chargingProfiles = []; @@ -418,7 +532,7 @@ export default class ChargingStation { // Initialize transaction attributes on connectors for (const connector in this.connectors) { if (Utils.convertToInt(connector) > 0 && !this.getConnector(Utils.convertToInt(connector)).transactionStarted) { - this.initTransactionOnConnector(Utils.convertToInt(connector)); + this.initTransactionAttributesOnConnector(Utils.convertToInt(connector)); } } switch (this.getOCPPVersion()) { @@ -431,28 +545,65 @@ export default class ChargingStation { break; } // OCPP parameters + this.initOCPPParameters(); + 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 = new PerformanceStatistics(this.stationInfo.chargingStationId); + } + } + + private initOCPPParameters(): void { + if (!this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles)) { + this.addConfigurationKey(StandardParametersKey.SupportedFeatureProfiles, `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.Local_Auth_List_Management},${SupportedFeatureProfiles.Smart_Charging}`); + } this.addConfigurationKey(StandardParametersKey.NumberOfConnectors, this.getNumberOfConnectors().toString(), true); if (!this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData)) { this.addConfigurationKey(StandardParametersKey.MeterValuesSampledData, MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER); } - this.stationInfo.powerDivider = this.getPowerDivider(); - if (this.getEnableStatistics()) { - this.statistics = new Statistics(this.stationInfo.chargingStationId); - this.performanceObserver = new PerformanceObserver((list) => { - const entry = list.getEntries()[0]; - this.statistics.logPerformance(entry, Constants.ENTITY_CHARGING_STATION); - this.performanceObserver.disconnect(); - }); + if (!this.getConfigurationKey(StandardParametersKey.ConnectorPhaseRotation)) { + const connectorPhaseRotation = []; + for (const connector in this.connectors) { + // AC/DC + if (Utils.convertToInt(connector) === 0 && this.getNumberOfPhases() === 0) { + connectorPhaseRotation.push(`${connector}.${ConnectorPhaseRotation.RST}`); + } else if (Utils.convertToInt(connector) > 0 && this.getNumberOfPhases() === 0) { + connectorPhaseRotation.push(`${connector}.${ConnectorPhaseRotation.NotApplicable}`); + // AC + } else if (Utils.convertToInt(connector) > 0 && this.getNumberOfPhases() === 1) { + connectorPhaseRotation.push(`${connector}.${ConnectorPhaseRotation.NotApplicable}`); + } else if (Utils.convertToInt(connector) > 0 && this.getNumberOfPhases() === 3) { + connectorPhaseRotation.push(`${connector}.${ConnectorPhaseRotation.RST}`); + } + } + this.addConfigurationKey(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)) { + this.addConfigurationKey(StandardParametersKey.LocalAuthListEnabled, 'false'); + } + if (!this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) { + this.addConfigurationKey(StandardParametersKey.ConnectionTimeOut, Constants.DEFAULT_CONNECTION_TIMEOUT.toString()); } } private async onOpen(): Promise { - logger.info(`${this.logPrefix()} Is connected to server through ${this.wsConnectionUrl}`); + logger.info(`${this.logPrefix()} Connected to OCPP server through ${this.wsConnectionUrl.toString()}`); if (!this.isRegistered()) { // Send BootNotification let registrationRetryCount = 0; do { - this.bootNotificationResponse = await this.ocppRequestService.sendBootNotification(this.bootNotificationRequest.chargePointModel, this.bootNotificationRequest.chargePointVendor, this.bootNotificationRequest.chargeBoxSerialNumber, this.bootNotificationRequest.firmwareVersion); + this.bootNotificationResponse = await this.ocppRequestService.sendBootNotification(this.bootNotificationRequest.chargePointModel, + this.bootNotificationRequest.chargePointVendor, this.bootNotificationRequest.chargeBoxSerialNumber, this.bootNotificationRequest.firmwareVersion); if (!this.isRegistered()) { registrationRetryCount++; await Utils.sleep(this.bootNotificationResponse?.interval ? this.bootNotificationResponse.interval * 1000 : Constants.OCPP_DEFAULT_BOOT_NOTIFICATION_INTERVAL); @@ -463,12 +614,7 @@ export default class ChargingStation { await this.startMessageSequence(); this.hasStopped && (this.hasStopped = false); if (this.hasSocketRestarted && this.isWebSocketOpen()) { - if (!Utils.isEmptyArray(this.messageQueue)) { - this.messageQueue.forEach((message, index) => { - this.messageQueue.splice(index, 1); - this.wsConnection.send(message); - }); - } + this.flushMessageQueue(); } } else { logger.error(`${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})`); @@ -477,7 +623,7 @@ export default class ChargingStation { this.hasSocketRestarted = false; } - private async onClose(closeEvent): Promise { + private async onClose(closeEvent: any): Promise { switch (closeEvent) { case WebSocketCloseEventStatusCode.CLOSE_NORMAL: // Normal close case WebSocketCloseEventStatusCode.CLOSE_NO_STATUS: @@ -493,20 +639,24 @@ export default class ChargingStation { private async onMessage(messageEvent: MessageEvent): Promise { let [messageType, messageId, commandName, commandPayload, errorDetails]: IncomingRequest = [0, '', '' as IncomingRequestCommand, {}, {}]; - let responseCallback: (payload?: Record | string, requestPayload?: Record) => void; + let responseCallback: (payload: Record | string, requestPayload: Record) => void; let rejectCallback: (error: OCPPError) => void; let requestPayload: Record; let errMsg: string; try { - // Parse the message - [messageType, messageId, commandName, commandPayload, errorDetails] = JSON.parse(messageEvent.toString()) as IncomingRequest; - + const request = JSON.parse(messageEvent.toString()) as IncomingRequest; + if (Utils.isIterable(request)) { + // Parse the message + [messageType, messageId, commandName, commandPayload, errorDetails] = request; + } else { + throw new Error('Incoming request is not iterable'); + } // Check the Type of message switch (messageType) { // Incoming Message case MessageType.CALL_MESSAGE: if (this.getEnableStatistics()) { - this.statistics.addMessage(commandName, messageType); + this.performanceStatistics.addRequestStatistic(commandName, messageType); } // Process the call await this.ocppIncomingRequestService.handleRequest(messageId, commandName, commandPayload); @@ -548,23 +698,23 @@ export default class ChargingStation { } } catch (error) { // Log - logger.error('%s Incoming message %j processing error %j on request content type %j', this.logPrefix(), messageEvent, error, this.requests[messageId]); + logger.error('%s Incoming request message %j processing error %j on content type %j', this.logPrefix(), messageEvent, error, this.requests[messageId]); // Send error messageType !== MessageType.CALL_ERROR_MESSAGE && await this.ocppRequestService.sendError(messageId, error, commandName); } } private onPing(): void { - logger.debug(this.logPrefix() + ' Has received a WS ping (rfc6455) from the server'); + logger.debug(this.logPrefix() + ' Received a WS ping (rfc6455) from the server'); } private onPong(): void { - logger.debug(this.logPrefix() + ' Has received a WS pong (rfc6455) from the server'); + logger.debug(this.logPrefix() + ' Received a WS pong (rfc6455) from the server'); } - private async onError(errorEvent): Promise { + private async onError(errorEvent: any): Promise { logger.error(this.logPrefix() + ' Socket error: %j', errorEvent); - // pragma switch (errorEvent.code) { + // switch (errorEvent.code) { // case 'ECONNREFUSED': // await this._reconnect(errorEvent); // break; @@ -572,11 +722,11 @@ export default class ChargingStation { } private getTemplateChargingStationConfiguration(): ChargingStationConfiguration { - return this.stationInfo.Configuration ? this.stationInfo.Configuration : {} as ChargingStationConfiguration; + return this.stationInfo.Configuration ?? {} as ChargingStationConfiguration; } - private getAuthorizationFile(): string { - return this.stationInfo.authorizationFile && this.stationInfo.authorizationFile; + private getAuthorizationFile(): string | undefined { + return this.stationInfo.authorizationFile && path.join(path.resolve(__dirname, '../'), 'assets', path.basename(this.stationInfo.authorizationFile)); } private getAuthorizedTags(): string[] { @@ -589,8 +739,7 @@ export default class ChargingStation { authorizedTags = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as string[]; fs.closeSync(fileDescriptor); } catch (error) { - logger.error(this.logPrefix() + ' Authorization file ' + authorizationFile + ' loading error: %j', error); - throw error; + FileUtils.handleFileException(this.logPrefix(), 'Authorization', authorizationFile, error); } } else { logger.info(this.logPrefix() + ' No authorization file given in template file ' + this.stationTemplateFile); @@ -598,7 +747,7 @@ export default class ChargingStation { return authorizedTags; } - private getUseConnectorId0(): boolean { + private getUseConnectorId0(): boolean | undefined { return !Utils.isUndefined(this.stationInfo.useConnectorId0) ? this.stationInfo.useConnectorId0 : true; } @@ -613,18 +762,15 @@ export default class ChargingStation { } // 0 for disabling - private getConnectionTimeout(): number { - if (!Utils.isUndefined(this.stationInfo.connectionTimeout)) { - return this.stationInfo.connectionTimeout; + private getConnectionTimeout(): number | undefined { + if (this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) { + return parseInt(this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut).value) ?? Constants.DEFAULT_CONNECTION_TIMEOUT; } - if (!Utils.isUndefined(Configuration.getConnectionTimeout())) { - return Configuration.getConnectionTimeout(); - } - return 30; + return Constants.DEFAULT_CONNECTION_TIMEOUT; } // -1 for unlimited, 0 for disabling - private getAutoReconnectMaxRetries(): number { + private getAutoReconnectMaxRetries(): number | undefined { if (!Utils.isUndefined(this.stationInfo.autoReconnectMaxRetries)) { return this.stationInfo.autoReconnectMaxRetries; } @@ -635,7 +781,7 @@ export default class ChargingStation { } // 0 for disabling - private getRegistrationMaxRetries(): number { + private getRegistrationMaxRetries(): number | undefined { if (!Utils.isUndefined(this.stationInfo.registrationMaxRetries)) { return this.stationInfo.registrationMaxRetries; } @@ -699,17 +845,19 @@ export default class ChargingStation { } } // Start the ATG + this.startAutomaticTransactionGenerator(); + } + + private startAutomaticTransactionGenerator() { if (this.stationInfo.AutomaticTransactionGenerator.enable) { if (!this.automaticTransactionGeneration) { this.automaticTransactionGeneration = new AutomaticTransactionGenerator(this); } if (this.automaticTransactionGeneration.timeToStop) { - await this.automaticTransactionGeneration.start(); + // The ATG might sleep + void this.automaticTransactionGeneration.start(); } } - if (this.getEnableStatistics()) { - this.statistics.start(); - } } private async stopMessageSequence(reason: StopTransactionReason = StopTransactionReason.NONE): Promise { @@ -726,14 +874,17 @@ export default class ChargingStation { for (const connector in this.connectors) { if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionStarted) { const transactionId = this.getConnector(Utils.convertToInt(connector)).transactionId; - await this.ocppRequestService.sendStopTransaction(transactionId, this.getTransactionMeterStop(transactionId), this.getTransactionIdTag(transactionId), reason); + await this.ocppRequestService.sendStopTransaction(transactionId, this.getEnergyActiveImportRegisterByTransactionId(transactionId), + this.getTransactionIdTag(transactionId), reason); } } } } private startWebSocketPing(): void { - const webSocketPingInterval: number = this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval) ? Utils.convertToInt(this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval).value) : 0; + const webSocketPingInterval: number = this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval) + ? Utils.convertToInt(this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval).value) + : 0; if (webSocketPingInterval > 0 && !this.webSocketPingSetInterval) { this.webSocketPingSetInterval = setInterval(() => { if (this.isWebSocketOpen()) { @@ -751,11 +902,10 @@ export default class ChargingStation { private stopWebSocketPing(): void { if (this.webSocketPingSetInterval) { clearInterval(this.webSocketPingSetInterval); - this.webSocketPingSetInterval = null; } } - private getSupervisionURL(): string { + private getSupervisionURL(): URL { const supervisionUrls = Utils.cloneObject(this.stationInfo.supervisionURL ? this.stationInfo.supervisionURL : Configuration.getSupervisionURLs()); let indexUrl = 0; if (!Utils.isEmptyArray(supervisionUrls)) { @@ -765,12 +915,12 @@ export default class ChargingStation { // Get a random url indexUrl = Math.floor(Math.random() * supervisionUrls.length); } - return supervisionUrls[indexUrl]; + return new URL(supervisionUrls[indexUrl]); } - return supervisionUrls as string; + return new URL(supervisionUrls as string); } - private getHeartbeatInterval(): number { + private getHeartbeatInterval(): number | undefined { const HeartbeatInterval = this.getConfigurationKey(StandardParametersKey.HeartbeatInterval); if (HeartbeatInterval) { return Utils.convertToInt(HeartbeatInterval.value) * 1000; @@ -779,21 +929,21 @@ export default class ChargingStation { if (HeartBeatInterval) { return Utils.convertToInt(HeartBeatInterval.value) * 1000; } + !this.stationInfo.autoRegister && logger.warn(`${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${Constants.DEFAULT_HEARTBEAT_INTERVAL}`); + return Constants.DEFAULT_HEARTBEAT_INTERVAL; } private stopHeartbeat(): void { if (this.heartbeatSetInterval) { clearInterval(this.heartbeatSetInterval); - this.heartbeatSetInterval = null; } } - private openWSConnection(options?: WebSocket.ClientOptions, forceCloseOpened = false): void { - if (Utils.isUndefined(options)) { - options = {} as WebSocket.ClientOptions; - } - if (Utils.isUndefined(options.handshakeTimeout)) { - options.handshakeTimeout = this.getConnectionTimeout() * 1000; + private openWSConnection(options?: ClientOptions & ClientRequestArgs, forceCloseOpened = false): void { + options = options ?? {}; + options.handshakeTimeout = options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000; + if (!Utils.isNullOrUndefined(this.stationInfo.supervisionUser) && !Utils.isNullOrUndefined(this.stationInfo.supervisionPassword)) { + options.auth = `${this.stationInfo.supervisionUser}:${this.stationInfo.supervisionPassword}`; } if (this.isWebSocketOpen() && forceCloseOpened) { this.wsConnection.close(); @@ -808,53 +958,72 @@ export default class ChargingStation { break; } this.wsConnection = new WebSocket(this.wsConnectionUrl, protocol, options); - logger.info(this.logPrefix() + ' Will communicate through URL ' + this.supervisionUrl); + logger.info(this.logPrefix() + ' Open OCPP connection to URL ' + this.wsConnectionUrl.toString()); + } + + private stopMeterValues(connectorId: number) { + if (this.getConnector(connectorId)?.transactionSetInterval) { + clearInterval(this.getConnector(connectorId).transactionSetInterval); + } } private startAuthorizationFileMonitoring(): void { - fs.watch(this.getAuthorizationFile()).on('change', (e) => { + const authorizationFile = this.getAuthorizationFile(); + if (authorizationFile) { try { - logger.debug(this.logPrefix() + ' Authorization file ' + this.getAuthorizationFile() + ' have changed, reload'); - // Initialize authorizedTags - this.authorizedTags = this.getAuthorizedTags(); + fs.watch(authorizationFile).on('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) { - logger.error(this.logPrefix() + ' Authorization file monitoring error: %j', error); + FileUtils.handleFileException(this.logPrefix(), 'Authorization', authorizationFile, error); } - }); + } else { + logger.info(this.logPrefix() + ' No authorization file given in template file ' + this.stationTemplateFile + '. Not monitoring changes'); + } } private startStationTemplateFileMonitoring(): void { - fs.watch(this.stationTemplateFile).on('change', async (e): Promise => { - try { - logger.debug(this.logPrefix() + ' Template file ' + this.stationTemplateFile + ' have changed, reload'); - // Initialize - this.initialize(); - // Stop the ATG - if (!this.stationInfo.AutomaticTransactionGenerator.enable && + try { + // eslint-disable-next-line @typescript-eslint/no-misused-promises + fs.watch(this.stationTemplateFile).on('change', async (): Promise => { + try { + logger.debug(this.logPrefix() + ' Template file ' + this.stationTemplateFile + ' have changed, reload'); + // Initialize + this.initialize(); + // Restart the ATG + if (!this.stationInfo.AutomaticTransactionGenerator.enable && this.automaticTransactionGeneration) { - await this.automaticTransactionGeneration.stop(); - } - // Start the ATG - if (this.stationInfo.AutomaticTransactionGenerator.enable) { - if (!this.automaticTransactionGeneration) { - this.automaticTransactionGeneration = new AutomaticTransactionGenerator(this); + await this.automaticTransactionGeneration.stop(); } - if (this.automaticTransactionGeneration.timeToStop) { - await this.automaticTransactionGeneration.start(); + 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); } - // 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); + } } - private getReconnectExponentialDelay(): boolean { + private getReconnectExponentialDelay(): boolean | undefined { return !Utils.isUndefined(this.stationInfo.reconnectExponentialDelay) ? this.stationInfo.reconnectExponentialDelay : false; } - private async reconnect(error): Promise { + private async reconnect(error: any): Promise { + // Stop WebSocket ping + this.stopWebSocketPing(); // Stop heartbeat this.stopHeartbeat(); // Stop the ATG if needed @@ -862,7 +1031,7 @@ export default class ChargingStation { this.stationInfo.AutomaticTransactionGenerator.stopOnConnectionFailure && this.automaticTransactionGeneration && !this.automaticTransactionGeneration.timeToStop) { - this.automaticTransactionGeneration.stop().catch(() => { }); + await this.automaticTransactionGeneration.stop(); } if (this.autoReconnectRetryCount < this.getAutoReconnectMaxRetries() || this.getAutoReconnectMaxRetries() === -1) { this.autoReconnectRetryCount++; @@ -877,11 +1046,11 @@ export default class ChargingStation { } } - private initTransactionOnConnector(connectorId: number): void { + private initTransactionAttributesOnConnector(connectorId: number): void { + this.getConnector(connectorId).authorized = false; this.getConnector(connectorId).transactionStarted = false; - this.getConnector(connectorId).transactionId = null; - this.getConnector(connectorId).idTag = null; - this.getConnector(connectorId).lastEnergyActiveImportRegisterValue = -1; + this.getConnector(connectorId).energyActiveImportRegisterValue = 0; + this.getConnector(connectorId).transactionEnergyActiveImportRegisterValue = 0; } }