1 // Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
3 import type { JSONSchemaType
} from
'ajv';
5 import { OCPP16Constants
} from
'./OCPP16Constants';
6 import { OCPP16ServiceUtils
} from
'./OCPP16ServiceUtils';
7 import type { ChargingStation
} from
'../../../charging-station';
8 import { OCPPError
} from
'../../../exception';
13 type OCPP16AuthorizeRequest
,
14 type OCPP16BootNotificationRequest
,
15 OCPP16ChargePointStatus
,
16 type OCPP16DataTransferRequest
,
17 type OCPP16DiagnosticsStatusNotificationRequest
,
18 type OCPP16FirmwareStatusNotificationRequest
,
19 type OCPP16HeartbeatRequest
,
20 type OCPP16MeterValuesRequest
,
22 type OCPP16StartTransactionRequest
,
23 type OCPP16StatusNotificationRequest
,
24 type OCPP16StopTransactionRequest
,
27 } from
'../../../types';
28 import { Constants
, generateUUID
} from
'../../../utils';
29 import { OCPPRequestService
} from
'../OCPPRequestService';
30 import type { OCPPResponseService
} from
'../OCPPResponseService';
32 const moduleName
= 'OCPP16RequestService';
34 export class OCPP16RequestService
extends OCPPRequestService
{
35 protected jsonSchemas
: Map
<OCPP16RequestCommand
, JSONSchemaType
<JsonObject
>>;
37 public constructor(ocppResponseService
: OCPPResponseService
) {
38 // if (new.target?.name === moduleName) {
39 // throw new TypeError(`Cannot construct ${new.target?.name} instances directly`);
41 super(OCPPVersion
.VERSION_16
, ocppResponseService
);
42 this.jsonSchemas
= new Map
<OCPP16RequestCommand
, JSONSchemaType
<JsonObject
>>([
44 OCPP16RequestCommand
.AUTHORIZE
,
45 OCPP16ServiceUtils
.parseJsonSchemaFile
<OCPP16AuthorizeRequest
>(
46 'assets/json-schemas/ocpp/1.6/Authorize.json',
52 OCPP16RequestCommand
.BOOT_NOTIFICATION
,
53 OCPP16ServiceUtils
.parseJsonSchemaFile
<OCPP16BootNotificationRequest
>(
54 'assets/json-schemas/ocpp/1.6/BootNotification.json',
60 OCPP16RequestCommand
.DIAGNOSTICS_STATUS_NOTIFICATION
,
61 OCPP16ServiceUtils
.parseJsonSchemaFile
<OCPP16DiagnosticsStatusNotificationRequest
>(
62 'assets/json-schemas/ocpp/1.6/DiagnosticsStatusNotification.json',
68 OCPP16RequestCommand
.HEARTBEAT
,
69 OCPP16ServiceUtils
.parseJsonSchemaFile
<OCPP16HeartbeatRequest
>(
70 'assets/json-schemas/ocpp/1.6/Heartbeat.json',
76 OCPP16RequestCommand
.METER_VALUES
,
77 OCPP16ServiceUtils
.parseJsonSchemaFile
<OCPP16MeterValuesRequest
>(
78 'assets/json-schemas/ocpp/1.6/MeterValues.json',
84 OCPP16RequestCommand
.STATUS_NOTIFICATION
,
85 OCPP16ServiceUtils
.parseJsonSchemaFile
<OCPP16StatusNotificationRequest
>(
86 'assets/json-schemas/ocpp/1.6/StatusNotification.json',
92 OCPP16RequestCommand
.START_TRANSACTION
,
93 OCPP16ServiceUtils
.parseJsonSchemaFile
<OCPP16StartTransactionRequest
>(
94 'assets/json-schemas/ocpp/1.6/StartTransaction.json',
100 OCPP16RequestCommand
.STOP_TRANSACTION
,
101 OCPP16ServiceUtils
.parseJsonSchemaFile
<OCPP16StopTransactionRequest
>(
102 'assets/json-schemas/ocpp/1.6/StopTransaction.json',
108 OCPP16RequestCommand
.DATA_TRANSFER
,
109 OCPP16ServiceUtils
.parseJsonSchemaFile
<OCPP16DataTransferRequest
>(
110 'assets/json-schemas/ocpp/1.6/DataTransfer.json',
116 OCPP16RequestCommand
.FIRMWARE_STATUS_NOTIFICATION
,
117 OCPP16ServiceUtils
.parseJsonSchemaFile
<OCPP16FirmwareStatusNotificationRequest
>(
118 'assets/json-schemas/ocpp/1.6/FirmwareStatusNotification.json',
124 this.buildRequestPayload
= this.buildRequestPayload
.bind(this) as <Request
extends JsonType
>(
125 chargingStation
: ChargingStation
,
126 commandName
: OCPP16RequestCommand
,
127 commandParams
?: JsonType
,
131 public async requestHandler
<RequestType
extends JsonType
, ResponseType
extends JsonType
>(
132 chargingStation
: ChargingStation
,
133 commandName
: OCPP16RequestCommand
,
134 commandParams
?: JsonType
,
135 params
?: RequestParams
,
136 ): Promise
<ResponseType
> {
137 // FIXME?: add sanity checks on charging station availability, connector availability, connector status, etc.
138 if (OCPP16ServiceUtils
.isRequestCommandSupported(chargingStation
, commandName
) === true) {
139 return (await this.sendMessage(
142 this.buildRequestPayload
<RequestType
>(chargingStation
, commandName
, commandParams
),
147 // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError().
149 ErrorType
.NOT_SUPPORTED
,
150 `Unsupported OCPP command '${commandName}'`,
156 private buildRequestPayload
<Request
extends JsonType
>(
157 chargingStation
: ChargingStation
,
158 commandName
: OCPP16RequestCommand
,
159 commandParams
?: JsonType
,
161 let connectorId
: number | undefined;
162 let energyActiveImportRegister
: number;
163 commandParams
= commandParams
as JsonObject
;
164 switch (commandName
) {
165 case OCPP16RequestCommand
.BOOT_NOTIFICATION
:
166 case OCPP16RequestCommand
.DIAGNOSTICS_STATUS_NOTIFICATION
:
167 case OCPP16RequestCommand
.FIRMWARE_STATUS_NOTIFICATION
:
168 case OCPP16RequestCommand
.METER_VALUES
:
169 case OCPP16RequestCommand
.STATUS_NOTIFICATION
:
170 case OCPP16RequestCommand
.DATA_TRANSFER
:
171 return commandParams
as unknown
as Request
;
172 case OCPP16RequestCommand
.AUTHORIZE
:
174 idTag
: Constants
.DEFAULT_IDTAG
,
176 } as unknown
as Request
;
177 case OCPP16RequestCommand
.HEARTBEAT
:
178 return OCPP16Constants
.OCPP_REQUEST_EMPTY
as unknown
as Request
;
179 case OCPP16RequestCommand
.START_TRANSACTION
:
181 idTag
: Constants
.DEFAULT_IDTAG
,
182 meterStart
: chargingStation
.getEnergyActiveImportRegisterByConnectorId(
183 commandParams
?.connectorId
as number,
186 timestamp
: new Date(),
187 ...(OCPP16ServiceUtils
.hasReservation(
189 commandParams
?.connectorId
as number,
190 commandParams
?.idTag
as string,
192 reservationId
: chargingStation
.getReservationBy(
194 chargingStation
.getConnectorStatus(0)?.status === OCPP16ChargePointStatus
.Reserved
196 : (commandParams
?.connectorId
as number),
200 } as unknown
as Request
;
201 case OCPP16RequestCommand
.STOP_TRANSACTION
:
202 chargingStation
.getTransactionDataMeterValues() &&
203 (connectorId
= chargingStation
.getConnectorIdByTransactionId(
204 commandParams
?.transactionId
as number,
206 energyActiveImportRegister
= chargingStation
.getEnergyActiveImportRegisterByTransactionId(
207 commandParams
?.transactionId
as number,
211 idTag
: chargingStation
.getTransactionIdTag(commandParams
?.transactionId
as number),
212 meterStop
: energyActiveImportRegister
,
213 timestamp
: new Date(),
214 ...(chargingStation
.getTransactionDataMeterValues() && {
215 transactionData
: OCPP16ServiceUtils
.buildTransactionDataMeterValues(
216 chargingStation
.getConnectorStatus(connectorId
!)!.transactionBeginMeterValue
!,
217 OCPP16ServiceUtils
.buildTransactionEndMeterValue(
220 energyActiveImportRegister
,
225 } as unknown
as Request
;
227 // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError().
229 ErrorType
.NOT_SUPPORTED
,
230 // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
231 `Unsupported OCPP command '${commandName}'`,