Merge branch 'master' of github.com:LucasBrazi06/ev-simulator into master-enterprise
[e-mobility-charging-stations-simulator.git] / src / charging-station / ChargingStation.ts
1 import { AuthorizationStatus, StartTransactionRequest, StartTransactionResponse, StopTransactionReason, StopTransactionRequest, StopTransactionResponse } from '../types/ocpp/1.6/Transaction';
2 import { AvailabilityType, BootNotificationRequest, ChangeAvailabilityRequest, ChangeConfigurationRequest, GetConfigurationRequest, HeartbeatRequest, IncomingRequestCommand, RemoteStartTransactionRequest, RemoteStopTransactionRequest, RequestCommand, ResetRequest, SetChargingProfileRequest, StatusNotificationRequest, UnlockConnectorRequest } from '../types/ocpp/1.6/Requests';
3 import { BootNotificationResponse, ChangeAvailabilityResponse, ChangeConfigurationResponse, DefaultResponse, GetConfigurationResponse, HeartbeatResponse, RegistrationStatus, SetChargingProfileResponse, StatusNotificationResponse, UnlockConnectorResponse } from '../types/ocpp/1.6/RequestResponses';
4 import { ChargingProfile, ChargingProfilePurposeType } from '../types/ocpp/1.6/ChargingProfile';
5 import ChargingStationConfiguration, { ConfigurationKey } from '../types/ChargingStationConfiguration';
6 import ChargingStationTemplate, { PowerOutType } from '../types/ChargingStationTemplate';
7 import Connectors, { Connector } from '../types/Connectors';
8 import { MeterValue, MeterValueLocation, MeterValueMeasurand, MeterValuePhase, MeterValueUnit, MeterValuesRequest, MeterValuesResponse, SampledValue } from '../types/ocpp/1.6/MeterValues';
9 import { PerformanceObserver, performance } from 'perf_hooks';
10 import Requests, { IncomingRequest, Request } from '../types/ocpp/Requests';
11 import WebSocket, { MessageEvent } from 'ws';
12
13 import AutomaticTransactionGenerator from './AutomaticTransactionGenerator';
14 import { ChargePointErrorCode } from '../types/ocpp/1.6/ChargePointErrorCode';
15 import { ChargePointStatus } from '../types/ocpp/1.6/ChargePointStatus';
16 import ChargingStationInfo from '../types/ChargingStationInfo';
17 import Configuration from '../utils/Configuration';
18 import Constants from '../utils/Constants';
19 import ElectricUtils from '../utils/ElectricUtils';
20 import { ErrorType } from '../types/ocpp/ErrorType';
21 import MeasurandValues from '../types/MeasurandValues';
22 import { MessageType } from '../types/ocpp/MessageType';
23 import { OCPPConfigurationKey } from '../types/ocpp/Configuration';
24 import OCPPError from './OcppError';
25 import { StandardParametersKey } from '../types/ocpp/1.6/Configuration';
26 import Statistics from '../utils/Statistics';
27 import Utils from '../utils/Utils';
28 import { WebSocketCloseEventStatusCode } from '../types/WebSocket';
29 import crypto from 'crypto';
30 import fs from 'fs';
31 import logger from '../utils/Logger';
32
33 export default class ChargingStation {
34 private _index: number;
35 private _stationTemplateFile: string;
36 private _stationInfo: ChargingStationInfo;
37 private _bootNotificationRequest: BootNotificationRequest;
38 private _bootNotificationResponse: BootNotificationResponse;
39 private _connectors: Connectors;
40 private _configuration: ChargingStationConfiguration;
41 private _connectorsConfigurationHash: string;
42 private _supervisionUrl: string;
43 private _wsConnectionUrl: string;
44 private _wsConnection: WebSocket;
45 private _hasStopped: boolean;
46 private _hasSocketRestarted: boolean;
47 private _autoReconnectRetryCount: number;
48 private _requests: Requests;
49 private _messageQueue: string[];
50 private _automaticTransactionGeneration: AutomaticTransactionGenerator;
51 private _authorizedTags: string[];
52 private _heartbeatSetInterval: NodeJS.Timeout;
53 private _webSocketPingSetInterval: NodeJS.Timeout;
54 private _statistics: Statistics;
55 private _performanceObserver: PerformanceObserver;
56
57 constructor(index: number, stationTemplateFile: string) {
58 this._index = index;
59 this._stationTemplateFile = stationTemplateFile;
60 this._connectors = {} as Connectors;
61 this._initialize();
62
63 this._hasStopped = false;
64 this._hasSocketRestarted = false;
65 this._autoReconnectRetryCount = 0;
66
67 this._requests = {} as Requests;
68 this._messageQueue = [] as string[];
69
70 this._authorizedTags = this._loadAndGetAuthorizedTags();
71 }
72
73 _getStationName(stationTemplate: ChargingStationTemplate): string {
74 return stationTemplate.fixedName ? stationTemplate.baseName : stationTemplate.baseName + '-' + ('000000000' + this._index.toString()).substr(('000000000' + this._index.toString()).length - 4);
75 }
76
77 _buildStationInfo(): ChargingStationInfo {
78 let stationTemplateFromFile: ChargingStationTemplate;
79 try {
80 // Load template file
81 const fileDescriptor = fs.openSync(this._stationTemplateFile, 'r');
82 stationTemplateFromFile = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as ChargingStationTemplate;
83 fs.closeSync(fileDescriptor);
84 } catch (error) {
85 logger.error('Template file ' + this._stationTemplateFile + ' loading error: %j', error);
86 throw error;
87 }
88 const stationInfo: ChargingStationInfo = stationTemplateFromFile || {} as ChargingStationInfo;
89 if (!Utils.isEmptyArray(stationTemplateFromFile.power)) {
90 stationTemplateFromFile.power = stationTemplateFromFile.power as number[];
91 stationInfo.maxPower = stationTemplateFromFile.power[Math.floor(Math.random() * stationTemplateFromFile.power.length)];
92 } else {
93 stationInfo.maxPower = stationTemplateFromFile.power as number;
94 }
95 stationInfo.name = this._getStationName(stationTemplateFromFile);
96 stationInfo.resetTime = stationTemplateFromFile.resetTime ? stationTemplateFromFile.resetTime * 1000 : Constants.CHARGING_STATION_DEFAULT_RESET_TIME;
97 return stationInfo;
98 }
99
100 get stationInfo(): ChargingStationInfo {
101 return this._stationInfo;
102 }
103
104 _initialize(): void {
105 this._stationInfo = this._buildStationInfo();
106 this._bootNotificationRequest = {
107 chargePointModel: this._stationInfo.chargePointModel,
108 chargePointVendor: this._stationInfo.chargePointVendor,
109 ...!Utils.isUndefined(this._stationInfo.chargeBoxSerialNumberPrefix) && { chargeBoxSerialNumber: this._stationInfo.chargeBoxSerialNumberPrefix },
110 ...!Utils.isUndefined(this._stationInfo.firmwareVersion) && { firmwareVersion: this._stationInfo.firmwareVersion },
111 };
112 this._configuration = this._getTemplateChargingStationConfiguration();
113 this._supervisionUrl = this._getSupervisionURL();
114 this._wsConnectionUrl = this._supervisionUrl + '/' + this._stationInfo.name;
115 // Build connectors if needed
116 const maxConnectors = this._getMaxNumberOfConnectors();
117 if (maxConnectors <= 0) {
118 logger.warn(`${this._logPrefix()} Charging station template ${this._stationTemplateFile} with ${maxConnectors} connectors`);
119 }
120 const templateMaxConnectors = this._getTemplateMaxNumberOfConnectors();
121 if (templateMaxConnectors <= 0) {
122 logger.warn(`${this._logPrefix()} Charging station template ${this._stationTemplateFile} with no connector configuration`);
123 }
124 if (!this._stationInfo.Connectors[0]) {
125 logger.warn(`${this._logPrefix()} Charging station template ${this._stationTemplateFile} with no connector Id 0 configuration`);
126 }
127 // Sanity check
128 if (maxConnectors > (this._stationInfo.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) && !this._stationInfo.randomConnectors) {
129 logger.warn(`${this._logPrefix()} Number of connectors exceeds the number of connector configurations in template ${this._stationTemplateFile}, forcing random connector configurations affectation`);
130 this._stationInfo.randomConnectors = true;
131 }
132 const connectorsConfigHash = crypto.createHash('sha256').update(JSON.stringify(this._stationInfo.Connectors) + maxConnectors.toString()).digest('hex');
133 // FIXME: Handle shrinking the number of connectors
134 if (!this._connectors || (this._connectors && this._connectorsConfigurationHash !== connectorsConfigHash)) {
135 this._connectorsConfigurationHash = connectorsConfigHash;
136 // Add connector Id 0
137 let lastConnector = '0';
138 for (lastConnector in this._stationInfo.Connectors) {
139 if (Utils.convertToInt(lastConnector) === 0 && this._getUseConnectorId0() && this._stationInfo.Connectors[lastConnector]) {
140 this._connectors[lastConnector] = Utils.cloneObject<Connector>(this._stationInfo.Connectors[lastConnector]);
141 this._connectors[lastConnector].availability = AvailabilityType.OPERATIVE;
142 }
143 }
144 // Generate all connectors
145 if ((this._stationInfo.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) > 0) {
146 for (let index = 1; index <= maxConnectors; index++) {
147 const randConnectorID = this._stationInfo.randomConnectors ? Utils.getRandomInt(Utils.convertToInt(lastConnector), 1) : index;
148 this._connectors[index] = Utils.cloneObject<Connector>(this._stationInfo.Connectors[randConnectorID]);
149 this._connectors[index].availability = AvailabilityType.OPERATIVE;
150 }
151 }
152 }
153 // Avoid duplication of connectors related information
154 delete this._stationInfo.Connectors;
155 // Initialize transaction attributes on connectors
156 for (const connector in this._connectors) {
157 if (Utils.convertToInt(connector) > 0 && !this.getConnector(Utils.convertToInt(connector)).transactionStarted) {
158 this._initTransactionOnConnector(Utils.convertToInt(connector));
159 }
160 }
161 // OCPP parameters
162 this._addConfigurationKey(StandardParametersKey.NumberOfConnectors, this._getNumberOfConnectors().toString(), true);
163 if (!this._getConfigurationKey(StandardParametersKey.MeterValuesSampledData)) {
164 this._addConfigurationKey(StandardParametersKey.MeterValuesSampledData, MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER);
165 }
166 this._stationInfo.powerDivider = this._getPowerDivider();
167 if (this.getEnableStatistics()) {
168 this._statistics = Statistics.getInstance();
169 this._statistics.objName = this._stationInfo.name;
170 this._performanceObserver = new PerformanceObserver((list) => {
171 const entry = list.getEntries()[0];
172 this._statistics.logPerformance(entry, Constants.ENTITY_CHARGING_STATION);
173 this._performanceObserver.disconnect();
174 });
175 }
176 }
177
178 get connectors(): Connectors {
179 return this._connectors;
180 }
181
182 get statistics(): Statistics {
183 return this._statistics;
184 }
185
186 _logPrefix(): string {
187 return Utils.logPrefix(` ${this._stationInfo.name}:`);
188 }
189
190 _isWebSocketOpen(): boolean {
191 return this._wsConnection?.readyState === WebSocket.OPEN;
192 }
193
194 _isRegistered(): boolean {
195 return this._bootNotificationResponse?.status === RegistrationStatus.ACCEPTED;
196 }
197
198 _getTemplateChargingStationConfiguration(): ChargingStationConfiguration {
199 return this._stationInfo.Configuration ? this._stationInfo.Configuration : {} as ChargingStationConfiguration;
200 }
201
202 _getAuthorizationFile(): string {
203 return this._stationInfo.authorizationFile && this._stationInfo.authorizationFile;
204 }
205
206 _getUseConnectorId0(): boolean {
207 return !Utils.isUndefined(this._stationInfo.useConnectorId0) ? this._stationInfo.useConnectorId0 : true;
208 }
209
210 _loadAndGetAuthorizedTags(): string[] {
211 let authorizedTags: string[] = [];
212 const authorizationFile = this._getAuthorizationFile();
213 if (authorizationFile) {
214 try {
215 // Load authorization file
216 const fileDescriptor = fs.openSync(authorizationFile, 'r');
217 authorizedTags = JSON.parse(fs.readFileSync(fileDescriptor, 'utf8')) as string[];
218 fs.closeSync(fileDescriptor);
219 } catch (error) {
220 logger.error(this._logPrefix() + ' Authorization file ' + authorizationFile + ' loading error: %j', error);
221 throw error;
222 }
223 } else {
224 logger.info(this._logPrefix() + ' No authorization file given in template file ' + this._stationTemplateFile);
225 }
226 return authorizedTags;
227 }
228
229 getRandomTagId(): string {
230 const index = Math.floor(Math.random() * this._authorizedTags.length);
231 return this._authorizedTags[index];
232 }
233
234 hasAuthorizedTags(): boolean {
235 return !Utils.isEmptyArray(this._authorizedTags);
236 }
237
238 getEnableStatistics(): boolean {
239 return !Utils.isUndefined(this._stationInfo.enableStatistics) ? this._stationInfo.enableStatistics : true;
240 }
241
242 _getNumberOfPhases(): number {
243 switch (this._getPowerOutType()) {
244 case PowerOutType.AC:
245 return !Utils.isUndefined(this._stationInfo.numberOfPhases) ? this._stationInfo.numberOfPhases : 3;
246 case PowerOutType.DC:
247 return 0;
248 }
249 }
250
251 _getNumberOfRunningTransactions(): number {
252 let trxCount = 0;
253 for (const connector in this._connectors) {
254 if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionStarted) {
255 trxCount++;
256 }
257 }
258 return trxCount;
259 }
260
261 // 0 for disabling
262 _getConnectionTimeout(): number {
263 if (!Utils.isUndefined(this._stationInfo.connectionTimeout)) {
264 return this._stationInfo.connectionTimeout;
265 }
266 if (!Utils.isUndefined(Configuration.getConnectionTimeout())) {
267 return Configuration.getConnectionTimeout();
268 }
269 return 30;
270 }
271
272 // -1 for unlimited, 0 for disabling
273 _getAutoReconnectMaxRetries(): number {
274 if (!Utils.isUndefined(this._stationInfo.autoReconnectMaxRetries)) {
275 return this._stationInfo.autoReconnectMaxRetries;
276 }
277 if (!Utils.isUndefined(Configuration.getAutoReconnectMaxRetries())) {
278 return Configuration.getAutoReconnectMaxRetries();
279 }
280 return -1;
281 }
282
283 // 0 for disabling
284 _getRegistrationMaxRetries(): number {
285 if (!Utils.isUndefined(this._stationInfo.registrationMaxRetries)) {
286 return this._stationInfo.registrationMaxRetries;
287 }
288 return -1;
289 }
290
291 _getPowerDivider(): number {
292 let powerDivider = this._getNumberOfConnectors();
293 if (this._stationInfo.powerSharedByConnectors) {
294 powerDivider = this._getNumberOfRunningTransactions();
295 }
296 return powerDivider;
297 }
298
299 getConnector(id: number): Connector {
300 return this._connectors[id];
301 }
302
303 _isConnectorAvailable(id: number): boolean {
304 return this.getConnector(id).availability === AvailabilityType.OPERATIVE;
305 }
306
307 _getTemplateMaxNumberOfConnectors(): number {
308 return Object.keys(this._stationInfo.Connectors).length;
309 }
310
311 _getMaxNumberOfConnectors(): number {
312 let maxConnectors = 0;
313 if (!Utils.isEmptyArray(this._stationInfo.numberOfConnectors)) {
314 const numberOfConnectors = this._stationInfo.numberOfConnectors as number[];
315 // Distribute evenly the number of connectors
316 maxConnectors = numberOfConnectors[(this._index - 1) % numberOfConnectors.length];
317 } else if (!Utils.isUndefined(this._stationInfo.numberOfConnectors)) {
318 maxConnectors = this._stationInfo.numberOfConnectors as number;
319 } else {
320 maxConnectors = this._stationInfo.Connectors[0] ? this._getTemplateMaxNumberOfConnectors() - 1 : this._getTemplateMaxNumberOfConnectors();
321 }
322 return maxConnectors;
323 }
324
325 _getNumberOfConnectors(): number {
326 return this._connectors[0] ? Object.keys(this._connectors).length - 1 : Object.keys(this._connectors).length;
327 }
328
329 _getVoltageOut(): number {
330 const errMsg = `${this._logPrefix()} Unknown ${this._getPowerOutType()} powerOutType in template file ${this._stationTemplateFile}, cannot define default voltage out`;
331 let defaultVoltageOut: number;
332 switch (this._getPowerOutType()) {
333 case PowerOutType.AC:
334 defaultVoltageOut = 230;
335 break;
336 case PowerOutType.DC:
337 defaultVoltageOut = 400;
338 break;
339 default:
340 logger.error(errMsg);
341 throw Error(errMsg);
342 }
343 return !Utils.isUndefined(this._stationInfo.voltageOut) ? this._stationInfo.voltageOut : defaultVoltageOut;
344 }
345
346 _getTransactionIdTag(transactionId: number): string {
347 for (const connector in this._connectors) {
348 if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) {
349 return this.getConnector(Utils.convertToInt(connector)).idTag;
350 }
351 }
352 }
353
354 _getTransactionMeterStop(transactionId: number): number {
355 for (const connector in this._connectors) {
356 if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionId === transactionId) {
357 return this.getConnector(Utils.convertToInt(connector)).lastEnergyActiveImportRegisterValue;
358 }
359 }
360 }
361
362 _getPowerOutType(): PowerOutType {
363 return !Utils.isUndefined(this._stationInfo.powerOutType) ? this._stationInfo.powerOutType : PowerOutType.AC;
364 }
365
366 _getSupervisionURL(): string {
367 const supervisionUrls = Utils.cloneObject<string | string[]>(this._stationInfo.supervisionURL ? this._stationInfo.supervisionURL : Configuration.getSupervisionURLs());
368 let indexUrl = 0;
369 if (!Utils.isEmptyArray(supervisionUrls)) {
370 if (Configuration.getDistributeStationsToTenantsEqually()) {
371 indexUrl = this._index % supervisionUrls.length;
372 } else {
373 // Get a random url
374 indexUrl = Math.floor(Math.random() * supervisionUrls.length);
375 }
376 return supervisionUrls[indexUrl];
377 }
378 return supervisionUrls as string;
379 }
380
381 _getReconnectExponentialDelay(): boolean {
382 return !Utils.isUndefined(this._stationInfo.reconnectExponentialDelay) ? this._stationInfo.reconnectExponentialDelay : false;
383 }
384
385 _getHeartbeatInterval(): number {
386 const HeartbeatInterval = this._getConfigurationKey(StandardParametersKey.HeartbeatInterval);
387 if (HeartbeatInterval) {
388 return Utils.convertToInt(HeartbeatInterval.value) * 1000;
389 }
390 const HeartBeatInterval = this._getConfigurationKey(StandardParametersKey.HeartBeatInterval);
391 if (HeartBeatInterval) {
392 return Utils.convertToInt(HeartBeatInterval.value) * 1000;
393 }
394 }
395
396 _getAuthorizeRemoteTxRequests(): boolean {
397 const authorizeRemoteTxRequests = this._getConfigurationKey(StandardParametersKey.AuthorizeRemoteTxRequests);
398 return authorizeRemoteTxRequests ? Utils.convertToBoolean(authorizeRemoteTxRequests.value) : false;
399 }
400
401 _getLocalAuthListEnabled(): boolean {
402 const localAuthListEnabled = this._getConfigurationKey(StandardParametersKey.LocalAuthListEnabled);
403 return localAuthListEnabled ? Utils.convertToBoolean(localAuthListEnabled.value) : false;
404 }
405
406 async _startMessageSequence(): Promise<void> {
407 // Start WebSocket ping
408 this._startWebSocketPing();
409 // Start heartbeat
410 this._startHeartbeat();
411 // Initialize connectors status
412 for (const connector in this._connectors) {
413 if (Utils.convertToInt(connector) === 0) {
414 continue;
415 } else if (!this._hasStopped && !this.getConnector(Utils.convertToInt(connector))?.status && this.getConnector(Utils.convertToInt(connector))?.bootStatus) {
416 // Send status in template at startup
417 await this.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).bootStatus);
418 } else if (this._hasStopped && this.getConnector(Utils.convertToInt(connector))?.bootStatus) {
419 // Send status in template after reset
420 await this.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).bootStatus);
421 } else if (!this._hasStopped && this.getConnector(Utils.convertToInt(connector))?.status) {
422 // Send previous status at template reload
423 await this.sendStatusNotification(Utils.convertToInt(connector), this.getConnector(Utils.convertToInt(connector)).status);
424 } else {
425 // Send default status
426 await this.sendStatusNotification(Utils.convertToInt(connector), ChargePointStatus.AVAILABLE);
427 }
428 }
429 // Start the ATG
430 if (this._stationInfo.AutomaticTransactionGenerator.enable) {
431 if (!this._automaticTransactionGeneration) {
432 this._automaticTransactionGeneration = new AutomaticTransactionGenerator(this);
433 }
434 if (this._automaticTransactionGeneration.timeToStop) {
435 this._automaticTransactionGeneration.start();
436 }
437 }
438 if (this.getEnableStatistics()) {
439 this._statistics.start();
440 }
441 }
442
443 async _stopMessageSequence(reason: StopTransactionReason = StopTransactionReason.NONE): Promise<void> {
444 // Stop WebSocket ping
445 this._stopWebSocketPing();
446 // Stop heartbeat
447 this._stopHeartbeat();
448 // Stop the ATG
449 if (this._stationInfo.AutomaticTransactionGenerator.enable &&
450 this._automaticTransactionGeneration &&
451 !this._automaticTransactionGeneration.timeToStop) {
452 await this._automaticTransactionGeneration.stop(reason);
453 } else {
454 for (const connector in this._connectors) {
455 if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector)).transactionStarted) {
456 await this.sendStopTransaction(this.getConnector(Utils.convertToInt(connector)).transactionId, reason);
457 }
458 }
459 }
460 }
461
462 _startWebSocketPing(): void {
463 const webSocketPingInterval: number = this._getConfigurationKey(StandardParametersKey.WebSocketPingInterval) ? Utils.convertToInt(this._getConfigurationKey(StandardParametersKey.WebSocketPingInterval).value) : 0;
464 if (webSocketPingInterval > 0 && !this._webSocketPingSetInterval) {
465 this._webSocketPingSetInterval = setInterval(() => {
466 if (this._isWebSocketOpen()) {
467 this._wsConnection.ping((): void => { });
468 }
469 }, webSocketPingInterval * 1000);
470 logger.info(this._logPrefix() + ' WebSocket ping started every ' + Utils.secondsToHHMMSS(webSocketPingInterval));
471 } else if (this._webSocketPingSetInterval) {
472 logger.info(this._logPrefix() + ' WebSocket ping every ' + Utils.secondsToHHMMSS(webSocketPingInterval) + ' already started');
473 } else {
474 logger.error(`${this._logPrefix()} WebSocket ping interval set to ${webSocketPingInterval ? Utils.secondsToHHMMSS(webSocketPingInterval) : webSocketPingInterval}, not starting the WebSocket ping`);
475 }
476 }
477
478 _stopWebSocketPing(): void {
479 if (this._webSocketPingSetInterval) {
480 clearInterval(this._webSocketPingSetInterval);
481 this._webSocketPingSetInterval = null;
482 }
483 }
484
485 _restartWebSocketPing(): void {
486 // Stop WebSocket ping
487 this._stopWebSocketPing();
488 // Start WebSocket ping
489 this._startWebSocketPing();
490 }
491
492 _startHeartbeat(): void {
493 if (this._getHeartbeatInterval() && this._getHeartbeatInterval() > 0 && !this._heartbeatSetInterval) {
494 this._heartbeatSetInterval = setInterval(async () => {
495 await this.sendHeartbeat();
496 }, this._getHeartbeatInterval());
497 logger.info(this._logPrefix() + ' Heartbeat started every ' + Utils.milliSecondsToHHMMSS(this._getHeartbeatInterval()));
498 } else if (this._heartbeatSetInterval) {
499 logger.info(this._logPrefix() + ' Heartbeat every ' + Utils.milliSecondsToHHMMSS(this._getHeartbeatInterval()) + ' already started');
500 } else {
501 logger.error(`${this._logPrefix()} Heartbeat interval set to ${this._getHeartbeatInterval() ? Utils.milliSecondsToHHMMSS(this._getHeartbeatInterval()) : this._getHeartbeatInterval()}, not starting the heartbeat`);
502 }
503 }
504
505 _stopHeartbeat(): void {
506 if (this._heartbeatSetInterval) {
507 clearInterval(this._heartbeatSetInterval);
508 this._heartbeatSetInterval = null;
509 }
510 }
511
512 _restartHeartbeat(): void {
513 // Stop heartbeat
514 this._stopHeartbeat();
515 // Start heartbeat
516 this._startHeartbeat();
517 }
518
519 _startAuthorizationFileMonitoring(): void {
520 // eslint-disable-next-line @typescript-eslint/no-unused-vars
521 fs.watchFile(this._getAuthorizationFile(), (current, previous) => {
522 try {
523 logger.debug(this._logPrefix() + ' Authorization file ' + this._getAuthorizationFile() + ' have changed, reload');
524 // Initialize _authorizedTags
525 this._authorizedTags = this._loadAndGetAuthorizedTags();
526 } catch (error) {
527 logger.error(this._logPrefix() + ' Authorization file monitoring error: %j', error);
528 }
529 });
530 }
531
532 _startStationTemplateFileMonitoring(): void {
533 // eslint-disable-next-line @typescript-eslint/no-unused-vars
534 fs.watchFile(this._stationTemplateFile, (current, previous) => {
535 try {
536 logger.debug(this._logPrefix() + ' Template file ' + this._stationTemplateFile + ' have changed, reload');
537 // Initialize
538 this._initialize();
539 if (!this._stationInfo.AutomaticTransactionGenerator.enable &&
540 this._automaticTransactionGeneration) {
541 this._automaticTransactionGeneration.stop().catch(() => { });
542 }
543 // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed
544 } catch (error) {
545 logger.error(this._logPrefix() + ' Charging station template file monitoring error: %j', error);
546 }
547 });
548 }
549
550 _startMeterValues(connectorId: number, interval: number): void {
551 if (connectorId === 0) {
552 logger.error(`${this._logPrefix()} Trying to start MeterValues on connector Id ${connectorId.toString()}`);
553 return;
554 }
555 if (!this.getConnector(connectorId)) {
556 logger.error(`${this._logPrefix()} Trying to start MeterValues on non existing connector Id ${connectorId.toString()}`);
557 return;
558 }
559 if (!this.getConnector(connectorId)?.transactionStarted) {
560 logger.error(`${this._logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction started`);
561 return;
562 } else if (this.getConnector(connectorId)?.transactionStarted && !this.getConnector(connectorId)?.transactionId) {
563 logger.error(`${this._logPrefix()} Trying to start MeterValues on connector Id ${connectorId} with no transaction id`);
564 return;
565 }
566 if (interval > 0) {
567 this.getConnector(connectorId).transactionSetInterval = setInterval(async () => {
568 if (this.getEnableStatistics()) {
569 const sendMeterValues = performance.timerify(this.sendMeterValues);
570 this._performanceObserver.observe({
571 entryTypes: ['function'],
572 });
573 await sendMeterValues(connectorId, interval, this);
574 } else {
575 await this.sendMeterValues(connectorId, interval, this);
576 }
577 }, interval);
578 } else {
579 logger.error(`${this._logPrefix()} Charging station MeterValueSampleInterval configuration set to ${Utils.milliSecondsToHHMMSS(interval)}, not sending MeterValues`);
580 }
581 }
582
583 _openWSConnection(options?: WebSocket.ClientOptions, forceCloseOpened = false): void {
584 if (Utils.isUndefined(options)) {
585 options = {} as WebSocket.ClientOptions;
586 }
587 if (Utils.isUndefined(options.handshakeTimeout)) {
588 options.handshakeTimeout = this._getConnectionTimeout() * 1000;
589 }
590 if (this._isWebSocketOpen() && forceCloseOpened) {
591 this._wsConnection.close();
592 }
593 this._wsConnection = new WebSocket(this._wsConnectionUrl, 'ocpp' + Constants.OCPP_VERSION_16, options);
594 logger.info(this._logPrefix() + ' Will communicate through URL ' + this._supervisionUrl);
595 }
596
597 start(): void {
598 this._openWSConnection();
599 // Monitor authorization file
600 this._startAuthorizationFileMonitoring();
601 // Monitor station template file
602 this._startStationTemplateFileMonitoring();
603 // Handle Socket incoming messages
604 this._wsConnection.on('message', this.onMessage.bind(this));
605 // Handle Socket error
606 this._wsConnection.on('error', this.onError.bind(this));
607 // Handle Socket close
608 this._wsConnection.on('close', this.onClose.bind(this));
609 // Handle Socket opening connection
610 this._wsConnection.on('open', this.onOpen.bind(this));
611 // Handle Socket ping
612 this._wsConnection.on('ping', this.onPing.bind(this));
613 // Handle Socket pong
614 this._wsConnection.on('pong', this.onPong.bind(this));
615 }
616
617 async stop(reason: StopTransactionReason = StopTransactionReason.NONE): Promise<void> {
618 // Stop message sequence
619 await this._stopMessageSequence(reason);
620 for (const connector in this._connectors) {
621 if (Utils.convertToInt(connector) > 0) {
622 await this.sendStatusNotification(Utils.convertToInt(connector), ChargePointStatus.UNAVAILABLE);
623 }
624 }
625 if (this._isWebSocketOpen()) {
626 this._wsConnection.close();
627 }
628 this._bootNotificationResponse = null;
629 this._hasStopped = true;
630 }
631
632 async _reconnect(error): Promise<void> {
633 // Stop heartbeat
634 this._stopHeartbeat();
635 // Stop the ATG if needed
636 if (this._stationInfo.AutomaticTransactionGenerator.enable &&
637 this._stationInfo.AutomaticTransactionGenerator.stopOnConnectionFailure &&
638 this._automaticTransactionGeneration &&
639 !this._automaticTransactionGeneration.timeToStop) {
640 this._automaticTransactionGeneration.stop().catch(() => { });
641 }
642 if (this._autoReconnectRetryCount < this._getAutoReconnectMaxRetries() || this._getAutoReconnectMaxRetries() === -1) {
643 this._autoReconnectRetryCount++;
644 const reconnectDelay = (this._getReconnectExponentialDelay() ? Utils.exponentialDelay(this._autoReconnectRetryCount) : this._getConnectionTimeout() * 1000);
645 logger.error(`${this._logPrefix()} Socket: connection retry in ${Utils.roundTo(reconnectDelay, 2)}ms, timeout ${reconnectDelay - 100}ms`);
646 await Utils.sleep(reconnectDelay);
647 logger.error(this._logPrefix() + ' Socket: reconnecting try #' + this._autoReconnectRetryCount.toString());
648 this._openWSConnection({ handshakeTimeout: reconnectDelay - 100 });
649 this._hasSocketRestarted = true;
650 } else if (this._getAutoReconnectMaxRetries() !== -1) {
651 logger.error(`${this._logPrefix()} Socket reconnect failure: max retries reached (${this._autoReconnectRetryCount}) or retry disabled (${this._getAutoReconnectMaxRetries()})`);
652 }
653 }
654
655 async onOpen(): Promise<void> {
656 logger.info(`${this._logPrefix()} Is connected to server through ${this._wsConnectionUrl}`);
657 if (!this._isRegistered()) {
658 // Send BootNotification
659 let registrationRetryCount = 0;
660 do {
661 this._bootNotificationResponse = await this.sendBootNotification();
662 if (!this._isRegistered()) {
663 registrationRetryCount++;
664 await Utils.sleep(this._bootNotificationResponse.interval * 1000);
665 }
666 } while (!this._isRegistered() && (registrationRetryCount <= this._getRegistrationMaxRetries() || this._getRegistrationMaxRetries() === -1));
667 }
668 if (this._isRegistered()) {
669 await this._startMessageSequence();
670 if (this._hasSocketRestarted && this._isWebSocketOpen()) {
671 if (!Utils.isEmptyArray(this._messageQueue)) {
672 this._messageQueue.forEach((message, index) => {
673 this._messageQueue.splice(index, 1);
674 this._wsConnection.send(message);
675 });
676 }
677 }
678 } else {
679 logger.error(`${this._logPrefix()} Registration failure: max retries reached (${this._getRegistrationMaxRetries()}) or retry disabled (${this._getRegistrationMaxRetries()})`);
680 }
681 this._autoReconnectRetryCount = 0;
682 this._hasSocketRestarted = false;
683 }
684
685 async onError(errorEvent): Promise<void> {
686 logger.error(this._logPrefix() + ' Socket error: %j', errorEvent);
687 // pragma switch (errorEvent.code) {
688 // case 'ECONNREFUSED':
689 // await this._reconnect(errorEvent);
690 // break;
691 // }
692 }
693
694 async onClose(closeEvent): Promise<void> {
695 switch (closeEvent) {
696 case WebSocketCloseEventStatusCode.CLOSE_NORMAL: // Normal close
697 case WebSocketCloseEventStatusCode.CLOSE_NO_STATUS:
698 logger.info(`${this._logPrefix()} Socket normally closed with status '${Utils.getWebSocketCloseEventStatusString(closeEvent)}'`);
699 this._autoReconnectRetryCount = 0;
700 break;
701 default: // Abnormal close
702 logger.error(`${this._logPrefix()} Socket abnormally closed with status '${Utils.getWebSocketCloseEventStatusString(closeEvent)}'`);
703 await this._reconnect(closeEvent);
704 break;
705 }
706 }
707
708 onPing(): void {
709 logger.debug(this._logPrefix() + ' Has received a WS ping (rfc6455) from the server');
710 }
711
712 onPong(): void {
713 logger.debug(this._logPrefix() + ' Has received a WS pong (rfc6455) from the server');
714 }
715
716 async onMessage(messageEvent: MessageEvent): Promise<void> {
717 let [messageType, messageId, commandName, commandPayload, errorDetails]: IncomingRequest = [0, '', '' as IncomingRequestCommand, '', ''];
718 let responseCallback: (payload?, requestPayload?) => void;
719 let rejectCallback: (error: OCPPError) => void;
720 let requestPayload: Record<string, unknown>;
721 let errMsg: string;
722 try {
723 // Parse the message
724 [messageType, messageId, commandName, commandPayload, errorDetails] = JSON.parse(messageEvent.toString()) as IncomingRequest;
725
726 // Check the Type of message
727 switch (messageType) {
728 // Incoming Message
729 case MessageType.CALL_MESSAGE:
730 if (this.getEnableStatistics()) {
731 this._statistics.addMessage(commandName, messageType);
732 }
733 // Process the call
734 await this.handleRequest(messageId, commandName, commandPayload);
735 break;
736 // Outcome Message
737 case MessageType.CALL_RESULT_MESSAGE:
738 // Respond
739 if (Utils.isIterable(this._requests[messageId])) {
740 [responseCallback, , requestPayload] = this._requests[messageId];
741 } else {
742 throw new Error(`Response request for message id ${messageId} is not iterable`);
743 }
744 if (!responseCallback) {
745 // Error
746 throw new Error(`Response request for unknown message id ${messageId}`);
747 }
748 delete this._requests[messageId];
749 responseCallback(commandName, requestPayload);
750 break;
751 // Error Message
752 case MessageType.CALL_ERROR_MESSAGE:
753 if (!this._requests[messageId]) {
754 // Error
755 throw new Error(`Error request for unknown message id ${messageId}`);
756 }
757 if (Utils.isIterable(this._requests[messageId])) {
758 [, rejectCallback] = this._requests[messageId];
759 } else {
760 throw new Error(`Error request for message id ${messageId} is not iterable`);
761 }
762 delete this._requests[messageId];
763 rejectCallback(new OCPPError(commandName, commandPayload, errorDetails));
764 break;
765 // Error
766 default:
767 errMsg = `${this._logPrefix()} Wrong message type ${messageType}`;
768 logger.error(errMsg);
769 throw new Error(errMsg);
770 }
771 } catch (error) {
772 // Log
773 logger.error('%s Incoming message %j processing error %j on request content type %j', this._logPrefix(), messageEvent, error, this._requests[messageId]);
774 // Send error
775 messageType !== MessageType.CALL_ERROR_MESSAGE && await this.sendError(messageId, error, commandName);
776 }
777 }
778
779 async sendHeartbeat(): Promise<void> {
780 try {
781 const payload: HeartbeatRequest = {};
782 await this.sendMessage(Utils.generateUUID(), payload, MessageType.CALL_MESSAGE, RequestCommand.HEARTBEAT);
783 } catch (error) {
784 this.handleRequestError(RequestCommand.HEARTBEAT, error);
785 }
786 }
787
788 async sendBootNotification(): Promise<BootNotificationResponse> {
789 try {
790 return await this.sendMessage(Utils.generateUUID(), this._bootNotificationRequest, MessageType.CALL_MESSAGE, RequestCommand.BOOT_NOTIFICATION) as BootNotificationResponse;
791 } catch (error) {
792 this.handleRequestError(RequestCommand.BOOT_NOTIFICATION, error);
793 }
794 }
795
796 async sendStatusNotification(connectorId: number, status: ChargePointStatus, errorCode: ChargePointErrorCode = ChargePointErrorCode.NO_ERROR): Promise<void> {
797 this.getConnector(connectorId).status = status;
798 try {
799 const payload: StatusNotificationRequest = {
800 connectorId,
801 errorCode,
802 status,
803 };
804 await this.sendMessage(Utils.generateUUID(), payload, MessageType.CALL_MESSAGE, RequestCommand.STATUS_NOTIFICATION);
805 } catch (error) {
806 this.handleRequestError(RequestCommand.STATUS_NOTIFICATION, error);
807 }
808 }
809
810 async sendStartTransaction(connectorId: number, idTag?: string): Promise<StartTransactionResponse> {
811 try {
812 const payload: StartTransactionRequest = {
813 connectorId,
814 ...!Utils.isUndefined(idTag) ? { idTag } : { idTag: Constants.TRANSACTION_DEFAULT_IDTAG },
815 meterStart: 0,
816 timestamp: new Date().toISOString(),
817 };
818 return await this.sendMessage(Utils.generateUUID(), payload, MessageType.CALL_MESSAGE, RequestCommand.START_TRANSACTION) as StartTransactionResponse;
819 } catch (error) {
820 this.handleRequestError(RequestCommand.START_TRANSACTION, error);
821 }
822 }
823
824 async sendStopTransaction(transactionId: number, reason: StopTransactionReason = StopTransactionReason.NONE): Promise<StopTransactionResponse> {
825 const idTag = this._getTransactionIdTag(transactionId);
826 try {
827 const payload: StopTransactionRequest = {
828 transactionId,
829 ...!Utils.isUndefined(idTag) && { idTag: idTag },
830 meterStop: this._getTransactionMeterStop(transactionId),
831 timestamp: new Date().toISOString(),
832 ...reason && { reason },
833 };
834 return await this.sendMessage(Utils.generateUUID(), payload, MessageType.CALL_MESSAGE, RequestCommand.STOP_TRANSACTION) as StartTransactionResponse;
835 } catch (error) {
836 this.handleRequestError(RequestCommand.STOP_TRANSACTION, error);
837 }
838 }
839
840 async sendError(messageId: string, err: Error | OCPPError, commandName: RequestCommand | IncomingRequestCommand): Promise<unknown> {
841 // Check exception type: only OCPP error are accepted
842 const error = err instanceof OCPPError ? err : new OCPPError(ErrorType.INTERNAL_ERROR, err.message, err.stack && err.stack);
843 // Send error
844 return this.sendMessage(messageId, error, MessageType.CALL_ERROR_MESSAGE, commandName);
845 }
846
847 async sendMessage(messageId: string, commandParams, messageType: MessageType = MessageType.CALL_RESULT_MESSAGE, commandName: RequestCommand | IncomingRequestCommand): Promise<any> {
848 // eslint-disable-next-line @typescript-eslint/no-this-alias
849 const self = this;
850 // Send a message through wsConnection
851 return new Promise((resolve: (value?: any | PromiseLike<any>) => void, reject: (reason?: any) => void) => {
852 let messageToSend: string;
853 // Type of message
854 switch (messageType) {
855 // Request
856 case MessageType.CALL_MESSAGE:
857 // Build request
858 this._requests[messageId] = [responseCallback, rejectCallback, commandParams] as Request;
859 messageToSend = JSON.stringify([messageType, messageId, commandName, commandParams]);
860 break;
861 // Response
862 case MessageType.CALL_RESULT_MESSAGE:
863 // Build response
864 messageToSend = JSON.stringify([messageType, messageId, commandParams]);
865 break;
866 // Error Message
867 case MessageType.CALL_ERROR_MESSAGE:
868 // Build Error Message
869 messageToSend = JSON.stringify([messageType, messageId, commandParams.code ? commandParams.code : ErrorType.GENERIC_ERROR, commandParams.message ? commandParams.message : '', commandParams.details ? commandParams.details : {}]);
870 break;
871 }
872 // Check if wsConnection opened and charging station registered
873 if (this._isWebSocketOpen() && (this._isRegistered() || commandName === RequestCommand.BOOT_NOTIFICATION)) {
874 if (this.getEnableStatistics()) {
875 this._statistics.addMessage(commandName, messageType);
876 }
877 // Yes: Send Message
878 this._wsConnection.send(messageToSend);
879 } else {
880 let dups = false;
881 // Handle dups in buffer
882 for (const message of this._messageQueue) {
883 // Same message
884 if (messageToSend === message) {
885 dups = true;
886 break;
887 }
888 }
889 if (!dups) {
890 // Buffer message
891 this._messageQueue.push(messageToSend);
892 }
893 // Reject it
894 return rejectCallback(new OCPPError(commandParams.code ? commandParams.code : ErrorType.GENERIC_ERROR, commandParams.message ? commandParams.message : `WebSocket closed for message id '${messageId}' with content '${messageToSend}', message buffered`, commandParams.details ? commandParams.details : {}));
895 }
896 // Response?
897 if (messageType === MessageType.CALL_RESULT_MESSAGE) {
898 // Yes: send Ok
899 resolve();
900 } else if (messageType === MessageType.CALL_ERROR_MESSAGE) {
901 // Send timeout
902 setTimeout(() => rejectCallback(new OCPPError(commandParams.code ? commandParams.code : ErrorType.GENERIC_ERROR, commandParams.message ? commandParams.message : `Timeout for message id '${messageId}' with content '${messageToSend}'`, commandParams.details ? commandParams.details : {})), Constants.OCPP_ERROR_TIMEOUT);
903 }
904
905 // Function that will receive the request's response
906 async function responseCallback(payload, requestPayload): Promise<void> {
907 if (self.getEnableStatistics()) {
908 self._statistics.addMessage(commandName, messageType);
909 }
910 // Send the response
911 await self.handleResponse(commandName as RequestCommand, payload, requestPayload);
912 resolve(payload);
913 }
914
915 // Function that will receive the request's rejection
916 function rejectCallback(error: OCPPError): void {
917 if (self.getEnableStatistics()) {
918 self._statistics.addMessage(commandName, messageType);
919 }
920 logger.debug(`${self._logPrefix()} Error: %j occurred when calling command %s with parameters: %j`, error, commandName, commandParams);
921 // Build Exception
922 // eslint-disable-next-line no-empty-function
923 self._requests[messageId] = [() => { }, () => { }, {}]; // Properly format the request
924 // Send error
925 reject(error);
926 }
927 });
928 }
929
930 async handleResponse(commandName: RequestCommand, payload, requestPayload): Promise<void> {
931 const responseCallbackFn = 'handleResponse' + commandName;
932 if (typeof this[responseCallbackFn] === 'function') {
933 await this[responseCallbackFn](payload, requestPayload);
934 } else {
935 logger.error(this._logPrefix() + ' Trying to call an undefined response callback function: ' + responseCallbackFn);
936 }
937 }
938
939 handleResponseBootNotification(payload: BootNotificationResponse, requestPayload: BootNotificationRequest): void {
940 if (payload.status === RegistrationStatus.ACCEPTED) {
941 this._heartbeatSetInterval ? this._restartHeartbeat() : this._startHeartbeat();
942 this._addConfigurationKey(StandardParametersKey.HeartBeatInterval, payload.interval.toString());
943 this._addConfigurationKey(StandardParametersKey.HeartbeatInterval, payload.interval.toString(), false, false);
944 this._hasStopped && (this._hasStopped = false);
945 } else if (payload.status === RegistrationStatus.PENDING) {
946 logger.info(this._logPrefix() + ' Charging station in pending state on the central server');
947 } else {
948 logger.info(this._logPrefix() + ' Charging station rejected by the central server');
949 }
950 }
951
952 _initTransactionOnConnector(connectorId: number): void {
953 this.getConnector(connectorId).transactionStarted = false;
954 this.getConnector(connectorId).transactionId = null;
955 this.getConnector(connectorId).idTag = null;
956 this.getConnector(connectorId).lastEnergyActiveImportRegisterValue = -1;
957 }
958
959 _resetTransactionOnConnector(connectorId: number): void {
960 this._initTransactionOnConnector(connectorId);
961 if (this.getConnector(connectorId)?.transactionSetInterval) {
962 clearInterval(this.getConnector(connectorId).transactionSetInterval);
963 }
964 }
965
966 async handleResponseStartTransaction(payload: StartTransactionResponse, requestPayload: StartTransactionRequest): Promise<void> {
967 const connectorId = requestPayload.connectorId;
968
969 let transactionConnectorId: number;
970 for (const connector in this._connectors) {
971 if (Utils.convertToInt(connector) > 0 && Utils.convertToInt(connector) === connectorId) {
972 transactionConnectorId = Utils.convertToInt(connector);
973 break;
974 }
975 }
976 if (!transactionConnectorId) {
977 logger.error(this._logPrefix() + ' Trying to start a transaction on a non existing connector Id ' + connectorId.toString());
978 return;
979 }
980 if (this.getConnector(connectorId)?.transactionStarted) {
981 logger.debug(this._logPrefix() + ' Trying to start a transaction on an already used connector ' + connectorId.toString() + ': %j', this.getConnector(connectorId));
982 return;
983 }
984
985 if (payload.idTagInfo.status === AuthorizationStatus.ACCEPTED) {
986 this.getConnector(connectorId).transactionStarted = true;
987 this.getConnector(connectorId).transactionId = payload.transactionId;
988 this.getConnector(connectorId).idTag = requestPayload.idTag;
989 this.getConnector(connectorId).lastEnergyActiveImportRegisterValue = 0;
990 await this.sendStatusNotification(connectorId, ChargePointStatus.CHARGING);
991 logger.info(this._logPrefix() + ' Transaction ' + payload.transactionId.toString() + ' STARTED on ' + this._stationInfo.name + '#' + connectorId.toString() + ' for idTag ' + requestPayload.idTag);
992 if (this._stationInfo.powerSharedByConnectors) {
993 this._stationInfo.powerDivider++;
994 }
995 const configuredMeterValueSampleInterval = this._getConfigurationKey(StandardParametersKey.MeterValueSampleInterval);
996 this._startMeterValues(connectorId,
997 configuredMeterValueSampleInterval ? Utils.convertToInt(configuredMeterValueSampleInterval.value) * 1000 : 60000);
998 } else {
999 logger.error(this._logPrefix() + ' Starting transaction id ' + payload.transactionId.toString() + ' REJECTED with status ' + payload.idTagInfo.status + ', idTag ' + requestPayload.idTag);
1000 this._resetTransactionOnConnector(connectorId);
1001 await this.sendStatusNotification(connectorId, ChargePointStatus.AVAILABLE);
1002 }
1003 }
1004
1005 async handleResponseStopTransaction(payload: StopTransactionResponse, requestPayload: StopTransactionRequest): Promise<void> {
1006 let transactionConnectorId: number;
1007 for (const connector in this._connectors) {
1008 if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector))?.transactionId === requestPayload.transactionId) {
1009 transactionConnectorId = Utils.convertToInt(connector);
1010 break;
1011 }
1012 }
1013 if (!transactionConnectorId) {
1014 logger.error(this._logPrefix() + ' Trying to stop a non existing transaction ' + requestPayload.transactionId.toString());
1015 return;
1016 }
1017 if (payload.idTagInfo?.status === AuthorizationStatus.ACCEPTED) {
1018 await this.sendStatusNotification(transactionConnectorId, ChargePointStatus.AVAILABLE);
1019 if (this._stationInfo.powerSharedByConnectors) {
1020 this._stationInfo.powerDivider--;
1021 }
1022 logger.info(this._logPrefix() + ' Transaction ' + requestPayload.transactionId.toString() + ' STOPPED on ' + this._stationInfo.name + '#' + transactionConnectorId.toString());
1023 this._resetTransactionOnConnector(transactionConnectorId);
1024 } else {
1025 logger.error(this._logPrefix() + ' Stopping transaction id ' + requestPayload.transactionId.toString() + ' REJECTED with status ' + payload.idTagInfo?.status);
1026 }
1027 }
1028
1029 handleResponseStatusNotification(payload: StatusNotificationRequest, requestPayload: StatusNotificationResponse): void {
1030 logger.debug(this._logPrefix() + ' Status notification response received: %j to StatusNotification request: %j', payload, requestPayload);
1031 }
1032
1033 handleResponseMeterValues(payload: MeterValuesRequest, requestPayload: MeterValuesResponse): void {
1034 logger.debug(this._logPrefix() + ' MeterValues response received: %j to MeterValues request: %j', payload, requestPayload);
1035 }
1036
1037 handleResponseHeartbeat(payload: HeartbeatResponse, requestPayload: HeartbeatRequest): void {
1038 logger.debug(this._logPrefix() + ' Heartbeat response received: %j to Heartbeat request: %j', payload, requestPayload);
1039 }
1040
1041 async handleRequest(messageId: string, commandName: IncomingRequestCommand, commandPayload): Promise<void> {
1042 let response;
1043 // Call
1044 if (typeof this['handleRequest' + commandName] === 'function') {
1045 try {
1046 // Call the method to build the response
1047 response = await this['handleRequest' + commandName](commandPayload);
1048 } catch (error) {
1049 // Log
1050 logger.error(this._logPrefix() + ' Handle request error: %j', error);
1051 // Send back response to inform backend
1052 await this.sendError(messageId, error, commandName);
1053 throw error;
1054 }
1055 } else {
1056 // Throw exception
1057 await this.sendError(messageId, new OCPPError(ErrorType.NOT_IMPLEMENTED, `${commandName} is not implemented`, {}), commandName);
1058 throw new Error(`${commandName} is not implemented ${JSON.stringify(commandPayload, null, ' ')}`);
1059 }
1060 // Send response
1061 await this.sendMessage(messageId, response, MessageType.CALL_RESULT_MESSAGE, commandName);
1062 }
1063
1064 // Simulate charging station restart
1065 handleRequestReset(commandPayload: ResetRequest): DefaultResponse {
1066 setImmediate(async () => {
1067 await this.stop(commandPayload.type + 'Reset' as StopTransactionReason);
1068 await Utils.sleep(this._stationInfo.resetTime);
1069 await this.start();
1070 });
1071 logger.info(`${this._logPrefix()} ${commandPayload.type} reset command received, simulating it. The station will be back online in ${Utils.milliSecondsToHHMMSS(this._stationInfo.resetTime)}`);
1072 return Constants.OCPP_RESPONSE_ACCEPTED;
1073 }
1074
1075 handleRequestClearCache(): DefaultResponse {
1076 return Constants.OCPP_RESPONSE_ACCEPTED;
1077 }
1078
1079 async handleRequestUnlockConnector(commandPayload: UnlockConnectorRequest): Promise<UnlockConnectorResponse> {
1080 const connectorId = commandPayload.connectorId;
1081 if (connectorId === 0) {
1082 logger.error(this._logPrefix() + ' Trying to unlock connector ' + connectorId.toString());
1083 return Constants.OCPP_RESPONSE_UNLOCK_NOT_SUPPORTED;
1084 }
1085 if (this.getConnector(connectorId)?.transactionStarted) {
1086 const stopResponse = await this.sendStopTransaction(this.getConnector(connectorId).transactionId, StopTransactionReason.UNLOCK_COMMAND);
1087 if (stopResponse.idTagInfo?.status === AuthorizationStatus.ACCEPTED) {
1088 return Constants.OCPP_RESPONSE_UNLOCKED;
1089 }
1090 return Constants.OCPP_RESPONSE_UNLOCK_FAILED;
1091 }
1092 await this.sendStatusNotification(connectorId, ChargePointStatus.AVAILABLE);
1093 return Constants.OCPP_RESPONSE_UNLOCKED;
1094 }
1095
1096 _getConfigurationKey(key: string | StandardParametersKey, caseInsensitive = false): ConfigurationKey {
1097 const configurationKey: ConfigurationKey = this._configuration.configurationKey.find((configElement) => {
1098 if (caseInsensitive) {
1099 return configElement.key.toLowerCase() === key.toLowerCase();
1100 }
1101 return configElement.key === key;
1102 });
1103 return configurationKey;
1104 }
1105
1106 _addConfigurationKey(key: string | StandardParametersKey, value: string, readonly = false, visible = true, reboot = false): void {
1107 const keyFound = this._getConfigurationKey(key);
1108 if (!keyFound) {
1109 this._configuration.configurationKey.push({
1110 key,
1111 readonly,
1112 value,
1113 visible,
1114 reboot,
1115 });
1116 } else {
1117 logger.error(`${this._logPrefix()} Trying to add an already existing configuration key: %j`, keyFound);
1118 }
1119 }
1120
1121 _setConfigurationKeyValue(key: string | StandardParametersKey, value: string): void {
1122 const keyFound = this._getConfigurationKey(key);
1123 if (keyFound) {
1124 const keyIndex = this._configuration.configurationKey.indexOf(keyFound);
1125 this._configuration.configurationKey[keyIndex].value = value;
1126 } else {
1127 logger.error(`${this._logPrefix()} Trying to set a value on a non existing configuration key: %j`, { key, value });
1128 }
1129 }
1130
1131 handleRequestGetConfiguration(commandPayload: GetConfigurationRequest): GetConfigurationResponse {
1132 const configurationKey: OCPPConfigurationKey[] = [];
1133 const unknownKey: string[] = [];
1134 if (Utils.isEmptyArray(commandPayload.key)) {
1135 for (const configuration of this._configuration.configurationKey) {
1136 if (Utils.isUndefined(configuration.visible)) {
1137 configuration.visible = true;
1138 }
1139 if (!configuration.visible) {
1140 continue;
1141 }
1142 configurationKey.push({
1143 key: configuration.key,
1144 readonly: configuration.readonly,
1145 value: configuration.value,
1146 });
1147 }
1148 } else {
1149 for (const key of commandPayload.key) {
1150 const keyFound = this._getConfigurationKey(key);
1151 if (keyFound) {
1152 if (Utils.isUndefined(keyFound.visible)) {
1153 keyFound.visible = true;
1154 }
1155 if (!keyFound.visible) {
1156 continue;
1157 }
1158 configurationKey.push({
1159 key: keyFound.key,
1160 readonly: keyFound.readonly,
1161 value: keyFound.value,
1162 });
1163 } else {
1164 unknownKey.push(key);
1165 }
1166 }
1167 }
1168 return {
1169 configurationKey,
1170 unknownKey,
1171 };
1172 }
1173
1174 handleRequestChangeConfiguration(commandPayload: ChangeConfigurationRequest): ChangeConfigurationResponse {
1175 // JSON request fields type sanity check
1176 if (!Utils.isString(commandPayload.key)) {
1177 logger.error(`${this._logPrefix()} ChangeConfiguration request key field is not a string:`, commandPayload);
1178 }
1179 if (!Utils.isString(commandPayload.value)) {
1180 logger.error(`${this._logPrefix()} ChangeConfiguration request value field is not a string:`, commandPayload);
1181 }
1182 const keyToChange = this._getConfigurationKey(commandPayload.key, true);
1183 if (!keyToChange) {
1184 return Constants.OCPP_CONFIGURATION_RESPONSE_NOT_SUPPORTED;
1185 } else if (keyToChange && keyToChange.readonly) {
1186 return Constants.OCPP_CONFIGURATION_RESPONSE_REJECTED;
1187 } else if (keyToChange && !keyToChange.readonly) {
1188 const keyIndex = this._configuration.configurationKey.indexOf(keyToChange);
1189 let valueChanged = false;
1190 if (this._configuration.configurationKey[keyIndex].value !== commandPayload.value) {
1191 this._configuration.configurationKey[keyIndex].value = commandPayload.value;
1192 valueChanged = true;
1193 }
1194 let triggerHeartbeatRestart = false;
1195 if (keyToChange.key === StandardParametersKey.HeartBeatInterval && valueChanged) {
1196 this._setConfigurationKeyValue(StandardParametersKey.HeartbeatInterval, commandPayload.value);
1197 triggerHeartbeatRestart = true;
1198 }
1199 if (keyToChange.key === StandardParametersKey.HeartbeatInterval && valueChanged) {
1200 this._setConfigurationKeyValue(StandardParametersKey.HeartBeatInterval, commandPayload.value);
1201 triggerHeartbeatRestart = true;
1202 }
1203 if (triggerHeartbeatRestart) {
1204 this._restartHeartbeat();
1205 }
1206 if (keyToChange.key === StandardParametersKey.WebSocketPingInterval && valueChanged) {
1207 this._restartWebSocketPing();
1208 }
1209 if (keyToChange.reboot) {
1210 return Constants.OCPP_CONFIGURATION_RESPONSE_REBOOT_REQUIRED;
1211 }
1212 return Constants.OCPP_CONFIGURATION_RESPONSE_ACCEPTED;
1213 }
1214 }
1215
1216 handleRequestSetChargingProfile(commandPayload: SetChargingProfileRequest): SetChargingProfileResponse {
1217 if (!this.getConnector(commandPayload.connectorId)) {
1218 logger.error(`${this._logPrefix()} Trying to set a charging profile to a non existing connector Id ${commandPayload.connectorId}`);
1219 return Constants.OCPP_CHARGING_PROFILE_RESPONSE_REJECTED;
1220 }
1221 if (commandPayload.csChargingProfiles.chargingProfilePurpose === ChargingProfilePurposeType.TX_PROFILE && !this.getConnector(commandPayload.connectorId)?.transactionStarted) {
1222 return Constants.OCPP_CHARGING_PROFILE_RESPONSE_REJECTED;
1223 }
1224 this.getConnector(commandPayload.connectorId).chargingProfiles.forEach((chargingProfile: ChargingProfile, index: number) => {
1225 if (chargingProfile.chargingProfileId === commandPayload.csChargingProfiles.chargingProfileId
1226 || (chargingProfile.stackLevel === commandPayload.csChargingProfiles.stackLevel && chargingProfile.chargingProfilePurpose === commandPayload.csChargingProfiles.chargingProfilePurpose)) {
1227 this.getConnector(commandPayload.connectorId).chargingProfiles[index] = chargingProfile;
1228 return Constants.OCPP_CHARGING_PROFILE_RESPONSE_ACCEPTED;
1229 }
1230 });
1231 this.getConnector(commandPayload.connectorId).chargingProfiles.push(commandPayload.csChargingProfiles);
1232 return Constants.OCPP_CHARGING_PROFILE_RESPONSE_ACCEPTED;
1233 }
1234
1235 // FIXME: Handle properly the transaction started case
1236 handleRequestChangeAvailability(commandPayload: ChangeAvailabilityRequest): ChangeAvailabilityResponse {
1237 const connectorId: number = commandPayload.connectorId;
1238 if (!this.getConnector(connectorId)) {
1239 logger.error(`${this._logPrefix()} Trying to change the availability of a non existing connector Id ${connectorId.toString()}`);
1240 return Constants.OCPP_AVAILABILITY_RESPONSE_REJECTED;
1241 }
1242 const chargePointStatus: ChargePointStatus = commandPayload.type === AvailabilityType.OPERATIVE ? ChargePointStatus.AVAILABLE : ChargePointStatus.UNAVAILABLE;
1243 if (connectorId === 0) {
1244 let response: ChangeAvailabilityResponse = Constants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED;
1245 for (const connector in this._connectors) {
1246 if (this.getConnector(Utils.convertToInt(connector)).transactionStarted) {
1247 response = Constants.OCPP_AVAILABILITY_RESPONSE_SCHEDULED;
1248 }
1249 this.getConnector(Utils.convertToInt(connector)).availability = commandPayload.type;
1250 void this.sendStatusNotification(Utils.convertToInt(connector), chargePointStatus);
1251 }
1252 return response;
1253 } else if (connectorId > 0 && (this.getConnector(0).availability === AvailabilityType.OPERATIVE || (this.getConnector(0).availability === AvailabilityType.INOPERATIVE && commandPayload.type === AvailabilityType.INOPERATIVE))) {
1254 if (this.getConnector(connectorId)?.transactionStarted) {
1255 this.getConnector(connectorId).availability = commandPayload.type;
1256 void this.sendStatusNotification(connectorId, chargePointStatus);
1257 return Constants.OCPP_AVAILABILITY_RESPONSE_SCHEDULED;
1258 }
1259 this.getConnector(connectorId).availability = commandPayload.type;
1260 void this.sendStatusNotification(connectorId, chargePointStatus);
1261 return Constants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED;
1262 }
1263 return Constants.OCPP_AVAILABILITY_RESPONSE_REJECTED;
1264 }
1265
1266 async handleRequestRemoteStartTransaction(commandPayload: RemoteStartTransactionRequest): Promise<DefaultResponse> {
1267 const transactionConnectorID: number = commandPayload.connectorId ? commandPayload.connectorId : 1;
1268 if (this._getAuthorizeRemoteTxRequests() && this._getLocalAuthListEnabled() && this.hasAuthorizedTags()) {
1269 // Check if authorized
1270 if (this._authorizedTags.find((value) => value === commandPayload.idTag)) {
1271 await this.sendStatusNotification(transactionConnectorID, ChargePointStatus.PREPARING);
1272 // Authorization successful start transaction
1273 await this.sendStartTransaction(transactionConnectorID, commandPayload.idTag);
1274 logger.debug(this._logPrefix() + ' Transaction remotely STARTED on ' + this._stationInfo.name + '#' + transactionConnectorID.toString() + ' for idTag ' + commandPayload.idTag);
1275 return Constants.OCPP_RESPONSE_ACCEPTED;
1276 }
1277 logger.error(this._logPrefix() + ' Remote starting transaction REJECTED, idTag ' + commandPayload.idTag);
1278 return Constants.OCPP_RESPONSE_REJECTED;
1279 }
1280 await this.sendStatusNotification(transactionConnectorID, ChargePointStatus.PREPARING);
1281 // No local authorization check required => start transaction
1282 await this.sendStartTransaction(transactionConnectorID, commandPayload.idTag);
1283 logger.debug(this._logPrefix() + ' Transaction remotely STARTED on ' + this._stationInfo.name + '#' + transactionConnectorID.toString() + ' for idTag ' + commandPayload.idTag);
1284 return Constants.OCPP_RESPONSE_ACCEPTED;
1285 }
1286
1287 async handleRequestRemoteStopTransaction(commandPayload: RemoteStopTransactionRequest): Promise<DefaultResponse> {
1288 const transactionId = commandPayload.transactionId;
1289 for (const connector in this._connectors) {
1290 if (Utils.convertToInt(connector) > 0 && this.getConnector(Utils.convertToInt(connector))?.transactionId === transactionId) {
1291 await this.sendStatusNotification(Utils.convertToInt(connector), ChargePointStatus.FINISHING);
1292 await this.sendStopTransaction(transactionId);
1293 return Constants.OCPP_RESPONSE_ACCEPTED;
1294 }
1295 }
1296 logger.info(this._logPrefix() + ' Trying to remote stop a non existing transaction ' + transactionId.toString());
1297 return Constants.OCPP_RESPONSE_REJECTED;
1298 }
1299
1300 // eslint-disable-next-line consistent-this
1301 private async sendMeterValues(connectorId: number, interval: number, self: ChargingStation, debug = false): Promise<void> {
1302 try {
1303 const meterValue: MeterValue = {
1304 timestamp: new Date().toISOString(),
1305 sampledValue: [],
1306 };
1307 const meterValuesTemplate: SampledValue[] = self.getConnector(connectorId).MeterValues;
1308 for (let index = 0; index < meterValuesTemplate.length; index++) {
1309 const connector = self.getConnector(connectorId);
1310 // SoC measurand
1311 if (meterValuesTemplate[index].measurand && meterValuesTemplate[index].measurand === MeterValueMeasurand.STATE_OF_CHARGE && self._getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes(MeterValueMeasurand.STATE_OF_CHARGE)) {
1312 meterValue.sampledValue.push({
1313 ...!Utils.isUndefined(meterValuesTemplate[index].unit) ? { unit: meterValuesTemplate[index].unit } : { unit: MeterValueUnit.PERCENT },
1314 ...!Utils.isUndefined(meterValuesTemplate[index].context) && { context: meterValuesTemplate[index].context },
1315 measurand: meterValuesTemplate[index].measurand,
1316 ...!Utils.isUndefined(meterValuesTemplate[index].location) ? { location: meterValuesTemplate[index].location } : { location: MeterValueLocation.EV },
1317 ...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } : { value: Utils.getRandomInt(100).toString() },
1318 });
1319 const sampledValuesIndex = meterValue.sampledValue.length - 1;
1320 if (Utils.convertToInt(meterValue.sampledValue[sampledValuesIndex].value) > 100 || debug) {
1321 logger.error(`${self._logPrefix()} MeterValues measurand ${meterValue.sampledValue[sampledValuesIndex].measurand ? meterValue.sampledValue[sampledValuesIndex].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: connectorId ${connectorId}, transaction ${connector.transactionId}, value: ${meterValue.sampledValue[sampledValuesIndex].value}/100`);
1322 }
1323 // Voltage measurand
1324 } else if (meterValuesTemplate[index].measurand && meterValuesTemplate[index].measurand === MeterValueMeasurand.VOLTAGE && self._getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes(MeterValueMeasurand.VOLTAGE)) {
1325 const voltageMeasurandValue = Utils.getRandomFloatRounded(self._getVoltageOut() + self._getVoltageOut() * 0.1, self._getVoltageOut() - self._getVoltageOut() * 0.1);
1326 meterValue.sampledValue.push({
1327 ...!Utils.isUndefined(meterValuesTemplate[index].unit) ? { unit: meterValuesTemplate[index].unit } : { unit: MeterValueUnit.VOLT },
1328 ...!Utils.isUndefined(meterValuesTemplate[index].context) && { context: meterValuesTemplate[index].context },
1329 measurand: meterValuesTemplate[index].measurand,
1330 ...!Utils.isUndefined(meterValuesTemplate[index].location) && { location: meterValuesTemplate[index].location },
1331 ...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } : { value: voltageMeasurandValue.toString() },
1332 });
1333 for (let phase = 1; self._getNumberOfPhases() === 3 && phase <= self._getNumberOfPhases(); phase++) {
1334 let phaseValue: string;
1335 if (self._getVoltageOut() >= 0 && self._getVoltageOut() <= 250) {
1336 phaseValue = `L${phase}-N`;
1337 } else if (self._getVoltageOut() > 250) {
1338 phaseValue = `L${phase}-L${(phase + 1) % self._getNumberOfPhases() !== 0 ? (phase + 1) % self._getNumberOfPhases() : self._getNumberOfPhases()}`;
1339 }
1340 meterValue.sampledValue.push({
1341 ...!Utils.isUndefined(meterValuesTemplate[index].unit) ? { unit: meterValuesTemplate[index].unit } : { unit: MeterValueUnit.VOLT },
1342 ...!Utils.isUndefined(meterValuesTemplate[index].context) && { context: meterValuesTemplate[index].context },
1343 measurand: meterValuesTemplate[index].measurand,
1344 ...!Utils.isUndefined(meterValuesTemplate[index].location) && { location: meterValuesTemplate[index].location },
1345 ...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } : { value: voltageMeasurandValue.toString() },
1346 phase: phaseValue as MeterValuePhase,
1347 });
1348 }
1349 // Power.Active.Import measurand
1350 } else if (meterValuesTemplate[index].measurand && meterValuesTemplate[index].measurand === MeterValueMeasurand.POWER_ACTIVE_IMPORT && self._getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes(MeterValueMeasurand.POWER_ACTIVE_IMPORT)) {
1351 // FIXME: factor out powerDivider checks
1352 if (Utils.isUndefined(self._stationInfo.powerDivider)) {
1353 const errMsg = `${self._logPrefix()} MeterValues measurand ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: powerDivider is undefined`;
1354 logger.error(errMsg);
1355 throw Error(errMsg);
1356 } else if (self._stationInfo.powerDivider && self._stationInfo.powerDivider <= 0) {
1357 const errMsg = `${self._logPrefix()} MeterValues measurand ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: powerDivider have zero or below value ${self._stationInfo.powerDivider}`;
1358 logger.error(errMsg);
1359 throw Error(errMsg);
1360 }
1361 const errMsg = `${self._logPrefix()} MeterValues measurand ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: Unknown ${self._getPowerOutType()} powerOutType in template file ${self._stationTemplateFile}, cannot calculate ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER} measurand value`;
1362 const powerMeasurandValues = {} as MeasurandValues;
1363 const maxPower = Math.round(self._stationInfo.maxPower / self._stationInfo.powerDivider);
1364 const maxPowerPerPhase = Math.round((self._stationInfo.maxPower / self._stationInfo.powerDivider) / self._getNumberOfPhases());
1365 switch (self._getPowerOutType()) {
1366 case PowerOutType.AC:
1367 if (Utils.isUndefined(meterValuesTemplate[index].value)) {
1368 powerMeasurandValues.L1 = Utils.getRandomFloatRounded(maxPowerPerPhase);
1369 powerMeasurandValues.L2 = 0;
1370 powerMeasurandValues.L3 = 0;
1371 if (self._getNumberOfPhases() === 3) {
1372 powerMeasurandValues.L2 = Utils.getRandomFloatRounded(maxPowerPerPhase);
1373 powerMeasurandValues.L3 = Utils.getRandomFloatRounded(maxPowerPerPhase);
1374 }
1375 powerMeasurandValues.allPhases = Utils.roundTo(powerMeasurandValues.L1 + powerMeasurandValues.L2 + powerMeasurandValues.L3, 2);
1376 }
1377 break;
1378 case PowerOutType.DC:
1379 if (Utils.isUndefined(meterValuesTemplate[index].value)) {
1380 powerMeasurandValues.allPhases = Utils.getRandomFloatRounded(maxPower);
1381 }
1382 break;
1383 default:
1384 logger.error(errMsg);
1385 throw Error(errMsg);
1386 }
1387 meterValue.sampledValue.push({
1388 ...!Utils.isUndefined(meterValuesTemplate[index].unit) ? { unit: meterValuesTemplate[index].unit } : { unit: MeterValueUnit.WATT },
1389 ...!Utils.isUndefined(meterValuesTemplate[index].context) && { context: meterValuesTemplate[index].context },
1390 measurand: meterValuesTemplate[index].measurand,
1391 ...!Utils.isUndefined(meterValuesTemplate[index].location) && { location: meterValuesTemplate[index].location },
1392 ...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } : { value: powerMeasurandValues.allPhases.toString() },
1393 });
1394 const sampledValuesIndex = meterValue.sampledValue.length - 1;
1395 if (Utils.convertToFloat(meterValue.sampledValue[sampledValuesIndex].value) > maxPower || debug) {
1396 logger.error(`${self._logPrefix()} MeterValues measurand ${meterValue.sampledValue[sampledValuesIndex].measurand ? meterValue.sampledValue[sampledValuesIndex].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: connectorId ${connectorId}, transaction ${connector.transactionId}, value: ${meterValue.sampledValue[sampledValuesIndex].value}/${maxPower}`);
1397 }
1398 for (let phase = 1; self._getNumberOfPhases() === 3 && phase <= self._getNumberOfPhases(); phase++) {
1399 const phaseValue = `L${phase}-N`;
1400 meterValue.sampledValue.push({
1401 ...!Utils.isUndefined(meterValuesTemplate[index].unit) ? { unit: meterValuesTemplate[index].unit } : { unit: MeterValueUnit.WATT },
1402 ...!Utils.isUndefined(meterValuesTemplate[index].context) && { context: meterValuesTemplate[index].context },
1403 ...!Utils.isUndefined(meterValuesTemplate[index].measurand) && { measurand: meterValuesTemplate[index].measurand },
1404 ...!Utils.isUndefined(meterValuesTemplate[index].location) && { location: meterValuesTemplate[index].location },
1405 ...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } : { value: powerMeasurandValues[`L${phase}`] as string },
1406 phase: phaseValue as MeterValuePhase,
1407 });
1408 }
1409 // Current.Import measurand
1410 } else if (meterValuesTemplate[index].measurand && meterValuesTemplate[index].measurand === MeterValueMeasurand.CURRENT_IMPORT && self._getConfigurationKey(StandardParametersKey.MeterValuesSampledData).value.includes(MeterValueMeasurand.CURRENT_IMPORT)) {
1411 // FIXME: factor out powerDivider checks
1412 if (Utils.isUndefined(self._stationInfo.powerDivider)) {
1413 const errMsg = `${self._logPrefix()} MeterValues measurand ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: powerDivider is undefined`;
1414 logger.error(errMsg);
1415 throw Error(errMsg);
1416 } else if (self._stationInfo.powerDivider && self._stationInfo.powerDivider <= 0) {
1417 const errMsg = `${self._logPrefix()} MeterValues measurand ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: powerDivider have zero or below value ${self._stationInfo.powerDivider}`;
1418 logger.error(errMsg);
1419 throw Error(errMsg);
1420 }
1421 const errMsg = `${self._logPrefix()} MeterValues measurand ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: Unknown ${self._getPowerOutType()} powerOutType in template file ${self._stationTemplateFile}, cannot calculate ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER} measurand value`;
1422 const currentMeasurandValues: MeasurandValues = {} as MeasurandValues;
1423 let maxAmperage: number;
1424 switch (self._getPowerOutType()) {
1425 case PowerOutType.AC:
1426 maxAmperage = ElectricUtils.ampPerPhaseFromPower(self._getNumberOfPhases(), self._stationInfo.maxPower / self._stationInfo.powerDivider, self._getVoltageOut());
1427 if (Utils.isUndefined(meterValuesTemplate[index].value)) {
1428 currentMeasurandValues.L1 = Utils.getRandomFloatRounded(maxAmperage);
1429 currentMeasurandValues.L2 = 0;
1430 currentMeasurandValues.L3 = 0;
1431 if (self._getNumberOfPhases() === 3) {
1432 currentMeasurandValues.L2 = Utils.getRandomFloatRounded(maxAmperage);
1433 currentMeasurandValues.L3 = Utils.getRandomFloatRounded(maxAmperage);
1434 }
1435 currentMeasurandValues.allPhases = Utils.roundTo((currentMeasurandValues.L1 + currentMeasurandValues.L2 + currentMeasurandValues.L3) / self._getNumberOfPhases(), 2);
1436 }
1437 break;
1438 case PowerOutType.DC:
1439 maxAmperage = ElectricUtils.ampTotalFromPower(self._stationInfo.maxPower / self._stationInfo.powerDivider, self._getVoltageOut());
1440 if (Utils.isUndefined(meterValuesTemplate[index].value)) {
1441 currentMeasurandValues.allPhases = Utils.getRandomFloatRounded(maxAmperage);
1442 }
1443 break;
1444 default:
1445 logger.error(errMsg);
1446 throw Error(errMsg);
1447 }
1448 meterValue.sampledValue.push({
1449 ...!Utils.isUndefined(meterValuesTemplate[index].unit) ? { unit: meterValuesTemplate[index].unit } : { unit: MeterValueUnit.AMP },
1450 ...!Utils.isUndefined(meterValuesTemplate[index].context) && { context: meterValuesTemplate[index].context },
1451 measurand: meterValuesTemplate[index].measurand,
1452 ...!Utils.isUndefined(meterValuesTemplate[index].location) && { location: meterValuesTemplate[index].location },
1453 ...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } : { value: currentMeasurandValues.allPhases.toString() },
1454 });
1455 const sampledValuesIndex = meterValue.sampledValue.length - 1;
1456 if (Utils.convertToFloat(meterValue.sampledValue[sampledValuesIndex].value) > maxAmperage || debug) {
1457 logger.error(`${self._logPrefix()} MeterValues measurand ${meterValue.sampledValue[sampledValuesIndex].measurand ? meterValue.sampledValue[sampledValuesIndex].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: connectorId ${connectorId}, transaction ${connector.transactionId}, value: ${meterValue.sampledValue[sampledValuesIndex].value}/${maxAmperage}`);
1458 }
1459 for (let phase = 1; self._getNumberOfPhases() === 3 && phase <= self._getNumberOfPhases(); phase++) {
1460 const phaseValue = `L${phase}`;
1461 meterValue.sampledValue.push({
1462 ...!Utils.isUndefined(meterValuesTemplate[index].unit) ? { unit: meterValuesTemplate[index].unit } : { unit: MeterValueUnit.AMP },
1463 ...!Utils.isUndefined(meterValuesTemplate[index].context) && { context: meterValuesTemplate[index].context },
1464 ...!Utils.isUndefined(meterValuesTemplate[index].measurand) && { measurand: meterValuesTemplate[index].measurand },
1465 ...!Utils.isUndefined(meterValuesTemplate[index].location) && { location: meterValuesTemplate[index].location },
1466 ...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } : { value: currentMeasurandValues[phaseValue] as string },
1467 phase: phaseValue as MeterValuePhase,
1468 });
1469 }
1470 // Energy.Active.Import.Register measurand (default)
1471 } else if (!meterValuesTemplate[index].measurand || meterValuesTemplate[index].measurand === MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER) {
1472 // FIXME: factor out powerDivider checks
1473 if (Utils.isUndefined(self._stationInfo.powerDivider)) {
1474 const errMsg = `${self._logPrefix()} MeterValues measurand ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: powerDivider is undefined`;
1475 logger.error(errMsg);
1476 throw Error(errMsg);
1477 } else if (self._stationInfo.powerDivider && self._stationInfo.powerDivider <= 0) {
1478 const errMsg = `${self._logPrefix()} MeterValues measurand ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: powerDivider have zero or below value ${self._stationInfo.powerDivider}`;
1479 logger.error(errMsg);
1480 throw Error(errMsg);
1481 }
1482 if (Utils.isUndefined(meterValuesTemplate[index].value)) {
1483 const measurandValue = Utils.getRandomInt(self._stationInfo.maxPower / (self._stationInfo.powerDivider * 3600000) * interval);
1484 // Persist previous value in connector
1485 if (connector && !Utils.isNullOrUndefined(connector.lastEnergyActiveImportRegisterValue) && connector.lastEnergyActiveImportRegisterValue >= 0) {
1486 connector.lastEnergyActiveImportRegisterValue += measurandValue;
1487 } else {
1488 connector.lastEnergyActiveImportRegisterValue = 0;
1489 }
1490 }
1491 meterValue.sampledValue.push({
1492 ...!Utils.isUndefined(meterValuesTemplate[index].unit) ? { unit: meterValuesTemplate[index].unit } : { unit: MeterValueUnit.WATT_HOUR },
1493 ...!Utils.isUndefined(meterValuesTemplate[index].context) && { context: meterValuesTemplate[index].context },
1494 ...!Utils.isUndefined(meterValuesTemplate[index].measurand) && { measurand: meterValuesTemplate[index].measurand },
1495 ...!Utils.isUndefined(meterValuesTemplate[index].location) && { location: meterValuesTemplate[index].location },
1496 ...!Utils.isUndefined(meterValuesTemplate[index].value) ? { value: meterValuesTemplate[index].value } :
1497 { value: connector.lastEnergyActiveImportRegisterValue.toString() },
1498 });
1499 const sampledValuesIndex = meterValue.sampledValue.length - 1;
1500 const maxConsumption = Math.round(self._stationInfo.maxPower * 3600 / (self._stationInfo.powerDivider * interval));
1501 if (Utils.convertToFloat(meterValue.sampledValue[sampledValuesIndex].value) > maxConsumption || debug) {
1502 logger.error(`${self._logPrefix()} MeterValues measurand ${meterValue.sampledValue[sampledValuesIndex].measurand ? meterValue.sampledValue[sampledValuesIndex].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: connectorId ${connectorId}, transaction ${connector.transactionId}, value: ${meterValue.sampledValue[sampledValuesIndex].value}/${maxConsumption}`);
1503 }
1504 // Unsupported measurand
1505 } else {
1506 logger.info(`${self._logPrefix()} Unsupported MeterValues measurand ${meterValuesTemplate[index].measurand ? meterValuesTemplate[index].measurand : MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER} on connectorId ${connectorId}`);
1507 }
1508 }
1509 const payload: MeterValuesRequest = {
1510 connectorId,
1511 transactionId: self.getConnector(connectorId).transactionId,
1512 meterValue: meterValue,
1513 };
1514 await self.sendMessage(Utils.generateUUID(), payload, MessageType.CALL_MESSAGE, RequestCommand.METERVALUES);
1515 } catch (error) {
1516 this.handleRequestError(RequestCommand.METERVALUES, error);
1517 }
1518 }
1519
1520 private handleRequestError(commandName: RequestCommand, error: Error) {
1521 logger.error(this._logPrefix() + ' Send ' + commandName + ' error: %j', error);
1522 throw error;
1523 }
1524 }
1525