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