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 type { AutomaticTransactionGeneratorConfiguration } from '../types/AutomaticTransactionGenerator';
  15 import type ChargingStationConfiguration from '../types/ChargingStationConfiguration';
  16 import type ChargingStationInfo from '../types/ChargingStationInfo';
  17 import type 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 type { ConnectorStatus } from '../types/ConnectorStatus';
  25 import { FileType } from '../types/FileType';
  26 import type { 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 type OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService';
  83 import type 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     this.stopped = true;
 554     parentPort.postMessage(MessageChannelUtils.buildStoppedMessage(this));
 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         this.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) === false) {
 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   public openWSConnection(
 679     options: WsOptions = this.stationInfo?.wsOptions ?? {},
 680     params: { closeOpened?: boolean; terminateOpened?: boolean } = {
 681       closeOpened: false,
 682       terminateOpened: false,
 683     }
 684   ): void {
 685     options.handshakeTimeout = options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000;
 686     params.closeOpened = params?.closeOpened ?? false;
 687     params.terminateOpened = params?.terminateOpened ?? false;
 688     if (
 689       !Utils.isNullOrUndefined(this.stationInfo.supervisionUser) &&
 690       !Utils.isNullOrUndefined(this.stationInfo.supervisionPassword)
 691     ) {
 692       options.auth = `${this.stationInfo.supervisionUser}:${this.stationInfo.supervisionPassword}`;
 693     }
 694     if (params?.closeOpened) {
 695       this.closeWSConnection();
 696     }
 697     if (params?.terminateOpened) {
 698       this.terminateWSConnection();
 699     }
 700     let protocol: string;
 701     switch (this.getOcppVersion()) {
 702       case OCPPVersion.VERSION_16:
 703         protocol = 'ocpp' + OCPPVersion.VERSION_16;
 704         break;
 705       default:
 706         this.handleUnsupportedVersion(this.getOcppVersion());
 707         break;
 708     }
 709
 710     logger.info(
 711       this.logPrefix() + ' Open OCPP connection to URL ' + this.wsConnectionUrl.toString()
 712     );
 713
 714     this.wsConnection = new WebSocket(this.wsConnectionUrl, protocol, options);
 715
 716     // Handle WebSocket message
 717     this.wsConnection.on(
 718       'message',
 719       this.onMessage.bind(this) as (this: WebSocket, data: RawData, isBinary: boolean) => void
 720     );
 721     // Handle WebSocket error
 722     this.wsConnection.on(
 723       'error',
 724       this.onError.bind(this) as (this: WebSocket, error: Error) => void
 725     );
 726     // Handle WebSocket close
 727     this.wsConnection.on(
 728       'close',
 729       this.onClose.bind(this) as (this: WebSocket, code: number, reason: Buffer) => void
 730     );
 731     // Handle WebSocket open
 732     this.wsConnection.on('open', this.onOpen.bind(this) as (this: WebSocket) => void);
 733     // Handle WebSocket ping
 734     this.wsConnection.on('ping', this.onPing.bind(this) as (this: WebSocket, data: Buffer) => void);
 735     // Handle WebSocket pong
 736     this.wsConnection.on('pong', this.onPong.bind(this) as (this: WebSocket, data: Buffer) => void);
 737   }
 738
 739   public closeWSConnection(): void {
 740     if (this.isWebSocketConnectionOpened()) {
 741       this.wsConnection.close();
 742       this.wsConnection = null;
 743     }
 744   }
 745
 746   private flushMessageBuffer() {
 747     if (this.messageBuffer.size > 0) {
 748       this.messageBuffer.forEach((message) => {
 749         // TODO: evaluate the need to track performance
 750         this.wsConnection.send(message);
 751         this.messageBuffer.delete(message);
 752       });
 753     }
 754   }
 755
 756   private getSupervisionUrlOcppConfiguration(): boolean {
 757     return this.stationInfo.supervisionUrlOcppConfiguration ?? false;
 758   }
 759
 760   private getSupervisionUrlOcppKey(): string {
 761     return this.stationInfo.supervisionUrlOcppKey ?? VendorDefaultParametersKey.ConnectionUrl;
 762   }
 763
 764   private getTemplateFromFile(): ChargingStationTemplate | null {
 765     let template: ChargingStationTemplate = null;
 766     try {
 767       if (this.sharedLRUCache.hasChargingStationTemplate(this.stationInfo?.templateHash)) {
 768         template = this.sharedLRUCache.getChargingStationTemplate(this.stationInfo.templateHash);
 769       } else {
 770         const measureId = `${FileType.ChargingStationTemplate} read`;
 771         const beginId = PerformanceStatistics.beginMeasure(measureId);
 772         template = JSON.parse(
 773           fs.readFileSync(this.templateFile, 'utf8')
 774         ) as ChargingStationTemplate;
 775         PerformanceStatistics.endMeasure(measureId, beginId);
 776         template.templateHash = crypto
 777           .createHash(Constants.DEFAULT_HASH_ALGORITHM)
 778           .update(JSON.stringify(template))
 779           .digest('hex');
 780         this.sharedLRUCache.setChargingStationTemplate(template);
 781       }
 782     } catch (error) {
 783       FileUtils.handleFileException(
 784         this.logPrefix(),
 785         FileType.ChargingStationTemplate,
 786         this.templateFile,
 787         error as NodeJS.ErrnoException
 788       );
 789     }
 790     return template;
 791   }
 792
 793   private getStationInfoFromTemplate(): ChargingStationInfo {
 794     const stationTemplate: ChargingStationTemplate = this.getTemplateFromFile();
 795     if (Utils.isNullOrUndefined(stationTemplate)) {
 796       const errorMsg = 'Failed to read charging station template file';
 797       logger.error(`${this.logPrefix()} ${errorMsg}`);
 798       throw new BaseError(errorMsg);
 799     }
 800     if (Utils.isEmptyObject(stationTemplate)) {
 801       const errorMsg = `Empty charging station information from template file ${this.templateFile}`;
 802       logger.error(`${this.logPrefix()} ${errorMsg}`);
 803       throw new BaseError(errorMsg);
 804     }
 805     // Deprecation template keys section
 806     ChargingStationUtils.warnDeprecatedTemplateKey(
 807       stationTemplate,
 808       'supervisionUrl',
 809       this.templateFile,
 810       this.logPrefix(),
 811       "Use 'supervisionUrls' instead"
 812     );
 813     ChargingStationUtils.convertDeprecatedTemplateKey(
 814       stationTemplate,
 815       'supervisionUrl',
 816       'supervisionUrls'
 817     );
 818     const stationInfo: ChargingStationInfo =
 819       ChargingStationUtils.stationTemplateToStationInfo(stationTemplate);
 820     stationInfo.chargingStationId = ChargingStationUtils.getChargingStationId(
 821       this.index,
 822       stationTemplate
 823     );
 824     ChargingStationUtils.createSerialNumber(stationTemplate, stationInfo);
 825     if (!Utils.isEmptyArray(stationTemplate.power)) {
 826       stationTemplate.power = stationTemplate.power as number[];
 827       const powerArrayRandomIndex = Math.floor(Utils.secureRandom() * stationTemplate.power.length);
 828       stationInfo.maximumPower =
 829         stationTemplate.powerUnit === PowerUnits.KILO_WATT
 830           ? stationTemplate.power[powerArrayRandomIndex] * 1000
 831           : stationTemplate.power[powerArrayRandomIndex];
 832     } else {
 833       stationTemplate.power = stationTemplate.power as number;
 834       stationInfo.maximumPower =
 835         stationTemplate.powerUnit === PowerUnits.KILO_WATT
 836           ? stationTemplate.power * 1000
 837           : stationTemplate.power;
 838     }
 839     stationInfo.resetTime = stationTemplate.resetTime
 840       ? stationTemplate.resetTime * 1000
 841       : Constants.CHARGING_STATION_DEFAULT_RESET_TIME;
 842     const configuredMaxConnectors = ChargingStationUtils.getConfiguredNumberOfConnectors(
 843       this.index,
 844       stationTemplate
 845     );
 846     ChargingStationUtils.checkConfiguredMaxConnectors(
 847       configuredMaxConnectors,
 848       this.templateFile,
 849       this.logPrefix()
 850     );
 851     const templateMaxConnectors =
 852       ChargingStationUtils.getTemplateMaxNumberOfConnectors(stationTemplate);
 853     ChargingStationUtils.checkTemplateMaxConnectors(
 854       templateMaxConnectors,
 855       this.templateFile,
 856       this.logPrefix()
 857     );
 858     if (
 859       configuredMaxConnectors >
 860         (stationTemplate?.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) &&
 861       !stationTemplate?.randomConnectors
 862     ) {
 863       logger.warn(
 864         `${this.logPrefix()} Number of connectors exceeds the number of connector configurations in template ${
 865           this.templateFile
 866         }, forcing random connector configurations affectation`
 867       );
 868       stationInfo.randomConnectors = true;
 869     }
 870     // Build connectors if needed (FIXME: should be factored out)
 871     this.initializeConnectors(stationInfo, configuredMaxConnectors, templateMaxConnectors);
 872     stationInfo.maximumAmperage = this.getMaximumAmperage(stationInfo);
 873     ChargingStationUtils.createStationInfoHash(stationInfo);
 874     return stationInfo;
 875   }
 876
 877   private getStationInfoFromFile(): ChargingStationInfo | null {
 878     let stationInfo: ChargingStationInfo = null;
 879     this.getStationInfoPersistentConfiguration() &&
 880       (stationInfo = this.getConfigurationFromFile()?.stationInfo ?? null);
 881     stationInfo && ChargingStationUtils.createStationInfoHash(stationInfo);
 882     return stationInfo;
 883   }
 884
 885   private getStationInfo(): ChargingStationInfo {
 886     const stationInfoFromTemplate: ChargingStationInfo = this.getStationInfoFromTemplate();
 887     const stationInfoFromFile: ChargingStationInfo = this.getStationInfoFromFile();
 888     // Priority: charging station info from template > charging station info from configuration file > charging station info attribute
 889     if (stationInfoFromFile?.templateHash === stationInfoFromTemplate.templateHash) {
 890       if (this.stationInfo?.infoHash === stationInfoFromFile?.infoHash) {
 891         return this.stationInfo;
 892       }
 893       return stationInfoFromFile;
 894     }
 895     stationInfoFromFile &&
 896       ChargingStationUtils.propagateSerialNumber(
 897         this.getTemplateFromFile(),
 898         stationInfoFromFile,
 899         stationInfoFromTemplate
 900       );
 901     return stationInfoFromTemplate;
 902   }
 903
 904   private saveStationInfo(): void {
 905     if (this.getStationInfoPersistentConfiguration()) {
 906       this.saveConfiguration();
 907     }
 908   }
 909
 910   private getOcppVersion(): OCPPVersion {
 911     return this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16;
 912   }
 913
 914   private getOcppPersistentConfiguration(): boolean {
 915     return this.stationInfo?.ocppPersistentConfiguration ?? true;
 916   }
 917
 918   private getStationInfoPersistentConfiguration(): boolean {
 919     return this.stationInfo?.stationInfoPersistentConfiguration ?? true;
 920   }
 921
 922   private handleUnsupportedVersion(version: OCPPVersion) {
 923     const errMsg = `Unsupported protocol version '${version}' configured in template file ${this.templateFile}`;
 924     logger.error(`${this.logPrefix()} ${errMsg}`);
 925     throw new BaseError(errMsg);
 926   }
 927
 928   private initialize(): void {
 929     this.hashId = ChargingStationUtils.getHashId(this.index, this.getTemplateFromFile());
 930     logger.info(`${this.logPrefix()} Charging station hashId '${this.hashId}'`);
 931     this.configurationFile = path.join(
 932       path.dirname(this.templateFile.replace('station-templates', 'configurations')),
 933       this.hashId + '.json'
 934     );
 935     this.stationInfo = this.getStationInfo();
 936     this.saveStationInfo();
 937     // Avoid duplication of connectors related information in RAM
 938     this.stationInfo?.Connectors && delete this.stationInfo.Connectors;
 939     this.configuredSupervisionUrl = this.getConfiguredSupervisionUrl();
 940     if (this.getEnableStatistics()) {
 941       this.performanceStatistics = PerformanceStatistics.getInstance(
 942         this.hashId,
 943         this.stationInfo.chargingStationId,
 944         this.configuredSupervisionUrl
 945       );
 946     }
 947     this.bootNotificationRequest = ChargingStationUtils.createBootNotificationRequest(
 948       this.stationInfo
 949     );
 950     this.powerDivider = this.getPowerDivider();
 951     // OCPP configuration
 952     this.ocppConfiguration = this.getOcppConfiguration();
 953     this.initializeOcppConfiguration();
 954     switch (this.getOcppVersion()) {
 955       case OCPPVersion.VERSION_16:
 956         this.ocppIncomingRequestService =
 957           OCPP16IncomingRequestService.getInstance<OCPP16IncomingRequestService>();
 958         this.ocppRequestService = OCPP16RequestService.getInstance<OCPP16RequestService>(
 959           OCPP16ResponseService.getInstance<OCPP16ResponseService>()
 960         );
 961         break;
 962       default:
 963         this.handleUnsupportedVersion(this.getOcppVersion());
 964         break;
 965     }
 966     if (this.stationInfo?.autoRegister) {
 967       this.bootNotificationResponse = {
 968         currentTime: new Date().toISOString(),
 969         interval: this.getHeartbeatInterval() / 1000,
 970         status: RegistrationStatus.ACCEPTED,
 971       };
 972     }
 973   }
 974
 975   private initializeOcppConfiguration(): void {
 976     if (
 977       !ChargingStationConfigurationUtils.getConfigurationKey(
 978         this,
 979         StandardParametersKey.HeartbeatInterval
 980       )
 981     ) {
 982       ChargingStationConfigurationUtils.addConfigurationKey(
 983         this,
 984         StandardParametersKey.HeartbeatInterval,
 985         '0'
 986       );
 987     }
 988     if (
 989       !ChargingStationConfigurationUtils.getConfigurationKey(
 990         this,
 991         StandardParametersKey.HeartBeatInterval
 992       )
 993     ) {
 994       ChargingStationConfigurationUtils.addConfigurationKey(
 995         this,
 996         StandardParametersKey.HeartBeatInterval,
 997         '0',
 998         { visible: false }
 999       );
1000     }
1001     if (
1002       this.getSupervisionUrlOcppConfiguration() &&
1003       !ChargingStationConfigurationUtils.getConfigurationKey(this, this.getSupervisionUrlOcppKey())
1004     ) {
1005       ChargingStationConfigurationUtils.addConfigurationKey(
1006         this,
1007         this.getSupervisionUrlOcppKey(),
1008         this.configuredSupervisionUrl.href,
1009         { reboot: true }
1010       );
1011     } else if (
1012       !this.getSupervisionUrlOcppConfiguration() &&
1013       ChargingStationConfigurationUtils.getConfigurationKey(this, this.getSupervisionUrlOcppKey())
1014     ) {
1015       ChargingStationConfigurationUtils.deleteConfigurationKey(
1016         this,
1017         this.getSupervisionUrlOcppKey(),
1018         { save: false }
1019       );
1020     }
1021     if (
1022       this.stationInfo.amperageLimitationOcppKey &&
1023       !ChargingStationConfigurationUtils.getConfigurationKey(
1024         this,
1025         this.stationInfo.amperageLimitationOcppKey
1026       )
1027     ) {
1028       ChargingStationConfigurationUtils.addConfigurationKey(
1029         this,
1030         this.stationInfo.amperageLimitationOcppKey,
1031         (
1032           this.stationInfo.maximumAmperage *
1033           ChargingStationUtils.getAmperageLimitationUnitDivider(this.stationInfo)
1034         ).toString()
1035       );
1036     }
1037     if (
1038       !ChargingStationConfigurationUtils.getConfigurationKey(
1039         this,
1040         StandardParametersKey.SupportedFeatureProfiles
1041       )
1042     ) {
1043       ChargingStationConfigurationUtils.addConfigurationKey(
1044         this,
1045         StandardParametersKey.SupportedFeatureProfiles,
1046         `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.FirmwareManagement},${SupportedFeatureProfiles.LocalAuthListManagement},${SupportedFeatureProfiles.SmartCharging},${SupportedFeatureProfiles.RemoteTrigger}`
1047       );
1048     }
1049     ChargingStationConfigurationUtils.addConfigurationKey(
1050       this,
1051       StandardParametersKey.NumberOfConnectors,
1052       this.getNumberOfConnectors().toString(),
1053       { readonly: true },
1054       { overwrite: true }
1055     );
1056     if (
1057       !ChargingStationConfigurationUtils.getConfigurationKey(
1058         this,
1059         StandardParametersKey.MeterValuesSampledData
1060       )
1061     ) {
1062       ChargingStationConfigurationUtils.addConfigurationKey(
1063         this,
1064         StandardParametersKey.MeterValuesSampledData,
1065         MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER
1066       );
1067     }
1068     if (
1069       !ChargingStationConfigurationUtils.getConfigurationKey(
1070         this,
1071         StandardParametersKey.ConnectorPhaseRotation
1072       )
1073     ) {
1074       const connectorPhaseRotation = [];
1075       for (const connectorId of this.connectors.keys()) {
1076         // AC/DC
1077         if (connectorId === 0 && this.getNumberOfPhases() === 0) {
1078           connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.RST}`);
1079         } else if (connectorId > 0 && this.getNumberOfPhases() === 0) {
1080           connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.NotApplicable}`);
1081           // AC
1082         } else if (connectorId > 0 && this.getNumberOfPhases() === 1) {
1083           connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.NotApplicable}`);
1084         } else if (connectorId > 0 && this.getNumberOfPhases() === 3) {
1085           connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.RST}`);
1086         }
1087       }
1088       ChargingStationConfigurationUtils.addConfigurationKey(
1089         this,
1090         StandardParametersKey.ConnectorPhaseRotation,
1091         connectorPhaseRotation.toString()
1092       );
1093     }
1094     if (
1095       !ChargingStationConfigurationUtils.getConfigurationKey(
1096         this,
1097         StandardParametersKey.AuthorizeRemoteTxRequests
1098       )
1099     ) {
1100       ChargingStationConfigurationUtils.addConfigurationKey(
1101         this,
1102         StandardParametersKey.AuthorizeRemoteTxRequests,
1103         'true'
1104       );
1105     }
1106     if (
1107       !ChargingStationConfigurationUtils.getConfigurationKey(
1108         this,
1109         StandardParametersKey.LocalAuthListEnabled
1110       ) &&
1111       ChargingStationConfigurationUtils.getConfigurationKey(
1112         this,
1113         StandardParametersKey.SupportedFeatureProfiles
1114       )?.value.includes(SupportedFeatureProfiles.LocalAuthListManagement)
1115     ) {
1116       ChargingStationConfigurationUtils.addConfigurationKey(
1117         this,
1118         StandardParametersKey.LocalAuthListEnabled,
1119         'false'
1120       );
1121     }
1122     if (
1123       !ChargingStationConfigurationUtils.getConfigurationKey(
1124         this,
1125         StandardParametersKey.ConnectionTimeOut
1126       )
1127     ) {
1128       ChargingStationConfigurationUtils.addConfigurationKey(
1129         this,
1130         StandardParametersKey.ConnectionTimeOut,
1131         Constants.DEFAULT_CONNECTION_TIMEOUT.toString()
1132       );
1133     }
1134     this.saveOcppConfiguration();
1135   }
1136
1137   private initializeConnectors(
1138     stationInfo: ChargingStationInfo,
1139     configuredMaxConnectors: number,
1140     templateMaxConnectors: number
1141   ): void {
1142     if (!stationInfo?.Connectors && this.connectors.size === 0) {
1143       const logMsg = `No already defined connectors and charging station information from template ${this.templateFile} with no connectors configuration defined`;
1144       logger.error(`${this.logPrefix()} ${logMsg}`);
1145       throw new BaseError(logMsg);
1146     }
1147     if (!stationInfo?.Connectors[0]) {
1148       logger.warn(
1149         `${this.logPrefix()} Charging station information from template ${
1150           this.templateFile
1151         } with no connector Id 0 configuration`
1152       );
1153     }
1154     if (stationInfo?.Connectors) {
1155       const connectorsConfigHash = crypto
1156         .createHash(Constants.DEFAULT_HASH_ALGORITHM)
1157         .update(JSON.stringify(stationInfo?.Connectors) + configuredMaxConnectors.toString())
1158         .digest('hex');
1159       const connectorsConfigChanged =
1160         this.connectors?.size !== 0 && this.connectorsConfigurationHash !== connectorsConfigHash;
1161       if (this.connectors?.size === 0 || connectorsConfigChanged) {
1162         connectorsConfigChanged && this.connectors.clear();
1163         this.connectorsConfigurationHash = connectorsConfigHash;
1164         // Add connector Id 0
1165         let lastConnector = '0';
1166         for (lastConnector in stationInfo?.Connectors) {
1167           const lastConnectorId = Utils.convertToInt(lastConnector);
1168           if (
1169             lastConnectorId === 0 &&
1170             this.getUseConnectorId0(stationInfo) &&
1171             stationInfo?.Connectors[lastConnector]
1172           ) {
1173             this.connectors.set(
1174               lastConnectorId,
1175               Utils.cloneObject<ConnectorStatus>(stationInfo?.Connectors[lastConnector])
1176             );
1177             this.getConnectorStatus(lastConnectorId).availability = AvailabilityType.OPERATIVE;
1178             if (Utils.isUndefined(this.getConnectorStatus(lastConnectorId)?.chargingProfiles)) {
1179               this.getConnectorStatus(lastConnectorId).chargingProfiles = [];
1180             }
1181           }
1182         }
1183         // Generate all connectors
1184         if ((stationInfo?.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) > 0) {
1185           for (let index = 1; index <= configuredMaxConnectors; index++) {
1186             const randConnectorId = stationInfo?.randomConnectors
1187               ? Utils.getRandomInteger(Utils.convertToInt(lastConnector), 1)
1188               : index;
1189             this.connectors.set(
1190               index,
1191               Utils.cloneObject<ConnectorStatus>(stationInfo?.Connectors[randConnectorId])
1192             );
1193             this.getConnectorStatus(index).availability = AvailabilityType.OPERATIVE;
1194             if (Utils.isUndefined(this.getConnectorStatus(index)?.chargingProfiles)) {
1195               this.getConnectorStatus(index).chargingProfiles = [];
1196             }
1197           }
1198         }
1199       }
1200     } else {
1201       logger.warn(
1202         `${this.logPrefix()} Charging station information from template ${
1203           this.templateFile
1204         } with no connectors configuration defined, using already defined connectors`
1205       );
1206     }
1207     // Initialize transaction attributes on connectors
1208     for (const connectorId of this.connectors.keys()) {
1209       if (connectorId > 0 && !this.getConnectorStatus(connectorId)?.transactionStarted) {
1210         this.initializeConnectorStatus(connectorId);
1211       }
1212     }
1213   }
1214
1215   private getConfigurationFromFile(): ChargingStationConfiguration | null {
1216     let configuration: ChargingStationConfiguration = null;
1217     if (this.configurationFile && fs.existsSync(this.configurationFile)) {
1218       try {
1219         if (this.sharedLRUCache.hasChargingStationConfiguration(this.configurationFileHash)) {
1220           configuration = this.sharedLRUCache.getChargingStationConfiguration(
1221             this.configurationFileHash
1222           );
1223         } else {
1224           const measureId = `${FileType.ChargingStationConfiguration} read`;
1225           const beginId = PerformanceStatistics.beginMeasure(measureId);
1226           configuration = JSON.parse(
1227             fs.readFileSync(this.configurationFile, 'utf8')
1228           ) as ChargingStationConfiguration;
1229           PerformanceStatistics.endMeasure(measureId, beginId);
1230           this.configurationFileHash = configuration.configurationHash;
1231           this.sharedLRUCache.setChargingStationConfiguration(configuration);
1232         }
1233       } catch (error) {
1234         FileUtils.handleFileException(
1235           this.logPrefix(),
1236           FileType.ChargingStationConfiguration,
1237           this.configurationFile,
1238           error as NodeJS.ErrnoException
1239         );
1240       }
1241     }
1242     return configuration;
1243   }
1244
1245   private saveConfiguration(): void {
1246     if (this.configurationFile) {
1247       try {
1248         if (!fs.existsSync(path.dirname(this.configurationFile))) {
1249           fs.mkdirSync(path.dirname(this.configurationFile), { recursive: true });
1250         }
1251         const configurationData: ChargingStationConfiguration =
1252           this.getConfigurationFromFile() ?? {};
1253         this.ocppConfiguration?.configurationKey &&
1254           (configurationData.configurationKey = this.ocppConfiguration.configurationKey);
1255         this.stationInfo && (configurationData.stationInfo = this.stationInfo);
1256         delete configurationData.configurationHash;
1257         const configurationHash = crypto
1258           .createHash(Constants.DEFAULT_HASH_ALGORITHM)
1259           .update(JSON.stringify(configurationData))
1260           .digest('hex');
1261         if (this.configurationFileHash !== configurationHash) {
1262           configurationData.configurationHash = configurationHash;
1263           const measureId = `${FileType.ChargingStationConfiguration} write`;
1264           const beginId = PerformanceStatistics.beginMeasure(measureId);
1265           const fileDescriptor = fs.openSync(this.configurationFile, 'w');
1266           fs.writeFileSync(fileDescriptor, JSON.stringify(configurationData, null, 2), 'utf8');
1267           fs.closeSync(fileDescriptor);
1268           PerformanceStatistics.endMeasure(measureId, beginId);
1269           this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash);
1270           this.configurationFileHash = configurationHash;
1271           this.sharedLRUCache.setChargingStationConfiguration(configurationData);
1272         } else {
1273           logger.debug(
1274             `${this.logPrefix()} Not saving unchanged charging station configuration file ${
1275               this.configurationFile
1276             }`
1277           );
1278         }
1279       } catch (error) {
1280         FileUtils.handleFileException(
1281           this.logPrefix(),
1282           FileType.ChargingStationConfiguration,
1283           this.configurationFile,
1284           error as NodeJS.ErrnoException
1285         );
1286       }
1287     } else {
1288       logger.error(
1289         `${this.logPrefix()} Trying to save charging station configuration to undefined configuration file`
1290       );
1291     }
1292   }
1293
1294   private getOcppConfigurationFromTemplate(): ChargingStationOcppConfiguration | null {
1295     return this.getTemplateFromFile()?.Configuration ?? null;
1296   }
1297
1298   private getOcppConfigurationFromFile(): ChargingStationOcppConfiguration | null {
1299     let configuration: ChargingStationConfiguration = null;
1300     if (this.getOcppPersistentConfiguration()) {
1301       const configurationFromFile = this.getConfigurationFromFile();
1302       configuration = configurationFromFile?.configurationKey && configurationFromFile;
1303     }
1304     configuration && delete configuration.stationInfo;
1305     return configuration;
1306   }
1307
1308   private getOcppConfiguration(): ChargingStationOcppConfiguration | null {
1309     let ocppConfiguration: ChargingStationOcppConfiguration = this.getOcppConfigurationFromFile();
1310     if (!ocppConfiguration) {
1311       ocppConfiguration = this.getOcppConfigurationFromTemplate();
1312     }
1313     return ocppConfiguration;
1314   }
1315
1316   private async onOpen(): Promise<void> {
1317     if (this.isWebSocketConnectionOpened()) {
1318       logger.info(
1319         `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} succeeded`
1320       );
1321       if (!this.isRegistered()) {
1322         // Send BootNotification
1323         let registrationRetryCount = 0;
1324         do {
1325           this.bootNotificationResponse = await this.ocppRequestService.requestHandler<
1326             BootNotificationRequest,
1327             BootNotificationResponse
1328           >(
1329             this,
1330             RequestCommand.BOOT_NOTIFICATION,
1331             {
1332               chargePointModel: this.bootNotificationRequest.chargePointModel,
1333               chargePointVendor: this.bootNotificationRequest.chargePointVendor,
1334               chargeBoxSerialNumber: this.bootNotificationRequest.chargeBoxSerialNumber,
1335               firmwareVersion: this.bootNotificationRequest.firmwareVersion,
1336               chargePointSerialNumber: this.bootNotificationRequest.chargePointSerialNumber,
1337               iccid: this.bootNotificationRequest.iccid,
1338               imsi: this.bootNotificationRequest.imsi,
1339               meterSerialNumber: this.bootNotificationRequest.meterSerialNumber,
1340               meterType: this.bootNotificationRequest.meterType,
1341             },
1342             { skipBufferingOnError: true }
1343           );
1344           if (!this.isRegistered()) {
1345             this.getRegistrationMaxRetries() !== -1 && registrationRetryCount++;
1346             await Utils.sleep(
1347               this.bootNotificationResponse?.interval
1348                 ? this.bootNotificationResponse.interval * 1000
1349                 : Constants.OCPP_DEFAULT_BOOT_NOTIFICATION_INTERVAL
1350             );
1351           }
1352         } while (
1353           !this.isRegistered() &&
1354           (registrationRetryCount <= this.getRegistrationMaxRetries() ||
1355             this.getRegistrationMaxRetries() === -1)
1356         );
1357       }
1358       if (this.isRegistered()) {
1359         if (this.isInAcceptedState()) {
1360           await this.startMessageSequence();
1361           this.wsConnectionRestarted && this.flushMessageBuffer();
1362         }
1363       } else {
1364         logger.error(
1365           `${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})`
1366         );
1367       }
1368       this.stopped && (this.stopped = false);
1369       this.autoReconnectRetryCount = 0;
1370       this.wsConnectionRestarted = false;
1371     } else {
1372       logger.warn(
1373         `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} failed`
1374       );
1375     }
1376   }
1377
1378   private async onClose(code: number, reason: string): Promise<void> {
1379     switch (code) {
1380       // Normal close
1381       case WebSocketCloseEventStatusCode.CLOSE_NORMAL:
1382       case WebSocketCloseEventStatusCode.CLOSE_NO_STATUS:
1383         logger.info(
1384           `${this.logPrefix()} WebSocket normally closed with status '${ChargingStationUtils.getWebSocketCloseEventStatusString(
1385             code
1386           )}' and reason '${reason}'`
1387         );
1388         this.autoReconnectRetryCount = 0;
1389         break;
1390       // Abnormal close
1391       default:
1392         logger.error(
1393           `${this.logPrefix()} WebSocket abnormally closed with status '${ChargingStationUtils.getWebSocketCloseEventStatusString(
1394             code
1395           )}' and reason '${reason}'`
1396         );
1397         await this.reconnect(code);
1398         break;
1399     }
1400   }
1401
1402   private async onMessage(data: Data): Promise<void> {
1403     let messageType: number;
1404     let messageId: string;
1405     let commandName: IncomingRequestCommand;
1406     let commandPayload: JsonType;
1407     let errorType: ErrorType;
1408     let errorMessage: string;
1409     let errorDetails: JsonType;
1410     let responseCallback: (payload: JsonType, requestPayload: JsonType) => void;
1411     let errorCallback: (error: OCPPError, requestStatistic?: boolean) => void;
1412     let requestCommandName: RequestCommand | IncomingRequestCommand;
1413     let requestPayload: JsonType;
1414     let cachedRequest: CachedRequest;
1415     let errMsg: string;
1416     try {
1417       const request = JSON.parse(data.toString()) as IncomingRequest | Response | ErrorResponse;
1418       if (Array.isArray(request) === true) {
1419         [messageType, messageId] = request;
1420         // Check the type of message
1421         switch (messageType) {
1422           // Incoming Message
1423           case MessageType.CALL_MESSAGE:
1424             [, , commandName, commandPayload] = request as IncomingRequest;
1425             if (this.getEnableStatistics()) {
1426               this.performanceStatistics.addRequestStatistic(commandName, messageType);
1427             }
1428             logger.debug(
1429               `${this.logPrefix()} << Command '${commandName}' received request payload: ${JSON.stringify(
1430                 request
1431               )}`
1432             );
1433             // Process the message
1434             await this.ocppIncomingRequestService.incomingRequestHandler(
1435               this,
1436               messageId,
1437               commandName,
1438               commandPayload
1439             );
1440             break;
1441           // Outcome Message
1442           case MessageType.CALL_RESULT_MESSAGE:
1443             [, , commandPayload] = request as Response;
1444             if (!this.requests.has(messageId)) {
1445               // Error
1446               throw new OCPPError(
1447                 ErrorType.INTERNAL_ERROR,
1448                 `Response for unknown message id ${messageId}`,
1449                 null,
1450                 commandPayload
1451               );
1452             }
1453             // Respond
1454             cachedRequest = this.requests.get(messageId);
1455             if (Array.isArray(cachedRequest) === true) {
1456               [responseCallback, , requestCommandName, requestPayload] = cachedRequest;
1457             } else {
1458               throw new OCPPError(
1459                 ErrorType.PROTOCOL_ERROR,
1460                 `Cached request for message id ${messageId} response is not an array`,
1461                 null,
1462                 cachedRequest as unknown as JsonType
1463               );
1464             }
1465             logger.debug(
1466               `${this.logPrefix()} << Command '${
1467                 requestCommandName ?? 'unknown'
1468               }' received response payload: ${JSON.stringify(request)}`
1469             );
1470             responseCallback(commandPayload, requestPayload);
1471             break;
1472           // Error Message
1473           case MessageType.CALL_ERROR_MESSAGE:
1474             [, , errorType, errorMessage, errorDetails] = request as ErrorResponse;
1475             if (!this.requests.has(messageId)) {
1476               // Error
1477               throw new OCPPError(
1478                 ErrorType.INTERNAL_ERROR,
1479                 `Error response for unknown message id ${messageId}`,
1480                 null,
1481                 { errorType, errorMessage, errorDetails }
1482               );
1483             }
1484             cachedRequest = this.requests.get(messageId);
1485             if (Array.isArray(cachedRequest) === true) {
1486               [, errorCallback, requestCommandName] = cachedRequest;
1487             } else {
1488               throw new OCPPError(
1489                 ErrorType.PROTOCOL_ERROR,
1490                 `Cached request for message id ${messageId} error response is not an array`,
1491                 null,
1492                 cachedRequest as unknown as JsonType
1493               );
1494             }
1495             logger.debug(
1496               `${this.logPrefix()} << Command '${
1497                 requestCommandName ?? 'unknown'
1498               }' received error payload: ${JSON.stringify(request)}`
1499             );
1500             errorCallback(new OCPPError(errorType, errorMessage, requestCommandName, errorDetails));
1501             break;
1502           // Error
1503           default:
1504             // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
1505             errMsg = `Wrong message type ${messageType}`;
1506             logger.error(`${this.logPrefix()} ${errMsg}`);
1507             throw new OCPPError(ErrorType.PROTOCOL_ERROR, errMsg);
1508         }
1509         parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
1510       } else {
1511         throw new OCPPError(ErrorType.PROTOCOL_ERROR, 'Incoming message is not an array', null, {
1512           payload: request,
1513         });
1514       }
1515     } catch (error) {
1516       // Log
1517       logger.error(
1518         `${this.logPrefix()} Incoming OCPP '${
1519           commandName ?? requestCommandName ?? null
1520         }' message '${data.toString()}' matching cached request '${JSON.stringify(
1521           this.requests.get(messageId)
1522         )}' processing error:`,
1523         error
1524       );
1525       if (!(error instanceof OCPPError)) {
1526         logger.warn(
1527           `${this.logPrefix()} Error thrown at incoming OCPP '${
1528             commandName ?? requestCommandName ?? null
1529           }' message '${data.toString()}' handling is not an OCPPError:`,
1530           error
1531         );
1532       }
1533       // Send error
1534       messageType === MessageType.CALL_MESSAGE &&
1535         (await this.ocppRequestService.sendError(
1536           this,
1537           messageId,
1538           error as OCPPError,
1539           commandName ?? requestCommandName ?? null
1540         ));
1541     }
1542   }
1543
1544   private onPing(): void {
1545     logger.debug(this.logPrefix() + ' Received a WS ping (rfc6455) from the server');
1546   }
1547
1548   private onPong(): void {
1549     logger.debug(this.logPrefix() + ' Received a WS pong (rfc6455) from the server');
1550   }
1551
1552   private onError(error: WSError): void {
1553     this.closeWSConnection();
1554     logger.error(this.logPrefix() + ' WebSocket error:', error);
1555   }
1556
1557   private getUseConnectorId0(stationInfo?: ChargingStationInfo): boolean | undefined {
1558     const localStationInfo = stationInfo ?? this.stationInfo;
1559     return !Utils.isUndefined(localStationInfo.useConnectorId0)
1560       ? localStationInfo.useConnectorId0
1561       : true;
1562   }
1563
1564   private getNumberOfRunningTransactions(): number {
1565     let trxCount = 0;
1566     for (const connectorId of this.connectors.keys()) {
1567       if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted) {
1568         trxCount++;
1569       }
1570     }
1571     return trxCount;
1572   }
1573
1574   // 0 for disabling
1575   private getConnectionTimeout(): number | undefined {
1576     if (
1577       ChargingStationConfigurationUtils.getConfigurationKey(
1578         this,
1579         StandardParametersKey.ConnectionTimeOut
1580       )
1581     ) {
1582       return (
1583         parseInt(
1584           ChargingStationConfigurationUtils.getConfigurationKey(
1585             this,
1586             StandardParametersKey.ConnectionTimeOut
1587           ).value
1588         ) ?? Constants.DEFAULT_CONNECTION_TIMEOUT
1589       );
1590     }
1591     return Constants.DEFAULT_CONNECTION_TIMEOUT;
1592   }
1593
1594   // -1 for unlimited, 0 for disabling
1595   private getAutoReconnectMaxRetries(): number | undefined {
1596     if (!Utils.isUndefined(this.stationInfo.autoReconnectMaxRetries)) {
1597       return this.stationInfo.autoReconnectMaxRetries;
1598     }
1599     if (!Utils.isUndefined(Configuration.getAutoReconnectMaxRetries())) {
1600       return Configuration.getAutoReconnectMaxRetries();
1601     }
1602     return -1;
1603   }
1604
1605   // 0 for disabling
1606   private getRegistrationMaxRetries(): number | undefined {
1607     if (!Utils.isUndefined(this.stationInfo.registrationMaxRetries)) {
1608       return this.stationInfo.registrationMaxRetries;
1609     }
1610     return -1;
1611   }
1612
1613   private getPowerDivider(): number {
1614     let powerDivider = this.getNumberOfConnectors();
1615     if (this.stationInfo?.powerSharedByConnectors) {
1616       powerDivider = this.getNumberOfRunningTransactions();
1617     }
1618     return powerDivider;
1619   }
1620
1621   private getMaximumPower(stationInfo?: ChargingStationInfo): number {
1622     const localStationInfo = stationInfo ?? this.stationInfo;
1623     return (localStationInfo['maxPower'] as number) ?? localStationInfo.maximumPower;
1624   }
1625
1626   private getMaximumAmperage(stationInfo: ChargingStationInfo): number | undefined {
1627     const maximumPower = this.getMaximumPower(stationInfo);
1628     switch (this.getCurrentOutType(stationInfo)) {
1629       case CurrentType.AC:
1630         return ACElectricUtils.amperagePerPhaseFromPower(
1631           this.getNumberOfPhases(stationInfo),
1632           maximumPower / this.getNumberOfConnectors(),
1633           this.getVoltageOut(stationInfo)
1634         );
1635       case CurrentType.DC:
1636         return DCElectricUtils.amperage(maximumPower, this.getVoltageOut(stationInfo));
1637     }
1638   }
1639
1640   private getAmperageLimitation(): number | undefined {
1641     if (
1642       this.stationInfo.amperageLimitationOcppKey &&
1643       ChargingStationConfigurationUtils.getConfigurationKey(
1644         this,
1645         this.stationInfo.amperageLimitationOcppKey
1646       )
1647     ) {
1648       return (
1649         Utils.convertToInt(
1650           ChargingStationConfigurationUtils.getConfigurationKey(
1651             this,
1652             this.stationInfo.amperageLimitationOcppKey
1653           ).value
1654         ) / ChargingStationUtils.getAmperageLimitationUnitDivider(this.stationInfo)
1655       );
1656     }
1657   }
1658
1659   private async startMessageSequence(): Promise<void> {
1660     if (this.stationInfo?.autoRegister) {
1661       await this.ocppRequestService.requestHandler<
1662         BootNotificationRequest,
1663         BootNotificationResponse
1664       >(
1665         this,
1666         RequestCommand.BOOT_NOTIFICATION,
1667         {
1668           chargePointModel: this.bootNotificationRequest.chargePointModel,
1669           chargePointVendor: this.bootNotificationRequest.chargePointVendor,
1670           chargeBoxSerialNumber: this.bootNotificationRequest.chargeBoxSerialNumber,
1671           firmwareVersion: this.bootNotificationRequest.firmwareVersion,
1672           chargePointSerialNumber: this.bootNotificationRequest.chargePointSerialNumber,
1673           iccid: this.bootNotificationRequest.iccid,
1674           imsi: this.bootNotificationRequest.imsi,
1675           meterSerialNumber: this.bootNotificationRequest.meterSerialNumber,
1676           meterType: this.bootNotificationRequest.meterType,
1677         },
1678         { skipBufferingOnError: true }
1679       );
1680     }
1681     // Start WebSocket ping
1682     this.startWebSocketPing();
1683     // Start heartbeat
1684     this.startHeartbeat();
1685     // Initialize connectors status
1686     for (const connectorId of this.connectors.keys()) {
1687       if (connectorId === 0) {
1688         continue;
1689       } else if (
1690         !this.stopped &&
1691         !this.getConnectorStatus(connectorId)?.status &&
1692         this.getConnectorStatus(connectorId)?.bootStatus
1693       ) {
1694         // Send status in template at startup
1695         await this.ocppRequestService.requestHandler<
1696           StatusNotificationRequest,
1697           StatusNotificationResponse
1698         >(this, RequestCommand.STATUS_NOTIFICATION, {
1699           connectorId,
1700           status: this.getConnectorStatus(connectorId).bootStatus,
1701           errorCode: ChargePointErrorCode.NO_ERROR,
1702         });
1703         this.getConnectorStatus(connectorId).status =
1704           this.getConnectorStatus(connectorId).bootStatus;
1705       } else if (
1706         this.stopped &&
1707         this.getConnectorStatus(connectorId)?.status &&
1708         this.getConnectorStatus(connectorId)?.bootStatus
1709       ) {
1710         // Send status in template after reset
1711         await this.ocppRequestService.requestHandler<
1712           StatusNotificationRequest,
1713           StatusNotificationResponse
1714         >(this, RequestCommand.STATUS_NOTIFICATION, {
1715           connectorId,
1716           status: this.getConnectorStatus(connectorId).bootStatus,
1717           errorCode: ChargePointErrorCode.NO_ERROR,
1718         });
1719         this.getConnectorStatus(connectorId).status =
1720           this.getConnectorStatus(connectorId).bootStatus;
1721       } else if (!this.stopped && this.getConnectorStatus(connectorId)?.status) {
1722         // Send previous status at template reload
1723         await this.ocppRequestService.requestHandler<
1724           StatusNotificationRequest,
1725           StatusNotificationResponse
1726         >(this, RequestCommand.STATUS_NOTIFICATION, {
1727           connectorId,
1728           status: this.getConnectorStatus(connectorId).status,
1729           errorCode: ChargePointErrorCode.NO_ERROR,
1730         });
1731       } else {
1732         // Send default status
1733         await this.ocppRequestService.requestHandler<
1734           StatusNotificationRequest,
1735           StatusNotificationResponse
1736         >(this, RequestCommand.STATUS_NOTIFICATION, {
1737           connectorId,
1738           status: ChargePointStatus.AVAILABLE,
1739           errorCode: ChargePointErrorCode.NO_ERROR,
1740         });
1741         this.getConnectorStatus(connectorId).status = ChargePointStatus.AVAILABLE;
1742       }
1743     }
1744     // Start the ATG
1745     this.startAutomaticTransactionGenerator();
1746   }
1747
1748   private startAutomaticTransactionGenerator() {
1749     if (this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable) {
1750       if (!this.automaticTransactionGenerator) {
1751         this.automaticTransactionGenerator = AutomaticTransactionGenerator.getInstance(
1752           this.getAutomaticTransactionGeneratorConfigurationFromTemplate(),
1753           this
1754         );
1755       }
1756       if (!this.automaticTransactionGenerator.started) {
1757         this.automaticTransactionGenerator.start();
1758       }
1759     }
1760   }
1761
1762   private stopAutomaticTransactionGenerator(): void {
1763     if (this.automaticTransactionGenerator?.started) {
1764       this.automaticTransactionGenerator.stop();
1765       this.automaticTransactionGenerator = null;
1766     }
1767   }
1768
1769   private async stopMessageSequence(
1770     reason: StopTransactionReason = StopTransactionReason.NONE
1771   ): Promise<void> {
1772     // Stop WebSocket ping
1773     this.stopWebSocketPing();
1774     // Stop heartbeat
1775     this.stopHeartbeat();
1776     // Stop ongoing transactions
1777     if (this.automaticTransactionGenerator?.configuration?.enable) {
1778       this.stopAutomaticTransactionGenerator();
1779     } else {
1780       for (const connectorId of this.connectors.keys()) {
1781         if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted) {
1782           const transactionId = this.getConnectorStatus(connectorId).transactionId;
1783           if (
1784             this.getBeginEndMeterValues() &&
1785             this.getOcppStrictCompliance() &&
1786             !this.getOutOfOrderEndMeterValues()
1787           ) {
1788             // FIXME: Implement OCPP version agnostic helpers
1789             const transactionEndMeterValue = OCPP16ServiceUtils.buildTransactionEndMeterValue(
1790               this,
1791               connectorId,
1792               this.getEnergyActiveImportRegisterByTransactionId(transactionId)
1793             );
1794             await this.ocppRequestService.requestHandler<MeterValuesRequest, MeterValuesResponse>(
1795               this,
1796               RequestCommand.METER_VALUES,
1797               {
1798                 connectorId,
1799                 transactionId,
1800                 meterValue: [transactionEndMeterValue],
1801               }
1802             );
1803           }
1804           await this.ocppRequestService.requestHandler<
1805             StopTransactionRequest,
1806             StopTransactionResponse
1807           >(this, RequestCommand.STOP_TRANSACTION, {
1808             transactionId,
1809             meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId),
1810             idTag: this.getTransactionIdTag(transactionId),
1811             reason,
1812           });
1813         }
1814       }
1815     }
1816   }
1817
1818   private startWebSocketPing(): void {
1819     const webSocketPingInterval: number = ChargingStationConfigurationUtils.getConfigurationKey(
1820       this,
1821       StandardParametersKey.WebSocketPingInterval
1822     )
1823       ? Utils.convertToInt(
1824           ChargingStationConfigurationUtils.getConfigurationKey(
1825             this,
1826             StandardParametersKey.WebSocketPingInterval
1827           ).value
1828         )
1829       : 0;
1830     if (webSocketPingInterval > 0 && !this.webSocketPingSetInterval) {
1831       this.webSocketPingSetInterval = setInterval(() => {
1832         if (this.isWebSocketConnectionOpened()) {
1833           this.wsConnection.ping((): void => {
1834             /* This is intentional */
1835           });
1836         }
1837       }, webSocketPingInterval * 1000);
1838       logger.info(
1839         this.logPrefix() +
1840           ' WebSocket ping started every ' +
1841           Utils.formatDurationSeconds(webSocketPingInterval)
1842       );
1843     } else if (this.webSocketPingSetInterval) {
1844       logger.info(
1845         this.logPrefix() +
1846           ' WebSocket ping every ' +
1847           Utils.formatDurationSeconds(webSocketPingInterval) +
1848           ' already started'
1849       );
1850     } else {
1851       logger.error(
1852         `${this.logPrefix()} WebSocket ping interval set to ${
1853           webSocketPingInterval
1854             ? Utils.formatDurationSeconds(webSocketPingInterval)
1855             : webSocketPingInterval
1856         }, not starting the WebSocket ping`
1857       );
1858     }
1859   }
1860
1861   private stopWebSocketPing(): void {
1862     if (this.webSocketPingSetInterval) {
1863       clearInterval(this.webSocketPingSetInterval);
1864     }
1865   }
1866
1867   private getConfiguredSupervisionUrl(): URL {
1868     const supervisionUrls = Utils.cloneObject<string | string[]>(
1869       this.stationInfo.supervisionUrls ?? Configuration.getSupervisionUrls()
1870     );
1871     if (!Utils.isEmptyArray(supervisionUrls)) {
1872       let urlIndex = 0;
1873       switch (Configuration.getSupervisionUrlDistribution()) {
1874         case SupervisionUrlDistribution.ROUND_ROBIN:
1875           urlIndex = (this.index - 1) % supervisionUrls.length;
1876           break;
1877         case SupervisionUrlDistribution.RANDOM:
1878           // Get a random url
1879           urlIndex = Math.floor(Utils.secureRandom() * supervisionUrls.length);
1880           break;
1881         case SupervisionUrlDistribution.SEQUENTIAL:
1882           if (this.index <= supervisionUrls.length) {
1883             urlIndex = this.index - 1;
1884           } else {
1885             logger.warn(
1886               `${this.logPrefix()} No more configured supervision urls available, using the first one`
1887             );
1888           }
1889           break;
1890         default:
1891           logger.error(
1892             `${this.logPrefix()} Unknown supervision url distribution '${Configuration.getSupervisionUrlDistribution()}' from values '${SupervisionUrlDistribution.toString()}', defaulting to ${
1893               SupervisionUrlDistribution.ROUND_ROBIN
1894             }`
1895           );
1896           urlIndex = (this.index - 1) % supervisionUrls.length;
1897           break;
1898       }
1899       return new URL(supervisionUrls[urlIndex]);
1900     }
1901     return new URL(supervisionUrls as string);
1902   }
1903
1904   private getHeartbeatInterval(): number | undefined {
1905     const HeartbeatInterval = ChargingStationConfigurationUtils.getConfigurationKey(
1906       this,
1907       StandardParametersKey.HeartbeatInterval
1908     );
1909     if (HeartbeatInterval) {
1910       return Utils.convertToInt(HeartbeatInterval.value) * 1000;
1911     }
1912     const HeartBeatInterval = ChargingStationConfigurationUtils.getConfigurationKey(
1913       this,
1914       StandardParametersKey.HeartBeatInterval
1915     );
1916     if (HeartBeatInterval) {
1917       return Utils.convertToInt(HeartBeatInterval.value) * 1000;
1918     }
1919     !this.stationInfo?.autoRegister &&
1920       logger.warn(
1921         `${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${
1922           Constants.DEFAULT_HEARTBEAT_INTERVAL
1923         }`
1924       );
1925     return Constants.DEFAULT_HEARTBEAT_INTERVAL;
1926   }
1927
1928   private stopHeartbeat(): void {
1929     if (this.heartbeatSetInterval) {
1930       clearInterval(this.heartbeatSetInterval);
1931     }
1932   }
1933
1934   private terminateWSConnection(): void {
1935     if (this.isWebSocketConnectionOpened()) {
1936       this.wsConnection.terminate();
1937       this.wsConnection = null;
1938     }
1939   }
1940
1941   private stopMeterValues(connectorId: number) {
1942     if (this.getConnectorStatus(connectorId)?.transactionSetInterval) {
1943       clearInterval(this.getConnectorStatus(connectorId).transactionSetInterval);
1944     }
1945   }
1946
1947   private getReconnectExponentialDelay(): boolean | undefined {
1948     return !Utils.isUndefined(this.stationInfo.reconnectExponentialDelay)
1949       ? this.stationInfo.reconnectExponentialDelay
1950       : false;
1951   }
1952
1953   private async reconnect(code: number): Promise<void> {
1954     // Stop WebSocket ping
1955     this.stopWebSocketPing();
1956     // Stop heartbeat
1957     this.stopHeartbeat();
1958     // Stop the ATG if needed
1959     if (this.automaticTransactionGenerator?.configuration?.stopOnConnectionFailure) {
1960       this.stopAutomaticTransactionGenerator();
1961     }
1962     if (
1963       this.autoReconnectRetryCount < this.getAutoReconnectMaxRetries() ||
1964       this.getAutoReconnectMaxRetries() === -1
1965     ) {
1966       this.autoReconnectRetryCount++;
1967       const reconnectDelay = this.getReconnectExponentialDelay()
1968         ? Utils.exponentialDelay(this.autoReconnectRetryCount)
1969         : this.getConnectionTimeout() * 1000;
1970       const reconnectDelayWithdraw = 1000;
1971       const reconnectTimeout =
1972         reconnectDelay && reconnectDelay - reconnectDelayWithdraw > 0
1973           ? reconnectDelay - reconnectDelayWithdraw
1974           : 0;
1975       logger.error(
1976         `${this.logPrefix()} WebSocket: connection retry in ${Utils.roundTo(
1977           reconnectDelay,
1978           2
1979         )}ms, timeout ${reconnectTimeout}ms`
1980       );
1981       await Utils.sleep(reconnectDelay);
1982       logger.error(
1983         this.logPrefix() +
1984           ' WebSocket: reconnecting try #' +
1985           this.autoReconnectRetryCount.toString()
1986       );
1987       this.openWSConnection(
1988         { ...(this.stationInfo?.wsOptions ?? {}), handshakeTimeout: reconnectTimeout },
1989         { closeOpened: true }
1990       );
1991       this.wsConnectionRestarted = true;
1992     } else if (this.getAutoReconnectMaxRetries() !== -1) {
1993       logger.error(
1994         `${this.logPrefix()} WebSocket reconnect failure: maximum retries reached (${
1995           this.autoReconnectRetryCount
1996         }) or retry disabled (${this.getAutoReconnectMaxRetries()})`
1997       );
1998     }
1999   }
2000
2001   private getAutomaticTransactionGeneratorConfigurationFromTemplate(): AutomaticTransactionGeneratorConfiguration | null {
2002     return this.getTemplateFromFile()?.AutomaticTransactionGenerator ?? null;
2003   }
2004
2005   private initializeConnectorStatus(connectorId: number): void {
2006     this.getConnectorStatus(connectorId).idTagLocalAuthorized = false;
2007     this.getConnectorStatus(connectorId).idTagAuthorized = false;
2008     this.getConnectorStatus(connectorId).transactionRemoteStarted = false;
2009     this.getConnectorStatus(connectorId).transactionStarted = false;
2010     this.getConnectorStatus(connectorId).energyActiveImportRegisterValue = 0;
2011     this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue = 0;
2012   }
2013 }