feat: add initial support for evse definition in template
[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 {
1895299d 240 return this.getConnectorStatus(0)?.availability === AvailabilityType.OPERATIVE;
c0560973
JB
241 }
242
243 public isConnectorAvailable(id: number): boolean {
1895299d 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
537 public start(): void {
0d8852a5
JB
538 if (this.started === false) {
539 if (this.starting === false) {
540 this.starting = true;
ad774cec 541 if (this.getEnableStatistics() === true) {
551e477c 542 this.performanceStatistics?.start();
0d8852a5
JB
543 }
544 this.openWSConnection();
545 // Monitor charging station template file
546 this.templateFileWatcher = FileUtils.watchJsonFile(
0d8852a5 547 this.templateFile,
7164966d
JB
548 FileType.ChargingStationTemplate,
549 this.logPrefix(),
550 undefined,
0d8852a5 551 (event, filename): void => {
5a2a53cf 552 if (Utils.isNotEmptyString(filename) && event === 'change') {
0d8852a5
JB
553 try {
554 logger.debug(
555 `${this.logPrefix()} ${FileType.ChargingStationTemplate} ${
556 this.templateFile
557 } file have changed, reload`
558 );
559 this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash);
560 // Initialize
561 this.initialize();
562 // Restart the ATG
563 this.stopAutomaticTransactionGenerator();
564 if (
565 this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable === true
566 ) {
567 this.startAutomaticTransactionGenerator();
568 }
ad774cec 569 if (this.getEnableStatistics() === true) {
551e477c 570 this.performanceStatistics?.restart();
0d8852a5 571 } else {
551e477c 572 this.performanceStatistics?.stop();
0d8852a5
JB
573 }
574 // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed
575 } catch (error) {
576 logger.error(
577 `${this.logPrefix()} ${FileType.ChargingStationTemplate} file monitoring error:`,
578 error
579 );
950b1349 580 }
a95873d8 581 }
a95873d8 582 }
0d8852a5 583 );
56eb297e 584 this.started = true;
1895299d 585 parentPort?.postMessage(MessageChannelUtils.buildStartedMessage(this));
0d8852a5
JB
586 this.starting = false;
587 } else {
588 logger.warn(`${this.logPrefix()} Charging station is already starting...`);
589 }
950b1349 590 } else {
0d8852a5 591 logger.warn(`${this.logPrefix()} Charging station is already started...`);
950b1349 592 }
c0560973
JB
593 }
594
60ddad53 595 public async stop(reason?: StopTransactionReason): Promise<void> {
0d8852a5
JB
596 if (this.started === true) {
597 if (this.stopping === false) {
598 this.stopping = true;
599 await this.stopMessageSequence(reason);
0d8852a5 600 this.closeWSConnection();
ad774cec 601 if (this.getEnableStatistics() === true) {
551e477c 602 this.performanceStatistics?.stop();
0d8852a5
JB
603 }
604 this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash);
72092cfc 605 this.templateFileWatcher?.close();
0d8852a5 606 this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash);
cdde2cfe 607 delete this.bootNotificationResponse;
0d8852a5 608 this.started = false;
1895299d 609 parentPort?.postMessage(MessageChannelUtils.buildStoppedMessage(this));
0d8852a5
JB
610 this.stopping = false;
611 } else {
612 logger.warn(`${this.logPrefix()} Charging station is already stopping...`);
c0560973 613 }
950b1349 614 } else {
0d8852a5 615 logger.warn(`${this.logPrefix()} Charging station is already stopped...`);
c0560973 616 }
c0560973
JB
617 }
618
60ddad53
JB
619 public async reset(reason?: StopTransactionReason): Promise<void> {
620 await this.stop(reason);
94ec7e96 621 await Utils.sleep(this.stationInfo.resetTime);
fa7bccf4 622 this.initialize();
94ec7e96
JB
623 this.start();
624 }
625
17ac262c
JB
626 public saveOcppConfiguration(): void {
627 if (this.getOcppPersistentConfiguration()) {
7c72977b 628 this.saveConfiguration();
e6895390
JB
629 }
630 }
631
a2653482
JB
632 public resetConnectorStatus(connectorId: number): void {
633 this.getConnectorStatus(connectorId).idTagLocalAuthorized = false;
634 this.getConnectorStatus(connectorId).idTagAuthorized = false;
635 this.getConnectorStatus(connectorId).transactionRemoteStarted = false;
734d790d 636 this.getConnectorStatus(connectorId).transactionStarted = false;
d812bdcb
JB
637 delete this.getConnectorStatus(connectorId)?.localAuthorizeIdTag;
638 delete this.getConnectorStatus(connectorId)?.authorizeIdTag;
639 delete this.getConnectorStatus(connectorId)?.transactionId;
640 delete this.getConnectorStatus(connectorId)?.transactionIdTag;
734d790d 641 this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue = 0;
d812bdcb 642 delete this.getConnectorStatus(connectorId)?.transactionBeginMeterValue;
dd119a6b 643 this.stopMeterValues(connectorId);
1895299d 644 parentPort?.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
2e6f5966
JB
645 }
646
72092cfc 647 public hasFeatureProfile(featureProfile: SupportedFeatureProfiles): boolean | undefined {
17ac262c
JB
648 return ChargingStationConfigurationUtils.getConfigurationKey(
649 this,
650 StandardParametersKey.SupportedFeatureProfiles
72092cfc 651 )?.value?.includes(featureProfile);
68cb8b91
JB
652 }
653
8e242273
JB
654 public bufferMessage(message: string): void {
655 this.messageBuffer.add(message);
3ba2381e
JB
656 }
657
db2336d9 658 public openWSConnection(
abe9e9dd 659 options: WsOptions = this.stationInfo?.wsOptions ?? {},
db2336d9
JB
660 params: { closeOpened?: boolean; terminateOpened?: boolean } = {
661 closeOpened: false,
662 terminateOpened: false,
663 }
664 ): void {
665 options.handshakeTimeout = options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000;
666 params.closeOpened = params?.closeOpened ?? false;
667 params.terminateOpened = params?.terminateOpened ?? false;
cbf9b878 668 if (this.started === false && this.starting === false) {
d1c6c833
JB
669 logger.warn(
670 `${this.logPrefix()} Cannot open OCPP connection to URL ${this.wsConnectionUrl.toString()} on stopped charging station`
671 );
672 return;
673 }
db2336d9
JB
674 if (
675 !Utils.isNullOrUndefined(this.stationInfo.supervisionUser) &&
676 !Utils.isNullOrUndefined(this.stationInfo.supervisionPassword)
677 ) {
678 options.auth = `${this.stationInfo.supervisionUser}:${this.stationInfo.supervisionPassword}`;
679 }
680 if (params?.closeOpened) {
681 this.closeWSConnection();
682 }
683 if (params?.terminateOpened) {
684 this.terminateWSConnection();
685 }
db2336d9 686
56eb297e 687 if (this.isWebSocketConnectionOpened() === true) {
0a03f36c
JB
688 logger.warn(
689 `${this.logPrefix()} OCPP connection to URL ${this.wsConnectionUrl.toString()} is already opened`
690 );
691 return;
692 }
693
db2336d9 694 logger.info(
0a03f36c 695 `${this.logPrefix()} Open OCPP connection to URL ${this.wsConnectionUrl.toString()}`
db2336d9
JB
696 );
697
feff11ec
JB
698 this.wsConnection = new WebSocket(
699 this.wsConnectionUrl,
700 `ocpp${this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16}`,
701 options
702 );
db2336d9
JB
703
704 // Handle WebSocket message
705 this.wsConnection.on(
706 'message',
707 this.onMessage.bind(this) as (this: WebSocket, data: RawData, isBinary: boolean) => void
708 );
709 // Handle WebSocket error
710 this.wsConnection.on(
711 'error',
712 this.onError.bind(this) as (this: WebSocket, error: Error) => void
713 );
714 // Handle WebSocket close
715 this.wsConnection.on(
716 'close',
717 this.onClose.bind(this) as (this: WebSocket, code: number, reason: Buffer) => void
718 );
719 // Handle WebSocket open
720 this.wsConnection.on('open', this.onOpen.bind(this) as (this: WebSocket) => void);
721 // Handle WebSocket ping
722 this.wsConnection.on('ping', this.onPing.bind(this) as (this: WebSocket, data: Buffer) => void);
723 // Handle WebSocket pong
724 this.wsConnection.on('pong', this.onPong.bind(this) as (this: WebSocket, data: Buffer) => void);
725 }
726
727 public closeWSConnection(): void {
56eb297e 728 if (this.isWebSocketConnectionOpened() === true) {
72092cfc 729 this.wsConnection?.close();
db2336d9
JB
730 this.wsConnection = null;
731 }
732 }
733
8f879946
JB
734 public startAutomaticTransactionGenerator(
735 connectorIds?: number[],
736 automaticTransactionGeneratorConfiguration?: AutomaticTransactionGeneratorConfiguration
737 ): void {
738 this.automaticTransactionGenerator = AutomaticTransactionGenerator.getInstance(
739 automaticTransactionGeneratorConfiguration ??
4f69be04 740 this.getAutomaticTransactionGeneratorConfigurationFromTemplate(),
8f879946
JB
741 this
742 );
53ac516c 743 if (Utils.isNotEmptyArray(connectorIds)) {
a5e9befc 744 for (const connectorId of connectorIds) {
551e477c 745 this.automaticTransactionGenerator?.startConnector(connectorId);
a5e9befc
JB
746 }
747 } else {
551e477c 748 this.automaticTransactionGenerator?.start();
4f69be04 749 }
1895299d 750 parentPort?.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
4f69be04
JB
751 }
752
a5e9befc 753 public stopAutomaticTransactionGenerator(connectorIds?: number[]): void {
53ac516c 754 if (Utils.isNotEmptyArray(connectorIds)) {
a5e9befc
JB
755 for (const connectorId of connectorIds) {
756 this.automaticTransactionGenerator?.stopConnector(connectorId);
757 }
758 } else {
759 this.automaticTransactionGenerator?.stop();
4f69be04 760 }
1895299d 761 parentPort?.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
4f69be04
JB
762 }
763
5e3cb728
JB
764 public async stopTransactionOnConnector(
765 connectorId: number,
766 reason = StopTransactionReason.NONE
767 ): Promise<StopTransactionResponse> {
72092cfc 768 const transactionId = this.getConnectorStatus(connectorId)?.transactionId;
5e3cb728 769 if (
c7e8e0a2
JB
770 this.getBeginEndMeterValues() === true &&
771 this.getOcppStrictCompliance() === true &&
772 this.getOutOfOrderEndMeterValues() === false
5e3cb728
JB
773 ) {
774 // FIXME: Implement OCPP version agnostic helpers
775 const transactionEndMeterValue = OCPP16ServiceUtils.buildTransactionEndMeterValue(
776 this,
777 connectorId,
778 this.getEnergyActiveImportRegisterByTransactionId(transactionId)
779 );
780 await this.ocppRequestService.requestHandler<MeterValuesRequest, MeterValuesResponse>(
781 this,
782 RequestCommand.METER_VALUES,
783 {
784 connectorId,
785 transactionId,
786 meterValue: [transactionEndMeterValue],
787 }
788 );
789 }
790 return this.ocppRequestService.requestHandler<StopTransactionRequest, StopTransactionResponse>(
791 this,
792 RequestCommand.STOP_TRANSACTION,
793 {
794 transactionId,
795 meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId, true),
5e3cb728
JB
796 reason,
797 }
798 );
799 }
800
f90c1757 801 private flushMessageBuffer(): void {
8e242273 802 if (this.messageBuffer.size > 0) {
7d3b0f64 803 for (const message of this.messageBuffer.values()) {
1431af78
JB
804 let beginId: string;
805 let commandName: RequestCommand;
8ca6874c 806 const [messageType] = JSON.parse(message) as OutgoingRequest | Response | ErrorResponse;
1431af78
JB
807 const isRequest = messageType === MessageType.CALL_MESSAGE;
808 if (isRequest) {
809 [, , commandName] = JSON.parse(message) as OutgoingRequest;
810 beginId = PerformanceStatistics.beginMeasure(commandName);
811 }
72092cfc 812 this.wsConnection?.send(message);
1431af78 813 isRequest && PerformanceStatistics.endMeasure(commandName, beginId);
8ca6874c
JB
814 logger.debug(
815 `${this.logPrefix()} >> Buffered ${OCPPServiceUtils.getMessageTypeString(
816 messageType
817 )} payload sent: ${message}`
818 );
8e242273 819 this.messageBuffer.delete(message);
7d3b0f64 820 }
77f00f84
JB
821 }
822 }
823
1f5df42a
JB
824 private getSupervisionUrlOcppConfiguration(): boolean {
825 return this.stationInfo.supervisionUrlOcppConfiguration ?? false;
12fc74d6
JB
826 }
827
e8e865ea 828 private getSupervisionUrlOcppKey(): string {
6dad8e21 829 return this.stationInfo.supervisionUrlOcppKey ?? VendorParametersKey.ConnectionUrl;
e8e865ea
JB
830 }
831
72092cfc
JB
832 private getTemplateFromFile(): ChargingStationTemplate | undefined {
833 let template: ChargingStationTemplate;
5ad8570f 834 try {
57adbebc
JB
835 if (this.sharedLRUCache.hasChargingStationTemplate(this.stationInfo?.templateHash)) {
836 template = this.sharedLRUCache.getChargingStationTemplate(this.stationInfo.templateHash);
7c72977b
JB
837 } else {
838 const measureId = `${FileType.ChargingStationTemplate} read`;
839 const beginId = PerformanceStatistics.beginMeasure(measureId);
840 template = JSON.parse(
841 fs.readFileSync(this.templateFile, 'utf8')
842 ) as ChargingStationTemplate;
843 PerformanceStatistics.endMeasure(measureId, beginId);
844 template.templateHash = crypto
845 .createHash(Constants.DEFAULT_HASH_ALGORITHM)
846 .update(JSON.stringify(template))
847 .digest('hex');
57adbebc 848 this.sharedLRUCache.setChargingStationTemplate(template);
7c72977b 849 }
5ad8570f 850 } catch (error) {
e7aeea18 851 FileUtils.handleFileException(
2484ac1e 852 this.templateFile,
7164966d
JB
853 FileType.ChargingStationTemplate,
854 error as NodeJS.ErrnoException,
855 this.logPrefix()
e7aeea18 856 );
5ad8570f 857 }
2484ac1e
JB
858 return template;
859 }
860
7a3a2ebb 861 private getStationInfoFromTemplate(): ChargingStationInfo {
72092cfc 862 const stationTemplate: ChargingStationTemplate | undefined = this.getTemplateFromFile();
fa7bccf4 863 if (Utils.isNullOrUndefined(stationTemplate)) {
eaad6e5c 864 const errorMsg = `Failed to read charging station template file ${this.templateFile}`;
ccb1d6e9
JB
865 logger.error(`${this.logPrefix()} ${errorMsg}`);
866 throw new BaseError(errorMsg);
94ec7e96 867 }
fa7bccf4 868 if (Utils.isEmptyObject(stationTemplate)) {
ccb1d6e9
JB
869 const errorMsg = `Empty charging station information from template file ${this.templateFile}`;
870 logger.error(`${this.logPrefix()} ${errorMsg}`);
871 throw new BaseError(errorMsg);
94ec7e96 872 }
ae5020a3
JB
873 ChargingStationUtils.warnTemplateKeysDeprecation(
874 this.templateFile,
875 stationTemplate,
876 this.logPrefix()
877 );
fa7bccf4
JB
878 const stationInfo: ChargingStationInfo =
879 ChargingStationUtils.stationTemplateToStationInfo(stationTemplate);
51c83d6f 880 stationInfo.hashId = ChargingStationUtils.getHashId(this.index, stationTemplate);
fa7bccf4
JB
881 stationInfo.chargingStationId = ChargingStationUtils.getChargingStationId(
882 this.index,
883 stationTemplate
884 );
72092cfc 885 stationInfo.ocppVersion = stationTemplate?.ocppVersion ?? OCPPVersion.VERSION_16;
fa7bccf4 886 ChargingStationUtils.createSerialNumber(stationTemplate, stationInfo);
53ac516c 887 if (Utils.isNotEmptyArray(stationTemplate?.power)) {
551e477c 888 stationTemplate.power = stationTemplate.power as number[];
fa7bccf4 889 const powerArrayRandomIndex = Math.floor(Utils.secureRandom() * stationTemplate.power.length);
cc6e8ab5 890 stationInfo.maximumPower =
72092cfc 891 stationTemplate?.powerUnit === PowerUnits.KILO_WATT
fa7bccf4
JB
892 ? stationTemplate.power[powerArrayRandomIndex] * 1000
893 : stationTemplate.power[powerArrayRandomIndex];
5ad8570f 894 } else {
551e477c 895 stationTemplate.power = stationTemplate?.power as number;
cc6e8ab5 896 stationInfo.maximumPower =
72092cfc 897 stationTemplate?.powerUnit === PowerUnits.KILO_WATT
fa7bccf4
JB
898 ? stationTemplate.power * 1000
899 : stationTemplate.power;
900 }
3637ca2c 901 stationInfo.firmwareVersionPattern =
72092cfc 902 stationTemplate?.firmwareVersionPattern ?? Constants.SEMVER_PATTERN;
3637ca2c 903 if (
5a2a53cf 904 Utils.isNotEmptyString(stationInfo.firmwareVersion) &&
3637ca2c
JB
905 new RegExp(stationInfo.firmwareVersionPattern).test(stationInfo.firmwareVersion) === false
906 ) {
907 logger.warn(
908 `${this.logPrefix()} Firmware version '${stationInfo.firmwareVersion}' in template file ${
909 this.templateFile
910 } does not match firmware version pattern '${stationInfo.firmwareVersionPattern}'`
911 );
912 }
598c886d 913 stationInfo.firmwareUpgrade = merge<FirmwareUpgrade>(
15748260 914 {
598c886d
JB
915 versionUpgrade: {
916 step: 1,
917 },
15748260
JB
918 reset: true,
919 },
abe9e9dd 920 stationTemplate?.firmwareUpgrade ?? {}
15748260 921 );
d812bdcb 922 stationInfo.resetTime = !Utils.isNullOrUndefined(stationTemplate?.resetTime)
fa7bccf4 923 ? stationTemplate.resetTime * 1000
e7aeea18 924 : Constants.CHARGING_STATION_DEFAULT_RESET_TIME;
c72f6634
JB
925 const configuredMaxConnectors =
926 ChargingStationUtils.getConfiguredNumberOfConnectors(stationTemplate);
fa7bccf4
JB
927 ChargingStationUtils.checkConfiguredMaxConnectors(
928 configuredMaxConnectors,
929 this.templateFile,
fc040c43 930 this.logPrefix()
fa7bccf4
JB
931 );
932 const templateMaxConnectors =
933 ChargingStationUtils.getTemplateMaxNumberOfConnectors(stationTemplate);
934 ChargingStationUtils.checkTemplateMaxConnectors(
935 templateMaxConnectors,
936 this.templateFile,
fc040c43 937 this.logPrefix()
fa7bccf4
JB
938 );
939 if (
940 configuredMaxConnectors >
941 (stationTemplate?.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) &&
942 !stationTemplate?.randomConnectors
943 ) {
944 logger.warn(
945 `${this.logPrefix()} Number of connectors exceeds the number of connector configurations in template ${
946 this.templateFile
947 }, forcing random connector configurations affectation`
948 );
949 stationInfo.randomConnectors = true;
950 }
951 // Build connectors if needed (FIXME: should be factored out)
952 this.initializeConnectors(stationInfo, configuredMaxConnectors, templateMaxConnectors);
2585c6e9 953 this.initializeEvses(stationInfo);
fa7bccf4
JB
954 stationInfo.maximumAmperage = this.getMaximumAmperage(stationInfo);
955 ChargingStationUtils.createStationInfoHash(stationInfo);
9ac86a7e 956 return stationInfo;
5ad8570f
JB
957 }
958
551e477c
JB
959 private getStationInfoFromFile(): ChargingStationInfo | undefined {
960 let stationInfo: ChargingStationInfo | undefined;
fa7bccf4 961 this.getStationInfoPersistentConfiguration() &&
551e477c 962 (stationInfo = this.getConfigurationFromFile()?.stationInfo);
fa7bccf4 963 stationInfo && ChargingStationUtils.createStationInfoHash(stationInfo);
f765beaa 964 return stationInfo;
2484ac1e
JB
965 }
966
967 private getStationInfo(): ChargingStationInfo {
968 const stationInfoFromTemplate: ChargingStationInfo = this.getStationInfoFromTemplate();
551e477c 969 const stationInfoFromFile: ChargingStationInfo | undefined = this.getStationInfoFromFile();
6b90dcca
JB
970 // Priority:
971 // 1. charging station info from template
972 // 2. charging station info from configuration file
973 // 3. charging station info attribute
f765beaa 974 if (stationInfoFromFile?.templateHash === stationInfoFromTemplate.templateHash) {
01efc60a
JB
975 if (this.stationInfo?.infoHash === stationInfoFromFile?.infoHash) {
976 return this.stationInfo;
977 }
2484ac1e 978 return stationInfoFromFile;
f765beaa 979 }
fec4d204
JB
980 stationInfoFromFile &&
981 ChargingStationUtils.propagateSerialNumber(
982 this.getTemplateFromFile(),
983 stationInfoFromFile,
984 stationInfoFromTemplate
985 );
01efc60a 986 return stationInfoFromTemplate;
2484ac1e
JB
987 }
988
989 private saveStationInfo(): void {
ccb1d6e9 990 if (this.getStationInfoPersistentConfiguration()) {
7c72977b 991 this.saveConfiguration();
ccb1d6e9 992 }
2484ac1e
JB
993 }
994
e8e865ea 995 private getOcppPersistentConfiguration(): boolean {
ccb1d6e9
JB
996 return this.stationInfo?.ocppPersistentConfiguration ?? true;
997 }
998
999 private getStationInfoPersistentConfiguration(): boolean {
1000 return this.stationInfo?.stationInfoPersistentConfiguration ?? true;
e8e865ea
JB
1001 }
1002
c0560973 1003 private handleUnsupportedVersion(version: OCPPVersion) {
fc040c43
JB
1004 const errMsg = `Unsupported protocol version '${version}' configured in template file ${this.templateFile}`;
1005 logger.error(`${this.logPrefix()} ${errMsg}`);
6c8f5d90 1006 throw new BaseError(errMsg);
c0560973
JB
1007 }
1008
2484ac1e 1009 private initialize(): void {
fa7bccf4 1010 this.configurationFile = path.join(
ee5f26a2 1011 path.dirname(this.templateFile.replace('station-templates', 'configurations')),
44eb6026 1012 `${ChargingStationUtils.getHashId(this.index, this.getTemplateFromFile())}.json`
0642c3d2 1013 );
b44b779a 1014 this.stationInfo = this.getStationInfo();
3637ca2c
JB
1015 if (
1016 this.stationInfo.firmwareStatus === FirmwareStatus.Installing &&
5a2a53cf
JB
1017 Utils.isNotEmptyString(this.stationInfo.firmwareVersion) &&
1018 Utils.isNotEmptyString(this.stationInfo.firmwareVersionPattern)
3637ca2c 1019 ) {
d812bdcb 1020 const patternGroup: number | undefined =
15748260 1021 this.stationInfo.firmwareUpgrade?.versionUpgrade?.patternGroup ??
d812bdcb 1022 this.stationInfo.firmwareVersion?.split('.').length;
72092cfc
JB
1023 const match = this.stationInfo?.firmwareVersion
1024 ?.match(new RegExp(this.stationInfo.firmwareVersionPattern))
1025 ?.slice(1, patternGroup + 1);
3637ca2c 1026 const patchLevelIndex = match.length - 1;
5d280aae 1027 match[patchLevelIndex] = (
07c52a72
JB
1028 Utils.convertToInt(match[patchLevelIndex]) +
1029 this.stationInfo.firmwareUpgrade?.versionUpgrade?.step
5d280aae 1030 ).toString();
72092cfc 1031 this.stationInfo.firmwareVersion = match?.join('.');
3637ca2c 1032 }
6bccfcbc
JB
1033 this.saveStationInfo();
1034 // Avoid duplication of connectors related information in RAM
1035 delete this.stationInfo?.Connectors;
1036 this.configuredSupervisionUrl = this.getConfiguredSupervisionUrl();
1037 if (this.getEnableStatistics() === true) {
1038 this.performanceStatistics = PerformanceStatistics.getInstance(
1039 this.stationInfo.hashId,
1040 this.stationInfo.chargingStationId,
1041 this.configuredSupervisionUrl
1042 );
1043 }
692f2f64
JB
1044 this.bootNotificationRequest = ChargingStationUtils.createBootNotificationRequest(
1045 this.stationInfo
1046 );
1047 this.powerDivider = this.getPowerDivider();
1048 // OCPP configuration
1049 this.ocppConfiguration = this.getOcppConfiguration();
1050 this.initializeOcppConfiguration();
1051 this.initializeOcppServices();
1052 if (this.stationInfo?.autoRegister === true) {
1053 this.bootNotificationResponse = {
1054 currentTime: new Date(),
1055 interval: this.getHeartbeatInterval() / 1000,
1056 status: RegistrationStatusEnumType.ACCEPTED,
1057 };
1058 }
147d0e0f
JB
1059 }
1060
feff11ec
JB
1061 private initializeOcppServices(): void {
1062 const ocppVersion = this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16;
1063 switch (ocppVersion) {
1064 case OCPPVersion.VERSION_16:
1065 this.ocppIncomingRequestService =
1066 OCPP16IncomingRequestService.getInstance<OCPP16IncomingRequestService>();
1067 this.ocppRequestService = OCPP16RequestService.getInstance<OCPP16RequestService>(
1068 OCPP16ResponseService.getInstance<OCPP16ResponseService>()
1069 );
1070 break;
1071 case OCPPVersion.VERSION_20:
1072 case OCPPVersion.VERSION_201:
1073 this.ocppIncomingRequestService =
1074 OCPP20IncomingRequestService.getInstance<OCPP20IncomingRequestService>();
1075 this.ocppRequestService = OCPP20RequestService.getInstance<OCPP20RequestService>(
1076 OCPP20ResponseService.getInstance<OCPP20ResponseService>()
1077 );
1078 break;
1079 default:
1080 this.handleUnsupportedVersion(ocppVersion);
1081 break;
1082 }
1083 }
1084
2484ac1e 1085 private initializeOcppConfiguration(): void {
17ac262c
JB
1086 if (
1087 !ChargingStationConfigurationUtils.getConfigurationKey(
1088 this,
1089 StandardParametersKey.HeartbeatInterval
1090 )
1091 ) {
1092 ChargingStationConfigurationUtils.addConfigurationKey(
1093 this,
1094 StandardParametersKey.HeartbeatInterval,
1095 '0'
1096 );
f0f65a62 1097 }
17ac262c
JB
1098 if (
1099 !ChargingStationConfigurationUtils.getConfigurationKey(
1100 this,
1101 StandardParametersKey.HeartBeatInterval
1102 )
1103 ) {
1104 ChargingStationConfigurationUtils.addConfigurationKey(
1105 this,
1106 StandardParametersKey.HeartBeatInterval,
1107 '0',
1108 { visible: false }
1109 );
f0f65a62 1110 }
e7aeea18
JB
1111 if (
1112 this.getSupervisionUrlOcppConfiguration() &&
269de583 1113 Utils.isNotEmptyString(this.getSupervisionUrlOcppKey()) &&
17ac262c 1114 !ChargingStationConfigurationUtils.getConfigurationKey(this, this.getSupervisionUrlOcppKey())
e7aeea18 1115 ) {
17ac262c
JB
1116 ChargingStationConfigurationUtils.addConfigurationKey(
1117 this,
a59737e3 1118 this.getSupervisionUrlOcppKey(),
fa7bccf4 1119 this.configuredSupervisionUrl.href,
e7aeea18
JB
1120 { reboot: true }
1121 );
e6895390
JB
1122 } else if (
1123 !this.getSupervisionUrlOcppConfiguration() &&
269de583 1124 Utils.isNotEmptyString(this.getSupervisionUrlOcppKey()) &&
17ac262c 1125 ChargingStationConfigurationUtils.getConfigurationKey(this, this.getSupervisionUrlOcppKey())
e6895390 1126 ) {
17ac262c
JB
1127 ChargingStationConfigurationUtils.deleteConfigurationKey(
1128 this,
1129 this.getSupervisionUrlOcppKey(),
1130 { save: false }
1131 );
12fc74d6 1132 }
cc6e8ab5 1133 if (
5a2a53cf 1134 Utils.isNotEmptyString(this.stationInfo?.amperageLimitationOcppKey) &&
17ac262c
JB
1135 !ChargingStationConfigurationUtils.getConfigurationKey(
1136 this,
1137 this.stationInfo.amperageLimitationOcppKey
1138 )
cc6e8ab5 1139 ) {
17ac262c
JB
1140 ChargingStationConfigurationUtils.addConfigurationKey(
1141 this,
cc6e8ab5 1142 this.stationInfo.amperageLimitationOcppKey,
17ac262c
JB
1143 (
1144 this.stationInfo.maximumAmperage *
1145 ChargingStationUtils.getAmperageLimitationUnitDivider(this.stationInfo)
1146 ).toString()
cc6e8ab5
JB
1147 );
1148 }
17ac262c
JB
1149 if (
1150 !ChargingStationConfigurationUtils.getConfigurationKey(
1151 this,
1152 StandardParametersKey.SupportedFeatureProfiles
1153 )
1154 ) {
1155 ChargingStationConfigurationUtils.addConfigurationKey(
1156 this,
e7aeea18 1157 StandardParametersKey.SupportedFeatureProfiles,
b22787b4 1158 `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.FirmwareManagement},${SupportedFeatureProfiles.LocalAuthListManagement},${SupportedFeatureProfiles.SmartCharging},${SupportedFeatureProfiles.RemoteTrigger}`
e7aeea18
JB
1159 );
1160 }
17ac262c
JB
1161 ChargingStationConfigurationUtils.addConfigurationKey(
1162 this,
e7aeea18
JB
1163 StandardParametersKey.NumberOfConnectors,
1164 this.getNumberOfConnectors().toString(),
a95873d8
JB
1165 { readonly: true },
1166 { overwrite: true }
e7aeea18 1167 );
17ac262c
JB
1168 if (
1169 !ChargingStationConfigurationUtils.getConfigurationKey(
1170 this,
1171 StandardParametersKey.MeterValuesSampledData
1172 )
1173 ) {
1174 ChargingStationConfigurationUtils.addConfigurationKey(
1175 this,
e7aeea18
JB
1176 StandardParametersKey.MeterValuesSampledData,
1177 MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER
1178 );
7abfea5f 1179 }
17ac262c
JB
1180 if (
1181 !ChargingStationConfigurationUtils.getConfigurationKey(
1182 this,
1183 StandardParametersKey.ConnectorPhaseRotation
1184 )
1185 ) {
7e1dc878 1186 const connectorPhaseRotation = [];
734d790d 1187 for (const connectorId of this.connectors.keys()) {
7e1dc878 1188 // AC/DC
734d790d
JB
1189 if (connectorId === 0 && this.getNumberOfPhases() === 0) {
1190 connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.RST}`);
1191 } else if (connectorId > 0 && this.getNumberOfPhases() === 0) {
1192 connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.NotApplicable}`);
e7aeea18 1193 // AC
734d790d
JB
1194 } else if (connectorId > 0 && this.getNumberOfPhases() === 1) {
1195 connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.NotApplicable}`);
1196 } else if (connectorId > 0 && this.getNumberOfPhases() === 3) {
1197 connectorPhaseRotation.push(`${connectorId}.${ConnectorPhaseRotation.RST}`);
7e1dc878
JB
1198 }
1199 }
17ac262c
JB
1200 ChargingStationConfigurationUtils.addConfigurationKey(
1201 this,
e7aeea18
JB
1202 StandardParametersKey.ConnectorPhaseRotation,
1203 connectorPhaseRotation.toString()
1204 );
7e1dc878 1205 }
e7aeea18 1206 if (
17ac262c
JB
1207 !ChargingStationConfigurationUtils.getConfigurationKey(
1208 this,
1209 StandardParametersKey.AuthorizeRemoteTxRequests
e7aeea18
JB
1210 )
1211 ) {
17ac262c
JB
1212 ChargingStationConfigurationUtils.addConfigurationKey(
1213 this,
1214 StandardParametersKey.AuthorizeRemoteTxRequests,
1215 'true'
1216 );
36f6a92e 1217 }
17ac262c
JB
1218 if (
1219 !ChargingStationConfigurationUtils.getConfigurationKey(
1220 this,
1221 StandardParametersKey.LocalAuthListEnabled
1222 ) &&
1223 ChargingStationConfigurationUtils.getConfigurationKey(
1224 this,
1225 StandardParametersKey.SupportedFeatureProfiles
72092cfc 1226 )?.value?.includes(SupportedFeatureProfiles.LocalAuthListManagement)
17ac262c
JB
1227 ) {
1228 ChargingStationConfigurationUtils.addConfigurationKey(
1229 this,
1230 StandardParametersKey.LocalAuthListEnabled,
1231 'false'
1232 );
1233 }
1234 if (
1235 !ChargingStationConfigurationUtils.getConfigurationKey(
1236 this,
1237 StandardParametersKey.ConnectionTimeOut
1238 )
1239 ) {
1240 ChargingStationConfigurationUtils.addConfigurationKey(
1241 this,
e7aeea18
JB
1242 StandardParametersKey.ConnectionTimeOut,
1243 Constants.DEFAULT_CONNECTION_TIMEOUT.toString()
1244 );
8bce55bf 1245 }
2484ac1e 1246 this.saveOcppConfiguration();
073bd098
JB
1247 }
1248
3d25cc86
JB
1249 private initializeConnectors(
1250 stationInfo: ChargingStationInfo,
fa7bccf4 1251 configuredMaxConnectors: number,
3d25cc86
JB
1252 templateMaxConnectors: number
1253 ): void {
1254 if (!stationInfo?.Connectors && this.connectors.size === 0) {
fc040c43
JB
1255 const logMsg = `No already defined connectors and charging station information from template ${this.templateFile} with no connectors configuration defined`;
1256 logger.error(`${this.logPrefix()} ${logMsg}`);
3d25cc86
JB
1257 throw new BaseError(logMsg);
1258 }
1259 if (!stationInfo?.Connectors[0]) {
1260 logger.warn(
1261 `${this.logPrefix()} Charging station information from template ${
1262 this.templateFile
2585c6e9 1263 } with no connector id 0 configuration`
3d25cc86
JB
1264 );
1265 }
1266 if (stationInfo?.Connectors) {
1267 const connectorsConfigHash = crypto
1268 .createHash(Constants.DEFAULT_HASH_ALGORITHM)
14ecae6a 1269 .update(`${JSON.stringify(stationInfo?.Connectors)}${configuredMaxConnectors.toString()}`)
3d25cc86
JB
1270 .digest('hex');
1271 const connectorsConfigChanged =
1272 this.connectors?.size !== 0 && this.connectorsConfigurationHash !== connectorsConfigHash;
1273 if (this.connectors?.size === 0 || connectorsConfigChanged) {
1274 connectorsConfigChanged && this.connectors.clear();
1275 this.connectorsConfigurationHash = connectorsConfigHash;
2585c6e9 1276 // Add connector id 0
3d25cc86
JB
1277 let lastConnector = '0';
1278 for (lastConnector in stationInfo?.Connectors) {
56eb297e 1279 const connectorStatus = stationInfo?.Connectors[lastConnector];
3d25cc86
JB
1280 const lastConnectorId = Utils.convertToInt(lastConnector);
1281 if (
1282 lastConnectorId === 0 &&
bb83b5ed 1283 this.getUseConnectorId0(stationInfo) === true &&
56eb297e 1284 connectorStatus
3d25cc86 1285 ) {
56eb297e 1286 this.checkStationInfoConnectorStatus(lastConnectorId, connectorStatus);
3d25cc86
JB
1287 this.connectors.set(
1288 lastConnectorId,
56eb297e 1289 Utils.cloneObject<ConnectorStatus>(connectorStatus)
3d25cc86
JB
1290 );
1291 this.getConnectorStatus(lastConnectorId).availability = AvailabilityType.OPERATIVE;
1292 if (Utils.isUndefined(this.getConnectorStatus(lastConnectorId)?.chargingProfiles)) {
1293 this.getConnectorStatus(lastConnectorId).chargingProfiles = [];
1294 }
1295 }
1296 }
1297 // Generate all connectors
1298 if ((stationInfo?.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) > 0) {
fa7bccf4 1299 for (let index = 1; index <= configuredMaxConnectors; index++) {
ccb1d6e9 1300 const randConnectorId = stationInfo?.randomConnectors
3d25cc86
JB
1301 ? Utils.getRandomInteger(Utils.convertToInt(lastConnector), 1)
1302 : index;
56eb297e
JB
1303 const connectorStatus = stationInfo?.Connectors[randConnectorId.toString()];
1304 this.checkStationInfoConnectorStatus(randConnectorId, connectorStatus);
1305 this.connectors.set(index, Utils.cloneObject<ConnectorStatus>(connectorStatus));
3d25cc86
JB
1306 this.getConnectorStatus(index).availability = AvailabilityType.OPERATIVE;
1307 if (Utils.isUndefined(this.getConnectorStatus(index)?.chargingProfiles)) {
1308 this.getConnectorStatus(index).chargingProfiles = [];
1309 }
1310 }
1311 }
1312 }
1313 } else {
1314 logger.warn(
1315 `${this.logPrefix()} Charging station information from template ${
1316 this.templateFile
1317 } with no connectors configuration defined, using already defined connectors`
1318 );
1319 }
1320 // Initialize transaction attributes on connectors
1321 for (const connectorId of this.connectors.keys()) {
72092cfc 1322 if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted === true) {
f5b51071
JB
1323 logger.warn(
1324 `${this.logPrefix()} Connector ${connectorId} at initialization has a transaction started: ${
72092cfc 1325 this.getConnectorStatus(connectorId)?.transactionId
f5b51071
JB
1326 }`
1327 );
1328 }
1984f194
JB
1329 if (
1330 connectorId > 0 &&
9bb1159e 1331 Utils.isNullOrUndefined(this.getConnectorStatus(connectorId)?.transactionStarted)
1984f194 1332 ) {
3d25cc86
JB
1333 this.initializeConnectorStatus(connectorId);
1334 }
1335 }
1336 }
1337
2585c6e9
JB
1338 private initializeEvses(stationInfo: ChargingStationInfo): void {
1339 if (!stationInfo?.Evses && this.evses.size === 0) {
1340 const logMsg = `No already defined evses and charging station information from template ${this.templateFile} with no evses configuration defined`;
1341 logger.warn(`${this.logPrefix()} ${logMsg}`);
1342 return;
1343 }
1344 if (!stationInfo?.Evses[0]) {
1345 logger.warn(
1346 `${this.logPrefix()} Charging station information from template ${
1347 this.templateFile
1348 } with no evse id 0 configuration`
1349 );
1350 }
1351 if (stationInfo?.Evses) {
1352 const evsesConfigHash = crypto
1353 .createHash(Constants.DEFAULT_HASH_ALGORITHM)
1354 .update(`${JSON.stringify(stationInfo?.Evses)}`)
1355 .digest('hex');
1356 const evsesConfigChanged =
1357 this.evses?.size !== 0 && this.evsesConfigurationHash !== evsesConfigHash;
1358 if (this.evses?.size === 0 || evsesConfigChanged) {
1359 evsesConfigChanged && this.evses.clear();
1360 this.evsesConfigurationHash = evsesConfigHash;
1361 for (const evse in stationInfo?.Evses) {
1362 const evseId = Utils.convertToInt(evse);
1363 this.evses.set(evseId, Utils.cloneObject<EvseStatus>(stationInfo?.Evses[evse]));
1364 this.evses.get(evseId).availability = AvailabilityType.OPERATIVE;
1365 }
1366 }
1367 } else {
1368 if (this.connectors.size === 0) {
1369 const logMsg = `No already defined connectors and charging station information from template ${this.templateFile} with no evses configuration defined`;
1370 logger.error(`${this.logPrefix()} ${logMsg}`);
1371 throw new BaseError(logMsg);
1372 }
1373 logger.info(
1374 `${this.logPrefix()} Charging station information from template ${
1375 this.templateFile
1376 } with no evses configuration defined, mapping one connector to one evse`
1377 );
1378 for (const [connectorId, connectorStatus] of this.connectors) {
1379 this.evses.set(connectorId, {
1380 connectorIds: [connectorId],
1381 availability: connectorStatus.availability,
1382 });
1383 }
1384 }
1385 }
1386
56eb297e
JB
1387 private checkStationInfoConnectorStatus(
1388 connectorId: number,
1389 connectorStatus: ConnectorStatus
1390 ): void {
1391 if (!Utils.isNullOrUndefined(connectorStatus?.status)) {
1392 logger.warn(
1393 `${this.logPrefix()} Charging station information from template ${
1394 this.templateFile
1395 } with connector ${connectorId} status configuration defined, undefine it`
1396 );
cdde2cfe 1397 delete connectorStatus.status;
56eb297e
JB
1398 }
1399 }
1400
551e477c
JB
1401 private getConfigurationFromFile(): ChargingStationConfiguration | undefined {
1402 let configuration: ChargingStationConfiguration | undefined;
2484ac1e 1403 if (this.configurationFile && fs.existsSync(this.configurationFile)) {
073bd098 1404 try {
57adbebc
JB
1405 if (this.sharedLRUCache.hasChargingStationConfiguration(this.configurationFileHash)) {
1406 configuration = this.sharedLRUCache.getChargingStationConfiguration(
1407 this.configurationFileHash
1408 );
7c72977b
JB
1409 } else {
1410 const measureId = `${FileType.ChargingStationConfiguration} read`;
1411 const beginId = PerformanceStatistics.beginMeasure(measureId);
1412 configuration = JSON.parse(
1413 fs.readFileSync(this.configurationFile, 'utf8')
1414 ) as ChargingStationConfiguration;
1415 PerformanceStatistics.endMeasure(measureId, beginId);
1416 this.configurationFileHash = configuration.configurationHash;
57adbebc 1417 this.sharedLRUCache.setChargingStationConfiguration(configuration);
7c72977b 1418 }
073bd098
JB
1419 } catch (error) {
1420 FileUtils.handleFileException(
073bd098 1421 this.configurationFile,
7164966d
JB
1422 FileType.ChargingStationConfiguration,
1423 error as NodeJS.ErrnoException,
1424 this.logPrefix()
073bd098
JB
1425 );
1426 }
1427 }
1428 return configuration;
1429 }
1430
7c72977b 1431 private saveConfiguration(): void {
2484ac1e
JB
1432 if (this.configurationFile) {
1433 try {
2484ac1e
JB
1434 if (!fs.existsSync(path.dirname(this.configurationFile))) {
1435 fs.mkdirSync(path.dirname(this.configurationFile), { recursive: true });
073bd098 1436 }
ccb1d6e9 1437 const configurationData: ChargingStationConfiguration =
abe9e9dd 1438 Utils.cloneObject(this.getConfigurationFromFile()) ?? {};
7c72977b
JB
1439 this.ocppConfiguration?.configurationKey &&
1440 (configurationData.configurationKey = this.ocppConfiguration.configurationKey);
1441 this.stationInfo && (configurationData.stationInfo = this.stationInfo);
1442 delete configurationData.configurationHash;
1443 const configurationHash = crypto
1444 .createHash(Constants.DEFAULT_HASH_ALGORITHM)
1445 .update(JSON.stringify(configurationData))
1446 .digest('hex');
1447 if (this.configurationFileHash !== configurationHash) {
1448 configurationData.configurationHash = configurationHash;
1449 const measureId = `${FileType.ChargingStationConfiguration} write`;
1450 const beginId = PerformanceStatistics.beginMeasure(measureId);
1451 const fileDescriptor = fs.openSync(this.configurationFile, 'w');
1452 fs.writeFileSync(fileDescriptor, JSON.stringify(configurationData, null, 2), 'utf8');
1453 fs.closeSync(fileDescriptor);
1454 PerformanceStatistics.endMeasure(measureId, beginId);
57adbebc 1455 this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash);
7c72977b 1456 this.configurationFileHash = configurationHash;
57adbebc 1457 this.sharedLRUCache.setChargingStationConfiguration(configurationData);
7c72977b
JB
1458 } else {
1459 logger.debug(
1460 `${this.logPrefix()} Not saving unchanged charging station configuration file ${
1461 this.configurationFile
1462 }`
1463 );
2484ac1e 1464 }
2484ac1e
JB
1465 } catch (error) {
1466 FileUtils.handleFileException(
2484ac1e 1467 this.configurationFile,
7164966d
JB
1468 FileType.ChargingStationConfiguration,
1469 error as NodeJS.ErrnoException,
1470 this.logPrefix()
073bd098
JB
1471 );
1472 }
2484ac1e
JB
1473 } else {
1474 logger.error(
01efc60a 1475 `${this.logPrefix()} Trying to save charging station configuration to undefined configuration file`
2484ac1e 1476 );
073bd098
JB
1477 }
1478 }
1479
551e477c
JB
1480 private getOcppConfigurationFromTemplate(): ChargingStationOcppConfiguration | undefined {
1481 return this.getTemplateFromFile()?.Configuration;
2484ac1e
JB
1482 }
1483
551e477c
JB
1484 private getOcppConfigurationFromFile(): ChargingStationOcppConfiguration | undefined {
1485 let configuration: ChargingStationConfiguration | undefined;
23290150 1486 if (this.getOcppPersistentConfiguration() === true) {
7a3a2ebb
JB
1487 const configurationFromFile = this.getConfigurationFromFile();
1488 configuration = configurationFromFile?.configurationKey && configurationFromFile;
073bd098 1489 }
648512ce
JB
1490 if (!Utils.isNullOrUndefined(configuration)) {
1491 delete configuration.stationInfo;
1492 delete configuration.configurationHash;
1493 }
073bd098 1494 return configuration;
7dde0b73
JB
1495 }
1496
551e477c
JB
1497 private getOcppConfiguration(): ChargingStationOcppConfiguration | undefined {
1498 let ocppConfiguration: ChargingStationOcppConfiguration | undefined =
72092cfc 1499 this.getOcppConfigurationFromFile();
2484ac1e
JB
1500 if (!ocppConfiguration) {
1501 ocppConfiguration = this.getOcppConfigurationFromTemplate();
1502 }
1503 return ocppConfiguration;
1504 }
1505
c0560973 1506 private async onOpen(): Promise<void> {
56eb297e 1507 if (this.isWebSocketConnectionOpened() === true) {
5144f4d1
JB
1508 logger.info(
1509 `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} succeeded`
1510 );
ed6cfcff 1511 if (this.isRegistered() === false) {
5144f4d1
JB
1512 // Send BootNotification
1513 let registrationRetryCount = 0;
1514 do {
f7f98c68 1515 this.bootNotificationResponse = await this.ocppRequestService.requestHandler<
5144f4d1
JB
1516 BootNotificationRequest,
1517 BootNotificationResponse
8bfbc743
JB
1518 >(this, RequestCommand.BOOT_NOTIFICATION, this.bootNotificationRequest, {
1519 skipBufferingOnError: true,
1520 });
ed6cfcff 1521 if (this.isRegistered() === false) {
5144f4d1
JB
1522 this.getRegistrationMaxRetries() !== -1 && registrationRetryCount++;
1523 await Utils.sleep(
1895299d 1524 this?.bootNotificationResponse?.interval
5144f4d1
JB
1525 ? this.bootNotificationResponse.interval * 1000
1526 : Constants.OCPP_DEFAULT_BOOT_NOTIFICATION_INTERVAL
1527 );
1528 }
1529 } while (
ed6cfcff 1530 this.isRegistered() === false &&
5144f4d1
JB
1531 (registrationRetryCount <= this.getRegistrationMaxRetries() ||
1532 this.getRegistrationMaxRetries() === -1)
1533 );
1534 }
ed6cfcff 1535 if (this.isRegistered() === true) {
23290150 1536 if (this.isInAcceptedState() === true) {
94bb24d5 1537 await this.startMessageSequence();
c0560973 1538 }
5144f4d1
JB
1539 } else {
1540 logger.error(
1541 `${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})`
1542 );
caad9d6b 1543 }
5144f4d1 1544 this.wsConnectionRestarted = false;
aa428a31 1545 this.autoReconnectRetryCount = 0;
1895299d 1546 parentPort?.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
2e6f5966 1547 } else {
5144f4d1
JB
1548 logger.warn(
1549 `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} failed`
e7aeea18 1550 );
2e6f5966 1551 }
2e6f5966
JB
1552 }
1553
ef7d8c21 1554 private async onClose(code: number, reason: Buffer): Promise<void> {
d09085e9 1555 switch (code) {
6c65a295
JB
1556 // Normal close
1557 case WebSocketCloseEventStatusCode.CLOSE_NORMAL:
c0560973 1558 case WebSocketCloseEventStatusCode.CLOSE_NO_STATUS:
e7aeea18 1559 logger.info(
5e3cb728 1560 `${this.logPrefix()} WebSocket normally closed with status '${Utils.getWebSocketCloseEventStatusString(
e7aeea18 1561 code
ef7d8c21 1562 )}' and reason '${reason.toString()}'`
e7aeea18 1563 );
c0560973
JB
1564 this.autoReconnectRetryCount = 0;
1565 break;
6c65a295
JB
1566 // Abnormal close
1567 default:
e7aeea18 1568 logger.error(
5e3cb728 1569 `${this.logPrefix()} WebSocket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString(
e7aeea18 1570 code
ef7d8c21 1571 )}' and reason '${reason.toString()}'`
e7aeea18 1572 );
56eb297e 1573 this.started === true && (await this.reconnect());
c0560973
JB
1574 break;
1575 }
1895299d 1576 parentPort?.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
2e6f5966
JB
1577 }
1578
56d09fd7
JB
1579 private getCachedRequest(messageType: MessageType, messageId: string): CachedRequest | undefined {
1580 const cachedRequest = this.requests.get(messageId);
1581 if (Array.isArray(cachedRequest) === true) {
1582 return cachedRequest;
1583 }
1584 throw new OCPPError(
1585 ErrorType.PROTOCOL_ERROR,
1586 `Cached request for message id ${messageId} ${OCPPServiceUtils.getMessageTypeString(
1587 messageType
1588 )} is not an array`,
1589 undefined,
617cad0c 1590 cachedRequest as JsonType
56d09fd7
JB
1591 );
1592 }
1593
1594 private async handleIncomingMessage(request: IncomingRequest): Promise<void> {
1595 const [messageType, messageId, commandName, commandPayload] = request;
1596 if (this.getEnableStatistics() === true) {
1597 this.performanceStatistics?.addRequestStatistic(commandName, messageType);
1598 }
1599 logger.debug(
1600 `${this.logPrefix()} << Command '${commandName}' received request payload: ${JSON.stringify(
1601 request
1602 )}`
1603 );
1604 // Process the message
1605 await this.ocppIncomingRequestService.incomingRequestHandler(
1606 this,
1607 messageId,
1608 commandName,
1609 commandPayload
1610 );
1611 }
1612
1613 private handleResponseMessage(response: Response): void {
1614 const [messageType, messageId, commandPayload] = response;
1615 if (this.requests.has(messageId) === false) {
1616 // Error
1617 throw new OCPPError(
1618 ErrorType.INTERNAL_ERROR,
1619 `Response for unknown message id ${messageId}`,
1620 undefined,
1621 commandPayload
1622 );
1623 }
1624 // Respond
1625 const [responseCallback, , requestCommandName, requestPayload] = this.getCachedRequest(
1626 messageType,
1627 messageId
1628 );
1629 logger.debug(
1630 `${this.logPrefix()} << Command '${
1631 requestCommandName ?? Constants.UNKNOWN_COMMAND
1632 }' received response payload: ${JSON.stringify(response)}`
1633 );
1634 responseCallback(commandPayload, requestPayload);
1635 }
1636
1637 private handleErrorMessage(errorResponse: ErrorResponse): void {
1638 const [messageType, messageId, errorType, errorMessage, errorDetails] = errorResponse;
1639 if (this.requests.has(messageId) === false) {
1640 // Error
1641 throw new OCPPError(
1642 ErrorType.INTERNAL_ERROR,
1643 `Error response for unknown message id ${messageId}`,
1644 undefined,
1645 { errorType, errorMessage, errorDetails }
1646 );
1647 }
1648 const [, errorCallback, requestCommandName] = this.getCachedRequest(messageType, messageId);
1649 logger.debug(
1650 `${this.logPrefix()} << Command '${
1651 requestCommandName ?? Constants.UNKNOWN_COMMAND
1652 }' received error response payload: ${JSON.stringify(errorResponse)}`
1653 );
1654 errorCallback(new OCPPError(errorType, errorMessage, requestCommandName, errorDetails));
1655 }
1656
ef7d8c21 1657 private async onMessage(data: RawData): Promise<void> {
56d09fd7 1658 let request: IncomingRequest | Response | ErrorResponse;
b3ec7bc1 1659 let messageType: number;
c0560973
JB
1660 let errMsg: string;
1661 try {
56d09fd7 1662 request = JSON.parse(data.toString()) as IncomingRequest | Response | ErrorResponse;
53e5fd67 1663 if (Array.isArray(request) === true) {
56d09fd7 1664 [messageType] = request;
b3ec7bc1
JB
1665 // Check the type of message
1666 switch (messageType) {
1667 // Incoming Message
1668 case MessageType.CALL_MESSAGE:
56d09fd7 1669 await this.handleIncomingMessage(request as IncomingRequest);
b3ec7bc1 1670 break;
56d09fd7 1671 // Response Message
b3ec7bc1 1672 case MessageType.CALL_RESULT_MESSAGE:
56d09fd7 1673 this.handleResponseMessage(request as Response);
a2d1c0f1
JB
1674 break;
1675 // Error Message
1676 case MessageType.CALL_ERROR_MESSAGE:
56d09fd7 1677 this.handleErrorMessage(request as ErrorResponse);
b3ec7bc1 1678 break;
56d09fd7 1679 // Unknown Message
b3ec7bc1
JB
1680 default:
1681 // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
fc040c43
JB
1682 errMsg = `Wrong message type ${messageType}`;
1683 logger.error(`${this.logPrefix()} ${errMsg}`);
b3ec7bc1
JB
1684 throw new OCPPError(ErrorType.PROTOCOL_ERROR, errMsg);
1685 }
1895299d 1686 parentPort?.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
47e22477 1687 } else {
53e5fd67 1688 throw new OCPPError(ErrorType.PROTOCOL_ERROR, 'Incoming message is not an array', null, {
ba7965c4 1689 request,
ac54a9bb 1690 });
47e22477 1691 }
c0560973 1692 } catch (error) {
56d09fd7
JB
1693 let commandName: IncomingRequestCommand;
1694 let requestCommandName: RequestCommand | IncomingRequestCommand;
1695 let errorCallback: ErrorCallback;
1696 const [, messageId] = request;
13701f69
JB
1697 switch (messageType) {
1698 case MessageType.CALL_MESSAGE:
56d09fd7 1699 [, , commandName] = request as IncomingRequest;
13701f69 1700 // Send error
56d09fd7 1701 await this.ocppRequestService.sendError(this, messageId, error as OCPPError, commandName);
13701f69
JB
1702 break;
1703 case MessageType.CALL_RESULT_MESSAGE:
1704 case MessageType.CALL_ERROR_MESSAGE:
56d09fd7
JB
1705 if (this.requests.has(messageId) === true) {
1706 [, errorCallback, requestCommandName] = this.getCachedRequest(messageType, messageId);
13701f69
JB
1707 // Reject the deferred promise in case of error at response handling (rejecting an already fulfilled promise is a no-op)
1708 errorCallback(error as OCPPError, false);
1709 } else {
1710 // Remove the request from the cache in case of error at response handling
1711 this.requests.delete(messageId);
1712 }
de4cb8b6 1713 break;
ba7965c4 1714 }
56d09fd7
JB
1715 if (error instanceof OCPPError === false) {
1716 logger.warn(
1717 `${this.logPrefix()} Error thrown at incoming OCPP command '${
1718 commandName ?? requestCommandName ?? Constants.UNKNOWN_COMMAND
1719 }' message '${data.toString()}' handling is not an OCPPError:`,
1720 error
1721 );
1722 }
1723 logger.error(
1724 `${this.logPrefix()} Incoming OCPP command '${
1725 commandName ?? requestCommandName ?? Constants.UNKNOWN_COMMAND
1726 }' message '${data.toString()}'${
1727 messageType !== MessageType.CALL_MESSAGE
1728 ? ` matching cached request '${JSON.stringify(this.requests.get(messageId))}'`
1729 : ''
1730 } processing error:`,
1731 error
1732 );
c0560973 1733 }
2328be1e
JB
1734 }
1735
c0560973 1736 private onPing(): void {
44eb6026 1737 logger.debug(`${this.logPrefix()} Received a WS ping (rfc6455) from the server`);
c0560973
JB
1738 }
1739
1740 private onPong(): void {
44eb6026 1741 logger.debug(`${this.logPrefix()} Received a WS pong (rfc6455) from the server`);
c0560973
JB
1742 }
1743
9534e74e 1744 private onError(error: WSError): void {
bcc9c3c0 1745 this.closeWSConnection();
44eb6026 1746 logger.error(`${this.logPrefix()} WebSocket error:`, error);
c0560973
JB
1747 }
1748
18bf8274 1749 private getEnergyActiveImportRegister(connectorStatus: ConnectorStatus, rounded = false): number {
95bdbf12 1750 if (this.getMeteringPerTransaction() === true) {
07989fad 1751 return (
18bf8274 1752 (rounded === true
07989fad
JB
1753 ? Math.round(connectorStatus?.transactionEnergyActiveImportRegisterValue)
1754 : connectorStatus?.transactionEnergyActiveImportRegisterValue) ?? 0
1755 );
1756 }
1757 return (
18bf8274 1758 (rounded === true
07989fad
JB
1759 ? Math.round(connectorStatus?.energyActiveImportRegisterValue)
1760 : connectorStatus?.energyActiveImportRegisterValue) ?? 0
1761 );
1762 }
1763
bb83b5ed 1764 private getUseConnectorId0(stationInfo?: ChargingStationInfo): boolean {
fa7bccf4 1765 const localStationInfo = stationInfo ?? this.stationInfo;
a14885a3 1766 return localStationInfo?.useConnectorId0 ?? true;
8bce55bf
JB
1767 }
1768
60ddad53
JB
1769 private getNumberOfRunningTransactions(): number {
1770 let trxCount = 0;
1771 for (const connectorId of this.connectors.keys()) {
1772 if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted === true) {
1773 trxCount++;
1774 }
1775 }
1776 return trxCount;
1777 }
1778
1779 private async stopRunningTransactions(reason = StopTransactionReason.NONE): Promise<void> {
1780 for (const connectorId of this.connectors.keys()) {
1781 if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted === true) {
1782 await this.stopTransactionOnConnector(connectorId, reason);
1783 }
1784 }
1785 }
1786
1f761b9a 1787 // 0 for disabling
c72f6634 1788 private getConnectionTimeout(): number {
17ac262c
JB
1789 if (
1790 ChargingStationConfigurationUtils.getConfigurationKey(
1791 this,
1792 StandardParametersKey.ConnectionTimeOut
1793 )
1794 ) {
e7aeea18 1795 return (
17ac262c
JB
1796 parseInt(
1797 ChargingStationConfigurationUtils.getConfigurationKey(
1798 this,
1799 StandardParametersKey.ConnectionTimeOut
1800 ).value
1801 ) ?? Constants.DEFAULT_CONNECTION_TIMEOUT
e7aeea18 1802 );
291cb255 1803 }
291cb255 1804 return Constants.DEFAULT_CONNECTION_TIMEOUT;
3574dfd3
JB
1805 }
1806
1f761b9a 1807 // -1 for unlimited, 0 for disabling
72092cfc 1808 private getAutoReconnectMaxRetries(): number | undefined {
ad2f27c3
JB
1809 if (!Utils.isUndefined(this.stationInfo.autoReconnectMaxRetries)) {
1810 return this.stationInfo.autoReconnectMaxRetries;
3574dfd3
JB
1811 }
1812 if (!Utils.isUndefined(Configuration.getAutoReconnectMaxRetries())) {
1813 return Configuration.getAutoReconnectMaxRetries();
1814 }
1815 return -1;
1816 }
1817
ec977daf 1818 // 0 for disabling
72092cfc 1819 private getRegistrationMaxRetries(): number | undefined {
ad2f27c3
JB
1820 if (!Utils.isUndefined(this.stationInfo.registrationMaxRetries)) {
1821 return this.stationInfo.registrationMaxRetries;
32a1eb7a
JB
1822 }
1823 return -1;
1824 }
1825
c0560973
JB
1826 private getPowerDivider(): number {
1827 let powerDivider = this.getNumberOfConnectors();
fa7bccf4 1828 if (this.stationInfo?.powerSharedByConnectors) {
c0560973 1829 powerDivider = this.getNumberOfRunningTransactions();
6ecb15e4
JB
1830 }
1831 return powerDivider;
1832 }
1833
fa7bccf4
JB
1834 private getMaximumAmperage(stationInfo: ChargingStationInfo): number | undefined {
1835 const maximumPower = this.getMaximumPower(stationInfo);
1836 switch (this.getCurrentOutType(stationInfo)) {
cc6e8ab5
JB
1837 case CurrentType.AC:
1838 return ACElectricUtils.amperagePerPhaseFromPower(
fa7bccf4 1839 this.getNumberOfPhases(stationInfo),
ad8537a7 1840 maximumPower / this.getNumberOfConnectors(),
fa7bccf4 1841 this.getVoltageOut(stationInfo)
cc6e8ab5
JB
1842 );
1843 case CurrentType.DC:
fa7bccf4 1844 return DCElectricUtils.amperage(maximumPower, this.getVoltageOut(stationInfo));
cc6e8ab5
JB
1845 }
1846 }
1847
cc6e8ab5
JB
1848 private getAmperageLimitation(): number | undefined {
1849 if (
5a2a53cf 1850 Utils.isNotEmptyString(this.stationInfo?.amperageLimitationOcppKey) &&
17ac262c
JB
1851 ChargingStationConfigurationUtils.getConfigurationKey(
1852 this,
1853 this.stationInfo.amperageLimitationOcppKey
1854 )
cc6e8ab5
JB
1855 ) {
1856 return (
1857 Utils.convertToInt(
17ac262c
JB
1858 ChargingStationConfigurationUtils.getConfigurationKey(
1859 this,
1860 this.stationInfo.amperageLimitationOcppKey
72092cfc 1861 )?.value
17ac262c 1862 ) / ChargingStationUtils.getAmperageLimitationUnitDivider(this.stationInfo)
cc6e8ab5
JB
1863 );
1864 }
1865 }
1866
c0560973 1867 private async startMessageSequence(): Promise<void> {
b7f9e41d 1868 if (this.stationInfo?.autoRegister === true) {
f7f98c68 1869 await this.ocppRequestService.requestHandler<
ef6fa3fb
JB
1870 BootNotificationRequest,
1871 BootNotificationResponse
8bfbc743
JB
1872 >(this, RequestCommand.BOOT_NOTIFICATION, this.bootNotificationRequest, {
1873 skipBufferingOnError: true,
1874 });
6114e6f1 1875 }
136c90ba 1876 // Start WebSocket ping
c0560973 1877 this.startWebSocketPing();
5ad8570f 1878 // Start heartbeat
c0560973 1879 this.startHeartbeat();
0a60c33c 1880 // Initialize connectors status
734d790d 1881 for (const connectorId of this.connectors.keys()) {
72092cfc 1882 let connectorStatus: ConnectorStatusEnum | undefined;
734d790d 1883 if (connectorId === 0) {
593cf3f9 1884 continue;
e7aeea18 1885 } else if (
56eb297e
JB
1886 !this.getConnectorStatus(connectorId)?.status &&
1887 (this.isChargingStationAvailable() === false ||
1789ba2c 1888 this.isConnectorAvailable(connectorId) === false)
e7aeea18 1889 ) {
721646e9 1890 connectorStatus = ConnectorStatusEnum.Unavailable;
45c0ae82
JB
1891 } else if (
1892 !this.getConnectorStatus(connectorId)?.status &&
1893 this.getConnectorStatus(connectorId)?.bootStatus
1894 ) {
1895 // Set boot status in template at startup
72092cfc 1896 connectorStatus = this.getConnectorStatus(connectorId)?.bootStatus;
56eb297e
JB
1897 } else if (this.getConnectorStatus(connectorId)?.status) {
1898 // Set previous status at startup
72092cfc 1899 connectorStatus = this.getConnectorStatus(connectorId)?.status;
5ad8570f 1900 } else {
56eb297e 1901 // Set default status
721646e9 1902 connectorStatus = ConnectorStatusEnum.Available;
5ad8570f 1903 }
48b75072 1904 await OCPPServiceUtils.sendAndSetConnectorStatus(this, connectorId, connectorStatus);
5ad8570f 1905 }
c9a4f9ea
JB
1906 if (this.stationInfo?.firmwareStatus === FirmwareStatus.Installing) {
1907 await this.ocppRequestService.requestHandler<
1908 FirmwareStatusNotificationRequest,
1909 FirmwareStatusNotificationResponse
1910 >(this, RequestCommand.FIRMWARE_STATUS_NOTIFICATION, {
1911 status: FirmwareStatus.Installed,
1912 });
1913 this.stationInfo.firmwareStatus = FirmwareStatus.Installed;
c9a4f9ea 1914 }
3637ca2c 1915
0a60c33c 1916 // Start the ATG
60ddad53 1917 if (this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable === true) {
4f69be04 1918 this.startAutomaticTransactionGenerator();
fa7bccf4 1919 }
aa428a31 1920 this.wsConnectionRestarted === true && this.flushMessageBuffer();
fa7bccf4
JB
1921 }
1922
e7aeea18
JB
1923 private async stopMessageSequence(
1924 reason: StopTransactionReason = StopTransactionReason.NONE
1925 ): Promise<void> {
136c90ba 1926 // Stop WebSocket ping
c0560973 1927 this.stopWebSocketPing();
79411696 1928 // Stop heartbeat
c0560973 1929 this.stopHeartbeat();
fa7bccf4 1930 // Stop ongoing transactions
b20eb107 1931 if (this.automaticTransactionGenerator?.started === true) {
60ddad53
JB
1932 this.stopAutomaticTransactionGenerator();
1933 } else {
1934 await this.stopRunningTransactions(reason);
79411696 1935 }
45c0ae82
JB
1936 for (const connectorId of this.connectors.keys()) {
1937 if (connectorId > 0) {
1938 await this.ocppRequestService.requestHandler<
1939 StatusNotificationRequest,
1940 StatusNotificationResponse
6e939d9e
JB
1941 >(
1942 this,
1943 RequestCommand.STATUS_NOTIFICATION,
1944 OCPPServiceUtils.buildStatusNotificationRequest(
1945 this,
1946 connectorId,
721646e9 1947 ConnectorStatusEnum.Unavailable
6e939d9e
JB
1948 )
1949 );
cdde2cfe 1950 delete this.getConnectorStatus(connectorId)?.status;
45c0ae82
JB
1951 }
1952 }
79411696
JB
1953 }
1954
c0560973 1955 private startWebSocketPing(): void {
17ac262c
JB
1956 const webSocketPingInterval: number = ChargingStationConfigurationUtils.getConfigurationKey(
1957 this,
e7aeea18
JB
1958 StandardParametersKey.WebSocketPingInterval
1959 )
1960 ? Utils.convertToInt(
17ac262c
JB
1961 ChargingStationConfigurationUtils.getConfigurationKey(
1962 this,
1963 StandardParametersKey.WebSocketPingInterval
72092cfc 1964 )?.value
e7aeea18 1965 )
9cd3dfb0 1966 : 0;
ad2f27c3
JB
1967 if (webSocketPingInterval > 0 && !this.webSocketPingSetInterval) {
1968 this.webSocketPingSetInterval = setInterval(() => {
56eb297e 1969 if (this.isWebSocketConnectionOpened() === true) {
72092cfc 1970 this.wsConnection?.ping();
136c90ba
JB
1971 }
1972 }, webSocketPingInterval * 1000);
e7aeea18 1973 logger.info(
44eb6026
JB
1974 `${this.logPrefix()} WebSocket ping started every ${Utils.formatDurationSeconds(
1975 webSocketPingInterval
1976 )}`
e7aeea18 1977 );
ad2f27c3 1978 } else if (this.webSocketPingSetInterval) {
e7aeea18 1979 logger.info(
44eb6026
JB
1980 `${this.logPrefix()} WebSocket ping already started every ${Utils.formatDurationSeconds(
1981 webSocketPingInterval
1982 )}`
e7aeea18 1983 );
136c90ba 1984 } else {
e7aeea18 1985 logger.error(
8f953431 1986 `${this.logPrefix()} WebSocket ping interval set to ${webSocketPingInterval}, not starting the WebSocket ping`
e7aeea18 1987 );
136c90ba
JB
1988 }
1989 }
1990
c0560973 1991 private stopWebSocketPing(): void {
ad2f27c3
JB
1992 if (this.webSocketPingSetInterval) {
1993 clearInterval(this.webSocketPingSetInterval);
dfe81c8f 1994 delete this.webSocketPingSetInterval;
136c90ba
JB
1995 }
1996 }
1997
1f5df42a 1998 private getConfiguredSupervisionUrl(): URL {
72092cfc 1999 const supervisionUrls = this.stationInfo?.supervisionUrls ?? Configuration.getSupervisionUrls();
53ac516c 2000 if (Utils.isNotEmptyArray(supervisionUrls)) {
269de583 2001 let configuredSupervisionUrlIndex: number;
2dcfe98e 2002 switch (Configuration.getSupervisionUrlDistribution()) {
2dcfe98e 2003 case SupervisionUrlDistribution.RANDOM:
269de583 2004 configuredSupervisionUrlIndex = Math.floor(Utils.secureRandom() * supervisionUrls.length);
2dcfe98e 2005 break;
a52a6446 2006 case SupervisionUrlDistribution.ROUND_ROBIN:
c72f6634 2007 case SupervisionUrlDistribution.CHARGING_STATION_AFFINITY:
2dcfe98e 2008 default:
a52a6446
JB
2009 Object.values(SupervisionUrlDistribution).includes(
2010 Configuration.getSupervisionUrlDistribution()
2011 ) === false &&
2012 logger.error(
2013 `${this.logPrefix()} Unknown supervision url distribution '${Configuration.getSupervisionUrlDistribution()}' from values '${SupervisionUrlDistribution.toString()}', defaulting to ${
2014 SupervisionUrlDistribution.CHARGING_STATION_AFFINITY
2015 }`
2016 );
269de583 2017 configuredSupervisionUrlIndex = (this.index - 1) % supervisionUrls.length;
2dcfe98e 2018 break;
c0560973 2019 }
269de583 2020 return new URL(supervisionUrls[configuredSupervisionUrlIndex]);
c0560973 2021 }
57939a9d 2022 return new URL(supervisionUrls as string);
136c90ba
JB
2023 }
2024
c0560973 2025 private stopHeartbeat(): void {
ad2f27c3
JB
2026 if (this.heartbeatSetInterval) {
2027 clearInterval(this.heartbeatSetInterval);
dfe81c8f 2028 delete this.heartbeatSetInterval;
7dde0b73 2029 }
5ad8570f
JB
2030 }
2031
55516218 2032 private terminateWSConnection(): void {
56eb297e 2033 if (this.isWebSocketConnectionOpened() === true) {
72092cfc 2034 this.wsConnection?.terminate();
55516218
JB
2035 this.wsConnection = null;
2036 }
2037 }
2038
dd119a6b 2039 private stopMeterValues(connectorId: number) {
734d790d 2040 if (this.getConnectorStatus(connectorId)?.transactionSetInterval) {
72092cfc 2041 clearInterval(this.getConnectorStatus(connectorId)?.transactionSetInterval);
dd119a6b
JB
2042 }
2043 }
2044
c72f6634 2045 private getReconnectExponentialDelay(): boolean {
a14885a3 2046 return this.stationInfo?.reconnectExponentialDelay ?? false;
5ad8570f
JB
2047 }
2048
aa428a31 2049 private async reconnect(): Promise<void> {
7874b0b1
JB
2050 // Stop WebSocket ping
2051 this.stopWebSocketPing();
136c90ba 2052 // Stop heartbeat
c0560973 2053 this.stopHeartbeat();
5ad8570f 2054 // Stop the ATG if needed
6d9876e7 2055 if (this.automaticTransactionGenerator?.configuration?.stopOnConnectionFailure === true) {
fa7bccf4 2056 this.stopAutomaticTransactionGenerator();
ad2f27c3 2057 }
e7aeea18
JB
2058 if (
2059 this.autoReconnectRetryCount < this.getAutoReconnectMaxRetries() ||
2060 this.getAutoReconnectMaxRetries() === -1
2061 ) {
ad2f27c3 2062 this.autoReconnectRetryCount++;
e7aeea18
JB
2063 const reconnectDelay = this.getReconnectExponentialDelay()
2064 ? Utils.exponentialDelay(this.autoReconnectRetryCount)
2065 : this.getConnectionTimeout() * 1000;
1e080116
JB
2066 const reconnectDelayWithdraw = 1000;
2067 const reconnectTimeout =
2068 reconnectDelay && reconnectDelay - reconnectDelayWithdraw > 0
2069 ? reconnectDelay - reconnectDelayWithdraw
2070 : 0;
e7aeea18 2071 logger.error(
d56ea27c 2072 `${this.logPrefix()} WebSocket connection retry in ${Utils.roundTo(
e7aeea18
JB
2073 reconnectDelay,
2074 2
2075 )}ms, timeout ${reconnectTimeout}ms`
2076 );
032d6efc 2077 await Utils.sleep(reconnectDelay);
e7aeea18 2078 logger.error(
44eb6026 2079 `${this.logPrefix()} WebSocket connection retry #${this.autoReconnectRetryCount.toString()}`
e7aeea18
JB
2080 );
2081 this.openWSConnection(
59b6ed8d 2082 {
abe9e9dd 2083 ...(this.stationInfo?.wsOptions ?? {}),
59b6ed8d
JB
2084 handshakeTimeout: reconnectTimeout,
2085 },
1e080116 2086 { closeOpened: true }
e7aeea18 2087 );
265e4266 2088 this.wsConnectionRestarted = true;
c0560973 2089 } else if (this.getAutoReconnectMaxRetries() !== -1) {
e7aeea18 2090 logger.error(
d56ea27c 2091 `${this.logPrefix()} WebSocket connection retries failure: maximum retries reached (${
e7aeea18 2092 this.autoReconnectRetryCount
d56ea27c 2093 }) or retries disabled (${this.getAutoReconnectMaxRetries()})`
e7aeea18 2094 );
5ad8570f
JB
2095 }
2096 }
2097
551e477c
JB
2098 private getAutomaticTransactionGeneratorConfigurationFromTemplate():
2099 | AutomaticTransactionGeneratorConfiguration
2100 | undefined {
2101 return this.getTemplateFromFile()?.AutomaticTransactionGenerator;
fa7bccf4
JB
2102 }
2103
a2653482
JB
2104 private initializeConnectorStatus(connectorId: number): void {
2105 this.getConnectorStatus(connectorId).idTagLocalAuthorized = false;
2106 this.getConnectorStatus(connectorId).idTagAuthorized = false;
2107 this.getConnectorStatus(connectorId).transactionRemoteStarted = false;
734d790d
JB
2108 this.getConnectorStatus(connectorId).transactionStarted = false;
2109 this.getConnectorStatus(connectorId).energyActiveImportRegisterValue = 0;
2110 this.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue = 0;
0a60c33c 2111 }
7dde0b73 2112}