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