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