Track ATG status on a per connector basis.
[e-mobility-charging-stations-simulator.git] / src / charging-station / ChargingStation.ts
CommitLineData
b4d34251
JB
1// Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
2
16b0d4e7 3import { AvailabilityType, BootNotificationRequest, IncomingRequest, IncomingRequestCommand, Request } from '../types/ocpp/Requests';
efa43e52 4import { BootNotificationResponse, RegistrationStatus } from '../types/ocpp/Responses';
e118beaa 5import ChargingStationConfiguration, { ConfigurationKey } from '../types/ChargingStationConfiguration';
4c2b4904 6import ChargingStationTemplate, { CurrentType, PowerUnits, Voltage } from '../types/ChargingStationTemplate';
2d7040b2 7import { Connector, Connectors, SampledValueTemplate } from '../types/Connectors';
7e1dc878 8import { ConnectorPhaseRotation, StandardParametersKey, SupportedFeatureProfiles } from '../types/ocpp/Configuration';
9ccca265 9import { MeterValueMeasurand, MeterValuePhase } from '../types/ocpp/MeterValues';
16b0d4e7 10import { WSError, WebSocketCloseEventStatusCode } from '../types/WebSocket';
58fad749 11import WebSocket, { ClientOptions, Data, OPEN } from 'ws';
3f40bc9c 12
6af9012e 13import AutomaticTransactionGenerator from './AutomaticTransactionGenerator';
c0560973
JB
14import { ChargePointStatus } from '../types/ocpp/ChargePointStatus';
15import { ChargingProfile } from '../types/ocpp/ChargingProfile';
9ac86a7e 16import ChargingStationInfo from '../types/ChargingStationInfo';
15042c5f 17import { ClientRequestArgs } from 'http';
6af9012e 18import Configuration from '../utils/Configuration';
63b48f77 19import Constants from '../utils/Constants';
14763b46 20import { ErrorType } from '../types/ocpp/ErrorType';
23132a44 21import FileUtils from '../utils/FileUtils';
d2a64eb5 22import { MessageType } from '../types/ocpp/MessageType';
e7171280 23import OCPP16IncomingRequestService from './ocpp/1.6/OCPP16IncomingRequestService';
c0560973
JB
24import OCPP16RequestService from './ocpp/1.6/OCPP16RequestService';
25import OCPP16ResponseService from './ocpp/1.6/OCPP16ResponseService';
14763b46 26import OCPPError from './ocpp/OCPPError';
c0560973
JB
27import OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService';
28import OCPPRequestService from './ocpp/OCPPRequestService';
29import { OCPPVersion } from '../types/ocpp/OCPPVersion';
a6b3c6c3 30import PerformanceStatistics from '../performance/PerformanceStatistics';
c0560973 31import { StopTransactionReason } from '../types/ocpp/Transaction';
57939a9d 32import { URL } from 'url';
6af9012e 33import Utils from '../utils/Utils';
3f40bc9c
JB
34import crypto from 'crypto';
35import fs from 'fs';
6af9012e 36import logger from '../utils/Logger';
bf1866b2 37import path from 'path';
3f40bc9c
JB
38
39export default class ChargingStation {
c0560973
JB
40 public stationTemplateFile: string;
41 public authorizedTags: string[];
6e0964c8 42 public stationInfo!: ChargingStationInfo;
ad2f27c3 43 public connectors: Connectors;
6e0964c8 44 public configuration!: ChargingStationConfiguration;
6e0964c8 45 public wsConnection!: WebSocket;
16b0d4e7 46 public requests: Map<string, Request>;
6e0964c8
JB
47 public performanceStatistics!: PerformanceStatistics;
48 public heartbeatSetInterval!: NodeJS.Timeout;
6e0964c8 49 public ocppRequestService!: OCPPRequestService;
ad2f27c3 50 private index: number;
6e0964c8
JB
51 private bootNotificationRequest!: BootNotificationRequest;
52 private bootNotificationResponse!: BootNotificationResponse | null;
53 private connectorsConfigurationHash!: string;
a472cf2b
JB
54 private ocppIncomingRequestService!: OCPPIncomingRequestService;
55 private messageQueue: string[];
57939a9d 56 private wsConnectionUrl!: URL;
265e4266 57 private wsConnectionRestarted: boolean;
a472cf2b 58 private stopped: boolean;
ad2f27c3 59 private autoReconnectRetryCount: number;
265e4266 60 private automaticTransactionGenerator!: AutomaticTransactionGenerator;
6e0964c8 61 private webSocketPingSetInterval!: NodeJS.Timeout;
6af9012e
JB
62
63 constructor(index: number, stationTemplateFile: string) {
ad2f27c3
JB
64 this.index = index;
65 this.stationTemplateFile = stationTemplateFile;
66 this.connectors = {} as Connectors;
c0560973 67 this.initialize();
2e6f5966 68
265e4266
JB
69 this.stopped = false;
70 this.wsConnectionRestarted = false;
ad2f27c3 71 this.autoReconnectRetryCount = 0;
2e6f5966 72
16b0d4e7
JB
73 this.requests = new Map<string, Request>();
74 this.messageQueue = new Array<string>();
2e6f5966 75
c0560973
JB
76 this.authorizedTags = this.getAuthorizedTags();
77 }
78
79 public logPrefix(): string {
54b1efe0 80 return Utils.logPrefix(` ${this.stationInfo.chargingStationId} |`);
c0560973
JB
81 }
82
802cfa13
JB
83 public getBootNotificationRequest(): BootNotificationRequest {
84 return this.bootNotificationRequest;
85 }
86
f4bf2abd 87 public getRandomIdTag(): string {
c37528f1 88 const index = Math.floor(Utils.secureRandom() * this.authorizedTags.length);
c0560973
JB
89 return this.authorizedTags[index];
90 }
91
92 public hasAuthorizedTags(): boolean {
93 return !Utils.isEmptyArray(this.authorizedTags);
94 }
95
6e0964c8 96 public getEnableStatistics(): boolean | undefined {
c0560973
JB
97 return !Utils.isUndefined(this.stationInfo.enableStatistics) ? this.stationInfo.enableStatistics : true;
98 }
99
a7fc8211
JB
100 public getMayAuthorizeAtRemoteStart(): boolean | undefined {
101 return this.stationInfo.mayAuthorizeAtRemoteStart ?? true;
102 }
103
6e0964c8 104 public getNumberOfPhases(): number | undefined {
7decf1b6 105 switch (this.getCurrentOutType()) {
4c2b4904 106 case CurrentType.AC:
c0560973 107 return !Utils.isUndefined(this.stationInfo.numberOfPhases) ? this.stationInfo.numberOfPhases : 3;
4c2b4904 108 case CurrentType.DC:
c0560973
JB
109 return 0;
110 }
111 }
112
d5bff457 113 public isWebSocketConnectionOpened(): boolean {
58fad749 114 return this.wsConnection?.readyState === OPEN;
c0560973
JB
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
4c2b4904
JB
133 public getCurrentOutType(): CurrentType | undefined {
134 return this.stationInfo.currentOutType ?? CurrentType.AC;
c0560973
JB
135 }
136
6e0964c8 137 public getVoltageOut(): number | undefined {
7decf1b6 138 const errMsg = `${this.logPrefix()} Unknown ${this.getCurrentOutType()} currentOutType in template file ${this.stationTemplateFile}, cannot define default voltage out`;
c0560973 139 let defaultVoltageOut: number;
7decf1b6 140 switch (this.getCurrentOutType()) {
4c2b4904
JB
141 case CurrentType.AC:
142 defaultVoltageOut = Voltage.VOLTAGE_230;
c0560973 143 break;
4c2b4904
JB
144 case CurrentType.DC:
145 defaultVoltageOut = Voltage.VOLTAGE_400;
c0560973
JB
146 break;
147 default:
148 logger.error(errMsg);
290d006c 149 throw new Error(errMsg);
c0560973
JB
150 }
151 return !Utils.isUndefined(this.stationInfo.voltageOut) ? this.stationInfo.voltageOut : defaultVoltageOut;
152 }
153
6e0964c8 154 public getTransactionIdTag(transactionId: number): string | undefined {
c0560973
JB
155 for (const connector in this.connectors) {
156 if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) {
163547b1 157 return this.getConnector(Utils.convertToInt(connector)).transactionIdTag;
c0560973
JB
158 }
159 }
160 }
161
6ed92bc1
JB
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
fd0c36fa
JB
174 public getTransactionDataMeterValues(): boolean {
175 return this.stationInfo.transactionDataMeterValues ?? false;
176 }
177
9ccca265
JB
178 public getMainVoltageMeterValues(): boolean {
179 return this.stationInfo.mainVoltageMeterValues ?? true;
180 }
181
6b10669b
JB
182 public getPhaseLineToLineVoltageMeterValues(): boolean {
183 return this.stationInfo.phaseLineToLineVoltageMeterValues ?? false;
9bd87386
JB
184 }
185
6ed92bc1
JB
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 }
c0560973
JB
194 for (const connector in this.connectors) {
195 if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) {
6ed92bc1 196 return this.getConnector(Utils.convertToInt(connector)).energyActiveImportRegisterValue;
c0560973
JB
197 }
198 }
199 }
200
6ed92bc1
JB
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
c0560973
JB
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
9ccca265
JB
225 public getSampledValueTemplate(connectorId: number, measurand: MeterValueMeasurand = MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER,
226 phase?: MeterValuePhase): SampledValueTemplate | undefined {
227 if (!Constants.SUPPORTED_MEASURANDS.includes(measurand)) {
7d75bee1 228 logger.warn(`${this.logPrefix()} Trying to get unsupported MeterValues measurand '${measurand}' ${phase ? `on phase ${phase} ` : ''}in template on connectorId ${connectorId}`);
9bd87386
JB
229 return;
230 }
231 if (measurand !== MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER && !this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes(measurand)) {
7d75bee1 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`);
9ccca265
JB
233 return;
234 }
235 const sampledValueTemplates: SampledValueTemplate[] = this.getConnector(connectorId).MeterValues;
9ccca265 236 for (let index = 0; !Utils.isEmptyArray(sampledValueTemplates) && index < sampledValueTemplates.length; index++) {
290d006c 237 if (!Constants.SUPPORTED_MEASURANDS.includes(sampledValueTemplates[index]?.measurand ?? MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER)) {
7d75bee1 238 logger.warn(`${this.logPrefix()} Unsupported MeterValues measurand '${measurand}' ${phase ? `on phase ${phase} ` : ''}in template on connectorId ${connectorId}`);
47e22477 239 } else if (phase && sampledValueTemplates[index]?.phase === phase && sampledValueTemplates[index]?.measurand === measurand
3ec10737 240 && this.getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes(measurand)) {
9ccca265
JB
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)) {
9ccca265
JB
247 return sampledValueTemplates[index];
248 }
249 }
9bd87386 250 if (measurand === MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER) {
7d75bee1 251 const errorMsg = `${this.logPrefix()} Missing MeterValues for default measurand '${measurand}' in template on connectorId ${connectorId}`;
de96acad
JB
252 logger.error(errorMsg);
253 throw new Error(errorMsg);
9ccca265 254 }
7d75bee1 255 logger.debug(`${this.logPrefix()} No MeterValues for measurand '${measurand}' ${phase ? `on phase ${phase} ` : ''}in template on connectorId ${connectorId}`);
9ccca265
JB
256 }
257
e644918b
JB
258 public getAutomaticTransactionGeneratorRequireAuthorize(): boolean {
259 return this.stationInfo.AutomaticTransactionGenerator.requireAuthorize ?? true;
260 }
261
c0560973
JB
262 public startHeartbeat(): void {
263 if (this.getHeartbeatInterval() && this.getHeartbeatInterval() > 0 && !this.heartbeatSetInterval) {
71623267
JB
264 // eslint-disable-next-line @typescript-eslint/no-misused-promises
265 this.heartbeatSetInterval = setInterval(async (): Promise<void> => {
c0560973
JB
266 await this.ocppRequestService.sendHeartbeat();
267 }, this.getHeartbeatInterval());
d7d1db72 268 logger.info(this.logPrefix() + ' Heartbeat started every ' + Utils.formatDurationMilliSeconds(this.getHeartbeatInterval()));
c0560973 269 } else if (this.heartbeatSetInterval) {
d7d1db72 270 logger.info(this.logPrefix() + ' Heartbeat already started every ' + Utils.formatDurationMilliSeconds(this.getHeartbeatInterval()));
c0560973 271 } else {
d7d1db72 272 logger.error(`${this.logPrefix()} Heartbeat interval set to ${this.getHeartbeatInterval() ? Utils.formatDurationMilliSeconds(this.getHeartbeatInterval()) : this.getHeartbeatInterval()}, not starting the heartbeat`);
c0560973
JB
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) {
71623267
JB
300 // eslint-disable-next-line @typescript-eslint/no-misused-promises
301 this.getConnector(connectorId).transactionSetInterval = setInterval(async (): Promise<void> => {
aef1b33a 302 await this.ocppRequestService.sendMeterValues(connectorId, this.getConnector(connectorId).transactionId, interval);
c0560973
JB
303 }, interval);
304 } else {
d7d1db72 305 logger.error(`${this.logPrefix()} Charging station ${StandardParametersKey.MeterValueSampleInterval} configuration set to ${interval ? Utils.formatDurationMilliSeconds(interval) : interval}, not sending MeterValues`);
c0560973
JB
306 }
307 }
308
309 public start(): void {
7874b0b1
JB
310 if (this.getEnableStatistics()) {
311 this.performanceStatistics.start();
312 }
c0560973
JB
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 }
d5bff457 341 if (this.isWebSocketConnectionOpened()) {
c0560973
JB
342 this.wsConnection.close();
343 }
7874b0b1
JB
344 if (this.getEnableStatistics()) {
345 this.performanceStatistics.stop();
346 }
c0560973 347 this.bootNotificationResponse = null;
265e4266 348 this.stopped = true;
c0560973
JB
349 }
350
6e0964c8 351 public getConfigurationKey(key: string | StandardParametersKey, caseInsensitive = false): ConfigurationKey | undefined {
7874b0b1 352 return this.configuration.configurationKey.find((configElement) => {
c0560973
JB
353 if (caseInsensitive) {
354 return configElement.key.toLowerCase() === key.toLowerCase();
355 }
356 return configElement.key === key;
357 });
c0560973
JB
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
a7fc8211
JB
385 public setChargingProfile(connectorId: number, cp: ChargingProfile): void {
386 let cpReplaced = false;
c0560973 387 if (!Utils.isEmptyArray(this.getConnector(connectorId).chargingProfiles)) {
6e0964c8 388 this.getConnector(connectorId).chargingProfiles?.forEach((chargingProfile: ChargingProfile, index: number) => {
c0560973 389 if (chargingProfile.chargingProfileId === cp.chargingProfileId
8e4e1939 390 || (chargingProfile.stackLevel === cp.stackLevel && chargingProfile.chargingProfilePurpose === cp.chargingProfilePurpose)) {
c0560973 391 this.getConnector(connectorId).chargingProfiles[index] = cp;
a7fc8211 392 cpReplaced = true;
c0560973
JB
393 }
394 });
395 }
a7fc8211 396 !cpReplaced && this.getConnector(connectorId).chargingProfiles?.push(cp);
c0560973
JB
397 }
398
399 public resetTransactionOnConnector(connectorId: number): void {
163547b1 400 this.getConnector(connectorId).authorized = false;
6ed92bc1 401 this.getConnector(connectorId).transactionStarted = false;
163547b1 402 delete this.getConnector(connectorId).authorizeIdTag;
6ed92bc1 403 delete this.getConnector(connectorId).transactionId;
163547b1 404 delete this.getConnector(connectorId).transactionIdTag;
6ed92bc1 405 this.getConnector(connectorId).transactionEnergyActiveImportRegisterValue = 0;
fd0c36fa 406 delete this.getConnector(connectorId).transactionBeginMeterValue;
dd119a6b 407 this.stopMeterValues(connectorId);
2e6f5966
JB
408 }
409
77f00f84 410 public addToMessageQueue(message: string): void {
3ba2381e 411 let dups = false;
cb31c873 412 // Handle dups in message queue
3ba2381e 413 for (const bufferedMessage of this.messageQueue) {
cb31c873 414 // Message already in the queue
3ba2381e
JB
415 if (message === bufferedMessage) {
416 dups = true;
417 break;
418 }
419 }
420 if (!dups) {
cb31c873 421 // Queue message
3ba2381e
JB
422 this.messageQueue.push(message);
423 }
424 }
425
77f00f84
JB
426 private flushMessageQueue() {
427 if (!Utils.isEmptyArray(this.messageQueue)) {
428 this.messageQueue.forEach((message, index) => {
429 this.messageQueue.splice(index, 1);
aef1b33a 430 // TODO: evaluate the need to track performance
77f00f84
JB
431 this.wsConnection.send(message);
432 });
433 }
434 }
435
c0560973 436 private getChargingStationId(stationTemplate: ChargingStationTemplate): string {
ef6076c1 437 // In case of multiple instances: add instance index to charging station id
203bc097 438 const instanceIndex = process.env.CF_INSTANCE_INDEX ?? 0;
9ccca265 439 const idSuffix = stationTemplate.nameSuffix ?? '';
ad2f27c3 440 return stationTemplate.fixedName ? stationTemplate.baseName : stationTemplate.baseName + '-' + instanceIndex.toString() + ('000000000' + this.index.toString()).substr(('000000000' + this.index.toString()).length - 4) + idSuffix;
5ad8570f
JB
441 }
442
c0560973 443 private buildStationInfo(): ChargingStationInfo {
9ac86a7e 444 let stationTemplateFromFile: ChargingStationTemplate;
5ad8570f
JB
445 try {
446 // Load template file
ad2f27c3 447 const fileDescriptor = fs.openSync(this.stationTemplateFile, 'r');
9ac86a7e 448 stationTemplateFromFile = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as ChargingStationTemplate;
5ad8570f
JB
449 fs.closeSync(fileDescriptor);
450 } catch (error) {
23132a44 451 FileUtils.handleFileException(this.logPrefix(), 'Template', this.stationTemplateFile, error);
5ad8570f 452 }
510f0fa5 453 const stationInfo: ChargingStationInfo = stationTemplateFromFile ?? {} as ChargingStationInfo;
0a60c33c 454 if (!Utils.isEmptyArray(stationTemplateFromFile.power)) {
9ac86a7e 455 stationTemplateFromFile.power = stationTemplateFromFile.power as number[];
c37528f1 456 const powerArrayRandomIndex = Math.floor(Utils.secureRandom() * stationTemplateFromFile.power.length);
510f0fa5
JB
457 stationInfo.maxPower = stationTemplateFromFile.powerUnit === PowerUnits.KILO_WATT
458 ? stationTemplateFromFile.power[powerArrayRandomIndex] * 1000
459 : stationTemplateFromFile.power[powerArrayRandomIndex];
5ad8570f 460 } else {
510f0fa5
JB
461 stationTemplateFromFile.power = stationTemplateFromFile.power as number;
462 stationInfo.maxPower = stationTemplateFromFile.powerUnit === PowerUnits.KILO_WATT
fd0c36fa 463 ? stationTemplateFromFile.power * 1000
510f0fa5 464 : stationTemplateFromFile.power;
5ad8570f 465 }
fd0c36fa
JB
466 delete stationInfo.power;
467 delete stationInfo.powerUnit;
c0560973 468 stationInfo.chargingStationId = this.getChargingStationId(stationTemplateFromFile);
9ac86a7e
JB
469 stationInfo.resetTime = stationTemplateFromFile.resetTime ? stationTemplateFromFile.resetTime * 1000 : Constants.CHARGING_STATION_DEFAULT_RESET_TIME;
470 return stationInfo;
5ad8570f
JB
471 }
472
c0560973
JB
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();
ad2f27c3
JB
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 },
2e6f5966 490 };
c0560973 491 this.configuration = this.getTemplateChargingStationConfiguration();
57939a9d 492 this.wsConnectionUrl = new URL(this.getSupervisionURL().href + '/' + this.stationInfo.chargingStationId);
0a60c33c 493 // Build connectors if needed
c0560973 494 const maxConnectors = this.getMaxNumberOfConnectors();
6ecb15e4 495 if (maxConnectors <= 0) {
c0560973 496 logger.warn(`${this.logPrefix()} Charging station template ${this.stationTemplateFile} with ${maxConnectors} connectors`);
7abfea5f 497 }
c0560973 498 const templateMaxConnectors = this.getTemplateMaxNumberOfConnectors();
7abfea5f 499 if (templateMaxConnectors <= 0) {
c0560973 500 logger.warn(`${this.logPrefix()} Charging station template ${this.stationTemplateFile} with no connector configuration`);
593cf3f9 501 }
ad2f27c3 502 if (!this.stationInfo.Connectors[0]) {
c0560973 503 logger.warn(`${this.logPrefix()} Charging station template ${this.stationTemplateFile} with no connector Id 0 configuration`);
7abfea5f
JB
504 }
505 // Sanity check
ad2f27c3 506 if (maxConnectors > (this.stationInfo.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) && !this.stationInfo.randomConnectors) {
c0560973 507 logger.warn(`${this.logPrefix()} Number of connectors exceeds the number of connector configurations in template ${this.stationTemplateFile}, forcing random connector configurations affectation`);
ad2f27c3 508 this.stationInfo.randomConnectors = true;
6ecb15e4 509 }
ad2f27c3 510 const connectorsConfigHash = crypto.createHash('sha256').update(JSON.stringify(this.stationInfo.Connectors) + maxConnectors.toString()).digest('hex');
de1f5008 511 // FIXME: Handle shrinking the number of connectors
ad2f27c3
JB
512 if (!this.connectors || (this.connectors && this.connectorsConfigurationHash !== connectorsConfigHash)) {
513 this.connectorsConfigurationHash = connectorsConfigHash;
7abfea5f 514 // Add connector Id 0
6af9012e 515 let lastConnector = '0';
ad2f27c3 516 for (lastConnector in this.stationInfo.Connectors) {
c0560973 517 if (Utils.convertToInt(lastConnector) === 0 && this.getUseConnectorId0() && this.stationInfo.Connectors[lastConnector]) {
ad2f27c3
JB
518 this.connectors[lastConnector] = Utils.cloneObject<Connector>(this.stationInfo.Connectors[lastConnector]);
519 this.connectors[lastConnector].availability = AvailabilityType.OPERATIVE;
418106c8
JB
520 if (Utils.isUndefined(this.connectors[lastConnector]?.chargingProfiles)) {
521 this.connectors[lastConnector].chargingProfiles = [];
522 }
0a60c33c
JB
523 }
524 }
0a60c33c 525 // Generate all connectors
ad2f27c3 526 if ((this.stationInfo.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) > 0) {
7abfea5f 527 for (let index = 1; index <= maxConnectors; index++) {
72740232 528 const randConnectorId = this.stationInfo.randomConnectors ? Utils.getRandomInteger(Utils.convertToInt(lastConnector), 1) : index;
5a20b4fd 529 this.connectors[index] = Utils.cloneObject<Connector>(this.stationInfo.Connectors[randConnectorId]);
ad2f27c3 530 this.connectors[index].availability = AvailabilityType.OPERATIVE;
418106c8
JB
531 if (Utils.isUndefined(this.connectors[lastConnector]?.chargingProfiles)) {
532 this.connectors[index].chargingProfiles = [];
533 }
7abfea5f 534 }
0a60c33c
JB
535 }
536 }
d4a73fb7 537 // Avoid duplication of connectors related information
ad2f27c3 538 delete this.stationInfo.Connectors;
0a60c33c 539 // Initialize transaction attributes on connectors
ad2f27c3 540 for (const connector in this.connectors) {
85d20667 541 if (Utils.convertToInt(connector) > 0 && !this.getConnector(Utils.convertToInt(connector))?.transactionStarted) {
6ed92bc1 542 this.initTransactionAttributesOnConnector(Utils.convertToInt(connector));
0a60c33c
JB
543 }
544 }
c0560973
JB
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 }
7abfea5f 554 // OCPP parameters
147d0e0f 555 this.initOCPPParameters();
47e22477
JB
556 if (this.stationInfo.autoRegister) {
557 this.bootNotificationResponse = {
558 currentTime: new Date().toISOString(),
559 interval: this.getHeartbeatInterval() / 1000,
560 status: RegistrationStatus.ACCEPTED
561 };
562 }
147d0e0f
JB
563 this.stationInfo.powerDivider = this.getPowerDivider();
564 if (this.getEnableStatistics()) {
2a370053 565 this.performanceStatistics = new PerformanceStatistics(this.stationInfo.chargingStationId, this.wsConnectionUrl);
147d0e0f
JB
566 }
567 }
568
569 private initOCPPParameters(): void {
36f6a92e
JB
570 if (!this.getConfigurationKey(StandardParametersKey.SupportedFeatureProfiles)) {
571 this.addConfigurationKey(StandardParametersKey.SupportedFeatureProfiles, `${SupportedFeatureProfiles.Core},${SupportedFeatureProfiles.Local_Auth_List_Management},${SupportedFeatureProfiles.Smart_Charging}`);
572 }
c0560973
JB
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);
7abfea5f 576 }
7e1dc878
JB
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 }
36f6a92e
JB
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 }
147d0e0f
JB
601 if (!this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) {
602 this.addConfigurationKey(StandardParametersKey.ConnectionTimeOut, Constants.DEFAULT_CONNECTION_TIMEOUT.toString());
8bce55bf 603 }
7dde0b73
JB
604 }
605
c0560973 606 private async onOpen(): Promise<void> {
e9017bfc 607 logger.info(`${this.logPrefix()} Connected to OCPP server through ${this.wsConnectionUrl.toString()}`);
c0560973
JB
608 if (!this.isRegistered()) {
609 // Send BootNotification
610 let registrationRetryCount = 0;
611 do {
43d673d9
JB
612 this.bootNotificationResponse = await this.ocppRequestService.sendBootNotification(this.bootNotificationRequest.chargePointModel,
613 this.bootNotificationRequest.chargePointVendor, this.bootNotificationRequest.chargeBoxSerialNumber, this.bootNotificationRequest.firmwareVersion);
c0560973
JB
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));
c7db4718
JB
619 }
620 if (this.isRegistered()) {
c0560973 621 await this.startMessageSequence();
265e4266
JB
622 this.stopped && (this.stopped = false);
623 if (this.wsConnectionRestarted && this.isWebSocketConnectionOpened()) {
77f00f84 624 this.flushMessageQueue();
2e6f5966
JB
625 }
626 } else {
c0560973 627 logger.error(`${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})`);
2e6f5966 628 }
c0560973 629 this.autoReconnectRetryCount = 0;
265e4266 630 this.wsConnectionRestarted = false;
2e6f5966
JB
631 }
632
6c65a295 633 private async onClose(code: number, reason: string): Promise<void> {
d09085e9 634 switch (code) {
6c65a295
JB
635 // Normal close
636 case WebSocketCloseEventStatusCode.CLOSE_NORMAL:
c0560973 637 case WebSocketCloseEventStatusCode.CLOSE_NO_STATUS:
6c65a295 638 logger.info(`${this.logPrefix()} Socket normally closed with status '${Utils.getWebSocketCloseEventStatusString(code)}' and reason '${reason}'`);
c0560973
JB
639 this.autoReconnectRetryCount = 0;
640 break;
6c65a295
JB
641 // Abnormal close
642 default:
b4a58db4 643 logger.error(`${this.logPrefix()} Socket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString(code)}' and reason '${reason}'`);
d09085e9 644 await this.reconnect(code);
c0560973
JB
645 break;
646 }
2e6f5966
JB
647 }
648
16b0d4e7 649 private async onMessage(data: Data): Promise<void> {
c0560973 650 let [messageType, messageId, commandName, commandPayload, errorDetails]: IncomingRequest = [0, '', '' as IncomingRequestCommand, {}, {}];
193d2c0a 651 let responseCallback: (payload: Record<string, unknown> | string, requestPayload: Record<string, unknown>) => void;
c0560973
JB
652 let rejectCallback: (error: OCPPError) => void;
653 let requestPayload: Record<string, unknown>;
16b0d4e7 654 let cachedRequest: Request;
c0560973
JB
655 let errMsg: string;
656 try {
16b0d4e7 657 const request = JSON.parse(data.toString()) as IncomingRequest;
47e22477
JB
658 if (Utils.isIterable(request)) {
659 // Parse the message
660 [messageType, messageId, commandName, commandPayload, errorDetails] = request;
661 } else {
a6b3c6c3 662 throw new OCPPError(ErrorType.PROTOCOL_ERROR, 'Incoming request is not iterable', commandName);
47e22477 663 }
c0560973
JB
664 // Check the Type of message
665 switch (messageType) {
666 // Incoming Message
667 case MessageType.CALL_MESSAGE:
668 if (this.getEnableStatistics()) {
aef1b33a 669 this.performanceStatistics.addRequestStatistic(commandName, messageType);
c0560973
JB
670 }
671 // Process the call
672 await this.ocppIncomingRequestService.handleRequest(messageId, commandName, commandPayload);
673 break;
674 // Outcome Message
675 case MessageType.CALL_RESULT_MESSAGE:
676 // Respond
16b0d4e7
JB
677 cachedRequest = this.requests.get(messageId);
678 if (Utils.isIterable(cachedRequest)) {
679 [responseCallback, , requestPayload] = cachedRequest;
c0560973 680 } else {
a6b3c6c3 681 throw new OCPPError(ErrorType.PROTOCOL_ERROR, `Response request for message id ${messageId} is not iterable`, commandName);
c0560973
JB
682 }
683 if (!responseCallback) {
684 // Error
a6b3c6c3 685 throw new OCPPError(ErrorType.INTERNAL_ERROR, `Response request for unknown message id ${messageId}`, commandName);
c0560973 686 }
16b0d4e7 687 this.requests.delete(messageId);
c0560973
JB
688 responseCallback(commandName, requestPayload);
689 break;
690 // Error Message
691 case MessageType.CALL_ERROR_MESSAGE:
16b0d4e7
JB
692 cachedRequest = this.requests.get(messageId);
693 if (!cachedRequest) {
c0560973 694 // Error
14763b46 695 throw new OCPPError(ErrorType.INTERNAL_ERROR, `Error request for unknown message id ${messageId}`);
c0560973 696 }
16b0d4e7
JB
697 if (Utils.isIterable(cachedRequest)) {
698 [, rejectCallback] = cachedRequest;
c0560973 699 } else {
14763b46 700 throw new OCPPError(ErrorType.PROTOCOL_ERROR, `Error request for message id ${messageId} is not iterable`);
c0560973 701 }
16b0d4e7 702 this.requests.delete(messageId);
a6b3c6c3 703 rejectCallback(new OCPPError(commandName, commandPayload.toString(), null, errorDetails));
c0560973
JB
704 break;
705 // Error
706 default:
707 errMsg = `${this.logPrefix()} Wrong message type ${messageType}`;
708 logger.error(errMsg);
14763b46 709 throw new OCPPError(ErrorType.PROTOCOL_ERROR, errMsg);
c0560973
JB
710 }
711 } catch (error) {
712 // Log
16b0d4e7 713 logger.error('%s Incoming request message %j processing error %j on content type %j', this.logPrefix(), data, error, this.requests.get(messageId));
c0560973
JB
714 // Send error
715 messageType !== MessageType.CALL_ERROR_MESSAGE && await this.ocppRequestService.sendError(messageId, error, commandName);
716 }
2328be1e
JB
717 }
718
c0560973 719 private onPing(): void {
57939a9d 720 logger.debug(this.logPrefix() + ' Received a WS ping (rfc6455) from the server');
c0560973
JB
721 }
722
723 private onPong(): void {
57939a9d 724 logger.debug(this.logPrefix() + ' Received a WS pong (rfc6455) from the server');
c0560973
JB
725 }
726
16b0d4e7
JB
727 private async onError(error: WSError): Promise<void> {
728 logger.error(this.logPrefix() + ' Socket error: %j', error);
729 // switch (error.code) {
c0560973 730 // case 'ECONNREFUSED':
16b0d4e7 731 // await this.reconnect(error);
c0560973
JB
732 // break;
733 // }
734 }
735
736 private getTemplateChargingStationConfiguration(): ChargingStationConfiguration {
7874b0b1 737 return this.stationInfo.Configuration ?? {} as ChargingStationConfiguration;
c0560973
JB
738 }
739
6e0964c8 740 private getAuthorizationFile(): string | undefined {
bf1866b2 741 return this.stationInfo.authorizationFile && path.join(path.resolve(__dirname, '../'), 'assets', path.basename(this.stationInfo.authorizationFile));
c0560973
JB
742 }
743
744 private getAuthorizedTags(): string[] {
745 let authorizedTags: string[] = [];
746 const authorizationFile = this.getAuthorizationFile();
747 if (authorizationFile) {
748 try {
749 // Load authorization file
750 const fileDescriptor = fs.openSync(authorizationFile, 'r');
751 authorizedTags = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as string[];
752 fs.closeSync(fileDescriptor);
753 } catch (error) {
23132a44 754 FileUtils.handleFileException(this.logPrefix(), 'Authorization', authorizationFile, error);
c0560973
JB
755 }
756 } else {
757 logger.info(this.logPrefix() + ' No authorization file given in template file ' + this.stationTemplateFile);
8c4da341 758 }
c0560973
JB
759 return authorizedTags;
760 }
761
6e0964c8 762 private getUseConnectorId0(): boolean | undefined {
c0560973 763 return !Utils.isUndefined(this.stationInfo.useConnectorId0) ? this.stationInfo.useConnectorId0 : true;
8bce55bf
JB
764 }
765
c0560973 766 private getNumberOfRunningTransactions(): number {
6ecb15e4 767 let trxCount = 0;
ad2f27c3 768 for (const connector in this.connectors) {
85d20667 769 if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector))?.transactionStarted) {
6ecb15e4
JB
770 trxCount++;
771 }
772 }
773 return trxCount;
774 }
775
1f761b9a 776 // 0 for disabling
6e0964c8 777 private getConnectionTimeout(): number | undefined {
291cb255
JB
778 if (this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut)) {
779 return parseInt(this.getConfigurationKey(StandardParametersKey.ConnectionTimeOut).value) ?? Constants.DEFAULT_CONNECTION_TIMEOUT;
780 }
291cb255 781 return Constants.DEFAULT_CONNECTION_TIMEOUT;
3574dfd3
JB
782 }
783
1f761b9a 784 // -1 for unlimited, 0 for disabling
6e0964c8 785 private getAutoReconnectMaxRetries(): number | undefined {
ad2f27c3
JB
786 if (!Utils.isUndefined(this.stationInfo.autoReconnectMaxRetries)) {
787 return this.stationInfo.autoReconnectMaxRetries;
3574dfd3
JB
788 }
789 if (!Utils.isUndefined(Configuration.getAutoReconnectMaxRetries())) {
790 return Configuration.getAutoReconnectMaxRetries();
791 }
792 return -1;
793 }
794
ec977daf 795 // 0 for disabling
6e0964c8 796 private getRegistrationMaxRetries(): number | undefined {
ad2f27c3
JB
797 if (!Utils.isUndefined(this.stationInfo.registrationMaxRetries)) {
798 return this.stationInfo.registrationMaxRetries;
32a1eb7a
JB
799 }
800 return -1;
801 }
802
c0560973
JB
803 private getPowerDivider(): number {
804 let powerDivider = this.getNumberOfConnectors();
ad2f27c3 805 if (this.stationInfo.powerSharedByConnectors) {
c0560973 806 powerDivider = this.getNumberOfRunningTransactions();
6ecb15e4
JB
807 }
808 return powerDivider;
809 }
810
c0560973 811 private getTemplateMaxNumberOfConnectors(): number {
ad2f27c3 812 return Object.keys(this.stationInfo.Connectors).length;
7abfea5f
JB
813 }
814
c0560973 815 private getMaxNumberOfConnectors(): number {
5ad8570f 816 let maxConnectors = 0;
ad2f27c3
JB
817 if (!Utils.isEmptyArray(this.stationInfo.numberOfConnectors)) {
818 const numberOfConnectors = this.stationInfo.numberOfConnectors as number[];
6ecb15e4 819 // Distribute evenly the number of connectors
ad2f27c3
JB
820 maxConnectors = numberOfConnectors[(this.index - 1) % numberOfConnectors.length];
821 } else if (!Utils.isUndefined(this.stationInfo.numberOfConnectors)) {
822 maxConnectors = this.stationInfo.numberOfConnectors as number;
488fd3a7 823 } else {
c0560973 824 maxConnectors = this.stationInfo.Connectors[0] ? this.getTemplateMaxNumberOfConnectors() - 1 : this.getTemplateMaxNumberOfConnectors();
5ad8570f
JB
825 }
826 return maxConnectors;
2e6f5966
JB
827 }
828
c0560973 829 private getNumberOfConnectors(): number {
ad2f27c3 830 return this.connectors[0] ? Object.keys(this.connectors).length - 1 : Object.keys(this.connectors).length;
6ecb15e4
JB
831 }
832
c0560973 833 private async startMessageSequence(): Promise<void> {
136c90ba 834 // Start WebSocket ping
c0560973 835 this.startWebSocketPing();
5ad8570f 836 // Start heartbeat
c0560973 837 this.startHeartbeat();
0a60c33c 838 // Initialize connectors status
ad2f27c3 839 for (const connector in this.connectors) {
593cf3f9
JB
840 if (Utils.convertToInt(connector) === 0) {
841 continue;
265e4266 842 } else if (!this.stopped && !this.getConnector(Utils.convertToInt(connector))?.status && this.getConnector(Utils.convertToInt(connector))?.bootStatus) {
136c90ba 843 // Send status in template at startup
c0560973
JB
844 await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).bootStatus);
845 this.getConnector(Utils.convertToInt(connector)).status = this.getConnector(Utils.convertToInt(connector)).bootStatus;
265e4266 846 } else if (this.stopped && this.getConnector(Utils.convertToInt(connector))?.bootStatus) {
136c90ba 847 // Send status in template after reset
c0560973
JB
848 await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).bootStatus);
849 this.getConnector(Utils.convertToInt(connector)).status = this.getConnector(Utils.convertToInt(connector)).bootStatus;
265e4266 850 } else if (!this.stopped && this.getConnector(Utils.convertToInt(connector))?.status) {
136c90ba 851 // Send previous status at template reload
c0560973 852 await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).status);
5ad8570f 853 } else {
136c90ba 854 // Send default status
c0560973
JB
855 await this.ocppRequestService.sendStatusNotification(Utils.convertToInt(connector), ChargePointStatus.AVAILABLE);
856 this.getConnector(Utils.convertToInt(connector)).status = ChargePointStatus.AVAILABLE;
5ad8570f
JB
857 }
858 }
0a60c33c 859 // Start the ATG
dd119a6b 860 this.startAutomaticTransactionGenerator();
dd119a6b
JB
861 }
862
863 private startAutomaticTransactionGenerator() {
ad2f27c3 864 if (this.stationInfo.AutomaticTransactionGenerator.enable) {
265e4266
JB
865 if (!this.automaticTransactionGenerator) {
866 this.automaticTransactionGenerator = new AutomaticTransactionGenerator(this);
5ad8570f 867 }
265e4266
JB
868 if (!this.automaticTransactionGenerator.started) {
869 this.automaticTransactionGenerator.start();
5ad8570f
JB
870 }
871 }
5ad8570f
JB
872 }
873
c0560973 874 private async stopMessageSequence(reason: StopTransactionReason = StopTransactionReason.NONE): Promise<void> {
136c90ba 875 // Stop WebSocket ping
c0560973 876 this.stopWebSocketPing();
79411696 877 // Stop heartbeat
c0560973 878 this.stopHeartbeat();
79411696 879 // Stop the ATG
ad2f27c3 880 if (this.stationInfo.AutomaticTransactionGenerator.enable &&
265e4266
JB
881 this.automaticTransactionGenerator &&
882 this.automaticTransactionGenerator.started) {
0045cef5 883 this.automaticTransactionGenerator.stop();
79411696 884 } else {
ad2f27c3 885 for (const connector in this.connectors) {
85d20667 886 if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector))?.transactionStarted) {
c0560973 887 const transactionId = this.getConnector(Utils.convertToInt(connector)).transactionId;
6ed92bc1
JB
888 await this.ocppRequestService.sendStopTransaction(transactionId, this.getEnergyActiveImportRegisterByTransactionId(transactionId),
889 this.getTransactionIdTag(transactionId), reason);
79411696
JB
890 }
891 }
892 }
893 }
894
c0560973 895 private startWebSocketPing(): void {
9cd3dfb0
JB
896 const webSocketPingInterval: number = this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval)
897 ? Utils.convertToInt(this.getConfigurationKey(StandardParametersKey.WebSocketPingInterval).value)
898 : 0;
ad2f27c3
JB
899 if (webSocketPingInterval > 0 && !this.webSocketPingSetInterval) {
900 this.webSocketPingSetInterval = setInterval(() => {
d5bff457 901 if (this.isWebSocketConnectionOpened()) {
0dad4bda 902 this.wsConnection.ping((): void => { /* This is intentional */ });
136c90ba
JB
903 }
904 }, webSocketPingInterval * 1000);
d7d1db72 905 logger.info(this.logPrefix() + ' WebSocket ping started every ' + Utils.formatDurationSeconds(webSocketPingInterval));
ad2f27c3 906 } else if (this.webSocketPingSetInterval) {
d7d1db72 907 logger.info(this.logPrefix() + ' WebSocket ping every ' + Utils.formatDurationSeconds(webSocketPingInterval) + ' already started');
136c90ba 908 } else {
d7d1db72 909 logger.error(`${this.logPrefix()} WebSocket ping interval set to ${webSocketPingInterval ? Utils.formatDurationSeconds(webSocketPingInterval) : webSocketPingInterval}, not starting the WebSocket ping`);
136c90ba
JB
910 }
911 }
912
c0560973 913 private stopWebSocketPing(): void {
ad2f27c3
JB
914 if (this.webSocketPingSetInterval) {
915 clearInterval(this.webSocketPingSetInterval);
136c90ba
JB
916 }
917 }
918
57939a9d 919 private getSupervisionURL(): URL {
c0560973
JB
920 const supervisionUrls = Utils.cloneObject<string | string[]>(this.stationInfo.supervisionURL ? this.stationInfo.supervisionURL : Configuration.getSupervisionURLs());
921 let indexUrl = 0;
922 if (!Utils.isEmptyArray(supervisionUrls)) {
923 if (Configuration.getDistributeStationsToTenantsEqually()) {
924 indexUrl = this.index % supervisionUrls.length;
925 } else {
926 // Get a random url
c37528f1 927 indexUrl = Math.floor(Utils.secureRandom() * supervisionUrls.length);
c0560973 928 }
57939a9d 929 return new URL(supervisionUrls[indexUrl]);
c0560973 930 }
57939a9d 931 return new URL(supervisionUrls as string);
136c90ba
JB
932 }
933
6e0964c8 934 private getHeartbeatInterval(): number | undefined {
c0560973
JB
935 const HeartbeatInterval = this.getConfigurationKey(StandardParametersKey.HeartbeatInterval);
936 if (HeartbeatInterval) {
937 return Utils.convertToInt(HeartbeatInterval.value) * 1000;
938 }
939 const HeartBeatInterval = this.getConfigurationKey(StandardParametersKey.HeartBeatInterval);
940 if (HeartBeatInterval) {
941 return Utils.convertToInt(HeartBeatInterval.value) * 1000;
0a60c33c 942 }
47e22477
JB
943 !this.stationInfo.autoRegister && logger.warn(`${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${Constants.DEFAULT_HEARTBEAT_INTERVAL}`);
944 return Constants.DEFAULT_HEARTBEAT_INTERVAL;
0a60c33c
JB
945 }
946
c0560973 947 private stopHeartbeat(): void {
ad2f27c3
JB
948 if (this.heartbeatSetInterval) {
949 clearInterval(this.heartbeatSetInterval);
7dde0b73 950 }
5ad8570f
JB
951 }
952
15042c5f 953 private openWSConnection(options?: ClientOptions & ClientRequestArgs, forceCloseOpened = false): void {
2891f761
JB
954 options = options ?? {};
955 options.handshakeTimeout = options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000;
15042c5f
JB
956 if (!Utils.isNullOrUndefined(this.stationInfo.supervisionUser) && !Utils.isNullOrUndefined(this.stationInfo.supervisionPassword)) {
957 options.auth = `${this.stationInfo.supervisionUser}:${this.stationInfo.supervisionPassword}`;
958 }
d5bff457 959 if (this.isWebSocketConnectionOpened() && forceCloseOpened) {
c0560973
JB
960 this.wsConnection.close();
961 }
962 let protocol;
963 switch (this.getOCPPVersion()) {
964 case OCPPVersion.VERSION_16:
965 protocol = 'ocpp' + OCPPVersion.VERSION_16;
966 break;
967 default:
968 this.handleUnsupportedVersion(this.getOCPPVersion());
969 break;
970 }
971 this.wsConnection = new WebSocket(this.wsConnectionUrl, protocol, options);
e9017bfc 972 logger.info(this.logPrefix() + ' Open OCPP connection to URL ' + this.wsConnectionUrl.toString());
136c90ba
JB
973 }
974
dd119a6b
JB
975 private stopMeterValues(connectorId: number) {
976 if (this.getConnector(connectorId)?.transactionSetInterval) {
977 clearInterval(this.getConnector(connectorId).transactionSetInterval);
978 }
979 }
980
c0560973 981 private startAuthorizationFileMonitoring(): void {
23132a44
JB
982 const authorizationFile = this.getAuthorizationFile();
983 if (authorizationFile) {
5ad8570f 984 try {
3ec10737
JB
985 fs.watch(authorizationFile, (event, filename) => {
986 if (filename && event === 'change') {
987 try {
988 logger.debug(this.logPrefix() + ' Authorization file ' + authorizationFile + ' have changed, reload');
989 // Initialize authorizedTags
990 this.authorizedTags = this.getAuthorizedTags();
991 } catch (error) {
992 logger.error(this.logPrefix() + ' Authorization file monitoring error: %j', error);
993 }
23132a44
JB
994 }
995 });
5ad8570f 996 } catch (error) {
23132a44 997 FileUtils.handleFileException(this.logPrefix(), 'Authorization', authorizationFile, error);
5ad8570f 998 }
23132a44
JB
999 } else {
1000 logger.info(this.logPrefix() + ' No authorization file given in template file ' + this.stationTemplateFile + '. Not monitoring changes');
1001 }
5ad8570f
JB
1002 }
1003
c0560973 1004 private startStationTemplateFileMonitoring(): void {
23132a44 1005 try {
b809adf1 1006 fs.watch(this.stationTemplateFile, (event, filename): void => {
3ec10737
JB
1007 if (filename && event === 'change') {
1008 try {
1009 logger.debug(this.logPrefix() + ' Template file ' + this.stationTemplateFile + ' have changed, reload');
1010 // Initialize
1011 this.initialize();
1012 // Restart the ATG
1013 if (!this.stationInfo.AutomaticTransactionGenerator.enable &&
265e4266 1014 this.automaticTransactionGenerator) {
0045cef5 1015 this.automaticTransactionGenerator.stop();
3ec10737
JB
1016 }
1017 this.startAutomaticTransactionGenerator();
1018 if (this.getEnableStatistics()) {
1019 this.performanceStatistics.restart();
1020 } else {
1021 this.performanceStatistics.stop();
1022 }
1023 // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed
1024 } catch (error) {
1025 logger.error(this.logPrefix() + ' Charging station template file monitoring error: %j', error);
087a502d 1026 }
79411696 1027 }
23132a44
JB
1028 });
1029 } catch (error) {
1030 FileUtils.handleFileException(this.logPrefix(), 'Template', this.stationTemplateFile, error);
1031 }
5ad8570f
JB
1032 }
1033
6e0964c8 1034 private getReconnectExponentialDelay(): boolean | undefined {
c0560973 1035 return !Utils.isUndefined(this.stationInfo.reconnectExponentialDelay) ? this.stationInfo.reconnectExponentialDelay : false;
5ad8570f
JB
1036 }
1037
d09085e9 1038 private async reconnect(code: number): Promise<void> {
7874b0b1
JB
1039 // Stop WebSocket ping
1040 this.stopWebSocketPing();
136c90ba 1041 // Stop heartbeat
c0560973 1042 this.stopHeartbeat();
5ad8570f 1043 // Stop the ATG if needed
ad2f27c3
JB
1044 if (this.stationInfo.AutomaticTransactionGenerator.enable &&
1045 this.stationInfo.AutomaticTransactionGenerator.stopOnConnectionFailure &&
265e4266
JB
1046 this.automaticTransactionGenerator &&
1047 this.automaticTransactionGenerator.started) {
0045cef5 1048 this.automaticTransactionGenerator.stop();
ad2f27c3 1049 }
c0560973 1050 if (this.autoReconnectRetryCount < this.getAutoReconnectMaxRetries() || this.getAutoReconnectMaxRetries() === -1) {
ad2f27c3 1051 this.autoReconnectRetryCount++;
c0560973 1052 const reconnectDelay = (this.getReconnectExponentialDelay() ? Utils.exponentialDelay(this.autoReconnectRetryCount) : this.getConnectionTimeout() * 1000);
a0f59b75
JB
1053 const reconnectTimeout = reconnectDelay - 100;
1054 logger.error(`${this.logPrefix()} Socket: connection retry in ${Utils.roundTo(reconnectDelay, 2)}ms, timeout ${reconnectTimeout}ms`);
032d6efc 1055 await Utils.sleep(reconnectDelay);
c0560973 1056 logger.error(this.logPrefix() + ' Socket: reconnecting try #' + this.autoReconnectRetryCount.toString());
a0f59b75 1057 this.openWSConnection({ handshakeTimeout: reconnectTimeout }, true);
265e4266 1058 this.wsConnectionRestarted = true;
c0560973
JB
1059 } else if (this.getAutoReconnectMaxRetries() !== -1) {
1060 logger.error(`${this.logPrefix()} Socket reconnect failure: max retries reached (${this.autoReconnectRetryCount}) or retry disabled (${this.getAutoReconnectMaxRetries()})`);
5ad8570f
JB
1061 }
1062 }
1063
6ed92bc1 1064 private initTransactionAttributesOnConnector(connectorId: number): void {
163547b1 1065 this.getConnector(connectorId).authorized = false;
8bce55bf 1066 this.getConnector(connectorId).transactionStarted = false;
6ed92bc1
JB
1067 this.getConnector(connectorId).energyActiveImportRegisterValue = 0;
1068 this.getConnector(connectorId).transactionEnergyActiveImportRegisterValue = 0;
0a60c33c 1069 }
7dde0b73
JB
1070}
1071