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