Commit | Line | Data |
---|---|---|
edd13439 | 1 | // Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved. |
c8eeb62b | 2 | |
b52c969d JB |
3 | import fs from 'fs'; |
4 | import path from 'path'; | |
5 | import { fileURLToPath } from 'url'; | |
6 | ||
6c1761d4 | 7 | import type { JSONSchemaType } from 'ajv'; |
b52c969d | 8 | |
78202038 | 9 | import { OCPP16ServiceUtils } from './OCPP16ServiceUtils'; |
8114d10e | 10 | import OCPPError from '../../../exception/OCPPError'; |
6c1761d4 JB |
11 | import type { JsonObject, JsonType } from '../../../types/JsonType'; |
12 | import type { OCPP16MeterValuesRequest } from '../../../types/ocpp/1.6/MeterValues'; | |
b52c969d | 13 | import { |
27782dbc JB |
14 | type OCPP16BootNotificationRequest, |
15 | type OCPP16DataTransferRequest, | |
c9a4f9ea | 16 | type OCPP16DiagnosticsStatusNotificationRequest, |
e9a4164c | 17 | type OCPP16FirmwareStatusNotificationRequest, |
27782dbc | 18 | type OCPP16HeartbeatRequest, |
b52c969d | 19 | OCPP16RequestCommand, |
27782dbc | 20 | type OCPP16StatusNotificationRequest, |
b52c969d | 21 | } from '../../../types/ocpp/1.6/Requests'; |
6c1761d4 | 22 | import type { |
b52c969d JB |
23 | OCPP16AuthorizeRequest, |
24 | OCPP16StartTransactionRequest, | |
25 | OCPP16StopTransactionRequest, | |
26 | } from '../../../types/ocpp/1.6/Transaction'; | |
8114d10e | 27 | import { ErrorType } from '../../../types/ocpp/ErrorType'; |
d270cc87 | 28 | import { OCPPVersion } from '../../../types/ocpp/OCPPVersion'; |
6c1761d4 | 29 | import type { RequestParams } from '../../../types/ocpp/Requests'; |
8114d10e | 30 | import Constants from '../../../utils/Constants'; |
c0560973 | 31 | import Utils from '../../../utils/Utils'; |
8114d10e JB |
32 | import type ChargingStation from '../../ChargingStation'; |
33 | import OCPPRequestService from '../OCPPRequestService'; | |
34 | import type OCPPResponseService from '../OCPPResponseService'; | |
c0560973 | 35 | |
909dcf2d JB |
36 | const moduleName = 'OCPP16RequestService'; |
37 | ||
c0560973 | 38 | export default class OCPP16RequestService extends OCPPRequestService { |
b3fc3ff5 | 39 | protected jsonSchemas: Map<OCPP16RequestCommand, JSONSchemaType<JsonObject>>; |
b52c969d | 40 | |
08f130a0 | 41 | public constructor(ocppResponseService: OCPPResponseService) { |
909dcf2d | 42 | if (new.target?.name === moduleName) { |
06127450 | 43 | throw new TypeError(`Cannot construct ${new.target?.name} instances directly`); |
9f2e3130 | 44 | } |
d270cc87 | 45 | super(OCPPVersion.VERSION_16, ocppResponseService); |
b52c969d JB |
46 | this.jsonSchemas = new Map<OCPP16RequestCommand, JSONSchemaType<JsonObject>>([ |
47 | [ | |
48 | OCPP16RequestCommand.AUTHORIZE, | |
e9a4164c JB |
49 | this.parseJsonSchemaFile<OCPP16AuthorizeRequest>( |
50 | '../../../assets/json-schemas/ocpp/1.6/Authorize.json' | |
51 | ), | |
b52c969d JB |
52 | ], |
53 | [ | |
54 | OCPP16RequestCommand.BOOT_NOTIFICATION, | |
e9a4164c JB |
55 | this.parseJsonSchemaFile<OCPP16BootNotificationRequest>( |
56 | '../../../assets/json-schemas/ocpp/1.6/BootNotification.json' | |
57 | ), | |
b52c969d JB |
58 | ], |
59 | [ | |
60 | OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION, | |
e9a4164c JB |
61 | this.parseJsonSchemaFile<OCPP16DiagnosticsStatusNotificationRequest>( |
62 | '../../../assets/json-schemas/ocpp/1.6/DiagnosticsStatusNotification.json' | |
63 | ), | |
b52c969d JB |
64 | ], |
65 | [ | |
66 | OCPP16RequestCommand.HEARTBEAT, | |
e9a4164c JB |
67 | this.parseJsonSchemaFile<OCPP16HeartbeatRequest>( |
68 | '../../../assets/json-schemas/ocpp/1.6/Heartbeat.json' | |
69 | ), | |
b52c969d JB |
70 | ], |
71 | [ | |
72 | OCPP16RequestCommand.METER_VALUES, | |
e9a4164c JB |
73 | this.parseJsonSchemaFile<OCPP16MeterValuesRequest>( |
74 | '../../../assets/json-schemas/ocpp/1.6/MeterValues.json' | |
75 | ), | |
b52c969d JB |
76 | ], |
77 | [ | |
78 | OCPP16RequestCommand.STATUS_NOTIFICATION, | |
e9a4164c JB |
79 | this.parseJsonSchemaFile<OCPP16StatusNotificationRequest>( |
80 | '../../../assets/json-schemas/ocpp/1.6/StatusNotification.json' | |
81 | ), | |
b52c969d JB |
82 | ], |
83 | [ | |
84 | OCPP16RequestCommand.START_TRANSACTION, | |
e9a4164c JB |
85 | this.parseJsonSchemaFile<OCPP16StartTransactionRequest>( |
86 | '../../../assets/json-schemas/ocpp/1.6/StartTransaction.json' | |
87 | ), | |
b52c969d JB |
88 | ], |
89 | [ | |
90 | OCPP16RequestCommand.STOP_TRANSACTION, | |
e9a4164c JB |
91 | this.parseJsonSchemaFile<OCPP16StopTransactionRequest>( |
92 | '../../../assets/json-schemas/ocpp/1.6/StopTransaction.json' | |
93 | ), | |
b52c969d | 94 | ], |
91a7d3ea JB |
95 | [ |
96 | OCPP16RequestCommand.DATA_TRANSFER, | |
e9a4164c JB |
97 | this.parseJsonSchemaFile<OCPP16DataTransferRequest>( |
98 | '../../../assets/json-schemas/ocpp/1.6/DataTransfer.json' | |
99 | ), | |
91a7d3ea | 100 | ], |
c9a4f9ea JB |
101 | [ |
102 | OCPP16RequestCommand.FIRMWARE_STATUS_NOTIFICATION, | |
e9a4164c JB |
103 | this.parseJsonSchemaFile<OCPP16FirmwareStatusNotificationRequest>( |
104 | '../../../assets/json-schemas/ocpp/1.6/FirmwareStatusNotification.json' | |
105 | ), | |
c9a4f9ea | 106 | ], |
b52c969d | 107 | ]); |
9952c548 | 108 | this.buildRequestPayload.bind(this); |
9f2e3130 JB |
109 | } |
110 | ||
6c1761d4 | 111 | public async requestHandler<RequestType extends JsonType, ResponseType extends JsonType>( |
08f130a0 | 112 | chargingStation: ChargingStation, |
94a464f9 | 113 | commandName: OCPP16RequestCommand, |
5cc4b63b | 114 | commandParams?: JsonType, |
be9b0d50 | 115 | params?: RequestParams |
6c1761d4 | 116 | ): Promise<ResponseType> { |
ed6cfcff | 117 | if (OCPP16ServiceUtils.isRequestCommandSupported(chargingStation, commandName) === true) { |
6c1761d4 | 118 | const requestPayload = this.buildRequestPayload<RequestType>( |
b52c969d JB |
119 | chargingStation, |
120 | commandName, | |
121 | commandParams | |
122 | ); | |
f22266fd | 123 | return (await this.sendMessage( |
08f130a0 | 124 | chargingStation, |
94a464f9 | 125 | Utils.generateUUID(), |
b52c969d | 126 | requestPayload, |
94a464f9 JB |
127 | commandName, |
128 | params | |
6c1761d4 | 129 | )) as unknown as ResponseType; |
94a464f9 | 130 | } |
e909d2a7 | 131 | // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError(). |
94a464f9 JB |
132 | throw new OCPPError( |
133 | ErrorType.NOT_SUPPORTED, | |
6c8f5d90 | 134 | `Unsupported OCPP command '${commandName}'`, |
94a464f9 | 135 | commandName, |
7369e417 | 136 | commandParams |
94a464f9 | 137 | ); |
c0560973 JB |
138 | } |
139 | ||
5cc4b63b | 140 | private buildRequestPayload<Request extends JsonType>( |
08f130a0 | 141 | chargingStation: ChargingStation, |
78085c42 | 142 | commandName: OCPP16RequestCommand, |
5cc4b63b | 143 | commandParams?: JsonType |
f22266fd | 144 | ): Request { |
68c993d5 | 145 | let connectorId: number; |
cf058664 | 146 | let energyActiveImportRegister: number; |
5cc4b63b | 147 | commandParams = commandParams as JsonObject; |
78085c42 JB |
148 | switch (commandName) { |
149 | case OCPP16RequestCommand.AUTHORIZE: | |
150 | return { | |
151 | ...(!Utils.isUndefined(commandParams?.idTag) | |
152 | ? { idTag: commandParams.idTag } | |
153 | : { idTag: Constants.DEFAULT_IDTAG }), | |
f22266fd | 154 | } as unknown as Request; |
78085c42 JB |
155 | case OCPP16RequestCommand.BOOT_NOTIFICATION: |
156 | return { | |
157 | chargePointModel: commandParams?.chargePointModel, | |
158 | chargePointVendor: commandParams?.chargePointVendor, | |
159 | ...(!Utils.isUndefined(commandParams?.chargeBoxSerialNumber) && { | |
160 | chargeBoxSerialNumber: commandParams.chargeBoxSerialNumber, | |
161 | }), | |
162 | ...(!Utils.isUndefined(commandParams?.chargePointSerialNumber) && { | |
163 | chargePointSerialNumber: commandParams.chargePointSerialNumber, | |
164 | }), | |
165 | ...(!Utils.isUndefined(commandParams?.firmwareVersion) && { | |
166 | firmwareVersion: commandParams.firmwareVersion, | |
167 | }), | |
168 | ...(!Utils.isUndefined(commandParams?.iccid) && { iccid: commandParams.iccid }), | |
169 | ...(!Utils.isUndefined(commandParams?.imsi) && { imsi: commandParams.imsi }), | |
170 | ...(!Utils.isUndefined(commandParams?.meterSerialNumber) && { | |
171 | meterSerialNumber: commandParams.meterSerialNumber, | |
172 | }), | |
173 | ...(!Utils.isUndefined(commandParams?.meterType) && { | |
174 | meterType: commandParams.meterType, | |
175 | }), | |
f22266fd | 176 | } as unknown as Request; |
78085c42 | 177 | case OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION: |
22e0d48e | 178 | case OCPP16RequestCommand.FIRMWARE_STATUS_NOTIFICATION: |
78085c42 | 179 | return { |
c9a4f9ea | 180 | status: commandParams?.status, |
f22266fd | 181 | } as unknown as Request; |
78085c42 | 182 | case OCPP16RequestCommand.HEARTBEAT: |
f22266fd | 183 | return {} as unknown as Request; |
78085c42 JB |
184 | case OCPP16RequestCommand.METER_VALUES: |
185 | return { | |
186 | connectorId: commandParams?.connectorId, | |
187 | transactionId: commandParams?.transactionId, | |
7369e417 | 188 | meterValue: commandParams?.meterValue, |
f22266fd | 189 | } as unknown as Request; |
78085c42 JB |
190 | case OCPP16RequestCommand.STATUS_NOTIFICATION: |
191 | return { | |
192 | connectorId: commandParams?.connectorId, | |
78085c42 | 193 | status: commandParams?.status, |
93b4a429 | 194 | errorCode: commandParams?.errorCode, |
f1e731bd JB |
195 | ...(!Utils.isUndefined(commandParams?.info) && { |
196 | info: commandParams?.info, | |
197 | }), | |
198 | ...(!Utils.isUndefined(commandParams?.timestamp) && { | |
199 | timestamp: commandParams?.timestamp, | |
200 | }), | |
201 | ...(!Utils.isUndefined(commandParams?.vendorId) && { | |
202 | vendorId: commandParams?.vendorId, | |
203 | }), | |
204 | ...(!Utils.isUndefined(commandParams?.vendorErrorCode) && { | |
205 | vendorErrorCode: commandParams?.vendorErrorCode, | |
206 | }), | |
f22266fd | 207 | } as unknown as Request; |
78085c42 JB |
208 | case OCPP16RequestCommand.START_TRANSACTION: |
209 | return { | |
210 | connectorId: commandParams?.connectorId, | |
211 | ...(!Utils.isUndefined(commandParams?.idTag) | |
212 | ? { idTag: commandParams?.idTag } | |
213 | : { idTag: Constants.DEFAULT_IDTAG }), | |
f1e731bd JB |
214 | meterStart: |
215 | commandParams?.meterStart ?? | |
216 | chargingStation.getEnergyActiveImportRegisterByConnectorId( | |
217 | commandParams?.connectorId as number | |
218 | ), | |
b2a0452d | 219 | timestamp: commandParams?.timestamp ?? new Date(), |
f1e731bd JB |
220 | ...(!Utils.isUndefined(commandParams?.reservationId) && { |
221 | reservationId: commandParams?.reservationId, | |
222 | }), | |
f22266fd | 223 | } as unknown as Request; |
78085c42 | 224 | case OCPP16RequestCommand.STOP_TRANSACTION: |
f1e731bd | 225 | chargingStation.getTransactionDataMeterValues() && |
cda96260 | 226 | Utils.isNullOrUndefined(commandParams?.transactionData) && |
f1e731bd JB |
227 | (connectorId = chargingStation.getConnectorIdByTransactionId( |
228 | commandParams?.transactionId as number | |
229 | )); | |
cda96260 | 230 | Utils.isNullOrUndefined(commandParams?.meterStop) && |
7acb3f7b JB |
231 | (energyActiveImportRegister = |
232 | chargingStation.getEnergyActiveImportRegisterByTransactionId( | |
233 | commandParams?.transactionId as number, | |
234 | true | |
235 | )); | |
78085c42 JB |
236 | return { |
237 | transactionId: commandParams?.transactionId, | |
cf058664 JB |
238 | idTag: |
239 | commandParams?.idTag ?? | |
240 | chargingStation.getTransactionIdTag(commandParams?.transactionId as number), | |
241 | meterStop: commandParams?.meterStop ?? energyActiveImportRegister, | |
b2a0452d | 242 | timestamp: commandParams?.timestamp ?? new Date(), |
f1e731bd JB |
243 | ...(!Utils.isUndefined(commandParams?.reason) && { |
244 | reason: commandParams?.reason, | |
78085c42 | 245 | }), |
f1e731bd JB |
246 | ...(!Utils.isUndefined(commandParams?.transactionData) |
247 | ? { transactionData: commandParams?.transactionData } | |
248 | : chargingStation.getTransactionDataMeterValues() && { | |
249 | transactionData: OCPP16ServiceUtils.buildTransactionDataMeterValues( | |
250 | chargingStation.getConnectorStatus(connectorId).transactionBeginMeterValue, | |
251 | OCPP16ServiceUtils.buildTransactionEndMeterValue( | |
252 | chargingStation, | |
253 | connectorId, | |
254 | (commandParams?.meterStop as number) ?? energyActiveImportRegister | |
255 | ) | |
256 | ), | |
257 | }), | |
f22266fd | 258 | } as unknown as Request; |
91a7d3ea JB |
259 | case OCPP16RequestCommand.DATA_TRANSFER: |
260 | return commandParams as unknown as Request; | |
78085c42 | 261 | default: |
e909d2a7 | 262 | // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError(). |
78085c42 JB |
263 | throw new OCPPError( |
264 | ErrorType.NOT_SUPPORTED, | |
265 | // eslint-disable-next-line @typescript-eslint/restrict-template-expressions | |
6c8f5d90 | 266 | `Unsupported OCPP command '${commandName}'`, |
78085c42 | 267 | commandName, |
7369e417 | 268 | commandParams |
78085c42 JB |
269 | ); |
270 | } | |
271 | } | |
e9a4164c JB |
272 | |
273 | private parseJsonSchemaFile<T extends JsonType>(relativePath: string): JSONSchemaType<T> { | |
274 | return JSON.parse( | |
275 | fs.readFileSync( | |
276 | path.resolve(path.dirname(fileURLToPath(import.meta.url)), relativePath), | |
277 | 'utf8' | |
278 | ) | |
279 | ) as JSONSchemaType<T>; | |
280 | } | |
c0560973 | 281 | } |