src/charging-station/ChargingStation.ts

   1 // Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
   2
   3 import crypto from 'crypto';
   4 import fs from 'fs';
   5 import path from 'path';
   6 import { URL } from 'url';
   7 import { parentPort } from 'worker_threads';
   8
   9 import WebSocket, { Data, RawData } from 'ws';
  10
  11 import BaseError from '../exception/BaseError';
  12 import OCPPError from '../exception/OCPPError';
  13 import PerformanceStatistics from '../performance/PerformanceStatistics';
  14 import { AutomaticTransactionGeneratorConfiguration } from '../types/AutomaticTransactionGenerator';
  15 import ChargingStationConfiguration from '../types/ChargingStationConfiguration';
  16 import ChargingStationInfo from '../types/ChargingStationInfo';
  17 import ChargingStationOcppConfiguration from '../types/ChargingStationOcppConfiguration';
  18 import ChargingStationTemplate, {
  19   CurrentType,
  20   PowerUnits,
  21   WsOptions,
  22 } from '../types/ChargingStationTemplate';
  23 import { SupervisionUrlDistribution } from '../types/ConfigurationData';
  24 import { ConnectorStatus } from '../types/ConnectorStatus';
  25 import { FileType } from '../types/FileType';
  26 import { JsonType } from '../types/JsonType';
  27 import { ChargePointErrorCode } from '../types/ocpp/ChargePointErrorCode';
  28 import { ChargePointStatus } from '../types/ocpp/ChargePointStatus';
  29 import { ChargingProfile, ChargingRateUnitType } from '../types/ocpp/ChargingProfile';
  30 import {
  31   ConnectorPhaseRotation,
  32   StandardParametersKey,
  33   SupportedFeatureProfiles,
  34   VendorDefaultParametersKey,
  35 } from '../types/ocpp/Configuration';
  36 import { ErrorType } from '../types/ocpp/ErrorType';
  37 import { MessageType } from '../types/ocpp/MessageType';
  38 import { MeterValue, MeterValueMeasurand } from '../types/ocpp/MeterValues';
  39 import { OCPPVersion } from '../types/ocpp/OCPPVersion';
  40 import {
  41   AvailabilityType,
  42   BootNotificationRequest,
  43   CachedRequest,
  44   HeartbeatRequest,
  45   IncomingRequest,
  46   IncomingRequestCommand,
  47   MeterValuesRequest,
  48   RequestCommand,
  49   StatusNotificationRequest,
  50 } from '../types/ocpp/Requests';
  51 import {
  52   BootNotificationResponse,
  53   ErrorResponse,
  54   HeartbeatResponse,
  55   MeterValuesResponse,
  56   RegistrationStatus,
  57   Response,
  58   StatusNotificationResponse,
  59 } from '../types/ocpp/Responses';
  60 import {
  61   StopTransactionReason,
  62   StopTransactionRequest,
  63   StopTransactionResponse,
  64 } from '../types/ocpp/Transaction';
  65 import { WSError, WebSocketCloseEventStatusCode } from '../types/WebSocket';
  66 import Configuration from '../utils/Configuration';
  67 import Constants from '../utils/Constants';
  68 import { ACElectricUtils, DCElectricUtils } from '../utils/ElectricUtils';
  69 import FileUtils from '../utils/FileUtils';
  70 import logger from '../utils/Logger';
  71 import Utils from '../utils/Utils';
  72 import AuthorizedTagsCache from './AuthorizedTagsCache';
  73 import AutomaticTransactionGenerator from './AutomaticTransactionGenerator';
  74 import { ChargingStationConfigurationUtils } from './ChargingStationConfigurationUtils';
  75 import { ChargingStationUtils } from './ChargingStationUtils';
  76 import ChargingStationWorkerBroadcastChannel from './ChargingStationWorkerBroadcastChannel';
  77 import { MessageChannelUtils } from './MessageChannelUtils';
  78 import OCPP16IncomingRequestService from './ocpp/1.6/OCPP16IncomingRequestService';
  79 import OCPP16RequestService from './ocpp/1.6/OCPP16RequestService';
  80 import OCPP16ResponseService from './ocpp/1.6/OCPP16ResponseService';
  81 import { OCPP16ServiceUtils } from './ocpp/1.6/OCPP16ServiceUtils';
  82 import OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService';
  83 import OCPPRequestService from './ocpp/OCPPRequestService';
  84 import SharedLRUCache from './SharedLRUCache';
  85
  86 export default class ChargingStation {
  87   public hashId!: string;
  88   public readonly templateFile: string;
  89   public authorizedTagsCache: AuthorizedTagsCache;
  90   public stationInfo!: ChargingStationInfo;
  91   public stopped: boolean;
  92   public readonly connectors: Map<number, ConnectorStatus>;
  93   public ocppConfiguration!: ChargingStationOcppConfiguration;
  94   public wsConnection!: WebSocket;
  95   public readonly requests: Map<string, CachedRequest>;
  96   public performanceStatistics!: PerformanceStatistics;
  97   public heartbeatSetInterval!: NodeJS.Timeout;
  98   public ocppRequestService!: OCPPRequestService;
  99   public bootNotificationResponse!: BootNotificationResponse | null;
 100   public powerDivider!: number;
 101   private readonly index: number;
 102   private configurationFile!: string;
 103   private configurationFileHash!: string;
 104   private bootNotificationRequest!: BootNotificationRequest;
 105   private connectorsConfigurationHash!: string;
 106   private ocppIncomingRequestService!: OCPPIncomingRequestService;
 107   private readonly messageBuffer: Set<string>;
 108   private configuredSupervisionUrl!: URL;
 109   private wsConnectionRestarted: boolean;
 110   private autoReconnectRetryCount: number;
 111   private templateFileWatcher!: fs.FSWatcher;
 112   private readonly sharedLRUCache: SharedLRUCache;
 113   private automaticTransactionGenerator!: AutomaticTransactionGenerator;
 114   private webSocketPingSetInterval!: NodeJS.Timeout;
 115   private readonly chargingStationWorkerBroadcastChannel: ChargingStationWorkerBroadcastChannel;
 116
 117   constructor(index: number, templateFile: string) {
 118     this.index = index;
 119     this.templateFile = templateFile;
 120     this.stopped = false;
 121     this.wsConnectionRestarted = false;
 122     this.autoReconnectRetryCount = 0;
 123     this.sharedLRUCache = SharedLRUCache.getInstance();
 124     this.authorizedTagsCache = AuthorizedTagsCache.getInstance();
 125     this.connectors = new Map<number, ConnectorStatus>();
 126     this.requests = new Map<string, CachedRequest>();
 127     this.messageBuffer = new Set<string>();
 128     this.chargingStationWorkerBroadcastChannel = new ChargingStationWorkerBroadcastChannel(this);
 129
 130     this.initialize();
 131   }
 132
 133   private get wsConnectionUrl(): URL {
 134     return new URL(
 135       (this.getSupervisionUrlOcppConfiguration()
 136         ? ChargingStationConfigurationUtils.getConfigurationKey(
 137             this,
 138             this.getSupervisionUrlOcppKey()
 139           ).value
 140         : this.configuredSupervisionUrl.href) +
 141         '/' +
 142         this.stationInfo.chargingStationId
 143     );
 144   }
 145
 146   public logPrefix(): string {
 147     return Utils.logPrefix(
 148       ` ${
 149         this?.stationInfo?.chargingStationId ??
 150         ChargingStationUtils.getChargingStationId(this.index, this.getTemplateFromFile())
 151       } |`
 152     );
 153   }
 154
 155   public getBootNotificationRequest(): BootNotificationRequest {
 156     return this.bootNotificationRequest;
 157   }
 158
 159   public getRandomIdTag(): string {
 160     const authorizationFile = ChargingStationUtils.getAuthorizationFile(this.stationInfo);
 161     const index = Math.floor(
 162       Utils.secureRandom() * this.authorizedTagsCache.getAuthorizedTags(authorizationFile).length
 163     );
 164     return this.authorizedTagsCache.getAuthorizedTags(authorizationFile)[index];
 165   }
 166
 167   public hasAuthorizedTags(): boolean {
 168     return !Utils.isEmptyArray(
 169       this.authorizedTagsCache.getAuthorizedTags(
 170         ChargingStationUtils.getAuthorizationFile(this.stationInfo)
 171       )
 172     );
 173   }
 174
 175   public getEnableStatistics(): boolean | undefined {
 176     return !Utils.isUndefined(this.stationInfo.enableStatistics)
 177       ? this.stationInfo.enableStatistics
 178       : true;
 179   }
 180
 181   public getMayAuthorizeAtRemoteStart(): boolean | undefined {
 182     return this.stationInfo.mayAuthorizeAtRemoteStart ?? true;
 183   }
 184
 185   public getPayloadSchemaValidation(): boolean | undefined {
 186     return this.stationInfo.payloadSchemaValidation ?? true;
 187   }
 188
 189   public getNumberOfPhases(stationInfo?: ChargingStationInfo): number | undefined {
 190     const localStationInfo: ChargingStationInfo = stationInfo ?? this.stationInfo;
 191     switch (this.getCurrentOutType(stationInfo)) {
 192       case CurrentType.AC:
 193         return !Utils.isUndefined(localStationInfo.numberOfPhases)
 194           ? localStationInfo.numberOfPhases
 195           : 3;
 196       case CurrentType.DC:
 197         return 0;
 198     }
 199   }
 200
 201   public isWebSocketConnectionOpened(): boolean {
 202     return this?.wsConnection?.readyState === WebSocket.OPEN;
 203   }
 204
 205   public getRegistrationStatus(): RegistrationStatus {
 206     return this?.bootNotificationResponse?.status;
 207   }
 208
 209   public isInUnknownState(): boolean {
 210     return Utils.isNullOrUndefined(this?.bootNotificationResponse?.status);
 211   }
 212
 213   public isInPendingState(): boolean {
 214     return this?.bootNotificationResponse?.status === RegistrationStatus.PENDING;
 215   }
 216
 217   public isInAcceptedState(): boolean {
 218     return this?.bootNotificationResponse?.status === RegistrationStatus.ACCEPTED;
 219   }
 220
 221   public isInRejectedState(): boolean {
 222     return this?.bootNotificationResponse?.status === RegistrationStatus.REJECTED;
 223   }
 224
 225   public isRegistered(): boolean {
 226     return !this.isInUnknownState() && (this.isInAcceptedState() || this.isInPendingState());
 227   }
 228
 229   public isChargingStationAvailable(): boolean {
 230     return this.getConnectorStatus(0).availability === AvailabilityType.OPERATIVE;
 231   }
 232
 233   public isConnectorAvailable(id: number): boolean {
 234     return id > 0 && this.getConnectorStatus(id).availability === AvailabilityType.OPERATIVE;
 235   }
 236
 237   public getNumberOfConnectors(): number {
 238     return this.connectors.get(0) ? this.connectors.size - 1 : this.connectors.size;
 239   }
 240
 241   public getConnectorStatus(id: number): ConnectorStatus {
 242     return this.connectors.get(id);
 243   }
 244
 245   public getCurrentOutType(stationInfo?: ChargingStationInfo): CurrentType {
 246     return (stationInfo ?? this.stationInfo).currentOutType ?? CurrentType.AC;
 247   }
 248
 249   public getOcppStrictCompliance(): boolean {
 250     return this.stationInfo?.ocppStrictCompliance ?? false;
 251   }
 252
 253   public getVoltageOut(stationInfo?: ChargingStationInfo): number | undefined {
 254     const defaultVoltageOut = ChargingStationUtils.getDefaultVoltageOut(
 255       this.getCurrentOutType(stationInfo),
 256       this.templateFile,
 257       this.logPrefix()
 258     );
 259     const localStationInfo: ChargingStationInfo = stationInfo ?? this.stationInfo;
 260     return !Utils.isUndefined(localStationInfo.voltageOut)
 261       ? localStationInfo.voltageOut
 262       : defaultVoltageOut;
 263   }
 264
 265   public getConnectorMaximumAvailablePower(connectorId: number): number {
 266     let connectorAmperageLimitationPowerLimit: number;
 267     if (
 268       !Utils.isNullOrUndefined(this.getAmperageLimitation()) &&
 269       this.getAmperageLimitation() < this.stationInfo.maximumAmperage
 270     ) {
 271       connectorAmperageLimitationPowerLimit =
 272         (this.getCurrentOutType() === CurrentType.AC
 273           ? ACElectricUtils.powerTotal(
 274               this.getNumberOfPhases(),
 275               this.getVoltageOut(),
 276               this.getAmperageLimitation() * this.getNumberOfConnectors()
 277             )
 278           : DCElectricUtils.power(this.getVoltageOut(), this.getAmperageLimitation())) /
 279         this.powerDivider;
 280     }
 281     const connectorMaximumPower = this.getMaximumPower() / this.powerDivider;
 282     const connectorChargingProfilePowerLimit = this.getChargingProfilePowerLimit(connectorId);
 283     return Math.min(
 284       isNaN(connectorMaximumPower) ? Infinity : connectorMaximumPower,
 285       isNaN(connectorAmperageLimitationPowerLimit)
 286         ? Infinity
 287         : connectorAmperageLimitationPowerLimit,
 288       isNaN(connectorChargingProfilePowerLimit) ? Infinity : connectorChargingProfilePowerLimit
 289     );
 290   }
 291
 292   public getTransactionIdTag(transactionId: number): string | undefined {
 293     for (const connectorId of this.connectors.keys()) {
 294       if (connectorId > 0 && this.getConnectorStatus(connectorId).transactionId === transactionId) {
 295         return this.getConnectorStatus(connectorId).transactionIdTag;
 296       }
 297     }
 298   }
 299
 300   public getOutOfOrderEndMeterValues(): boolean {
 301     return this.stationInfo?.outOfOrderEndMeterValues ?? false;
 302   }
 303
 304   public getBeginEndMeterValues(): boolean {
 305     return this.stationInfo?.beginEndMeterValues ?? false;
 306   }
 307
 308   public getMeteringPerTransaction(): boolean {
 309     return this.stationInfo?.meteringPerTransaction ?? true;
 310   }
 311
 312   public getTransactionDataMeterValues(): boolean {
 313     return this.stationInfo?.transactionDataMeterValues ?? false;
 314   }
 315
 316   public getMainVoltageMeterValues(): boolean {
 317     return this.stationInfo?.mainVoltageMeterValues ?? true;
 318   }
 319
 320   public getPhaseLineToLineVoltageMeterValues(): boolean {
 321     return this.stationInfo?.phaseLineToLineVoltageMeterValues ?? false;
 322   }
 323
 324   public getCustomValueLimitationMeterValues(): boolean {
 325     return this.stationInfo?.customValueLimitationMeterValues ?? true;
 326   }
 327
 328   public getConnectorIdByTransactionId(transactionId: number): number | undefined {
 329     for (const connectorId of this.connectors.keys()) {
 330       if (
 331         connectorId > 0 &&
 332         this.getConnectorStatus(connectorId)?.transactionId === transactionId
 333       ) {
 334         return connectorId;
 335       }
 336     }
 337   }
 338
 339   public getEnergyActiveImportRegisterByTransactionId(transactionId: number): number {
 340     const transactionConnectorStatus = this.getConnectorStatus(
 341       this.getConnectorIdByTransactionId(transactionId)
 342     );
 343     if (this.getMeteringPerTransaction()) {
 344       return transactionConnectorStatus?.transactionEnergyActiveImportRegisterValue ?? 0;
 345     }
 346     return transactionConnectorStatus?.energyActiveImportRegisterValue ?? 0;
 347   }
 348
 349   public getEnergyActiveImportRegisterByConnectorId(connectorId: number): number {
 350     const connectorStatus = this.getConnectorStatus(connectorId);
 351     if (this.getMeteringPerTransaction()) {
 352       return connectorStatus?.transactionEnergyActiveImportRegisterValue ?? 0;
 353     }
 354     return connectorStatus?.energyActiveImportRegisterValue ?? 0;
 355   }
 356
 357   public getAuthorizeRemoteTxRequests(): boolean {
 358     const authorizeRemoteTxRequests = ChargingStationConfigurationUtils.getConfigurationKey(
 359       this,
 360       StandardParametersKey.AuthorizeRemoteTxRequests
 361     );
 362     return authorizeRemoteTxRequests
 363       ? Utils.convertToBoolean(authorizeRemoteTxRequests.value)
 364       : false;
 365   }
 366
 367   public getLocalAuthListEnabled(): boolean {
 368     const localAuthListEnabled = ChargingStationConfigurationUtils.getConfigurationKey(
 369       this,
 370       StandardParametersKey.LocalAuthListEnabled
 371     );
 372     return localAuthListEnabled ? Utils.convertToBoolean(localAuthListEnabled.value) : false;
 373   }
 374
 375   public startHeartbeat(): void {
 376     if (
 377       this.getHeartbeatInterval() &&
 378       this.getHeartbeatInterval() > 0 &&
 379       !this.heartbeatSetInterval
 380     ) {
 381       // eslint-disable-next-line @typescript-eslint/no-misused-promises
 382       this.heartbeatSetInterval = setInterval(async (): Promise<void> => {
 383         await this.ocppRequestService.requestHandler<HeartbeatRequest, HeartbeatResponse>(
 384           this,
 385           RequestCommand.HEARTBEAT
 386         );
 387       }, this.getHeartbeatInterval());
 388       logger.info(
 389         this.logPrefix() +
 390           ' Heartbeat started every ' +
 391           Utils.formatDurationMilliSeconds(this.getHeartbeatInterval())
 392       );
 393     } else if (this.heartbeatSetInterval) {
 394       logger.info(
 395         this.logPrefix() +
 396           ' Heartbeat already started every ' +
 397           Utils.formatDurationMilliSeconds(this.getHeartbeatInterval())
 398       );
 399     } else {
 400       logger.error(
 401         `${this.logPrefix()} Heartbeat interval set to ${
 402           this.getHeartbeatInterval()
 403             ? Utils.formatDurationMilliSeconds(this.getHeartbeatInterval())
 404             : this.getHeartbeatInterval()
 405         }, not starting the heartbeat`
 406       );
 407     }
 408   }
 409
 410   public restartHeartbeat(): void {
 411     // Stop heartbeat
 412     this.stopHeartbeat();
 413     // Start heartbeat
 414     this.startHeartbeat();
 415   }
 416
 417   public restartWebSocketPing(): void {
 418     // Stop WebSocket ping
 419     this.stopWebSocketPing();
 420     // Start WebSocket ping
 421     this.startWebSocketPing();
 422   }
 423
 424   public startMeterValues(connectorId: number, interval: number): void {
 425     if (connectorId === 0) {
 426       logger.error(
 427         `${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId.toString()}`
 428       );
 429       return;
 430     }
 431     if (!this.getConnectorStatus(connectorId)) {
 432       logger.error(
 433         `${this.logPrefix()} Trying to start MeterValues on non existing connector Id ${connectorId.toString()}`
 434       );
 435       return;
 436     }
 437     if (!this.getConnectorStatus(connectorId)?.transactionStarted) {
 438       logger.error(
 439         `${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction started`
 440       );
 441       return;
 442     } else if (
 443       this.getConnectorStatus(connectorId)?.transactionStarted &&
 444       !this.getConnectorStatus(connectorId)?.transactionId
 445     ) {
 446       logger.error(
 447         `${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction id`
 448       );
 449       return;
 450     }
 451     if (interval > 0) {
 452       // eslint-disable-next-line @typescript-eslint/no-misused-promises
 453       this.getConnectorStatus(connectorId).transactionSetInterval = setInterval(
 454         // eslint-disable-next-line @typescript-eslint/no-misused-promises
 455         async (): Promise<void> => {
 456           // FIXME: Implement OCPP version agnostic helpers
 457           const meterValue: MeterValue = OCPP16ServiceUtils.buildMeterValue(
 458             this,
 459             connectorId,
 460             this.getConnectorStatus(connectorId).transactionId,
 461             interval
 462           );
 463           await this.ocppRequestService.requestHandler<MeterValuesRequest, MeterValuesResponse>(
 464             this,
 465             RequestCommand.METER_VALUES,
 466             {
 467               connectorId,
 468               transactionId: this.getConnectorStatus(connectorId).transactionId,
 469               meterValue: [meterValue],
 470             }
 471           );
 472         },
 473         interval
 474       );
 475     } else {
 476       logger.error(
 477         `${this.logPrefix()} Charging station ${
 478           StandardParametersKey.MeterValueSampleInterval
 479         } configuration set to ${
 480           interval ? Utils.formatDurationMilliSeconds(interval) : interval
 481         }, not sending MeterValues`
 482       );
 483     }
 484   }
 485
 486   public start(): void {
 487     if (this.getEnableStatistics()) {
 488       this.performanceStatistics.start();
 489     }
 490     this.openWSConnection();
 491     // Monitor charging station template file
 492     this.templateFileWatcher = FileUtils.watchJsonFile(
 493       this.logPrefix(),
 494       FileType.ChargingStationTemplate,
 495       this.templateFile,
 496       null,
 497       (event, filename): void => {
 498         if (filename && event === 'change') {
 499           try {
 500             logger.debug(
 501               `${this.logPrefix()} ${FileType.ChargingStationTemplate} ${
 502                 this.templateFile
 503               } file have changed, reload`
 504             );
 505             this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash);
 506             // Initialize
 507             this.initialize();
 508             // Restart the ATG
 509             this.stopAutomaticTransactionGenerator();
 510             this.startAutomaticTransactionGenerator();
 511             if (this.getEnableStatistics()) {
 512               this.performanceStatistics.restart();
 513             } else {
 514               this.performanceStatistics.stop();
 515             }
 516             // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed
 517           } catch (error) {
 518             logger.error(
 519               `${this.logPrefix()} ${FileType.ChargingStationTemplate} file monitoring error:`,
 520               error
 521             );
 522           }
 523         }
 524       }
 525     );
 526     parentPort.postMessage(MessageChannelUtils.buildStartedMessage(this));
 527   }
 528
 529   public async stop(reason: StopTransactionReason = StopTransactionReason.NONE): Promise<void> {
 530     // Stop message sequence
 531     await this.stopMessageSequence(reason);
 532     for (const connectorId of this.connectors.keys()) {
 533       if (connectorId > 0) {
 534         await this.ocppRequestService.requestHandler<
 535           StatusNotificationRequest,
 536           StatusNotificationResponse
 537         >(this, RequestCommand.STATUS_NOTIFICATION, {
 538           connectorId,
 539           status: ChargePointStatus.UNAVAILABLE,
 540           errorCode: ChargePointErrorCode.NO_ERROR,
 541         });
 542         this.getConnectorStatus(connectorId).status = ChargePointStatus.UNAVAILABLE;
 543       }
 544     }
 545     this.closeWSConnection();
 546     if (this.getEnableStatistics()) {
 547       this.performanceStatistics.stop();
 548     }
 549     this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash);
 550     this.templateFileWatcher.close();
 551     this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash);
 552     this.bootNotificationResponse = null;
 553     parentPort.postMessage(MessageChannelUtils.buildStoppedMessage(this));
 554     this.stopped = true;
 555   }
 556
 557   public async reset(reason?: StopTransactionReason): Promise<void> {
 558     await this.stop(reason);
 559     await Utils.sleep(this.stationInfo.resetTime);
 560     this.initialize();
 561     this.start();
 562   }
 563
 564   public saveOcppConfiguration(): void {
 565     if (this.getOcppPersistentConfiguration()) {
 566       this.saveConfiguration();
 567     }
 568   }
 569
 570   public getChargingProfilePowerLimit(connectorId: number): number | undefined {
 571     let limit: number, matchingChargingProfile: ChargingProfile;
 572     let chargingProfiles: ChargingProfile[] = [];
 573     // Get charging profiles for connector and sort by stack level
 574     chargingProfiles = this.getConnectorStatus(connectorId).chargingProfiles.sort(
 575       (a, b) => b.stackLevel - a.stackLevel
 576     );
 577     // Get profiles on connector 0
 578     if (this.getConnectorStatus(0).chargingProfiles) {
 579       chargingProfiles.push(
 580         ...this.getConnectorStatus(0).chargingProfiles.sort((a, b) => b.stackLevel - a.stackLevel)
 581       );
 582     }
 583     if (!Utils.isEmptyArray(chargingProfiles)) {
 584       const result = ChargingStationUtils.getLimitFromChargingProfiles(
 585         chargingProfiles,
 586         Utils.logPrefix()
 587       );
 588       if (!Utils.isNullOrUndefined(result)) {
 589         limit = result.limit;
 590         matchingChargingProfile = result.matchingChargingProfile;
 591         switch (this.getCurrentOutType()) {
 592           case CurrentType.AC:
 593             limit =
 594               matchingChargingProfile.chargingSchedule.chargingRateUnit ===
 595               ChargingRateUnitType.WATT
 596                 ? limit
 597                 : ACElectricUtils.powerTotal(this.getNumberOfPhases(), this.getVoltageOut(), limit);
 598             break;
 599           case CurrentType.DC:
 600             limit =
 601               matchingChargingProfile.chargingSchedule.chargingRateUnit ===
 602               ChargingRateUnitType.WATT
 603                 ? limit
 604                 : DCElectricUtils.power(this.getVoltageOut(), limit);
 605         }
 606
 607         const connectorMaximumPower = this.getMaximumPower() / this.powerDivider;
 608         if (limit > connectorMaximumPower) {
 609           logger.error(
 610             `${this.logPrefix()} Charging profile id ${
 611               matchingChargingProfile.chargingProfileId
 612             } limit is greater than connector id ${connectorId} maximum, dump charging profiles' stack: %j`,
 613             this.getConnectorStatus(connectorId).chargingProfiles
 614           );
 615           limit = connectorMaximumPower;
 616         }
 617       }
 618     }
 619     return limit;
 620   }
 621
 622   public setChargingProfile(connectorId: number, cp: ChargingProfile): void {
 623     if (Utils.isNullOrUndefined(this.getConnectorStatus(connectorId).chargingProfiles)) {
 624       logger.error(
 625         `${this.logPrefix()} Trying to set a charging profile on connectorId ${connectorId} with an uninitialized charging profiles array attribute, applying deferred initialization`
 626       );
 627       this.getConnectorStatus(connectorId).chargingProfiles = [];
 628     }
 629     if (!Array.isArray(this.getConnectorStatus(connectorId).chargingProfiles)) {
 630       logger.error(
 631         `${this.logPrefix()} Trying to set a charging profile on connectorId ${connectorId} with an improper attribute type for the charging profiles array, applying proper type initialization`
 632       );
 633       this.getConnectorStatus(connectorId).chargingProfiles = [];
 634     }
 635     let cpReplaced = false;
 636     if (!Utils.isEmptyArray(this.getConnectorStatus(connectorId).chargingProfiles)) {
 637       this.getConnectorStatus(connectorId).chargingProfiles?.forEach(
 638         (chargingProfile: ChargingProfile, index: number) => {
 639           if (
 640             chargingProfile.chargingProfileId === cp.chargingProfileId ||
 641             (chargingProfile.stackLevel === cp.stackLevel &&
 642               chargingProfile.chargingProfilePurpose === cp.chargingProfilePurpose)
 643           ) {
 644             this.getConnectorStatus(connectorId).chargingProfiles[index] = cp;
 645             cpReplaced = true;
 646           }
 647         }
 648       );
 649     }
 650     !cpReplaced && this.getConnectorStatus(connectorId).chargingProfiles?.push(cp);
 651   }
 652
 653   public resetConnectorStatus(connectorId: number): void {
 654     this.getConnectorStatus(connectorId).idTagLocalAuthorized = false;
 655     this.getConnectorStatus(connectorId).idTagAuthorized = false;
 656     this.getConnectorStatus(connectorId).transactionRemoteStarted = false;
 657     this.getConnectorStatus(connectorId).transactionStarted = false;
 658     delete this.getConnectorStatus(connectorId).localAuthorizeIdTag;
 659     delete this.getConnectorStatus(connectorId).authorizeIdTag;
 660     delete this.getConnectorStatus(connectorId).transactionId;
 661     delete this.getConnectorStatus(connectorId).transactionIdTag;
 662     this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue = 0;
 663     delete this.getConnectorStatus(connectorId).transactionBeginMeterValue;
 664     this.stopMeterValues(connectorId);
 665   }
 666
 667   public hasFeatureProfile(featureProfile: SupportedFeatureProfiles) {
 668     return ChargingStationConfigurationUtils.getConfigurationKey(
 669       this,
 670       StandardParametersKey.SupportedFeatureProfiles
 671     )?.value.includes(featureProfile);
 672   }
 673
 674   public bufferMessage(message: string): void {
 675     this.messageBuffer.add(message);
 676   }
 677
 678   private flushMessageBuffer() {
 679     if (this.messageBuffer.size > 0) {
 680       this.messageBuffer.forEach((message) => {
 681         // TODO: evaluate the need to track performance
 682         this.wsConnection.send(message);
 683         this.messageBuffer.delete(message);
 684       });
 685     }
 686   }
 687
 688   private getSupervisionUrlOcppConfiguration(): boolean {
 689     return this.stationInfo.supervisionUrlOcppConfiguration ?? false;
 690   }
 691
 692   private getSupervisionUrlOcppKey(): string {
 693     return this.stationInfo.supervisionUrlOcppKey ?? VendorDefaultParametersKey.ConnectionUrl;
 694   }
 695
 696   private getTemplateFromFile(): ChargingStationTemplate | null {
 697     let template: ChargingStationTemplate = null;
 698     try {
 699       if (this.sharedLRUCache.hasChargingStationTemplate(this.stationInfo?.templateHash)) {
 700         template = this.sharedLRUCache.getChargingStationTemplate(this.stationInfo.templateHash);
 701       } else {
 702         const measureId = `${FileType.ChargingStationTemplate} read`;
 703         const beginId = PerformanceStatistics.beginMeasure(measureId);
 704         template = JSON.parse(
 705           fs.readFileSync(this.templateFile, 'utf8')
 706         ) as ChargingStationTemplate;
 707         PerformanceStatistics.endMeasure(measureId, beginId);
 708         template.templateHash = crypto
 709           .createHash(Constants.DEFAULT_HASH_ALGORITHM)
 710           .update(JSON.stringify(template))
 711           .digest('hex');
 712         this.sharedLRUCache.setChargingStationTemplate(template);
 713       }
 714     } catch (error) {
 715       FileUtils.handleFileException(
 716         this.logPrefix(),
 717         FileType.ChargingStationTemplate,
 718         this.templateFile,
 719         error as NodeJS.ErrnoException
 720       );
 721     }
 722     return template;
 723   }
 724
 725   private getStationInfoFromTemplate(): ChargingStationInfo {
 726     const stationTemplate: ChargingStationTemplate = this.getTemplateFromFile();
 727     if (Utils.isNullOrUndefined(stationTemplate)) {
 728       const errorMsg = 'Failed to read charging station template file';
 729       logger.error(`${this.logPrefix()} ${errorMsg}`);
 730       throw new BaseError(errorMsg);
 731     }
 732     if (Utils.isEmptyObject(stationTemplate)) {
 733       const errorMsg = `Empty charging station information from template file ${this.templateFile}`;
 734       logger.error(`${this.logPrefix()} ${errorMsg}`);
 735       throw new BaseError(errorMsg);
 736     }
 737     // Deprecation template keys section
 738     ChargingStationUtils.warnDeprecatedTemplateKey(
 739       stationTemplate,
 740       'supervisionUrl',
 741       this.templateFile,
 742       this.logPrefix(),
 743       "Use 'supervisionUrls' instead"
 744     );
 745     ChargingStationUtils.convertDeprecatedTemplateKey(
 746       stationTemplate,
 747       'supervisionUrl',
 748       'supervisionUrls'
 749     );
 750     const stationInfo: ChargingStationInfo =
 751       ChargingStationUtils.stationTemplateToStationInfo(stationTemplate);
 752     stationInfo.chargingStationId = ChargingStationUtils.getChargingStationId(
 753       this.index,
 754       stationTemplate
 755     );
 756     ChargingStationUtils.createSerialNumber(stationTemplate, stationInfo);
 757     if (!Utils.isEmptyArray(stationTemplate.power)) {
 758       stationTemplate.power = stationTemplate.power as number[];
 759       const powerArrayRandomIndex = Math.floor(Utils.secureRandom() * stationTemplate.power.length);
 760       stationInfo.maximumPower =
 761         stationTemplate.powerUnit === PowerUnits.KILO_WATT
 762           ? stationTemplate.power[powerArrayRandomIndex] * 1000
 763           : stationTemplate.power[powerArrayRandomIndex];
 764     } else {
 765       stationTemplate.power = stationTemplate.power as number;
 766       stationInfo.maximumPower =
 767         stationTemplate.powerUnit === PowerUnits.KILO_WATT
 768           ? stationTemplate.power * 1000
 769           : stationTemplate.power;
 770     }
 771     stationInfo.resetTime = stationTemplate.resetTime
 772       ? stationTemplate.resetTime * 1000
 773       : Constants.CHARGING_STATION_DEFAULT_RESET_TIME;
 774     const configuredMaxConnectors = ChargingStationUtils.getConfiguredNumberOfConnectors(
 775       this.index,
 776       stationTemplate
 777     );
 778     ChargingStationUtils.checkConfiguredMaxConnectors(
 779       configuredMaxConnectors,
 780       this.templateFile,
 781       Utils.logPrefix()
 782     );
 783     const templateMaxConnectors =
 784       ChargingStationUtils.getTemplateMaxNumberOfConnectors(stationTemplate);
 785     ChargingStationUtils.checkTemplateMaxConnectors(
 786       templateMaxConnectors,
 787       this.templateFile,
 788       Utils.logPrefix()
 789     );
 790     if (
 791       configuredMaxConnectors >
 792         (stationTemplate?.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) &&
 793       !stationTemplate?.randomConnectors
 794     ) {
 795       logger.warn(
 796         `${this.logPrefix()} Number of connectors exceeds the number of connector configurations in template ${
 797           this.templateFile
 798         }, forcing random connector configurations affectation`
 799       );
 800       stationInfo.randomConnectors = true;
 801     }
 802     // Build connectors if needed (FIXME: should be factored out)
 803     this.initializeConnectors(stationInfo, configuredMaxConnectors, templateMaxConnectors);
 804     stationInfo.maximumAmperage = this.getMaximumAmperage(stationInfo);
 805     ChargingStationUtils.createStationInfoHash(stationInfo);
 806     return stationInfo;
 807   }
 808
 809   private getStationInfoFromFile(): ChargingStationInfo | null {
 810     let stationInfo: ChargingStationInfo = null;
 811     this.getStationInfoPersistentConfiguration() &&
 812       (stationInfo = this.getConfigurationFromFile()?.stationInfo ?? null);
 813     stationInfo && ChargingStationUtils.createStationInfoHash(stationInfo);
 814     return stationInfo;
 815   }
 816
 817   private getStationInfo(): ChargingStationInfo {
 818     const stationInfoFromTemplate: ChargingStationInfo = this.getStationInfoFromTemplate();
 819     const stationInfoFromFile: ChargingStationInfo = this.getStationInfoFromFile();
 820     // Priority: charging station info from template > charging station info from configuration file > charging station info attribute
 821     if (stationInfoFromFile?.templateHash === stationInfoFromTemplate.templateHash) {
 822       if (this.stationInfo?.infoHash === stationInfoFromFile?.infoHash) {
 823         return this.stationInfo;
 824       }
 825       return stationInfoFromFile;
 826     }
 827     stationInfoFromFile &&
 828       ChargingStationUtils.propagateSerialNumber(
 829         this.getTemplateFromFile(),
 830         stationInfoFromFile,
 831         stationInfoFromTemplate
 832       );
 833     return stationInfoFromTemplate;
 834   }
 835
 836   private saveStationInfo(): void {
 837     if (this.getStationInfoPersistentConfiguration()) {
 838       this.saveConfiguration();
 839     }
 840   }
 841
 842   private getOcppVersion(): OCPPVersion {
 843     return this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16;
 844   }
 845
 846   private getOcppPersistentConfiguration(): boolean {
 847     return this.stationInfo?.ocppPersistentConfiguration ?? true;
 848   }
 849
 850   private getStationInfoPersistentConfiguration(): boolean {
 851     return this.stationInfo?.stationInfoPersistentConfiguration ?? true;
 852   }
 853
 854   private handleUnsupportedVersion(version: OCPPVersion) {
 855     const errMsg = `${this.logPrefix()} Unsupported protocol version '${version}' configured in template file ${
 856       this.templateFile
 857     }`;
 858     logger.error(errMsg);
 859     throw new Error(errMsg);
 860   }
 861
 862   private initialize(): void {
 863     this.hashId = ChargingStationUtils.getHashId(this.index, this.getTemplateFromFile());
 864     logger.info(`${this.logPrefix()} Charging station hashId '${this.hashId}'`);
 865     this.configurationFile = path.join(
 866       path.dirname(this.templateFile.replace('station-templates', 'configurations')),
 867       this.hashId + '.json'
 868     );
 869     this.stationInfo = this.getStationInfo();
 870     this.saveStationInfo();
 871     // Avoid duplication of connectors related information in RAM
 872     this.stationInfo?.Connectors && delete this.stationInfo.Connectors;
 873     this.configuredSupervisionUrl = this.getConfiguredSupervisionUrl();
 874     if (this.getEnableStatistics()) {
 875       this.performanceStatistics = PerformanceStatistics.getInstance(
 876         this.hashId,
 877         this.stationInfo.chargingStationId,
 878         this.configuredSupervisionUrl
 879       );
 880     }
 881     this.bootNotificationRequest = ChargingStationUtils.createBootNotificationRequest(
 882       this.stationInfo
 883     );
 884     this.powerDivider = this.getPowerDivider();
 885     // OCPP configuration
 886     this.ocppConfiguration = this.getOcppConfiguration();
 887     this.initializeOcppConfiguration();
 888     switch (this.getOcppVersion()) {
 889       case OCPPVersion.VERSION_16:
 890         this.ocppIncomingRequestService =
 891           OCPP16IncomingRequestService.getInstance<OCPP16IncomingRequestService>();
 892         this.ocppRequestService = OCPP16RequestService.getInstance<OCPP16RequestService>(
 893           OCPP16ResponseService.getInstance<OCPP16ResponseService>()
 894         );
 895         break;
 896       default:
 897         this.handleUnsupportedVersion(this.getOcppVersion());
 898         break;
 899     }
 900     if (this.stationInfo?.autoRegister) {
 901       this.bootNotificationResponse = {
 902         currentTime: new Date().toISOString(),
 903         interval: this.getHeartbeatInterval() / 1000,
 904         status: RegistrationStatus.ACCEPTED,
 905       };
 906     }
 907   }
 908
 909   private initializeOcppConfiguration(): void {
 910     if (
 911       !ChargingStationConfigurationUtils.getConfigurationKey(
 912         this,
 913         StandardParametersKey.HeartbeatInterval
 914       )
 915     ) {
 916       ChargingStationConfigurationUtils.addConfigurationKey(
 917         this,
 918         StandardParametersKey.HeartbeatInterval,
 919         '0'
 920       );
 921     }
 922     if (
 923       !ChargingStationConfigurationUtils.getConfigurationKey(
 924         this,
 925         StandardParametersKey.HeartBeatInterval
 926       )
 927     ) {
 928       ChargingStationConfigurationUtils.addConfigurationKey(
 929         this,
 930         StandardParametersKey.HeartBeatInterval,
 931         '0',
 932         { visible: false }
 933       );
 934     }
 935     if (
 936       this.getSupervisionUrlOcppConfiguration() &&
 937       !ChargingStationConfigurationUtils.getConfigurationKey(this, this.getSupervisionUrlOcppKey())
 938     ) {
 939       ChargingStationConfigurationUtils.addConfigurationKey(
 940         this,
 941         this.getSupervisionUrlOcppKey(),
 942         this.configuredSupervisionUrl.href,
 943         { reboot: true }
 944       );
 945     } else if (
 946       !this.getSupervisionUrlOcppConfiguration() &&
 947       ChargingStationConfigurationUtils.getConfigurationKey(this, this.getSupervisionUrlOcppKey())
 948     ) {
 949       ChargingStationConfigurationUtils.deleteConfigurationKey(
 950         this,
 951         this.getSupervisionUrlOcppKey(),
 952         { save: false }
 953       );
 954     }
 955     if (
 956       this.stationInfo.amperageLimitationOcppKey &&
 957       !ChargingStationConfigurationUtils.getConfigurationKey(
 958         this,
 959         this.stationInfo.amperageLimitationOcppKey
 960       )
 961     ) {
 962       ChargingStationConfigurationUtils.addConfigurationKey(
 963         this,
 964         this.stationInfo.amperageLimitationOcppKey,
 965         (
 966           this.stationInfo.maximumAmperage *
 967           ChargingStationUtils.getAmperageLimitationUnitDivider(this.stationInfo)
 968         ).toString()
 969       );
 970     }
 971     if (
 972       !ChargingStationConfigurationUtils.getConfigurationKey(
 973         this,
 974         StandardParametersKey.SupportedFeatureProfiles
 975       )
 976     ) {
 977       ChargingStationConfigurationUtils.addConfigurationKey(
 978         this,
 979         StandardParametersKey.SupportedFeatureProfiles,
 980         `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.FirmwareManagement},${SupportedFeatureProfiles.LocalAuthListManagement},${SupportedFeatureProfiles.SmartCharging},${SupportedFeatureProfiles.RemoteTrigger}`
 981       );
 982     }
 983     ChargingStationConfigurationUtils.addConfigurationKey(
 984       this,
 985       StandardParametersKey.NumberOfConnectors,
 986       this.getNumberOfConnectors().toString(),
 987       { readonly: true },
 988       { overwrite: true }
 989     );
 990     if (
 991       !ChargingStationConfigurationUtils.getConfigurationKey(
 992         this,
 993         StandardParametersKey.MeterValuesSampledData
 994       )
 995     ) {
 996       ChargingStationConfigurationUtils.addConfigurationKey(
 997         this,
 998         StandardParametersKey.MeterValuesSampledData,
 999         MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER
1000       );
1001     }
1002     if (
1003       !ChargingStationConfigurationUtils.getConfigurationKey(
1004         this,
1005         StandardParametersKey.ConnectorPhaseRotation
1006       )
1007     ) {
1008       const connectorPhaseRotation = [];
1009       for (const connectorId of this.connectors.keys()) {
1010         // AC/DC
1011         if (connectorId === 0 && this.getNumberOfPhases() === 0) {
1012           connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.RST}`);
1013         } else if (connectorId > 0 && this.getNumberOfPhases() === 0) {
1014           connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.NotApplicable}`);
1015           // AC
1016         } else if (connectorId > 0 && this.getNumberOfPhases() === 1) {
1017           connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.NotApplicable}`);
1018         } else if (connectorId > 0 && this.getNumberOfPhases() === 3) {
1019           connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.RST}`);
1020         }
1021       }
1022       ChargingStationConfigurationUtils.addConfigurationKey(
1023         this,
1024         StandardParametersKey.ConnectorPhaseRotation,
1025         connectorPhaseRotation.toString()
1026       );
1027     }
1028     if (
1029       !ChargingStationConfigurationUtils.getConfigurationKey(
1030         this,
1031         StandardParametersKey.AuthorizeRemoteTxRequests
1032       )
1033     ) {
1034       ChargingStationConfigurationUtils.addConfigurationKey(
1035         this,
1036         StandardParametersKey.AuthorizeRemoteTxRequests,
1037         'true'
1038       );
1039     }
1040     if (
1041       !ChargingStationConfigurationUtils.getConfigurationKey(
1042         this,
1043         StandardParametersKey.LocalAuthListEnabled
1044       ) &&
1045       ChargingStationConfigurationUtils.getConfigurationKey(
1046         this,
1047         StandardParametersKey.SupportedFeatureProfiles
1048       )?.value.includes(SupportedFeatureProfiles.LocalAuthListManagement)
1049     ) {
1050       ChargingStationConfigurationUtils.addConfigurationKey(
1051         this,
1052         StandardParametersKey.LocalAuthListEnabled,
1053         'false'
1054       );
1055     }
1056     if (
1057       !ChargingStationConfigurationUtils.getConfigurationKey(
1058         this,
1059         StandardParametersKey.ConnectionTimeOut
1060       )
1061     ) {
1062       ChargingStationConfigurationUtils.addConfigurationKey(
1063         this,
1064         StandardParametersKey.ConnectionTimeOut,
1065         Constants.DEFAULT_CONNECTION_TIMEOUT.toString()
1066       );
1067     }
1068     this.saveOcppConfiguration();
1069   }
1070
1071   private initializeConnectors(
1072     stationInfo: ChargingStationInfo,
1073     configuredMaxConnectors: number,
1074     templateMaxConnectors: number
1075   ): void {
1076     if (!stationInfo?.Connectors && this.connectors.size === 0) {
1077       const logMsg = `${this.logPrefix()} No already defined connectors and charging station information from template ${
1078         this.templateFile
1079       } with no connectors configuration defined`;
1080       logger.error(logMsg);
1081       throw new BaseError(logMsg);
1082     }
1083     if (!stationInfo?.Connectors[0]) {
1084       logger.warn(
1085         `${this.logPrefix()} Charging station information from template ${
1086           this.templateFile
1087         } with no connector Id 0 configuration`
1088       );
1089     }
1090     if (stationInfo?.Connectors) {
1091       const connectorsConfigHash = crypto
1092         .createHash(Constants.DEFAULT_HASH_ALGORITHM)
1093         .update(JSON.stringify(stationInfo?.Connectors) + configuredMaxConnectors.toString())
1094         .digest('hex');
1095       const connectorsConfigChanged =
1096         this.connectors?.size !== 0 && this.connectorsConfigurationHash !== connectorsConfigHash;
1097       if (this.connectors?.size === 0 || connectorsConfigChanged) {
1098         connectorsConfigChanged && this.connectors.clear();
1099         this.connectorsConfigurationHash = connectorsConfigHash;
1100         // Add connector Id 0
1101         let lastConnector = '0';
1102         for (lastConnector in stationInfo?.Connectors) {
1103           const lastConnectorId = Utils.convertToInt(lastConnector);
1104           if (
1105             lastConnectorId === 0 &&
1106             this.getUseConnectorId0(stationInfo) &&
1107             stationInfo?.Connectors[lastConnector]
1108           ) {
1109             this.connectors.set(
1110               lastConnectorId,
1111               Utils.cloneObject<ConnectorStatus>(stationInfo?.Connectors[lastConnector])
1112             );
1113             this.getConnectorStatus(lastConnectorId).availability = AvailabilityType.OPERATIVE;
1114             if (Utils.isUndefined(this.getConnectorStatus(lastConnectorId)?.chargingProfiles)) {
1115               this.getConnectorStatus(lastConnectorId).chargingProfiles = [];
1116             }
1117           }
1118         }
1119         // Generate all connectors
1120         if ((stationInfo?.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) > 0) {
1121           for (let index = 1; index <= configuredMaxConnectors; index++) {
1122             const randConnectorId = stationInfo?.randomConnectors
1123               ? Utils.getRandomInteger(Utils.convertToInt(lastConnector), 1)
1124               : index;
1125             this.connectors.set(
1126               index,
1127               Utils.cloneObject<ConnectorStatus>(stationInfo?.Connectors[randConnectorId])
1128             );
1129             this.getConnectorStatus(index).availability = AvailabilityType.OPERATIVE;
1130             if (Utils.isUndefined(this.getConnectorStatus(index)?.chargingProfiles)) {
1131               this.getConnectorStatus(index).chargingProfiles = [];
1132             }
1133           }
1134         }
1135       }
1136     } else {
1137       logger.warn(
1138         `${this.logPrefix()} Charging station information from template ${
1139           this.templateFile
1140         } with no connectors configuration defined, using already defined connectors`
1141       );
1142     }
1143     // Initialize transaction attributes on connectors
1144     for (const connectorId of this.connectors.keys()) {
1145       if (connectorId > 0 && !this.getConnectorStatus(connectorId)?.transactionStarted) {
1146         this.initializeConnectorStatus(connectorId);
1147       }
1148     }
1149   }
1150
1151   private getConfigurationFromFile(): ChargingStationConfiguration | null {
1152     let configuration: ChargingStationConfiguration = null;
1153     if (this.configurationFile && fs.existsSync(this.configurationFile)) {
1154       try {
1155         if (this.sharedLRUCache.hasChargingStationConfiguration(this.configurationFileHash)) {
1156           configuration = this.sharedLRUCache.getChargingStationConfiguration(
1157             this.configurationFileHash
1158           );
1159         } else {
1160           const measureId = `${FileType.ChargingStationConfiguration} read`;
1161           const beginId = PerformanceStatistics.beginMeasure(measureId);
1162           configuration = JSON.parse(
1163             fs.readFileSync(this.configurationFile, 'utf8')
1164           ) as ChargingStationConfiguration;
1165           PerformanceStatistics.endMeasure(measureId, beginId);
1166           this.configurationFileHash = configuration.configurationHash;
1167           this.sharedLRUCache.setChargingStationConfiguration(configuration);
1168         }
1169       } catch (error) {
1170         FileUtils.handleFileException(
1171           this.logPrefix(),
1172           FileType.ChargingStationConfiguration,
1173           this.configurationFile,
1174           error as NodeJS.ErrnoException
1175         );
1176       }
1177     }
1178     return configuration;
1179   }
1180
1181   private saveConfiguration(): void {
1182     if (this.configurationFile) {
1183       try {
1184         if (!fs.existsSync(path.dirname(this.configurationFile))) {
1185           fs.mkdirSync(path.dirname(this.configurationFile), { recursive: true });
1186         }
1187         const configurationData: ChargingStationConfiguration =
1188           this.getConfigurationFromFile() ?? {};
1189         this.ocppConfiguration?.configurationKey &&
1190           (configurationData.configurationKey = this.ocppConfiguration.configurationKey);
1191         this.stationInfo && (configurationData.stationInfo = this.stationInfo);
1192         delete configurationData.configurationHash;
1193         const configurationHash = crypto
1194           .createHash(Constants.DEFAULT_HASH_ALGORITHM)
1195           .update(JSON.stringify(configurationData))
1196           .digest('hex');
1197         if (this.configurationFileHash !== configurationHash) {
1198           configurationData.configurationHash = configurationHash;
1199           const measureId = `${FileType.ChargingStationConfiguration} write`;
1200           const beginId = PerformanceStatistics.beginMeasure(measureId);
1201           const fileDescriptor = fs.openSync(this.configurationFile, 'w');
1202           fs.writeFileSync(fileDescriptor, JSON.stringify(configurationData, null, 2), 'utf8');
1203           fs.closeSync(fileDescriptor);
1204           PerformanceStatistics.endMeasure(measureId, beginId);
1205           this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash);
1206           this.configurationFileHash = configurationHash;
1207           this.sharedLRUCache.setChargingStationConfiguration(configurationData);
1208         } else {
1209           logger.debug(
1210             `${this.logPrefix()} Not saving unchanged charging station configuration file ${
1211               this.configurationFile
1212             }`
1213           );
1214         }
1215       } catch (error) {
1216         FileUtils.handleFileException(
1217           this.logPrefix(),
1218           FileType.ChargingStationConfiguration,
1219           this.configurationFile,
1220           error as NodeJS.ErrnoException
1221         );
1222       }
1223     } else {
1224       logger.error(
1225         `${this.logPrefix()} Trying to save charging station configuration to undefined configuration file`
1226       );
1227     }
1228   }
1229
1230   private getOcppConfigurationFromTemplate(): ChargingStationOcppConfiguration | null {
1231     return this.getTemplateFromFile()?.Configuration ?? null;
1232   }
1233
1234   private getOcppConfigurationFromFile(): ChargingStationOcppConfiguration | null {
1235     let configuration: ChargingStationConfiguration = null;
1236     if (this.getOcppPersistentConfiguration()) {
1237       const configurationFromFile = this.getConfigurationFromFile();
1238       configuration = configurationFromFile?.configurationKey && configurationFromFile;
1239     }
1240     configuration && delete configuration.stationInfo;
1241     return configuration;
1242   }
1243
1244   private getOcppConfiguration(): ChargingStationOcppConfiguration | null {
1245     let ocppConfiguration: ChargingStationOcppConfiguration = this.getOcppConfigurationFromFile();
1246     if (!ocppConfiguration) {
1247       ocppConfiguration = this.getOcppConfigurationFromTemplate();
1248     }
1249     return ocppConfiguration;
1250   }
1251
1252   private async onOpen(): Promise<void> {
1253     if (this.isWebSocketConnectionOpened()) {
1254       logger.info(
1255         `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} succeeded`
1256       );
1257       if (!this.isRegistered()) {
1258         // Send BootNotification
1259         let registrationRetryCount = 0;
1260         do {
1261           this.bootNotificationResponse = await this.ocppRequestService.requestHandler<
1262             BootNotificationRequest,
1263             BootNotificationResponse
1264           >(
1265             this,
1266             RequestCommand.BOOT_NOTIFICATION,
1267             {
1268               chargePointModel: this.bootNotificationRequest.chargePointModel,
1269               chargePointVendor: this.bootNotificationRequest.chargePointVendor,
1270               chargeBoxSerialNumber: this.bootNotificationRequest.chargeBoxSerialNumber,
1271               firmwareVersion: this.bootNotificationRequest.firmwareVersion,
1272               chargePointSerialNumber: this.bootNotificationRequest.chargePointSerialNumber,
1273               iccid: this.bootNotificationRequest.iccid,
1274               imsi: this.bootNotificationRequest.imsi,
1275               meterSerialNumber: this.bootNotificationRequest.meterSerialNumber,
1276               meterType: this.bootNotificationRequest.meterType,
1277             },
1278             { skipBufferingOnError: true }
1279           );
1280           if (!this.isRegistered()) {
1281             this.getRegistrationMaxRetries() !== -1 && registrationRetryCount++;
1282             await Utils.sleep(
1283               this.bootNotificationResponse?.interval
1284                 ? this.bootNotificationResponse.interval * 1000
1285                 : Constants.OCPP_DEFAULT_BOOT_NOTIFICATION_INTERVAL
1286             );
1287           }
1288         } while (
1289           !this.isRegistered() &&
1290           (registrationRetryCount <= this.getRegistrationMaxRetries() ||
1291             this.getRegistrationMaxRetries() === -1)
1292         );
1293       }
1294       if (this.isRegistered()) {
1295         if (this.isInAcceptedState()) {
1296           await this.startMessageSequence();
1297           this.wsConnectionRestarted && this.flushMessageBuffer();
1298         }
1299       } else {
1300         logger.error(
1301           `${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})`
1302         );
1303       }
1304       this.stopped && (this.stopped = false);
1305       this.autoReconnectRetryCount = 0;
1306       this.wsConnectionRestarted = false;
1307     } else {
1308       logger.warn(
1309         `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} failed`
1310       );
1311     }
1312   }
1313
1314   private async onClose(code: number, reason: string): Promise<void> {
1315     switch (code) {
1316       // Normal close
1317       case WebSocketCloseEventStatusCode.CLOSE_NORMAL:
1318       case WebSocketCloseEventStatusCode.CLOSE_NO_STATUS:
1319         logger.info(
1320           `${this.logPrefix()} WebSocket normally closed with status '${ChargingStationUtils.getWebSocketCloseEventStatusString(
1321             code
1322           )}' and reason '${reason}'`
1323         );
1324         this.autoReconnectRetryCount = 0;
1325         break;
1326       // Abnormal close
1327       default:
1328         logger.error(
1329           `${this.logPrefix()} WebSocket abnormally closed with status '${ChargingStationUtils.getWebSocketCloseEventStatusString(
1330             code
1331           )}' and reason '${reason}'`
1332         );
1333         await this.reconnect(code);
1334         break;
1335     }
1336   }
1337
1338   private async onMessage(data: Data): Promise<void> {
1339     let messageType: number;
1340     let messageId: string;
1341     let commandName: IncomingRequestCommand;
1342     let commandPayload: JsonType;
1343     let errorType: ErrorType;
1344     let errorMessage: string;
1345     let errorDetails: JsonType;
1346     let responseCallback: (payload: JsonType, requestPayload: JsonType) => void;
1347     let errorCallback: (error: OCPPError, requestStatistic?: boolean) => void;
1348     let requestCommandName: RequestCommand | IncomingRequestCommand;
1349     let requestPayload: JsonType;
1350     let cachedRequest: CachedRequest;
1351     let errMsg: string;
1352     try {
1353       const request = JSON.parse(data.toString()) as IncomingRequest | Response | ErrorResponse;
1354       if (Utils.isIterable(request)) {
1355         [messageType, messageId] = request;
1356         // Check the type of message
1357         switch (messageType) {
1358           // Incoming Message
1359           case MessageType.CALL_MESSAGE:
1360             [, , commandName, commandPayload] = request as IncomingRequest;
1361             if (this.getEnableStatistics()) {
1362               this.performanceStatistics.addRequestStatistic(commandName, messageType);
1363             }
1364             logger.debug(
1365               `${this.logPrefix()} << Command '${commandName}' received request payload: ${JSON.stringify(
1366                 request
1367               )}`
1368             );
1369             // Process the message
1370             await this.ocppIncomingRequestService.incomingRequestHandler(
1371               this,
1372               messageId,
1373               commandName,
1374               commandPayload
1375             );
1376             break;
1377           // Outcome Message
1378           case MessageType.CALL_RESULT_MESSAGE:
1379             [, , commandPayload] = request as Response;
1380             if (!this.requests.has(messageId)) {
1381               // Error
1382               throw new OCPPError(
1383                 ErrorType.INTERNAL_ERROR,
1384                 `Response for unknown message id ${messageId}`,
1385                 null,
1386                 commandPayload
1387               );
1388             }
1389             // Respond
1390             cachedRequest = this.requests.get(messageId);
1391             if (Utils.isIterable(cachedRequest)) {
1392               [responseCallback, , requestCommandName, requestPayload] = cachedRequest;
1393             } else {
1394               throw new OCPPError(
1395                 ErrorType.PROTOCOL_ERROR,
1396                 `Cached request for message id ${messageId} response is not iterable`,
1397                 null,
1398                 cachedRequest as unknown as JsonType
1399               );
1400             }
1401             logger.debug(
1402               `${this.logPrefix()} << Command '${
1403                 requestCommandName ?? 'unknown'
1404               }' received response payload: ${JSON.stringify(request)}`
1405             );
1406             responseCallback(commandPayload, requestPayload);
1407             break;
1408           // Error Message
1409           case MessageType.CALL_ERROR_MESSAGE:
1410             [, , errorType, errorMessage, errorDetails] = request as ErrorResponse;
1411             if (!this.requests.has(messageId)) {
1412               // Error
1413               throw new OCPPError(
1414                 ErrorType.INTERNAL_ERROR,
1415                 `Error response for unknown message id ${messageId}`,
1416                 null,
1417                 { errorType, errorMessage, errorDetails }
1418               );
1419             }
1420             cachedRequest = this.requests.get(messageId);
1421             if (Utils.isIterable(cachedRequest)) {
1422               [, errorCallback, requestCommandName] = cachedRequest;
1423             } else {
1424               throw new OCPPError(
1425                 ErrorType.PROTOCOL_ERROR,
1426                 `Cached request for message id ${messageId} error response is not iterable`,
1427                 null,
1428                 cachedRequest as unknown as JsonType
1429               );
1430             }
1431             logger.debug(
1432               `${this.logPrefix()} << Command '${
1433                 requestCommandName ?? 'unknown'
1434               }' received error payload: ${JSON.stringify(request)}`
1435             );
1436             errorCallback(new OCPPError(errorType, errorMessage, requestCommandName, errorDetails));
1437             break;
1438           // Error
1439           default:
1440             // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
1441             errMsg = `${this.logPrefix()} Wrong message type ${messageType}`;
1442             logger.error(errMsg);
1443             throw new OCPPError(ErrorType.PROTOCOL_ERROR, errMsg);
1444         }
1445         parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
1446       } else {
1447         throw new OCPPError(ErrorType.PROTOCOL_ERROR, 'Incoming message is not iterable', null, {
1448           payload: request,
1449         });
1450       }
1451     } catch (error) {
1452       // Log
1453       logger.error(
1454         "%s Incoming OCPP '%s' message '%j' matching cached request '%j' processing error:",
1455         this.logPrefix(),
1456         commandName ?? requestCommandName ?? null,
1457         data.toString(),
1458         this.requests.get(messageId),
1459         error
1460       );
1461       if (!(error instanceof OCPPError)) {
1462         logger.warn(
1463           "%s Error thrown at incoming OCPP '%s' message '%j' handling is not an OCPPError:",
1464           this.logPrefix(),
1465           commandName ?? requestCommandName ?? null,
1466           data.toString(),
1467           error
1468         );
1469       }
1470       // Send error
1471       messageType === MessageType.CALL_MESSAGE &&
1472         (await this.ocppRequestService.sendError(
1473           this,
1474           messageId,
1475           error as OCPPError,
1476           commandName ?? requestCommandName ?? null
1477         ));
1478     }
1479   }
1480
1481   private onPing(): void {
1482     logger.debug(this.logPrefix() + ' Received a WS ping (rfc6455) from the server');
1483   }
1484
1485   private onPong(): void {
1486     logger.debug(this.logPrefix() + ' Received a WS pong (rfc6455) from the server');
1487   }
1488
1489   private onError(error: WSError): void {
1490     this.closeWSConnection();
1491     logger.error(this.logPrefix() + ' WebSocket error:', error);
1492   }
1493
1494   private getUseConnectorId0(stationInfo?: ChargingStationInfo): boolean | undefined {
1495     const localStationInfo = stationInfo ?? this.stationInfo;
1496     return !Utils.isUndefined(localStationInfo.useConnectorId0)
1497       ? localStationInfo.useConnectorId0
1498       : true;
1499   }
1500
1501   private getNumberOfRunningTransactions(): number {
1502     let trxCount = 0;
1503     for (const connectorId of this.connectors.keys()) {
1504       if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted) {
1505         trxCount++;
1506       }
1507     }
1508     return trxCount;
1509   }
1510
1511   // 0 for disabling
1512   private getConnectionTimeout(): number | undefined {
1513     if (
1514       ChargingStationConfigurationUtils.getConfigurationKey(
1515         this,
1516         StandardParametersKey.ConnectionTimeOut
1517       )
1518     ) {
1519       return (
1520         parseInt(
1521           ChargingStationConfigurationUtils.getConfigurationKey(
1522             this,
1523             StandardParametersKey.ConnectionTimeOut
1524           ).value
1525         ) ?? Constants.DEFAULT_CONNECTION_TIMEOUT
1526       );
1527     }
1528     return Constants.DEFAULT_CONNECTION_TIMEOUT;
1529   }
1530
1531   // -1 for unlimited, 0 for disabling
1532   private getAutoReconnectMaxRetries(): number | undefined {
1533     if (!Utils.isUndefined(this.stationInfo.autoReconnectMaxRetries)) {
1534       return this.stationInfo.autoReconnectMaxRetries;
1535     }
1536     if (!Utils.isUndefined(Configuration.getAutoReconnectMaxRetries())) {
1537       return Configuration.getAutoReconnectMaxRetries();
1538     }
1539     return -1;
1540   }
1541
1542   // 0 for disabling
1543   private getRegistrationMaxRetries(): number | undefined {
1544     if (!Utils.isUndefined(this.stationInfo.registrationMaxRetries)) {
1545       return this.stationInfo.registrationMaxRetries;
1546     }
1547     return -1;
1548   }
1549
1550   private getPowerDivider(): number {
1551     let powerDivider = this.getNumberOfConnectors();
1552     if (this.stationInfo?.powerSharedByConnectors) {
1553       powerDivider = this.getNumberOfRunningTransactions();
1554     }
1555     return powerDivider;
1556   }
1557
1558   private getMaximumPower(stationInfo?: ChargingStationInfo): number {
1559     const localStationInfo = stationInfo ?? this.stationInfo;
1560     return (localStationInfo['maxPower'] as number) ?? localStationInfo.maximumPower;
1561   }
1562
1563   private getMaximumAmperage(stationInfo: ChargingStationInfo): number | undefined {
1564     const maximumPower = this.getMaximumPower(stationInfo);
1565     switch (this.getCurrentOutType(stationInfo)) {
1566       case CurrentType.AC:
1567         return ACElectricUtils.amperagePerPhaseFromPower(
1568           this.getNumberOfPhases(stationInfo),
1569           maximumPower / this.getNumberOfConnectors(),
1570           this.getVoltageOut(stationInfo)
1571         );
1572       case CurrentType.DC:
1573         return DCElectricUtils.amperage(maximumPower, this.getVoltageOut(stationInfo));
1574     }
1575   }
1576
1577   private getAmperageLimitation(): number | undefined {
1578     if (
1579       this.stationInfo.amperageLimitationOcppKey &&
1580       ChargingStationConfigurationUtils.getConfigurationKey(
1581         this,
1582         this.stationInfo.amperageLimitationOcppKey
1583       )
1584     ) {
1585       return (
1586         Utils.convertToInt(
1587           ChargingStationConfigurationUtils.getConfigurationKey(
1588             this,
1589             this.stationInfo.amperageLimitationOcppKey
1590           ).value
1591         ) / ChargingStationUtils.getAmperageLimitationUnitDivider(this.stationInfo)
1592       );
1593     }
1594   }
1595
1596   private async startMessageSequence(): Promise<void> {
1597     if (this.stationInfo?.autoRegister) {
1598       await this.ocppRequestService.requestHandler<
1599         BootNotificationRequest,
1600         BootNotificationResponse
1601       >(
1602         this,
1603         RequestCommand.BOOT_NOTIFICATION,
1604         {
1605           chargePointModel: this.bootNotificationRequest.chargePointModel,
1606           chargePointVendor: this.bootNotificationRequest.chargePointVendor,
1607           chargeBoxSerialNumber: this.bootNotificationRequest.chargeBoxSerialNumber,
1608           firmwareVersion: this.bootNotificationRequest.firmwareVersion,
1609           chargePointSerialNumber: this.bootNotificationRequest.chargePointSerialNumber,
1610           iccid: this.bootNotificationRequest.iccid,
1611           imsi: this.bootNotificationRequest.imsi,
1612           meterSerialNumber: this.bootNotificationRequest.meterSerialNumber,
1613           meterType: this.bootNotificationRequest.meterType,
1614         },
1615         { skipBufferingOnError: true }
1616       );
1617     }
1618     // Start WebSocket ping
1619     this.startWebSocketPing();
1620     // Start heartbeat
1621     this.startHeartbeat();
1622     // Initialize connectors status
1623     for (const connectorId of this.connectors.keys()) {
1624       if (connectorId === 0) {
1625         continue;
1626       } else if (
1627         !this.stopped &&
1628         !this.getConnectorStatus(connectorId)?.status &&
1629         this.getConnectorStatus(connectorId)?.bootStatus
1630       ) {
1631         // Send status in template at startup
1632         await this.ocppRequestService.requestHandler<
1633           StatusNotificationRequest,
1634           StatusNotificationResponse
1635         >(this, RequestCommand.STATUS_NOTIFICATION, {
1636           connectorId,
1637           status: this.getConnectorStatus(connectorId).bootStatus,
1638           errorCode: ChargePointErrorCode.NO_ERROR,
1639         });
1640         this.getConnectorStatus(connectorId).status =
1641           this.getConnectorStatus(connectorId).bootStatus;
1642       } else if (
1643         this.stopped &&
1644         this.getConnectorStatus(connectorId)?.status &&
1645         this.getConnectorStatus(connectorId)?.bootStatus
1646       ) {
1647         // Send status in template after reset
1648         await this.ocppRequestService.requestHandler<
1649           StatusNotificationRequest,
1650           StatusNotificationResponse
1651         >(this, RequestCommand.STATUS_NOTIFICATION, {
1652           connectorId,
1653           status: this.getConnectorStatus(connectorId).bootStatus,
1654           errorCode: ChargePointErrorCode.NO_ERROR,
1655         });
1656         this.getConnectorStatus(connectorId).status =
1657           this.getConnectorStatus(connectorId).bootStatus;
1658       } else if (!this.stopped && this.getConnectorStatus(connectorId)?.status) {
1659         // Send previous status at template reload
1660         await this.ocppRequestService.requestHandler<
1661           StatusNotificationRequest,
1662           StatusNotificationResponse
1663         >(this, RequestCommand.STATUS_NOTIFICATION, {
1664           connectorId,
1665           status: this.getConnectorStatus(connectorId).status,
1666           errorCode: ChargePointErrorCode.NO_ERROR,
1667         });
1668       } else {
1669         // Send default status
1670         await this.ocppRequestService.requestHandler<
1671           StatusNotificationRequest,
1672           StatusNotificationResponse
1673         >(this, RequestCommand.STATUS_NOTIFICATION, {
1674           connectorId,
1675           status: ChargePointStatus.AVAILABLE,
1676           errorCode: ChargePointErrorCode.NO_ERROR,
1677         });
1678         this.getConnectorStatus(connectorId).status = ChargePointStatus.AVAILABLE;
1679       }
1680     }
1681     // Start the ATG
1682     this.startAutomaticTransactionGenerator();
1683   }
1684
1685   private startAutomaticTransactionGenerator() {
1686     if (this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable) {
1687       if (!this.automaticTransactionGenerator) {
1688         this.automaticTransactionGenerator = AutomaticTransactionGenerator.getInstance(
1689           this.getAutomaticTransactionGeneratorConfigurationFromTemplate(),
1690           this
1691         );
1692       }
1693       if (!this.automaticTransactionGenerator.started) {
1694         this.automaticTransactionGenerator.start();
1695       }
1696     }
1697   }
1698
1699   private stopAutomaticTransactionGenerator(): void {
1700     if (this.automaticTransactionGenerator?.started) {
1701       this.automaticTransactionGenerator.stop();
1702       this.automaticTransactionGenerator = null;
1703     }
1704   }
1705
1706   private async stopMessageSequence(
1707     reason: StopTransactionReason = StopTransactionReason.NONE
1708   ): Promise<void> {
1709     // Stop WebSocket ping
1710     this.stopWebSocketPing();
1711     // Stop heartbeat
1712     this.stopHeartbeat();
1713     // Stop ongoing transactions
1714     if (this.automaticTransactionGenerator?.configuration?.enable) {
1715       this.stopAutomaticTransactionGenerator();
1716     } else {
1717       for (const connectorId of this.connectors.keys()) {
1718         if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted) {
1719           const transactionId = this.getConnectorStatus(connectorId).transactionId;
1720           if (
1721             this.getBeginEndMeterValues() &&
1722             this.getOcppStrictCompliance() &&
1723             !this.getOutOfOrderEndMeterValues()
1724           ) {
1725             // FIXME: Implement OCPP version agnostic helpers
1726             const transactionEndMeterValue = OCPP16ServiceUtils.buildTransactionEndMeterValue(
1727               this,
1728               connectorId,
1729               this.getEnergyActiveImportRegisterByTransactionId(transactionId)
1730             );
1731             await this.ocppRequestService.requestHandler<MeterValuesRequest, MeterValuesResponse>(
1732               this,
1733               RequestCommand.METER_VALUES,
1734               {
1735                 connectorId,
1736                 transactionId,
1737                 meterValue: [transactionEndMeterValue],
1738               }
1739             );
1740           }
1741           await this.ocppRequestService.requestHandler<
1742             StopTransactionRequest,
1743             StopTransactionResponse
1744           >(this, RequestCommand.STOP_TRANSACTION, {
1745             transactionId,
1746             meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId),
1747             idTag: this.getTransactionIdTag(transactionId),
1748             reason,
1749           });
1750         }
1751       }
1752     }
1753   }
1754
1755   private startWebSocketPing(): void {
1756     const webSocketPingInterval: number = ChargingStationConfigurationUtils.getConfigurationKey(
1757       this,
1758       StandardParametersKey.WebSocketPingInterval
1759     )
1760       ? Utils.convertToInt(
1761           ChargingStationConfigurationUtils.getConfigurationKey(
1762             this,
1763             StandardParametersKey.WebSocketPingInterval
1764           ).value
1765         )
1766       : 0;
1767     if (webSocketPingInterval > 0 && !this.webSocketPingSetInterval) {
1768       this.webSocketPingSetInterval = setInterval(() => {
1769         if (this.isWebSocketConnectionOpened()) {
1770           this.wsConnection.ping((): void => {
1771             /* This is intentional */
1772           });
1773         }
1774       }, webSocketPingInterval * 1000);
1775       logger.info(
1776         this.logPrefix() +
1777           ' WebSocket ping started every ' +
1778           Utils.formatDurationSeconds(webSocketPingInterval)
1779       );
1780     } else if (this.webSocketPingSetInterval) {
1781       logger.info(
1782         this.logPrefix() +
1783           ' WebSocket ping every ' +
1784           Utils.formatDurationSeconds(webSocketPingInterval) +
1785           ' already started'
1786       );
1787     } else {
1788       logger.error(
1789         `${this.logPrefix()} WebSocket ping interval set to ${
1790           webSocketPingInterval
1791             ? Utils.formatDurationSeconds(webSocketPingInterval)
1792             : webSocketPingInterval
1793         }, not starting the WebSocket ping`
1794       );
1795     }
1796   }
1797
1798   private stopWebSocketPing(): void {
1799     if (this.webSocketPingSetInterval) {
1800       clearInterval(this.webSocketPingSetInterval);
1801     }
1802   }
1803
1804   private getConfiguredSupervisionUrl(): URL {
1805     const supervisionUrls = Utils.cloneObject<string | string[]>(
1806       this.stationInfo.supervisionUrls ?? Configuration.getSupervisionUrls()
1807     );
1808     if (!Utils.isEmptyArray(supervisionUrls)) {
1809       let urlIndex = 0;
1810       switch (Configuration.getSupervisionUrlDistribution()) {
1811         case SupervisionUrlDistribution.ROUND_ROBIN:
1812           urlIndex = (this.index - 1) % supervisionUrls.length;
1813           break;
1814         case SupervisionUrlDistribution.RANDOM:
1815           // Get a random url
1816           urlIndex = Math.floor(Utils.secureRandom() * supervisionUrls.length);
1817           break;
1818         case SupervisionUrlDistribution.SEQUENTIAL:
1819           if (this.index <= supervisionUrls.length) {
1820             urlIndex = this.index - 1;
1821           } else {
1822             logger.warn(
1823               `${this.logPrefix()} No more configured supervision urls available, using the first one`
1824             );
1825           }
1826           break;
1827         default:
1828           logger.error(
1829             `${this.logPrefix()} Unknown supervision url distribution '${Configuration.getSupervisionUrlDistribution()}' from values '${SupervisionUrlDistribution.toString()}', defaulting to ${
1830               SupervisionUrlDistribution.ROUND_ROBIN
1831             }`
1832           );
1833           urlIndex = (this.index - 1) % supervisionUrls.length;
1834           break;
1835       }
1836       return new URL(supervisionUrls[urlIndex]);
1837     }
1838     return new URL(supervisionUrls as string);
1839   }
1840
1841   private getHeartbeatInterval(): number | undefined {
1842     const HeartbeatInterval = ChargingStationConfigurationUtils.getConfigurationKey(
1843       this,
1844       StandardParametersKey.HeartbeatInterval
1845     );
1846     if (HeartbeatInterval) {
1847       return Utils.convertToInt(HeartbeatInterval.value) * 1000;
1848     }
1849     const HeartBeatInterval = ChargingStationConfigurationUtils.getConfigurationKey(
1850       this,
1851       StandardParametersKey.HeartBeatInterval
1852     );
1853     if (HeartBeatInterval) {
1854       return Utils.convertToInt(HeartBeatInterval.value) * 1000;
1855     }
1856     !this.stationInfo?.autoRegister &&
1857       logger.warn(
1858         `${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${
1859           Constants.DEFAULT_HEARTBEAT_INTERVAL
1860         }`
1861       );
1862     return Constants.DEFAULT_HEARTBEAT_INTERVAL;
1863   }
1864
1865   private stopHeartbeat(): void {
1866     if (this.heartbeatSetInterval) {
1867       clearInterval(this.heartbeatSetInterval);
1868     }
1869   }
1870
1871   private openWSConnection(
1872     options: WsOptions = this.stationInfo?.wsOptions ?? {},
1873     params: { closeOpened?: boolean; terminateOpened?: boolean } = {
1874       closeOpened: false,
1875       terminateOpened: false,
1876     }
1877   ): void {
1878     options.handshakeTimeout = options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000;
1879     params.closeOpened = params?.closeOpened ?? false;
1880     params.terminateOpened = params?.terminateOpened ?? false;
1881     if (
1882       !Utils.isNullOrUndefined(this.stationInfo.supervisionUser) &&
1883       !Utils.isNullOrUndefined(this.stationInfo.supervisionPassword)
1884     ) {
1885       options.auth = `${this.stationInfo.supervisionUser}:${this.stationInfo.supervisionPassword}`;
1886     }
1887     if (params?.closeOpened) {
1888       this.closeWSConnection();
1889     }
1890     if (params?.terminateOpened) {
1891       this.terminateWSConnection();
1892     }
1893     let protocol: string;
1894     switch (this.getOcppVersion()) {
1895       case OCPPVersion.VERSION_16:
1896         protocol = 'ocpp' + OCPPVersion.VERSION_16;
1897         break;
1898       default:
1899         this.handleUnsupportedVersion(this.getOcppVersion());
1900         break;
1901     }
1902
1903     logger.info(
1904       this.logPrefix() + ' Open OCPP connection to URL ' + this.wsConnectionUrl.toString()
1905     );
1906
1907     this.wsConnection = new WebSocket(this.wsConnectionUrl, protocol, options);
1908
1909     // Handle WebSocket message
1910     this.wsConnection.on(
1911       'message',
1912       this.onMessage.bind(this) as (this: WebSocket, data: RawData, isBinary: boolean) => void
1913     );
1914     // Handle WebSocket error
1915     this.wsConnection.on(
1916       'error',
1917       this.onError.bind(this) as (this: WebSocket, error: Error) => void
1918     );
1919     // Handle WebSocket close
1920     this.wsConnection.on(
1921       'close',
1922       this.onClose.bind(this) as (this: WebSocket, code: number, reason: Buffer) => void
1923     );
1924     // Handle WebSocket open
1925     this.wsConnection.on('open', this.onOpen.bind(this) as (this: WebSocket) => void);
1926     // Handle WebSocket ping
1927     this.wsConnection.on('ping', this.onPing.bind(this) as (this: WebSocket, data: Buffer) => void);
1928     // Handle WebSocket pong
1929     this.wsConnection.on('pong', this.onPong.bind(this) as (this: WebSocket, data: Buffer) => void);
1930   }
1931
1932   private closeWSConnection(): void {
1933     if (this.isWebSocketConnectionOpened()) {
1934       this.wsConnection.close();
1935       this.wsConnection = null;
1936     }
1937   }
1938
1939   private terminateWSConnection(): void {
1940     if (this.isWebSocketConnectionOpened()) {
1941       this.wsConnection.terminate();
1942       this.wsConnection = null;
1943     }
1944   }
1945
1946   private stopMeterValues(connectorId: number) {
1947     if (this.getConnectorStatus(connectorId)?.transactionSetInterval) {
1948       clearInterval(this.getConnectorStatus(connectorId).transactionSetInterval);
1949     }
1950   }
1951
1952   private getReconnectExponentialDelay(): boolean | undefined {
1953     return !Utils.isUndefined(this.stationInfo.reconnectExponentialDelay)
1954       ? this.stationInfo.reconnectExponentialDelay
1955       : false;
1956   }
1957
1958   private async reconnect(code: number): Promise<void> {
1959     // Stop WebSocket ping
1960     this.stopWebSocketPing();
1961     // Stop heartbeat
1962     this.stopHeartbeat();
1963     // Stop the ATG if needed
1964     if (this.automaticTransactionGenerator?.configuration?.stopOnConnectionFailure) {
1965       this.stopAutomaticTransactionGenerator();
1966     }
1967     if (
1968       this.autoReconnectRetryCount < this.getAutoReconnectMaxRetries() ||
1969       this.getAutoReconnectMaxRetries() === -1
1970     ) {
1971       this.autoReconnectRetryCount++;
1972       const reconnectDelay = this.getReconnectExponentialDelay()
1973         ? Utils.exponentialDelay(this.autoReconnectRetryCount)
1974         : this.getConnectionTimeout() * 1000;
1975       const reconnectDelayWithdraw = 1000;
1976       const reconnectTimeout =
1977         reconnectDelay && reconnectDelay - reconnectDelayWithdraw > 0
1978           ? reconnectDelay - reconnectDelayWithdraw
1979           : 0;
1980       logger.error(
1981         `${this.logPrefix()} WebSocket: connection retry in ${Utils.roundTo(
1982           reconnectDelay,
1983           2
1984         )}ms, timeout ${reconnectTimeout}ms`
1985       );
1986       await Utils.sleep(reconnectDelay);
1987       logger.error(
1988         this.logPrefix() +
1989           ' WebSocket: reconnecting try #' +
1990           this.autoReconnectRetryCount.toString()
1991       );
1992       this.openWSConnection(
1993         { ...(this.stationInfo?.wsOptions ?? {}), handshakeTimeout: reconnectTimeout },
1994         { closeOpened: true }
1995       );
1996       this.wsConnectionRestarted = true;
1997     } else if (this.getAutoReconnectMaxRetries() !== -1) {
1998       logger.error(
1999         `${this.logPrefix()} WebSocket reconnect failure: maximum retries reached (${
2000           this.autoReconnectRetryCount
2001         }) or retry disabled (${this.getAutoReconnectMaxRetries()})`
2002       );
2003     }
2004   }
2005
2006   private getAutomaticTransactionGeneratorConfigurationFromTemplate(): AutomaticTransactionGeneratorConfiguration | null {
2007     return this.getTemplateFromFile()?.AutomaticTransactionGenerator ?? null;
2008   }
2009
2010   private initializeConnectorStatus(connectorId: number): void {
2011     this.getConnectorStatus(connectorId).idTagLocalAuthorized = false;
2012     this.getConnectorStatus(connectorId).idTagAuthorized = false;
2013     this.getConnectorStatus(connectorId).transactionRemoteStarted = false;
2014     this.getConnectorStatus(connectorId).transactionStarted = false;
2015     this.getConnectorStatus(connectorId).energyActiveImportRegisterValue = 0;
2016     this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue = 0;
2017   }
2018 }