Refine autoRegister CS template tunable handling
[e-mobility-charging-stations-simulator.git] / src / charging-station / ocpp / 1.6 / OCPP16IncomingRequestService.ts
CommitLineData
c8eeb62b
JB
1// Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
2
58144adb 3import { ChangeAvailabilityRequest, ChangeConfigurationRequest, ClearChargingProfileRequest, GetConfigurationRequest, GetDiagnosticsRequest, MessageTrigger, OCPP16AvailabilityType, OCPP16IncomingRequestCommand, OCPP16RequestCommand, OCPP16TriggerMessageRequest, RemoteStartTransactionRequest, RemoteStopTransactionRequest, ResetRequest, SetChargingProfileRequest, UnlockConnectorRequest } from '../../../types/ocpp/1.6/Requests';
802cfa13 4import { ChangeAvailabilityResponse, ChangeConfigurationResponse, ClearChargingProfileResponse, GetConfigurationResponse, GetDiagnosticsResponse, OCPP16TriggerMessageResponse, SetChargingProfileResponse, UnlockConnectorResponse } from '../../../types/ocpp/1.6/Responses';
c0560973 5import { ChargingProfilePurposeType, OCPP16ChargingProfile } from '../../../types/ocpp/1.6/ChargingProfile';
47e22477 6import { Client, FTPResponse } from 'basic-ftp';
c0560973
JB
7import { OCPP16AuthorizationStatus, OCPP16StopTransactionReason } from '../../../types/ocpp/1.6/Transaction';
8
58144adb 9import ChargingStation from '../../ChargingStation';
c0560973 10import Constants from '../../../utils/Constants';
9ccca265 11import { DefaultResponse } from '../../../types/ocpp/Responses';
c0560973 12import { ErrorType } from '../../../types/ocpp/ErrorType';
58144adb 13import { IncomingRequestHandler } from '../../../types/ocpp/Requests';
c0560973 14import { OCPP16ChargePointStatus } from '../../../types/ocpp/1.6/ChargePointStatus';
47e22477 15import { OCPP16DiagnosticsStatus } from '../../../types/ocpp/1.6/DiagnosticsStatus';
c0560973
JB
16import { OCPP16StandardParametersKey } from '../../../types/ocpp/1.6/Configuration';
17import { OCPPConfigurationKey } from '../../../types/ocpp/Configuration';
e58068fd 18import OCPPError from '../../../exception/OCPPError';
c0560973 19import OCPPIncomingRequestService from '../OCPPIncomingRequestService';
a3868ec4 20import { URL } from 'url';
c0560973 21import Utils from '../../../utils/Utils';
47e22477 22import fs from 'fs';
c0560973 23import logger from '../../../utils/Logger';
47e22477
JB
24import path from 'path';
25import tar from 'tar';
c0560973
JB
26
27export default class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
58144adb
JB
28 private incomingRequestHandlers: Map<OCPP16IncomingRequestCommand, IncomingRequestHandler>;
29
30 constructor(chargingStation: ChargingStation) {
31 super(chargingStation);
32 this.incomingRequestHandlers = new Map<OCPP16IncomingRequestCommand, IncomingRequestHandler>([
33 [OCPP16IncomingRequestCommand.RESET, this.handleRequestReset.bind(this)],
34 [OCPP16IncomingRequestCommand.CLEAR_CACHE, this.handleRequestClearCache.bind(this)],
35 [OCPP16IncomingRequestCommand.UNLOCK_CONNECTOR, this.handleRequestUnlockConnector.bind(this)],
36 [OCPP16IncomingRequestCommand.GET_CONFIGURATION, this.handleRequestGetConfiguration.bind(this)],
37 [OCPP16IncomingRequestCommand.CHANGE_CONFIGURATION, this.handleRequestChangeConfiguration.bind(this)],
38 [OCPP16IncomingRequestCommand.SET_CHARGING_PROFILE, this.handleRequestSetChargingProfile.bind(this)],
39 [OCPP16IncomingRequestCommand.CLEAR_CHARGING_PROFILE, this.handleRequestClearChargingProfile.bind(this)],
40 [OCPP16IncomingRequestCommand.CHANGE_AVAILABILITY, this.handleRequestChangeAvailability.bind(this)],
41 [OCPP16IncomingRequestCommand.REMOTE_START_TRANSACTION, this.handleRequestRemoteStartTransaction.bind(this)],
42 [OCPP16IncomingRequestCommand.REMOTE_STOP_TRANSACTION, this.handleRequestRemoteStopTransaction.bind(this)],
734d790d 43 [OCPP16IncomingRequestCommand.GET_DIAGNOSTICS, this.handleRequestGetDiagnostics.bind(this)],
58144adb
JB
44 [OCPP16IncomingRequestCommand.TRIGGER_MESSAGE, this.handleRequestTriggerMessage.bind(this)]
45 ]);
46 }
47
c0560973 48 public async handleRequest(messageId: string, commandName: OCPP16IncomingRequestCommand, commandPayload: Record<string, unknown>): Promise<void> {
de3dbcf5 49 let result: Record<string, unknown>;
124f3553
JB
50 if (this.chargingStation.isRegistered()) {
51 if (this.incomingRequestHandlers.has(commandName)) {
52 try {
53 // Call the method to build the result
54 result = await this.incomingRequestHandlers.get(commandName)(commandPayload);
55 } catch (error) {
56 // Log
57 logger.error(this.chargingStation.logPrefix() + ' Handle request error: %j', error);
58 throw error;
59 }
60 } else {
61 // Throw exception
62 throw new OCPPError(ErrorType.NOT_IMPLEMENTED, `${commandName} is not implemented to handle request payload ${JSON.stringify(commandPayload, null, 2)}`, commandName);
c0560973
JB
63 }
64 } else {
124f3553 65 throw new OCPPError(ErrorType.SECURITY_ERROR, `The charging station is not registered on the central server. ${commandName} cannot be not issued to handle request payload ${JSON.stringify(commandPayload, null, 2)}`, commandName);
c0560973 66 }
de3dbcf5
JB
67 // Send the built result
68 await this.chargingStation.ocppRequestService.sendResult(messageId, result, commandName);
c0560973
JB
69 }
70
71 // Simulate charging station restart
72 private handleRequestReset(commandPayload: ResetRequest): DefaultResponse {
71623267
JB
73 // eslint-disable-next-line @typescript-eslint/no-misused-promises
74 setImmediate(async (): Promise<void> => {
c0560973
JB
75 await this.chargingStation.stop(commandPayload.type + 'Reset' as OCPP16StopTransactionReason);
76 await Utils.sleep(this.chargingStation.stationInfo.resetTime);
71623267 77 this.chargingStation.start();
c0560973 78 });
d7d1db72 79 logger.info(`${this.chargingStation.logPrefix()} ${commandPayload.type} reset command received, simulating it. The station will be back online in ${Utils.formatDurationMilliSeconds(this.chargingStation.stationInfo.resetTime)}`);
c0560973
JB
80 return Constants.OCPP_RESPONSE_ACCEPTED;
81 }
82
83 private handleRequestClearCache(): DefaultResponse {
84 return Constants.OCPP_RESPONSE_ACCEPTED;
85 }
86
87 private async handleRequestUnlockConnector(commandPayload: UnlockConnectorRequest): Promise<UnlockConnectorResponse> {
88 const connectorId = commandPayload.connectorId;
89 if (connectorId === 0) {
90 logger.error(this.chargingStation.logPrefix() + ' Trying to unlock connector ' + connectorId.toString());
91 return Constants.OCPP_RESPONSE_UNLOCK_NOT_SUPPORTED;
92 }
734d790d
JB
93 if (this.chargingStation.getConnectorStatus(connectorId)?.transactionStarted) {
94 const transactionId = this.chargingStation.getConnectorStatus(connectorId).transactionId;
6ed92bc1
JB
95 const stopResponse = await this.chargingStation.ocppRequestService.sendStopTransaction(transactionId,
96 this.chargingStation.getEnergyActiveImportRegisterByTransactionId(transactionId),
97 this.chargingStation.getTransactionIdTag(transactionId),
98 OCPP16StopTransactionReason.UNLOCK_COMMAND);
c0560973
JB
99 if (stopResponse.idTagInfo?.status === OCPP16AuthorizationStatus.ACCEPTED) {
100 return Constants.OCPP_RESPONSE_UNLOCKED;
101 }
102 return Constants.OCPP_RESPONSE_UNLOCK_FAILED;
103 }
104 await this.chargingStation.ocppRequestService.sendStatusNotification(connectorId, OCPP16ChargePointStatus.AVAILABLE);
734d790d 105 this.chargingStation.getConnectorStatus(connectorId).status = OCPP16ChargePointStatus.AVAILABLE;
c0560973
JB
106 return Constants.OCPP_RESPONSE_UNLOCKED;
107 }
108
109 private handleRequestGetConfiguration(commandPayload: GetConfigurationRequest): GetConfigurationResponse {
110 const configurationKey: OCPPConfigurationKey[] = [];
111 const unknownKey: string[] = [];
112 if (Utils.isEmptyArray(commandPayload.key)) {
113 for (const configuration of this.chargingStation.configuration.configurationKey) {
114 if (Utils.isUndefined(configuration.visible)) {
115 configuration.visible = true;
116 }
117 if (!configuration.visible) {
118 continue;
119 }
120 configurationKey.push({
121 key: configuration.key,
122 readonly: configuration.readonly,
123 value: configuration.value,
124 });
125 }
126 } else {
127 for (const key of commandPayload.key) {
128 const keyFound = this.chargingStation.getConfigurationKey(key);
129 if (keyFound) {
130 if (Utils.isUndefined(keyFound.visible)) {
131 keyFound.visible = true;
132 }
133 if (!keyFound.visible) {
134 continue;
135 }
136 configurationKey.push({
137 key: keyFound.key,
138 readonly: keyFound.readonly,
139 value: keyFound.value,
140 });
141 } else {
142 unknownKey.push(key);
143 }
144 }
145 }
146 return {
147 configurationKey,
148 unknownKey,
149 };
150 }
151
152 private handleRequestChangeConfiguration(commandPayload: ChangeConfigurationRequest): ChangeConfigurationResponse {
153 // JSON request fields type sanity check
154 if (!Utils.isString(commandPayload.key)) {
58144adb 155 logger.error(`${this.chargingStation.logPrefix()} ${OCPP16RequestCommand.CHANGE_CONFIGURATION} request key field is not a string:`, commandPayload);
c0560973
JB
156 }
157 if (!Utils.isString(commandPayload.value)) {
58144adb 158 logger.error(`${this.chargingStation.logPrefix()} ${OCPP16RequestCommand.CHANGE_CONFIGURATION} request value field is not a string:`, commandPayload);
c0560973
JB
159 }
160 const keyToChange = this.chargingStation.getConfigurationKey(commandPayload.key, true);
161 if (!keyToChange) {
162 return Constants.OCPP_CONFIGURATION_RESPONSE_NOT_SUPPORTED;
163 } else if (keyToChange && keyToChange.readonly) {
164 return Constants.OCPP_CONFIGURATION_RESPONSE_REJECTED;
165 } else if (keyToChange && !keyToChange.readonly) {
166 const keyIndex = this.chargingStation.configuration.configurationKey.indexOf(keyToChange);
167 let valueChanged = false;
168 if (this.chargingStation.configuration.configurationKey[keyIndex].value !== commandPayload.value) {
169 this.chargingStation.configuration.configurationKey[keyIndex].value = commandPayload.value;
170 valueChanged = true;
171 }
172 let triggerHeartbeatRestart = false;
173 if (keyToChange.key === OCPP16StandardParametersKey.HeartBeatInterval && valueChanged) {
174 this.chargingStation.setConfigurationKeyValue(OCPP16StandardParametersKey.HeartbeatInterval, commandPayload.value);
175 triggerHeartbeatRestart = true;
176 }
177 if (keyToChange.key === OCPP16StandardParametersKey.HeartbeatInterval && valueChanged) {
178 this.chargingStation.setConfigurationKeyValue(OCPP16StandardParametersKey.HeartBeatInterval, commandPayload.value);
179 triggerHeartbeatRestart = true;
180 }
181 if (triggerHeartbeatRestart) {
182 this.chargingStation.restartHeartbeat();
183 }
184 if (keyToChange.key === OCPP16StandardParametersKey.WebSocketPingInterval && valueChanged) {
185 this.chargingStation.restartWebSocketPing();
186 }
187 if (keyToChange.reboot) {
188 return Constants.OCPP_CONFIGURATION_RESPONSE_REBOOT_REQUIRED;
189 }
190 return Constants.OCPP_CONFIGURATION_RESPONSE_ACCEPTED;
191 }
192 }
193
194 private handleRequestSetChargingProfile(commandPayload: SetChargingProfileRequest): SetChargingProfileResponse {
734d790d 195 if (!this.chargingStation.getConnectorStatus(commandPayload.connectorId)) {
a4cc42ea 196 logger.error(`${this.chargingStation.logPrefix()} Trying to set charging profile(s) to a non existing connector Id ${commandPayload.connectorId}`);
c0560973
JB
197 return Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED;
198 }
199 if (commandPayload.csChargingProfiles.chargingProfilePurpose === ChargingProfilePurposeType.CHARGE_POINT_MAX_PROFILE && commandPayload.connectorId !== 0) {
200 return Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED;
201 }
734d790d 202 if (commandPayload.csChargingProfiles.chargingProfilePurpose === ChargingProfilePurposeType.TX_PROFILE && (commandPayload.connectorId === 0 || !this.chargingStation.getConnectorStatus(commandPayload.connectorId)?.transactionStarted)) {
c0560973
JB
203 return Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED;
204 }
205 this.chargingStation.setChargingProfile(commandPayload.connectorId, commandPayload.csChargingProfiles);
734d790d 206 logger.debug(`${this.chargingStation.logPrefix()} Charging profile(s) set, dump their stack: %j`, this.chargingStation.getConnectorStatus(commandPayload.connectorId).chargingProfiles);
c0560973
JB
207 return Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_ACCEPTED;
208 }
209
210 private handleRequestClearChargingProfile(commandPayload: ClearChargingProfileRequest): ClearChargingProfileResponse {
734d790d 211 if (!this.chargingStation.getConnectorStatus(commandPayload.connectorId)) {
a4cc42ea 212 logger.error(`${this.chargingStation.logPrefix()} Trying to clear a charging profile(s) to a non existing connector Id ${commandPayload.connectorId}`);
c0560973
JB
213 return Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN;
214 }
734d790d
JB
215 if (commandPayload.connectorId && !Utils.isEmptyArray(this.chargingStation.getConnectorStatus(commandPayload.connectorId).chargingProfiles)) {
216 this.chargingStation.getConnectorStatus(commandPayload.connectorId).chargingProfiles = [];
217 logger.debug(`${this.chargingStation.logPrefix()} Charging profile(s) cleared, dump their stack: %j`, this.chargingStation.getConnectorStatus(commandPayload.connectorId).chargingProfiles);
c0560973
JB
218 return Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_ACCEPTED;
219 }
220 if (!commandPayload.connectorId) {
221 let clearedCP = false;
734d790d
JB
222 for (const connectorId of this.chargingStation.connectors.keys()) {
223 if (!Utils.isEmptyArray(this.chargingStation.getConnectorStatus(connectorId).chargingProfiles)) {
224 this.chargingStation.getConnectorStatus(connectorId).chargingProfiles?.forEach((chargingProfile: OCPP16ChargingProfile, index: number) => {
c0560973
JB
225 let clearCurrentCP = false;
226 if (chargingProfile.chargingProfileId === commandPayload.id) {
227 clearCurrentCP = true;
228 }
229 if (!commandPayload.chargingProfilePurpose && chargingProfile.stackLevel === commandPayload.stackLevel) {
230 clearCurrentCP = true;
231 }
232 if (!chargingProfile.stackLevel && chargingProfile.chargingProfilePurpose === commandPayload.chargingProfilePurpose) {
233 clearCurrentCP = true;
234 }
235 if (chargingProfile.stackLevel === commandPayload.stackLevel && chargingProfile.chargingProfilePurpose === commandPayload.chargingProfilePurpose) {
236 clearCurrentCP = true;
237 }
238 if (clearCurrentCP) {
734d790d
JB
239 this.chargingStation.getConnectorStatus(commandPayload.connectorId).chargingProfiles[index] = {} as OCPP16ChargingProfile;
240 logger.debug(`${this.chargingStation.logPrefix()} Charging profile(s) cleared, dump their stack: %j`, this.chargingStation.getConnectorStatus(commandPayload.connectorId).chargingProfiles);
c0560973
JB
241 clearedCP = true;
242 }
243 });
244 }
245 }
246 if (clearedCP) {
247 return Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_ACCEPTED;
248 }
249 }
250 return Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN;
251 }
252
e268356b 253 private async handleRequestChangeAvailability(commandPayload: ChangeAvailabilityRequest): Promise<ChangeAvailabilityResponse> {
c0560973 254 const connectorId: number = commandPayload.connectorId;
734d790d 255 if (!this.chargingStation.getConnectorStatus(connectorId)) {
c0560973
JB
256 logger.error(`${this.chargingStation.logPrefix()} Trying to change the availability of a non existing connector Id ${connectorId.toString()}`);
257 return Constants.OCPP_AVAILABILITY_RESPONSE_REJECTED;
258 }
734d790d
JB
259 const chargePointStatus: OCPP16ChargePointStatus = commandPayload.type === OCPP16AvailabilityType.OPERATIVE
260 ? OCPP16ChargePointStatus.AVAILABLE
261 : OCPP16ChargePointStatus.UNAVAILABLE;
c0560973
JB
262 if (connectorId === 0) {
263 let response: ChangeAvailabilityResponse = Constants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED;
734d790d
JB
264 for (const id of this.chargingStation.connectors.keys()) {
265 if (this.chargingStation.getConnectorStatus(id)?.transactionStarted) {
c0560973
JB
266 response = Constants.OCPP_AVAILABILITY_RESPONSE_SCHEDULED;
267 }
734d790d 268 this.chargingStation.getConnectorStatus(id).availability = commandPayload.type;
c0560973 269 if (response === Constants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED) {
734d790d
JB
270 await this.chargingStation.ocppRequestService.sendStatusNotification(id, chargePointStatus);
271 this.chargingStation.getConnectorStatus(id).status = chargePointStatus;
c0560973
JB
272 }
273 }
274 return response;
734d790d
JB
275 } else if (connectorId > 0 && (this.chargingStation.getConnectorStatus(0).availability === OCPP16AvailabilityType.OPERATIVE || (this.chargingStation.getConnectorStatus(0).availability === OCPP16AvailabilityType.INOPERATIVE && commandPayload.type === OCPP16AvailabilityType.INOPERATIVE))) {
276 if (this.chargingStation.getConnectorStatus(connectorId)?.transactionStarted) {
277 this.chargingStation.getConnectorStatus(connectorId).availability = commandPayload.type;
c0560973
JB
278 return Constants.OCPP_AVAILABILITY_RESPONSE_SCHEDULED;
279 }
734d790d 280 this.chargingStation.getConnectorStatus(connectorId).availability = commandPayload.type;
e268356b 281 await this.chargingStation.ocppRequestService.sendStatusNotification(connectorId, chargePointStatus);
734d790d 282 this.chargingStation.getConnectorStatus(connectorId).status = chargePointStatus;
c0560973
JB
283 return Constants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED;
284 }
285 return Constants.OCPP_AVAILABILITY_RESPONSE_REJECTED;
286 }
287
288 private async handleRequestRemoteStartTransaction(commandPayload: RemoteStartTransactionRequest): Promise<DefaultResponse> {
a7fc8211
JB
289 const transactionConnectorId: number = commandPayload.connectorId;
290 if (transactionConnectorId) {
291 await this.chargingStation.ocppRequestService.sendStatusNotification(transactionConnectorId, OCPP16ChargePointStatus.PREPARING);
734d790d 292 this.chargingStation.getConnectorStatus(transactionConnectorId).status = OCPP16ChargePointStatus.PREPARING;
a7fc8211 293 if (this.chargingStation.isChargingStationAvailable() && this.chargingStation.isConnectorAvailable(transactionConnectorId)) {
e060fe58 294 // Check if authorized
a7fc8211
JB
295 if (this.chargingStation.getAuthorizeRemoteTxRequests()) {
296 let authorized = false;
a7fc8211
JB
297 if (this.chargingStation.getLocalAuthListEnabled() && this.chargingStation.hasAuthorizedTags()
298 && this.chargingStation.authorizedTags.find((value) => value === commandPayload.idTag)) {
a2653482
JB
299 this.chargingStation.getConnectorStatus(transactionConnectorId).localAuthorizeIdTag = commandPayload.idTag;
300 this.chargingStation.getConnectorStatus(transactionConnectorId).idTagLocalAuthorized = true;
36f6a92e 301 authorized = true;
71068fb9 302 } else if (this.chargingStation.getMayAuthorizeAtRemoteStart()) {
a7fc8211
JB
303 const authorizeResponse = await this.chargingStation.ocppRequestService.sendAuthorize(transactionConnectorId, commandPayload.idTag);
304 if (authorizeResponse?.idTagInfo?.status === OCPP16AuthorizationStatus.ACCEPTED) {
305 authorized = true;
a7fc8211 306 }
71068fb9 307 } else {
b4d1b412 308 logger.warn(`${this.chargingStation.logPrefix()} The charging station configuration expects authorize at remote start transaction but local authorization or authorize isn't enabled`);
a7fc8211
JB
309 }
310 if (authorized) {
311 // Authorization successful, start transaction
e060fe58 312 if (this.setRemoteStartTransactionChargingProfile(transactionConnectorId, commandPayload.chargingProfile)) {
a2653482 313 this.chargingStation.getConnectorStatus(transactionConnectorId).transactionRemoteStarted = true;
e060fe58
JB
314 if ((await this.chargingStation.ocppRequestService.sendStartTransaction(transactionConnectorId, commandPayload.idTag)).idTagInfo.status === OCPP16AuthorizationStatus.ACCEPTED) {
315 logger.debug(this.chargingStation.logPrefix() + ' Transaction remotely STARTED on ' + this.chargingStation.stationInfo.chargingStationId + '#' + transactionConnectorId.toString() + ' for idTag ' + commandPayload.idTag);
316 return Constants.OCPP_RESPONSE_ACCEPTED;
317 }
57939a9d 318 return this.notifyRemoteStartTransactionRejected(transactionConnectorId, commandPayload.idTag);
e060fe58 319 }
57939a9d 320 return this.notifyRemoteStartTransactionRejected(transactionConnectorId, commandPayload.idTag);
a7fc8211 321 }
57939a9d 322 return this.notifyRemoteStartTransactionRejected(transactionConnectorId, commandPayload.idTag);
36f6a92e 323 }
a7fc8211 324 // No authorization check required, start transaction
e060fe58 325 if (this.setRemoteStartTransactionChargingProfile(transactionConnectorId, commandPayload.chargingProfile)) {
a2653482 326 this.chargingStation.getConnectorStatus(transactionConnectorId).transactionRemoteStarted = true;
e060fe58
JB
327 if ((await this.chargingStation.ocppRequestService.sendStartTransaction(transactionConnectorId, commandPayload.idTag)).idTagInfo.status === OCPP16AuthorizationStatus.ACCEPTED) {
328 logger.debug(this.chargingStation.logPrefix() + ' Transaction remotely STARTED on ' + this.chargingStation.stationInfo.chargingStationId + '#' + transactionConnectorId.toString() + ' for idTag ' + commandPayload.idTag);
329 return Constants.OCPP_RESPONSE_ACCEPTED;
330 }
57939a9d 331 return this.notifyRemoteStartTransactionRejected(transactionConnectorId, commandPayload.idTag);
e060fe58 332 }
57939a9d 333 return this.notifyRemoteStartTransactionRejected(transactionConnectorId, commandPayload.idTag);
c0560973 334 }
57939a9d 335 return this.notifyRemoteStartTransactionRejected(transactionConnectorId, commandPayload.idTag);
c0560973 336 }
57939a9d 337 return this.notifyRemoteStartTransactionRejected(transactionConnectorId, commandPayload.idTag);
a7fc8211
JB
338 }
339
340 private async notifyRemoteStartTransactionRejected(connectorId: number, idTag: string): Promise<DefaultResponse> {
734d790d 341 if (this.chargingStation.getConnectorStatus(connectorId).status !== OCPP16ChargePointStatus.AVAILABLE) {
e060fe58 342 await this.chargingStation.ocppRequestService.sendStatusNotification(connectorId, OCPP16ChargePointStatus.AVAILABLE);
734d790d 343 this.chargingStation.getConnectorStatus(connectorId).status = OCPP16ChargePointStatus.AVAILABLE;
e060fe58 344 }
734d790d 345 logger.warn(this.chargingStation.logPrefix() + ' Remote starting transaction REJECTED on connector Id ' + connectorId.toString() + ', idTag ' + idTag + ', availability ' + this.chargingStation.getConnectorStatus(connectorId).availability + ', status ' + this.chargingStation.getConnectorStatus(connectorId).status);
c0560973
JB
346 return Constants.OCPP_RESPONSE_REJECTED;
347 }
348
e060fe58 349 private setRemoteStartTransactionChargingProfile(connectorId: number, cp: OCPP16ChargingProfile): boolean {
a7fc8211
JB
350 if (cp && cp.chargingProfilePurpose === ChargingProfilePurposeType.TX_PROFILE) {
351 this.chargingStation.setChargingProfile(connectorId, cp);
734d790d 352 logger.debug(`${this.chargingStation.logPrefix()} Charging profile(s) set at remote start transaction, dump their stack: %j`, this.chargingStation.getConnectorStatus(connectorId).chargingProfiles);
a7fc8211
JB
353 return true;
354 } else if (cp && cp.chargingProfilePurpose !== ChargingProfilePurposeType.TX_PROFILE) {
a7fc8211
JB
355 logger.warn(`${this.chargingStation.logPrefix()} Not allowed to set ${cp.chargingProfilePurpose} charging profile(s) at remote start transaction`);
356 return false;
e060fe58
JB
357 } else if (!cp) {
358 return true;
a7fc8211
JB
359 }
360 }
361
c0560973
JB
362 private async handleRequestRemoteStopTransaction(commandPayload: RemoteStopTransactionRequest): Promise<DefaultResponse> {
363 const transactionId = commandPayload.transactionId;
734d790d
JB
364 for (const connectorId of this.chargingStation.connectors.keys()) {
365 if (connectorId > 0 && this.chargingStation.getConnectorStatus(connectorId)?.transactionId === transactionId) {
366 await this.chargingStation.ocppRequestService.sendStatusNotification(connectorId, OCPP16ChargePointStatus.FINISHING);
367 this.chargingStation.getConnectorStatus(connectorId).status = OCPP16ChargePointStatus.FINISHING;
6ed92bc1 368 await this.chargingStation.ocppRequestService.sendStopTransaction(transactionId, this.chargingStation.getEnergyActiveImportRegisterByTransactionId(transactionId),
035742f7 369 this.chargingStation.getTransactionIdTag(transactionId));
c0560973
JB
370 return Constants.OCPP_RESPONSE_ACCEPTED;
371 }
372 }
373 logger.info(this.chargingStation.logPrefix() + ' Trying to remote stop a non existing transaction ' + transactionId.toString());
374 return Constants.OCPP_RESPONSE_REJECTED;
375 }
47e22477
JB
376
377 private async handleRequestGetDiagnostics(commandPayload: GetDiagnosticsRequest): Promise<GetDiagnosticsResponse> {
58144adb 378 logger.debug(this.chargingStation.logPrefix() + ' ' + OCPP16IncomingRequestCommand.GET_DIAGNOSTICS + ' request received: %j', commandPayload);
a3868ec4 379 const uri = new URL(commandPayload.location);
47e22477
JB
380 if (uri.protocol.startsWith('ftp:')) {
381 let ftpClient: Client;
382 try {
383 const logFiles = fs.readdirSync(path.resolve(__dirname, '../../../../')).filter((file) => file.endsWith('.log')).map((file) => path.join('./', file));
384 const diagnosticsArchive = this.chargingStation.stationInfo.chargingStationId + '_logs.tar.gz';
385 tar.create({ gzip: true }, logFiles).pipe(fs.createWriteStream(diagnosticsArchive));
386 ftpClient = new Client();
387 const accessResponse = await ftpClient.access({
388 host: uri.host,
389 ...(uri.port !== '') && { port: Utils.convertToInt(uri.port) },
390 ...(uri.username !== '') && { user: uri.username },
391 ...(uri.password !== '') && { password: uri.password },
392 });
393 let uploadResponse: FTPResponse;
394 if (accessResponse.code === 220) {
395 // eslint-disable-next-line @typescript-eslint/no-misused-promises
396 ftpClient.trackProgress(async (info) => {
397 logger.info(`${this.chargingStation.logPrefix()} ${info.bytes / 1024} bytes transferred from diagnostics archive ${info.name}`);
398 await this.chargingStation.ocppRequestService.sendDiagnosticsStatusNotification(OCPP16DiagnosticsStatus.Uploading);
399 });
400 uploadResponse = await ftpClient.uploadFrom(path.join(path.resolve(__dirname, '../../../../'), diagnosticsArchive), uri.pathname + diagnosticsArchive);
401 if (uploadResponse.code === 226) {
402 await this.chargingStation.ocppRequestService.sendDiagnosticsStatusNotification(OCPP16DiagnosticsStatus.Uploaded);
403 if (ftpClient) {
404 ftpClient.close();
405 }
406 return { fileName: diagnosticsArchive };
407 }
58144adb 408 throw new OCPPError(ErrorType.GENERIC_ERROR, `Diagnostics transfer failed with error code ${accessResponse.code.toString()}${uploadResponse?.code && '|' + uploadResponse?.code.toString()}`, OCPP16IncomingRequestCommand.GET_DIAGNOSTICS);
47e22477 409 }
58144adb 410 throw new OCPPError(ErrorType.GENERIC_ERROR, `Diagnostics transfer failed with error code ${accessResponse.code.toString()}${uploadResponse?.code && '|' + uploadResponse?.code.toString()}`, OCPP16IncomingRequestCommand.GET_DIAGNOSTICS);
47e22477
JB
411 } catch (error) {
412 await this.chargingStation.ocppRequestService.sendDiagnosticsStatusNotification(OCPP16DiagnosticsStatus.UploadFailed);
47e22477
JB
413 if (ftpClient) {
414 ftpClient.close();
415 }
88184022 416 return this.handleIncomingRequestError(OCPP16IncomingRequestCommand.GET_DIAGNOSTICS, error as Error, Constants.OCPP_RESPONSE_EMPTY);
47e22477
JB
417 }
418 } else {
419 logger.error(`${this.chargingStation.logPrefix()} Unsupported protocol ${uri.protocol} to transfer the diagnostic logs archive`);
420 await this.chargingStation.ocppRequestService.sendDiagnosticsStatusNotification(OCPP16DiagnosticsStatus.UploadFailed);
421 return Constants.OCPP_RESPONSE_EMPTY;
422 }
423 }
802cfa13
JB
424
425 private handleRequestTriggerMessage(commandPayload: OCPP16TriggerMessageRequest): OCPP16TriggerMessageResponse {
426 try {
427 switch (commandPayload.requestedMessage) {
428 case MessageTrigger.BootNotification:
429 setTimeout(() => {
430 this.chargingStation.ocppRequestService.sendBootNotification(this.chargingStation.getBootNotificationRequest().chargePointModel,
431 this.chargingStation.getBootNotificationRequest().chargePointVendor, this.chargingStation.getBootNotificationRequest().chargeBoxSerialNumber,
0dad4bda 432 this.chargingStation.getBootNotificationRequest().firmwareVersion).catch(() => { /* This is intentional */ });
802cfa13
JB
433 }, Constants.OCPP_TRIGGER_MESSAGE_DELAY);
434 return Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED;
435 case MessageTrigger.Heartbeat:
436 setTimeout(() => {
0dad4bda 437 this.chargingStation.ocppRequestService.sendHeartbeat().catch(() => { /* This is intentional */ });
802cfa13
JB
438 }, Constants.OCPP_TRIGGER_MESSAGE_DELAY);
439 return Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED;
440 default:
441 return Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_NOT_IMPLEMENTED;
442 }
443 } catch (error) {
88184022 444 return this.handleIncomingRequestError(OCPP16IncomingRequestCommand.TRIGGER_MESSAGE, error as Error, Constants.OCPP_TRIGGER_MESSAGE_RESPONSE_REJECTED);
802cfa13
JB
445 }
446 }
c0560973 447}