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