Ensure configuration key have default settings values
[e-mobility-charging-stations-simulator.git] / src / charging-station / ChargingStation.ts
index 01829fdf47273797aefa980824db13282cd72862..90b788a68b83235e599c843139ef79406a610bb9 100644 (file)
@@ -8,7 +8,13 @@ import {
   IncomingRequestCommand,
   RequestCommand,
 } from '../types/ocpp/Requests';
-import { BootNotificationResponse, RegistrationStatus } from '../types/ocpp/Responses';
+import {
+  BootNotificationResponse,
+  HeartbeatResponse,
+  MeterValuesResponse,
+  RegistrationStatus,
+  StatusNotificationResponse,
+} from '../types/ocpp/Responses';
 import ChargingStationConfiguration, {
   ConfigurationKey,
 } from '../types/ChargingStationConfiguration';
@@ -24,6 +30,7 @@ import {
   VendorDefaultParametersKey,
 } from '../types/ocpp/Configuration';
 import { MeterValue, MeterValueMeasurand, MeterValuePhase } from '../types/ocpp/MeterValues';
+import { StopTransactionReason, StopTransactionResponse } from '../types/ocpp/Transaction';
 import { WSError, WebSocketCloseEventStatusCode } from '../types/WebSocket';
 import WebSocket, { ClientOptions, Data, OPEN, RawData } from 'ws';
 
@@ -52,7 +59,6 @@ import OCPPRequestService from './ocpp/OCPPRequestService';
 import { OCPPVersion } from '../types/ocpp/OCPPVersion';
 import PerformanceStatistics from '../performance/PerformanceStatistics';
 import { SampledValueTemplate } from '../types/MeasurandPerPhaseSampledValueTemplates';
-import { StopTransactionReason } from '../types/ocpp/Transaction';
 import { SupervisionUrlDistribution } from '../types/ConfigurationData';
 import { URL } from 'url';
 import Utils from '../utils/Utils';
@@ -63,7 +69,7 @@ import { parentPort } from 'worker_threads';
 import path from 'path';
 
 export default class ChargingStation {
-  public readonly id: string;
+  public hashId!: string;
   public readonly stationTemplateFile: string;
   public authorizedTags: string[];
   public stationInfo!: ChargingStationInfo;
@@ -74,10 +80,10 @@ export default class ChargingStation {
   public performanceStatistics!: PerformanceStatistics;
   public heartbeatSetInterval!: NodeJS.Timeout;
   public ocppRequestService!: OCPPRequestService;
+  public bootNotificationResponse!: BootNotificationResponse | null;
   private readonly index: number;
   private configurationFile!: string;
   private bootNotificationRequest!: BootNotificationRequest;
-  private bootNotificationResponse!: BootNotificationResponse | null;
   private connectorsConfigurationHash!: string;
   private ocppIncomingRequestService!: OCPPIncomingRequestService;
   private readonly messageBuffer: Set<string>;
@@ -89,7 +95,6 @@ export default class ChargingStation {
   private webSocketPingSetInterval!: NodeJS.Timeout;
 
   constructor(index: number, stationTemplateFile: string) {
-    this.id = Utils.generateUUID();
     this.index = index;
     this.stationTemplateFile = stationTemplateFile;
     this.stopped = false;
@@ -102,7 +107,7 @@ export default class ChargingStation {
     this.authorizedTags = this.getAuthorizedTags();
   }
 
-  get wsConnectionUrl(): URL {
+  private get wsConnectionUrl(): URL {
     return this.getSupervisionUrlOcppConfiguration()
       ? new URL(
           this.getConfigurationKey(this.getSupervisionUrlOcppKey()).value +
@@ -396,7 +401,9 @@ export default class ChargingStation {
     ) {
       // eslint-disable-next-line @typescript-eslint/no-misused-promises
       this.heartbeatSetInterval = setInterval(async (): Promise<void> => {
-        await this.ocppRequestService.sendMessageHandler(RequestCommand.HEARTBEAT);
+        await this.ocppRequestService.sendMessageHandler<HeartbeatResponse>(
+          RequestCommand.HEARTBEAT
+        );
       }, this.getHeartbeatInterval());
       logger.info(
         this.logPrefix() +
@@ -466,11 +473,14 @@ export default class ChargingStation {
             this.getConnectorStatus(connectorId).transactionId,
             interval
           );
-          await this.ocppRequestService.sendMessageHandler(RequestCommand.METER_VALUES, {
-            connectorId,
-            transactionId: this.getConnectorStatus(connectorId).transactionId,
-            meterValue: [meterValue],
-          });
+          await this.ocppRequestService.sendMessageHandler<MeterValuesResponse>(
+            RequestCommand.METER_VALUES,
+            {
+              connectorId,
+              transactionId: this.getConnectorStatus(connectorId).transactionId,
+              meterValue: [meterValue],
+            }
+          );
         },
         interval
       );
@@ -536,15 +546,6 @@ export default class ChargingStation {
         }
       }
     );
-    // FIXME: triggered by saveConfiguration()
-    // if (this.getOcppPersistentConfiguration()) {
-    //   FileUtils.watchJsonFile<ChargingStationConfiguration>(
-    //     this.logPrefix(),
-    //     FileType.ChargingStationConfiguration,
-    //     this.configurationFile,
-    //     this.configuration
-    //   );
-    // }
     // Handle WebSocket message
     this.wsConnection.on(
       'message',
@@ -577,11 +578,14 @@ export default class ChargingStation {
     await this.stopMessageSequence(reason);
     for (const connectorId of this.connectors.keys()) {
       if (connectorId > 0) {
-        await this.ocppRequestService.sendMessageHandler(RequestCommand.STATUS_NOTIFICATION, {
-          connectorId,
-          status: ChargePointStatus.UNAVAILABLE,
-          errorCode: ChargePointErrorCode.NO_ERROR,
-        });
+        await this.ocppRequestService.sendMessageHandler<StatusNotificationResponse>(
+          RequestCommand.STATUS_NOTIFICATION,
+          {
+            connectorId,
+            status: ChargePointStatus.UNAVAILABLE,
+            errorCode: ChargePointErrorCode.NO_ERROR,
+          }
+        );
         this.getConnectorStatus(connectorId).status = ChargePointStatus.UNAVAILABLE;
       }
     }
@@ -628,9 +632,9 @@ export default class ChargingStation {
         reboot: false,
       };
     }
-    const readonly = options.readonly;
-    const visible = options.visible;
-    const reboot = options.reboot;
+    const readonly = options.readonly ?? false;
+    const visible = options.visible ?? true;
+    const reboot = options.reboot ?? false;
     let keyFound = this.getConfigurationKey(key);
     if (keyFound && params?.overwrite) {
       this.deleteConfigurationKey(keyFound.key, { save: false });
@@ -824,13 +828,6 @@ export default class ChargingStation {
 
   private initialize(): void {
     this.stationInfo = this.buildStationInfo();
-    this.configurationFile = path.join(
-      path.resolve(__dirname, '../'),
-      'assets/configurations',
-      this.stationInfo.chargingStationId + '.json'
-    );
-    this.configuration = this.getConfiguration();
-    delete this.stationInfo.Configuration;
     this.bootNotificationRequest = {
       chargePointModel: this.stationInfo.chargePointModel,
       chargePointVendor: this.stationInfo.chargePointVendor,
@@ -840,7 +837,29 @@ export default class ChargingStation {
       ...(!Utils.isUndefined(this.stationInfo.firmwareVersion) && {
         firmwareVersion: this.stationInfo.firmwareVersion,
       }),
+      ...(!Utils.isUndefined(this.stationInfo.iccid) && { iccid: this.stationInfo.iccid }),
+      ...(!Utils.isUndefined(this.stationInfo.imsi) && { imsi: this.stationInfo.imsi }),
+      ...(!Utils.isUndefined(this.stationInfo.meterSerialNumber) && {
+        meterSerialNumber: this.stationInfo.meterSerialNumber,
+      }),
+      ...(!Utils.isUndefined(this.stationInfo.meterType) && {
+        meterType: this.stationInfo.meterType,
+      }),
     };
+
+    this.hashId = crypto
+      .createHash(Constants.DEFAULT_HASH_ALGORITHM)
+      .update(JSON.stringify(this.bootNotificationRequest) + this.stationInfo.chargingStationId)
+      .digest('hex');
+    logger.info(`${this.logPrefix()} Charging station hashId '${this.hashId}'`);
+    this.configurationFile = path.join(
+      path.resolve(__dirname, '../'),
+      'assets',
+      'configurations',
+      this.hashId + '.json'
+    );
+    this.configuration = this.getConfiguration();
+    delete this.stationInfo.Configuration;
     // Build connectors if needed
     const maxConnectors = this.getMaxNumberOfConnectors();
     if (maxConnectors <= 0) {
@@ -879,7 +898,7 @@ export default class ChargingStation {
       this.stationInfo.randomConnectors = true;
     }
     const connectorsConfigHash = crypto
-      .createHash('sha256')
+      .createHash(Constants.DEFAULT_HASH_ALGORITHM)
       .update(JSON.stringify(this.stationInfo.Connectors) + maxConnectors.toString())
       .digest('hex');
     const connectorsConfigChanged =
@@ -936,6 +955,8 @@ export default class ChargingStation {
     this.wsConfiguredConnectionUrl = new URL(
       this.getConfiguredSupervisionUrl().href + '/' + this.stationInfo.chargingStationId
     );
+    // OCPP parameters
+    this.initOcppParameters();
     switch (this.getOcppVersion()) {
       case OCPPVersion.VERSION_16:
         this.ocppIncomingRequestService =
@@ -949,8 +970,6 @@ export default class ChargingStation {
         this.handleUnsupportedVersion(this.getOcppVersion());
         break;
     }
-    // OCPP parameters
-    this.initOcppParameters();
     if (this.stationInfo.autoRegister) {
       this.bootNotificationResponse = {
         currentTime: new Date().toISOString(),
@@ -961,7 +980,7 @@ export default class ChargingStation {
     this.stationInfo.powerDivider = this.getPowerDivider();
     if (this.getEnableStatistics()) {
       this.performanceStatistics = PerformanceStatistics.getInstance(
-        this.id,
+        this.hashId,
         this.stationInfo.chargingStationId,
         this.wsConnectionUrl
       );
@@ -1111,21 +1130,22 @@ export default class ChargingStation {
       // Send BootNotification
       let registrationRetryCount = 0;
       do {
-        this.bootNotificationResponse = (await this.ocppRequestService.sendMessageHandler(
-          RequestCommand.BOOT_NOTIFICATION,
-          {
-            chargePointModel: this.bootNotificationRequest.chargePointModel,
-            chargePointVendor: this.bootNotificationRequest.chargePointVendor,
-            chargeBoxSerialNumber: this.bootNotificationRequest.chargeBoxSerialNumber,
-            firmwareVersion: this.bootNotificationRequest.firmwareVersion,
-            chargePointSerialNumber: this.bootNotificationRequest.chargePointSerialNumber,
-            iccid: this.bootNotificationRequest.iccid,
-            imsi: this.bootNotificationRequest.imsi,
-            meterSerialNumber: this.bootNotificationRequest.meterSerialNumber,
-            meterType: this.bootNotificationRequest.meterType,
-          },
-          { skipBufferingOnError: true }
-        )) as BootNotificationResponse;
+        this.bootNotificationResponse =
+          await this.ocppRequestService.sendMessageHandler<BootNotificationResponse>(
+            RequestCommand.BOOT_NOTIFICATION,
+            {
+              chargePointModel: this.bootNotificationRequest.chargePointModel,
+              chargePointVendor: this.bootNotificationRequest.chargePointVendor,
+              chargeBoxSerialNumber: this.bootNotificationRequest.chargeBoxSerialNumber,
+              firmwareVersion: this.bootNotificationRequest.firmwareVersion,
+              chargePointSerialNumber: this.bootNotificationRequest.chargePointSerialNumber,
+              iccid: this.bootNotificationRequest.iccid,
+              imsi: this.bootNotificationRequest.imsi,
+              meterSerialNumber: this.bootNotificationRequest.meterSerialNumber,
+              meterType: this.bootNotificationRequest.meterType,
+            },
+            { skipBufferingOnError: true }
+          );
         if (!this.isInAcceptedState()) {
           this.getRegistrationMaxRetries() !== -1 && registrationRetryCount++;
           await Utils.sleep(
@@ -1414,7 +1434,7 @@ export default class ChargingStation {
 
   private async startMessageSequence(): Promise<void> {
     if (this.stationInfo.autoRegister) {
-      await this.ocppRequestService.sendMessageHandler(
+      await this.ocppRequestService.sendMessageHandler<BootNotificationResponse>(
         RequestCommand.BOOT_NOTIFICATION,
         {
           chargePointModel: this.bootNotificationRequest.chargePointModel,
@@ -1444,11 +1464,14 @@ export default class ChargingStation {
         this.getConnectorStatus(connectorId)?.bootStatus
       ) {
         // Send status in template at startup
-        await this.ocppRequestService.sendMessageHandler(RequestCommand.STATUS_NOTIFICATION, {
-          connectorId,
-          status: this.getConnectorStatus(connectorId).bootStatus,
-          errorCode: ChargePointErrorCode.NO_ERROR,
-        });
+        await this.ocppRequestService.sendMessageHandler<StatusNotificationResponse>(
+          RequestCommand.STATUS_NOTIFICATION,
+          {
+            connectorId,
+            status: this.getConnectorStatus(connectorId).bootStatus,
+            errorCode: ChargePointErrorCode.NO_ERROR,
+          }
+        );
         this.getConnectorStatus(connectorId).status =
           this.getConnectorStatus(connectorId).bootStatus;
       } else if (
@@ -1457,27 +1480,36 @@ export default class ChargingStation {
         this.getConnectorStatus(connectorId)?.bootStatus
       ) {
         // Send status in template after reset
-        await this.ocppRequestService.sendMessageHandler(RequestCommand.STATUS_NOTIFICATION, {
-          connectorId,
-          status: this.getConnectorStatus(connectorId).bootStatus,
-          errorCode: ChargePointErrorCode.NO_ERROR,
-        });
+        await this.ocppRequestService.sendMessageHandler<StatusNotificationResponse>(
+          RequestCommand.STATUS_NOTIFICATION,
+          {
+            connectorId,
+            status: this.getConnectorStatus(connectorId).bootStatus,
+            errorCode: ChargePointErrorCode.NO_ERROR,
+          }
+        );
         this.getConnectorStatus(connectorId).status =
           this.getConnectorStatus(connectorId).bootStatus;
       } else if (!this.stopped && this.getConnectorStatus(connectorId)?.status) {
         // Send previous status at template reload
-        await this.ocppRequestService.sendMessageHandler(RequestCommand.STATUS_NOTIFICATION, {
-          connectorId,
-          status: this.getConnectorStatus(connectorId).status,
-          errorCode: ChargePointErrorCode.NO_ERROR,
-        });
+        await this.ocppRequestService.sendMessageHandler<StatusNotificationResponse>(
+          RequestCommand.STATUS_NOTIFICATION,
+          {
+            connectorId,
+            status: this.getConnectorStatus(connectorId).status,
+            errorCode: ChargePointErrorCode.NO_ERROR,
+          }
+        );
       } else {
         // Send default status
-        await this.ocppRequestService.sendMessageHandler(RequestCommand.STATUS_NOTIFICATION, {
-          connectorId,
-          status: ChargePointStatus.AVAILABLE,
-          errorCode: ChargePointErrorCode.NO_ERROR,
-        });
+        await this.ocppRequestService.sendMessageHandler<StatusNotificationResponse>(
+          RequestCommand.STATUS_NOTIFICATION,
+          {
+            connectorId,
+            status: ChargePointStatus.AVAILABLE,
+            errorCode: ChargePointErrorCode.NO_ERROR,
+          }
+        );
         this.getConnectorStatus(connectorId).status = ChargePointStatus.AVAILABLE;
       }
     }
@@ -1524,18 +1556,24 @@ export default class ChargingStation {
               connectorId,
               this.getEnergyActiveImportRegisterByTransactionId(transactionId)
             );
-            await this.ocppRequestService.sendMessageHandler(RequestCommand.METER_VALUES, {
-              connectorId,
-              transactionId,
-              meterValue: transactionEndMeterValue,
-            });
+            await this.ocppRequestService.sendMessageHandler<MeterValuesResponse>(
+              RequestCommand.METER_VALUES,
+              {
+                connectorId,
+                transactionId,
+                meterValue: transactionEndMeterValue,
+              }
+            );
           }
-          await this.ocppRequestService.sendMessageHandler(RequestCommand.STOP_TRANSACTION, {
-            transactionId,
-            meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId),
-            idTag: this.getTransactionIdTag(transactionId),
-            reason,
-          });
+          await this.ocppRequestService.sendMessageHandler<StopTransactionResponse>(
+            RequestCommand.STOP_TRANSACTION,
+            {
+              transactionId,
+              meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId),
+              idTag: this.getTransactionIdTag(transactionId),
+              reason,
+            }
+          );
         }
       }
     }