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