src/charging-station/ocpp/1.6/OCPP16RequestService.ts

   1 // Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
   2
   3 import fs from 'fs';
   4 import path from 'path';
   5 import { fileURLToPath } from 'url';
   6
   7 import type { JSONSchemaType } from 'ajv';
   8
   9 import OCPPError from '../../../exception/OCPPError';
  10 import type { JsonObject, JsonType } from '../../../types/JsonType';
  11 import type { OCPP16MeterValuesRequest } from '../../../types/ocpp/1.6/MeterValues';
  12 import {
  13   type DiagnosticsStatusNotificationRequest,
  14   type OCPP16BootNotificationRequest,
  15   type OCPP16DataTransferRequest,
  16   type OCPP16HeartbeatRequest,
  17   OCPP16RequestCommand,
  18   type OCPP16StatusNotificationRequest,
  19 } from '../../../types/ocpp/1.6/Requests';
  20 import type {
  21   OCPP16AuthorizeRequest,
  22   OCPP16StartTransactionRequest,
  23   OCPP16StopTransactionRequest,
  24 } from '../../../types/ocpp/1.6/Transaction';
  25 import { ErrorType } from '../../../types/ocpp/ErrorType';
  26 import { OCPPVersion } from '../../../types/ocpp/OCPPVersion';
  27 import type { RequestParams } from '../../../types/ocpp/Requests';
  28 import Constants from '../../../utils/Constants';
  29 import Utils from '../../../utils/Utils';
  30 import type ChargingStation from '../../ChargingStation';
  31 import OCPPRequestService from '../OCPPRequestService';
  32 import type OCPPResponseService from '../OCPPResponseService';
  33 import { OCPP16ServiceUtils } from './OCPP16ServiceUtils';
  34
  35 const moduleName = 'OCPP16RequestService';
  36
  37 export default class OCPP16RequestService extends OCPPRequestService {
  38   protected jsonSchemas: Map<OCPP16RequestCommand, JSONSchemaType<JsonObject>>;
  39
  40   public constructor(ocppResponseService: OCPPResponseService) {
  41     if (new.target?.name === moduleName) {
  42       throw new TypeError(`Cannot construct ${new.target?.name} instances directly`);
  43     }
  44     super(OCPPVersion.VERSION_16, ocppResponseService);
  45     this.jsonSchemas = new Map<OCPP16RequestCommand, JSONSchemaType<JsonObject>>([
  46       [
  47         OCPP16RequestCommand.AUTHORIZE,
  48         JSON.parse(
  49           fs.readFileSync(
  50             path.resolve(
  51               path.dirname(fileURLToPath(import.meta.url)),
  52               '../../../assets/json-schemas/ocpp/1.6/Authorize.json'
  53             ),
  54             'utf8'
  55           )
  56         ) as JSONSchemaType<OCPP16AuthorizeRequest>,
  57       ],
  58       [
  59         OCPP16RequestCommand.BOOT_NOTIFICATION,
  60         JSON.parse(
  61           fs.readFileSync(
  62             path.resolve(
  63               path.dirname(fileURLToPath(import.meta.url)),
  64               '../../../assets/json-schemas/ocpp/1.6/BootNotification.json'
  65             ),
  66             'utf8'
  67           )
  68         ) as JSONSchemaType<OCPP16BootNotificationRequest>,
  69       ],
  70       [
  71         OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION,
  72         JSON.parse(
  73           fs.readFileSync(
  74             path.resolve(
  75               path.dirname(fileURLToPath(import.meta.url)),
  76               '../../../assets/json-schemas/ocpp/1.6/DiagnosticsStatusNotification.json'
  77             ),
  78             'utf8'
  79           )
  80         ) as JSONSchemaType<DiagnosticsStatusNotificationRequest>,
  81       ],
  82       [
  83         OCPP16RequestCommand.HEARTBEAT,
  84         JSON.parse(
  85           fs.readFileSync(
  86             path.resolve(
  87               path.dirname(fileURLToPath(import.meta.url)),
  88               '../../../assets/json-schemas/ocpp/1.6/Heartbeat.json'
  89             ),
  90             'utf8'
  91           )
  92         ) as JSONSchemaType<OCPP16HeartbeatRequest>,
  93       ],
  94       [
  95         OCPP16RequestCommand.METER_VALUES,
  96         JSON.parse(
  97           fs.readFileSync(
  98             path.resolve(
  99               path.dirname(fileURLToPath(import.meta.url)),
 100               '../../../assets/json-schemas/ocpp/1.6/MeterValues.json'
 101             ),
 102             'utf8'
 103           )
 104         ) as JSONSchemaType<OCPP16MeterValuesRequest>,
 105       ],
 106       [
 107         OCPP16RequestCommand.STATUS_NOTIFICATION,
 108         JSON.parse(
 109           fs.readFileSync(
 110             path.resolve(
 111               path.dirname(fileURLToPath(import.meta.url)),
 112               '../../../assets/json-schemas/ocpp/1.6/StatusNotification.json'
 113             ),
 114             'utf8'
 115           )
 116         ) as JSONSchemaType<OCPP16StatusNotificationRequest>,
 117       ],
 118       [
 119         OCPP16RequestCommand.START_TRANSACTION,
 120         JSON.parse(
 121           fs.readFileSync(
 122             path.resolve(
 123               path.dirname(fileURLToPath(import.meta.url)),
 124               '../../../assets/json-schemas/ocpp/1.6/StartTransaction.json'
 125             ),
 126             'utf8'
 127           )
 128         ) as JSONSchemaType<OCPP16StartTransactionRequest>,
 129       ],
 130       [
 131         OCPP16RequestCommand.STOP_TRANSACTION,
 132         JSON.parse(
 133           fs.readFileSync(
 134             path.resolve(
 135               path.dirname(fileURLToPath(import.meta.url)),
 136               '../../../assets/json-schemas/ocpp/1.6/StopTransaction.json'
 137             ),
 138             'utf8'
 139           )
 140         ) as JSONSchemaType<OCPP16StopTransactionRequest>,
 141       ],
 142       [
 143         OCPP16RequestCommand.DATA_TRANSFER,
 144         JSON.parse(
 145           fs.readFileSync(
 146             path.resolve(
 147               path.dirname(fileURLToPath(import.meta.url)),
 148               '../../../assets/json-schemas/ocpp/1.6/DataTransfer.json'
 149             ),
 150             'utf8'
 151           )
 152         ) as JSONSchemaType<OCPP16DataTransferRequest>,
 153       ],
 154     ]);
 155     this.buildRequestPayload.bind(this);
 156   }
 157
 158   public async requestHandler<RequestType extends JsonType, ResponseType extends JsonType>(
 159     chargingStation: ChargingStation,
 160     commandName: OCPP16RequestCommand,
 161     commandParams?: JsonType,
 162     params?: RequestParams
 163   ): Promise<ResponseType> {
 164     if (OCPP16ServiceUtils.isRequestCommandSupported(chargingStation, commandName) === true) {
 165       const requestPayload = this.buildRequestPayload<RequestType>(
 166         chargingStation,
 167         commandName,
 168         commandParams
 169       );
 170       return (await this.sendMessage(
 171         chargingStation,
 172         Utils.generateUUID(),
 173         requestPayload,
 174         commandName,
 175         params
 176       )) as unknown as ResponseType;
 177     }
 178     // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError().
 179     throw new OCPPError(
 180       ErrorType.NOT_SUPPORTED,
 181       `Unsupported OCPP command '${commandName}'`,
 182       commandName,
 183       commandParams
 184     );
 185   }
 186
 187   private buildRequestPayload<Request extends JsonType>(
 188     chargingStation: ChargingStation,
 189     commandName: OCPP16RequestCommand,
 190     commandParams?: JsonType
 191   ): Request {
 192     let connectorId: number;
 193     let energyActiveImportRegister: number;
 194     commandParams = commandParams as JsonObject;
 195     switch (commandName) {
 196       case OCPP16RequestCommand.AUTHORIZE:
 197         return {
 198           ...(!Utils.isUndefined(commandParams?.idTag)
 199             ? { idTag: commandParams.idTag }
 200             : { idTag: Constants.DEFAULT_IDTAG }),
 201         } as unknown as Request;
 202       case OCPP16RequestCommand.BOOT_NOTIFICATION:
 203         return {
 204           chargePointModel: commandParams?.chargePointModel,
 205           chargePointVendor: commandParams?.chargePointVendor,
 206           ...(!Utils.isUndefined(commandParams?.chargeBoxSerialNumber) && {
 207             chargeBoxSerialNumber: commandParams.chargeBoxSerialNumber,
 208           }),
 209           ...(!Utils.isUndefined(commandParams?.chargePointSerialNumber) && {
 210             chargePointSerialNumber: commandParams.chargePointSerialNumber,
 211           }),
 212           ...(!Utils.isUndefined(commandParams?.firmwareVersion) && {
 213             firmwareVersion: commandParams.firmwareVersion,
 214           }),
 215           ...(!Utils.isUndefined(commandParams?.iccid) && { iccid: commandParams.iccid }),
 216           ...(!Utils.isUndefined(commandParams?.imsi) && { imsi: commandParams.imsi }),
 217           ...(!Utils.isUndefined(commandParams?.meterSerialNumber) && {
 218             meterSerialNumber: commandParams.meterSerialNumber,
 219           }),
 220           ...(!Utils.isUndefined(commandParams?.meterType) && {
 221             meterType: commandParams.meterType,
 222           }),
 223         } as unknown as Request;
 224       case OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION:
 225         return {
 226           status: commandParams?.diagnosticsStatus,
 227         } as unknown as Request;
 228       case OCPP16RequestCommand.HEARTBEAT:
 229         return {} as unknown as Request;
 230       case OCPP16RequestCommand.METER_VALUES:
 231         return {
 232           connectorId: commandParams?.connectorId,
 233           transactionId: commandParams?.transactionId,
 234           meterValue: commandParams?.meterValue,
 235         } as unknown as Request;
 236       case OCPP16RequestCommand.STATUS_NOTIFICATION:
 237         return {
 238           connectorId: commandParams?.connectorId,
 239           status: commandParams?.status,
 240           errorCode: commandParams?.errorCode,
 241         } as unknown as Request;
 242       case OCPP16RequestCommand.START_TRANSACTION:
 243         return {
 244           connectorId: commandParams?.connectorId,
 245           ...(!Utils.isUndefined(commandParams?.idTag)
 246             ? { idTag: commandParams?.idTag }
 247             : { idTag: Constants.DEFAULT_IDTAG }),
 248           meterStart: chargingStation.getEnergyActiveImportRegisterByConnectorId(
 249             commandParams?.connectorId as number
 250           ),
 251           timestamp: new Date(),
 252         } as unknown as Request;
 253       case OCPP16RequestCommand.STOP_TRANSACTION:
 254         connectorId = chargingStation.getConnectorIdByTransactionId(
 255           commandParams?.transactionId as number
 256         );
 257         commandParams?.meterStop &&
 258           (energyActiveImportRegister =
 259             chargingStation.getEnergyActiveImportRegisterByTransactionId(
 260               commandParams?.transactionId as number,
 261               true
 262             ));
 263         return {
 264           transactionId: commandParams?.transactionId,
 265           idTag:
 266             commandParams?.idTag ??
 267             chargingStation.getTransactionIdTag(commandParams?.transactionId as number),
 268           meterStop: commandParams?.meterStop ?? energyActiveImportRegister,
 269           timestamp: new Date(),
 270           reason: commandParams?.reason,
 271           ...(chargingStation.getTransactionDataMeterValues() && {
 272             transactionData: OCPP16ServiceUtils.buildTransactionDataMeterValues(
 273               chargingStation.getConnectorStatus(connectorId).transactionBeginMeterValue,
 274               OCPP16ServiceUtils.buildTransactionEndMeterValue(
 275                 chargingStation,
 276                 connectorId,
 277                 (commandParams?.meterStop as number) ?? energyActiveImportRegister
 278               )
 279             ),
 280           }),
 281         } as unknown as Request;
 282       case OCPP16RequestCommand.DATA_TRANSFER:
 283         return commandParams as unknown as Request;
 284       default:
 285         // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError().
 286         throw new OCPPError(
 287           ErrorType.NOT_SUPPORTED,
 288           // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
 289           `Unsupported OCPP command '${commandName}'`,
 290           commandName,
 291           commandParams
 292         );
 293     }
 294   }
 295 }