src/charging-station/ChargingStation.ts

   1 import { BootNotificationResponse, RegistrationStatus } from '../types/ocpp/Responses';
   2 import ChargingStationConfiguration, { ConfigurationKey } from '../types/ChargingStationConfiguration';
   3 import ChargingStationTemplate, { CurrentType, PowerUnits, Voltage } from '../types/ChargingStationTemplate';
   4 import { ConnectorPhaseRotation, StandardParametersKey, SupportedFeatureProfiles } from '../types/ocpp/Configuration';
   5 import Connectors, { Connector, SampledValueTemplate } from '../types/Connectors';
   6 import { MeterValueMeasurand, MeterValuePhase } from '../types/ocpp/MeterValues';
   7 import Requests, { AvailabilityType, BootNotificationRequest, IncomingRequest, IncomingRequestCommand } from '../types/ocpp/Requests';
   8 import WebSocket, { MessageEvent } from 'ws';
   9
  10 import AutomaticTransactionGenerator from './AutomaticTransactionGenerator';
  11 import { ChargePointStatus } from '../types/ocpp/ChargePointStatus';
  12 import { ChargingProfile } from '../types/ocpp/ChargingProfile';
  13 import ChargingStationInfo from '../types/ChargingStationInfo';
  14 import Configuration from '../utils/Configuration';
  15 import Constants from '../utils/Constants';
  16 import FileUtils from '../utils/FileUtils';
  17 import { MessageType } from '../types/ocpp/MessageType';
  18 import OCPP16IncomingRequestService from './ocpp/1.6/OCCP16IncomingRequestService';
  19 import OCPP16RequestService from './ocpp/1.6/OCPP16RequestService';
  20 import OCPP16ResponseService from './ocpp/1.6/OCPP16ResponseService';
  21 import OCPPError from './OCPPError';
  22 import OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService';
  23 import OCPPRequestService from './ocpp/OCPPRequestService';
  24 import { OCPPVersion } from '../types/ocpp/OCPPVersion';
  25 import PerformanceStatistics from '../utils/PerformanceStatistics';
  26 import { StopTransactionReason } from '../types/ocpp/Transaction';
  27 import { URL } from 'url';
  28 import Utils from '../utils/Utils';
  29 import { WebSocketCloseEventStatusCode } from '../types/WebSocket';
  30 import crypto from 'crypto';
  31 import fs from 'fs';
  32 import logger from '../utils/Logger';
  33 import path from 'path';
  34
  35 export default class ChargingStation {
  36   public stationTemplateFile: string;
  37   public authorizedTags: string[];
  38   public stationInfo!: ChargingStationInfo;
  39   public connectors: Connectors;
  40   public configuration!: ChargingStationConfiguration;
  41   public hasStopped: boolean;
  42   public wsConnection!: WebSocket;
  43   public requests: Requests;
  44   public messageQueue: string[];
  45   public performanceStatistics!: PerformanceStatistics;
  46   public heartbeatSetInterval!: NodeJS.Timeout;
  47   public ocppIncomingRequestService!: OCPPIncomingRequestService;
  48   public ocppRequestService!: OCPPRequestService;
  49   private index: number;
  50   private bootNotificationRequest!: BootNotificationRequest;
  51   private bootNotificationResponse!: BootNotificationResponse | null;
  52   private connectorsConfigurationHash!: string;
  53   private wsConnectionUrl!: URL;
  54   private hasSocketRestarted: boolean;
  55   private autoReconnectRetryCount: number;
  56   private automaticTransactionGeneration!: AutomaticTransactionGenerator;
  57   private webSocketPingSetInterval!: NodeJS.Timeout;
  58
  59   constructor(index: number, stationTemplateFile: string) {
  60     this.index = index;
  61     this.stationTemplateFile = stationTemplateFile;
  62     this.connectors = {} as Connectors;
  63     this.initialize();
  64
  65     this.hasStopped = false;
  66     this.hasSocketRestarted = false;
  67     this.autoReconnectRetryCount = 0;
  68
  69     this.requests = {} as Requests;
  70     this.messageQueue = [] as string[];
  71
  72     this.authorizedTags = this.getAuthorizedTags();
  73   }
  74
  75   public logPrefix(): string {
  76     return Utils.logPrefix(` ${this.stationInfo.chargingStationId} |`);
  77   }
  78
  79   public getRandomTagId(): string {
  80     const index = Math.floor(Math.random() * this.authorizedTags.length);
  81     return this.authorizedTags[index];
  82   }
  83
  84   public hasAuthorizedTags(): boolean {
  85     return !Utils.isEmptyArray(this.authorizedTags);
  86   }
  87
  88   public getEnableStatistics(): boolean | undefined {
  89     return !Utils.isUndefined(this.stationInfo.enableStatistics) ? this.stationInfo.enableStatistics : true;
  90   }
  91
  92   public getMayAuthorizeAtRemoteStart(): boolean | undefined {
  93     return this.stationInfo.mayAuthorizeAtRemoteStart ?? true;
  94   }
  95
  96   public getNumberOfPhases(): number | undefined {
  97     switch (this.getCurrentOutType()) {
  98       case CurrentType.AC:
  99         return !Utils.isUndefined(this.stationInfo.numberOfPhases) ? this.stationInfo.numberOfPhases : 3;
 100       case CurrentType.DC:
 101         return 0;
 102     }
 103   }
 104
 105   public isWebSocketOpen(): boolean {
 106     return this.wsConnection?.readyState === WebSocket.OPEN;
 107   }
 108
 109   public isRegistered(): boolean {
 110     return this.bootNotificationResponse?.status === RegistrationStatus.ACCEPTED;
 111   }
 112
 113   public isChargingStationAvailable(): boolean {
 114     return this.getConnector(0).availability === AvailabilityType.OPERATIVE;
 115   }
 116
 117   public isConnectorAvailable(id: number): boolean {
 118     return this.getConnector(id).availability === AvailabilityType.OPERATIVE;
 119   }
 120
 121   public getConnector(id: number): Connector {
 122     return this.connectors[id];
 123   }
 124
 125   public getCurrentOutType(): CurrentType | undefined {
 126     return this.stationInfo.currentOutType ?? CurrentType.AC;
 127   }
 128
 129   public getVoltageOut(): number | undefined {
 130     const errMsg = `${this.logPrefix()} Unknown ${this.getCurrentOutType()} currentOutType in template file ${this.stationTemplateFile}, cannot define default voltage out`;
 131     let defaultVoltageOut: number;
 132     switch (this.getCurrentOutType()) {
 133       case CurrentType.AC:
 134         defaultVoltageOut = Voltage.VOLTAGE_230;
 135         break;
 136       case CurrentType.DC:
 137         defaultVoltageOut = Voltage.VOLTAGE_400;
 138         break;
 139       default:
 140         logger.error(errMsg);
 141         throw new Error(errMsg);
 142     }
 143     return !Utils.isUndefined(this.stationInfo.voltageOut) ? this.stationInfo.voltageOut : defaultVoltageOut;
 144   }
 145
 146   public getTransactionIdTag(transactionId: number): string | undefined {
 147     for (const connector in this.connectors) {
 148       if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) {
 149         return this.getConnector(Utils.convertToInt(connector)).transactionIdTag;
 150       }
 151     }
 152   }
 153
 154   public getOutOfOrderEndMeterValues(): boolean {
 155     return this.stationInfo.outOfOrderEndMeterValues ?? false;
 156   }
 157
 158   public getBeginEndMeterValues(): boolean {
 159     return this.stationInfo.beginEndMeterValues ?? false;
 160   }
 161
 162   public getMeteringPerTransaction(): boolean {
 163     return this.stationInfo.meteringPerTransaction ?? true;
 164   }
 165
 166   public getTransactionDataMeterValues(): boolean {
 167     return this.stationInfo.transactionDataMeterValues ?? false;
 168   }
 169
 170   public getMainVoltageMeterValues(): boolean {
 171     return this.stationInfo.mainVoltageMeterValues ?? true;
 172   }
 173
 174   public getPhaseLineToLineVoltageMeterValues(): boolean {
 175     return this.stationInfo.phaseLineToLineVoltageMeterValues ?? false;
 176   }
 177
 178   public getEnergyActiveImportRegisterByTransactionId(transactionId: number): number | undefined {
 179     if (this.getMeteringPerTransaction()) {
 180       for (const connector in this.connectors) {
 181         if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) {
 182           return this.getConnector(Utils.convertToInt(connector)).transactionEnergyActiveImportRegisterValue;
 183         }
 184       }
 185     }
 186     for (const connector in this.connectors) {
 187       if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) {
 188         return this.getConnector(Utils.convertToInt(connector)).energyActiveImportRegisterValue;
 189       }
 190     }
 191   }
 192
 193   public getEnergyActiveImportRegisterByConnectorId(connectorId: number): number | undefined {
 194     if (this.getMeteringPerTransaction()) {
 195       return this.getConnector(connectorId).transactionEnergyActiveImportRegisterValue;
 196     }
 197     return this.getConnector(connectorId).energyActiveImportRegisterValue;
 198   }
 199
 200   public getAuthorizeRemoteTxRequests(): boolean {
 201     const authorizeRemoteTxRequests = this.getConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests);
 202     return authorizeRemoteTxRequests ? Utils.convertToBoolean(authorizeRemoteTxRequests.value) : false;
 203   }
 204
 205   public getLocalAuthListEnabled(): boolean {
 206     const localAuthListEnabled = this.getConfigurationKey(StandardParametersKey.LocalAuthListEnabled);
 207     return localAuthListEnabled ? Utils.convertToBoolean(localAuthListEnabled.value) : false;
 208   }
 209
 210   public restartWebSocketPing(): void {
 211     // Stop WebSocket ping
 212     this.stopWebSocketPing();
 213     // Start WebSocket ping
 214     this.startWebSocketPing();
 215   }
 216
 217   public getSampledValueTemplate(connectorId: number, measurand: MeterValueMeasurand = MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER,
 218       phase?: MeterValuePhase): SampledValueTemplate | undefined {
 219     if (!Constants.SUPPORTED_MEASURANDS.includes(measurand)) {
 220       logger.warn(`${this.logPrefix()} Trying to get unsupported MeterValues measurand ${measurand} ${phase ? `on phase ${phase} ` : ''}in template on connectorId ${connectorId}`);
 221       return;
 222     }
 223     if (measurand !== MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER && !this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes(measurand)) {
 224       logger.debug(`${this.logPrefix()} Trying to get MeterValues measurand ${measurand} ${phase ? `on phase ${phase} ` : ''}in template on connectorId ${connectorId} not found in '${StandardParametersKey.MeterValuesSampledData}' OCPP parameter`);
 225       return;
 226     }
 227     const sampledValueTemplates: SampledValueTemplate[] = this.getConnector(connectorId).MeterValues;
 228     for (let index = 0; !Utils.isEmptyArray(sampledValueTemplates) && index < sampledValueTemplates.length; index++) {
 229       if (!Constants.SUPPORTED_MEASURANDS.includes(sampledValueTemplates[index]?.measurand ?? MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER)) {
 230         logger.warn(`${this.logPrefix()} Unsupported MeterValues measurand ${measurand} ${phase ? `on phase ${phase} ` : ''}in template on connectorId ${connectorId}`);
 231         continue;
 232       } else if (phase && sampledValueTemplates[index]?.phase === phase && sampledValueTemplates[index]?.measurand === measurand
 233           && this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes(measurand)) {
 234         return sampledValueTemplates[index];
 235       } else if (!phase && !sampledValueTemplates[index].phase && sampledValueTemplates[index]?.measurand === measurand
 236                  && this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes(measurand)) {
 237         return sampledValueTemplates[index];
 238       } else if (measurand === MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER
 239                  && (!sampledValueTemplates[index].measurand || sampledValueTemplates[index].measurand === measurand)) {
 240         return sampledValueTemplates[index];
 241       }
 242     }
 243     if (measurand === MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER) {
 244       logger.error(`${this.logPrefix()} Missing MeterValues for default measurand ${measurand} in template on connectorId ${connectorId}`);
 245     }
 246     logger.debug(`${this.logPrefix()} No MeterValues for measurand ${measurand} ${phase ? `on phase ${phase} ` : ''}in template on connectorId ${connectorId}`);
 247   }
 248
 249   public getAutomaticTransactionGeneratorRequireAuthorize(): boolean {
 250     return this.stationInfo.AutomaticTransactionGenerator.requireAuthorize ?? true;
 251   }
 252
 253   public startHeartbeat(): void {
 254     if (this.getHeartbeatInterval() && this.getHeartbeatInterval() > 0 && !this.heartbeatSetInterval) {
 255       // eslint-disable-next-line @typescript-eslint/no-misused-promises
 256       this.heartbeatSetInterval = setInterval(async (): Promise<void> => {
 257         await this.ocppRequestService.sendHeartbeat();
 258       }, this.getHeartbeatInterval());
 259       logger.info(this.logPrefix() + ' Heartbeat started every ' + Utils.milliSecondsToHHMMSS(this.getHeartbeatInterval()));
 260     } else if (this.heartbeatSetInterval) {
 261       logger.info(this.logPrefix() + ' Heartbeat already started every ' + Utils.milliSecondsToHHMMSS(this.getHeartbeatInterval()));
 262     } else {
 263       logger.error(`${this.logPrefix()} Heartbeat interval set to ${this.getHeartbeatInterval() ? Utils.milliSecondsToHHMMSS(this.getHeartbeatInterval()) : this.getHeartbeatInterval()}, not starting the heartbeat`);
 264     }
 265   }
 266
 267   public restartHeartbeat(): void {
 268     // Stop heartbeat
 269     this.stopHeartbeat();
 270     // Start heartbeat
 271     this.startHeartbeat();
 272   }
 273
 274   public startMeterValues(connectorId: number, interval: number): void {
 275     if (connectorId === 0) {
 276       logger.error(`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId.toString()}`);
 277       return;
 278     }
 279     if (!this.getConnector(connectorId)) {
 280       logger.error(`${this.logPrefix()} Trying to start MeterValues on non existing connector Id ${connectorId.toString()}`);
 281       return;
 282     }
 283     if (!this.getConnector(connectorId)?.transactionStarted) {
 284       logger.error(`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction started`);
 285       return;
 286     } else if (this.getConnector(connectorId)?.transactionStarted && !this.getConnector(connectorId)?.transactionId) {
 287       logger.error(`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction id`);
 288       return;
 289     }
 290     if (interval > 0) {
 291       // eslint-disable-next-line @typescript-eslint/no-misused-promises
 292       this.getConnector(connectorId).transactionSetInterval = setInterval(async (): Promise<void> => {
 293         await this.ocppRequestService.sendMeterValues(connectorId, this.getConnector(connectorId).transactionId, interval);
 294       }, interval);
 295     } else {
 296       logger.error(`${this.logPrefix()} Charging station ${StandardParametersKey.MeterValueSampleInterval} configuration set to ${interval ? Utils.milliSecondsToHHMMSS(interval) : interval}, not sending MeterValues`);
 297     }
 298   }
 299
 300   public start(): void {
 301     this.openWSConnection();
 302     // Monitor authorization file
 303     this.startAuthorizationFileMonitoring();
 304     // Monitor station template file
 305     this.startStationTemplateFileMonitoring();
 306     // Handle Socket incoming messages
 307     this.wsConnection.on('message', this.onMessage.bind(this));
 308     // Handle Socket error
 309     this.wsConnection.on('error', this.onError.bind(this));
 310     // Handle Socket close
 311     this.wsConnection.on('close', this.onClose.bind(this));
 312     // Handle Socket opening connection
 313     this.wsConnection.on('open', this.onOpen.bind(this));
 314     // Handle Socket ping
 315     this.wsConnection.on('ping', this.onPing.bind(this));
 316     // Handle Socket pong
 317     this.wsConnection.on('pong', this.onPong.bind(this));
 318   }
 319
 320   public async stop(reason: StopTransactionReason = StopTransactionReason.NONE): Promise<void> {
 321     // Stop message sequence
 322     await this.stopMessageSequence(reason);
 323     for (const connector in this.connectors) {
 324       if (Utils.convertToInt(connector) > 0) {
 325         await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), ChargePointStatus.UNAVAILABLE);
 326         this.getConnector(Utils.convertToInt(connector)).status = ChargePointStatus.UNAVAILABLE;
 327       }
 328     }
 329     if (this.isWebSocketOpen()) {
 330       this.wsConnection.close();
 331     }
 332     this.bootNotificationResponse = null;
 333     this.hasStopped = true;
 334   }
 335
 336   public getConfigurationKey(key: string | StandardParametersKey, caseInsensitive = false): ConfigurationKey | undefined {
 337     const configurationKey: ConfigurationKey | undefined = this.configuration.configurationKey.find((configElement) => {
 338       if (caseInsensitive) {
 339         return configElement.key.toLowerCase() === key.toLowerCase();
 340       }
 341       return configElement.key === key;
 342     });
 343     return configurationKey;
 344   }
 345
 346   public addConfigurationKey(key: string | StandardParametersKey, value: string, readonly = false, visible = true, reboot = false): void {
 347     const keyFound = this.getConfigurationKey(key);
 348     if (!keyFound) {
 349       this.configuration.configurationKey.push({
 350         key,
 351         readonly,
 352         value,
 353         visible,
 354         reboot,
 355       });
 356     } else {
 357       logger.error(`${this.logPrefix()} Trying to add an already existing configuration key: %j`, keyFound);
 358     }
 359   }
 360
 361   public setConfigurationKeyValue(key: string | StandardParametersKey, value: string): void {
 362     const keyFound = this.getConfigurationKey(key);
 363     if (keyFound) {
 364       const keyIndex = this.configuration.configurationKey.indexOf(keyFound);
 365       this.configuration.configurationKey[keyIndex].value = value;
 366     } else {
 367       logger.error(`${this.logPrefix()} Trying to set a value on a non existing configuration key: %j`, { key, value });
 368     }
 369   }
 370
 371   public setChargingProfile(connectorId: number, cp: ChargingProfile): void {
 372     let cpReplaced = false;
 373     if (!Utils.isEmptyArray(this.getConnector(connectorId).chargingProfiles)) {
 374       this.getConnector(connectorId).chargingProfiles?.forEach((chargingProfile: ChargingProfile, index: number) => {
 375         if (chargingProfile.chargingProfileId === cp.chargingProfileId
 376             || (chargingProfile.stackLevel === cp.stackLevel && chargingProfile.chargingProfilePurpose === cp.chargingProfilePurpose)) {
 377           this.getConnector(connectorId).chargingProfiles[index] = cp;
 378           cpReplaced = true;
 379         }
 380       });
 381     }
 382     !cpReplaced && this.getConnector(connectorId).chargingProfiles?.push(cp);
 383   }
 384
 385   public resetTransactionOnConnector(connectorId: number): void {
 386     this.getConnector(connectorId).authorized = false;
 387     this.getConnector(connectorId).transactionStarted = false;
 388     delete this.getConnector(connectorId).authorizeIdTag;
 389     delete this.getConnector(connectorId).transactionId;
 390     delete this.getConnector(connectorId).transactionIdTag;
 391     this.getConnector(connectorId).transactionEnergyActiveImportRegisterValue = 0;
 392     delete this.getConnector(connectorId).transactionBeginMeterValue;
 393     this.stopMeterValues(connectorId);
 394   }
 395
 396   public addToMessageQueue(message: string): void {
 397     let dups = false;
 398     // Handle dups in message queue
 399     for (const bufferedMessage of this.messageQueue) {
 400       // Message already in the queue
 401       if (message === bufferedMessage) {
 402         dups = true;
 403         break;
 404       }
 405     }
 406     if (!dups) {
 407       // Queue message
 408       this.messageQueue.push(message);
 409     }
 410   }
 411
 412   private flushMessageQueue() {
 413     if (!Utils.isEmptyArray(this.messageQueue)) {
 414       this.messageQueue.forEach((message, index) => {
 415         this.messageQueue.splice(index, 1);
 416         // TODO: evaluate the need to track performance
 417         this.wsConnection.send(message);
 418       });
 419     }
 420   }
 421
 422   private getChargingStationId(stationTemplate: ChargingStationTemplate): string {
 423     // In case of multiple instances: add instance index to charging station id
 424     let instanceIndex = process.env.CF_INSTANCE_INDEX ?? 0;
 425     instanceIndex = instanceIndex > 0 ? instanceIndex : '';
 426     const idSuffix = stationTemplate.nameSuffix ?? '';
 427     return stationTemplate.fixedName ? stationTemplate.baseName : stationTemplate.baseName + '-' + instanceIndex.toString() + ('000000000' + this.index.toString()).substr(('000000000' + this.index.toString()).length - 4) + idSuffix;
 428   }
 429
 430   private buildStationInfo(): ChargingStationInfo {
 431     let stationTemplateFromFile: ChargingStationTemplate;
 432     try {
 433       // Load template file
 434       const fileDescriptor = fs.openSync(this.stationTemplateFile, 'r');
 435       stationTemplateFromFile = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as ChargingStationTemplate;
 436       fs.closeSync(fileDescriptor);
 437     } catch (error) {
 438       FileUtils.handleFileException(this.logPrefix(), 'Template', this.stationTemplateFile, error);
 439     }
 440     const stationInfo: ChargingStationInfo = stationTemplateFromFile ?? {} as ChargingStationInfo;
 441     if (!Utils.isEmptyArray(stationTemplateFromFile.power)) {
 442       stationTemplateFromFile.power = stationTemplateFromFile.power as number[];
 443       const powerArrayRandomIndex = Math.floor(Math.random() * stationTemplateFromFile.power.length);
 444       stationInfo.maxPower = stationTemplateFromFile.powerUnit === PowerUnits.KILO_WATT
 445         ? stationTemplateFromFile.power[powerArrayRandomIndex] * 1000
 446         : stationTemplateFromFile.power[powerArrayRandomIndex];
 447     } else {
 448       stationTemplateFromFile.power = stationTemplateFromFile.power as number;
 449       stationInfo.maxPower = stationTemplateFromFile.powerUnit === PowerUnits.KILO_WATT
 450         ? stationTemplateFromFile.power * 1000
 451         : stationTemplateFromFile.power;
 452     }
 453     delete stationInfo.power;
 454     delete stationInfo.powerUnit;
 455     stationInfo.chargingStationId = this.getChargingStationId(stationTemplateFromFile);
 456     stationInfo.resetTime = stationTemplateFromFile.resetTime ? stationTemplateFromFile.resetTime * 1000 : Constants.CHARGING_STATION_DEFAULT_RESET_TIME;
 457     return stationInfo;
 458   }
 459
 460   private getOCPPVersion(): OCPPVersion {
 461     return this.stationInfo.ocppVersion ? this.stationInfo.ocppVersion : OCPPVersion.VERSION_16;
 462   }
 463
 464   private handleUnsupportedVersion(version: OCPPVersion) {
 465     const errMsg = `${this.logPrefix()} Unsupported protocol version '${version}' configured in template file ${this.stationTemplateFile}`;
 466     logger.error(errMsg);
 467     throw new Error(errMsg);
 468   }
 469
 470   private initialize(): void {
 471     this.stationInfo = this.buildStationInfo();
 472     this.bootNotificationRequest = {
 473       chargePointModel: this.stationInfo.chargePointModel,
 474       chargePointVendor: this.stationInfo.chargePointVendor,
 475       ...!Utils.isUndefined(this.stationInfo.chargeBoxSerialNumberPrefix) && { chargeBoxSerialNumber: this.stationInfo.chargeBoxSerialNumberPrefix },
 476       ...!Utils.isUndefined(this.stationInfo.firmwareVersion) && { firmwareVersion: this.stationInfo.firmwareVersion },
 477     };
 478     this.configuration = this.getTemplateChargingStationConfiguration();
 479     this.wsConnectionUrl = new URL(this.getSupervisionURL().href + '/' + this.stationInfo.chargingStationId);
 480     // Build connectors if needed
 481     const maxConnectors = this.getMaxNumberOfConnectors();
 482     if (maxConnectors <= 0) {
 483       logger.warn(`${this.logPrefix()} Charging station template ${this.stationTemplateFile} with ${maxConnectors} connectors`);
 484     }
 485     const templateMaxConnectors = this.getTemplateMaxNumberOfConnectors();
 486     if (templateMaxConnectors <= 0) {
 487       logger.warn(`${this.logPrefix()} Charging station template ${this.stationTemplateFile} with no connector configuration`);
 488     }
 489     if (!this.stationInfo.Connectors[0]) {
 490       logger.warn(`${this.logPrefix()} Charging station template ${this.stationTemplateFile} with no connector Id 0 configuration`);
 491     }
 492     // Sanity check
 493     if (maxConnectors > (this.stationInfo.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) && !this.stationInfo.randomConnectors) {
 494       logger.warn(`${this.logPrefix()} Number of connectors exceeds the number of connector configurations in template ${this.stationTemplateFile}, forcing random connector configurations affectation`);
 495       this.stationInfo.randomConnectors = true;
 496     }
 497     const connectorsConfigHash = crypto.createHash('sha256').update(JSON.stringify(this.stationInfo.Connectors) + maxConnectors.toString()).digest('hex');
 498     // FIXME: Handle shrinking the number of connectors
 499     if (!this.connectors || (this.connectors && this.connectorsConfigurationHash !== connectorsConfigHash)) {
 500       this.connectorsConfigurationHash = connectorsConfigHash;
 501       // Add connector Id 0
 502       let lastConnector = '0';
 503       for (lastConnector in this.stationInfo.Connectors) {
 504         if (Utils.convertToInt(lastConnector) === 0 && this.getUseConnectorId0() && this.stationInfo.Connectors[lastConnector]) {
 505           this.connectors[lastConnector] = Utils.cloneObject<Connector>(this.stationInfo.Connectors[lastConnector]);
 506           this.connectors[lastConnector].availability = AvailabilityType.OPERATIVE;
 507           if (Utils.isUndefined(this.connectors[lastConnector]?.chargingProfiles)) {
 508             this.connectors[lastConnector].chargingProfiles = [];
 509           }
 510         }
 511       }
 512       // Generate all connectors
 513       if ((this.stationInfo.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) > 0) {
 514         for (let index = 1; index <= maxConnectors; index++) {
 515           const randConnectorId = this.stationInfo.randomConnectors ? Utils.getRandomInt(Utils.convertToInt(lastConnector), 1) : index;
 516           this.connectors[index] = Utils.cloneObject<Connector>(this.stationInfo.Connectors[randConnectorId]);
 517           this.connectors[index].availability = AvailabilityType.OPERATIVE;
 518           if (Utils.isUndefined(this.connectors[lastConnector]?.chargingProfiles)) {
 519             this.connectors[index].chargingProfiles = [];
 520           }
 521         }
 522       }
 523     }
 524     // Avoid duplication of connectors related information
 525     delete this.stationInfo.Connectors;
 526     // Initialize transaction attributes on connectors
 527     for (const connector in this.connectors) {
 528       if (Utils.convertToInt(connector) > 0 && !this.getConnector(Utils.convertToInt(connector)).transactionStarted) {
 529         this.initTransactionAttributesOnConnector(Utils.convertToInt(connector));
 530       }
 531     }
 532     switch (this.getOCPPVersion()) {
 533       case OCPPVersion.VERSION_16:
 534         this.ocppIncomingRequestService = new OCPP16IncomingRequestService(this);
 535         this.ocppRequestService = new OCPP16RequestService(this, new OCPP16ResponseService(this));
 536         break;
 537       default:
 538         this.handleUnsupportedVersion(this.getOCPPVersion());
 539         break;
 540     }
 541     // OCPP parameters
 542     this.initOCPPParameters();
 543     if (this.stationInfo.autoRegister) {
 544       this.bootNotificationResponse = {
 545         currentTime: new Date().toISOString(),
 546         interval: this.getHeartbeatInterval() / 1000,
 547         status: RegistrationStatus.ACCEPTED
 548       };
 549     }
 550     this.stationInfo.powerDivider = this.getPowerDivider();
 551     if (this.getEnableStatistics()) {
 552       this.performanceStatistics = new PerformanceStatistics(this.stationInfo.chargingStationId);
 553     }
 554   }
 555
 556   private initOCPPParameters(): void {
 557     if (!this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles)) {
 558       this.addConfigurationKey(StandardParametersKey.SupportedFeatureProfiles, `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.Local_Auth_List_Management},${SupportedFeatureProfiles.Smart_Charging}`);
 559     }
 560     this.addConfigurationKey(StandardParametersKey.NumberOfConnectors, this.getNumberOfConnectors().toString(), true);
 561     if (!this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData)) {
 562       this.addConfigurationKey(StandardParametersKey.MeterValuesSampledData, MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER);
 563     }
 564     if (!this.getConfigurationKey(StandardParametersKey.ConnectorPhaseRotation)) {
 565       const connectorPhaseRotation = [];
 566       for (const connector in this.connectors) {
 567         // AC/DC
 568         if (Utils.convertToInt(connector) === 0 && this.getNumberOfPhases() === 0) {
 569           connectorPhaseRotation.push(`${connector}.${ConnectorPhaseRotation.RST}`);
 570         } else if (Utils.convertToInt(connector) > 0 && this.getNumberOfPhases() === 0) {
 571           connectorPhaseRotation.push(`${connector}.${ConnectorPhaseRotation.NotApplicable}`);
 572         // AC
 573         } else if (Utils.convertToInt(connector) > 0 && this.getNumberOfPhases() === 1) {
 574           connectorPhaseRotation.push(`${connector}.${ConnectorPhaseRotation.NotApplicable}`);
 575         } else if (Utils.convertToInt(connector) > 0 && this.getNumberOfPhases() === 3) {
 576           connectorPhaseRotation.push(`${connector}.${ConnectorPhaseRotation.RST}`);
 577         }
 578       }
 579       this.addConfigurationKey(StandardParametersKey.ConnectorPhaseRotation, connectorPhaseRotation.toString());
 580     }
 581     if (!this.getConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests)) {
 582       this.addConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests, 'true');
 583     }
 584     if (!this.getConfigurationKey(StandardParametersKey.LocalAuthListEnabled)
 585         && this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles).value.includes(SupportedFeatureProfiles.Local_Auth_List_Management)) {
 586       this.addConfigurationKey(StandardParametersKey.LocalAuthListEnabled, 'false');
 587     }
 588     if (!this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) {
 589       this.addConfigurationKey(StandardParametersKey.ConnectionTimeOut, Constants.DEFAULT_CONNECTION_TIMEOUT.toString());
 590     }
 591   }
 592
 593   private async onOpen(): Promise<void> {
 594     logger.info(`${this.logPrefix()} Connected to OCPP server through ${this.wsConnectionUrl.toString()}`);
 595     if (!this.isRegistered()) {
 596       // Send BootNotification
 597       let registrationRetryCount = 0;
 598       do {
 599         this.bootNotificationResponse = await this.ocppRequestService.sendBootNotification(this.bootNotificationRequest.chargePointModel,
 600           this.bootNotificationRequest.chargePointVendor, this.bootNotificationRequest.chargeBoxSerialNumber, this.bootNotificationRequest.firmwareVersion);
 601         if (!this.isRegistered()) {
 602           registrationRetryCount++;
 603           await Utils.sleep(this.bootNotificationResponse?.interval ? this.bootNotificationResponse.interval * 1000 : Constants.OCPP_DEFAULT_BOOT_NOTIFICATION_INTERVAL);
 604         }
 605       } while (!this.isRegistered() && (registrationRetryCount <= this.getRegistrationMaxRetries() || this.getRegistrationMaxRetries() === -1));
 606     }
 607     if (this.isRegistered()) {
 608       await this.startMessageSequence();
 609       this.hasStopped && (this.hasStopped = false);
 610       if (this.hasSocketRestarted && this.isWebSocketOpen()) {
 611         this.flushMessageQueue();
 612       }
 613     } else {
 614       logger.error(`${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})`);
 615     }
 616     this.autoReconnectRetryCount = 0;
 617     this.hasSocketRestarted = false;
 618   }
 619
 620   private async onClose(closeEvent: any): Promise<void> {
 621     switch (closeEvent) {
 622       case WebSocketCloseEventStatusCode.CLOSE_NORMAL: // Normal close
 623       case WebSocketCloseEventStatusCode.CLOSE_NO_STATUS:
 624         logger.info(`${this.logPrefix()} Socket normally closed with status '${Utils.getWebSocketCloseEventStatusString(closeEvent)}'`);
 625         this.autoReconnectRetryCount = 0;
 626         break;
 627       default: // Abnormal close
 628         logger.error(`${this.logPrefix()} Socket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString(closeEvent)}'`);
 629         await this.reconnect(closeEvent);
 630         break;
 631     }
 632   }
 633
 634   private async onMessage(messageEvent: MessageEvent): Promise<void> {
 635     let [messageType, messageId, commandName, commandPayload, errorDetails]: IncomingRequest = [0, '', '' as IncomingRequestCommand, {}, {}];
 636     let responseCallback: (payload: Record<string, unknown> | string, requestPayload: Record<string, unknown>) => void;
 637     let rejectCallback: (error: OCPPError) => void;
 638     let requestPayload: Record<string, unknown>;
 639     let errMsg: string;
 640     try {
 641       const request = JSON.parse(messageEvent.toString()) as IncomingRequest;
 642       if (Utils.isIterable(request)) {
 643         // Parse the message
 644         [messageType, messageId, commandName, commandPayload, errorDetails] = request;
 645       } else {
 646         throw new Error('Incoming request is not iterable');
 647       }
 648       // Check the Type of message
 649       switch (messageType) {
 650         // Incoming Message
 651         case MessageType.CALL_MESSAGE:
 652           if (this.getEnableStatistics()) {
 653             this.performanceStatistics.addRequestStatistic(commandName, messageType);
 654           }
 655           // Process the call
 656           await this.ocppIncomingRequestService.handleRequest(messageId, commandName, commandPayload);
 657           break;
 658         // Outcome Message
 659         case MessageType.CALL_RESULT_MESSAGE:
 660           // Respond
 661           if (Utils.isIterable(this.requests[messageId])) {
 662             [responseCallback, , requestPayload] = this.requests[messageId];
 663           } else {
 664             throw new Error(`Response request for message id ${messageId} is not iterable`);
 665           }
 666           if (!responseCallback) {
 667             // Error
 668             throw new Error(`Response request for unknown message id ${messageId}`);
 669           }
 670           delete this.requests[messageId];
 671           responseCallback(commandName, requestPayload);
 672           break;
 673         // Error Message
 674         case MessageType.CALL_ERROR_MESSAGE:
 675           if (!this.requests[messageId]) {
 676             // Error
 677             throw new Error(`Error request for unknown message id ${messageId}`);
 678           }
 679           if (Utils.isIterable(this.requests[messageId])) {
 680             [, rejectCallback] = this.requests[messageId];
 681           } else {
 682             throw new Error(`Error request for message id ${messageId} is not iterable`);
 683           }
 684           delete this.requests[messageId];
 685           rejectCallback(new OCPPError(commandName, commandPayload.toString(), errorDetails));
 686           break;
 687         // Error
 688         default:
 689           errMsg = `${this.logPrefix()} Wrong message type ${messageType}`;
 690           logger.error(errMsg);
 691           throw new Error(errMsg);
 692       }
 693     } catch (error) {
 694       // Log
 695       logger.error('%s Incoming request message %j processing error %j on content type %j', this.logPrefix(), messageEvent, error, this.requests[messageId]);
 696       // Send error
 697       messageType !== MessageType.CALL_ERROR_MESSAGE && await this.ocppRequestService.sendError(messageId, error, commandName);
 698     }
 699   }
 700
 701   private onPing(): void {
 702     logger.debug(this.logPrefix() + ' Received a WS ping (rfc6455) from the server');
 703   }
 704
 705   private onPong(): void {
 706     logger.debug(this.logPrefix() + ' Received a WS pong (rfc6455) from the server');
 707   }
 708
 709   private async onError(errorEvent: any): Promise<void> {
 710     logger.error(this.logPrefix() + ' Socket error: %j', errorEvent);
 711     // switch (errorEvent.code) {
 712     //   case 'ECONNREFUSED':
 713     //     await this._reconnect(errorEvent);
 714     //     break;
 715     // }
 716   }
 717
 718   private getTemplateChargingStationConfiguration(): ChargingStationConfiguration {
 719     return this.stationInfo.Configuration ? this.stationInfo.Configuration : {} as ChargingStationConfiguration;
 720   }
 721
 722   private getAuthorizationFile(): string | undefined {
 723     return this.stationInfo.authorizationFile && path.join(path.resolve(__dirname, '../'), 'assets', path.basename(this.stationInfo.authorizationFile));
 724   }
 725
 726   private getAuthorizedTags(): string[] {
 727     let authorizedTags: string[] = [];
 728     const authorizationFile = this.getAuthorizationFile();
 729     if (authorizationFile) {
 730       try {
 731         // Load authorization file
 732         const fileDescriptor = fs.openSync(authorizationFile, 'r');
 733         authorizedTags = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as string[];
 734         fs.closeSync(fileDescriptor);
 735       } catch (error) {
 736         FileUtils.handleFileException(this.logPrefix(), 'Authorization', authorizationFile, error);
 737       }
 738     } else {
 739       logger.info(this.logPrefix() + ' No authorization file given in template file ' + this.stationTemplateFile);
 740     }
 741     return authorizedTags;
 742   }
 743
 744   private getUseConnectorId0(): boolean | undefined {
 745     return !Utils.isUndefined(this.stationInfo.useConnectorId0) ? this.stationInfo.useConnectorId0 : true;
 746   }
 747
 748   private getNumberOfRunningTransactions(): number {
 749     let trxCount = 0;
 750     for (const connector in this.connectors) {
 751       if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionStarted) {
 752         trxCount++;
 753       }
 754     }
 755     return trxCount;
 756   }
 757
 758   // 0 for disabling
 759   private getConnectionTimeout(): number | undefined {
 760     if (this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) {
 761       return parseInt(this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut).value) ?? Constants.DEFAULT_CONNECTION_TIMEOUT;
 762     }
 763     return Constants.DEFAULT_CONNECTION_TIMEOUT;
 764   }
 765
 766   // -1 for unlimited, 0 for disabling
 767   private getAutoReconnectMaxRetries(): number | undefined {
 768     if (!Utils.isUndefined(this.stationInfo.autoReconnectMaxRetries)) {
 769       return this.stationInfo.autoReconnectMaxRetries;
 770     }
 771     if (!Utils.isUndefined(Configuration.getAutoReconnectMaxRetries())) {
 772       return Configuration.getAutoReconnectMaxRetries();
 773     }
 774     return -1;
 775   }
 776
 777   // 0 for disabling
 778   private getRegistrationMaxRetries(): number | undefined {
 779     if (!Utils.isUndefined(this.stationInfo.registrationMaxRetries)) {
 780       return this.stationInfo.registrationMaxRetries;
 781     }
 782     return -1;
 783   }
 784
 785   private getPowerDivider(): number {
 786     let powerDivider = this.getNumberOfConnectors();
 787     if (this.stationInfo.powerSharedByConnectors) {
 788       powerDivider = this.getNumberOfRunningTransactions();
 789     }
 790     return powerDivider;
 791   }
 792
 793   private getTemplateMaxNumberOfConnectors(): number {
 794     return Object.keys(this.stationInfo.Connectors).length;
 795   }
 796
 797   private getMaxNumberOfConnectors(): number {
 798     let maxConnectors = 0;
 799     if (!Utils.isEmptyArray(this.stationInfo.numberOfConnectors)) {
 800       const numberOfConnectors = this.stationInfo.numberOfConnectors as number[];
 801       // Distribute evenly the number of connectors
 802       maxConnectors = numberOfConnectors[(this.index - 1) % numberOfConnectors.length];
 803     } else if (!Utils.isUndefined(this.stationInfo.numberOfConnectors)) {
 804       maxConnectors = this.stationInfo.numberOfConnectors as number;
 805     } else {
 806       maxConnectors = this.stationInfo.Connectors[0] ? this.getTemplateMaxNumberOfConnectors() - 1 : this.getTemplateMaxNumberOfConnectors();
 807     }
 808     return maxConnectors;
 809   }
 810
 811   private getNumberOfConnectors(): number {
 812     return this.connectors[0] ? Object.keys(this.connectors).length - 1 : Object.keys(this.connectors).length;
 813   }
 814
 815   private async startMessageSequence(): Promise<void> {
 816     // Start WebSocket ping
 817     this.startWebSocketPing();
 818     // Start heartbeat
 819     this.startHeartbeat();
 820     // Initialize connectors status
 821     for (const connector in this.connectors) {
 822       if (Utils.convertToInt(connector) === 0) {
 823         continue;
 824       } else if (!this.hasStopped && !this.getConnector(Utils.convertToInt(connector))?.status && this.getConnector(Utils.convertToInt(connector))?.bootStatus) {
 825         // Send status in template at startup
 826         await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).bootStatus);
 827         this.getConnector(Utils.convertToInt(connector)).status = this.getConnector(Utils.convertToInt(connector)).bootStatus;
 828       } else if (this.hasStopped && this.getConnector(Utils.convertToInt(connector))?.bootStatus) {
 829         // Send status in template after reset
 830         await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).bootStatus);
 831         this.getConnector(Utils.convertToInt(connector)).status = this.getConnector(Utils.convertToInt(connector)).bootStatus;
 832       } else if (!this.hasStopped && this.getConnector(Utils.convertToInt(connector))?.status) {
 833         // Send previous status at template reload
 834         await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).status);
 835       } else {
 836         // Send default status
 837         await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), ChargePointStatus.AVAILABLE);
 838         this.getConnector(Utils.convertToInt(connector)).status = ChargePointStatus.AVAILABLE;
 839       }
 840     }
 841     // Start the ATG
 842     this.startAutomaticTransactionGenerator();
 843     if (this.getEnableStatistics()) {
 844       this.performanceStatistics.start();
 845     }
 846   }
 847
 848   private startAutomaticTransactionGenerator() {
 849     if (this.stationInfo.AutomaticTransactionGenerator.enable) {
 850       if (!this.automaticTransactionGeneration) {
 851         this.automaticTransactionGeneration = new AutomaticTransactionGenerator(this);
 852       }
 853       if (this.automaticTransactionGeneration.timeToStop) {
 854         // The ATG might sleep
 855         void this.automaticTransactionGeneration.start();
 856       }
 857     }
 858   }
 859
 860   private async stopMessageSequence(reason: StopTransactionReason = StopTransactionReason.NONE): Promise<void> {
 861     // Stop WebSocket ping
 862     this.stopWebSocketPing();
 863     // Stop heartbeat
 864     this.stopHeartbeat();
 865     // Stop the ATG
 866     if (this.stationInfo.AutomaticTransactionGenerator.enable &&
 867       this.automaticTransactionGeneration &&
 868       !this.automaticTransactionGeneration.timeToStop) {
 869       await this.automaticTransactionGeneration.stop(reason);
 870     } else {
 871       for (const connector in this.connectors) {
 872         if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionStarted) {
 873           const transactionId = this.getConnector(Utils.convertToInt(connector)).transactionId;
 874           await this.ocppRequestService.sendStopTransaction(transactionId, this.getEnergyActiveImportRegisterByTransactionId(transactionId),
 875             this.getTransactionIdTag(transactionId), reason);
 876         }
 877       }
 878     }
 879   }
 880
 881   private startWebSocketPing(): void {
 882     const webSocketPingInterval: number = this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval)
 883       ? Utils.convertToInt(this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval).value)
 884       : 0;
 885     if (webSocketPingInterval > 0 && !this.webSocketPingSetInterval) {
 886       this.webSocketPingSetInterval = setInterval(() => {
 887         if (this.isWebSocketOpen()) {
 888           this.wsConnection.ping((): void => { });
 889         }
 890       }, webSocketPingInterval * 1000);
 891       logger.info(this.logPrefix() + ' WebSocket ping started every ' + Utils.secondsToHHMMSS(webSocketPingInterval));
 892     } else if (this.webSocketPingSetInterval) {
 893       logger.info(this.logPrefix() + ' WebSocket ping every ' + Utils.secondsToHHMMSS(webSocketPingInterval) + ' already started');
 894     } else {
 895       logger.error(`${this.logPrefix()} WebSocket ping interval set to ${webSocketPingInterval ? Utils.secondsToHHMMSS(webSocketPingInterval) : webSocketPingInterval}, not starting the WebSocket ping`);
 896     }
 897   }
 898
 899   private stopWebSocketPing(): void {
 900     if (this.webSocketPingSetInterval) {
 901       clearInterval(this.webSocketPingSetInterval);
 902     }
 903   }
 904
 905   private getSupervisionURL(): URL {
 906     const supervisionUrls = Utils.cloneObject<string | string[]>(this.stationInfo.supervisionURL ? this.stationInfo.supervisionURL : Configuration.getSupervisionURLs());
 907     let indexUrl = 0;
 908     if (!Utils.isEmptyArray(supervisionUrls)) {
 909       if (Configuration.getDistributeStationsToTenantsEqually()) {
 910         indexUrl = this.index % supervisionUrls.length;
 911       } else {
 912         // Get a random url
 913         indexUrl = Math.floor(Math.random() * supervisionUrls.length);
 914       }
 915       return new URL(supervisionUrls[indexUrl]);
 916     }
 917     return new URL(supervisionUrls as string);
 918   }
 919
 920   private getHeartbeatInterval(): number | undefined {
 921     const HeartbeatInterval = this.getConfigurationKey(StandardParametersKey.HeartbeatInterval);
 922     if (HeartbeatInterval) {
 923       return Utils.convertToInt(HeartbeatInterval.value) * 1000;
 924     }
 925     const HeartBeatInterval = this.getConfigurationKey(StandardParametersKey.HeartBeatInterval);
 926     if (HeartBeatInterval) {
 927       return Utils.convertToInt(HeartBeatInterval.value) * 1000;
 928     }
 929     !this.stationInfo.autoRegister && logger.warn(`${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${Constants.DEFAULT_HEARTBEAT_INTERVAL}`);
 930     return Constants.DEFAULT_HEARTBEAT_INTERVAL;
 931   }
 932
 933   private stopHeartbeat(): void {
 934     if (this.heartbeatSetInterval) {
 935       clearInterval(this.heartbeatSetInterval);
 936     }
 937   }
 938
 939   private openWSConnection(options?: WebSocket.ClientOptions, forceCloseOpened = false): void {
 940     options ?? {} as WebSocket.ClientOptions;
 941     options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000;
 942     if (this.isWebSocketOpen() && forceCloseOpened) {
 943       this.wsConnection.close();
 944     }
 945     let protocol;
 946     switch (this.getOCPPVersion()) {
 947       case OCPPVersion.VERSION_16:
 948         protocol = 'ocpp' + OCPPVersion.VERSION_16;
 949         break;
 950       default:
 951         this.handleUnsupportedVersion(this.getOCPPVersion());
 952         break;
 953     }
 954     this.wsConnection = new WebSocket(this.wsConnectionUrl, protocol, options);
 955     logger.info(this.logPrefix() + ' Open OCPP connection to URL ' + this.wsConnectionUrl.toString());
 956   }
 957
 958   private stopMeterValues(connectorId: number) {
 959     if (this.getConnector(connectorId)?.transactionSetInterval) {
 960       clearInterval(this.getConnector(connectorId).transactionSetInterval);
 961     }
 962   }
 963
 964   private startAuthorizationFileMonitoring(): void {
 965     const authorizationFile = this.getAuthorizationFile();
 966     if (authorizationFile) {
 967       try {
 968         fs.watch(authorizationFile).on('change', () => {
 969           try {
 970             logger.debug(this.logPrefix() + ' Authorization file ' + authorizationFile + ' have changed, reload');
 971             // Initialize authorizedTags
 972             this.authorizedTags = this.getAuthorizedTags();
 973           } catch (error) {
 974             logger.error(this.logPrefix() + ' Authorization file monitoring error: %j', error);
 975           }
 976         });
 977       } catch (error) {
 978         FileUtils.handleFileException(this.logPrefix(), 'Authorization', authorizationFile, error);
 979       }
 980     } else {
 981       logger.info(this.logPrefix() + ' No authorization file given in template file ' + this.stationTemplateFile + '. Not monitoring changes');
 982     }
 983   }
 984
 985   private startStationTemplateFileMonitoring(): void {
 986     try {
 987       // eslint-disable-next-line @typescript-eslint/no-misused-promises
 988       fs.watch(this.stationTemplateFile).on('change', async (): Promise<void> => {
 989         try {
 990           logger.debug(this.logPrefix() + ' Template file ' + this.stationTemplateFile + ' have changed, reload');
 991           // Initialize
 992           this.initialize();
 993           // Stop the ATG
 994           if (!this.stationInfo.AutomaticTransactionGenerator.enable &&
 995           this.automaticTransactionGeneration) {
 996             await this.automaticTransactionGeneration.stop();
 997           }
 998           // Start the ATG
 999           this.startAutomaticTransactionGenerator();
1000           // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed
1001         } catch (error) {
1002           logger.error(this.logPrefix() + ' Charging station template file monitoring error: %j', error);
1003         }
1004       });
1005     } catch (error) {
1006       FileUtils.handleFileException(this.logPrefix(), 'Template', this.stationTemplateFile, error);
1007     }
1008   }
1009
1010   private getReconnectExponentialDelay(): boolean | undefined {
1011     return !Utils.isUndefined(this.stationInfo.reconnectExponentialDelay) ? this.stationInfo.reconnectExponentialDelay : false;
1012   }
1013
1014   private async reconnect(error: any): Promise<void> {
1015     // Stop heartbeat
1016     this.stopHeartbeat();
1017     // Stop the ATG if needed
1018     if (this.stationInfo.AutomaticTransactionGenerator.enable &&
1019       this.stationInfo.AutomaticTransactionGenerator.stopOnConnectionFailure &&
1020       this.automaticTransactionGeneration &&
1021       !this.automaticTransactionGeneration.timeToStop) {
1022       await this.automaticTransactionGeneration.stop();
1023     }
1024     if (this.autoReconnectRetryCount < this.getAutoReconnectMaxRetries() || this.getAutoReconnectMaxRetries() === -1) {
1025       this.autoReconnectRetryCount++;
1026       const reconnectDelay = (this.getReconnectExponentialDelay() ? Utils.exponentialDelay(this.autoReconnectRetryCount) : this.getConnectionTimeout() * 1000);
1027       logger.error(`${this.logPrefix()} Socket: connection retry in ${Utils.roundTo(reconnectDelay, 2)}ms, timeout ${reconnectDelay - 100}ms`);
1028       await Utils.sleep(reconnectDelay);
1029       logger.error(this.logPrefix() + ' Socket: reconnecting try #' + this.autoReconnectRetryCount.toString());
1030       this.openWSConnection({ handshakeTimeout: reconnectDelay - 100 });
1031       this.hasSocketRestarted = true;
1032     } else if (this.getAutoReconnectMaxRetries() !== -1) {
1033       logger.error(`${this.logPrefix()} Socket reconnect failure: max retries reached (${this.autoReconnectRetryCount}) or retry disabled (${this.getAutoReconnectMaxRetries()})`);
1034     }
1035   }
1036
1037   private initTransactionAttributesOnConnector(connectorId: number): void {
1038     this.getConnector(connectorId).authorized = false;
1039     this.getConnector(connectorId).transactionStarted = false;
1040     this.getConnector(connectorId).energyActiveImportRegisterValue = 0;
1041     this.getConnector(connectorId).transactionEnergyActiveImportRegisterValue = 0;
1042   }
1043 }
1044