Fix firmware update OCPP command handling and simulation

[e-mobility-charging-stations-simulator.git] / src / charging-station / ocpp / 1.6 / OCPP16IncomingRequestService.ts

diff --git a/src/charging-station/ocpp/1.6/OCPP16IncomingRequestService.ts b/src/charging-station/ocpp/1.6/OCPP16IncomingRequestService.ts
index e0ba24d4b467352ff680151590e9c9e012217082..6f089a7029eb78cdcb0705276960a1db345ff0e2 100644 (file)
--- a/src/charging-station/ocpp/1.6/OCPP16IncomingRequestService.ts
+++ b/src/charging-station/ocpp/1.6/OCPP16IncomingRequestService.ts
@@ -78,7 +78,7 @@ import type { OCPPConfigurationKey } from '../../../types/ocpp/Configuration';
 import { ErrorType } from '../../../types/ocpp/ErrorType';
 import { OCPPVersion } from '../../../types/ocpp/OCPPVersion';
 import type { IncomingRequestHandler } from '../../../types/ocpp/Requests';
-import type { DefaultResponse } from '../../../types/ocpp/Responses';
+import type { GenericResponse } from '../../../types/ocpp/Responses';
 import Constants from '../../../utils/Constants';
 import logger from '../../../utils/Logger';
 import Utils from '../../../utils/Utils';
@@ -140,171 +140,85 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
     this.jsonSchemas = new Map<OCPP16IncomingRequestCommand, JSONSchemaType<JsonObject>>([
       [
         OCPP16IncomingRequestCommand.RESET,
-        JSON.parse(
-          fs.readFileSync(
-            path.resolve(
-              path.dirname(fileURLToPath(import.meta.url)),
-              '../../../assets/json-schemas/ocpp/1.6/Reset.json'
-            ),
-            'utf8'
-          )
-        ) as JSONSchemaType<ResetRequest>,
+        this.parseJsonSchemaFile<ResetRequest>('../../../assets/json-schemas/ocpp/1.6/Reset.json'),
       ],
       [
         OCPP16IncomingRequestCommand.CLEAR_CACHE,
-        JSON.parse(
-          fs.readFileSync(
-            path.resolve(
-              path.dirname(fileURLToPath(import.meta.url)),
-              '../../../assets/json-schemas/ocpp/1.6/ClearCache.json'
-            ),
-            'utf8'
-          )
-        ) as JSONSchemaType<OCPP16ClearCacheRequest>,
+        this.parseJsonSchemaFile<OCPP16ClearCacheRequest>(
+          '../../../assets/json-schemas/ocpp/1.6/ClearCache.json'
+        ),
       ],
       [
         OCPP16IncomingRequestCommand.UNLOCK_CONNECTOR,
-        JSON.parse(
-          fs.readFileSync(
-            path.resolve(
-              path.dirname(fileURLToPath(import.meta.url)),
-              '../../../assets/json-schemas/ocpp/1.6/UnlockConnector.json'
-            ),
-            'utf8'
-          )
-        ) as JSONSchemaType<UnlockConnectorRequest>,
+        this.parseJsonSchemaFile<UnlockConnectorRequest>(
+          '../../../assets/json-schemas/ocpp/1.6/UnlockConnector.json'
+        ),
       ],
       [
         OCPP16IncomingRequestCommand.GET_CONFIGURATION,
-        JSON.parse(
-          fs.readFileSync(
-            path.resolve(
-              path.dirname(fileURLToPath(import.meta.url)),
-              '../../../assets/json-schemas/ocpp/1.6/GetConfiguration.json'
-            ),
-            'utf8'
-          )
-        ) as JSONSchemaType<GetConfigurationRequest>,
+        this.parseJsonSchemaFile<GetConfigurationRequest>(
+          '../../../assets/json-schemas/ocpp/1.6/GetConfiguration.json'
+        ),
       ],
       [
         OCPP16IncomingRequestCommand.CHANGE_CONFIGURATION,
-        JSON.parse(
-          fs.readFileSync(
-            path.resolve(
-              path.dirname(fileURLToPath(import.meta.url)),
-              '../../../assets/json-schemas/ocpp/1.6/ChangeConfiguration.json'
-            ),
-            'utf8'
-          )
-        ) as JSONSchemaType<ChangeConfigurationRequest>,
+        this.parseJsonSchemaFile<ChangeConfigurationRequest>(
+          '../../../assets/json-schemas/ocpp/1.6/ChangeConfiguration.json'
+        ),
       ],
       [
         OCPP16IncomingRequestCommand.GET_DIAGNOSTICS,
-        JSON.parse(
-          fs.readFileSync(
-            path.resolve(
-              path.dirname(fileURLToPath(import.meta.url)),
-              '../../../assets/json-schemas/ocpp/1.6/GetDiagnostics.json'
-            ),
-            'utf8'
-          )
-        ) as JSONSchemaType<GetDiagnosticsRequest>,
+        this.parseJsonSchemaFile<GetDiagnosticsRequest>(
+          '../../../assets/json-schemas/ocpp/1.6/GetDiagnostics.json'
+        ),
       ],
       [
         OCPP16IncomingRequestCommand.SET_CHARGING_PROFILE,
-        JSON.parse(
-          fs.readFileSync(
-            path.resolve(
-              path.dirname(fileURLToPath(import.meta.url)),
-              '../../../assets/json-schemas/ocpp/1.6/SetChargingProfile.json'
-            ),
-            'utf8'
-          )
-        ) as JSONSchemaType<SetChargingProfileRequest>,
+        this.parseJsonSchemaFile<SetChargingProfileRequest>(
+          '../../../assets/json-schemas/ocpp/1.6/SetChargingProfile.json'
+        ),
       ],
       [
         OCPP16IncomingRequestCommand.CLEAR_CHARGING_PROFILE,
-        JSON.parse(
-          fs.readFileSync(
-            path.resolve(
-              path.dirname(fileURLToPath(import.meta.url)),
-              '../../../assets/json-schemas/ocpp/1.6/ClearChargingProfile.json'
-            ),
-            'utf8'
-          )
-        ) as JSONSchemaType<ClearChargingProfileRequest>,
+        this.parseJsonSchemaFile<ClearChargingProfileRequest>(
+          '../../../assets/json-schemas/ocpp/1.6/ClearChargingProfile.json'
+        ),
       ],
       [
         OCPP16IncomingRequestCommand.CHANGE_AVAILABILITY,
-        JSON.parse(
-          fs.readFileSync(
-            path.resolve(
-              path.dirname(fileURLToPath(import.meta.url)),
-              '../../../assets/json-schemas/ocpp/1.6/ChangeAvailability.json'
-            ),
-            'utf8'
-          )
-        ) as JSONSchemaType<ChangeAvailabilityRequest>,
+        this.parseJsonSchemaFile<ChangeAvailabilityRequest>(
+          '../../../assets/json-schemas/ocpp/1.6/ChangeAvailability.json'
+        ),
       ],
       [
         OCPP16IncomingRequestCommand.REMOTE_START_TRANSACTION,
-        JSON.parse(
-          fs.readFileSync(
-            path.resolve(
-              path.dirname(fileURLToPath(import.meta.url)),
-              '../../../assets/json-schemas/ocpp/1.6/RemoteStartTransaction.json'
-            ),
-            'utf8'
-          )
-        ) as JSONSchemaType<RemoteStartTransactionRequest>,
+        this.parseJsonSchemaFile<RemoteStartTransactionRequest>(
+          '../../../assets/json-schemas/ocpp/1.6/RemoteStartTransaction.json'
+        ),
       ],
       [
         OCPP16IncomingRequestCommand.REMOTE_STOP_TRANSACTION,
-        JSON.parse(
-          fs.readFileSync(
-            path.resolve(
-              path.dirname(fileURLToPath(import.meta.url)),
-              '../../../assets/json-schemas/ocpp/1.6/RemoteStopTransaction.json'
-            ),
-            'utf8'
-          )
-        ) as JSONSchemaType<RemoteStopTransactionRequest>,
+        this.parseJsonSchemaFile<RemoteStopTransactionRequest>(
+          '../../../assets/json-schemas/ocpp/1.6/RemoteStopTransaction.json'
+        ),
       ],
       [
         OCPP16IncomingRequestCommand.TRIGGER_MESSAGE,
-        JSON.parse(
-          fs.readFileSync(
-            path.resolve(
-              path.dirname(fileURLToPath(import.meta.url)),
-              '../../../assets/json-schemas/ocpp/1.6/TriggerMessage.json'
-            ),
-            'utf8'
-          )
-        ) as JSONSchemaType<OCPP16TriggerMessageRequest>,
+        this.parseJsonSchemaFile<OCPP16TriggerMessageRequest>(
+          '../../../assets/json-schemas/ocpp/1.6/TriggerMessage.json'
+        ),
       ],
       [
         OCPP16IncomingRequestCommand.DATA_TRANSFER,
-        JSON.parse(
-          fs.readFileSync(
-            path.resolve(
-              path.dirname(fileURLToPath(import.meta.url)),
-              '../../../assets/json-schemas/ocpp/1.6/DataTransfer.json'
-            ),
-            'utf8'
-          )
-        ) as JSONSchemaType<OCPP16DataTransferRequest>,
+        this.parseJsonSchemaFile<OCPP16DataTransferRequest>(
+          '../../../assets/json-schemas/ocpp/1.6/DataTransfer.json'
+        ),
       ],
       [
         OCPP16IncomingRequestCommand.UPDATE_FIRMWARE,
-        JSON.parse(
-          fs.readFileSync(
-            path.resolve(
-              path.dirname(fileURLToPath(import.meta.url)),
-              '../../../assets/json-schemas/ocpp/1.6/UpdateFirmware.json'
-            ),
-            'utf8'
-          )
-        ) as JSONSchemaType<OCPP16UpdateFirmwareRequest>,
+        this.parseJsonSchemaFile<OCPP16UpdateFirmwareRequest>(
+          '../../../assets/json-schemas/ocpp/1.6/UpdateFirmware.json'
+        ),
       ],
     ]);
     this.validatePayload.bind(this);
@@ -415,7 +329,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
   private handleRequestReset(
     chargingStation: ChargingStation,
     commandPayload: ResetRequest
-  ): DefaultResponse {
+  ): GenericResponse {
     this.asyncResource
       .runInAsyncScope(
         chargingStation.reset.bind(chargingStation) as (
@@ -438,13 +352,6 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
     return OCPPConstants.OCPP_RESPONSE_ACCEPTED;
   }
 
-  private handleRequestClearCache(chargingStation: ChargingStation): DefaultResponse {
-    chargingStation.authorizedTagsCache.deleteAuthorizedTags(
-      ChargingStationUtils.getAuthorizationFile(chargingStation.stationInfo)
-    );
-    return OCPPConstants.OCPP_RESPONSE_ACCEPTED;
-  }
-
   private async handleRequestUnlockConnector(
     chargingStation: ChargingStation,
     commandPayload: UnlockConnectorRequest
@@ -787,7 +694,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
   private async handleRequestRemoteStartTransaction(
     chargingStation: ChargingStation,
     commandPayload: RemoteStartTransactionRequest
-  ): Promise<DefaultResponse> {
+  ): Promise<GenericResponse> {
     const transactionConnectorId = commandPayload.connectorId;
     if (chargingStation.connectors.has(transactionConnectorId) === true) {
       const remoteStartTransactionLogMsg =
@@ -936,7 +843,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
     chargingStation: ChargingStation,
     connectorId: number,
     idTag: string
-  ): Promise<DefaultResponse> {
+  ): Promise<GenericResponse> {
     if (
       chargingStation.getConnectorStatus(connectorId).status !== OCPP16ChargePointStatus.AVAILABLE
     ) {
@@ -992,7 +899,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
   private async handleRequestRemoteStopTransaction(
     chargingStation: ChargingStation,
     commandPayload: RemoteStopTransactionRequest
-  ): Promise<DefaultResponse> {
+  ): Promise<GenericResponse> {
     const transactionId = commandPayload.transactionId;
     for (const connectorId of chargingStation.connectors.keys()) {
       if (
@@ -1037,6 +944,18 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
         OCPP16IncomingRequestCommand.UPDATE_FIRMWARE
       ) === false
     ) {
+      logger.warn(
+        `${chargingStation.logPrefix()} ${moduleName}.handleRequestUpdateFirmware: Cannot simulate firmware update: feature profile not supported`
+      );
+      return OCPPConstants.OCPP_RESPONSE_EMPTY;
+    }
+    if (
+      !Utils.isNullOrUndefined(chargingStation.stationInfo.firmwareStatus) &&
+      chargingStation.stationInfo.firmwareStatus !== OCPP16FirmwareStatus.Installed
+    ) {
+      logger.warn(
+        `${chargingStation.logPrefix()} ${moduleName}.handleRequestUpdateFirmware: Cannot simulate firmware update: firmware update is already in progress`
+      );
       return OCPPConstants.OCPP_RESPONSE_EMPTY;
     }
     const retrieveDate = Utils.convertToDate(commandPayload.retrieveDate);
@@ -1065,8 +984,8 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
 
   private async updateFirmware(
     chargingStation: ChargingStation,
-    minDelay = 15,
-    maxDelay = 30
+    maxDelay = 30,
+    minDelay = 15
   ): Promise<void> {
     chargingStation.stopAutomaticTransactionGenerator();
     for (const connectorId of chargingStation.connectors.keys()) {
@@ -1082,8 +1001,22 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
           status: OCPP16ChargePointStatus.UNAVAILABLE,
           errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
         });
+        chargingStation.getConnectorStatus(connectorId).status =
+          OCPP16ChargePointStatus.UNAVAILABLE;
       }
     }
+    if (
+      chargingStation.getFirmwareUpgrade()?.failureStatus &&
+      !Utils.isEmptyString(chargingStation.getFirmwareUpgrade().failureStatus)
+    ) {
+      await chargingStation.ocppRequestService.requestHandler<
+        OCPP16FirmwareStatusNotificationRequest,
+        OCPP16FirmwareStatusNotificationResponse
+      >(chargingStation, OCPP16RequestCommand.FIRMWARE_STATUS_NOTIFICATION, {
+        status: chargingStation.getFirmwareUpgrade().failureStatus,
+      });
+      return;
+    }
     await chargingStation.ocppRequestService.requestHandler<
       OCPP16FirmwareStatusNotificationRequest,
       OCPP16FirmwareStatusNotificationResponse
@@ -1091,7 +1024,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
       status: OCPP16FirmwareStatus.Downloading,
     });
     chargingStation.stationInfo.firmwareStatus = OCPP16FirmwareStatus.Downloading;
-    await Utils.sleep(Utils.getRandomInteger(minDelay, maxDelay) * 1000);
+    await Utils.sleep(Utils.getRandomInteger(maxDelay, minDelay) * 1000);
     await chargingStation.ocppRequestService.requestHandler<
       OCPP16FirmwareStatusNotificationRequest,
       OCPP16FirmwareStatusNotificationResponse
@@ -1099,7 +1032,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
       status: OCPP16FirmwareStatus.Downloaded,
     });
     chargingStation.stationInfo.firmwareStatus = OCPP16FirmwareStatus.Downloaded;
-    await Utils.sleep(Utils.getRandomInteger(minDelay, maxDelay) * 1000);
+    await Utils.sleep(Utils.getRandomInteger(maxDelay, minDelay) * 1000);
     await chargingStation.ocppRequestService.requestHandler<
       OCPP16FirmwareStatusNotificationRequest,
       OCPP16FirmwareStatusNotificationResponse
@@ -1107,8 +1040,10 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
       status: OCPP16FirmwareStatus.Installing,
     });
     chargingStation.stationInfo.firmwareStatus = OCPP16FirmwareStatus.Installing;
-    await Utils.sleep(Utils.getRandomInteger(minDelay, maxDelay) * 1000);
-    await chargingStation.reset(OCPP16StopTransactionReason.REBOOT);
+    if (chargingStation.getFirmwareUpgrade().reset === true) {
+      await Utils.sleep(Utils.getRandomInteger(maxDelay, minDelay) * 1000);
+      await chargingStation.reset(OCPP16StopTransactionReason.REBOOT);
+    }
   }
 
   private async handleRequestGetDiagnostics(
@@ -1122,6 +1057,9 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
         OCPP16IncomingRequestCommand.GET_DIAGNOSTICS
       ) === false
     ) {
+      logger.warn(
+        `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetDiagnostics: Cannot get diagnostics: feature profile not supported`
+      );
       return OCPPConstants.OCPP_RESPONSE_EMPTY;
     }
     const uri = new URL(commandPayload.location);
@@ -1364,4 +1302,13 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
       );
     }
   }
+
+  private parseJsonSchemaFile<T extends JsonType>(relativePath: string): JSONSchemaType<T> {
+    return JSON.parse(
+      fs.readFileSync(
+        path.resolve(path.dirname(fileURLToPath(import.meta.url)), relativePath),
+        'utf8'
+      )
+    ) as JSONSchemaType<T>;
+  }
 }