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

   1 // Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
   2
   3 import {
   4   OCPP16AuthorizationStatus,
   5   OCPP16AuthorizeRequest,
   6   OCPP16AuthorizeResponse,
   7   OCPP16StartTransactionRequest,
   8   OCPP16StartTransactionResponse,
   9   OCPP16StopTransactionRequest,
  10   OCPP16StopTransactionResponse,
  11 } from '../../../types/ocpp/1.6/Transaction';
  12 import {
  13   OCPP16BootNotificationRequest,
  14   OCPP16HeartbeatRequest,
  15   OCPP16RequestCommand,
  16   OCPP16StatusNotificationRequest,
  17 } from '../../../types/ocpp/1.6/Requests';
  18 import {
  19   OCPP16BootNotificationResponse,
  20   OCPP16HeartbeatResponse,
  21   OCPP16RegistrationStatus,
  22   OCPP16StatusNotificationResponse,
  23 } from '../../../types/ocpp/1.6/Responses';
  24 import {
  25   OCPP16MeterValuesRequest,
  26   OCPP16MeterValuesResponse,
  27 } from '../../../types/ocpp/1.6/MeterValues';
  28
  29 import type ChargingStation from '../../ChargingStation';
  30 import { ErrorType } from '../../../types/ocpp/ErrorType';
  31 import { JsonType } from '../../../types/JsonType';
  32 import { OCPP16ChargePointErrorCode } from '../../../types/ocpp/1.6/ChargePointErrorCode';
  33 import { OCPP16ChargePointStatus } from '../../../types/ocpp/1.6/ChargePointStatus';
  34 import { OCPP16ServiceUtils } from './OCPP16ServiceUtils';
  35 import { OCPP16StandardParametersKey } from '../../../types/ocpp/1.6/Configuration';
  36 import OCPPError from '../../../exception/OCPPError';
  37 import OCPPResponseService from '../OCPPResponseService';
  38 import { ResponseHandler } from '../../../types/ocpp/Responses';
  39 import Utils from '../../../utils/Utils';
  40 import logger from '../../../utils/Logger';
  41
  42 const moduleName = 'OCPP16ResponseService';
  43
  44 export default class OCPP16ResponseService extends OCPPResponseService {
  45   private responseHandlers: Map<OCPP16RequestCommand, ResponseHandler>;
  46
  47   public constructor(chargingStation: ChargingStation) {
  48     if (new.target?.name === moduleName) {
  49       throw new TypeError(`Cannot construct ${new.target?.name} instances directly`);
  50     }
  51     super(chargingStation);
  52     this.responseHandlers = new Map<OCPP16RequestCommand, ResponseHandler>([
  53       [OCPP16RequestCommand.BOOT_NOTIFICATION, this.handleResponseBootNotification.bind(this)],
  54       [OCPP16RequestCommand.HEARTBEAT, this.handleResponseHeartbeat.bind(this)],
  55       [OCPP16RequestCommand.AUTHORIZE, this.handleResponseAuthorize.bind(this)],
  56       [OCPP16RequestCommand.START_TRANSACTION, this.handleResponseStartTransaction.bind(this)],
  57       [OCPP16RequestCommand.STOP_TRANSACTION, this.handleResponseStopTransaction.bind(this)],
  58       [OCPP16RequestCommand.STATUS_NOTIFICATION, this.handleResponseStatusNotification.bind(this)],
  59       [OCPP16RequestCommand.METER_VALUES, this.handleResponseMeterValues.bind(this)],
  60     ]);
  61   }
  62
  63   public async handleResponse(
  64     commandName: OCPP16RequestCommand,
  65     payload: JsonType | string,
  66     requestPayload: JsonType
  67   ): Promise<void> {
  68     if (
  69       this.chargingStation.isRegistered() ||
  70       commandName === OCPP16RequestCommand.BOOT_NOTIFICATION
  71     ) {
  72       if (this.responseHandlers.has(commandName)) {
  73         try {
  74           await this.responseHandlers.get(commandName)(payload, requestPayload);
  75         } catch (error) {
  76           logger.error(
  77             this.chargingStation.logPrefix() + ' Handle request response error: %j',
  78             error
  79           );
  80           throw error;
  81         }
  82       } else {
  83         // Throw exception
  84         throw new OCPPError(
  85           ErrorType.NOT_IMPLEMENTED,
  86           `${commandName} is not implemented to handle request response payload ${JSON.stringify(
  87             payload,
  88             null,
  89             2
  90           )}`,
  91           commandName
  92         );
  93       }
  94     } else {
  95       throw new OCPPError(
  96         ErrorType.SECURITY_ERROR,
  97         `${commandName} cannot be issued to handle request response payload ${JSON.stringify(
  98           payload,
  99           null,
 100           2
 101         )} while the charging station is not registered on the central server. `,
 102         commandName
 103       );
 104     }
 105   }
 106
 107   private handleResponseBootNotification(payload: OCPP16BootNotificationResponse): void {
 108     if (payload.status === OCPP16RegistrationStatus.ACCEPTED) {
 109       this.chargingStation.addConfigurationKey(
 110         OCPP16StandardParametersKey.HeartBeatInterval,
 111         payload.interval.toString(),
 112         {},
 113         { overwrite: true, save: true }
 114       );
 115       this.chargingStation.addConfigurationKey(
 116         OCPP16StandardParametersKey.HeartbeatInterval,
 117         payload.interval.toString(),
 118         { visible: false },
 119         { overwrite: true, save: true }
 120       );
 121       this.chargingStation.heartbeatSetInterval
 122         ? this.chargingStation.restartHeartbeat()
 123         : this.chargingStation.startHeartbeat();
 124     }
 125     if (Object.values(OCPP16RegistrationStatus).includes(payload.status)) {
 126       const logMsg = `${this.chargingStation.logPrefix()} Charging station in '${
 127         payload.status
 128       }' state on the central server`;
 129       payload.status === OCPP16RegistrationStatus.REJECTED
 130         ? logger.warn(logMsg)
 131         : logger.info(logMsg);
 132     } else {
 133       logger.error(
 134         this.chargingStation.logPrefix() +
 135           ' Charging station boot notification response received: %j with undefined registration status',
 136         payload
 137       );
 138     }
 139   }
 140
 141   private handleResponseHeartbeat(
 142     payload: OCPP16HeartbeatResponse,
 143     requestPayload: OCPP16HeartbeatRequest
 144   ): void {
 145     logger.debug(
 146       this.chargingStation.logPrefix() +
 147         ' Heartbeat response received: %j to Heartbeat request: %j',
 148       payload,
 149       requestPayload
 150     );
 151   }
 152
 153   private handleResponseAuthorize(
 154     payload: OCPP16AuthorizeResponse,
 155     requestPayload: OCPP16AuthorizeRequest
 156   ): void {
 157     let authorizeConnectorId: number;
 158     for (const connectorId of this.chargingStation.connectors.keys()) {
 159       if (
 160         connectorId > 0 &&
 161         this.chargingStation.getConnectorStatus(connectorId)?.authorizeIdTag ===
 162           requestPayload.idTag
 163       ) {
 164         authorizeConnectorId = connectorId;
 165         break;
 166       }
 167     }
 168     if (payload.idTagInfo.status === OCPP16AuthorizationStatus.ACCEPTED) {
 169       this.chargingStation.getConnectorStatus(authorizeConnectorId).idTagAuthorized = true;
 170       logger.debug(
 171         `${this.chargingStation.logPrefix()} IdTag ${
 172           requestPayload.idTag
 173         } authorized on connector ${authorizeConnectorId}`
 174       );
 175     } else {
 176       this.chargingStation.getConnectorStatus(authorizeConnectorId).idTagAuthorized = false;
 177       delete this.chargingStation.getConnectorStatus(authorizeConnectorId).authorizeIdTag;
 178       logger.debug(
 179         `${this.chargingStation.logPrefix()} IdTag ${requestPayload.idTag} refused with status '${
 180           payload.idTagInfo.status
 181         }' on connector ${authorizeConnectorId}`
 182       );
 183     }
 184   }
 185
 186   private async handleResponseStartTransaction(
 187     payload: OCPP16StartTransactionResponse,
 188     requestPayload: OCPP16StartTransactionRequest
 189   ): Promise<void> {
 190     const connectorId = requestPayload.connectorId;
 191
 192     let transactionConnectorId: number;
 193     for (const id of this.chargingStation.connectors.keys()) {
 194       if (id > 0 && id === connectorId) {
 195         transactionConnectorId = id;
 196         break;
 197       }
 198     }
 199     if (!transactionConnectorId) {
 200       logger.error(
 201         this.chargingStation.logPrefix() +
 202           ' Trying to start a transaction on a non existing connector Id ' +
 203           connectorId.toString()
 204       );
 205       return;
 206     }
 207     if (
 208       this.chargingStation.getConnectorStatus(connectorId).transactionRemoteStarted &&
 209       this.chargingStation.getAuthorizeRemoteTxRequests() &&
 210       this.chargingStation.getLocalAuthListEnabled() &&
 211       this.chargingStation.hasAuthorizedTags() &&
 212       !this.chargingStation.getConnectorStatus(connectorId).idTagLocalAuthorized
 213     ) {
 214       logger.error(
 215         this.chargingStation.logPrefix() +
 216           ' Trying to start a transaction with a not local authorized idTag ' +
 217           this.chargingStation.getConnectorStatus(connectorId).localAuthorizeIdTag +
 218           ' on connector Id ' +
 219           connectorId.toString()
 220       );
 221       await this.resetConnectorOnStartTransactionError(connectorId);
 222       return;
 223     }
 224     if (
 225       this.chargingStation.getConnectorStatus(connectorId).transactionRemoteStarted &&
 226       this.chargingStation.getAuthorizeRemoteTxRequests() &&
 227       this.chargingStation.getMayAuthorizeAtRemoteStart() &&
 228       !this.chargingStation.getConnectorStatus(connectorId).idTagLocalAuthorized &&
 229       !this.chargingStation.getConnectorStatus(connectorId).idTagAuthorized
 230     ) {
 231       logger.error(
 232         this.chargingStation.logPrefix() +
 233           ' Trying to start a transaction with a not authorized idTag ' +
 234           this.chargingStation.getConnectorStatus(connectorId).authorizeIdTag +
 235           ' on connector Id ' +
 236           connectorId.toString()
 237       );
 238       await this.resetConnectorOnStartTransactionError(connectorId);
 239       return;
 240     }
 241     if (
 242       this.chargingStation.getConnectorStatus(connectorId).idTagAuthorized &&
 243       this.chargingStation.getConnectorStatus(connectorId).authorizeIdTag !== requestPayload.idTag
 244     ) {
 245       logger.error(
 246         this.chargingStation.logPrefix() +
 247           ' Trying to start a transaction with an idTag ' +
 248           requestPayload.idTag +
 249           ' different from the authorize request one ' +
 250           this.chargingStation.getConnectorStatus(connectorId).authorizeIdTag +
 251           ' on connector Id ' +
 252           connectorId.toString()
 253       );
 254       await this.resetConnectorOnStartTransactionError(connectorId);
 255       return;
 256     }
 257     if (
 258       this.chargingStation.getConnectorStatus(connectorId).idTagLocalAuthorized &&
 259       this.chargingStation.getConnectorStatus(connectorId).localAuthorizeIdTag !==
 260         requestPayload.idTag
 261     ) {
 262       logger.error(
 263         this.chargingStation.logPrefix() +
 264           ' Trying to start a transaction with an idTag ' +
 265           requestPayload.idTag +
 266           ' different from the local authorized one ' +
 267           this.chargingStation.getConnectorStatus(connectorId).localAuthorizeIdTag +
 268           ' on connector Id ' +
 269           connectorId.toString()
 270       );
 271       await this.resetConnectorOnStartTransactionError(connectorId);
 272       return;
 273     }
 274     if (this.chargingStation.getConnectorStatus(connectorId)?.transactionStarted) {
 275       logger.debug(
 276         this.chargingStation.logPrefix() +
 277           ' Trying to start a transaction on an already used connector ' +
 278           connectorId.toString() +
 279           ': %j',
 280         this.chargingStation.getConnectorStatus(connectorId)
 281       );
 282       return;
 283     }
 284     if (
 285       this.chargingStation.getConnectorStatus(connectorId)?.status !==
 286         OCPP16ChargePointStatus.AVAILABLE &&
 287       this.chargingStation.getConnectorStatus(connectorId)?.status !==
 288         OCPP16ChargePointStatus.PREPARING
 289     ) {
 290       logger.error(
 291         `${this.chargingStation.logPrefix()} Trying to start a transaction on connector ${connectorId.toString()} with status ${
 292           this.chargingStation.getConnectorStatus(connectorId)?.status
 293         }`
 294       );
 295       return;
 296     }
 297     if (!Number.isInteger(payload.transactionId)) {
 298       logger.warn(
 299         `${this.chargingStation.logPrefix()} Trying to start a transaction on connector ${connectorId.toString()} with a non integer transaction Id ${
 300           payload.transactionId
 301         }, converting to integer`
 302       );
 303       payload.transactionId = Utils.convertToInt(payload.transactionId);
 304     }
 305
 306     if (payload.idTagInfo?.status === OCPP16AuthorizationStatus.ACCEPTED) {
 307       this.chargingStation.getConnectorStatus(connectorId).transactionStarted = true;
 308       this.chargingStation.getConnectorStatus(connectorId).transactionId = payload.transactionId;
 309       this.chargingStation.getConnectorStatus(connectorId).transactionIdTag = requestPayload.idTag;
 310       this.chargingStation.getConnectorStatus(
 311         connectorId
 312       ).transactionEnergyActiveImportRegisterValue = 0;
 313       this.chargingStation.getConnectorStatus(connectorId).transactionBeginMeterValue =
 314         OCPP16ServiceUtils.buildTransactionBeginMeterValue(
 315           this.chargingStation,
 316           connectorId,
 317           requestPayload.meterStart
 318         );
 319       this.chargingStation.getBeginEndMeterValues() &&
 320         (await this.chargingStation.ocppRequestService.sendMessageHandler<
 321           OCPP16MeterValuesRequest,
 322           OCPP16MeterValuesResponse
 323         >(OCPP16RequestCommand.METER_VALUES, {
 324           connectorId,
 325           transactionId: payload.transactionId,
 326           meterValue:
 327             this.chargingStation.getConnectorStatus(connectorId).transactionBeginMeterValue,
 328         }));
 329       await this.chargingStation.ocppRequestService.sendMessageHandler<
 330         OCPP16StatusNotificationRequest,
 331         OCPP16StatusNotificationResponse
 332       >(OCPP16RequestCommand.STATUS_NOTIFICATION, {
 333         connectorId,
 334         status: OCPP16ChargePointStatus.CHARGING,
 335         errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
 336       });
 337       this.chargingStation.getConnectorStatus(connectorId).status =
 338         OCPP16ChargePointStatus.CHARGING;
 339       logger.info(
 340         this.chargingStation.logPrefix() +
 341           ' Transaction ' +
 342           payload.transactionId.toString() +
 343           ' STARTED on ' +
 344           this.chargingStation.stationInfo.chargingStationId +
 345           '#' +
 346           connectorId.toString() +
 347           ' for idTag ' +
 348           requestPayload.idTag
 349       );
 350       if (this.chargingStation.stationInfo.powerSharedByConnectors) {
 351         this.chargingStation.stationInfo.powerDivider++;
 352       }
 353       const configuredMeterValueSampleInterval = this.chargingStation.getConfigurationKey(
 354         OCPP16StandardParametersKey.MeterValueSampleInterval
 355       );
 356       this.chargingStation.startMeterValues(
 357         connectorId,
 358         configuredMeterValueSampleInterval
 359           ? Utils.convertToInt(configuredMeterValueSampleInterval.value) * 1000
 360           : 60000
 361       );
 362     } else {
 363       logger.warn(
 364         this.chargingStation.logPrefix() +
 365           ' Starting transaction id ' +
 366           payload.transactionId.toString() +
 367           " REJECTED with status '" +
 368           payload?.idTagInfo?.status +
 369           "', idTag " +
 370           requestPayload.idTag
 371       );
 372       await this.resetConnectorOnStartTransactionError(connectorId);
 373     }
 374   }
 375
 376   private async resetConnectorOnStartTransactionError(connectorId: number): Promise<void> {
 377     this.chargingStation.resetConnectorStatus(connectorId);
 378     if (
 379       this.chargingStation.getConnectorStatus(connectorId).status !==
 380       OCPP16ChargePointStatus.AVAILABLE
 381     ) {
 382       await this.chargingStation.ocppRequestService.sendMessageHandler<
 383         OCPP16StatusNotificationRequest,
 384         OCPP16StatusNotificationResponse
 385       >(OCPP16RequestCommand.STATUS_NOTIFICATION, {
 386         connectorId,
 387         status: OCPP16ChargePointStatus.AVAILABLE,
 388         errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
 389       });
 390       this.chargingStation.getConnectorStatus(connectorId).status =
 391         OCPP16ChargePointStatus.AVAILABLE;
 392     }
 393   }
 394
 395   private async handleResponseStopTransaction(
 396     payload: OCPP16StopTransactionResponse,
 397     requestPayload: OCPP16StopTransactionRequest
 398   ): Promise<void> {
 399     const transactionConnectorId = this.chargingStation.getConnectorIdByTransactionId(
 400       requestPayload.transactionId
 401     );
 402     if (!transactionConnectorId) {
 403       logger.error(
 404         this.chargingStation.logPrefix() +
 405           ' Trying to stop a non existing transaction ' +
 406           requestPayload.transactionId.toString()
 407       );
 408       return;
 409     }
 410     if (payload.idTagInfo?.status === OCPP16AuthorizationStatus.ACCEPTED) {
 411       this.chargingStation.getBeginEndMeterValues() &&
 412         !this.chargingStation.getOcppStrictCompliance() &&
 413         this.chargingStation.getOutOfOrderEndMeterValues() &&
 414         (await this.chargingStation.ocppRequestService.sendMessageHandler<
 415           OCPP16MeterValuesRequest,
 416           OCPP16MeterValuesResponse
 417         >(OCPP16RequestCommand.METER_VALUES, {
 418           connectorId: transactionConnectorId,
 419           transactionId: requestPayload.transactionId,
 420           meterValue: OCPP16ServiceUtils.buildTransactionEndMeterValue(
 421             this.chargingStation,
 422             transactionConnectorId,
 423             requestPayload.meterStop
 424           ),
 425         }));
 426       if (
 427         !this.chargingStation.isChargingStationAvailable() ||
 428         !this.chargingStation.isConnectorAvailable(transactionConnectorId)
 429       ) {
 430         await this.chargingStation.ocppRequestService.sendMessageHandler<
 431           OCPP16StatusNotificationRequest,
 432           OCPP16StatusNotificationResponse
 433         >(OCPP16RequestCommand.STATUS_NOTIFICATION, {
 434           connectorId: transactionConnectorId,
 435           status: OCPP16ChargePointStatus.UNAVAILABLE,
 436           errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
 437         });
 438         this.chargingStation.getConnectorStatus(transactionConnectorId).status =
 439           OCPP16ChargePointStatus.UNAVAILABLE;
 440       } else {
 441         await this.chargingStation.ocppRequestService.sendMessageHandler<
 442           OCPP16BootNotificationRequest,
 443           OCPP16BootNotificationResponse
 444         >(OCPP16RequestCommand.STATUS_NOTIFICATION, {
 445           connectorId: transactionConnectorId,
 446           status: OCPP16ChargePointStatus.AVAILABLE,
 447           errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
 448         });
 449         this.chargingStation.getConnectorStatus(transactionConnectorId).status =
 450           OCPP16ChargePointStatus.AVAILABLE;
 451       }
 452       if (this.chargingStation.stationInfo.powerSharedByConnectors) {
 453         this.chargingStation.stationInfo.powerDivider--;
 454       }
 455       logger.info(
 456         this.chargingStation.logPrefix() +
 457           ' Transaction ' +
 458           requestPayload.transactionId.toString() +
 459           ' STOPPED on ' +
 460           this.chargingStation.stationInfo.chargingStationId +
 461           '#' +
 462           transactionConnectorId.toString()
 463       );
 464       this.chargingStation.resetConnectorStatus(transactionConnectorId);
 465     } else {
 466       logger.warn(
 467         this.chargingStation.logPrefix() +
 468           ' Stopping transaction id ' +
 469           requestPayload.transactionId.toString() +
 470           " REJECTED with status '" +
 471           payload.idTagInfo?.status +
 472           "'"
 473       );
 474     }
 475   }
 476
 477   private handleResponseStatusNotification(
 478     payload: OCPP16StatusNotificationRequest,
 479     requestPayload: OCPP16StatusNotificationResponse
 480   ): void {
 481     logger.debug(
 482       this.chargingStation.logPrefix() +
 483         ' Status notification response received: %j to StatusNotification request: %j',
 484       payload,
 485       requestPayload
 486     );
 487   }
 488
 489   private handleResponseMeterValues(
 490     payload: OCPP16MeterValuesRequest,
 491     requestPayload: OCPP16MeterValuesResponse
 492   ): void {
 493     logger.debug(
 494       this.chargingStation.logPrefix() +
 495         ' MeterValues response received: %j to MeterValues request: %j',
 496       payload,
 497       requestPayload
 498     );
 499   }
 500 }