src/charging-station/ocpp/OCPPRequestService.ts

   1 import { AuthorizeResponse, StartTransactionResponse, StopTransactionReason, StopTransactionResponse } from '../../types/ocpp/Transaction';
   2 import { DiagnosticsStatus, IncomingRequestCommand, RequestCommand } from '../../types/ocpp/Requests';
   3
   4 import { BootNotificationResponse } from '../../types/ocpp/Responses';
   5 import { ChargePointErrorCode } from '../../types/ocpp/ChargePointErrorCode';
   6 import { ChargePointStatus } from '../../types/ocpp/ChargePointStatus';
   7 import ChargingStation from '../ChargingStation';
   8 import Constants from '../../utils/Constants';
   9 import { ErrorType } from '../../types/ocpp/ErrorType';
  10 import { MessageType } from '../../types/ocpp/MessageType';
  11 import { MeterValue } from '../../types/ocpp/MeterValues';
  12 import OCPPError from '../OcppError';
  13 import OCPPResponseService from './OCPPResponseService';
  14 import logger from '../../utils/Logger';
  15
  16 export default abstract class OCPPRequestService {
  17   public chargingStation: ChargingStation;
  18   protected ocppResponseService: OCPPResponseService;
  19
  20   constructor(chargingStation: ChargingStation, ocppResponseService: OCPPResponseService) {
  21     this.chargingStation = chargingStation;
  22     this.ocppResponseService = ocppResponseService;
  23   }
  24
  25   public async sendMessage(messageId: string, commandParams: any, messageType: MessageType, commandName: RequestCommand | IncomingRequestCommand): Promise<any> {
  26     // eslint-disable-next-line @typescript-eslint/no-this-alias
  27     const self = this;
  28     // Send a message through wsConnection
  29     return new Promise((resolve: (value?: any | PromiseLike<any>) => void, reject: (reason?: any) => void) => {
  30       let messageToSend: string;
  31       // Type of message
  32       switch (messageType) {
  33         // Request
  34         case MessageType.CALL_MESSAGE:
  35           // Build request
  36           this.chargingStation.requests[messageId] = [responseCallback, rejectCallback, commandParams as Record<string, unknown>];
  37           messageToSend = JSON.stringify([messageType, messageId, commandName, commandParams]);
  38           break;
  39         // Response
  40         case MessageType.CALL_RESULT_MESSAGE:
  41           // Build response
  42           messageToSend = JSON.stringify([messageType, messageId, commandParams]);
  43           break;
  44         // Error Message
  45         case MessageType.CALL_ERROR_MESSAGE:
  46           // Build Error Message
  47           messageToSend = JSON.stringify([messageType, messageId, commandParams.code ? commandParams.code : ErrorType.GENERIC_ERROR, commandParams.message ? commandParams.message : '', commandParams.details ? commandParams.details : {}]);
  48           break;
  49       }
  50       // Check if wsConnection opened and charging station registered
  51       if (this.chargingStation.isWebSocketOpen() && (this.chargingStation.isRegistered() || commandName === RequestCommand.BOOT_NOTIFICATION)) {
  52         if (this.chargingStation.getEnableStatistics()) {
  53           this.chargingStation.performanceStatistics.addMessage(commandName, messageType);
  54         }
  55         // Yes: Send Message
  56         this.chargingStation.wsConnection.send(messageToSend);
  57       } else if (commandName !== RequestCommand.BOOT_NOTIFICATION) {
  58         // Buffer it
  59         this.chargingStation.addToMessageQueue(messageToSend);
  60         // Reject it
  61         return rejectCallback(new OCPPError(commandParams.code ? commandParams.code : ErrorType.GENERIC_ERROR, commandParams.message ? commandParams.message : `WebSocket closed for message id '${messageId}' with content '${messageToSend}', message buffered`, commandParams.details ? commandParams.details : {}));
  62       }
  63       // Response?
  64       if (messageType === MessageType.CALL_RESULT_MESSAGE) {
  65         // Yes: send Ok
  66         resolve();
  67       } else if (messageType === MessageType.CALL_ERROR_MESSAGE) {
  68         // Send timeout
  69         setTimeout(() => rejectCallback(new OCPPError(commandParams.code ? commandParams.code : ErrorType.GENERIC_ERROR, commandParams.message ? commandParams.message : `Timeout for message id '${messageId}' with content '${messageToSend}'`, commandParams.details ? commandParams.details : {})), Constants.OCPP_ERROR_TIMEOUT);
  70       }
  71
  72       /**
  73        * Function that will receive the request's response
  74        *
  75        * @param {Record<string, unknown> | string} payload
  76        * @param {Record<string, unknown>} requestPayload
  77        */
  78       async function responseCallback(payload: Record<string, unknown> | string, requestPayload: Record<string, unknown>): Promise<void> {
  79         if (self.chargingStation.getEnableStatistics()) {
  80           self.chargingStation.performanceStatistics.addMessage(commandName, MessageType.CALL_RESULT_MESSAGE);
  81         }
  82         // Send the response
  83         await self.ocppResponseService.handleResponse(commandName as RequestCommand, payload, requestPayload);
  84         resolve(payload);
  85       }
  86
  87       /**
  88        * Function that will receive the request's rejection
  89        *
  90        * @param {OCPPError} error
  91        */
  92       function rejectCallback(error: OCPPError): void {
  93         if (self.chargingStation.getEnableStatistics()) {
  94           self.chargingStation.performanceStatistics.addMessage(commandName, MessageType.CALL_ERROR_MESSAGE);
  95         }
  96         logger.debug(`${self.chargingStation.logPrefix()} Error: %j occurred when calling command %s with parameters: %j`, error, commandName, commandParams);
  97         // Build Exception
  98         // eslint-disable-next-line no-empty-function
  99         self.chargingStation.requests[messageId] = [() => { }, () => { }, {}];
 100         // Send error
 101         reject(error);
 102       }
 103     });
 104   }
 105
 106   public handleRequestError(commandName: RequestCommand, error: Error): void {
 107     logger.error(this.chargingStation.logPrefix() + ' Request command ' + commandName + ' error: %j', error);
 108     throw error;
 109   }
 110
 111   public abstract sendHeartbeat(): Promise<void>;
 112   public abstract sendBootNotification(chargePointModel: string, chargePointVendor: string, chargeBoxSerialNumber?: string, firmwareVersion?: string, chargePointSerialNumber?: string, iccid?: string, imsi?: string, meterSerialNumber?: string, meterType?: string): Promise<BootNotificationResponse>;
 113   public abstract sendStatusNotification(connectorId: number, status: ChargePointStatus, errorCode?: ChargePointErrorCode): Promise<void>;
 114   public abstract sendAuthorize(connectorId: number, idTag?: string): Promise<AuthorizeResponse>;
 115   public abstract sendStartTransaction(connectorId: number, idTag?: string): Promise<StartTransactionResponse>;
 116   public abstract sendStopTransaction(transactionId: number, meterStop: number, idTag?: string, reason?: StopTransactionReason): Promise<StopTransactionResponse>;
 117   public abstract sendMeterValues(connectorId: number, transactionId: number, interval: number, self: OCPPRequestService): Promise<void>;
 118   public abstract sendTransactionBeginMeterValues(connectorId: number, transactionId: number, beginMeterValue: MeterValue): Promise<void>;
 119   public abstract sendTransactionEndMeterValues(connectorId: number, transactionId: number, endMeterValue: MeterValue): Promise<void>;
 120   public abstract sendDiagnosticsStatusNotification(diagnosticsStatus: DiagnosticsStatus): Promise<void>;
 121   public abstract sendError(messageId: string, error: OCPPError, commandName: RequestCommand | IncomingRequestCommand): Promise<unknown>;
 122 }