UI Protocol: add Authorize command support
[e-mobility-charging-stations-simulator.git] / src / charging-station / ocpp / 1.6 / OCPP16ResponseService.ts
1 // Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
2
3 import fs from 'fs';
4 import path from 'path';
5 import { fileURLToPath } from 'url';
6
7 import type { JSONSchemaType } from 'ajv';
8
9 import OCPPError from '../../../exception/OCPPError';
10 import type { JsonObject, JsonType } from '../../../types/JsonType';
11 import { OCPP16ChargePointErrorCode } from '../../../types/ocpp/1.6/ChargePointErrorCode';
12 import { OCPP16ChargePointStatus } from '../../../types/ocpp/1.6/ChargePointStatus';
13 import { OCPP16StandardParametersKey } from '../../../types/ocpp/1.6/Configuration';
14 import type {
15 OCPP16MeterValuesRequest,
16 OCPP16MeterValuesResponse,
17 } from '../../../types/ocpp/1.6/MeterValues';
18 import {
19 OCPP16BootNotificationRequest,
20 OCPP16RequestCommand,
21 OCPP16StatusNotificationRequest,
22 } from '../../../types/ocpp/1.6/Requests';
23 import {
24 DiagnosticsStatusNotificationResponse,
25 OCPP16BootNotificationResponse,
26 OCPP16HeartbeatResponse,
27 OCPP16RegistrationStatus,
28 OCPP16StatusNotificationResponse,
29 } from '../../../types/ocpp/1.6/Responses';
30 import {
31 OCPP16AuthorizationStatus,
32 OCPP16AuthorizeRequest,
33 OCPP16AuthorizeResponse,
34 OCPP16StartTransactionRequest,
35 OCPP16StartTransactionResponse,
36 OCPP16StopTransactionRequest,
37 OCPP16StopTransactionResponse,
38 } from '../../../types/ocpp/1.6/Transaction';
39 import { ErrorType } from '../../../types/ocpp/ErrorType';
40 import type { ResponseHandler } from '../../../types/ocpp/Responses';
41 import logger from '../../../utils/Logger';
42 import Utils from '../../../utils/Utils';
43 import type ChargingStation from '../../ChargingStation';
44 import { ChargingStationConfigurationUtils } from '../../ChargingStationConfigurationUtils';
45 import { ChargingStationUtils } from '../../ChargingStationUtils';
46 import OCPPResponseService from '../OCPPResponseService';
47 import { OCPP16ServiceUtils } from './OCPP16ServiceUtils';
48
49 const moduleName = 'OCPP16ResponseService';
50
51 export default class OCPP16ResponseService extends OCPPResponseService {
52 private responseHandlers: Map<OCPP16RequestCommand, ResponseHandler>;
53 private jsonSchemas: Map<OCPP16RequestCommand, JSONSchemaType<JsonObject>>;
54
55 public constructor() {
56 if (new.target?.name === moduleName) {
57 throw new TypeError(`Cannot construct ${new.target?.name} instances directly`);
58 }
59 super();
60 this.responseHandlers = new Map<OCPP16RequestCommand, ResponseHandler>([
61 [OCPP16RequestCommand.BOOT_NOTIFICATION, this.handleResponseBootNotification.bind(this)],
62 [OCPP16RequestCommand.HEARTBEAT, this.emptyResponseHandler.bind(this)],
63 [OCPP16RequestCommand.AUTHORIZE, this.handleResponseAuthorize.bind(this)],
64 [OCPP16RequestCommand.START_TRANSACTION, this.handleResponseStartTransaction.bind(this)],
65 [OCPP16RequestCommand.STOP_TRANSACTION, this.handleResponseStopTransaction.bind(this)],
66 [OCPP16RequestCommand.STATUS_NOTIFICATION, this.emptyResponseHandler.bind(this)],
67 [OCPP16RequestCommand.METER_VALUES, this.emptyResponseHandler.bind(this)],
68 [OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION, this.emptyResponseHandler.bind(this)],
69 ]);
70 this.jsonSchemas = new Map<OCPP16RequestCommand, JSONSchemaType<JsonObject>>([
71 [
72 OCPP16RequestCommand.BOOT_NOTIFICATION,
73 JSON.parse(
74 fs.readFileSync(
75 path.resolve(
76 path.dirname(fileURLToPath(import.meta.url)),
77 '../../../assets/json-schemas/ocpp/1.6/BootNotificationResponse.json'
78 ),
79 'utf8'
80 )
81 ) as JSONSchemaType<OCPP16BootNotificationResponse>,
82 ],
83 [
84 OCPP16RequestCommand.HEARTBEAT,
85 JSON.parse(
86 fs.readFileSync(
87 path.resolve(
88 path.dirname(fileURLToPath(import.meta.url)),
89 '../../../assets/json-schemas/ocpp/1.6/HeartbeatResponse.json'
90 ),
91 'utf8'
92 )
93 ) as JSONSchemaType<OCPP16HeartbeatResponse>,
94 ],
95 [
96 OCPP16RequestCommand.AUTHORIZE,
97 JSON.parse(
98 fs.readFileSync(
99 path.resolve(
100 path.dirname(fileURLToPath(import.meta.url)),
101 '../../../assets/json-schemas/ocpp/1.6/AuthorizeResponse.json'
102 ),
103 'utf8'
104 )
105 ) as JSONSchemaType<OCPP16AuthorizeResponse>,
106 ],
107 [
108 OCPP16RequestCommand.START_TRANSACTION,
109 JSON.parse(
110 fs.readFileSync(
111 path.resolve(
112 path.dirname(fileURLToPath(import.meta.url)),
113 '../../../assets/json-schemas/ocpp/1.6/StartTransactionResponse.json'
114 ),
115 'utf8'
116 )
117 ) as JSONSchemaType<OCPP16StartTransactionResponse>,
118 ],
119 [
120 OCPP16RequestCommand.STOP_TRANSACTION,
121 JSON.parse(
122 fs.readFileSync(
123 path.resolve(
124 path.dirname(fileURLToPath(import.meta.url)),
125 '../../../assets/json-schemas/ocpp/1.6/StopTransactionResponse.json'
126 ),
127 'utf8'
128 )
129 ) as JSONSchemaType<OCPP16StopTransactionResponse>,
130 ],
131 [
132 OCPP16RequestCommand.STATUS_NOTIFICATION,
133 JSON.parse(
134 fs.readFileSync(
135 path.resolve(
136 path.dirname(fileURLToPath(import.meta.url)),
137 '../../../assets/json-schemas/ocpp/1.6/StatusNotificationResponse.json'
138 ),
139 'utf8'
140 )
141 ) as JSONSchemaType<OCPP16StatusNotificationResponse>,
142 ],
143 [
144 OCPP16RequestCommand.METER_VALUES,
145 JSON.parse(
146 fs.readFileSync(
147 path.resolve(
148 path.dirname(fileURLToPath(import.meta.url)),
149 '../../../assets/json-schemas/ocpp/1.6/MeterValuesResponse.json'
150 ),
151 'utf8'
152 )
153 ) as JSONSchemaType<OCPP16MeterValuesResponse>,
154 ],
155 [
156 OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION,
157 JSON.parse(
158 fs.readFileSync(
159 path.resolve(
160 path.dirname(fileURLToPath(import.meta.url)),
161 '../../../assets/json-schemas/ocpp/1.6/DiagnosticsStatusNotificationResponse.json'
162 ),
163 'utf8'
164 )
165 ) as JSONSchemaType<DiagnosticsStatusNotificationResponse>,
166 ],
167 ]);
168 this.validatePayload.bind(this);
169 }
170
171 public async responseHandler(
172 chargingStation: ChargingStation,
173 commandName: OCPP16RequestCommand,
174 payload: JsonType,
175 requestPayload: JsonType
176 ): Promise<void> {
177 if (chargingStation.isRegistered() || commandName === OCPP16RequestCommand.BOOT_NOTIFICATION) {
178 if (
179 this.responseHandlers.has(commandName) &&
180 ChargingStationUtils.isRequestCommandSupported(commandName, chargingStation)
181 ) {
182 try {
183 this.validatePayload(chargingStation, commandName, payload);
184 await this.responseHandlers.get(commandName)(chargingStation, payload, requestPayload);
185 } catch (error) {
186 logger.error(
187 `${chargingStation.logPrefix()} ${moduleName}.responseHandler: Handle response error:`,
188 error
189 );
190 throw error;
191 }
192 } else {
193 // Throw exception
194 throw new OCPPError(
195 ErrorType.NOT_IMPLEMENTED,
196 `${commandName} is not implemented to handle response PDU ${JSON.stringify(
197 payload,
198 null,
199 2
200 )}`,
201 commandName,
202 payload
203 );
204 }
205 } else {
206 throw new OCPPError(
207 ErrorType.SECURITY_ERROR,
208 `${commandName} cannot be issued to handle response PDU ${JSON.stringify(
209 payload,
210 null,
211 2
212 )} while the charging station is not registered on the central server. `,
213 commandName,
214 payload
215 );
216 }
217 }
218
219 private validatePayload(
220 chargingStation: ChargingStation,
221 commandName: OCPP16RequestCommand,
222 payload: JsonType
223 ): boolean {
224 if (this.jsonSchemas.has(commandName)) {
225 return this.validateResponsePayload(
226 chargingStation,
227 commandName,
228 this.jsonSchemas.get(commandName),
229 payload
230 );
231 }
232 logger.warn(
233 `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema found for command ${commandName} PDU validation`
234 );
235 return false;
236 }
237
238 private handleResponseBootNotification(
239 chargingStation: ChargingStation,
240 payload: OCPP16BootNotificationResponse
241 ): void {
242 if (payload.status === OCPP16RegistrationStatus.ACCEPTED) {
243 ChargingStationConfigurationUtils.addConfigurationKey(
244 chargingStation,
245 OCPP16StandardParametersKey.HeartbeatInterval,
246 payload.interval.toString(),
247 {},
248 { overwrite: true, save: true }
249 );
250 ChargingStationConfigurationUtils.addConfigurationKey(
251 chargingStation,
252 OCPP16StandardParametersKey.HeartBeatInterval,
253 payload.interval.toString(),
254 { visible: false },
255 { overwrite: true, save: true }
256 );
257 chargingStation.heartbeatSetInterval
258 ? chargingStation.restartHeartbeat()
259 : chargingStation.startHeartbeat();
260 }
261 if (Object.values(OCPP16RegistrationStatus).includes(payload.status)) {
262 const logMsg = `${chargingStation.logPrefix()} Charging station in '${
263 payload.status
264 }' state on the central server`;
265 payload.status === OCPP16RegistrationStatus.REJECTED
266 ? logger.warn(logMsg)
267 : logger.info(logMsg);
268 } else {
269 logger.error(
270 chargingStation.logPrefix() +
271 ' Charging station boot notification response received: %j with undefined registration status',
272 payload
273 );
274 }
275 }
276
277 private handleResponseAuthorize(
278 chargingStation: ChargingStation,
279 payload: OCPP16AuthorizeResponse,
280 requestPayload: OCPP16AuthorizeRequest
281 ): void {
282 let authorizeConnectorId: number;
283 for (const connectorId of chargingStation.connectors.keys()) {
284 if (
285 connectorId > 0 &&
286 chargingStation.getConnectorStatus(connectorId)?.authorizeIdTag === requestPayload.idTag
287 ) {
288 authorizeConnectorId = connectorId;
289 break;
290 }
291 }
292 const isAuthorizeConnectorIdDefined = authorizeConnectorId !== undefined;
293 if (payload.idTagInfo.status === OCPP16AuthorizationStatus.ACCEPTED) {
294 isAuthorizeConnectorIdDefined &&
295 (chargingStation.getConnectorStatus(authorizeConnectorId).idTagAuthorized = true);
296 logger.debug(
297 `${chargingStation.logPrefix()} IdTag '${requestPayload.idTag}' accepted${
298 isAuthorizeConnectorIdDefined ? ` on connector ${authorizeConnectorId}` : ''
299 }`
300 );
301 } else {
302 if (isAuthorizeConnectorIdDefined) {
303 chargingStation.getConnectorStatus(authorizeConnectorId).idTagAuthorized = false;
304 delete chargingStation.getConnectorStatus(authorizeConnectorId).authorizeIdTag;
305 }
306 logger.debug(
307 `${chargingStation.logPrefix()} IdTag '${requestPayload.idTag}' rejected with status '${
308 payload.idTagInfo.status
309 }'${isAuthorizeConnectorIdDefined ? ` on connector ${authorizeConnectorId}` : ''}`
310 );
311 }
312 }
313
314 private async handleResponseStartTransaction(
315 chargingStation: ChargingStation,
316 payload: OCPP16StartTransactionResponse,
317 requestPayload: OCPP16StartTransactionRequest
318 ): Promise<void> {
319 const connectorId = requestPayload.connectorId;
320
321 let transactionConnectorId: number;
322 for (const id of chargingStation.connectors.keys()) {
323 if (id > 0 && id === connectorId) {
324 transactionConnectorId = id;
325 break;
326 }
327 }
328 if (!transactionConnectorId) {
329 logger.error(
330 chargingStation.logPrefix() +
331 ' Trying to start a transaction on a non existing connector Id ' +
332 connectorId.toString()
333 );
334 return;
335 }
336 if (
337 chargingStation.getConnectorStatus(connectorId).transactionRemoteStarted === true &&
338 chargingStation.getAuthorizeRemoteTxRequests() &&
339 chargingStation.getLocalAuthListEnabled() &&
340 chargingStation.hasAuthorizedTags() &&
341 chargingStation.getConnectorStatus(connectorId).idTagLocalAuthorized === false
342 ) {
343 logger.error(
344 chargingStation.logPrefix() +
345 ' Trying to start a transaction with a not local authorized idTag ' +
346 chargingStation.getConnectorStatus(connectorId).localAuthorizeIdTag +
347 ' on connector Id ' +
348 connectorId.toString()
349 );
350 await this.resetConnectorOnStartTransactionError(chargingStation, connectorId);
351 return;
352 }
353 if (
354 chargingStation.getConnectorStatus(connectorId).transactionRemoteStarted === true &&
355 chargingStation.getAuthorizeRemoteTxRequests() &&
356 chargingStation.getMustAuthorizeAtRemoteStart() &&
357 chargingStation.getConnectorStatus(connectorId).idTagLocalAuthorized === false &&
358 chargingStation.getConnectorStatus(connectorId).idTagAuthorized === false
359 ) {
360 logger.error(
361 chargingStation.logPrefix() +
362 ' Trying to start a transaction with a not authorized idTag ' +
363 chargingStation.getConnectorStatus(connectorId).authorizeIdTag +
364 ' on connector Id ' +
365 connectorId.toString()
366 );
367 await this.resetConnectorOnStartTransactionError(chargingStation, connectorId);
368 return;
369 }
370 if (
371 chargingStation.getConnectorStatus(connectorId).idTagAuthorized &&
372 chargingStation.getConnectorStatus(connectorId).authorizeIdTag !== requestPayload.idTag
373 ) {
374 logger.error(
375 chargingStation.logPrefix() +
376 ' Trying to start a transaction with an idTag ' +
377 requestPayload.idTag +
378 ' different from the authorize request one ' +
379 chargingStation.getConnectorStatus(connectorId).authorizeIdTag +
380 ' on connector Id ' +
381 connectorId.toString()
382 );
383 await this.resetConnectorOnStartTransactionError(chargingStation, connectorId);
384 return;
385 }
386 if (
387 chargingStation.getConnectorStatus(connectorId).idTagLocalAuthorized &&
388 chargingStation.getConnectorStatus(connectorId).localAuthorizeIdTag !== requestPayload.idTag
389 ) {
390 logger.error(
391 chargingStation.logPrefix() +
392 ' Trying to start a transaction with an idTag ' +
393 requestPayload.idTag +
394 ' different from the local authorized one ' +
395 chargingStation.getConnectorStatus(connectorId).localAuthorizeIdTag +
396 ' on connector Id ' +
397 connectorId.toString()
398 );
399 await this.resetConnectorOnStartTransactionError(chargingStation, connectorId);
400 return;
401 }
402 if (chargingStation.getConnectorStatus(connectorId)?.transactionStarted === true) {
403 logger.debug(
404 chargingStation.logPrefix() +
405 ' Trying to start a transaction on an already used connector ' +
406 connectorId.toString() +
407 ': %j',
408 chargingStation.getConnectorStatus(connectorId)
409 );
410 return;
411 }
412 if (
413 chargingStation.getConnectorStatus(connectorId)?.status !==
414 OCPP16ChargePointStatus.AVAILABLE &&
415 chargingStation.getConnectorStatus(connectorId)?.status !== OCPP16ChargePointStatus.PREPARING
416 ) {
417 logger.error(
418 `${chargingStation.logPrefix()} Trying to start a transaction on connector ${connectorId.toString()} with status ${
419 chargingStation.getConnectorStatus(connectorId)?.status
420 }`
421 );
422 return;
423 }
424 // if (!Number.isInteger(payload.transactionId)) {
425 // logger.warn(
426 // `${chargingStation.logPrefix()} Trying to start a transaction on connector ${connectorId.toString()} with a non integer transaction Id ${
427 // payload.transactionId
428 // }, converting to integer`
429 // );
430 // payload.transactionId = Utils.convertToInt(payload.transactionId);
431 // }
432
433 if (payload.idTagInfo?.status === OCPP16AuthorizationStatus.ACCEPTED) {
434 chargingStation.getConnectorStatus(connectorId).transactionStarted = true;
435 chargingStation.getConnectorStatus(connectorId).transactionId = payload.transactionId;
436 chargingStation.getConnectorStatus(connectorId).transactionIdTag = requestPayload.idTag;
437 chargingStation.getConnectorStatus(
438 connectorId
439 ).transactionEnergyActiveImportRegisterValue = 0;
440 chargingStation.getConnectorStatus(connectorId).transactionBeginMeterValue =
441 OCPP16ServiceUtils.buildTransactionBeginMeterValue(
442 chargingStation,
443 connectorId,
444 requestPayload.meterStart
445 );
446 chargingStation.getBeginEndMeterValues() &&
447 (await chargingStation.ocppRequestService.requestHandler<
448 OCPP16MeterValuesRequest,
449 OCPP16MeterValuesResponse
450 >(chargingStation, OCPP16RequestCommand.METER_VALUES, {
451 connectorId,
452 transactionId: payload.transactionId,
453 meterValue: [chargingStation.getConnectorStatus(connectorId).transactionBeginMeterValue],
454 }));
455 await chargingStation.ocppRequestService.requestHandler<
456 OCPP16StatusNotificationRequest,
457 OCPP16StatusNotificationResponse
458 >(chargingStation, OCPP16RequestCommand.STATUS_NOTIFICATION, {
459 connectorId,
460 status: OCPP16ChargePointStatus.CHARGING,
461 errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
462 });
463 chargingStation.getConnectorStatus(connectorId).status = OCPP16ChargePointStatus.CHARGING;
464 logger.info(
465 chargingStation.logPrefix() +
466 ' Transaction ' +
467 payload.transactionId.toString() +
468 ' STARTED on ' +
469 chargingStation.stationInfo.chargingStationId +
470 '#' +
471 connectorId.toString() +
472 " for idTag '" +
473 requestPayload.idTag +
474 "'"
475 );
476 if (chargingStation.stationInfo.powerSharedByConnectors) {
477 chargingStation.powerDivider++;
478 }
479 const configuredMeterValueSampleInterval =
480 ChargingStationConfigurationUtils.getConfigurationKey(
481 chargingStation,
482 OCPP16StandardParametersKey.MeterValueSampleInterval
483 );
484 chargingStation.startMeterValues(
485 connectorId,
486 configuredMeterValueSampleInterval
487 ? Utils.convertToInt(configuredMeterValueSampleInterval.value) * 1000
488 : 60000
489 );
490 } else {
491 logger.warn(
492 chargingStation.logPrefix() +
493 ' Starting transaction id ' +
494 payload.transactionId.toString() +
495 " REJECTED with status '" +
496 payload?.idTagInfo?.status +
497 "', idTag '" +
498 requestPayload.idTag +
499 "'"
500 );
501 await this.resetConnectorOnStartTransactionError(chargingStation, connectorId);
502 }
503 }
504
505 private async resetConnectorOnStartTransactionError(
506 chargingStation: ChargingStation,
507 connectorId: number
508 ): Promise<void> {
509 chargingStation.resetConnectorStatus(connectorId);
510 if (
511 chargingStation.getConnectorStatus(connectorId).status !== OCPP16ChargePointStatus.AVAILABLE
512 ) {
513 await chargingStation.ocppRequestService.requestHandler<
514 OCPP16StatusNotificationRequest,
515 OCPP16StatusNotificationResponse
516 >(chargingStation, OCPP16RequestCommand.STATUS_NOTIFICATION, {
517 connectorId,
518 status: OCPP16ChargePointStatus.AVAILABLE,
519 errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
520 });
521 chargingStation.getConnectorStatus(connectorId).status = OCPP16ChargePointStatus.AVAILABLE;
522 }
523 }
524
525 private async handleResponseStopTransaction(
526 chargingStation: ChargingStation,
527 payload: OCPP16StopTransactionResponse,
528 requestPayload: OCPP16StopTransactionRequest
529 ): Promise<void> {
530 const transactionConnectorId = chargingStation.getConnectorIdByTransactionId(
531 requestPayload.transactionId
532 );
533 if (!transactionConnectorId) {
534 logger.error(
535 chargingStation.logPrefix() +
536 ' Trying to stop a non existing transaction ' +
537 requestPayload.transactionId.toString()
538 );
539 return;
540 }
541 if (payload.idTagInfo?.status === OCPP16AuthorizationStatus.ACCEPTED) {
542 chargingStation.getBeginEndMeterValues() &&
543 !chargingStation.getOcppStrictCompliance() &&
544 chargingStation.getOutOfOrderEndMeterValues() &&
545 (await chargingStation.ocppRequestService.requestHandler<
546 OCPP16MeterValuesRequest,
547 OCPP16MeterValuesResponse
548 >(chargingStation, OCPP16RequestCommand.METER_VALUES, {
549 connectorId: transactionConnectorId,
550 transactionId: requestPayload.transactionId,
551 meterValue: [
552 OCPP16ServiceUtils.buildTransactionEndMeterValue(
553 chargingStation,
554 transactionConnectorId,
555 requestPayload.meterStop
556 ),
557 ],
558 }));
559 if (
560 !chargingStation.isChargingStationAvailable() ||
561 !chargingStation.isConnectorAvailable(transactionConnectorId)
562 ) {
563 await chargingStation.ocppRequestService.requestHandler<
564 OCPP16StatusNotificationRequest,
565 OCPP16StatusNotificationResponse
566 >(chargingStation, OCPP16RequestCommand.STATUS_NOTIFICATION, {
567 connectorId: transactionConnectorId,
568 status: OCPP16ChargePointStatus.UNAVAILABLE,
569 errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
570 });
571 chargingStation.getConnectorStatus(transactionConnectorId).status =
572 OCPP16ChargePointStatus.UNAVAILABLE;
573 } else {
574 await chargingStation.ocppRequestService.requestHandler<
575 OCPP16BootNotificationRequest,
576 OCPP16BootNotificationResponse
577 >(chargingStation, OCPP16RequestCommand.STATUS_NOTIFICATION, {
578 connectorId: transactionConnectorId,
579 status: OCPP16ChargePointStatus.AVAILABLE,
580 errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
581 });
582 chargingStation.getConnectorStatus(transactionConnectorId).status =
583 OCPP16ChargePointStatus.AVAILABLE;
584 }
585 if (chargingStation.stationInfo.powerSharedByConnectors) {
586 chargingStation.powerDivider--;
587 }
588 chargingStation.resetConnectorStatus(transactionConnectorId);
589 logger.info(
590 chargingStation.logPrefix() +
591 ' Transaction ' +
592 requestPayload.transactionId.toString() +
593 ' STOPPED on ' +
594 chargingStation.stationInfo.chargingStationId +
595 '#' +
596 transactionConnectorId.toString()
597 );
598 } else {
599 logger.warn(
600 chargingStation.logPrefix() +
601 ' Stopping transaction id ' +
602 requestPayload.transactionId.toString() +
603 " REJECTED with status '" +
604 payload.idTagInfo?.status +
605 "'"
606 );
607 }
608 }
609 }