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 DiagnosticsStatusNotificationRequest
,
14 OCPP16BootNotificationRequest
,
15 OCPP16HeartbeatRequest
,
17 OCPP16StatusNotificationRequest
,
18 } from
'../../../types/ocpp/1.6/Requests';
20 OCPP16AuthorizeRequest
,
21 OCPP16StartTransactionRequest
,
22 OCPP16StopTransactionRequest
,
23 } from
'../../../types/ocpp/1.6/Transaction';
24 import { ErrorType
} from
'../../../types/ocpp/ErrorType';
25 import type { RequestParams
} from
'../../../types/ocpp/Requests';
26 import Constants from
'../../../utils/Constants';
27 import logger from
'../../../utils/Logger';
28 import Utils from
'../../../utils/Utils';
29 import type ChargingStation from
'../../ChargingStation';
30 import { ChargingStationUtils
} from
'../../ChargingStationUtils';
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 this.buildRequestPayload
.bind(this);
144 this.validatePayload
.bind(this);
147 public async requestHandler
<RequestType
extends JsonType
, ResponseType
extends JsonType
>(
148 chargingStation
: ChargingStation
,
149 commandName
: OCPP16RequestCommand
,
150 commandParams
?: JsonType
,
151 params
?: RequestParams
152 ): Promise
<ResponseType
> {
153 if (ChargingStationUtils
.isRequestCommandSupported(commandName
, chargingStation
)) {
154 const requestPayload
= this.buildRequestPayload
<RequestType
>(
159 this.validatePayload(chargingStation
, commandName
, requestPayload
);
160 return (await this.sendMessage(
162 Utils
.generateUUID(),
166 )) as unknown
as ResponseType
;
169 ErrorType
.NOT_SUPPORTED
,
170 `Unsupported OCPP command '${commandName}'`,
176 private buildRequestPayload
<Request
extends JsonType
>(
177 chargingStation
: ChargingStation
,
178 commandName
: OCPP16RequestCommand
,
179 commandParams
?: JsonType
181 let connectorId
: number;
182 commandParams
= commandParams
as JsonObject
;
183 switch (commandName
) {
184 case OCPP16RequestCommand
.AUTHORIZE
:
186 ...(!Utils
.isUndefined(commandParams
?.idTag
)
187 ? { idTag
: commandParams
.idTag
}
188 : { idTag
: Constants
.DEFAULT_IDTAG
}),
189 } as unknown
as Request
;
190 case OCPP16RequestCommand
.BOOT_NOTIFICATION
:
192 chargePointModel
: commandParams
?.chargePointModel
,
193 chargePointVendor
: commandParams
?.chargePointVendor
,
194 ...(!Utils
.isUndefined(commandParams
?.chargeBoxSerialNumber
) && {
195 chargeBoxSerialNumber
: commandParams
.chargeBoxSerialNumber
,
197 ...(!Utils
.isUndefined(commandParams
?.chargePointSerialNumber
) && {
198 chargePointSerialNumber
: commandParams
.chargePointSerialNumber
,
200 ...(!Utils
.isUndefined(commandParams
?.firmwareVersion
) && {
201 firmwareVersion
: commandParams
.firmwareVersion
,
203 ...(!Utils
.isUndefined(commandParams
?.iccid
) && { iccid
: commandParams
.iccid
}),
204 ...(!Utils
.isUndefined(commandParams
?.imsi
) && { imsi
: commandParams
.imsi
}),
205 ...(!Utils
.isUndefined(commandParams
?.meterSerialNumber
) && {
206 meterSerialNumber
: commandParams
.meterSerialNumber
,
208 ...(!Utils
.isUndefined(commandParams
?.meterType
) && {
209 meterType
: commandParams
.meterType
,
211 } as unknown
as Request
;
212 case OCPP16RequestCommand
.DIAGNOSTICS_STATUS_NOTIFICATION
:
214 status: commandParams
?.diagnosticsStatus
,
215 } as unknown
as Request
;
216 case OCPP16RequestCommand
.HEARTBEAT
:
217 return {} as unknown
as Request
;
218 case OCPP16RequestCommand
.METER_VALUES
:
220 connectorId
: commandParams
?.connectorId
,
221 transactionId
: commandParams
?.transactionId
,
222 meterValue
: commandParams
?.meterValue
,
223 } as unknown
as Request
;
224 case OCPP16RequestCommand
.STATUS_NOTIFICATION
:
226 connectorId
: commandParams
?.connectorId
,
227 status: commandParams
?.status,
228 errorCode
: commandParams
?.errorCode
,
229 } as unknown
as Request
;
230 case OCPP16RequestCommand
.START_TRANSACTION
:
232 connectorId
: commandParams
?.connectorId
,
233 ...(!Utils
.isUndefined(commandParams
?.idTag
)
234 ? { idTag
: commandParams
?.idTag
}
235 : { idTag
: Constants
.DEFAULT_IDTAG
}),
236 meterStart
: chargingStation
.getEnergyActiveImportRegisterByConnectorId(
237 commandParams
?.connectorId
as number
239 timestamp
: new Date().toISOString(),
240 } as unknown
as Request
;
241 case OCPP16RequestCommand
.STOP_TRANSACTION
:
242 connectorId
= chargingStation
.getConnectorIdByTransactionId(
243 commandParams
?.transactionId
as number
246 transactionId
: commandParams
?.transactionId
,
247 ...(!Utils
.isUndefined(commandParams
?.idTag
) && { idTag
: commandParams
.idTag
}),
248 meterStop
: commandParams
?.meterStop
,
249 timestamp
: new Date().toISOString(),
250 ...(commandParams
?.reason
&& { reason
: commandParams
.reason
}),
251 ...(chargingStation
.getTransactionDataMeterValues() && {
252 transactionData
: OCPP16ServiceUtils
.buildTransactionDataMeterValues(
253 chargingStation
.getConnectorStatus(connectorId
).transactionBeginMeterValue
,
254 OCPP16ServiceUtils
.buildTransactionEndMeterValue(
257 commandParams
?.meterStop
as number
261 } as unknown
as Request
;
264 ErrorType
.NOT_SUPPORTED
,
265 // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
266 `Unsupported OCPP command '${commandName}'`,
273 private validatePayload
<Request
extends JsonType
>(
274 chargingStation
: ChargingStation
,
275 commandName
: OCPP16RequestCommand
,
276 requestPayload
: Request
278 if (this.jsonSchemas
.has(commandName
)) {
279 return this.validateRequestPayload(
282 this.jsonSchemas
.get(commandName
),
287 `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema found for command ${commandName} PDU validation`