AjvErrorsToErrorType -> ajvErrorsToErrorType
[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 { JSONSchemaType } from 'ajv';
8
9 import OCPPError from '../../../exception/OCPPError';
10 import { 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 {
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 { 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 }
169
170 public async responseHandler(
171 chargingStation: ChargingStation,
172 commandName: OCPP16RequestCommand,
173 payload: JsonType,
174 requestPayload: JsonType
175 ): Promise<void> {
176 if (chargingStation.isRegistered() || commandName === OCPP16RequestCommand.BOOT_NOTIFICATION) {
177 if (
178 this.responseHandlers.has(commandName) &&
179 ChargingStationUtils.isRequestCommandSupported(commandName, chargingStation)
180 ) {
181 try {
182 this.validatePayload(chargingStation, commandName, payload);
183 await this.responseHandlers.get(commandName)(chargingStation, payload, requestPayload);
184 } catch (error) {
185 logger.error(chargingStation.logPrefix() + ' Handle request response error: %j', error);
186 throw error;
187 }
188 } else {
189 // Throw exception
190 throw new OCPPError(
191 ErrorType.NOT_IMPLEMENTED,
192 `${commandName} is not implemented to handle request response PDU ${JSON.stringify(
193 payload,
194 null,
195 2
196 )}`,
197 commandName,
198 payload
199 );
200 }
201 } else {
202 throw new OCPPError(
203 ErrorType.SECURITY_ERROR,
204 `${commandName} cannot be issued to handle request response PDU ${JSON.stringify(
205 payload,
206 null,
207 2
208 )} while the charging station is not registered on the central server. `,
209 commandName,
210 payload
211 );
212 }
213 }
214
215 private validatePayload(
216 chargingStation: ChargingStation,
217 commandName: OCPP16RequestCommand,
218 payload: JsonType
219 ): boolean {
220 if (this.jsonSchemas.has(commandName)) {
221 return this.validateResponsePayload(
222 chargingStation,
223 commandName,
224 this.jsonSchemas.get(commandName),
225 payload
226 );
227 }
228 logger.warn(
229 `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema found for command ${commandName} PDU validation`
230 );
231 return false;
232 }
233
234 private handleResponseBootNotification(
235 chargingStation: ChargingStation,
236 payload: OCPP16BootNotificationResponse
237 ): void {
238 if (payload.status === OCPP16RegistrationStatus.ACCEPTED) {
239 ChargingStationConfigurationUtils.addConfigurationKey(
240 chargingStation,
241 OCPP16StandardParametersKey.HeartbeatInterval,
242 payload.interval.toString(),
243 {},
244 { overwrite: true, save: true }
245 );
246 ChargingStationConfigurationUtils.addConfigurationKey(
247 chargingStation,
248 OCPP16StandardParametersKey.HeartBeatInterval,
249 payload.interval.toString(),
250 { visible: false },
251 { overwrite: true, save: true }
252 );
253 chargingStation.heartbeatSetInterval
254 ? chargingStation.restartHeartbeat()
255 : chargingStation.startHeartbeat();
256 }
257 if (Object.values(OCPP16RegistrationStatus).includes(payload.status)) {
258 const logMsg = `${chargingStation.logPrefix()} Charging station in '${
259 payload.status
260 }' state on the central server`;
261 payload.status === OCPP16RegistrationStatus.REJECTED
262 ? logger.warn(logMsg)
263 : logger.info(logMsg);
264 } else {
265 logger.error(
266 chargingStation.logPrefix() +
267 ' Charging station boot notification response received: %j with undefined registration status',
268 payload
269 );
270 }
271 }
272
273 private handleResponseAuthorize(
274 chargingStation: ChargingStation,
275 payload: OCPP16AuthorizeResponse,
276 requestPayload: OCPP16AuthorizeRequest
277 ): void {
278 let authorizeConnectorId: number;
279 for (const connectorId of chargingStation.connectors.keys()) {
280 if (
281 connectorId > 0 &&
282 chargingStation.getConnectorStatus(connectorId)?.authorizeIdTag === requestPayload.idTag
283 ) {
284 authorizeConnectorId = connectorId;
285 break;
286 }
287 }
288 if (payload.idTagInfo.status === OCPP16AuthorizationStatus.ACCEPTED) {
289 chargingStation.getConnectorStatus(authorizeConnectorId).idTagAuthorized = true;
290 logger.debug(
291 `${chargingStation.logPrefix()} IdTag ${
292 requestPayload.idTag
293 } authorized on connector ${authorizeConnectorId}`
294 );
295 } else {
296 chargingStation.getConnectorStatus(authorizeConnectorId).idTagAuthorized = false;
297 delete chargingStation.getConnectorStatus(authorizeConnectorId).authorizeIdTag;
298 logger.debug(
299 `${chargingStation.logPrefix()} IdTag ${requestPayload.idTag} refused with status '${
300 payload.idTagInfo.status
301 }' on connector ${authorizeConnectorId}`
302 );
303 }
304 }
305
306 private async handleResponseStartTransaction(
307 chargingStation: ChargingStation,
308 payload: OCPP16StartTransactionResponse,
309 requestPayload: OCPP16StartTransactionRequest
310 ): Promise<void> {
311 const connectorId = requestPayload.connectorId;
312
313 let transactionConnectorId: number;
314 for (const id of chargingStation.connectors.keys()) {
315 if (id > 0 && id === connectorId) {
316 transactionConnectorId = id;
317 break;
318 }
319 }
320 if (!transactionConnectorId) {
321 logger.error(
322 chargingStation.logPrefix() +
323 ' Trying to start a transaction on a non existing connector Id ' +
324 connectorId.toString()
325 );
326 return;
327 }
328 if (
329 chargingStation.getConnectorStatus(connectorId).transactionRemoteStarted &&
330 chargingStation.getAuthorizeRemoteTxRequests() &&
331 chargingStation.getLocalAuthListEnabled() &&
332 chargingStation.hasAuthorizedTags() &&
333 !chargingStation.getConnectorStatus(connectorId).idTagLocalAuthorized
334 ) {
335 logger.error(
336 chargingStation.logPrefix() +
337 ' Trying to start a transaction with a not local authorized idTag ' +
338 chargingStation.getConnectorStatus(connectorId).localAuthorizeIdTag +
339 ' on connector Id ' +
340 connectorId.toString()
341 );
342 await this.resetConnectorOnStartTransactionError(chargingStation, connectorId);
343 return;
344 }
345 if (
346 chargingStation.getConnectorStatus(connectorId).transactionRemoteStarted &&
347 chargingStation.getAuthorizeRemoteTxRequests() &&
348 chargingStation.getMayAuthorizeAtRemoteStart() &&
349 !chargingStation.getConnectorStatus(connectorId).idTagLocalAuthorized &&
350 !chargingStation.getConnectorStatus(connectorId).idTagAuthorized
351 ) {
352 logger.error(
353 chargingStation.logPrefix() +
354 ' Trying to start a transaction with a not authorized idTag ' +
355 chargingStation.getConnectorStatus(connectorId).authorizeIdTag +
356 ' on connector Id ' +
357 connectorId.toString()
358 );
359 await this.resetConnectorOnStartTransactionError(chargingStation, connectorId);
360 return;
361 }
362 if (
363 chargingStation.getConnectorStatus(connectorId).idTagAuthorized &&
364 chargingStation.getConnectorStatus(connectorId).authorizeIdTag !== requestPayload.idTag
365 ) {
366 logger.error(
367 chargingStation.logPrefix() +
368 ' Trying to start a transaction with an idTag ' +
369 requestPayload.idTag +
370 ' different from the authorize request one ' +
371 chargingStation.getConnectorStatus(connectorId).authorizeIdTag +
372 ' on connector Id ' +
373 connectorId.toString()
374 );
375 await this.resetConnectorOnStartTransactionError(chargingStation, connectorId);
376 return;
377 }
378 if (
379 chargingStation.getConnectorStatus(connectorId).idTagLocalAuthorized &&
380 chargingStation.getConnectorStatus(connectorId).localAuthorizeIdTag !== requestPayload.idTag
381 ) {
382 logger.error(
383 chargingStation.logPrefix() +
384 ' Trying to start a transaction with an idTag ' +
385 requestPayload.idTag +
386 ' different from the local authorized one ' +
387 chargingStation.getConnectorStatus(connectorId).localAuthorizeIdTag +
388 ' on connector Id ' +
389 connectorId.toString()
390 );
391 await this.resetConnectorOnStartTransactionError(chargingStation, connectorId);
392 return;
393 }
394 if (chargingStation.getConnectorStatus(connectorId)?.transactionStarted) {
395 logger.debug(
396 chargingStation.logPrefix() +
397 ' Trying to start a transaction on an already used connector ' +
398 connectorId.toString() +
399 ': %j',
400 chargingStation.getConnectorStatus(connectorId)
401 );
402 return;
403 }
404 if (
405 chargingStation.getConnectorStatus(connectorId)?.status !==
406 OCPP16ChargePointStatus.AVAILABLE &&
407 chargingStation.getConnectorStatus(connectorId)?.status !== OCPP16ChargePointStatus.PREPARING
408 ) {
409 logger.error(
410 `${chargingStation.logPrefix()} Trying to start a transaction on connector ${connectorId.toString()} with status ${
411 chargingStation.getConnectorStatus(connectorId)?.status
412 }`
413 );
414 return;
415 }
416 if (!Number.isInteger(payload.transactionId)) {
417 logger.warn(
418 `${chargingStation.logPrefix()} Trying to start a transaction on connector ${connectorId.toString()} with a non integer transaction Id ${
419 payload.transactionId
420 }, converting to integer`
421 );
422 payload.transactionId = Utils.convertToInt(payload.transactionId);
423 }
424
425 if (payload.idTagInfo?.status === OCPP16AuthorizationStatus.ACCEPTED) {
426 chargingStation.getConnectorStatus(connectorId).transactionStarted = true;
427 chargingStation.getConnectorStatus(connectorId).transactionId = payload.transactionId;
428 chargingStation.getConnectorStatus(connectorId).transactionIdTag = requestPayload.idTag;
429 chargingStation.getConnectorStatus(
430 connectorId
431 ).transactionEnergyActiveImportRegisterValue = 0;
432 chargingStation.getConnectorStatus(connectorId).transactionBeginMeterValue =
433 OCPP16ServiceUtils.buildTransactionBeginMeterValue(
434 chargingStation,
435 connectorId,
436 requestPayload.meterStart
437 );
438 chargingStation.getBeginEndMeterValues() &&
439 (await chargingStation.ocppRequestService.requestHandler<
440 OCPP16MeterValuesRequest,
441 OCPP16MeterValuesResponse
442 >(chargingStation, OCPP16RequestCommand.METER_VALUES, {
443 connectorId,
444 transactionId: payload.transactionId,
445 meterValue: [chargingStation.getConnectorStatus(connectorId).transactionBeginMeterValue],
446 }));
447 await chargingStation.ocppRequestService.requestHandler<
448 OCPP16StatusNotificationRequest,
449 OCPP16StatusNotificationResponse
450 >(chargingStation, OCPP16RequestCommand.STATUS_NOTIFICATION, {
451 connectorId,
452 status: OCPP16ChargePointStatus.CHARGING,
453 errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
454 });
455 chargingStation.getConnectorStatus(connectorId).status = OCPP16ChargePointStatus.CHARGING;
456 logger.info(
457 chargingStation.logPrefix() +
458 ' Transaction ' +
459 payload.transactionId.toString() +
460 ' STARTED on ' +
461 chargingStation.stationInfo.chargingStationId +
462 '#' +
463 connectorId.toString() +
464 ' for idTag ' +
465 requestPayload.idTag
466 );
467 if (chargingStation.stationInfo.powerSharedByConnectors) {
468 chargingStation.powerDivider++;
469 }
470 const configuredMeterValueSampleInterval =
471 ChargingStationConfigurationUtils.getConfigurationKey(
472 chargingStation,
473 OCPP16StandardParametersKey.MeterValueSampleInterval
474 );
475 chargingStation.startMeterValues(
476 connectorId,
477 configuredMeterValueSampleInterval
478 ? Utils.convertToInt(configuredMeterValueSampleInterval.value) * 1000
479 : 60000
480 );
481 } else {
482 logger.warn(
483 chargingStation.logPrefix() +
484 ' Starting transaction id ' +
485 payload.transactionId.toString() +
486 " REJECTED with status '" +
487 payload?.idTagInfo?.status +
488 "', idTag " +
489 requestPayload.idTag
490 );
491 await this.resetConnectorOnStartTransactionError(chargingStation, connectorId);
492 }
493 }
494
495 private async resetConnectorOnStartTransactionError(
496 chargingStation: ChargingStation,
497 connectorId: number
498 ): Promise<void> {
499 chargingStation.resetConnectorStatus(connectorId);
500 if (
501 chargingStation.getConnectorStatus(connectorId).status !== OCPP16ChargePointStatus.AVAILABLE
502 ) {
503 await chargingStation.ocppRequestService.requestHandler<
504 OCPP16StatusNotificationRequest,
505 OCPP16StatusNotificationResponse
506 >(chargingStation, OCPP16RequestCommand.STATUS_NOTIFICATION, {
507 connectorId,
508 status: OCPP16ChargePointStatus.AVAILABLE,
509 errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
510 });
511 chargingStation.getConnectorStatus(connectorId).status = OCPP16ChargePointStatus.AVAILABLE;
512 }
513 }
514
515 private async handleResponseStopTransaction(
516 chargingStation: ChargingStation,
517 payload: OCPP16StopTransactionResponse,
518 requestPayload: OCPP16StopTransactionRequest
519 ): Promise<void> {
520 const transactionConnectorId = chargingStation.getConnectorIdByTransactionId(
521 requestPayload.transactionId
522 );
523 if (!transactionConnectorId) {
524 logger.error(
525 chargingStation.logPrefix() +
526 ' Trying to stop a non existing transaction ' +
527 requestPayload.transactionId.toString()
528 );
529 return;
530 }
531 if (payload.idTagInfo?.status === OCPP16AuthorizationStatus.ACCEPTED) {
532 chargingStation.getBeginEndMeterValues() &&
533 !chargingStation.getOcppStrictCompliance() &&
534 chargingStation.getOutOfOrderEndMeterValues() &&
535 (await chargingStation.ocppRequestService.requestHandler<
536 OCPP16MeterValuesRequest,
537 OCPP16MeterValuesResponse
538 >(chargingStation, OCPP16RequestCommand.METER_VALUES, {
539 connectorId: transactionConnectorId,
540 transactionId: requestPayload.transactionId,
541 meterValue: [
542 OCPP16ServiceUtils.buildTransactionEndMeterValue(
543 chargingStation,
544 transactionConnectorId,
545 requestPayload.meterStop
546 ),
547 ],
548 }));
549 if (
550 !chargingStation.isChargingStationAvailable() ||
551 !chargingStation.isConnectorAvailable(transactionConnectorId)
552 ) {
553 await chargingStation.ocppRequestService.requestHandler<
554 OCPP16StatusNotificationRequest,
555 OCPP16StatusNotificationResponse
556 >(chargingStation, OCPP16RequestCommand.STATUS_NOTIFICATION, {
557 connectorId: transactionConnectorId,
558 status: OCPP16ChargePointStatus.UNAVAILABLE,
559 errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
560 });
561 chargingStation.getConnectorStatus(transactionConnectorId).status =
562 OCPP16ChargePointStatus.UNAVAILABLE;
563 } else {
564 await chargingStation.ocppRequestService.requestHandler<
565 OCPP16BootNotificationRequest,
566 OCPP16BootNotificationResponse
567 >(chargingStation, OCPP16RequestCommand.STATUS_NOTIFICATION, {
568 connectorId: transactionConnectorId,
569 status: OCPP16ChargePointStatus.AVAILABLE,
570 errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
571 });
572 chargingStation.getConnectorStatus(transactionConnectorId).status =
573 OCPP16ChargePointStatus.AVAILABLE;
574 }
575 if (chargingStation.stationInfo.powerSharedByConnectors) {
576 chargingStation.powerDivider--;
577 }
578 logger.info(
579 chargingStation.logPrefix() +
580 ' Transaction ' +
581 requestPayload.transactionId.toString() +
582 ' STOPPED on ' +
583 chargingStation.stationInfo.chargingStationId +
584 '#' +
585 transactionConnectorId.toString()
586 );
587 chargingStation.resetConnectorStatus(transactionConnectorId);
588 } else {
589 logger.warn(
590 chargingStation.logPrefix() +
591 ' Stopping transaction id ' +
592 requestPayload.transactionId.toString() +
593 " REJECTED with status '" +
594 payload.idTagInfo?.status +
595 "'"
596 );
597 }
598 }
599 }