Ensure performance statistics is started before connection to the OCPP
[e-mobility-charging-stations-simulator.git] / src / charging-station / ChargingStation.ts
CommitLineData
efa43e52 1import { BootNotificationResponse, RegistrationStatus } from '../types/ocpp/Responses';
e118beaa 2import ChargingStationConfiguration, { ConfigurationKey } from '../types/ChargingStationConfiguration';
4c2b4904 3import ChargingStationTemplate, { CurrentType, PowerUnits, Voltage } from '../types/ChargingStationTemplate';
7e1dc878 4import { ConnectorPhaseRotation, StandardParametersKey, SupportedFeatureProfiles } from '../types/ocpp/Configuration';
9ccca265
JB
5import Connectors, { Connector, SampledValueTemplate } from '../types/Connectors';
6import { MeterValueMeasurand, MeterValuePhase } from '../types/ocpp/MeterValues';
c0560973 7import Requests, { AvailabilityType, BootNotificationRequest, IncomingRequest, IncomingRequestCommand } from '../types/ocpp/Requests';
136c90ba 8import WebSocket, { MessageEvent } from 'ws';
3f40bc9c 9
6af9012e 10import AutomaticTransactionGenerator from './AutomaticTransactionGenerator';
c0560973
JB
11import { ChargePointStatus } from '../types/ocpp/ChargePointStatus';
12import { ChargingProfile } from '../types/ocpp/ChargingProfile';
9ac86a7e 13import ChargingStationInfo from '../types/ChargingStationInfo';
6af9012e 14import Configuration from '../utils/Configuration';
63b48f77 15import Constants from '../utils/Constants';
23132a44 16import FileUtils from '../utils/FileUtils';
d2a64eb5 17import { MessageType } from '../types/ocpp/MessageType';
c0560973
JB
18import OCPP16IncomingRequestService from './ocpp/1.6/OCCP16IncomingRequestService';
19import OCPP16RequestService from './ocpp/1.6/OCPP16RequestService';
20import OCPP16ResponseService from './ocpp/1.6/OCPP16ResponseService';
7170127d 21import OCPPError from './OCPPError';
c0560973
JB
22import OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService';
23import OCPPRequestService from './ocpp/OCPPRequestService';
24import { OCPPVersion } from '../types/ocpp/OCPPVersion';
54b1efe0 25import PerformanceStatistics from '../utils/PerformanceStatistics';
c0560973 26import { StopTransactionReason } from '../types/ocpp/Transaction';
57939a9d 27import { URL } from 'url';
6af9012e 28import Utils from '../utils/Utils';
32a1eb7a 29import { WebSocketCloseEventStatusCode } from '../types/WebSocket';
3f40bc9c
JB
30import crypto from 'crypto';
31import fs from 'fs';
6af9012e 32import logger from '../utils/Logger';
bf1866b2 33import path from 'path';
3f40bc9c
JB
34
35export default class ChargingStation {
c0560973
JB
36 public stationTemplateFile: string;
37 public authorizedTags: string[];
6e0964c8 38 public stationInfo!: ChargingStationInfo;
ad2f27c3 39 public connectors: Connectors;
6e0964c8 40 public configuration!: ChargingStationConfiguration;
c0560973 41 public hasStopped: boolean;
6e0964c8 42 public wsConnection!: WebSocket;
c0560973
JB
43 public requests: Requests;
44 public messageQueue: string[];
6e0964c8
JB
45 public performanceStatistics!: PerformanceStatistics;
46 public heartbeatSetInterval!: NodeJS.Timeout;
47 public ocppIncomingRequestService!: OCPPIncomingRequestService;
48 public ocppRequestService!: OCPPRequestService;
ad2f27c3 49 private index: number;
6e0964c8
JB
50 private bootNotificationRequest!: BootNotificationRequest;
51 private bootNotificationResponse!: BootNotificationResponse | null;
52 private connectorsConfigurationHash!: string;
57939a9d 53 private wsConnectionUrl!: URL;
ad2f27c3
JB
54 private hasSocketRestarted: boolean;
55 private autoReconnectRetryCount: number;
6e0964c8 56 private automaticTransactionGeneration!: AutomaticTransactionGenerator;
6e0964c8 57 private webSocketPingSetInterval!: NodeJS.Timeout;
6af9012e
JB
58
59 constructor(index: number, stationTemplateFile: string) {
ad2f27c3
JB
60 this.index = index;
61 this.stationTemplateFile = stationTemplateFile;
62 this.connectors = {} as Connectors;
c0560973 63 this.initialize();
2e6f5966 64
ad2f27c3
JB
65 this.hasStopped = false;
66 this.hasSocketRestarted = false;
67 this.autoReconnectRetryCount = 0;
2e6f5966 68
ad2f27c3
JB
69 this.requests = {} as Requests;
70 this.messageQueue = [] as string[];
2e6f5966 71
c0560973
JB
72 this.authorizedTags = this.getAuthorizedTags();
73 }
74
75 public logPrefix(): string {
54b1efe0 76 return Utils.logPrefix(` ${this.stationInfo.chargingStationId} |`);
c0560973
JB
77 }
78
79 public getRandomTagId(): string {
80 const index = Math.floor(Math.random() * this.authorizedTags.length);
81 return this.authorizedTags[index];
82 }
83
84 public hasAuthorizedTags(): boolean {
85 return !Utils.isEmptyArray(this.authorizedTags);
86 }
87
6e0964c8 88 public getEnableStatistics(): boolean | undefined {
c0560973
JB
89 return !Utils.isUndefined(this.stationInfo.enableStatistics) ? this.stationInfo.enableStatistics : true;
90 }
91
a7fc8211
JB
92 public getMayAuthorizeAtRemoteStart(): boolean | undefined {
93 return this.stationInfo.mayAuthorizeAtRemoteStart ?? true;
94 }
95
6e0964c8 96 public getNumberOfPhases(): number | undefined {
7decf1b6 97 switch (this.getCurrentOutType()) {
4c2b4904 98 case CurrentType.AC:
c0560973 99 return !Utils.isUndefined(this.stationInfo.numberOfPhases) ? this.stationInfo.numberOfPhases : 3;
4c2b4904 100 case CurrentType.DC:
c0560973
JB
101 return 0;
102 }
103 }
104
105 public isWebSocketOpen(): boolean {
106 return this.wsConnection?.readyState === WebSocket.OPEN;
107 }
108
109 public isRegistered(): boolean {
110 return this.bootNotificationResponse?.status === RegistrationStatus.ACCEPTED;
111 }
112
113 public isChargingStationAvailable(): boolean {
114 return this.getConnector(0).availability === AvailabilityType.OPERATIVE;
115 }
116
117 public isConnectorAvailable(id: number): boolean {
118 return this.getConnector(id).availability === AvailabilityType.OPERATIVE;
119 }
120
121 public getConnector(id: number): Connector {
122 return this.connectors[id];
123 }
124
4c2b4904
JB
125 public getCurrentOutType(): CurrentType | undefined {
126 return this.stationInfo.currentOutType ?? CurrentType.AC;
c0560973
JB
127 }
128
6e0964c8 129 public getVoltageOut(): number | undefined {
7decf1b6 130 const errMsg = `${this.logPrefix()} Unknown ${this.getCurrentOutType()} currentOutType in template file ${this.stationTemplateFile}, cannot define default voltage out`;
c0560973 131 let defaultVoltageOut: number;
7decf1b6 132 switch (this.getCurrentOutType()) {
4c2b4904
JB
133 case CurrentType.AC:
134 defaultVoltageOut = Voltage.VOLTAGE_230;
c0560973 135 break;
4c2b4904
JB
136 case CurrentType.DC:
137 defaultVoltageOut = Voltage.VOLTAGE_400;
c0560973
JB
138 break;
139 default:
140 logger.error(errMsg);
290d006c 141 throw new Error(errMsg);
c0560973
JB
142 }
143 return !Utils.isUndefined(this.stationInfo.voltageOut) ? this.stationInfo.voltageOut : defaultVoltageOut;
144 }
145
6e0964c8 146 public getTransactionIdTag(transactionId: number): string | undefined {
c0560973
JB
147 for (const connector in this.connectors) {
148 if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) {
163547b1 149 return this.getConnector(Utils.convertToInt(connector)).transactionIdTag;
c0560973
JB
150 }
151 }
152 }
153
6ed92bc1
JB
154 public getOutOfOrderEndMeterValues(): boolean {
155 return this.stationInfo.outOfOrderEndMeterValues ?? false;
156 }
157
158 public getBeginEndMeterValues(): boolean {
159 return this.stationInfo.beginEndMeterValues ?? false;
160 }
161
162 public getMeteringPerTransaction(): boolean {
163 return this.stationInfo.meteringPerTransaction ?? true;
164 }
165
fd0c36fa
JB
166 public getTransactionDataMeterValues(): boolean {
167 return this.stationInfo.transactionDataMeterValues ?? false;
168 }
169
9ccca265
JB
170 public getMainVoltageMeterValues(): boolean {
171 return this.stationInfo.mainVoltageMeterValues ?? true;
172 }
173
6b10669b
JB
174 public getPhaseLineToLineVoltageMeterValues(): boolean {
175 return this.stationInfo.phaseLineToLineVoltageMeterValues ?? false;
9bd87386
JB
176 }
177
6ed92bc1
JB
178 public getEnergyActiveImportRegisterByTransactionId(transactionId: number): number | undefined {
179 if (this.getMeteringPerTransaction()) {
180 for (const connector in this.connectors) {
181 if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) {
182 return this.getConnector(Utils.convertToInt(connector)).transactionEnergyActiveImportRegisterValue;
183 }
184 }
185 }
c0560973
JB
186 for (const connector in this.connectors) {
187 if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) {
6ed92bc1 188 return this.getConnector(Utils.convertToInt(connector)).energyActiveImportRegisterValue;
c0560973
JB
189 }
190 }
191 }
192
6ed92bc1
JB
193 public getEnergyActiveImportRegisterByConnectorId(connectorId: number): number | undefined {
194 if (this.getMeteringPerTransaction()) {
195 return this.getConnector(connectorId).transactionEnergyActiveImportRegisterValue;
196 }
197 return this.getConnector(connectorId).energyActiveImportRegisterValue;
198 }
199
c0560973
JB
200 public getAuthorizeRemoteTxRequests(): boolean {
201 const authorizeRemoteTxRequests = this.getConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests);
202 return authorizeRemoteTxRequests ? Utils.convertToBoolean(authorizeRemoteTxRequests.value) : false;
203 }
204
205 public getLocalAuthListEnabled(): boolean {
206 const localAuthListEnabled = this.getConfigurationKey(StandardParametersKey.LocalAuthListEnabled);
207 return localAuthListEnabled ? Utils.convertToBoolean(localAuthListEnabled.value) : false;
208 }
209
210 public restartWebSocketPing(): void {
211 // Stop WebSocket ping
212 this.stopWebSocketPing();
213 // Start WebSocket ping
214 this.startWebSocketPing();
215 }
216
9ccca265
JB
217 public getSampledValueTemplate(connectorId: number, measurand: MeterValueMeasurand = MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER,
218 phase?: MeterValuePhase): SampledValueTemplate | undefined {
219 if (!Constants.SUPPORTED_MEASURANDS.includes(measurand)) {
9bd87386
JB
220 logger.warn(`${this.logPrefix()} Trying to get unsupported MeterValues measurand ${measurand} ${phase ? `on phase ${phase} ` : ''}in template on connectorId ${connectorId}`);
221 return;
222 }
223 if (measurand !== MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER && !this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes(measurand)) {
163547b1 224 logger.debug(`${this.logPrefix()} Trying to get MeterValues measurand ${measurand} ${phase ? `on phase ${phase} ` : ''}in template on connectorId ${connectorId} not found in '${StandardParametersKey.MeterValuesSampledData}' OCPP parameter`);
9ccca265
JB
225 return;
226 }
227 const sampledValueTemplates: SampledValueTemplate[] = this.getConnector(connectorId).MeterValues;
9ccca265 228 for (let index = 0; !Utils.isEmptyArray(sampledValueTemplates) && index < sampledValueTemplates.length; index++) {
290d006c 229 if (!Constants.SUPPORTED_MEASURANDS.includes(sampledValueTemplates[index]?.measurand ?? MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER)) {
47e22477
JB
230 logger.warn(`${this.logPrefix()} Unsupported MeterValues measurand ${measurand} ${phase ? `on phase ${phase} ` : ''}in template on connectorId ${connectorId}`);
231 continue;
232 } else if (phase && sampledValueTemplates[index]?.phase === phase && sampledValueTemplates[index]?.measurand === measurand
9ccca265
JB
233 && this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes(measurand)) {
234 return sampledValueTemplates[index];
235 } else if (!phase && !sampledValueTemplates[index].phase && sampledValueTemplates[index]?.measurand === measurand
236 && this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes(measurand)) {
237 return sampledValueTemplates[index];
238 } else if (measurand === MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER
239 && (!sampledValueTemplates[index].measurand || sampledValueTemplates[index].measurand === measurand)) {
9ccca265
JB
240 return sampledValueTemplates[index];
241 }
242 }
9bd87386
JB
243 if (measurand === MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER) {
244 logger.error(`${this.logPrefix()} Missing MeterValues for default measurand ${measurand} in template on connectorId ${connectorId}`);
9ccca265
JB
245 }
246 logger.debug(`${this.logPrefix()} No MeterValues for measurand ${measurand} ${phase ? `on phase ${phase} ` : ''}in template on connectorId ${connectorId}`);
247 }
248
e644918b
JB
249 public getAutomaticTransactionGeneratorRequireAuthorize(): boolean {
250 return this.stationInfo.AutomaticTransactionGenerator.requireAuthorize ?? true;
251 }
252
c0560973
JB
253 public startHeartbeat(): void {
254 if (this.getHeartbeatInterval() && this.getHeartbeatInterval() > 0 && !this.heartbeatSetInterval) {
71623267
JB
255 // eslint-disable-next-line @typescript-eslint/no-misused-promises
256 this.heartbeatSetInterval = setInterval(async (): Promise<void> => {
c0560973
JB
257 await this.ocppRequestService.sendHeartbeat();
258 }, this.getHeartbeatInterval());
259 logger.info(this.logPrefix() + ' Heartbeat started every ' + Utils.milliSecondsToHHMMSS(this.getHeartbeatInterval()));
260 } else if (this.heartbeatSetInterval) {
54b1efe0 261 logger.info(this.logPrefix() + ' Heartbeat already started every ' + Utils.milliSecondsToHHMMSS(this.getHeartbeatInterval()));
c0560973
JB
262 } else {
263 logger.error(`${this.logPrefix()} Heartbeat interval set to ${this.getHeartbeatInterval() ? Utils.milliSecondsToHHMMSS(this.getHeartbeatInterval()) : this.getHeartbeatInterval()}, not starting the heartbeat`);
264 }
265 }
266
267 public restartHeartbeat(): void {
268 // Stop heartbeat
269 this.stopHeartbeat();
270 // Start heartbeat
271 this.startHeartbeat();
272 }
273
274 public startMeterValues(connectorId: number, interval: number): void {
275 if (connectorId === 0) {
276 logger.error(`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId.toString()}`);
277 return;
278 }
279 if (!this.getConnector(connectorId)) {
280 logger.error(`${this.logPrefix()} Trying to start MeterValues on non existing connector Id ${connectorId.toString()}`);
281 return;
282 }
283 if (!this.getConnector(connectorId)?.transactionStarted) {
284 logger.error(`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction started`);
285 return;
286 } else if (this.getConnector(connectorId)?.transactionStarted && !this.getConnector(connectorId)?.transactionId) {
287 logger.error(`${this.logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction id`);
288 return;
289 }
290 if (interval > 0) {
71623267
JB
291 // eslint-disable-next-line @typescript-eslint/no-misused-promises
292 this.getConnector(connectorId).transactionSetInterval = setInterval(async (): Promise<void> => {
aef1b33a 293 await this.ocppRequestService.sendMeterValues(connectorId, this.getConnector(connectorId).transactionId, interval);
c0560973
JB
294 }, interval);
295 } else {
eb87fe87 296 logger.error(`${this.logPrefix()} Charging station ${StandardParametersKey.MeterValueSampleInterval} configuration set to ${interval ? Utils.milliSecondsToHHMMSS(interval) : interval}, not sending MeterValues`);
c0560973
JB
297 }
298 }
299
300 public start(): void {
7874b0b1
JB
301 if (this.getEnableStatistics()) {
302 this.performanceStatistics.start();
303 }
c0560973
JB
304 this.openWSConnection();
305 // Monitor authorization file
306 this.startAuthorizationFileMonitoring();
307 // Monitor station template file
308 this.startStationTemplateFileMonitoring();
309 // Handle Socket incoming messages
310 this.wsConnection.on('message', this.onMessage.bind(this));
311 // Handle Socket error
312 this.wsConnection.on('error', this.onError.bind(this));
313 // Handle Socket close
314 this.wsConnection.on('close', this.onClose.bind(this));
315 // Handle Socket opening connection
316 this.wsConnection.on('open', this.onOpen.bind(this));
317 // Handle Socket ping
318 this.wsConnection.on('ping', this.onPing.bind(this));
319 // Handle Socket pong
320 this.wsConnection.on('pong', this.onPong.bind(this));
321 }
322
323 public async stop(reason: StopTransactionReason = StopTransactionReason.NONE): Promise<void> {
324 // Stop message sequence
325 await this.stopMessageSequence(reason);
326 for (const connector in this.connectors) {
327 if (Utils.convertToInt(connector) > 0) {
328 await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), ChargePointStatus.UNAVAILABLE);
329 this.getConnector(Utils.convertToInt(connector)).status = ChargePointStatus.UNAVAILABLE;
330 }
331 }
332 if (this.isWebSocketOpen()) {
333 this.wsConnection.close();
334 }
7874b0b1
JB
335 if (this.getEnableStatistics()) {
336 this.performanceStatistics.stop();
337 }
c0560973
JB
338 this.bootNotificationResponse = null;
339 this.hasStopped = true;
340 }
341
6e0964c8 342 public getConfigurationKey(key: string | StandardParametersKey, caseInsensitive = false): ConfigurationKey | undefined {
7874b0b1 343 return this.configuration.configurationKey.find((configElement) => {
c0560973
JB
344 if (caseInsensitive) {
345 return configElement.key.toLowerCase() === key.toLowerCase();
346 }
347 return configElement.key === key;
348 });
c0560973
JB
349 }
350
351 public addConfigurationKey(key: string | StandardParametersKey, value: string, readonly = false, visible = true, reboot = false): void {
352 const keyFound = this.getConfigurationKey(key);
353 if (!keyFound) {
354 this.configuration.configurationKey.push({
355 key,
356 readonly,
357 value,
358 visible,
359 reboot,
360 });
361 } else {
362 logger.error(`${this.logPrefix()} Trying to add an already existing configuration key: %j`, keyFound);
363 }
364 }
365
366 public setConfigurationKeyValue(key: string | StandardParametersKey, value: string): void {
367 const keyFound = this.getConfigurationKey(key);
368 if (keyFound) {
369 const keyIndex = this.configuration.configurationKey.indexOf(keyFound);
370 this.configuration.configurationKey[keyIndex].value = value;
371 } else {
372 logger.error(`${this.logPrefix()} Trying to set a value on a non existing configuration key: %j`, { key, value });
373 }
374 }
375
a7fc8211
JB
376 public setChargingProfile(connectorId: number, cp: ChargingProfile): void {
377 let cpReplaced = false;
c0560973 378 if (!Utils.isEmptyArray(this.getConnector(connectorId).chargingProfiles)) {
6e0964c8 379 this.getConnector(connectorId).chargingProfiles?.forEach((chargingProfile: ChargingProfile, index: number) => {
c0560973 380 if (chargingProfile.chargingProfileId === cp.chargingProfileId
8e4e1939 381 || (chargingProfile.stackLevel === cp.stackLevel && chargingProfile.chargingProfilePurpose === cp.chargingProfilePurpose)) {
c0560973 382 this.getConnector(connectorId).chargingProfiles[index] = cp;
a7fc8211 383 cpReplaced = true;
c0560973
JB
384 }
385 });
386 }
a7fc8211 387 !cpReplaced && this.getConnector(connectorId).chargingProfiles?.push(cp);
c0560973
JB
388 }
389
390 public resetTransactionOnConnector(connectorId: number): void {
163547b1 391 this.getConnector(connectorId).authorized = false;
6ed92bc1 392 this.getConnector(connectorId).transactionStarted = false;
163547b1 393 delete this.getConnector(connectorId).authorizeIdTag;
6ed92bc1 394 delete this.getConnector(connectorId).transactionId;
163547b1 395 delete this.getConnector(connectorId).transactionIdTag;
6ed92bc1 396 this.getConnector(connectorId).transactionEnergyActiveImportRegisterValue = 0;
fd0c36fa 397 delete this.getConnector(connectorId).transactionBeginMeterValue;
dd119a6b 398 this.stopMeterValues(connectorId);
2e6f5966
JB
399 }
400
77f00f84 401 public addToMessageQueue(message: string): void {
3ba2381e 402 let dups = false;
cb31c873 403 // Handle dups in message queue
3ba2381e 404 for (const bufferedMessage of this.messageQueue) {
cb31c873 405 // Message already in the queue
3ba2381e
JB
406 if (message === bufferedMessage) {
407 dups = true;
408 break;
409 }
410 }
411 if (!dups) {
cb31c873 412 // Queue message
3ba2381e
JB
413 this.messageQueue.push(message);
414 }
415 }
416
77f00f84
JB
417 private flushMessageQueue() {
418 if (!Utils.isEmptyArray(this.messageQueue)) {
419 this.messageQueue.forEach((message, index) => {
420 this.messageQueue.splice(index, 1);
aef1b33a 421 // TODO: evaluate the need to track performance
77f00f84
JB
422 this.wsConnection.send(message);
423 });
424 }
425 }
426
c0560973 427 private getChargingStationId(stationTemplate: ChargingStationTemplate): string {
ef6076c1 428 // In case of multiple instances: add instance index to charging station id
9ccca265 429 let instanceIndex = process.env.CF_INSTANCE_INDEX ?? 0;
ef6076c1 430 instanceIndex = instanceIndex > 0 ? instanceIndex : '';
9ccca265 431 const idSuffix = stationTemplate.nameSuffix ?? '';
ad2f27c3 432 return stationTemplate.fixedName ? stationTemplate.baseName : stationTemplate.baseName + '-' + instanceIndex.toString() + ('000000000' + this.index.toString()).substr(('000000000' + this.index.toString()).length - 4) + idSuffix;
5ad8570f
JB
433 }
434
c0560973 435 private buildStationInfo(): ChargingStationInfo {
9ac86a7e 436 let stationTemplateFromFile: ChargingStationTemplate;
5ad8570f
JB
437 try {
438 // Load template file
ad2f27c3 439 const fileDescriptor = fs.openSync(this.stationTemplateFile, 'r');
9ac86a7e 440 stationTemplateFromFile = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as ChargingStationTemplate;
5ad8570f
JB
441 fs.closeSync(fileDescriptor);
442 } catch (error) {
23132a44 443 FileUtils.handleFileException(this.logPrefix(), 'Template', this.stationTemplateFile, error);
5ad8570f 444 }
510f0fa5 445 const stationInfo: ChargingStationInfo = stationTemplateFromFile ?? {} as ChargingStationInfo;
0a60c33c 446 if (!Utils.isEmptyArray(stationTemplateFromFile.power)) {
9ac86a7e 447 stationTemplateFromFile.power = stationTemplateFromFile.power as number[];
510f0fa5
JB
448 const powerArrayRandomIndex = Math.floor(Math.random() * stationTemplateFromFile.power.length);
449 stationInfo.maxPower = stationTemplateFromFile.powerUnit === PowerUnits.KILO_WATT
450 ? stationTemplateFromFile.power[powerArrayRandomIndex] * 1000
451 : stationTemplateFromFile.power[powerArrayRandomIndex];
5ad8570f 452 } else {
510f0fa5
JB
453 stationTemplateFromFile.power = stationTemplateFromFile.power as number;
454 stationInfo.maxPower = stationTemplateFromFile.powerUnit === PowerUnits.KILO_WATT
fd0c36fa 455 ? stationTemplateFromFile.power * 1000
510f0fa5 456 : stationTemplateFromFile.power;
5ad8570f 457 }
fd0c36fa
JB
458 delete stationInfo.power;
459 delete stationInfo.powerUnit;
c0560973 460 stationInfo.chargingStationId = this.getChargingStationId(stationTemplateFromFile);
9ac86a7e
JB
461 stationInfo.resetTime = stationTemplateFromFile.resetTime ? stationTemplateFromFile.resetTime * 1000 : Constants.CHARGING_STATION_DEFAULT_RESET_TIME;
462 return stationInfo;
5ad8570f
JB
463 }
464
c0560973
JB
465 private getOCPPVersion(): OCPPVersion {
466 return this.stationInfo.ocppVersion ? this.stationInfo.ocppVersion : OCPPVersion.VERSION_16;
467 }
468
469 private handleUnsupportedVersion(version: OCPPVersion) {
470 const errMsg = `${this.logPrefix()} Unsupported protocol version '${version}' configured in template file ${this.stationTemplateFile}`;
471 logger.error(errMsg);
472 throw new Error(errMsg);
473 }
474
475 private initialize(): void {
476 this.stationInfo = this.buildStationInfo();
ad2f27c3
JB
477 this.bootNotificationRequest = {
478 chargePointModel: this.stationInfo.chargePointModel,
479 chargePointVendor: this.stationInfo.chargePointVendor,
480 ...!Utils.isUndefined(this.stationInfo.chargeBoxSerialNumberPrefix) && { chargeBoxSerialNumber: this.stationInfo.chargeBoxSerialNumberPrefix },
481 ...!Utils.isUndefined(this.stationInfo.firmwareVersion) && { firmwareVersion: this.stationInfo.firmwareVersion },
2e6f5966 482 };
c0560973 483 this.configuration = this.getTemplateChargingStationConfiguration();
57939a9d 484 this.wsConnectionUrl = new URL(this.getSupervisionURL().href + '/' + this.stationInfo.chargingStationId);
0a60c33c 485 // Build connectors if needed
c0560973 486 const maxConnectors = this.getMaxNumberOfConnectors();
6ecb15e4 487 if (maxConnectors <= 0) {
c0560973 488 logger.warn(`${this.logPrefix()} Charging station template ${this.stationTemplateFile} with ${maxConnectors} connectors`);
7abfea5f 489 }
c0560973 490 const templateMaxConnectors = this.getTemplateMaxNumberOfConnectors();
7abfea5f 491 if (templateMaxConnectors <= 0) {
c0560973 492 logger.warn(`${this.logPrefix()} Charging station template ${this.stationTemplateFile} with no connector configuration`);
593cf3f9 493 }
ad2f27c3 494 if (!this.stationInfo.Connectors[0]) {
c0560973 495 logger.warn(`${this.logPrefix()} Charging station template ${this.stationTemplateFile} with no connector Id 0 configuration`);
7abfea5f
JB
496 }
497 // Sanity check
ad2f27c3 498 if (maxConnectors > (this.stationInfo.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) && !this.stationInfo.randomConnectors) {
c0560973 499 logger.warn(`${this.logPrefix()} Number of connectors exceeds the number of connector configurations in template ${this.stationTemplateFile}, forcing random connector configurations affectation`);
ad2f27c3 500 this.stationInfo.randomConnectors = true;
6ecb15e4 501 }
ad2f27c3 502 const connectorsConfigHash = crypto.createHash('sha256').update(JSON.stringify(this.stationInfo.Connectors) + maxConnectors.toString()).digest('hex');
de1f5008 503 // FIXME: Handle shrinking the number of connectors
ad2f27c3
JB
504 if (!this.connectors || (this.connectors && this.connectorsConfigurationHash !== connectorsConfigHash)) {
505 this.connectorsConfigurationHash = connectorsConfigHash;
7abfea5f 506 // Add connector Id 0
6af9012e 507 let lastConnector = '0';
ad2f27c3 508 for (lastConnector in this.stationInfo.Connectors) {
c0560973 509 if (Utils.convertToInt(lastConnector) === 0 && this.getUseConnectorId0() && this.stationInfo.Connectors[lastConnector]) {
ad2f27c3
JB
510 this.connectors[lastConnector] = Utils.cloneObject<Connector>(this.stationInfo.Connectors[lastConnector]);
511 this.connectors[lastConnector].availability = AvailabilityType.OPERATIVE;
418106c8
JB
512 if (Utils.isUndefined(this.connectors[lastConnector]?.chargingProfiles)) {
513 this.connectors[lastConnector].chargingProfiles = [];
514 }
0a60c33c
JB
515 }
516 }
0a60c33c 517 // Generate all connectors
ad2f27c3 518 if ((this.stationInfo.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) > 0) {
7abfea5f 519 for (let index = 1; index <= maxConnectors; index++) {
5a20b4fd
JB
520 const randConnectorId = this.stationInfo.randomConnectors ? Utils.getRandomInt(Utils.convertToInt(lastConnector), 1) : index;
521 this.connectors[index] = Utils.cloneObject<Connector>(this.stationInfo.Connectors[randConnectorId]);
ad2f27c3 522 this.connectors[index].availability = AvailabilityType.OPERATIVE;
418106c8
JB
523 if (Utils.isUndefined(this.connectors[lastConnector]?.chargingProfiles)) {
524 this.connectors[index].chargingProfiles = [];
525 }
7abfea5f 526 }
0a60c33c
JB
527 }
528 }
d4a73fb7 529 // Avoid duplication of connectors related information
ad2f27c3 530 delete this.stationInfo.Connectors;
0a60c33c 531 // Initialize transaction attributes on connectors
ad2f27c3 532 for (const connector in this.connectors) {
593cf3f9 533 if (Utils.convertToInt(connector) > 0 && !this.getConnector(Utils.convertToInt(connector)).transactionStarted) {
6ed92bc1 534 this.initTransactionAttributesOnConnector(Utils.convertToInt(connector));
0a60c33c
JB
535 }
536 }
c0560973
JB
537 switch (this.getOCPPVersion()) {
538 case OCPPVersion.VERSION_16:
539 this.ocppIncomingRequestService = new OCPP16IncomingRequestService(this);
540 this.ocppRequestService = new OCPP16RequestService(this, new OCPP16ResponseService(this));
541 break;
542 default:
543 this.handleUnsupportedVersion(this.getOCPPVersion());
544 break;
545 }
7abfea5f 546 // OCPP parameters
147d0e0f 547 this.initOCPPParameters();
47e22477
JB
548 if (this.stationInfo.autoRegister) {
549 this.bootNotificationResponse = {
550 currentTime: new Date().toISOString(),
551 interval: this.getHeartbeatInterval() / 1000,
552 status: RegistrationStatus.ACCEPTED
553 };
554 }
147d0e0f
JB
555 this.stationInfo.powerDivider = this.getPowerDivider();
556 if (this.getEnableStatistics()) {
557 this.performanceStatistics = new PerformanceStatistics(this.stationInfo.chargingStationId);
147d0e0f
JB
558 }
559 }
560
561 private initOCPPParameters(): void {
36f6a92e
JB
562 if (!this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles)) {
563 this.addConfigurationKey(StandardParametersKey.SupportedFeatureProfiles, `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.Local_Auth_List_Management},${SupportedFeatureProfiles.Smart_Charging}`);
564 }
c0560973
JB
565 this.addConfigurationKey(StandardParametersKey.NumberOfConnectors, this.getNumberOfConnectors().toString(), true);
566 if (!this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData)) {
567 this.addConfigurationKey(StandardParametersKey.MeterValuesSampledData, MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER);
7abfea5f 568 }
7e1dc878
JB
569 if (!this.getConfigurationKey(StandardParametersKey.ConnectorPhaseRotation)) {
570 const connectorPhaseRotation = [];
571 for (const connector in this.connectors) {
572 // AC/DC
573 if (Utils.convertToInt(connector) === 0 && this.getNumberOfPhases() === 0) {
574 connectorPhaseRotation.push(`${connector}.${ConnectorPhaseRotation.RST}`);
575 } else if (Utils.convertToInt(connector) > 0 && this.getNumberOfPhases() === 0) {
576 connectorPhaseRotation.push(`${connector}.${ConnectorPhaseRotation.NotApplicable}`);
577 // AC
578 } else if (Utils.convertToInt(connector) > 0 && this.getNumberOfPhases() === 1) {
579 connectorPhaseRotation.push(`${connector}.${ConnectorPhaseRotation.NotApplicable}`);
580 } else if (Utils.convertToInt(connector) > 0 && this.getNumberOfPhases() === 3) {
581 connectorPhaseRotation.push(`${connector}.${ConnectorPhaseRotation.RST}`);
582 }
583 }
584 this.addConfigurationKey(StandardParametersKey.ConnectorPhaseRotation, connectorPhaseRotation.toString());
585 }
36f6a92e
JB
586 if (!this.getConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests)) {
587 this.addConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests, 'true');
588 }
589 if (!this.getConfigurationKey(StandardParametersKey.LocalAuthListEnabled)
590 && this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles).value.includes(SupportedFeatureProfiles.Local_Auth_List_Management)) {
591 this.addConfigurationKey(StandardParametersKey.LocalAuthListEnabled, 'false');
592 }
147d0e0f
JB
593 if (!this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) {
594 this.addConfigurationKey(StandardParametersKey.ConnectionTimeOut, Constants.DEFAULT_CONNECTION_TIMEOUT.toString());
8bce55bf 595 }
7dde0b73
JB
596 }
597
c0560973 598 private async onOpen(): Promise<void> {
e9017bfc 599 logger.info(`${this.logPrefix()} Connected to OCPP server through ${this.wsConnectionUrl.toString()}`);
c0560973
JB
600 if (!this.isRegistered()) {
601 // Send BootNotification
602 let registrationRetryCount = 0;
603 do {
43d673d9
JB
604 this.bootNotificationResponse = await this.ocppRequestService.sendBootNotification(this.bootNotificationRequest.chargePointModel,
605 this.bootNotificationRequest.chargePointVendor, this.bootNotificationRequest.chargeBoxSerialNumber, this.bootNotificationRequest.firmwareVersion);
c0560973
JB
606 if (!this.isRegistered()) {
607 registrationRetryCount++;
608 await Utils.sleep(this.bootNotificationResponse?.interval ? this.bootNotificationResponse.interval * 1000 : Constants.OCPP_DEFAULT_BOOT_NOTIFICATION_INTERVAL);
609 }
610 } while (!this.isRegistered() && (registrationRetryCount <= this.getRegistrationMaxRetries() || this.getRegistrationMaxRetries() === -1));
c7db4718
JB
611 }
612 if (this.isRegistered()) {
c0560973 613 await this.startMessageSequence();
3ba49ba9 614 this.hasStopped && (this.hasStopped = false);
c0560973 615 if (this.hasSocketRestarted && this.isWebSocketOpen()) {
77f00f84 616 this.flushMessageQueue();
2e6f5966
JB
617 }
618 } else {
c0560973 619 logger.error(`${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})`);
2e6f5966 620 }
c0560973
JB
621 this.autoReconnectRetryCount = 0;
622 this.hasSocketRestarted = false;
2e6f5966
JB
623 }
624
6e0964c8 625 private async onClose(closeEvent: any): Promise<void> {
c0560973
JB
626 switch (closeEvent) {
627 case WebSocketCloseEventStatusCode.CLOSE_NORMAL: // Normal close
628 case WebSocketCloseEventStatusCode.CLOSE_NO_STATUS:
629 logger.info(`${this.logPrefix()} Socket normally closed with status '${Utils.getWebSocketCloseEventStatusString(closeEvent)}'`);
630 this.autoReconnectRetryCount = 0;
631 break;
632 default: // Abnormal close
633 logger.error(`${this.logPrefix()} Socket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString(closeEvent)}'`);
634 await this.reconnect(closeEvent);
635 break;
636 }
2e6f5966
JB
637 }
638
c0560973
JB
639 private async onMessage(messageEvent: MessageEvent): Promise<void> {
640 let [messageType, messageId, commandName, commandPayload, errorDetails]: IncomingRequest = [0, '', '' as IncomingRequestCommand, {}, {}];
193d2c0a 641 let responseCallback: (payload: Record<string, unknown> | string, requestPayload: Record<string, unknown>) => void;
c0560973
JB
642 let rejectCallback: (error: OCPPError) => void;
643 let requestPayload: Record<string, unknown>;
644 let errMsg: string;
645 try {
47e22477
JB
646 const request = JSON.parse(messageEvent.toString()) as IncomingRequest;
647 if (Utils.isIterable(request)) {
648 // Parse the message
649 [messageType, messageId, commandName, commandPayload, errorDetails] = request;
650 } else {
651 throw new Error('Incoming request is not iterable');
652 }
c0560973
JB
653 // Check the Type of message
654 switch (messageType) {
655 // Incoming Message
656 case MessageType.CALL_MESSAGE:
657 if (this.getEnableStatistics()) {
aef1b33a 658 this.performanceStatistics.addRequestStatistic(commandName, messageType);
c0560973
JB
659 }
660 // Process the call
661 await this.ocppIncomingRequestService.handleRequest(messageId, commandName, commandPayload);
662 break;
663 // Outcome Message
664 case MessageType.CALL_RESULT_MESSAGE:
665 // Respond
666 if (Utils.isIterable(this.requests[messageId])) {
667 [responseCallback, , requestPayload] = this.requests[messageId];
668 } else {
669 throw new Error(`Response request for message id ${messageId} is not iterable`);
670 }
671 if (!responseCallback) {
672 // Error
673 throw new Error(`Response request for unknown message id ${messageId}`);
674 }
675 delete this.requests[messageId];
676 responseCallback(commandName, requestPayload);
677 break;
678 // Error Message
679 case MessageType.CALL_ERROR_MESSAGE:
680 if (!this.requests[messageId]) {
681 // Error
682 throw new Error(`Error request for unknown message id ${messageId}`);
683 }
684 if (Utils.isIterable(this.requests[messageId])) {
685 [, rejectCallback] = this.requests[messageId];
686 } else {
687 throw new Error(`Error request for message id ${messageId} is not iterable`);
688 }
689 delete this.requests[messageId];
690 rejectCallback(new OCPPError(commandName, commandPayload.toString(), errorDetails));
691 break;
692 // Error
693 default:
694 errMsg = `${this.logPrefix()} Wrong message type ${messageType}`;
695 logger.error(errMsg);
696 throw new Error(errMsg);
697 }
698 } catch (error) {
699 // Log
47e22477 700 logger.error('%s Incoming request message %j processing error %j on content type %j', this.logPrefix(), messageEvent, error, this.requests[messageId]);
c0560973
JB
701 // Send error
702 messageType !== MessageType.CALL_ERROR_MESSAGE && await this.ocppRequestService.sendError(messageId, error, commandName);
703 }
2328be1e
JB
704 }
705
c0560973 706 private onPing(): void {
57939a9d 707 logger.debug(this.logPrefix() + ' Received a WS ping (rfc6455) from the server');
c0560973
JB
708 }
709
710 private onPong(): void {
57939a9d 711 logger.debug(this.logPrefix() + ' Received a WS pong (rfc6455) from the server');
c0560973
JB
712 }
713
6e0964c8 714 private async onError(errorEvent: any): Promise<void> {
c0560973 715 logger.error(this.logPrefix() + ' Socket error: %j', errorEvent);
0a44f741 716 // switch (errorEvent.code) {
c0560973
JB
717 // case 'ECONNREFUSED':
718 // await this._reconnect(errorEvent);
719 // break;
720 // }
721 }
722
723 private getTemplateChargingStationConfiguration(): ChargingStationConfiguration {
7874b0b1 724 return this.stationInfo.Configuration ?? {} as ChargingStationConfiguration;
c0560973
JB
725 }
726
6e0964c8 727 private getAuthorizationFile(): string | undefined {
bf1866b2 728 return this.stationInfo.authorizationFile && path.join(path.resolve(__dirname, '../'), 'assets', path.basename(this.stationInfo.authorizationFile));
c0560973
JB
729 }
730
731 private getAuthorizedTags(): string[] {
732 let authorizedTags: string[] = [];
733 const authorizationFile = this.getAuthorizationFile();
734 if (authorizationFile) {
735 try {
736 // Load authorization file
737 const fileDescriptor = fs.openSync(authorizationFile, 'r');
738 authorizedTags = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as string[];
739 fs.closeSync(fileDescriptor);
740 } catch (error) {
23132a44 741 FileUtils.handleFileException(this.logPrefix(), 'Authorization', authorizationFile, error);
c0560973
JB
742 }
743 } else {
744 logger.info(this.logPrefix() + ' No authorization file given in template file ' + this.stationTemplateFile);
8c4da341 745 }
c0560973
JB
746 return authorizedTags;
747 }
748
6e0964c8 749 private getUseConnectorId0(): boolean | undefined {
c0560973 750 return !Utils.isUndefined(this.stationInfo.useConnectorId0) ? this.stationInfo.useConnectorId0 : true;
8bce55bf
JB
751 }
752
c0560973 753 private getNumberOfRunningTransactions(): number {
6ecb15e4 754 let trxCount = 0;
ad2f27c3 755 for (const connector in this.connectors) {
593cf3f9 756 if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionStarted) {
6ecb15e4
JB
757 trxCount++;
758 }
759 }
760 return trxCount;
761 }
762
1f761b9a 763 // 0 for disabling
6e0964c8 764 private getConnectionTimeout(): number | undefined {
291cb255
JB
765 if (this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) {
766 return parseInt(this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut).value) ?? Constants.DEFAULT_CONNECTION_TIMEOUT;
767 }
291cb255 768 return Constants.DEFAULT_CONNECTION_TIMEOUT;
3574dfd3
JB
769 }
770
1f761b9a 771 // -1 for unlimited, 0 for disabling
6e0964c8 772 private getAutoReconnectMaxRetries(): number | undefined {
ad2f27c3
JB
773 if (!Utils.isUndefined(this.stationInfo.autoReconnectMaxRetries)) {
774 return this.stationInfo.autoReconnectMaxRetries;
3574dfd3
JB
775 }
776 if (!Utils.isUndefined(Configuration.getAutoReconnectMaxRetries())) {
777 return Configuration.getAutoReconnectMaxRetries();
778 }
779 return -1;
780 }
781
ec977daf 782 // 0 for disabling
6e0964c8 783 private getRegistrationMaxRetries(): number | undefined {
ad2f27c3
JB
784 if (!Utils.isUndefined(this.stationInfo.registrationMaxRetries)) {
785 return this.stationInfo.registrationMaxRetries;
32a1eb7a
JB
786 }
787 return -1;
788 }
789
c0560973
JB
790 private getPowerDivider(): number {
791 let powerDivider = this.getNumberOfConnectors();
ad2f27c3 792 if (this.stationInfo.powerSharedByConnectors) {
c0560973 793 powerDivider = this.getNumberOfRunningTransactions();
6ecb15e4
JB
794 }
795 return powerDivider;
796 }
797
c0560973 798 private getTemplateMaxNumberOfConnectors(): number {
ad2f27c3 799 return Object.keys(this.stationInfo.Connectors).length;
7abfea5f
JB
800 }
801
c0560973 802 private getMaxNumberOfConnectors(): number {
5ad8570f 803 let maxConnectors = 0;
ad2f27c3
JB
804 if (!Utils.isEmptyArray(this.stationInfo.numberOfConnectors)) {
805 const numberOfConnectors = this.stationInfo.numberOfConnectors as number[];
6ecb15e4 806 // Distribute evenly the number of connectors
ad2f27c3
JB
807 maxConnectors = numberOfConnectors[(this.index - 1) % numberOfConnectors.length];
808 } else if (!Utils.isUndefined(this.stationInfo.numberOfConnectors)) {
809 maxConnectors = this.stationInfo.numberOfConnectors as number;
488fd3a7 810 } else {
c0560973 811 maxConnectors = this.stationInfo.Connectors[0] ? this.getTemplateMaxNumberOfConnectors() - 1 : this.getTemplateMaxNumberOfConnectors();
5ad8570f
JB
812 }
813 return maxConnectors;
2e6f5966
JB
814 }
815
c0560973 816 private getNumberOfConnectors(): number {
ad2f27c3 817 return this.connectors[0] ? Object.keys(this.connectors).length - 1 : Object.keys(this.connectors).length;
6ecb15e4
JB
818 }
819
c0560973 820 private async startMessageSequence(): Promise<void> {
136c90ba 821 // Start WebSocket ping
c0560973 822 this.startWebSocketPing();
5ad8570f 823 // Start heartbeat
c0560973 824 this.startHeartbeat();
0a60c33c 825 // Initialize connectors status
ad2f27c3 826 for (const connector in this.connectors) {
593cf3f9
JB
827 if (Utils.convertToInt(connector) === 0) {
828 continue;
ad2f27c3 829 } else if (!this.hasStopped && !this.getConnector(Utils.convertToInt(connector))?.status && this.getConnector(Utils.convertToInt(connector))?.bootStatus) {
136c90ba 830 // Send status in template at startup
c0560973
JB
831 await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).bootStatus);
832 this.getConnector(Utils.convertToInt(connector)).status = this.getConnector(Utils.convertToInt(connector)).bootStatus;
ad2f27c3 833 } else if (this.hasStopped && this.getConnector(Utils.convertToInt(connector))?.bootStatus) {
136c90ba 834 // Send status in template after reset
c0560973
JB
835 await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).bootStatus);
836 this.getConnector(Utils.convertToInt(connector)).status = this.getConnector(Utils.convertToInt(connector)).bootStatus;
ad2f27c3 837 } else if (!this.hasStopped && this.getConnector(Utils.convertToInt(connector))?.status) {
136c90ba 838 // Send previous status at template reload
c0560973 839 await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).status);
5ad8570f 840 } else {
136c90ba 841 // Send default status
c0560973
JB
842 await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), ChargePointStatus.AVAILABLE);
843 this.getConnector(Utils.convertToInt(connector)).status = ChargePointStatus.AVAILABLE;
5ad8570f
JB
844 }
845 }
0a60c33c 846 // Start the ATG
dd119a6b 847 this.startAutomaticTransactionGenerator();
dd119a6b
JB
848 }
849
850 private startAutomaticTransactionGenerator() {
ad2f27c3
JB
851 if (this.stationInfo.AutomaticTransactionGenerator.enable) {
852 if (!this.automaticTransactionGeneration) {
853 this.automaticTransactionGeneration = new AutomaticTransactionGenerator(this);
5ad8570f 854 }
ad2f27c3 855 if (this.automaticTransactionGeneration.timeToStop) {
a1256107
JB
856 // The ATG might sleep
857 void this.automaticTransactionGeneration.start();
5ad8570f
JB
858 }
859 }
5ad8570f
JB
860 }
861
c0560973 862 private async stopMessageSequence(reason: StopTransactionReason = StopTransactionReason.NONE): Promise<void> {
136c90ba 863 // Stop WebSocket ping
c0560973 864 this.stopWebSocketPing();
79411696 865 // Stop heartbeat
c0560973 866 this.stopHeartbeat();
79411696 867 // Stop the ATG
ad2f27c3
JB
868 if (this.stationInfo.AutomaticTransactionGenerator.enable &&
869 this.automaticTransactionGeneration &&
870 !this.automaticTransactionGeneration.timeToStop) {
871 await this.automaticTransactionGeneration.stop(reason);
79411696 872 } else {
ad2f27c3 873 for (const connector in this.connectors) {
593cf3f9 874 if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionStarted) {
c0560973 875 const transactionId = this.getConnector(Utils.convertToInt(connector)).transactionId;
6ed92bc1
JB
876 await this.ocppRequestService.sendStopTransaction(transactionId, this.getEnergyActiveImportRegisterByTransactionId(transactionId),
877 this.getTransactionIdTag(transactionId), reason);
79411696
JB
878 }
879 }
880 }
881 }
882
c0560973 883 private startWebSocketPing(): void {
9cd3dfb0
JB
884 const webSocketPingInterval: number = this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval)
885 ? Utils.convertToInt(this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval).value)
886 : 0;
ad2f27c3
JB
887 if (webSocketPingInterval > 0 && !this.webSocketPingSetInterval) {
888 this.webSocketPingSetInterval = setInterval(() => {
c0560973 889 if (this.isWebSocketOpen()) {
ad2f27c3 890 this.wsConnection.ping((): void => { });
136c90ba
JB
891 }
892 }, webSocketPingInterval * 1000);
c0560973 893 logger.info(this.logPrefix() + ' WebSocket ping started every ' + Utils.secondsToHHMMSS(webSocketPingInterval));
ad2f27c3 894 } else if (this.webSocketPingSetInterval) {
c0560973 895 logger.info(this.logPrefix() + ' WebSocket ping every ' + Utils.secondsToHHMMSS(webSocketPingInterval) + ' already started');
136c90ba 896 } else {
c0560973 897 logger.error(`${this.logPrefix()} WebSocket ping interval set to ${webSocketPingInterval ? Utils.secondsToHHMMSS(webSocketPingInterval) : webSocketPingInterval}, not starting the WebSocket ping`);
136c90ba
JB
898 }
899 }
900
c0560973 901 private stopWebSocketPing(): void {
ad2f27c3
JB
902 if (this.webSocketPingSetInterval) {
903 clearInterval(this.webSocketPingSetInterval);
136c90ba
JB
904 }
905 }
906
57939a9d 907 private getSupervisionURL(): URL {
c0560973
JB
908 const supervisionUrls = Utils.cloneObject<string | string[]>(this.stationInfo.supervisionURL ? this.stationInfo.supervisionURL : Configuration.getSupervisionURLs());
909 let indexUrl = 0;
910 if (!Utils.isEmptyArray(supervisionUrls)) {
911 if (Configuration.getDistributeStationsToTenantsEqually()) {
912 indexUrl = this.index % supervisionUrls.length;
913 } else {
914 // Get a random url
915 indexUrl = Math.floor(Math.random() * supervisionUrls.length);
916 }
57939a9d 917 return new URL(supervisionUrls[indexUrl]);
c0560973 918 }
57939a9d 919 return new URL(supervisionUrls as string);
136c90ba
JB
920 }
921
6e0964c8 922 private getHeartbeatInterval(): number | undefined {
c0560973
JB
923 const HeartbeatInterval = this.getConfigurationKey(StandardParametersKey.HeartbeatInterval);
924 if (HeartbeatInterval) {
925 return Utils.convertToInt(HeartbeatInterval.value) * 1000;
926 }
927 const HeartBeatInterval = this.getConfigurationKey(StandardParametersKey.HeartBeatInterval);
928 if (HeartBeatInterval) {
929 return Utils.convertToInt(HeartBeatInterval.value) * 1000;
0a60c33c 930 }
47e22477
JB
931 !this.stationInfo.autoRegister && logger.warn(`${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${Constants.DEFAULT_HEARTBEAT_INTERVAL}`);
932 return Constants.DEFAULT_HEARTBEAT_INTERVAL;
0a60c33c
JB
933 }
934
c0560973 935 private stopHeartbeat(): void {
ad2f27c3
JB
936 if (this.heartbeatSetInterval) {
937 clearInterval(this.heartbeatSetInterval);
7dde0b73 938 }
5ad8570f
JB
939 }
940
c0560973 941 private openWSConnection(options?: WebSocket.ClientOptions, forceCloseOpened = false): void {
ee6fd7d1
JB
942 options ?? {} as WebSocket.ClientOptions;
943 options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000;
c0560973
JB
944 if (this.isWebSocketOpen() && forceCloseOpened) {
945 this.wsConnection.close();
946 }
947 let protocol;
948 switch (this.getOCPPVersion()) {
949 case OCPPVersion.VERSION_16:
950 protocol = 'ocpp' + OCPPVersion.VERSION_16;
951 break;
952 default:
953 this.handleUnsupportedVersion(this.getOCPPVersion());
954 break;
955 }
956 this.wsConnection = new WebSocket(this.wsConnectionUrl, protocol, options);
e9017bfc 957 logger.info(this.logPrefix() + ' Open OCPP connection to URL ' + this.wsConnectionUrl.toString());
136c90ba
JB
958 }
959
dd119a6b
JB
960 private stopMeterValues(connectorId: number) {
961 if (this.getConnector(connectorId)?.transactionSetInterval) {
962 clearInterval(this.getConnector(connectorId).transactionSetInterval);
963 }
964 }
965
c0560973 966 private startAuthorizationFileMonitoring(): void {
23132a44
JB
967 const authorizationFile = this.getAuthorizationFile();
968 if (authorizationFile) {
5ad8570f 969 try {
fd0c36fa 970 fs.watch(authorizationFile).on('change', () => {
23132a44
JB
971 try {
972 logger.debug(this.logPrefix() + ' Authorization file ' + authorizationFile + ' have changed, reload');
973 // Initialize authorizedTags
974 this.authorizedTags = this.getAuthorizedTags();
975 } catch (error) {
976 logger.error(this.logPrefix() + ' Authorization file monitoring error: %j', error);
977 }
978 });
5ad8570f 979 } catch (error) {
23132a44 980 FileUtils.handleFileException(this.logPrefix(), 'Authorization', authorizationFile, error);
5ad8570f 981 }
23132a44
JB
982 } else {
983 logger.info(this.logPrefix() + ' No authorization file given in template file ' + this.stationTemplateFile + '. Not monitoring changes');
984 }
5ad8570f
JB
985 }
986
c0560973 987 private startStationTemplateFileMonitoring(): void {
23132a44 988 try {
fd0c36fa
JB
989 // eslint-disable-next-line @typescript-eslint/no-misused-promises
990 fs.watch(this.stationTemplateFile).on('change', async (): Promise<void> => {
23132a44
JB
991 try {
992 logger.debug(this.logPrefix() + ' Template file ' + this.stationTemplateFile + ' have changed, reload');
993 // Initialize
994 this.initialize();
995 // Stop the ATG
996 if (!this.stationInfo.AutomaticTransactionGenerator.enable &&
ad2f27c3 997 this.automaticTransactionGeneration) {
23132a44
JB
998 await this.automaticTransactionGeneration.stop();
999 }
1000 // Start the ATG
1001 this.startAutomaticTransactionGenerator();
1002 // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed
1003 } catch (error) {
1004 logger.error(this.logPrefix() + ' Charging station template file monitoring error: %j', error);
79411696 1005 }
23132a44
JB
1006 });
1007 } catch (error) {
1008 FileUtils.handleFileException(this.logPrefix(), 'Template', this.stationTemplateFile, error);
1009 }
5ad8570f
JB
1010 }
1011
6e0964c8 1012 private getReconnectExponentialDelay(): boolean | undefined {
c0560973 1013 return !Utils.isUndefined(this.stationInfo.reconnectExponentialDelay) ? this.stationInfo.reconnectExponentialDelay : false;
5ad8570f
JB
1014 }
1015
6e0964c8 1016 private async reconnect(error: any): Promise<void> {
7874b0b1
JB
1017 // Stop WebSocket ping
1018 this.stopWebSocketPing();
136c90ba 1019 // Stop heartbeat
c0560973 1020 this.stopHeartbeat();
5ad8570f 1021 // Stop the ATG if needed
ad2f27c3
JB
1022 if (this.stationInfo.AutomaticTransactionGenerator.enable &&
1023 this.stationInfo.AutomaticTransactionGenerator.stopOnConnectionFailure &&
1024 this.automaticTransactionGeneration &&
1025 !this.automaticTransactionGeneration.timeToStop) {
dd119a6b 1026 await this.automaticTransactionGeneration.stop();
ad2f27c3 1027 }
c0560973 1028 if (this.autoReconnectRetryCount < this.getAutoReconnectMaxRetries() || this.getAutoReconnectMaxRetries() === -1) {
ad2f27c3 1029 this.autoReconnectRetryCount++;
c0560973
JB
1030 const reconnectDelay = (this.getReconnectExponentialDelay() ? Utils.exponentialDelay(this.autoReconnectRetryCount) : this.getConnectionTimeout() * 1000);
1031 logger.error(`${this.logPrefix()} Socket: connection retry in ${Utils.roundTo(reconnectDelay, 2)}ms, timeout ${reconnectDelay - 100}ms`);
032d6efc 1032 await Utils.sleep(reconnectDelay);
c0560973
JB
1033 logger.error(this.logPrefix() + ' Socket: reconnecting try #' + this.autoReconnectRetryCount.toString());
1034 this.openWSConnection({ handshakeTimeout: reconnectDelay - 100 });
ad2f27c3 1035 this.hasSocketRestarted = true;
c0560973
JB
1036 } else if (this.getAutoReconnectMaxRetries() !== -1) {
1037 logger.error(`${this.logPrefix()} Socket reconnect failure: max retries reached (${this.autoReconnectRetryCount}) or retry disabled (${this.getAutoReconnectMaxRetries()})`);
5ad8570f
JB
1038 }
1039 }
1040
6ed92bc1 1041 private initTransactionAttributesOnConnector(connectorId: number): void {
163547b1 1042 this.getConnector(connectorId).authorized = false;
8bce55bf 1043 this.getConnector(connectorId).transactionStarted = false;
6ed92bc1
JB
1044 this.getConnector(connectorId).energyActiveImportRegisterValue = 0;
1045 this.getConnector(connectorId).transactionEnergyActiveImportRegisterValue = 0;
0a60c33c 1046 }
7dde0b73
JB
1047}
1048