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