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