-import Connectors, { Connector } from '../types/Connectors';
-import MeterValue, { MeterValueLocation, MeterValueMeasurand, MeterValuePhase, MeterValueUnit } from '../types/MeterValue';
+import { BootNotificationResponse, RegistrationStatus } from '../types/ocpp/Responses';
+import ChargingStationConfiguration, { ConfigurationKey } from '../types/ChargingStationConfiguration';
+import ChargingStationTemplate, { CurrentOutType, PowerUnits, VoltageOut } from '../types/ChargingStationTemplate';
+import { ConnectorPhaseRotation, StandardParametersKey, SupportedFeatureProfiles } from '../types/ocpp/Configuration';
+import Connectors, { Connector, SampledValueTemplate } from '../types/Connectors';
+import { MeterValueMeasurand, MeterValuePhase } from '../types/ocpp/MeterValues';
import { PerformanceObserver, performance } from 'perf_hooks';
+import Requests, { AvailabilityType, BootNotificationRequest, IncomingRequest, IncomingRequestCommand } from '../types/ocpp/Requests';
+import WebSocket, { MessageEvent } from 'ws';
import AutomaticTransactionGenerator from './AutomaticTransactionGenerator';
-import { ChargePointErrorCode } from '../types/ChargePointErrorCode';
-import { ChargePointStatus } from '../types/ChargePointStatus';
+import { ChargePointStatus } from '../types/ocpp/ChargePointStatus';
+import { ChargingProfile } from '../types/ocpp/ChargingProfile';
+import ChargingStationInfo from '../types/ChargingStationInfo';
import Configuration from '../utils/Configuration';
-import Constants from '../utils/Constants.js';
-import ElectricUtils from '../utils/ElectricUtils';
-import MeasurandValues from '../types/MeasurandValues';
-import OCPPError from './OcppError.js';
-import Statistics from '../utils/Statistics';
+import Constants from '../utils/Constants';
+import FileUtils from '../utils/FileUtils';
+import { MessageType } from '../types/ocpp/MessageType';
+import OCPP16IncomingRequestService from './ocpp/1.6/OCCP16IncomingRequestService';
+import OCPP16RequestService from './ocpp/1.6/OCPP16RequestService';
+import OCPP16ResponseService from './ocpp/1.6/OCPP16ResponseService';
+import OCPPError from './OcppError';
+import OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService';
+import OCPPRequestService from './ocpp/OCPPRequestService';
+import { OCPPVersion } from '../types/ocpp/OCPPVersion';
+import PerformanceStatistics from '../utils/PerformanceStatistics';
+import { StopTransactionReason } from '../types/ocpp/Transaction';
import Utils from '../utils/Utils';
-import WebSocket from 'ws';
+import { WebSocketCloseEventStatusCode } from '../types/WebSocket';
import crypto from 'crypto';
import fs from 'fs';
import logger from '../utils/Logger';
+import path from 'path';
export default class ChargingStation {
- private _index: number;
- private _stationTemplateFile: string;
- private _stationInfo;
- private _bootNotificationMessage;
- private _connectors: Connectors;
- private _configuration;
- private _connectorsConfigurationHash: string;
- private _supervisionUrl: string;
- private _wsConnectionUrl: string;
- private _wsConnection: WebSocket;
- private _isSocketRestart: boolean;
- private _autoReconnectRetryCount: number;
- private _autoReconnectMaxRetries: number;
- private _autoReconnectTimeout: number;
- private _requests;
- private _messageQueue: any[];
- private _automaticTransactionGeneration: AutomaticTransactionGenerator;
- private _authorizedTags: string[];
- private _heartbeatInterval: number;
- private _heartbeatSetInterval: NodeJS.Timeout;
- private _statistics: Statistics;
- private _performanceObserver: PerformanceObserver;
+ public stationTemplateFile: string;
+ public authorizedTags: string[];
+ public stationInfo!: ChargingStationInfo;
+ public connectors: Connectors;
+ public configuration!: ChargingStationConfiguration;
+ public hasStopped: boolean;
+ public wsConnection!: WebSocket;
+ public requests: Requests;
+ public messageQueue: string[];
+ public performanceStatistics!: PerformanceStatistics;
+ public heartbeatSetInterval!: NodeJS.Timeout;
+ public ocppIncomingRequestService!: OCPPIncomingRequestService;
+ public ocppRequestService!: OCPPRequestService;
+ private index: number;
+ private bootNotificationRequest!: BootNotificationRequest;
+ private bootNotificationResponse!: BootNotificationResponse | null;
+ private connectorsConfigurationHash!: string;
+ private supervisionUrl!: string;
+ private wsConnectionUrl!: string;
+ private hasSocketRestarted: boolean;
+ private autoReconnectRetryCount: number;
+ private automaticTransactionGeneration!: AutomaticTransactionGenerator;
+ private performanceObserver!: PerformanceObserver;
+ private webSocketPingSetInterval!: NodeJS.Timeout;
constructor(index: number, stationTemplateFile: string) {
- this._index = index;
- this._stationTemplateFile = stationTemplateFile;
- this._connectors = {};
- this._initialize();
+ this.index = index;
+ this.stationTemplateFile = stationTemplateFile;
+ this.connectors = {} as Connectors;
+ this.initialize();
- this._isSocketRestart = false;
- this._autoReconnectRetryCount = 0;
- this._autoReconnectMaxRetries = Configuration.getAutoReconnectMaxRetries(); // -1 for unlimited
- this._autoReconnectTimeout = Configuration.getAutoReconnectTimeout() * 1000; // Ms, zero for disabling
+ this.hasStopped = false;
+ this.hasSocketRestarted = false;
+ this.autoReconnectRetryCount = 0;
- this._requests = {};
- this._messageQueue = [];
+ this.requests = {} as Requests;
+ this.messageQueue = [] as string[];
- this._authorizedTags = this._loadAndGetAuthorizedTags();
+ this.authorizedTags = this.getAuthorizedTags();
}
- _getStationName(stationTemplate): string {
- return stationTemplate.fixedName ? stationTemplate.baseName : stationTemplate.baseName + '-' + ('000000000' + this._index).substr(('000000000' + this._index).length - 4);
+ public logPrefix(): string {
+ return Utils.logPrefix(` ${this.stationInfo.chargingStationId} |`);
}
- _buildStationInfo() {
- let stationTemplateFromFile;
- try {
- // Load template file
- const fileDescriptor = fs.openSync(this._stationTemplateFile, 'r');
- stationTemplateFromFile = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8'));
- fs.closeSync(fileDescriptor);
- } catch (error) {
- logger.error('Template file ' + this._stationTemplateFile + ' loading error: ' + error);
- throw error;
- }
- const stationTemplate = stationTemplateFromFile || {};
- if (!Utils.isEmptyArray(stationTemplateFromFile.power)) {
- stationTemplate.maxPower = stationTemplateFromFile.power[Math.floor(Math.random() * stationTemplateFromFile.power.length)];
- } else {
- stationTemplate.maxPower = stationTemplateFromFile.power;
- }
- stationTemplate.name = this._getStationName(stationTemplateFromFile);
- stationTemplate.resetTime = stationTemplateFromFile.resetTime ? stationTemplateFromFile.resetTime * 1000 : Constants.CHARGING_STATION_DEFAULT_RESET_TIME;
- return stationTemplate;
- }
-
- get stationInfo() {
- return this._stationInfo;
- }
-
- _initialize(): void {
- this._stationInfo = this._buildStationInfo();
- this._bootNotificationMessage = {
- 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._supervisionUrl = this._getSupervisionURL();
- this._wsConnectionUrl = this._supervisionUrl + '/' + this._stationInfo.name;
- // Build connectors if needed
- const maxConnectors = this._getMaxNumberOfConnectors();
- if (maxConnectors <= 0) {
- logger.warn(`${this._logPrefix()} Charging station template ${this._stationTemplateFile} with ${maxConnectors} connectors`);
- }
- const templateMaxConnectors = this._getTemplateMaxNumberOfConnectors();
- if (templateMaxConnectors <= 0) {
- 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)) {
- 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;
- }
- const connectorsConfigHash = crypto.createHash('sha256').update(JSON.stringify(this._stationInfo.Connectors) + maxConnectors.toString()).digest('hex');
- // FIXME: Handle shrinking the number of connectors
- if (!this._connectors || (this._connectors && this._connectorsConfigurationHash !== connectorsConfigHash)) {
- this._connectorsConfigurationHash = connectorsConfigHash;
- // 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]);
- }
- }
- // 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]);
- }
- }
- }
- // Avoid duplication of connectors related information
- delete this._stationInfo.Connectors;
- // Initialize transaction attributes on connectors
- for (const connector in this._connectors) {
- if (!this.getConnector(Utils.convertToInt(connector)).transactionStarted) {
- this._initTransactionOnConnector(Utils.convertToInt(connector));
- }
- }
- // OCPP parameters
- this._addConfigurationKey('NumberOfConnectors', this._getNumberOfConnectors().toString(), true);
- if (!this._getConfigurationKey('MeterValuesSampledData')) {
- this._addConfigurationKey('MeterValuesSampledData', MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER);
- }
- this._stationInfo.powerDivider = this._getPowerDivider();
- if (this.getEnableStatistics()) {
- this._statistics = Statistics.getInstance();
- this._statistics.objName = this._stationInfo.name;
- this._performanceObserver = new PerformanceObserver((list) => {
- const entry = list.getEntries()[0];
- this._statistics.logPerformance(entry, Constants.ENTITY_CHARGING_STATION);
- this._performanceObserver.disconnect();
- });
- }
+ public getRandomTagId(): string {
+ const index = Math.floor(Math.random() * this.authorizedTags.length);
+ return this.authorizedTags[index];
}
- get connectors(): Connectors {
- return this._connectors;
+ public hasAuthorizedTags(): boolean {
+ return !Utils.isEmptyArray(this.authorizedTags);
}
- get statistics(): Statistics {
- return this._statistics;
+ public getEnableStatistics(): boolean | undefined {
+ return !Utils.isUndefined(this.stationInfo.enableStatistics) ? this.stationInfo.enableStatistics : true;
}
- _logPrefix(): string {
- return Utils.logPrefix(` ${this._stationInfo.name}:`);
+ public getNumberOfPhases(): number | undefined {
+ switch (this.getCurrentOutType()) {
+ case CurrentOutType.AC:
+ return !Utils.isUndefined(this.stationInfo.numberOfPhases) ? this.stationInfo.numberOfPhases : 3;
+ case CurrentOutType.DC:
+ return 0;
+ }
}
- _getConfiguration() {
- return this._stationInfo.Configuration ? this._stationInfo.Configuration : {};
+ public isWebSocketOpen(): boolean {
+ return this.wsConnection?.readyState === WebSocket.OPEN;
}
- _getAuthorizationFile(): string {
- return this._stationInfo.authorizationFile && this._stationInfo.authorizationFile;
+ public isRegistered(): boolean {
+ return this.bootNotificationResponse?.status === RegistrationStatus.ACCEPTED;
}
- _loadAndGetAuthorizedTags(): string[] {
- let authorizedTags: string[] = [];
- const authorizationFile = this._getAuthorizationFile();
- if (authorizationFile) {
- try {
- // Load authorization file
- const fileDescriptor = fs.openSync(authorizationFile, 'r');
- authorizedTags = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as string[];
- fs.closeSync(fileDescriptor);
- } catch (error) {
- logger.error(this._logPrefix() + ' Authorization file ' + authorizationFile + ' loading error: ' + error);
- throw error;
- }
- } else {
- logger.info(this._logPrefix() + ' No authorization file given in template file ' + this._stationTemplateFile);
- }
- return authorizedTags;
+ public isChargingStationAvailable(): boolean {
+ return this.getConnector(0).availability === AvailabilityType.OPERATIVE;
}
- getRandomTagId(): string {
- const index = Math.floor(Math.random() * this._authorizedTags.length);
- return this._authorizedTags[index];
+ public isConnectorAvailable(id: number): boolean {
+ return this.getConnector(id).availability === AvailabilityType.OPERATIVE;
}
- hasAuthorizedTags(): boolean {
- return !Utils.isEmptyArray(this._authorizedTags);
+ public getConnector(id: number): Connector {
+ return this.connectors[id];
}
- getEnableStatistics(): boolean {
- return !Utils.isUndefined(this._stationInfo.enableStatistics) ? Utils.convertToBoolean(this._stationInfo.enableStatistics) : true;
+ public getCurrentOutType(): CurrentOutType | undefined {
+ return !Utils.isUndefined(this.stationInfo.currentOutType) ? this.stationInfo.currentOutType : CurrentOutType.AC;
}
- _getNumberOfPhases(): number {
- switch (this._getPowerOutType()) {
- case 'AC':
- return !Utils.isUndefined(this._stationInfo.numberOfPhases) ? Utils.convertToInt(this._stationInfo.numberOfPhases) : 3;
- case 'DC':
- return 0;
+ public getVoltageOut(): number | undefined {
+ const errMsg = `${this.logPrefix()} Unknown ${this.getCurrentOutType()} currentOutType in template file ${this.stationTemplateFile}, cannot define default voltage out`;
+ let defaultVoltageOut: number;
+ switch (this.getCurrentOutType()) {
+ case CurrentOutType.AC:
+ defaultVoltageOut = VoltageOut.VOLTAGE_230;
+ break;
+ case CurrentOutType.DC:
+ defaultVoltageOut = VoltageOut.VOLTAGE_400;
+ break;
+ default:
+ logger.error(errMsg);
+ throw Error(errMsg);
}
+ return !Utils.isUndefined(this.stationInfo.voltageOut) ? this.stationInfo.voltageOut : defaultVoltageOut;
}
- _getNumberOfRunningTransactions(): number {
- let trxCount = 0;
- for (const connector in this._connectors) {
- if (this.getConnector(Utils.convertToInt(connector)).transactionStarted) {
- trxCount++;
+ public getTransactionIdTag(transactionId: number): string | undefined {
+ for (const connector in this.connectors) {
+ if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) {
+ return this.getConnector(Utils.convertToInt(connector)).idTag;
}
}
- return trxCount;
}
- _getPowerDivider(): number {
- let powerDivider = this._getNumberOfConnectors();
- if (this._stationInfo.powerSharedByConnectors) {
- powerDivider = this._getNumberOfRunningTransactions();
- }
- return powerDivider;
+ public getOutOfOrderEndMeterValues(): boolean {
+ return this.stationInfo.outOfOrderEndMeterValues ?? false;
}
- getConnector(id: number): Connector {
- return this._connectors[id];
+ public getBeginEndMeterValues(): boolean {
+ return this.stationInfo.beginEndMeterValues ?? false;
}
- _getTemplateMaxNumberOfConnectors(): number {
- return Object.keys(this._stationInfo.Connectors).length;
+ public getMeteringPerTransaction(): boolean {
+ return this.stationInfo.meteringPerTransaction ?? true;
}
- _getMaxNumberOfConnectors(): number {
- let maxConnectors = 0;
- if (!Utils.isEmptyArray(this._stationInfo.numberOfConnectors)) {
- // Distribute evenly the number of connectors
- maxConnectors = this._stationInfo.numberOfConnectors[(this._index - 1) % this._stationInfo.numberOfConnectors.length];
- } else if (!Utils.isUndefined(this._stationInfo.numberOfConnectors)) {
- maxConnectors = this._stationInfo.numberOfConnectors;
- } else {
- maxConnectors = this._stationInfo.Connectors[0] ? this._getTemplateMaxNumberOfConnectors() - 1 : this._getTemplateMaxNumberOfConnectors();
- }
- return maxConnectors;
+ public getTransactionDataMeterValues(): boolean {
+ return this.stationInfo.transactionDataMeterValues ?? false;
}
- _getNumberOfConnectors(): number {
- return this._connectors[0] ? Object.keys(this._connectors).length - 1 : Object.keys(this._connectors).length;
+ public getMainVoltageMeterValues(): boolean {
+ return this.stationInfo.mainVoltageMeterValues ?? true;
}
- _getVoltageOut(): number {
- 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':
- defaultVoltageOut = 230;
- break;
- case 'DC':
- defaultVoltageOut = 400;
- break;
- default:
- logger.error(errMsg);
- throw Error(errMsg);
+ public getEnergyActiveImportRegisterByTransactionId(transactionId: number): number | undefined {
+ if (this.getMeteringPerTransaction()) {
+ for (const connector in this.connectors) {
+ if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) {
+ return this.getConnector(Utils.convertToInt(connector)).transactionEnergyActiveImportRegisterValue;
+ }
+ }
+ }
+ for (const connector in this.connectors) {
+ if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) {
+ return this.getConnector(Utils.convertToInt(connector)).energyActiveImportRegisterValue;
+ }
}
- return !Utils.isUndefined(this._stationInfo.voltageOut) ? Utils.convertToInt(this._stationInfo.voltageOut) : defaultVoltageOut;
- }
-
- _getPowerOutType(): string {
- return !Utils.isUndefined(this._stationInfo.powerOutType) ? this._stationInfo.powerOutType : 'AC';
}
- _getSupervisionURL(): string {
- const supervisionUrls = Utils.cloneObject(this._stationInfo.supervisionURL ? this._stationInfo.supervisionURL : Configuration.getSupervisionURLs());
- let indexUrl = 0;
- if (!Utils.isEmptyArray(supervisionUrls)) {
- if (Configuration.getDistributeStationToTenantEqually()) {
- indexUrl = this._index % supervisionUrls.length;
- } else {
- // Get a random url
- indexUrl = Math.floor(Math.random() * supervisionUrls.length);
- }
- return supervisionUrls[indexUrl];
+ public getEnergyActiveImportRegisterByConnectorId(connectorId: number): number | undefined {
+ if (this.getMeteringPerTransaction()) {
+ return this.getConnector(connectorId).transactionEnergyActiveImportRegisterValue;
}
- return supervisionUrls;
+ return this.getConnector(connectorId).energyActiveImportRegisterValue;
}
- _getAuthorizeRemoteTxRequests(): boolean {
- const authorizeRemoteTxRequests = this._getConfigurationKey('AuthorizeRemoteTxRequests');
+ public getAuthorizeRemoteTxRequests(): boolean {
+ const authorizeRemoteTxRequests = this.getConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests);
return authorizeRemoteTxRequests ? Utils.convertToBoolean(authorizeRemoteTxRequests.value) : false;
}
- _getLocalAuthListEnabled(): boolean {
- const localAuthListEnabled = this._getConfigurationKey('LocalAuthListEnabled');
+ public getLocalAuthListEnabled(): boolean {
+ const localAuthListEnabled = this.getConfigurationKey(StandardParametersKey.LocalAuthListEnabled);
return localAuthListEnabled ? Utils.convertToBoolean(localAuthListEnabled.value) : false;
}
- _startMessageSequence(): void {
- // 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)).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) {
- this.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).status);
- } else {
- this.sendStatusNotification(Utils.convertToInt(connector), ChargePointStatus.AVAILABLE);
- }
- } else {
- this.sendStatusNotification(Utils.convertToInt(connector), ChargePointStatus.CHARGING);
- }
+ public restartWebSocketPing(): void {
+ // Stop WebSocket ping
+ this.stopWebSocketPing();
+ // Start WebSocket ping
+ this.startWebSocketPing();
+ }
+
+ public getSampledValueTemplate(connectorId: number, measurand: MeterValueMeasurand = MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER,
+ phase?: MeterValuePhase): SampledValueTemplate | undefined {
+ if (!Constants.SUPPORTED_MEASURANDS.includes(measurand)) {
+ logger.warn(`${this.logPrefix()} Unsupported MeterValues measurand ${measurand} in template on connectorId ${connectorId}`);
+ return;
}
- // Start the ATG
- if (Utils.convertToBoolean(this._stationInfo.AutomaticTransactionGenerator.enable)) {
- if (!this._automaticTransactionGeneration) {
- this._automaticTransactionGeneration = new AutomaticTransactionGenerator(this);
- }
- if (this._automaticTransactionGeneration.timeToStop) {
- this._automaticTransactionGeneration.start();
+ const sampledValueTemplates: SampledValueTemplate[] = this.getConnector(connectorId).MeterValues;
+ let defaultMeasurandFound = false;
+ for (let index = 0; !Utils.isEmptyArray(sampledValueTemplates) && index < sampledValueTemplates.length; index++) {
+ if (phase && sampledValueTemplates[index]?.phase === phase && sampledValueTemplates[index]?.measurand === measurand
+ && this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes(measurand)) {
+ return sampledValueTemplates[index];
+ } else if (!phase && !sampledValueTemplates[index].phase && sampledValueTemplates[index]?.measurand === measurand
+ && this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes(measurand)) {
+ return sampledValueTemplates[index];
+ } else if (measurand === MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER
+ && (!sampledValueTemplates[index].measurand || sampledValueTemplates[index].measurand === measurand)) {
+ defaultMeasurandFound = true;
+ return sampledValueTemplates[index];
}
}
- if (this.getEnableStatistics()) {
- this._statistics.start();
+ if (measurand === MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER && !defaultMeasurandFound) {
+ logger.error(`${this.logPrefix()} Missing MeterValues for default measurand ${MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER} in template on connectorId ${connectorId}`);
}
+ logger.debug(`${this.logPrefix()} No MeterValues for measurand ${measurand} ${phase ? `on phase ${phase} ` : ''}in template on connectorId ${connectorId}`);
}
- async _stopMessageSequence(reason = ''): Promise<void> {
- // Stop heartbeat
- this._stopHeartbeat();
- // Stop the ATG
- if (Utils.convertToBoolean(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) {
- await this.sendStopTransaction(this.getConnector(Utils.convertToInt(connector)).transactionId, reason);
- }
- }
- }
+ public getAutomaticTransactionGeneratorRequireAuthorize(): boolean {
+ return this.stationInfo.AutomaticTransactionGenerator.requireAuthorize ?? true;
}
- _startHeartbeat(): void {
- if (this._heartbeatInterval && this._heartbeatInterval > 0 && !this._heartbeatSetInterval) {
- this._heartbeatSetInterval = setInterval(() => {
- this.sendHeartbeat();
- }, this._heartbeatInterval);
- logger.info(this._logPrefix() + ' Heartbeat started every ' + this._heartbeatInterval.toString() + 'ms');
+ public startHeartbeat(): void {
+ if (this.getHeartbeatInterval() && this.getHeartbeatInterval() > 0 && !this.heartbeatSetInterval) {
+ // eslint-disable-next-line @typescript-eslint/no-misused-promises
+ this.heartbeatSetInterval = setInterval(async (): Promise<void> => {
+ await this.ocppRequestService.sendHeartbeat();
+ }, this.getHeartbeatInterval());
+ logger.info(this.logPrefix() + ' Heartbeat started every ' + Utils.milliSecondsToHHMMSS(this.getHeartbeatInterval()));
+ } else if (this.heartbeatSetInterval) {
+ logger.info(this.logPrefix() + ' Heartbeat already started every ' + Utils.milliSecondsToHHMMSS(this.getHeartbeatInterval()));
} else {
- logger.error(`${this._logPrefix()} Heartbeat interval set to ${this._heartbeatInterval}ms, not starting the heartbeat`);
- }
- }
-
- _stopHeartbeat(): void {
- if (this._heartbeatSetInterval) {
- clearInterval(this._heartbeatSetInterval);
- this._heartbeatSetInterval = null;
+ logger.error(`${this.logPrefix()} Heartbeat interval set to ${this.getHeartbeatInterval() ? Utils.milliSecondsToHHMMSS(this.getHeartbeatInterval()) : this.getHeartbeatInterval()}, not starting the heartbeat`);
}
}
- _startAuthorizationFileMonitoring(): void {
- // eslint-disable-next-line @typescript-eslint/no-unused-vars
- fs.watchFile(this._getAuthorizationFile(), (current, previous) => {
- try {
- logger.debug(this._logPrefix() + ' Authorization file ' + this._getAuthorizationFile() + ' have changed, reload');
- // Initialize _authorizedTags
- this._authorizedTags = this._loadAndGetAuthorizedTags();
- } catch (error) {
- logger.error(this._logPrefix() + ' Authorization file monitoring error: ' + error);
- }
- });
- }
-
- _startStationTemplateFileMonitoring(): void {
- // eslint-disable-next-line @typescript-eslint/no-unused-vars
- fs.watchFile(this._stationTemplateFile, (current, previous) => {
- try {
- 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(() => { });
- }
- } catch (error) {
- logger.error(this._logPrefix() + ' Charging station template file monitoring error: ' + error);
- }
- });
+ public restartHeartbeat(): void {
+ // Stop heartbeat
+ this.stopHeartbeat();
+ // Start heartbeat
+ this.startHeartbeat();
}
- _startMeterValues(connectorId: number, interval: number): void {
- if (!this.getConnector(connectorId).transactionStarted) {
- logger.error(`${this._logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction started`);
+ public startMeterValues(connectorId: number, interval: number): void {
+ if (connectorId === 0) {
+ logger.error(`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId.toString()}`);
+ return;
+ }
+ if (!this.getConnector(connectorId)) {
+ logger.error(`${this.logPrefix()} Trying to start MeterValues on non existing connector Id ${connectorId.toString()}`);
+ return;
+ }
+ if (!this.getConnector(connectorId)?.transactionStarted) {
+ logger.error(`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction started`);
return;
- } else if (this.getConnector(connectorId).transactionStarted && !this.getConnector(connectorId).transactionId) {
- logger.error(`${this._logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction id`);
+ } else if (this.getConnector(connectorId)?.transactionStarted && !this.getConnector(connectorId)?.transactionId) {
+ logger.error(`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction id`);
return;
}
if (interval > 0) {
- this.getConnector(connectorId).transactionSetInterval = setInterval(async () => {
+ // eslint-disable-next-line @typescript-eslint/no-misused-promises
+ this.getConnector(connectorId).transactionSetInterval = setInterval(async (): Promise<void> => {
if (this.getEnableStatistics()) {
- const sendMeterValues = performance.timerify(this.sendMeterValues);
- this._performanceObserver.observe({
+ const sendMeterValues = performance.timerify(this.ocppRequestService.sendMeterValues);
+ this.performanceObserver.observe({
entryTypes: ['function'],
});
- await sendMeterValues(connectorId, interval, this);
+ await sendMeterValues(connectorId, this.getConnector(connectorId).transactionId, interval, this.ocppRequestService);
} else {
- await this.sendMeterValues(connectorId, interval, this);
+ await this.ocppRequestService.sendMeterValues(connectorId, this.getConnector(connectorId).transactionId, interval, this.ocppRequestService);
}
}, interval);
} else {
- logger.error(`${this._logPrefix()} Charging station MeterValueSampleInterval configuration set to ${interval}ms, not sending MeterValues`);
+ logger.error(`${this.logPrefix()} Charging station ${StandardParametersKey.MeterValueSampleInterval} configuration set to ${interval ? Utils.milliSecondsToHHMMSS(interval) : interval}, not sending MeterValues`);
}
}
- start(): void {
- if (!this._wsConnectionUrl) {
- this._wsConnectionUrl = this._supervisionUrl + '/' + this._stationInfo.name;
- }
- this._wsConnection = new WebSocket(this._wsConnectionUrl, 'ocpp' + Constants.OCPP_VERSION_16);
- logger.info(this._logPrefix() + ' Will communicate through URL ' + this._supervisionUrl);
+ public start(): void {
+ this.openWSConnection();
// Monitor authorization file
- this._startAuthorizationFileMonitoring();
+ this.startAuthorizationFileMonitoring();
// Monitor station template file
- this._startStationTemplateFileMonitoring();
+ this.startStationTemplateFileMonitoring();
// Handle Socket incoming messages
- this._wsConnection.on('message', this.onMessage.bind(this));
+ this.wsConnection.on('message', this.onMessage.bind(this));
// Handle Socket error
- this._wsConnection.on('error', this.onError.bind(this));
+ this.wsConnection.on('error', this.onError.bind(this));
// Handle Socket close
- this._wsConnection.on('close', this.onClose.bind(this));
+ this.wsConnection.on('close', this.onClose.bind(this));
// Handle Socket opening connection
- this._wsConnection.on('open', this.onOpen.bind(this));
+ this.wsConnection.on('open', this.onOpen.bind(this));
// Handle Socket ping
- this._wsConnection.on('ping', this.onPing.bind(this));
+ this.wsConnection.on('ping', this.onPing.bind(this));
+ // Handle Socket pong
+ this.wsConnection.on('pong', this.onPong.bind(this));
+ }
+
+ public async stop(reason: StopTransactionReason = StopTransactionReason.NONE): Promise<void> {
+ // Stop message sequence
+ await this.stopMessageSequence(reason);
+ for (const connector in this.connectors) {
+ if (Utils.convertToInt(connector) > 0) {
+ await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), ChargePointStatus.UNAVAILABLE);
+ this.getConnector(Utils.convertToInt(connector)).status = ChargePointStatus.UNAVAILABLE;
+ }
+ }
+ if (this.isWebSocketOpen()) {
+ this.wsConnection.close();
+ }
+ this.bootNotificationResponse = null;
+ this.hasStopped = true;
}
- async stop(reason = ''): Promise<void> {
- // Stop
- await this._stopMessageSequence(reason);
- // eslint-disable-next-line guard-for-in
- for (const connector in this._connectors) {
- await this.sendStatusNotification(Utils.convertToInt(connector), ChargePointStatus.UNAVAILABLE);
+ public getConfigurationKey(key: string | StandardParametersKey, caseInsensitive = false): ConfigurationKey | undefined {
+ const configurationKey: ConfigurationKey | undefined = this.configuration.configurationKey.find((configElement) => {
+ if (caseInsensitive) {
+ return configElement.key.toLowerCase() === key.toLowerCase();
+ }
+ return configElement.key === key;
+ });
+ return configurationKey;
+ }
+
+ public addConfigurationKey(key: string | StandardParametersKey, value: string, readonly = false, visible = true, reboot = false): void {
+ const keyFound = this.getConfigurationKey(key);
+ if (!keyFound) {
+ this.configuration.configurationKey.push({
+ key,
+ readonly,
+ value,
+ visible,
+ reboot,
+ });
+ } else {
+ logger.error(`${this.logPrefix()} Trying to add an already existing configuration key: %j`, keyFound);
}
- if (this._wsConnection && this._wsConnection.readyState === WebSocket.OPEN) {
- this._wsConnection.close();
+ }
+
+ public setConfigurationKeyValue(key: string | StandardParametersKey, value: string): void {
+ const keyFound = this.getConfigurationKey(key);
+ if (keyFound) {
+ const keyIndex = this.configuration.configurationKey.indexOf(keyFound);
+ this.configuration.configurationKey[keyIndex].value = value;
+ } else {
+ logger.error(`${this.logPrefix()} Trying to set a value on a non existing configuration key: %j`, { key, value });
}
}
- _reconnect(error): void {
- logger.error(this._logPrefix() + ' Socket: abnormally closed', error);
- // Stop the ATG if needed
- if (Utils.convertToBoolean(this._stationInfo.AutomaticTransactionGenerator.enable) &&
- Utils.convertToBoolean(this._stationInfo.AutomaticTransactionGenerator.stopOnConnectionFailure) &&
- this._automaticTransactionGeneration &&
- !this._automaticTransactionGeneration.timeToStop) {
- this._automaticTransactionGeneration.stop();
+ public setChargingProfile(connectorId: number, cp: ChargingProfile): boolean {
+ if (!Utils.isEmptyArray(this.getConnector(connectorId).chargingProfiles)) {
+ this.getConnector(connectorId).chargingProfiles?.forEach((chargingProfile: ChargingProfile, index: number) => {
+ if (chargingProfile.chargingProfileId === cp.chargingProfileId
+ || (chargingProfile.stackLevel === cp.stackLevel && chargingProfile.chargingProfilePurpose === cp.chargingProfilePurpose)) {
+ this.getConnector(connectorId).chargingProfiles[index] = cp;
+ return true;
+ }
+ });
}
- // 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`);
- 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})`);
- }
- }
-
- onOpen(): void {
- logger.info(`${this._logPrefix()} Is connected to server through ${this._wsConnectionUrl}`);
- if (!this._isSocketRestart) {
- // Send BootNotification
- this.sendBootNotification();
- }
- if (this._isSocketRestart) {
- this._startMessageSequence();
- if (!Utils.isEmptyArray(this._messageQueue)) {
- this._messageQueue.forEach((message) => {
- if (this._wsConnection && this._wsConnection.readyState === WebSocket.OPEN) {
- this._wsConnection.send(message);
- }
- });
+ this.getConnector(connectorId).chargingProfiles?.push(cp);
+ return true;
+ }
+
+ public resetTransactionOnConnector(connectorId: number): void {
+ this.getConnector(connectorId).transactionStarted = false;
+ delete this.getConnector(connectorId).transactionId;
+ delete this.getConnector(connectorId).idTag;
+ this.getConnector(connectorId).transactionEnergyActiveImportRegisterValue = 0;
+ delete this.getConnector(connectorId).transactionBeginMeterValue;
+ this.stopMeterValues(connectorId);
+ }
+
+ public addToMessageQueue(message: string): void {
+ let dups = false;
+ // Handle dups in message queue
+ for (const bufferedMessage of this.messageQueue) {
+ // Message already in the queue
+ if (message === bufferedMessage) {
+ dups = true;
+ break;
}
}
- this._autoReconnectRetryCount = 0;
- this._isSocketRestart = false;
+ if (!dups) {
+ // Queue message
+ this.messageQueue.push(message);
+ }
+ }
+
+ private flushMessageQueue() {
+ if (!Utils.isEmptyArray(this.messageQueue)) {
+ this.messageQueue.forEach((message, index) => {
+ this.messageQueue.splice(index, 1);
+ this.wsConnection.send(message);
+ });
+ }
+ }
+
+ private getChargingStationId(stationTemplate: ChargingStationTemplate): string {
+ // In case of multiple instances: add instance index to charging station id
+ let instanceIndex = process.env.CF_INSTANCE_INDEX ?? 0;
+ instanceIndex = instanceIndex > 0 ? instanceIndex : '';
+ const idSuffix = stationTemplate.nameSuffix ?? '';
+ return stationTemplate.fixedName ? stationTemplate.baseName : stationTemplate.baseName + '-' + instanceIndex.toString() + ('000000000' + this.index.toString()).substr(('000000000' + this.index.toString()).length - 4) + idSuffix;
+ }
+
+ private buildStationInfo(): ChargingStationInfo {
+ let stationTemplateFromFile: ChargingStationTemplate;
+ try {
+ // Load template file
+ const fileDescriptor = fs.openSync(this.stationTemplateFile, 'r');
+ stationTemplateFromFile = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as ChargingStationTemplate;
+ fs.closeSync(fileDescriptor);
+ } catch (error) {
+ FileUtils.handleFileException(this.logPrefix(), 'Template', this.stationTemplateFile, error);
+ }
+ const stationInfo: ChargingStationInfo = stationTemplateFromFile ?? {} as ChargingStationInfo;
+ if (!Utils.isEmptyArray(stationTemplateFromFile.power)) {
+ stationTemplateFromFile.power = stationTemplateFromFile.power as number[];
+ const powerArrayRandomIndex = Math.floor(Math.random() * stationTemplateFromFile.power.length);
+ stationInfo.maxPower = stationTemplateFromFile.powerUnit === PowerUnits.KILO_WATT
+ ? stationTemplateFromFile.power[powerArrayRandomIndex] * 1000
+ : stationTemplateFromFile.power[powerArrayRandomIndex];
+ } else {
+ stationTemplateFromFile.power = stationTemplateFromFile.power as number;
+ stationInfo.maxPower = stationTemplateFromFile.powerUnit === PowerUnits.KILO_WATT
+ ? stationTemplateFromFile.power * 1000
+ : stationTemplateFromFile.power;
+ }
+ delete stationInfo.power;
+ delete stationInfo.powerUnit;
+ stationInfo.chargingStationId = this.getChargingStationId(stationTemplateFromFile);
+ stationInfo.resetTime = stationTemplateFromFile.resetTime ? stationTemplateFromFile.resetTime * 1000 : Constants.CHARGING_STATION_DEFAULT_RESET_TIME;
+ return stationInfo;
+ }
+
+ private getOCPPVersion(): OCPPVersion {
+ return this.stationInfo.ocppVersion ? this.stationInfo.ocppVersion : OCPPVersion.VERSION_16;
}
- onError(error): void {
- switch (error) {
- case 'ECONNREFUSED':
- this._isSocketRestart = true;
- this._reconnect(error);
+ private handleUnsupportedVersion(version: OCPPVersion) {
+ const errMsg = `${this.logPrefix()} Unsupported protocol version '${version}' configured in template file ${this.stationTemplateFile}`;
+ logger.error(errMsg);
+ throw new Error(errMsg);
+ }
+
+ private initialize(): void {
+ this.stationInfo = this.buildStationInfo();
+ 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.getTemplateChargingStationConfiguration();
+ this.supervisionUrl = this.getSupervisionURL();
+ this.wsConnectionUrl = this.supervisionUrl + '/' + this.stationInfo.chargingStationId;
+ // Build connectors if needed
+ const maxConnectors = this.getMaxNumberOfConnectors();
+ if (maxConnectors <= 0) {
+ logger.warn(`${this.logPrefix()} Charging station template ${this.stationTemplateFile} with ${maxConnectors} connectors`);
+ }
+ const templateMaxConnectors = this.getTemplateMaxNumberOfConnectors();
+ if (templateMaxConnectors <= 0) {
+ 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) && !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;
+ }
+ const connectorsConfigHash = crypto.createHash('sha256').update(JSON.stringify(this.stationInfo.Connectors) + maxConnectors.toString()).digest('hex');
+ // FIXME: Handle shrinking the number of connectors
+ if (!this.connectors || (this.connectors && this.connectorsConfigurationHash !== connectorsConfigHash)) {
+ this.connectorsConfigurationHash = connectorsConfigHash;
+ // Add connector Id 0
+ let lastConnector = '0';
+ for (lastConnector in this.stationInfo.Connectors) {
+ if (Utils.convertToInt(lastConnector) === 0 && this.getUseConnectorId0() && this.stationInfo.Connectors[lastConnector]) {
+ this.connectors[lastConnector] = Utils.cloneObject<Connector>(this.stationInfo.Connectors[lastConnector]);
+ this.connectors[lastConnector].availability = AvailabilityType.OPERATIVE;
+ if (Utils.isUndefined(this.connectors[lastConnector]?.chargingProfiles)) {
+ this.connectors[lastConnector].chargingProfiles = [];
+ }
+ }
+ }
+ // Generate all connectors
+ if ((this.stationInfo.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) > 0) {
+ for (let index = 1; index <= maxConnectors; index++) {
+ const randConnectorID = this.stationInfo.randomConnectors ? Utils.getRandomInt(Utils.convertToInt(lastConnector), 1) : index;
+ this.connectors[index] = Utils.cloneObject<Connector>(this.stationInfo.Connectors[randConnectorID]);
+ this.connectors[index].availability = AvailabilityType.OPERATIVE;
+ if (Utils.isUndefined(this.connectors[lastConnector]?.chargingProfiles)) {
+ this.connectors[index].chargingProfiles = [];
+ }
+ }
+ }
+ }
+ // Avoid duplication of connectors related information
+ delete this.stationInfo.Connectors;
+ // Initialize transaction attributes on connectors
+ for (const connector in this.connectors) {
+ if (Utils.convertToInt(connector) > 0 && !this.getConnector(Utils.convertToInt(connector)).transactionStarted) {
+ this.initTransactionAttributesOnConnector(Utils.convertToInt(connector));
+ }
+ }
+ switch (this.getOCPPVersion()) {
+ case OCPPVersion.VERSION_16:
+ this.ocppIncomingRequestService = new OCPP16IncomingRequestService(this);
+ this.ocppRequestService = new OCPP16RequestService(this, new OCPP16ResponseService(this));
break;
default:
- logger.error(this._logPrefix() + ' Socket error: ' + error);
+ this.handleUnsupportedVersion(this.getOCPPVersion());
break;
}
+ // OCPP parameters
+ this.initOCPPParameters();
+ this.stationInfo.powerDivider = this.getPowerDivider();
+ if (this.getEnableStatistics()) {
+ this.performanceStatistics = new PerformanceStatistics(this.stationInfo.chargingStationId);
+ this.performanceObserver = new PerformanceObserver((list) => {
+ const entry = list.getEntries()[0];
+ this.performanceStatistics.logPerformance(entry, Constants.ENTITY_CHARGING_STATION);
+ this.performanceObserver.disconnect();
+ });
+ }
+ }
+
+ private initOCPPParameters(): void {
+ if (!this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles)) {
+ this.addConfigurationKey(StandardParametersKey.SupportedFeatureProfiles, `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.Local_Auth_List_Management},${SupportedFeatureProfiles.Smart_Charging}`);
+ }
+ this.addConfigurationKey(StandardParametersKey.NumberOfConnectors, this.getNumberOfConnectors().toString(), true);
+ if (!this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData)) {
+ this.addConfigurationKey(StandardParametersKey.MeterValuesSampledData, MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER);
+ }
+ if (!this.getConfigurationKey(StandardParametersKey.ConnectorPhaseRotation)) {
+ const connectorPhaseRotation = [];
+ for (const connector in this.connectors) {
+ // AC/DC
+ if (Utils.convertToInt(connector) === 0 && this.getNumberOfPhases() === 0) {
+ connectorPhaseRotation.push(`${connector}.${ConnectorPhaseRotation.RST}`);
+ } else if (Utils.convertToInt(connector) > 0 && this.getNumberOfPhases() === 0) {
+ connectorPhaseRotation.push(`${connector}.${ConnectorPhaseRotation.NotApplicable}`);
+ // AC
+ } else if (Utils.convertToInt(connector) > 0 && this.getNumberOfPhases() === 1) {
+ connectorPhaseRotation.push(`${connector}.${ConnectorPhaseRotation.NotApplicable}`);
+ } else if (Utils.convertToInt(connector) > 0 && this.getNumberOfPhases() === 3) {
+ connectorPhaseRotation.push(`${connector}.${ConnectorPhaseRotation.RST}`);
+ }
+ }
+ this.addConfigurationKey(StandardParametersKey.ConnectorPhaseRotation, connectorPhaseRotation.toString());
+ }
+ if (!this.getConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests)) {
+ this.addConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests, 'true');
+ }
+ if (!this.getConfigurationKey(StandardParametersKey.LocalAuthListEnabled)
+ && this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles).value.includes(SupportedFeatureProfiles.Local_Auth_List_Management)) {
+ this.addConfigurationKey(StandardParametersKey.LocalAuthListEnabled, 'false');
+ }
+ if (!this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) {
+ this.addConfigurationKey(StandardParametersKey.ConnectionTimeOut, Constants.DEFAULT_CONNECTION_TIMEOUT.toString());
+ }
+ }
+
+ private async onOpen(): Promise<void> {
+ logger.info(`${this.logPrefix()} Is connected to server through ${this.wsConnectionUrl}`);
+ if (!this.isRegistered()) {
+ // Send BootNotification
+ let registrationRetryCount = 0;
+ do {
+ this.bootNotificationResponse = await this.ocppRequestService.sendBootNotification(this.bootNotificationRequest.chargePointModel,
+ this.bootNotificationRequest.chargePointVendor, this.bootNotificationRequest.chargeBoxSerialNumber, this.bootNotificationRequest.firmwareVersion);
+ if (!this.isRegistered()) {
+ registrationRetryCount++;
+ await Utils.sleep(this.bootNotificationResponse?.interval ? this.bootNotificationResponse.interval * 1000 : Constants.OCPP_DEFAULT_BOOT_NOTIFICATION_INTERVAL);
+ }
+ } while (!this.isRegistered() && (registrationRetryCount <= this.getRegistrationMaxRetries() || this.getRegistrationMaxRetries() === -1));
+ }
+ if (this.isRegistered()) {
+ await this.startMessageSequence();
+ this.hasStopped && (this.hasStopped = false);
+ if (this.hasSocketRestarted && this.isWebSocketOpen()) {
+ this.flushMessageQueue();
+ }
+ } else {
+ logger.error(`${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})`);
+ }
+ this.autoReconnectRetryCount = 0;
+ this.hasSocketRestarted = false;
}
- onClose(error): void {
- switch (error) {
- case 1000: // Normal close
- case 1005:
- logger.info(this._logPrefix() + ' Socket normally closed ' + error);
- this._autoReconnectRetryCount = 0;
+ private async onClose(closeEvent: any): Promise<void> {
+ switch (closeEvent) {
+ case WebSocketCloseEventStatusCode.CLOSE_NORMAL: // Normal close
+ case WebSocketCloseEventStatusCode.CLOSE_NO_STATUS:
+ logger.info(`${this.logPrefix()} Socket normally closed with status '${Utils.getWebSocketCloseEventStatusString(closeEvent)}'`);
+ this.autoReconnectRetryCount = 0;
break;
default: // Abnormal close
- this._isSocketRestart = true;
- this._reconnect(error);
+ logger.error(`${this.logPrefix()} Socket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString(closeEvent)}'`);
+ await this.reconnect(closeEvent);
break;
}
}
- onPing(): void {
- logger.debug(this._logPrefix() + ' Has received a WS ping (rfc6455) from the server');
- }
-
- async onMessage(message): Promise<void> {
- let [messageType, messageId, commandName, commandPayload, errorDetails] = [0, '', Constants.ENTITY_CHARGING_STATION, '', ''];
+ private async onMessage(messageEvent: MessageEvent): Promise<void> {
+ let [messageType, messageId, commandName, commandPayload, errorDetails]: IncomingRequest = [0, '', '' as IncomingRequestCommand, {}, {}];
+ let responseCallback: (payload: Record<string, unknown> | string, requestPayload: Record<string, unknown>) => void;
+ let rejectCallback: (error: OCPPError) => void;
+ let requestPayload: Record<string, unknown>;
+ let errMsg: string;
try {
// Parse the message
- [messageType, messageId, commandName, commandPayload, errorDetails] = JSON.parse(message);
-
+ [messageType, messageId, commandName, commandPayload, errorDetails] = JSON.parse(messageEvent.toString()) as IncomingRequest;
// Check the Type of message
switch (messageType) {
// Incoming Message
- case Constants.OCPP_JSON_CALL_MESSAGE:
+ case MessageType.CALL_MESSAGE:
if (this.getEnableStatistics()) {
- this._statistics.addMessage(commandName, messageType);
+ this.performanceStatistics.addMessage(commandName, messageType);
}
// Process the call
- await this.handleRequest(messageId, commandName, commandPayload);
+ await this.ocppIncomingRequestService.handleRequest(messageId, commandName, commandPayload);
break;
// Outcome Message
- case Constants.OCPP_JSON_CALL_RESULT_MESSAGE:
+ case MessageType.CALL_RESULT_MESSAGE:
// Respond
- // eslint-disable-next-line no-case-declarations
- let responseCallback; let requestPayload;
- if (Utils.isIterable(this._requests[messageId])) {
- [responseCallback, , requestPayload] = this._requests[messageId];
+ if (Utils.isIterable(this.requests[messageId])) {
+ [responseCallback, , requestPayload] = this.requests[messageId];
} else {
throw new Error(`Response request for message id ${messageId} is not iterable`);
}
// Error
throw new Error(`Response request for unknown message id ${messageId}`);
}
- delete this._requests[messageId];
+ delete this.requests[messageId];
responseCallback(commandName, requestPayload);
break;
// Error Message
- case Constants.OCPP_JSON_CALL_ERROR_MESSAGE:
- if (!this._requests[messageId]) {
+ case MessageType.CALL_ERROR_MESSAGE:
+ if (!this.requests[messageId]) {
// Error
throw new Error(`Error request for unknown message id ${messageId}`);
}
- // eslint-disable-next-line no-case-declarations
- let rejectCallback;
- if (Utils.isIterable(this._requests[messageId])) {
- [, rejectCallback] = this._requests[messageId];
+ if (Utils.isIterable(this.requests[messageId])) {
+ [, rejectCallback] = this.requests[messageId];
} else {
throw new Error(`Error request for message id ${messageId} is not iterable`);
}
- delete this._requests[messageId];
- rejectCallback(new OCPPError(commandName, commandPayload, errorDetails));
+ delete this.requests[messageId];
+ rejectCallback(new OCPPError(commandName, commandPayload.toString(), errorDetails));
break;
// Error
default:
- // eslint-disable-next-line no-case-declarations
- const errMsg = `${this._logPrefix()} Wrong message type ${messageType}`;
+ errMsg = `${this.logPrefix()} Wrong message type ${messageType}`;
logger.error(errMsg);
throw new Error(errMsg);
}
} 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 %j on request content type %j', this.logPrefix(), messageEvent, error, this.requests[messageId]);
// Send error
- await this.sendError(messageId, error, commandName);
+ messageType !== MessageType.CALL_ERROR_MESSAGE && await this.ocppRequestService.sendError(messageId, error, commandName);
}
}
- async sendHeartbeat(): Promise<void> {
- try {
- const payload = {
- currentTime: new Date().toISOString(),
- };
- await this.sendMessage(Utils.generateUUID(), payload, Constants.OCPP_JSON_CALL_MESSAGE, 'Heartbeat');
- } catch (error) {
- logger.error(this._logPrefix() + ' Send Heartbeat error: ' + error);
- throw error;
- }
+ private onPing(): void {
+ logger.debug(this.logPrefix() + ' Has received a WS ping (rfc6455) from the server');
}
- async sendBootNotification(): Promise<void> {
- try {
- await this.sendMessage(Utils.generateUUID(), this._bootNotificationMessage, Constants.OCPP_JSON_CALL_MESSAGE, 'BootNotification');
- } catch (error) {
- logger.error(this._logPrefix() + ' Send BootNotification error: ' + error);
- throw error;
- }
+ private onPong(): void {
+ logger.debug(this.logPrefix() + ' Has received a WS pong (rfc6455) from the server');
}
- async sendStatusNotification(connectorId: number, status: ChargePointStatus, errorCode: ChargePointErrorCode = ChargePointErrorCode.NO_ERROR): Promise<void> {
- this.getConnector(connectorId).status = status;
- try {
- const payload = {
- 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);
- throw error;
- }
+ private async onError(errorEvent: any): Promise<void> {
+ logger.error(this.logPrefix() + ' Socket error: %j', errorEvent);
+ // switch (errorEvent.code) {
+ // case 'ECONNREFUSED':
+ // await this._reconnect(errorEvent);
+ // break;
+ // }
}
- async sendStartTransaction(connectorId: number, idTag?: string): Promise<unknown> {
- try {
- const payload = {
- connectorId,
- ...!Utils.isUndefined(idTag) ? { idTag } : { idTag: '' },
- meterStart: 0,
- timestamp: new Date().toISOString(),
- };
- return await this.sendMessage(Utils.generateUUID(), payload, Constants.OCPP_JSON_CALL_MESSAGE, 'StartTransaction');
- } catch (error) {
- logger.error(this._logPrefix() + ' Send StartTransaction error: ' + error);
- throw error;
- }
+ private getTemplateChargingStationConfiguration(): ChargingStationConfiguration {
+ return this.stationInfo.Configuration ? this.stationInfo.Configuration : {} as ChargingStationConfiguration;
}
- async sendStopTransaction(transactionId: number, reason = ''): Promise<void> {
- try {
- const payload = {
- transactionId,
- meterStop: 0,
- timestamp: new Date().toISOString(),
- ...reason && { reason },
- };
- await this.sendMessage(Utils.generateUUID(), payload, Constants.OCPP_JSON_CALL_MESSAGE, 'StopTransaction');
- } catch (error) {
- logger.error(this._logPrefix() + ' Send StopTransaction error: ' + error);
- throw error;
- }
+ private getAuthorizationFile(): string | undefined {
+ return this.stationInfo.authorizationFile && path.join(path.resolve(__dirname, '../'), 'assets', path.basename(this.stationInfo.authorizationFile));
}
- // eslint-disable-next-line consistent-this
- async sendMeterValues(connectorId: number, interval: number, self: ChargingStation, debug = false): Promise<void> {
- try {
- const sampledValues: {
- timestamp: string;
- sampledValue: MeterValue[];
- } = {
- timestamp: new Date().toISOString(),
- sampledValue: [],
- };
- const meterValuesTemplate = 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 === MeterValueMeasurand.STATE_OF_CHARGE && self._getConfigurationKey('MeterValuesSampledData').value.includes(MeterValueMeasurand.STATE_OF_CHARGE)) {
- sampledValues.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: MeterValueLocation.EV },
- ...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } : { value: Utils.getRandomInt(100).toString() },
- });
- const sampledValuesIndex = sampledValues.sampledValue.length - 1;
- if (Utils.convertToInt(sampledValues.sampledValue[sampledValuesIndex].value) > 100 || debug) {
- logger.error(`${self._logPrefix()} MeterValues measurand ${sampledValues.sampledValue[sampledValuesIndex].measurand ? sampledValues.sampledValue[sampledValuesIndex].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: connectorId ${connectorId}, transaction ${connector.transactionId}, value: ${sampledValues.sampledValue[sampledValuesIndex].value}/100`);
- }
- // Voltage measurand
- } 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: 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.toString() },
- });
- for (let phase = 1; self._getNumberOfPhases() === 3 && phase <= self._getNumberOfPhases(); phase++) {
- const voltageValue = Utils.convertToInt(sampledValues.sampledValue[sampledValues.sampledValue.length - 1].value);
- let phaseValue: string;
- if (voltageValue >= 0 && voltageValue <= 250) {
- phaseValue = `L${phase}-N`;
- } else if (voltageValue > 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: 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.toString() },
- phase: phaseValue as MeterValuePhase,
- });
- }
- // 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)) {
- // 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`;
- 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 : 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 : 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':
- if (Utils.isUndefined(meterValuesTemplate[index].value)) {
- powerMeasurandValues.L1 = Utils.getRandomFloatRounded(maxPowerPerPhase);
- powerMeasurandValues.L2 = 0;
- powerMeasurandValues.L3 = 0;
- if (self._getNumberOfPhases() === 3) {
- powerMeasurandValues.L2 = Utils.getRandomFloatRounded(maxPowerPerPhase);
- powerMeasurandValues.L3 = Utils.getRandomFloatRounded(maxPowerPerPhase);
- }
- powerMeasurandValues.allPhases = Utils.roundTo(powerMeasurandValues.L1 + powerMeasurandValues.L2 + powerMeasurandValues.L3, 2);
- }
- break;
- case 'DC':
- if (Utils.isUndefined(meterValuesTemplate[index].value)) {
- 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: 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.allPhases.toString() },
- });
- const sampledValuesIndex = sampledValues.sampledValue.length - 1;
- if (Utils.convertToFloat(sampledValues.sampledValue[sampledValuesIndex].value) > maxPower || debug) {
- logger.error(`${self._logPrefix()} MeterValues measurand ${sampledValues.sampledValue[sampledValuesIndex].measurand ? sampledValues.sampledValue[sampledValuesIndex].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: connectorId ${connectorId}, transaction ${connector.transactionId}, value: ${sampledValues.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: 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 as MeterValuePhase,
- });
- }
- // Current.Import measurand
- } 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 : 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 : 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 : 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;
- let maxAmperage: number;
- switch (self._getPowerOutType()) {
- case '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);
- currentMeasurandValues.L2 = 0;
- currentMeasurandValues.L3 = 0;
- if (self._getNumberOfPhases() === 3) {
- currentMeasurandValues.L2 = Utils.getRandomFloatRounded(maxAmperage);
- currentMeasurandValues.L3 = Utils.getRandomFloatRounded(maxAmperage);
- }
- currentMeasurandValues.allPhases = Utils.roundTo((currentMeasurandValues.L1 + currentMeasurandValues.L2 + currentMeasurandValues.L3) / self._getNumberOfPhases(), 2);
- }
- break;
- case 'DC':
- maxAmperage = ElectricUtils.ampTotalFromPower(self._stationInfo.maxPower / self._stationInfo.powerDivider, self._getVoltageOut());
- if (Utils.isUndefined(meterValuesTemplate[index].value)) {
- 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: 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.allPhases.toString() },
- });
- const sampledValuesIndex = sampledValues.sampledValue.length - 1;
- if (Utils.convertToFloat(sampledValues.sampledValue[sampledValuesIndex].value) > maxAmperage || debug) {
- logger.error(`${self._logPrefix()} MeterValues measurand ${sampledValues.sampledValue[sampledValuesIndex].measurand ? sampledValues.sampledValue[sampledValuesIndex].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: connectorId ${connectorId}, transaction ${connector.transactionId}, value: ${sampledValues.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: 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 as MeterValuePhase,
- });
- }
- // Energy.Active.Import.Register measurand (default)
- } 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 : 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 : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: powerDivider have zero or below value ${self._stationInfo.powerDivider}`;
- logger.error(errMsg);
- throw Error(errMsg);
- }
- if (Utils.isUndefined(meterValuesTemplate[index].value)) {
- const measurandValue = Utils.getRandomInt(self._stationInfo.maxPower / (self._stationInfo.powerDivider * 3600000) * interval);
- // Persist previous value in connector
- if (connector && !Utils.isNullOrUndefined(connector.lastEnergyActiveImportRegisterValue) && connector.lastEnergyActiveImportRegisterValue >= 0) {
- connector.lastEnergyActiveImportRegisterValue += measurandValue;
- } else {
- connector.lastEnergyActiveImportRegisterValue = 0;
- }
- }
- sampledValues.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.toString() },
- });
- const sampledValuesIndex = sampledValues.sampledValue.length - 1;
- const maxConsumption = Math.round(self._stationInfo.maxPower * 3600 / (self._stationInfo.powerDivider * interval));
- if (Utils.convertToFloat(sampledValues.sampledValue[sampledValuesIndex].value) > maxConsumption || debug) {
- logger.error(`${self._logPrefix()} MeterValues measurand ${sampledValues.sampledValue[sampledValuesIndex].measurand ? sampledValues.sampledValue[sampledValuesIndex].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: connectorId ${connectorId}, transaction ${connector.transactionId}, value: ${sampledValues.sampledValue[sampledValuesIndex].value}/${maxConsumption}`);
- }
- // Unsupported measurand
- } else {
- logger.info(`${self._logPrefix()} Unsupported MeterValues measurand ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER} on connectorId ${connectorId}`);
- }
+ private getAuthorizedTags(): string[] {
+ let authorizedTags: string[] = [];
+ const authorizationFile = this.getAuthorizationFile();
+ if (authorizationFile) {
+ try {
+ // Load authorization file
+ const fileDescriptor = fs.openSync(authorizationFile, 'r');
+ authorizedTags = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as string[];
+ fs.closeSync(fileDescriptor);
+ } catch (error) {
+ FileUtils.handleFileException(this.logPrefix(), 'Authorization', authorizationFile, error);
}
-
- const payload = {
- connectorId,
- transactionId: self.getConnector(connectorId).transactionId,
- meterValue: sampledValues,
- };
- await self.sendMessage(Utils.generateUUID(), payload, Constants.OCPP_JSON_CALL_MESSAGE, 'MeterValues');
- } catch (error) {
- logger.error(self._logPrefix() + ' Send MeterValues error: ' + error);
- throw error;
+ } else {
+ logger.info(this.logPrefix() + ' No authorization file given in template file ' + this.stationTemplateFile);
}
+ return authorizedTags;
}
- async sendError(messageId, err: Error | OCPPError, commandName): Promise<unknown> {
- // 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);
+ private getUseConnectorId0(): boolean | undefined {
+ return !Utils.isUndefined(this.stationInfo.useConnectorId0) ? this.stationInfo.useConnectorId0 : true;
}
- async sendMessage(messageId, commandParams, messageType = Constants.OCPP_JSON_CALL_RESULT_MESSAGE, commandName: string): Promise<unknown> {
- // eslint-disable-next-line @typescript-eslint/no-this-alias
- const self = this;
- // Send a message through wsConnection
- return new Promise((resolve, reject) => {
- let messageToSend;
- // Type of message
- switch (messageType) {
- // Request
- case Constants.OCPP_JSON_CALL_MESSAGE:
- // Build request
- this._requests[messageId] = [responseCallback, rejectCallback, commandParams];
- messageToSend = JSON.stringify([messageType, messageId, commandName, commandParams]);
- break;
- // Response
- case Constants.OCPP_JSON_CALL_RESULT_MESSAGE:
- // Build response
- messageToSend = JSON.stringify([messageType, messageId, commandParams]);
- break;
- // Error Message
- case Constants.OCPP_JSON_CALL_ERROR_MESSAGE:
- // Build Error Message
- messageToSend = JSON.stringify([messageType, messageId, commandParams.code ? commandParams.code : Constants.OCPP_ERROR_GENERIC_ERROR, commandParams.message ? commandParams.message : '', commandParams.details ? commandParams.details : {}]);
- break;
- }
- // Check if wsConnection is ready
- if (this._wsConnection && this._wsConnection.readyState === WebSocket.OPEN) {
- if (this.getEnableStatistics()) {
- this._statistics.addMessage(commandName, messageType);
- }
- // Yes: Send Message
- this._wsConnection.send(messageToSend);
- } else {
- let dups = false;
- // Handle dups in buffer
- for (const message of this._messageQueue) {
- // Same message
- if (JSON.stringify(messageToSend) === JSON.stringify(message)) {
- dups = true;
- break;
- }
- }
- if (!dups) {
- // Buffer message
- 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 : {}));
- }
- // Response?
- if (messageType === Constants.OCPP_JSON_CALL_RESULT_MESSAGE) {
- // Yes: send Ok
- resolve();
- } else if (messageType === Constants.OCPP_JSON_CALL_ERROR_MESSAGE) {
- // Send timeout
- setTimeout(() => rejectCallback(new OCPPError(commandParams.code ? commandParams.code : Constants.OCPP_ERROR_GENERIC_ERROR, commandParams.message ? commandParams.message : `Timeout for message id '${messageId}' with content '${messageToSend}'`, commandParams.details ? commandParams.details : {})), Constants.OCPP_SOCKET_TIMEOUT);
+ private getNumberOfRunningTransactions(): number {
+ let trxCount = 0;
+ for (const connector in this.connectors) {
+ if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionStarted) {
+ trxCount++;
}
+ }
+ return trxCount;
+ }
- // Function that will receive the request's response
- function responseCallback(payload, requestPayload): void {
- if (self.getEnableStatistics()) {
- self._statistics.addMessage(commandName, messageType);
- }
- // Send the response
- self.handleResponse(commandName, payload, requestPayload);
- resolve(payload);
- }
+ // 0 for disabling
+ private getConnectionTimeout(): number | undefined {
+ if (this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) {
+ return parseInt(this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut).value) ?? Constants.DEFAULT_CONNECTION_TIMEOUT;
+ }
+ return Constants.DEFAULT_CONNECTION_TIMEOUT;
+ }
- // Function that will receive the request's rejection
- function rejectCallback(error: OCPPError): void {
- 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);
- // Build Exception
- // eslint-disable-next-line no-empty-function
- self._requests[messageId] = [() => { }, () => { }, '']; // Properly format the request
- // Send error
- reject(error);
- }
- });
+ // -1 for unlimited, 0 for disabling
+ private getAutoReconnectMaxRetries(): number | undefined {
+ if (!Utils.isUndefined(this.stationInfo.autoReconnectMaxRetries)) {
+ return this.stationInfo.autoReconnectMaxRetries;
+ }
+ if (!Utils.isUndefined(Configuration.getAutoReconnectMaxRetries())) {
+ return Configuration.getAutoReconnectMaxRetries();
+ }
+ return -1;
}
- handleResponse(commandName: string, payload, requestPayload): void {
- const responseCallbackFn = 'handleResponse' + commandName;
- if (typeof this[responseCallbackFn] === 'function') {
- this[responseCallbackFn](payload, requestPayload);
- } else {
- logger.error(this._logPrefix() + ' Trying to call an undefined response callback function: ' + responseCallbackFn);
+ // 0 for disabling
+ private getRegistrationMaxRetries(): number | undefined {
+ if (!Utils.isUndefined(this.stationInfo.registrationMaxRetries)) {
+ return this.stationInfo.registrationMaxRetries;
}
+ return -1;
}
- handleResponseBootNotification(payload, requestPayload): void {
- if (payload.status === 'Accepted') {
- this._heartbeatInterval = payload.interval * 1000;
- this._addConfigurationKey('HeartBeatInterval', payload.interval);
- this._addConfigurationKey('HeartbeatInterval', payload.interval, false, false);
- this._startMessageSequence();
- } else if (payload.status === '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');
+ private getPowerDivider(): number {
+ let powerDivider = this.getNumberOfConnectors();
+ if (this.stationInfo.powerSharedByConnectors) {
+ powerDivider = this.getNumberOfRunningTransactions();
}
+ return powerDivider;
}
- _initTransactionOnConnector(connectorId: number): void {
- this.getConnector(connectorId).transactionStarted = false;
- this.getConnector(connectorId).transactionId = null;
- this.getConnector(connectorId).idTag = null;
- this.getConnector(connectorId).lastEnergyActiveImportRegisterValue = -1;
+ private getTemplateMaxNumberOfConnectors(): number {
+ return Object.keys(this.stationInfo.Connectors).length;
}
- _resetTransactionOnConnector(connectorId: number): void {
- this._initTransactionOnConnector(connectorId);
- if (this.getConnector(connectorId).transactionSetInterval) {
- clearInterval(this.getConnector(connectorId).transactionSetInterval);
+ private 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 = numberOfConnectors[(this.index - 1) % numberOfConnectors.length];
+ } else if (!Utils.isUndefined(this.stationInfo.numberOfConnectors)) {
+ maxConnectors = this.stationInfo.numberOfConnectors as number;
+ } else {
+ maxConnectors = this.stationInfo.Connectors[0] ? this.getTemplateMaxNumberOfConnectors() - 1 : this.getTemplateMaxNumberOfConnectors();
}
+ return maxConnectors;
}
- 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));
- return;
- }
+ private getNumberOfConnectors(): number {
+ return this.connectors[0] ? Object.keys(this.connectors).length - 1 : Object.keys(this.connectors).length;
+ }
- let transactionConnectorId;
- for (const connector in this._connectors) {
- if (Utils.convertToInt(connector) === Utils.convertToInt(requestPayload.connectorId)) {
- transactionConnectorId = connector;
- break;
+ private async startMessageSequence(): Promise<void> {
+ // Start WebSocket ping
+ this.startWebSocketPing();
+ // Start heartbeat
+ this.startHeartbeat();
+ // Initialize connectors status
+ for (const connector in this.connectors) {
+ 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.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).bootStatus);
+ this.getConnector(Utils.convertToInt(connector)).status = this.getConnector(Utils.convertToInt(connector)).bootStatus;
+ } else if (this.hasStopped && this.getConnector(Utils.convertToInt(connector))?.bootStatus) {
+ // Send status in template after reset
+ await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).bootStatus);
+ this.getConnector(Utils.convertToInt(connector)).status = this.getConnector(Utils.convertToInt(connector)).bootStatus;
+ } else if (!this.hasStopped && this.getConnector(Utils.convertToInt(connector))?.status) {
+ // Send previous status at template reload
+ await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).status);
+ } else {
+ // Send default status
+ await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), ChargePointStatus.AVAILABLE);
+ this.getConnector(Utils.convertToInt(connector)).status = ChargePointStatus.AVAILABLE;
}
}
- if (!transactionConnectorId) {
- logger.error(this._logPrefix() + ' Try to start a transaction on a non existing connector Id ' + requestPayload.connectorId);
- 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 (this._stationInfo.powerSharedByConnectors) {
- this._stationInfo.powerDivider++;
- }
- const configuredMeterValueSampleInterval = this._getConfigurationKey('MeterValueSampleInterval');
- this._startMeterValues(requestPayload.connectorId,
- configuredMeterValueSampleInterval ? 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);
+ // Start the ATG
+ this.startAutomaticTransactionGenerator();
+ if (this.getEnableStatistics()) {
+ this.performanceStatistics.start();
}
}
- handleResponseStopTransaction(payload, requestPayload): void {
- let transactionConnectorId;
- for (const connector in this._connectors) {
- if (this.getConnector(Utils.convertToInt(connector)).transactionId === requestPayload.transactionId) {
- transactionConnectorId = connector;
- break;
+ private startAutomaticTransactionGenerator() {
+ if (this.stationInfo.AutomaticTransactionGenerator.enable) {
+ if (!this.automaticTransactionGeneration) {
+ this.automaticTransactionGeneration = new AutomaticTransactionGenerator(this);
}
- }
- if (!transactionConnectorId) {
- logger.error(this._logPrefix() + ' Try to stop a non existing transaction ' + requestPayload.transactionId);
- return;
- }
- if (payload.idTagInfo && payload.idTagInfo.status === 'Accepted') {
- this.sendStatusNotification(transactionConnectorId, ChargePointStatus.AVAILABLE);
- if (this._stationInfo.powerSharedByConnectors) {
- this._stationInfo.powerDivider--;
+ if (this.automaticTransactionGeneration.timeToStop) {
+ // The ATG might sleep
+ void this.automaticTransactionGeneration.start();
}
- logger.info(this._logPrefix() + ' Transaction ' + requestPayload.transactionId + ' STOPPED on ' + this._stationInfo.name + '#' + transactionConnectorId);
- this._resetTransactionOnConnector(transactionConnectorId);
- } else {
- logger.error(this._logPrefix() + ' Stopping transaction id ' + requestPayload.transactionId + ' REJECTED with status ' + payload.idTagInfo.status);
}
}
- handleResponseStatusNotification(payload, requestPayload): void {
- logger.debug(this._logPrefix() + ' Status notification response received: %j to StatusNotification request: %j', payload, requestPayload);
+ private async stopMessageSequence(reason: StopTransactionReason = StopTransactionReason.NONE): Promise<void> {
+ // Stop WebSocket ping
+ this.stopWebSocketPing();
+ // Stop heartbeat
+ this.stopHeartbeat();
+ // Stop the ATG
+ if (this.stationInfo.AutomaticTransactionGenerator.enable &&
+ this.automaticTransactionGeneration &&
+ !this.automaticTransactionGeneration.timeToStop) {
+ await this.automaticTransactionGeneration.stop(reason);
+ } else {
+ for (const connector in this.connectors) {
+ if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionStarted) {
+ const transactionId = this.getConnector(Utils.convertToInt(connector)).transactionId;
+ await this.ocppRequestService.sendStopTransaction(transactionId, this.getEnergyActiveImportRegisterByTransactionId(transactionId),
+ this.getTransactionIdTag(transactionId), reason);
+ }
+ }
+ }
}
- handleResponseMeterValues(payload, requestPayload): void {
- logger.debug(this._logPrefix() + ' MeterValues response received: %j to MeterValues request: %j', payload, requestPayload);
+ private startWebSocketPing(): void {
+ const webSocketPingInterval: number = this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval)
+ ? Utils.convertToInt(this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval).value)
+ : 0;
+ if (webSocketPingInterval > 0 && !this.webSocketPingSetInterval) {
+ this.webSocketPingSetInterval = setInterval(() => {
+ if (this.isWebSocketOpen()) {
+ 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`);
+ }
}
- handleResponseHeartbeat(payload, requestPayload): void {
- logger.debug(this._logPrefix() + ' Heartbeat response received: %j to Heartbeat request: %j', payload, requestPayload);
+ private stopWebSocketPing(): void {
+ if (this.webSocketPingSetInterval) {
+ clearInterval(this.webSocketPingSetInterval);
+ }
}
- async handleRequest(messageId, commandName, commandPayload): Promise<void> {
- let response;
- // Call
- if (typeof this['handleRequest' + commandName] === 'function') {
- try {
- // Call the method to build the response
- response = await this['handleRequest' + commandName](commandPayload);
- } catch (error) {
- // Log
- logger.error(this._logPrefix() + ' Handle request error: ' + error);
- // Send back response to inform backend
- await this.sendError(messageId, error, commandName);
- throw error;
+ private getSupervisionURL(): string {
+ const supervisionUrls = Utils.cloneObject<string | string[]>(this.stationInfo.supervisionURL ? this.stationInfo.supervisionURL : Configuration.getSupervisionURLs());
+ let indexUrl = 0;
+ if (!Utils.isEmptyArray(supervisionUrls)) {
+ if (Configuration.getDistributeStationsToTenantsEqually()) {
+ indexUrl = this.index % supervisionUrls.length;
+ } else {
+ // Get a random url
+ indexUrl = Math.floor(Math.random() * supervisionUrls.length);
}
- } else {
- // Throw exception
- await this.sendError(messageId, new OCPPError(Constants.OCPP_ERROR_NOT_IMPLEMENTED, `${commandName} is not implemented`, {}), commandName);
- throw new Error(`${commandName} is not implemented ${JSON.stringify(commandPayload, null, ' ')}`);
+ return supervisionUrls[indexUrl];
}
- // Send response
- await this.sendMessage(messageId, response, Constants.OCPP_JSON_CALL_RESULT_MESSAGE, commandName);
+ return supervisionUrls as string;
}
- // Simulate charging station restart
- handleRequestReset(commandPayload) {
- setImmediate(async () => {
- await this.stop(commandPayload.type + 'Reset');
- 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`);
- return Constants.OCPP_RESPONSE_ACCEPTED;
+ private getHeartbeatInterval(): number | undefined {
+ const HeartbeatInterval = this.getConfigurationKey(StandardParametersKey.HeartbeatInterval);
+ if (HeartbeatInterval) {
+ return Utils.convertToInt(HeartbeatInterval.value) * 1000;
+ }
+ const HeartBeatInterval = this.getConfigurationKey(StandardParametersKey.HeartBeatInterval);
+ if (HeartBeatInterval) {
+ return Utils.convertToInt(HeartBeatInterval.value) * 1000;
+ }
}
- _getConfigurationKey(key: string) {
- return this._configuration.configurationKey.find((configElement) => configElement.key === key);
+ private stopHeartbeat(): void {
+ if (this.heartbeatSetInterval) {
+ clearInterval(this.heartbeatSetInterval);
+ }
}
- _addConfigurationKey(key: string, value: string, readonly = false, visible = true, reboot = false): void {
- const keyFound = this._getConfigurationKey(key);
- if (!keyFound) {
- this._configuration.configurationKey.push({
- key,
- readonly,
- value,
- visible,
- reboot,
- });
+ private openWSConnection(options?: WebSocket.ClientOptions, forceCloseOpened = false): void {
+ options ?? {} as WebSocket.ClientOptions;
+ options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000;
+ if (this.isWebSocketOpen() && forceCloseOpened) {
+ this.wsConnection.close();
}
+ let protocol;
+ switch (this.getOCPPVersion()) {
+ case OCPPVersion.VERSION_16:
+ protocol = 'ocpp' + OCPPVersion.VERSION_16;
+ break;
+ default:
+ this.handleUnsupportedVersion(this.getOCPPVersion());
+ break;
+ }
+ this.wsConnection = new WebSocket(this.wsConnectionUrl, protocol, options);
+ logger.info(this.logPrefix() + ' Will communicate through URL ' + this.supervisionUrl);
}
- _setConfigurationKeyValue(key: string, value: string): void {
- const keyFound = this._getConfigurationKey(key);
- if (keyFound) {
- const keyIndex = this._configuration.configurationKey.indexOf(keyFound);
- this._configuration.configurationKey[keyIndex].value = value;
+ private stopMeterValues(connectorId: number) {
+ if (this.getConnector(connectorId)?.transactionSetInterval) {
+ clearInterval(this.getConnector(connectorId).transactionSetInterval);
}
}
- handleRequestGetConfiguration(commandPayload) {
- const configurationKey = [];
- const unknownKey = [];
- 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;
- }
- configurationKey.push({
- key: configuration.key,
- readonly: configuration.readonly,
- value: configuration.value,
+ private startAuthorizationFileMonitoring(): void {
+ const authorizationFile = this.getAuthorizationFile();
+ if (authorizationFile) {
+ try {
+ fs.watch(authorizationFile).on('change', () => {
+ try {
+ logger.debug(this.logPrefix() + ' Authorization file ' + authorizationFile + ' have changed, reload');
+ // Initialize authorizedTags
+ this.authorizedTags = this.getAuthorizedTags();
+ } catch (error) {
+ logger.error(this.logPrefix() + ' Authorization file monitoring error: %j', error);
+ }
});
+ } catch (error) {
+ FileUtils.handleFileException(this.logPrefix(), 'Authorization', authorizationFile, error);
}
} else {
- for (const configurationKey of commandPayload.key) {
- const keyFound = this._getConfigurationKey(configurationKey);
- if (keyFound) {
- if (Utils.isUndefined(keyFound.visible)) {
- keyFound.visible = true;
- } else {
- keyFound.visible = Utils.convertToBoolean(configurationKey.visible);
- }
- if (!keyFound.visible) {
- continue;
+ logger.info(this.logPrefix() + ' No authorization file given in template file ' + this.stationTemplateFile + '. Not monitoring changes');
+ }
+ }
+
+ private startStationTemplateFileMonitoring(): void {
+ try {
+ // eslint-disable-next-line @typescript-eslint/no-misused-promises
+ fs.watch(this.stationTemplateFile).on('change', async (): Promise<void> => {
+ try {
+ logger.debug(this.logPrefix() + ' Template file ' + this.stationTemplateFile + ' have changed, reload');
+ // Initialize
+ this.initialize();
+ // Stop the ATG
+ if (!this.stationInfo.AutomaticTransactionGenerator.enable &&
+ this.automaticTransactionGeneration) {
+ await this.automaticTransactionGeneration.stop();
}
- configurationKey.push({
- key: keyFound.key,
- readonly: keyFound.readonly,
- value: keyFound.value,
- });
- } else {
- unknownKey.push(configurationKey);
+ // Start the ATG
+ this.startAutomaticTransactionGenerator();
+ // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed
+ } catch (error) {
+ logger.error(this.logPrefix() + ' Charging station template file monitoring error: %j', error);
}
- }
+ });
+ } catch (error) {
+ FileUtils.handleFileException(this.logPrefix(), 'Template', this.stationTemplateFile, error);
}
- return {
- configurationKey,
- unknownKey,
- };
}
- handleRequestChangeConfiguration(commandPayload) {
- 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)) {
- const keyIndex = this._configuration.configurationKey.indexOf(keyToChange);
- this._configuration.configurationKey[keyIndex].value = commandPayload.value;
- let triggerHeartbeatRestart = false;
- if (keyToChange.key === 'HeartBeatInterval') {
- this._setConfigurationKeyValue('HeartbeatInterval', commandPayload.value);
- triggerHeartbeatRestart = true;
- }
- if (keyToChange.key === 'HeartbeatInterval') {
- this._setConfigurationKeyValue('HeartBeatInterval', commandPayload.value);
- triggerHeartbeatRestart = true;
- }
- if (triggerHeartbeatRestart) {
- this._heartbeatInterval = Utils.convertToInt(commandPayload.value) * 1000;
- // Stop heartbeat
- this._stopHeartbeat();
- // Start heartbeat
- this._startHeartbeat();
- }
- if (Utils.convertToBoolean(keyToChange.reboot)) {
- return Constants.OCPP_RESPONSE_REBOOT_REQUIRED;
- }
- return Constants.OCPP_RESPONSE_ACCEPTED;
- }
+ private getReconnectExponentialDelay(): boolean | undefined {
+ return !Utils.isUndefined(this.stationInfo.reconnectExponentialDelay) ? this.stationInfo.reconnectExponentialDelay : false;
}
- async handleRequestRemoteStartTransaction(commandPayload) {
- const transactionConnectorID = commandPayload.connectorId ? 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);
- return Constants.OCPP_RESPONSE_ACCEPTED;
- }
- logger.error(this._logPrefix() + ' Remote starting transaction REJECTED with status ' + commandPayload.idTagInfo.status + ', idTag ' + commandPayload.idTag);
- return Constants.OCPP_RESPONSE_REJECTED;
+ private async reconnect(error: any): Promise<void> {
+ // Stop heartbeat
+ this.stopHeartbeat();
+ // Stop the ATG if needed
+ if (this.stationInfo.AutomaticTransactionGenerator.enable &&
+ this.stationInfo.AutomaticTransactionGenerator.stopOnConnectionFailure &&
+ this.automaticTransactionGeneration &&
+ !this.automaticTransactionGeneration.timeToStop) {
+ await this.automaticTransactionGeneration.stop();
+ }
+ if (this.autoReconnectRetryCount < this.getAutoReconnectMaxRetries() || this.getAutoReconnectMaxRetries() === -1) {
+ this.autoReconnectRetryCount++;
+ const reconnectDelay = (this.getReconnectExponentialDelay() ? Utils.exponentialDelay(this.autoReconnectRetryCount) : this.getConnectionTimeout() * 1000);
+ 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 });
+ this.hasSocketRestarted = true;
+ } else if (this.getAutoReconnectMaxRetries() !== -1) {
+ logger.error(`${this.logPrefix()} Socket reconnect failure: max retries reached (${this.autoReconnectRetryCount}) or retry disabled (${this.getAutoReconnectMaxRetries()})`);
}
- // 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);
- return Constants.OCPP_RESPONSE_ACCEPTED;
}
- async handleRequestRemoteStopTransaction(commandPayload) {
- for (const connector in this._connectors) {
- if (this.getConnector(Utils.convertToInt(connector)).transactionId === commandPayload.transactionId) {
- await this.sendStopTransaction(commandPayload.transactionId);
- return Constants.OCPP_RESPONSE_ACCEPTED;
- }
- }
- logger.info(this._logPrefix() + ' Try to stop remotely a non existing transaction ' + commandPayload.transactionId);
- return Constants.OCPP_RESPONSE_REJECTED;
+ private initTransactionAttributesOnConnector(connectorId: number): void {
+ this.getConnector(connectorId).transactionStarted = false;
+ this.getConnector(connectorId).energyActiveImportRegisterValue = 0;
+ this.getConnector(connectorId).transactionEnergyActiveImportRegisterValue = 0;
}
}
repositories / e-mobility-charging-stations-simulator.git / blobdiff