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

   1 // Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
   2
   3 import { AuthorizeRequest, OCPP16AuthorizationStatus, OCPP16AuthorizeResponse, OCPP16StartTransactionResponse, OCPP16StopTransactionResponse, StartTransactionRequest, StopTransactionRequest } from '../../../types/ocpp/1.6/Transaction';
   4 import { HeartbeatRequest, OCPP16RequestCommand, StatusNotificationRequest } from '../../../types/ocpp/1.6/Requests';
   5 import { HeartbeatResponse, OCPP16BootNotificationResponse, OCPP16RegistrationStatus, StatusNotificationResponse } from '../../../types/ocpp/1.6/Responses';
   6 import { MeterValuesRequest, MeterValuesResponse } from '../../../types/ocpp/1.6/MeterValues';
   7
   8 import ChargingStation from '../../ChargingStation';
   9 import { OCPP16ChargePointStatus } from '../../../types/ocpp/1.6/ChargePointStatus';
  10 import { OCPP16ServiceUtils } from './OCPP16ServiceUtils';
  11 import { OCPP16StandardParametersKey } from '../../../types/ocpp/1.6/Configuration';
  12 import OCPPResponseService from '../OCPPResponseService';
  13 import { ResponseHandler } from '../../../types/ocpp/Responses';
  14 import Utils from '../../../utils/Utils';
  15 import logger from '../../../utils/Logger';
  16
  17 export default class OCPP16ResponseService extends OCPPResponseService {
  18   private responseHandlers: Map<OCPP16RequestCommand, ResponseHandler>;
  19
  20   constructor(chargingStation: ChargingStation) {
  21     super(chargingStation);
  22     this.responseHandlers = new Map<OCPP16RequestCommand, ResponseHandler>([
  23       [OCPP16RequestCommand.BOOT_NOTIFICATION, this.handleResponseBootNotification.bind(this)],
  24       [OCPP16RequestCommand.HEARTBEAT, this.handleResponseHeartbeat.bind(this)],
  25       [OCPP16RequestCommand.AUTHORIZE, this.handleResponseAuthorize.bind(this)],
  26       [OCPP16RequestCommand.START_TRANSACTION, this.handleResponseStartTransaction.bind(this)],
  27       [OCPP16RequestCommand.STOP_TRANSACTION, this.handleResponseStopTransaction.bind(this)],
  28       [OCPP16RequestCommand.STATUS_NOTIFICATION, this.handleResponseStatusNotification.bind(this)],
  29       [OCPP16RequestCommand.METER_VALUES, this.handleResponseMeterValues.bind(this)]
  30     ]);
  31   }
  32
  33   public async handleResponse(commandName: OCPP16RequestCommand, payload: Record<string, unknown> | string, requestPayload: Record<string, unknown>): Promise<void> {
  34     if (this.responseHandlers.has(commandName)) {
  35       try {
  36         await this.responseHandlers.get(commandName)(payload, requestPayload);
  37       } catch (error) {
  38         logger.error(this.chargingStation.logPrefix() + ' Handle request response error: %j', error);
  39       }
  40     } else {
  41       logger.error(`${this.chargingStation.logPrefix()} %s is not implemented to handle request response payload %j`, commandName, payload);
  42     }
  43   }
  44
  45   private handleResponseBootNotification(payload: OCPP16BootNotificationResponse): void {
  46     if (payload.status === OCPP16RegistrationStatus.ACCEPTED) {
  47       this.chargingStation.addConfigurationKey(OCPP16StandardParametersKey.HeartBeatInterval, payload.interval.toString());
  48       this.chargingStation.addConfigurationKey(OCPP16StandardParametersKey.HeartbeatInterval, payload.interval.toString(), false, false);
  49       this.chargingStation.heartbeatSetInterval ? this.chargingStation.restartHeartbeat() : this.chargingStation.startHeartbeat();
  50     } else if (payload.status === OCPP16RegistrationStatus.PENDING) {
  51       logger.info(this.chargingStation.logPrefix() + ' Charging station in pending state on the central server');
  52     } else {
  53       logger.warn(this.chargingStation.logPrefix() + ' Charging station rejected by the central server');
  54     }
  55   }
  56
  57   private handleResponseHeartbeat(payload: HeartbeatResponse, requestPayload: HeartbeatRequest): void {
  58     logger.debug(this.chargingStation.logPrefix() + ' Heartbeat response received: %j to Heartbeat request: %j', payload, requestPayload);
  59   }
  60
  61   private handleResponseAuthorize(payload: OCPP16AuthorizeResponse, requestPayload: AuthorizeRequest): void {
  62     let authorizeConnectorId: number;
  63     for (const connectorId of this.chargingStation.connectors.keys()) {
  64       if (connectorId > 0 && this.chargingStation.getConnectorStatus(connectorId)?.authorizeIdTag === requestPayload.idTag) {
  65         authorizeConnectorId = connectorId;
  66         break;
  67       }
  68     }
  69     if (payload.idTagInfo.status === OCPP16AuthorizationStatus.ACCEPTED) {
  70       this.chargingStation.getConnectorStatus(authorizeConnectorId).idTagAuthorized = true;
  71       logger.debug(`${this.chargingStation.logPrefix()} IdTag ${requestPayload.idTag} authorized on connector ${authorizeConnectorId}`);
  72     } else {
  73       this.chargingStation.getConnectorStatus(authorizeConnectorId).idTagAuthorized = false;
  74       delete this.chargingStation.getConnectorStatus(authorizeConnectorId).authorizeIdTag;
  75       logger.debug(`${this.chargingStation.logPrefix()} IdTag ${requestPayload.idTag} refused with status ${payload.idTagInfo.status} on connector ${authorizeConnectorId}`);
  76     }
  77   }
  78
  79   private async handleResponseStartTransaction(payload: OCPP16StartTransactionResponse, requestPayload: StartTransactionRequest): Promise<void> {
  80     const connectorId = requestPayload.connectorId;
  81
  82     let transactionConnectorId: number;
  83     for (const id of this.chargingStation.connectors.keys()) {
  84       if (id > 0 && id === connectorId) {
  85         transactionConnectorId = id;
  86         break;
  87       }
  88     }
  89     if (!transactionConnectorId) {
  90       logger.error(this.chargingStation.logPrefix() + ' Trying to start a transaction on a non existing connector Id ' + connectorId.toString());
  91       return;
  92     }
  93     if (this.chargingStation.getConnectorStatus(connectorId).transactionRemoteStarted && this.chargingStation.getAuthorizeRemoteTxRequests()
  94       && this.chargingStation.getLocalAuthListEnabled() && this.chargingStation.hasAuthorizedTags() && !this.chargingStation.getConnectorStatus(connectorId).idTagLocalAuthorized) {
  95       logger.error(this.chargingStation.logPrefix() + ' Trying to start a transaction with a not local authorized idTag ' + this.chargingStation.getConnectorStatus(connectorId).localAuthorizeIdTag + ' on connector Id ' + connectorId.toString());
  96       await this.resetConnectorOnStartTransactionError(connectorId);
  97       return;
  98     }
  99     if (this.chargingStation.getConnectorStatus(connectorId).transactionRemoteStarted && this.chargingStation.getAuthorizeRemoteTxRequests()
 100       && this.chargingStation.getMayAuthorizeAtRemoteStart() && !this.chargingStation.getConnectorStatus(connectorId).idTagLocalAuthorized
 101       && !this.chargingStation.getConnectorStatus(connectorId).idTagAuthorized) {
 102       logger.error(this.chargingStation.logPrefix() + ' Trying to start a transaction with a not authorized idTag ' + this.chargingStation.getConnectorStatus(connectorId).authorizeIdTag + ' on connector Id ' + connectorId.toString());
 103       await this.resetConnectorOnStartTransactionError(connectorId);
 104       return;
 105     }
 106     if (this.chargingStation.getConnectorStatus(connectorId).idTagAuthorized && this.chargingStation.getConnectorStatus(connectorId).authorizeIdTag !== requestPayload.idTag) {
 107       logger.error(this.chargingStation.logPrefix() + ' Trying to start a transaction with an idTag ' + requestPayload.idTag + ' different from the authorize request one ' + this.chargingStation.getConnectorStatus(connectorId).authorizeIdTag + ' on connector Id ' + connectorId.toString());
 108       await this.resetConnectorOnStartTransactionError(connectorId);
 109       return;
 110     }
 111     if (this.chargingStation.getConnectorStatus(connectorId).idTagLocalAuthorized
 112       && this.chargingStation.getConnectorStatus(connectorId).localAuthorizeIdTag !== requestPayload.idTag) {
 113       logger.error(this.chargingStation.logPrefix() + ' Trying to start a transaction with an idTag ' + requestPayload.idTag + ' different from the local authorized one ' + this.chargingStation.getConnectorStatus(connectorId).localAuthorizeIdTag + ' on connector Id ' + connectorId.toString());
 114       await this.resetConnectorOnStartTransactionError(connectorId);
 115       return;
 116     }
 117     if (this.chargingStation.getConnectorStatus(connectorId)?.transactionStarted) {
 118       logger.debug(this.chargingStation.logPrefix() + ' Trying to start a transaction on an already used connector ' + connectorId.toString() + ': %j', this.chargingStation.getConnectorStatus(connectorId));
 119       return;
 120     }
 121     if (this.chargingStation.getConnectorStatus(connectorId)?.status !== OCPP16ChargePointStatus.AVAILABLE
 122       && this.chargingStation.getConnectorStatus(connectorId)?.status !== OCPP16ChargePointStatus.PREPARING) {
 123       logger.error(`${this.chargingStation.logPrefix()} Trying to start a transaction on connector ${connectorId.toString()} with status ${this.chargingStation.getConnectorStatus(connectorId)?.status}`);
 124       return;
 125     }
 126     if (!Number.isInteger(payload.transactionId)) {
 127       logger.warn(`${this.chargingStation.logPrefix()} Trying to start a transaction on connector ${connectorId.toString()} with a non integer transaction Id ${payload.transactionId}, converting to integer`);
 128       payload.transactionId = Utils.convertToInt(payload.transactionId);
 129     }
 130
 131     if (payload.idTagInfo?.status === OCPP16AuthorizationStatus.ACCEPTED) {
 132       this.chargingStation.getConnectorStatus(connectorId).transactionStarted = true;
 133       this.chargingStation.getConnectorStatus(connectorId).transactionId = payload.transactionId;
 134       this.chargingStation.getConnectorStatus(connectorId).transactionIdTag = requestPayload.idTag;
 135       this.chargingStation.getConnectorStatus(connectorId).transactionEnergyActiveImportRegisterValue = 0;
 136       this.chargingStation.getConnectorStatus(connectorId).transactionBeginMeterValue = OCPP16ServiceUtils.buildTransactionBeginMeterValue(this.chargingStation, connectorId,
 137         requestPayload.meterStart);
 138       this.chargingStation.getBeginEndMeterValues() && await this.chargingStation.ocppRequestService.sendTransactionBeginMeterValues(connectorId, payload.transactionId,
 139         this.chargingStation.getConnectorStatus(connectorId).transactionBeginMeterValue);
 140       await this.chargingStation.ocppRequestService.sendStatusNotification(connectorId, OCPP16ChargePointStatus.CHARGING);
 141       this.chargingStation.getConnectorStatus(connectorId).status = OCPP16ChargePointStatus.CHARGING;
 142       logger.info(this.chargingStation.logPrefix() + ' Transaction ' + payload.transactionId.toString() + ' STARTED on ' + this.chargingStation.stationInfo.chargingStationId + '#' + connectorId.toString() + ' for idTag ' + requestPayload.idTag);
 143       if (this.chargingStation.stationInfo.powerSharedByConnectors) {
 144         this.chargingStation.stationInfo.powerDivider++;
 145       }
 146       const configuredMeterValueSampleInterval = this.chargingStation.getConfigurationKey(OCPP16StandardParametersKey.MeterValueSampleInterval);
 147       this.chargingStation.startMeterValues(connectorId, configuredMeterValueSampleInterval ? Utils.convertToInt(configuredMeterValueSampleInterval.value) * 1000 : 60000);
 148     } else {
 149       logger.warn(this.chargingStation.logPrefix() + ' Starting transaction id ' + payload.transactionId.toString() + ' REJECTED with status ' + payload?.idTagInfo?.status + ', idTag ' + requestPayload.idTag);
 150       await this.resetConnectorOnStartTransactionError(connectorId);
 151     }
 152   }
 153
 154   private async resetConnectorOnStartTransactionError(connectorId: number): Promise<void> {
 155     this.chargingStation.resetConnectorStatus(connectorId);
 156     if (this.chargingStation.getConnectorStatus(connectorId).status !== OCPP16ChargePointStatus.AVAILABLE) {
 157       await this.chargingStation.ocppRequestService.sendStatusNotification(connectorId, OCPP16ChargePointStatus.AVAILABLE);
 158       this.chargingStation.getConnectorStatus(connectorId).status = OCPP16ChargePointStatus.AVAILABLE;
 159     }
 160   }
 161
 162   private async handleResponseStopTransaction(payload: OCPP16StopTransactionResponse, requestPayload: StopTransactionRequest): Promise<void> {
 163     let transactionConnectorId: number;
 164     for (const connectorId of this.chargingStation.connectors.keys()) {
 165       if (connectorId > 0 && this.chargingStation.getConnectorStatus(connectorId)?.transactionId === requestPayload.transactionId) {
 166         transactionConnectorId = connectorId;
 167         break;
 168       }
 169     }
 170     if (!transactionConnectorId) {
 171       logger.error(this.chargingStation.logPrefix() + ' Trying to stop a non existing transaction ' + requestPayload.transactionId.toString());
 172       return;
 173     }
 174     if (payload.idTagInfo?.status === OCPP16AuthorizationStatus.ACCEPTED) {
 175       (this.chargingStation.getBeginEndMeterValues() && this.chargingStation.getOutOfOrderEndMeterValues())
 176         && await this.chargingStation.ocppRequestService.sendTransactionEndMeterValues(transactionConnectorId, requestPayload.transactionId,
 177           OCPP16ServiceUtils.buildTransactionEndMeterValue(this.chargingStation, transactionConnectorId, requestPayload.meterStop));
 178       if (!this.chargingStation.isChargingStationAvailable() || !this.chargingStation.isConnectorAvailable(transactionConnectorId)) {
 179         await this.chargingStation.ocppRequestService.sendStatusNotification(transactionConnectorId, OCPP16ChargePointStatus.UNAVAILABLE);
 180         this.chargingStation.getConnectorStatus(transactionConnectorId).status = OCPP16ChargePointStatus.UNAVAILABLE;
 181       } else {
 182         await this.chargingStation.ocppRequestService.sendStatusNotification(transactionConnectorId, OCPP16ChargePointStatus.AVAILABLE);
 183         this.chargingStation.getConnectorStatus(transactionConnectorId).status = OCPP16ChargePointStatus.AVAILABLE;
 184       }
 185       if (this.chargingStation.stationInfo.powerSharedByConnectors) {
 186         this.chargingStation.stationInfo.powerDivider--;
 187       }
 188       logger.info(this.chargingStation.logPrefix() + ' Transaction ' + requestPayload.transactionId.toString() + ' STOPPED on ' + this.chargingStation.stationInfo.chargingStationId + '#' + transactionConnectorId.toString());
 189       this.chargingStation.resetConnectorStatus(transactionConnectorId);
 190     } else {
 191       logger.warn(this.chargingStation.logPrefix() + ' Stopping transaction id ' + requestPayload.transactionId.toString() + ' REJECTED with status ' + payload.idTagInfo?.status);
 192     }
 193   }
 194
 195   private handleResponseStatusNotification(payload: StatusNotificationRequest, requestPayload: StatusNotificationResponse): void {
 196     logger.debug(this.chargingStation.logPrefix() + ' Status notification response received: %j to StatusNotification request: %j', payload, requestPayload);
 197   }
 198
 199   private handleResponseMeterValues(payload: MeterValuesRequest, requestPayload: MeterValuesResponse): void {
 200     logger.debug(this.chargingStation.logPrefix() + ' MeterValues response received: %j to MeterValues request: %j', payload, requestPayload);
 201   }
 202 }