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
>,
168 this.validatePayload
.bind(this);
171 public async responseHandler(
172 chargingStation
: ChargingStation
,
173 commandName
: OCPP16RequestCommand
,
175 requestPayload
: JsonType
177 if (chargingStation
.isRegistered() || commandName
=== OCPP16RequestCommand
.BOOT_NOTIFICATION
) {
179 this.responseHandlers
.has(commandName
) &&
180 ChargingStationUtils
.isRequestCommandSupported(commandName
, chargingStation
)
183 this.validatePayload(chargingStation
, commandName
, payload
);
184 await this.responseHandlers
.get(commandName
)(chargingStation
, payload
, requestPayload
);
186 logger
.error(chargingStation
.logPrefix() + ' Handle request response error: %j', error
);
192 ErrorType
.NOT_IMPLEMENTED
,
193 `${commandName} is not implemented to handle request response PDU ${JSON.stringify(
204 ErrorType
.SECURITY_ERROR
,
205 `${commandName} cannot be issued to handle request response PDU ${JSON.stringify(
209 )} while the charging station is not registered on the central server. `,
216 private validatePayload(
217 chargingStation
: ChargingStation
,
218 commandName
: OCPP16RequestCommand
,
221 if (this.jsonSchemas
.has(commandName
)) {
222 return this.validateResponsePayload(
225 this.jsonSchemas
.get(commandName
),
230 `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema found for command ${commandName} PDU validation`
235 private handleResponseBootNotification(
236 chargingStation
: ChargingStation
,
237 payload
: OCPP16BootNotificationResponse
239 if (payload
.status === OCPP16RegistrationStatus
.ACCEPTED
) {
240 ChargingStationConfigurationUtils
.addConfigurationKey(
242 OCPP16StandardParametersKey
.HeartbeatInterval
,
243 payload
.interval
.toString(),
245 { overwrite
: true, save
: true }
247 ChargingStationConfigurationUtils
.addConfigurationKey(
249 OCPP16StandardParametersKey
.HeartBeatInterval
,
250 payload
.interval
.toString(),
252 { overwrite
: true, save
: true }
254 chargingStation
.heartbeatSetInterval
255 ? chargingStation
.restartHeartbeat()
256 : chargingStation
.startHeartbeat();
258 if (Object.values(OCPP16RegistrationStatus
).includes(payload
.status)) {
259 const logMsg
= `${chargingStation.logPrefix()} Charging station in '${
261 }' state on the central server`;
262 payload
.status === OCPP16RegistrationStatus
.REJECTED
263 ? logger
.warn(logMsg
)
264 : logger
.info(logMsg
);
267 chargingStation
.logPrefix() +
268 ' Charging station boot notification response received: %j with undefined registration status',
274 private handleResponseAuthorize(
275 chargingStation
: ChargingStation
,
276 payload
: OCPP16AuthorizeResponse
,
277 requestPayload
: OCPP16AuthorizeRequest
279 let authorizeConnectorId
: number;
280 for (const connectorId
of chargingStation
.connectors
.keys()) {
283 chargingStation
.getConnectorStatus(connectorId
)?.authorizeIdTag
=== requestPayload
.idTag
285 authorizeConnectorId
= connectorId
;
289 if (payload
.idTagInfo
.status === OCPP16AuthorizationStatus
.ACCEPTED
) {
290 chargingStation
.getConnectorStatus(authorizeConnectorId
).idTagAuthorized
= true;
292 `${chargingStation.logPrefix()} IdTag ${
294 } authorized on connector ${authorizeConnectorId}`
297 chargingStation
.getConnectorStatus(authorizeConnectorId
).idTagAuthorized
= false;
298 delete chargingStation
.getConnectorStatus(authorizeConnectorId
).authorizeIdTag
;
300 `${chargingStation.logPrefix()} IdTag ${requestPayload.idTag} refused with status '${
301 payload.idTagInfo.status
302 }' on connector ${authorizeConnectorId}`
307 private async handleResponseStartTransaction(
308 chargingStation
: ChargingStation
,
309 payload
: OCPP16StartTransactionResponse
,
310 requestPayload
: OCPP16StartTransactionRequest
312 const connectorId
= requestPayload
.connectorId
;
314 let transactionConnectorId
: number;
315 for (const id
of chargingStation
.connectors
.keys()) {
316 if (id
> 0 && id
=== connectorId
) {
317 transactionConnectorId
= id
;
321 if (!transactionConnectorId
) {
323 chargingStation
.logPrefix() +
324 ' Trying to start a transaction on a non existing connector Id ' +
325 connectorId
.toString()
330 chargingStation
.getConnectorStatus(connectorId
).transactionRemoteStarted
&&
331 chargingStation
.getAuthorizeRemoteTxRequests() &&
332 chargingStation
.getLocalAuthListEnabled() &&
333 chargingStation
.hasAuthorizedTags() &&
334 !chargingStation
.getConnectorStatus(connectorId
).idTagLocalAuthorized
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()
343 await this.resetConnectorOnStartTransactionError(chargingStation
, connectorId
);
347 chargingStation
.getConnectorStatus(connectorId
).transactionRemoteStarted
&&
348 chargingStation
.getAuthorizeRemoteTxRequests() &&
349 chargingStation
.getMayAuthorizeAtRemoteStart() &&
350 !chargingStation
.getConnectorStatus(connectorId
).idTagLocalAuthorized
&&
351 !chargingStation
.getConnectorStatus(connectorId
).idTagAuthorized
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()
360 await this.resetConnectorOnStartTransactionError(chargingStation
, connectorId
);
364 chargingStation
.getConnectorStatus(connectorId
).idTagAuthorized
&&
365 chargingStation
.getConnectorStatus(connectorId
).authorizeIdTag
!== requestPayload
.idTag
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()
376 await this.resetConnectorOnStartTransactionError(chargingStation
, connectorId
);
380 chargingStation
.getConnectorStatus(connectorId
).idTagLocalAuthorized
&&
381 chargingStation
.getConnectorStatus(connectorId
).localAuthorizeIdTag
!== requestPayload
.idTag
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()
392 await this.resetConnectorOnStartTransactionError(chargingStation
, connectorId
);
395 if (chargingStation
.getConnectorStatus(connectorId
)?.transactionStarted
) {
397 chargingStation
.logPrefix() +
398 ' Trying to start a transaction on an already used connector ' +
399 connectorId
.toString() +
401 chargingStation
.getConnectorStatus(connectorId
)
406 chargingStation
.getConnectorStatus(connectorId
)?.status !==
407 OCPP16ChargePointStatus
.AVAILABLE
&&
408 chargingStation
.getConnectorStatus(connectorId
)?.status !== OCPP16ChargePointStatus
.PREPARING
411 `${chargingStation.logPrefix()} Trying to start a transaction on connector ${connectorId.toString()} with status ${
412 chargingStation.getConnectorStatus(connectorId)?.status
417 if (!Number.isInteger(payload
.transactionId
)) {
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`
423 payload
.transactionId
= Utils
.convertToInt(payload
.transactionId
);
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(
432 ).transactionEnergyActiveImportRegisterValue
= 0;
433 chargingStation
.getConnectorStatus(connectorId
).transactionBeginMeterValue
=
434 OCPP16ServiceUtils
.buildTransactionBeginMeterValue(
437 requestPayload
.meterStart
439 chargingStation
.getBeginEndMeterValues() &&
440 (await chargingStation
.ocppRequestService
.requestHandler
<
441 OCPP16MeterValuesRequest
,
442 OCPP16MeterValuesResponse
443 >(chargingStation
, OCPP16RequestCommand
.METER_VALUES
, {
445 transactionId
: payload
.transactionId
,
446 meterValue
: [chargingStation
.getConnectorStatus(connectorId
).transactionBeginMeterValue
],
448 await chargingStation
.ocppRequestService
.requestHandler
<
449 OCPP16StatusNotificationRequest
,
450 OCPP16StatusNotificationResponse
451 >(chargingStation
, OCPP16RequestCommand
.STATUS_NOTIFICATION
, {
453 status: OCPP16ChargePointStatus
.CHARGING
,
454 errorCode
: OCPP16ChargePointErrorCode
.NO_ERROR
,
456 chargingStation
.getConnectorStatus(connectorId
).status = OCPP16ChargePointStatus
.CHARGING
;
458 chargingStation
.logPrefix() +
460 payload
.transactionId
.toString() +
462 chargingStation
.stationInfo
.chargingStationId
+
464 connectorId
.toString() +
468 if (chargingStation
.stationInfo
.powerSharedByConnectors
) {
469 chargingStation
.powerDivider
++;
471 const configuredMeterValueSampleInterval
=
472 ChargingStationConfigurationUtils
.getConfigurationKey(
474 OCPP16StandardParametersKey
.MeterValueSampleInterval
476 chargingStation
.startMeterValues(
478 configuredMeterValueSampleInterval
479 ? Utils
.convertToInt(configuredMeterValueSampleInterval
.value
) * 1000
484 chargingStation
.logPrefix() +
485 ' Starting transaction id ' +
486 payload
.transactionId
.toString() +
487 " REJECTED with status '" +
488 payload
?.idTagInfo
?.status +
492 await this.resetConnectorOnStartTransactionError(chargingStation
, connectorId
);
496 private async resetConnectorOnStartTransactionError(
497 chargingStation
: ChargingStation
,
500 chargingStation
.resetConnectorStatus(connectorId
);
502 chargingStation
.getConnectorStatus(connectorId
).status !== OCPP16ChargePointStatus
.AVAILABLE
504 await chargingStation
.ocppRequestService
.requestHandler
<
505 OCPP16StatusNotificationRequest
,
506 OCPP16StatusNotificationResponse
507 >(chargingStation
, OCPP16RequestCommand
.STATUS_NOTIFICATION
, {
509 status: OCPP16ChargePointStatus
.AVAILABLE
,
510 errorCode
: OCPP16ChargePointErrorCode
.NO_ERROR
,
512 chargingStation
.getConnectorStatus(connectorId
).status = OCPP16ChargePointStatus
.AVAILABLE
;
516 private async handleResponseStopTransaction(
517 chargingStation
: ChargingStation
,
518 payload
: OCPP16StopTransactionResponse
,
519 requestPayload
: OCPP16StopTransactionRequest
521 const transactionConnectorId
= chargingStation
.getConnectorIdByTransactionId(
522 requestPayload
.transactionId
524 if (!transactionConnectorId
) {
526 chargingStation
.logPrefix() +
527 ' Trying to stop a non existing transaction ' +
528 requestPayload
.transactionId
.toString()
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
,
543 OCPP16ServiceUtils
.buildTransactionEndMeterValue(
545 transactionConnectorId
,
546 requestPayload
.meterStop
551 !chargingStation
.isChargingStationAvailable() ||
552 !chargingStation
.isConnectorAvailable(transactionConnectorId
)
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
,
562 chargingStation
.getConnectorStatus(transactionConnectorId
).status =
563 OCPP16ChargePointStatus
.UNAVAILABLE
;
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
,
573 chargingStation
.getConnectorStatus(transactionConnectorId
).status =
574 OCPP16ChargePointStatus
.AVAILABLE
;
576 if (chargingStation
.stationInfo
.powerSharedByConnectors
) {
577 chargingStation
.powerDivider
--;
580 chargingStation
.logPrefix() +
582 requestPayload
.transactionId
.toString() +
584 chargingStation
.stationInfo
.chargingStationId
+
586 transactionConnectorId
.toString()
588 chargingStation
.resetConnectorStatus(transactionConnectorId
);
591 chargingStation
.logPrefix() +
592 ' Stopping transaction id ' +
593 requestPayload
.transactionId
.toString() +
594 " REJECTED with status '" +
595 payload
.idTagInfo
?.status +