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