Add Hearbeat command to OCPP 2.0.1
[e-mobility-charging-stations-simulator.git] / src / charging-station / ocpp / 2.0 / OCPP20RequestService.ts
index ac22e9fbc23c9fe2684bfb2b7bae6b45b009d6c4..3e54ca50326c4bde179674662b50bfbe5ed6d6bb 100644 (file)
@@ -9,14 +9,13 @@ import type { JSONSchemaType } from 'ajv';
 import OCPPError from '../../../exception/OCPPError';
 import type { JsonObject, JsonType } from '../../../types/JsonType';
 import {
-  BootReasonEnumType,
-  OCPP20BootNotificationRequest,
+  type OCPP20BootNotificationRequest,
+  type OCPP20HeartbeatRequest,
   OCPP20RequestCommand,
 } from '../../../types/ocpp/2.0/Requests';
 import { ErrorType } from '../../../types/ocpp/ErrorType';
 import { OCPPVersion } from '../../../types/ocpp/OCPPVersion';
 import type { RequestParams } from '../../../types/ocpp/Requests';
-import logger from '../../../utils/Logger';
 import Utils from '../../../utils/Utils';
 import type ChargingStation from '../../ChargingStation';
 import OCPPRequestService from '../OCPPRequestService';
@@ -26,7 +25,7 @@ import { OCPP20ServiceUtils } from './OCPP20ServiceUtils';
 const moduleName = 'OCPP20RequestService';
 
 export default class OCPP20RequestService extends OCPPRequestService {
-  private jsonSchemas: Map<OCPP20RequestCommand, JSONSchemaType<JsonObject>>;
+  protected jsonSchemas: Map<OCPP20RequestCommand, JSONSchemaType<JsonObject>>;
 
   public constructor(ocppResponseService: OCPPResponseService) {
     if (new.target?.name === moduleName) {
@@ -46,9 +45,20 @@ export default class OCPP20RequestService extends OCPPRequestService {
           )
         ) as JSONSchemaType<OCPP20BootNotificationRequest>,
       ],
+      [
+        OCPP20RequestCommand.HEARTBEAT,
+        JSON.parse(
+          fs.readFileSync(
+            path.resolve(
+              path.dirname(fileURLToPath(import.meta.url)),
+              '../../../assets/json-schemas/ocpp/2.0/HeartbeatRequest.json'
+            ),
+            'utf8'
+          )
+        ) as JSONSchemaType<OCPP20HeartbeatRequest>,
+      ],
     ]);
     this.buildRequestPayload.bind(this);
-    this.validatePayload.bind(this);
   }
 
   public async requestHandler<RequestType extends JsonType, ResponseType extends JsonType>(
@@ -63,7 +73,6 @@ export default class OCPP20RequestService extends OCPPRequestService {
         commandName,
         commandParams
       );
-      this.validatePayload(chargingStation, commandName, requestPayload);
       return (await this.sendMessage(
         chargingStation,
         Utils.generateUUID(),
@@ -89,28 +98,33 @@ export default class OCPP20RequestService extends OCPPRequestService {
     commandParams = commandParams as JsonObject;
     switch (commandName) {
       case OCPP20RequestCommand.BOOT_NOTIFICATION:
-        commandParams.modem = commandParams.modem as JsonObject;
+        commandParams.chargingStation = commandParams.chargingStation as JsonObject;
+        commandParams.chargingStation.modem = commandParams.chargingStation.modem as JsonObject;
         return {
           reason: commandParams?.reason,
           chargingStation: {
-            model: commandParams?.model,
-            vendorName: commandParams?.vendorName,
-            ...(!Utils.isUndefined(commandParams?.firmwareVersion) && {
-              firmwareVersion: commandParams.firmwareVersion,
+            model: commandParams?.chargingStation?.model,
+            vendorName: commandParams?.chargingStation?.vendorName,
+            ...(!Utils.isUndefined(commandParams?.chargingStation?.firmwareVersion) && {
+              firmwareVersion: commandParams.chargingStation?.firmwareVersion,
+            }),
+            ...(!Utils.isUndefined(commandParams?.chargingStation?.serialNumber) && {
+              serialNumber: commandParams.chargingStation?.serialNumber,
             }),
-            ...(!Utils.isUndefined(commandParams?.serialNumber) && {
-              serialNumber: commandParams.serialNumber,
+            ...(!Utils.isUndefined(commandParams?.chargingStation?.modem) && {
+              modem: {
+                ...(!Utils.isUndefined(commandParams?.chargingStation?.modem?.iccid) && {
+                  iccid: commandParams.chargingStation.modem.iccid,
+                }),
+                ...(!Utils.isUndefined(commandParams?.chargingStation?.modem?.imsi) && {
+                  imsi: commandParams.chargingStation.modem.imsi,
+                }),
+              },
             }),
-            modem: {
-              ...(!Utils.isUndefined(commandParams?.modem?.iccid) && {
-                iccid: commandParams.modem.iccid,
-              }),
-              ...(!Utils.isUndefined(commandParams?.modem?.imsi) && {
-                imsi: commandParams.modem.imsi,
-              }),
-            },
           },
         } as unknown as Request;
+      case OCPP20RequestCommand.HEARTBEAT:
+        return {} as unknown as Request;
       default:
         // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError().
         throw new OCPPError(
@@ -122,23 +136,4 @@ export default class OCPP20RequestService extends OCPPRequestService {
         );
     }
   }
-
-  private validatePayload<Request extends JsonType>(
-    chargingStation: ChargingStation,
-    commandName: OCPP20RequestCommand,
-    requestPayload: Request
-  ): boolean {
-    if (this.jsonSchemas.has(commandName)) {
-      return this.validateRequestPayload(
-        chargingStation,
-        commandName,
-        this.jsonSchemas.get(commandName),
-        requestPayload
-      );
-    }
-    logger.warn(
-      `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema found for command ${commandName} PDU validation`
-    );
-    return false;
-  }
 }