1 // Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
3 import crypto from
'crypto';
5 import path from
'path';
6 import { URL
} from
'url';
7 import { parentPort
} from
'worker_threads';
9 import WebSocket
, { Data
, RawData
} from
'ws';
11 import BaseError from
'../exception/BaseError';
12 import OCPPError from
'../exception/OCPPError';
13 import PerformanceStatistics from
'../performance/PerformanceStatistics';
14 import type { AutomaticTransactionGeneratorConfiguration
} from
'../types/AutomaticTransactionGenerator';
15 import type { ChargingStationConfiguration
} from
'../types/ChargingStationConfiguration';
16 import type { ChargingStationInfo
} from
'../types/ChargingStationInfo';
17 import type { ChargingStationOcppConfiguration
} from
'../types/ChargingStationOcppConfiguration';
19 type ChargingStationTemplate
,
23 } from
'../types/ChargingStationTemplate';
24 import { SupervisionUrlDistribution
} from
'../types/ConfigurationData';
25 import type { ConnectorStatus
} from
'../types/ConnectorStatus';
26 import { FileType
} from
'../types/FileType';
27 import type { JsonType
} from
'../types/JsonType';
28 import { ChargePointErrorCode
} from
'../types/ocpp/ChargePointErrorCode';
29 import { ChargePointStatus
} from
'../types/ocpp/ChargePointStatus';
30 import { ChargingProfile
, ChargingRateUnitType
} from
'../types/ocpp/ChargingProfile';
32 ConnectorPhaseRotation
,
33 StandardParametersKey
,
34 SupportedFeatureProfiles
,
35 VendorDefaultParametersKey
,
36 } from
'../types/ocpp/Configuration';
37 import { ErrorType
} from
'../types/ocpp/ErrorType';
38 import { MessageType
} from
'../types/ocpp/MessageType';
39 import { MeterValue
, MeterValueMeasurand
} from
'../types/ocpp/MeterValues';
40 import { OCPPVersion
} from
'../types/ocpp/OCPPVersion';
43 BootNotificationRequest
,
48 IncomingRequestCommand
,
52 StatusNotificationRequest
,
53 } from
'../types/ocpp/Requests';
55 BootNotificationResponse
,
61 StatusNotificationResponse
,
62 } from
'../types/ocpp/Responses';
64 StopTransactionReason
,
65 StopTransactionRequest
,
66 StopTransactionResponse
,
67 } from
'../types/ocpp/Transaction';
68 import { WSError
, WebSocketCloseEventStatusCode
} from
'../types/WebSocket';
69 import Configuration from
'../utils/Configuration';
70 import Constants from
'../utils/Constants';
71 import { ACElectricUtils
, DCElectricUtils
} from
'../utils/ElectricUtils';
72 import FileUtils from
'../utils/FileUtils';
73 import logger from
'../utils/Logger';
74 import Utils from
'../utils/Utils';
75 import AuthorizedTagsCache from
'./AuthorizedTagsCache';
76 import AutomaticTransactionGenerator from
'./AutomaticTransactionGenerator';
77 import { ChargingStationConfigurationUtils
} from
'./ChargingStationConfigurationUtils';
78 import { ChargingStationUtils
} from
'./ChargingStationUtils';
79 import ChargingStationWorkerBroadcastChannel from
'./ChargingStationWorkerBroadcastChannel';
80 import { MessageChannelUtils
} from
'./MessageChannelUtils';
81 import OCPP16IncomingRequestService from
'./ocpp/1.6/OCPP16IncomingRequestService';
82 import OCPP16RequestService from
'./ocpp/1.6/OCPP16RequestService';
83 import OCPP16ResponseService from
'./ocpp/1.6/OCPP16ResponseService';
84 import { OCPP16ServiceUtils
} from
'./ocpp/1.6/OCPP16ServiceUtils';
85 import type OCPPIncomingRequestService from
'./ocpp/OCPPIncomingRequestService';
86 import type OCPPRequestService from
'./ocpp/OCPPRequestService';
87 import SharedLRUCache from
'./SharedLRUCache';
89 export default class ChargingStation
{
90 public readonly index
: number;
91 public readonly templateFile
: string;
92 public stationInfo
!: ChargingStationInfo
;
93 public started
: boolean;
94 public starting
: boolean;
95 public authorizedTagsCache
: AuthorizedTagsCache
;
96 public automaticTransactionGenerator
!: AutomaticTransactionGenerator
;
97 public ocppConfiguration
!: ChargingStationOcppConfiguration
;
98 public wsConnection
!: WebSocket
;
99 public readonly connectors
: Map
<number, ConnectorStatus
>;
100 public readonly requests
: Map
<string, CachedRequest
>;
101 public performanceStatistics
!: PerformanceStatistics
;
102 public heartbeatSetInterval
!: NodeJS
.Timeout
;
103 public ocppRequestService
!: OCPPRequestService
;
104 public bootNotificationRequest
!: BootNotificationRequest
;
105 public bootNotificationResponse
!: BootNotificationResponse
| null;
106 public powerDivider
!: number;
107 private stopping
: boolean;
108 private configurationFile
!: string;
109 private configurationFileHash
!: string;
110 private connectorsConfigurationHash
!: string;
111 private ocppIncomingRequestService
!: OCPPIncomingRequestService
;
112 private readonly messageBuffer
: Set
<string>;
113 private configuredSupervisionUrl
!: URL
;
114 private configuredSupervisionUrlIndex
!: number;
115 private wsConnectionRestarted
: boolean;
116 private autoReconnectRetryCount
: number;
117 private templateFileWatcher
!: fs
.FSWatcher
;
118 private readonly sharedLRUCache
: SharedLRUCache
;
119 private webSocketPingSetInterval
!: NodeJS
.Timeout
;
120 private readonly chargingStationWorkerBroadcastChannel
: ChargingStationWorkerBroadcastChannel
;
122 constructor(index
: number, templateFile
: string) {
123 this.started
= false;
124 this.starting
= false;
125 this.stopping
= false;
126 this.wsConnectionRestarted
= false;
127 this.autoReconnectRetryCount
= 0;
129 this.templateFile
= templateFile
;
130 this.connectors
= new Map
<number, ConnectorStatus
>();
131 this.requests
= new Map
<string, CachedRequest
>();
132 this.messageBuffer
= new Set
<string>();
133 this.sharedLRUCache
= SharedLRUCache
.getInstance();
134 this.authorizedTagsCache
= AuthorizedTagsCache
.getInstance();
135 this.chargingStationWorkerBroadcastChannel
= new ChargingStationWorkerBroadcastChannel(this);
140 private get
wsConnectionUrl(): URL
{
142 (this.getSupervisionUrlOcppConfiguration()
143 ? ChargingStationConfigurationUtils
.getConfigurationKey(
145 this.getSupervisionUrlOcppKey()
147 : this.configuredSupervisionUrl
.href
) +
149 this.stationInfo
.chargingStationId
153 public logPrefix(): string {
154 return Utils
.logPrefix(
156 this?.stationInfo?.chargingStationId ??
157 ChargingStationUtils.getChargingStationId(this.index, this.getTemplateFromFile())
162 public hasAuthorizedTags(): boolean {
163 return !Utils
.isEmptyArray(
164 this.authorizedTagsCache
.getAuthorizedTags(
165 ChargingStationUtils
.getAuthorizationFile(this.stationInfo
)
170 public getEnableStatistics(): boolean | undefined {
171 return !Utils
.isUndefined(this.stationInfo
.enableStatistics
)
172 ? this.stationInfo
.enableStatistics
176 public getMustAuthorizeAtRemoteStart(): boolean | undefined {
177 return this.stationInfo
.mustAuthorizeAtRemoteStart
?? true;
180 public getPayloadSchemaValidation(): boolean | undefined {
181 return this.stationInfo
.payloadSchemaValidation
?? true;
184 public getNumberOfPhases(stationInfo
?: ChargingStationInfo
): number | undefined {
185 const localStationInfo
: ChargingStationInfo
= stationInfo
?? this.stationInfo
;
186 switch (this.getCurrentOutType(stationInfo
)) {
188 return !Utils
.isUndefined(localStationInfo
.numberOfPhases
)
189 ? localStationInfo
.numberOfPhases
196 public isWebSocketConnectionOpened(): boolean {
197 return this?.wsConnection
?.readyState
=== WebSocket
.OPEN
;
200 public getRegistrationStatus(): RegistrationStatus
{
201 return this?.bootNotificationResponse
?.status;
204 public isInUnknownState(): boolean {
205 return Utils
.isNullOrUndefined(this?.bootNotificationResponse
?.status);
208 public isInPendingState(): boolean {
209 return this?.bootNotificationResponse
?.status === RegistrationStatus
.PENDING
;
212 public isInAcceptedState(): boolean {
213 return this?.bootNotificationResponse
?.status === RegistrationStatus
.ACCEPTED
;
216 public isInRejectedState(): boolean {
217 return this?.bootNotificationResponse
?.status === RegistrationStatus
.REJECTED
;
220 public isRegistered(): boolean {
222 this.isInUnknownState() === false &&
223 (this.isInAcceptedState() === true || this.isInPendingState() === true)
227 public isChargingStationAvailable(): boolean {
228 return this.getConnectorStatus(0).availability
=== AvailabilityType
.OPERATIVE
;
231 public isConnectorAvailable(id
: number): boolean {
232 return id
> 0 && this.getConnectorStatus(id
).availability
=== AvailabilityType
.OPERATIVE
;
235 public getNumberOfConnectors(): number {
236 return this.connectors
.get(0) ? this.connectors
.size
- 1 : this.connectors
.size
;
239 public getConnectorStatus(id
: number): ConnectorStatus
| undefined {
240 return this.connectors
.get(id
);
243 public getCurrentOutType(stationInfo
?: ChargingStationInfo
): CurrentType
{
244 return (stationInfo
?? this.stationInfo
).currentOutType
?? CurrentType
.AC
;
247 public getOcppStrictCompliance(): boolean {
248 return this.stationInfo
?.ocppStrictCompliance
?? false;
251 public getVoltageOut(stationInfo
?: ChargingStationInfo
): number | undefined {
252 const defaultVoltageOut
= ChargingStationUtils
.getDefaultVoltageOut(
253 this.getCurrentOutType(stationInfo
),
257 const localStationInfo
: ChargingStationInfo
= stationInfo
?? this.stationInfo
;
258 return !Utils
.isUndefined(localStationInfo
.voltageOut
)
259 ? localStationInfo
.voltageOut
263 public getConnectorMaximumAvailablePower(connectorId
: number): number {
264 let connectorAmperageLimitationPowerLimit
: number;
266 !Utils
.isNullOrUndefined(this.getAmperageLimitation()) &&
267 this.getAmperageLimitation() < this.stationInfo
.maximumAmperage
269 connectorAmperageLimitationPowerLimit
=
270 (this.getCurrentOutType() === CurrentType
.AC
271 ? ACElectricUtils
.powerTotal(
272 this.getNumberOfPhases(),
273 this.getVoltageOut(),
274 this.getAmperageLimitation() * this.getNumberOfConnectors()
276 : DCElectricUtils
.power(this.getVoltageOut(), this.getAmperageLimitation())) /
279 const connectorMaximumPower
= this.getMaximumPower() / this.powerDivider
;
280 const connectorChargingProfilePowerLimit
= this.getChargingProfilePowerLimit(connectorId
);
282 isNaN(connectorMaximumPower
) ? Infinity : connectorMaximumPower
,
283 isNaN(connectorAmperageLimitationPowerLimit
)
285 : connectorAmperageLimitationPowerLimit
,
286 isNaN(connectorChargingProfilePowerLimit
) ? Infinity : connectorChargingProfilePowerLimit
290 public getTransactionIdTag(transactionId
: number): string | undefined {
291 for (const connectorId
of this.connectors
.keys()) {
292 if (connectorId
> 0 && this.getConnectorStatus(connectorId
).transactionId
=== transactionId
) {
293 return this.getConnectorStatus(connectorId
).transactionIdTag
;
298 public getOutOfOrderEndMeterValues(): boolean {
299 return this.stationInfo
?.outOfOrderEndMeterValues
?? false;
302 public getBeginEndMeterValues(): boolean {
303 return this.stationInfo
?.beginEndMeterValues
?? false;
306 public getMeteringPerTransaction(): boolean {
307 return this.stationInfo
?.meteringPerTransaction
?? true;
310 public getTransactionDataMeterValues(): boolean {
311 return this.stationInfo
?.transactionDataMeterValues
?? false;
314 public getMainVoltageMeterValues(): boolean {
315 return this.stationInfo
?.mainVoltageMeterValues
?? true;
318 public getPhaseLineToLineVoltageMeterValues(): boolean {
319 return this.stationInfo
?.phaseLineToLineVoltageMeterValues
?? false;
322 public getCustomValueLimitationMeterValues(): boolean {
323 return this.stationInfo
?.customValueLimitationMeterValues
?? true;
326 public getConnectorIdByTransactionId(transactionId
: number): number | undefined {
327 for (const connectorId
of this.connectors
.keys()) {
330 this.getConnectorStatus(connectorId
)?.transactionId
=== transactionId
337 public getEnergyActiveImportRegisterByTransactionId(
338 transactionId
: number,
341 return this.getEnergyActiveImportRegister(
342 this.getConnectorStatus(this.getConnectorIdByTransactionId(transactionId
)),
347 public getEnergyActiveImportRegisterByConnectorId(connectorId
: number): number {
348 return this.getEnergyActiveImportRegister(this.getConnectorStatus(connectorId
));
351 public getAuthorizeRemoteTxRequests(): boolean {
352 const authorizeRemoteTxRequests
= ChargingStationConfigurationUtils
.getConfigurationKey(
354 StandardParametersKey
.AuthorizeRemoteTxRequests
356 return authorizeRemoteTxRequests
357 ? Utils
.convertToBoolean(authorizeRemoteTxRequests
.value
)
361 public getLocalAuthListEnabled(): boolean {
362 const localAuthListEnabled
= ChargingStationConfigurationUtils
.getConfigurationKey(
364 StandardParametersKey
.LocalAuthListEnabled
366 return localAuthListEnabled
? Utils
.convertToBoolean(localAuthListEnabled
.value
) : false;
369 public startHeartbeat(): void {
371 this.getHeartbeatInterval() &&
372 this.getHeartbeatInterval() > 0 &&
373 !this.heartbeatSetInterval
375 // eslint-disable-next-line @typescript-eslint/no-misused-promises
376 this.heartbeatSetInterval
= setInterval(async (): Promise
<void> => {
377 await this.ocppRequestService
.requestHandler
<HeartbeatRequest
, HeartbeatResponse
>(
379 RequestCommand
.HEARTBEAT
381 }, this.getHeartbeatInterval());
384 ' Heartbeat started every ' +
385 Utils
.formatDurationMilliSeconds(this.getHeartbeatInterval())
387 } else if (this.heartbeatSetInterval
) {
390 ' Heartbeat already started every ' +
391 Utils
.formatDurationMilliSeconds(this.getHeartbeatInterval())
395 `${this.logPrefix()} Heartbeat interval set to ${
396 this.getHeartbeatInterval()
397 ? Utils.formatDurationMilliSeconds(this.getHeartbeatInterval())
398 : this.getHeartbeatInterval()
399 }, not starting the heartbeat`
404 public restartHeartbeat(): void {
406 this.stopHeartbeat();
408 this.startHeartbeat();
411 public restartWebSocketPing(): void {
412 // Stop WebSocket ping
413 this.stopWebSocketPing();
414 // Start WebSocket ping
415 this.startWebSocketPing();
418 public startMeterValues(connectorId
: number, interval
: number): void {
419 if (connectorId
=== 0) {
421 `${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId.toString()}`
425 if (!this.getConnectorStatus(connectorId
)) {
427 `${this.logPrefix()} Trying to start MeterValues on non existing connector Id ${connectorId.toString()}`
431 if (this.getConnectorStatus(connectorId
)?.transactionStarted
=== false) {
433 `${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction started`
437 this.getConnectorStatus(connectorId
)?.transactionStarted
=== true &&
438 !this.getConnectorStatus(connectorId
)?.transactionId
441 `${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction id`
446 // eslint-disable-next-line @typescript-eslint/no-misused-promises
447 this.getConnectorStatus(connectorId
).transactionSetInterval
= setInterval(
448 // eslint-disable-next-line @typescript-eslint/no-misused-promises
449 async (): Promise
<void> => {
450 // FIXME: Implement OCPP version agnostic helpers
451 const meterValue
: MeterValue
= OCPP16ServiceUtils
.buildMeterValue(
454 this.getConnectorStatus(connectorId
).transactionId
,
457 await this.ocppRequestService
.requestHandler
<MeterValuesRequest
, MeterValuesResponse
>(
459 RequestCommand
.METER_VALUES
,
462 transactionId
: this.getConnectorStatus(connectorId
).transactionId
,
463 meterValue
: [meterValue
],
471 `${this.logPrefix()} Charging station ${
472 StandardParametersKey.MeterValueSampleInterval
473 } configuration set to ${
474 interval ? Utils.formatDurationMilliSeconds(interval) : interval
475 }, not sending MeterValues`
480 public start(): void {
481 if (this.started
=== false) {
482 if (this.starting
=== false) {
483 this.starting
= true;
484 if (this.getEnableStatistics()) {
485 this.performanceStatistics
.start();
487 this.openWSConnection();
488 // Monitor charging station template file
489 this.templateFileWatcher
= FileUtils
.watchJsonFile(
491 FileType
.ChargingStationTemplate
,
494 (event
, filename
): void => {
495 if (filename
&& event
=== 'change') {
498 `${this.logPrefix()} ${FileType.ChargingStationTemplate} ${
500 } file have changed, reload`
502 this.sharedLRUCache
.deleteChargingStationTemplate(this.stationInfo
?.templateHash
);
506 this.stopAutomaticTransactionGenerator();
508 this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable
=== true
510 this.startAutomaticTransactionGenerator();
512 if (this.getEnableStatistics()) {
513 this.performanceStatistics
.restart();
515 this.performanceStatistics
.stop();
517 // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed
520 `${this.logPrefix()} ${FileType.ChargingStationTemplate} file monitoring error:`,
528 parentPort
.postMessage(MessageChannelUtils
.buildStartedMessage(this));
529 this.starting
= false;
531 logger
.warn(`${this.logPrefix()} Charging station is already starting...`);
534 logger
.warn(`${this.logPrefix()} Charging station is already started...`);
538 public async stop(reason
?: StopTransactionReason
): Promise
<void> {
539 if (this.started
=== true) {
540 if (this.stopping
=== false) {
541 this.stopping
= true;
542 await this.stopMessageSequence(reason
);
543 this.closeWSConnection();
544 if (this.getEnableStatistics()) {
545 this.performanceStatistics
.stop();
547 this.sharedLRUCache
.deleteChargingStationConfiguration(this.configurationFileHash
);
548 this.templateFileWatcher
.close();
549 this.sharedLRUCache
.deleteChargingStationTemplate(this.stationInfo
?.templateHash
);
550 this.bootNotificationResponse
= null;
551 this.started
= false;
552 parentPort
.postMessage(MessageChannelUtils
.buildStoppedMessage(this));
553 this.stopping
= false;
555 logger
.warn(`${this.logPrefix()} Charging station is already stopping...`);
558 logger
.warn(`${this.logPrefix()} Charging station is already stopped...`);
562 public async reset(reason
?: StopTransactionReason
): Promise
<void> {
563 await this.stop(reason
);
564 await Utils
.sleep(this.stationInfo
.resetTime
);
569 public saveOcppConfiguration(): void {
570 if (this.getOcppPersistentConfiguration()) {
571 this.saveConfiguration();
575 public resetConnectorStatus(connectorId
: number): void {
576 this.getConnectorStatus(connectorId
).idTagLocalAuthorized
= false;
577 this.getConnectorStatus(connectorId
).idTagAuthorized
= false;
578 this.getConnectorStatus(connectorId
).transactionRemoteStarted
= false;
579 this.getConnectorStatus(connectorId
).transactionStarted
= false;
580 delete this.getConnectorStatus(connectorId
).localAuthorizeIdTag
;
581 delete this.getConnectorStatus(connectorId
).authorizeIdTag
;
582 delete this.getConnectorStatus(connectorId
).transactionId
;
583 delete this.getConnectorStatus(connectorId
).transactionIdTag
;
584 this.getConnectorStatus(connectorId
).transactionEnergyActiveImportRegisterValue
= 0;
585 delete this.getConnectorStatus(connectorId
).transactionBeginMeterValue
;
586 this.stopMeterValues(connectorId
);
587 parentPort
.postMessage(MessageChannelUtils
.buildUpdatedMessage(this));
590 public hasFeatureProfile(featureProfile
: SupportedFeatureProfiles
): boolean {
591 return ChargingStationConfigurationUtils
.getConfigurationKey(
593 StandardParametersKey
.SupportedFeatureProfiles
594 )?.value
.includes(featureProfile
);
597 public bufferMessage(message
: string): void {
598 this.messageBuffer
.add(message
);
601 public openWSConnection(
602 options
: WsOptions
= this.stationInfo
?.wsOptions
?? {},
603 params
: { closeOpened
?: boolean; terminateOpened
?: boolean } = {
605 terminateOpened
: false,
608 options
.handshakeTimeout
= options
?.handshakeTimeout
?? this.getConnectionTimeout() * 1000;
609 params
.closeOpened
= params
?.closeOpened
?? false;
610 params
.terminateOpened
= params
?.terminateOpened
?? false;
611 if (this.started
=== false && this.starting
=== false) {
613 `${this.logPrefix()} Cannot open OCPP connection to URL ${this.wsConnectionUrl.toString()} on stopped charging station`
618 !Utils
.isNullOrUndefined(this.stationInfo
.supervisionUser
) &&
619 !Utils
.isNullOrUndefined(this.stationInfo
.supervisionPassword
)
621 options
.auth
= `${this.stationInfo.supervisionUser}:${this.stationInfo.supervisionPassword}`;
623 if (params
?.closeOpened
) {
624 this.closeWSConnection();
626 if (params
?.terminateOpened
) {
627 this.terminateWSConnection();
629 let protocol
: string;
630 switch (this.getOcppVersion()) {
631 case OCPPVersion
.VERSION_16
:
632 protocol
= 'ocpp' + OCPPVersion
.VERSION_16
;
635 this.handleUnsupportedVersion(this.getOcppVersion());
639 if (this.isWebSocketConnectionOpened() === true) {
641 `${this.logPrefix()} OCPP connection to URL ${this.wsConnectionUrl.toString()} is already opened`
647 `${this.logPrefix()} Open OCPP connection to URL ${this.wsConnectionUrl.toString()}`
650 this.wsConnection
= new WebSocket(this.wsConnectionUrl
, protocol
, options
);
652 // Handle WebSocket message
653 this.wsConnection
.on(
655 this.onMessage
.bind(this) as (this: WebSocket
, data
: RawData
, isBinary
: boolean) => void
657 // Handle WebSocket error
658 this.wsConnection
.on(
660 this.onError
.bind(this) as (this: WebSocket
, error
: Error) => void
662 // Handle WebSocket close
663 this.wsConnection
.on(
665 this.onClose
.bind(this) as (this: WebSocket
, code
: number, reason
: Buffer
) => void
667 // Handle WebSocket open
668 this.wsConnection
.on('open', this.onOpen
.bind(this) as (this: WebSocket
) => void);
669 // Handle WebSocket ping
670 this.wsConnection
.on('ping', this.onPing
.bind(this) as (this: WebSocket
, data
: Buffer
) => void);
671 // Handle WebSocket pong
672 this.wsConnection
.on('pong', this.onPong
.bind(this) as (this: WebSocket
, data
: Buffer
) => void);
675 public closeWSConnection(): void {
676 if (this.isWebSocketConnectionOpened() === true) {
677 this.wsConnection
.close();
678 this.wsConnection
= null;
682 public startAutomaticTransactionGenerator(
683 connectorIds
?: number[],
684 automaticTransactionGeneratorConfiguration
?: AutomaticTransactionGeneratorConfiguration
686 this.automaticTransactionGenerator
= AutomaticTransactionGenerator
.getInstance(
687 automaticTransactionGeneratorConfiguration
??
688 this.getAutomaticTransactionGeneratorConfigurationFromTemplate(),
691 if (!Utils
.isEmptyArray(connectorIds
)) {
692 for (const connectorId
of connectorIds
) {
693 this.automaticTransactionGenerator
.startConnector(connectorId
);
696 this.automaticTransactionGenerator
.start();
698 parentPort
.postMessage(MessageChannelUtils
.buildUpdatedMessage(this));
701 public stopAutomaticTransactionGenerator(connectorIds
?: number[]): void {
702 if (!Utils
.isEmptyArray(connectorIds
)) {
703 for (const connectorId
of connectorIds
) {
704 this.automaticTransactionGenerator
?.stopConnector(connectorId
);
707 this.automaticTransactionGenerator
?.stop();
709 parentPort
.postMessage(MessageChannelUtils
.buildUpdatedMessage(this));
712 public async stopTransactionOnConnector(
714 reason
= StopTransactionReason
.NONE
715 ): Promise
<StopTransactionResponse
> {
716 const transactionId
= this.getConnectorStatus(connectorId
).transactionId
;
718 this.getBeginEndMeterValues() === true &&
719 this.getOcppStrictCompliance() === true &&
720 this.getOutOfOrderEndMeterValues() === false
722 // FIXME: Implement OCPP version agnostic helpers
723 const transactionEndMeterValue
= OCPP16ServiceUtils
.buildTransactionEndMeterValue(
726 this.getEnergyActiveImportRegisterByTransactionId(transactionId
)
728 await this.ocppRequestService
.requestHandler
<MeterValuesRequest
, MeterValuesResponse
>(
730 RequestCommand
.METER_VALUES
,
734 meterValue
: [transactionEndMeterValue
],
738 return this.ocppRequestService
.requestHandler
<StopTransactionRequest
, StopTransactionResponse
>(
740 RequestCommand
.STOP_TRANSACTION
,
743 meterStop
: this.getEnergyActiveImportRegisterByTransactionId(transactionId
, true),
749 private flushMessageBuffer(): void {
750 if (this.messageBuffer
.size
> 0) {
751 this.messageBuffer
.forEach((message
) => {
752 // TODO: evaluate the need to track performance
753 this.wsConnection
.send(message
);
754 this.messageBuffer
.delete(message
);
759 private getSupervisionUrlOcppConfiguration(): boolean {
760 return this.stationInfo
.supervisionUrlOcppConfiguration
?? false;
763 private getSupervisionUrlOcppKey(): string {
764 return this.stationInfo
.supervisionUrlOcppKey
?? VendorDefaultParametersKey
.ConnectionUrl
;
767 private getTemplateFromFile(): ChargingStationTemplate
| null {
768 let template
: ChargingStationTemplate
= null;
770 if (this.sharedLRUCache
.hasChargingStationTemplate(this.stationInfo
?.templateHash
)) {
771 template
= this.sharedLRUCache
.getChargingStationTemplate(this.stationInfo
.templateHash
);
773 const measureId
= `${FileType.ChargingStationTemplate} read`;
774 const beginId
= PerformanceStatistics
.beginMeasure(measureId
);
775 template
= JSON
.parse(
776 fs
.readFileSync(this.templateFile
, 'utf8')
777 ) as ChargingStationTemplate
;
778 PerformanceStatistics
.endMeasure(measureId
, beginId
);
779 template
.templateHash
= crypto
780 .createHash(Constants
.DEFAULT_HASH_ALGORITHM
)
781 .update(JSON
.stringify(template
))
783 this.sharedLRUCache
.setChargingStationTemplate(template
);
786 FileUtils
.handleFileException(
788 FileType
.ChargingStationTemplate
,
790 error
as NodeJS
.ErrnoException
796 private getStationInfoFromTemplate(): ChargingStationInfo
{
797 const stationTemplate
: ChargingStationTemplate
= this.getTemplateFromFile();
798 if (Utils
.isNullOrUndefined(stationTemplate
)) {
799 const errorMsg
= 'Failed to read charging station template file';
800 logger
.error(`${this.logPrefix()} ${errorMsg}`);
801 throw new BaseError(errorMsg
);
803 if (Utils
.isEmptyObject(stationTemplate
)) {
804 const errorMsg
= `Empty charging station information from template file ${this.templateFile}`;
805 logger
.error(`${this.logPrefix()} ${errorMsg}`);
806 throw new BaseError(errorMsg
);
808 // Deprecation template keys section
809 ChargingStationUtils
.warnDeprecatedTemplateKey(
814 "Use 'supervisionUrls' instead"
816 ChargingStationUtils
.convertDeprecatedTemplateKey(
821 const stationInfo
: ChargingStationInfo
=
822 ChargingStationUtils
.stationTemplateToStationInfo(stationTemplate
);
823 stationInfo
.hashId
= ChargingStationUtils
.getHashId(this.index
, stationTemplate
);
824 stationInfo
.chargingStationId
= ChargingStationUtils
.getChargingStationId(
828 ChargingStationUtils
.createSerialNumber(stationTemplate
, stationInfo
);
829 if (!Utils
.isEmptyArray(stationTemplate
.power
)) {
830 stationTemplate
.power
= stationTemplate
.power
as number[];
831 const powerArrayRandomIndex
= Math.floor(Utils
.secureRandom() * stationTemplate
.power
.length
);
832 stationInfo
.maximumPower
=
833 stationTemplate
.powerUnit
=== PowerUnits
.KILO_WATT
834 ? stationTemplate
.power
[powerArrayRandomIndex
] * 1000
835 : stationTemplate
.power
[powerArrayRandomIndex
];
837 stationTemplate
.power
= stationTemplate
.power
as number;
838 stationInfo
.maximumPower
=
839 stationTemplate
.powerUnit
=== PowerUnits
.KILO_WATT
840 ? stationTemplate
.power
* 1000
841 : stationTemplate
.power
;
843 stationInfo
.resetTime
= stationTemplate
.resetTime
844 ? stationTemplate
.resetTime
* 1000
845 : Constants
.CHARGING_STATION_DEFAULT_RESET_TIME
;
846 const configuredMaxConnectors
=
847 ChargingStationUtils
.getConfiguredNumberOfConnectors(stationTemplate
);
848 ChargingStationUtils
.checkConfiguredMaxConnectors(
849 configuredMaxConnectors
,
853 const templateMaxConnectors
=
854 ChargingStationUtils
.getTemplateMaxNumberOfConnectors(stationTemplate
);
855 ChargingStationUtils
.checkTemplateMaxConnectors(
856 templateMaxConnectors
,
861 configuredMaxConnectors
>
862 (stationTemplate
?.Connectors
[0] ? templateMaxConnectors
- 1 : templateMaxConnectors
) &&
863 !stationTemplate
?.randomConnectors
866 `${this.logPrefix()} Number of connectors exceeds the number of connector configurations in template ${
868 }, forcing random connector configurations affectation`
870 stationInfo
.randomConnectors
= true;
872 // Build connectors if needed (FIXME: should be factored out)
873 this.initializeConnectors(stationInfo
, configuredMaxConnectors
, templateMaxConnectors
);
874 stationInfo
.maximumAmperage
= this.getMaximumAmperage(stationInfo
);
875 ChargingStationUtils
.createStationInfoHash(stationInfo
);
879 private getStationInfoFromFile(): ChargingStationInfo
| null {
880 let stationInfo
: ChargingStationInfo
= null;
881 this.getStationInfoPersistentConfiguration() &&
882 (stationInfo
= this.getConfigurationFromFile()?.stationInfo
?? null);
883 stationInfo
&& ChargingStationUtils
.createStationInfoHash(stationInfo
);
887 private getStationInfo(): ChargingStationInfo
{
888 const stationInfoFromTemplate
: ChargingStationInfo
= this.getStationInfoFromTemplate();
889 const stationInfoFromFile
: ChargingStationInfo
= this.getStationInfoFromFile();
890 // Priority: charging station info from template > charging station info from configuration file > charging station info attribute
891 if (stationInfoFromFile
?.templateHash
=== stationInfoFromTemplate
.templateHash
) {
892 if (this.stationInfo
?.infoHash
=== stationInfoFromFile
?.infoHash
) {
893 return this.stationInfo
;
895 return stationInfoFromFile
;
897 stationInfoFromFile
&&
898 ChargingStationUtils
.propagateSerialNumber(
899 this.getTemplateFromFile(),
901 stationInfoFromTemplate
903 return stationInfoFromTemplate
;
906 private saveStationInfo(): void {
907 if (this.getStationInfoPersistentConfiguration()) {
908 this.saveConfiguration();
912 private getOcppVersion(): OCPPVersion
{
913 return this.stationInfo
.ocppVersion
?? OCPPVersion
.VERSION_16
;
916 private getOcppPersistentConfiguration(): boolean {
917 return this.stationInfo
?.ocppPersistentConfiguration
?? true;
920 private getStationInfoPersistentConfiguration(): boolean {
921 return this.stationInfo
?.stationInfoPersistentConfiguration
?? true;
924 private handleUnsupportedVersion(version
: OCPPVersion
) {
925 const errMsg
= `Unsupported protocol version '${version}' configured in template file ${this.templateFile}`;
926 logger
.error(`${this.logPrefix()} ${errMsg}`);
927 throw new BaseError(errMsg
);
930 private initialize(): void {
931 this.configurationFile
= path
.join(
932 path
.dirname(this.templateFile
.replace('station-templates', 'configurations')),
933 ChargingStationUtils
.getHashId(this.index
, this.getTemplateFromFile()) + '.json'
935 this.stationInfo
= this.getStationInfo();
936 this.saveStationInfo();
937 // Avoid duplication of connectors related information in RAM
938 this.stationInfo
?.Connectors
&& delete this.stationInfo
.Connectors
;
939 this.configuredSupervisionUrl
= this.getConfiguredSupervisionUrl();
940 if (this.getEnableStatistics()) {
941 this.performanceStatistics
= PerformanceStatistics
.getInstance(
942 this.stationInfo
.hashId
,
943 this.stationInfo
.chargingStationId
,
944 this.configuredSupervisionUrl
947 this.bootNotificationRequest
= ChargingStationUtils
.createBootNotificationRequest(
950 this.powerDivider
= this.getPowerDivider();
951 // OCPP configuration
952 this.ocppConfiguration
= this.getOcppConfiguration();
953 this.initializeOcppConfiguration();
954 switch (this.getOcppVersion()) {
955 case OCPPVersion
.VERSION_16
:
956 this.ocppIncomingRequestService
=
957 OCPP16IncomingRequestService
.getInstance
<OCPP16IncomingRequestService
>();
958 this.ocppRequestService
= OCPP16RequestService
.getInstance
<OCPP16RequestService
>(
959 OCPP16ResponseService
.getInstance
<OCPP16ResponseService
>()
963 this.handleUnsupportedVersion(this.getOcppVersion());
966 if (this.stationInfo
?.autoRegister
=== true) {
967 this.bootNotificationResponse
= {
968 currentTime
: new Date().toISOString(),
969 interval
: this.getHeartbeatInterval() / 1000,
970 status: RegistrationStatus
.ACCEPTED
,
975 private initializeOcppConfiguration(): void {
977 !ChargingStationConfigurationUtils
.getConfigurationKey(
979 StandardParametersKey
.HeartbeatInterval
982 ChargingStationConfigurationUtils
.addConfigurationKey(
984 StandardParametersKey
.HeartbeatInterval
,
989 !ChargingStationConfigurationUtils
.getConfigurationKey(
991 StandardParametersKey
.HeartBeatInterval
994 ChargingStationConfigurationUtils
.addConfigurationKey(
996 StandardParametersKey
.HeartBeatInterval
,
1002 this.getSupervisionUrlOcppConfiguration() &&
1003 !ChargingStationConfigurationUtils
.getConfigurationKey(this, this.getSupervisionUrlOcppKey())
1005 ChargingStationConfigurationUtils
.addConfigurationKey(
1007 this.getSupervisionUrlOcppKey(),
1008 this.configuredSupervisionUrl
.href
,
1012 !this.getSupervisionUrlOcppConfiguration() &&
1013 ChargingStationConfigurationUtils
.getConfigurationKey(this, this.getSupervisionUrlOcppKey())
1015 ChargingStationConfigurationUtils
.deleteConfigurationKey(
1017 this.getSupervisionUrlOcppKey(),
1022 this.stationInfo
.amperageLimitationOcppKey
&&
1023 !ChargingStationConfigurationUtils
.getConfigurationKey(
1025 this.stationInfo
.amperageLimitationOcppKey
1028 ChargingStationConfigurationUtils
.addConfigurationKey(
1030 this.stationInfo
.amperageLimitationOcppKey
,
1032 this.stationInfo
.maximumAmperage
*
1033 ChargingStationUtils
.getAmperageLimitationUnitDivider(this.stationInfo
)
1038 !ChargingStationConfigurationUtils
.getConfigurationKey(
1040 StandardParametersKey
.SupportedFeatureProfiles
1043 ChargingStationConfigurationUtils
.addConfigurationKey(
1045 StandardParametersKey
.SupportedFeatureProfiles
,
1046 `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.FirmwareManagement},${SupportedFeatureProfiles.LocalAuthListManagement},${SupportedFeatureProfiles.SmartCharging},${SupportedFeatureProfiles.RemoteTrigger}`
1049 ChargingStationConfigurationUtils
.addConfigurationKey(
1051 StandardParametersKey
.NumberOfConnectors
,
1052 this.getNumberOfConnectors().toString(),
1057 !ChargingStationConfigurationUtils
.getConfigurationKey(
1059 StandardParametersKey
.MeterValuesSampledData
1062 ChargingStationConfigurationUtils
.addConfigurationKey(
1064 StandardParametersKey
.MeterValuesSampledData
,
1065 MeterValueMeasurand
.ENERGY_ACTIVE_IMPORT_REGISTER
1069 !ChargingStationConfigurationUtils
.getConfigurationKey(
1071 StandardParametersKey
.ConnectorPhaseRotation
1074 const connectorPhaseRotation
= [];
1075 for (const connectorId
of this.connectors
.keys()) {
1077 if (connectorId
=== 0 && this.getNumberOfPhases() === 0) {
1078 connectorPhaseRotation
.push(`${connectorId}.${ConnectorPhaseRotation.RST}`);
1079 } else if (connectorId
> 0 && this.getNumberOfPhases() === 0) {
1080 connectorPhaseRotation
.push(`${connectorId}.${ConnectorPhaseRotation.NotApplicable}`);
1082 } else if (connectorId
> 0 && this.getNumberOfPhases() === 1) {
1083 connectorPhaseRotation
.push(`${connectorId}.${ConnectorPhaseRotation.NotApplicable}`);
1084 } else if (connectorId
> 0 && this.getNumberOfPhases() === 3) {
1085 connectorPhaseRotation
.push(`${connectorId}.${ConnectorPhaseRotation.RST}`);
1088 ChargingStationConfigurationUtils
.addConfigurationKey(
1090 StandardParametersKey
.ConnectorPhaseRotation
,
1091 connectorPhaseRotation
.toString()
1095 !ChargingStationConfigurationUtils
.getConfigurationKey(
1097 StandardParametersKey
.AuthorizeRemoteTxRequests
1100 ChargingStationConfigurationUtils
.addConfigurationKey(
1102 StandardParametersKey
.AuthorizeRemoteTxRequests
,
1107 !ChargingStationConfigurationUtils
.getConfigurationKey(
1109 StandardParametersKey
.LocalAuthListEnabled
1111 ChargingStationConfigurationUtils
.getConfigurationKey(
1113 StandardParametersKey
.SupportedFeatureProfiles
1114 )?.value
.includes(SupportedFeatureProfiles
.LocalAuthListManagement
)
1116 ChargingStationConfigurationUtils
.addConfigurationKey(
1118 StandardParametersKey
.LocalAuthListEnabled
,
1123 !ChargingStationConfigurationUtils
.getConfigurationKey(
1125 StandardParametersKey
.ConnectionTimeOut
1128 ChargingStationConfigurationUtils
.addConfigurationKey(
1130 StandardParametersKey
.ConnectionTimeOut
,
1131 Constants
.DEFAULT_CONNECTION_TIMEOUT
.toString()
1134 this.saveOcppConfiguration();
1137 private initializeConnectors(
1138 stationInfo
: ChargingStationInfo
,
1139 configuredMaxConnectors
: number,
1140 templateMaxConnectors
: number
1142 if (!stationInfo
?.Connectors
&& this.connectors
.size
=== 0) {
1143 const logMsg
= `No already defined connectors and charging station information from template ${this.templateFile} with no connectors configuration defined`;
1144 logger
.error(`${this.logPrefix()} ${logMsg}`);
1145 throw new BaseError(logMsg
);
1147 if (!stationInfo
?.Connectors
[0]) {
1149 `${this.logPrefix()} Charging station information from template ${
1151 } with no connector Id 0 configuration`
1154 if (stationInfo
?.Connectors
) {
1155 const connectorsConfigHash
= crypto
1156 .createHash(Constants
.DEFAULT_HASH_ALGORITHM
)
1157 .update(JSON
.stringify(stationInfo
?.Connectors
) + configuredMaxConnectors
.toString())
1159 const connectorsConfigChanged
=
1160 this.connectors
?.size
!== 0 && this.connectorsConfigurationHash
!== connectorsConfigHash
;
1161 if (this.connectors
?.size
=== 0 || connectorsConfigChanged
) {
1162 connectorsConfigChanged
&& this.connectors
.clear();
1163 this.connectorsConfigurationHash
= connectorsConfigHash
;
1164 // Add connector Id 0
1165 let lastConnector
= '0';
1166 for (lastConnector
in stationInfo
?.Connectors
) {
1167 const connectorStatus
= stationInfo
?.Connectors
[lastConnector
];
1168 const lastConnectorId
= Utils
.convertToInt(lastConnector
);
1170 lastConnectorId
=== 0 &&
1171 this.getUseConnectorId0(stationInfo
) === true &&
1174 this.checkStationInfoConnectorStatus(lastConnectorId
, connectorStatus
);
1175 this.connectors
.set(
1177 Utils
.cloneObject
<ConnectorStatus
>(connectorStatus
)
1179 this.getConnectorStatus(lastConnectorId
).availability
= AvailabilityType
.OPERATIVE
;
1180 if (Utils
.isUndefined(this.getConnectorStatus(lastConnectorId
)?.chargingProfiles
)) {
1181 this.getConnectorStatus(lastConnectorId
).chargingProfiles
= [];
1185 // Generate all connectors
1186 if ((stationInfo
?.Connectors
[0] ? templateMaxConnectors
- 1 : templateMaxConnectors
) > 0) {
1187 for (let index
= 1; index
<= configuredMaxConnectors
; index
++) {
1188 const randConnectorId
= stationInfo
?.randomConnectors
1189 ? Utils
.getRandomInteger(Utils
.convertToInt(lastConnector
), 1)
1191 const connectorStatus
= stationInfo
?.Connectors
[randConnectorId
.toString()];
1192 this.checkStationInfoConnectorStatus(randConnectorId
, connectorStatus
);
1193 this.connectors
.set(index
, Utils
.cloneObject
<ConnectorStatus
>(connectorStatus
));
1194 this.getConnectorStatus(index
).availability
= AvailabilityType
.OPERATIVE
;
1195 if (Utils
.isUndefined(this.getConnectorStatus(index
)?.chargingProfiles
)) {
1196 this.getConnectorStatus(index
).chargingProfiles
= [];
1203 `${this.logPrefix()} Charging station information from template ${
1205 } with no connectors configuration defined, using already defined connectors`
1208 // Initialize transaction attributes on connectors
1209 for (const connectorId
of this.connectors
.keys()) {
1210 if (connectorId
> 0 && this.getConnectorStatus(connectorId
).transactionStarted
=== true) {
1212 `${this.logPrefix()} Connector ${connectorId} at initialization has a transaction started: ${
1213 this.getConnectorStatus(connectorId).transactionId
1219 (this.getConnectorStatus(connectorId
).transactionStarted
=== undefined ||
1220 this.getConnectorStatus(connectorId
).transactionStarted
=== null)
1222 this.initializeConnectorStatus(connectorId
);
1227 private checkStationInfoConnectorStatus(
1228 connectorId
: number,
1229 connectorStatus
: ConnectorStatus
1231 if (!Utils
.isNullOrUndefined(connectorStatus
?.status)) {
1233 `${this.logPrefix()} Charging station information from template ${
1235 } with connector ${connectorId} status configuration defined, undefine it`
1237 connectorStatus
.status = undefined;
1241 private getConfigurationFromFile(): ChargingStationConfiguration
| null {
1242 let configuration
: ChargingStationConfiguration
= null;
1243 if (this.configurationFile
&& fs
.existsSync(this.configurationFile
)) {
1245 if (this.sharedLRUCache
.hasChargingStationConfiguration(this.configurationFileHash
)) {
1246 configuration
= this.sharedLRUCache
.getChargingStationConfiguration(
1247 this.configurationFileHash
1250 const measureId
= `${FileType.ChargingStationConfiguration} read`;
1251 const beginId
= PerformanceStatistics
.beginMeasure(measureId
);
1252 configuration
= JSON
.parse(
1253 fs
.readFileSync(this.configurationFile
, 'utf8')
1254 ) as ChargingStationConfiguration
;
1255 PerformanceStatistics
.endMeasure(measureId
, beginId
);
1256 this.configurationFileHash
= configuration
.configurationHash
;
1257 this.sharedLRUCache
.setChargingStationConfiguration(configuration
);
1260 FileUtils
.handleFileException(
1262 FileType
.ChargingStationConfiguration
,
1263 this.configurationFile
,
1264 error
as NodeJS
.ErrnoException
1268 return configuration
;
1271 private saveConfiguration(): void {
1272 if (this.configurationFile
) {
1274 if (!fs
.existsSync(path
.dirname(this.configurationFile
))) {
1275 fs
.mkdirSync(path
.dirname(this.configurationFile
), { recursive
: true });
1277 const configurationData
: ChargingStationConfiguration
=
1278 this.getConfigurationFromFile() ?? {};
1279 this.ocppConfiguration
?.configurationKey
&&
1280 (configurationData
.configurationKey
= this.ocppConfiguration
.configurationKey
);
1281 this.stationInfo
&& (configurationData
.stationInfo
= this.stationInfo
);
1282 delete configurationData
.configurationHash
;
1283 const configurationHash
= crypto
1284 .createHash(Constants
.DEFAULT_HASH_ALGORITHM
)
1285 .update(JSON
.stringify(configurationData
))
1287 if (this.configurationFileHash
!== configurationHash
) {
1288 configurationData
.configurationHash
= configurationHash
;
1289 const measureId
= `${FileType.ChargingStationConfiguration} write`;
1290 const beginId
= PerformanceStatistics
.beginMeasure(measureId
);
1291 const fileDescriptor
= fs
.openSync(this.configurationFile
, 'w');
1292 fs
.writeFileSync(fileDescriptor
, JSON
.stringify(configurationData
, null, 2), 'utf8');
1293 fs
.closeSync(fileDescriptor
);
1294 PerformanceStatistics
.endMeasure(measureId
, beginId
);
1295 this.sharedLRUCache
.deleteChargingStationConfiguration(this.configurationFileHash
);
1296 this.configurationFileHash
= configurationHash
;
1297 this.sharedLRUCache
.setChargingStationConfiguration(configurationData
);
1300 `${this.logPrefix()} Not saving unchanged charging station configuration file ${
1301 this.configurationFile
1306 FileUtils
.handleFileException(
1308 FileType
.ChargingStationConfiguration
,
1309 this.configurationFile
,
1310 error
as NodeJS
.ErrnoException
1315 `${this.logPrefix()} Trying to save charging station configuration to undefined configuration file`
1320 private getOcppConfigurationFromTemplate(): ChargingStationOcppConfiguration
| null {
1321 return this.getTemplateFromFile()?.Configuration
?? null;
1324 private getOcppConfigurationFromFile(): ChargingStationOcppConfiguration
| null {
1325 let configuration
: ChargingStationConfiguration
= null;
1326 if (this.getOcppPersistentConfiguration() === true) {
1327 const configurationFromFile
= this.getConfigurationFromFile();
1328 configuration
= configurationFromFile
?.configurationKey
&& configurationFromFile
;
1330 configuration
&& delete configuration
.stationInfo
;
1331 return configuration
;
1334 private getOcppConfiguration(): ChargingStationOcppConfiguration
| null {
1335 let ocppConfiguration
: ChargingStationOcppConfiguration
= this.getOcppConfigurationFromFile();
1336 if (!ocppConfiguration
) {
1337 ocppConfiguration
= this.getOcppConfigurationFromTemplate();
1339 return ocppConfiguration
;
1342 private async onOpen(): Promise
<void> {
1343 if (this.isWebSocketConnectionOpened() === true) {
1345 `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} succeeded`
1347 if (this.isRegistered() === false) {
1348 // Send BootNotification
1349 let registrationRetryCount
= 0;
1351 this.bootNotificationResponse
= await this.ocppRequestService
.requestHandler
<
1352 BootNotificationRequest
,
1353 BootNotificationResponse
1354 >(this, RequestCommand
.BOOT_NOTIFICATION
, this.bootNotificationRequest
, {
1355 skipBufferingOnError
: true,
1357 if (this.isRegistered() === false) {
1358 this.getRegistrationMaxRetries() !== -1 && registrationRetryCount
++;
1360 this.bootNotificationResponse
?.interval
1361 ? this.bootNotificationResponse
.interval
* 1000
1362 : Constants
.OCPP_DEFAULT_BOOT_NOTIFICATION_INTERVAL
1366 this.isRegistered() === false &&
1367 (registrationRetryCount
<= this.getRegistrationMaxRetries() ||
1368 this.getRegistrationMaxRetries() === -1)
1371 if (this.isRegistered() === true) {
1372 if (this.isInAcceptedState() === true) {
1373 await this.startMessageSequence();
1377 `${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})`
1380 this.wsConnectionRestarted
= false;
1381 this.autoReconnectRetryCount
= 0;
1382 parentPort
.postMessage(MessageChannelUtils
.buildUpdatedMessage(this));
1385 `${this.logPrefix()} Connection to OCPP server through ${this.wsConnectionUrl.toString()} failed`
1390 private async onClose(code
: number, reason
: string): Promise
<void> {
1393 case WebSocketCloseEventStatusCode
.CLOSE_NORMAL
:
1394 case WebSocketCloseEventStatusCode
.CLOSE_NO_STATUS
:
1396 `${this.logPrefix()} WebSocket normally closed with status '${Utils.getWebSocketCloseEventStatusString(
1398 )}' and reason '${reason}'`
1400 this.autoReconnectRetryCount
= 0;
1405 `${this.logPrefix()} WebSocket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString(
1407 )}' and reason '${reason}'`
1409 this.started
=== true && (await this.reconnect());
1412 parentPort
.postMessage(MessageChannelUtils
.buildUpdatedMessage(this));
1415 private async onMessage(data
: Data
): Promise
<void> {
1416 let messageType
: number;
1417 let messageId
: string;
1418 let commandName
: IncomingRequestCommand
;
1419 let commandPayload
: JsonType
;
1420 let errorType
: ErrorType
;
1421 let errorMessage
: string;
1422 let errorDetails
: JsonType
;
1423 let responseCallback
: ResponseCallback
;
1424 let errorCallback
: ErrorCallback
;
1425 let requestCommandName
: RequestCommand
| IncomingRequestCommand
;
1426 let requestPayload
: JsonType
;
1427 let cachedRequest
: CachedRequest
;
1430 const request
= JSON
.parse(data
.toString()) as IncomingRequest
| Response
| ErrorResponse
;
1431 if (Array.isArray(request
) === true) {
1432 [messageType
, messageId
] = request
;
1433 // Check the type of message
1434 switch (messageType
) {
1436 case MessageType
.CALL_MESSAGE
:
1437 [, , commandName
, commandPayload
] = request
as IncomingRequest
;
1438 if (this.getEnableStatistics() === true) {
1439 this.performanceStatistics
.addRequestStatistic(commandName
, messageType
);
1442 `${this.logPrefix()} << Command '${commandName}' received request payload: ${JSON.stringify(
1446 // Process the message
1447 await this.ocppIncomingRequestService
.incomingRequestHandler(
1455 case MessageType
.CALL_RESULT_MESSAGE
:
1456 [, , commandPayload
] = request
as Response
;
1457 if (this.requests
.has(messageId
) === false) {
1459 throw new OCPPError(
1460 ErrorType
.INTERNAL_ERROR
,
1461 `Response for unknown message id ${messageId}`,
1467 cachedRequest
= this.requests
.get(messageId
);
1468 if (Array.isArray(cachedRequest
) === true) {
1469 [responseCallback
, errorCallback
, requestCommandName
, requestPayload
] = cachedRequest
;
1471 throw new OCPPError(
1472 ErrorType
.PROTOCOL_ERROR
,
1473 `Cached request for message id ${messageId} response is not an array`,
1475 cachedRequest
as unknown
as JsonType
1479 `${this.logPrefix()} << Command '${
1480 requestCommandName ?? Constants.UNKNOWN_COMMAND
1481 }' received response payload: ${JSON.stringify(request)}`
1483 responseCallback(commandPayload
, requestPayload
);
1486 case MessageType
.CALL_ERROR_MESSAGE
:
1487 [, , errorType
, errorMessage
, errorDetails
] = request
as ErrorResponse
;
1488 if (this.requests
.has(messageId
) === false) {
1490 throw new OCPPError(
1491 ErrorType
.INTERNAL_ERROR
,
1492 `Error response for unknown message id ${messageId}`,
1494 { errorType
, errorMessage
, errorDetails
}
1497 cachedRequest
= this.requests
.get(messageId
);
1498 if (Array.isArray(cachedRequest
) === true) {
1499 [, errorCallback
, requestCommandName
] = cachedRequest
;
1501 throw new OCPPError(
1502 ErrorType
.PROTOCOL_ERROR
,
1503 `Cached request for message id ${messageId} error response is not an array`,
1505 cachedRequest
as unknown
as JsonType
1509 `${this.logPrefix()} << Command '${
1510 requestCommandName ?? Constants.UNKNOWN_COMMAND
1511 }' received error payload: ${JSON.stringify(request)}`
1513 errorCallback(new OCPPError(errorType
, errorMessage
, requestCommandName
, errorDetails
));
1517 // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
1518 errMsg
= `Wrong message type ${messageType}`;
1519 logger
.error(`${this.logPrefix()} ${errMsg}`);
1520 throw new OCPPError(ErrorType
.PROTOCOL_ERROR
, errMsg
);
1522 parentPort
.postMessage(MessageChannelUtils
.buildUpdatedMessage(this));
1524 throw new OCPPError(ErrorType
.PROTOCOL_ERROR
, 'Incoming message is not an array', null, {
1531 `${this.logPrefix()} Incoming OCPP command '${
1532 commandName ?? requestCommandName ?? Constants.UNKNOWN_COMMAND
1533 }' message '${data.toString()}'${
1534 messageType !== MessageType.CALL_MESSAGE
1535 ? ` matching cached request
'${JSON.stringify(this.requests.get(messageId))}'`
1537 } processing error:`,
1540 if (error
instanceof OCPPError
=== false) {
1542 `${this.logPrefix()} Error thrown at incoming OCPP command '${
1543 commandName ?? requestCommandName ?? Constants.UNKNOWN_COMMAND
1544 }' message '${data.toString()}' handling is not an OCPPError:`,
1548 switch (messageType
) {
1549 case MessageType
.CALL_MESSAGE
:
1551 await this.ocppRequestService
.sendError(
1555 commandName
?? requestCommandName
?? null
1558 case MessageType
.CALL_RESULT_MESSAGE
:
1559 case MessageType
.CALL_ERROR_MESSAGE
:
1560 if (errorCallback
) {
1561 // Reject the deferred promise in case of error at response handling (rejecting an already fulfilled promise is a no-op)
1562 errorCallback(error
as OCPPError
, false);
1564 // Remove the request from the cache in case of error at response handling
1565 this.requests
.delete(messageId
);
1572 private onPing(): void {
1573 logger
.debug(this.logPrefix() + ' Received a WS ping (rfc6455) from the server');
1576 private onPong(): void {
1577 logger
.debug(this.logPrefix() + ' Received a WS pong (rfc6455) from the server');
1580 private onError(error
: WSError
): void {
1581 this.closeWSConnection();
1582 logger
.error(this.logPrefix() + ' WebSocket error:', error
);
1585 private getEnergyActiveImportRegister(
1586 connectorStatus
: ConnectorStatus
,
1589 if (this.getMeteringPerTransaction() === true) {
1592 ? Math.round(connectorStatus
?.transactionEnergyActiveImportRegisterValue
)
1593 : connectorStatus
?.transactionEnergyActiveImportRegisterValue
) ?? 0
1598 ? Math.round(connectorStatus
?.energyActiveImportRegisterValue
)
1599 : connectorStatus
?.energyActiveImportRegisterValue
) ?? 0
1603 private getUseConnectorId0(stationInfo
?: ChargingStationInfo
): boolean {
1604 const localStationInfo
= stationInfo
?? this.stationInfo
;
1605 return !Utils
.isUndefined(localStationInfo
.useConnectorId0
)
1606 ? localStationInfo
.useConnectorId0
1610 private getNumberOfRunningTransactions(): number {
1612 for (const connectorId
of this.connectors
.keys()) {
1613 if (connectorId
> 0 && this.getConnectorStatus(connectorId
)?.transactionStarted
=== true) {
1620 private async stopRunningTransactions(reason
= StopTransactionReason
.NONE
): Promise
<void> {
1621 for (const connectorId
of this.connectors
.keys()) {
1622 if (connectorId
> 0 && this.getConnectorStatus(connectorId
)?.transactionStarted
=== true) {
1623 await this.stopTransactionOnConnector(connectorId
, reason
);
1629 private getConnectionTimeout(): number {
1631 ChargingStationConfigurationUtils
.getConfigurationKey(
1633 StandardParametersKey
.ConnectionTimeOut
1638 ChargingStationConfigurationUtils
.getConfigurationKey(
1640 StandardParametersKey
.ConnectionTimeOut
1642 ) ?? Constants
.DEFAULT_CONNECTION_TIMEOUT
1645 return Constants
.DEFAULT_CONNECTION_TIMEOUT
;
1648 // -1 for unlimited, 0 for disabling
1649 private getAutoReconnectMaxRetries(): number {
1650 if (!Utils
.isUndefined(this.stationInfo
.autoReconnectMaxRetries
)) {
1651 return this.stationInfo
.autoReconnectMaxRetries
;
1653 if (!Utils
.isUndefined(Configuration
.getAutoReconnectMaxRetries())) {
1654 return Configuration
.getAutoReconnectMaxRetries();
1660 private getRegistrationMaxRetries(): number {
1661 if (!Utils
.isUndefined(this.stationInfo
.registrationMaxRetries
)) {
1662 return this.stationInfo
.registrationMaxRetries
;
1667 private getPowerDivider(): number {
1668 let powerDivider
= this.getNumberOfConnectors();
1669 if (this.stationInfo
?.powerSharedByConnectors
) {
1670 powerDivider
= this.getNumberOfRunningTransactions();
1672 return powerDivider
;
1675 private getMaximumPower(stationInfo
?: ChargingStationInfo
): number {
1676 const localStationInfo
= stationInfo
?? this.stationInfo
;
1677 return (localStationInfo
['maxPower'] as number) ?? localStationInfo
.maximumPower
;
1680 private getMaximumAmperage(stationInfo
: ChargingStationInfo
): number | undefined {
1681 const maximumPower
= this.getMaximumPower(stationInfo
);
1682 switch (this.getCurrentOutType(stationInfo
)) {
1683 case CurrentType
.AC
:
1684 return ACElectricUtils
.amperagePerPhaseFromPower(
1685 this.getNumberOfPhases(stationInfo
),
1686 maximumPower
/ this.getNumberOfConnectors(),
1687 this.getVoltageOut(stationInfo
)
1689 case CurrentType
.DC
:
1690 return DCElectricUtils
.amperage(maximumPower
, this.getVoltageOut(stationInfo
));
1694 private getAmperageLimitation(): number | undefined {
1696 this.stationInfo
.amperageLimitationOcppKey
&&
1697 ChargingStationConfigurationUtils
.getConfigurationKey(
1699 this.stationInfo
.amperageLimitationOcppKey
1704 ChargingStationConfigurationUtils
.getConfigurationKey(
1706 this.stationInfo
.amperageLimitationOcppKey
1708 ) / ChargingStationUtils
.getAmperageLimitationUnitDivider(this.stationInfo
)
1713 private getChargingProfilePowerLimit(connectorId
: number): number | undefined {
1714 let limit
: number, matchingChargingProfile
: ChargingProfile
;
1715 let chargingProfiles
: ChargingProfile
[] = [];
1716 // Get charging profiles for connector and sort by stack level
1717 chargingProfiles
= this.getConnectorStatus(connectorId
).chargingProfiles
.sort(
1718 (a
, b
) => b
.stackLevel
- a
.stackLevel
1720 // Get profiles on connector 0
1721 if (this.getConnectorStatus(0).chargingProfiles
) {
1722 chargingProfiles
.push(
1723 ...this.getConnectorStatus(0).chargingProfiles
.sort((a
, b
) => b
.stackLevel
- a
.stackLevel
)
1726 if (!Utils
.isEmptyArray(chargingProfiles
)) {
1727 const result
= ChargingStationUtils
.getLimitFromChargingProfiles(
1731 if (!Utils
.isNullOrUndefined(result
)) {
1732 limit
= result
.limit
;
1733 matchingChargingProfile
= result
.matchingChargingProfile
;
1734 switch (this.getCurrentOutType()) {
1735 case CurrentType
.AC
:
1737 matchingChargingProfile
.chargingSchedule
.chargingRateUnit
===
1738 ChargingRateUnitType
.WATT
1740 : ACElectricUtils
.powerTotal(this.getNumberOfPhases(), this.getVoltageOut(), limit
);
1742 case CurrentType
.DC
:
1744 matchingChargingProfile
.chargingSchedule
.chargingRateUnit
===
1745 ChargingRateUnitType
.WATT
1747 : DCElectricUtils
.power(this.getVoltageOut(), limit
);
1749 const connectorMaximumPower
= this.getMaximumPower() / this.powerDivider
;
1750 if (limit
> connectorMaximumPower
) {
1752 `${this.logPrefix()} Charging profile id ${
1753 matchingChargingProfile.chargingProfileId
1754 } limit is greater than connector id ${connectorId} maximum, dump charging profiles' stack: %j`,
1755 this.getConnectorStatus(connectorId
).chargingProfiles
1757 limit
= connectorMaximumPower
;
1764 private async startMessageSequence(): Promise
<void> {
1765 if (this.stationInfo
?.autoRegister
=== true) {
1766 await this.ocppRequestService
.requestHandler
<
1767 BootNotificationRequest
,
1768 BootNotificationResponse
1769 >(this, RequestCommand
.BOOT_NOTIFICATION
, this.bootNotificationRequest
, {
1770 skipBufferingOnError
: true,
1773 // Start WebSocket ping
1774 this.startWebSocketPing();
1776 this.startHeartbeat();
1777 // Initialize connectors status
1778 for (const connectorId
of this.connectors
.keys()) {
1779 let chargePointStatus
: ChargePointStatus
;
1780 if (connectorId
=== 0) {
1783 !this.getConnectorStatus(connectorId
)?.status &&
1784 (this.isChargingStationAvailable() === false ||
1785 this.isConnectorAvailable(connectorId
) === false)
1787 chargePointStatus
= ChargePointStatus
.UNAVAILABLE
;
1789 !this.getConnectorStatus(connectorId
)?.status &&
1790 this.getConnectorStatus(connectorId
)?.bootStatus
1792 // Set boot status in template at startup
1793 chargePointStatus
= this.getConnectorStatus(connectorId
).bootStatus
;
1794 } else if (this.getConnectorStatus(connectorId
)?.status) {
1795 // Set previous status at startup
1796 chargePointStatus
= this.getConnectorStatus(connectorId
).status;
1798 // Set default status
1799 chargePointStatus
= ChargePointStatus
.AVAILABLE
;
1801 await this.ocppRequestService
.requestHandler
<
1802 StatusNotificationRequest
,
1803 StatusNotificationResponse
1804 >(this, RequestCommand
.STATUS_NOTIFICATION
, {
1806 status: chargePointStatus
,
1807 errorCode
: ChargePointErrorCode
.NO_ERROR
,
1809 this.getConnectorStatus(connectorId
).status = chargePointStatus
;
1812 if (this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable
=== true) {
1813 this.startAutomaticTransactionGenerator();
1815 this.wsConnectionRestarted
=== true && this.flushMessageBuffer();
1818 private async stopMessageSequence(
1819 reason
: StopTransactionReason
= StopTransactionReason
.NONE
1821 // Stop WebSocket ping
1822 this.stopWebSocketPing();
1824 this.stopHeartbeat();
1825 // Stop ongoing transactions
1826 if (this.automaticTransactionGenerator
?.started
=== true) {
1827 this.stopAutomaticTransactionGenerator();
1829 await this.stopRunningTransactions(reason
);
1831 for (const connectorId
of this.connectors
.keys()) {
1832 if (connectorId
> 0) {
1833 await this.ocppRequestService
.requestHandler
<
1834 StatusNotificationRequest
,
1835 StatusNotificationResponse
1836 >(this, RequestCommand
.STATUS_NOTIFICATION
, {
1838 status: ChargePointStatus
.UNAVAILABLE
,
1839 errorCode
: ChargePointErrorCode
.NO_ERROR
,
1841 this.getConnectorStatus(connectorId
).status = null;
1846 private startWebSocketPing(): void {
1847 const webSocketPingInterval
: number = ChargingStationConfigurationUtils
.getConfigurationKey(
1849 StandardParametersKey
.WebSocketPingInterval
1851 ? Utils
.convertToInt(
1852 ChargingStationConfigurationUtils
.getConfigurationKey(
1854 StandardParametersKey
.WebSocketPingInterval
1858 if (webSocketPingInterval
> 0 && !this.webSocketPingSetInterval
) {
1859 this.webSocketPingSetInterval
= setInterval(() => {
1860 if (this.isWebSocketConnectionOpened() === true) {
1861 this.wsConnection
.ping();
1863 }, webSocketPingInterval
* 1000);
1866 ' WebSocket ping started every ' +
1867 Utils
.formatDurationSeconds(webSocketPingInterval
)
1869 } else if (this.webSocketPingSetInterval
) {
1872 ' WebSocket ping already started every ' +
1873 Utils
.formatDurationSeconds(webSocketPingInterval
)
1877 `${this.logPrefix()} WebSocket ping interval set to ${
1878 webSocketPingInterval
1879 ? Utils.formatDurationSeconds(webSocketPingInterval)
1880 : webSocketPingInterval
1881 }, not starting the WebSocket ping`
1886 private stopWebSocketPing(): void {
1887 if (this.webSocketPingSetInterval
) {
1888 clearInterval(this.webSocketPingSetInterval
);
1892 private getConfiguredSupervisionUrl(): URL
{
1893 const supervisionUrls
= (
1894 this.stationInfo
.supervisionUrls
?? Configuration
.getSupervisionUrls()
1896 if (!Utils
.isEmptyArray(supervisionUrls
)) {
1897 switch (Configuration
.getSupervisionUrlDistribution()) {
1898 case SupervisionUrlDistribution
.ROUND_ROBIN
:
1900 this.configuredSupervisionUrlIndex
= (this.index
- 1) % supervisionUrls
.length
;
1902 case SupervisionUrlDistribution
.RANDOM
:
1903 this.configuredSupervisionUrlIndex
= Math.floor(
1904 Utils
.secureRandom() * supervisionUrls
.length
1907 case SupervisionUrlDistribution
.CHARGING_STATION_AFFINITY
:
1908 this.configuredSupervisionUrlIndex
= (this.index
- 1) % supervisionUrls
.length
;
1912 `${this.logPrefix()} Unknown supervision url distribution '${Configuration.getSupervisionUrlDistribution()}' from values '${SupervisionUrlDistribution.toString()}', defaulting to ${
1913 SupervisionUrlDistribution.CHARGING_STATION_AFFINITY
1916 this.configuredSupervisionUrlIndex
= (this.index
- 1) % supervisionUrls
.length
;
1919 return new URL(supervisionUrls
[this.configuredSupervisionUrlIndex
]);
1921 return new URL(supervisionUrls
as string);
1924 private getHeartbeatInterval(): number {
1925 const HeartbeatInterval
= ChargingStationConfigurationUtils
.getConfigurationKey(
1927 StandardParametersKey
.HeartbeatInterval
1929 if (HeartbeatInterval
) {
1930 return Utils
.convertToInt(HeartbeatInterval
.value
) * 1000;
1932 const HeartBeatInterval
= ChargingStationConfigurationUtils
.getConfigurationKey(
1934 StandardParametersKey
.HeartBeatInterval
1936 if (HeartBeatInterval
) {
1937 return Utils
.convertToInt(HeartBeatInterval
.value
) * 1000;
1939 this.stationInfo
?.autoRegister
=== false &&
1941 `${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${
1942 Constants.DEFAULT_HEARTBEAT_INTERVAL
1945 return Constants
.DEFAULT_HEARTBEAT_INTERVAL
;
1948 private stopHeartbeat(): void {
1949 if (this.heartbeatSetInterval
) {
1950 clearInterval(this.heartbeatSetInterval
);
1954 private terminateWSConnection(): void {
1955 if (this.isWebSocketConnectionOpened() === true) {
1956 this.wsConnection
.terminate();
1957 this.wsConnection
= null;
1961 private stopMeterValues(connectorId
: number) {
1962 if (this.getConnectorStatus(connectorId
)?.transactionSetInterval
) {
1963 clearInterval(this.getConnectorStatus(connectorId
).transactionSetInterval
);
1967 private getReconnectExponentialDelay(): boolean {
1968 return !Utils
.isUndefined(this.stationInfo
.reconnectExponentialDelay
)
1969 ? this.stationInfo
.reconnectExponentialDelay
1973 private async reconnect(): Promise
<void> {
1974 // Stop WebSocket ping
1975 this.stopWebSocketPing();
1977 this.stopHeartbeat();
1978 // Stop the ATG if needed
1979 if (this.automaticTransactionGenerator
?.configuration
?.stopOnConnectionFailure
=== true) {
1980 this.stopAutomaticTransactionGenerator();
1983 this.autoReconnectRetryCount
< this.getAutoReconnectMaxRetries() ||
1984 this.getAutoReconnectMaxRetries() === -1
1986 this.autoReconnectRetryCount
++;
1987 const reconnectDelay
= this.getReconnectExponentialDelay()
1988 ? Utils
.exponentialDelay(this.autoReconnectRetryCount
)
1989 : this.getConnectionTimeout() * 1000;
1990 const reconnectDelayWithdraw
= 1000;
1991 const reconnectTimeout
=
1992 reconnectDelay
&& reconnectDelay
- reconnectDelayWithdraw
> 0
1993 ? reconnectDelay
- reconnectDelayWithdraw
1996 `${this.logPrefix()} WebSocket connection retry in ${Utils.roundTo(
1999 )}ms, timeout ${reconnectTimeout}ms`
2001 await Utils
.sleep(reconnectDelay
);
2003 this.logPrefix() + ' WebSocket connection retry #' + this.autoReconnectRetryCount
.toString()
2005 this.openWSConnection(
2006 { ...(this.stationInfo
?.wsOptions
?? {}), handshakeTimeout
: reconnectTimeout
},
2007 { closeOpened
: true }
2009 this.wsConnectionRestarted
= true;
2010 } else if (this.getAutoReconnectMaxRetries() !== -1) {
2012 `${this.logPrefix()} WebSocket connection retries failure: maximum retries reached (${
2013 this.autoReconnectRetryCount
2014 }) or retries disabled (${this.getAutoReconnectMaxRetries()})`
2019 private getAutomaticTransactionGeneratorConfigurationFromTemplate(): AutomaticTransactionGeneratorConfiguration
| null {
2020 return this.getTemplateFromFile()?.AutomaticTransactionGenerator
?? null;
2023 private initializeConnectorStatus(connectorId
: number): void {
2024 this.getConnectorStatus(connectorId
).idTagLocalAuthorized
= false;
2025 this.getConnectorStatus(connectorId
).idTagAuthorized
= false;
2026 this.getConnectorStatus(connectorId
).transactionRemoteStarted
= false;
2027 this.getConnectorStatus(connectorId
).transactionStarted
= false;
2028 this.getConnectorStatus(connectorId
).energyActiveImportRegisterValue
= 0;
2029 this.getConnectorStatus(connectorId
).transactionEnergyActiveImportRegisterValue
= 0;