src/charging-station/ChargingStation.ts

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