1 // Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
3 import crypto from
'node:crypto';
4 import fs from
'node:fs';
5 import path from
'node:path';
6 import { URL
} from
'node:url';
7 import { parentPort
} from
'node:worker_threads';
9 import merge from
'just-merge';
10 import WebSocket
, { type RawData
} from
'ws';
12 import { AutomaticTransactionGenerator
} from
'./AutomaticTransactionGenerator';
13 import { ChargingStationWorkerBroadcastChannel
} from
'./broadcast-channel/ChargingStationWorkerBroadcastChannel';
14 import { ChargingStationConfigurationUtils
} from
'./ChargingStationConfigurationUtils';
15 import { ChargingStationUtils
} from
'./ChargingStationUtils';
16 import { IdTagsCache
} from
'./IdTagsCache';
18 OCPP16IncomingRequestService
,
20 OCPP16ResponseService
,
22 OCPP20IncomingRequestService
,
24 OCPP20ResponseService
,
25 type OCPPIncomingRequestService
,
26 type OCPPRequestService
,
29 import { SharedLRUCache
} from
'./SharedLRUCache';
30 import { BaseError
, OCPPError
} from
'../exception';
31 import { PerformanceStatistics
} from
'../performance';
33 type AutomaticTransactionGeneratorConfiguration
,
35 type BootNotificationRequest
,
36 type BootNotificationResponse
,
38 type ChargingStationConfiguration
,
39 type ChargingStationInfo
,
40 type ChargingStationOcppConfiguration
,
41 type ChargingStationTemplate
,
49 type EvseStatusConfiguration
,
52 type FirmwareStatusNotificationRequest
,
53 type FirmwareStatusNotificationResponse
,
55 type HeartbeatRequest
,
56 type HeartbeatResponse
,
58 type IncomingRequestCommand
,
63 type MeterValuesRequest
,
64 type MeterValuesResponse
,
68 RegistrationStatusEnumType
,
72 ReservationTerminationReason
,
74 StandardParametersKey
,
76 type StatusNotificationRequest
,
77 type StatusNotificationResponse
,
78 StopTransactionReason
,
79 type StopTransactionRequest
,
80 type StopTransactionResponse
,
81 SupervisionUrlDistribution
,
82 SupportedFeatureProfiles
,
85 WebSocketCloseEventStatusCode
,
96 buildChargingStationAutomaticTransactionGeneratorConfiguration
,
97 buildConnectorsStatus
,
107 export class ChargingStation
{
108 public readonly index
: number;
109 public readonly templateFile
: string;
110 public stationInfo
!: ChargingStationInfo
;
111 public started
: boolean;
112 public starting
: boolean;
113 public idTagsCache
: IdTagsCache
;
114 public automaticTransactionGenerator
!: AutomaticTransactionGenerator
| undefined;
115 public ocppConfiguration
!: ChargingStationOcppConfiguration
| undefined;
116 public wsConnection
!: WebSocket
| null;
117 public readonly connectors
: Map
<number, ConnectorStatus
>;
118 public readonly evses
: Map
<number, EvseStatus
>;
119 public readonly requests
: Map
<string, CachedRequest
>;
120 public performanceStatistics
!: PerformanceStatistics
| undefined;
121 public heartbeatSetInterval
!: NodeJS
.Timeout
;
122 public ocppRequestService
!: OCPPRequestService
;
123 public bootNotificationRequest
!: BootNotificationRequest
;
124 public bootNotificationResponse
!: BootNotificationResponse
| undefined;
125 public powerDivider
!: number;
126 private stopping
: boolean;
127 private configurationFile
!: string;
128 private configurationFileHash
!: string;
129 private connectorsConfigurationHash
!: string;
130 private evsesConfigurationHash
!: string;
131 private ocppIncomingRequestService
!: OCPPIncomingRequestService
;
132 private readonly messageBuffer
: Set
<string>;
133 private configuredSupervisionUrl
!: URL
;
134 private wsConnectionRestarted
: boolean;
135 private autoReconnectRetryCount
: number;
136 private templateFileWatcher
!: fs
.FSWatcher
| undefined;
137 private templateFileHash
!: string;
138 private readonly sharedLRUCache
: SharedLRUCache
;
139 private webSocketPingSetInterval
!: NodeJS
.Timeout
;
140 private readonly chargingStationWorkerBroadcastChannel
: ChargingStationWorkerBroadcastChannel
;
141 private reservationExpirationSetInterval
?: NodeJS
.Timeout
;
143 constructor(index
: number, templateFile
: string) {
144 this.started
= false;
145 this.starting
= false;
146 this.stopping
= false;
147 this.wsConnectionRestarted
= false;
148 this.autoReconnectRetryCount
= 0;
150 this.templateFile
= templateFile
;
151 this.connectors
= new Map
<number, ConnectorStatus
>();
152 this.evses
= new Map
<number, EvseStatus
>();
153 this.requests
= new Map
<string, CachedRequest
>();
154 this.messageBuffer
= new Set
<string>();
155 this.sharedLRUCache
= SharedLRUCache
.getInstance();
156 this.idTagsCache
= IdTagsCache
.getInstance();
157 this.chargingStationWorkerBroadcastChannel
= new ChargingStationWorkerBroadcastChannel(this);
162 public get
hasEvses(): boolean {
163 return this.connectors
.size
=== 0 && this.evses
.size
> 0;
166 private get
wsConnectionUrl(): URL
{
169 this.getSupervisionUrlOcppConfiguration() &&
170 Utils.isNotEmptyString(this.getSupervisionUrlOcppKey()) &&
171 Utils.isNotEmptyString(
172 ChargingStationConfigurationUtils.getConfigurationKey(
174 this.getSupervisionUrlOcppKey()
177 ? ChargingStationConfigurationUtils.getConfigurationKey(
179 this.getSupervisionUrlOcppKey()
181 : this.configuredSupervisionUrl.href
182 }/${this.stationInfo.chargingStationId}`
186 public logPrefix
= (): string => {
187 return Utils
.logPrefix(
189 (Utils.isNotEmptyString(this?.stationInfo?.chargingStationId)
190 ? this?.stationInfo?.chargingStationId
191 : ChargingStationUtils.getChargingStationId(this.index, this.getTemplateFromFile())) ??
192 'Error at building log prefix'
197 public hasIdTags(): boolean {
198 return Utils
.isNotEmptyArray(
199 this.idTagsCache
.getIdTags(ChargingStationUtils
.getIdTagsFile(this.stationInfo
))
203 public getEnableStatistics(): boolean {
204 return this.stationInfo
.enableStatistics
?? false;
207 public getMustAuthorizeAtRemoteStart(): boolean {
208 return this.stationInfo
.mustAuthorizeAtRemoteStart
?? true;
211 public getPayloadSchemaValidation(): boolean {
212 return this.stationInfo
.payloadSchemaValidation
?? true;
215 public getNumberOfPhases(stationInfo
?: ChargingStationInfo
): number | undefined {
216 const localStationInfo
: ChargingStationInfo
= stationInfo
?? this.stationInfo
;
217 switch (this.getCurrentOutType(stationInfo
)) {
219 return !Utils
.isUndefined(localStationInfo
.numberOfPhases
)
220 ? localStationInfo
.numberOfPhases
227 public isWebSocketConnectionOpened(): boolean {
228 return this?.wsConnection
?.readyState
=== WebSocket
.OPEN
;
231 public getRegistrationStatus(): RegistrationStatusEnumType
| undefined {
232 return this?.bootNotificationResponse
?.status;
235 public inUnknownState(): boolean {
236 return Utils
.isNullOrUndefined(this?.bootNotificationResponse
?.status);
239 public inPendingState(): boolean {
240 return this?.bootNotificationResponse
?.status === RegistrationStatusEnumType
.PENDING
;
243 public inAcceptedState(): boolean {
244 return this?.bootNotificationResponse
?.status === RegistrationStatusEnumType
.ACCEPTED
;
247 public inRejectedState(): boolean {
248 return this?.bootNotificationResponse
?.status === RegistrationStatusEnumType
.REJECTED
;
251 public isRegistered(): boolean {
253 this.inUnknownState() === false &&
254 (this.inAcceptedState() === true || this.inPendingState() === true)
258 public isChargingStationAvailable(): boolean {
259 return this.getConnectorStatus(0)?.availability
=== AvailabilityType
.Operative
;
262 public hasConnector(connectorId
: number): boolean {
264 for (const evseStatus
of this.evses
.values()) {
265 if (evseStatus
.connectors
.has(connectorId
)) {
271 return this.connectors
.has(connectorId
);
274 public isConnectorAvailable(connectorId
: number): boolean {
277 this.getConnectorStatus(connectorId
)?.availability
=== AvailabilityType
.Operative
281 public getNumberOfConnectors(): number {
283 if (this.evses
.size
=== 0) {
284 throw new BaseError('Evses not initialized, cannot get number of connectors');
286 let numberOfConnectors
= 0;
287 for (const [evseId
, evseStatus
] of this.evses
) {
289 numberOfConnectors
+= evseStatus
.connectors
.size
;
292 return numberOfConnectors
;
294 if (this.connectors
.size
=== 0) {
295 throw new BaseError('Connectors not initialized, cannot get number of connectors');
297 return this.connectors
.has(0) ? this.connectors
.size
- 1 : this.connectors
.size
;
300 public getNumberOfEvses(): number {
301 if (this.evses
.size
=== 0) {
302 throw new BaseError('Evses not initialized, cannot get number of evses');
304 return this.evses
.has(0) ? this.evses
.size
- 1 : this.evses
.size
;
307 public getConnectorStatus(connectorId
: number): ConnectorStatus
| undefined {
309 for (const evseStatus
of this.evses
.values()) {
310 if (evseStatus
.connectors
.has(connectorId
)) {
311 return evseStatus
.connectors
.get(connectorId
);
316 return this.connectors
.get(connectorId
);
319 public getCurrentOutType(stationInfo
?: ChargingStationInfo
): CurrentType
{
320 return (stationInfo
?? this.stationInfo
)?.currentOutType
?? CurrentType
.AC
;
323 public getOcppStrictCompliance(): boolean {
324 return this.stationInfo
?.ocppStrictCompliance
?? false;
327 public getVoltageOut(stationInfo
?: ChargingStationInfo
): number | undefined {
328 const defaultVoltageOut
= ChargingStationUtils
.getDefaultVoltageOut(
329 this.getCurrentOutType(stationInfo
),
333 return (stationInfo
?? this.stationInfo
).voltageOut
?? defaultVoltageOut
;
336 public getMaximumPower(stationInfo
?: ChargingStationInfo
): number {
337 const localStationInfo
= stationInfo
?? this.stationInfo
;
338 return (localStationInfo
['maxPower'] as number) ?? localStationInfo
.maximumPower
;
341 public getConnectorMaximumAvailablePower(connectorId
: number): number {
342 let connectorAmperageLimitationPowerLimit
: number;
344 !Utils
.isNullOrUndefined(this.getAmperageLimitation()) &&
345 this.getAmperageLimitation() < this.stationInfo
?.maximumAmperage
347 connectorAmperageLimitationPowerLimit
=
348 (this.getCurrentOutType() === CurrentType
.AC
349 ? ACElectricUtils
.powerTotal(
350 this.getNumberOfPhases(),
351 this.getVoltageOut(),
352 this.getAmperageLimitation() *
353 (this.hasEvses
? this.getNumberOfEvses() : this.getNumberOfConnectors())
355 : DCElectricUtils
.power(this.getVoltageOut(), this.getAmperageLimitation())) /
358 const connectorMaximumPower
= this.getMaximumPower() / this.powerDivider
;
359 const connectorChargingProfilesPowerLimit
=
360 ChargingStationUtils
.getChargingStationConnectorChargingProfilesPowerLimit(this, connectorId
);
362 isNaN(connectorMaximumPower
) ? Infinity : connectorMaximumPower
,
363 isNaN(connectorAmperageLimitationPowerLimit
)
365 : connectorAmperageLimitationPowerLimit
,
366 isNaN(connectorChargingProfilesPowerLimit
) ? Infinity : connectorChargingProfilesPowerLimit
370 public getTransactionIdTag(transactionId
: number): string | undefined {
372 for (const evseStatus
of this.evses
.values()) {
373 for (const connectorStatus
of evseStatus
.connectors
.values()) {
374 if (connectorStatus
.transactionId
=== transactionId
) {
375 return connectorStatus
.transactionIdTag
;
380 for (const connectorId
of this.connectors
.keys()) {
383 this.getConnectorStatus(connectorId
)?.transactionId
=== transactionId
385 return this.getConnectorStatus(connectorId
)?.transactionIdTag
;
391 public getNumberOfRunningTransactions(): number {
394 for (const evseStatus
of this.evses
.values()) {
395 for (const connectorStatus
of evseStatus
.connectors
.values()) {
396 if (connectorStatus
.transactionStarted
=== true) {
402 for (const connectorId
of this.connectors
.keys()) {
403 if (connectorId
> 0 && this.getConnectorStatus(connectorId
)?.transactionStarted
=== true) {
411 public getOutOfOrderEndMeterValues(): boolean {
412 return this.stationInfo
?.outOfOrderEndMeterValues
?? false;
415 public getBeginEndMeterValues(): boolean {
416 return this.stationInfo
?.beginEndMeterValues
?? false;
419 public getMeteringPerTransaction(): boolean {
420 return this.stationInfo
?.meteringPerTransaction
?? true;
423 public getTransactionDataMeterValues(): boolean {
424 return this.stationInfo
?.transactionDataMeterValues
?? false;
427 public getMainVoltageMeterValues(): boolean {
428 return this.stationInfo
?.mainVoltageMeterValues
?? true;
431 public getPhaseLineToLineVoltageMeterValues(): boolean {
432 return this.stationInfo
?.phaseLineToLineVoltageMeterValues
?? false;
435 public getCustomValueLimitationMeterValues(): boolean {
436 return this.stationInfo
?.customValueLimitationMeterValues
?? true;
439 public getConnectorIdByTransactionId(transactionId
: number): number | undefined {
441 for (const evseStatus
of this.evses
.values()) {
442 for (const [connectorId
, connectorStatus
] of evseStatus
.connectors
) {
443 if (connectorStatus
.transactionId
=== transactionId
) {
449 for (const connectorId
of this.connectors
.keys()) {
452 this.getConnectorStatus(connectorId
)?.transactionId
=== transactionId
460 public getEnergyActiveImportRegisterByTransactionId(
461 transactionId
: number,
464 return this.getEnergyActiveImportRegister(
465 this.getConnectorStatus(this.getConnectorIdByTransactionId(transactionId
)),
470 public getEnergyActiveImportRegisterByConnectorId(connectorId
: number, rounded
= false): number {
471 return this.getEnergyActiveImportRegister(this.getConnectorStatus(connectorId
), rounded
);
474 public getAuthorizeRemoteTxRequests(): boolean {
475 const authorizeRemoteTxRequests
= ChargingStationConfigurationUtils
.getConfigurationKey(
477 StandardParametersKey
.AuthorizeRemoteTxRequests
479 return authorizeRemoteTxRequests
480 ? Utils
.convertToBoolean(authorizeRemoteTxRequests
.value
)
484 public getLocalAuthListEnabled(): boolean {
485 const localAuthListEnabled
= ChargingStationConfigurationUtils
.getConfigurationKey(
487 StandardParametersKey
.LocalAuthListEnabled
489 return localAuthListEnabled
? Utils
.convertToBoolean(localAuthListEnabled
.value
) : false;
492 public getHeartbeatInterval(): number {
493 const HeartbeatInterval
= ChargingStationConfigurationUtils
.getConfigurationKey(
495 StandardParametersKey
.HeartbeatInterval
497 if (HeartbeatInterval
) {
498 return Utils
.convertToInt(HeartbeatInterval
.value
) * 1000;
500 const HeartBeatInterval
= ChargingStationConfigurationUtils
.getConfigurationKey(
502 StandardParametersKey
.HeartBeatInterval
504 if (HeartBeatInterval
) {
505 return Utils
.convertToInt(HeartBeatInterval
.value
) * 1000;
507 this.stationInfo
?.autoRegister
=== false &&
509 `${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${
510 Constants.DEFAULT_HEARTBEAT_INTERVAL
513 return Constants
.DEFAULT_HEARTBEAT_INTERVAL
;
516 public setSupervisionUrl(url
: string): void {
518 this.getSupervisionUrlOcppConfiguration() &&
519 Utils
.isNotEmptyString(this.getSupervisionUrlOcppKey())
521 ChargingStationConfigurationUtils
.setConfigurationKeyValue(
523 this.getSupervisionUrlOcppKey(),
527 this.stationInfo
.supervisionUrls
= url
;
528 this.saveStationInfo();
529 this.configuredSupervisionUrl
= this.getConfiguredSupervisionUrl();
533 public startHeartbeat(): void {
534 if (this.getHeartbeatInterval() > 0 && !this.heartbeatSetInterval
) {
535 this.heartbeatSetInterval
= setInterval(() => {
536 this.ocppRequestService
537 .requestHandler
<HeartbeatRequest
, HeartbeatResponse
>(this, RequestCommand
.HEARTBEAT
)
540 `${this.logPrefix()} Error while sending '${RequestCommand.HEARTBEAT}':`,
544 }, this.getHeartbeatInterval());
546 `${this.logPrefix()} Heartbeat started every ${Utils.formatDurationMilliSeconds(
547 this.getHeartbeatInterval()
550 } else if (this.heartbeatSetInterval
) {
552 `${this.logPrefix()} Heartbeat already started every ${Utils.formatDurationMilliSeconds(
553 this.getHeartbeatInterval()
558 `${this.logPrefix()} Heartbeat interval set to ${this.getHeartbeatInterval()},
559 not starting the heartbeat`
564 public restartHeartbeat(): void {
566 this.stopHeartbeat();
568 this.startHeartbeat();
571 public restartWebSocketPing(): void {
572 // Stop WebSocket ping
573 this.stopWebSocketPing();
574 // Start WebSocket ping
575 this.startWebSocketPing();
578 public startMeterValues(connectorId
: number, interval
: number): void {
579 if (connectorId
=== 0) {
581 `${this.logPrefix()} Trying to start MeterValues on connector id ${connectorId.toString()}`
585 if (!this.getConnectorStatus(connectorId
)) {
587 `${this.logPrefix()} Trying to start MeterValues on non existing connector id
588 ${connectorId.toString()}`
592 if (this.getConnectorStatus(connectorId
)?.transactionStarted
=== false) {
594 `${this.logPrefix()} Trying to start MeterValues on connector id ${connectorId}
595 with no transaction started`
599 this.getConnectorStatus(connectorId
)?.transactionStarted
=== true &&
600 Utils
.isNullOrUndefined(this.getConnectorStatus(connectorId
)?.transactionId
)
603 `${this.logPrefix()} Trying to start MeterValues on connector id ${connectorId}
604 with no transaction id`
609 this.getConnectorStatus(connectorId
).transactionSetInterval
= setInterval(() => {
610 // FIXME: Implement OCPP version agnostic helpers
611 const meterValue
: MeterValue
= OCPP16ServiceUtils
.buildMeterValue(
614 this.getConnectorStatus(connectorId
).transactionId
,
617 this.ocppRequestService
618 .requestHandler
<MeterValuesRequest
, MeterValuesResponse
>(
620 RequestCommand
.METER_VALUES
,
623 transactionId
: this.getConnectorStatus(connectorId
)?.transactionId
,
624 meterValue
: [meterValue
],
629 `${this.logPrefix()} Error while sending '${RequestCommand.METER_VALUES}':`,
636 `${this.logPrefix()} Charging station ${
637 StandardParametersKey.MeterValueSampleInterval
638 } configuration set to ${interval}, not sending MeterValues`
643 public stopMeterValues(connectorId
: number) {
644 if (this.getConnectorStatus(connectorId
)?.transactionSetInterval
) {
645 clearInterval(this.getConnectorStatus(connectorId
)?.transactionSetInterval
);
649 public start(): void {
650 if (this.started
=== false) {
651 if (this.starting
=== false) {
652 this.starting
= true;
653 if (this.getEnableStatistics() === true) {
654 this.performanceStatistics
?.start();
656 if (this.hasFeatureProfile(SupportedFeatureProfiles
.Reservation
)) {
657 this.startReservationExpirationSetInterval();
659 this.openWSConnection();
660 // Monitor charging station template file
661 this.templateFileWatcher
= watchJsonFile(
663 FileType
.ChargingStationTemplate
,
666 (event
, filename
): void => {
667 if (Utils
.isNotEmptyString(filename
) && event
=== 'change') {
670 `${this.logPrefix()} ${FileType.ChargingStationTemplate} ${
672 } file have changed, reload`
674 this.sharedLRUCache
.deleteChargingStationTemplate(this.templateFileHash
);
678 this.stopAutomaticTransactionGenerator();
679 if (this.getAutomaticTransactionGeneratorConfiguration()?.enable
=== true) {
680 this.startAutomaticTransactionGenerator();
682 if (this.getEnableStatistics() === true) {
683 this.performanceStatistics
?.restart();
685 this.performanceStatistics
?.stop();
687 // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed
690 `${this.logPrefix()} ${FileType.ChargingStationTemplate} file monitoring error:`,
698 parentPort
?.postMessage(buildStartedMessage(this));
699 this.starting
= false;
701 logger
.warn(`${this.logPrefix()} Charging station is already starting...`);
704 logger
.warn(`${this.logPrefix()} Charging station is already started...`);
708 public async stop(reason
?: StopTransactionReason
): Promise
<void> {
709 if (this.started
=== true) {
710 if (this.stopping
=== false) {
711 this.stopping
= true;
712 await this.stopMessageSequence(reason
);
713 this.closeWSConnection();
714 if (this.getEnableStatistics() === true) {
715 this.performanceStatistics
?.stop();
717 this.sharedLRUCache
.deleteChargingStationConfiguration(this.configurationFileHash
);
718 this.templateFileWatcher
?.close();
719 this.sharedLRUCache
.deleteChargingStationTemplate(this.templateFileHash
);
720 delete this.bootNotificationResponse
;
721 this.started
= false;
722 this.saveConfiguration();
723 parentPort
?.postMessage(buildStoppedMessage(this));
724 this.stopping
= false;
726 logger
.warn(`${this.logPrefix()} Charging station is already stopping...`);
729 logger
.warn(`${this.logPrefix()} Charging station is already stopped...`);
733 public async reset(reason
?: StopTransactionReason
): Promise
<void> {
734 await this.stop(reason
);
735 await Utils
.sleep(this.stationInfo
.resetTime
);
740 public saveOcppConfiguration(): void {
741 if (this.getOcppPersistentConfiguration()) {
742 this.saveConfiguration();
746 public hasFeatureProfile(featureProfile
: SupportedFeatureProfiles
): boolean | undefined {
747 return ChargingStationConfigurationUtils
.getConfigurationKey(
749 StandardParametersKey
.SupportedFeatureProfiles
750 )?.value
?.includes(featureProfile
);
753 public bufferMessage(message
: string): void {
754 this.messageBuffer
.add(message
);
757 public openWSConnection(
758 options
: WsOptions
= this.stationInfo
?.wsOptions
?? {},
759 params
: { closeOpened
?: boolean; terminateOpened
?: boolean } = {
761 terminateOpened
: false,
764 options
= { handshakeTimeout
: this.getConnectionTimeout() * 1000, ...options
};
765 params
= { ...{ closeOpened
: false, terminateOpened
: false }, ...params
};
766 if (this.started
=== false && this.starting
=== false) {
768 `${this.logPrefix()} Cannot open OCPP connection to URL ${this.wsConnectionUrl.toString()}
769 on stopped charging station`
774 !Utils
.isNullOrUndefined(this.stationInfo
.supervisionUser
) &&
775 !Utils
.isNullOrUndefined(this.stationInfo
.supervisionPassword
)
777 options
.auth
= `${this.stationInfo.supervisionUser}:${this.stationInfo.supervisionPassword}`;
779 if (params
?.closeOpened
) {
780 this.closeWSConnection();
782 if (params
?.terminateOpened
) {
783 this.terminateWSConnection();
786 if (this.isWebSocketConnectionOpened() === true) {
788 `${this.logPrefix()} OCPP connection to URL ${this.wsConnectionUrl.toString()}
795 `${this.logPrefix()} Open OCPP connection to URL ${this.wsConnectionUrl.toString()}`
798 this.wsConnection
= new WebSocket(
799 this.wsConnectionUrl
,
800 `ocpp${this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16}`,
804 // Handle WebSocket message
805 this.wsConnection
.on(
807 this.onMessage
.bind(this) as (this: WebSocket
, data
: RawData
, isBinary
: boolean) => void
809 // Handle WebSocket error
810 this.wsConnection
.on(
812 this.onError
.bind(this) as (this: WebSocket
, error
: Error) => void
814 // Handle WebSocket close
815 this.wsConnection
.on(
817 this.onClose
.bind(this) as (this: WebSocket
, code
: number, reason
: Buffer
) => void
819 // Handle WebSocket open
820 this.wsConnection
.on('open', this.onOpen
.bind(this) as (this: WebSocket
) => void);
821 // Handle WebSocket ping
822 this.wsConnection
.on('ping', this.onPing
.bind(this) as (this: WebSocket
, data
: Buffer
) => void);
823 // Handle WebSocket pong
824 this.wsConnection
.on('pong', this.onPong
.bind(this) as (this: WebSocket
, data
: Buffer
) => void);
827 public closeWSConnection(): void {
828 if (this.isWebSocketConnectionOpened() === true) {
829 this.wsConnection
?.close();
830 this.wsConnection
= null;
834 public getAutomaticTransactionGeneratorConfiguration():
835 | AutomaticTransactionGeneratorConfiguration
837 let automaticTransactionGeneratorConfiguration
:
838 | AutomaticTransactionGeneratorConfiguration
840 const automaticTransactionGeneratorConfigurationFromFile
=
841 this.getConfigurationFromFile()?.automaticTransactionGenerator
;
843 this.getAutomaticTransactionGeneratorPersistentConfiguration() &&
844 automaticTransactionGeneratorConfigurationFromFile
846 automaticTransactionGeneratorConfiguration
=
847 automaticTransactionGeneratorConfigurationFromFile
;
849 automaticTransactionGeneratorConfiguration
=
850 this.getTemplateFromFile()?.AutomaticTransactionGenerator
;
853 ...Constants
.DEFAULT_ATG_CONFIGURATION
,
854 ...automaticTransactionGeneratorConfiguration
,
858 public getAutomaticTransactionGeneratorStatuses(): Status
[] | undefined {
859 return this.getConfigurationFromFile()?.automaticTransactionGeneratorStatuses
;
862 public startAutomaticTransactionGenerator(connectorIds
?: number[]): void {
863 this.automaticTransactionGenerator
= AutomaticTransactionGenerator
.getInstance(this);
864 if (Utils
.isNotEmptyArray(connectorIds
)) {
865 for (const connectorId
of connectorIds
) {
866 this.automaticTransactionGenerator
?.startConnector(connectorId
);
869 this.automaticTransactionGenerator
?.start();
871 this.saveAutomaticTransactionGeneratorConfiguration();
872 parentPort
?.postMessage(buildUpdatedMessage(this));
875 public stopAutomaticTransactionGenerator(connectorIds
?: number[]): void {
876 if (Utils
.isNotEmptyArray(connectorIds
)) {
877 for (const connectorId
of connectorIds
) {
878 this.automaticTransactionGenerator
?.stopConnector(connectorId
);
881 this.automaticTransactionGenerator
?.stop();
883 this.saveAutomaticTransactionGeneratorConfiguration();
884 parentPort
?.postMessage(buildUpdatedMessage(this));
887 public async stopTransactionOnConnector(
889 reason
= StopTransactionReason
.NONE
890 ): Promise
<StopTransactionResponse
> {
891 const transactionId
= this.getConnectorStatus(connectorId
)?.transactionId
;
893 this.getBeginEndMeterValues() === true &&
894 this.getOcppStrictCompliance() === true &&
895 this.getOutOfOrderEndMeterValues() === false
897 // FIXME: Implement OCPP version agnostic helpers
898 const transactionEndMeterValue
= OCPP16ServiceUtils
.buildTransactionEndMeterValue(
901 this.getEnergyActiveImportRegisterByTransactionId(transactionId
)
903 await this.ocppRequestService
.requestHandler
<MeterValuesRequest
, MeterValuesResponse
>(
905 RequestCommand
.METER_VALUES
,
909 meterValue
: [transactionEndMeterValue
],
913 return this.ocppRequestService
.requestHandler
<StopTransactionRequest
, StopTransactionResponse
>(
915 RequestCommand
.STOP_TRANSACTION
,
918 meterStop
: this.getEnergyActiveImportRegisterByTransactionId(transactionId
, true),
924 public getReservationOnConnectorId0Enabled(): boolean {
925 return Utils
.convertToBoolean(
926 ChargingStationConfigurationUtils
.getConfigurationKey(
928 StandardParametersKey
.ReserveConnectorZeroSupported
933 public async addReservation(reservation
: Reservation
): Promise
<void> {
934 const [exists
, reservationFound
] = this.doesReservationExists(reservation
);
936 await this.removeReservation(reservationFound
, ReservationTerminationReason
.REPLACE_EXISTING
);
938 this.getConnectorStatus(reservation
.connectorId
).reservation
= reservation
;
939 await OCPPServiceUtils
.sendAndSetConnectorStatus(
941 reservation
.connectorId
,
942 ConnectorStatusEnum
.Reserved
,
944 { send
: reservation
.connectorId
!== 0 }
948 public async removeReservation(
949 reservation
: Reservation
,
950 reason
?: ReservationTerminationReason
952 const connector
= this.getConnectorStatus(reservation
.connectorId
);
954 case ReservationTerminationReason
.CONNECTOR_STATE_CHANGED
:
955 delete connector
.reservation
;
957 case ReservationTerminationReason
.TRANSACTION_STARTED
:
958 delete connector
.reservation
;
960 case ReservationTerminationReason
.RESERVATION_CANCELED
||
961 ReservationTerminationReason
.REPLACE_EXISTING
||
962 ReservationTerminationReason
.EXPIRED
:
963 await OCPPServiceUtils
.sendAndSetConnectorStatus(
965 reservation
.connectorId
,
966 ConnectorStatusEnum
.Available
,
968 { send
: reservation
.connectorId
!== 0 }
970 delete connector
.reservation
;
977 public getReservationBy(filterKey
: ReservationFilterKey
, value
: number | string): Reservation
{
979 for (const evse
of this.evses
.values()) {
980 for (const connector
of evse
.connectors
.values()) {
981 if (connector
?.reservation
?.[filterKey
] === value
) {
982 return connector
.reservation
;
987 for (const connector
of this.connectors
.values()) {
988 if (connector
?.reservation
?.[filterKey
] === value
) {
989 return connector
.reservation
;
995 public doesReservationExists(reservation
: Partial
<Reservation
>): [boolean, Reservation
] {
996 const foundReservation
= this.getReservationBy(
997 ReservationFilterKey
.RESERVATION_ID
,
1000 return Utils
.isUndefined(foundReservation
) ? [false, null] : [true, foundReservation
];
1003 public startReservationExpirationSetInterval(customInterval
?: number): void {
1005 customInterval
?? Constants
.DEFAULT_RESERVATION_EXPIRATION_OBSERVATION_INTERVAL
;
1007 `${this.logPrefix()} Reservation expiration date interval is set to ${interval}
1008 and starts on charging station now`
1010 // eslint-disable-next-line @typescript-eslint/no-misused-promises
1011 this.reservationExpirationSetInterval
= setInterval(async (): Promise
<void> => {
1012 if (this.hasEvses
) {
1013 for (const evse
of this.evses
.values()) {
1014 for (const connector
of evse
.connectors
.values()) {
1015 if (connector
?.reservation
?.expiryDate
.toString() < new Date().toISOString()) {
1016 await this.removeReservation(
1017 connector
.reservation
,
1018 ReservationTerminationReason
.EXPIRED
1024 for (const connector
of this.connectors
.values()) {
1025 if (connector
?.reservation
?.expiryDate
.toString() < new Date().toISOString()) {
1026 await this.removeReservation(
1027 connector
.reservation
,
1028 ReservationTerminationReason
.EXPIRED
1036 public restartReservationExpiryDateSetInterval(): void {
1037 this.stopReservationExpirationSetInterval();
1038 this.startReservationExpirationSetInterval();
1041 public validateIncomingRequestWithReservation(connectorId
: number, idTag
: string): boolean {
1042 const reservation
= this.getReservationBy(ReservationFilterKey
.CONNECTOR_ID
, connectorId
);
1043 return !Utils
.isUndefined(reservation
) && reservation
.idTag
=== idTag
;
1046 public isConnectorReservable(
1047 reservationId
: number,
1049 connectorId
?: number
1051 const [alreadyExists
] = this.doesReservationExists({ id
: reservationId
});
1052 if (alreadyExists
) {
1053 return alreadyExists
;
1055 const userReservedAlready
= Utils
.isUndefined(
1056 this.getReservationBy(ReservationFilterKey
.ID_TAG
, idTag
)
1060 const notConnectorZero
= Utils
.isUndefined(connectorId
) ? true : connectorId
> 0;
1061 const freeConnectorsAvailable
= this.getNumberOfReservableConnectors() > 0;
1062 return !alreadyExists
&& !userReservedAlready
&& notConnectorZero
&& freeConnectorsAvailable
;
1065 private getNumberOfReservableConnectors(): number {
1066 let reservableConnectors
= 0;
1067 if (this.hasEvses
) {
1068 for (const evse
of this.evses
.values()) {
1069 reservableConnectors
= this.countReservableConnectors(evse
.connectors
);
1072 reservableConnectors
= this.countReservableConnectors(this.connectors
);
1074 return reservableConnectors
- this.getNumberOfReservationsOnConnectorZero();
1077 private countReservableConnectors(connectors
: Map
<number, ConnectorStatus
>) {
1078 let reservableConnectors
= 0;
1079 for (const [connectorId
, connector
] of connectors
) {
1080 if (connectorId
=== 0) {
1083 if (connector
.status === ConnectorStatusEnum
.Available
) {
1084 ++reservableConnectors
;
1087 return reservableConnectors
;
1090 private getNumberOfReservationsOnConnectorZero(): number {
1091 let numberOfReservations
= 0;
1092 if (this.hasEvses
) {
1093 for (const evse
of this.evses
.values()) {
1094 if (evse
.connectors
.get(0)?.reservation
) {
1095 ++numberOfReservations
;
1098 } else if (this.connectors
.get(0)?.reservation
) {
1099 ++numberOfReservations
;
1101 return numberOfReservations
;
1104 private flushMessageBuffer(): void {
1105 if (this.messageBuffer
.size
> 0) {
1106 for (const message
of this.messageBuffer
.values()) {
1107 let beginId
: string;
1108 let commandName
: RequestCommand
;
1109 const [messageType
] = JSON
.parse(message
) as OutgoingRequest
| Response
| ErrorResponse
;
1110 const isRequest
= messageType
=== MessageType
.CALL_MESSAGE
;
1112 [, , commandName
] = JSON
.parse(message
) as OutgoingRequest
;
1113 beginId
= PerformanceStatistics
.beginMeasure(commandName
);
1115 this.wsConnection
?.send(message
);
1116 isRequest
&& PerformanceStatistics
.endMeasure(commandName
, beginId
);
1118 `${this.logPrefix()} >> Buffered ${OCPPServiceUtils.getMessageTypeString(
1120 )} payload sent: ${message}`
1122 this.messageBuffer
.delete(message
);
1127 private getSupervisionUrlOcppConfiguration(): boolean {
1128 return this.stationInfo
.supervisionUrlOcppConfiguration
?? false;
1131 private stopReservationExpirationSetInterval(): void {
1132 if (this.reservationExpirationSetInterval
) {
1133 clearInterval(this.reservationExpirationSetInterval
);
1137 private getSupervisionUrlOcppKey(): string {
1138 return this.stationInfo
.supervisionUrlOcppKey
?? VendorParametersKey
.ConnectionUrl
;
1141 private getTemplateFromFile(): ChargingStationTemplate
| undefined {
1142 let template
: ChargingStationTemplate
;
1144 if (this.sharedLRUCache
.hasChargingStationTemplate(this.templateFileHash
)) {
1145 template
= this.sharedLRUCache
.getChargingStationTemplate(this.templateFileHash
);
1147 const measureId
= `${FileType.ChargingStationTemplate} read`;
1148 const beginId
= PerformanceStatistics
.beginMeasure(measureId
);
1149 template
= JSON
.parse(
1150 fs
.readFileSync(this.templateFile
, 'utf8')
1151 ) as ChargingStationTemplate
;
1152 PerformanceStatistics
.endMeasure(measureId
, beginId
);
1153 template
.templateHash
= crypto
1154 .createHash(Constants
.DEFAULT_HASH_ALGORITHM
)
1155 .update(JSON
.stringify(template
))
1157 this.sharedLRUCache
.setChargingStationTemplate(template
);
1158 this.templateFileHash
= template
.templateHash
;
1161 handleFileException(
1163 FileType
.ChargingStationTemplate
,
1164 error
as NodeJS
.ErrnoException
,
1171 private getStationInfoFromTemplate(): ChargingStationInfo
{
1172 const stationTemplate
: ChargingStationTemplate
| undefined = this.getTemplateFromFile();
1173 ChargingStationUtils
.checkTemplate(stationTemplate
, this.logPrefix(), this.templateFile
);
1174 ChargingStationUtils
.warnTemplateKeysDeprecation(
1179 if (stationTemplate
?.Connectors
) {
1180 ChargingStationUtils
.checkConnectorsConfiguration(
1186 const stationInfo
: ChargingStationInfo
=
1187 ChargingStationUtils
.stationTemplateToStationInfo(stationTemplate
);
1188 stationInfo
.hashId
= ChargingStationUtils
.getHashId(this.index
, stationTemplate
);
1189 stationInfo
.chargingStationId
= ChargingStationUtils
.getChargingStationId(
1193 stationInfo
.ocppVersion
= stationTemplate
?.ocppVersion
?? OCPPVersion
.VERSION_16
;
1194 ChargingStationUtils
.createSerialNumber(stationTemplate
, stationInfo
);
1195 if (Utils
.isNotEmptyArray(stationTemplate
?.power
)) {
1196 stationTemplate
.power
= stationTemplate
.power
as number[];
1197 const powerArrayRandomIndex
= Math.floor(Utils
.secureRandom() * stationTemplate
.power
.length
);
1198 stationInfo
.maximumPower
=
1199 stationTemplate
?.powerUnit
=== PowerUnits
.KILO_WATT
1200 ? stationTemplate
.power
[powerArrayRandomIndex
] * 1000
1201 : stationTemplate
.power
[powerArrayRandomIndex
];
1203 stationTemplate
.power
= stationTemplate
?.power
as number;
1204 stationInfo
.maximumPower
=
1205 stationTemplate
?.powerUnit
=== PowerUnits
.KILO_WATT
1206 ? stationTemplate
.power
* 1000
1207 : stationTemplate
.power
;
1209 stationInfo
.firmwareVersionPattern
=
1210 stationTemplate
?.firmwareVersionPattern
?? Constants
.SEMVER_PATTERN
;
1212 Utils
.isNotEmptyString(stationInfo
.firmwareVersion
) &&
1213 new RegExp(stationInfo
.firmwareVersionPattern
).test(stationInfo
.firmwareVersion
) === false
1216 `${this.logPrefix()} Firmware version '${stationInfo.firmwareVersion}' in template file ${
1218 } does not match firmware version pattern '${stationInfo.firmwareVersionPattern}'`
1221 stationInfo
.firmwareUpgrade
= merge
<FirmwareUpgrade
>(
1228 stationTemplate
?.firmwareUpgrade
?? {}
1230 stationInfo
.resetTime
= !Utils
.isNullOrUndefined(stationTemplate
?.resetTime
)
1231 ? stationTemplate
.resetTime
* 1000
1232 : Constants
.CHARGING_STATION_DEFAULT_RESET_TIME
;
1233 stationInfo
.maximumAmperage
= this.getMaximumAmperage(stationInfo
);
1237 private getStationInfoFromFile(): ChargingStationInfo
| undefined {
1238 let stationInfo
: ChargingStationInfo
| undefined;
1239 if (this.getStationInfoPersistentConfiguration()) {
1240 stationInfo
= this.getConfigurationFromFile()?.stationInfo
;
1242 delete stationInfo
?.infoHash
;
1248 private getStationInfo(): ChargingStationInfo
{
1249 const stationInfoFromTemplate
: ChargingStationInfo
= this.getStationInfoFromTemplate();
1250 const stationInfoFromFile
: ChargingStationInfo
| undefined = this.getStationInfoFromFile();
1252 // 1. charging station info from template
1253 // 2. charging station info from configuration file
1254 if (stationInfoFromFile
?.templateHash
=== stationInfoFromTemplate
.templateHash
) {
1255 return stationInfoFromFile
;
1257 stationInfoFromFile
&&
1258 ChargingStationUtils
.propagateSerialNumber(
1259 this.getTemplateFromFile(),
1260 stationInfoFromFile
,
1261 stationInfoFromTemplate
1263 return stationInfoFromTemplate
;
1266 private saveStationInfo(): void {
1267 if (this.getStationInfoPersistentConfiguration()) {
1268 this.saveConfiguration();
1272 private getOcppPersistentConfiguration(): boolean {
1273 return this.stationInfo
?.ocppPersistentConfiguration
?? true;
1276 private getStationInfoPersistentConfiguration(): boolean {
1277 return this.stationInfo
?.stationInfoPersistentConfiguration
?? true;
1280 private getAutomaticTransactionGeneratorPersistentConfiguration(): boolean {
1281 return this.stationInfo
?.automaticTransactionGeneratorPersistentConfiguration
?? true;
1284 private handleUnsupportedVersion(version
: OCPPVersion
) {
1285 const errorMsg
= `Unsupported protocol version '${version}' configured
1286 in template file ${this.templateFile}`;
1287 logger
.error(`${this.logPrefix()} ${errorMsg}`);
1288 throw new BaseError(errorMsg
);
1291 private initialize(): void {
1292 const stationTemplate
= this.getTemplateFromFile();
1293 ChargingStationUtils
.checkTemplate(stationTemplate
, this.logPrefix(), this.templateFile
);
1294 this.configurationFile
= path
.join(
1295 path
.dirname(this.templateFile
.replace('station-templates', 'configurations')),
1296 `${ChargingStationUtils.getHashId(this.index, stationTemplate)}.json`
1298 const chargingStationConfiguration
= this.getConfigurationFromFile();
1300 chargingStationConfiguration
?.stationInfo
?.templateHash
=== stationTemplate
?.templateHash
&&
1301 (chargingStationConfiguration
?.connectorsStatus
|| chargingStationConfiguration
?.evsesStatus
)
1303 this.initializeConnectorsOrEvsesFromFile(chargingStationConfiguration
);
1305 this.initializeConnectorsOrEvsesFromTemplate(stationTemplate
);
1307 this.stationInfo
= this.getStationInfo();
1309 this.stationInfo
.firmwareStatus
=== FirmwareStatus
.Installing
&&
1310 Utils
.isNotEmptyString(this.stationInfo
.firmwareVersion
) &&
1311 Utils
.isNotEmptyString(this.stationInfo
.firmwareVersionPattern
)
1313 const patternGroup
: number | undefined =
1314 this.stationInfo
.firmwareUpgrade
?.versionUpgrade
?.patternGroup
??
1315 this.stationInfo
.firmwareVersion
?.split('.').length
;
1316 const match
= this.stationInfo
?.firmwareVersion
1317 ?.match(new RegExp(this.stationInfo
.firmwareVersionPattern
))
1318 ?.slice(1, patternGroup
+ 1);
1319 const patchLevelIndex
= match
.length
- 1;
1320 match
[patchLevelIndex
] = (
1321 Utils
.convertToInt(match
[patchLevelIndex
]) +
1322 this.stationInfo
.firmwareUpgrade
?.versionUpgrade
?.step
1324 this.stationInfo
.firmwareVersion
= match
?.join('.');
1326 this.saveStationInfo();
1327 this.configuredSupervisionUrl
= this.getConfiguredSupervisionUrl();
1328 if (this.getEnableStatistics() === true) {
1329 this.performanceStatistics
= PerformanceStatistics
.getInstance(
1330 this.stationInfo
.hashId
,
1331 this.stationInfo
.chargingStationId
,
1332 this.configuredSupervisionUrl
1335 this.bootNotificationRequest
= ChargingStationUtils
.createBootNotificationRequest(
1338 this.powerDivider
= this.getPowerDivider();
1339 // OCPP configuration
1340 this.ocppConfiguration
= this.getOcppConfiguration();
1341 this.initializeOcppConfiguration();
1342 this.initializeOcppServices();
1343 if (this.stationInfo
?.autoRegister
=== true) {
1344 this.bootNotificationResponse
= {
1345 currentTime
: new Date(),
1346 interval
: this.getHeartbeatInterval() / 1000,
1347 status: RegistrationStatusEnumType
.ACCEPTED
,
1352 private initializeOcppServices(): void {
1353 const ocppVersion
= this.stationInfo
.ocppVersion
?? OCPPVersion
.VERSION_16
;
1354 switch (ocppVersion
) {
1355 case OCPPVersion
.VERSION_16
:
1356 this.ocppIncomingRequestService
=
1357 OCPP16IncomingRequestService
.getInstance
<OCPP16IncomingRequestService
>();
1358 this.ocppRequestService
= OCPP16RequestService
.getInstance
<OCPP16RequestService
>(
1359 OCPP16ResponseService
.getInstance
<OCPP16ResponseService
>()
1362 case OCPPVersion
.VERSION_20
:
1363 case OCPPVersion
.VERSION_201
:
1364 this.ocppIncomingRequestService
=
1365 OCPP20IncomingRequestService
.getInstance
<OCPP20IncomingRequestService
>();
1366 this.ocppRequestService
= OCPP20RequestService
.getInstance
<OCPP20RequestService
>(
1367 OCPP20ResponseService
.getInstance
<OCPP20ResponseService
>()
1371 this.handleUnsupportedVersion(ocppVersion
);
1376 private initializeOcppConfiguration(): void {
1378 !ChargingStationConfigurationUtils
.getConfigurationKey(
1380 StandardParametersKey
.HeartbeatInterval
1383 ChargingStationConfigurationUtils
.addConfigurationKey(
1385 StandardParametersKey
.HeartbeatInterval
,
1390 !ChargingStationConfigurationUtils
.getConfigurationKey(
1392 StandardParametersKey
.HeartBeatInterval
1395 ChargingStationConfigurationUtils
.addConfigurationKey(
1397 StandardParametersKey
.HeartBeatInterval
,
1403 this.getSupervisionUrlOcppConfiguration() &&
1404 Utils
.isNotEmptyString(this.getSupervisionUrlOcppKey()) &&
1405 !ChargingStationConfigurationUtils
.getConfigurationKey(this, this.getSupervisionUrlOcppKey())
1407 ChargingStationConfigurationUtils
.addConfigurationKey(
1409 this.getSupervisionUrlOcppKey(),
1410 this.configuredSupervisionUrl
.href
,
1414 !this.getSupervisionUrlOcppConfiguration() &&
1415 Utils
.isNotEmptyString(this.getSupervisionUrlOcppKey()) &&
1416 ChargingStationConfigurationUtils
.getConfigurationKey(this, this.getSupervisionUrlOcppKey())
1418 ChargingStationConfigurationUtils
.deleteConfigurationKey(
1420 this.getSupervisionUrlOcppKey(),
1425 Utils
.isNotEmptyString(this.stationInfo
?.amperageLimitationOcppKey
) &&
1426 !ChargingStationConfigurationUtils
.getConfigurationKey(
1428 this.stationInfo
.amperageLimitationOcppKey
1431 ChargingStationConfigurationUtils
.addConfigurationKey(
1433 this.stationInfo
.amperageLimitationOcppKey
,
1435 this.stationInfo
.maximumAmperage
*
1436 ChargingStationUtils
.getAmperageLimitationUnitDivider(this.stationInfo
)
1441 !ChargingStationConfigurationUtils
.getConfigurationKey(
1443 StandardParametersKey
.SupportedFeatureProfiles
1446 ChargingStationConfigurationUtils
.addConfigurationKey(
1448 StandardParametersKey
.SupportedFeatureProfiles
,
1449 `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.FirmwareManagement},${SupportedFeatureProfiles.LocalAuthListManagement},${SupportedFeatureProfiles.SmartCharging},${SupportedFeatureProfiles.RemoteTrigger}`
1452 ChargingStationConfigurationUtils
.addConfigurationKey(
1454 StandardParametersKey
.NumberOfConnectors
,
1455 this.getNumberOfConnectors().toString(),
1460 !ChargingStationConfigurationUtils
.getConfigurationKey(
1462 StandardParametersKey
.MeterValuesSampledData
1465 ChargingStationConfigurationUtils
.addConfigurationKey(
1467 StandardParametersKey
.MeterValuesSampledData
,
1468 MeterValueMeasurand
.ENERGY_ACTIVE_IMPORT_REGISTER
1472 !ChargingStationConfigurationUtils
.getConfigurationKey(
1474 StandardParametersKey
.ConnectorPhaseRotation
1477 const connectorsPhaseRotation
: string[] = [];
1478 if (this.hasEvses
) {
1479 for (const evseStatus
of this.evses
.values()) {
1480 for (const connectorId
of evseStatus
.connectors
.keys()) {
1481 connectorsPhaseRotation
.push(
1482 ChargingStationUtils
.getPhaseRotationValue(connectorId
, this.getNumberOfPhases())
1487 for (const connectorId
of this.connectors
.keys()) {
1488 connectorsPhaseRotation
.push(
1489 ChargingStationUtils
.getPhaseRotationValue(connectorId
, this.getNumberOfPhases())
1493 ChargingStationConfigurationUtils
.addConfigurationKey(
1495 StandardParametersKey
.ConnectorPhaseRotation
,
1496 connectorsPhaseRotation
.toString()
1500 !ChargingStationConfigurationUtils
.getConfigurationKey(
1502 StandardParametersKey
.AuthorizeRemoteTxRequests
1505 ChargingStationConfigurationUtils
.addConfigurationKey(
1507 StandardParametersKey
.AuthorizeRemoteTxRequests
,
1512 !ChargingStationConfigurationUtils
.getConfigurationKey(
1514 StandardParametersKey
.LocalAuthListEnabled
1516 ChargingStationConfigurationUtils
.getConfigurationKey(
1518 StandardParametersKey
.SupportedFeatureProfiles
1519 )?.value
?.includes(SupportedFeatureProfiles
.LocalAuthListManagement
)
1521 ChargingStationConfigurationUtils
.addConfigurationKey(
1523 StandardParametersKey
.LocalAuthListEnabled
,
1528 !ChargingStationConfigurationUtils
.getConfigurationKey(
1530 StandardParametersKey
.ConnectionTimeOut
1533 ChargingStationConfigurationUtils
.addConfigurationKey(
1535 StandardParametersKey
.ConnectionTimeOut
,
1536 Constants
.DEFAULT_CONNECTION_TIMEOUT
.toString()
1539 this.saveOcppConfiguration();
1542 private initializeConnectorsOrEvsesFromFile(configuration
: ChargingStationConfiguration
): void {
1543 if (configuration
?.connectorsStatus
&& !configuration
?.evsesStatus
) {
1544 for (const [connectorId
, connectorStatus
] of configuration
.connectorsStatus
.entries()) {
1545 this.connectors
.set(connectorId
, Utils
.cloneObject
<ConnectorStatus
>(connectorStatus
));
1547 } else if (configuration
?.evsesStatus
&& !configuration
?.connectorsStatus
) {
1548 for (const [evseId
, evseStatusConfiguration
] of configuration
.evsesStatus
.entries()) {
1549 const evseStatus
= Utils
.cloneObject
<EvseStatusConfiguration
>(evseStatusConfiguration
);
1550 delete evseStatus
.connectorsStatus
;
1551 this.evses
.set(evseId
, {
1552 ...(evseStatus
as EvseStatus
),
1553 connectors
: new Map
<number, ConnectorStatus
>(
1554 evseStatusConfiguration
.connectorsStatus
.map((connectorStatus
, connectorId
) => [
1561 } else if (configuration
?.evsesStatus
&& configuration
?.connectorsStatus
) {
1562 const errorMsg
= `Connectors and evses defined at the same time in configuration file ${this.configurationFile}`;
1563 logger
.error(`${this.logPrefix()} ${errorMsg}`);
1564 throw new BaseError(errorMsg
);
1566 const errorMsg
= `No connectors or evses defined in configuration file ${this.configurationFile}`;
1567 logger
.error(`${this.logPrefix()} ${errorMsg}`);
1568 throw new BaseError(errorMsg
);
1572 private initializeConnectorsOrEvsesFromTemplate(stationTemplate
: ChargingStationTemplate
) {
1573 if (stationTemplate
?.Connectors
&& !stationTemplate
?.Evses
) {
1574 this.initializeConnectorsFromTemplate(stationTemplate
);
1575 } else if (stationTemplate
?.Evses
&& !stationTemplate
?.Connectors
) {
1576 this.initializeEvsesFromTemplate(stationTemplate
);
1577 } else if (stationTemplate
?.Evses
&& stationTemplate
?.Connectors
) {
1578 const errorMsg
= `Connectors and evses defined at the same time in template file ${this.templateFile}`;
1579 logger
.error(`${this.logPrefix()} ${errorMsg}`);
1580 throw new BaseError(errorMsg
);
1582 const errorMsg
= `No connectors or evses defined in template file ${this.templateFile}`;
1583 logger
.error(`${this.logPrefix()} ${errorMsg}`);
1584 throw new BaseError(errorMsg
);
1588 private initializeConnectorsFromTemplate(stationTemplate
: ChargingStationTemplate
): void {
1589 if (!stationTemplate
?.Connectors
&& this.connectors
.size
=== 0) {
1590 const errorMsg
= `No already defined connectors and charging station information from template ${this.templateFile} with no connectors configuration defined`;
1591 logger
.error(`${this.logPrefix()} ${errorMsg}`);
1592 throw new BaseError(errorMsg
);
1594 if (!stationTemplate
?.Connectors
[0]) {
1596 `${this.logPrefix()} Charging station information from template ${
1598 } with no connector id 0 configuration`
1601 if (stationTemplate
?.Connectors
) {
1602 const { configuredMaxConnectors
, templateMaxConnectors
, templateMaxAvailableConnectors
} =
1603 ChargingStationUtils
.checkConnectorsConfiguration(
1608 const connectorsConfigHash
= crypto
1609 .createHash(Constants
.DEFAULT_HASH_ALGORITHM
)
1611 `${JSON.stringify(stationTemplate?.Connectors)}${configuredMaxConnectors.toString()}`
1614 const connectorsConfigChanged
=
1615 this.connectors
?.size
!== 0 && this.connectorsConfigurationHash
!== connectorsConfigHash
;
1616 if (this.connectors
?.size
=== 0 || connectorsConfigChanged
) {
1617 connectorsConfigChanged
&& this.connectors
.clear();
1618 this.connectorsConfigurationHash
= connectorsConfigHash
;
1619 if (templateMaxConnectors
> 0) {
1620 for (let connectorId
= 0; connectorId
<= configuredMaxConnectors
; connectorId
++) {
1622 connectorId
=== 0 &&
1623 (!stationTemplate
?.Connectors
[connectorId
] ||
1624 this.getUseConnectorId0(stationTemplate
) === false)
1628 const templateConnectorId
=
1629 connectorId
> 0 && stationTemplate
?.randomConnectors
1630 ? Utils
.getRandomInteger(templateMaxAvailableConnectors
, 1)
1632 const connectorStatus
= stationTemplate
?.Connectors
[templateConnectorId
];
1633 ChargingStationUtils
.checkStationInfoConnectorStatus(
1634 templateConnectorId
,
1639 this.connectors
.set(connectorId
, Utils
.cloneObject
<ConnectorStatus
>(connectorStatus
));
1641 ChargingStationUtils
.initializeConnectorsMapStatus(this.connectors
, this.logPrefix());
1642 this.saveConnectorsStatus();
1645 `${this.logPrefix()} Charging station information from template ${
1647 } with no connectors configuration defined, cannot create connectors`
1653 `${this.logPrefix()} Charging station information from template ${
1655 } with no connectors configuration defined, using already defined connectors`
1660 private initializeEvsesFromTemplate(stationTemplate
: ChargingStationTemplate
): void {
1661 if (!stationTemplate
?.Evses
&& this.evses
.size
=== 0) {
1662 const errorMsg
= `No already defined evses and charging station information from template ${this.templateFile} with no evses configuration defined`;
1663 logger
.error(`${this.logPrefix()} ${errorMsg}`);
1664 throw new BaseError(errorMsg
);
1666 if (!stationTemplate
?.Evses
[0]) {
1668 `${this.logPrefix()} Charging station information from template ${
1670 } with no evse id 0 configuration`
1673 if (!stationTemplate
?.Evses
[0]?.Connectors
[0]) {
1675 `${this.logPrefix()} Charging station information from template ${
1677 } with evse id 0 with no connector id 0 configuration`
1680 if (stationTemplate
?.Evses
) {
1681 const evsesConfigHash
= crypto
1682 .createHash(Constants
.DEFAULT_HASH_ALGORITHM
)
1683 .update(JSON
.stringify(stationTemplate
?.Evses
))
1685 const evsesConfigChanged
=
1686 this.evses
?.size
!== 0 && this.evsesConfigurationHash
!== evsesConfigHash
;
1687 if (this.evses
?.size
=== 0 || evsesConfigChanged
) {
1688 evsesConfigChanged
&& this.evses
.clear();
1689 this.evsesConfigurationHash
= evsesConfigHash
;
1690 const templateMaxEvses
= ChargingStationUtils
.getMaxNumberOfEvses(stationTemplate
?.Evses
);
1691 if (templateMaxEvses
> 0) {
1692 for (const evse
in stationTemplate
.Evses
) {
1693 const evseId
= Utils
.convertToInt(evse
);
1694 this.evses
.set(evseId
, {
1695 connectors
: ChargingStationUtils
.buildConnectorsMap(
1696 stationTemplate
?.Evses
[evse
]?.Connectors
,
1700 availability
: AvailabilityType
.Operative
,
1702 ChargingStationUtils
.initializeConnectorsMapStatus(
1703 this.evses
.get(evseId
)?.connectors
,
1707 this.saveEvsesStatus();
1710 `${this.logPrefix()} Charging station information from template ${
1712 } with no evses configuration defined, cannot create evses`
1718 `${this.logPrefix()} Charging station information from template ${
1720 } with no evses configuration defined, using already defined evses`
1725 private getConfigurationFromFile(): ChargingStationConfiguration
| undefined {
1726 let configuration
: ChargingStationConfiguration
| undefined;
1727 if (Utils
.isNotEmptyString(this.configurationFile
) && fs
.existsSync(this.configurationFile
)) {
1729 if (this.sharedLRUCache
.hasChargingStationConfiguration(this.configurationFileHash
)) {
1730 configuration
= this.sharedLRUCache
.getChargingStationConfiguration(
1731 this.configurationFileHash
1734 const measureId
= `${FileType.ChargingStationConfiguration} read`;
1735 const beginId
= PerformanceStatistics
.beginMeasure(measureId
);
1736 configuration
= JSON
.parse(
1737 fs
.readFileSync(this.configurationFile
, 'utf8')
1738 ) as ChargingStationConfiguration
;
1739 PerformanceStatistics
.endMeasure(measureId
, beginId
);
1740 this.sharedLRUCache
.setChargingStationConfiguration(configuration
);
1741 this.configurationFileHash
= configuration
.configurationHash
;
1744 handleFileException(
1745 this.configurationFile
,
1746 FileType
.ChargingStationConfiguration
,
1747 error
as NodeJS
.ErrnoException
,
1752 return configuration
;
1755 private saveAutomaticTransactionGeneratorConfiguration(): void {
1756 if (this.getAutomaticTransactionGeneratorPersistentConfiguration()) {
1757 this.saveConfiguration();
1761 private saveConnectorsStatus() {
1762 this.saveConfiguration();
1765 private saveEvsesStatus() {
1766 this.saveConfiguration();
1769 private saveConfiguration(): void {
1770 if (Utils
.isNotEmptyString(this.configurationFile
)) {
1772 if (!fs
.existsSync(path
.dirname(this.configurationFile
))) {
1773 fs
.mkdirSync(path
.dirname(this.configurationFile
), { recursive
: true });
1775 let configurationData
: ChargingStationConfiguration
=
1776 Utils
.cloneObject
<ChargingStationConfiguration
>(this.getConfigurationFromFile()) ?? {};
1777 if (this.getStationInfoPersistentConfiguration() && this.stationInfo
) {
1778 configurationData
.stationInfo
= this.stationInfo
;
1780 delete configurationData
.stationInfo
;
1782 if (this.getOcppPersistentConfiguration() && this.ocppConfiguration
?.configurationKey
) {
1783 configurationData
.configurationKey
= this.ocppConfiguration
.configurationKey
;
1785 delete configurationData
.configurationKey
;
1787 configurationData
= merge
<ChargingStationConfiguration
>(
1789 buildChargingStationAutomaticTransactionGeneratorConfiguration(this)
1792 !this.getAutomaticTransactionGeneratorPersistentConfiguration() ||
1793 !this.getAutomaticTransactionGeneratorConfiguration()
1795 delete configurationData
.automaticTransactionGenerator
;
1797 if (this.connectors
.size
> 0) {
1798 configurationData
.connectorsStatus
= buildConnectorsStatus(this);
1800 delete configurationData
.connectorsStatus
;
1802 if (this.evses
.size
> 0) {
1803 configurationData
.evsesStatus
= buildEvsesStatus(this);
1805 delete configurationData
.evsesStatus
;
1807 delete configurationData
.configurationHash
;
1808 const configurationHash
= crypto
1809 .createHash(Constants
.DEFAULT_HASH_ALGORITHM
)
1812 stationInfo
: configurationData
.stationInfo
,
1813 configurationKey
: configurationData
.configurationKey
,
1814 automaticTransactionGenerator
: configurationData
.automaticTransactionGenerator
,
1815 } as ChargingStationConfiguration
)
1818 if (this.configurationFileHash
!== configurationHash
) {
1819 AsyncLock
.acquire(AsyncLockType
.configuration
)
1821 configurationData
.configurationHash
= configurationHash
;
1822 const measureId
= `${FileType.ChargingStationConfiguration} write`;
1823 const beginId
= PerformanceStatistics
.beginMeasure(measureId
);
1824 const fileDescriptor
= fs
.openSync(this.configurationFile
, 'w');
1825 fs
.writeFileSync(fileDescriptor
, JSON
.stringify(configurationData
, null, 2), 'utf8');
1826 fs
.closeSync(fileDescriptor
);
1827 PerformanceStatistics
.endMeasure(measureId
, beginId
);
1828 this.sharedLRUCache
.deleteChargingStationConfiguration(this.configurationFileHash
);
1829 this.sharedLRUCache
.setChargingStationConfiguration(configurationData
);
1830 this.configurationFileHash
= configurationHash
;
1833 handleFileException(
1834 this.configurationFile
,
1835 FileType
.ChargingStationConfiguration
,
1836 error
as NodeJS
.ErrnoException
,
1841 AsyncLock
.release(AsyncLockType
.configuration
).catch(Constants
.EMPTY_FUNCTION
);
1845 `${this.logPrefix()} Not saving unchanged charging station configuration file ${
1846 this.configurationFile
1851 handleFileException(
1852 this.configurationFile
,
1853 FileType
.ChargingStationConfiguration
,
1854 error
as NodeJS
.ErrnoException
,
1860 `${this.logPrefix()} Trying to save charging station configuration to undefined configuration file`
1865 private getOcppConfigurationFromTemplate(): ChargingStationOcppConfiguration
| undefined {
1866 return this.getTemplateFromFile()?.Configuration
;
1869 private getOcppConfigurationFromFile(): ChargingStationOcppConfiguration
| undefined {
1870 const configurationKey
= this.getConfigurationFromFile()?.configurationKey
;
1871 if (this.getOcppPersistentConfiguration() === true && configurationKey
) {
1872 return { configurationKey
};
1877 private getOcppConfiguration(): ChargingStationOcppConfiguration
| undefined {
1878 let ocppConfiguration
: ChargingStationOcppConfiguration
| undefined =
1879 this.getOcppConfigurationFromFile();
1880 if (!ocppConfiguration
) {
1881 ocppConfiguration
= this.getOcppConfigurationFromTemplate();
1883 return ocppConfiguration
;
1886 private async onOpen(): Promise
<void> {
1887 if (this.isWebSocketConnectionOpened() === true) {
1889 `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} succeeded`
1891 if (this.isRegistered() === false) {
1892 // Send BootNotification
1893 let registrationRetryCount
= 0;
1895 this.bootNotificationResponse
= await this.ocppRequestService
.requestHandler
<
1896 BootNotificationRequest
,
1897 BootNotificationResponse
1898 >(this, RequestCommand
.BOOT_NOTIFICATION
, this.bootNotificationRequest
, {
1899 skipBufferingOnError
: true,
1901 if (this.isRegistered() === false) {
1902 this.getRegistrationMaxRetries() !== -1 && ++registrationRetryCount
;
1904 this?.bootNotificationResponse
?.interval
1905 ? this.bootNotificationResponse
.interval
* 1000
1906 : Constants
.DEFAULT_BOOT_NOTIFICATION_INTERVAL
1910 this.isRegistered() === false &&
1911 (registrationRetryCount
<= this.getRegistrationMaxRetries() ||
1912 this.getRegistrationMaxRetries() === -1)
1915 if (this.isRegistered() === true) {
1916 if (this.inAcceptedState() === true) {
1917 await this.startMessageSequence();
1921 `${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})`
1924 this.wsConnectionRestarted
= false;
1925 this.autoReconnectRetryCount
= 0;
1926 parentPort
?.postMessage(buildUpdatedMessage(this));
1929 `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} failed`
1934 private async onClose(code
: number, reason
: Buffer
): Promise
<void> {
1937 case WebSocketCloseEventStatusCode
.CLOSE_NORMAL
:
1938 case WebSocketCloseEventStatusCode
.CLOSE_NO_STATUS
:
1940 `${this.logPrefix()} WebSocket normally closed with status '${Utils.getWebSocketCloseEventStatusString(
1942 )}' and reason '${reason.toString()}'`
1944 this.autoReconnectRetryCount
= 0;
1949 `${this.logPrefix()} WebSocket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString(
1951 )}' and reason '${reason.toString()}'`
1953 this.started
=== true && (await this.reconnect());
1956 parentPort
?.postMessage(buildUpdatedMessage(this));
1959 private getCachedRequest(messageType
: MessageType
, messageId
: string): CachedRequest
| undefined {
1960 const cachedRequest
= this.requests
.get(messageId
);
1961 if (Array.isArray(cachedRequest
) === true) {
1962 return cachedRequest
;
1964 throw new OCPPError(
1965 ErrorType
.PROTOCOL_ERROR
,
1966 `Cached request for message id ${messageId} ${OCPPServiceUtils.getMessageTypeString(
1968 )} is not an array`,
1970 cachedRequest
as JsonType
1974 private async handleIncomingMessage(request
: IncomingRequest
): Promise
<void> {
1975 const [messageType
, messageId
, commandName
, commandPayload
] = request
;
1976 if (this.getEnableStatistics() === true) {
1977 this.performanceStatistics
?.addRequestStatistic(commandName
, messageType
);
1980 `${this.logPrefix()} << Command '${commandName}' received request payload: ${JSON.stringify(
1984 // Process the message
1985 await this.ocppIncomingRequestService
.incomingRequestHandler(
1993 private handleResponseMessage(response
: Response
): void {
1994 const [messageType
, messageId
, commandPayload
] = response
;
1995 if (this.requests
.has(messageId
) === false) {
1997 throw new OCPPError(
1998 ErrorType
.INTERNAL_ERROR
,
1999 `Response for unknown message id ${messageId}`,
2005 const [responseCallback
, , requestCommandName
, requestPayload
] = this.getCachedRequest(
2010 `${this.logPrefix()} << Command '${
2011 requestCommandName ?? Constants.UNKNOWN_COMMAND
2012 }' received response payload: ${JSON.stringify(response)}`
2014 responseCallback(commandPayload
, requestPayload
);
2017 private handleErrorMessage(errorResponse
: ErrorResponse
): void {
2018 const [messageType
, messageId
, errorType
, errorMessage
, errorDetails
] = errorResponse
;
2019 if (this.requests
.has(messageId
) === false) {
2021 throw new OCPPError(
2022 ErrorType
.INTERNAL_ERROR
,
2023 `Error response for unknown message id ${messageId}`,
2025 { errorType
, errorMessage
, errorDetails
}
2028 const [, errorCallback
, requestCommandName
] = this.getCachedRequest(messageType
, messageId
);
2030 `${this.logPrefix()} << Command '${
2031 requestCommandName ?? Constants.UNKNOWN_COMMAND
2032 }' received error response payload: ${JSON.stringify(errorResponse)}`
2034 errorCallback(new OCPPError(errorType
, errorMessage
, requestCommandName
, errorDetails
));
2037 private async onMessage(data
: RawData
): Promise
<void> {
2038 let request
: IncomingRequest
| Response
| ErrorResponse
;
2039 let messageType
: number;
2040 let errorMsg
: string;
2042 request
= JSON
.parse(data
.toString()) as IncomingRequest
| Response
| ErrorResponse
;
2043 if (Array.isArray(request
) === true) {
2044 [messageType
] = request
;
2045 // Check the type of message
2046 switch (messageType
) {
2048 case MessageType
.CALL_MESSAGE
:
2049 await this.handleIncomingMessage(request
as IncomingRequest
);
2052 case MessageType
.CALL_RESULT_MESSAGE
:
2053 this.handleResponseMessage(request
as Response
);
2056 case MessageType
.CALL_ERROR_MESSAGE
:
2057 this.handleErrorMessage(request
as ErrorResponse
);
2061 // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
2062 errorMsg
= `Wrong message type ${messageType}`;
2063 logger
.error(`${this.logPrefix()} ${errorMsg}`);
2064 throw new OCPPError(ErrorType
.PROTOCOL_ERROR
, errorMsg
);
2066 parentPort
?.postMessage(buildUpdatedMessage(this));
2068 throw new OCPPError(ErrorType
.PROTOCOL_ERROR
, 'Incoming message is not an array', null, {
2073 let commandName
: IncomingRequestCommand
;
2074 let requestCommandName
: RequestCommand
| IncomingRequestCommand
;
2075 let errorCallback
: ErrorCallback
;
2076 const [, messageId
] = request
;
2077 switch (messageType
) {
2078 case MessageType
.CALL_MESSAGE
:
2079 [, , commandName
] = request
as IncomingRequest
;
2081 await this.ocppRequestService
.sendError(this, messageId
, error
as OCPPError
, commandName
);
2083 case MessageType
.CALL_RESULT_MESSAGE
:
2084 case MessageType
.CALL_ERROR_MESSAGE
:
2085 if (this.requests
.has(messageId
) === true) {
2086 [, errorCallback
, requestCommandName
] = this.getCachedRequest(messageType
, messageId
);
2087 // Reject the deferred promise in case of error at response handling (rejecting an already fulfilled promise is a no-op)
2088 errorCallback(error
as OCPPError
, false);
2090 // Remove the request from the cache in case of error at response handling
2091 this.requests
.delete(messageId
);
2095 if (error
instanceof OCPPError
=== false) {
2097 `${this.logPrefix()} Error thrown at incoming OCPP command '${
2098 commandName ?? requestCommandName ?? Constants.UNKNOWN_COMMAND
2099 }' message '${data.toString()}' handling is not an OCPPError:`,
2104 `${this.logPrefix()} Incoming OCPP command '${
2105 commandName ?? requestCommandName ?? Constants.UNKNOWN_COMMAND
2106 }' message '${data.toString()}'${
2107 messageType !== MessageType.CALL_MESSAGE
2108 ? ` matching cached request
'${JSON.stringify(this.requests.get(messageId))}'`
2110 } processing error:`,
2116 private onPing(): void {
2117 logger
.debug(`${this.logPrefix()} Received a WS ping (rfc6455) from the server`);
2120 private onPong(): void {
2121 logger
.debug(`${this.logPrefix()} Received a WS pong (rfc6455) from the server`);
2124 private onError(error
: WSError
): void {
2125 this.closeWSConnection();
2126 logger
.error(`${this.logPrefix()} WebSocket error:`, error
);
2129 private getEnergyActiveImportRegister(connectorStatus
: ConnectorStatus
, rounded
= false): number {
2130 if (this.getMeteringPerTransaction() === true) {
2133 ? Math.round(connectorStatus
?.transactionEnergyActiveImportRegisterValue
)
2134 : connectorStatus
?.transactionEnergyActiveImportRegisterValue
) ?? 0
2139 ? Math.round(connectorStatus
?.energyActiveImportRegisterValue
)
2140 : connectorStatus
?.energyActiveImportRegisterValue
) ?? 0
2144 private getUseConnectorId0(stationTemplate
?: ChargingStationTemplate
): boolean {
2145 return stationTemplate
?.useConnectorId0
?? true;
2148 private async stopRunningTransactions(reason
= StopTransactionReason
.NONE
): Promise
<void> {
2149 if (this.hasEvses
) {
2150 for (const evseStatus
of this.evses
.values()) {
2151 for (const [connectorId
, connectorStatus
] of evseStatus
.connectors
) {
2152 if (connectorStatus
.transactionStarted
=== true) {
2153 await this.stopTransactionOnConnector(connectorId
, reason
);
2158 for (const connectorId
of this.connectors
.keys()) {
2159 if (connectorId
> 0 && this.getConnectorStatus(connectorId
)?.transactionStarted
=== true) {
2160 await this.stopTransactionOnConnector(connectorId
, reason
);
2167 private getConnectionTimeout(): number {
2169 ChargingStationConfigurationUtils
.getConfigurationKey(
2171 StandardParametersKey
.ConnectionTimeOut
2176 ChargingStationConfigurationUtils
.getConfigurationKey(
2178 StandardParametersKey
.ConnectionTimeOut
2180 ) ?? Constants
.DEFAULT_CONNECTION_TIMEOUT
2183 return Constants
.DEFAULT_CONNECTION_TIMEOUT
;
2186 // -1 for unlimited, 0 for disabling
2187 private getAutoReconnectMaxRetries(): number | undefined {
2189 this.stationInfo
.autoReconnectMaxRetries
?? Configuration
.getAutoReconnectMaxRetries() ?? -1
2194 private getRegistrationMaxRetries(): number | undefined {
2195 return this.stationInfo
.registrationMaxRetries
?? -1;
2198 private getPowerDivider(): number {
2199 let powerDivider
= this.hasEvses
? this.getNumberOfEvses() : this.getNumberOfConnectors();
2200 if (this.stationInfo
?.powerSharedByConnectors
) {
2201 powerDivider
= this.getNumberOfRunningTransactions();
2203 return powerDivider
;
2206 private getMaximumAmperage(stationInfo
: ChargingStationInfo
): number | undefined {
2207 const maximumPower
= this.getMaximumPower(stationInfo
);
2208 switch (this.getCurrentOutType(stationInfo
)) {
2209 case CurrentType
.AC
:
2210 return ACElectricUtils
.amperagePerPhaseFromPower(
2211 this.getNumberOfPhases(stationInfo
),
2212 maximumPower
/ (this.hasEvses
? this.getNumberOfEvses() : this.getNumberOfConnectors()),
2213 this.getVoltageOut(stationInfo
)
2215 case CurrentType
.DC
:
2216 return DCElectricUtils
.amperage(maximumPower
, this.getVoltageOut(stationInfo
));
2220 private getAmperageLimitation(): number | undefined {
2222 Utils
.isNotEmptyString(this.stationInfo
?.amperageLimitationOcppKey
) &&
2223 ChargingStationConfigurationUtils
.getConfigurationKey(
2225 this.stationInfo
.amperageLimitationOcppKey
2230 ChargingStationConfigurationUtils
.getConfigurationKey(
2232 this.stationInfo
.amperageLimitationOcppKey
2234 ) / ChargingStationUtils
.getAmperageLimitationUnitDivider(this.stationInfo
)
2239 private async startMessageSequence(): Promise
<void> {
2240 if (this.stationInfo
?.autoRegister
=== true) {
2241 await this.ocppRequestService
.requestHandler
<
2242 BootNotificationRequest
,
2243 BootNotificationResponse
2244 >(this, RequestCommand
.BOOT_NOTIFICATION
, this.bootNotificationRequest
, {
2245 skipBufferingOnError
: true,
2248 // Start WebSocket ping
2249 this.startWebSocketPing();
2251 this.startHeartbeat();
2252 // Initialize connectors status
2253 if (this.hasEvses
) {
2254 for (const [evseId
, evseStatus
] of this.evses
) {
2256 for (const [connectorId
, connectorStatus
] of evseStatus
.connectors
) {
2257 const connectorBootStatus
= ChargingStationUtils
.getBootConnectorStatus(
2262 await OCPPServiceUtils
.sendAndSetConnectorStatus(
2265 connectorBootStatus
,
2272 for (const connectorId
of this.connectors
.keys()) {
2273 if (connectorId
> 0) {
2274 const connectorBootStatus
= ChargingStationUtils
.getBootConnectorStatus(
2277 this.getConnectorStatus(connectorId
)
2279 await OCPPServiceUtils
.sendAndSetConnectorStatus(this, connectorId
, connectorBootStatus
);
2283 if (this.stationInfo
?.firmwareStatus
=== FirmwareStatus
.Installing
) {
2284 await this.ocppRequestService
.requestHandler
<
2285 FirmwareStatusNotificationRequest
,
2286 FirmwareStatusNotificationResponse
2287 >(this, RequestCommand
.FIRMWARE_STATUS_NOTIFICATION
, {
2288 status: FirmwareStatus
.Installed
,
2290 this.stationInfo
.firmwareStatus
= FirmwareStatus
.Installed
;
2294 if (this.getAutomaticTransactionGeneratorConfiguration()?.enable
=== true) {
2295 this.startAutomaticTransactionGenerator();
2297 this.wsConnectionRestarted
=== true && this.flushMessageBuffer();
2300 private async stopMessageSequence(
2301 reason
: StopTransactionReason
= StopTransactionReason
.NONE
2303 // Stop WebSocket ping
2304 this.stopWebSocketPing();
2306 this.stopHeartbeat();
2307 // Stop ongoing transactions
2308 if (this.automaticTransactionGenerator
?.started
=== true) {
2309 this.stopAutomaticTransactionGenerator();
2311 await this.stopRunningTransactions(reason
);
2313 if (this.hasEvses
) {
2314 for (const [evseId
, evseStatus
] of this.evses
) {
2316 for (const [connectorId
, connectorStatus
] of evseStatus
.connectors
) {
2317 await this.ocppRequestService
.requestHandler
<
2318 StatusNotificationRequest
,
2319 StatusNotificationResponse
2322 RequestCommand
.STATUS_NOTIFICATION
,
2323 OCPPServiceUtils
.buildStatusNotificationRequest(
2326 ConnectorStatusEnum
.Unavailable
,
2330 delete connectorStatus
?.status;
2335 for (const connectorId
of this.connectors
.keys()) {
2336 if (connectorId
> 0) {
2337 await this.ocppRequestService
.requestHandler
<
2338 StatusNotificationRequest
,
2339 StatusNotificationResponse
2342 RequestCommand
.STATUS_NOTIFICATION
,
2343 OCPPServiceUtils
.buildStatusNotificationRequest(
2346 ConnectorStatusEnum
.Unavailable
2349 delete this.getConnectorStatus(connectorId
)?.status;
2355 private startWebSocketPing(): void {
2356 const webSocketPingInterval
: number = ChargingStationConfigurationUtils
.getConfigurationKey(
2358 StandardParametersKey
.WebSocketPingInterval
2360 ? Utils
.convertToInt(
2361 ChargingStationConfigurationUtils
.getConfigurationKey(
2363 StandardParametersKey
.WebSocketPingInterval
2367 if (webSocketPingInterval
> 0 && !this.webSocketPingSetInterval
) {
2368 this.webSocketPingSetInterval
= setInterval(() => {
2369 if (this.isWebSocketConnectionOpened() === true) {
2370 this.wsConnection
?.ping();
2372 }, webSocketPingInterval
* 1000);
2374 `${this.logPrefix()} WebSocket ping started every ${Utils.formatDurationSeconds(
2375 webSocketPingInterval
2378 } else if (this.webSocketPingSetInterval
) {
2380 `${this.logPrefix()} WebSocket ping already started every ${Utils.formatDurationSeconds(
2381 webSocketPingInterval
2386 `${this.logPrefix()} WebSocket ping interval set to ${webSocketPingInterval}, not starting the WebSocket ping`
2391 private stopWebSocketPing(): void {
2392 if (this.webSocketPingSetInterval
) {
2393 clearInterval(this.webSocketPingSetInterval
);
2394 delete this.webSocketPingSetInterval
;
2398 private getConfiguredSupervisionUrl(): URL
{
2399 let configuredSupervisionUrl
: string;
2400 const supervisionUrls
= this.stationInfo
?.supervisionUrls
?? Configuration
.getSupervisionUrls();
2401 if (Utils
.isNotEmptyArray(supervisionUrls
)) {
2402 let configuredSupervisionUrlIndex
: number;
2403 switch (Configuration
.getSupervisionUrlDistribution()) {
2404 case SupervisionUrlDistribution
.RANDOM
:
2405 configuredSupervisionUrlIndex
= Math.floor(Utils
.secureRandom() * supervisionUrls
.length
);
2407 case SupervisionUrlDistribution
.ROUND_ROBIN
:
2408 case SupervisionUrlDistribution
.CHARGING_STATION_AFFINITY
:
2410 Object.values(SupervisionUrlDistribution
).includes(
2411 Configuration
.getSupervisionUrlDistribution()
2414 `${this.logPrefix()} Unknown supervision url distribution '${Configuration.getSupervisionUrlDistribution()}' from values '${SupervisionUrlDistribution.toString()}', defaulting to ${
2415 SupervisionUrlDistribution.CHARGING_STATION_AFFINITY
2418 configuredSupervisionUrlIndex
= (this.index
- 1) % supervisionUrls
.length
;
2421 configuredSupervisionUrl
= supervisionUrls
[configuredSupervisionUrlIndex
];
2423 configuredSupervisionUrl
= supervisionUrls
as string;
2425 if (Utils
.isNotEmptyString(configuredSupervisionUrl
)) {
2426 return new URL(configuredSupervisionUrl
);
2428 const errorMsg
= 'No supervision url(s) configured';
2429 logger
.error(`${this.logPrefix()} ${errorMsg}`);
2430 throw new BaseError(`${errorMsg}`);
2433 private stopHeartbeat(): void {
2434 if (this.heartbeatSetInterval
) {
2435 clearInterval(this.heartbeatSetInterval
);
2436 delete this.heartbeatSetInterval
;
2440 private terminateWSConnection(): void {
2441 if (this.isWebSocketConnectionOpened() === true) {
2442 this.wsConnection
?.terminate();
2443 this.wsConnection
= null;
2447 private getReconnectExponentialDelay(): boolean {
2448 return this.stationInfo
?.reconnectExponentialDelay
?? false;
2451 private async reconnect(): Promise
<void> {
2452 // Stop WebSocket ping
2453 this.stopWebSocketPing();
2455 this.stopHeartbeat();
2456 // Stop the ATG if needed
2457 if (this.getAutomaticTransactionGeneratorConfiguration().stopOnConnectionFailure
=== true) {
2458 this.stopAutomaticTransactionGenerator();
2461 this.autoReconnectRetryCount
< this.getAutoReconnectMaxRetries() ||
2462 this.getAutoReconnectMaxRetries() === -1
2464 ++this.autoReconnectRetryCount
;
2465 const reconnectDelay
= this.getReconnectExponentialDelay()
2466 ? Utils
.exponentialDelay(this.autoReconnectRetryCount
)
2467 : this.getConnectionTimeout() * 1000;
2468 const reconnectDelayWithdraw
= 1000;
2469 const reconnectTimeout
=
2470 reconnectDelay
&& reconnectDelay
- reconnectDelayWithdraw
> 0
2471 ? reconnectDelay
- reconnectDelayWithdraw
2474 `${this.logPrefix()} WebSocket connection retry in ${Utils.roundTo(
2477 )}ms, timeout ${reconnectTimeout}ms`
2479 await Utils
.sleep(reconnectDelay
);
2481 `${this.logPrefix()} WebSocket connection retry #${this.autoReconnectRetryCount.toString()}`
2483 this.openWSConnection(
2485 ...(this.stationInfo
?.wsOptions
?? {}),
2486 handshakeTimeout
: reconnectTimeout
,
2488 { closeOpened
: true }
2490 this.wsConnectionRestarted
= true;
2491 } else if (this.getAutoReconnectMaxRetries() !== -1) {
2493 `${this.logPrefix()} WebSocket connection retries failure: maximum retries reached (${
2494 this.autoReconnectRetryCount
2495 }) or retries disabled (${this.getAutoReconnectMaxRetries()})`