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