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