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