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