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