1 // Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
4 import path from
'path';
5 import { URL
, fileURLToPath
} from
'url';
7 import type { JSONSchemaType
} from
'ajv';
8 import { Client
, FTPResponse
} from
'basic-ftp';
11 import OCPPError from
'../../../exception/OCPPError';
12 import type { JsonObject
, JsonType
} from
'../../../types/JsonType';
13 import { OCPP16ChargePointErrorCode
} from
'../../../types/ocpp/1.6/ChargePointErrorCode';
14 import { OCPP16ChargePointStatus
} from
'../../../types/ocpp/1.6/ChargePointStatus';
16 ChargingProfilePurposeType
,
17 OCPP16ChargingProfile
,
18 } from
'../../../types/ocpp/1.6/ChargingProfile';
20 OCPP16StandardParametersKey
,
21 OCPP16SupportedFeatureProfiles
,
22 } from
'../../../types/ocpp/1.6/Configuration';
23 import { OCPP16DiagnosticsStatus
} from
'../../../types/ocpp/1.6/DiagnosticsStatus';
25 ChangeAvailabilityRequest
,
26 ChangeConfigurationRequest
,
27 ClearChargingProfileRequest
,
28 DiagnosticsStatusNotificationRequest
,
29 GetConfigurationRequest
,
30 GetDiagnosticsRequest
,
32 OCPP16AvailabilityType
,
33 OCPP16BootNotificationRequest
,
34 OCPP16ClearCacheRequest
,
35 OCPP16HeartbeatRequest
,
36 OCPP16IncomingRequestCommand
,
38 OCPP16StatusNotificationRequest
,
39 OCPP16TriggerMessageRequest
,
40 RemoteStartTransactionRequest
,
41 RemoteStopTransactionRequest
,
43 SetChargingProfileRequest
,
44 UnlockConnectorRequest
,
45 } from
'../../../types/ocpp/1.6/Requests';
47 ChangeAvailabilityResponse
,
48 ChangeConfigurationResponse
,
49 ClearChargingProfileResponse
,
50 DiagnosticsStatusNotificationResponse
,
51 GetConfigurationResponse
,
52 GetDiagnosticsResponse
,
53 OCPP16BootNotificationResponse
,
54 OCPP16HeartbeatResponse
,
55 OCPP16StatusNotificationResponse
,
56 OCPP16TriggerMessageResponse
,
57 SetChargingProfileResponse
,
58 UnlockConnectorResponse
,
59 } from
'../../../types/ocpp/1.6/Responses';
61 OCPP16AuthorizationStatus
,
62 OCPP16AuthorizeRequest
,
63 OCPP16AuthorizeResponse
,
64 OCPP16StartTransactionRequest
,
65 OCPP16StartTransactionResponse
,
66 OCPP16StopTransactionReason
,
67 } from
'../../../types/ocpp/1.6/Transaction';
68 import type { OCPPConfigurationKey
} from
'../../../types/ocpp/Configuration';
69 import { ErrorType
} from
'../../../types/ocpp/ErrorType';
70 import type { IncomingRequestHandler
} from
'../../../types/ocpp/Requests';
71 import type { DefaultResponse
} from
'../../../types/ocpp/Responses';
72 import Constants from
'../../../utils/Constants';
73 import logger from
'../../../utils/Logger';
74 import Utils from
'../../../utils/Utils';
75 import type ChargingStation from
'../../ChargingStation';
76 import { ChargingStationConfigurationUtils
} from
'../../ChargingStationConfigurationUtils';
77 import { ChargingStationUtils
} from
'../../ChargingStationUtils';
78 import OCPPIncomingRequestService from
'../OCPPIncomingRequestService';
79 import { OCPP16ServiceUtils
} from
'./OCPP16ServiceUtils';
81 const moduleName
= 'OCPP16IncomingRequestService';
83 export default class OCPP16IncomingRequestService
extends OCPPIncomingRequestService
{
84 private incomingRequestHandlers
: Map
<OCPP16IncomingRequestCommand
, IncomingRequestHandler
>;
85 private jsonSchemas
: Map
<OCPP16IncomingRequestCommand
, JSONSchemaType
<JsonObject
>>;
87 public constructor() {
88 if (new.target
?.name
=== moduleName
) {
89 throw new TypeError(`Cannot construct ${new.target?.name} instances directly`);
92 this.incomingRequestHandlers
= new Map
<OCPP16IncomingRequestCommand
, IncomingRequestHandler
>([
93 [OCPP16IncomingRequestCommand
.RESET
, this.handleRequestReset
.bind(this)],
94 [OCPP16IncomingRequestCommand
.CLEAR_CACHE
, this.handleRequestClearCache
.bind(this)],
95 [OCPP16IncomingRequestCommand
.UNLOCK_CONNECTOR
, this.handleRequestUnlockConnector
.bind(this)],
97 OCPP16IncomingRequestCommand
.GET_CONFIGURATION
,
98 this.handleRequestGetConfiguration
.bind(this),
101 OCPP16IncomingRequestCommand
.CHANGE_CONFIGURATION
,
102 this.handleRequestChangeConfiguration
.bind(this),
105 OCPP16IncomingRequestCommand
.SET_CHARGING_PROFILE
,
106 this.handleRequestSetChargingProfile
.bind(this),
109 OCPP16IncomingRequestCommand
.CLEAR_CHARGING_PROFILE
,
110 this.handleRequestClearChargingProfile
.bind(this),
113 OCPP16IncomingRequestCommand
.CHANGE_AVAILABILITY
,
114 this.handleRequestChangeAvailability
.bind(this),
117 OCPP16IncomingRequestCommand
.REMOTE_START_TRANSACTION
,
118 this.handleRequestRemoteStartTransaction
.bind(this),
121 OCPP16IncomingRequestCommand
.REMOTE_STOP_TRANSACTION
,
122 this.handleRequestRemoteStopTransaction
.bind(this),
124 [OCPP16IncomingRequestCommand
.GET_DIAGNOSTICS
, this.handleRequestGetDiagnostics
.bind(this)],
125 [OCPP16IncomingRequestCommand
.TRIGGER_MESSAGE
, this.handleRequestTriggerMessage
.bind(this)],
127 this.jsonSchemas
= new Map
<OCPP16IncomingRequestCommand
, JSONSchemaType
<JsonObject
>>([
129 OCPP16IncomingRequestCommand
.RESET
,
133 path
.dirname(fileURLToPath(import.meta
.url
)),
134 '../../../assets/json-schemas/ocpp/1.6/Reset.json'
138 ) as JSONSchemaType
<ResetRequest
>,
141 OCPP16IncomingRequestCommand
.CLEAR_CACHE
,
145 path
.dirname(fileURLToPath(import.meta
.url
)),
146 '../../../assets/json-schemas/ocpp/1.6/ClearCache.json'
150 ) as JSONSchemaType
<OCPP16ClearCacheRequest
>,
153 OCPP16IncomingRequestCommand
.UNLOCK_CONNECTOR
,
157 path
.dirname(fileURLToPath(import.meta
.url
)),
158 '../../../assets/json-schemas/ocpp/1.6/UnlockConnector.json'
162 ) as JSONSchemaType
<UnlockConnectorRequest
>,
165 OCPP16IncomingRequestCommand
.GET_CONFIGURATION
,
169 path
.dirname(fileURLToPath(import.meta
.url
)),
170 '../../../assets/json-schemas/ocpp/1.6/GetConfiguration.json'
174 ) as JSONSchemaType
<GetConfigurationRequest
>,
177 OCPP16IncomingRequestCommand
.CHANGE_CONFIGURATION
,
181 path
.dirname(fileURLToPath(import.meta
.url
)),
182 '../../../assets/json-schemas/ocpp/1.6/ChangeConfiguration.json'
186 ) as JSONSchemaType
<ChangeConfigurationRequest
>,
189 OCPP16IncomingRequestCommand
.GET_DIAGNOSTICS
,
193 path
.dirname(fileURLToPath(import.meta
.url
)),
194 '../../../assets/json-schemas/ocpp/1.6/GetDiagnostics.json'
198 ) as JSONSchemaType
<GetDiagnosticsRequest
>,
201 OCPP16IncomingRequestCommand
.SET_CHARGING_PROFILE
,
205 path
.dirname(fileURLToPath(import.meta
.url
)),
206 '../../../assets/json-schemas/ocpp/1.6/SetChargingProfile.json'
210 ) as JSONSchemaType
<SetChargingProfileRequest
>,
213 OCPP16IncomingRequestCommand
.CLEAR_CHARGING_PROFILE
,
217 path
.dirname(fileURLToPath(import.meta
.url
)),
218 '../../../assets/json-schemas/ocpp/1.6/ClearChargingProfile.json'
222 ) as JSONSchemaType
<ClearChargingProfileRequest
>,
225 OCPP16IncomingRequestCommand
.CHANGE_AVAILABILITY
,
229 path
.dirname(fileURLToPath(import.meta
.url
)),
230 '../../../assets/json-schemas/ocpp/1.6/ChangeAvailability.json'
234 ) as JSONSchemaType
<ChangeAvailabilityRequest
>,
237 OCPP16IncomingRequestCommand
.REMOTE_START_TRANSACTION
,
241 path
.dirname(fileURLToPath(import.meta
.url
)),
242 '../../../assets/json-schemas/ocpp/1.6/RemoteStartTransaction.json'
246 ) as JSONSchemaType
<RemoteStartTransactionRequest
>,
249 OCPP16IncomingRequestCommand
.REMOTE_STOP_TRANSACTION
,
253 path
.dirname(fileURLToPath(import.meta
.url
)),
254 '../../../assets/json-schemas/ocpp/1.6/RemoteStopTransaction.json'
258 ) as JSONSchemaType
<RemoteStopTransactionRequest
>,
261 OCPP16IncomingRequestCommand
.TRIGGER_MESSAGE
,
265 path
.dirname(fileURLToPath(import.meta
.url
)),
266 '../../../assets/json-schemas/ocpp/1.6/TriggerMessage.json'
270 ) as JSONSchemaType
<OCPP16TriggerMessageRequest
>,
273 this.validatePayload
.bind(this);
276 public async incomingRequestHandler(
277 chargingStation
: ChargingStation
,
279 commandName
: OCPP16IncomingRequestCommand
,
280 commandPayload
: JsonType
282 let response
: JsonType
;
284 chargingStation
.getOcppStrictCompliance() &&
285 chargingStation
.isInPendingState() &&
286 (commandName
=== OCPP16IncomingRequestCommand
.REMOTE_START_TRANSACTION
||
287 commandName
=== OCPP16IncomingRequestCommand
.REMOTE_STOP_TRANSACTION
)
290 ErrorType
.SECURITY_ERROR
,
291 `${commandName} cannot be issued to handle request PDU ${JSON.stringify(
295 )} while the charging station is in pending state on the central server`,
301 chargingStation
.isRegistered() === true ||
302 (chargingStation
.getOcppStrictCompliance() === false &&
303 chargingStation
.isInUnknownState() === true)
306 this.incomingRequestHandlers
.has(commandName
) === true &&
307 OCPP16ServiceUtils
.isIncomingRequestCommandSupported(chargingStation
, commandName
) === true
310 this.validatePayload(chargingStation
, commandName
, commandPayload
);
311 // Call the method to build the response
312 response
= await this.incomingRequestHandlers
.get(commandName
)(
319 `${chargingStation.logPrefix()} ${moduleName}.incomingRequestHandler: Handle incoming request error:`,
327 ErrorType
.NOT_IMPLEMENTED
,
328 `${commandName} is not implemented to handle request PDU ${JSON.stringify(
339 ErrorType
.SECURITY_ERROR
,
340 `${commandName} cannot be issued to handle request PDU ${JSON.stringify(
344 )} while the charging station is not registered on the central server.`,
349 // Send the built response
350 await chargingStation
.ocppRequestService
.sendResponse(
358 private validatePayload(
359 chargingStation
: ChargingStation
,
360 commandName
: OCPP16IncomingRequestCommand
,
361 commandPayload
: JsonType
363 if (this.jsonSchemas
.has(commandName
)) {
364 return this.validateIncomingRequestPayload(
367 this.jsonSchemas
.get(commandName
),
372 `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema found for command ${commandName} PDU validation`
377 // Simulate charging station restart
378 private handleRequestReset(
379 chargingStation
: ChargingStation
,
380 commandPayload
: ResetRequest
382 this.asyncResource
.runInAsyncScope(
383 chargingStation
.reset
.bind(chargingStation
) as (
384 this: ChargingStation
,
388 (commandPayload
.type + 'Reset') as OCPP16StopTransactionReason
391 `${chargingStation.logPrefix()} ${
393 } reset command received, simulating it. The station will be back online in ${Utils.formatDurationMilliSeconds(
394 chargingStation.stationInfo.resetTime
397 return Constants
.OCPP_RESPONSE_ACCEPTED
;
400 private handleRequestClearCache(chargingStation
: ChargingStation
): DefaultResponse
{
401 chargingStation
.authorizedTagsCache
.deleteAuthorizedTags(
402 ChargingStationUtils
.getAuthorizationFile(chargingStation
.stationInfo
)
404 return Constants
.OCPP_RESPONSE_ACCEPTED
;
407 private async handleRequestUnlockConnector(
408 chargingStation
: ChargingStation
,
409 commandPayload
: UnlockConnectorRequest
410 ): Promise
<UnlockConnectorResponse
> {
411 const connectorId
= commandPayload
.connectorId
;
412 if (connectorId
=== 0) {
414 chargingStation
.logPrefix() + ' Trying to unlock connector ' + connectorId
.toString()
416 return Constants
.OCPP_RESPONSE_UNLOCK_NOT_SUPPORTED
;
418 if (chargingStation
.getConnectorStatus(connectorId
)?.transactionStarted
=== true) {
419 const stopResponse
= await chargingStation
.stopTransactionOnConnector(
421 OCPP16StopTransactionReason
.UNLOCK_COMMAND
423 if (stopResponse
.idTagInfo
?.status === OCPP16AuthorizationStatus
.ACCEPTED
) {
424 return Constants
.OCPP_RESPONSE_UNLOCKED
;
426 return Constants
.OCPP_RESPONSE_UNLOCK_FAILED
;
428 await chargingStation
.ocppRequestService
.requestHandler
<
429 OCPP16StatusNotificationRequest
,
430 OCPP16StatusNotificationResponse
431 >(chargingStation
, OCPP16RequestCommand
.STATUS_NOTIFICATION
, {
433 status: OCPP16ChargePointStatus
.AVAILABLE
,
434 errorCode
: OCPP16ChargePointErrorCode
.NO_ERROR
,
436 chargingStation
.getConnectorStatus(connectorId
).status = OCPP16ChargePointStatus
.AVAILABLE
;
437 return Constants
.OCPP_RESPONSE_UNLOCKED
;
440 private handleRequestGetConfiguration(
441 chargingStation
: ChargingStation
,
442 commandPayload
: GetConfigurationRequest
443 ): GetConfigurationResponse
{
444 const configurationKey
: OCPPConfigurationKey
[] = [];
445 const unknownKey
: string[] = [];
446 if (Utils
.isEmptyArray(commandPayload
.key
) === true) {
447 for (const configuration
of chargingStation
.ocppConfiguration
.configurationKey
) {
448 if (Utils
.isUndefined(configuration
.visible
) === true) {
449 configuration
.visible
= true;
451 if (configuration
.visible
=== false) {
454 configurationKey
.push({
455 key
: configuration
.key
,
456 readonly: configuration
.readonly,
457 value
: configuration
.value
,
461 for (const key
of commandPayload
.key
) {
462 const keyFound
= ChargingStationConfigurationUtils
.getConfigurationKey(
467 if (Utils
.isUndefined(keyFound
.visible
) === true) {
468 keyFound
.visible
= true;
470 if (keyFound
.visible
=== false) {
473 configurationKey
.push({
475 readonly: keyFound
.readonly,
476 value
: keyFound
.value
,
479 unknownKey
.push(key
);
489 private handleRequestChangeConfiguration(
490 chargingStation
: ChargingStation
,
491 commandPayload
: ChangeConfigurationRequest
492 ): ChangeConfigurationResponse
{
493 const keyToChange
= ChargingStationConfigurationUtils
.getConfigurationKey(
499 return Constants
.OCPP_CONFIGURATION_RESPONSE_NOT_SUPPORTED
;
500 } else if (keyToChange
&& keyToChange
.readonly) {
501 return Constants
.OCPP_CONFIGURATION_RESPONSE_REJECTED
;
502 } else if (keyToChange
&& !keyToChange
.readonly) {
503 let valueChanged
= false;
504 if (keyToChange
.value
!== commandPayload
.value
) {
505 ChargingStationConfigurationUtils
.setConfigurationKeyValue(
508 commandPayload
.value
,
513 let triggerHeartbeatRestart
= false;
514 if (keyToChange
.key
=== OCPP16StandardParametersKey
.HeartBeatInterval
&& valueChanged
) {
515 ChargingStationConfigurationUtils
.setConfigurationKeyValue(
517 OCPP16StandardParametersKey
.HeartbeatInterval
,
520 triggerHeartbeatRestart
= true;
522 if (keyToChange
.key
=== OCPP16StandardParametersKey
.HeartbeatInterval
&& valueChanged
) {
523 ChargingStationConfigurationUtils
.setConfigurationKeyValue(
525 OCPP16StandardParametersKey
.HeartBeatInterval
,
528 triggerHeartbeatRestart
= true;
530 if (triggerHeartbeatRestart
) {
531 chargingStation
.restartHeartbeat();
533 if (keyToChange
.key
=== OCPP16StandardParametersKey
.WebSocketPingInterval
&& valueChanged
) {
534 chargingStation
.restartWebSocketPing();
536 if (keyToChange
.reboot
) {
537 return Constants
.OCPP_CONFIGURATION_RESPONSE_REBOOT_REQUIRED
;
539 return Constants
.OCPP_CONFIGURATION_RESPONSE_ACCEPTED
;
543 private handleRequestSetChargingProfile(
544 chargingStation
: ChargingStation
,
545 commandPayload
: SetChargingProfileRequest
546 ): SetChargingProfileResponse
{
548 OCPP16ServiceUtils
.checkFeatureProfile(
550 OCPP16SupportedFeatureProfiles
.SmartCharging
,
551 OCPP16IncomingRequestCommand
.SET_CHARGING_PROFILE
554 return Constants
.OCPP_SET_CHARGING_PROFILE_RESPONSE_NOT_SUPPORTED
;
556 if (chargingStation
.connectors
.has(commandPayload
.connectorId
) === false) {
558 `${chargingStation.logPrefix()} Trying to set charging profile(s) to a non existing connector Id ${
559 commandPayload.connectorId
562 return Constants
.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED
;
565 commandPayload
.csChargingProfiles
.chargingProfilePurpose
===
566 ChargingProfilePurposeType
.CHARGE_POINT_MAX_PROFILE
&&
567 commandPayload
.connectorId
!== 0
569 return Constants
.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED
;
572 commandPayload
.csChargingProfiles
.chargingProfilePurpose
===
573 ChargingProfilePurposeType
.TX_PROFILE
&&
574 (commandPayload
.connectorId
=== 0 ||
575 chargingStation
.getConnectorStatus(commandPayload
.connectorId
)?.transactionStarted
===
578 return Constants
.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED
;
580 OCPP16ServiceUtils
.setChargingProfile(
582 commandPayload
.connectorId
,
583 commandPayload
.csChargingProfiles
586 `${chargingStation.logPrefix()} Charging profile(s) set on connector id ${
587 commandPayload.connectorId
588 }, dump their stack: %j`,
589 chargingStation
.getConnectorStatus(commandPayload
.connectorId
).chargingProfiles
591 return Constants
.OCPP_SET_CHARGING_PROFILE_RESPONSE_ACCEPTED
;
594 private handleRequestClearChargingProfile(
595 chargingStation
: ChargingStation
,
596 commandPayload
: ClearChargingProfileRequest
597 ): ClearChargingProfileResponse
{
599 OCPP16ServiceUtils
.checkFeatureProfile(
601 OCPP16SupportedFeatureProfiles
.SmartCharging
,
602 OCPP16IncomingRequestCommand
.CLEAR_CHARGING_PROFILE
605 return Constants
.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN
;
607 if (chargingStation
.connectors
.has(commandPayload
.connectorId
) === false) {
609 `${chargingStation.logPrefix()} Trying to clear a charging profile(s) to a non existing connector Id ${
610 commandPayload.connectorId
613 return Constants
.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN
;
615 const connectorStatus
= chargingStation
.getConnectorStatus(commandPayload
.connectorId
);
616 if (commandPayload
.connectorId
&& !Utils
.isEmptyArray(connectorStatus
.chargingProfiles
)) {
617 connectorStatus
.chargingProfiles
= [];
619 `${chargingStation.logPrefix()} Charging profile(s) cleared on connector id ${
620 commandPayload.connectorId
621 }, dump their stack: %j`,
622 connectorStatus
.chargingProfiles
624 return Constants
.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_ACCEPTED
;
626 if (!commandPayload
.connectorId
) {
627 let clearedCP
= false;
628 for (const connectorId
of chargingStation
.connectors
.keys()) {
629 if (!Utils
.isEmptyArray(chargingStation
.getConnectorStatus(connectorId
).chargingProfiles
)) {
631 .getConnectorStatus(connectorId
)
632 .chargingProfiles
?.forEach((chargingProfile
: OCPP16ChargingProfile
, index
: number) => {
633 let clearCurrentCP
= false;
634 if (chargingProfile
.chargingProfileId
=== commandPayload
.id
) {
635 clearCurrentCP
= true;
638 !commandPayload
.chargingProfilePurpose
&&
639 chargingProfile
.stackLevel
=== commandPayload
.stackLevel
641 clearCurrentCP
= true;
644 !chargingProfile
.stackLevel
&&
645 chargingProfile
.chargingProfilePurpose
=== commandPayload
.chargingProfilePurpose
647 clearCurrentCP
= true;
650 chargingProfile
.stackLevel
=== commandPayload
.stackLevel
&&
651 chargingProfile
.chargingProfilePurpose
=== commandPayload
.chargingProfilePurpose
653 clearCurrentCP
= true;
655 if (clearCurrentCP
) {
656 connectorStatus
.chargingProfiles
.splice(index
, 1);
658 `${chargingStation.logPrefix()} Matching charging profile(s) cleared on connector id ${
659 commandPayload.connectorId
660 }, dump their stack: %j`,
661 connectorStatus
.chargingProfiles
669 return Constants
.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_ACCEPTED
;
672 return Constants
.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN
;
675 private async handleRequestChangeAvailability(
676 chargingStation
: ChargingStation
,
677 commandPayload
: ChangeAvailabilityRequest
678 ): Promise
<ChangeAvailabilityResponse
> {
679 const connectorId
: number = commandPayload
.connectorId
;
680 if (!chargingStation
.getConnectorStatus(connectorId
)) {
682 `${chargingStation.logPrefix()} Trying to change the availability of a non existing connector Id ${connectorId.toString()}`
684 return Constants
.OCPP_AVAILABILITY_RESPONSE_REJECTED
;
686 const chargePointStatus
: OCPP16ChargePointStatus
=
687 commandPayload
.type === OCPP16AvailabilityType
.OPERATIVE
688 ? OCPP16ChargePointStatus
.AVAILABLE
689 : OCPP16ChargePointStatus
.UNAVAILABLE
;
690 if (connectorId
=== 0) {
691 let response
: ChangeAvailabilityResponse
= Constants
.OCPP_AVAILABILITY_RESPONSE_ACCEPTED
;
692 for (const id
of chargingStation
.connectors
.keys()) {
693 if (chargingStation
.getConnectorStatus(id
)?.transactionStarted
=== true) {
694 response
= Constants
.OCPP_AVAILABILITY_RESPONSE_SCHEDULED
;
696 chargingStation
.getConnectorStatus(id
).availability
= commandPayload
.type;
697 if (response
=== Constants
.OCPP_AVAILABILITY_RESPONSE_ACCEPTED
) {
698 await chargingStation
.ocppRequestService
.requestHandler
<
699 OCPP16StatusNotificationRequest
,
700 OCPP16StatusNotificationResponse
701 >(chargingStation
, OCPP16RequestCommand
.STATUS_NOTIFICATION
, {
703 status: chargePointStatus
,
704 errorCode
: OCPP16ChargePointErrorCode
.NO_ERROR
,
706 chargingStation
.getConnectorStatus(id
).status = chargePointStatus
;
712 (chargingStation
.isChargingStationAvailable() === true ||
713 (chargingStation
.isChargingStationAvailable() === false &&
714 commandPayload
.type === OCPP16AvailabilityType
.INOPERATIVE
))
716 if (chargingStation
.getConnectorStatus(connectorId
)?.transactionStarted
=== true) {
717 chargingStation
.getConnectorStatus(connectorId
).availability
= commandPayload
.type;
718 return Constants
.OCPP_AVAILABILITY_RESPONSE_SCHEDULED
;
720 chargingStation
.getConnectorStatus(connectorId
).availability
= commandPayload
.type;
721 await chargingStation
.ocppRequestService
.requestHandler
<
722 OCPP16StatusNotificationRequest
,
723 OCPP16StatusNotificationResponse
724 >(chargingStation
, OCPP16RequestCommand
.STATUS_NOTIFICATION
, {
726 status: chargePointStatus
,
727 errorCode
: OCPP16ChargePointErrorCode
.NO_ERROR
,
729 chargingStation
.getConnectorStatus(connectorId
).status = chargePointStatus
;
730 return Constants
.OCPP_AVAILABILITY_RESPONSE_ACCEPTED
;
732 return Constants
.OCPP_AVAILABILITY_RESPONSE_REJECTED
;
735 private async handleRequestRemoteStartTransaction(
736 chargingStation
: ChargingStation
,
737 commandPayload
: RemoteStartTransactionRequest
738 ): Promise
<DefaultResponse
> {
739 const transactionConnectorId
= commandPayload
.connectorId
;
740 if (chargingStation
.connectors
.has(transactionConnectorId
) === true) {
741 const remoteStartTransactionLogMsg
=
742 chargingStation
.logPrefix() +
743 ' Transaction remotely STARTED on ' +
744 chargingStation
.stationInfo
.chargingStationId
+
746 transactionConnectorId
.toString() +
748 commandPayload
.idTag
+
750 await chargingStation
.ocppRequestService
.requestHandler
<
751 OCPP16StatusNotificationRequest
,
752 OCPP16StatusNotificationResponse
753 >(chargingStation
, OCPP16RequestCommand
.STATUS_NOTIFICATION
, {
754 connectorId
: transactionConnectorId
,
755 status: OCPP16ChargePointStatus
.PREPARING
,
756 errorCode
: OCPP16ChargePointErrorCode
.NO_ERROR
,
758 const connectorStatus
= chargingStation
.getConnectorStatus(transactionConnectorId
);
759 connectorStatus
.status = OCPP16ChargePointStatus
.PREPARING
;
760 if (chargingStation
.isChargingStationAvailable() === true) {
761 // Check if authorized
762 if (chargingStation
.getAuthorizeRemoteTxRequests() === true) {
763 let authorized
= false;
765 chargingStation
.getLocalAuthListEnabled() === true &&
766 chargingStation
.hasAuthorizedTags() === true &&
767 chargingStation
.authorizedTagsCache
769 ChargingStationUtils
.getAuthorizationFile(chargingStation
.stationInfo
)
771 .find((idTag
) => idTag
=== commandPayload
.idTag
)
773 connectorStatus
.localAuthorizeIdTag
= commandPayload
.idTag
;
774 connectorStatus
.idTagLocalAuthorized
= true;
776 } else if (chargingStation
.getMustAuthorizeAtRemoteStart() === true) {
777 connectorStatus
.authorizeIdTag
= commandPayload
.idTag
;
778 const authorizeResponse
: OCPP16AuthorizeResponse
=
779 await chargingStation
.ocppRequestService
.requestHandler
<
780 OCPP16AuthorizeRequest
,
781 OCPP16AuthorizeResponse
782 >(chargingStation
, OCPP16RequestCommand
.AUTHORIZE
, {
783 idTag
: commandPayload
.idTag
,
785 if (authorizeResponse
?.idTagInfo
?.status === OCPP16AuthorizationStatus
.ACCEPTED
) {
790 `${chargingStation.logPrefix()} The charging station configuration expects authorize at remote start transaction but local authorization or authorize isn't enabled`
793 if (authorized
=== true) {
794 // Authorization successful, start transaction
796 this.setRemoteStartTransactionChargingProfile(
798 transactionConnectorId
,
799 commandPayload
.chargingProfile
802 connectorStatus
.transactionRemoteStarted
= true;
805 await chargingStation
.ocppRequestService
.requestHandler
<
806 OCPP16StartTransactionRequest
,
807 OCPP16StartTransactionResponse
808 >(chargingStation
, OCPP16RequestCommand
.START_TRANSACTION
, {
809 connectorId
: transactionConnectorId
,
810 idTag
: commandPayload
.idTag
,
812 ).idTagInfo
.status === OCPP16AuthorizationStatus
.ACCEPTED
814 logger
.debug(remoteStartTransactionLogMsg
);
815 return Constants
.OCPP_RESPONSE_ACCEPTED
;
817 return this.notifyRemoteStartTransactionRejected(
819 transactionConnectorId
,
823 return this.notifyRemoteStartTransactionRejected(
825 transactionConnectorId
,
829 return this.notifyRemoteStartTransactionRejected(
831 transactionConnectorId
,
835 // No authorization check required, start transaction
837 this.setRemoteStartTransactionChargingProfile(
839 transactionConnectorId
,
840 commandPayload
.chargingProfile
843 connectorStatus
.transactionRemoteStarted
= true;
846 await chargingStation
.ocppRequestService
.requestHandler
<
847 OCPP16StartTransactionRequest
,
848 OCPP16StartTransactionResponse
849 >(chargingStation
, OCPP16RequestCommand
.START_TRANSACTION
, {
850 connectorId
: transactionConnectorId
,
851 idTag
: commandPayload
.idTag
,
853 ).idTagInfo
.status === OCPP16AuthorizationStatus
.ACCEPTED
855 logger
.debug(remoteStartTransactionLogMsg
);
856 return Constants
.OCPP_RESPONSE_ACCEPTED
;
858 return this.notifyRemoteStartTransactionRejected(
860 transactionConnectorId
,
864 return this.notifyRemoteStartTransactionRejected(
866 transactionConnectorId
,
870 return this.notifyRemoteStartTransactionRejected(
872 transactionConnectorId
,
876 return this.notifyRemoteStartTransactionRejected(
878 transactionConnectorId
,
883 private async notifyRemoteStartTransactionRejected(
884 chargingStation
: ChargingStation
,
887 ): Promise
<DefaultResponse
> {
889 chargingStation
.getConnectorStatus(connectorId
).status !== OCPP16ChargePointStatus
.AVAILABLE
891 await chargingStation
.ocppRequestService
.requestHandler
<
892 OCPP16StatusNotificationRequest
,
893 OCPP16StatusNotificationResponse
894 >(chargingStation
, OCPP16RequestCommand
.STATUS_NOTIFICATION
, {
896 status: OCPP16ChargePointStatus
.AVAILABLE
,
897 errorCode
: OCPP16ChargePointErrorCode
.NO_ERROR
,
899 chargingStation
.getConnectorStatus(connectorId
).status = OCPP16ChargePointStatus
.AVAILABLE
;
902 chargingStation
.logPrefix() +
903 ' Remote starting transaction REJECTED on connector Id ' +
904 connectorId
.toString() +
907 "', availability '" +
908 chargingStation
.getConnectorStatus(connectorId
).availability
+
910 chargingStation
.getConnectorStatus(connectorId
).status +
913 return Constants
.OCPP_RESPONSE_REJECTED
;
916 private setRemoteStartTransactionChargingProfile(
917 chargingStation
: ChargingStation
,
919 cp
: OCPP16ChargingProfile
921 if (cp
&& cp
.chargingProfilePurpose
=== ChargingProfilePurposeType
.TX_PROFILE
) {
922 OCPP16ServiceUtils
.setChargingProfile(chargingStation
, connectorId
, cp
);
924 `${chargingStation.logPrefix()} Charging profile(s) set at remote start transaction on connector id ${connectorId}, dump their stack: %j`,
925 chargingStation
.getConnectorStatus(connectorId
).chargingProfiles
928 } else if (cp
&& cp
.chargingProfilePurpose
!== ChargingProfilePurposeType
.TX_PROFILE
) {
930 `${chargingStation.logPrefix()} Not allowed to set ${
931 cp.chargingProfilePurpose
932 } charging profile(s) at remote start transaction`
940 private async handleRequestRemoteStopTransaction(
941 chargingStation
: ChargingStation
,
942 commandPayload
: RemoteStopTransactionRequest
943 ): Promise
<DefaultResponse
> {
944 const transactionId
= commandPayload
.transactionId
;
945 for (const connectorId
of chargingStation
.connectors
.keys()) {
948 chargingStation
.getConnectorStatus(connectorId
)?.transactionId
=== transactionId
950 await chargingStation
.ocppRequestService
.requestHandler
<
951 OCPP16StatusNotificationRequest
,
952 OCPP16StatusNotificationResponse
953 >(chargingStation
, OCPP16RequestCommand
.STATUS_NOTIFICATION
, {
955 status: OCPP16ChargePointStatus
.FINISHING
,
956 errorCode
: OCPP16ChargePointErrorCode
.NO_ERROR
,
958 chargingStation
.getConnectorStatus(connectorId
).status = OCPP16ChargePointStatus
.FINISHING
;
959 const stopResponse
= await chargingStation
.stopTransactionOnConnector(
961 OCPP16StopTransactionReason
.REMOTE
963 if (stopResponse
.idTagInfo
?.status === OCPP16AuthorizationStatus
.ACCEPTED
) {
964 return Constants
.OCPP_RESPONSE_ACCEPTED
;
966 return Constants
.OCPP_RESPONSE_REJECTED
;
970 chargingStation
.logPrefix() +
971 ' Trying to remote stop a non existing transaction ' +
972 transactionId
.toString()
974 return Constants
.OCPP_RESPONSE_REJECTED
;
977 private async handleRequestGetDiagnostics(
978 chargingStation
: ChargingStation
,
979 commandPayload
: GetDiagnosticsRequest
980 ): Promise
<GetDiagnosticsResponse
> {
982 OCPP16ServiceUtils
.checkFeatureProfile(
984 OCPP16SupportedFeatureProfiles
.FirmwareManagement
,
985 OCPP16IncomingRequestCommand
.GET_DIAGNOSTICS
988 return Constants
.OCPP_RESPONSE_EMPTY
;
991 chargingStation
.logPrefix() +
993 OCPP16IncomingRequestCommand
.GET_DIAGNOSTICS
+
994 ' request received: %j',
997 const uri
= new URL(commandPayload
.location
);
998 if (uri
.protocol
.startsWith('ftp:')) {
999 let ftpClient
: Client
;
1002 .readdirSync(path
.resolve(path
.dirname(fileURLToPath(import.meta
.url
)), '../../../../'))
1003 .filter((file
) => file
.endsWith('.log'))
1004 .map((file
) => path
.join('./', file
));
1005 const diagnosticsArchive
= chargingStation
.stationInfo
.chargingStationId
+ '_logs.tar.gz';
1006 tar
.create({ gzip
: true }, logFiles
).pipe(fs
.createWriteStream(diagnosticsArchive
));
1007 ftpClient
= new Client();
1008 const accessResponse
= await ftpClient
.access({
1010 ...(!Utils
.isEmptyString(uri
.port
) && { port
: Utils
.convertToInt(uri
.port
) }),
1011 ...(!Utils
.isEmptyString(uri
.username
) && { user
: uri
.username
}),
1012 ...(!Utils
.isEmptyString(uri
.password
) && { password
: uri
.password
}),
1014 let uploadResponse
: FTPResponse
;
1015 if (accessResponse
.code
=== 220) {
1016 // eslint-disable-next-line @typescript-eslint/no-misused-promises
1017 ftpClient
.trackProgress(async (info
) => {
1019 `${chargingStation.logPrefix()} ${
1021 } bytes transferred from diagnostics archive ${info.name}`
1023 await chargingStation
.ocppRequestService
.requestHandler
<
1024 DiagnosticsStatusNotificationRequest
,
1025 DiagnosticsStatusNotificationResponse
1026 >(chargingStation
, OCPP16RequestCommand
.DIAGNOSTICS_STATUS_NOTIFICATION
, {
1027 status: OCPP16DiagnosticsStatus
.Uploading
,
1030 uploadResponse
= await ftpClient
.uploadFrom(
1032 path
.resolve(path
.dirname(fileURLToPath(import.meta
.url
)), '../../../../'),
1035 uri
.pathname
+ diagnosticsArchive
1037 if (uploadResponse
.code
=== 226) {
1038 await chargingStation
.ocppRequestService
.requestHandler
<
1039 DiagnosticsStatusNotificationRequest
,
1040 DiagnosticsStatusNotificationResponse
1041 >(chargingStation
, OCPP16RequestCommand
.DIAGNOSTICS_STATUS_NOTIFICATION
, {
1042 status: OCPP16DiagnosticsStatus
.Uploaded
,
1047 return { fileName
: diagnosticsArchive
};
1049 throw new OCPPError(
1050 ErrorType
.GENERIC_ERROR
,
1051 `Diagnostics transfer failed with error code ${accessResponse.code.toString()}${
1052 uploadResponse?.code && '|' + uploadResponse?.code.toString()
1054 OCPP16IncomingRequestCommand
.GET_DIAGNOSTICS
1057 throw new OCPPError(
1058 ErrorType
.GENERIC_ERROR
,
1059 `Diagnostics transfer failed with error code ${accessResponse.code.toString()}${
1060 uploadResponse?.code && '|' + uploadResponse?.code.toString()
1062 OCPP16IncomingRequestCommand
.GET_DIAGNOSTICS
1065 await chargingStation
.ocppRequestService
.requestHandler
<
1066 DiagnosticsStatusNotificationRequest
,
1067 DiagnosticsStatusNotificationResponse
1068 >(chargingStation
, OCPP16RequestCommand
.DIAGNOSTICS_STATUS_NOTIFICATION
, {
1069 status: OCPP16DiagnosticsStatus
.UploadFailed
,
1074 return this.handleIncomingRequestError(
1076 OCPP16IncomingRequestCommand
.GET_DIAGNOSTICS
,
1078 { errorResponse
: Constants
.OCPP_RESPONSE_EMPTY
}
1083 `${chargingStation.logPrefix()} Unsupported protocol ${
1085 } to transfer the diagnostic logs archive`
1087 await chargingStation
.ocppRequestService
.requestHandler
<
1088 DiagnosticsStatusNotificationRequest
,
1089 DiagnosticsStatusNotificationResponse
1090 >(chargingStation
, OCPP16RequestCommand
.DIAGNOSTICS_STATUS_NOTIFICATION
, {
1091 status: OCPP16DiagnosticsStatus
.UploadFailed
,
1093 return Constants
.OCPP_RESPONSE_EMPTY
;
1097 private handleRequestTriggerMessage(
1098 chargingStation
: ChargingStation
,
1099 commandPayload
: OCPP16TriggerMessageRequest
1100 ): OCPP16TriggerMessageResponse
{
1102 !OCPP16ServiceUtils
.checkFeatureProfile(
1104 OCPP16SupportedFeatureProfiles
.RemoteTrigger
,
1105 OCPP16IncomingRequestCommand
.TRIGGER_MESSAGE
1108 return Constants
.OCPP_TRIGGER_MESSAGE_RESPONSE_NOT_IMPLEMENTED
;
1110 // TODO: factor out the check on connector id
1111 if (commandPayload
?.connectorId
< 0) {
1113 `${chargingStation.logPrefix()} ${
1114 OCPP16IncomingRequestCommand.TRIGGER_MESSAGE
1115 } incoming request received with invalid connectorId ${commandPayload.connectorId}`
1117 return Constants
.OCPP_TRIGGER_MESSAGE_RESPONSE_REJECTED
;
1120 switch (commandPayload
.requestedMessage
) {
1121 case MessageTrigger
.BootNotification
:
1123 chargingStation
.ocppRequestService
1124 .requestHandler
<OCPP16BootNotificationRequest
, OCPP16BootNotificationResponse
>(
1126 OCPP16RequestCommand
.BOOT_NOTIFICATION
,
1127 chargingStation
.bootNotificationRequest
,
1128 { skipBufferingOnError
: true, triggerMessage
: true }
1130 .then((response
) => {
1131 chargingStation
.bootNotificationResponse
= response
;
1134 /* This is intentional */
1136 }, Constants
.OCPP_TRIGGER_MESSAGE_DELAY
);
1137 return Constants
.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED
;
1138 case MessageTrigger
.Heartbeat
:
1140 chargingStation
.ocppRequestService
1141 .requestHandler
<OCPP16HeartbeatRequest
, OCPP16HeartbeatResponse
>(
1143 OCPP16RequestCommand
.HEARTBEAT
,
1146 triggerMessage
: true,
1150 /* This is intentional */
1152 }, Constants
.OCPP_TRIGGER_MESSAGE_DELAY
);
1153 return Constants
.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED
;
1154 case MessageTrigger
.StatusNotification
:
1156 if (commandPayload
?.connectorId
) {
1157 chargingStation
.ocppRequestService
1158 .requestHandler
<OCPP16StatusNotificationRequest
, OCPP16StatusNotificationResponse
>(
1160 OCPP16RequestCommand
.STATUS_NOTIFICATION
,
1162 connectorId
: commandPayload
.connectorId
,
1163 errorCode
: OCPP16ChargePointErrorCode
.NO_ERROR
,
1164 status: chargingStation
.getConnectorStatus(commandPayload
.connectorId
).status,
1167 triggerMessage
: true,
1171 /* This is intentional */
1174 for (const connectorId
of chargingStation
.connectors
.keys()) {
1175 chargingStation
.ocppRequestService
1177 OCPP16StatusNotificationRequest
,
1178 OCPP16StatusNotificationResponse
1181 OCPP16RequestCommand
.STATUS_NOTIFICATION
,
1184 errorCode
: OCPP16ChargePointErrorCode
.NO_ERROR
,
1185 status: chargingStation
.getConnectorStatus(connectorId
).status,
1188 triggerMessage
: true,
1192 /* This is intentional */
1196 }, Constants
.OCPP_TRIGGER_MESSAGE_DELAY
);
1197 return Constants
.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED
;
1199 return Constants
.OCPP_TRIGGER_MESSAGE_RESPONSE_NOT_IMPLEMENTED
;
1202 return this.handleIncomingRequestError(
1204 OCPP16IncomingRequestCommand
.TRIGGER_MESSAGE
,
1206 { errorResponse
: Constants
.OCPP_TRIGGER_MESSAGE_RESPONSE_REJECTED
}