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

   1 import { ACElectricUtils, DCElectricUtils } from '../../../utils/ElectricUtils';
   2 import { AuthorizeRequest, OCPP16AuthorizeResponse, OCPP16StartTransactionResponse, OCPP16StopTransactionReason, OCPP16StopTransactionResponse, StartTransactionRequest, StopTransactionRequest } from '../../../types/ocpp/1.6/Transaction';
   3 import { HeartbeatRequest, OCPP16BootNotificationRequest, OCPP16IncomingRequestCommand, OCPP16RequestCommand, StatusNotificationRequest } from '../../../types/ocpp/1.6/Requests';
   4 import { MeterValuePhase, MeterValueUnit, MeterValuesRequest, OCPP16MeterValue, OCPP16MeterValueMeasurand, OCPP16SampledValue } from '../../../types/ocpp/1.6/MeterValues';
   5
   6 import Constants from '../../../utils/Constants';
   7 import { CurrentOutType } from '../../../types/ChargingStationTemplate';
   8 import MeasurandValues from '../../../types/MeasurandValues';
   9 import { MessageType } from '../../../types/ocpp/MessageType';
  10 import { OCPP16BootNotificationResponse } from '../../../types/ocpp/1.6/Responses';
  11 import { OCPP16ChargePointErrorCode } from '../../../types/ocpp/1.6/ChargePointErrorCode';
  12 import { OCPP16ChargePointStatus } from '../../../types/ocpp/1.6/ChargePointStatus';
  13 import { OCPP16ServiceUtils } from './OCPP16ServiceUtils';
  14 import { OCPP16StandardParametersKey } from '../../../types/ocpp/1.6/Configuration';
  15 import OCPPError from '../../OcppError';
  16 import OCPPRequestService from '../OCPPRequestService';
  17 import Utils from '../../../utils/Utils';
  18 import logger from '../../../utils/Logger';
  19
  20 export default class OCPP16RequestService extends OCPPRequestService {
  21   public async sendHeartbeat(): Promise<void> {
  22     try {
  23       const payload: HeartbeatRequest = {};
  24       await this.sendMessage(Utils.generateUUID(), payload, MessageType.CALL_MESSAGE, OCPP16RequestCommand.HEARTBEAT);
  25     } catch (error) {
  26       this.handleRequestError(OCPP16RequestCommand.HEARTBEAT, error);
  27     }
  28   }
  29
  30   public async sendBootNotification(chargePointModel: string, chargePointVendor: string, chargeBoxSerialNumber?: string, firmwareVersion?: string,
  31       chargePointSerialNumber?: string, iccid?: string, imsi?: string, meterSerialNumber?: string, meterType?: string): Promise<OCPP16BootNotificationResponse> {
  32     try {
  33       const payload: OCPP16BootNotificationRequest = {
  34         chargePointModel,
  35         chargePointVendor,
  36         ...!Utils.isUndefined(chargeBoxSerialNumber) && { chargeBoxSerialNumber },
  37         ...!Utils.isUndefined(chargePointSerialNumber) && { chargePointSerialNumber },
  38         ...!Utils.isUndefined(firmwareVersion) && { firmwareVersion },
  39         ...!Utils.isUndefined(iccid) && { iccid },
  40         ...!Utils.isUndefined(imsi) && { imsi },
  41         ...!Utils.isUndefined(meterSerialNumber) && { meterSerialNumber },
  42         ...!Utils.isUndefined(meterType) && { meterType }
  43       };
  44       return await this.sendMessage(Utils.generateUUID(), payload, MessageType.CALL_MESSAGE, OCPP16RequestCommand.BOOT_NOTIFICATION) as OCPP16BootNotificationResponse;
  45     } catch (error) {
  46       this.handleRequestError(OCPP16RequestCommand.BOOT_NOTIFICATION, error);
  47     }
  48   }
  49
  50   public async sendStatusNotification(connectorId: number, status: OCPP16ChargePointStatus,
  51       errorCode: OCPP16ChargePointErrorCode = OCPP16ChargePointErrorCode.NO_ERROR): Promise<void> {
  52     try {
  53       const payload: StatusNotificationRequest = {
  54         connectorId,
  55         errorCode,
  56         status,
  57       };
  58       await this.sendMessage(Utils.generateUUID(), payload, MessageType.CALL_MESSAGE, OCPP16RequestCommand.STATUS_NOTIFICATION);
  59     } catch (error) {
  60       this.handleRequestError(OCPP16RequestCommand.STATUS_NOTIFICATION, error);
  61     }
  62   }
  63
  64   public async sendAuthorize(idTag?: string): Promise<OCPP16AuthorizeResponse> {
  65     try {
  66       const payload: AuthorizeRequest = {
  67         ...!Utils.isUndefined(idTag) ? { idTag } : { idTag: Constants.TRANSACTION_DEFAULT_IDTAG },
  68       };
  69       return await this.sendMessage(Utils.generateUUID(), payload, MessageType.CALL_MESSAGE, OCPP16RequestCommand.AUTHORIZE) as OCPP16AuthorizeResponse;
  70     } catch (error) {
  71       this.handleRequestError(OCPP16RequestCommand.AUTHORIZE, error);
  72     }
  73   }
  74
  75   public async sendStartTransaction(connectorId: number, idTag?: string): Promise<OCPP16StartTransactionResponse> {
  76     try {
  77       const payload: StartTransactionRequest = {
  78         connectorId,
  79         ...!Utils.isUndefined(idTag) ? { idTag } : { idTag: Constants.TRANSACTION_DEFAULT_IDTAG },
  80         meterStart: this.chargingStation.getEnergyActiveImportRegisterByConnectorId(connectorId),
  81         timestamp: new Date().toISOString(),
  82       };
  83       return await this.sendMessage(Utils.generateUUID(), payload, MessageType.CALL_MESSAGE, OCPP16RequestCommand.START_TRANSACTION) as OCPP16StartTransactionResponse;
  84     } catch (error) {
  85       this.handleRequestError(OCPP16RequestCommand.START_TRANSACTION, error);
  86     }
  87   }
  88
  89   public async sendStopTransaction(transactionId: number, meterStop: number, idTag?: string,
  90       reason: OCPP16StopTransactionReason = OCPP16StopTransactionReason.NONE): Promise<OCPP16StopTransactionResponse> {
  91     try {
  92       let connectorId: number;
  93       for (const connector in this.chargingStation.connectors) {
  94         if (Utils.convertToInt(connector) > 0 && this.chargingStation.getConnector(Utils.convertToInt(connector))?.transactionId === transactionId) {
  95           connectorId = Utils.convertToInt(connector);
  96         }
  97       }
  98       const transactionEndMeterValue = OCPP16ServiceUtils.buildTransactionEndMeterValue(this.chargingStation, connectorId, meterStop);
  99       // FIXME: should be a callback, each OCPP commands implementation must do only one job
 100       (this.chargingStation.getBeginEndMeterValues() && !this.chargingStation.getOutOfOrderEndMeterValues())
 101         && await this.sendTransactionEndMeterValues(connectorId, transactionId, transactionEndMeterValue);
 102       const payload: StopTransactionRequest = {
 103         transactionId,
 104         ...!Utils.isUndefined(idTag) && { idTag },
 105         meterStop,
 106         timestamp: new Date().toISOString(),
 107         ...reason && { reason },
 108         ...this.chargingStation.getTransactionDataMeterValues() && { transactionData: OCPP16ServiceUtils.buildTransactionDataMeterValues(this.chargingStation.getConnector(connectorId).transactionBeginMeterValue, transactionEndMeterValue) },
 109       };
 110       return await this.sendMessage(Utils.generateUUID(), payload, MessageType.CALL_MESSAGE, OCPP16RequestCommand.STOP_TRANSACTION) as OCPP16StartTransactionResponse;
 111     } catch (error) {
 112       this.handleRequestError(OCPP16RequestCommand.STOP_TRANSACTION, error);
 113     }
 114   }
 115
 116   // eslint-disable-next-line consistent-this
 117   public async sendMeterValues(connectorId: number, transactionId: number, interval: number, self: OCPPRequestService, debug = false): Promise<void> {
 118     try {
 119       const meterValue: OCPP16MeterValue = {
 120         timestamp: new Date().toISOString(),
 121         sampledValue: [],
 122       };
 123       const meterValuesTemplate: OCPP16SampledValue[] = self.chargingStation.getConnector(connectorId).MeterValues;
 124       for (let index = 0; index < meterValuesTemplate.length; index++) {
 125         const connector = self.chargingStation.getConnector(connectorId);
 126         // SoC measurand
 127         if (meterValuesTemplate[index].measurand && meterValuesTemplate[index].measurand === OCPP16MeterValueMeasurand.STATE_OF_CHARGE && self.chargingStation.getConfigurationKey(OCPP16StandardParametersKey.MeterValuesSampledData).value.includes(OCPP16MeterValueMeasurand.STATE_OF_CHARGE)) {
 128           meterValue.sampledValue.push(OCPP16ServiceUtils.buildSampledValue(meterValuesTemplate[index], Utils.getRandomInt(100)));
 129           const sampledValuesIndex = meterValue.sampledValue.length - 1;
 130           if (Utils.convertToInt(meterValue.sampledValue[sampledValuesIndex].value) > 100 || debug) {
 131             logger.error(`${self.chargingStation.logPrefix()} MeterValues measurand ${meterValue.sampledValue[sampledValuesIndex].measurand ?? OCPP16MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: connectorId ${connectorId}, transaction ${connector.transactionId}, value: ${meterValue.sampledValue[sampledValuesIndex].value}/100`);
 132           }
 133         // Voltage measurand
 134         } else if (meterValuesTemplate[index].measurand && meterValuesTemplate[index].measurand === OCPP16MeterValueMeasurand.VOLTAGE && self.chargingStation.getConfigurationKey(OCPP16StandardParametersKey.MeterValuesSampledData).value.includes(OCPP16MeterValueMeasurand.VOLTAGE)) {
 135           const voltageMeasurandValue = Utils.getRandomFloatRounded(self.chargingStation.getVoltageOut() + self.chargingStation.getVoltageOut() * 0.1, self.chargingStation.getVoltageOut() - self.chargingStation.getVoltageOut() * 0.1);
 136           meterValue.sampledValue.push(OCPP16ServiceUtils.buildSampledValue(meterValuesTemplate[index], voltageMeasurandValue));
 137           for (let phase = 1; self.chargingStation.getNumberOfPhases() === 3 && phase <= self.chargingStation.getNumberOfPhases(); phase++) {
 138             let phaseValue: string;
 139             if (self.chargingStation.getVoltageOut() >= 0 && self.chargingStation.getVoltageOut() <= 250) {
 140               phaseValue = `L${phase}-N`;
 141             } else if (self.chargingStation.getVoltageOut() > 250) {
 142               phaseValue = `L${phase}-L${(phase + 1) % self.chargingStation.getNumberOfPhases() !== 0 ? (phase + 1) % self.chargingStation.getNumberOfPhases() : self.chargingStation.getNumberOfPhases()}`;
 143             }
 144             meterValue.sampledValue.push(OCPP16ServiceUtils.buildSampledValue(meterValuesTemplate[index], voltageMeasurandValue, null,
 145               phaseValue as MeterValuePhase));
 146           }
 147         // Power.Active.Import measurand
 148         } else if (meterValuesTemplate[index].measurand && meterValuesTemplate[index].measurand === OCPP16MeterValueMeasurand.POWER_ACTIVE_IMPORT && self.chargingStation.getConfigurationKey(OCPP16StandardParametersKey.MeterValuesSampledData).value.includes(OCPP16MeterValueMeasurand.POWER_ACTIVE_IMPORT)) {
 149           OCPP16ServiceUtils.checkMeasurandPowerDivider(self.chargingStation, meterValuesTemplate[index].measurand);
 150           const errMsg = `${self.chargingStation.logPrefix()} MeterValues measurand ${meterValuesTemplate[index].measurand ?? OCPP16MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: Unknown ${self.chargingStation.getCurrentOutType()} currentOutType in template file ${self.chargingStation.stationTemplateFile}, cannot calculate ${meterValuesTemplate[index].measurand ?? OCPP16MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER} measurand value`;
 151           const powerMeasurandValues = {} as MeasurandValues;
 152           const unitDivider = meterValuesTemplate[index]?.unit === MeterValueUnit.KILO_WATT ? 1000 : 1;
 153           const maxPower = Math.round(self.chargingStation.stationInfo.maxPower / self.chargingStation.stationInfo.powerDivider);
 154           const maxPowerPerPhase = Math.round((self.chargingStation.stationInfo.maxPower / self.chargingStation.stationInfo.powerDivider) / self.chargingStation.getNumberOfPhases());
 155           switch (self.chargingStation.getCurrentOutType()) {
 156             case CurrentOutType.AC:
 157               if (Utils.isUndefined(meterValuesTemplate[index].value)) {
 158                 powerMeasurandValues.L1 = Utils.getRandomFloatRounded(maxPowerPerPhase / unitDivider);
 159                 powerMeasurandValues.L2 = 0;
 160                 powerMeasurandValues.L3 = 0;
 161                 if (self.chargingStation.getNumberOfPhases() === 3) {
 162                   powerMeasurandValues.L2 = Utils.getRandomFloatRounded(maxPowerPerPhase / unitDivider);
 163                   powerMeasurandValues.L3 = Utils.getRandomFloatRounded(maxPowerPerPhase / unitDivider);
 164                 }
 165                 powerMeasurandValues.allPhases = Utils.roundTo(powerMeasurandValues.L1 + powerMeasurandValues.L2 + powerMeasurandValues.L3, 2);
 166               }
 167               break;
 168             case CurrentOutType.DC:
 169               if (Utils.isUndefined(meterValuesTemplate[index].value)) {
 170                 powerMeasurandValues.allPhases = Utils.getRandomFloatRounded(maxPower / unitDivider);
 171               }
 172               break;
 173             default:
 174               logger.error(errMsg);
 175               throw Error(errMsg);
 176           }
 177           meterValue.sampledValue.push(OCPP16ServiceUtils.buildSampledValue(meterValuesTemplate[index], powerMeasurandValues.allPhases));
 178           const sampledValuesIndex = meterValue.sampledValue.length - 1;
 179           const maxPowerRounded = Utils.roundTo(maxPower / unitDivider, 2);
 180           if (Utils.convertToFloat(meterValue.sampledValue[sampledValuesIndex].value) > maxPowerRounded || debug) {
 181             logger.error(`${self.chargingStation.logPrefix()} MeterValues measurand ${meterValue.sampledValue[sampledValuesIndex].measurand ?? OCPP16MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: connectorId ${connectorId}, transaction ${connector.transactionId}, value: ${meterValue.sampledValue[sampledValuesIndex].value}/${maxPowerRounded}`);
 182           }
 183           for (let phase = 1; self.chargingStation.getNumberOfPhases() === 3 && phase <= self.chargingStation.getNumberOfPhases(); phase++) {
 184             const phaseValue = `L${phase}-N`;
 185             meterValue.sampledValue.push(OCPP16ServiceUtils.buildSampledValue(meterValuesTemplate[index], powerMeasurandValues[`L${phase}`], null,
 186               phaseValue as MeterValuePhase));
 187           }
 188         // Current.Import measurand
 189         } else if (meterValuesTemplate[index].measurand && meterValuesTemplate[index].measurand === OCPP16MeterValueMeasurand.CURRENT_IMPORT && self.chargingStation.getConfigurationKey(OCPP16StandardParametersKey.MeterValuesSampledData).value.includes(OCPP16MeterValueMeasurand.CURRENT_IMPORT)) {
 190           OCPP16ServiceUtils.checkMeasurandPowerDivider(self.chargingStation, meterValuesTemplate[index].measurand);
 191           const errMsg = `${self.chargingStation.logPrefix()} MeterValues measurand ${meterValuesTemplate[index].measurand ?? OCPP16MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: Unknown ${self.chargingStation.getCurrentOutType()} currentOutType in template file ${self.chargingStation.stationTemplateFile}, cannot calculate ${meterValuesTemplate[index].measurand ?? OCPP16MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER} measurand value`;
 192           const currentMeasurandValues: MeasurandValues = {} as MeasurandValues;
 193           let maxAmperage: number;
 194           switch (self.chargingStation.getCurrentOutType()) {
 195             case CurrentOutType.AC:
 196               maxAmperage = ACElectricUtils.amperagePerPhaseFromPower(self.chargingStation.getNumberOfPhases(), self.chargingStation.stationInfo.maxPower / self.chargingStation.stationInfo.powerDivider, self.chargingStation.getVoltageOut());
 197               if (Utils.isUndefined(meterValuesTemplate[index].value)) {
 198                 currentMeasurandValues.L1 = Utils.getRandomFloatRounded(maxAmperage);
 199                 currentMeasurandValues.L2 = 0;
 200                 currentMeasurandValues.L3 = 0;
 201                 if (self.chargingStation.getNumberOfPhases() === 3) {
 202                   currentMeasurandValues.L2 = Utils.getRandomFloatRounded(maxAmperage);
 203                   currentMeasurandValues.L3 = Utils.getRandomFloatRounded(maxAmperage);
 204                 }
 205                 currentMeasurandValues.allPhases = Utils.roundTo((currentMeasurandValues.L1 + currentMeasurandValues.L2 + currentMeasurandValues.L3) / self.chargingStation.getNumberOfPhases(), 2);
 206               }
 207               break;
 208             case CurrentOutType.DC:
 209               maxAmperage = DCElectricUtils.amperage(self.chargingStation.stationInfo.maxPower / self.chargingStation.stationInfo.powerDivider, self.chargingStation.getVoltageOut());
 210               if (Utils.isUndefined(meterValuesTemplate[index].value)) {
 211                 currentMeasurandValues.allPhases = Utils.getRandomFloatRounded(maxAmperage);
 212               }
 213               break;
 214             default:
 215               logger.error(errMsg);
 216               throw Error(errMsg);
 217           }
 218           meterValue.sampledValue.push(OCPP16ServiceUtils.buildSampledValue(meterValuesTemplate[index], currentMeasurandValues.allPhases));
 219           const sampledValuesIndex = meterValue.sampledValue.length - 1;
 220           if (Utils.convertToFloat(meterValue.sampledValue[sampledValuesIndex].value) > maxAmperage || debug) {
 221             logger.error(`${self.chargingStation.logPrefix()} MeterValues measurand ${meterValue.sampledValue[sampledValuesIndex].measurand ?? OCPP16MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: connectorId ${connectorId}, transaction ${connector.transactionId}, value: ${meterValue.sampledValue[sampledValuesIndex].value}/${maxAmperage}`);
 222           }
 223           for (let phase = 1; self.chargingStation.getNumberOfPhases() === 3 && phase <= self.chargingStation.getNumberOfPhases(); phase++) {
 224             const phaseValue = `L${phase}`;
 225             meterValue.sampledValue.push(OCPP16ServiceUtils.buildSampledValue(meterValuesTemplate[index], currentMeasurandValues[phaseValue], null,
 226               phaseValue as MeterValuePhase));
 227           }
 228         // Energy.Active.Import.Register measurand (default)
 229         } else if (!meterValuesTemplate[index].measurand || meterValuesTemplate[index].measurand === OCPP16MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER) {
 230           OCPP16ServiceUtils.checkMeasurandPowerDivider(self.chargingStation, meterValuesTemplate[index].measurand);
 231           const unitDivider = meterValuesTemplate[index]?.unit === MeterValueUnit.KILO_WATT_HOUR ? 1000 : 1;
 232           if (Utils.isUndefined(meterValuesTemplate[index].value)) {
 233             const energyMeasurandValue = Utils.getRandomInt(self.chargingStation.stationInfo.maxPower / (self.chargingStation.stationInfo.powerDivider * 3600000) * interval);
 234             // Persist previous value in connector
 235             if (connector && !Utils.isNullOrUndefined(connector.energyActiveImportRegisterValue) && connector.energyActiveImportRegisterValue >= 0 &&
 236                 !Utils.isNullOrUndefined(connector.transactionEnergyActiveImportRegisterValue) && connector.transactionEnergyActiveImportRegisterValue >= 0) {
 237               connector.energyActiveImportRegisterValue += energyMeasurandValue;
 238               connector.transactionEnergyActiveImportRegisterValue += energyMeasurandValue;
 239             } else {
 240               connector.energyActiveImportRegisterValue = 0;
 241               connector.transactionEnergyActiveImportRegisterValue = 0;
 242             }
 243           }
 244           meterValue.sampledValue.push(OCPP16ServiceUtils.buildSampledValue(meterValuesTemplate[index],
 245             Utils.roundTo(self.chargingStation.getEnergyActiveImportRegisterByTransactionId(transactionId) / unitDivider, 4)));
 246           const sampledValuesIndex = meterValue.sampledValue.length - 1;
 247           const maxEnergy = Math.round(self.chargingStation.stationInfo.maxPower * 3600 / (self.chargingStation.stationInfo.powerDivider * interval));
 248           const maxEnergyRounded = Utils.roundTo(maxEnergy / unitDivider, 4);
 249           if (Utils.convertToFloat(meterValue.sampledValue[sampledValuesIndex].value) > maxEnergyRounded || debug) {
 250             logger.error(`${self.chargingStation.logPrefix()} MeterValues measurand ${meterValue.sampledValue[sampledValuesIndex].measurand ?? OCPP16MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER}: connectorId ${connectorId}, transaction ${connector.transactionId}, value: ${meterValue.sampledValue[sampledValuesIndex].value}/${maxEnergyRounded}`);
 251           }
 252         // Unsupported measurand
 253         } else {
 254           logger.info(`${self.chargingStation.logPrefix()} Unsupported MeterValues measurand ${meterValuesTemplate[index].measurand ?? OCPP16MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER} on connectorId ${connectorId}`);
 255         }
 256       }
 257       const payload: MeterValuesRequest = {
 258         connectorId,
 259         transactionId,
 260         meterValue,
 261       };
 262       await self.sendMessage(Utils.generateUUID(), payload, MessageType.CALL_MESSAGE, OCPP16RequestCommand.METER_VALUES);
 263     } catch (error) {
 264       self.handleRequestError(OCPP16RequestCommand.METER_VALUES, error);
 265     }
 266   }
 267
 268   public async sendTransactionBeginMeterValues(connectorId: number, transactionId: number, beginMeterValue: OCPP16MeterValue): Promise<void> {
 269     const payload: MeterValuesRequest = {
 270       connectorId,
 271       transactionId,
 272       meterValue: beginMeterValue,
 273     };
 274     await this.sendMessage(Utils.generateUUID(), payload, MessageType.CALL_MESSAGE, OCPP16RequestCommand.METER_VALUES);
 275   }
 276
 277   public async sendTransactionEndMeterValues(connectorId: number, transactionId: number, endMeterValue: OCPP16MeterValue): Promise<void> {
 278     const payload: MeterValuesRequest = {
 279       connectorId,
 280       transactionId,
 281       meterValue: endMeterValue,
 282     };
 283     await this.sendMessage(Utils.generateUUID(), payload, MessageType.CALL_MESSAGE, OCPP16RequestCommand.METER_VALUES);
 284   }
 285
 286   public async sendError(messageId: string, error: OCPPError, commandName: OCPP16RequestCommand | OCPP16IncomingRequestCommand): Promise<unknown> {
 287     // Send error
 288     return this.sendMessage(messageId, error, MessageType.CALL_ERROR_MESSAGE, commandName);
 289   }
 290 }