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 this.validatePayload(chargingStation
, commandName
, payload
);
183 await this.responseHandlers
.get(commandName
)(chargingStation
, payload
, requestPayload
);
185 logger
.error(chargingStation
.logPrefix() + ' Handle request response error: %j', error
);
191 ErrorType
.NOT_IMPLEMENTED
,
192 `${commandName} is not implemented to handle request response PDU ${JSON.stringify(
203 ErrorType
.SECURITY_ERROR
,
204 `${commandName} cannot be issued to handle request response PDU ${JSON.stringify(
208 )} while the charging station is not registered on the central server. `,
215 private validatePayload(
216 chargingStation
: ChargingStation
,
217 commandName
: OCPP16RequestCommand
,
220 if (this.jsonSchemas
.has(commandName
)) {
221 return this.validateResponsePayload(
224 this.jsonSchemas
.get(commandName
),
229 `${chargingStation.logPrefix()} ${moduleName}.responseHandler: No JSON schema found for command ${commandName} PDU validation`
234 private handleResponseBootNotification(
235 chargingStation
: ChargingStation
,
236 payload
: OCPP16BootNotificationResponse
238 if (payload
.status === OCPP16RegistrationStatus
.ACCEPTED
) {
239 ChargingStationConfigurationUtils
.addConfigurationKey(
241 OCPP16StandardParametersKey
.HeartbeatInterval
,
242 payload
.interval
.toString(),
244 { overwrite
: true, save
: true }
246 ChargingStationConfigurationUtils
.addConfigurationKey(
248 OCPP16StandardParametersKey
.HeartBeatInterval
,
249 payload
.interval
.toString(),
251 { overwrite
: true, save
: true }
253 chargingStation
.heartbeatSetInterval
254 ? chargingStation
.restartHeartbeat()
255 : chargingStation
.startHeartbeat();
257 if (Object.values(OCPP16RegistrationStatus
).includes(payload
.status)) {
258 const logMsg
= `${chargingStation.logPrefix()} Charging station in '${
260 }' state on the central server`;
261 payload
.status === OCPP16RegistrationStatus
.REJECTED
262 ? logger
.warn(logMsg
)
263 : logger
.info(logMsg
);
266 chargingStation
.logPrefix() +
267 ' Charging station boot notification response received: %j with undefined registration status',
273 private handleResponseAuthorize(
274 chargingStation
: ChargingStation
,
275 payload
: OCPP16AuthorizeResponse
,
276 requestPayload
: OCPP16AuthorizeRequest
278 let authorizeConnectorId
: number;
279 for (const connectorId
of chargingStation
.connectors
.keys()) {
282 chargingStation
.getConnectorStatus(connectorId
)?.authorizeIdTag
=== requestPayload
.idTag
284 authorizeConnectorId
= connectorId
;
288 if (payload
.idTagInfo
.status === OCPP16AuthorizationStatus
.ACCEPTED
) {
289 chargingStation
.getConnectorStatus(authorizeConnectorId
).idTagAuthorized
= true;
291 `${chargingStation.logPrefix()} IdTag ${
293 } authorized on connector ${authorizeConnectorId}`
296 chargingStation
.getConnectorStatus(authorizeConnectorId
).idTagAuthorized
= false;
297 delete chargingStation
.getConnectorStatus(authorizeConnectorId
).authorizeIdTag
;
299 `${chargingStation.logPrefix()} IdTag ${requestPayload.idTag} refused with status '${
300 payload.idTagInfo.status
301 }' on connector ${authorizeConnectorId}`
306 private async handleResponseStartTransaction(
307 chargingStation
: ChargingStation
,
308 payload
: OCPP16StartTransactionResponse
,
309 requestPayload
: OCPP16StartTransactionRequest
311 const connectorId
= requestPayload
.connectorId
;
313 let transactionConnectorId
: number;
314 for (const id
of chargingStation
.connectors
.keys()) {
315 if (id
> 0 && id
=== connectorId
) {
316 transactionConnectorId
= id
;
320 if (!transactionConnectorId
) {
322 chargingStation
.logPrefix() +
323 ' Trying to start a transaction on a non existing connector Id ' +
324 connectorId
.toString()
329 chargingStation
.getConnectorStatus(connectorId
).transactionRemoteStarted
&&
330 chargingStation
.getAuthorizeRemoteTxRequests() &&
331 chargingStation
.getLocalAuthListEnabled() &&
332 chargingStation
.hasAuthorizedTags() &&
333 !chargingStation
.getConnectorStatus(connectorId
).idTagLocalAuthorized
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()
342 await this.resetConnectorOnStartTransactionError(chargingStation
, connectorId
);
346 chargingStation
.getConnectorStatus(connectorId
).transactionRemoteStarted
&&
347 chargingStation
.getAuthorizeRemoteTxRequests() &&
348 chargingStation
.getMayAuthorizeAtRemoteStart() &&
349 !chargingStation
.getConnectorStatus(connectorId
).idTagLocalAuthorized
&&
350 !chargingStation
.getConnectorStatus(connectorId
).idTagAuthorized
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()
359 await this.resetConnectorOnStartTransactionError(chargingStation
, connectorId
);
363 chargingStation
.getConnectorStatus(connectorId
).idTagAuthorized
&&
364 chargingStation
.getConnectorStatus(connectorId
).authorizeIdTag
!== requestPayload
.idTag
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()
375 await this.resetConnectorOnStartTransactionError(chargingStation
, connectorId
);
379 chargingStation
.getConnectorStatus(connectorId
).idTagLocalAuthorized
&&
380 chargingStation
.getConnectorStatus(connectorId
).localAuthorizeIdTag
!== requestPayload
.idTag
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()
391 await this.resetConnectorOnStartTransactionError(chargingStation
, connectorId
);
394 if (chargingStation
.getConnectorStatus(connectorId
)?.transactionStarted
) {
396 chargingStation
.logPrefix() +
397 ' Trying to start a transaction on an already used connector ' +
398 connectorId
.toString() +
400 chargingStation
.getConnectorStatus(connectorId
)
405 chargingStation
.getConnectorStatus(connectorId
)?.status !==
406 OCPP16ChargePointStatus
.AVAILABLE
&&
407 chargingStation
.getConnectorStatus(connectorId
)?.status !== OCPP16ChargePointStatus
.PREPARING
410 `${chargingStation.logPrefix()} Trying to start a transaction on connector ${connectorId.toString()} with status ${
411 chargingStation.getConnectorStatus(connectorId)?.status
416 if (!Number.isInteger(payload
.transactionId
)) {
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`
422 payload
.transactionId
= Utils
.convertToInt(payload
.transactionId
);
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(
431 ).transactionEnergyActiveImportRegisterValue
= 0;
432 chargingStation
.getConnectorStatus(connectorId
).transactionBeginMeterValue
=
433 OCPP16ServiceUtils
.buildTransactionBeginMeterValue(
436 requestPayload
.meterStart
438 chargingStation
.getBeginEndMeterValues() &&
439 (await chargingStation
.ocppRequestService
.requestHandler
<
440 OCPP16MeterValuesRequest
,
441 OCPP16MeterValuesResponse
442 >(chargingStation
, OCPP16RequestCommand
.METER_VALUES
, {
444 transactionId
: payload
.transactionId
,
445 meterValue
: [chargingStation
.getConnectorStatus(connectorId
).transactionBeginMeterValue
],
447 await chargingStation
.ocppRequestService
.requestHandler
<
448 OCPP16StatusNotificationRequest
,
449 OCPP16StatusNotificationResponse
450 >(chargingStation
, OCPP16RequestCommand
.STATUS_NOTIFICATION
, {
452 status: OCPP16ChargePointStatus
.CHARGING
,
453 errorCode
: OCPP16ChargePointErrorCode
.NO_ERROR
,
455 chargingStation
.getConnectorStatus(connectorId
).status = OCPP16ChargePointStatus
.CHARGING
;
457 chargingStation
.logPrefix() +
459 payload
.transactionId
.toString() +
461 chargingStation
.stationInfo
.chargingStationId
+
463 connectorId
.toString() +
467 if (chargingStation
.stationInfo
.powerSharedByConnectors
) {
468 chargingStation
.powerDivider
++;
470 const configuredMeterValueSampleInterval
=
471 ChargingStationConfigurationUtils
.getConfigurationKey(
473 OCPP16StandardParametersKey
.MeterValueSampleInterval
475 chargingStation
.startMeterValues(
477 configuredMeterValueSampleInterval
478 ? Utils
.convertToInt(configuredMeterValueSampleInterval
.value
) * 1000
483 chargingStation
.logPrefix() +
484 ' Starting transaction id ' +
485 payload
.transactionId
.toString() +
486 " REJECTED with status '" +
487 payload
?.idTagInfo
?.status +
491 await this.resetConnectorOnStartTransactionError(chargingStation
, connectorId
);
495 private async resetConnectorOnStartTransactionError(
496 chargingStation
: ChargingStation
,
499 chargingStation
.resetConnectorStatus(connectorId
);
501 chargingStation
.getConnectorStatus(connectorId
).status !== OCPP16ChargePointStatus
.AVAILABLE
503 await chargingStation
.ocppRequestService
.requestHandler
<
504 OCPP16StatusNotificationRequest
,
505 OCPP16StatusNotificationResponse
506 >(chargingStation
, OCPP16RequestCommand
.STATUS_NOTIFICATION
, {
508 status: OCPP16ChargePointStatus
.AVAILABLE
,
509 errorCode
: OCPP16ChargePointErrorCode
.NO_ERROR
,
511 chargingStation
.getConnectorStatus(connectorId
).status = OCPP16ChargePointStatus
.AVAILABLE
;
515 private async handleResponseStopTransaction(
516 chargingStation
: ChargingStation
,
517 payload
: OCPP16StopTransactionResponse
,
518 requestPayload
: OCPP16StopTransactionRequest
520 const transactionConnectorId
= chargingStation
.getConnectorIdByTransactionId(
521 requestPayload
.transactionId
523 if (!transactionConnectorId
) {
525 chargingStation
.logPrefix() +
526 ' Trying to stop a non existing transaction ' +
527 requestPayload
.transactionId
.toString()
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
,
542 OCPP16ServiceUtils
.buildTransactionEndMeterValue(
544 transactionConnectorId
,
545 requestPayload
.meterStop
550 !chargingStation
.isChargingStationAvailable() ||
551 !chargingStation
.isConnectorAvailable(transactionConnectorId
)
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
,
561 chargingStation
.getConnectorStatus(transactionConnectorId
).status =
562 OCPP16ChargePointStatus
.UNAVAILABLE
;
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
,
572 chargingStation
.getConnectorStatus(transactionConnectorId
).status =
573 OCPP16ChargePointStatus
.AVAILABLE
;
575 if (chargingStation
.stationInfo
.powerSharedByConnectors
) {
576 chargingStation
.powerDivider
--;
579 chargingStation
.logPrefix() +
581 requestPayload
.transactionId
.toString() +
583 chargingStation
.stationInfo
.chargingStationId
+
585 transactionConnectorId
.toString()
587 chargingStation
.resetConnectorStatus(transactionConnectorId
);
590 chargingStation
.logPrefix() +
591 ' Stopping transaction id ' +
592 requestPayload
.transactionId
.toString() +
593 " REJECTED with status '" +
594 payload
.idTagInfo
?.status +