1 // Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
4 import path from
'path';
5 import { fileURLToPath
} from
'url';
7 import type { JSONSchemaType
} from
'ajv';
9 import OCPPError from
'../../../exception/OCPPError';
10 import type { JsonObject
, JsonType
} from
'../../../types/JsonType';
11 import type { OCPP16MeterValuesRequest
} from
'../../../types/ocpp/1.6/MeterValues';
13 type DiagnosticsStatusNotificationRequest
,
14 type OCPP16BootNotificationRequest
,
15 type OCPP16DataTransferRequest
,
16 type OCPP16HeartbeatRequest
,
18 type OCPP16StatusNotificationRequest
,
19 } from
'../../../types/ocpp/1.6/Requests';
21 OCPP16AuthorizeRequest
,
22 OCPP16StartTransactionRequest
,
23 OCPP16StopTransactionRequest
,
24 } from
'../../../types/ocpp/1.6/Transaction';
25 import { ErrorType
} from
'../../../types/ocpp/ErrorType';
26 import type { RequestParams
} from
'../../../types/ocpp/Requests';
27 import Constants from
'../../../utils/Constants';
28 import logger from
'../../../utils/Logger';
29 import Utils from
'../../../utils/Utils';
30 import type ChargingStation from
'../../ChargingStation';
31 import OCPPRequestService from
'../OCPPRequestService';
32 import type OCPPResponseService from
'../OCPPResponseService';
33 import { OCPP16ServiceUtils
} from
'./OCPP16ServiceUtils';
35 const moduleName
= 'OCPP16RequestService';
37 export default class OCPP16RequestService
extends OCPPRequestService
{
38 private jsonSchemas
: Map
<OCPP16RequestCommand
, JSONSchemaType
<JsonObject
>>;
40 public constructor(ocppResponseService
: OCPPResponseService
) {
41 if (new.target
?.name
=== moduleName
) {
42 throw new TypeError(`Cannot construct ${new.target?.name} instances directly`);
44 super(ocppResponseService
);
45 this.jsonSchemas
= new Map
<OCPP16RequestCommand
, JSONSchemaType
<JsonObject
>>([
47 OCPP16RequestCommand
.AUTHORIZE
,
51 path
.dirname(fileURLToPath(import.meta
.url
)),
52 '../../../assets/json-schemas/ocpp/1.6/Authorize.json'
56 ) as JSONSchemaType
<OCPP16AuthorizeRequest
>,
59 OCPP16RequestCommand
.BOOT_NOTIFICATION
,
63 path
.dirname(fileURLToPath(import.meta
.url
)),
64 '../../../assets/json-schemas/ocpp/1.6/BootNotification.json'
68 ) as JSONSchemaType
<OCPP16BootNotificationRequest
>,
71 OCPP16RequestCommand
.DIAGNOSTICS_STATUS_NOTIFICATION
,
75 path
.dirname(fileURLToPath(import.meta
.url
)),
76 '../../../assets/json-schemas/ocpp/1.6/DiagnosticsStatusNotification.json'
80 ) as JSONSchemaType
<DiagnosticsStatusNotificationRequest
>,
83 OCPP16RequestCommand
.HEARTBEAT
,
87 path
.dirname(fileURLToPath(import.meta
.url
)),
88 '../../../assets/json-schemas/ocpp/1.6/Heartbeat.json'
92 ) as JSONSchemaType
<OCPP16HeartbeatRequest
>,
95 OCPP16RequestCommand
.METER_VALUES
,
99 path
.dirname(fileURLToPath(import.meta
.url
)),
100 '../../../assets/json-schemas/ocpp/1.6/MeterValues.json'
104 ) as JSONSchemaType
<OCPP16MeterValuesRequest
>,
107 OCPP16RequestCommand
.STATUS_NOTIFICATION
,
111 path
.dirname(fileURLToPath(import.meta
.url
)),
112 '../../../assets/json-schemas/ocpp/1.6/StatusNotification.json'
116 ) as JSONSchemaType
<OCPP16StatusNotificationRequest
>,
119 OCPP16RequestCommand
.START_TRANSACTION
,
123 path
.dirname(fileURLToPath(import.meta
.url
)),
124 '../../../assets/json-schemas/ocpp/1.6/StartTransaction.json'
128 ) as JSONSchemaType
<OCPP16StartTransactionRequest
>,
131 OCPP16RequestCommand
.STOP_TRANSACTION
,
135 path
.dirname(fileURLToPath(import.meta
.url
)),
136 '../../../assets/json-schemas/ocpp/1.6/StopTransaction.json'
140 ) as JSONSchemaType
<OCPP16StopTransactionRequest
>,
143 OCPP16RequestCommand
.DATA_TRANSFER
,
147 path
.dirname(fileURLToPath(import.meta
.url
)),
148 '../../../assets/json-schemas/ocpp/1.6/DataTransfer.json'
152 ) as JSONSchemaType
<OCPP16DataTransferRequest
>,
155 this.buildRequestPayload
.bind(this);
156 this.validatePayload
.bind(this);
159 public async requestHandler
<RequestType
extends JsonType
, ResponseType
extends JsonType
>(
160 chargingStation
: ChargingStation
,
161 commandName
: OCPP16RequestCommand
,
162 commandParams
?: JsonType
,
163 params
?: RequestParams
164 ): Promise
<ResponseType
> {
165 if (OCPP16ServiceUtils
.isRequestCommandSupported(chargingStation
, commandName
) === true) {
166 const requestPayload
= this.buildRequestPayload
<RequestType
>(
171 this.validatePayload(chargingStation
, commandName
, requestPayload
);
172 return (await this.sendMessage(
174 Utils
.generateUUID(),
178 )) as unknown
as ResponseType
;
180 // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError().
182 ErrorType
.NOT_SUPPORTED
,
183 `Unsupported OCPP command '${commandName}'`,
189 private buildRequestPayload
<Request
extends JsonType
>(
190 chargingStation
: ChargingStation
,
191 commandName
: OCPP16RequestCommand
,
192 commandParams
?: JsonType
194 let connectorId
: number;
195 let energyActiveImportRegister
: number;
196 commandParams
= commandParams
as JsonObject
;
197 switch (commandName
) {
198 case OCPP16RequestCommand
.AUTHORIZE
:
200 ...(!Utils
.isUndefined(commandParams
?.idTag
)
201 ? { idTag
: commandParams
.idTag
}
202 : { idTag
: Constants
.DEFAULT_IDTAG
}),
203 } as unknown
as Request
;
204 case OCPP16RequestCommand
.BOOT_NOTIFICATION
:
206 chargePointModel
: commandParams
?.chargePointModel
,
207 chargePointVendor
: commandParams
?.chargePointVendor
,
208 ...(!Utils
.isUndefined(commandParams
?.chargeBoxSerialNumber
) && {
209 chargeBoxSerialNumber
: commandParams
.chargeBoxSerialNumber
,
211 ...(!Utils
.isUndefined(commandParams
?.chargePointSerialNumber
) && {
212 chargePointSerialNumber
: commandParams
.chargePointSerialNumber
,
214 ...(!Utils
.isUndefined(commandParams
?.firmwareVersion
) && {
215 firmwareVersion
: commandParams
.firmwareVersion
,
217 ...(!Utils
.isUndefined(commandParams
?.iccid
) && { iccid
: commandParams
.iccid
}),
218 ...(!Utils
.isUndefined(commandParams
?.imsi
) && { imsi
: commandParams
.imsi
}),
219 ...(!Utils
.isUndefined(commandParams
?.meterSerialNumber
) && {
220 meterSerialNumber
: commandParams
.meterSerialNumber
,
222 ...(!Utils
.isUndefined(commandParams
?.meterType
) && {
223 meterType
: commandParams
.meterType
,
225 } as unknown
as Request
;
226 case OCPP16RequestCommand
.DIAGNOSTICS_STATUS_NOTIFICATION
:
228 status: commandParams
?.diagnosticsStatus
,
229 } as unknown
as Request
;
230 case OCPP16RequestCommand
.HEARTBEAT
:
231 return {} as unknown
as Request
;
232 case OCPP16RequestCommand
.METER_VALUES
:
234 connectorId
: commandParams
?.connectorId
,
235 transactionId
: commandParams
?.transactionId
,
236 meterValue
: commandParams
?.meterValue
,
237 } as unknown
as Request
;
238 case OCPP16RequestCommand
.STATUS_NOTIFICATION
:
240 connectorId
: commandParams
?.connectorId
,
241 status: commandParams
?.status,
242 errorCode
: commandParams
?.errorCode
,
243 } as unknown
as Request
;
244 case OCPP16RequestCommand
.START_TRANSACTION
:
246 connectorId
: commandParams
?.connectorId
,
247 ...(!Utils
.isUndefined(commandParams
?.idTag
)
248 ? { idTag
: commandParams
?.idTag
}
249 : { idTag
: Constants
.DEFAULT_IDTAG
}),
250 meterStart
: chargingStation
.getEnergyActiveImportRegisterByConnectorId(
251 commandParams
?.connectorId
as number
253 timestamp
: new Date().toISOString(),
254 } as unknown
as Request
;
255 case OCPP16RequestCommand
.STOP_TRANSACTION
:
256 connectorId
= chargingStation
.getConnectorIdByTransactionId(
257 commandParams
?.transactionId
as number
259 commandParams
?.meterStop
&&
260 (energyActiveImportRegister
=
261 chargingStation
.getEnergyActiveImportRegisterByTransactionId(
262 commandParams
?.transactionId
as number,
266 transactionId
: commandParams
?.transactionId
,
268 commandParams
?.idTag
??
269 chargingStation
.getTransactionIdTag(commandParams
?.transactionId
as number),
270 meterStop
: commandParams
?.meterStop
?? energyActiveImportRegister
,
271 timestamp
: new Date().toISOString(),
272 reason
: commandParams
?.reason
,
273 ...(chargingStation
.getTransactionDataMeterValues() && {
274 transactionData
: OCPP16ServiceUtils
.buildTransactionDataMeterValues(
275 chargingStation
.getConnectorStatus(connectorId
).transactionBeginMeterValue
,
276 OCPP16ServiceUtils
.buildTransactionEndMeterValue(
279 (commandParams
?.meterStop
as number) ?? energyActiveImportRegister
283 } as unknown
as Request
;
284 case OCPP16RequestCommand
.DATA_TRANSFER
:
285 return commandParams
as unknown
as Request
;
287 // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError().
289 ErrorType
.NOT_SUPPORTED
,
290 // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
291 `Unsupported OCPP command '${commandName}'`,
298 private validatePayload
<Request
extends JsonType
>(
299 chargingStation
: ChargingStation
,
300 commandName
: OCPP16RequestCommand
,
301 requestPayload
: Request
303 if (this.jsonSchemas
.has(commandName
)) {
304 return this.validateRequestPayload(
307 this.jsonSchemas
.get(commandName
),
312 `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema found for command ${commandName} PDU validation`