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

   1 // Partial Copyright Jerome Benoit. 2021. 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   DiagnosticsStatusNotificationRequest,
  14   OCPP16BootNotificationRequest,
  15   OCPP16DataTransferRequest,
  16   OCPP16HeartbeatRequest,
  17   OCPP16RequestCommand,
  18   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 type { RequestParams } from '../../../types/ocpp/Requests';
  27 import Constants from '../../../utils/Constants';
  28 import logger from '../../../utils/Logger';
  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   private 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(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     this.validatePayload.bind(this);
 157   }
 158
 159   public async requestHandler<RequestType extends JsonType, ResponseType extends JsonType>(
 160     chargingStation: ChargingStation,
 161     commandName: OCPP16RequestCommand,
 162     commandParams?: JsonType,
 163     params?: RequestParams
 164   ): Promise<ResponseType> {
 165     if (OCPP16ServiceUtils.isRequestCommandSupported(chargingStation, commandName) === true) {
 166       const requestPayload = this.buildRequestPayload<RequestType>(
 167         chargingStation,
 168         commandName,
 169         commandParams
 170       );
 171       this.validatePayload(chargingStation, commandName, requestPayload);
 172       return (await this.sendMessage(
 173         chargingStation,
 174         Utils.generateUUID(),
 175         requestPayload,
 176         commandName,
 177         params
 178       )) as unknown as ResponseType;
 179     }
 180     // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError().
 181     throw new OCPPError(
 182       ErrorType.NOT_SUPPORTED,
 183       `Unsupported OCPP command '${commandName}'`,
 184       commandName,
 185       commandParams
 186     );
 187   }
 188
 189   private buildRequestPayload<Request extends JsonType>(
 190     chargingStation: ChargingStation,
 191     commandName: OCPP16RequestCommand,
 192     commandParams?: JsonType
 193   ): Request {
 194     let connectorId: number;
 195     let energyActiveImportRegister: number;
 196     commandParams = commandParams as JsonObject;
 197     switch (commandName) {
 198       case OCPP16RequestCommand.AUTHORIZE:
 199         return {
 200           ...(!Utils.isUndefined(commandParams?.idTag)
 201             ? { idTag: commandParams.idTag }
 202             : { idTag: Constants.DEFAULT_IDTAG }),
 203         } as unknown as Request;
 204       case OCPP16RequestCommand.BOOT_NOTIFICATION:
 205         return {
 206           chargePointModel: commandParams?.chargePointModel,
 207           chargePointVendor: commandParams?.chargePointVendor,
 208           ...(!Utils.isUndefined(commandParams?.chargeBoxSerialNumber) && {
 209             chargeBoxSerialNumber: commandParams.chargeBoxSerialNumber,
 210           }),
 211           ...(!Utils.isUndefined(commandParams?.chargePointSerialNumber) && {
 212             chargePointSerialNumber: commandParams.chargePointSerialNumber,
 213           }),
 214           ...(!Utils.isUndefined(commandParams?.firmwareVersion) && {
 215             firmwareVersion: commandParams.firmwareVersion,
 216           }),
 217           ...(!Utils.isUndefined(commandParams?.iccid) && { iccid: commandParams.iccid }),
 218           ...(!Utils.isUndefined(commandParams?.imsi) && { imsi: commandParams.imsi }),
 219           ...(!Utils.isUndefined(commandParams?.meterSerialNumber) && {
 220             meterSerialNumber: commandParams.meterSerialNumber,
 221           }),
 222           ...(!Utils.isUndefined(commandParams?.meterType) && {
 223             meterType: commandParams.meterType,
 224           }),
 225         } as unknown as Request;
 226       case OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION:
 227         return {
 228           status: commandParams?.diagnosticsStatus,
 229         } as unknown as Request;
 230       case OCPP16RequestCommand.HEARTBEAT:
 231         return {} as unknown as Request;
 232       case OCPP16RequestCommand.METER_VALUES:
 233         return {
 234           connectorId: commandParams?.connectorId,
 235           transactionId: commandParams?.transactionId,
 236           meterValue: commandParams?.meterValue,
 237         } as unknown as Request;
 238       case OCPP16RequestCommand.STATUS_NOTIFICATION:
 239         return {
 240           connectorId: commandParams?.connectorId,
 241           status: commandParams?.status,
 242           errorCode: commandParams?.errorCode,
 243         } as unknown as Request;
 244       case OCPP16RequestCommand.START_TRANSACTION:
 245         return {
 246           connectorId: commandParams?.connectorId,
 247           ...(!Utils.isUndefined(commandParams?.idTag)
 248             ? { idTag: commandParams?.idTag }
 249             : { idTag: Constants.DEFAULT_IDTAG }),
 250           meterStart: chargingStation.getEnergyActiveImportRegisterByConnectorId(
 251             commandParams?.connectorId as number
 252           ),
 253           timestamp: new Date().toISOString(),
 254         } as unknown as Request;
 255       case OCPP16RequestCommand.STOP_TRANSACTION:
 256         connectorId = chargingStation.getConnectorIdByTransactionId(
 257           commandParams?.transactionId as number
 258         );
 259         commandParams?.meterStop &&
 260           (energyActiveImportRegister =
 261             chargingStation.getEnergyActiveImportRegisterByTransactionId(
 262               commandParams?.transactionId as number,
 263               true
 264             ));
 265         return {
 266           transactionId: commandParams?.transactionId,
 267           idTag:
 268             commandParams?.idTag ??
 269             chargingStation.getTransactionIdTag(commandParams?.transactionId as number),
 270           meterStop: commandParams?.meterStop ?? energyActiveImportRegister,
 271           timestamp: new Date().toISOString(),
 272           reason: commandParams?.reason,
 273           ...(chargingStation.getTransactionDataMeterValues() && {
 274             transactionData: OCPP16ServiceUtils.buildTransactionDataMeterValues(
 275               chargingStation.getConnectorStatus(connectorId).transactionBeginMeterValue,
 276               OCPP16ServiceUtils.buildTransactionEndMeterValue(
 277                 chargingStation,
 278                 connectorId,
 279                 (commandParams?.meterStop as number) ?? energyActiveImportRegister
 280               )
 281             ),
 282           }),
 283         } as unknown as Request;
 284       case OCPP16RequestCommand.DATA_TRANSFER:
 285         return commandParams as unknown as Request;
 286       default:
 287         // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError().
 288         throw new OCPPError(
 289           ErrorType.NOT_SUPPORTED,
 290           // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
 291           `Unsupported OCPP command '${commandName}'`,
 292           commandName,
 293           commandParams
 294         );
 295     }
 296   }
 297
 298   private validatePayload<Request extends JsonType>(
 299     chargingStation: ChargingStation,
 300     commandName: OCPP16RequestCommand,
 301     requestPayload: Request
 302   ): boolean {
 303     if (this.jsonSchemas.has(commandName)) {
 304       return this.validateRequestPayload(
 305         chargingStation,
 306         commandName,
 307         this.jsonSchemas.get(commandName),
 308         requestPayload
 309       );
 310     }
 311     logger.warn(
 312       `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema found for command ${commandName} PDU validation`
 313     );
 314     return false;
 315   }
 316 }