Fix zero value in metervalues charging station templates.
[e-mobility-charging-stations-simulator.git] / src / charging-station / ChargingStation.js
CommitLineData
7dde0b73
JB
1const Configuration = require('../utils/Configuration');
2const logger = require('../utils/Logger');
3const WebSocket = require('ws');
f7869514 4const Constants = require('../utils/Constants');
7dde0b73
JB
5const Utils = require('../utils/Utils');
6const OCPPError = require('./OcppError');
7dde0b73
JB
7const AutomaticTransactionGenerator = require('./AutomaticTransactionGenerator');
8const Statistics = require('../utils/Statistics');
9const fs = require('fs');
10const {performance, PerformanceObserver} = require('perf_hooks');
11
12class ChargingStation {
2e6f5966
JB
13 constructor(index, stationTemplateFile) {
14 this._index = index;
15 this._stationTemplateFile = stationTemplateFile;
16 this._initialize();
17
0a60c33c 18 this._isSocketRestart = false;
7dde0b73
JB
19 this._autoReconnectRetryCount = 0;
20 this._autoReconnectMaxRetries = Configuration.getAutoReconnectMaxRetries(); // -1 for unlimited
21 this._autoReconnectTimeout = Configuration.getAutoReconnectTimeout() * 1000; // ms, zero for disabling
2e6f5966
JB
22
23 this._requests = {};
24 this._messageQueue = [];
25
83045896 26 this._authorizedTags = this._loadAndGetAuthorizedTags();
2e6f5966
JB
27 }
28
5ad8570f
JB
29 _getStationName(stationTemplate) {
30 return stationTemplate.fixedName ? stationTemplate.baseName : stationTemplate.baseName + '-' + ('000000000' + this._index).substr(('000000000' + this._index).length - 4);
31 }
32
33 _buildStationInfo() {
34 let stationTemplateFromFile;
35 try {
36 // Load template file
37 const fileDescriptor = fs.openSync(this._stationTemplateFile, 'r');
38 stationTemplateFromFile = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8'));
39 fs.closeSync(fileDescriptor);
40 } catch (error) {
41 logger.error(this._basicFormatLog() + ' Template file loading error: ' + error);
42 }
43 const stationTemplate = stationTemplateFromFile || {};
0a60c33c 44 if (!Utils.isEmptyArray(stationTemplateFromFile.power)) {
5ad8570f
JB
45 stationTemplate.maxPower = stationTemplateFromFile.power[Math.floor(Math.random() * stationTemplateFromFile.power.length)];
46 } else {
47 stationTemplate.maxPower = stationTemplateFromFile.power;
48 }
49 stationTemplate.name = this._getStationName(stationTemplateFromFile);
0a60c33c 50 stationTemplate.resetTime = stationTemplateFromFile.resetTime ? stationTemplateFromFile.resetTime * 1000 : Constants.CHARGING_STATION_DEFAULT_RESET_TIME;
5ad8570f
JB
51 return stationTemplate;
52 }
53
2e6f5966
JB
54 _initialize() {
55 this._stationInfo = this._buildStationInfo();
56 this._bootNotificationMessage = {
57 chargePointModel: this._stationInfo.chargePointModel,
58 chargePointVendor: this._stationInfo.chargePointVendor,
6958152c 59 chargePointSerialNumber: this._stationInfo.chargePointSerialNumberPrefix ? this._stationInfo.chargePointSerialNumberPrefix : '',
34dcb3b5 60 firmwareVersion: this._stationInfo.firmwareVersion ? this._stationInfo.firmwareVersion : '',
2e6f5966
JB
61 };
62 this._configuration = this._getConfiguration();
2e6f5966 63 this._supervisionUrl = this._getSupervisionURL();
0a60c33c
JB
64 this._wsConnectionUrl = this._supervisionUrl + '/' + this._stationInfo.name;
65 // Build connectors if needed
66 const maxConnectors = this._getMaxConnectors();
67 const connectorsConfig = Utils.cloneJSonDocument(this._stationInfo.Connectors);
68 const connectorsConfigLength = Utils.convertToBoolean(this._stationInfo.useConnectorId0) && Object.keys(connectorsConfig).includes('0') ? Object.keys(connectorsConfig).length : Object.keys(connectorsConfig).length - 1;
69 if (!this._connectors || (this._connectors && Object.keys(this._connectors).length !== connectorsConfigLength)) {
70 this._connectors = {};
71 // Determine number of customized connectors
72 let lastConnector;
73 for (lastConnector in connectorsConfig) {
74 // Add connector 0, OCPP specification violation that for example KEBA have
75 if (Utils.convertToInt(lastConnector) === 0 && Utils.convertToBoolean(this._stationInfo.useConnectorId0) &&
76 connectorsConfig[lastConnector]) {
77 this._connectors[lastConnector] = connectorsConfig[lastConnector];
78 }
79 }
80 this._addConfigurationKey('NumberOfConnectors', maxConnectors, true);
81 // Generate all connectors
82 for (let index = 1; index <= maxConnectors; index++) {
83 const randConnectorID = Utils.convertToBoolean(this._stationInfo.randomConnectors) ? Utils.getRandomInt(lastConnector, 1) : index;
84 this._connectors[index] = connectorsConfig[randConnectorID];
85 }
86 }
87 // Initialize transaction attributes on connectors
88 for (const connector in this._connectors) {
89 if (!this._connectors[connector].transactionStarted) {
90 this._initTransactionOnConnector(connector);
91 }
92 }
7dde0b73
JB
93 this._statistics = new Statistics(this._stationInfo.name);
94 this._performanceObserver = new PerformanceObserver((list) => {
95 const entry = list.getEntries()[0];
96 this._statistics.logPerformance(entry, 'ChargingStation');
97 this._performanceObserver.disconnect();
98 });
7dde0b73
JB
99 }
100
101 _basicFormatLog() {
102 return Utils.basicFormatLog(` ${this._stationInfo.name}:`);
103 }
104
2e6f5966
JB
105 _getConfiguration() {
106 return this._stationInfo.Configuration ? this._stationInfo.Configuration : {};
7dde0b73
JB
107 }
108
2e6f5966
JB
109 _getAuthorizationFile() {
110 return this._stationInfo.authorizationFile ? this._stationInfo.authorizationFile : '';
7dde0b73
JB
111 }
112
83045896 113 _loadAndGetAuthorizedTags() {
2e6f5966
JB
114 let authorizedTags = [];
115 const authorizationFile = this._getAuthorizationFile();
116 if (authorizationFile) {
117 try {
118 // Load authorization file
119 const fileDescriptor = fs.openSync(authorizationFile, 'r');
120 authorizedTags = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8'));
121 fs.closeSync(fileDescriptor);
122 } catch (error) {
123 logger.error(this._basicFormatLog() + ' Authorization file loading error: ' + error);
124 }
125 } else {
126 logger.info(this._basicFormatLog() + ' No authorization file given in template file ' + this._stationTemplateFile);
127 }
128 return authorizedTags;
129 }
130
5ad8570f
JB
131 getRandomTagId() {
132 const index = Math.floor(Math.random() * this._authorizedTags.length);
133 return this._authorizedTags[index];
2e6f5966
JB
134 }
135
5ad8570f
JB
136 hasAuthorizedTags() {
137 return !Utils.isEmptyArray(this._authorizedTags);
138 }
139
140 _getConnector(number) {
141 return this._stationInfo.Connectors[number];
142 }
143
144 _getMaxConnectors() {
145 let maxConnectors = 0;
0a60c33c
JB
146 if (!Utils.isEmptyArray(this._stationInfo.numberOfConnectors)) {
147 // Get evenly the number of connectors
5ad8570f
JB
148 maxConnectors = this._stationInfo.numberOfConnectors[(this._index - 1) % this._stationInfo.numberOfConnectors.length];
149 } else {
150 maxConnectors = this._stationInfo.numberOfConnectors;
151 }
152 return maxConnectors;
2e6f5966
JB
153 }
154
155 _getSupervisionURL() {
156 const supervisionUrls = Utils.cloneJSonDocument(this._stationInfo.supervisionURL ? this._stationInfo.supervisionURL : Configuration.getSupervisionURLs());
7dde0b73 157 let indexUrl = 0;
0a60c33c 158 if (!Utils.isEmptyArray(supervisionUrls)) {
2e6f5966
JB
159 if (Configuration.getDistributeStationToTenantEqually()) {
160 indexUrl = this._index % supervisionUrls.length;
7dde0b73
JB
161 } else {
162 // Get a random url
163 indexUrl = Math.floor(Math.random() * supervisionUrls.length);
164 }
165 return supervisionUrls[indexUrl];
166 }
167 return supervisionUrls;
168 }
169
7dde0b73 170 _getAuthorizeRemoteTxRequests() {
61c2e33d 171 const authorizeRemoteTxRequests = this._getConfigurationKey('AuthorizeRemoteTxRequests');
a6e68f34 172 return authorizeRemoteTxRequests ? Utils.convertToBoolean(authorizeRemoteTxRequests.value) : false;
7dde0b73
JB
173 }
174
def3d48e 175 _getLocalAuthListEnabled() {
61c2e33d 176 const localAuthListEnabled = this._getConfigurationKey('LocalAuthListEnabled');
def3d48e
JB
177 return localAuthListEnabled ? Utils.convertToBoolean(localAuthListEnabled.value) : false;
178 }
179
5ad8570f
JB
180 async _basicStartMessageSequence() {
181 // Start heartbeat
182 this._startHeartbeat(this);
0a60c33c 183 // Initialize connectors status
5ad8570f
JB
184 for (const connector in this._connectors) {
185 if (!this._connectors[connector].transactionStarted) {
186 if (this._connectors[connector].bootStatus) {
187 this.sendStatusNotificationWithTimeout(connector, this._connectors[connector].bootStatus);
188 } else {
189 this.sendStatusNotificationWithTimeout(connector, 'Available');
190 }
191 } else {
192 this.sendStatusNotificationWithTimeout(connector, 'Charging');
193 }
194 }
0a60c33c 195 // Start the ATG
5ad8570f
JB
196 if (Utils.convertToBoolean(this._stationInfo.AutomaticTransactionGenerator.enable)) {
197 if (!this._automaticTransactionGeneration) {
198 this._automaticTransactionGeneration = new AutomaticTransactionGenerator(this);
199 }
200 if (this._automaticTransactionGeneration.timeToStop) {
201 this._automaticTransactionGeneration.start();
202 }
203 }
204 this._statistics.start();
205 }
206
207 // eslint-disable-next-line class-methods-use-this
208 async _startHeartbeat(self) {
0a60c33c 209 if (self._heartbeatInterval && self._heartbeatInterval > 0 && !self._heartbeatSetInterval) {
5ad8570f 210 self._heartbeatSetInterval = setInterval(() => {
0a60c33c 211 this.sendHeartbeat();
5ad8570f
JB
212 }, self._heartbeatInterval);
213 logger.info(self._basicFormatLog() + ' Heartbeat started every ' + self._heartbeatInterval + 'ms');
7dde0b73 214 } else {
0a60c33c
JB
215 logger.error(`${self._basicFormatLog()} Heartbeat interval set to ${self._heartbeatInterval}, not starting the heartbeat`);
216 }
217 }
218
219 async _stopHeartbeat() {
220 if (this._heartbeatSetInterval) {
221 clearInterval(this._heartbeatSetInterval);
222 this._heartbeatSetInterval = null;
7dde0b73 223 }
5ad8570f
JB
224 }
225
226 _startAuthorizationFileMonitoring() {
227 // eslint-disable-next-line no-unused-vars
228 fs.watchFile(this._getAuthorizationFile(), (current, previous) => {
229 try {
230 logger.debug(this._basicFormatLog() + ' Authorization file ' + this._getAuthorizationFile() + ' have changed, reload');
231 // Initialize _authorizedTags
232 this._authorizedTags = this._loadAndGetAuthorizedTags();
233 } catch (error) {
234 logger.error(this._basicFormatLog() + ' Authorization file monitoring error: ' + error);
235 }
236 });
237 }
238
239 _startStationTemplateFileMonitoring() {
240 // eslint-disable-next-line no-unused-vars
241 fs.watchFile(this._stationTemplateFile, (current, previous) => {
242 try {
243 logger.debug(this._basicFormatLog() + ' Template file ' + this._stationTemplateFile + ' have changed, reload');
244 // Initialize
245 this._initialize();
246 this._addConfigurationKey('HeartBeatInterval', Utils.convertToInt(this._heartbeatInterval ? this._heartbeatInterval / 1000 : 0));
247 this._addConfigurationKey('HeartbeatInterval', Utils.convertToInt(this._heartbeatInterval ? this._heartbeatInterval / 1000 : 0), false, false);
5ad8570f
JB
248 } catch (error) {
249 logger.error(this._basicFormatLog() + ' Charging station template file monitoring error: ' + error);
250 }
251 });
252 }
253
bec64e8b
JB
254 async _startMeterValues(connectorId, interval) {
255 if (!this._connectors[connectorId].transactionStarted) {
256 logger.error(`${this._basicFormatLog()} Trying to start MeterValues on connector ID ${connectorId} with no transaction started`);
5ad8570f 257 return;
bec64e8b
JB
258 } else if (this._connectors[connectorId].transactionStarted && !this._connectors[connectorId].transactionId) {
259 logger.error(`${this._basicFormatLog()} Trying to start MeterValues on connector ID ${connectorId} with no transaction id`);
5ad8570f
JB
260 return;
261 }
0a60c33c 262 if (interval > 0) {
bec64e8b 263 this._connectors[connectorId].transactionSetInterval = setInterval(async () => {
0a60c33c
JB
264 const sendMeterValues = performance.timerify(this.sendMeterValues);
265 this._performanceObserver.observe({
266 entryTypes: ['function'],
267 });
bec64e8b 268 await sendMeterValues(connectorId, interval, this);
0a60c33c
JB
269 }, interval);
270 } else {
546dec0f 271 logger.error(`${this._basicFormatLog()} Charging station MeterValueSampleInterval configuration set to ${interval}ms, not sending MeterValues`);
0a60c33c 272 }
7dde0b73
JB
273 }
274
275 async start() {
0a60c33c
JB
276 if (!this._wsConnectionUrl) {
277 this._wsConnectionUrl = this._supervisionUrl + '/' + this._stationInfo.name;
5ad8570f 278 }
0a60c33c 279 this._wsConnection = new WebSocket(this._wsConnectionUrl, 'ocpp' + Constants.OCPP_VERSION_16);
2d0e26f5 280 logger.info(this._basicFormatLog() + ' Will communicate through URL ' + this._supervisionUrl);
2e6f5966
JB
281 // Monitor authorization file
282 this._startAuthorizationFileMonitoring();
283 // Monitor station template file
284 this._startStationTemplateFileMonitoring();
7dde0b73
JB
285 // Handle Socket incoming messages
286 this._wsConnection.on('message', this.onMessage.bind(this));
287 // Handle Socket error
288 this._wsConnection.on('error', this.onError.bind(this));
289 // Handle Socket close
290 this._wsConnection.on('close', this.onClose.bind(this));
291 // Handle Socket opening connection
292 this._wsConnection.on('open', this.onOpen.bind(this));
293 // Handle Socket ping
294 this._wsConnection.on('ping', this.onPing.bind(this));
295 }
296
2d0e26f5 297 async stop(reason = '') {
5ad8570f 298 // Stop heartbeat
0a60c33c 299 await this._stopHeartbeat();
5ad8570f
JB
300 // Stop the ATG
301 if (Utils.convertToBoolean(this._stationInfo.AutomaticTransactionGenerator.enable) &&
302 this._automaticTransactionGeneration &&
303 !this._automaticTransactionGeneration.timeToStop) {
2d0e26f5 304 await this._automaticTransactionGeneration.stop(reason);
5ad8570f
JB
305 } else {
306 for (const connector in this._connectors) {
307 if (this._connectors[connector].transactionStarted) {
2d0e26f5 308 await this.sendStopTransaction(this._connectors[connector].transactionId, reason);
5ad8570f
JB
309 }
310 }
311 }
312 // eslint-disable-next-line guard-for-in
313 for (const connector in this._connectors) {
314 await this.sendStatusNotification(connector, 'Unavailable');
315 }
0a60c33c 316 if (this._wsConnection && this._wsConnection.readyState === WebSocket.OPEN) {
5ad8570f
JB
317 await this._wsConnection.close();
318 }
319 }
320
321 _reconnect(error) {
322 logger.error(this._basicFormatLog() + ' Socket: abnormally closed', error);
323 // Stop the ATG if needed
324 if (Utils.convertToBoolean(this._stationInfo.AutomaticTransactionGenerator.enable) &&
325 Utils.convertToBoolean(this._stationInfo.AutomaticTransactionGenerator.stopOnConnectionFailure) &&
326 this._automaticTransactionGeneration &&
327 !this._automaticTransactionGeneration.timeToStop) {
328 this._automaticTransactionGeneration.stop();
329 }
330 // Stop heartbeat
0a60c33c 331 this._stopHeartbeat();
5ad8570f
JB
332 if (this._autoReconnectTimeout !== 0 &&
333 (this._autoReconnectRetryCount < this._autoReconnectMaxRetries || this._autoReconnectMaxRetries === -1)) {
334 logger.error(`${this._basicFormatLog()} Socket: connection retry with timeout ${this._autoReconnectTimeout}ms`);
335 this._autoReconnectRetryCount++;
336 setTimeout(() => {
337 logger.error(this._basicFormatLog() + ' Socket: reconnecting try #' + this._autoReconnectRetryCount);
338 this.start();
339 }, this._autoReconnectTimeout);
340 } else if (this._autoReconnectTimeout !== 0 || this._autoReconnectMaxRetries !== -1) {
341 logger.error(`${this._basicFormatLog()} Socket: max retries reached (${this._autoReconnectRetryCount}) or retry disabled (${this._autoReconnectTimeout})`);
342 }
343 }
344
7dde0b73 345 onOpen() {
0a60c33c 346 logger.info(`${this._basicFormatLog()} Is connected to server through ${this._wsConnectionUrl}`);
5ad8570f 347 if (!this._isSocketRestart) {
0bbcb3dc 348 // Send BootNotification
0a60c33c 349 this.sendBootNotification();
0bbcb3dc 350 }
7dde0b73 351 if (this._isSocketRestart) {
027b409a 352 this._basicStartMessageSequence();
546dec0f 353 if (!Utils.isEmptyArray(this._messageQueue)) {
7dde0b73 354 this._messageQueue.forEach((message) => {
0a60c33c 355 if (this._wsConnection && this._wsConnection.readyState === WebSocket.OPEN) {
7dde0b73
JB
356 this._wsConnection.send(message);
357 }
358 });
359 }
7dde0b73
JB
360 }
361 this._autoReconnectRetryCount = 0;
362 this._isSocketRestart = false;
363 }
364
365 onError(error) {
366 switch (error) {
367 case 'ECONNREFUSED':
368 this._isSocketRestart = true;
369 this._reconnect(error);
370 break;
371 default:
372 logger.error(this._basicFormatLog() + ' Socket error: ' + error);
373 break;
374 }
375 }
376
377 onClose(error) {
378 switch (error) {
379 case 1000: // Normal close
380 case 1005:
381 logger.info(this._basicFormatLog() + ' Socket normally closed ' + error);
382 this._autoReconnectRetryCount = 0;
383 break;
384 default: // Abnormal close
385 this._isSocketRestart = true;
386 this._reconnect(error);
387 break;
388 }
389 }
390
391 onPing() {
027b409a 392 logger.debug(this._basicFormatLog() + ' Has received a WS ping (rfc6455) from the server');
7dde0b73
JB
393 }
394
395 async onMessage(message) {
2d8cee5a 396 let [messageType, messageId, commandName, commandPayload, errorDetails] = [0, '', Constants.ENTITY_CHARGING_STATION, '', ''];
7dde0b73 397 try {
2d8cee5a
JB
398 // Parse the message
399 [messageType, messageId, commandName, commandPayload, errorDetails] = JSON.parse(message);
400
7dde0b73
JB
401 // Check the Type of message
402 switch (messageType) {
403 // Incoming Message
f7869514 404 case Constants.OCPP_JSON_CALL_MESSAGE:
7dde0b73 405 // Process the call
7dde0b73
JB
406 await this.handleRequest(messageId, commandName, commandPayload);
407 break;
408 // Outcome Message
f7869514 409 case Constants.OCPP_JSON_CALL_RESULT_MESSAGE:
7dde0b73
JB
410 // Respond
411 // eslint-disable-next-line no-case-declarations
412 let responseCallback; let requestPayload;
413 if (Utils.isIterable(this._requests[messageId])) {
414 [responseCallback, , requestPayload] = this._requests[messageId];
415 } else {
416 throw new Error(`Response request for unknown message id ${messageId} is not iterable`);
417 }
418 if (!responseCallback) {
419 // Error
420 throw new Error(`Response for unknown message id ${messageId}`);
421 }
422 delete this._requests[messageId];
7dde0b73
JB
423 responseCallback(commandName, requestPayload);
424 break;
425 // Error Message
f7869514 426 case Constants.OCPP_JSON_CALL_ERROR_MESSAGE:
7dde0b73
JB
427 if (!this._requests[messageId]) {
428 // Error
429 throw new Error(`Error for unknown message id ${messageId}`);
430 }
431 // eslint-disable-next-line no-case-declarations
432 let rejectCallback;
433 if (Utils.isIterable(this._requests[messageId])) {
434 [, rejectCallback] = this._requests[messageId];
435 } else {
436 throw new Error(`Error request for unknown message id ${messageId} is not iterable`);
437 }
438 delete this._requests[messageId];
439 rejectCallback(new OCPPError(commandName, commandPayload, errorDetails));
440 break;
441 // Error
442 default:
443 throw new Error(`Wrong message type ${messageType}`);
444 }
445 } catch (error) {
446 // Log
447 logger.error('%s Incoming message %j processing error %s on request content %s', this._basicFormatLog(), message, error, this._requests[messageId]);
448 // Send error
449 // await this.sendError(messageId, error);
450 }
451 }
452
0a60c33c
JB
453 sendHeartbeat() {
454 try {
455 const payload = {
456 currentTime: new Date().toISOString(),
457 };
458 this.sendMessage(Utils.generateUUID(), payload, Constants.OCPP_JSON_CALL_MESSAGE, 'Heartbeat');
459 } catch (error) {
460 logger.error(this._basicFormatLog() + ' Send Heartbeat error: ' + error);
461 throw error;
462 }
463 }
464
465 sendBootNotification() {
466 try {
467 this.sendMessage(Utils.generateUUID(), this._bootNotificationMessage, Constants.OCPP_JSON_CALL_MESSAGE, 'BootNotification');
468 } catch (error) {
469 logger.error(this._basicFormatLog() + ' Send BootNotification error: ' + error);
470 throw error;
471 }
472 }
473
5ad8570f
JB
474 async sendStatusNotification(connectorId, status, errorCode = 'NoError') {
475 try {
476 const payload = {
477 connectorId,
478 errorCode,
479 status,
480 };
481 await this.sendMessage(Utils.generateUUID(), payload, Constants.OCPP_JSON_CALL_MESSAGE, 'StatusNotification');
482 } catch (error) {
0a60c33c 483 logger.error(this._basicFormatLog() + ' Send StatusNotification error: ' + error);
5ad8570f 484 throw error;
027b409a
JB
485 }
486 }
487
5ad8570f
JB
488 sendStatusNotificationWithTimeout(connectorId, status, errorCode = 'NoError', timeout = Constants.STATUS_NOTIFICATION_TIMEOUT) {
489 setTimeout(() => this.sendStatusNotification(connectorId, status, errorCode), timeout);
490 }
491
bec64e8b 492 async sendStartTransaction(connectorId, idTag) {
5ad8570f
JB
493 try {
494 const payload = {
bec64e8b 495 connectorId,
5ad8570f
JB
496 idTag,
497 meterStart: 0,
498 timestamp: new Date().toISOString(),
499 };
500 return await this.sendMessage(Utils.generateUUID(), payload, Constants.OCPP_JSON_CALL_MESSAGE, 'StartTransaction');
501 } catch (error) {
0a60c33c 502 logger.error(this._basicFormatLog() + ' Send StartTransaction error: ' + error);
5ad8570f 503 throw error;
7dde0b73
JB
504 }
505 }
506
bec64e8b
JB
507 sendStartTransactionWithTimeout(connectorId, idTag, timeout) {
508 setTimeout(() => this.sendStartTransaction(connectorId, idTag), timeout);
7dde0b73
JB
509 }
510
5ad8570f 511 async sendStopTransaction(transactionId, reason = '') {
027b409a 512 try {
bec64e8b 513 let payload;
2d0e26f5
JB
514 if (reason) {
515 payload = {
516 transactionId,
517 meterStop: 0,
518 timestamp: new Date().toISOString(),
519 reason,
520 };
521 } else {
522 payload = {
523 transactionId,
524 meterStop: 0,
525 timestamp: new Date().toISOString(),
526 };
527 }
5ad8570f 528 await this.sendMessage(Utils.generateUUID(), payload, Constants.OCPP_JSON_CALL_MESSAGE, 'StopTransaction');
027b409a 529 } catch (error) {
0a60c33c 530 logger.error(this._basicFormatLog() + ' Send StopTransaction error: ' + error);
5ad8570f 531 throw error;
027b409a
JB
532 }
533 }
534
5ad8570f 535 // eslint-disable-next-line class-methods-use-this
bec64e8b 536 async sendMeterValues(connectorId, interval, self, debug = false) {
5ad8570f
JB
537 try {
538 const sampledValueLcl = {
539 timestamp: new Date().toISOString(),
540 };
bec64e8b 541 const meterValuesClone = Utils.cloneJSonDocument(self._getConnector(connectorId).MeterValues);
0a60c33c 542 if (!Utils.isEmptyArray(meterValuesClone)) {
5ad8570f
JB
543 sampledValueLcl.sampledValue = meterValuesClone;
544 } else {
545 sampledValueLcl.sampledValue = [meterValuesClone];
546 }
547 for (let index = 0; index < sampledValueLcl.sampledValue.length; index++) {
bec64e8b 548 const connector = self._connectors[connectorId];
0a60c33c 549 // SoC measurand
5ad8570f 550 if (sampledValueLcl.sampledValue[index].measurand && sampledValueLcl.sampledValue[index].measurand === 'SoC') {
5c389abe 551 sampledValueLcl.sampledValue[index].value = !Utils.isUndefined(sampledValueLcl.sampledValue[index].value) ?
9b25a525
JB
552 sampledValueLcl.sampledValue[index].value :
553 sampledValueLcl.sampledValue[index].value = Utils.getRandomInt(100);
5ad8570f 554 if (sampledValueLcl.sampledValue[index].value > 100 || debug) {
bec64e8b 555 logger.error(`${self._basicFormatLog()} MeterValues measurand ${sampledValueLcl.sampledValue[index].measurand ? sampledValueLcl.sampledValue[index].measurand : 'Energy.Active.Import.Register'}: connectorId ${connectorId}, transaction ${connector.transactionId}, value: ${sampledValueLcl.sampledValue[index].value}`);
5ad8570f 556 }
0a60c33c
JB
557 // Voltage measurand
558 } else if (sampledValueLcl.sampledValue[index].measurand && sampledValueLcl.sampledValue[index].measurand === 'Voltage') {
5c389abe 559 sampledValueLcl.sampledValue[index].value = !Utils.isUndefined(sampledValueLcl.sampledValue[index].value) ? sampledValueLcl.sampledValue[index].value : 230;
0a60c33c
JB
560 // Energy.Active.Import.Register measurand (default)
561 } else if (!sampledValueLcl.sampledValue[index].measurand || sampledValueLcl.sampledValue[index].measurand === 'Energy.Active.Import.Register') {
5c389abe 562 if (Utils.isUndefined(sampledValueLcl.sampledValue[index].value)) {
9b25a525
JB
563 const measurandValue = Utils.getRandomInt(self._stationInfo.maxPower / 3600000 * interval);
564 // Persist previous value in connector
565 if (connector && connector.lastEnergyActiveImportRegisterValue >= 0) {
566 connector.lastEnergyActiveImportRegisterValue += measurandValue;
567 } else {
568 connector.lastEnergyActiveImportRegisterValue = 0;
569 }
570 sampledValueLcl.sampledValue[index].value = connector.lastEnergyActiveImportRegisterValue;
5ad8570f 571 }
bec64e8b 572 logger.info(`${self._basicFormatLog()} MeterValues measurand ${sampledValueLcl.sampledValue[index].measurand ? sampledValueLcl.sampledValue[index].measurand : 'Energy.Active.Import.Register'}: connectorId ${connectorId}, transaction ${connector.transactionId}, value ${sampledValueLcl.sampledValue[index].value}`);
5ad8570f 573 const maxConsumption = self._stationInfo.maxPower * 3600 / interval;
5ad8570f 574 if (sampledValueLcl.sampledValue[index].value > maxConsumption || debug) {
bec64e8b 575 logger.error(`${self._basicFormatLog()} MeterValues measurand ${sampledValueLcl.sampledValue[index].measurand ? sampledValueLcl.sampledValue[index].measurand : 'Energy.Active.Import.Register'}: connectorId ${connectorId}, transaction ${connector.transactionId}, value: ${sampledValueLcl.sampledValue[index].value}/${maxConsumption}`);
5ad8570f 576 }
0a60c33c
JB
577 // Unsupported measurand
578 } else {
bec64e8b 579 logger.info(`${self._basicFormatLog()} Unsupported MeterValues measurand ${sampledValueLcl.sampledValue[index].measurand ? sampledValueLcl.sampledValue[index].measurand : 'Energy.Active.Import.Register'} on connectorId ${connectorId}`);
5ad8570f
JB
580 }
581 }
582
583 const payload = {
bec64e8b
JB
584 connectorId,
585 transactionId: self._connectors[connectorId].transactionId,
5ad8570f
JB
586 meterValue: [sampledValueLcl],
587 };
588 await self.sendMessage(Utils.generateUUID(), payload, Constants.OCPP_JSON_CALL_MESSAGE, 'MeterValues');
589 } catch (error) {
590 logger.error(self._basicFormatLog() + ' Send MeterValues error: ' + error);
0a60c33c 591 throw error;
5ad8570f
JB
592 }
593 }
594
595 sendError(messageId, err) {
596 // Check exception: only OCPP error are accepted
597 const error = err instanceof OCPPError ? err : new OCPPError(Constants.OCPP_ERROR_INTERNAL_ERROR, err.message);
598 // Send error
599 return this.sendMessage(messageId, error, Constants.OCPP_JSON_CALL_ERROR_MESSAGE);
027b409a
JB
600 }
601
f7869514 602 sendMessage(messageId, command, messageType = Constants.OCPP_JSON_CALL_RESULT_MESSAGE, commandName = '') {
7dde0b73
JB
603 // Send a message through wsConnection
604 const self = this;
605 // Create a promise
606 return new Promise((resolve, reject) => {
607 let messageToSend;
608 // Type of message
609 switch (messageType) {
610 // Request
f7869514 611 case Constants.OCPP_JSON_CALL_MESSAGE:
7dde0b73
JB
612 this._statistics.addMessage(commandName);
613 // Build request
614 this._requests[messageId] = [responseCallback, rejectCallback, command];
615 messageToSend = JSON.stringify([messageType, messageId, commandName, command]);
616 break;
617 // Response
f7869514 618 case Constants.OCPP_JSON_CALL_RESULT_MESSAGE:
d3a7883e 619 this._statistics.addMessage(commandName);
7dde0b73
JB
620 // Build response
621 messageToSend = JSON.stringify([messageType, messageId, command]);
622 break;
623 // Error Message
f7869514 624 case Constants.OCPP_JSON_CALL_ERROR_MESSAGE:
7dde0b73 625 // Build Message
7de604f9 626 this._statistics.addMessage(`Error ${command.code ? command.code : Constants.OCPP_ERROR_GENERIC_ERROR} on ${commandName || ''}`);
894a1780 627 messageToSend = JSON.stringify([messageType, messageId, command.code ? command.code : Constants.OCPP_ERROR_GENERIC_ERROR, command.message ? command.message : '', command.details ? command.details : {}]);
7dde0b73
JB
628 break;
629 }
2e6f5966 630 // Check if wsConnection is ready
0a60c33c 631 if (this._wsConnection && this._wsConnection.readyState === WebSocket.OPEN) {
7dde0b73
JB
632 // Yes: Send Message
633 this._wsConnection.send(messageToSend);
634 } else {
635 // Buffer message until connection is back
636 this._messageQueue.push(messageToSend);
637 }
638 // Request?
f7869514 639 if (messageType !== Constants.OCPP_JSON_CALL_MESSAGE) {
7dde0b73
JB
640 // Yes: send Ok
641 resolve();
0a60c33c 642 } else if (this._wsConnection && this._wsConnection.readyState === WebSocket.OPEN) {
7dde0b73
JB
643 // Send timeout in case connection is open otherwise wait for ever
644 // FIXME: Handle message on timeout
f7869514 645 setTimeout(() => rejectCallback(`Timeout for message ${messageId}`), Constants.OCPP_SOCKET_TIMEOUT);
7dde0b73
JB
646 }
647
648 // Function that will receive the request's response
649 function responseCallback(payload, requestPayload) {
650 self._statistics.addMessage(commandName, true);
651 const responseCallbackFn = 'handleResponse' + commandName;
652 if (typeof self[responseCallbackFn] === 'function') {
653 self[responseCallbackFn](payload, requestPayload, self);
654 } else {
61c2e33d 655 logger.debug(self._basicFormatLog() + ' Trying to call an undefined response callback function: ' + responseCallbackFn);
7dde0b73
JB
656 }
657 // Send the response
658 resolve(payload);
659 }
660
661 // Function that will receive the request's rejection
662 function rejectCallback(reason) {
7de604f9 663 self._statistics.addMessage(`Error ${command.code ? command.code : Constants.OCPP_ERROR_GENERIC_ERROR} on ${commandName || ''}`, true);
7dde0b73
JB
664 // Build Exception
665 // eslint-disable-next-line no-empty-function
666 self._requests[messageId] = [() => { }, () => { }, '']; // Properly format the request
667 const error = reason instanceof OCPPError ? reason : new Error(reason);
668 // Send error
669 reject(error);
670 }
671 });
672 }
673
5ad8570f
JB
674 handleResponseBootNotification(payload) {
675 if (payload.status === 'Accepted') {
676 this._heartbeatInterval = payload.interval * 1000;
677 this._addConfigurationKey('HeartBeatInterval', Utils.convertToInt(payload.interval));
678 this._addConfigurationKey('HeartbeatInterval', Utils.convertToInt(payload.interval), false, false);
679 this._basicStartMessageSequence();
0a60c33c
JB
680 } else if (payload.status === 'Pending') {
681 logger.info(this._basicFormatLog() + ' Charging station pending on the central server');
5ad8570f 682 } else {
0a60c33c 683 logger.info(this._basicFormatLog() + ' Charging station rejected by the central server');
7dde0b73 684 }
7dde0b73
JB
685 }
686
bec64e8b
JB
687 _initTransactionOnConnector(connectorId) {
688 this._connectors[connectorId].transactionStarted = false;
689 this._connectors[connectorId].transactionId = null;
690 this._connectors[connectorId].idTag = null;
691 this._connectors[connectorId].lastEnergyActiveImportRegisterValue = -1;
0a60c33c
JB
692 }
693
bec64e8b
JB
694 _resetTransactionOnConnector(connectorId) {
695 this._initTransactionOnConnector(connectorId);
696 if (this._connectors[connectorId].transactionSetInterval) {
697 clearInterval(this._connectors[connectorId].transactionSetInterval);
027b409a
JB
698 }
699 }
700
7dde0b73 701 handleResponseStartTransaction(payload, requestPayload) {
d3a7883e 702 if (this._connectors[requestPayload.connectorId].transactionStarted) {
2d0e26f5
JB
703 logger.debug(this._basicFormatLog() + ' Try to start a transaction on an already used connector ' + requestPayload.connectorId + ': %s', this._connectors[requestPayload.connectorId]);
704 return;
d3a7883e 705 }
84393381 706
7de604f9
JB
707 let transactionConnectorId;
708 for (const connector in this._connectors) {
709 if (Utils.convertToInt(connector) === Utils.convertToInt(requestPayload.connectorId)) {
710 transactionConnectorId = connector;
711 break;
7dde0b73 712 }
7de604f9
JB
713 }
714 if (!transactionConnectorId) {
715 logger.error(this._basicFormatLog() + ' Try to start a transaction on a non existing connector Id ' + requestPayload.connectorId);
716 return;
717 }
718 if (payload.idTagInfo && payload.idTagInfo.status === 'Accepted') {
719 this._connectors[transactionConnectorId].transactionStarted = true;
720 this._connectors[transactionConnectorId].transactionId = payload.transactionId;
721 this._connectors[transactionConnectorId].idTag = requestPayload.idTag;
9b25a525 722 this._connectors[transactionConnectorId].lastEnergyActiveImportRegisterValue = 0;
7de604f9 723 this.sendStatusNotification(requestPayload.connectorId, 'Charging');
2d0e26f5 724 logger.info(this._basicFormatLog() + ' Transaction ' + payload.transactionId + ' STARTED on ' + this._stationInfo.name + '#' + requestPayload.connectorId + ' for idTag ' + requestPayload.idTag);
7de604f9 725 const configuredMeterValueSampleInterval = this._getConfigurationKey('MeterValueSampleInterval');
5ad8570f 726 this._startMeterValues(requestPayload.connectorId,
7de604f9 727 configuredMeterValueSampleInterval ? configuredMeterValueSampleInterval.value * 1000 : 60000);
7dde0b73
JB
728 } else {
729 logger.error(this._basicFormatLog() + ' Starting transaction id ' + payload.transactionId + ' REJECTED with status ' + payload.idTagInfo.status + ', idTag ' + requestPayload.idTag);
7de604f9 730 this._resetTransactionOnConnector(transactionConnectorId);
7dde0b73
JB
731 this.sendStatusNotification(requestPayload.connectorId, 'Available');
732 }
733 }
734
34dcb3b5 735 handleResponseStopTransaction(payload, requestPayload) {
d3a7883e
JB
736 let transactionConnectorId;
737 for (const connector in this._connectors) {
738 if (this._connectors[connector].transactionId === requestPayload.transactionId) {
739 transactionConnectorId = connector;
740 break;
741 }
742 }
743 if (!transactionConnectorId) {
7de604f9
JB
744 logger.error(this._basicFormatLog() + ' Try to stop a non existing transaction ' + requestPayload.transactionId);
745 return;
d3a7883e
JB
746 }
747 if (payload.idTagInfo && payload.idTagInfo.status === 'Accepted') {
748 this.sendStatusNotification(transactionConnectorId, 'Available');
2d0e26f5 749 logger.info(this._basicFormatLog() + ' Transaction ' + requestPayload.transactionId + ' STOPPED on ' + this._stationInfo.name + '#' + transactionConnectorId);
d3a7883e 750 this._resetTransactionOnConnector(transactionConnectorId);
34dcb3b5 751 } else {
2d0e26f5 752 logger.error(this._basicFormatLog() + ' Stopping transaction id ' + requestPayload.transactionId + ' REJECTED with status ' + payload.idTagInfo.status);
34dcb3b5
JB
753 }
754 }
755
facd8ebd 756 handleResponseStatusNotification(payload, requestPayload) {
546dec0f 757 logger.debug(this._basicFormatLog() + ' Status notification response received: %j to StatusNotification request: %j', payload, requestPayload);
7dde0b73
JB
758 }
759
facd8ebd
JB
760 handleResponseMeterValues(payload, requestPayload) {
761 logger.debug(this._basicFormatLog() + ' MeterValues response received: %j to MeterValues request: %j', payload, requestPayload);
027b409a
JB
762 }
763
facd8ebd
JB
764 handleResponseHeartbeat(payload, requestPayload) {
765 logger.debug(this._basicFormatLog() + ' Heartbeat response received: %j to Heartbeat request: %j', payload, requestPayload);
7dde0b73
JB
766 }
767
768 async handleRequest(messageId, commandName, commandPayload) {
769 let result;
770 this._statistics.addMessage(commandName, true);
771 // Call
772 if (typeof this['handle' + commandName] === 'function') {
773 try {
774 // Call the method
775 result = await this['handle' + commandName](commandPayload);
776 } catch (error) {
777 // Log
778 logger.error(this._basicFormatLog() + ' Handle request error: ' + error);
facd8ebd 779 // Send back response to inform backend
7dde0b73
JB
780 await this.sendError(messageId, error);
781 }
782 } else {
84393381 783 // Throw exception
f7869514 784 await this.sendError(messageId, new OCPPError(Constants.OCPP_ERROR_NOT_IMPLEMENTED, 'Not implemented', {}));
7dde0b73
JB
785 throw new Error(`${commandName} is not implemented ${JSON.stringify(commandPayload, null, ' ')}`);
786 }
84393381 787 // Send response
f7869514 788 await this.sendMessage(messageId, result, Constants.OCPP_JSON_CALL_RESULT_MESSAGE);
7dde0b73
JB
789 }
790
5ad8570f 791 async handleReset(commandPayload) {
5ad8570f
JB
792 // Simulate charging station restart
793 setImmediate(async () => {
2d0e26f5 794 await this.stop(commandPayload.type + 'Reset');
0a60c33c 795 await Utils.sleep(this._stationInfo.resetTime);
5ad8570f
JB
796 await this.start();
797 });
0a60c33c 798 logger.info(`${this._basicFormatLog()} ${commandPayload.type} reset command received, simulating it. The station will be back online in ${this._stationInfo.resetTime}ms`);
5ad8570f
JB
799 return Constants.OCPP_RESPONSE_ACCEPTED;
800 }
801
61c2e33d
JB
802 _getConfigurationKey(key) {
803 return this._configuration.configurationKey.find((configElement) => configElement.key === key);
804 }
805
3497da01 806 _addConfigurationKey(key, value, readonly = false, visible = true, reboot = false) {
61c2e33d
JB
807 const keyFound = this._getConfigurationKey(key);
808 if (!keyFound) {
809 this._configuration.configurationKey.push({
810 key,
811 readonly,
812 value,
813 visible,
3497da01 814 reboot,
61c2e33d
JB
815 });
816 }
817 }
818
819 _setConfigurationKeyValue(key, value) {
820 const keyFound = this._getConfigurationKey(key);
821 if (keyFound) {
d3a7883e
JB
822 const keyIndex = this._configuration.configurationKey.indexOf(keyFound);
823 this._configuration.configurationKey[keyIndex].value = value;
61c2e33d
JB
824 }
825 }
826
34dcb3b5 827 async handleGetConfiguration(commandPayload) {
facd8ebd
JB
828 const configurationKey = [];
829 const unknownKey = [];
61c2e33d
JB
830 if (Utils.isEmptyArray(commandPayload.key)) {
831 for (const configuration of this._configuration.configurationKey) {
832 if (Utils.isUndefined(configuration.visible)) {
833 configuration.visible = true;
834 } else {
835 configuration.visible = Utils.convertToBoolean(configuration.visible);
836 }
837 if (!configuration.visible) {
838 continue;
839 }
840 configurationKey.push({
841 key: configuration.key,
842 readonly: configuration.readonly,
843 value: configuration.value,
844 });
facd8ebd 845 }
61c2e33d 846 } else {
d20c21a0
JB
847 for (const configurationKey of commandPayload.key) {
848 const keyFound = this._getConfigurationKey(configurationKey);
61c2e33d
JB
849 if (keyFound) {
850 if (Utils.isUndefined(keyFound.visible)) {
851 keyFound.visible = true;
852 } else {
d20c21a0 853 keyFound.visible = Utils.convertToBoolean(configurationKey.visible);
61c2e33d
JB
854 }
855 if (!keyFound.visible) {
856 continue;
857 }
858 configurationKey.push({
859 key: keyFound.key,
860 readonly: keyFound.readonly,
861 value: keyFound.value,
862 });
863 } else {
d20c21a0 864 unknownKey.push(configurationKey);
61c2e33d 865 }
facd8ebd 866 }
facd8ebd
JB
867 }
868 return {
869 configurationKey,
870 unknownKey,
871 };
7dde0b73
JB
872 }
873
874 async handleChangeConfiguration(commandPayload) {
61c2e33d 875 const keyToChange = this._getConfigurationKey(commandPayload.key);
7d887a1b
JB
876 if (!keyToChange) {
877 return {status: Constants.OCPP_ERROR_NOT_SUPPORTED};
878 } else if (keyToChange && Utils.convertToBoolean(keyToChange.readonly)) {
879 return Constants.OCPP_RESPONSE_REJECTED;
880 } else if (keyToChange && !Utils.convertToBoolean(keyToChange.readonly)) {
a6e68f34
JB
881 const keyIndex = this._configuration.configurationKey.indexOf(keyToChange);
882 this._configuration.configurationKey[keyIndex].value = commandPayload.value;
d3a7883e
JB
883 let triggerHeartbeatRestart = false;
884 if (keyToChange.key === 'HeartBeatInterval') {
885 this._setConfigurationKeyValue('HeartbeatInterval', commandPayload.value);
886 triggerHeartbeatRestart = true;
887 }
888 if (keyToChange.key === 'HeartbeatInterval') {
889 this._setConfigurationKeyValue('HeartBeatInterval', commandPayload.value);
890 triggerHeartbeatRestart = true;
891 }
892 if (triggerHeartbeatRestart) {
5c68da4d
JB
893 this._heartbeatInterval = Utils.convertToInt(commandPayload.value) * 1000;
894 // Stop heartbeat
0a60c33c 895 this._stopHeartbeat();
5c68da4d
JB
896 // Start heartbeat
897 this._startHeartbeat(this);
898 }
7d887a1b
JB
899 if (Utils.convertToBoolean(keyToChange.reboot)) {
900 return Constants.OCPP_RESPONSE_REBOOT_REQUIRED;
901 }
dcab13bd 902 return Constants.OCPP_RESPONSE_ACCEPTED;
7dde0b73 903 }
7dde0b73
JB
904 }
905
906 async handleRemoteStartTransaction(commandPayload) {
72766a82 907 const transactionConnectorID = commandPayload.connectorId ? commandPayload.connectorId : '1';
2e6f5966 908 if (this.hasAuthorizedTags() && this._getLocalAuthListEnabled() && this._getAuthorizeRemoteTxRequests()) {
dcab13bd 909 // Check if authorized
2e6f5966 910 if (this._authorizedTags.find((value) => value === commandPayload.idTag)) {
7dde0b73 911 // Authorization successful start transaction
61c2e33d 912 this.sendStartTransactionWithTimeout(transactionConnectorID, commandPayload.idTag, Constants.START_TRANSACTION_TIMEOUT);
027b409a 913 logger.debug(this._basicFormatLog() + ' Transaction remotely STARTED on ' + this._stationInfo.name + '#' + transactionConnectorID + ' for idTag ' + commandPayload.idTag);
dcab13bd 914 return Constants.OCPP_RESPONSE_ACCEPTED;
7dde0b73 915 }
84393381 916 logger.error(this._basicFormatLog() + ' Remote starting transaction REJECTED with status ' + commandPayload.idTagInfo.status + ', idTag ' + commandPayload.idTag);
dcab13bd 917 return Constants.OCPP_RESPONSE_REJECTED;
7dde0b73 918 }
dcab13bd 919 // No local authorization check required => start transaction
61c2e33d 920 this.sendStartTransactionWithTimeout(transactionConnectorID, commandPayload.idTag, Constants.START_TRANSACTION_TIMEOUT);
027b409a
JB
921 logger.debug(this._basicFormatLog() + ' Transaction remotely STARTED on ' + this._stationInfo.name + '#' + transactionConnectorID + ' for idTag ' + commandPayload.idTag);
922 return Constants.OCPP_RESPONSE_ACCEPTED;
923 }
924
925 async handleRemoteStopTransaction(commandPayload) {
926 for (const connector in this._connectors) {
927 if (this._connectors[connector].transactionId === commandPayload.transactionId) {
d3a7883e
JB
928 this.sendStopTransaction(commandPayload.transactionId);
929 return Constants.OCPP_RESPONSE_ACCEPTED;
027b409a
JB
930 }
931 }
d3a7883e
JB
932 logger.info(this._basicFormatLog() + ' Try to stop remotely a non existing transaction ' + commandPayload.transactionId);
933 return Constants.OCPP_RESPONSE_REJECTED;
7dde0b73 934 }
7dde0b73
JB
935}
936
937module.exports = ChargingStation;