1 // Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
3 import { createHash
} from
'node:crypto';
4 import { type FSWatcher
, existsSync
, mkdirSync
, readFileSync
, writeFileSync
} from
'node:fs';
5 import { dirname
, join
} from
'node:path';
6 import { URL
} from
'node:url';
7 import { parentPort
} from
'node:worker_threads';
9 import { millisecondsToSeconds
, secondsToMilliseconds
} from
'date-fns';
10 import merge from
'just-merge';
11 import { type RawData
, WebSocket
} from
'ws';
13 import { AutomaticTransactionGenerator
} from
'./AutomaticTransactionGenerator';
14 import { ChargingStationWorkerBroadcastChannel
} from
'./broadcast-channel/ChargingStationWorkerBroadcastChannel';
17 deleteConfigurationKey
,
19 setConfigurationKeyValue
,
20 } from
'./ConfigurationKeyUtils';
24 checkConnectorsConfiguration
,
25 checkStationInfoConnectorStatus
,
27 createBootNotificationRequest
,
29 getAmperageLimitationUnitDivider
,
30 getBootConnectorStatus
,
31 getChargingStationConnectorChargingProfilesPowerLimit
,
37 getNumberOfReservableConnectors
,
38 getPhaseRotationValue
,
40 hasReservationExpired
,
41 initializeConnectorsMapStatus
,
42 propagateSerialNumber
,
43 removeExpiredReservations
,
44 stationTemplateToStationInfo
,
45 warnTemplateKeysDeprecation
,
47 import { IdTagsCache
} from
'./IdTagsCache';
49 OCPP16IncomingRequestService
,
51 OCPP16ResponseService
,
53 OCPP20IncomingRequestService
,
55 OCPP20ResponseService
,
56 type OCPPIncomingRequestService
,
57 type OCPPRequestService
,
60 import { SharedLRUCache
} from
'./SharedLRUCache';
61 import { BaseError
, OCPPError
} from
'../exception';
62 import { PerformanceStatistics
} from
'../performance';
64 type AutomaticTransactionGeneratorConfiguration
,
66 type BootNotificationRequest
,
67 type BootNotificationResponse
,
69 type ChargingStationConfiguration
,
70 type ChargingStationInfo
,
71 type ChargingStationOcppConfiguration
,
72 type ChargingStationTemplate
,
80 type EvseStatusConfiguration
,
83 type FirmwareStatusNotificationRequest
,
84 type FirmwareStatusNotificationResponse
,
86 type HeartbeatRequest
,
87 type HeartbeatResponse
,
89 type IncomingRequestCommand
,
94 type MeterValuesRequest
,
95 type MeterValuesResponse
,
99 RegistrationStatusEnumType
,
103 ReservationTerminationReason
,
105 StandardParametersKey
,
107 type StatusNotificationRequest
,
108 type StatusNotificationResponse
,
109 StopTransactionReason
,
110 type StopTransactionRequest
,
111 type StopTransactionResponse
,
112 SupervisionUrlDistribution
,
113 SupportedFeatureProfiles
,
116 WebSocketCloseEventStatusCode
,
126 buildChargingStationAutomaticTransactionGeneratorConfiguration
,
127 buildConnectorsStatus
,
136 formatDurationMilliSeconds
,
137 formatDurationSeconds
,
139 getWebSocketCloseEventStatusString
,
155 export class ChargingStation
{
156 public readonly index
: number;
157 public readonly templateFile
: string;
158 public stationInfo
!: ChargingStationInfo
;
159 public started
: boolean;
160 public starting
: boolean;
161 public idTagsCache
: IdTagsCache
;
162 public automaticTransactionGenerator
!: AutomaticTransactionGenerator
| undefined;
163 public ocppConfiguration
!: ChargingStationOcppConfiguration
| undefined;
164 public wsConnection
!: WebSocket
| null;
165 public readonly connectors
: Map
<number, ConnectorStatus
>;
166 public readonly evses
: Map
<number, EvseStatus
>;
167 public readonly requests
: Map
<string, CachedRequest
>;
168 public performanceStatistics
!: PerformanceStatistics
| undefined;
169 public heartbeatSetInterval
?: NodeJS
.Timeout
;
170 public ocppRequestService
!: OCPPRequestService
;
171 public bootNotificationRequest
!: BootNotificationRequest
;
172 public bootNotificationResponse
!: BootNotificationResponse
| undefined;
173 public powerDivider
!: number;
174 private stopping
: boolean;
175 private configurationFile
!: string;
176 private configurationFileHash
!: string;
177 private connectorsConfigurationHash
!: string;
178 private evsesConfigurationHash
!: string;
179 private automaticTransactionGeneratorConfiguration
?: AutomaticTransactionGeneratorConfiguration
;
180 private ocppIncomingRequestService
!: OCPPIncomingRequestService
;
181 private readonly messageBuffer
: Set
<string>;
182 private configuredSupervisionUrl
!: URL
;
183 private wsConnectionRestarted
: boolean;
184 private autoReconnectRetryCount
: number;
185 private templateFileWatcher
!: FSWatcher
| undefined;
186 private templateFileHash
!: string;
187 private readonly sharedLRUCache
: SharedLRUCache
;
188 private webSocketPingSetInterval
?: NodeJS
.Timeout
;
189 private readonly chargingStationWorkerBroadcastChannel
: ChargingStationWorkerBroadcastChannel
;
190 private reservationExpirationSetInterval
?: NodeJS
.Timeout
;
192 constructor(index
: number, templateFile
: string) {
193 this.started
= false;
194 this.starting
= false;
195 this.stopping
= false;
196 this.wsConnectionRestarted
= false;
197 this.autoReconnectRetryCount
= 0;
199 this.templateFile
= templateFile
;
200 this.connectors
= new Map
<number, ConnectorStatus
>();
201 this.evses
= new Map
<number, EvseStatus
>();
202 this.requests
= new Map
<string, CachedRequest
>();
203 this.messageBuffer
= new Set
<string>();
204 this.sharedLRUCache
= SharedLRUCache
.getInstance();
205 this.idTagsCache
= IdTagsCache
.getInstance();
206 this.chargingStationWorkerBroadcastChannel
= new ChargingStationWorkerBroadcastChannel(this);
211 public get
hasEvses(): boolean {
212 return this.connectors
.size
=== 0 && this.evses
.size
> 0;
215 private get
wsConnectionUrl(): URL
{
218 this.getSupervisionUrlOcppConfiguration() &&
219 isNotEmptyString(this.getSupervisionUrlOcppKey()) &&
220 isNotEmptyString(getConfigurationKey(this, this.getSupervisionUrlOcppKey())?.value)
221 ? getConfigurationKey(this, this.getSupervisionUrlOcppKey())!.value
222 : this.configuredSupervisionUrl.href
223 }/${this.stationInfo.chargingStationId}`,
227 public logPrefix
= (): string => {
230 (isNotEmptyString(this?.stationInfo?.chargingStationId)
231 ? this?.stationInfo?.chargingStationId
232 : getChargingStationId(this.index, this.getTemplateFromFile()!)) ??
233 'Error at building log prefix'
238 public hasIdTags(): boolean {
239 return isNotEmptyArray(this.idTagsCache
.getIdTags(getIdTagsFile(this.stationInfo
)!));
242 public getEnableStatistics(): boolean {
243 return this.stationInfo
.enableStatistics
?? false;
246 public getRemoteAuthorization(): boolean {
247 return this.stationInfo
.remoteAuthorization
?? true;
250 public getNumberOfPhases(stationInfo
?: ChargingStationInfo
): number {
251 const localStationInfo
: ChargingStationInfo
= stationInfo
?? this.stationInfo
;
252 switch (this.getCurrentOutType(stationInfo
)) {
254 return !isUndefined(localStationInfo
.numberOfPhases
) ? localStationInfo
.numberOfPhases
! : 3;
260 public isWebSocketConnectionOpened(): boolean {
261 return this?.wsConnection
?.readyState
=== WebSocket
.OPEN
;
264 public getRegistrationStatus(): RegistrationStatusEnumType
| undefined {
265 return this?.bootNotificationResponse
?.status;
268 public inUnknownState(): boolean {
269 return isNullOrUndefined(this?.bootNotificationResponse
?.status);
272 public inPendingState(): boolean {
273 return this?.bootNotificationResponse
?.status === RegistrationStatusEnumType
.PENDING
;
276 public inAcceptedState(): boolean {
277 return this?.bootNotificationResponse
?.status === RegistrationStatusEnumType
.ACCEPTED
;
280 public inRejectedState(): boolean {
281 return this?.bootNotificationResponse
?.status === RegistrationStatusEnumType
.REJECTED
;
284 public isRegistered(): boolean {
286 this.inUnknownState() === false &&
287 (this.inAcceptedState() === true || this.inPendingState() === true)
291 public isChargingStationAvailable(): boolean {
292 return this.getConnectorStatus(0)?.availability
=== AvailabilityType
.Operative
;
295 public hasConnector(connectorId
: number): boolean {
297 for (const evseStatus
of this.evses
.values()) {
298 if (evseStatus
.connectors
.has(connectorId
)) {
304 return this.connectors
.has(connectorId
);
307 public isConnectorAvailable(connectorId
: number): boolean {
310 this.getConnectorStatus(connectorId
)?.availability
=== AvailabilityType
.Operative
314 public getNumberOfConnectors(): number {
316 let numberOfConnectors
= 0;
317 for (const [evseId
, evseStatus
] of this.evses
) {
319 numberOfConnectors
+= evseStatus
.connectors
.size
;
322 return numberOfConnectors
;
324 return this.connectors
.has(0) ? this.connectors
.size
- 1 : this.connectors
.size
;
327 public getNumberOfEvses(): number {
328 return this.evses
.has(0) ? this.evses
.size
- 1 : this.evses
.size
;
331 public getConnectorStatus(connectorId
: number): ConnectorStatus
| undefined {
333 for (const evseStatus
of this.evses
.values()) {
334 if (evseStatus
.connectors
.has(connectorId
)) {
335 return evseStatus
.connectors
.get(connectorId
);
340 return this.connectors
.get(connectorId
);
343 public getCurrentOutType(stationInfo
?: ChargingStationInfo
): CurrentType
{
344 return (stationInfo
?? this.stationInfo
)?.currentOutType
?? CurrentType
.AC
;
347 public getOcppStrictCompliance(): boolean {
348 return this.stationInfo
?.ocppStrictCompliance
?? true;
351 public getVoltageOut(stationInfo
?: ChargingStationInfo
): number {
352 const defaultVoltageOut
= getDefaultVoltageOut(
353 this.getCurrentOutType(stationInfo
),
357 return (stationInfo
?? this.stationInfo
).voltageOut
?? defaultVoltageOut
;
360 public getMaximumPower(stationInfo
?: ChargingStationInfo
): number {
361 return (stationInfo
?? this.stationInfo
).maximumPower
!;
364 public getConnectorMaximumAvailablePower(connectorId
: number): number {
365 let connectorAmperageLimitationPowerLimit
: number | undefined;
367 !isNullOrUndefined(this.getAmperageLimitation()) &&
368 this.getAmperageLimitation()! < this.stationInfo
.maximumAmperage
!
370 connectorAmperageLimitationPowerLimit
=
371 (this.getCurrentOutType() === CurrentType
.AC
372 ? ACElectricUtils
.powerTotal(
373 this.getNumberOfPhases(),
374 this.getVoltageOut(),
375 this.getAmperageLimitation()! *
376 (this.hasEvses
? this.getNumberOfEvses() : this.getNumberOfConnectors()),
378 : DCElectricUtils
.power(this.getVoltageOut(), this.getAmperageLimitation()!)) /
381 const connectorMaximumPower
= this.getMaximumPower() / this.powerDivider
;
382 const connectorChargingProfilesPowerLimit
=
383 getChargingStationConnectorChargingProfilesPowerLimit(this, connectorId
);
385 isNaN(connectorMaximumPower
) ? Infinity : connectorMaximumPower
,
386 isNaN(connectorAmperageLimitationPowerLimit
!)
388 : connectorAmperageLimitationPowerLimit
!,
389 isNaN(connectorChargingProfilesPowerLimit
!) ? Infinity : connectorChargingProfilesPowerLimit
!,
393 public getTransactionIdTag(transactionId
: number): string | undefined {
395 for (const evseStatus
of this.evses
.values()) {
396 for (const connectorStatus
of evseStatus
.connectors
.values()) {
397 if (connectorStatus
.transactionId
=== transactionId
) {
398 return connectorStatus
.transactionIdTag
;
403 for (const connectorId
of this.connectors
.keys()) {
404 if (this.getConnectorStatus(connectorId
)?.transactionId
=== transactionId
) {
405 return this.getConnectorStatus(connectorId
)?.transactionIdTag
;
411 public getNumberOfRunningTransactions(): number {
412 let numberOfRunningTransactions
= 0;
414 for (const [evseId
, evseStatus
] of this.evses
) {
418 for (const connectorStatus
of evseStatus
.connectors
.values()) {
419 if (connectorStatus
.transactionStarted
=== true) {
420 ++numberOfRunningTransactions
;
425 for (const connectorId
of this.connectors
.keys()) {
426 if (connectorId
> 0 && this.getConnectorStatus(connectorId
)?.transactionStarted
=== true) {
427 ++numberOfRunningTransactions
;
431 return numberOfRunningTransactions
;
434 public getOutOfOrderEndMeterValues(): boolean {
435 return this.stationInfo
?.outOfOrderEndMeterValues
?? false;
438 public getBeginEndMeterValues(): boolean {
439 return this.stationInfo
?.beginEndMeterValues
?? false;
442 public getMeteringPerTransaction(): boolean {
443 return this.stationInfo
?.meteringPerTransaction
?? true;
446 public getTransactionDataMeterValues(): boolean {
447 return this.stationInfo
?.transactionDataMeterValues
?? false;
450 public getMainVoltageMeterValues(): boolean {
451 return this.stationInfo
?.mainVoltageMeterValues
?? true;
454 public getPhaseLineToLineVoltageMeterValues(): boolean {
455 return this.stationInfo
?.phaseLineToLineVoltageMeterValues
?? false;
458 public getCustomValueLimitationMeterValues(): boolean {
459 return this.stationInfo
?.customValueLimitationMeterValues
?? true;
462 public getConnectorIdByTransactionId(transactionId
: number): number | undefined {
464 for (const evseStatus
of this.evses
.values()) {
465 for (const [connectorId
, connectorStatus
] of evseStatus
.connectors
) {
466 if (connectorStatus
.transactionId
=== transactionId
) {
472 for (const connectorId
of this.connectors
.keys()) {
473 if (this.getConnectorStatus(connectorId
)?.transactionId
=== transactionId
) {
480 public getEnergyActiveImportRegisterByTransactionId(
481 transactionId
: number,
484 return this.getEnergyActiveImportRegister(
485 this.getConnectorStatus(this.getConnectorIdByTransactionId(transactionId
)!)!,
490 public getEnergyActiveImportRegisterByConnectorId(connectorId
: number, rounded
= false): number {
491 return this.getEnergyActiveImportRegister(this.getConnectorStatus(connectorId
)!, rounded
);
494 public getAuthorizeRemoteTxRequests(): boolean {
495 const authorizeRemoteTxRequests
= getConfigurationKey(
497 StandardParametersKey
.AuthorizeRemoteTxRequests
,
499 return authorizeRemoteTxRequests
? convertToBoolean(authorizeRemoteTxRequests
.value
) : false;
502 public getLocalAuthListEnabled(): boolean {
503 const localAuthListEnabled
= getConfigurationKey(
505 StandardParametersKey
.LocalAuthListEnabled
,
507 return localAuthListEnabled
? convertToBoolean(localAuthListEnabled
.value
) : false;
510 public getHeartbeatInterval(): number {
511 const HeartbeatInterval
= getConfigurationKey(this, StandardParametersKey
.HeartbeatInterval
);
512 if (HeartbeatInterval
) {
513 return secondsToMilliseconds(convertToInt(HeartbeatInterval
.value
));
515 const HeartBeatInterval
= getConfigurationKey(this, StandardParametersKey
.HeartBeatInterval
);
516 if (HeartBeatInterval
) {
517 return secondsToMilliseconds(convertToInt(HeartBeatInterval
.value
));
519 this.stationInfo
?.autoRegister
=== false &&
521 `${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${
522 Constants.DEFAULT_HEARTBEAT_INTERVAL
525 return Constants
.DEFAULT_HEARTBEAT_INTERVAL
;
528 public setSupervisionUrl(url
: string): void {
530 this.getSupervisionUrlOcppConfiguration() &&
531 isNotEmptyString(this.getSupervisionUrlOcppKey())
533 setConfigurationKeyValue(this, this.getSupervisionUrlOcppKey(), url
);
535 this.stationInfo
.supervisionUrls
= url
;
536 this.saveStationInfo();
537 this.configuredSupervisionUrl
= this.getConfiguredSupervisionUrl();
541 public startHeartbeat(): void {
542 if (this.getHeartbeatInterval() > 0 && !this.heartbeatSetInterval
) {
543 this.heartbeatSetInterval
= setInterval(() => {
544 this.ocppRequestService
545 .requestHandler
<HeartbeatRequest
, HeartbeatResponse
>(this, RequestCommand
.HEARTBEAT
)
548 `${this.logPrefix()} Error while sending '${RequestCommand.HEARTBEAT}':`,
552 }, this.getHeartbeatInterval());
554 `${this.logPrefix()} Heartbeat started every ${formatDurationMilliSeconds(
555 this.getHeartbeatInterval(),
558 } else if (this.heartbeatSetInterval
) {
560 `${this.logPrefix()} Heartbeat already started every ${formatDurationMilliSeconds(
561 this.getHeartbeatInterval(),
566 `${this.logPrefix()} Heartbeat interval set to ${this.getHeartbeatInterval()}, not starting the heartbeat`,
571 public restartHeartbeat(): void {
573 this.stopHeartbeat();
575 this.startHeartbeat();
578 public restartWebSocketPing(): void {
579 // Stop WebSocket ping
580 this.stopWebSocketPing();
581 // Start WebSocket ping
582 this.startWebSocketPing();
585 public startMeterValues(connectorId
: number, interval
: number): void {
586 if (connectorId
=== 0) {
588 `${this.logPrefix()} Trying to start MeterValues on connector id ${connectorId}`,
592 if (!this.getConnectorStatus(connectorId
)) {
594 `${this.logPrefix()} Trying to start MeterValues on non existing connector id
599 if (this.getConnectorStatus(connectorId
)?.transactionStarted
=== false) {
601 `${this.logPrefix()} Trying to start MeterValues on connector id ${connectorId} with no transaction started`,
605 this.getConnectorStatus(connectorId
)?.transactionStarted
=== true &&
606 isNullOrUndefined(this.getConnectorStatus(connectorId
)?.transactionId
)
609 `${this.logPrefix()} Trying to start MeterValues on connector id ${connectorId} with no transaction id`,
614 this.getConnectorStatus(connectorId
)!.transactionSetInterval
= setInterval(() => {
615 // FIXME: Implement OCPP version agnostic helpers
616 const meterValue
: MeterValue
= OCPP16ServiceUtils
.buildMeterValue(
619 this.getConnectorStatus(connectorId
)!.transactionId
!,
622 this.ocppRequestService
623 .requestHandler
<MeterValuesRequest
, MeterValuesResponse
>(
625 RequestCommand
.METER_VALUES
,
628 transactionId
: this.getConnectorStatus(connectorId
)?.transactionId
,
629 meterValue
: [meterValue
],
634 `${this.logPrefix()} Error while sending '${RequestCommand.METER_VALUES}':`,
641 `${this.logPrefix()} Charging station ${
642 StandardParametersKey.MeterValueSampleInterval
643 } configuration set to ${interval}, not sending MeterValues`,
648 public stopMeterValues(connectorId
: number) {
649 if (this.getConnectorStatus(connectorId
)?.transactionSetInterval
) {
650 clearInterval(this.getConnectorStatus(connectorId
)?.transactionSetInterval
);
654 public start(): void {
655 if (this.started
=== false) {
656 if (this.starting
=== false) {
657 this.starting
= true;
658 if (this.getEnableStatistics() === true) {
659 this.performanceStatistics
?.start();
661 if (hasFeatureProfile(this, SupportedFeatureProfiles
.Reservation
)) {
662 this.startReservationExpirationSetInterval();
664 this.openWSConnection();
665 // Monitor charging station template file
666 this.templateFileWatcher
= watchJsonFile(
668 FileType
.ChargingStationTemplate
,
671 (event
, filename
): void => {
672 if (isNotEmptyString(filename
) && event
=== 'change') {
675 `${this.logPrefix()} ${FileType.ChargingStationTemplate} ${
677 } file have changed, reload`,
679 this.sharedLRUCache
.deleteChargingStationTemplate(this.templateFileHash
);
682 this.idTagsCache
.deleteIdTags(getIdTagsFile(this.stationInfo
)!);
684 this.stopAutomaticTransactionGenerator();
685 delete this.automaticTransactionGeneratorConfiguration
;
686 if (this.getAutomaticTransactionGeneratorConfiguration()?.enable
=== true) {
687 this.startAutomaticTransactionGenerator();
689 if (this.getEnableStatistics() === true) {
690 this.performanceStatistics
?.restart();
692 this.performanceStatistics
?.stop();
694 // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed
697 `${this.logPrefix()} ${FileType.ChargingStationTemplate} file monitoring error:`,
705 parentPort
?.postMessage(buildStartedMessage(this));
706 this.starting
= false;
708 logger
.warn(`${this.logPrefix()} Charging station is already starting...`);
711 logger
.warn(`${this.logPrefix()} Charging station is already started...`);
715 public async stop(reason
?: StopTransactionReason
): Promise
<void> {
716 if (this.started
=== true) {
717 if (this.stopping
=== false) {
718 this.stopping
= true;
719 await this.stopMessageSequence(reason
);
720 this.closeWSConnection();
721 if (this.getEnableStatistics() === true) {
722 this.performanceStatistics
?.stop();
724 if (hasFeatureProfile(this, SupportedFeatureProfiles
.Reservation
)) {
725 this.stopReservationExpirationSetInterval();
727 this.sharedLRUCache
.deleteChargingStationConfiguration(this.configurationFileHash
);
728 this.templateFileWatcher
?.close();
729 this.sharedLRUCache
.deleteChargingStationTemplate(this.templateFileHash
);
730 delete this.bootNotificationResponse
;
731 this.started
= false;
732 this.saveConfiguration();
733 parentPort
?.postMessage(buildStoppedMessage(this));
734 this.stopping
= false;
736 logger
.warn(`${this.logPrefix()} Charging station is already stopping...`);
739 logger
.warn(`${this.logPrefix()} Charging station is already stopped...`);
743 public async reset(reason
?: StopTransactionReason
): Promise
<void> {
744 await this.stop(reason
);
745 await sleep(this.stationInfo
.resetTime
!);
750 public saveOcppConfiguration(): void {
751 if (this.getOcppPersistentConfiguration()) {
752 this.saveConfiguration();
756 public bufferMessage(message
: string): void {
757 this.messageBuffer
.add(message
);
760 public openWSConnection(
762 params
?: { closeOpened
?: boolean; terminateOpened
?: boolean },
765 handshakeTimeout
: secondsToMilliseconds(this.getConnectionTimeout()),
766 ...this.stationInfo
?.wsOptions
,
769 params
= { ...{ closeOpened
: false, terminateOpened
: false }, ...params
};
770 if (!checkChargingStation(this, this.logPrefix())) {
774 !isNullOrUndefined(this.stationInfo
.supervisionUser
) &&
775 !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()} is already opened`,
794 `${this.logPrefix()} Open OCPP connection to URL ${this.wsConnectionUrl.toString()}`,
797 this.wsConnection
= new WebSocket(
798 this.wsConnectionUrl
,
799 `ocpp${this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16}`,
803 // Handle WebSocket message
804 this.wsConnection
.on(
806 this.onMessage
.bind(this) as (this: WebSocket
, data
: RawData
, isBinary
: boolean) => void,
808 // Handle WebSocket error
809 this.wsConnection
.on(
811 this.onError
.bind(this) as (this: WebSocket
, error
: Error) => void,
813 // Handle WebSocket close
814 this.wsConnection
.on(
816 this.onClose
.bind(this) as (this: WebSocket
, code
: number, reason
: Buffer
) => void,
818 // Handle WebSocket open
819 this.wsConnection
.on('open', this.onOpen
.bind(this) as (this: WebSocket
) => void);
820 // Handle WebSocket ping
821 this.wsConnection
.on('ping', this.onPing
.bind(this) as (this: WebSocket
, data
: Buffer
) => void);
822 // Handle WebSocket pong
823 this.wsConnection
.on('pong', this.onPong
.bind(this) as (this: WebSocket
, data
: Buffer
) => void);
826 public closeWSConnection(): void {
827 if (this.isWebSocketConnectionOpened() === true) {
828 this.wsConnection
?.close();
829 this.wsConnection
= null;
833 public getAutomaticTransactionGeneratorConfiguration(): AutomaticTransactionGeneratorConfiguration
{
834 if (isNullOrUndefined(this.automaticTransactionGeneratorConfiguration
)) {
835 let automaticTransactionGeneratorConfiguration
:
836 | AutomaticTransactionGeneratorConfiguration
838 const automaticTransactionGeneratorConfigurationFromFile
=
839 this.getConfigurationFromFile()?.automaticTransactionGenerator
;
841 this.getAutomaticTransactionGeneratorPersistentConfiguration() &&
842 automaticTransactionGeneratorConfigurationFromFile
844 automaticTransactionGeneratorConfiguration
=
845 automaticTransactionGeneratorConfigurationFromFile
;
847 automaticTransactionGeneratorConfiguration
=
848 this.getTemplateFromFile()?.AutomaticTransactionGenerator
;
850 this.automaticTransactionGeneratorConfiguration
= {
851 ...Constants
.DEFAULT_ATG_CONFIGURATION
,
852 ...automaticTransactionGeneratorConfiguration
,
855 return this.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 (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 (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 getReserveConnectorZeroSupported(): boolean {
925 return convertToBoolean(
926 getConfigurationKey(this, StandardParametersKey
.ReserveConnectorZeroSupported
)!.value
,
930 public async addReservation(reservation
: Reservation
): Promise
<void> {
931 const reservationFound
= this.getReservationBy('reservationId', reservation
.reservationId
);
932 if (!isUndefined(reservationFound
)) {
933 await this.removeReservation(
935 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 case ReservationTerminationReason
.TRANSACTION_STARTED
:
956 delete connector
.reservation
;
958 case ReservationTerminationReason
.RESERVATION_CANCELED
:
959 case ReservationTerminationReason
.REPLACE_EXISTING
:
960 case ReservationTerminationReason
.EXPIRED
:
961 await OCPPServiceUtils
.sendAndSetConnectorStatus(
963 reservation
.connectorId
,
964 ConnectorStatusEnum
.Available
,
966 { send
: reservation
.connectorId
!== 0 },
968 delete connector
.reservation
;
971 // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
972 throw new BaseError(`Unknown reservation termination reason '${reason}'`);
976 public getReservationBy(
977 filterKey
: ReservationKey
,
978 value
: number | string,
979 ): Reservation
| undefined {
981 for (const evseStatus
of this.evses
.values()) {
982 for (const connectorStatus
of evseStatus
.connectors
.values()) {
983 if (connectorStatus
?.reservation
?.[filterKey
] === value
) {
984 return connectorStatus
.reservation
;
989 for (const connectorStatus
of this.connectors
.values()) {
990 if (connectorStatus
?.reservation
?.[filterKey
] === value
) {
991 return connectorStatus
.reservation
;
997 public isConnectorReservable(
998 reservationId
: number,
1000 connectorId
?: number,
1002 const reservation
= this.getReservationBy('reservationId', reservationId
);
1003 const reservationExists
= !isUndefined(reservation
) && !hasReservationExpired(reservation
!);
1004 if (arguments.length
=== 1) {
1005 return !reservationExists
;
1006 } else if (arguments.length
> 1) {
1007 const userReservation
= !isUndefined(idTag
)
1008 ? this.getReservationBy('idTag', idTag
!)
1010 const userReservationExists
=
1011 !isUndefined(userReservation
) && !hasReservationExpired(userReservation
!);
1012 const notConnectorZero
= isUndefined(connectorId
) ? true : connectorId
! > 0;
1013 const freeConnectorsAvailable
= this.getNumberOfReservableConnectors() > 0;
1015 !reservationExists
&& !userReservationExists
&& notConnectorZero
&& freeConnectorsAvailable
1021 private startReservationExpirationSetInterval(customInterval
?: number): void {
1023 customInterval
?? Constants
.DEFAULT_RESERVATION_EXPIRATION_OBSERVATION_INTERVAL
;
1026 `${this.logPrefix()} Reservation expiration date checks started every ${formatDurationMilliSeconds(
1030 this.reservationExpirationSetInterval
= setInterval((): void => {
1031 removeExpiredReservations(this).catch(Constants
.EMPTY_FUNCTION
);
1036 private stopReservationExpirationSetInterval(): void {
1037 if (this.reservationExpirationSetInterval
) {
1038 clearInterval(this.reservationExpirationSetInterval
);
1042 // private restartReservationExpiryDateSetInterval(): void {
1043 // this.stopReservationExpirationSetInterval();
1044 // this.startReservationExpirationSetInterval();
1047 private getNumberOfReservableConnectors(): number {
1048 let numberOfReservableConnectors
= 0;
1049 if (this.hasEvses
) {
1050 for (const evseStatus
of this.evses
.values()) {
1051 numberOfReservableConnectors
+= getNumberOfReservableConnectors(evseStatus
.connectors
);
1054 numberOfReservableConnectors
= getNumberOfReservableConnectors(this.connectors
);
1056 return numberOfReservableConnectors
- this.getNumberOfReservationsOnConnectorZero();
1059 private getNumberOfReservationsOnConnectorZero(): number {
1061 // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
1062 (this.hasEvses
&& this.evses
.get(0)?.connectors
.get(0)?.reservation
) ||
1063 (!this.hasEvses
&& this.connectors
.get(0)?.reservation
)
1070 private flushMessageBuffer(): void {
1071 if (this.messageBuffer
.size
> 0) {
1072 for (const message
of this.messageBuffer
.values()) {
1073 let beginId
: string | undefined;
1074 let commandName
: RequestCommand
| undefined;
1075 const [messageType
] = JSON
.parse(message
) as OutgoingRequest
| Response
| ErrorResponse
;
1076 const isRequest
= messageType
=== MessageType
.CALL_MESSAGE
;
1078 [, , commandName
] = JSON
.parse(message
) as OutgoingRequest
;
1079 beginId
= PerformanceStatistics
.beginMeasure(commandName
);
1081 this.wsConnection
?.send(message
);
1082 isRequest
&& PerformanceStatistics
.endMeasure(commandName
!, beginId
!);
1084 `${this.logPrefix()} >> Buffered ${OCPPServiceUtils.getMessageTypeString(
1086 )} payload sent: ${message}`,
1088 this.messageBuffer
.delete(message
);
1093 private getSupervisionUrlOcppConfiguration(): boolean {
1094 return this.stationInfo
.supervisionUrlOcppConfiguration
?? false;
1097 private getSupervisionUrlOcppKey(): string {
1098 return this.stationInfo
.supervisionUrlOcppKey
?? VendorParametersKey
.ConnectionUrl
;
1101 private getTemplateFromFile(): ChargingStationTemplate
| undefined {
1102 let template
: ChargingStationTemplate
| undefined;
1104 if (this.sharedLRUCache
.hasChargingStationTemplate(this.templateFileHash
)) {
1105 template
= this.sharedLRUCache
.getChargingStationTemplate(this.templateFileHash
);
1107 const measureId
= `${FileType.ChargingStationTemplate} read`;
1108 const beginId
= PerformanceStatistics
.beginMeasure(measureId
);
1109 template
= JSON
.parse(readFileSync(this.templateFile
, 'utf8')) as ChargingStationTemplate
;
1110 PerformanceStatistics
.endMeasure(measureId
, beginId
);
1111 template
.templateHash
= createHash(Constants
.DEFAULT_HASH_ALGORITHM
)
1112 .update(JSON
.stringify(template
))
1114 this.sharedLRUCache
.setChargingStationTemplate(template
);
1115 this.templateFileHash
= template
.templateHash
;
1118 handleFileException(
1120 FileType
.ChargingStationTemplate
,
1121 error
as NodeJS
.ErrnoException
,
1128 private getStationInfoFromTemplate(): ChargingStationInfo
{
1129 const stationTemplate
: ChargingStationTemplate
= this.getTemplateFromFile()!;
1130 checkTemplate(stationTemplate
, this.logPrefix(), this.templateFile
);
1131 const warnTemplateKeysDeprecationOnce
= once(warnTemplateKeysDeprecation
, this);
1132 warnTemplateKeysDeprecationOnce(stationTemplate
, this.logPrefix(), this.templateFile
);
1133 if (stationTemplate
?.Connectors
) {
1134 checkConnectorsConfiguration(stationTemplate
, this.logPrefix(), this.templateFile
);
1136 const stationInfo
: ChargingStationInfo
= stationTemplateToStationInfo(stationTemplate
);
1137 stationInfo
.hashId
= getHashId(this.index
, stationTemplate
);
1138 stationInfo
.chargingStationId
= getChargingStationId(this.index
, stationTemplate
);
1139 stationInfo
.ocppVersion
= stationTemplate
?.ocppVersion
?? OCPPVersion
.VERSION_16
;
1140 createSerialNumber(stationTemplate
, stationInfo
);
1141 if (isNotEmptyArray(stationTemplate
?.power
)) {
1142 stationTemplate
.power
= stationTemplate
.power
as number[];
1143 const powerArrayRandomIndex
= Math.floor(secureRandom() * stationTemplate
.power
.length
);
1144 stationInfo
.maximumPower
=
1145 stationTemplate
?.powerUnit
=== PowerUnits
.KILO_WATT
1146 ? stationTemplate
.power
[powerArrayRandomIndex
] * 1000
1147 : stationTemplate
.power
[powerArrayRandomIndex
];
1149 stationTemplate
.power
= stationTemplate
?.power
as number;
1150 stationInfo
.maximumPower
=
1151 stationTemplate
?.powerUnit
=== PowerUnits
.KILO_WATT
1152 ? stationTemplate
.power
* 1000
1153 : stationTemplate
.power
;
1155 stationInfo
.firmwareVersionPattern
=
1156 stationTemplate
?.firmwareVersionPattern
?? Constants
.SEMVER_PATTERN
;
1158 isNotEmptyString(stationInfo
.firmwareVersion
) &&
1159 new RegExp(stationInfo
.firmwareVersionPattern
).test(stationInfo
.firmwareVersion
!) === false
1162 `${this.logPrefix()} Firmware version '${stationInfo.firmwareVersion}' in template file ${
1164 } does not match firmware version pattern '${stationInfo.firmwareVersionPattern}'`,
1167 stationInfo
.firmwareUpgrade
= merge
<FirmwareUpgrade
>(
1174 stationTemplate
?.firmwareUpgrade
?? {},
1176 stationInfo
.resetTime
= !isNullOrUndefined(stationTemplate
?.resetTime
)
1177 ? secondsToMilliseconds(stationTemplate
.resetTime
!)
1178 : Constants
.CHARGING_STATION_DEFAULT_RESET_TIME
;
1179 stationInfo
.maximumAmperage
= this.getMaximumAmperage(stationInfo
);
1183 private getStationInfoFromFile(): ChargingStationInfo
| undefined {
1184 let stationInfo
: ChargingStationInfo
| undefined;
1185 if (this.getStationInfoPersistentConfiguration()) {
1186 stationInfo
= this.getConfigurationFromFile()?.stationInfo
;
1188 delete stationInfo
?.infoHash
;
1194 private getStationInfo(): ChargingStationInfo
{
1195 const stationInfoFromTemplate
: ChargingStationInfo
= this.getStationInfoFromTemplate();
1196 const stationInfoFromFile
: ChargingStationInfo
| undefined = this.getStationInfoFromFile();
1198 // 1. charging station info from template
1199 // 2. charging station info from configuration file
1200 if (stationInfoFromFile
?.templateHash
=== stationInfoFromTemplate
.templateHash
) {
1201 return stationInfoFromFile
!;
1203 stationInfoFromFile
&&
1204 propagateSerialNumber(
1205 this.getTemplateFromFile()!,
1206 stationInfoFromFile
,
1207 stationInfoFromTemplate
,
1209 return stationInfoFromTemplate
;
1212 private saveStationInfo(): void {
1213 if (this.getStationInfoPersistentConfiguration()) {
1214 this.saveConfiguration();
1218 private getOcppPersistentConfiguration(): boolean {
1219 return this.stationInfo
?.ocppPersistentConfiguration
?? true;
1222 private getStationInfoPersistentConfiguration(): boolean {
1223 return this.stationInfo
?.stationInfoPersistentConfiguration
?? true;
1226 private getAutomaticTransactionGeneratorPersistentConfiguration(): boolean {
1227 return this.stationInfo
?.automaticTransactionGeneratorPersistentConfiguration
?? true;
1230 private handleUnsupportedVersion(version
: OCPPVersion
) {
1231 const errorMsg
= `Unsupported protocol version '${version}' configured in template file ${this.templateFile}`;
1232 logger
.error(`${this.logPrefix()} ${errorMsg}`);
1233 throw new BaseError(errorMsg
);
1236 private initialize(): void {
1237 const stationTemplate
= this.getTemplateFromFile()!;
1238 checkTemplate(stationTemplate
, this.logPrefix(), this.templateFile
);
1239 this.configurationFile
= join(
1240 dirname(this.templateFile
.replace('station-templates', 'configurations')),
1241 `${getHashId(this.index, stationTemplate)}.json`,
1243 const chargingStationConfiguration
= this.getConfigurationFromFile();
1245 chargingStationConfiguration
?.stationInfo
?.templateHash
=== stationTemplate
?.templateHash
&&
1246 // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
1247 (chargingStationConfiguration
?.connectorsStatus
|| chargingStationConfiguration
?.evsesStatus
)
1249 this.initializeConnectorsOrEvsesFromFile(chargingStationConfiguration
);
1251 this.initializeConnectorsOrEvsesFromTemplate(stationTemplate
);
1253 this.stationInfo
= this.getStationInfo();
1255 this.stationInfo
.firmwareStatus
=== FirmwareStatus
.Installing
&&
1256 isNotEmptyString(this.stationInfo
.firmwareVersion
) &&
1257 isNotEmptyString(this.stationInfo
.firmwareVersionPattern
)
1259 const patternGroup
: number | undefined =
1260 this.stationInfo
.firmwareUpgrade
?.versionUpgrade
?.patternGroup
??
1261 this.stationInfo
.firmwareVersion
?.split('.').length
;
1262 const match
= this.stationInfo
1263 .firmwareVersion
!.match(new RegExp(this.stationInfo
.firmwareVersionPattern
!))!
1264 .slice(1, patternGroup
! + 1);
1265 const patchLevelIndex
= match
.length
- 1;
1266 match
[patchLevelIndex
] = (
1267 convertToInt(match
[patchLevelIndex
]) +
1268 this.stationInfo
.firmwareUpgrade
!.versionUpgrade
!.step
!
1270 this.stationInfo
.firmwareVersion
= match
?.join('.');
1272 this.saveStationInfo();
1273 this.configuredSupervisionUrl
= this.getConfiguredSupervisionUrl();
1274 if (this.getEnableStatistics() === true) {
1275 this.performanceStatistics
= PerformanceStatistics
.getInstance(
1276 this.stationInfo
.hashId
,
1277 this.stationInfo
.chargingStationId
!,
1278 this.configuredSupervisionUrl
,
1281 this.bootNotificationRequest
= createBootNotificationRequest(this.stationInfo
);
1282 this.powerDivider
= this.getPowerDivider();
1283 // OCPP configuration
1284 this.ocppConfiguration
= this.getOcppConfiguration();
1285 this.initializeOcppConfiguration();
1286 this.initializeOcppServices();
1287 if (this.stationInfo
?.autoRegister
=== true) {
1288 this.bootNotificationResponse
= {
1289 currentTime
: new Date(),
1290 interval
: millisecondsToSeconds(this.getHeartbeatInterval()),
1291 status: RegistrationStatusEnumType
.ACCEPTED
,
1296 private initializeOcppServices(): void {
1297 const ocppVersion
= this.stationInfo
.ocppVersion
?? OCPPVersion
.VERSION_16
;
1298 switch (ocppVersion
) {
1299 case OCPPVersion
.VERSION_16
:
1300 this.ocppIncomingRequestService
=
1301 OCPP16IncomingRequestService
.getInstance
<OCPP16IncomingRequestService
>();
1302 this.ocppRequestService
= OCPP16RequestService
.getInstance
<OCPP16RequestService
>(
1303 OCPP16ResponseService
.getInstance
<OCPP16ResponseService
>(),
1306 case OCPPVersion
.VERSION_20
:
1307 case OCPPVersion
.VERSION_201
:
1308 this.ocppIncomingRequestService
=
1309 OCPP20IncomingRequestService
.getInstance
<OCPP20IncomingRequestService
>();
1310 this.ocppRequestService
= OCPP20RequestService
.getInstance
<OCPP20RequestService
>(
1311 OCPP20ResponseService
.getInstance
<OCPP20ResponseService
>(),
1315 this.handleUnsupportedVersion(ocppVersion
);
1320 private initializeOcppConfiguration(): void {
1321 if (!getConfigurationKey(this, StandardParametersKey
.HeartbeatInterval
)) {
1322 addConfigurationKey(this, StandardParametersKey
.HeartbeatInterval
, '0');
1324 if (!getConfigurationKey(this, StandardParametersKey
.HeartBeatInterval
)) {
1325 addConfigurationKey(this, StandardParametersKey
.HeartBeatInterval
, '0', { visible
: false });
1328 this.getSupervisionUrlOcppConfiguration() &&
1329 isNotEmptyString(this.getSupervisionUrlOcppKey()) &&
1330 !getConfigurationKey(this, this.getSupervisionUrlOcppKey())
1332 addConfigurationKey(
1334 this.getSupervisionUrlOcppKey(),
1335 this.configuredSupervisionUrl
.href
,
1339 !this.getSupervisionUrlOcppConfiguration() &&
1340 isNotEmptyString(this.getSupervisionUrlOcppKey()) &&
1341 getConfigurationKey(this, this.getSupervisionUrlOcppKey())
1343 deleteConfigurationKey(this, this.getSupervisionUrlOcppKey(), { save
: false });
1346 isNotEmptyString(this.stationInfo
?.amperageLimitationOcppKey
) &&
1347 !getConfigurationKey(this, this.stationInfo
.amperageLimitationOcppKey
!)
1349 addConfigurationKey(
1351 this.stationInfo
.amperageLimitationOcppKey
!,
1353 this.stationInfo
.maximumAmperage
! * getAmperageLimitationUnitDivider(this.stationInfo
)
1357 if (!getConfigurationKey(this, StandardParametersKey
.SupportedFeatureProfiles
)) {
1358 addConfigurationKey(
1360 StandardParametersKey
.SupportedFeatureProfiles
,
1361 `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.FirmwareManagement},${SupportedFeatureProfiles.LocalAuthListManagement},${SupportedFeatureProfiles.SmartCharging},${SupportedFeatureProfiles.RemoteTrigger}`,
1364 addConfigurationKey(
1366 StandardParametersKey
.NumberOfConnectors
,
1367 this.getNumberOfConnectors().toString(),
1369 { overwrite
: true },
1371 if (!getConfigurationKey(this, StandardParametersKey
.MeterValuesSampledData
)) {
1372 addConfigurationKey(
1374 StandardParametersKey
.MeterValuesSampledData
,
1375 MeterValueMeasurand
.ENERGY_ACTIVE_IMPORT_REGISTER
,
1378 if (!getConfigurationKey(this, StandardParametersKey
.ConnectorPhaseRotation
)) {
1379 const connectorsPhaseRotation
: string[] = [];
1380 if (this.hasEvses
) {
1381 for (const evseStatus
of this.evses
.values()) {
1382 for (const connectorId
of evseStatus
.connectors
.keys()) {
1383 connectorsPhaseRotation
.push(
1384 getPhaseRotationValue(connectorId
, this.getNumberOfPhases())!,
1389 for (const connectorId
of this.connectors
.keys()) {
1390 connectorsPhaseRotation
.push(
1391 getPhaseRotationValue(connectorId
, this.getNumberOfPhases())!,
1395 addConfigurationKey(
1397 StandardParametersKey
.ConnectorPhaseRotation
,
1398 connectorsPhaseRotation
.toString(),
1401 if (!getConfigurationKey(this, StandardParametersKey
.AuthorizeRemoteTxRequests
)) {
1402 addConfigurationKey(this, StandardParametersKey
.AuthorizeRemoteTxRequests
, 'true');
1405 !getConfigurationKey(this, StandardParametersKey
.LocalAuthListEnabled
) &&
1406 getConfigurationKey(this, StandardParametersKey
.SupportedFeatureProfiles
)?.value
?.includes(
1407 SupportedFeatureProfiles
.LocalAuthListManagement
,
1410 addConfigurationKey(this, StandardParametersKey
.LocalAuthListEnabled
, 'false');
1412 if (!getConfigurationKey(this, StandardParametersKey
.ConnectionTimeOut
)) {
1413 addConfigurationKey(
1415 StandardParametersKey
.ConnectionTimeOut
,
1416 Constants
.DEFAULT_CONNECTION_TIMEOUT
.toString(),
1419 this.saveOcppConfiguration();
1422 private initializeConnectorsOrEvsesFromFile(configuration
: ChargingStationConfiguration
): void {
1423 if (configuration
?.connectorsStatus
&& !configuration
?.evsesStatus
) {
1424 for (const [connectorId
, connectorStatus
] of configuration
.connectorsStatus
.entries()) {
1425 this.connectors
.set(connectorId
, cloneObject
<ConnectorStatus
>(connectorStatus
));
1427 } else if (configuration
?.evsesStatus
&& !configuration
?.connectorsStatus
) {
1428 for (const [evseId
, evseStatusConfiguration
] of configuration
.evsesStatus
.entries()) {
1429 const evseStatus
= cloneObject
<EvseStatusConfiguration
>(evseStatusConfiguration
);
1430 delete evseStatus
.connectorsStatus
;
1431 this.evses
.set(evseId
, {
1432 ...(evseStatus
as EvseStatus
),
1433 connectors
: new Map
<number, ConnectorStatus
>(
1434 evseStatusConfiguration
.connectorsStatus
!.map((connectorStatus
, connectorId
) => [
1441 } else if (configuration
?.evsesStatus
&& configuration
?.connectorsStatus
) {
1442 const errorMsg
= `Connectors and evses defined at the same time in configuration file ${this.configurationFile}`;
1443 logger
.error(`${this.logPrefix()} ${errorMsg}`);
1444 throw new BaseError(errorMsg
);
1446 const errorMsg
= `No connectors or evses defined in configuration file ${this.configurationFile}`;
1447 logger
.error(`${this.logPrefix()} ${errorMsg}`);
1448 throw new BaseError(errorMsg
);
1452 private initializeConnectorsOrEvsesFromTemplate(stationTemplate
: ChargingStationTemplate
) {
1453 if (stationTemplate
?.Connectors
&& !stationTemplate
?.Evses
) {
1454 this.initializeConnectorsFromTemplate(stationTemplate
);
1455 } else if (stationTemplate
?.Evses
&& !stationTemplate
?.Connectors
) {
1456 this.initializeEvsesFromTemplate(stationTemplate
);
1457 } else if (stationTemplate
?.Evses
&& stationTemplate
?.Connectors
) {
1458 const errorMsg
= `Connectors and evses defined at the same time in template file ${this.templateFile}`;
1459 logger
.error(`${this.logPrefix()} ${errorMsg}`);
1460 throw new BaseError(errorMsg
);
1462 const errorMsg
= `No connectors or evses defined in template file ${this.templateFile}`;
1463 logger
.error(`${this.logPrefix()} ${errorMsg}`);
1464 throw new BaseError(errorMsg
);
1468 private initializeConnectorsFromTemplate(stationTemplate
: ChargingStationTemplate
): void {
1469 if (!stationTemplate
?.Connectors
&& this.connectors
.size
=== 0) {
1470 const errorMsg
= `No already defined connectors and charging station information from template ${this.templateFile} with no connectors configuration defined`;
1471 logger
.error(`${this.logPrefix()} ${errorMsg}`);
1472 throw new BaseError(errorMsg
);
1474 if (!stationTemplate
?.Connectors
?.[0]) {
1476 `${this.logPrefix()} Charging station information from template ${
1478 } with no connector id 0 configuration`,
1481 if (stationTemplate
?.Connectors
) {
1482 const { configuredMaxConnectors
, templateMaxConnectors
, templateMaxAvailableConnectors
} =
1483 checkConnectorsConfiguration(stationTemplate
, this.logPrefix(), this.templateFile
);
1484 const connectorsConfigHash
= createHash(Constants
.DEFAULT_HASH_ALGORITHM
)
1486 `${JSON.stringify(stationTemplate?.Connectors)}${configuredMaxConnectors.toString()}`,
1489 const connectorsConfigChanged
=
1490 this.connectors
?.size
!== 0 && this.connectorsConfigurationHash
!== connectorsConfigHash
;
1491 if (this.connectors
?.size
=== 0 || connectorsConfigChanged
) {
1492 connectorsConfigChanged
&& this.connectors
.clear();
1493 this.connectorsConfigurationHash
= connectorsConfigHash
;
1494 if (templateMaxConnectors
> 0) {
1495 for (let connectorId
= 0; connectorId
<= configuredMaxConnectors
; connectorId
++) {
1497 connectorId
=== 0 &&
1498 (!stationTemplate
?.Connectors
?.[connectorId
] ||
1499 this.getUseConnectorId0(stationTemplate
) === false)
1503 const templateConnectorId
=
1504 connectorId
> 0 && stationTemplate
?.randomConnectors
1505 ? getRandomInteger(templateMaxAvailableConnectors
, 1)
1507 const connectorStatus
= stationTemplate
?.Connectors
[templateConnectorId
];
1508 checkStationInfoConnectorStatus(
1509 templateConnectorId
,
1514 this.connectors
.set(connectorId
, cloneObject
<ConnectorStatus
>(connectorStatus
));
1516 initializeConnectorsMapStatus(this.connectors
, this.logPrefix());
1517 this.saveConnectorsStatus();
1520 `${this.logPrefix()} Charging station information from template ${
1522 } with no connectors configuration defined, cannot create connectors`,
1528 `${this.logPrefix()} Charging station information from template ${
1530 } with no connectors configuration defined, using already defined connectors`,
1535 private initializeEvsesFromTemplate(stationTemplate
: ChargingStationTemplate
): void {
1536 if (!stationTemplate
?.Evses
&& this.evses
.size
=== 0) {
1537 const errorMsg
= `No already defined evses and charging station information from template ${this.templateFile} with no evses configuration defined`;
1538 logger
.error(`${this.logPrefix()} ${errorMsg}`);
1539 throw new BaseError(errorMsg
);
1541 if (!stationTemplate
?.Evses
?.[0]) {
1543 `${this.logPrefix()} Charging station information from template ${
1545 } with no evse id 0 configuration`,
1548 if (!stationTemplate
?.Evses
?.[0]?.Connectors
?.[0]) {
1550 `${this.logPrefix()} Charging station information from template ${
1552 } with evse id 0 with no connector id 0 configuration`,
1555 if (Object.keys(stationTemplate
?.Evses
?.[0]?.Connectors
as object
).length
> 1) {
1557 `${this.logPrefix()} Charging station information from template ${
1559 } with evse id 0 with more than one connector configuration, only connector id 0 configuration will be used`,
1562 if (stationTemplate
?.Evses
) {
1563 const evsesConfigHash
= createHash(Constants
.DEFAULT_HASH_ALGORITHM
)
1564 .update(JSON
.stringify(stationTemplate
?.Evses
))
1566 const evsesConfigChanged
=
1567 this.evses
?.size
!== 0 && this.evsesConfigurationHash
!== evsesConfigHash
;
1568 if (this.evses
?.size
=== 0 || evsesConfigChanged
) {
1569 evsesConfigChanged
&& this.evses
.clear();
1570 this.evsesConfigurationHash
= evsesConfigHash
;
1571 const templateMaxEvses
= getMaxNumberOfEvses(stationTemplate
?.Evses
);
1572 if (templateMaxEvses
> 0) {
1573 for (const evseKey
in stationTemplate
.Evses
) {
1574 const evseId
= convertToInt(evseKey
);
1575 this.evses
.set(evseId
, {
1576 connectors
: buildConnectorsMap(
1577 stationTemplate
?.Evses
[evseKey
]?.Connectors
,
1581 availability
: AvailabilityType
.Operative
,
1583 initializeConnectorsMapStatus(this.evses
.get(evseId
)!.connectors
, this.logPrefix());
1585 this.saveEvsesStatus();
1588 `${this.logPrefix()} Charging station information from template ${
1590 } with no evses configuration defined, cannot create evses`,
1596 `${this.logPrefix()} Charging station information from template ${
1598 } with no evses configuration defined, using already defined evses`,
1603 private getConfigurationFromFile(): ChargingStationConfiguration
| undefined {
1604 let configuration
: ChargingStationConfiguration
| undefined;
1605 if (isNotEmptyString(this.configurationFile
) && existsSync(this.configurationFile
)) {
1607 if (this.sharedLRUCache
.hasChargingStationConfiguration(this.configurationFileHash
)) {
1608 configuration
= this.sharedLRUCache
.getChargingStationConfiguration(
1609 this.configurationFileHash
,
1612 const measureId
= `${FileType.ChargingStationConfiguration} read`;
1613 const beginId
= PerformanceStatistics
.beginMeasure(measureId
);
1614 configuration
= JSON
.parse(
1615 readFileSync(this.configurationFile
, 'utf8'),
1616 ) as ChargingStationConfiguration
;
1617 PerformanceStatistics
.endMeasure(measureId
, beginId
);
1618 this.sharedLRUCache
.setChargingStationConfiguration(configuration
);
1619 this.configurationFileHash
= configuration
.configurationHash
!;
1622 handleFileException(
1623 this.configurationFile
,
1624 FileType
.ChargingStationConfiguration
,
1625 error
as NodeJS
.ErrnoException
,
1630 return configuration
;
1633 private saveAutomaticTransactionGeneratorConfiguration(): void {
1634 if (this.getAutomaticTransactionGeneratorPersistentConfiguration()) {
1635 this.saveConfiguration();
1639 private saveConnectorsStatus() {
1640 this.saveConfiguration();
1643 private saveEvsesStatus() {
1644 this.saveConfiguration();
1647 private saveConfiguration(): void {
1648 if (isNotEmptyString(this.configurationFile
)) {
1650 if (!existsSync(dirname(this.configurationFile
))) {
1651 mkdirSync(dirname(this.configurationFile
), { recursive
: true });
1653 let configurationData
: ChargingStationConfiguration
= this.getConfigurationFromFile()
1654 ? cloneObject
<ChargingStationConfiguration
>(this.getConfigurationFromFile()!)
1656 if (this.getStationInfoPersistentConfiguration() && this.stationInfo
) {
1657 configurationData
.stationInfo
= this.stationInfo
;
1659 delete configurationData
.stationInfo
;
1661 if (this.getOcppPersistentConfiguration() && this.ocppConfiguration
?.configurationKey
) {
1662 configurationData
.configurationKey
= this.ocppConfiguration
.configurationKey
;
1664 delete configurationData
.configurationKey
;
1666 configurationData
= merge
<ChargingStationConfiguration
>(
1668 buildChargingStationAutomaticTransactionGeneratorConfiguration(this),
1671 !this.getAutomaticTransactionGeneratorPersistentConfiguration() ||
1672 !this.getAutomaticTransactionGeneratorConfiguration()
1674 delete configurationData
.automaticTransactionGenerator
;
1676 if (this.connectors
.size
> 0) {
1677 configurationData
.connectorsStatus
= buildConnectorsStatus(this);
1679 delete configurationData
.connectorsStatus
;
1681 if (this.evses
.size
> 0) {
1682 configurationData
.evsesStatus
= buildEvsesStatus(this);
1684 delete configurationData
.evsesStatus
;
1686 delete configurationData
.configurationHash
;
1687 const configurationHash
= createHash(Constants
.DEFAULT_HASH_ALGORITHM
)
1690 stationInfo
: configurationData
.stationInfo
,
1691 configurationKey
: configurationData
.configurationKey
,
1692 automaticTransactionGenerator
: configurationData
.automaticTransactionGenerator
,
1693 } as ChargingStationConfiguration
),
1696 if (this.configurationFileHash
!== configurationHash
) {
1697 AsyncLock
.runExclusive(AsyncLockType
.configuration
, () => {
1698 configurationData
.configurationHash
= configurationHash
;
1699 const measureId
= `${FileType.ChargingStationConfiguration} write`;
1700 const beginId
= PerformanceStatistics
.beginMeasure(measureId
);
1702 this.configurationFile
,
1703 JSON
.stringify(configurationData
, null, 2),
1706 PerformanceStatistics
.endMeasure(measureId
, beginId
);
1707 this.sharedLRUCache
.deleteChargingStationConfiguration(this.configurationFileHash
);
1708 this.sharedLRUCache
.setChargingStationConfiguration(configurationData
);
1709 this.configurationFileHash
= configurationHash
;
1710 }).catch((error
) => {
1711 handleFileException(
1712 this.configurationFile
,
1713 FileType
.ChargingStationConfiguration
,
1714 error
as NodeJS
.ErrnoException
,
1720 `${this.logPrefix()} Not saving unchanged charging station configuration file ${
1721 this.configurationFile
1726 handleFileException(
1727 this.configurationFile
,
1728 FileType
.ChargingStationConfiguration
,
1729 error
as NodeJS
.ErrnoException
,
1735 `${this.logPrefix()} Trying to save charging station configuration to undefined configuration file`,
1740 private getOcppConfigurationFromTemplate(): ChargingStationOcppConfiguration
| undefined {
1741 return this.getTemplateFromFile()?.Configuration
;
1744 private getOcppConfigurationFromFile(): ChargingStationOcppConfiguration
| undefined {
1745 const configurationKey
= this.getConfigurationFromFile()?.configurationKey
;
1746 if (this.getOcppPersistentConfiguration() === true && configurationKey
) {
1747 return { configurationKey
};
1752 private getOcppConfiguration(): ChargingStationOcppConfiguration
| undefined {
1753 let ocppConfiguration
: ChargingStationOcppConfiguration
| undefined =
1754 this.getOcppConfigurationFromFile();
1755 if (!ocppConfiguration
) {
1756 ocppConfiguration
= this.getOcppConfigurationFromTemplate();
1758 return ocppConfiguration
;
1761 private async onOpen(): Promise
<void> {
1762 if (this.isWebSocketConnectionOpened() === true) {
1764 `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} succeeded`,
1766 if (this.isRegistered() === false) {
1767 // Send BootNotification
1768 let registrationRetryCount
= 0;
1770 this.bootNotificationResponse
= await this.ocppRequestService
.requestHandler
<
1771 BootNotificationRequest
,
1772 BootNotificationResponse
1773 >(this, RequestCommand
.BOOT_NOTIFICATION
, this.bootNotificationRequest
, {
1774 skipBufferingOnError
: true,
1776 if (this.isRegistered() === false) {
1777 this.getRegistrationMaxRetries() !== -1 && ++registrationRetryCount
;
1779 this?.bootNotificationResponse
?.interval
1780 ? secondsToMilliseconds(this.bootNotificationResponse
.interval
)
1781 : Constants
.DEFAULT_BOOT_NOTIFICATION_INTERVAL
,
1785 this.isRegistered() === false &&
1786 (registrationRetryCount
<= this.getRegistrationMaxRetries()! ||
1787 this.getRegistrationMaxRetries() === -1)
1790 if (this.isRegistered() === true) {
1791 if (this.inAcceptedState() === true) {
1792 await this.startMessageSequence();
1796 `${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})`,
1799 this.wsConnectionRestarted
= false;
1800 this.autoReconnectRetryCount
= 0;
1801 parentPort
?.postMessage(buildUpdatedMessage(this));
1804 `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} failed`,
1809 private async onClose(code
: number, reason
: Buffer
): Promise
<void> {
1812 case WebSocketCloseEventStatusCode
.CLOSE_NORMAL
:
1813 case WebSocketCloseEventStatusCode
.CLOSE_NO_STATUS
:
1815 `${this.logPrefix()} WebSocket normally closed with status '${getWebSocketCloseEventStatusString(
1817 )}' and reason '${reason.toString()}'`,
1819 this.autoReconnectRetryCount
= 0;
1824 `${this.logPrefix()} WebSocket abnormally closed with status '${getWebSocketCloseEventStatusString(
1826 )}' and reason '${reason.toString()}'`,
1828 this.started
=== true && (await this.reconnect());
1831 parentPort
?.postMessage(buildUpdatedMessage(this));
1834 private getCachedRequest(messageType
: MessageType
, messageId
: string): CachedRequest
| undefined {
1835 const cachedRequest
= this.requests
.get(messageId
);
1836 if (Array.isArray(cachedRequest
) === true) {
1837 return cachedRequest
;
1839 throw new OCPPError(
1840 ErrorType
.PROTOCOL_ERROR
,
1841 `Cached request for message id ${messageId} ${OCPPServiceUtils.getMessageTypeString(
1843 )} is not an array`,
1845 cachedRequest
as JsonType
,
1849 private async handleIncomingMessage(request
: IncomingRequest
): Promise
<void> {
1850 const [messageType
, messageId
, commandName
, commandPayload
] = request
;
1851 if (this.getEnableStatistics() === true) {
1852 this.performanceStatistics
?.addRequestStatistic(commandName
, messageType
);
1855 `${this.logPrefix()} << Command '${commandName}' received request payload: ${JSON.stringify(
1859 // Process the message
1860 await this.ocppIncomingRequestService
.incomingRequestHandler(
1868 private handleResponseMessage(response
: Response
): void {
1869 const [messageType
, messageId
, commandPayload
] = response
;
1870 if (this.requests
.has(messageId
) === false) {
1872 throw new OCPPError(
1873 ErrorType
.INTERNAL_ERROR
,
1874 `Response for unknown message id ${messageId}`,
1880 const [responseCallback
, , requestCommandName
, requestPayload
] = this.getCachedRequest(
1885 `${this.logPrefix()} << Command '${
1886 requestCommandName ?? Constants.UNKNOWN_COMMAND
1887 }' received response payload: ${JSON.stringify(response)}`,
1889 responseCallback(commandPayload
, requestPayload
);
1892 private handleErrorMessage(errorResponse
: ErrorResponse
): void {
1893 const [messageType
, messageId
, errorType
, errorMessage
, errorDetails
] = errorResponse
;
1894 if (this.requests
.has(messageId
) === false) {
1896 throw new OCPPError(
1897 ErrorType
.INTERNAL_ERROR
,
1898 `Error response for unknown message id ${messageId}`,
1900 { errorType
, errorMessage
, errorDetails
},
1903 const [, errorCallback
, requestCommandName
] = this.getCachedRequest(messageType
, messageId
)!;
1905 `${this.logPrefix()} << Command '${
1906 requestCommandName ?? Constants.UNKNOWN_COMMAND
1907 }' received error response payload: ${JSON.stringify(errorResponse)}`,
1909 errorCallback(new OCPPError(errorType
, errorMessage
, requestCommandName
, errorDetails
));
1912 private async onMessage(data
: RawData
): Promise
<void> {
1913 let request
: IncomingRequest
| Response
| ErrorResponse
| undefined;
1914 let messageType
: number | undefined;
1915 let errorMsg
: string;
1917 // eslint-disable-next-line @typescript-eslint/no-base-to-string
1918 request
= JSON
.parse(data
.toString()) as IncomingRequest
| Response
| ErrorResponse
;
1919 if (Array.isArray(request
) === true) {
1920 [messageType
] = request
;
1921 // Check the type of message
1922 switch (messageType
) {
1924 case MessageType
.CALL_MESSAGE
:
1925 await this.handleIncomingMessage(request
as IncomingRequest
);
1928 case MessageType
.CALL_RESULT_MESSAGE
:
1929 this.handleResponseMessage(request
as Response
);
1932 case MessageType
.CALL_ERROR_MESSAGE
:
1933 this.handleErrorMessage(request
as ErrorResponse
);
1937 // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
1938 errorMsg
= `Wrong message type ${messageType}`;
1939 logger
.error(`${this.logPrefix()} ${errorMsg}`);
1940 throw new OCPPError(ErrorType
.PROTOCOL_ERROR
, errorMsg
);
1942 parentPort
?.postMessage(buildUpdatedMessage(this));
1944 throw new OCPPError(
1945 ErrorType
.PROTOCOL_ERROR
,
1946 'Incoming message is not an array',
1954 let commandName
: IncomingRequestCommand
| undefined;
1955 let requestCommandName
: RequestCommand
| IncomingRequestCommand
| undefined;
1956 let errorCallback
: ErrorCallback
;
1957 const [, messageId
] = request
!;
1958 switch (messageType
) {
1959 case MessageType
.CALL_MESSAGE
:
1960 [, , commandName
] = request
as IncomingRequest
;
1962 await this.ocppRequestService
.sendError(this, messageId
, error
as OCPPError
, commandName
);
1964 case MessageType
.CALL_RESULT_MESSAGE
:
1965 case MessageType
.CALL_ERROR_MESSAGE
:
1966 if (this.requests
.has(messageId
) === true) {
1967 [, errorCallback
, requestCommandName
] = this.getCachedRequest(messageType
, messageId
)!;
1968 // Reject the deferred promise in case of error at response handling (rejecting an already fulfilled promise is a no-op)
1969 errorCallback(error
as OCPPError
, false);
1971 // Remove the request from the cache in case of error at response handling
1972 this.requests
.delete(messageId
);
1976 if (error
instanceof OCPPError
=== false) {
1978 `${this.logPrefix()} Error thrown at incoming OCPP command '${
1979 commandName ?? requestCommandName ?? Constants.UNKNOWN_COMMAND
1980 // eslint-disable-next-line @typescript-eslint/no-base-to-string
1981 }' message '${data.toString()}' handling is not an OCPPError:`,
1986 `${this.logPrefix()} Incoming OCPP command '${
1987 commandName ?? requestCommandName ?? Constants.UNKNOWN_COMMAND
1988 // eslint-disable-next-line @typescript-eslint/no-base-to-string
1989 }' message '${data.toString()}'${
1990 messageType !== MessageType.CALL_MESSAGE
1991 ? ` matching cached request
'${JSON.stringify(this.requests.get(messageId))}'`
1993 } processing error:`,
1999 private onPing(): void {
2000 logger
.debug(`${this.logPrefix()} Received a WS ping (rfc6455) from the server`);
2003 private onPong(): void {
2004 logger
.debug(`${this.logPrefix()} Received a WS pong (rfc6455) from the server`);
2007 private onError(error
: WSError
): void {
2008 this.closeWSConnection();
2009 logger
.error(`${this.logPrefix()} WebSocket error:`, error
);
2012 private getEnergyActiveImportRegister(connectorStatus
: ConnectorStatus
, rounded
= false): number {
2013 if (this.getMeteringPerTransaction() === true) {
2016 ? Math.round(connectorStatus
.transactionEnergyActiveImportRegisterValue
!)
2017 : connectorStatus
?.transactionEnergyActiveImportRegisterValue
) ?? 0
2022 ? Math.round(connectorStatus
.energyActiveImportRegisterValue
!)
2023 : connectorStatus
?.energyActiveImportRegisterValue
) ?? 0
2027 private getUseConnectorId0(stationTemplate
?: ChargingStationTemplate
): boolean {
2028 return stationTemplate
?.useConnectorId0
?? true;
2031 private async stopRunningTransactions(reason
= StopTransactionReason
.NONE
): Promise
<void> {
2032 if (this.hasEvses
) {
2033 for (const [evseId
, evseStatus
] of this.evses
) {
2037 for (const [connectorId
, connectorStatus
] of evseStatus
.connectors
) {
2038 if (connectorStatus
.transactionStarted
=== true) {
2039 await this.stopTransactionOnConnector(connectorId
, reason
);
2044 for (const connectorId
of this.connectors
.keys()) {
2045 if (connectorId
> 0 && this.getConnectorStatus(connectorId
)?.transactionStarted
=== true) {
2046 await this.stopTransactionOnConnector(connectorId
, reason
);
2053 private getConnectionTimeout(): number {
2054 if (getConfigurationKey(this, StandardParametersKey
.ConnectionTimeOut
)) {
2056 parseInt(getConfigurationKey(this, StandardParametersKey
.ConnectionTimeOut
)!.value
!) ??
2057 Constants
.DEFAULT_CONNECTION_TIMEOUT
2060 return Constants
.DEFAULT_CONNECTION_TIMEOUT
;
2063 // -1 for unlimited, 0 for disabling
2064 private getAutoReconnectMaxRetries(): number | undefined {
2065 return this.stationInfo
.autoReconnectMaxRetries
?? -1;
2068 // -1 for unlimited, 0 for disabling
2069 private getRegistrationMaxRetries(): number | undefined {
2070 return this.stationInfo
.registrationMaxRetries
?? -1;
2073 private getPowerDivider(): number {
2074 let powerDivider
= this.hasEvses
? this.getNumberOfEvses() : this.getNumberOfConnectors();
2075 if (this.stationInfo
?.powerSharedByConnectors
) {
2076 powerDivider
= this.getNumberOfRunningTransactions();
2078 return powerDivider
;
2081 private getMaximumAmperage(stationInfo
: ChargingStationInfo
): number | undefined {
2082 const maximumPower
= this.getMaximumPower(stationInfo
);
2083 switch (this.getCurrentOutType(stationInfo
)) {
2084 case CurrentType
.AC
:
2085 return ACElectricUtils
.amperagePerPhaseFromPower(
2086 this.getNumberOfPhases(stationInfo
),
2087 maximumPower
/ (this.hasEvses
? this.getNumberOfEvses() : this.getNumberOfConnectors()),
2088 this.getVoltageOut(stationInfo
),
2090 case CurrentType
.DC
:
2091 return DCElectricUtils
.amperage(maximumPower
, this.getVoltageOut(stationInfo
));
2095 private getAmperageLimitation(): number | undefined {
2097 isNotEmptyString(this.stationInfo
?.amperageLimitationOcppKey
) &&
2098 getConfigurationKey(this, this.stationInfo
.amperageLimitationOcppKey
!)
2102 getConfigurationKey(this, this.stationInfo
.amperageLimitationOcppKey
!)?.value
,
2103 ) / getAmperageLimitationUnitDivider(this.stationInfo
)
2108 private async startMessageSequence(): Promise
<void> {
2109 if (this.stationInfo
?.autoRegister
=== true) {
2110 await this.ocppRequestService
.requestHandler
<
2111 BootNotificationRequest
,
2112 BootNotificationResponse
2113 >(this, RequestCommand
.BOOT_NOTIFICATION
, this.bootNotificationRequest
, {
2114 skipBufferingOnError
: true,
2117 // Start WebSocket ping
2118 this.startWebSocketPing();
2120 this.startHeartbeat();
2121 // Initialize connectors status
2122 if (this.hasEvses
) {
2123 for (const [evseId
, evseStatus
] of this.evses
) {
2125 for (const [connectorId
, connectorStatus
] of evseStatus
.connectors
) {
2126 const connectorBootStatus
= getBootConnectorStatus(this, connectorId
, connectorStatus
);
2127 await OCPPServiceUtils
.sendAndSetConnectorStatus(
2130 connectorBootStatus
,
2137 for (const connectorId
of this.connectors
.keys()) {
2138 if (connectorId
> 0) {
2139 const connectorBootStatus
= getBootConnectorStatus(
2142 this.getConnectorStatus(connectorId
)!,
2144 await OCPPServiceUtils
.sendAndSetConnectorStatus(this, connectorId
, connectorBootStatus
);
2148 if (this.stationInfo
?.firmwareStatus
=== FirmwareStatus
.Installing
) {
2149 await this.ocppRequestService
.requestHandler
<
2150 FirmwareStatusNotificationRequest
,
2151 FirmwareStatusNotificationResponse
2152 >(this, RequestCommand
.FIRMWARE_STATUS_NOTIFICATION
, {
2153 status: FirmwareStatus
.Installed
,
2155 this.stationInfo
.firmwareStatus
= FirmwareStatus
.Installed
;
2159 if (this.getAutomaticTransactionGeneratorConfiguration()?.enable
=== true) {
2160 this.startAutomaticTransactionGenerator();
2162 this.wsConnectionRestarted
=== true && this.flushMessageBuffer();
2165 private async stopMessageSequence(
2166 reason
: StopTransactionReason
= StopTransactionReason
.NONE
,
2168 // Stop WebSocket ping
2169 this.stopWebSocketPing();
2171 this.stopHeartbeat();
2172 // Stop ongoing transactions
2173 if (this.automaticTransactionGenerator
?.started
=== true) {
2174 this.stopAutomaticTransactionGenerator();
2176 await this.stopRunningTransactions(reason
);
2178 if (this.hasEvses
) {
2179 for (const [evseId
, evseStatus
] of this.evses
) {
2181 for (const [connectorId
, connectorStatus
] of evseStatus
.connectors
) {
2182 await this.ocppRequestService
.requestHandler
<
2183 StatusNotificationRequest
,
2184 StatusNotificationResponse
2187 RequestCommand
.STATUS_NOTIFICATION
,
2188 OCPPServiceUtils
.buildStatusNotificationRequest(
2191 ConnectorStatusEnum
.Unavailable
,
2195 delete connectorStatus
?.status;
2200 for (const connectorId
of this.connectors
.keys()) {
2201 if (connectorId
> 0) {
2202 await this.ocppRequestService
.requestHandler
<
2203 StatusNotificationRequest
,
2204 StatusNotificationResponse
2207 RequestCommand
.STATUS_NOTIFICATION
,
2208 OCPPServiceUtils
.buildStatusNotificationRequest(
2211 ConnectorStatusEnum
.Unavailable
,
2214 delete this.getConnectorStatus(connectorId
)?.status;
2220 private startWebSocketPing(): void {
2221 const webSocketPingInterval
: number = getConfigurationKey(
2223 StandardParametersKey
.WebSocketPingInterval
,
2225 ? convertToInt(getConfigurationKey(this, StandardParametersKey
.WebSocketPingInterval
)?.value
)
2227 if (webSocketPingInterval
> 0 && !this.webSocketPingSetInterval
) {
2228 this.webSocketPingSetInterval
= setInterval(() => {
2229 if (this.isWebSocketConnectionOpened() === true) {
2230 this.wsConnection
?.ping();
2232 }, secondsToMilliseconds(webSocketPingInterval
));
2234 `${this.logPrefix()} WebSocket ping started every ${formatDurationSeconds(
2235 webSocketPingInterval,
2238 } else if (this.webSocketPingSetInterval
) {
2240 `${this.logPrefix()} WebSocket ping already started every ${formatDurationSeconds(
2241 webSocketPingInterval,
2246 `${this.logPrefix()} WebSocket ping interval set to ${webSocketPingInterval}, not starting the WebSocket ping`,
2251 private stopWebSocketPing(): void {
2252 if (this.webSocketPingSetInterval
) {
2253 clearInterval(this.webSocketPingSetInterval
);
2254 delete this.webSocketPingSetInterval
;
2258 private getConfiguredSupervisionUrl(): URL
{
2259 let configuredSupervisionUrl
: string;
2260 const supervisionUrls
= this.stationInfo
?.supervisionUrls
?? Configuration
.getSupervisionUrls();
2261 if (isNotEmptyArray(supervisionUrls
)) {
2262 let configuredSupervisionUrlIndex
: number;
2263 switch (Configuration
.getSupervisionUrlDistribution()) {
2264 case SupervisionUrlDistribution
.RANDOM
:
2265 configuredSupervisionUrlIndex
= Math.floor(
2266 secureRandom() * (supervisionUrls
as string[]).length
,
2269 case SupervisionUrlDistribution
.ROUND_ROBIN
:
2270 case SupervisionUrlDistribution
.CHARGING_STATION_AFFINITY
:
2272 Object.values(SupervisionUrlDistribution
).includes(
2273 Configuration
.getSupervisionUrlDistribution()!,
2276 // eslint-disable-next-line @typescript-eslint/no-base-to-string
2277 `${this.logPrefix()} Unknown supervision url distribution '${Configuration.getSupervisionUrlDistribution()}' from values '${SupervisionUrlDistribution.toString()}', defaulting to ${
2278 SupervisionUrlDistribution.CHARGING_STATION_AFFINITY
2281 configuredSupervisionUrlIndex
= (this.index
- 1) % (supervisionUrls
as string[]).length
;
2284 configuredSupervisionUrl
= (supervisionUrls
as string[])[configuredSupervisionUrlIndex
];
2286 configuredSupervisionUrl
= supervisionUrls
as string;
2288 if (isNotEmptyString(configuredSupervisionUrl
)) {
2289 return new URL(configuredSupervisionUrl
);
2291 const errorMsg
= 'No supervision url(s) configured';
2292 logger
.error(`${this.logPrefix()} ${errorMsg}`);
2293 throw new BaseError(`${errorMsg}`);
2296 private stopHeartbeat(): void {
2297 if (this.heartbeatSetInterval
) {
2298 clearInterval(this.heartbeatSetInterval
);
2299 delete this.heartbeatSetInterval
;
2303 private terminateWSConnection(): void {
2304 if (this.isWebSocketConnectionOpened() === true) {
2305 this.wsConnection
?.terminate();
2306 this.wsConnection
= null;
2310 private getReconnectExponentialDelay(): boolean {
2311 return this.stationInfo
?.reconnectExponentialDelay
?? false;
2314 private async reconnect(): Promise
<void> {
2315 // Stop WebSocket ping
2316 this.stopWebSocketPing();
2318 this.stopHeartbeat();
2319 // Stop the ATG if needed
2320 if (this.getAutomaticTransactionGeneratorConfiguration().stopOnConnectionFailure
=== true) {
2321 this.stopAutomaticTransactionGenerator();
2324 this.autoReconnectRetryCount
< this.getAutoReconnectMaxRetries()! ||
2325 this.getAutoReconnectMaxRetries() === -1
2327 ++this.autoReconnectRetryCount
;
2328 const reconnectDelay
= this.getReconnectExponentialDelay()
2329 ? exponentialDelay(this.autoReconnectRetryCount
)
2330 : secondsToMilliseconds(this.getConnectionTimeout());
2331 const reconnectDelayWithdraw
= 1000;
2332 const reconnectTimeout
=
2333 reconnectDelay
&& reconnectDelay
- reconnectDelayWithdraw
> 0
2334 ? reconnectDelay
- reconnectDelayWithdraw
2337 `${this.logPrefix()} WebSocket connection retry in ${roundTo(
2340 )}ms, timeout ${reconnectTimeout}ms`,
2342 await sleep(reconnectDelay
);
2344 `${this.logPrefix()} WebSocket connection retry #${this.autoReconnectRetryCount.toString()}`,
2346 this.openWSConnection(
2348 handshakeTimeout
: reconnectTimeout
,
2350 { closeOpened
: true },
2352 this.wsConnectionRestarted
= true;
2353 } else if (this.getAutoReconnectMaxRetries() !== -1) {
2355 `${this.logPrefix()} WebSocket connection retries failure: maximum retries reached (${
2356 this.autoReconnectRetryCount
2357 }) or retries disabled (${this.getAutoReconnectMaxRetries()})`,