1 import { ChangeAvailabilityRequest
, ChangeConfigurationRequest
, ClearChargingProfileRequest
, GetConfigurationRequest
, OCPP16AvailabilityType
, OCPP16IncomingRequestCommand
, RemoteStartTransactionRequest
, RemoteStopTransactionRequest
, ResetRequest
, SetChargingProfileRequest
, UnlockConnectorRequest
} from
'../../../types/ocpp/1.6/Requests';
2 import { ChangeAvailabilityResponse
, ChangeConfigurationResponse
, ClearChargingProfileResponse
, DefaultResponse
, GetConfigurationResponse
, SetChargingProfileResponse
, UnlockConnectorResponse
} from
'../../../types/ocpp/1.6/Responses';
3 import { ChargingProfilePurposeType
, OCPP16ChargingProfile
} from
'../../../types/ocpp/1.6/ChargingProfile';
4 import { OCPP16AuthorizationStatus
, OCPP16StopTransactionReason
} from
'../../../types/ocpp/1.6/Transaction';
6 import Constants from
'../../../utils/Constants';
7 import { ErrorType
} from
'../../../types/ocpp/ErrorType';
8 import { MessageType
} from
'../../../types/ocpp/MessageType';
9 import { OCPP16ChargePointStatus
} from
'../../../types/ocpp/1.6/ChargePointStatus';
10 import { OCPP16StandardParametersKey
} from
'../../../types/ocpp/1.6/Configuration';
11 import { OCPPConfigurationKey
} from
'../../../types/ocpp/Configuration';
12 import OCPPError from
'../../OcppError';
13 import OCPPIncomingRequestService from
'../OCPPIncomingRequestService';
14 import Utils from
'../../../utils/Utils';
15 import logger from
'../../../utils/Logger';
17 export default class OCPP16IncomingRequestService
extends OCPPIncomingRequestService
{
18 public async handleRequest(messageId
: string, commandName
: OCPP16IncomingRequestCommand
, commandPayload
: Record
<string, unknown
>): Promise
<void> {
20 const methodName
= `handleRequest${commandName}`;
22 if (typeof this[methodName
] === 'function') {
24 // Call the method to build the response
25 response
= await this[methodName
](commandPayload
);
28 logger
.error(this.chargingStation
.logPrefix() + ' Handle request error: %j', error
);
29 // Send back an error response to inform backend
30 await this.chargingStation
.ocppRequestService
.sendError(messageId
, error
, commandName
);
35 await this.chargingStation
.ocppRequestService
.sendError(messageId
, new OCPPError(ErrorType
.NOT_IMPLEMENTED
, `${commandName} is not implemented`, {}), commandName
);
36 throw new Error(`${commandName} is not implemented to handle payload ${JSON.stringify(commandPayload)}`);
38 // Send the built response
39 await this.chargingStation
.ocppRequestService
.sendMessage(messageId
, response
, MessageType
.CALL_RESULT_MESSAGE
, commandName
);
42 // Simulate charging station restart
43 private handleRequestReset(commandPayload
: ResetRequest
): DefaultResponse
{
44 // eslint-disable-next-line @typescript-eslint/no-misused-promises
45 setImmediate(async (): Promise
<void> => {
46 await this.chargingStation
.stop(commandPayload
.type + 'Reset' as OCPP16StopTransactionReason
);
47 await Utils
.sleep(this.chargingStation
.stationInfo
.resetTime
);
48 this.chargingStation
.start();
50 logger
.info(`${this.chargingStation.logPrefix()} ${commandPayload.type} reset command received, simulating it. The station will be back online in ${Utils.milliSecondsToHHMMSS(this.chargingStation.stationInfo.resetTime)}`);
51 return Constants
.OCPP_RESPONSE_ACCEPTED
;
54 private handleRequestClearCache(): DefaultResponse
{
55 return Constants
.OCPP_RESPONSE_ACCEPTED
;
58 private async handleRequestUnlockConnector(commandPayload
: UnlockConnectorRequest
): Promise
<UnlockConnectorResponse
> {
59 const connectorId
= commandPayload
.connectorId
;
60 if (connectorId
=== 0) {
61 logger
.error(this.chargingStation
.logPrefix() + ' Trying to unlock connector ' + connectorId
.toString());
62 return Constants
.OCPP_RESPONSE_UNLOCK_NOT_SUPPORTED
;
64 if (this.chargingStation
.getConnector(connectorId
)?.transactionStarted
) {
65 const transactionId
= this.chargingStation
.getConnector(connectorId
).transactionId
;
66 const stopResponse
= await this.chargingStation
.ocppRequestService
.sendStopTransaction(transactionId
, this.chargingStation
.getTransactionMeterStop(transactionId
),
67 this.chargingStation
.getTransactionIdTag(transactionId
), OCPP16StopTransactionReason
.UNLOCK_COMMAND
);
68 if (stopResponse
.idTagInfo
?.status === OCPP16AuthorizationStatus
.ACCEPTED
) {
69 return Constants
.OCPP_RESPONSE_UNLOCKED
;
71 return Constants
.OCPP_RESPONSE_UNLOCK_FAILED
;
73 await this.chargingStation
.ocppRequestService
.sendStatusNotification(connectorId
, OCPP16ChargePointStatus
.AVAILABLE
);
74 this.chargingStation
.getConnector(connectorId
).status = OCPP16ChargePointStatus
.AVAILABLE
;
75 return Constants
.OCPP_RESPONSE_UNLOCKED
;
78 private handleRequestGetConfiguration(commandPayload
: GetConfigurationRequest
): GetConfigurationResponse
{
79 const configurationKey
: OCPPConfigurationKey
[] = [];
80 const unknownKey
: string[] = [];
81 if (Utils
.isEmptyArray(commandPayload
.key
)) {
82 for (const configuration
of this.chargingStation
.configuration
.configurationKey
) {
83 if (Utils
.isUndefined(configuration
.visible
)) {
84 configuration
.visible
= true;
86 if (!configuration
.visible
) {
89 configurationKey
.push({
90 key
: configuration
.key
,
91 readonly: configuration
.readonly,
92 value
: configuration
.value
,
96 for (const key
of commandPayload
.key
) {
97 const keyFound
= this.chargingStation
.getConfigurationKey(key
);
99 if (Utils
.isUndefined(keyFound
.visible
)) {
100 keyFound
.visible
= true;
102 if (!keyFound
.visible
) {
105 configurationKey
.push({
107 readonly: keyFound
.readonly,
108 value
: keyFound
.value
,
111 unknownKey
.push(key
);
121 private handleRequestChangeConfiguration(commandPayload
: ChangeConfigurationRequest
): ChangeConfigurationResponse
{
122 // JSON request fields type sanity check
123 if (!Utils
.isString(commandPayload
.key
)) {
124 logger
.error(`${this.chargingStation.logPrefix()} ChangeConfiguration request key field is not a string:`, commandPayload
);
126 if (!Utils
.isString(commandPayload
.value
)) {
127 logger
.error(`${this.chargingStation.logPrefix()} ChangeConfiguration request value field is not a string:`, commandPayload
);
129 const keyToChange
= this.chargingStation
.getConfigurationKey(commandPayload
.key
, true);
131 return Constants
.OCPP_CONFIGURATION_RESPONSE_NOT_SUPPORTED
;
132 } else if (keyToChange
&& keyToChange
.readonly) {
133 return Constants
.OCPP_CONFIGURATION_RESPONSE_REJECTED
;
134 } else if (keyToChange
&& !keyToChange
.readonly) {
135 const keyIndex
= this.chargingStation
.configuration
.configurationKey
.indexOf(keyToChange
);
136 let valueChanged
= false;
137 if (this.chargingStation
.configuration
.configurationKey
[keyIndex
].value
!== commandPayload
.value
) {
138 this.chargingStation
.configuration
.configurationKey
[keyIndex
].value
= commandPayload
.value
;
141 let triggerHeartbeatRestart
= false;
142 if (keyToChange
.key
=== OCPP16StandardParametersKey
.HeartBeatInterval
&& valueChanged
) {
143 this.chargingStation
.setConfigurationKeyValue(OCPP16StandardParametersKey
.HeartbeatInterval
, commandPayload
.value
);
144 triggerHeartbeatRestart
= true;
146 if (keyToChange
.key
=== OCPP16StandardParametersKey
.HeartbeatInterval
&& valueChanged
) {
147 this.chargingStation
.setConfigurationKeyValue(OCPP16StandardParametersKey
.HeartBeatInterval
, commandPayload
.value
);
148 triggerHeartbeatRestart
= true;
150 if (triggerHeartbeatRestart
) {
151 this.chargingStation
.restartHeartbeat();
153 if (keyToChange
.key
=== OCPP16StandardParametersKey
.WebSocketPingInterval
&& valueChanged
) {
154 this.chargingStation
.restartWebSocketPing();
156 if (keyToChange
.reboot
) {
157 return Constants
.OCPP_CONFIGURATION_RESPONSE_REBOOT_REQUIRED
;
159 return Constants
.OCPP_CONFIGURATION_RESPONSE_ACCEPTED
;
163 private handleRequestSetChargingProfile(commandPayload
: SetChargingProfileRequest
): SetChargingProfileResponse
{
164 if (!this.chargingStation
.getConnector(commandPayload
.connectorId
)) {
165 logger
.error(`${this.chargingStation.logPrefix()} Trying to set charging profile(s) to a non existing connector Id ${commandPayload.connectorId}`);
166 return Constants
.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED
;
168 if (commandPayload
.csChargingProfiles
.chargingProfilePurpose
=== ChargingProfilePurposeType
.CHARGE_POINT_MAX_PROFILE
&& commandPayload
.connectorId
!== 0) {
169 return Constants
.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED
;
171 if (commandPayload
.csChargingProfiles
.chargingProfilePurpose
=== ChargingProfilePurposeType
.TX_PROFILE
&& (commandPayload
.connectorId
=== 0 || !this.chargingStation
.getConnector(commandPayload
.connectorId
)?.transactionStarted
)) {
172 return Constants
.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED
;
174 this.chargingStation
.setChargingProfile(commandPayload
.connectorId
, commandPayload
.csChargingProfiles
);
175 logger
.debug(`${this.chargingStation.logPrefix()} Charging profile(s) set, dump their stack: %j`, this.chargingStation
.getConnector(commandPayload
.connectorId
).chargingProfiles
);
176 return Constants
.OCPP_SET_CHARGING_PROFILE_RESPONSE_ACCEPTED
;
179 private handleRequestClearChargingProfile(commandPayload
: ClearChargingProfileRequest
): ClearChargingProfileResponse
{
180 if (!this.chargingStation
.getConnector(commandPayload
.connectorId
)) {
181 logger
.error(`${this.chargingStation.logPrefix()} Trying to clear a charging profile(s) to a non existing connector Id ${commandPayload.connectorId}`);
182 return Constants
.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN
;
184 if (commandPayload
.connectorId
&& !Utils
.isEmptyArray(this.chargingStation
.getConnector(commandPayload
.connectorId
).chargingProfiles
)) {
185 this.chargingStation
.getConnector(commandPayload
.connectorId
).chargingProfiles
= [];
186 logger
.debug(`${this.chargingStation.logPrefix()} Charging profile(s) cleared, dump their stack: %j`, this.chargingStation
.getConnector(commandPayload
.connectorId
).chargingProfiles
);
187 return Constants
.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_ACCEPTED
;
189 if (!commandPayload
.connectorId
) {
190 let clearedCP
= false;
191 for (const connector
in this.chargingStation
.connectors
) {
192 if (!Utils
.isEmptyArray(this.chargingStation
.getConnector(Utils
.convertToInt(connector
)).chargingProfiles
)) {
193 this.chargingStation
.getConnector(Utils
.convertToInt(connector
)).chargingProfiles
.forEach((chargingProfile
: OCPP16ChargingProfile
, index
: number) => {
194 let clearCurrentCP
= false;
195 if (chargingProfile
.chargingProfileId
=== commandPayload
.id
) {
196 clearCurrentCP
= true;
198 if (!commandPayload
.chargingProfilePurpose
&& chargingProfile
.stackLevel
=== commandPayload
.stackLevel
) {
199 clearCurrentCP
= true;
201 if (!chargingProfile
.stackLevel
&& chargingProfile
.chargingProfilePurpose
=== commandPayload
.chargingProfilePurpose
) {
202 clearCurrentCP
= true;
204 if (chargingProfile
.stackLevel
=== commandPayload
.stackLevel
&& chargingProfile
.chargingProfilePurpose
=== commandPayload
.chargingProfilePurpose
) {
205 clearCurrentCP
= true;
207 if (clearCurrentCP
) {
208 this.chargingStation
.getConnector(commandPayload
.connectorId
).chargingProfiles
[index
] = {} as OCPP16ChargingProfile
;
209 logger
.debug(`${this.chargingStation.logPrefix()} Charging profile(s) cleared, dump their stack: %j`, this.chargingStation
.getConnector(commandPayload
.connectorId
).chargingProfiles
);
216 return Constants
.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_ACCEPTED
;
219 return Constants
.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN
;
222 private async handleRequestChangeAvailability(commandPayload
: ChangeAvailabilityRequest
): Promise
<ChangeAvailabilityResponse
> {
223 const connectorId
: number = commandPayload
.connectorId
;
224 if (!this.chargingStation
.getConnector(connectorId
)) {
225 logger
.error(`${this.chargingStation.logPrefix()} Trying to change the availability of a non existing connector Id ${connectorId.toString()}`);
226 return Constants
.OCPP_AVAILABILITY_RESPONSE_REJECTED
;
228 const chargePointStatus
: OCPP16ChargePointStatus
= commandPayload
.type === OCPP16AvailabilityType
.OPERATIVE
? OCPP16ChargePointStatus
.AVAILABLE
: OCPP16ChargePointStatus
.UNAVAILABLE
;
229 if (connectorId
=== 0) {
230 let response
: ChangeAvailabilityResponse
= Constants
.OCPP_AVAILABILITY_RESPONSE_ACCEPTED
;
231 for (const connector
in this.chargingStation
.connectors
) {
232 if (this.chargingStation
.getConnector(Utils
.convertToInt(connector
)).transactionStarted
) {
233 response
= Constants
.OCPP_AVAILABILITY_RESPONSE_SCHEDULED
;
235 this.chargingStation
.getConnector(Utils
.convertToInt(connector
)).availability
= commandPayload
.type;
236 if (response
=== Constants
.OCPP_AVAILABILITY_RESPONSE_ACCEPTED
) {
237 await this.chargingStation
.ocppRequestService
.sendStatusNotification(Utils
.convertToInt(connector
), chargePointStatus
);
238 this.chargingStation
.getConnector(Utils
.convertToInt(connector
)).status = chargePointStatus
;
242 } else if (connectorId
> 0 && (this.chargingStation
.getConnector(0).availability
=== OCPP16AvailabilityType
.OPERATIVE
|| (this.chargingStation
.getConnector(0).availability
=== OCPP16AvailabilityType
.INOPERATIVE
&& commandPayload
.type === OCPP16AvailabilityType
.INOPERATIVE
))) {
243 if (this.chargingStation
.getConnector(connectorId
)?.transactionStarted
) {
244 this.chargingStation
.getConnector(connectorId
).availability
= commandPayload
.type;
245 return Constants
.OCPP_AVAILABILITY_RESPONSE_SCHEDULED
;
247 this.chargingStation
.getConnector(connectorId
).availability
= commandPayload
.type;
248 await this.chargingStation
.ocppRequestService
.sendStatusNotification(connectorId
, chargePointStatus
);
249 this.chargingStation
.getConnector(connectorId
).status = chargePointStatus
;
250 return Constants
.OCPP_AVAILABILITY_RESPONSE_ACCEPTED
;
252 return Constants
.OCPP_AVAILABILITY_RESPONSE_REJECTED
;
255 private async handleRequestRemoteStartTransaction(commandPayload
: RemoteStartTransactionRequest
): Promise
<DefaultResponse
> {
256 const transactionConnectorID
: number = commandPayload
.connectorId
? commandPayload
.connectorId
: 1;
257 if (this.chargingStation
.isChargingStationAvailable() && this.chargingStation
.isConnectorAvailable(transactionConnectorID
)) {
258 if (this.chargingStation
.getAuthorizeRemoteTxRequests() && this.chargingStation
.getLocalAuthListEnabled() && this.chargingStation
.hasAuthorizedTags()) {
259 // Check if authorized
260 if (this.chargingStation
.authorizedTags
.find((value
) => value
=== commandPayload
.idTag
)) {
261 await this.chargingStation
.ocppRequestService
.sendStatusNotification(transactionConnectorID
, OCPP16ChargePointStatus
.PREPARING
);
262 this.chargingStation
.getConnector(transactionConnectorID
).status = OCPP16ChargePointStatus
.PREPARING
;
263 if (commandPayload
.chargingProfile
&& commandPayload
.chargingProfile
.chargingProfilePurpose
=== ChargingProfilePurposeType
.TX_PROFILE
) {
264 this.chargingStation
.setChargingProfile(transactionConnectorID
, commandPayload
.chargingProfile
);
265 logger
.debug(`${this.chargingStation.logPrefix()} Charging profile(s) set at start transaction, dump their stack: %j`, this.chargingStation
.getConnector(transactionConnectorID
).chargingProfiles
);
266 } else if (commandPayload
.chargingProfile
&& commandPayload
.chargingProfile
.chargingProfilePurpose
!== ChargingProfilePurposeType
.TX_PROFILE
) {
267 return Constants
.OCPP_RESPONSE_REJECTED
;
269 // Authorization successful start transaction
270 await this.chargingStation
.ocppRequestService
.sendStartTransaction(transactionConnectorID
, commandPayload
.idTag
);
271 logger
.debug(this.chargingStation
.logPrefix() + ' Transaction remotely STARTED on ' + this.chargingStation
.stationInfo
.chargingStationId
+ '#' + transactionConnectorID
.toString() + ' for idTag ' + commandPayload
.idTag
);
272 return Constants
.OCPP_RESPONSE_ACCEPTED
;
274 logger
.warn(this.chargingStation
.logPrefix() + ' Remote starting transaction REJECTED on connector Id ' + transactionConnectorID
.toString() + ', idTag ' + commandPayload
.idTag
);
275 return Constants
.OCPP_RESPONSE_REJECTED
;
277 await this.chargingStation
.ocppRequestService
.sendStatusNotification(transactionConnectorID
, OCPP16ChargePointStatus
.PREPARING
);
278 this.chargingStation
.getConnector(transactionConnectorID
).status = OCPP16ChargePointStatus
.PREPARING
;
279 if (commandPayload
.chargingProfile
&& commandPayload
.chargingProfile
.chargingProfilePurpose
=== ChargingProfilePurposeType
.TX_PROFILE
) {
280 this.chargingStation
.setChargingProfile(transactionConnectorID
, commandPayload
.chargingProfile
);
281 logger
.debug(`${this.chargingStation.logPrefix()} Charging profile(s) set at start transaction, dump their stack: %j`, this.chargingStation
.getConnector(commandPayload
.connectorId
).chargingProfiles
);
282 } else if (commandPayload
.chargingProfile
&& commandPayload
.chargingProfile
.chargingProfilePurpose
!== ChargingProfilePurposeType
.TX_PROFILE
) {
283 return Constants
.OCPP_RESPONSE_REJECTED
;
285 // No local authorization check required => start transaction
286 await this.chargingStation
.ocppRequestService
.sendStartTransaction(transactionConnectorID
, commandPayload
.idTag
);
287 logger
.debug(this.chargingStation
.logPrefix() + ' Transaction remotely STARTED on ' + this.chargingStation
.stationInfo
.chargingStationId
+ '#' + transactionConnectorID
.toString() + ' for idTag ' + commandPayload
.idTag
);
288 return Constants
.OCPP_RESPONSE_ACCEPTED
;
290 logger
.warn(this.chargingStation
.logPrefix() + ' Remote starting transaction REJECTED on unavailable connector Id ' + transactionConnectorID
.toString() + ', idTag ' + commandPayload
.idTag
);
291 return Constants
.OCPP_RESPONSE_REJECTED
;
294 private async handleRequestRemoteStopTransaction(commandPayload
: RemoteStopTransactionRequest
): Promise
<DefaultResponse
> {
295 const transactionId
= commandPayload
.transactionId
;
296 for (const connector
in this.chargingStation
.connectors
) {
297 if (Utils
.convertToInt(connector
) > 0 && this.chargingStation
.getConnector(Utils
.convertToInt(connector
))?.transactionId
=== transactionId
) {
298 await this.chargingStation
.ocppRequestService
.sendStatusNotification(Utils
.convertToInt(connector
), OCPP16ChargePointStatus
.FINISHING
);
299 this.chargingStation
.getConnector(Utils
.convertToInt(connector
)).status = OCPP16ChargePointStatus
.FINISHING
;
300 await this.chargingStation
.ocppRequestService
.sendStopTransaction(transactionId
, this.chargingStation
.getTransactionMeterStop(transactionId
),
301 this.chargingStation
.getTransactionIdTag(transactionId
));
302 return Constants
.OCPP_RESPONSE_ACCEPTED
;
305 logger
.info(this.chargingStation
.logPrefix() + ' Trying to remote stop a non existing transaction ' + transactionId
.toString());
306 return Constants
.OCPP_RESPONSE_REJECTED
;