Commit | Line | Data |
---|---|---|
c8eeb62b JB |
1 | // Partial Copyright Jerome Benoit. 2021. All Rights Reserved. |
2 | ||
e7aeea18 JB |
3 | import { |
4 | AuthorizeRequest, | |
5 | OCPP16AuthorizeResponse, | |
6 | OCPP16StartTransactionResponse, | |
7 | OCPP16StopTransactionReason, | |
8 | OCPP16StopTransactionResponse, | |
9 | StartTransactionRequest, | |
10 | StopTransactionRequest, | |
11 | } from '../../../types/ocpp/1.6/Transaction'; | |
e7aeea18 JB |
12 | import { |
13 | DiagnosticsStatusNotificationRequest, | |
14 | HeartbeatRequest, | |
15 | OCPP16BootNotificationRequest, | |
16 | OCPP16RequestCommand, | |
17 | StatusNotificationRequest, | |
18 | } from '../../../types/ocpp/1.6/Requests'; | |
78085c42 | 19 | import { MeterValuesRequest, OCPP16MeterValue } from '../../../types/ocpp/1.6/MeterValues'; |
94a464f9 | 20 | import { ResponseType, SendParams } from '../../../types/ocpp/Requests'; |
c0560973 | 21 | |
73b9adec | 22 | import type ChargingStation from '../../ChargingStation'; |
c0560973 | 23 | import Constants from '../../../utils/Constants'; |
14763b46 | 24 | import { ErrorType } from '../../../types/ocpp/ErrorType'; |
78085c42 | 25 | import { JsonType } from '../../../types/JsonType'; |
efa43e52 | 26 | import { OCPP16BootNotificationResponse } from '../../../types/ocpp/1.6/Responses'; |
c0560973 JB |
27 | import { OCPP16ChargePointErrorCode } from '../../../types/ocpp/1.6/ChargePointErrorCode'; |
28 | import { OCPP16ChargePointStatus } from '../../../types/ocpp/1.6/ChargePointStatus'; | |
47e22477 | 29 | import { OCPP16DiagnosticsStatus } from '../../../types/ocpp/1.6/DiagnosticsStatus'; |
6ed92bc1 | 30 | import { OCPP16ServiceUtils } from './OCPP16ServiceUtils'; |
e58068fd | 31 | import OCPPError from '../../../exception/OCPPError'; |
c0560973 | 32 | import OCPPRequestService from '../OCPPRequestService'; |
73b9adec | 33 | import type OCPPResponseService from '../OCPPResponseService'; |
c0560973 | 34 | import Utils from '../../../utils/Utils'; |
c0560973 | 35 | |
909dcf2d JB |
36 | const moduleName = 'OCPP16RequestService'; |
37 | ||
c0560973 | 38 | export default class OCPP16RequestService extends OCPPRequestService { |
9f2e3130 | 39 | public constructor(chargingStation: ChargingStation, ocppResponseService: OCPPResponseService) { |
909dcf2d | 40 | if (new.target?.name === moduleName) { |
06127450 | 41 | throw new TypeError(`Cannot construct ${new.target?.name} instances directly`); |
9f2e3130 JB |
42 | } |
43 | super(chargingStation, ocppResponseService); | |
44 | } | |
45 | ||
94a464f9 JB |
46 | public async sendMessageHandler( |
47 | commandName: OCPP16RequestCommand, | |
48 | commandParams?: JsonType, | |
49 | params?: SendParams | |
50 | ): Promise<ResponseType> { | |
51 | if (Object.values(OCPP16RequestCommand).includes(commandName)) { | |
52 | return this.sendMessage( | |
53 | Utils.generateUUID(), | |
54 | this.buildCommandPayload(commandName, commandParams), | |
55 | commandName, | |
56 | params | |
57 | ); | |
58 | } | |
59 | throw new OCPPError( | |
60 | ErrorType.NOT_SUPPORTED, | |
61 | `${moduleName}.sendMessageHandler: Unsupported OCPP command ${commandName}`, | |
62 | commandName, | |
63 | { commandName } | |
64 | ); | |
c0560973 JB |
65 | } |
66 | ||
e7aeea18 JB |
67 | public async sendBootNotification( |
68 | chargePointModel: string, | |
69 | chargePointVendor: string, | |
70 | chargeBoxSerialNumber?: string, | |
71 | firmwareVersion?: string, | |
72 | chargePointSerialNumber?: string, | |
73 | iccid?: string, | |
74 | imsi?: string, | |
75 | meterSerialNumber?: string, | |
76 | meterType?: string, | |
77 | params?: SendParams | |
78 | ): Promise<OCPP16BootNotificationResponse> { | |
5e0c67e8 JB |
79 | const payload: OCPP16BootNotificationRequest = { |
80 | chargePointModel, | |
81 | chargePointVendor, | |
e7aeea18 JB |
82 | ...(!Utils.isUndefined(chargeBoxSerialNumber) && { chargeBoxSerialNumber }), |
83 | ...(!Utils.isUndefined(chargePointSerialNumber) && { chargePointSerialNumber }), | |
84 | ...(!Utils.isUndefined(firmwareVersion) && { firmwareVersion }), | |
85 | ...(!Utils.isUndefined(iccid) && { iccid }), | |
86 | ...(!Utils.isUndefined(imsi) && { imsi }), | |
87 | ...(!Utils.isUndefined(meterSerialNumber) && { meterSerialNumber }), | |
88 | ...(!Utils.isUndefined(meterType) && { meterType }), | |
5e0c67e8 | 89 | }; |
e7aeea18 JB |
90 | return (await this.sendMessage( |
91 | Utils.generateUUID(), | |
92 | payload, | |
93 | OCPP16RequestCommand.BOOT_NOTIFICATION, | |
94 | { ...params, skipBufferingOnError: true } | |
95 | )) as OCPP16BootNotificationResponse; | |
c0560973 JB |
96 | } |
97 | ||
e7aeea18 JB |
98 | public async sendStatusNotification( |
99 | connectorId: number, | |
100 | status: OCPP16ChargePointStatus, | |
101 | errorCode: OCPP16ChargePointErrorCode = OCPP16ChargePointErrorCode.NO_ERROR | |
102 | ): Promise<void> { | |
5e0c67e8 JB |
103 | const payload: StatusNotificationRequest = { |
104 | connectorId, | |
105 | errorCode, | |
106 | status, | |
107 | }; | |
108 | await this.sendMessage(Utils.generateUUID(), payload, OCPP16RequestCommand.STATUS_NOTIFICATION); | |
c0560973 JB |
109 | } |
110 | ||
e7aeea18 JB |
111 | public async sendAuthorize( |
112 | connectorId: number, | |
113 | idTag?: string | |
114 | ): Promise<OCPP16AuthorizeResponse> { | |
5e0c67e8 | 115 | const payload: AuthorizeRequest = { |
e7aeea18 | 116 | ...(!Utils.isUndefined(idTag) ? { idTag } : { idTag: Constants.DEFAULT_IDTAG }), |
5e0c67e8 JB |
117 | }; |
118 | this.chargingStation.getConnectorStatus(connectorId).authorizeIdTag = idTag; | |
e7aeea18 JB |
119 | return (await this.sendMessage( |
120 | Utils.generateUUID(), | |
121 | payload, | |
122 | OCPP16RequestCommand.AUTHORIZE | |
123 | )) as OCPP16AuthorizeResponse; | |
c0560973 JB |
124 | } |
125 | ||
e7aeea18 JB |
126 | public async sendStartTransaction( |
127 | connectorId: number, | |
128 | idTag?: string | |
129 | ): Promise<OCPP16StartTransactionResponse> { | |
5e0c67e8 JB |
130 | const payload: StartTransactionRequest = { |
131 | connectorId, | |
e7aeea18 | 132 | ...(!Utils.isUndefined(idTag) ? { idTag } : { idTag: Constants.DEFAULT_IDTAG }), |
5e0c67e8 JB |
133 | meterStart: this.chargingStation.getEnergyActiveImportRegisterByConnectorId(connectorId), |
134 | timestamp: new Date().toISOString(), | |
135 | }; | |
e7aeea18 JB |
136 | return (await this.sendMessage( |
137 | Utils.generateUUID(), | |
138 | payload, | |
139 | OCPP16RequestCommand.START_TRANSACTION | |
140 | )) as OCPP16StartTransactionResponse; | |
c0560973 JB |
141 | } |
142 | ||
e7aeea18 JB |
143 | public async sendStopTransaction( |
144 | transactionId: number, | |
145 | meterStop: number, | |
146 | idTag?: string, | |
147 | reason: OCPP16StopTransactionReason = OCPP16StopTransactionReason.NONE | |
148 | ): Promise<OCPP16StopTransactionResponse> { | |
5e0c67e8 JB |
149 | let connectorId: number; |
150 | for (const id of this.chargingStation.connectors.keys()) { | |
151 | if (id > 0 && this.chargingStation.getConnectorStatus(id)?.transactionId === transactionId) { | |
152 | connectorId = id; | |
153 | break; | |
326f6e38 | 154 | } |
c0560973 | 155 | } |
e7aeea18 JB |
156 | const transactionEndMeterValue = OCPP16ServiceUtils.buildTransactionEndMeterValue( |
157 | this.chargingStation, | |
158 | connectorId, | |
159 | meterStop | |
160 | ); | |
5e0c67e8 | 161 | // FIXME: should be a callback, each OCPP commands implementation must do only one job |
e7aeea18 JB |
162 | this.chargingStation.getBeginEndMeterValues() && |
163 | this.chargingStation.getOcppStrictCompliance() && | |
164 | !this.chargingStation.getOutOfOrderEndMeterValues() && | |
165 | (await this.sendTransactionEndMeterValues( | |
166 | connectorId, | |
167 | transactionId, | |
168 | transactionEndMeterValue | |
169 | )); | |
5e0c67e8 JB |
170 | const payload: StopTransactionRequest = { |
171 | transactionId, | |
e7aeea18 | 172 | ...(!Utils.isUndefined(idTag) && { idTag }), |
5e0c67e8 JB |
173 | meterStop, |
174 | timestamp: new Date().toISOString(), | |
e7aeea18 JB |
175 | ...(reason && { reason }), |
176 | ...(this.chargingStation.getTransactionDataMeterValues() && { | |
177 | transactionData: OCPP16ServiceUtils.buildTransactionDataMeterValues( | |
178 | this.chargingStation.getConnectorStatus(connectorId).transactionBeginMeterValue, | |
179 | transactionEndMeterValue | |
180 | ), | |
181 | }), | |
5e0c67e8 | 182 | }; |
e7aeea18 JB |
183 | return (await this.sendMessage( |
184 | Utils.generateUUID(), | |
185 | payload, | |
186 | OCPP16RequestCommand.STOP_TRANSACTION | |
187 | )) as OCPP16StartTransactionResponse; | |
c0560973 JB |
188 | } |
189 | ||
e7aeea18 JB |
190 | public async sendMeterValues( |
191 | connectorId: number, | |
192 | transactionId: number, | |
78085c42 | 193 | interval: number |
e7aeea18 | 194 | ): Promise<void> { |
94a464f9 | 195 | const meterValue: OCPP16MeterValue = OCPP16ServiceUtils.buildMeterValue( |
78085c42 | 196 | this.chargingStation, |
e7aeea18 | 197 | connectorId, |
78085c42 JB |
198 | transactionId, |
199 | interval | |
e7aeea18 | 200 | ); |
5e0c67e8 JB |
201 | const payload: MeterValuesRequest = { |
202 | connectorId, | |
203 | transactionId, | |
204 | meterValue: [meterValue], | |
205 | }; | |
206 | await this.sendMessage(Utils.generateUUID(), payload, OCPP16RequestCommand.METER_VALUES); | |
c0560973 JB |
207 | } |
208 | ||
e7aeea18 JB |
209 | public async sendTransactionBeginMeterValues( |
210 | connectorId: number, | |
211 | transactionId: number, | |
212 | beginMeterValue: OCPP16MeterValue | |
213 | ): Promise<void> { | |
5e0c67e8 JB |
214 | const payload: MeterValuesRequest = { |
215 | connectorId, | |
216 | transactionId, | |
217 | meterValue: [beginMeterValue], | |
218 | }; | |
219 | await this.sendMessage(Utils.generateUUID(), payload, OCPP16RequestCommand.METER_VALUES); | |
326f6e38 JB |
220 | } |
221 | ||
e7aeea18 JB |
222 | public async sendTransactionEndMeterValues( |
223 | connectorId: number, | |
224 | transactionId: number, | |
225 | endMeterValue: OCPP16MeterValue | |
226 | ): Promise<void> { | |
5e0c67e8 JB |
227 | const payload: MeterValuesRequest = { |
228 | connectorId, | |
229 | transactionId, | |
230 | meterValue: [endMeterValue], | |
231 | }; | |
232 | await this.sendMessage(Utils.generateUUID(), payload, OCPP16RequestCommand.METER_VALUES); | |
326f6e38 | 233 | } |
6ed92bc1 | 234 | |
e7aeea18 JB |
235 | public async sendDiagnosticsStatusNotification( |
236 | diagnosticsStatus: OCPP16DiagnosticsStatus | |
237 | ): Promise<void> { | |
5e0c67e8 | 238 | const payload: DiagnosticsStatusNotificationRequest = { |
e7aeea18 | 239 | status: diagnosticsStatus, |
5e0c67e8 | 240 | }; |
e7aeea18 JB |
241 | await this.sendMessage( |
242 | Utils.generateUUID(), | |
243 | payload, | |
244 | OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION | |
245 | ); | |
6ed92bc1 | 246 | } |
78085c42 JB |
247 | |
248 | private buildCommandPayload( | |
249 | commandName: OCPP16RequestCommand, | |
94a464f9 | 250 | commandParams?: JsonType |
78085c42 JB |
251 | ): JsonType { |
252 | switch (commandName) { | |
253 | case OCPP16RequestCommand.AUTHORIZE: | |
254 | return { | |
255 | ...(!Utils.isUndefined(commandParams?.idTag) | |
256 | ? { idTag: commandParams.idTag } | |
257 | : { idTag: Constants.DEFAULT_IDTAG }), | |
258 | } as AuthorizeRequest; | |
259 | case OCPP16RequestCommand.BOOT_NOTIFICATION: | |
260 | return { | |
261 | chargePointModel: commandParams?.chargePointModel, | |
262 | chargePointVendor: commandParams?.chargePointVendor, | |
263 | ...(!Utils.isUndefined(commandParams?.chargeBoxSerialNumber) && { | |
264 | chargeBoxSerialNumber: commandParams.chargeBoxSerialNumber, | |
265 | }), | |
266 | ...(!Utils.isUndefined(commandParams?.chargePointSerialNumber) && { | |
267 | chargePointSerialNumber: commandParams.chargePointSerialNumber, | |
268 | }), | |
269 | ...(!Utils.isUndefined(commandParams?.firmwareVersion) && { | |
270 | firmwareVersion: commandParams.firmwareVersion, | |
271 | }), | |
272 | ...(!Utils.isUndefined(commandParams?.iccid) && { iccid: commandParams.iccid }), | |
273 | ...(!Utils.isUndefined(commandParams?.imsi) && { imsi: commandParams.imsi }), | |
274 | ...(!Utils.isUndefined(commandParams?.meterSerialNumber) && { | |
275 | meterSerialNumber: commandParams.meterSerialNumber, | |
276 | }), | |
277 | ...(!Utils.isUndefined(commandParams?.meterType) && { | |
278 | meterType: commandParams.meterType, | |
279 | }), | |
280 | } as OCPP16BootNotificationRequest; | |
281 | case OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION: | |
282 | return { | |
283 | status: commandParams?.diagnosticsStatus, | |
284 | } as DiagnosticsStatusNotificationRequest; | |
285 | case OCPP16RequestCommand.HEARTBEAT: | |
286 | return {} as HeartbeatRequest; | |
287 | case OCPP16RequestCommand.METER_VALUES: | |
288 | return { | |
289 | connectorId: commandParams?.connectorId, | |
290 | transactionId: commandParams?.transactionId, | |
291 | meterValue: Array.isArray(commandParams?.meterValues) | |
292 | ? commandParams?.meterValues | |
293 | : [commandParams?.meterValue], | |
294 | } as MeterValuesRequest; | |
295 | case OCPP16RequestCommand.STATUS_NOTIFICATION: | |
296 | return { | |
297 | connectorId: commandParams?.connectorId, | |
298 | errorCode: commandParams?.errorCode, | |
299 | status: commandParams?.status, | |
300 | } as StatusNotificationRequest; | |
301 | case OCPP16RequestCommand.START_TRANSACTION: | |
302 | return { | |
303 | connectorId: commandParams?.connectorId, | |
304 | ...(!Utils.isUndefined(commandParams?.idTag) | |
305 | ? { idTag: commandParams?.idTag } | |
306 | : { idTag: Constants.DEFAULT_IDTAG }), | |
307 | meterStart: this.chargingStation.getEnergyActiveImportRegisterByConnectorId( | |
308 | commandParams?.connectorId as number | |
309 | ), | |
310 | timestamp: new Date().toISOString(), | |
311 | } as StartTransactionRequest; | |
312 | case OCPP16RequestCommand.STOP_TRANSACTION: | |
313 | return { | |
314 | transactionId: commandParams?.transactionId, | |
315 | ...(!Utils.isUndefined(commandParams?.idTag) && { idTag: commandParams.idTag }), | |
316 | meterStop: commandParams?.meterStop, | |
317 | timestamp: new Date().toISOString(), | |
318 | ...(commandParams?.reason && { reason: commandParams.reason }), | |
319 | ...(this.chargingStation.getTransactionDataMeterValues() && { | |
320 | transactionData: OCPP16ServiceUtils.buildTransactionDataMeterValues( | |
321 | this.chargingStation.getConnectorStatus(commandParams?.connectorId as number) | |
322 | .transactionBeginMeterValue, | |
323 | OCPP16ServiceUtils.buildTransactionEndMeterValue( | |
324 | this.chargingStation, | |
325 | commandParams?.connectorId as number, | |
326 | commandParams?.meterStop as number | |
327 | ) | |
328 | ), | |
329 | }), | |
330 | } as StopTransactionRequest; | |
331 | default: | |
332 | throw new OCPPError( | |
333 | ErrorType.NOT_SUPPORTED, | |
334 | // eslint-disable-next-line @typescript-eslint/restrict-template-expressions | |
94a464f9 | 335 | `${moduleName}.buildCommandPayload: Unsupported OCPP command: ${commandName}`, |
78085c42 JB |
336 | commandName, |
337 | { commandName } | |
338 | ); | |
339 | } | |
340 | } | |
c0560973 | 341 | } |