Improve charging profiles handling debug logs
[e-mobility-charging-stations-simulator.git] / src / charging-station / ChargingStation.ts
index 84aa81ca649336eda64779744c87600ac5d9a098..a52ebacb88eeb91a62e1d3ddf91d70b3a519f40b 100644 (file)
@@ -6,8 +6,26 @@ import path from 'path';
 import { URL } from 'url';
 import { parentPort } from 'worker_threads';
 
+import merge from 'just-merge';
 import WebSocket, { type RawData } from 'ws';
 
+import AuthorizedTagsCache from './AuthorizedTagsCache';
+import AutomaticTransactionGenerator from './AutomaticTransactionGenerator';
+import { ChargingStationConfigurationUtils } from './ChargingStationConfigurationUtils';
+import { ChargingStationUtils } from './ChargingStationUtils';
+import ChargingStationWorkerBroadcastChannel from './ChargingStationWorkerBroadcastChannel';
+import { MessageChannelUtils } from './MessageChannelUtils';
+import OCPP16IncomingRequestService from './ocpp/1.6/OCPP16IncomingRequestService';
+import OCPP16RequestService from './ocpp/1.6/OCPP16RequestService';
+import OCPP16ResponseService from './ocpp/1.6/OCPP16ResponseService';
+import { OCPP16ServiceUtils } from './ocpp/1.6/OCPP16ServiceUtils';
+import OCPP20IncomingRequestService from './ocpp/2.0/OCPP20IncomingRequestService';
+import OCPP20RequestService from './ocpp/2.0/OCPP20RequestService';
+import OCPP20ResponseService from './ocpp/2.0/OCPP20ResponseService';
+import type OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService';
+import type OCPPRequestService from './ocpp/OCPPRequestService';
+import { OCPPServiceUtils } from './ocpp/OCPPServiceUtils';
+import SharedLRUCache from './SharedLRUCache';
 import BaseError from '../exception/BaseError';
 import OCPPError from '../exception/OCPPError';
 import PerformanceStatistics from '../performance/PerformanceStatistics';
@@ -25,8 +43,6 @@ import { SupervisionUrlDistribution } from '../types/ConfigurationData';
 import type { ConnectorStatus } from '../types/ConnectorStatus';
 import { FileType } from '../types/FileType';
 import type { JsonType } from '../types/JsonType';
-import { ChargePointErrorCode } from '../types/ocpp/ChargePointErrorCode';
-import { ChargePointStatus } from '../types/ocpp/ChargePointStatus';
 import { ChargingProfile, ChargingRateUnitType } from '../types/ocpp/ChargingProfile';
 import {
   ConnectorPhaseRotation,
@@ -34,6 +50,7 @@ import {
   SupportedFeatureProfiles,
   VendorDefaultParametersKey,
 } from '../types/ocpp/Configuration';
+import { ConnectorStatusEnum } from '../types/ocpp/ConnectorStatusEnum';
 import { ErrorType } from '../types/ocpp/ErrorType';
 import { MessageType } from '../types/ocpp/MessageType';
 import { MeterValue, MeterValueMeasurand } from '../types/ocpp/MeterValues';
@@ -75,22 +92,6 @@ import { ACElectricUtils, DCElectricUtils } from '../utils/ElectricUtils';
 import FileUtils from '../utils/FileUtils';
 import logger from '../utils/Logger';
 import Utils from '../utils/Utils';
-import AuthorizedTagsCache from './AuthorizedTagsCache';
-import AutomaticTransactionGenerator from './AutomaticTransactionGenerator';
-import { ChargingStationConfigurationUtils } from './ChargingStationConfigurationUtils';
-import { ChargingStationUtils } from './ChargingStationUtils';
-import ChargingStationWorkerBroadcastChannel from './ChargingStationWorkerBroadcastChannel';
-import { MessageChannelUtils } from './MessageChannelUtils';
-import OCPP16IncomingRequestService from './ocpp/1.6/OCPP16IncomingRequestService';
-import OCPP16RequestService from './ocpp/1.6/OCPP16RequestService';
-import OCPP16ResponseService from './ocpp/1.6/OCPP16ResponseService';
-import { OCPP16ServiceUtils } from './ocpp/1.6/OCPP16ServiceUtils';
-import OCPP20IncomingRequestService from './ocpp/2.0/OCPP20IncomingRequestService';
-import OCPP20RequestService from './ocpp/2.0/OCPP20RequestService';
-import OCPP20ResponseService from './ocpp/2.0/OCPP20ResponseService';
-import type OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService';
-import type OCPPRequestService from './ocpp/OCPPRequestService';
-import SharedLRUCache from './SharedLRUCache';
 
 export default class ChargingStation {
   public readonly index: number;
@@ -376,12 +377,15 @@ export default class ChargingStation {
       this.getHeartbeatInterval() > 0 &&
       !this.heartbeatSetInterval
     ) {
-      // eslint-disable-next-line @typescript-eslint/no-misused-promises
-      this.heartbeatSetInterval = setInterval(async (): Promise<void> => {
-        await this.ocppRequestService.requestHandler<HeartbeatRequest, HeartbeatResponse>(
-          this,
-          RequestCommand.HEARTBEAT
-        );
+      this.heartbeatSetInterval = setInterval(() => {
+        this.ocppRequestService
+          .requestHandler<HeartbeatRequest, HeartbeatResponse>(this, RequestCommand.HEARTBEAT)
+          .catch((error) => {
+            logger.error(
+              `${this.logPrefix()} Error while sending '${RequestCommand.HEARTBEAT}':`,
+              error
+            );
+          });
       }, this.getHeartbeatInterval());
       logger.info(
         this.logPrefix() +
@@ -447,18 +451,16 @@ export default class ChargingStation {
       return;
     }
     if (interval > 0) {
-      // eslint-disable-next-line @typescript-eslint/no-misused-promises
-      this.getConnectorStatus(connectorId).transactionSetInterval = setInterval(
-        // eslint-disable-next-line @typescript-eslint/no-misused-promises
-        async (): Promise<void> => {
-          // FIXME: Implement OCPP version agnostic helpers
-          const meterValue: MeterValue = OCPP16ServiceUtils.buildMeterValue(
-            this,
-            connectorId,
-            this.getConnectorStatus(connectorId).transactionId,
-            interval
-          );
-          await this.ocppRequestService.requestHandler<MeterValuesRequest, MeterValuesResponse>(
+      this.getConnectorStatus(connectorId).transactionSetInterval = setInterval(() => {
+        // FIXME: Implement OCPP version agnostic helpers
+        const meterValue: MeterValue = OCPP16ServiceUtils.buildMeterValue(
+          this,
+          connectorId,
+          this.getConnectorStatus(connectorId).transactionId,
+          interval
+        );
+        this.ocppRequestService
+          .requestHandler<MeterValuesRequest, MeterValuesResponse>(
             this,
             RequestCommand.METER_VALUES,
             {
@@ -466,10 +468,14 @@ export default class ChargingStation {
               transactionId: this.getConnectorStatus(connectorId).transactionId,
               meterValue: [meterValue],
             }
-          );
-        },
-        interval
-      );
+          )
+          .catch((error) => {
+            logger.error(
+              `${this.logPrefix()} Error while sending '${RequestCommand.METER_VALUES}':`,
+              error
+            );
+          });
+      }, interval);
     } else {
       logger.error(
         `${this.logPrefix()} Charging station ${
@@ -630,7 +636,7 @@ export default class ChargingStation {
     if (params?.terminateOpened) {
       this.terminateWSConnection();
     }
-    const ocppVersion = this.getOcppVersion();
+    const ocppVersion = this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16;
     let protocol: string;
     switch (ocppVersion) {
       case OCPPVersion.VERSION_16:
@@ -832,6 +838,7 @@ export default class ChargingStation {
       this.index,
       stationTemplate
     );
+    stationInfo.ocppVersion = stationTemplate.ocppVersion ?? OCPPVersion.VERSION_16;
     ChargingStationUtils.createSerialNumber(stationTemplate, stationInfo);
     if (!Utils.isEmptyArray(stationTemplate.power)) {
       stationTemplate.power = stationTemplate.power as number[];
@@ -859,6 +866,12 @@ export default class ChargingStation {
         } does not match firmware version pattern '${stationInfo.firmwareVersionPattern}'`
       );
     }
+    stationInfo.firmwareUpgrade = merge(
+      {
+        reset: true,
+      },
+      stationTemplate.firmwareUpgrade ?? {}
+    );
     stationInfo.resetTime = stationTemplate.resetTime
       ? stationTemplate.resetTime * 1000
       : Constants.CHARGING_STATION_DEFAULT_RESET_TIME;
@@ -928,10 +941,6 @@ export default class ChargingStation {
     }
   }
 
-  private getOcppVersion(): OCPPVersion {
-    return this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16;
-  }
-
   private getOcppPersistentConfiguration(): boolean {
     return this.stationInfo?.ocppPersistentConfiguration ?? true;
   }
@@ -970,7 +979,8 @@ export default class ChargingStation {
     // OCPP configuration
     this.ocppConfiguration = this.getOcppConfiguration();
     this.initializeOcppConfiguration();
-    switch (this.getOcppVersion()) {
+    const ocppVersion = this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16;
+    switch (ocppVersion) {
       case OCPPVersion.VERSION_16:
         this.ocppIncomingRequestService =
           OCPP16IncomingRequestService.getInstance<OCPP16IncomingRequestService>();
@@ -987,7 +997,7 @@ export default class ChargingStation {
         );
         break;
       default:
-        this.handleUnsupportedVersion(this.getOcppVersion());
+        this.handleUnsupportedVersion(ocppVersion);
         break;
     }
     if (this.stationInfo?.autoRegister === true) {
@@ -1002,11 +1012,17 @@ export default class ChargingStation {
       this.stationInfo.firmwareVersion &&
       this.stationInfo.firmwareVersionPattern
     ) {
+      const versionStep = this.stationInfo.firmwareUpgrade?.versionUpgrade?.step ?? 1;
+      const patternGroup: number =
+        this.stationInfo.firmwareUpgrade?.versionUpgrade?.patternGroup ??
+        this.stationInfo.firmwareVersion.split('.').length;
       const match = this.stationInfo.firmwareVersion
         .match(new RegExp(this.stationInfo.firmwareVersionPattern))
-        .slice(1, this.stationInfo.firmwareVersion.split('.').length + 1);
+        .slice(1, patternGroup + 1);
       const patchLevelIndex = match.length - 1;
-      match[patchLevelIndex] = (Utils.convertToInt(match[patchLevelIndex]) + 1).toString();
+      match[patchLevelIndex] = (
+        Utils.convertToInt(match[patchLevelIndex]) + versionStep
+      ).toString();
       this.stationInfo.firmwareVersion = match.join('.');
     }
   }
@@ -1790,8 +1806,11 @@ export default class ChargingStation {
           logger.error(
             `${this.logPrefix()} Charging profile id ${
               matchingChargingProfile.chargingProfileId
-            } limit ${limit} is greater than connector id ${connectorId} maximum ${connectorMaximumPower}, dump charging profiles' stack: %j`,
-            this.getConnectorStatus(connectorId).chargingProfiles
+            } limit ${limit} is greater than connector id ${connectorId} maximum ${connectorMaximumPower}: %j`,
+            this.getConnectorStatus(connectorId).chargingProfiles.find(
+              (chargingProfile) =>
+                chargingProfile.chargingProfileId === matchingChargingProfile.chargingProfileId
+            )
           );
           limit = connectorMaximumPower;
         }
@@ -1815,7 +1834,7 @@ export default class ChargingStation {
     this.startHeartbeat();
     // Initialize connectors status
     for (const connectorId of this.connectors.keys()) {
-      let chargePointStatus: ChargePointStatus;
+      let connectorStatus: ConnectorStatusEnum;
       if (connectorId === 0) {
         continue;
       } else if (
@@ -1823,29 +1842,29 @@ export default class ChargingStation {
         (this.isChargingStationAvailable() === false ||
           this.isConnectorAvailable(connectorId) === false)
       ) {
-        chargePointStatus = ChargePointStatus.UNAVAILABLE;
+        connectorStatus = ConnectorStatusEnum.UNAVAILABLE;
       } else if (
         !this.getConnectorStatus(connectorId)?.status &&
         this.getConnectorStatus(connectorId)?.bootStatus
       ) {
         // Set boot status in template at startup
-        chargePointStatus = this.getConnectorStatus(connectorId).bootStatus;
+        connectorStatus = this.getConnectorStatus(connectorId).bootStatus;
       } else if (this.getConnectorStatus(connectorId)?.status) {
         // Set previous status at startup
-        chargePointStatus = this.getConnectorStatus(connectorId).status;
+        connectorStatus = this.getConnectorStatus(connectorId).status;
       } else {
         // Set default status
-        chargePointStatus = ChargePointStatus.AVAILABLE;
+        connectorStatus = ConnectorStatusEnum.AVAILABLE;
       }
       await this.ocppRequestService.requestHandler<
         StatusNotificationRequest,
         StatusNotificationResponse
-      >(this, RequestCommand.STATUS_NOTIFICATION, {
-        connectorId,
-        status: chargePointStatus,
-        errorCode: ChargePointErrorCode.NO_ERROR,
-      });
-      this.getConnectorStatus(connectorId).status = chargePointStatus;
+      >(
+        this,
+        RequestCommand.STATUS_NOTIFICATION,
+        OCPPServiceUtils.buildStatusNotificationRequest(this, connectorId, connectorStatus)
+      );
+      this.getConnectorStatus(connectorId).status = connectorStatus;
     }
     if (this.stationInfo?.firmwareStatus === FirmwareStatus.Installing) {
       await this.ocppRequestService.requestHandler<
@@ -1882,11 +1901,15 @@ export default class ChargingStation {
         await this.ocppRequestService.requestHandler<
           StatusNotificationRequest,
           StatusNotificationResponse
-        >(this, RequestCommand.STATUS_NOTIFICATION, {
-          connectorId,
-          status: ChargePointStatus.UNAVAILABLE,
-          errorCode: ChargePointErrorCode.NO_ERROR,
-        });
+        >(
+          this,
+          RequestCommand.STATUS_NOTIFICATION,
+          OCPPServiceUtils.buildStatusNotificationRequest(
+            this,
+            connectorId,
+            ConnectorStatusEnum.UNAVAILABLE
+          )
+        );
         this.getConnectorStatus(connectorId).status = null;
       }
     }