1 import { BootNotificationResponse
, RegistrationStatus
} from
'../types/ocpp/Responses';
2 import ChargingStationConfiguration
, { ConfigurationKey
} from
'../types/ChargingStationConfiguration';
3 import ChargingStationTemplate
, { CurrentOutType
, VoltageOut
} from
'../types/ChargingStationTemplate';
4 import Connectors
, { Connector
} from
'../types/Connectors';
5 import { PerformanceObserver
, performance
} from
'perf_hooks';
6 import Requests
, { AvailabilityType
, BootNotificationRequest
, IncomingRequest
, IncomingRequestCommand
} from
'../types/ocpp/Requests';
7 import WebSocket
, { MessageEvent
} from
'ws';
9 import AutomaticTransactionGenerator from
'./AutomaticTransactionGenerator';
10 import { ChargePointStatus
} from
'../types/ocpp/ChargePointStatus';
11 import { ChargingProfile
} from
'../types/ocpp/ChargingProfile';
12 import ChargingStationInfo from
'../types/ChargingStationInfo';
13 import Configuration from
'../utils/Configuration';
14 import Constants from
'../utils/Constants';
15 import { MessageType
} from
'../types/ocpp/MessageType';
16 import { MeterValueMeasurand
} from
'../types/ocpp/MeterValues';
17 import OCPP16IncomingRequestService from
'./ocpp/1.6/OCCP16IncomingRequestService';
18 import OCPP16RequestService from
'./ocpp/1.6/OCPP16RequestService';
19 import OCPP16ResponseService from
'./ocpp/1.6/OCPP16ResponseService';
20 import OCPPError from
'./OcppError';
21 import OCPPIncomingRequestService from
'./ocpp/OCPPIncomingRequestService';
22 import OCPPRequestService from
'./ocpp/OCPPRequestService';
23 import { OCPPVersion
} from
'../types/ocpp/OCPPVersion';
24 import PerformanceStatistics from
'../utils/PerformanceStatistics';
25 import { StandardParametersKey
} from
'../types/ocpp/Configuration';
26 import { StopTransactionReason
} from
'../types/ocpp/Transaction';
27 import Utils from
'../utils/Utils';
28 import { WebSocketCloseEventStatusCode
} from
'../types/WebSocket';
29 import crypto from
'crypto';
31 import logger from
'../utils/Logger';
32 import path from
'path';
34 export default class ChargingStation
{
35 public stationTemplateFile
: string;
36 public authorizedTags
: string[];
37 public stationInfo
!: ChargingStationInfo
;
38 public connectors
: Connectors
;
39 public configuration
!: ChargingStationConfiguration
;
40 public hasStopped
: boolean;
41 public wsConnection
!: WebSocket
;
42 public requests
: Requests
;
43 public messageQueue
: string[];
44 public performanceStatistics
!: PerformanceStatistics
;
45 public heartbeatSetInterval
!: NodeJS
.Timeout
;
46 public ocppIncomingRequestService
!: OCPPIncomingRequestService
;
47 public ocppRequestService
!: OCPPRequestService
;
48 private index
: number;
49 private bootNotificationRequest
!: BootNotificationRequest
;
50 private bootNotificationResponse
!: BootNotificationResponse
| null;
51 private connectorsConfigurationHash
!: string;
52 private supervisionUrl
!: string;
53 private wsConnectionUrl
!: string;
54 private hasSocketRestarted
: boolean;
55 private autoReconnectRetryCount
: number;
56 private automaticTransactionGeneration
!: AutomaticTransactionGenerator
;
57 private performanceObserver
!: PerformanceObserver
;
58 private webSocketPingSetInterval
!: NodeJS
.Timeout
;
60 constructor(index
: number, stationTemplateFile
: string) {
62 this.stationTemplateFile
= stationTemplateFile
;
63 this.connectors
= {} as Connectors
;
66 this.hasStopped
= false;
67 this.hasSocketRestarted
= false;
68 this.autoReconnectRetryCount
= 0;
70 this.requests
= {} as Requests
;
71 this.messageQueue
= [] as string[];
73 this.authorizedTags
= this.getAuthorizedTags();
76 public logPrefix(): string {
77 return Utils
.logPrefix(` ${this.stationInfo.chargingStationId} |`);
80 public getRandomTagId(): string {
81 const index
= Math.floor(Math.random() * this.authorizedTags
.length
);
82 return this.authorizedTags
[index
];
85 public hasAuthorizedTags(): boolean {
86 return !Utils
.isEmptyArray(this.authorizedTags
);
89 public getEnableStatistics(): boolean | undefined {
90 return !Utils
.isUndefined(this.stationInfo
.enableStatistics
) ? this.stationInfo
.enableStatistics
: true;
93 public getNumberOfPhases(): number | undefined {
94 switch (this.getCurrentOutType()) {
95 case CurrentOutType
.AC
:
96 return !Utils
.isUndefined(this.stationInfo
.numberOfPhases
) ? this.stationInfo
.numberOfPhases
: 3;
97 case CurrentOutType
.DC
:
102 public isWebSocketOpen(): boolean {
103 return this.wsConnection
?.readyState
=== WebSocket
.OPEN
;
106 public isRegistered(): boolean {
107 return this.bootNotificationResponse
?.status === RegistrationStatus
.ACCEPTED
;
110 public isChargingStationAvailable(): boolean {
111 return this.getConnector(0).availability
=== AvailabilityType
.OPERATIVE
;
114 public isConnectorAvailable(id
: number): boolean {
115 return this.getConnector(id
).availability
=== AvailabilityType
.OPERATIVE
;
118 public getConnector(id
: number): Connector
{
119 return this.connectors
[id
];
122 public getCurrentOutType(): CurrentOutType
| undefined {
123 return !Utils
.isUndefined(this.stationInfo
.currentOutType
) ? this.stationInfo
.currentOutType
: CurrentOutType
.AC
;
126 public getVoltageOut(): number | undefined {
127 const errMsg
= `${this.logPrefix()} Unknown ${this.getCurrentOutType()} currentOutType in template file ${this.stationTemplateFile}, cannot define default voltage out`;
128 let defaultVoltageOut
: number;
129 switch (this.getCurrentOutType()) {
130 case CurrentOutType
.AC
:
131 defaultVoltageOut
= VoltageOut
.VOLTAGE_230
;
133 case CurrentOutType
.DC
:
134 defaultVoltageOut
= VoltageOut
.VOLTAGE_400
;
137 logger
.error(errMsg
);
140 return !Utils
.isUndefined(this.stationInfo
.voltageOut
) ? this.stationInfo
.voltageOut
: defaultVoltageOut
;
143 public getTransactionIdTag(transactionId
: number): string | undefined {
144 for (const connector
in this.connectors
) {
145 if (Utils
.convertToInt(connector
) > 0 && this.getConnector(Utils
.convertToInt(connector
)).transactionId
=== transactionId
) {
146 return this.getConnector(Utils
.convertToInt(connector
)).idTag
;
151 public getTransactionMeterStop(transactionId
: number): number | undefined {
152 for (const connector
in this.connectors
) {
153 if (Utils
.convertToInt(connector
) > 0 && this.getConnector(Utils
.convertToInt(connector
)).transactionId
=== transactionId
) {
154 return this.getConnector(Utils
.convertToInt(connector
)).lastEnergyActiveImportRegisterValue
;
159 public getAuthorizeRemoteTxRequests(): boolean {
160 const authorizeRemoteTxRequests
= this.getConfigurationKey(StandardParametersKey
.AuthorizeRemoteTxRequests
);
161 return authorizeRemoteTxRequests
? Utils
.convertToBoolean(authorizeRemoteTxRequests
.value
) : false;
164 public getLocalAuthListEnabled(): boolean {
165 const localAuthListEnabled
= this.getConfigurationKey(StandardParametersKey
.LocalAuthListEnabled
);
166 return localAuthListEnabled
? Utils
.convertToBoolean(localAuthListEnabled
.value
) : false;
169 public restartWebSocketPing(): void {
170 // Stop WebSocket ping
171 this.stopWebSocketPing();
172 // Start WebSocket ping
173 this.startWebSocketPing();
176 public startHeartbeat(): void {
177 if (this.getHeartbeatInterval() && this.getHeartbeatInterval() > 0 && !this.heartbeatSetInterval
) {
178 // eslint-disable-next-line @typescript-eslint/no-misused-promises
179 this.heartbeatSetInterval
= setInterval(async (): Promise
<void> => {
180 await this.ocppRequestService
.sendHeartbeat();
181 }, this.getHeartbeatInterval());
182 logger
.info(this.logPrefix() + ' Heartbeat started every ' + Utils
.milliSecondsToHHMMSS(this.getHeartbeatInterval()));
183 } else if (this.heartbeatSetInterval
) {
184 logger
.info(this.logPrefix() + ' Heartbeat already started every ' + Utils
.milliSecondsToHHMMSS(this.getHeartbeatInterval()));
186 logger
.error(`${this.logPrefix()} Heartbeat interval set to ${this.getHeartbeatInterval() ? Utils.milliSecondsToHHMMSS(this.getHeartbeatInterval()) : this.getHeartbeatInterval()}, not starting the heartbeat`);
190 public restartHeartbeat(): void {
192 this.stopHeartbeat();
194 this.startHeartbeat();
197 public startMeterValues(connectorId
: number, interval
: number): void {
198 if (connectorId
=== 0) {
199 logger
.error(`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId.toString()}`);
202 if (!this.getConnector(connectorId
)) {
203 logger
.error(`${this.logPrefix()} Trying to start MeterValues on non existing connector Id ${connectorId.toString()}`);
206 if (!this.getConnector(connectorId
)?.transactionStarted
) {
207 logger
.error(`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction started`);
209 } else if (this.getConnector(connectorId
)?.transactionStarted
&& !this.getConnector(connectorId
)?.transactionId
) {
210 logger
.error(`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction id`);
214 // eslint-disable-next-line @typescript-eslint/no-misused-promises
215 this.getConnector(connectorId
).transactionSetInterval
= setInterval(async (): Promise
<void> => {
216 if (this.getEnableStatistics()) {
217 const sendMeterValues
= performance
.timerify(this.ocppRequestService
.sendMeterValues
);
218 this.performanceObserver
.observe({
219 entryTypes
: ['function'],
221 await sendMeterValues(connectorId
, this.getConnector(connectorId
).transactionId
, interval
, this.ocppRequestService
);
223 await this.ocppRequestService
.sendMeterValues(connectorId
, this.getConnector(connectorId
).transactionId
, interval
, this.ocppRequestService
);
227 logger
.error(`${this.logPrefix()} Charging station ${StandardParametersKey.MeterValueSampleInterval} configuration set to ${interval ? Utils.milliSecondsToHHMMSS(interval) : interval}, not sending MeterValues`);
231 public start(): void {
232 this.openWSConnection();
233 // Monitor authorization file
234 this.startAuthorizationFileMonitoring();
235 // Monitor station template file
236 this.startStationTemplateFileMonitoring();
237 // Handle Socket incoming messages
238 this.wsConnection
.on('message', this.onMessage
.bind(this));
239 // Handle Socket error
240 this.wsConnection
.on('error', this.onError
.bind(this));
241 // Handle Socket close
242 this.wsConnection
.on('close', this.onClose
.bind(this));
243 // Handle Socket opening connection
244 this.wsConnection
.on('open', this.onOpen
.bind(this));
245 // Handle Socket ping
246 this.wsConnection
.on('ping', this.onPing
.bind(this));
247 // Handle Socket pong
248 this.wsConnection
.on('pong', this.onPong
.bind(this));
251 public async stop(reason
: StopTransactionReason
= StopTransactionReason
.NONE
): Promise
<void> {
252 // Stop message sequence
253 await this.stopMessageSequence(reason
);
254 for (const connector
in this.connectors
) {
255 if (Utils
.convertToInt(connector
) > 0) {
256 await this.ocppRequestService
.sendStatusNotification(Utils
.convertToInt(connector
), ChargePointStatus
.UNAVAILABLE
);
257 this.getConnector(Utils
.convertToInt(connector
)).status = ChargePointStatus
.UNAVAILABLE
;
260 if (this.isWebSocketOpen()) {
261 this.wsConnection
.close();
263 this.bootNotificationResponse
= null;
264 this.hasStopped
= true;
267 public getConfigurationKey(key
: string | StandardParametersKey
, caseInsensitive
= false): ConfigurationKey
| undefined {
268 const configurationKey
: ConfigurationKey
| undefined = this.configuration
.configurationKey
.find((configElement
) => {
269 if (caseInsensitive
) {
270 return configElement
.key
.toLowerCase() === key
.toLowerCase();
272 return configElement
.key
=== key
;
274 return configurationKey
;
277 public addConfigurationKey(key
: string | StandardParametersKey
, value
: string, readonly = false, visible
= true, reboot
= false): void {
278 const keyFound
= this.getConfigurationKey(key
);
280 this.configuration
.configurationKey
.push({
288 logger
.error(`${this.logPrefix()} Trying to add an already existing configuration key: %j`, keyFound
);
292 public setConfigurationKeyValue(key
: string | StandardParametersKey
, value
: string): void {
293 const keyFound
= this.getConfigurationKey(key
);
295 const keyIndex
= this.configuration
.configurationKey
.indexOf(keyFound
);
296 this.configuration
.configurationKey
[keyIndex
].value
= value
;
298 logger
.error(`${this.logPrefix()} Trying to set a value on a non existing configuration key: %j`, { key
, value
});
302 public setChargingProfile(connectorId
: number, cp
: ChargingProfile
): boolean {
303 if (!Utils
.isEmptyArray(this.getConnector(connectorId
).chargingProfiles
)) {
304 this.getConnector(connectorId
).chargingProfiles
?.forEach((chargingProfile
: ChargingProfile
, index
: number) => {
305 if (chargingProfile
.chargingProfileId
=== cp
.chargingProfileId
306 || (chargingProfile
.stackLevel
=== cp
.stackLevel
&& chargingProfile
.chargingProfilePurpose
=== cp
.chargingProfilePurpose
)) {
307 this.getConnector(connectorId
).chargingProfiles
[index
] = cp
;
312 this.getConnector(connectorId
).chargingProfiles
?.push(cp
);
316 public resetTransactionOnConnector(connectorId
: number): void {
317 this.initTransactionOnConnector(connectorId
);
318 if (this.getConnector(connectorId
)?.transactionSetInterval
) {
319 clearInterval(this.getConnector(connectorId
).transactionSetInterval
);
323 public addToMessageQueue(message
: string): void {
325 // Handle dups in message queue
326 for (const bufferedMessage
of this.messageQueue
) {
327 // Message already in the queue
328 if (message
=== bufferedMessage
) {
335 this.messageQueue
.push(message
);
339 private flushMessageQueue() {
340 if (!Utils
.isEmptyArray(this.messageQueue
)) {
341 this.messageQueue
.forEach((message
, index
) => {
342 this.messageQueue
.splice(index
, 1);
343 this.wsConnection
.send(message
);
348 private getChargingStationId(stationTemplate
: ChargingStationTemplate
): string {
349 // In case of multiple instances: add instance index to charging station id
350 let instanceIndex
= process
.env
.CF_INSTANCE_INDEX
? process
.env
.CF_INSTANCE_INDEX
: 0;
351 instanceIndex
= instanceIndex
> 0 ? instanceIndex
: '';
352 const idSuffix
= stationTemplate
.nameSuffix
? stationTemplate
.nameSuffix
: '';
353 return stationTemplate
.fixedName
? stationTemplate
.baseName
: stationTemplate
.baseName
+ '-' + instanceIndex
.toString() + ('000000000' + this.index
.toString()).substr(('000000000' + this.index
.toString()).length
- 4) + idSuffix
;
356 private buildStationInfo(): ChargingStationInfo
{
357 let stationTemplateFromFile
: ChargingStationTemplate
;
359 // Load template file
360 const fileDescriptor
= fs
.openSync(this.stationTemplateFile
, 'r');
361 stationTemplateFromFile
= JSON
.parse(fs
.readFileSync(fileDescriptor
, 'utf8')) as ChargingStationTemplate
;
362 fs
.closeSync(fileDescriptor
);
364 logger
.error('Template file ' + this.stationTemplateFile
+ ' loading error: %j', error
);
367 const stationInfo
: ChargingStationInfo
= stationTemplateFromFile
|| {} as ChargingStationInfo
;
368 if (!Utils
.isEmptyArray(stationTemplateFromFile
.power
)) {
369 stationTemplateFromFile
.power
= stationTemplateFromFile
.power
as number[];
370 stationInfo
.maxPower
= stationTemplateFromFile
.power
[Math.floor(Math.random() * stationTemplateFromFile
.power
.length
)];
372 stationInfo
.maxPower
= stationTemplateFromFile
.power
as number;
374 stationInfo
.chargingStationId
= this.getChargingStationId(stationTemplateFromFile
);
375 stationInfo
.resetTime
= stationTemplateFromFile
.resetTime
? stationTemplateFromFile
.resetTime
* 1000 : Constants
.CHARGING_STATION_DEFAULT_RESET_TIME
;
379 private getOCPPVersion(): OCPPVersion
{
380 return this.stationInfo
.ocppVersion
? this.stationInfo
.ocppVersion
: OCPPVersion
.VERSION_16
;
383 private handleUnsupportedVersion(version
: OCPPVersion
) {
384 const errMsg
= `${this.logPrefix()} Unsupported protocol version '${version}' configured in template file ${this.stationTemplateFile}`;
385 logger
.error(errMsg
);
386 throw new Error(errMsg
);
389 private initialize(): void {
390 this.stationInfo
= this.buildStationInfo();
391 this.bootNotificationRequest
= {
392 chargePointModel
: this.stationInfo
.chargePointModel
,
393 chargePointVendor
: this.stationInfo
.chargePointVendor
,
394 ...!Utils
.isUndefined(this.stationInfo
.chargeBoxSerialNumberPrefix
) && { chargeBoxSerialNumber
: this.stationInfo
.chargeBoxSerialNumberPrefix
},
395 ...!Utils
.isUndefined(this.stationInfo
.firmwareVersion
) && { firmwareVersion
: this.stationInfo
.firmwareVersion
},
397 this.configuration
= this.getTemplateChargingStationConfiguration();
398 this.supervisionUrl
= this.getSupervisionURL();
399 this.wsConnectionUrl
= this.supervisionUrl
+ '/' + this.stationInfo
.chargingStationId
;
400 // Build connectors if needed
401 const maxConnectors
= this.getMaxNumberOfConnectors();
402 if (maxConnectors
<= 0) {
403 logger
.warn(`${this.logPrefix()} Charging station template ${this.stationTemplateFile} with ${maxConnectors} connectors`);
405 const templateMaxConnectors
= this.getTemplateMaxNumberOfConnectors();
406 if (templateMaxConnectors
<= 0) {
407 logger
.warn(`${this.logPrefix()} Charging station template ${this.stationTemplateFile} with no connector configuration`);
409 if (!this.stationInfo
.Connectors
[0]) {
410 logger
.warn(`${this.logPrefix()} Charging station template ${this.stationTemplateFile} with no connector Id 0 configuration`);
413 if (maxConnectors
> (this.stationInfo
.Connectors
[0] ? templateMaxConnectors
- 1 : templateMaxConnectors
) && !this.stationInfo
.randomConnectors
) {
414 logger
.warn(`${this.logPrefix()} Number of connectors exceeds the number of connector configurations in template ${this.stationTemplateFile}, forcing random connector configurations affectation`);
415 this.stationInfo
.randomConnectors
= true;
417 const connectorsConfigHash
= crypto
.createHash('sha256').update(JSON
.stringify(this.stationInfo
.Connectors
) + maxConnectors
.toString()).digest('hex');
418 // FIXME: Handle shrinking the number of connectors
419 if (!this.connectors
|| (this.connectors
&& this.connectorsConfigurationHash
!== connectorsConfigHash
)) {
420 this.connectorsConfigurationHash
= connectorsConfigHash
;
421 // Add connector Id 0
422 let lastConnector
= '0';
423 for (lastConnector
in this.stationInfo
.Connectors
) {
424 if (Utils
.convertToInt(lastConnector
) === 0 && this.getUseConnectorId0() && this.stationInfo
.Connectors
[lastConnector
]) {
425 this.connectors
[lastConnector
] = Utils
.cloneObject
<Connector
>(this.stationInfo
.Connectors
[lastConnector
]);
426 this.connectors
[lastConnector
].availability
= AvailabilityType
.OPERATIVE
;
427 if (Utils
.isUndefined(this.connectors
[lastConnector
]?.chargingProfiles
)) {
428 this.connectors
[lastConnector
].chargingProfiles
= [];
432 // Generate all connectors
433 if ((this.stationInfo
.Connectors
[0] ? templateMaxConnectors
- 1 : templateMaxConnectors
) > 0) {
434 for (let index
= 1; index
<= maxConnectors
; index
++) {
435 const randConnectorID
= this.stationInfo
.randomConnectors
? Utils
.getRandomInt(Utils
.convertToInt(lastConnector
), 1) : index
;
436 this.connectors
[index
] = Utils
.cloneObject
<Connector
>(this.stationInfo
.Connectors
[randConnectorID
]);
437 this.connectors
[index
].availability
= AvailabilityType
.OPERATIVE
;
438 if (Utils
.isUndefined(this.connectors
[lastConnector
]?.chargingProfiles
)) {
439 this.connectors
[index
].chargingProfiles
= [];
444 // Avoid duplication of connectors related information
445 delete this.stationInfo
.Connectors
;
446 // Initialize transaction attributes on connectors
447 for (const connector
in this.connectors
) {
448 if (Utils
.convertToInt(connector
) > 0 && !this.getConnector(Utils
.convertToInt(connector
)).transactionStarted
) {
449 this.initTransactionOnConnector(Utils
.convertToInt(connector
));
452 switch (this.getOCPPVersion()) {
453 case OCPPVersion
.VERSION_16
:
454 this.ocppIncomingRequestService
= new OCPP16IncomingRequestService(this);
455 this.ocppRequestService
= new OCPP16RequestService(this, new OCPP16ResponseService(this));
458 this.handleUnsupportedVersion(this.getOCPPVersion());
462 this.addConfigurationKey(StandardParametersKey
.NumberOfConnectors
, this.getNumberOfConnectors().toString(), true);
463 if (!this.getConfigurationKey(StandardParametersKey
.MeterValuesSampledData
)) {
464 this.addConfigurationKey(StandardParametersKey
.MeterValuesSampledData
, MeterValueMeasurand
.ENERGY_ACTIVE_IMPORT_REGISTER
);
466 this.stationInfo
.powerDivider
= this.getPowerDivider();
467 if (this.getEnableStatistics()) {
468 this.performanceStatistics
= new PerformanceStatistics(this.stationInfo
.chargingStationId
);
469 this.performanceObserver
= new PerformanceObserver((list
) => {
470 const entry
= list
.getEntries()[0];
471 this.performanceStatistics
.logPerformance(entry
, Constants
.ENTITY_CHARGING_STATION
);
472 this.performanceObserver
.disconnect();
477 private async onOpen(): Promise
<void> {
478 logger
.info(`${this.logPrefix()} Is connected to server through ${this.wsConnectionUrl}`);
479 if (!this.isRegistered()) {
480 // Send BootNotification
481 let registrationRetryCount
= 0;
483 this.bootNotificationResponse
= await this.ocppRequestService
.sendBootNotification(this.bootNotificationRequest
.chargePointModel
,
484 this.bootNotificationRequest
.chargePointVendor
, this.bootNotificationRequest
.chargeBoxSerialNumber
, this.bootNotificationRequest
.firmwareVersion
);
485 if (!this.isRegistered()) {
486 registrationRetryCount
++;
487 await Utils
.sleep(this.bootNotificationResponse
?.interval
? this.bootNotificationResponse
.interval
* 1000 : Constants
.OCPP_DEFAULT_BOOT_NOTIFICATION_INTERVAL
);
489 } while (!this.isRegistered() && (registrationRetryCount
<= this.getRegistrationMaxRetries() || this.getRegistrationMaxRetries() === -1));
491 if (this.isRegistered()) {
492 await this.startMessageSequence();
493 this.hasStopped
&& (this.hasStopped
= false);
494 if (this.hasSocketRestarted
&& this.isWebSocketOpen()) {
495 this.flushMessageQueue();
498 logger
.error(`${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})`);
500 this.autoReconnectRetryCount
= 0;
501 this.hasSocketRestarted
= false;
504 private async onClose(closeEvent
: any): Promise
<void> {
505 switch (closeEvent
) {
506 case WebSocketCloseEventStatusCode
.CLOSE_NORMAL
: // Normal close
507 case WebSocketCloseEventStatusCode
.CLOSE_NO_STATUS
:
508 logger
.info(`${this.logPrefix()} Socket normally closed with status '${Utils.getWebSocketCloseEventStatusString(closeEvent)}'`);
509 this.autoReconnectRetryCount
= 0;
511 default: // Abnormal close
512 logger
.error(`${this.logPrefix()} Socket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString(closeEvent)}'`);
513 await this.reconnect(closeEvent
);
518 private async onMessage(messageEvent
: MessageEvent
): Promise
<void> {
519 let [messageType
, messageId
, commandName
, commandPayload
, errorDetails
]: IncomingRequest
= [0, '', '' as IncomingRequestCommand
, {}, {}];
520 let responseCallback
: (payload
: Record
<string, unknown
> | string, requestPayload
: Record
<string, unknown
>) => void;
521 let rejectCallback
: (error
: OCPPError
) => void;
522 let requestPayload
: Record
<string, unknown
>;
526 [messageType
, messageId
, commandName
, commandPayload
, errorDetails
] = JSON
.parse(messageEvent
.toString()) as IncomingRequest
;
528 // Check the Type of message
529 switch (messageType
) {
531 case MessageType
.CALL_MESSAGE
:
532 if (this.getEnableStatistics()) {
533 this.performanceStatistics
.addMessage(commandName
, messageType
);
536 await this.ocppIncomingRequestService
.handleRequest(messageId
, commandName
, commandPayload
);
539 case MessageType
.CALL_RESULT_MESSAGE
:
541 if (Utils
.isIterable(this.requests
[messageId
])) {
542 [responseCallback
, , requestPayload
] = this.requests
[messageId
];
544 throw new Error(`Response request for message id ${messageId} is not iterable`);
546 if (!responseCallback
) {
548 throw new Error(`Response request for unknown message id ${messageId}`);
550 delete this.requests
[messageId
];
551 responseCallback(commandName
, requestPayload
);
554 case MessageType
.CALL_ERROR_MESSAGE
:
555 if (!this.requests
[messageId
]) {
557 throw new Error(`Error request for unknown message id ${messageId}`);
559 if (Utils
.isIterable(this.requests
[messageId
])) {
560 [, rejectCallback
] = this.requests
[messageId
];
562 throw new Error(`Error request for message id ${messageId} is not iterable`);
564 delete this.requests
[messageId
];
565 rejectCallback(new OCPPError(commandName
, commandPayload
.toString(), errorDetails
));
569 errMsg
= `${this.logPrefix()} Wrong message type ${messageType}`;
570 logger
.error(errMsg
);
571 throw new Error(errMsg
);
575 logger
.error('%s Incoming message %j processing error %j on request content type %j', this.logPrefix(), messageEvent
, error
, this.requests
[messageId
]);
577 messageType
!== MessageType
.CALL_ERROR_MESSAGE
&& await this.ocppRequestService
.sendError(messageId
, error
, commandName
);
581 private onPing(): void {
582 logger
.debug(this.logPrefix() + ' Has received a WS ping (rfc6455) from the server');
585 private onPong(): void {
586 logger
.debug(this.logPrefix() + ' Has received a WS pong (rfc6455) from the server');
589 private async onError(errorEvent
: any): Promise
<void> {
590 logger
.error(this.logPrefix() + ' Socket error: %j', errorEvent
);
591 // pragma switch (errorEvent.code) {
592 // case 'ECONNREFUSED':
593 // await this._reconnect(errorEvent);
598 private getTemplateChargingStationConfiguration(): ChargingStationConfiguration
{
599 return this.stationInfo
.Configuration
? this.stationInfo
.Configuration
: {} as ChargingStationConfiguration
;
602 private getAuthorizationFile(): string | undefined {
603 return this.stationInfo
.authorizationFile
&& path
.join(path
.resolve(__dirname
, '../'), 'assets', path
.basename(this.stationInfo
.authorizationFile
));
606 private getAuthorizedTags(): string[] {
607 let authorizedTags
: string[] = [];
608 const authorizationFile
= this.getAuthorizationFile();
609 if (authorizationFile
) {
611 // Load authorization file
612 const fileDescriptor
= fs
.openSync(authorizationFile
, 'r');
613 authorizedTags
= JSON
.parse(fs
.readFileSync(fileDescriptor
, 'utf8')) as string[];
614 fs
.closeSync(fileDescriptor
);
616 logger
.error(this.logPrefix() + ' Authorization file ' + authorizationFile
+ ' loading error: %j', error
);
620 logger
.info(this.logPrefix() + ' No authorization file given in template file ' + this.stationTemplateFile
);
622 return authorizedTags
;
625 private getUseConnectorId0(): boolean | undefined {
626 return !Utils
.isUndefined(this.stationInfo
.useConnectorId0
) ? this.stationInfo
.useConnectorId0
: true;
629 private getNumberOfRunningTransactions(): number {
631 for (const connector
in this.connectors
) {
632 if (Utils
.convertToInt(connector
) > 0 && this.getConnector(Utils
.convertToInt(connector
)).transactionStarted
) {
640 private getConnectionTimeout(): number | undefined {
641 if (!Utils
.isUndefined(this.stationInfo
.connectionTimeout
)) {
642 return this.stationInfo
.connectionTimeout
;
644 if (!Utils
.isUndefined(Configuration
.getConnectionTimeout())) {
645 return Configuration
.getConnectionTimeout();
650 // -1 for unlimited, 0 for disabling
651 private getAutoReconnectMaxRetries(): number | undefined {
652 if (!Utils
.isUndefined(this.stationInfo
.autoReconnectMaxRetries
)) {
653 return this.stationInfo
.autoReconnectMaxRetries
;
655 if (!Utils
.isUndefined(Configuration
.getAutoReconnectMaxRetries())) {
656 return Configuration
.getAutoReconnectMaxRetries();
662 private getRegistrationMaxRetries(): number | undefined {
663 if (!Utils
.isUndefined(this.stationInfo
.registrationMaxRetries
)) {
664 return this.stationInfo
.registrationMaxRetries
;
669 private getPowerDivider(): number {
670 let powerDivider
= this.getNumberOfConnectors();
671 if (this.stationInfo
.powerSharedByConnectors
) {
672 powerDivider
= this.getNumberOfRunningTransactions();
677 private getTemplateMaxNumberOfConnectors(): number {
678 return Object.keys(this.stationInfo
.Connectors
).length
;
681 private getMaxNumberOfConnectors(): number {
682 let maxConnectors
= 0;
683 if (!Utils
.isEmptyArray(this.stationInfo
.numberOfConnectors
)) {
684 const numberOfConnectors
= this.stationInfo
.numberOfConnectors
as number[];
685 // Distribute evenly the number of connectors
686 maxConnectors
= numberOfConnectors
[(this.index
- 1) % numberOfConnectors
.length
];
687 } else if (!Utils
.isUndefined(this.stationInfo
.numberOfConnectors
)) {
688 maxConnectors
= this.stationInfo
.numberOfConnectors
as number;
690 maxConnectors
= this.stationInfo
.Connectors
[0] ? this.getTemplateMaxNumberOfConnectors() - 1 : this.getTemplateMaxNumberOfConnectors();
692 return maxConnectors
;
695 private getNumberOfConnectors(): number {
696 return this.connectors
[0] ? Object.keys(this.connectors
).length
- 1 : Object.keys(this.connectors
).length
;
699 private async startMessageSequence(): Promise
<void> {
700 // Start WebSocket ping
701 this.startWebSocketPing();
703 this.startHeartbeat();
704 // Initialize connectors status
705 for (const connector
in this.connectors
) {
706 if (Utils
.convertToInt(connector
) === 0) {
708 } else if (!this.hasStopped
&& !this.getConnector(Utils
.convertToInt(connector
))?.status && this.getConnector(Utils
.convertToInt(connector
))?.bootStatus
) {
709 // Send status in template at startup
710 await this.ocppRequestService
.sendStatusNotification(Utils
.convertToInt(connector
), this.getConnector(Utils
.convertToInt(connector
)).bootStatus
);
711 this.getConnector(Utils
.convertToInt(connector
)).status = this.getConnector(Utils
.convertToInt(connector
)).bootStatus
;
712 } else if (this.hasStopped
&& this.getConnector(Utils
.convertToInt(connector
))?.bootStatus
) {
713 // Send status in template after reset
714 await this.ocppRequestService
.sendStatusNotification(Utils
.convertToInt(connector
), this.getConnector(Utils
.convertToInt(connector
)).bootStatus
);
715 this.getConnector(Utils
.convertToInt(connector
)).status = this.getConnector(Utils
.convertToInt(connector
)).bootStatus
;
716 } else if (!this.hasStopped
&& this.getConnector(Utils
.convertToInt(connector
))?.status) {
717 // Send previous status at template reload
718 await this.ocppRequestService
.sendStatusNotification(Utils
.convertToInt(connector
), this.getConnector(Utils
.convertToInt(connector
)).status);
720 // Send default status
721 await this.ocppRequestService
.sendStatusNotification(Utils
.convertToInt(connector
), ChargePointStatus
.AVAILABLE
);
722 this.getConnector(Utils
.convertToInt(connector
)).status = ChargePointStatus
.AVAILABLE
;
726 if (this.stationInfo
.AutomaticTransactionGenerator
.enable
) {
727 if (!this.automaticTransactionGeneration
) {
728 this.automaticTransactionGeneration
= new AutomaticTransactionGenerator(this);
730 if (this.automaticTransactionGeneration
.timeToStop
) {
731 // The ATG might sleep
732 void this.automaticTransactionGeneration
.start();
735 if (this.getEnableStatistics()) {
736 this.performanceStatistics
.start();
740 private async stopMessageSequence(reason
: StopTransactionReason
= StopTransactionReason
.NONE
): Promise
<void> {
741 // Stop WebSocket ping
742 this.stopWebSocketPing();
744 this.stopHeartbeat();
746 if (this.stationInfo
.AutomaticTransactionGenerator
.enable
&&
747 this.automaticTransactionGeneration
&&
748 !this.automaticTransactionGeneration
.timeToStop
) {
749 await this.automaticTransactionGeneration
.stop(reason
);
751 for (const connector
in this.connectors
) {
752 if (Utils
.convertToInt(connector
) > 0 && this.getConnector(Utils
.convertToInt(connector
)).transactionStarted
) {
753 const transactionId
= this.getConnector(Utils
.convertToInt(connector
)).transactionId
;
754 await this.ocppRequestService
.sendStopTransaction(transactionId
, this.getTransactionMeterStop(transactionId
), this.getTransactionIdTag(transactionId
), reason
);
760 private startWebSocketPing(): void {
761 const webSocketPingInterval
: number = this.getConfigurationKey(StandardParametersKey
.WebSocketPingInterval
) ? Utils
.convertToInt(this.getConfigurationKey(StandardParametersKey
.WebSocketPingInterval
).value
) : 0;
762 if (webSocketPingInterval
> 0 && !this.webSocketPingSetInterval
) {
763 this.webSocketPingSetInterval
= setInterval(() => {
764 if (this.isWebSocketOpen()) {
765 this.wsConnection
.ping((): void => { });
767 }, webSocketPingInterval
* 1000);
768 logger
.info(this.logPrefix() + ' WebSocket ping started every ' + Utils
.secondsToHHMMSS(webSocketPingInterval
));
769 } else if (this.webSocketPingSetInterval
) {
770 logger
.info(this.logPrefix() + ' WebSocket ping every ' + Utils
.secondsToHHMMSS(webSocketPingInterval
) + ' already started');
772 logger
.error(`${this.logPrefix()} WebSocket ping interval set to ${webSocketPingInterval ? Utils.secondsToHHMMSS(webSocketPingInterval) : webSocketPingInterval}, not starting the WebSocket ping`);
776 private stopWebSocketPing(): void {
777 if (this.webSocketPingSetInterval
) {
778 clearInterval(this.webSocketPingSetInterval
);
782 private getSupervisionURL(): string {
783 const supervisionUrls
= Utils
.cloneObject
<string | string[]>(this.stationInfo
.supervisionURL
? this.stationInfo
.supervisionURL
: Configuration
.getSupervisionURLs());
785 if (!Utils
.isEmptyArray(supervisionUrls
)) {
786 if (Configuration
.getDistributeStationsToTenantsEqually()) {
787 indexUrl
= this.index
% supervisionUrls
.length
;
790 indexUrl
= Math.floor(Math.random() * supervisionUrls
.length
);
792 return supervisionUrls
[indexUrl
];
794 return supervisionUrls
as string;
797 private getHeartbeatInterval(): number | undefined {
798 const HeartbeatInterval
= this.getConfigurationKey(StandardParametersKey
.HeartbeatInterval
);
799 if (HeartbeatInterval
) {
800 return Utils
.convertToInt(HeartbeatInterval
.value
) * 1000;
802 const HeartBeatInterval
= this.getConfigurationKey(StandardParametersKey
.HeartBeatInterval
);
803 if (HeartBeatInterval
) {
804 return Utils
.convertToInt(HeartBeatInterval
.value
) * 1000;
808 private stopHeartbeat(): void {
809 if (this.heartbeatSetInterval
) {
810 clearInterval(this.heartbeatSetInterval
);
814 private openWSConnection(options
?: WebSocket
.ClientOptions
, forceCloseOpened
= false): void {
815 if (Utils
.isUndefined(options
)) {
816 options
= {} as WebSocket
.ClientOptions
;
818 if (Utils
.isUndefined(options
?.handshakeTimeout
)) {
819 options
.handshakeTimeout
= this.getConnectionTimeout() * 1000;
821 if (this.isWebSocketOpen() && forceCloseOpened
) {
822 this.wsConnection
.close();
825 switch (this.getOCPPVersion()) {
826 case OCPPVersion
.VERSION_16
:
827 protocol
= 'ocpp' + OCPPVersion
.VERSION_16
;
830 this.handleUnsupportedVersion(this.getOCPPVersion());
833 this.wsConnection
= new WebSocket(this.wsConnectionUrl
, protocol
, options
);
834 logger
.info(this.logPrefix() + ' Will communicate through URL ' + this.supervisionUrl
);
837 private startAuthorizationFileMonitoring(): void {
838 fs
.watch(this.getAuthorizationFile()).on('change', (e
) => {
840 logger
.debug(this.logPrefix() + ' Authorization file ' + this.getAuthorizationFile() + ' have changed, reload');
841 // Initialize authorizedTags
842 this.authorizedTags
= this.getAuthorizedTags();
844 logger
.error(this.logPrefix() + ' Authorization file monitoring error: %j', error
);
849 private startStationTemplateFileMonitoring(): void {
850 // eslint-disable-next-line @typescript-eslint/no-misused-promises
851 fs
.watch(this.stationTemplateFile
).on('change', async (e
): Promise
<void> => {
853 logger
.debug(this.logPrefix() + ' Template file ' + this.stationTemplateFile
+ ' have changed, reload');
857 if (!this.stationInfo
.AutomaticTransactionGenerator
.enable
&&
858 this.automaticTransactionGeneration
) {
859 await this.automaticTransactionGeneration
.stop();
862 if (this.stationInfo
.AutomaticTransactionGenerator
.enable
) {
863 if (!this.automaticTransactionGeneration
) {
864 this.automaticTransactionGeneration
= new AutomaticTransactionGenerator(this);
866 if (this.automaticTransactionGeneration
.timeToStop
) {
867 // The ATG might sleep
868 void this.automaticTransactionGeneration
.start();
871 // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed
873 logger
.error(this.logPrefix() + ' Charging station template file monitoring error: %j', error
);
878 private getReconnectExponentialDelay(): boolean | undefined {
879 return !Utils
.isUndefined(this.stationInfo
.reconnectExponentialDelay
) ? this.stationInfo
.reconnectExponentialDelay
: false;
882 private async reconnect(error
: any): Promise
<void> {
884 this.stopHeartbeat();
885 // Stop the ATG if needed
886 if (this.stationInfo
.AutomaticTransactionGenerator
.enable
&&
887 this.stationInfo
.AutomaticTransactionGenerator
.stopOnConnectionFailure
&&
888 this.automaticTransactionGeneration
&&
889 !this.automaticTransactionGeneration
.timeToStop
) {
890 this.automaticTransactionGeneration
.stop().catch(() => { });
892 if (this.autoReconnectRetryCount
< this.getAutoReconnectMaxRetries() || this.getAutoReconnectMaxRetries() === -1) {
893 this.autoReconnectRetryCount
++;
894 const reconnectDelay
= (this.getReconnectExponentialDelay() ? Utils
.exponentialDelay(this.autoReconnectRetryCount
) : this.getConnectionTimeout() * 1000);
895 logger
.error(`${this.logPrefix()} Socket: connection retry in ${Utils.roundTo(reconnectDelay, 2)}ms, timeout ${reconnectDelay - 100}ms`);
896 await Utils
.sleep(reconnectDelay
);
897 logger
.error(this.logPrefix() + ' Socket: reconnecting try #' + this.autoReconnectRetryCount
.toString());
898 this.openWSConnection({ handshakeTimeout
: reconnectDelay
- 100 });
899 this.hasSocketRestarted
= true;
900 } else if (this.getAutoReconnectMaxRetries() !== -1) {
901 logger
.error(`${this.logPrefix()} Socket reconnect failure: max retries reached (${this.autoReconnectRetryCount}) or retry disabled (${this.getAutoReconnectMaxRetries()})`);
905 private initTransactionOnConnector(connectorId
: number): void {
906 this.getConnector(connectorId
).transactionStarted
= false;
907 delete this.getConnector(connectorId
).transactionId
;
908 delete this.getConnector(connectorId
).idTag
;
909 this.getConnector(connectorId
).lastEnergyActiveImportRegisterValue
= -1;