1 // Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
4 import path from
'path';
5 import { fileURLToPath
} from
'url';
7 import { JSONSchemaType
} from
'ajv';
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';
15 OCPP16MeterValuesRequest
,
16 OCPP16MeterValuesResponse
,
17 } from
'../../../types/ocpp/1.6/MeterValues';
19 OCPP16BootNotificationRequest
,
21 OCPP16StatusNotificationRequest
,
22 } from
'../../../types/ocpp/1.6/Requests';
24 DiagnosticsStatusNotificationResponse
,
25 OCPP16BootNotificationResponse
,
26 OCPP16HeartbeatResponse
,
27 OCPP16RegistrationStatus
,
28 OCPP16StatusNotificationResponse
,
29 } from
'../../../types/ocpp/1.6/Responses';
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';
49 const moduleName
= 'OCPP16ResponseService';
51 export default class OCPP16ResponseService
extends OCPPResponseService
{
52 private responseHandlers
: Map
<OCPP16RequestCommand
, ResponseHandler
>;
53 private jsonSchemas
: Map
<OCPP16RequestCommand
, JSONSchemaType
<JsonObject
>>;
55 public constructor() {
56 if (new.target
?.name
=== moduleName
) {
57 throw new TypeError(`Cannot construct ${new.target?.name} instances directly`);
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)],
70 this.jsonSchemas
= new Map
<OCPP16RequestCommand
, JSONSchemaType
<JsonObject
>>([
72 OCPP16RequestCommand
.BOOT_NOTIFICATION
,
76 path
.dirname(fileURLToPath(import.meta
.url
)),
77 '../../../assets/json-schemas/ocpp/1.6/BootNotificationResponse.json'
81 ) as JSONSchemaType
<OCPP16BootNotificationResponse
>,
84 OCPP16RequestCommand
.HEARTBEAT
,
88 path
.dirname(fileURLToPath(import.meta
.url
)),
89 '../../../assets/json-schemas/ocpp/1.6/HeartbeatResponse.json'
93 ) as JSONSchemaType
<OCPP16HeartbeatResponse
>,
96 OCPP16RequestCommand
.AUTHORIZE
,
100 path
.dirname(fileURLToPath(import.meta
.url
)),
101 '../../../assets/json-schemas/ocpp/1.6/AuthorizeResponse.json'
105 ) as JSONSchemaType
<OCPP16AuthorizeResponse
>,
108 OCPP16RequestCommand
.START_TRANSACTION
,
112 path
.dirname(fileURLToPath(import.meta
.url
)),
113 '../../../assets/json-schemas/ocpp/1.6/StartTransactionResponse.json'
117 ) as JSONSchemaType
<OCPP16StartTransactionResponse
>,
120 OCPP16RequestCommand
.STOP_TRANSACTION
,
124 path
.dirname(fileURLToPath(import.meta
.url
)),
125 '../../../assets/json-schemas/ocpp/1.6/StopTransactionResponse.json'
129 ) as JSONSchemaType
<OCPP16StopTransactionResponse
>,
132 OCPP16RequestCommand
.STATUS_NOTIFICATION
,
136 path
.dirname(fileURLToPath(import.meta
.url
)),
137 '../../../assets/json-schemas/ocpp/1.6/StatusNotificationResponse.json'
141 ) as JSONSchemaType
<OCPP16StatusNotificationResponse
>,
144 OCPP16RequestCommand
.METER_VALUES
,
148 path
.dirname(fileURLToPath(import.meta
.url
)),
149 '../../../assets/json-schemas/ocpp/1.6/MeterValuesResponse.json'
153 ) as JSONSchemaType
<OCPP16MeterValuesResponse
>,
156 OCPP16RequestCommand
.DIAGNOSTICS_STATUS_NOTIFICATION
,
160 path
.dirname(fileURLToPath(import.meta
.url
)),
161 '../../../assets/json-schemas/ocpp/1.6/DiagnosticsStatusNotificationResponse.json'
165 ) as JSONSchemaType
<DiagnosticsStatusNotificationResponse
>,
170 public async responseHandler(
171 chargingStation
: ChargingStation
,
172 commandName
: OCPP16RequestCommand
,
174 requestPayload
: JsonType
176 if (chargingStation
.isRegistered() || commandName
=== OCPP16RequestCommand
.BOOT_NOTIFICATION
) {
178 this.responseHandlers
.has(commandName
) &&
179 ChargingStationUtils
.isRequestCommandSupported(commandName
, chargingStation
)
182 if (this.jsonSchemas
.has(commandName
)) {
183 this.validateResponsePayload(
186 this.jsonSchemas
.get(commandName
),
191 `${chargingStation.logPrefix()} ${moduleName}.responseHandler: No JSON schema found for command ${commandName} PDU validation`
194 await this.responseHandlers
.get(commandName
)(chargingStation
, payload
, requestPayload
);
196 logger
.error(chargingStation
.logPrefix() + ' Handle request response error: %j', error
);
202 ErrorType
.NOT_IMPLEMENTED
,
203 `${commandName} is not implemented to handle request response PDU ${JSON.stringify(
214 ErrorType
.SECURITY_ERROR
,
215 `${commandName} cannot be issued to handle request response PDU ${JSON.stringify(
219 )} while the charging station is not registered on the central server. `,
226 private handleResponseBootNotification(
227 chargingStation
: ChargingStation
,
228 payload
: OCPP16BootNotificationResponse
230 if (payload
.status === OCPP16RegistrationStatus
.ACCEPTED
) {
231 ChargingStationConfigurationUtils
.addConfigurationKey(
233 OCPP16StandardParametersKey
.HeartbeatInterval
,
234 payload
.interval
.toString(),
236 { overwrite
: true, save
: true }
238 ChargingStationConfigurationUtils
.addConfigurationKey(
240 OCPP16StandardParametersKey
.HeartBeatInterval
,
241 payload
.interval
.toString(),
243 { overwrite
: true, save
: true }
245 chargingStation
.heartbeatSetInterval
246 ? chargingStation
.restartHeartbeat()
247 : chargingStation
.startHeartbeat();
249 if (Object.values(OCPP16RegistrationStatus
).includes(payload
.status)) {
250 const logMsg
= `${chargingStation.logPrefix()} Charging station in '${
252 }' state on the central server`;
253 payload
.status === OCPP16RegistrationStatus
.REJECTED
254 ? logger
.warn(logMsg
)
255 : logger
.info(logMsg
);
258 chargingStation
.logPrefix() +
259 ' Charging station boot notification response received: %j with undefined registration status',
265 private handleResponseAuthorize(
266 chargingStation
: ChargingStation
,
267 payload
: OCPP16AuthorizeResponse
,
268 requestPayload
: OCPP16AuthorizeRequest
270 let authorizeConnectorId
: number;
271 for (const connectorId
of chargingStation
.connectors
.keys()) {
274 chargingStation
.getConnectorStatus(connectorId
)?.authorizeIdTag
=== requestPayload
.idTag
276 authorizeConnectorId
= connectorId
;
280 if (payload
.idTagInfo
.status === OCPP16AuthorizationStatus
.ACCEPTED
) {
281 chargingStation
.getConnectorStatus(authorizeConnectorId
).idTagAuthorized
= true;
283 `${chargingStation.logPrefix()} IdTag ${
285 } authorized on connector ${authorizeConnectorId}`
288 chargingStation
.getConnectorStatus(authorizeConnectorId
).idTagAuthorized
= false;
289 delete chargingStation
.getConnectorStatus(authorizeConnectorId
).authorizeIdTag
;
291 `${chargingStation.logPrefix()} IdTag ${requestPayload.idTag} refused with status '${
292 payload.idTagInfo.status
293 }' on connector ${authorizeConnectorId}`
298 private async handleResponseStartTransaction(
299 chargingStation
: ChargingStation
,
300 payload
: OCPP16StartTransactionResponse
,
301 requestPayload
: OCPP16StartTransactionRequest
303 const connectorId
= requestPayload
.connectorId
;
305 let transactionConnectorId
: number;
306 for (const id
of chargingStation
.connectors
.keys()) {
307 if (id
> 0 && id
=== connectorId
) {
308 transactionConnectorId
= id
;
312 if (!transactionConnectorId
) {
314 chargingStation
.logPrefix() +
315 ' Trying to start a transaction on a non existing connector Id ' +
316 connectorId
.toString()
321 chargingStation
.getConnectorStatus(connectorId
).transactionRemoteStarted
&&
322 chargingStation
.getAuthorizeRemoteTxRequests() &&
323 chargingStation
.getLocalAuthListEnabled() &&
324 chargingStation
.hasAuthorizedTags() &&
325 !chargingStation
.getConnectorStatus(connectorId
).idTagLocalAuthorized
328 chargingStation
.logPrefix() +
329 ' Trying to start a transaction with a not local authorized idTag ' +
330 chargingStation
.getConnectorStatus(connectorId
).localAuthorizeIdTag
+
331 ' on connector Id ' +
332 connectorId
.toString()
334 await this.resetConnectorOnStartTransactionError(chargingStation
, connectorId
);
338 chargingStation
.getConnectorStatus(connectorId
).transactionRemoteStarted
&&
339 chargingStation
.getAuthorizeRemoteTxRequests() &&
340 chargingStation
.getMayAuthorizeAtRemoteStart() &&
341 !chargingStation
.getConnectorStatus(connectorId
).idTagLocalAuthorized
&&
342 !chargingStation
.getConnectorStatus(connectorId
).idTagAuthorized
345 chargingStation
.logPrefix() +
346 ' Trying to start a transaction with a not authorized idTag ' +
347 chargingStation
.getConnectorStatus(connectorId
).authorizeIdTag
+
348 ' on connector Id ' +
349 connectorId
.toString()
351 await this.resetConnectorOnStartTransactionError(chargingStation
, connectorId
);
355 chargingStation
.getConnectorStatus(connectorId
).idTagAuthorized
&&
356 chargingStation
.getConnectorStatus(connectorId
).authorizeIdTag
!== requestPayload
.idTag
359 chargingStation
.logPrefix() +
360 ' Trying to start a transaction with an idTag ' +
361 requestPayload
.idTag
+
362 ' different from the authorize request one ' +
363 chargingStation
.getConnectorStatus(connectorId
).authorizeIdTag
+
364 ' on connector Id ' +
365 connectorId
.toString()
367 await this.resetConnectorOnStartTransactionError(chargingStation
, connectorId
);
371 chargingStation
.getConnectorStatus(connectorId
).idTagLocalAuthorized
&&
372 chargingStation
.getConnectorStatus(connectorId
).localAuthorizeIdTag
!== requestPayload
.idTag
375 chargingStation
.logPrefix() +
376 ' Trying to start a transaction with an idTag ' +
377 requestPayload
.idTag
+
378 ' different from the local authorized one ' +
379 chargingStation
.getConnectorStatus(connectorId
).localAuthorizeIdTag
+
380 ' on connector Id ' +
381 connectorId
.toString()
383 await this.resetConnectorOnStartTransactionError(chargingStation
, connectorId
);
386 if (chargingStation
.getConnectorStatus(connectorId
)?.transactionStarted
) {
388 chargingStation
.logPrefix() +
389 ' Trying to start a transaction on an already used connector ' +
390 connectorId
.toString() +
392 chargingStation
.getConnectorStatus(connectorId
)
397 chargingStation
.getConnectorStatus(connectorId
)?.status !==
398 OCPP16ChargePointStatus
.AVAILABLE
&&
399 chargingStation
.getConnectorStatus(connectorId
)?.status !== OCPP16ChargePointStatus
.PREPARING
402 `${chargingStation.logPrefix()} Trying to start a transaction on connector ${connectorId.toString()} with status ${
403 chargingStation.getConnectorStatus(connectorId)?.status
408 if (!Number.isInteger(payload
.transactionId
)) {
410 `${chargingStation.logPrefix()} Trying to start a transaction on connector ${connectorId.toString()} with a non integer transaction Id ${
411 payload.transactionId
412 }, converting to integer`
414 payload
.transactionId
= Utils
.convertToInt(payload
.transactionId
);
417 if (payload
.idTagInfo
?.status === OCPP16AuthorizationStatus
.ACCEPTED
) {
418 chargingStation
.getConnectorStatus(connectorId
).transactionStarted
= true;
419 chargingStation
.getConnectorStatus(connectorId
).transactionId
= payload
.transactionId
;
420 chargingStation
.getConnectorStatus(connectorId
).transactionIdTag
= requestPayload
.idTag
;
421 chargingStation
.getConnectorStatus(
423 ).transactionEnergyActiveImportRegisterValue
= 0;
424 chargingStation
.getConnectorStatus(connectorId
).transactionBeginMeterValue
=
425 OCPP16ServiceUtils
.buildTransactionBeginMeterValue(
428 requestPayload
.meterStart
430 chargingStation
.getBeginEndMeterValues() &&
431 (await chargingStation
.ocppRequestService
.requestHandler
<
432 OCPP16MeterValuesRequest
,
433 OCPP16MeterValuesResponse
434 >(chargingStation
, OCPP16RequestCommand
.METER_VALUES
, {
436 transactionId
: payload
.transactionId
,
437 meterValue
: [chargingStation
.getConnectorStatus(connectorId
).transactionBeginMeterValue
],
439 await chargingStation
.ocppRequestService
.requestHandler
<
440 OCPP16StatusNotificationRequest
,
441 OCPP16StatusNotificationResponse
442 >(chargingStation
, OCPP16RequestCommand
.STATUS_NOTIFICATION
, {
444 status: OCPP16ChargePointStatus
.CHARGING
,
445 errorCode
: OCPP16ChargePointErrorCode
.NO_ERROR
,
447 chargingStation
.getConnectorStatus(connectorId
).status = OCPP16ChargePointStatus
.CHARGING
;
449 chargingStation
.logPrefix() +
451 payload
.transactionId
.toString() +
453 chargingStation
.stationInfo
.chargingStationId
+
455 connectorId
.toString() +
459 if (chargingStation
.stationInfo
.powerSharedByConnectors
) {
460 chargingStation
.powerDivider
++;
462 const configuredMeterValueSampleInterval
=
463 ChargingStationConfigurationUtils
.getConfigurationKey(
465 OCPP16StandardParametersKey
.MeterValueSampleInterval
467 chargingStation
.startMeterValues(
469 configuredMeterValueSampleInterval
470 ? Utils
.convertToInt(configuredMeterValueSampleInterval
.value
) * 1000
475 chargingStation
.logPrefix() +
476 ' Starting transaction id ' +
477 payload
.transactionId
.toString() +
478 " REJECTED with status '" +
479 payload
?.idTagInfo
?.status +
483 await this.resetConnectorOnStartTransactionError(chargingStation
, connectorId
);
487 private async resetConnectorOnStartTransactionError(
488 chargingStation
: ChargingStation
,
491 chargingStation
.resetConnectorStatus(connectorId
);
493 chargingStation
.getConnectorStatus(connectorId
).status !== OCPP16ChargePointStatus
.AVAILABLE
495 await chargingStation
.ocppRequestService
.requestHandler
<
496 OCPP16StatusNotificationRequest
,
497 OCPP16StatusNotificationResponse
498 >(chargingStation
, OCPP16RequestCommand
.STATUS_NOTIFICATION
, {
500 status: OCPP16ChargePointStatus
.AVAILABLE
,
501 errorCode
: OCPP16ChargePointErrorCode
.NO_ERROR
,
503 chargingStation
.getConnectorStatus(connectorId
).status = OCPP16ChargePointStatus
.AVAILABLE
;
507 private async handleResponseStopTransaction(
508 chargingStation
: ChargingStation
,
509 payload
: OCPP16StopTransactionResponse
,
510 requestPayload
: OCPP16StopTransactionRequest
512 const transactionConnectorId
= chargingStation
.getConnectorIdByTransactionId(
513 requestPayload
.transactionId
515 if (!transactionConnectorId
) {
517 chargingStation
.logPrefix() +
518 ' Trying to stop a non existing transaction ' +
519 requestPayload
.transactionId
.toString()
523 if (payload
.idTagInfo
?.status === OCPP16AuthorizationStatus
.ACCEPTED
) {
524 chargingStation
.getBeginEndMeterValues() &&
525 !chargingStation
.getOcppStrictCompliance() &&
526 chargingStation
.getOutOfOrderEndMeterValues() &&
527 (await chargingStation
.ocppRequestService
.requestHandler
<
528 OCPP16MeterValuesRequest
,
529 OCPP16MeterValuesResponse
530 >(chargingStation
, OCPP16RequestCommand
.METER_VALUES
, {
531 connectorId
: transactionConnectorId
,
532 transactionId
: requestPayload
.transactionId
,
534 OCPP16ServiceUtils
.buildTransactionEndMeterValue(
536 transactionConnectorId
,
537 requestPayload
.meterStop
542 !chargingStation
.isChargingStationAvailable() ||
543 !chargingStation
.isConnectorAvailable(transactionConnectorId
)
545 await chargingStation
.ocppRequestService
.requestHandler
<
546 OCPP16StatusNotificationRequest
,
547 OCPP16StatusNotificationResponse
548 >(chargingStation
, OCPP16RequestCommand
.STATUS_NOTIFICATION
, {
549 connectorId
: transactionConnectorId
,
550 status: OCPP16ChargePointStatus
.UNAVAILABLE
,
551 errorCode
: OCPP16ChargePointErrorCode
.NO_ERROR
,
553 chargingStation
.getConnectorStatus(transactionConnectorId
).status =
554 OCPP16ChargePointStatus
.UNAVAILABLE
;
556 await chargingStation
.ocppRequestService
.requestHandler
<
557 OCPP16BootNotificationRequest
,
558 OCPP16BootNotificationResponse
559 >(chargingStation
, OCPP16RequestCommand
.STATUS_NOTIFICATION
, {
560 connectorId
: transactionConnectorId
,
561 status: OCPP16ChargePointStatus
.AVAILABLE
,
562 errorCode
: OCPP16ChargePointErrorCode
.NO_ERROR
,
564 chargingStation
.getConnectorStatus(transactionConnectorId
).status =
565 OCPP16ChargePointStatus
.AVAILABLE
;
567 if (chargingStation
.stationInfo
.powerSharedByConnectors
) {
568 chargingStation
.powerDivider
--;
571 chargingStation
.logPrefix() +
573 requestPayload
.transactionId
.toString() +
575 chargingStation
.stationInfo
.chargingStationId
+
577 transactionConnectorId
.toString()
579 chargingStation
.resetConnectorStatus(transactionConnectorId
);
582 chargingStation
.logPrefix() +
583 ' Stopping transaction id ' +
584 requestPayload
.transactionId
.toString() +
585 " REJECTED with status '" +
586 payload
.idTagInfo
?.status +