X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2FOCPPServiceUtils.ts;h=d09d8b1a1afaffc72b9891ab52f72b48f6282c69;hb=08b58f0020986c0ad1b55e562aaf325a47b9d58c;hp=451870862ad1c5630a68fa34da323594e1e27fa7;hpb=130783a74f495abcb198b7f01abe19dab4f7fb47;p=e-mobility-charging-stations-simulator.git

diff --git a/src/charging-station/ocpp/OCPPServiceUtils.ts b/src/charging-station/ocpp/OCPPServiceUtils.ts
index 45187086..d09d8b1a 100644
--- a/src/charging-station/ocpp/OCPPServiceUtils.ts
+++ b/src/charging-station/ocpp/OCPPServiceUtils.ts
@@ -1,28 +1,42 @@
-import type { DefinedError, ErrorObject } from 'ajv';
+import { readFileSync } from 'node:fs';
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
 
-import BaseError from '../../exception/BaseError';
-import type { JsonObject, JsonType } from '../../types/JsonType';
-import type { SampledValueTemplate } from '../../types/MeasurandPerPhaseSampledValueTemplates';
-import type { OCPP16StatusNotificationRequest } from '../../types/ocpp/1.6/Requests';
-import type { OCPP20StatusNotificationRequest } from '../../types/ocpp/2.0/Requests';
-import { ChargePointErrorCode } from '../../types/ocpp/ChargePointErrorCode';
-import { StandardParametersKey } from '../../types/ocpp/Configuration';
-import type { ConnectorStatusEnum } from '../../types/ocpp/ConnectorStatusEnum';
-import { ErrorType } from '../../types/ocpp/ErrorType';
-import { MessageType } from '../../types/ocpp/MessageType';
-import { MeterValueMeasurand, type MeterValuePhase } from '../../types/ocpp/MeterValues';
-import { OCPPVersion } from '../../types/ocpp/OCPPVersion';
+import type { DefinedError, ErrorObject, JSONSchemaType } from 'ajv';
+import { isDate } from 'date-fns';
+
+import { OCPP16Constants } from './1.6/OCPP16Constants';
+import { OCPP20Constants } from './2.0/OCPP20Constants';
+import { OCPPConstants } from './OCPPConstants';
+import { type ChargingStation, getConfigurationKey } from '../../charging-station';
+import { BaseError } from '../../exception';
 import {
+  ChargePointErrorCode,
+  type ConnectorStatusEnum,
+  ErrorType,
+  FileType,
   IncomingRequestCommand,
+  type JsonType,
   MessageTrigger,
+  MessageType,
+  MeterValueMeasurand,
+  type MeterValuePhase,
+  type OCPP16StatusNotificationRequest,
+  type OCPP20StatusNotificationRequest,
+  OCPPVersion,
   RequestCommand,
+  type SampledValueTemplate,
+  StandardParametersKey,
   type StatusNotificationRequest,
-} from '../../types/ocpp/Requests';
-import Constants from '../../utils/Constants';
-import logger from '../../utils/Logger';
-import Utils from '../../utils/Utils';
-import type ChargingStation from '../ChargingStation';
-import { ChargingStationConfigurationUtils } from '../ChargingStationConfigurationUtils';
+  type StatusNotificationResponse,
+} from '../../types';
+import {
+  handleFileException,
+  isNotEmptyArray,
+  isNotEmptyString,
+  logPrefix,
+  logger,
+} from '../../utils';
 
 export class OCPPServiceUtils {
   protected constructor() {
@@ -60,7 +74,7 @@ export class OCPPServiceUtils {
 
   public static isRequestCommandSupported(
     chargingStation: ChargingStation,
-    command: RequestCommand
+    command: RequestCommand,
   ): boolean {
     const isRequestCommand = Object.values<RequestCommand>(RequestCommand).includes(command);
     if (
@@ -80,7 +94,7 @@ export class OCPPServiceUtils {
 
   public static isIncomingRequestCommandSupported(
     chargingStation: ChargingStation,
-    command: IncomingRequestCommand
+    command: IncomingRequestCommand,
   ): boolean {
     const isIncomingRequestCommand =
       Object.values<IncomingRequestCommand>(IncomingRequestCommand).includes(command);
@@ -101,7 +115,7 @@ export class OCPPServiceUtils {
 
   public static isMessageTriggerSupported(
     chargingStation: ChargingStation,
-    messageTrigger: MessageTrigger
+    messageTrigger: MessageTrigger,
   ): boolean {
     const isMessageTrigger = Object.values(MessageTrigger).includes(messageTrigger);
     if (isMessageTrigger === true && !chargingStation.stationInfo?.messageTriggerSupport) {
@@ -110,7 +124,7 @@ export class OCPPServiceUtils {
       return chargingStation.stationInfo?.messageTriggerSupport[messageTrigger] ?? false;
     }
     logger.error(
-      `${chargingStation.logPrefix()} Unknown incoming OCPP message trigger '${messageTrigger}'`
+      `${chargingStation.logPrefix()} Unknown incoming OCPP message trigger '${messageTrigger}'`,
     );
     return false;
   }
@@ -118,11 +132,11 @@ export class OCPPServiceUtils {
   public static isConnectorIdValid(
     chargingStation: ChargingStation,
     ocppCommand: IncomingRequestCommand,
-    connectorId: number
+    connectorId: number,
   ): boolean {
     if (connectorId < 0) {
       logger.error(
-        `${chargingStation.logPrefix()} ${ocppCommand} incoming request received with invalid connector Id ${connectorId}`
+        `${chargingStation.logPrefix()} ${ocppCommand} incoming request received with invalid connector id ${connectorId}`,
       );
       return false;
     }
@@ -131,10 +145,14 @@ export class OCPPServiceUtils {
 
   public static convertDateToISOString<T extends JsonType>(obj: T): void {
     for (const key in obj) {
-      if (obj[key] instanceof Date) {
-        (obj as JsonObject)[key] = (obj[key] as Date).toISOString();
-      } else if (obj[key] !== null && typeof obj[key] === 'object') {
-        this.convertDateToISOString<T>(obj[key] as T);
+      // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
+      if (isDate(obj![key])) {
+        // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
+        (obj![key] as string) = (obj![key] as Date).toISOString();
+        // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
+      } else if (obj![key] !== null && typeof obj![key] === 'object') {
+        // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
+        OCPPServiceUtils.convertDateToISOString<T>(obj![key] as T);
       }
     }
   }
@@ -142,7 +160,8 @@ export class OCPPServiceUtils {
   public static buildStatusNotificationRequest(
     chargingStation: ChargingStation,
     connectorId: number,
-    status: ConnectorStatusEnum
+    status: ConnectorStatusEnum,
+    evseId?: number,
   ): StatusNotificationRequest {
     switch (chargingStation.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16) {
       case OCPPVersion.VERSION_16:
@@ -157,67 +176,174 @@ export class OCPPServiceUtils {
           timestamp: new Date(),
           connectorStatus: status,
           connectorId,
-          evseId: connectorId,
+          evseId,
         } as OCPP20StatusNotificationRequest;
       default:
         throw new BaseError('Cannot build status notification payload: OCPP version not supported');
     }
   }
 
-  protected static logPrefix(ocppVersion: OCPPVersion): string {
-    return Utils.logPrefix(` OCPP ${ocppVersion} |`);
+  public static startHeartbeatInterval(chargingStation: ChargingStation, interval: number): void {
+    if (!chargingStation.heartbeatSetInterval) {
+      chargingStation.startHeartbeat();
+    } else if (chargingStation.getHeartbeatInterval() !== interval) {
+      chargingStation.restartHeartbeat();
+    }
+  }
+
+  public static async sendAndSetConnectorStatus(
+    chargingStation: ChargingStation,
+    connectorId: number,
+    status: ConnectorStatusEnum,
+    evseId?: number,
+    options?: { send: boolean },
+  ) {
+    options = { send: true, ...options };
+    if (options.send) {
+      OCPPServiceUtils.checkConnectorStatusTransition(chargingStation, connectorId, status);
+      await chargingStation.ocppRequestService.requestHandler<
+        StatusNotificationRequest,
+        StatusNotificationResponse
+      >(
+        chargingStation,
+        RequestCommand.STATUS_NOTIFICATION,
+        OCPPServiceUtils.buildStatusNotificationRequest(
+          chargingStation,
+          connectorId,
+          status,
+          evseId,
+        ),
+      );
+    }
+    chargingStation.getConnectorStatus(connectorId)!.status = status;
+  }
+
+  protected static checkConnectorStatusTransition(
+    chargingStation: ChargingStation,
+    connectorId: number,
+    status: ConnectorStatusEnum,
+  ): boolean {
+    const fromStatus = chargingStation.getConnectorStatus(connectorId)!.status;
+    let transitionAllowed = false;
+    switch (chargingStation.stationInfo.ocppVersion) {
+      case OCPPVersion.VERSION_16:
+        if (
+          (connectorId === 0 &&
+            OCPP16Constants.ChargePointStatusChargingStationTransitions.findIndex(
+              (transition) => transition.from === fromStatus && transition.to === status,
+            ) !== -1) ||
+          (connectorId > 0 &&
+            OCPP16Constants.ChargePointStatusConnectorTransitions.findIndex(
+              (transition) => transition.from === fromStatus && transition.to === status,
+            ) !== -1)
+        ) {
+          transitionAllowed = true;
+        }
+        break;
+      case OCPPVersion.VERSION_20:
+      case OCPPVersion.VERSION_201:
+        if (
+          (connectorId === 0 &&
+            OCPP20Constants.ChargingStationStatusTransitions.findIndex(
+              (transition) => transition.from === fromStatus && transition.to === status,
+            ) !== -1) ||
+          (connectorId > 0 &&
+            OCPP20Constants.ConnectorStatusTransitions.findIndex(
+              (transition) => transition.from === fromStatus && transition.to === status,
+            ) !== -1)
+        ) {
+          transitionAllowed = true;
+        }
+        break;
+      default:
+        throw new BaseError(
+          // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+          `Cannot check connector status transition: OCPP version ${chargingStation.stationInfo.ocppVersion} not supported`,
+        );
+    }
+    if (transitionAllowed === false) {
+      logger.warn(
+        `${chargingStation.logPrefix()} OCPP ${
+          chargingStation.stationInfo.ocppVersion
+        } connector id ${connectorId} status transition from '${
+          chargingStation.getConnectorStatus(connectorId)!.status
+        }' to '${status}' is not allowed`,
+      );
+    }
+    return transitionAllowed;
+  }
+
+  protected static parseJsonSchemaFile<T extends JsonType>(
+    relativePath: string,
+    ocppVersion: OCPPVersion,
+    moduleName?: string,
+    methodName?: string,
+  ): JSONSchemaType<T> {
+    const filePath = join(dirname(fileURLToPath(import.meta.url)), relativePath);
+    try {
+      return JSON.parse(readFileSync(filePath, 'utf8')) as JSONSchemaType<T>;
+    } catch (error) {
+      handleFileException(
+        filePath,
+        FileType.JsonSchema,
+        error as NodeJS.ErrnoException,
+        OCPPServiceUtils.logPrefix(ocppVersion, moduleName, methodName),
+        { throwError: false },
+      );
+      return {} as JSONSchemaType<T>;
+    }
   }
 
   protected static getSampledValueTemplate(
     chargingStation: ChargingStation,
     connectorId: number,
     measurand: MeterValueMeasurand = MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER,
-    phase?: MeterValuePhase
+    phase?: MeterValuePhase,
   ): SampledValueTemplate | undefined {
     const onPhaseStr = phase ? `on phase ${phase} ` : '';
-    if (Constants.SUPPORTED_MEASURANDS.includes(measurand) === false) {
+    if (OCPPConstants.OCPP_MEASURANDS_SUPPORTED.includes(measurand) === false) {
       logger.warn(
-        `${chargingStation.logPrefix()} Trying to get unsupported MeterValues measurand '${measurand}' ${onPhaseStr}in template on connectorId ${connectorId}`
+        `${chargingStation.logPrefix()} Trying to get unsupported MeterValues measurand '${measurand}' ${onPhaseStr}in template on connector id ${connectorId}`,
       );
       return;
     }
     if (
       measurand !== MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER &&
-      ChargingStationConfigurationUtils.getConfigurationKey(
+      getConfigurationKey(
         chargingStation,
-        StandardParametersKey.MeterValuesSampledData
+        StandardParametersKey.MeterValuesSampledData,
       )?.value?.includes(measurand) === false
     ) {
       logger.debug(
-        `${chargingStation.logPrefix()} Trying to get MeterValues measurand '${measurand}' ${onPhaseStr}in template on connectorId ${connectorId} not found in '${
+        `${chargingStation.logPrefix()} Trying to get MeterValues measurand '${measurand}' ${onPhaseStr}in template on connector id ${connectorId} not found in '${
           StandardParametersKey.MeterValuesSampledData
-        }' OCPP parameter`
+        }' OCPP parameter`,
       );
       return;
     }
     const sampledValueTemplates: SampledValueTemplate[] =
-      chargingStation.getConnectorStatus(connectorId)?.MeterValues;
+      chargingStation.getConnectorStatus(connectorId)!.MeterValues;
     for (
       let index = 0;
-      Utils.isEmptyArray(sampledValueTemplates) === false && index < sampledValueTemplates.length;
+      isNotEmptyArray(sampledValueTemplates) === true && index < sampledValueTemplates.length;
       index++
     ) {
       if (
-        Constants.SUPPORTED_MEASURANDS.includes(
+        OCPPConstants.OCPP_MEASURANDS_SUPPORTED.includes(
           sampledValueTemplates[index]?.measurand ??
-            MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER
+            MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER,
         ) === false
       ) {
         logger.warn(
-          `${chargingStation.logPrefix()} Unsupported MeterValues measurand '${measurand}' ${onPhaseStr}in template on connectorId ${connectorId}`
+          `${chargingStation.logPrefix()} Unsupported MeterValues measurand '${measurand}' ${onPhaseStr}in template on connector id ${connectorId}`,
         );
       } else if (
         phase &&
         sampledValueTemplates[index]?.phase === phase &&
         sampledValueTemplates[index]?.measurand === measurand &&
-        ChargingStationConfigurationUtils.getConfigurationKey(
+        getConfigurationKey(
           chargingStation,
-          StandardParametersKey.MeterValuesSampledData
+          StandardParametersKey.MeterValuesSampledData,
         )?.value?.includes(measurand) === true
       ) {
         return sampledValueTemplates[index];
@@ -225,9 +351,9 @@ export class OCPPServiceUtils {
         !phase &&
         !sampledValueTemplates[index].phase &&
         sampledValueTemplates[index]?.measurand === measurand &&
-        ChargingStationConfigurationUtils.getConfigurationKey(
+        getConfigurationKey(
           chargingStation,
-          StandardParametersKey.MeterValuesSampledData
+          StandardParametersKey.MeterValuesSampledData,
         )?.value?.includes(measurand) === true
       ) {
         return sampledValueTemplates[index];
@@ -240,12 +366,12 @@ export class OCPPServiceUtils {
       }
     }
     if (measurand === MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER) {
-      const errorMsg = `Missing MeterValues for default measurand '${measurand}' in template on connectorId ${connectorId}`;
+      const errorMsg = `Missing MeterValues for default measurand '${measurand}' in template on connector id ${connectorId}`;
       logger.error(`${chargingStation.logPrefix()} ${errorMsg}`);
       throw new BaseError(errorMsg);
     }
     logger.debug(
-      `${chargingStation.logPrefix()} No MeterValues for measurand '${measurand}' ${onPhaseStr}in template on connectorId ${connectorId}`
+      `${chargingStation.logPrefix()} No MeterValues for measurand '${measurand}' ${onPhaseStr}in template on connector id ${connectorId}`,
     );
   }
 
@@ -255,14 +381,31 @@ export class OCPPServiceUtils {
     options: { limitationEnabled?: boolean; unitMultiplier?: number } = {
       limitationEnabled: true,
       unitMultiplier: 1,
-    }
+    },
   ): number {
-    options.limitationEnabled = options?.limitationEnabled ?? true;
-    options.unitMultiplier = options?.unitMultiplier ?? 1;
+    options = {
+      ...{
+        limitationEnabled: true,
+        unitMultiplier: 1,
+      },
+      ...options,
+    };
     const parsedInt = parseInt(value);
     const numberValue = isNaN(parsedInt) ? Infinity : parsedInt;
     return options?.limitationEnabled
-      ? Math.min(numberValue * options.unitMultiplier, limit)
-      : numberValue * options.unitMultiplier;
+      ? Math.min(numberValue * options.unitMultiplier!, limit)
+      : numberValue * options.unitMultiplier!;
   }
+
+  private static logPrefix = (
+    ocppVersion: OCPPVersion,
+    moduleName?: string,
+    methodName?: string,
+  ): string => {
+    const logMsg =
+      isNotEmptyString(moduleName) && isNotEmptyString(methodName)
+        ? ` OCPP ${ocppVersion} | ${moduleName}.${methodName}:`
+        : ` OCPP ${ocppVersion} |`;
+    return logPrefix(logMsg);
+  };
 }