X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FChargingStation.ts;h=1301bc7aa9373f9f67eecf450da4c6a004e2e110;hb=593cf3f9c5d1b68ec8b5a034343a7cd6f0be7f38;hp=44f1c9c55d48d0e3a520567946edf24229201a10;hpb=7dc7fd620d2b296ef041a939b84d4a22ec425fb1;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ChargingStation.ts b/src/charging-station/ChargingStation.ts index 44f1c9c5..1301bc7a 100644 --- a/src/charging-station/ChargingStation.ts +++ b/src/charging-station/ChargingStation.ts @@ -1,14 +1,25 @@ +import { AuthorizationStatus, StartTransactionRequest, StartTransactionResponse, StopTransactionReason, StopTransactionRequest, StopTransactionResponse } from '../types/ocpp/1.6/Transaction'; +import { BootNotificationResponse, ChangeConfigurationResponse, DefaultResponse, GetConfigurationResponse, HeartbeatResponse, RegistrationStatus, SetChargingProfileResponse, StatusNotificationResponse, UnlockConnectorResponse } from '../types/ocpp/1.6/RequestResponses'; +import { ChargingProfile, ChargingProfilePurposeType } from '../types/ocpp/1.6/ChargingProfile'; +import ChargingStationConfiguration, { ConfigurationKey } from '../types/ChargingStationConfiguration'; +import ChargingStationTemplate, { PowerOutType } from '../types/ChargingStationTemplate'; +import Connectors, { Connector } from '../types/Connectors'; +import { MeterValue, MeterValueLocation, MeterValueMeasurand, MeterValuePhase, MeterValueUnit, MeterValuesRequest, MeterValuesResponse, SampledValue } from '../types/ocpp/1.6/MeterValues'; import { PerformanceObserver, performance } from 'perf_hooks'; +import Requests, { BootNotificationRequest, ChangeConfigurationRequest, GetConfigurationRequest, HeartbeatRequest, RemoteStartTransactionRequest, RemoteStopTransactionRequest, ResetRequest, SetChargingProfileRequest, StatusNotificationRequest, UnlockConnectorRequest } from '../types/ocpp/1.6/Requests'; +import WebSocket, { MessageEvent } from 'ws'; import AutomaticTransactionGenerator from './AutomaticTransactionGenerator'; +import { ChargePointErrorCode } from '../types/ocpp/1.6/ChargePointErrorCode'; +import { ChargePointStatus } from '../types/ocpp/1.6/ChargePointStatus'; +import ChargingStationInfo from '../types/ChargingStationInfo'; import Configuration from '../utils/Configuration'; -import Constants from '../utils/Constants.js'; +import Constants from '../utils/Constants'; import ElectricUtils from '../utils/ElectricUtils'; -import { MeasurandValues } from '../types/MeasurandValues'; -import OCPPError from './OcppError.js'; +import MeasurandValues from '../types/MeasurandValues'; +import OCPPError from './OcppError'; import Statistics from '../utils/Statistics'; import Utils from '../utils/Utils'; -import WebSocket from 'ws'; import crypto from 'crypto'; import fs from 'fs'; import logger from '../utils/Logger'; @@ -16,85 +27,90 @@ import logger from '../utils/Logger'; export default class ChargingStation { private _index: number; private _stationTemplateFile: string; - private _stationInfo; - private _bootNotificationMessage; - private _connectors; - private _configuration; + private _stationInfo: ChargingStationInfo; + private _bootNotificationRequest: BootNotificationRequest; + private _bootNotificationResponse: BootNotificationResponse; + private _connectors: Connectors; + private _configuration: ChargingStationConfiguration; private _connectorsConfigurationHash: string; - private _supervisionUrl; - private _wsConnectionUrl; + private _supervisionUrl: string; + private _wsConnectionUrl: string; private _wsConnection: WebSocket; - private _isSocketRestart; + private _hasStopped: boolean; + private _hasSocketRestarted: boolean; + private _connectionTimeout: number; private _autoReconnectRetryCount: number; private _autoReconnectMaxRetries: number; - private _autoReconnectTimeout: number; - private _requests; - private _messageQueue: any[]; + private _requests: Requests; + private _messageQueue: string[]; private _automaticTransactionGeneration: AutomaticTransactionGenerator; private _authorizedTags: string[]; private _heartbeatInterval: number; - private _heartbeatSetInterval; + private _heartbeatSetInterval: NodeJS.Timeout; + private _webSocketPingSetInterval: NodeJS.Timeout; private _statistics: Statistics; private _performanceObserver: PerformanceObserver; constructor(index: number, stationTemplateFile: string) { this._index = index; this._stationTemplateFile = stationTemplateFile; - this._connectors = {}; + this._connectors = {} as Connectors; this._initialize(); - this._isSocketRestart = false; + this._hasStopped = false; + this._hasSocketRestarted = false; this._autoReconnectRetryCount = 0; - this._autoReconnectMaxRetries = Configuration.getAutoReconnectMaxRetries(); // -1 for unlimited - this._autoReconnectTimeout = Configuration.getAutoReconnectTimeout() * 1000; // Ms, zero for disabling - this._requests = {}; - this._messageQueue = []; + this._requests = {} as Requests; + this._messageQueue = [] as string[]; this._authorizedTags = this._loadAndGetAuthorizedTags(); } - _getStationName(stationTemplate): string { - return stationTemplate.fixedName ? stationTemplate.baseName : stationTemplate.baseName + '-' + ('000000000' + this._index).substr(('000000000' + this._index).length - 4); + _getStationName(stationTemplate: ChargingStationTemplate): string { + return stationTemplate.fixedName ? stationTemplate.baseName : stationTemplate.baseName + '-' + ('000000000' + this._index.toString()).substr(('000000000' + this._index.toString()).length - 4); } - _buildStationInfo() { - let stationTemplateFromFile; + _buildStationInfo(): ChargingStationInfo { + let stationTemplateFromFile: ChargingStationTemplate; try { // Load template file const fileDescriptor = fs.openSync(this._stationTemplateFile, 'r'); - stationTemplateFromFile = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')); + stationTemplateFromFile = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as ChargingStationTemplate; fs.closeSync(fileDescriptor); } catch (error) { - logger.error('Template file ' + this._stationTemplateFile + ' loading error: ' + error); + logger.error('Template file ' + this._stationTemplateFile + ' loading error: %j', error); throw error; } - const stationTemplate = stationTemplateFromFile || {}; + const stationInfo: ChargingStationInfo = stationTemplateFromFile || {} as ChargingStationInfo; if (!Utils.isEmptyArray(stationTemplateFromFile.power)) { - stationTemplate.maxPower = stationTemplateFromFile.power[Math.floor(Math.random() * stationTemplateFromFile.power.length)]; + stationTemplateFromFile.power = stationTemplateFromFile.power as number[]; + stationInfo.maxPower = stationTemplateFromFile.power[Math.floor(Math.random() * stationTemplateFromFile.power.length)]; } else { - stationTemplate.maxPower = stationTemplateFromFile.power; + stationInfo.maxPower = stationTemplateFromFile.power as number; } - stationTemplate.name = this._getStationName(stationTemplateFromFile); - stationTemplate.resetTime = stationTemplateFromFile.resetTime ? stationTemplateFromFile.resetTime * 1000 : Constants.CHARGING_STATION_DEFAULT_RESET_TIME; - return stationTemplate; + stationInfo.name = this._getStationName(stationTemplateFromFile); + stationInfo.resetTime = stationTemplateFromFile.resetTime ? stationTemplateFromFile.resetTime * 1000 : Constants.CHARGING_STATION_DEFAULT_RESET_TIME; + return stationInfo; } - get stationInfo() { + get stationInfo(): ChargingStationInfo { return this._stationInfo; } _initialize(): void { this._stationInfo = this._buildStationInfo(); - this._bootNotificationMessage = { + this._bootNotificationRequest = { chargePointModel: this._stationInfo.chargePointModel, chargePointVendor: this._stationInfo.chargePointVendor, ...!Utils.isUndefined(this._stationInfo.chargeBoxSerialNumberPrefix) && { chargeBoxSerialNumber: this._stationInfo.chargeBoxSerialNumberPrefix }, ...!Utils.isUndefined(this._stationInfo.firmwareVersion) && { firmwareVersion: this._stationInfo.firmwareVersion }, }; - this._configuration = this._getConfiguration(); + this._configuration = this._getTemplateChargingStationConfiguration(); this._supervisionUrl = this._getSupervisionURL(); this._wsConnectionUrl = this._supervisionUrl + '/' + this._stationInfo.name; + this._connectionTimeout = this._getConnectionTimeout() * 1000; // Ms, zero for disabling + this._autoReconnectMaxRetries = this._getAutoReconnectMaxRetries(); // -1 for unlimited // Build connectors if needed const maxConnectors = this._getMaxNumberOfConnectors(); if (maxConnectors <= 0) { @@ -102,10 +118,13 @@ export default class ChargingStation { } const templateMaxConnectors = this._getTemplateMaxNumberOfConnectors(); if (templateMaxConnectors <= 0) { - logger.warn(`${this._logPrefix()} Charging station template ${this._stationTemplateFile} with no connector configurations`); + logger.warn(`${this._logPrefix()} Charging station template ${this._stationTemplateFile} with no connector configuration`); + } + if (!this._stationInfo.Connectors[0]) { + logger.warn(`${this._logPrefix()} Charging station template ${this._stationTemplateFile} with no connector Id 0 configuration`); } // Sanity check - if (maxConnectors > (this._stationInfo.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) && !Utils.convertToBoolean(this._stationInfo.randomConnectors)) { + if (maxConnectors > (this._stationInfo.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) && !this._stationInfo.randomConnectors) { logger.warn(`${this._logPrefix()} Number of connectors exceeds the number of connector configurations in template ${this._stationTemplateFile}, forcing random connector configurations affectation`); this._stationInfo.randomConnectors = true; } @@ -116,15 +135,15 @@ export default class ChargingStation { // Add connector Id 0 let lastConnector = '0'; for (lastConnector in this._stationInfo.Connectors) { - if (Utils.convertToInt(lastConnector) === 0 && Utils.convertToBoolean(this._stationInfo.useConnectorId0) && this._stationInfo.Connectors[lastConnector]) { - this._connectors[lastConnector] = Utils.cloneObject(this._stationInfo.Connectors[lastConnector]); + if (Utils.convertToInt(lastConnector) === 0 && this._getUseConnectorId0() && this._stationInfo.Connectors[lastConnector]) { + this._connectors[lastConnector] = Utils.cloneObject(this._stationInfo.Connectors[lastConnector]) as Connector; } } // Generate all connectors if ((this._stationInfo.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) > 0) { for (let index = 1; index <= maxConnectors; index++) { - const randConnectorID = Utils.convertToBoolean(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]) as Connector; } } } @@ -132,14 +151,14 @@ export default class ChargingStation { delete this._stationInfo.Connectors; // Initialize transaction attributes on connectors for (const connector in this._connectors) { - if (!this.getConnector(Utils.convertToInt(connector)).transactionStarted) { - this._initTransactionOnConnector(connector); + if (Utils.convertToInt(connector) > 0 && !this.getConnector(Utils.convertToInt(connector)).transactionStarted) { + this._initTransactionOnConnector(Utils.convertToInt(connector)); } } // OCPP parameters - this._addConfigurationKey('NumberOfConnectors', this._getNumberOfConnectors(), true); + this._addConfigurationKey('NumberOfConnectors', this._getNumberOfConnectors().toString(), true); if (!this._getConfigurationKey('MeterValuesSampledData')) { - this._addConfigurationKey('MeterValuesSampledData', 'Energy.Active.Import.Register'); + this._addConfigurationKey('MeterValuesSampledData', MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER); } this._stationInfo.powerDivider = this._getPowerDivider(); if (this.getEnableStatistics()) { @@ -147,13 +166,13 @@ export default class ChargingStation { this._statistics.objName = this._stationInfo.name; this._performanceObserver = new PerformanceObserver((list) => { const entry = list.getEntries()[0]; - this._statistics.logPerformance(entry, 'ChargingStation'); + this._statistics.logPerformance(entry, Constants.ENTITY_CHARGING_STATION); this._performanceObserver.disconnect(); }); } } - get connectors() { + get connectors(): Connectors { return this._connectors; } @@ -165,14 +184,18 @@ export default class ChargingStation { return Utils.logPrefix(` ${this._stationInfo.name}:`); } - _getConfiguration() { - return this._stationInfo.Configuration ? this._stationInfo.Configuration : {}; + _getTemplateChargingStationConfiguration(): ChargingStationConfiguration { + return this._stationInfo.Configuration ? this._stationInfo.Configuration : {} as ChargingStationConfiguration; } - _getAuthorizationFile() : string { + _getAuthorizationFile(): string { return this._stationInfo.authorizationFile && this._stationInfo.authorizationFile; } + _getUseConnectorId0(): boolean { + return !Utils.isUndefined(this._stationInfo.useConnectorId0) ? this._stationInfo.useConnectorId0 : true; + } + _loadAndGetAuthorizedTags(): string[] { let authorizedTags: string[] = []; const authorizationFile = this._getAuthorizationFile(); @@ -180,10 +203,10 @@ export default class ChargingStation { try { // Load authorization file const fileDescriptor = fs.openSync(authorizationFile, 'r'); - authorizedTags = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')); + authorizedTags = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as string[]; fs.closeSync(fileDescriptor); } catch (error) { - logger.error(this._logPrefix() + ' Authorization file ' + authorizationFile + ' loading error: ' + error); + logger.error(this._logPrefix() + ' Authorization file ' + authorizationFile + ' loading error: %j', error); throw error; } } else { @@ -202,14 +225,14 @@ export default class ChargingStation { } getEnableStatistics(): boolean { - return !Utils.isUndefined(this._stationInfo.enableStatistics) ? Utils.convertToBoolean(this._stationInfo.enableStatistics) : true; + return !Utils.isUndefined(this._stationInfo.enableStatistics) ? this._stationInfo.enableStatistics : true; } _getNumberOfPhases(): number { switch (this._getPowerOutType()) { - case 'AC': + case PowerOutType.AC: return !Utils.isUndefined(this._stationInfo.numberOfPhases) ? Utils.convertToInt(this._stationInfo.numberOfPhases) : 3; - case 'DC': + case PowerOutType.DC: return 0; } } @@ -217,13 +240,33 @@ export default class ChargingStation { _getNumberOfRunningTransactions(): number { let trxCount = 0; for (const connector in this._connectors) { - if (this.getConnector(Utils.convertToInt(connector)).transactionStarted) { + if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionStarted) { trxCount++; } } return trxCount; } + _getConnectionTimeout(): number { + if (!Utils.isUndefined(this._stationInfo.connectionTimeout)) { + return this._stationInfo.connectionTimeout; + } + if (!Utils.isUndefined(Configuration.getConnectionTimeout())) { + return Configuration.getConnectionTimeout(); + } + return 30; + } + + _getAutoReconnectMaxRetries(): number { + if (!Utils.isUndefined(this._stationInfo.autoReconnectMaxRetries)) { + return this._stationInfo.autoReconnectMaxRetries; + } + if (!Utils.isUndefined(Configuration.getAutoReconnectMaxRetries())) { + return Configuration.getAutoReconnectMaxRetries(); + } + return -1; + } + _getPowerDivider(): number { let powerDivider = this._getNumberOfConnectors(); if (this._stationInfo.powerSharedByConnectors) { @@ -232,7 +275,7 @@ export default class ChargingStation { return powerDivider; } - getConnector(id: number) { + getConnector(id: number): Connector { return this._connectors[id]; } @@ -243,10 +286,11 @@ export default class ChargingStation { _getMaxNumberOfConnectors(): number { let maxConnectors = 0; if (!Utils.isEmptyArray(this._stationInfo.numberOfConnectors)) { + const numberOfConnectors = this._stationInfo.numberOfConnectors as number[]; // Distribute evenly the number of connectors - maxConnectors = this._stationInfo.numberOfConnectors[(this._index - 1) % this._stationInfo.numberOfConnectors.length]; + maxConnectors = numberOfConnectors[(this._index - 1) % numberOfConnectors.length]; } else if (!Utils.isUndefined(this._stationInfo.numberOfConnectors)) { - maxConnectors = this._stationInfo.numberOfConnectors; + maxConnectors = this._stationInfo.numberOfConnectors as number; } else { maxConnectors = this._stationInfo.Connectors[0] ? this._getTemplateMaxNumberOfConnectors() - 1 : this._getTemplateMaxNumberOfConnectors(); } @@ -259,12 +303,12 @@ export default class ChargingStation { _getVoltageOut(): number { const errMsg = `${this._logPrefix()} Unknown ${this._getPowerOutType()} powerOutType in template file ${this._stationTemplateFile}, cannot define default voltage out`; - let defaultVoltageOut; + let defaultVoltageOut: number; switch (this._getPowerOutType()) { - case 'AC': + case PowerOutType.AC: defaultVoltageOut = 230; break; - case 'DC': + case PowerOutType.DC: defaultVoltageOut = 400; break; default: @@ -274,15 +318,31 @@ export default class ChargingStation { return !Utils.isUndefined(this._stationInfo.voltageOut) ? Utils.convertToInt(this._stationInfo.voltageOut) : defaultVoltageOut; } - _getPowerOutType(): string { - return !Utils.isUndefined(this._stationInfo.powerOutType) ? this._stationInfo.powerOutType : 'AC'; + _getTransactionIdTag(transactionId: number): string { + 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; + } + } + } + + _getTransactionMeterStop(transactionId: number): number { + 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; + } + } + } + + _getPowerOutType(): PowerOutType { + return !Utils.isUndefined(this._stationInfo.powerOutType) ? this._stationInfo.powerOutType : PowerOutType.AC; } _getSupervisionURL(): string { - const supervisionUrls = Utils.cloneObject(this._stationInfo.supervisionURL ? this._stationInfo.supervisionURL : Configuration.getSupervisionURLs()); + const supervisionUrls = Utils.cloneObject(this._stationInfo.supervisionURL ? this._stationInfo.supervisionURL : Configuration.getSupervisionURLs()) as string | string[]; let indexUrl = 0; if (!Utils.isEmptyArray(supervisionUrls)) { - if (Configuration.getDistributeStationToTenantEqually()) { + if (Configuration.getDistributeStationsToTenantsEqually()) { indexUrl = this._index % supervisionUrls.length; } else { // Get a random url @@ -290,7 +350,11 @@ export default class ChargingStation { } return supervisionUrls[indexUrl]; } - return supervisionUrls; + return supervisionUrls as string; + } + + _getReconnectExponentialDelay(): boolean { + return !Utils.isUndefined(this._stationInfo.reconnectExponentialDelay) ? this._stationInfo.reconnectExponentialDelay : false; } _getAuthorizeRemoteTxRequests(): boolean { @@ -303,23 +367,31 @@ export default class ChargingStation { return localAuthListEnabled ? Utils.convertToBoolean(localAuthListEnabled.value) : false; } - _startMessageSequence(): void { + async _startMessageSequence(): Promise { + // Start WebSocket ping + this._startWebSocketPing(); // Start heartbeat this._startHeartbeat(); // Initialize connectors status for (const connector in this._connectors) { - if (!this.getConnector(Utils.convertToInt(connector)).transactionStarted) { - if (this.getConnector(Utils.convertToInt(connector)).bootStatus) { - this.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).bootStatus); - } else { - this.sendStatusNotification(Utils.convertToInt(connector), 'Available'); - } + if (Utils.convertToInt(connector) === 0) { + continue; + } else if (!this._hasStopped && !this.getConnector(Utils.convertToInt(connector)).status && this.getConnector(Utils.convertToInt(connector)).bootStatus) { + // Send status in template at startup + await this.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).bootStatus); + } else if (this._hasStopped && this.getConnector(Utils.convertToInt(connector)).bootStatus) { + // Send status in template after reset + await this.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).bootStatus); + } else if (!this._hasStopped && this.getConnector(Utils.convertToInt(connector)).status) { + // Send previous status at template reload + await this.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).status); } else { - this.sendStatusNotification(Utils.convertToInt(connector), 'Charging'); + // Send default status + await this.sendStatusNotification(Utils.convertToInt(connector), ChargePointStatus.AVAILABLE); } } // Start the ATG - if (Utils.convertToBoolean(this._stationInfo.AutomaticTransactionGenerator.enable)) { + if (this._stationInfo.AutomaticTransactionGenerator.enable) { if (!this._automaticTransactionGeneration) { this._automaticTransactionGeneration = new AutomaticTransactionGenerator(this); } @@ -332,31 +404,65 @@ export default class ChargingStation { } } - async _stopMessageSequence(reason = ''): Promise { + async _stopMessageSequence(reason: StopTransactionReason = StopTransactionReason.NONE): Promise { + // Stop WebSocket ping + this._stopWebSocketPing(); // Stop heartbeat this._stopHeartbeat(); // Stop the ATG - if (Utils.convertToBoolean(this._stationInfo.AutomaticTransactionGenerator.enable) && + if (this._stationInfo.AutomaticTransactionGenerator.enable && this._automaticTransactionGeneration && !this._automaticTransactionGeneration.timeToStop) { await this._automaticTransactionGeneration.stop(reason); } else { for (const connector in this._connectors) { - if (this.getConnector(Utils.convertToInt(connector)).transactionStarted) { + if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionStarted) { await this.sendStopTransaction(this.getConnector(Utils.convertToInt(connector)).transactionId, reason); } } } } + _startWebSocketPing(): void { + const webSocketPingInterval: number = this._getConfigurationKey('WebSocketPingInterval') ? Utils.convertToInt(this._getConfigurationKey('WebSocketPingInterval').value) : 0; + if (webSocketPingInterval > 0 && !this._webSocketPingSetInterval) { + this._webSocketPingSetInterval = setInterval(() => { + if (this._wsConnection?.readyState === WebSocket.OPEN) { + this._wsConnection.ping((): void => { }); + } + }, webSocketPingInterval * 1000); + logger.info(this._logPrefix() + ' WebSocket ping started every ' + Utils.secondsToHHMMSS(webSocketPingInterval)); + } else if (this._webSocketPingSetInterval) { + logger.info(this._logPrefix() + ' WebSocket ping every ' + Utils.secondsToHHMMSS(webSocketPingInterval) + ' already started'); + } else { + logger.error(`${this._logPrefix()} WebSocket ping interval set to ${webSocketPingInterval ? Utils.secondsToHHMMSS(webSocketPingInterval) : webSocketPingInterval}, not starting the WebSocket ping`); + } + } + + _stopWebSocketPing(): void { + if (this._webSocketPingSetInterval) { + clearInterval(this._webSocketPingSetInterval); + this._webSocketPingSetInterval = null; + } + } + + _restartWebSocketPing(): void { + // Stop WebSocket ping + this._stopWebSocketPing(); + // Start WebSocket ping + this._startWebSocketPing(); + } + _startHeartbeat(): void { if (this._heartbeatInterval && this._heartbeatInterval > 0 && !this._heartbeatSetInterval) { - this._heartbeatSetInterval = setInterval(() => { - this.sendHeartbeat(); + this._heartbeatSetInterval = setInterval(async () => { + await this.sendHeartbeat(); }, this._heartbeatInterval); - logger.info(this._logPrefix() + ' Heartbeat started every ' + this._heartbeatInterval.toString() + 'ms'); + logger.info(this._logPrefix() + ' Heartbeat started every ' + Utils.milliSecondsToHHMMSS(this._heartbeatInterval)); + } else if (this._heartbeatSetInterval) { + logger.info(this._logPrefix() + ' Heartbeat every ' + Utils.milliSecondsToHHMMSS(this._heartbeatInterval) + ' already started'); } else { - logger.error(`${this._logPrefix()} Heartbeat interval set to ${this._heartbeatInterval}ms, not starting the heartbeat`); + logger.error(`${this._logPrefix()} Heartbeat interval set to ${this._heartbeatInterval ? Utils.milliSecondsToHHMMSS(this._heartbeatInterval) : this._heartbeatInterval}, not starting the heartbeat`); } } @@ -367,6 +473,13 @@ export default class ChargingStation { } } + _restartHeartbeat(): void { + // Stop heartbeat + this._stopHeartbeat(); + // Start heartbeat + this._startHeartbeat(); + } + _startAuthorizationFileMonitoring(): void { // eslint-disable-next-line @typescript-eslint/no-unused-vars fs.watchFile(this._getAuthorizationFile(), (current, previous) => { @@ -375,7 +488,7 @@ export default class ChargingStation { // Initialize _authorizedTags this._authorizedTags = this._loadAndGetAuthorizedTags(); } catch (error) { - logger.error(this._logPrefix() + ' Authorization file monitoring error: ' + error); + logger.error(this._logPrefix() + ' Authorization file monitoring error: %j', error); } }); } @@ -387,12 +500,13 @@ export default class ChargingStation { logger.debug(this._logPrefix() + ' Template file ' + this._stationTemplateFile + ' have changed, reload'); // Initialize this._initialize(); - if (!Utils.convertToBoolean(this._stationInfo.AutomaticTransactionGenerator.enable) && - this._automaticTransactionGeneration) { - this._automaticTransactionGeneration.stop().catch(() => {}); + if (!this._stationInfo.AutomaticTransactionGenerator.enable && + this._automaticTransactionGeneration) { + this._automaticTransactionGeneration.stop().catch(() => { }); } + // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed } catch (error) { - logger.error(this._logPrefix() + ' Charging station template file monitoring error: ' + error); + logger.error(this._logPrefix() + ' Charging station template file monitoring error: %j', error); } }); } @@ -406,7 +520,7 @@ export default class ChargingStation { return; } if (interval > 0) { - this.getConnector(connectorId).transactionSetInterval = setInterval(async (): Promise => { + this.getConnector(connectorId).transactionSetInterval = setInterval(async () => { if (this.getEnableStatistics()) { const sendMeterValues = performance.timerify(this.sendMeterValues); this._performanceObserver.observe({ @@ -418,16 +532,23 @@ export default class ChargingStation { } }, interval); } else { - logger.error(`${this._logPrefix()} Charging station MeterValueSampleInterval configuration set to ${interval}ms, not sending MeterValues`); + logger.error(`${this._logPrefix()} Charging station MeterValueSampleInterval configuration set to ${Utils.milliSecondsToHHMMSS(interval)}, not sending MeterValues`); } } - start(): void { - if (!this._wsConnectionUrl) { - this._wsConnectionUrl = this._supervisionUrl + '/' + this._stationInfo.name; + _openWSConnection(options?: WebSocket.ClientOptions): void { + if (Utils.isUndefined(options)) { + options = {} as WebSocket.ClientOptions; + } + if (Utils.isUndefined(options.handshakeTimeout)) { + options.handshakeTimeout = this._connectionTimeout; } - this._wsConnection = new WebSocket(this._wsConnectionUrl, 'ocpp' + Constants.OCPP_VERSION_16); + this._wsConnection = new WebSocket(this._wsConnectionUrl, 'ocpp' + Constants.OCPP_VERSION_16, options); logger.info(this._logPrefix() + ' Will communicate through URL ' + this._supervisionUrl); + } + + start(): void { + this._openWSConnection(); // Monitor authorization file this._startAuthorizationFileMonitoring(); // Monitor station template file @@ -442,99 +563,116 @@ export default class ChargingStation { this._wsConnection.on('open', this.onOpen.bind(this)); // Handle Socket ping this._wsConnection.on('ping', this.onPing.bind(this)); + // Handle Socket pong + this._wsConnection.on('pong', this.onPong.bind(this)); } - async stop(reason = ''): Promise { - // Stop - await this._stopMessageSequence(); - // eslint-disable-next-line guard-for-in + async stop(reason: StopTransactionReason = StopTransactionReason.NONE): Promise { + // Stop message sequence + await this._stopMessageSequence(reason); for (const connector in this._connectors) { - await this.sendStatusNotification(Utils.convertToInt(connector), 'Unavailable'); + if (Utils.convertToInt(connector) > 0) { + await this.sendStatusNotification(Utils.convertToInt(connector), ChargePointStatus.UNAVAILABLE); + } } - if (this._wsConnection && this._wsConnection.readyState === WebSocket.OPEN) { + if (this._wsConnection?.readyState === WebSocket.OPEN) { this._wsConnection.close(); } + this._bootNotificationResponse = null; + this._hasStopped = true; } - _reconnect(error): void { - logger.error(this._logPrefix() + ' Socket: abnormally closed', error); + async _reconnect(error): Promise { + logger.error(this._logPrefix() + ' Socket: abnormally closed: %j', error); + // Stop heartbeat + this._stopHeartbeat(); // Stop the ATG if needed - if (Utils.convertToBoolean(this._stationInfo.AutomaticTransactionGenerator.enable) && - Utils.convertToBoolean(this._stationInfo.AutomaticTransactionGenerator.stopOnConnectionFailure) && + if (this._stationInfo.AutomaticTransactionGenerator.enable && + this._stationInfo.AutomaticTransactionGenerator.stopOnConnectionFailure && this._automaticTransactionGeneration && !this._automaticTransactionGeneration.timeToStop) { - this._automaticTransactionGeneration.stop(); + this._automaticTransactionGeneration.stop().catch(() => { }); } - // Stop heartbeat - this._stopHeartbeat(); - if (this._autoReconnectTimeout !== 0 && - (this._autoReconnectRetryCount < this._autoReconnectMaxRetries || this._autoReconnectMaxRetries === -1)) { - logger.error(`${this._logPrefix()} Socket: connection retry with timeout ${this._autoReconnectTimeout}ms`); + if (this._autoReconnectRetryCount < this._autoReconnectMaxRetries || this._autoReconnectMaxRetries === -1) { this._autoReconnectRetryCount++; - setTimeout(() => { - logger.error(this._logPrefix() + ' Socket: reconnecting try #' + this._autoReconnectRetryCount); - this.start(); - }, this._autoReconnectTimeout); - } else if (this._autoReconnectTimeout !== 0 || this._autoReconnectMaxRetries !== -1) { - logger.error(`${this._logPrefix()} Socket: max retries reached (${this._autoReconnectRetryCount}) or retry disabled (${this._autoReconnectTimeout})`); + const reconnectDelay = (this._getReconnectExponentialDelay() ? Utils.exponentialDelay(this._autoReconnectRetryCount) : this._connectionTimeout); + logger.error(`${this._logPrefix()} Socket: connection retry in ${Utils.roundTo(reconnectDelay, 2)}ms, timeout ${reconnectDelay - 100}ms`); + await Utils.sleep(reconnectDelay); + logger.error(this._logPrefix() + ' Socket: reconnecting try #' + this._autoReconnectRetryCount.toString()); + this._openWSConnection({ handshakeTimeout: reconnectDelay - 100 }); + } else if (this._autoReconnectMaxRetries !== -1) { + logger.error(`${this._logPrefix()} Socket: max retries reached (${this._autoReconnectRetryCount}) or retry disabled (${this._autoReconnectMaxRetries})`); } } - onOpen() { + async onOpen(): Promise { logger.info(`${this._logPrefix()} Is connected to server through ${this._wsConnectionUrl}`); - if (!this._isSocketRestart) { + if (!this._hasSocketRestarted || this._hasStopped) { // Send BootNotification - this.sendBootNotification(); + this._bootNotificationResponse = await this.sendBootNotification(); + } + if (this._bootNotificationResponse.status === RegistrationStatus.ACCEPTED) { + await this._startMessageSequence(); + } else { + do { + await Utils.sleep(this._bootNotificationResponse.interval * 1000); + // Resend BootNotification + this._bootNotificationResponse = await this.sendBootNotification(); + } while (this._bootNotificationResponse.status !== RegistrationStatus.ACCEPTED); } - if (this._isSocketRestart) { - this._startMessageSequence(); + if (this._hasSocketRestarted && this._bootNotificationResponse.status === RegistrationStatus.ACCEPTED) { if (!Utils.isEmptyArray(this._messageQueue)) { - this._messageQueue.forEach((message) => { - if (this._wsConnection && this._wsConnection.readyState === WebSocket.OPEN) { + this._messageQueue.forEach((message, index) => { + if (this._wsConnection?.readyState === WebSocket.OPEN) { + this._messageQueue.splice(index, 1); this._wsConnection.send(message); } }); } } this._autoReconnectRetryCount = 0; - this._isSocketRestart = false; + this._hasSocketRestarted = false; } - onError(error) { - switch (error) { + async onError(errorEvent): Promise { + switch (errorEvent.code) { case 'ECONNREFUSED': - this._isSocketRestart = true; - this._reconnect(error); + this._hasSocketRestarted = true; + await this._reconnect(errorEvent); break; default: - logger.error(this._logPrefix() + ' Socket error: ' + error); + logger.error(this._logPrefix() + ' Socket error: %j', errorEvent); break; } } - onClose(error) { - switch (error) { + async onClose(closeEvent): Promise { + switch (closeEvent) { case 1000: // Normal close case 1005: - logger.info(this._logPrefix() + ' Socket normally closed ' + error); + logger.info(this._logPrefix() + ' Socket normally closed: %j', closeEvent); this._autoReconnectRetryCount = 0; break; default: // Abnormal close - this._isSocketRestart = true; - this._reconnect(error); + this._hasSocketRestarted = true; + await this._reconnect(closeEvent); break; } } - onPing() { + onPing(): void { logger.debug(this._logPrefix() + ' Has received a WS ping (rfc6455) from the server'); } - async onMessage(message) { + onPong(): void { + logger.debug(this._logPrefix() + ' Has received a WS pong (rfc6455) from the server'); + } + + async onMessage(messageEvent: MessageEvent): Promise { let [messageType, messageId, commandName, commandPayload, errorDetails] = [0, '', Constants.ENTITY_CHARGING_STATION, '', '']; try { // Parse the message - [messageType, messageId, commandName, commandPayload, errorDetails] = JSON.parse(message); + [messageType, messageId, commandName, commandPayload, errorDetails] = JSON.parse(messageEvent.toString()); // Check the Type of message switch (messageType) { @@ -588,73 +726,74 @@ export default class ChargingStation { } } catch (error) { // Log - logger.error('%s Incoming message %j processing error %s on request content type %s', this._logPrefix(), message, error, this._requests[messageId]); + logger.error('%s Incoming message %j processing error %s on request content type %s', this._logPrefix(), messageEvent, error, this._requests[messageId]); // Send error - await this.sendError(messageId, error, commandName); + messageType !== Constants.OCPP_JSON_CALL_ERROR_MESSAGE && await this.sendError(messageId, error, commandName); } } - async sendHeartbeat() { + async sendHeartbeat(): Promise { try { - const payload = { - currentTime: new Date().toISOString(), - }; + const payload: HeartbeatRequest = {}; await this.sendMessage(Utils.generateUUID(), payload, Constants.OCPP_JSON_CALL_MESSAGE, 'Heartbeat'); } catch (error) { - logger.error(this._logPrefix() + ' Send Heartbeat error: ' + error); + logger.error(this._logPrefix() + ' Send Heartbeat error: %j', error); throw error; } } - async sendBootNotification() { + async sendBootNotification(): Promise { try { - await this.sendMessage(Utils.generateUUID(), this._bootNotificationMessage, Constants.OCPP_JSON_CALL_MESSAGE, 'BootNotification'); + return await this.sendMessage(Utils.generateUUID(), this._bootNotificationRequest, Constants.OCPP_JSON_CALL_MESSAGE, 'BootNotification') as BootNotificationResponse; } catch (error) { - logger.error(this._logPrefix() + ' Send BootNotification error: ' + error); + logger.error(this._logPrefix() + ' Send BootNotification error: %j', error); throw error; } } - async sendStatusNotification(connectorId: number, status: string, errorCode = 'NoError') { + async sendStatusNotification(connectorId: number, status: ChargePointStatus, errorCode: ChargePointErrorCode = ChargePointErrorCode.NO_ERROR): Promise { + this.getConnector(connectorId).status = status; try { - const payload = { + const payload: StatusNotificationRequest = { connectorId, errorCode, status, }; await this.sendMessage(Utils.generateUUID(), payload, Constants.OCPP_JSON_CALL_MESSAGE, 'StatusNotification'); } catch (error) { - logger.error(this._logPrefix() + ' Send StatusNotification error: ' + error); + logger.error(this._logPrefix() + ' Send StatusNotification error: %j', error); throw error; } } - async sendStartTransaction(connectorId: number, idTag?: string): Promise { + async sendStartTransaction(connectorId: number, idTag?: string): Promise { try { - const payload = { + const payload: StartTransactionRequest = { connectorId, - ...!Utils.isUndefined(idTag) ? { idTag } : { idTag: '' }, + ...!Utils.isUndefined(idTag) ? { idTag } : { idTag: Constants.TRANSACTION_DEFAULT_IDTAG }, meterStart: 0, timestamp: new Date().toISOString(), }; - return await this.sendMessage(Utils.generateUUID(), payload, Constants.OCPP_JSON_CALL_MESSAGE, 'StartTransaction'); + return await this.sendMessage(Utils.generateUUID(), payload, Constants.OCPP_JSON_CALL_MESSAGE, 'StartTransaction') as StartTransactionResponse; } catch (error) { - logger.error(this._logPrefix() + ' Send StartTransaction error: ' + error); + logger.error(this._logPrefix() + ' Send StartTransaction error: %j', error); throw error; } } - async sendStopTransaction(transactionId: number, reason = ''): Promise { + async sendStopTransaction(transactionId: number, reason: StopTransactionReason = StopTransactionReason.NONE): Promise { + const idTag = this._getTransactionIdTag(transactionId); try { - const payload = { + const payload: StopTransactionRequest = { transactionId, - meterStop: 0, + ...!Utils.isUndefined(idTag) && { idTag: idTag }, + meterStop: this._getTransactionMeterStop(transactionId), timestamp: new Date().toISOString(), ...reason && { reason }, }; - await this.sendMessage(Utils.generateUUID(), payload, Constants.OCPP_JSON_CALL_MESSAGE, 'StopTransaction'); + return await this.sendMessage(Utils.generateUUID(), payload, Constants.OCPP_JSON_CALL_MESSAGE, 'StopTransaction') as StartTransactionResponse; } catch (error) { - logger.error(this._logPrefix() + ' Send StopTransaction error: ' + error); + logger.error(this._logPrefix() + ' Send StopTransaction error: %j', error); throw error; } } @@ -662,71 +801,70 @@ export default class ChargingStation { // eslint-disable-next-line consistent-this async sendMeterValues(connectorId: number, interval: number, self: ChargingStation, debug = false): Promise { try { - const sampledValues = { + const meterValue: MeterValue = { timestamp: new Date().toISOString(), sampledValue: [], }; - const meterValuesTemplate = self.getConnector(connectorId).MeterValues; + const meterValuesTemplate: SampledValue[] = self.getConnector(connectorId).MeterValues; for (let index = 0; index < meterValuesTemplate.length; index++) { const connector = self.getConnector(connectorId); // SoC measurand - if (meterValuesTemplate[index].measurand && meterValuesTemplate[index].measurand === 'SoC' && self._getConfigurationKey('MeterValuesSampledData').value.includes('SoC')) { - sampledValues.sampledValue.push({ - ...!Utils.isUndefined(meterValuesTemplate[index].unit) ? { unit: meterValuesTemplate[index].unit } : { unit: 'Percent' }, + if (meterValuesTemplate[index].measurand && meterValuesTemplate[index].measurand === MeterValueMeasurand.STATE_OF_CHARGE && self._getConfigurationKey('MeterValuesSampledData').value.includes(MeterValueMeasurand.STATE_OF_CHARGE)) { + meterValue.sampledValue.push({ + ...!Utils.isUndefined(meterValuesTemplate[index].unit) ? { unit: meterValuesTemplate[index].unit } : { unit: MeterValueUnit.PERCENT }, ...!Utils.isUndefined(meterValuesTemplate[index].context) && { context: meterValuesTemplate[index].context }, measurand: meterValuesTemplate[index].measurand, - ...!Utils.isUndefined(meterValuesTemplate[index].location) ? { location: meterValuesTemplate[index].location } : { location: 'EV' }, - ...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } : { value: Utils.getRandomInt(100) }, + ...!Utils.isUndefined(meterValuesTemplate[index].location) ? { location: meterValuesTemplate[index].location } : { location: MeterValueLocation.EV }, + ...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } : { value: Utils.getRandomInt(100).toString() }, }); - const sampledValuesIndex = sampledValues.sampledValue.length - 1; - if (sampledValues.sampledValue[sampledValuesIndex].value > 100 || debug) { - logger.error(`${self._logPrefix()} MeterValues measurand ${sampledValues.sampledValue[sampledValuesIndex].measurand ? sampledValues.sampledValue[sampledValuesIndex].measurand : 'Energy.Active.Import.Register'}: connectorId ${connectorId}, transaction ${connector.transactionId}, value: ${sampledValues.sampledValue[sampledValuesIndex].value}/100`); + const sampledValuesIndex = meterValue.sampledValue.length - 1; + if (Utils.convertToInt(meterValue.sampledValue[sampledValuesIndex].value) > 100 || debug) { + logger.error(`${self._logPrefix()} MeterValues measurand ${meterValue.sampledValue[sampledValuesIndex].measurand ? meterValue.sampledValue[sampledValuesIndex].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: connectorId ${connectorId}, transaction ${connector.transactionId}, value: ${meterValue.sampledValue[sampledValuesIndex].value}/100`); } // Voltage measurand - } else if (meterValuesTemplate[index].measurand && meterValuesTemplate[index].measurand === 'Voltage' && self._getConfigurationKey('MeterValuesSampledData').value.includes('Voltage')) { + } else if (meterValuesTemplate[index].measurand && meterValuesTemplate[index].measurand === MeterValueMeasurand.VOLTAGE && self._getConfigurationKey('MeterValuesSampledData').value.includes(MeterValueMeasurand.VOLTAGE)) { const voltageMeasurandValue = Utils.getRandomFloatRounded(self._getVoltageOut() + self._getVoltageOut() * 0.1, self._getVoltageOut() - self._getVoltageOut() * 0.1); - sampledValues.sampledValue.push({ - ...!Utils.isUndefined(meterValuesTemplate[index].unit) ? { unit: meterValuesTemplate[index].unit } : { unit: 'V' }, + meterValue.sampledValue.push({ + ...!Utils.isUndefined(meterValuesTemplate[index].unit) ? { unit: meterValuesTemplate[index].unit } : { unit: MeterValueUnit.VOLT }, ...!Utils.isUndefined(meterValuesTemplate[index].context) && { context: meterValuesTemplate[index].context }, measurand: meterValuesTemplate[index].measurand, ...!Utils.isUndefined(meterValuesTemplate[index].location) && { location: meterValuesTemplate[index].location }, - ...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } : { value: voltageMeasurandValue }, + ...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } : { value: voltageMeasurandValue.toString() }, }); for (let phase = 1; self._getNumberOfPhases() === 3 && phase <= self._getNumberOfPhases(); phase++) { - const voltageValue = sampledValues.sampledValue[sampledValues.sampledValue.length - 1].value; - let phaseValue; - if (voltageValue >= 0 && voltageValue <= 250) { + let phaseValue: string; + if (self._getVoltageOut() >= 0 && self._getVoltageOut() <= 250) { phaseValue = `L${phase}-N`; - } else if (voltageValue > 250) { + } else if (self._getVoltageOut() > 250) { phaseValue = `L${phase}-L${(phase + 1) % self._getNumberOfPhases() !== 0 ? (phase + 1) % self._getNumberOfPhases() : self._getNumberOfPhases()}`; } - sampledValues.sampledValue.push({ - ...!Utils.isUndefined(meterValuesTemplate[index].unit) ? { unit: meterValuesTemplate[index].unit } : { unit: 'V' }, + meterValue.sampledValue.push({ + ...!Utils.isUndefined(meterValuesTemplate[index].unit) ? { unit: meterValuesTemplate[index].unit } : { unit: MeterValueUnit.VOLT }, ...!Utils.isUndefined(meterValuesTemplate[index].context) && { context: meterValuesTemplate[index].context }, measurand: meterValuesTemplate[index].measurand, ...!Utils.isUndefined(meterValuesTemplate[index].location) && { location: meterValuesTemplate[index].location }, - ...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } : { value: voltageMeasurandValue }, - phase: phaseValue, + ...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } : { value: voltageMeasurandValue.toString() }, + phase: phaseValue as MeterValuePhase, }); } // Power.Active.Import measurand - } else if (meterValuesTemplate[index].measurand && meterValuesTemplate[index].measurand === 'Power.Active.Import' && self._getConfigurationKey('MeterValuesSampledData').value.includes('Power.Active.Import')) { + } else if (meterValuesTemplate[index].measurand && meterValuesTemplate[index].measurand === MeterValueMeasurand.POWER_ACTIVE_IMPORT && self._getConfigurationKey('MeterValuesSampledData').value.includes(MeterValueMeasurand.POWER_ACTIVE_IMPORT)) { // FIXME: factor out powerDivider checks if (Utils.isUndefined(self._stationInfo.powerDivider)) { - const errMsg = `${self._logPrefix()} MeterValues measurand ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : 'Energy.Active.Import.Register'}: powerDivider is undefined`; + const errMsg = `${self._logPrefix()} MeterValues measurand ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: powerDivider is undefined`; logger.error(errMsg); throw Error(errMsg); } else if (self._stationInfo.powerDivider && self._stationInfo.powerDivider <= 0) { - const errMsg = `${self._logPrefix()} MeterValues measurand ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : 'Energy.Active.Import.Register'}: powerDivider have zero or below value ${self._stationInfo.powerDivider}`; + const errMsg = `${self._logPrefix()} MeterValues measurand ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: powerDivider have zero or below value ${self._stationInfo.powerDivider}`; logger.error(errMsg); throw Error(errMsg); } - const errMsg = `${self._logPrefix()} MeterValues measurand ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : 'Energy.Active.Import.Register'}: Unknown ${self._getPowerOutType()} powerOutType in template file ${self._stationTemplateFile}, cannot calculate ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : 'Energy.Active.Import.Register'} measurand value`; - const powerMeasurandValues = {} as MeasurandValues ; + const errMsg = `${self._logPrefix()} MeterValues measurand ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: Unknown ${self._getPowerOutType()} powerOutType in template file ${self._stationTemplateFile}, cannot calculate ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER} measurand value`; + const powerMeasurandValues = {} as MeasurandValues; const maxPower = Math.round(self._stationInfo.maxPower / self._stationInfo.powerDivider); const maxPowerPerPhase = Math.round((self._stationInfo.maxPower / self._stationInfo.powerDivider) / self._getNumberOfPhases()); switch (self._getPowerOutType()) { - case 'AC': + case PowerOutType.AC: if (Utils.isUndefined(meterValuesTemplate[index].value)) { powerMeasurandValues.L1 = Utils.getRandomFloatRounded(maxPowerPerPhase); powerMeasurandValues.L2 = 0; @@ -735,57 +873,57 @@ export default class ChargingStation { powerMeasurandValues.L2 = Utils.getRandomFloatRounded(maxPowerPerPhase); powerMeasurandValues.L3 = Utils.getRandomFloatRounded(maxPowerPerPhase); } - powerMeasurandValues.all = Utils.roundTo(powerMeasurandValues.L1 + powerMeasurandValues.L2 + powerMeasurandValues.L3, 2); + powerMeasurandValues.allPhases = Utils.roundTo(powerMeasurandValues.L1 + powerMeasurandValues.L2 + powerMeasurandValues.L3, 2); } break; - case 'DC': + case PowerOutType.DC: if (Utils.isUndefined(meterValuesTemplate[index].value)) { - powerMeasurandValues.all = Utils.getRandomFloatRounded(maxPower); + powerMeasurandValues.allPhases = Utils.getRandomFloatRounded(maxPower); } break; default: logger.error(errMsg); throw Error(errMsg); } - sampledValues.sampledValue.push({ - ...!Utils.isUndefined(meterValuesTemplate[index].unit) ? { unit: meterValuesTemplate[index].unit } : { unit: 'W' }, + meterValue.sampledValue.push({ + ...!Utils.isUndefined(meterValuesTemplate[index].unit) ? { unit: meterValuesTemplate[index].unit } : { unit: MeterValueUnit.WATT }, ...!Utils.isUndefined(meterValuesTemplate[index].context) && { context: meterValuesTemplate[index].context }, measurand: meterValuesTemplate[index].measurand, ...!Utils.isUndefined(meterValuesTemplate[index].location) && { location: meterValuesTemplate[index].location }, - ...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } : { value: powerMeasurandValues.all }, + ...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } : { value: powerMeasurandValues.allPhases.toString() }, }); - const sampledValuesIndex = sampledValues.sampledValue.length - 1; - if (sampledValues.sampledValue[sampledValuesIndex].value > maxPower || debug) { - logger.error(`${self._logPrefix()} MeterValues measurand ${sampledValues.sampledValue[sampledValuesIndex].measurand ? sampledValues.sampledValue[sampledValuesIndex].measurand : 'Energy.Active.Import.Register'}: connectorId ${connectorId}, transaction ${connector.transactionId}, value: ${sampledValues.sampledValue[sampledValuesIndex].value}/${maxPower}`); + const sampledValuesIndex = meterValue.sampledValue.length - 1; + if (Utils.convertToFloat(meterValue.sampledValue[sampledValuesIndex].value) > maxPower || debug) { + logger.error(`${self._logPrefix()} MeterValues measurand ${meterValue.sampledValue[sampledValuesIndex].measurand ? meterValue.sampledValue[sampledValuesIndex].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: connectorId ${connectorId}, transaction ${connector.transactionId}, value: ${meterValue.sampledValue[sampledValuesIndex].value}/${maxPower}`); } for (let phase = 1; self._getNumberOfPhases() === 3 && phase <= self._getNumberOfPhases(); phase++) { const phaseValue = `L${phase}-N`; - sampledValues.sampledValue.push({ - ...!Utils.isUndefined(meterValuesTemplate[index].unit) ? { unit: meterValuesTemplate[index].unit } : { unit: 'W' }, + meterValue.sampledValue.push({ + ...!Utils.isUndefined(meterValuesTemplate[index].unit) ? { unit: meterValuesTemplate[index].unit } : { unit: MeterValueUnit.WATT }, ...!Utils.isUndefined(meterValuesTemplate[index].context) && { context: meterValuesTemplate[index].context }, ...!Utils.isUndefined(meterValuesTemplate[index].measurand) && { measurand: meterValuesTemplate[index].measurand }, ...!Utils.isUndefined(meterValuesTemplate[index].location) && { location: meterValuesTemplate[index].location }, - ...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } : { value: powerMeasurandValues[`L${phase}`] }, - phase: phaseValue, + ...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } : { value: powerMeasurandValues[`L${phase}`] as string }, + phase: phaseValue as MeterValuePhase, }); } // Current.Import measurand - } else if (meterValuesTemplate[index].measurand && meterValuesTemplate[index].measurand === 'Current.Import' && self._getConfigurationKey('MeterValuesSampledData').value.includes('Current.Import')) { + } else if (meterValuesTemplate[index].measurand && meterValuesTemplate[index].measurand === MeterValueMeasurand.CURRENT_IMPORT && self._getConfigurationKey('MeterValuesSampledData').value.includes(MeterValueMeasurand.CURRENT_IMPORT)) { // FIXME: factor out powerDivider checks if (Utils.isUndefined(self._stationInfo.powerDivider)) { - const errMsg = `${self._logPrefix()} MeterValues measurand ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : 'Energy.Active.Import.Register'}: powerDivider is undefined`; + const errMsg = `${self._logPrefix()} MeterValues measurand ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: powerDivider is undefined`; logger.error(errMsg); throw Error(errMsg); } else if (self._stationInfo.powerDivider && self._stationInfo.powerDivider <= 0) { - const errMsg = `${self._logPrefix()} MeterValues measurand ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : 'Energy.Active.Import.Register'}: powerDivider have zero or below value ${self._stationInfo.powerDivider}`; + const errMsg = `${self._logPrefix()} MeterValues measurand ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: powerDivider have zero or below value ${self._stationInfo.powerDivider}`; logger.error(errMsg); throw Error(errMsg); } - const errMsg = `${self._logPrefix()} MeterValues measurand ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : 'Energy.Active.Import.Register'}: Unknown ${self._getPowerOutType()} powerOutType in template file ${self._stationTemplateFile}, cannot calculate ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : 'Energy.Active.Import.Register'} measurand value`; - const currentMeasurandValues = {} as MeasurandValues; - let maxAmperage; + const errMsg = `${self._logPrefix()} MeterValues measurand ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: Unknown ${self._getPowerOutType()} powerOutType in template file ${self._stationTemplateFile}, cannot calculate ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER} measurand value`; + const currentMeasurandValues: MeasurandValues = {} as MeasurandValues; + let maxAmperage: number; switch (self._getPowerOutType()) { - case 'AC': + case PowerOutType.AC: maxAmperage = ElectricUtils.ampPerPhaseFromPower(self._getNumberOfPhases(), self._stationInfo.maxPower / self._stationInfo.powerDivider, self._getVoltageOut()); if (Utils.isUndefined(meterValuesTemplate[index].value)) { currentMeasurandValues.L1 = Utils.getRandomFloatRounded(maxAmperage); @@ -795,50 +933,50 @@ export default class ChargingStation { currentMeasurandValues.L2 = Utils.getRandomFloatRounded(maxAmperage); currentMeasurandValues.L3 = Utils.getRandomFloatRounded(maxAmperage); } - currentMeasurandValues.all = Utils.roundTo((currentMeasurandValues.L1 + currentMeasurandValues.L2 + currentMeasurandValues.L3) / self._getNumberOfPhases(), 2); + currentMeasurandValues.allPhases = Utils.roundTo((currentMeasurandValues.L1 + currentMeasurandValues.L2 + currentMeasurandValues.L3) / self._getNumberOfPhases(), 2); } break; - case 'DC': + case PowerOutType.DC: maxAmperage = ElectricUtils.ampTotalFromPower(self._stationInfo.maxPower / self._stationInfo.powerDivider, self._getVoltageOut()); if (Utils.isUndefined(meterValuesTemplate[index].value)) { - currentMeasurandValues.all = Utils.getRandomFloatRounded(maxAmperage); + currentMeasurandValues.allPhases = Utils.getRandomFloatRounded(maxAmperage); } break; default: logger.error(errMsg); throw Error(errMsg); } - sampledValues.sampledValue.push({ - ...!Utils.isUndefined(meterValuesTemplate[index].unit) ? { unit: meterValuesTemplate[index].unit } : { unit: 'A' }, + meterValue.sampledValue.push({ + ...!Utils.isUndefined(meterValuesTemplate[index].unit) ? { unit: meterValuesTemplate[index].unit } : { unit: MeterValueUnit.AMP }, ...!Utils.isUndefined(meterValuesTemplate[index].context) && { context: meterValuesTemplate[index].context }, measurand: meterValuesTemplate[index].measurand, ...!Utils.isUndefined(meterValuesTemplate[index].location) && { location: meterValuesTemplate[index].location }, - ...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } : { value: currentMeasurandValues.all }, + ...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } : { value: currentMeasurandValues.allPhases.toString() }, }); - const sampledValuesIndex = sampledValues.sampledValue.length - 1; - if (sampledValues.sampledValue[sampledValuesIndex].value > maxAmperage || debug) { - logger.error(`${self._logPrefix()} MeterValues measurand ${sampledValues.sampledValue[sampledValuesIndex].measurand ? sampledValues.sampledValue[sampledValuesIndex].measurand : 'Energy.Active.Import.Register'}: connectorId ${connectorId}, transaction ${connector.transactionId}, value: ${sampledValues.sampledValue[sampledValuesIndex].value}/${maxAmperage}`); + const sampledValuesIndex = meterValue.sampledValue.length - 1; + if (Utils.convertToFloat(meterValue.sampledValue[sampledValuesIndex].value) > maxAmperage || debug) { + logger.error(`${self._logPrefix()} MeterValues measurand ${meterValue.sampledValue[sampledValuesIndex].measurand ? meterValue.sampledValue[sampledValuesIndex].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: connectorId ${connectorId}, transaction ${connector.transactionId}, value: ${meterValue.sampledValue[sampledValuesIndex].value}/${maxAmperage}`); } for (let phase = 1; self._getNumberOfPhases() === 3 && phase <= self._getNumberOfPhases(); phase++) { const phaseValue = `L${phase}`; - sampledValues.sampledValue.push({ - ...!Utils.isUndefined(meterValuesTemplate[index].unit) ? { unit: meterValuesTemplate[index].unit } : { unit: 'A' }, + meterValue.sampledValue.push({ + ...!Utils.isUndefined(meterValuesTemplate[index].unit) ? { unit: meterValuesTemplate[index].unit } : { unit: MeterValueUnit.AMP }, ...!Utils.isUndefined(meterValuesTemplate[index].context) && { context: meterValuesTemplate[index].context }, ...!Utils.isUndefined(meterValuesTemplate[index].measurand) && { measurand: meterValuesTemplate[index].measurand }, ...!Utils.isUndefined(meterValuesTemplate[index].location) && { location: meterValuesTemplate[index].location }, - ...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } : { value: currentMeasurandValues[phaseValue] }, - phase: phaseValue, + ...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } : { value: currentMeasurandValues[phaseValue] as string }, + phase: phaseValue as MeterValuePhase, }); } // Energy.Active.Import.Register measurand (default) - } else if (!meterValuesTemplate[index].measurand || meterValuesTemplate[index].measurand === 'Energy.Active.Import.Register') { + } else if (!meterValuesTemplate[index].measurand || meterValuesTemplate[index].measurand === MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER) { // FIXME: factor out powerDivider checks if (Utils.isUndefined(self._stationInfo.powerDivider)) { - const errMsg = `${self._logPrefix()} MeterValues measurand ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : 'Energy.Active.Import.Register'}: powerDivider is undefined`; + const errMsg = `${self._logPrefix()} MeterValues measurand ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: powerDivider is undefined`; logger.error(errMsg); throw Error(errMsg); } else if (self._stationInfo.powerDivider && self._stationInfo.powerDivider <= 0) { - const errMsg = `${self._logPrefix()} MeterValues measurand ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : 'Energy.Active.Import.Register'}: powerDivider have zero or below value ${self._stationInfo.powerDivider}`; + const errMsg = `${self._logPrefix()} MeterValues measurand ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: powerDivider have zero or below value ${self._stationInfo.powerDivider}`; logger.error(errMsg); throw Error(errMsg); } @@ -851,48 +989,48 @@ export default class ChargingStation { connector.lastEnergyActiveImportRegisterValue = 0; } } - sampledValues.sampledValue.push({ - ...!Utils.isUndefined(meterValuesTemplate[index].unit) ? { unit: meterValuesTemplate[index].unit } : { unit: 'Wh' }, + meterValue.sampledValue.push({ + ...!Utils.isUndefined(meterValuesTemplate[index].unit) ? { unit: meterValuesTemplate[index].unit } : { unit: MeterValueUnit.WATT_HOUR }, ...!Utils.isUndefined(meterValuesTemplate[index].context) && { context: meterValuesTemplate[index].context }, ...!Utils.isUndefined(meterValuesTemplate[index].measurand) && { measurand: meterValuesTemplate[index].measurand }, ...!Utils.isUndefined(meterValuesTemplate[index].location) && { location: meterValuesTemplate[index].location }, - ...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } : { value: connector.lastEnergyActiveImportRegisterValue }, + ...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } : + { value: connector.lastEnergyActiveImportRegisterValue.toString() }, }); - const sampledValuesIndex = sampledValues.sampledValue.length - 1; + const sampledValuesIndex = meterValue.sampledValue.length - 1; const maxConsumption = Math.round(self._stationInfo.maxPower * 3600 / (self._stationInfo.powerDivider * interval)); - if (sampledValues.sampledValue[sampledValuesIndex].value > maxConsumption || debug) { - logger.error(`${self._logPrefix()} MeterValues measurand ${sampledValues.sampledValue[sampledValuesIndex].measurand ? sampledValues.sampledValue[sampledValuesIndex].measurand : 'Energy.Active.Import.Register'}: connectorId ${connectorId}, transaction ${connector.transactionId}, value: ${sampledValues.sampledValue[sampledValuesIndex].value}/${maxConsumption}`); + if (Utils.convertToFloat(meterValue.sampledValue[sampledValuesIndex].value) > maxConsumption || debug) { + logger.error(`${self._logPrefix()} MeterValues measurand ${meterValue.sampledValue[sampledValuesIndex].measurand ? meterValue.sampledValue[sampledValuesIndex].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: connectorId ${connectorId}, transaction ${connector.transactionId}, value: ${meterValue.sampledValue[sampledValuesIndex].value}/${maxConsumption}`); } // Unsupported measurand } else { - logger.info(`${self._logPrefix()} Unsupported MeterValues measurand ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : 'Energy.Active.Import.Register'} on connectorId ${connectorId}`); + logger.info(`${self._logPrefix()} Unsupported MeterValues measurand ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER} on connectorId ${connectorId}`); } } - - const payload = { + const payload: MeterValuesRequest = { connectorId, transactionId: self.getConnector(connectorId).transactionId, - meterValue: sampledValues, + meterValue: meterValue, }; await self.sendMessage(Utils.generateUUID(), payload, Constants.OCPP_JSON_CALL_MESSAGE, 'MeterValues'); } catch (error) { - logger.error(self._logPrefix() + ' Send MeterValues error: ' + error); + logger.error(self._logPrefix() + ' Send MeterValues error: %j', error); throw error; } } - async sendError(messageId, err: Error|OCPPError, commandName) { + async sendError(messageId: string, err: Error | OCPPError, commandName: string): Promise { // Check exception type: only OCPP error are accepted const error = err instanceof OCPPError ? err : new OCPPError(Constants.OCPP_ERROR_INTERNAL_ERROR, err.message, err.stack && err.stack); // Send error return this.sendMessage(messageId, error, Constants.OCPP_JSON_CALL_ERROR_MESSAGE, commandName); } - async sendMessage(messageId, commandParams, messageType = Constants.OCPP_JSON_CALL_RESULT_MESSAGE, commandName: string) { + async sendMessage(messageId: string, commandParams, messageType = Constants.OCPP_JSON_CALL_RESULT_MESSAGE, commandName: string): Promise { // eslint-disable-next-line @typescript-eslint/no-this-alias const self = this; // Send a message through wsConnection - return new Promise((resolve, reject) => { + return new Promise((resolve: (value?: any | PromiseLike) => void, reject: (reason?: any) => void) => { let messageToSend; // Type of message switch (messageType) { @@ -914,7 +1052,7 @@ export default class ChargingStation { break; } // Check if wsConnection is ready - if (this._wsConnection && this._wsConnection.readyState === WebSocket.OPEN) { + if (this._wsConnection?.readyState === WebSocket.OPEN) { if (this.getEnableStatistics()) { this._statistics.addMessage(commandName, messageType); } @@ -935,7 +1073,7 @@ export default class ChargingStation { this._messageQueue.push(messageToSend); } // Reject it - return rejectCallback(new OCPPError(commandParams.code ? commandParams.code : Constants.OCPP_ERROR_GENERIC_ERROR, commandParams.message ? commandParams.message : `Web socket closed for message id '${messageId}' with content '${messageToSend}', message buffered`, commandParams.details ? commandParams.details : {})); + return rejectCallback(new OCPPError(commandParams.code ? commandParams.code : Constants.OCPP_ERROR_GENERIC_ERROR, commandParams.message ? commandParams.message : `WebSocket closed for message id '${messageId}' with content '${messageToSend}', message buffered`, commandParams.details ? commandParams.details : {})); } // Response? if (messageType === Constants.OCPP_JSON_CALL_RESULT_MESSAGE) { @@ -961,17 +1099,17 @@ export default class ChargingStation { if (self.getEnableStatistics()) { self._statistics.addMessage(commandName, messageType); } - logger.debug(`${self._logPrefix()} Error %j occurred when calling command %s with parameters %j`, error, commandName, commandParams); + logger.debug(`${self._logPrefix()} Error: %j occurred when calling command %s with parameters: %j`, error, commandName, commandParams); // Build Exception // eslint-disable-next-line no-empty-function - self._requests[messageId] = [() => { }, () => { }, '']; // Properly format the request + self._requests[messageId] = [() => { }, () => { }, {}]; // Properly format the request // Send error reject(error); } }); } - handleResponse(commandName: string, payload, requestPayload) { + handleResponse(commandName: string, payload, requestPayload): void { const responseCallbackFn = 'handleResponse' + commandName; if (typeof this[responseCallbackFn] === 'function') { this[responseCallbackFn](payload, requestPayload); @@ -980,107 +1118,109 @@ export default class ChargingStation { } } - handleResponseBootNotification(payload, requestPayload) { - if (payload.status === 'Accepted') { - this._heartbeatInterval = payload.interval * 1000; - this._addConfigurationKey('HeartBeatInterval', Utils.convertToInt(payload.interval)); - this._addConfigurationKey('HeartbeatInterval', Utils.convertToInt(payload.interval), false, false); - this._startMessageSequence(); - } else if (payload.status === 'Pending') { + handleResponseBootNotification(payload: BootNotificationResponse, requestPayload: BootNotificationRequest): void { + if (payload.status === RegistrationStatus.ACCEPTED) { + this._heartbeatInterval = Utils.convertToInt(payload.interval) * 1000; + this._heartbeatSetInterval ? this._restartHeartbeat() : this._startHeartbeat(); + this._addConfigurationKey('HeartBeatInterval', payload.interval.toString()); + this._addConfigurationKey('HeartbeatInterval', payload.interval.toString(), false, false); + this._hasStopped && (this._hasStopped = false); + } else if (payload.status === RegistrationStatus.PENDING) { logger.info(this._logPrefix() + ' Charging station in pending state on the central server'); } else { logger.info(this._logPrefix() + ' Charging station rejected by the central server'); } } - _initTransactionOnConnector(connectorId) { + _initTransactionOnConnector(connectorId: number): void { this.getConnector(connectorId).transactionStarted = false; this.getConnector(connectorId).transactionId = null; this.getConnector(connectorId).idTag = null; this.getConnector(connectorId).lastEnergyActiveImportRegisterValue = -1; } - _resetTransactionOnConnector(connectorId) { + _resetTransactionOnConnector(connectorId: number): void { this._initTransactionOnConnector(connectorId); if (this.getConnector(connectorId).transactionSetInterval) { clearInterval(this.getConnector(connectorId).transactionSetInterval); } } - handleResponseStartTransaction(payload, requestPayload) { - if (this.getConnector(requestPayload.connectorId).transactionStarted) { - logger.debug(this._logPrefix() + ' Try to start a transaction on an already used connector ' + requestPayload.connectorId + ': %s', this.getConnector(requestPayload.connectorId)); + handleResponseStartTransaction(payload: StartTransactionResponse, requestPayload: StartTransactionRequest): void { + const connectorId = Utils.convertToInt(requestPayload.connectorId); + if (this.getConnector(connectorId).transactionStarted) { + logger.debug(this._logPrefix() + ' Trying to start a transaction on an already used connector ' + connectorId.toString() + ': %j', this.getConnector(connectorId)); return; } - let transactionConnectorId; + let transactionConnectorId: number; for (const connector in this._connectors) { - if (Utils.convertToInt(connector) === Utils.convertToInt(requestPayload.connectorId)) { - transactionConnectorId = connector; + if (Utils.convertToInt(connector) > 0 && Utils.convertToInt(connector) === connectorId) { + transactionConnectorId = Utils.convertToInt(connector); break; } } if (!transactionConnectorId) { - logger.error(this._logPrefix() + ' Try to start a transaction on a non existing connector Id ' + requestPayload.connectorId); + logger.error(this._logPrefix() + ' Trying to start a transaction on a non existing connector Id ' + connectorId.toString()); return; } - if (payload.idTagInfo && payload.idTagInfo.status === 'Accepted') { - this.getConnector(requestPayload.connectorId).transactionStarted = true; - this.getConnector(requestPayload.connectorId).transactionId = payload.transactionId; - this.getConnector(requestPayload.connectorId).idTag = requestPayload.idTag; - this.getConnector(requestPayload.connectorId).lastEnergyActiveImportRegisterValue = 0; - this.sendStatusNotification(requestPayload.connectorId, 'Charging'); - logger.info(this._logPrefix() + ' Transaction ' + payload.transactionId + ' STARTED on ' + this._stationInfo.name + '#' + requestPayload.connectorId + ' for idTag ' + requestPayload.idTag); + if (payload.idTagInfo?.status === AuthorizationStatus.ACCEPTED) { + this.getConnector(connectorId).transactionStarted = true; + this.getConnector(connectorId).transactionId = payload.transactionId; + this.getConnector(connectorId).idTag = requestPayload.idTag; + this.getConnector(connectorId).lastEnergyActiveImportRegisterValue = 0; + this.sendStatusNotification(connectorId, ChargePointStatus.CHARGING).catch(() => { }); + logger.info(this._logPrefix() + ' Transaction ' + payload.transactionId.toString() + ' STARTED on ' + this._stationInfo.name + '#' + connectorId.toString() + ' for idTag ' + requestPayload.idTag); if (this._stationInfo.powerSharedByConnectors) { this._stationInfo.powerDivider++; } const configuredMeterValueSampleInterval = this._getConfigurationKey('MeterValueSampleInterval'); - this._startMeterValues(requestPayload.connectorId, - configuredMeterValueSampleInterval ? configuredMeterValueSampleInterval.value * 1000 : 60000); + this._startMeterValues(connectorId, + configuredMeterValueSampleInterval ? Utils.convertToInt(configuredMeterValueSampleInterval.value) * 1000 : 60000); } else { - logger.error(this._logPrefix() + ' Starting transaction id ' + payload.transactionId + ' REJECTED with status ' + payload.idTagInfo.status + ', idTag ' + requestPayload.idTag); - this._resetTransactionOnConnector(requestPayload.connectorId); - this.sendStatusNotification(requestPayload.connectorId, 'Available'); + logger.error(this._logPrefix() + ' Starting transaction id ' + payload.transactionId.toString() + ' REJECTED with status ' + payload.idTagInfo.status + ', idTag ' + requestPayload.idTag); + this._resetTransactionOnConnector(connectorId); + this.sendStatusNotification(connectorId, ChargePointStatus.AVAILABLE).catch(() => { }); } } - handleResponseStopTransaction(payload, requestPayload) { - let transactionConnectorId; + handleResponseStopTransaction(payload: StopTransactionResponse, requestPayload: StopTransactionRequest): void { + let transactionConnectorId: number; for (const connector in this._connectors) { - if (this.getConnector(Utils.convertToInt(connector)).transactionId === requestPayload.transactionId) { - transactionConnectorId = connector; + if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === Utils.convertToInt(requestPayload.transactionId)) { + transactionConnectorId = Utils.convertToInt(connector); break; } } if (!transactionConnectorId) { - logger.error(this._logPrefix() + ' Try to stop a non existing transaction ' + requestPayload.transactionId); + logger.error(this._logPrefix() + ' Trying to stop a non existing transaction ' + requestPayload.transactionId.toString()); return; } - if (payload.idTagInfo && payload.idTagInfo.status === 'Accepted') { - this.sendStatusNotification(transactionConnectorId, 'Available'); + if (payload.idTagInfo?.status === AuthorizationStatus.ACCEPTED) { + this.sendStatusNotification(transactionConnectorId, ChargePointStatus.AVAILABLE).catch(() => { }); if (this._stationInfo.powerSharedByConnectors) { this._stationInfo.powerDivider--; } - logger.info(this._logPrefix() + ' Transaction ' + requestPayload.transactionId + ' STOPPED on ' + this._stationInfo.name + '#' + transactionConnectorId); + logger.info(this._logPrefix() + ' Transaction ' + requestPayload.transactionId.toString() + ' STOPPED on ' + this._stationInfo.name + '#' + transactionConnectorId.toString()); this._resetTransactionOnConnector(transactionConnectorId); } else { - logger.error(this._logPrefix() + ' Stopping transaction id ' + requestPayload.transactionId + ' REJECTED with status ' + payload.idTagInfo.status); + logger.error(this._logPrefix() + ' Stopping transaction id ' + requestPayload.transactionId.toString() + ' REJECTED with status ' + payload.idTagInfo?.status); } } - handleResponseStatusNotification(payload, requestPayload) { + handleResponseStatusNotification(payload: StatusNotificationRequest, requestPayload: StatusNotificationResponse): void { logger.debug(this._logPrefix() + ' Status notification response received: %j to StatusNotification request: %j', payload, requestPayload); } - handleResponseMeterValues(payload, requestPayload) { + handleResponseMeterValues(payload: MeterValuesRequest, requestPayload: MeterValuesResponse): void { logger.debug(this._logPrefix() + ' MeterValues response received: %j to MeterValues request: %j', payload, requestPayload); } - handleResponseHeartbeat(payload, requestPayload) { + handleResponseHeartbeat(payload: HeartbeatResponse, requestPayload: HeartbeatRequest): void { logger.debug(this._logPrefix() + ' Heartbeat response received: %j to Heartbeat request: %j', payload, requestPayload); } - async handleRequest(messageId, commandName, commandPayload) { + async handleRequest(messageId: string, commandName: string, commandPayload): Promise { let response; // Call if (typeof this['handleRequest' + commandName] === 'function') { @@ -1089,7 +1229,7 @@ export default class ChargingStation { response = await this['handleRequest' + commandName](commandPayload); } catch (error) { // Log - logger.error(this._logPrefix() + ' Handle request error: ' + error); + logger.error(this._logPrefix() + ' Handle request error: %j', error); // Send back response to inform backend await this.sendError(messageId, error, commandName); throw error; @@ -1104,21 +1244,42 @@ export default class ChargingStation { } // Simulate charging station restart - async handleRequestReset(commandPayload) { + handleRequestReset(commandPayload: ResetRequest): DefaultResponse { setImmediate(async () => { - await this.stop(commandPayload.type + 'Reset'); + await this.stop(commandPayload.type + 'Reset' as StopTransactionReason); await Utils.sleep(this._stationInfo.resetTime); await this.start(); }); - logger.info(`${this._logPrefix()} ${commandPayload.type} reset command received, simulating it. The station will be back online in ${this._stationInfo.resetTime}ms`); + logger.info(`${this._logPrefix()} ${commandPayload.type} reset command received, simulating it. The station will be back online in ${Utils.milliSecondsToHHMMSS(this._stationInfo.resetTime)}`); return Constants.OCPP_RESPONSE_ACCEPTED; } - _getConfigurationKey(key) { + handleRequestClearCache(): DefaultResponse { + return Constants.OCPP_RESPONSE_ACCEPTED; + } + + async handleRequestUnlockConnector(commandPayload: UnlockConnectorRequest): Promise { + const connectorId = Utils.convertToInt(commandPayload.connectorId); + if (connectorId === 0) { + logger.error(this._logPrefix() + ' Trying to unlock connector ' + connectorId.toString()); + return Constants.OCPP_RESPONSE_UNLOCK_NOT_SUPPORTED; + } + if (this.getConnector(connectorId).transactionStarted) { + const stopResponse = await this.sendStopTransaction(this.getConnector(connectorId).transactionId, StopTransactionReason.UNLOCK_COMMAND); + if (stopResponse.idTagInfo?.status === AuthorizationStatus.ACCEPTED) { + return Constants.OCPP_RESPONSE_UNLOCKED; + } + return Constants.OCPP_RESPONSE_UNLOCK_FAILED; + } + await this.sendStatusNotification(connectorId, ChargePointStatus.AVAILABLE); + return Constants.OCPP_RESPONSE_UNLOCKED; + } + + _getConfigurationKey(key: string): ConfigurationKey { return this._configuration.configurationKey.find((configElement) => configElement.key === key); } - _addConfigurationKey(key, value, readonly = false, visible = true, reboot = false) { + _addConfigurationKey(key: string, value: string, readonly = false, visible = true, reboot = false): void { const keyFound = this._getConfigurationKey(key); if (!keyFound) { this._configuration.configurationKey.push({ @@ -1131,7 +1292,7 @@ export default class ChargingStation { } } - _setConfigurationKeyValue(key, value) { + _setConfigurationKeyValue(key: string, value: string): void { const keyFound = this._getConfigurationKey(key); if (keyFound) { const keyIndex = this._configuration.configurationKey.indexOf(keyFound); @@ -1139,15 +1300,13 @@ export default class ChargingStation { } } - async handleRequestGetConfiguration(commandPayload) { - const configurationKey = []; - const unknownKey = []; + handleRequestGetConfiguration(commandPayload: GetConfigurationRequest): GetConfigurationResponse { + const configurationKey: ConfigurationKey[] = []; + const unknownKey: string[] = []; if (Utils.isEmptyArray(commandPayload.key)) { for (const configuration of this._configuration.configurationKey) { if (Utils.isUndefined(configuration.visible)) { configuration.visible = true; - } else { - configuration.visible = Utils.convertToBoolean(configuration.visible); } if (!configuration.visible) { continue; @@ -1159,13 +1318,11 @@ export default class ChargingStation { }); } } else { - for (const configurationKey of commandPayload.key) { - const keyFound = this._getConfigurationKey(configurationKey); + for (const key of commandPayload.key) { + const keyFound = this._getConfigurationKey(key); if (keyFound) { if (Utils.isUndefined(keyFound.visible)) { keyFound.visible = true; - } else { - keyFound.visible = Utils.convertToBoolean(configurationKey.visible); } if (!keyFound.visible) { continue; @@ -1176,7 +1333,7 @@ export default class ChargingStation { value: keyFound.value, }); } else { - unknownKey.push(configurationKey); + unknownKey.push(key); } } } @@ -1186,65 +1343,89 @@ export default class ChargingStation { }; } - async handleRequestChangeConfiguration(commandPayload) { + handleRequestChangeConfiguration(commandPayload: ChangeConfigurationRequest): ChangeConfigurationResponse { const keyToChange = this._getConfigurationKey(commandPayload.key); if (!keyToChange) { - return { status: Constants.OCPP_ERROR_NOT_SUPPORTED }; - } else if (keyToChange && Utils.convertToBoolean(keyToChange.readonly)) { - return Constants.OCPP_RESPONSE_REJECTED; - } else if (keyToChange && !Utils.convertToBoolean(keyToChange.readonly)) { + return Constants.OCPP_CONFIGURATION_RESPONSE_NOT_SUPPORTED; + } else if (keyToChange && keyToChange.readonly) { + return Constants.OCPP_CONFIGURATION_RESPONSE_REJECTED; + } else if (keyToChange && !keyToChange.readonly) { const keyIndex = this._configuration.configurationKey.indexOf(keyToChange); - this._configuration.configurationKey[keyIndex].value = commandPayload.value; + let valueChanged = false; + if (this._configuration.configurationKey[keyIndex].value !== commandPayload.value) { + this._configuration.configurationKey[keyIndex].value = commandPayload.value; + valueChanged = true; + } let triggerHeartbeatRestart = false; - if (keyToChange.key === 'HeartBeatInterval') { + if (keyToChange.key === 'HeartBeatInterval' && valueChanged) { this._setConfigurationKeyValue('HeartbeatInterval', commandPayload.value); triggerHeartbeatRestart = true; } - if (keyToChange.key === 'HeartbeatInterval') { + if (keyToChange.key === 'HeartbeatInterval' && valueChanged) { this._setConfigurationKeyValue('HeartBeatInterval', commandPayload.value); triggerHeartbeatRestart = true; } if (triggerHeartbeatRestart) { this._heartbeatInterval = Utils.convertToInt(commandPayload.value) * 1000; - // Stop heartbeat - this._stopHeartbeat(); - // Start heartbeat - this._startHeartbeat(); + this._restartHeartbeat(); + } + if (keyToChange.key === 'WebSocketPingInterval' && valueChanged) { + this._restartWebSocketPing(); } - if (Utils.convertToBoolean(keyToChange.reboot)) { - return Constants.OCPP_RESPONSE_REBOOT_REQUIRED; + if (keyToChange.reboot) { + return Constants.OCPP_CONFIGURATION_RESPONSE_REBOOT_REQUIRED; } - return Constants.OCPP_RESPONSE_ACCEPTED; + return Constants.OCPP_CONFIGURATION_RESPONSE_ACCEPTED; } } - async handleRequestRemoteStartTransaction(commandPayload) { - const transactionConnectorID = commandPayload.connectorId ? commandPayload.connectorId : '1'; + handleRequestSetChargingProfile(commandPayload: SetChargingProfileRequest): SetChargingProfileResponse { + if (!this.getConnector(commandPayload.connectorId)) { + logger.error(`${this._logPrefix()} Trying to set a charging profile to a non existing connector Id ${commandPayload.connectorId}`); + return Constants.OCPP_CHARGING_PROFILE_RESPONSE_REJECTED; + } + if (commandPayload.csChargingProfiles.chargingProfilePurpose === ChargingProfilePurposeType.TX_PROFILE && !this.getConnector(commandPayload.connectorId)?.transactionStarted) { + return Constants.OCPP_CHARGING_PROFILE_RESPONSE_REJECTED; + } + this.getConnector(commandPayload.connectorId).chargingProfiles.forEach((chargingProfile: ChargingProfile, index: number) => { + if (chargingProfile.chargingProfileId === commandPayload.csChargingProfiles.chargingProfileId + || (chargingProfile.stackLevel === commandPayload.csChargingProfiles.stackLevel && chargingProfile.chargingProfilePurpose === commandPayload.csChargingProfiles.chargingProfilePurpose)) { + this.getConnector(commandPayload.connectorId).chargingProfiles[index] = chargingProfile; + return Constants.OCPP_CHARGING_PROFILE_RESPONSE_ACCEPTED; + } + }); + this.getConnector(commandPayload.connectorId).chargingProfiles.push(commandPayload.csChargingProfiles); + return Constants.OCPP_CHARGING_PROFILE_RESPONSE_ACCEPTED; + } + + async handleRequestRemoteStartTransaction(commandPayload: RemoteStartTransactionRequest): Promise { + const transactionConnectorID: number = commandPayload.connectorId ? Utils.convertToInt(commandPayload.connectorId) : 1; if (this._getAuthorizeRemoteTxRequests() && this._getLocalAuthListEnabled() && this.hasAuthorizedTags()) { // Check if authorized if (this._authorizedTags.find((value) => value === commandPayload.idTag)) { // Authorization successful start transaction await this.sendStartTransaction(transactionConnectorID, commandPayload.idTag); - logger.debug(this._logPrefix() + ' Transaction remotely STARTED on ' + this._stationInfo.name + '#' + transactionConnectorID + ' for idTag ' + commandPayload.idTag); + logger.debug(this._logPrefix() + ' Transaction remotely STARTED on ' + this._stationInfo.name + '#' + transactionConnectorID.toString() + ' for idTag ' + commandPayload.idTag); return Constants.OCPP_RESPONSE_ACCEPTED; } - logger.error(this._logPrefix() + ' Remote starting transaction REJECTED with status ' + commandPayload.idTagInfo.status + ', idTag ' + commandPayload.idTag); + logger.error(this._logPrefix() + ' Remote starting transaction REJECTED, idTag ' + commandPayload.idTag); return Constants.OCPP_RESPONSE_REJECTED; } // No local authorization check required => start transaction await this.sendStartTransaction(transactionConnectorID, commandPayload.idTag); - logger.debug(this._logPrefix() + ' Transaction remotely STARTED on ' + this._stationInfo.name + '#' + transactionConnectorID + ' for idTag ' + commandPayload.idTag); + logger.debug(this._logPrefix() + ' Transaction remotely STARTED on ' + this._stationInfo.name + '#' + transactionConnectorID.toString() + ' for idTag ' + commandPayload.idTag); return Constants.OCPP_RESPONSE_ACCEPTED; } - async handleRequestRemoteStopTransaction(commandPayload) { + async handleRequestRemoteStopTransaction(commandPayload: RemoteStopTransactionRequest): Promise { + const transactionId = Utils.convertToInt(commandPayload.transactionId); for (const connector in this._connectors) { - if (this.getConnector(Utils.convertToInt(connector)).transactionId === commandPayload.transactionId) { - await this.sendStopTransaction(commandPayload.transactionId); + if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) { + await this.sendStopTransaction(transactionId); return Constants.OCPP_RESPONSE_ACCEPTED; } } - logger.info(this._logPrefix() + ' Try to stop remotely a non existing transaction ' + commandPayload.transactionId); + logger.info(this._logPrefix() + ' Trying to remote stop a non existing transaction ' + transactionId.toString()); return Constants.OCPP_RESPONSE_REJECTED; } }