1 // Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
3 import { AuthorizeRequest
, OCPP16AuthorizationStatus
, OCPP16AuthorizeResponse
, OCPP16StartTransactionResponse
, OCPP16StopTransactionResponse
, StartTransactionRequest
, StopTransactionRequest
} from
'../../../types/ocpp/1.6/Transaction';
4 import { HeartbeatRequest
, OCPP16RequestCommand
, StatusNotificationRequest
} from
'../../../types/ocpp/1.6/Requests';
5 import { HeartbeatResponse
, OCPP16BootNotificationResponse
, OCPP16RegistrationStatus
, StatusNotificationResponse
} from
'../../../types/ocpp/1.6/Responses';
6 import { MeterValuesRequest
, MeterValuesResponse
} from
'../../../types/ocpp/1.6/MeterValues';
8 import ChargingStation from
'../../ChargingStation';
9 import { OCPP16ChargePointStatus
} from
'../../../types/ocpp/1.6/ChargePointStatus';
10 import { OCPP16ServiceUtils
} from
'./OCPP16ServiceUtils';
11 import { OCPP16StandardParametersKey
} from
'../../../types/ocpp/1.6/Configuration';
12 import OCPPResponseService from
'../OCPPResponseService';
13 import { ResponseHandler
} from
'../../../types/ocpp/Responses';
14 import Utils from
'../../../utils/Utils';
15 import logger from
'../../../utils/Logger';
17 export default class OCPP16ResponseService
extends OCPPResponseService
{
18 private responseHandlers
: Map
<OCPP16RequestCommand
, ResponseHandler
>;
20 constructor(chargingStation
: ChargingStation
) {
21 super(chargingStation
);
22 this.responseHandlers
= new Map
<OCPP16RequestCommand
, ResponseHandler
>([
23 [OCPP16RequestCommand
.BOOT_NOTIFICATION
, this.handleResponseBootNotification
.bind(this)],
24 [OCPP16RequestCommand
.HEARTBEAT
, this.handleResponseHeartbeat
.bind(this)],
25 [OCPP16RequestCommand
.AUTHORIZE
, this.handleResponseAuthorize
.bind(this)],
26 [OCPP16RequestCommand
.START_TRANSACTION
, this.handleResponseStartTransaction
.bind(this)],
27 [OCPP16RequestCommand
.STOP_TRANSACTION
, this.handleResponseStopTransaction
.bind(this)],
28 [OCPP16RequestCommand
.STATUS_NOTIFICATION
, this.handleResponseStatusNotification
.bind(this)],
29 [OCPP16RequestCommand
.METER_VALUES
, this.handleResponseMeterValues
.bind(this)]
33 public async handleResponse(commandName
: OCPP16RequestCommand
, payload
: Record
<string, unknown
> | string, requestPayload
: Record
<string, unknown
>): Promise
<void> {
34 if (this.responseHandlers
.has(commandName
)) {
35 await this.responseHandlers
.get(commandName
)(payload
, requestPayload
);
37 logger
.error(this.chargingStation
.logPrefix() + ' Trying to call an undefined method for command ' + commandName
+ ' response');
41 private handleResponseBootNotification(payload
: OCPP16BootNotificationResponse
): void {
42 if (payload
.status === OCPP16RegistrationStatus
.ACCEPTED
) {
43 this.chargingStation
.addConfigurationKey(OCPP16StandardParametersKey
.HeartBeatInterval
, payload
.interval
.toString());
44 this.chargingStation
.addConfigurationKey(OCPP16StandardParametersKey
.HeartbeatInterval
, payload
.interval
.toString(), false, false);
45 this.chargingStation
.heartbeatSetInterval
? this.chargingStation
.restartHeartbeat() : this.chargingStation
.startHeartbeat();
46 } else if (payload
.status === OCPP16RegistrationStatus
.PENDING
) {
47 logger
.info(this.chargingStation
.logPrefix() + ' Charging station in pending state on the central server');
49 logger
.warn(this.chargingStation
.logPrefix() + ' Charging station rejected by the central server');
53 private handleResponseHeartbeat(payload
: HeartbeatResponse
, requestPayload
: HeartbeatRequest
): void {
54 logger
.debug(this.chargingStation
.logPrefix() + ' Heartbeat response received: %j to Heartbeat request: %j', payload
, requestPayload
);
57 private handleResponseAuthorize(payload
: OCPP16AuthorizeResponse
, requestPayload
: AuthorizeRequest
): void {
58 let authorizeConnectorId
: number;
59 for (const connectorId
of this.chargingStation
.connectors
.keys()) {
60 if (connectorId
> 0 && this.chargingStation
.getConnectorStatus(connectorId
)?.authorizeIdTag
=== requestPayload
.idTag
) {
61 authorizeConnectorId
= connectorId
;
65 if (payload
.idTagInfo
.status === OCPP16AuthorizationStatus
.ACCEPTED
) {
66 this.chargingStation
.getConnectorStatus(authorizeConnectorId
).authorized
= true;
67 logger
.debug(`${this.chargingStation.logPrefix()} IdTag ${requestPayload.idTag} authorized on connector ${authorizeConnectorId}`);
69 this.chargingStation
.getConnectorStatus(authorizeConnectorId
).authorized
= false;
70 delete this.chargingStation
.getConnectorStatus(authorizeConnectorId
).authorizeIdTag
;
71 logger
.debug(`${this.chargingStation.logPrefix()} IdTag ${requestPayload.idTag} refused with status ${payload.idTagInfo.status} on connector ${authorizeConnectorId}`);
75 private async handleResponseStartTransaction(payload
: OCPP16StartTransactionResponse
, requestPayload
: StartTransactionRequest
): Promise
<void> {
76 const connectorId
= requestPayload
.connectorId
;
78 let transactionConnectorId
: number;
79 for (const id
of this.chargingStation
.connectors
.keys()) {
80 if (id
> 0 && id
=== connectorId
) {
81 transactionConnectorId
= id
;
85 if (!transactionConnectorId
) {
86 logger
.error(this.chargingStation
.logPrefix() + ' Trying to start a transaction on a non existing connector Id ' + connectorId
.toString());
89 if (this.chargingStation
.getConnectorStatus(connectorId
).authorized
&& this.chargingStation
.getConnectorStatus(connectorId
).authorizeIdTag
!== requestPayload
.idTag
) {
90 logger
.error(this.chargingStation
.logPrefix() + ' Trying to start a transaction with an idTag ' + requestPayload
.idTag
+ ' different from the authorize request one ' + this.chargingStation
.getConnectorStatus(connectorId
).authorizeIdTag
+ ' on connector Id ' + connectorId
.toString());
93 if (this.chargingStation
.getConnectorStatus(connectorId
)?.transactionStarted
) {
94 logger
.debug(this.chargingStation
.logPrefix() + ' Trying to start a transaction on an already used connector ' + connectorId
.toString() + ': %j', this.chargingStation
.getConnectorStatus(connectorId
));
97 if (this.chargingStation
.getConnectorStatus(connectorId
)?.status !== OCPP16ChargePointStatus
.AVAILABLE
98 && this.chargingStation
.getConnectorStatus(connectorId
)?.status !== OCPP16ChargePointStatus
.PREPARING
) {
99 logger
.error(`${this.chargingStation.logPrefix()} Trying to start a transaction on connector ${connectorId.toString()} with status ${this.chargingStation.getConnectorStatus(connectorId)?.status}`);
102 if (!Number.isInteger(payload
.transactionId
)) {
103 logger
.warn(`${this.chargingStation.logPrefix()} Trying to start a transaction on connector ${connectorId.toString()} with a non integer transaction Id ${payload.transactionId}, converting to integer`);
104 payload
.transactionId
= Utils
.convertToInt(payload
.transactionId
);
107 if (payload
.idTagInfo
?.status === OCPP16AuthorizationStatus
.ACCEPTED
) {
108 this.chargingStation
.getConnectorStatus(connectorId
).transactionStarted
= true;
109 this.chargingStation
.getConnectorStatus(connectorId
).transactionId
= payload
.transactionId
;
110 this.chargingStation
.getConnectorStatus(connectorId
).transactionIdTag
= requestPayload
.idTag
;
111 this.chargingStation
.getConnectorStatus(connectorId
).transactionEnergyActiveImportRegisterValue
= 0;
112 this.chargingStation
.getConnectorStatus(connectorId
).transactionBeginMeterValue
= OCPP16ServiceUtils
.buildTransactionBeginMeterValue(this.chargingStation
, connectorId
,
113 requestPayload
.meterStart
);
114 this.chargingStation
.getBeginEndMeterValues() && await this.chargingStation
.ocppRequestService
.sendTransactionBeginMeterValues(connectorId
, payload
.transactionId
,
115 this.chargingStation
.getConnectorStatus(connectorId
).transactionBeginMeterValue
);
116 await this.chargingStation
.ocppRequestService
.sendStatusNotification(connectorId
, OCPP16ChargePointStatus
.CHARGING
);
117 this.chargingStation
.getConnectorStatus(connectorId
).status = OCPP16ChargePointStatus
.CHARGING
;
118 logger
.info(this.chargingStation
.logPrefix() + ' Transaction ' + payload
.transactionId
.toString() + ' STARTED on ' + this.chargingStation
.stationInfo
.chargingStationId
+ '#' + connectorId
.toString() + ' for idTag ' + requestPayload
.idTag
);
119 if (this.chargingStation
.stationInfo
.powerSharedByConnectors
) {
120 this.chargingStation
.stationInfo
.powerDivider
++;
122 const configuredMeterValueSampleInterval
= this.chargingStation
.getConfigurationKey(OCPP16StandardParametersKey
.MeterValueSampleInterval
);
123 this.chargingStation
.startMeterValues(connectorId
, configuredMeterValueSampleInterval
? Utils
.convertToInt(configuredMeterValueSampleInterval
.value
) * 1000 : 60000);
125 logger
.warn(this.chargingStation
.logPrefix() + ' Starting transaction id ' + payload
.transactionId
.toString() + ' REJECTED with status ' + payload
?.idTagInfo
?.status + ', idTag ' + requestPayload
.idTag
);
126 this.chargingStation
.resetTransactionOnConnector(connectorId
);
127 if (this.chargingStation
.getConnectorStatus(connectorId
).status !== OCPP16ChargePointStatus
.AVAILABLE
) {
128 await this.chargingStation
.ocppRequestService
.sendStatusNotification(connectorId
, OCPP16ChargePointStatus
.AVAILABLE
);
129 this.chargingStation
.getConnectorStatus(connectorId
).status = OCPP16ChargePointStatus
.AVAILABLE
;
134 private async handleResponseStopTransaction(payload
: OCPP16StopTransactionResponse
, requestPayload
: StopTransactionRequest
): Promise
<void> {
135 let transactionConnectorId
: number;
136 for (const connectorId
of this.chargingStation
.connectors
.keys()) {
137 if (connectorId
> 0 && this.chargingStation
.getConnectorStatus(connectorId
)?.transactionId
=== requestPayload
.transactionId
) {
138 transactionConnectorId
= connectorId
;
142 if (!transactionConnectorId
) {
143 logger
.error(this.chargingStation
.logPrefix() + ' Trying to stop a non existing transaction ' + requestPayload
.transactionId
.toString());
146 if (payload
.idTagInfo
?.status === OCPP16AuthorizationStatus
.ACCEPTED
) {
147 (this.chargingStation
.getBeginEndMeterValues() && this.chargingStation
.getOutOfOrderEndMeterValues())
148 && await this.chargingStation
.ocppRequestService
.sendTransactionEndMeterValues(transactionConnectorId
, requestPayload
.transactionId
,
149 OCPP16ServiceUtils
.buildTransactionEndMeterValue(this.chargingStation
, transactionConnectorId
, requestPayload
.meterStop
));
150 if (!this.chargingStation
.isChargingStationAvailable() || !this.chargingStation
.isConnectorAvailable(transactionConnectorId
)) {
151 await this.chargingStation
.ocppRequestService
.sendStatusNotification(transactionConnectorId
, OCPP16ChargePointStatus
.UNAVAILABLE
);
152 this.chargingStation
.getConnectorStatus(transactionConnectorId
).status = OCPP16ChargePointStatus
.UNAVAILABLE
;
154 await this.chargingStation
.ocppRequestService
.sendStatusNotification(transactionConnectorId
, OCPP16ChargePointStatus
.AVAILABLE
);
155 this.chargingStation
.getConnectorStatus(transactionConnectorId
).status = OCPP16ChargePointStatus
.AVAILABLE
;
157 if (this.chargingStation
.stationInfo
.powerSharedByConnectors
) {
158 this.chargingStation
.stationInfo
.powerDivider
--;
160 logger
.info(this.chargingStation
.logPrefix() + ' Transaction ' + requestPayload
.transactionId
.toString() + ' STOPPED on ' + this.chargingStation
.stationInfo
.chargingStationId
+ '#' + transactionConnectorId
.toString());
161 this.chargingStation
.resetTransactionOnConnector(transactionConnectorId
);
163 logger
.warn(this.chargingStation
.logPrefix() + ' Stopping transaction id ' + requestPayload
.transactionId
.toString() + ' REJECTED with status ' + payload
.idTagInfo
?.status);
167 private handleResponseStatusNotification(payload
: StatusNotificationRequest
, requestPayload
: StatusNotificationResponse
): void {
168 logger
.debug(this.chargingStation
.logPrefix() + ' Status notification response received: %j to StatusNotification request: %j', payload
, requestPayload
);
171 private handleResponseMeterValues(payload
: MeterValuesRequest
, requestPayload
: MeterValuesResponse
): void {
172 logger
.debug(this.chargingStation
.logPrefix() + ' MeterValues response received: %j to MeterValues request: %j', payload
, requestPayload
);