X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FChargingStation.ts;h=e509c0288118e0b59c7380a4e78f8680e0af6fc6;hb=edfb206c5a6a309cbe5a8e6bf3c3f52ab57d96fc;hp=0a0043c9daf5d2ac8e070905afeedfaa36134339;hpb=10570d974fe84597ed0067bb41edc104ffa64167;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ChargingStation.ts b/src/charging-station/ChargingStation.ts index 0a0043c9..e509c028 100644 --- a/src/charging-station/ChargingStation.ts +++ b/src/charging-station/ChargingStation.ts @@ -1,15 +1,21 @@ +import { AuthorizationStatus, StartTransactionResponse, StopTransactionReason, StopTransactionResponse } from '../types/ocpp/1.6/Transaction'; +import ChargingStationConfiguration, { ConfigurationKey } from '../types/ChargingStationConfiguration'; +import ChargingStationTemplate, { PowerOutType } from '../types/ChargingStationTemplate'; +import { ConfigurationResponse, DefaultRequestResponse, UnlockResponse } from '../types/ocpp/1.6/RequestResponses'; import Connectors, { Connector } from '../types/Connectors'; -import MeterValue, { MeterValueLocation, MeterValueMeasurand, MeterValuePhase, MeterValueUnit } from '../types/MeterValue'; +import MeterValue, { MeterValueLocation, MeterValueMeasurand, MeterValuePhase, MeterValueUnit } from '../types/ocpp/1.6/MeterValue'; import { PerformanceObserver, performance } from 'perf_hooks'; import AutomaticTransactionGenerator from './AutomaticTransactionGenerator'; -import { ChargePointErrorCode } from '../types/ChargePointErrorCode'; -import { ChargePointStatus } from '../types/ChargePointStatus'; +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 OCPPError from './OcppError'; +import Requests from '../types/ocpp/1.6/Requests'; import Statistics from '../utils/Statistics'; import Utils from '../utils/Utils'; import WebSocket from 'ws'; @@ -20,20 +26,27 @@ import logger from '../utils/Logger'; export default class ChargingStation { private _index: number; private _stationTemplateFile: string; - private _stationInfo; - private _bootNotificationMessage; + private _stationInfo: ChargingStationInfo; + private _bootNotificationMessage: { + chargePointModel: string, + chargePointVendor: string, + chargeBoxSerialNumber?: string, + firmwareVersion?: string, + }; + private _connectors: Connectors; - private _configuration; + private _configuration: ChargingStationConfiguration; private _connectorsConfigurationHash: string; private _supervisionUrl: string; private _wsConnectionUrl: string; private _wsConnection: WebSocket; - private _isSocketRestart: boolean; + private _hasStopped: boolean; + private _hasSocketRestarted: boolean; 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; @@ -44,47 +57,49 @@ export default class ChargingStation { 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; } @@ -109,7 +124,7 @@ export default class ChargingStation { logger.warn(`${this._logPrefix()} Charging station template ${this._stationTemplateFile} with no connector configurations`); } // 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; } @@ -120,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._stationInfo.useConnectorId0 && 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; } } } @@ -169,8 +184,8 @@ export default class ChargingStation { return Utils.logPrefix(` ${this._stationInfo.name}:`); } - _getConfiguration() { - return this._stationInfo.Configuration ? this._stationInfo.Configuration : {}; + _getConfiguration(): ChargingStationConfiguration { + return this._stationInfo.Configuration ? this._stationInfo.Configuration : {} as ChargingStationConfiguration; } _getAuthorizationFile(): string { @@ -187,7 +202,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: ' + error); + logger.error(this._logPrefix() + ' Authorization file ' + authorizationFile + ' loading error: %j', error); throw error; } } else { @@ -206,14 +221,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; } } @@ -247,10 +262,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(); } @@ -265,10 +281,10 @@ export default class ChargingStation { const errMsg = `${this._logPrefix()} Unknown ${this._getPowerOutType()} powerOutType in template file ${this._stationTemplateFile}, cannot define default voltage out`; let defaultVoltageOut: number; switch (this._getPowerOutType()) { - case 'AC': + case PowerOutType.AC: defaultVoltageOut = 230; break; - case 'DC': + case PowerOutType.DC: defaultVoltageOut = 400; break; default: @@ -278,15 +294,23 @@ 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 (this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) { + return this.getConnector(Utils.convertToInt(connector)).idTag; + } + } + } + + _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 @@ -294,7 +318,7 @@ export default class ChargingStation { } return supervisionUrls[indexUrl]; } - return supervisionUrls; + return supervisionUrls as string; } _getAuthorizeRemoteTxRequests(): boolean { @@ -315,7 +339,7 @@ export default class ChargingStation { if (!this.getConnector(Utils.convertToInt(connector)).transactionStarted) { if (!this.getConnector(Utils.convertToInt(connector)).status && this.getConnector(Utils.convertToInt(connector)).bootStatus) { this.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).bootStatus); - } else if (this.getConnector(Utils.convertToInt(connector)).status) { + } else if (!this._hasStopped && this.getConnector(Utils.convertToInt(connector)).status) { this.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).status); } else { this.sendStatusNotification(Utils.convertToInt(connector), ChargePointStatus.AVAILABLE); @@ -325,7 +349,7 @@ export default class ChargingStation { } } // Start the ATG - if (Utils.convertToBoolean(this._stationInfo.AutomaticTransactionGenerator.enable)) { + if (this._stationInfo.AutomaticTransactionGenerator.enable) { if (!this._automaticTransactionGeneration) { this._automaticTransactionGeneration = new AutomaticTransactionGenerator(this); } @@ -338,11 +362,11 @@ export default class ChargingStation { } } - async _stopMessageSequence(reason = ''): Promise { + async _stopMessageSequence(reason: StopTransactionReason = StopTransactionReason.NONE): Promise { // 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); @@ -360,9 +384,9 @@ export default class ChargingStation { this._heartbeatSetInterval = setInterval(() => { 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 { - logger.error(`${this._logPrefix()} Heartbeat interval set to ${this._heartbeatInterval}ms, not starting the heartbeat`); + logger.error(`${this._logPrefix()} Heartbeat interval set to ${Utils.milliSecondsToHHMMSS(this._heartbeatInterval)}, not starting the heartbeat`); } } @@ -381,7 +405,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); } }); } @@ -393,12 +417,12 @@ 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) && + if (!this._stationInfo.AutomaticTransactionGenerator.enable && this._automaticTransactionGeneration) { this._automaticTransactionGeneration.stop().catch(() => { }); } } 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); } }); } @@ -424,7 +448,7 @@ 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`); } } @@ -450,7 +474,7 @@ export default class ChargingStation { this._wsConnection.on('ping', this.onPing.bind(this)); } - async stop(reason = ''): Promise { + async stop(reason: StopTransactionReason = StopTransactionReason.NONE): Promise { // Stop await this._stopMessageSequence(reason); // eslint-disable-next-line guard-for-in @@ -460,16 +484,17 @@ export default class ChargingStation { if (this._wsConnection && this._wsConnection.readyState === WebSocket.OPEN) { this._wsConnection.close(); } + this._hasStopped = true; } _reconnect(error): void { - logger.error(this._logPrefix() + ' Socket: abnormally closed', error); + logger.error(this._logPrefix() + ' Socket: abnormally closed: %j', error); // 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(); @@ -478,7 +503,7 @@ export default class ChargingStation { logger.error(`${this._logPrefix()} Socket: connection retry with timeout ${this._autoReconnectTimeout}ms`); this._autoReconnectRetryCount++; setTimeout(() => { - logger.error(this._logPrefix() + ' Socket: reconnecting try #' + this._autoReconnectRetryCount); + logger.error(this._logPrefix() + ' Socket: reconnecting try #' + this._autoReconnectRetryCount.toString()); this.start(); }, this._autoReconnectTimeout); } else if (this._autoReconnectTimeout !== 0 || this._autoReconnectMaxRetries !== -1) { @@ -488,46 +513,47 @@ export default class ChargingStation { onOpen(): void { logger.info(`${this._logPrefix()} Is connected to server through ${this._wsConnectionUrl}`); - if (!this._isSocketRestart) { + if (!this._hasSocketRestarted) { // Send BootNotification this.sendBootNotification(); } - if (this._isSocketRestart) { + if (this._hasSocketRestarted) { this._startMessageSequence(); if (!Utils.isEmptyArray(this._messageQueue)) { - this._messageQueue.forEach((message) => { + this._messageQueue.forEach((message, index) => { if (this._wsConnection && 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): void { - switch (error) { + onError(errorEvent): void { + switch (errorEvent) { case 'ECONNREFUSED': - this._isSocketRestart = true; - this._reconnect(error); + this._hasSocketRestarted = true; + this._reconnect(errorEvent); break; default: - logger.error(this._logPrefix() + ' Socket error: ' + error); + logger.error(this._logPrefix() + ' Socket error: %j', errorEvent); break; } } - onClose(error): void { - switch (error) { + onClose(closeEvent): void { + 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; + this._reconnect(closeEvent); break; } } @@ -536,11 +562,11 @@ export default class ChargingStation { logger.debug(this._logPrefix() + ' Has received a WS ping (rfc6455) from the server'); } - async onMessage(message): Promise { + async onMessage(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); // Check the Type of message switch (messageType) { @@ -594,7 +620,7 @@ 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); } @@ -607,7 +633,7 @@ export default class ChargingStation { }; 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; } } @@ -616,7 +642,7 @@ export default class ChargingStation { try { await this.sendMessage(Utils.generateUUID(), this._bootNotificationMessage, Constants.OCPP_JSON_CALL_MESSAGE, 'BootNotification'); } catch (error) { - logger.error(this._logPrefix() + ' Send BootNotification error: ' + error); + logger.error(this._logPrefix() + ' Send BootNotification error: %j', error); throw error; } } @@ -631,37 +657,39 @@ export default class ChargingStation { }; 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 = { 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 = { transactionId, + ...!Utils.isUndefined(idTag) && { idTag: idTag }, meterStop: 0, 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; } } @@ -703,7 +731,7 @@ export default class ChargingStation { ...!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 = Utils.convertToInt(sampledValues.sampledValue[sampledValues.sampledValue.length - 1].value); + const voltageValue = Utils.convertToFloat(sampledValues.sampledValue[sampledValues.sampledValue.length - 1].value); let phaseValue: string; if (voltageValue >= 0 && voltageValue <= 250) { phaseValue = `L${phase}-N`; @@ -720,7 +748,7 @@ export default class ChargingStation { }); } // Power.Active.Import measurand - } else if (meterValuesTemplate[index].measurand && meterValuesTemplate[index].measurand === MeterValueMeasurand.POWER_ACTIVE_EXPORT && self._getConfigurationKey('MeterValuesSampledData').value.includes(MeterValueMeasurand.POWER_ACTIVE_EXPORT)) { + } 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 : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: powerDivider is undefined`; @@ -736,7 +764,7 @@ export default class ChargingStation { 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; @@ -748,7 +776,7 @@ export default class ChargingStation { powerMeasurandValues.allPhases = Utils.roundTo(powerMeasurandValues.L1 + powerMeasurandValues.L2 + powerMeasurandValues.L3, 2); } break; - case 'DC': + case PowerOutType.DC: if (Utils.isUndefined(meterValuesTemplate[index].value)) { powerMeasurandValues.allPhases = Utils.getRandomFloatRounded(maxPower); } @@ -775,7 +803,7 @@ export default class ChargingStation { ...!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}`] }, + ...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } : { value: powerMeasurandValues[`L${phase}`] as string }, phase: phaseValue as MeterValuePhase, }); } @@ -792,10 +820,10 @@ export default class ChargingStation { throw Error(errMsg); } 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 = {} as MeasurandValues; + 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); @@ -808,7 +836,7 @@ export default class ChargingStation { 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.allPhases = Utils.getRandomFloatRounded(maxAmperage); @@ -836,7 +864,7 @@ export default class ChargingStation { ...!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] }, + ...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } : { value: currentMeasurandValues[phaseValue] as string }, phase: phaseValue as MeterValuePhase, }); } @@ -866,7 +894,8 @@ export default class ChargingStation { ...!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.toString() }, + ...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } : + { value: connector.lastEnergyActiveImportRegisterValue.toString() }, }); const sampledValuesIndex = sampledValues.sampledValue.length - 1; const maxConsumption = Math.round(self._stationInfo.maxPower * 3600 / (self._stationInfo.powerDivider * interval)); @@ -886,19 +915,19 @@ export default class ChargingStation { }; 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): Promise { + 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): Promise { + 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 @@ -971,10 +1000,10 @@ 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); } @@ -996,6 +1025,7 @@ export default class ChargingStation { this._addConfigurationKey('HeartBeatInterval', payload.interval); this._addConfigurationKey('HeartbeatInterval', payload.interval, false, false); this._startMessageSequence(); + this._hasStopped && (this._hasStopped = false); } else if (payload.status === 'Pending') { logger.info(this._logPrefix() + ' Charging station in pending state on the central server'); } else { @@ -1017,64 +1047,65 @@ export default class ChargingStation { } } - handleResponseStartTransaction(payload, requestPayload): void { - 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): 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) === 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, ChargePointStatus.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, ChargePointStatus.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): void { - let transactionConnectorId; + handleResponseStopTransaction(payload: StopTransactionResponse, requestPayload): void { + let transactionConnectorId: number; for (const connector in this._connectors) { - if (this.getConnector(Utils.convertToInt(connector)).transactionId === requestPayload.transactionId) { - transactionConnectorId = connector; + if (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); return; } - if (payload.idTagInfo && payload.idTagInfo.status === 'Accepted') { - this.sendStatusNotification(transactionConnectorId, ChargePointStatus.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 + ' 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 + ' REJECTED with status ' + payload.idTagInfo?.status); } } @@ -1090,7 +1121,7 @@ export default class ChargingStation { logger.debug(this._logPrefix() + ' Heartbeat response received: %j to Heartbeat request: %j', payload, requestPayload); } - async handleRequest(messageId, commandName, commandPayload): Promise { + async handleRequest(messageId: string, commandName: string, commandPayload): Promise { let response; // Call if (typeof this['handleRequest' + commandName] === 'function') { @@ -1099,7 +1130,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; @@ -1114,17 +1145,34 @@ export default class ChargingStation { } // Simulate charging station restart - handleRequestReset(commandPayload) { + handleRequestReset(commandPayload): DefaultRequestResponse { 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: string) { + async handleRequestUnlockConnector(commandPayload): 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); } @@ -1149,15 +1197,13 @@ export default class ChargingStation { } } - handleRequestGetConfiguration(commandPayload) { - const configurationKey = []; - const unknownKey = []; + handleRequestGetConfiguration(commandPayload): { configurationKey: ConfigurationKey[]; unknownKey: string[] } { + 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; @@ -1169,13 +1215,11 @@ export default class ChargingStation { }); } } else { - for (const configurationKey of commandPayload.key) { - const keyFound = this._getConfigurationKey(configurationKey); + for (const key of commandPayload.key as string[]) { + 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; @@ -1186,7 +1230,7 @@ export default class ChargingStation { value: keyFound.value, }); } else { - unknownKey.push(configurationKey); + unknownKey.push(key); } } } @@ -1196,13 +1240,13 @@ export default class ChargingStation { }; } - handleRequestChangeConfiguration(commandPayload) { + handleRequestChangeConfiguration(commandPayload): ConfigurationResponse { 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 triggerHeartbeatRestart = false; @@ -1221,40 +1265,41 @@ export default class ChargingStation { // Start heartbeat this._startHeartbeat(); } - 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'; + async handleRequestRemoteStartTransaction(commandPayload): 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 with status ' + commandPayload.idTagInfo?.status + ', 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): 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 (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; } }