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 | ||
7 | import { JSONSchemaType } from 'ajv'; | |
8 | ||
8114d10e | 9 | import OCPPError from '../../../exception/OCPPError'; |
5cc4b63b | 10 | import { JsonObject, JsonType } from '../../../types/JsonType'; |
b52c969d JB |
11 | import { OCPP16MeterValuesRequest } from '../../../types/ocpp/1.6/MeterValues'; |
12 | import { | |
13 | DiagnosticsStatusNotificationRequest, | |
14 | OCPP16BootNotificationRequest, | |
15 | OCPP16HeartbeatRequest, | |
16 | OCPP16RequestCommand, | |
17 | OCPP16StatusNotificationRequest, | |
18 | } from '../../../types/ocpp/1.6/Requests'; | |
19 | import { | |
20 | OCPP16AuthorizeRequest, | |
21 | OCPP16StartTransactionRequest, | |
22 | OCPP16StopTransactionRequest, | |
23 | } from '../../../types/ocpp/1.6/Transaction'; | |
8114d10e | 24 | import { ErrorType } from '../../../types/ocpp/ErrorType'; |
be9b0d50 | 25 | import { 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 | ||
5cc4b63b | 147 | public async requestHandler<Request extends JsonType, Response extends JsonType>( |
08f130a0 | 148 | chargingStation: ChargingStation, |
94a464f9 | 149 | commandName: OCPP16RequestCommand, |
5cc4b63b | 150 | commandParams?: JsonType, |
be9b0d50 | 151 | params?: RequestParams |
f22266fd | 152 | ): Promise<Response> { |
ada189a8 | 153 | if (ChargingStationUtils.isRequestCommandSupported(commandName, chargingStation)) { |
b52c969d JB |
154 | const requestPayload = this.buildRequestPayload<Request>( |
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 | |
f22266fd | 166 | )) as unknown as Response; |
94a464f9 JB |
167 | } |
168 | throw new OCPPError( | |
169 | ErrorType.NOT_SUPPORTED, | |
ada189a8 | 170 | `${moduleName}.requestHandler: 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; |
5cc4b63b | 182 | commandParams = commandParams as JsonObject; |
78085c42 JB |
183 | switch (commandName) { |
184 | case OCPP16RequestCommand.AUTHORIZE: | |
185 | return { | |
186 | ...(!Utils.isUndefined(commandParams?.idTag) | |
187 | ? { idTag: commandParams.idTag } | |
188 | : { idTag: Constants.DEFAULT_IDTAG }), | |
f22266fd | 189 | } as unknown as Request; |
78085c42 JB |
190 | case OCPP16RequestCommand.BOOT_NOTIFICATION: |
191 | return { | |
192 | chargePointModel: commandParams?.chargePointModel, | |
193 | chargePointVendor: commandParams?.chargePointVendor, | |
194 | ...(!Utils.isUndefined(commandParams?.chargeBoxSerialNumber) && { | |
195 | chargeBoxSerialNumber: commandParams.chargeBoxSerialNumber, | |
196 | }), | |
197 | ...(!Utils.isUndefined(commandParams?.chargePointSerialNumber) && { | |
198 | chargePointSerialNumber: commandParams.chargePointSerialNumber, | |
199 | }), | |
200 | ...(!Utils.isUndefined(commandParams?.firmwareVersion) && { | |
201 | firmwareVersion: commandParams.firmwareVersion, | |
202 | }), | |
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, | |
207 | }), | |
208 | ...(!Utils.isUndefined(commandParams?.meterType) && { | |
209 | meterType: commandParams.meterType, | |
210 | }), | |
f22266fd | 211 | } as unknown as Request; |
78085c42 JB |
212 | case OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION: |
213 | return { | |
214 | status: commandParams?.diagnosticsStatus, | |
f22266fd | 215 | } as unknown as Request; |
78085c42 | 216 | case OCPP16RequestCommand.HEARTBEAT: |
f22266fd | 217 | return {} as unknown as Request; |
78085c42 JB |
218 | case OCPP16RequestCommand.METER_VALUES: |
219 | return { | |
220 | connectorId: commandParams?.connectorId, | |
221 | transactionId: commandParams?.transactionId, | |
7369e417 | 222 | meterValue: commandParams?.meterValue, |
f22266fd | 223 | } as unknown as Request; |
78085c42 JB |
224 | case OCPP16RequestCommand.STATUS_NOTIFICATION: |
225 | return { | |
226 | connectorId: commandParams?.connectorId, | |
78085c42 | 227 | status: commandParams?.status, |
93b4a429 | 228 | errorCode: commandParams?.errorCode, |
f22266fd | 229 | } as unknown as Request; |
78085c42 JB |
230 | case OCPP16RequestCommand.START_TRANSACTION: |
231 | return { | |
232 | connectorId: commandParams?.connectorId, | |
233 | ...(!Utils.isUndefined(commandParams?.idTag) | |
234 | ? { idTag: commandParams?.idTag } | |
235 | : { idTag: Constants.DEFAULT_IDTAG }), | |
08f130a0 | 236 | meterStart: chargingStation.getEnergyActiveImportRegisterByConnectorId( |
78085c42 JB |
237 | commandParams?.connectorId as number |
238 | ), | |
239 | timestamp: new Date().toISOString(), | |
f22266fd | 240 | } as unknown as Request; |
78085c42 | 241 | case OCPP16RequestCommand.STOP_TRANSACTION: |
08f130a0 | 242 | connectorId = chargingStation.getConnectorIdByTransactionId( |
f479a792 JB |
243 | commandParams?.transactionId as number |
244 | ); | |
78085c42 JB |
245 | return { |
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 }), | |
08f130a0 | 251 | ...(chargingStation.getTransactionDataMeterValues() && { |
78085c42 | 252 | transactionData: OCPP16ServiceUtils.buildTransactionDataMeterValues( |
08f130a0 | 253 | chargingStation.getConnectorStatus(connectorId).transactionBeginMeterValue, |
78085c42 | 254 | OCPP16ServiceUtils.buildTransactionEndMeterValue( |
08f130a0 | 255 | chargingStation, |
68c993d5 | 256 | connectorId, |
78085c42 JB |
257 | commandParams?.meterStop as number |
258 | ) | |
259 | ), | |
260 | }), | |
f22266fd | 261 | } as unknown as Request; |
78085c42 JB |
262 | default: |
263 | throw new OCPPError( | |
264 | ErrorType.NOT_SUPPORTED, | |
265 | // eslint-disable-next-line @typescript-eslint/restrict-template-expressions | |
ada189a8 | 266 | `${moduleName}.buildRequestPayload: Unsupported OCPP command '${commandName}'`, |
78085c42 | 267 | commandName, |
7369e417 | 268 | commandParams |
78085c42 JB |
269 | ); |
270 | } | |
271 | } | |
9c5c4195 JB |
272 | |
273 | private validatePayload<Request extends JsonType>( | |
274 | chargingStation: ChargingStation, | |
275 | commandName: OCPP16RequestCommand, | |
276 | requestPayload: Request | |
277 | ): boolean { | |
278 | if (this.jsonSchemas.has(commandName)) { | |
279 | return this.validateRequestPayload( | |
280 | chargingStation, | |
281 | commandName, | |
282 | this.jsonSchemas.get(commandName), | |
283 | requestPayload | |
284 | ); | |
285 | } | |
286 | logger.warn( | |
ee307db5 | 287 | `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema found for command ${commandName} PDU validation` |
9c5c4195 JB |
288 | ); |
289 | return false; | |
290 | } | |
c0560973 | 291 | } |