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