1 // Partial Copyright Jerome Benoit. 2021-2024. All Rights Reserved.
3 import { randomInt
} from
'node:crypto'
4 import { createWriteStream
, readdirSync
} from
'node:fs'
5 import { dirname
, extname
, join
, resolve
} from
'node:path'
6 import { fileURLToPath
, URL
} from
'node:url'
8 import type { ValidateFunction
} from
'ajv'
9 import { Client
, type FTPResponse
} from
'basic-ftp'
17 import { maxTime
} from
'date-fns/constants'
18 import { isEmpty
} from
'rambda'
19 import { create
} from
'tar'
22 canProceedChargingProfile
,
26 getConnectorChargingProfiles
,
27 prepareChargingProfileKind
,
28 removeExpiredReservations
,
29 resetAuthorizeConnectorStatus
,
30 setConfigurationKeyValue
31 } from
'../../../charging-station/index.js'
32 import { OCPPError
} from
'../../../exception/index.js'
34 type ChangeConfigurationRequest
,
35 type ChangeConfigurationResponse
,
40 type GetConfigurationRequest
,
41 type GetConfigurationResponse
,
42 type GetDiagnosticsRequest
,
43 type GetDiagnosticsResponse
,
44 type IncomingRequestHandler
,
46 type LogConfiguration
,
47 OCPP16AuthorizationStatus
,
48 OCPP16AvailabilityType
,
49 type OCPP16BootNotificationRequest
,
50 type OCPP16BootNotificationResponse
,
51 type OCPP16CancelReservationRequest
,
52 type OCPP16ChangeAvailabilityRequest
,
53 type OCPP16ChangeAvailabilityResponse
,
54 OCPP16ChargePointErrorCode
,
55 OCPP16ChargePointStatus
,
56 type OCPP16ChargingProfile
,
57 OCPP16ChargingProfilePurposeType
,
58 type OCPP16ChargingSchedule
,
59 type OCPP16ClearCacheRequest
,
60 type OCPP16ClearChargingProfileRequest
,
61 type OCPP16ClearChargingProfileResponse
,
62 type OCPP16DataTransferRequest
,
63 type OCPP16DataTransferResponse
,
64 OCPP16DataTransferVendorId
,
65 OCPP16DiagnosticsStatus
,
66 type OCPP16DiagnosticsStatusNotificationRequest
,
67 type OCPP16DiagnosticsStatusNotificationResponse
,
69 type OCPP16FirmwareStatusNotificationRequest
,
70 type OCPP16FirmwareStatusNotificationResponse
,
71 type OCPP16GetCompositeScheduleRequest
,
72 type OCPP16GetCompositeScheduleResponse
,
73 type OCPP16HeartbeatRequest
,
74 type OCPP16HeartbeatResponse
,
75 OCPP16IncomingRequestCommand
,
78 type OCPP16ReserveNowRequest
,
79 type OCPP16ReserveNowResponse
,
80 OCPP16StandardParametersKey
,
81 type OCPP16StartTransactionRequest
,
82 type OCPP16StartTransactionResponse
,
83 type OCPP16StatusNotificationRequest
,
84 type OCPP16StatusNotificationResponse
,
85 OCPP16StopTransactionReason
,
86 OCPP16SupportedFeatureProfiles
,
87 type OCPP16TriggerMessageRequest
,
88 type OCPP16TriggerMessageResponse
,
89 OCPP16TriggerMessageStatus
,
90 type OCPP16UpdateFirmwareRequest
,
91 type OCPP16UpdateFirmwareResponse
,
92 type OCPPConfigurationKey
,
94 type RemoteStartTransactionRequest
,
95 type RemoteStopTransactionRequest
,
96 ReservationTerminationReason
,
98 type SetChargingProfileRequest
,
99 type SetChargingProfileResponse
,
100 type UnlockConnectorRequest
,
101 type UnlockConnectorResponse
102 } from
'../../../types/index.js'
108 formatDurationMilliSeconds
,
114 } from
'../../../utils/index.js'
115 import { OCPPIncomingRequestService
} from
'../OCPPIncomingRequestService.js'
116 import { OCPP16Constants
} from
'./OCPP16Constants.js'
117 import { OCPP16ServiceUtils
} from
'./OCPP16ServiceUtils.js'
119 const moduleName
= 'OCPP16IncomingRequestService'
121 export class OCPP16IncomingRequestService
extends OCPPIncomingRequestService
{
122 protected payloadValidateFunctions
: Map
<OCPP16IncomingRequestCommand
, ValidateFunction
<JsonType
>>
124 private readonly incomingRequestHandlers
: Map
<
125 OCPP16IncomingRequestCommand
,
126 IncomingRequestHandler
129 public constructor () {
130 // if (new.target.name === moduleName) {
131 // throw new TypeError(`Cannot construct ${new.target.name} instances directly`)
133 super(OCPPVersion
.VERSION_16
)
134 this.incomingRequestHandlers
= new Map
<OCPP16IncomingRequestCommand
, IncomingRequestHandler
>([
136 OCPP16IncomingRequestCommand
.RESET
,
137 this.handleRequestReset
.bind(this) as unknown
as IncomingRequestHandler
140 OCPP16IncomingRequestCommand
.CLEAR_CACHE
,
141 this.handleRequestClearCache
.bind(this) as IncomingRequestHandler
144 OCPP16IncomingRequestCommand
.UNLOCK_CONNECTOR
,
145 this.handleRequestUnlockConnector
.bind(this) as unknown
as IncomingRequestHandler
148 OCPP16IncomingRequestCommand
.GET_CONFIGURATION
,
149 this.handleRequestGetConfiguration
.bind(this) as IncomingRequestHandler
152 OCPP16IncomingRequestCommand
.CHANGE_CONFIGURATION
,
153 this.handleRequestChangeConfiguration
.bind(this) as unknown
as IncomingRequestHandler
156 OCPP16IncomingRequestCommand
.GET_COMPOSITE_SCHEDULE
,
157 this.handleRequestGetCompositeSchedule
.bind(this) as unknown
as IncomingRequestHandler
160 OCPP16IncomingRequestCommand
.SET_CHARGING_PROFILE
,
161 this.handleRequestSetChargingProfile
.bind(this) as unknown
as IncomingRequestHandler
164 OCPP16IncomingRequestCommand
.CLEAR_CHARGING_PROFILE
,
165 this.handleRequestClearChargingProfile
.bind(this) as IncomingRequestHandler
168 OCPP16IncomingRequestCommand
.CHANGE_AVAILABILITY
,
169 this.handleRequestChangeAvailability
.bind(this) as unknown
as IncomingRequestHandler
172 OCPP16IncomingRequestCommand
.REMOTE_START_TRANSACTION
,
173 this.handleRequestRemoteStartTransaction
.bind(this) as unknown
as IncomingRequestHandler
176 OCPP16IncomingRequestCommand
.REMOTE_STOP_TRANSACTION
,
177 this.handleRequestRemoteStopTransaction
.bind(this) as unknown
as IncomingRequestHandler
180 OCPP16IncomingRequestCommand
.GET_DIAGNOSTICS
,
181 this.handleRequestGetDiagnostics
.bind(this) as IncomingRequestHandler
184 OCPP16IncomingRequestCommand
.TRIGGER_MESSAGE
,
185 this.handleRequestTriggerMessage
.bind(this) as unknown
as IncomingRequestHandler
188 OCPP16IncomingRequestCommand
.DATA_TRANSFER
,
189 this.handleRequestDataTransfer
.bind(this) as unknown
as IncomingRequestHandler
192 OCPP16IncomingRequestCommand
.UPDATE_FIRMWARE
,
193 this.handleRequestUpdateFirmware
.bind(this) as unknown
as IncomingRequestHandler
196 OCPP16IncomingRequestCommand
.RESERVE_NOW
,
197 this.handleRequestReserveNow
.bind(this) as unknown
as IncomingRequestHandler
200 OCPP16IncomingRequestCommand
.CANCEL_RESERVATION
,
201 this.handleRequestCancelReservation
.bind(this) as unknown
as IncomingRequestHandler
204 this.payloadValidateFunctions
= new Map
<
205 OCPP16IncomingRequestCommand
,
206 ValidateFunction
<JsonType
>
209 OCPP16IncomingRequestCommand
.RESET
,
212 OCPP16ServiceUtils
.parseJsonSchemaFile
<ResetRequest
>(
213 'assets/json-schemas/ocpp/1.6/Reset.json',
221 OCPP16IncomingRequestCommand
.CLEAR_CACHE
,
224 OCPP16ServiceUtils
.parseJsonSchemaFile
<OCPP16ClearCacheRequest
>(
225 'assets/json-schemas/ocpp/1.6/ClearCache.json',
233 OCPP16IncomingRequestCommand
.UNLOCK_CONNECTOR
,
236 OCPP16ServiceUtils
.parseJsonSchemaFile
<UnlockConnectorRequest
>(
237 'assets/json-schemas/ocpp/1.6/UnlockConnector.json',
245 OCPP16IncomingRequestCommand
.GET_CONFIGURATION
,
248 OCPP16ServiceUtils
.parseJsonSchemaFile
<GetConfigurationRequest
>(
249 'assets/json-schemas/ocpp/1.6/GetConfiguration.json',
257 OCPP16IncomingRequestCommand
.CHANGE_CONFIGURATION
,
260 OCPP16ServiceUtils
.parseJsonSchemaFile
<ChangeConfigurationRequest
>(
261 'assets/json-schemas/ocpp/1.6/ChangeConfiguration.json',
269 OCPP16IncomingRequestCommand
.GET_DIAGNOSTICS
,
272 OCPP16ServiceUtils
.parseJsonSchemaFile
<GetDiagnosticsRequest
>(
273 'assets/json-schemas/ocpp/1.6/GetDiagnostics.json',
281 OCPP16IncomingRequestCommand
.GET_COMPOSITE_SCHEDULE
,
284 OCPP16ServiceUtils
.parseJsonSchemaFile
<OCPP16GetCompositeScheduleRequest
>(
285 'assets/json-schemas/ocpp/1.6/GetCompositeSchedule.json',
293 OCPP16IncomingRequestCommand
.SET_CHARGING_PROFILE
,
296 OCPP16ServiceUtils
.parseJsonSchemaFile
<SetChargingProfileRequest
>(
297 'assets/json-schemas/ocpp/1.6/SetChargingProfile.json',
305 OCPP16IncomingRequestCommand
.CLEAR_CHARGING_PROFILE
,
308 OCPP16ServiceUtils
.parseJsonSchemaFile
<OCPP16ClearChargingProfileRequest
>(
309 'assets/json-schemas/ocpp/1.6/ClearChargingProfile.json',
317 OCPP16IncomingRequestCommand
.CHANGE_AVAILABILITY
,
320 OCPP16ServiceUtils
.parseJsonSchemaFile
<OCPP16ChangeAvailabilityRequest
>(
321 'assets/json-schemas/ocpp/1.6/ChangeAvailability.json',
329 OCPP16IncomingRequestCommand
.REMOTE_START_TRANSACTION
,
332 OCPP16ServiceUtils
.parseJsonSchemaFile
<RemoteStartTransactionRequest
>(
333 'assets/json-schemas/ocpp/1.6/RemoteStartTransaction.json',
341 OCPP16IncomingRequestCommand
.REMOTE_STOP_TRANSACTION
,
344 OCPP16ServiceUtils
.parseJsonSchemaFile
<RemoteStopTransactionRequest
>(
345 'assets/json-schemas/ocpp/1.6/RemoteStopTransaction.json',
353 OCPP16IncomingRequestCommand
.TRIGGER_MESSAGE
,
356 OCPP16ServiceUtils
.parseJsonSchemaFile
<OCPP16TriggerMessageRequest
>(
357 'assets/json-schemas/ocpp/1.6/TriggerMessage.json',
365 OCPP16IncomingRequestCommand
.DATA_TRANSFER
,
368 OCPP16ServiceUtils
.parseJsonSchemaFile
<OCPP16DataTransferRequest
>(
369 'assets/json-schemas/ocpp/1.6/DataTransfer.json',
377 OCPP16IncomingRequestCommand
.UPDATE_FIRMWARE
,
380 OCPP16ServiceUtils
.parseJsonSchemaFile
<OCPP16UpdateFirmwareRequest
>(
381 'assets/json-schemas/ocpp/1.6/UpdateFirmware.json',
389 OCPP16IncomingRequestCommand
.RESERVE_NOW
,
392 OCPP16ServiceUtils
.parseJsonSchemaFile
<OCPP16ReserveNowRequest
>(
393 'assets/json-schemas/ocpp/1.6/ReserveNow.json',
401 OCPP16IncomingRequestCommand
.CANCEL_RESERVATION
,
404 OCPP16ServiceUtils
.parseJsonSchemaFile
<OCPP16CancelReservationRequest
>(
405 'assets/json-schemas/ocpp/1.6/CancelReservation.json',
413 // Handle incoming request events
415 OCPP16IncomingRequestCommand
.REMOTE_START_TRANSACTION
,
417 chargingStation
: ChargingStation
,
418 request
: RemoteStartTransactionRequest
,
419 response
: GenericResponse
421 if (response
.status === GenericStatus
.Accepted
) {
422 const { connectorId
, idTag
} = request
423 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
424 chargingStation
.getConnectorStatus(connectorId
!)!.transactionRemoteStarted
= true
425 chargingStation
.ocppRequestService
426 .requestHandler
<Partial
<OCPP16StartTransactionRequest
>, OCPP16StartTransactionResponse
>(
428 OCPP16RequestCommand
.START_TRANSACTION
,
435 if (response
.idTagInfo
.status === OCPP16AuthorizationStatus
.ACCEPTED
) {
437 `${chargingStation.logPrefix()} Remote start transaction ACCEPTED on ${
438 chargingStation.stationInfo?.chargingStationId
439 }#${connectorId} for idTag '${idTag}'`
443 `${chargingStation.logPrefix()} Remote start transaction REJECTED on ${
444 chargingStation.stationInfo?.chargingStationId
445 }#${connectorId} for idTag '${idTag}'`
449 .catch((error
: unknown
) => {
451 `${chargingStation.logPrefix()} ${moduleName}.constructor: Remote start transaction error:`,
459 OCPP16IncomingRequestCommand
.REMOTE_STOP_TRANSACTION
,
461 chargingStation
: ChargingStation
,
462 request
: RemoteStopTransactionRequest
,
463 response
: GenericResponse
465 if (response
.status === GenericStatus
.Accepted
) {
466 const { transactionId
} = request
467 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
468 const connectorId
= chargingStation
.getConnectorIdByTransactionId(transactionId
)!
469 OCPP16ServiceUtils
.remoteStopTransaction(chargingStation
, connectorId
)
471 if (response
.status === GenericStatus
.Accepted
) {
473 `${chargingStation.logPrefix()} Remote stop transaction ACCEPTED on ${
474 chargingStation.stationInfo?.chargingStationId
475 }#${connectorId} for transaction '${transactionId}'`
479 `${chargingStation.logPrefix()} Remote stop transaction REJECTED on ${
480 chargingStation.stationInfo?.chargingStationId
481 }#${connectorId} for transaction '${transactionId}'`
485 .catch((error
: unknown
) => {
487 `${chargingStation.logPrefix()} ${moduleName}.constructor: Remote stop transaction error:`,
495 OCPP16IncomingRequestCommand
.TRIGGER_MESSAGE
,
497 chargingStation
: ChargingStation
,
498 request
: OCPP16TriggerMessageRequest
,
499 response
: OCPP16TriggerMessageResponse
501 if (response
.status !== OCPP16TriggerMessageStatus
.ACCEPTED
) {
504 const { requestedMessage
, connectorId
} = request
505 const errorHandler
= (error
: unknown
): void => {
507 `${chargingStation.logPrefix()} ${moduleName}.constructor: Trigger ${requestedMessage} error:`,
511 switch (requestedMessage
) {
512 case OCPP16MessageTrigger
.BootNotification
:
513 chargingStation
.ocppRequestService
515 OCPP16BootNotificationRequest
,
516 OCPP16BootNotificationResponse
517 >(chargingStation
, OCPP16RequestCommand
.BOOT_NOTIFICATION
, chargingStation
.bootNotificationRequest
as OCPP16BootNotificationRequest
, { skipBufferingOnError
: true, triggerMessage
: true })
520 case OCPP16MessageTrigger
.Heartbeat
:
521 chargingStation
.ocppRequestService
522 .requestHandler
<OCPP16HeartbeatRequest
, OCPP16HeartbeatResponse
>(
524 OCPP16RequestCommand
.HEARTBEAT
,
532 case OCPP16MessageTrigger
.StatusNotification
:
533 if (connectorId
!= null) {
534 chargingStation
.ocppRequestService
535 .requestHandler
<OCPP16StatusNotificationRequest
, OCPP16StatusNotificationResponse
>(
537 OCPP16RequestCommand
.STATUS_NOTIFICATION
,
540 errorCode
: OCPP16ChargePointErrorCode
.NO_ERROR
,
541 status: chargingStation
.getConnectorStatus(connectorId
)
542 ?.status as OCPP16ChargePointStatus
549 } else if (chargingStation
.hasEvses
) {
550 for (const evseStatus
of chargingStation
.evses
.values()) {
551 for (const [id
, connectorStatus
] of evseStatus
.connectors
) {
552 chargingStation
.ocppRequestService
554 OCPP16StatusNotificationRequest
,
555 OCPP16StatusNotificationResponse
558 OCPP16RequestCommand
.STATUS_NOTIFICATION
,
561 errorCode
: OCPP16ChargePointErrorCode
.NO_ERROR
,
562 status: connectorStatus
.status as OCPP16ChargePointStatus
572 for (const [id
, connectorStatus
] of chargingStation
.connectors
) {
573 chargingStation
.ocppRequestService
575 OCPP16StatusNotificationRequest
,
576 OCPP16StatusNotificationResponse
579 OCPP16RequestCommand
.STATUS_NOTIFICATION
,
582 errorCode
: OCPP16ChargePointErrorCode
.NO_ERROR
,
583 status: connectorStatus
.status as OCPP16ChargePointStatus
596 this.validatePayload
= this.validatePayload
.bind(this)
599 public async incomingRequestHandler
<ReqType
extends JsonType
, ResType
extends JsonType
>(
600 chargingStation
: ChargingStation
,
602 commandName
: OCPP16IncomingRequestCommand
,
603 commandPayload
: ReqType
605 let response
: ResType
607 chargingStation
.stationInfo
?.ocppStrictCompliance
=== true &&
608 chargingStation
.inPendingState() &&
609 (commandName
=== OCPP16IncomingRequestCommand
.REMOTE_START_TRANSACTION
||
610 commandName
=== OCPP16IncomingRequestCommand
.REMOTE_STOP_TRANSACTION
)
613 ErrorType
.SECURITY_ERROR
,
614 `${commandName} cannot be issued to handle request PDU ${JSON.stringify(
618 )} while the charging station is in pending state on the central server`,
624 chargingStation
.isRegistered() ||
625 (chargingStation
.stationInfo
?.ocppStrictCompliance
=== false &&
626 chargingStation
.inUnknownState())
629 this.incomingRequestHandlers
.has(commandName
) &&
630 OCPP16ServiceUtils
.isIncomingRequestCommandSupported(chargingStation
, commandName
)
633 this.validatePayload(chargingStation
, commandName
, commandPayload
)
634 // Call the method to build the response
635 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
636 const incomingRequestHandler
= this.incomingRequestHandlers
.get(commandName
)!
637 if (isAsyncFunction(incomingRequestHandler
)) {
638 response
= (await incomingRequestHandler(chargingStation
, commandPayload
)) as ResType
640 response
= incomingRequestHandler(chargingStation
, commandPayload
) as ResType
645 `${chargingStation.logPrefix()} ${moduleName}.incomingRequestHandler: Handle incoming request error:`,
653 ErrorType
.NOT_IMPLEMENTED
,
654 `${commandName} is not implemented to handle request PDU ${JSON.stringify(
665 ErrorType
.SECURITY_ERROR
,
666 `${commandName} cannot be issued to handle request PDU ${JSON.stringify(
670 )} while the charging station is not registered on the central server`,
675 // Send the built response
676 await chargingStation
.ocppRequestService
.sendResponse(
682 // Emit command name event to allow delayed handling
683 this.emit(commandName
, chargingStation
, commandPayload
, response
)
686 private validatePayload (
687 chargingStation
: ChargingStation
,
688 commandName
: OCPP16IncomingRequestCommand
,
689 commandPayload
: JsonType
691 if (this.payloadValidateFunctions
.has(commandName
)) {
692 return this.validateIncomingRequestPayload(chargingStation
, commandName
, commandPayload
)
695 `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema validation function found for command '${commandName}' PDU validation`
700 // Simulate charging station restart
701 private handleRequestReset (
702 chargingStation
: ChargingStation
,
703 commandPayload
: ResetRequest
705 const { type } = commandPayload
707 .reset(`${type}Reset` as OCPP16StopTransactionReason
)
708 .catch(Constants
.EMPTY_FUNCTION
)
710 `${chargingStation.logPrefix()} ${type} reset command received, simulating it. The station will be back online in ${formatDurationMilliSeconds(
711 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
712 chargingStation.stationInfo!.resetTime!
715 return OCPP16Constants
.OCPP_RESPONSE_ACCEPTED
718 private async handleRequestUnlockConnector (
719 chargingStation
: ChargingStation
,
720 commandPayload
: UnlockConnectorRequest
721 ): Promise
<UnlockConnectorResponse
> {
722 const { connectorId
} = commandPayload
723 if (!chargingStation
.hasConnector(connectorId
)) {
725 `${chargingStation.logPrefix()} Trying to unlock a non existing connector id ${connectorId}`
727 return OCPP16Constants
.OCPP_RESPONSE_UNLOCK_NOT_SUPPORTED
729 if (connectorId
=== 0) {
730 logger
.error(`${chargingStation.logPrefix()} Trying to unlock connector id ${connectorId}`)
731 return OCPP16Constants
.OCPP_RESPONSE_UNLOCK_NOT_SUPPORTED
733 if (chargingStation
.getConnectorStatus(connectorId
)?.transactionStarted
=== true) {
734 const stopResponse
= await chargingStation
.stopTransactionOnConnector(
736 OCPP16StopTransactionReason
.UNLOCK_COMMAND
738 if (stopResponse
.idTagInfo
?.status === OCPP16AuthorizationStatus
.ACCEPTED
) {
739 return OCPP16Constants
.OCPP_RESPONSE_UNLOCKED
741 return OCPP16Constants
.OCPP_RESPONSE_UNLOCK_FAILED
743 await OCPP16ServiceUtils
.sendAndSetConnectorStatus(
746 OCPP16ChargePointStatus
.Available
748 return OCPP16Constants
.OCPP_RESPONSE_UNLOCKED
751 private handleRequestGetConfiguration (
752 chargingStation
: ChargingStation
,
753 commandPayload
: GetConfigurationRequest
754 ): GetConfigurationResponse
{
755 const { key
} = commandPayload
756 const configurationKey
: OCPPConfigurationKey
[] = []
757 const unknownKey
: string[] = []
759 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
760 for (const configKey
of chargingStation
.ocppConfiguration
!.configurationKey
!) {
761 if (!OCPP16ServiceUtils
.isConfigurationKeyVisible(configKey
)) {
764 configurationKey
.push({
766 readonly: configKey
.readonly,
767 value
: configKey
.value
770 } else if (isNotEmptyArray(key
)) {
771 for (const k
of key
) {
772 const keyFound
= getConfigurationKey(chargingStation
, k
, true)
773 if (keyFound
!= null) {
774 if (!OCPP16ServiceUtils
.isConfigurationKeyVisible(keyFound
)) {
777 configurationKey
.push({
779 readonly: keyFound
.readonly,
780 value
: keyFound
.value
793 private handleRequestChangeConfiguration (
794 chargingStation
: ChargingStation
,
795 commandPayload
: ChangeConfigurationRequest
796 ): ChangeConfigurationResponse
{
797 const { key
, value
} = commandPayload
798 const keyToChange
= getConfigurationKey(chargingStation
, key
, true)
799 if (keyToChange
?.readonly === true) {
800 return OCPP16Constants
.OCPP_CONFIGURATION_RESPONSE_REJECTED
801 } else if (keyToChange
?.readonly === false) {
802 let valueChanged
= false
803 if (keyToChange
.value
!== value
) {
804 setConfigurationKeyValue(chargingStation
, key
, value
, true)
807 let triggerHeartbeatRestart
= false
809 (keyToChange
.key
as OCPP16StandardParametersKey
) ===
810 OCPP16StandardParametersKey
.HeartBeatInterval
&&
813 setConfigurationKeyValue(
815 OCPP16StandardParametersKey
.HeartbeatInterval
,
818 triggerHeartbeatRestart
= true
821 (keyToChange
.key
as OCPP16StandardParametersKey
) ===
822 OCPP16StandardParametersKey
.HeartbeatInterval
&&
825 setConfigurationKeyValue(
827 OCPP16StandardParametersKey
.HeartBeatInterval
,
830 triggerHeartbeatRestart
= true
832 if (triggerHeartbeatRestart
) {
833 chargingStation
.restartHeartbeat()
836 (keyToChange
.key
as OCPP16StandardParametersKey
) ===
837 OCPP16StandardParametersKey
.WebSocketPingInterval
&&
840 chargingStation
.restartWebSocketPing()
842 if (keyToChange
.reboot
=== true) {
843 return OCPP16Constants
.OCPP_CONFIGURATION_RESPONSE_REBOOT_REQUIRED
845 return OCPP16Constants
.OCPP_CONFIGURATION_RESPONSE_ACCEPTED
847 return OCPP16Constants
.OCPP_CONFIGURATION_RESPONSE_NOT_SUPPORTED
850 private handleRequestSetChargingProfile (
851 chargingStation
: ChargingStation
,
852 commandPayload
: SetChargingProfileRequest
853 ): SetChargingProfileResponse
{
855 !OCPP16ServiceUtils
.checkFeatureProfile(
857 OCPP16SupportedFeatureProfiles
.SmartCharging
,
858 OCPP16IncomingRequestCommand
.SET_CHARGING_PROFILE
861 return OCPP16Constants
.OCPP_SET_CHARGING_PROFILE_RESPONSE_NOT_SUPPORTED
863 const { connectorId
, csChargingProfiles
} = commandPayload
864 if (!chargingStation
.hasConnector(connectorId
)) {
866 `${chargingStation.logPrefix()} Trying to set charging profile(s) to a non existing connector id ${connectorId}`
868 return OCPP16Constants
.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED
871 csChargingProfiles
.chargingProfilePurpose
===
872 OCPP16ChargingProfilePurposeType
.CHARGE_POINT_MAX_PROFILE
&&
875 return OCPP16Constants
.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED
878 csChargingProfiles
.chargingProfilePurpose
=== OCPP16ChargingProfilePurposeType
.TX_PROFILE
&&
882 `${chargingStation.logPrefix()} Trying to set transaction charging profile(s) on connector ${connectorId}`
884 return OCPP16Constants
.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED
886 const connectorStatus
= chargingStation
.getConnectorStatus(connectorId
)
888 csChargingProfiles
.chargingProfilePurpose
=== OCPP16ChargingProfilePurposeType
.TX_PROFILE
&&
890 connectorStatus
?.transactionStarted
=== false
893 `${chargingStation.logPrefix()} Trying to set transaction charging profile(s) on connector ${connectorId} without a started transaction`
895 return OCPP16Constants
.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED
898 csChargingProfiles
.chargingProfilePurpose
=== OCPP16ChargingProfilePurposeType
.TX_PROFILE
&&
900 connectorStatus
?.transactionStarted
=== true &&
901 csChargingProfiles
.transactionId
!== connectorStatus
.transactionId
904 `${chargingStation.logPrefix()} Trying to set transaction charging profile(s) on connector ${connectorId} with a different transaction id ${
905 csChargingProfiles.transactionId
906 } than the started transaction id ${connectorStatus.transactionId}`
908 return OCPP16Constants
.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED
910 OCPP16ServiceUtils
.setChargingProfile(chargingStation
, connectorId
, csChargingProfiles
)
912 `${chargingStation.logPrefix()} Charging profile(s) set on connector id ${connectorId}: %j`,
915 return OCPP16Constants
.OCPP_SET_CHARGING_PROFILE_RESPONSE_ACCEPTED
918 private handleRequestGetCompositeSchedule (
919 chargingStation
: ChargingStation
,
920 commandPayload
: OCPP16GetCompositeScheduleRequest
921 ): OCPP16GetCompositeScheduleResponse
{
923 !OCPP16ServiceUtils
.checkFeatureProfile(
925 OCPP16SupportedFeatureProfiles
.SmartCharging
,
926 OCPP16IncomingRequestCommand
.GET_COMPOSITE_SCHEDULE
929 return OCPP16Constants
.OCPP_RESPONSE_REJECTED
931 const { connectorId
, duration
, chargingRateUnit
} = commandPayload
932 if (!chargingStation
.hasConnector(connectorId
)) {
934 `${chargingStation.logPrefix()} Trying to get composite schedule to a non existing connector id ${connectorId}`
936 return OCPP16Constants
.OCPP_RESPONSE_REJECTED
938 if (connectorId
=== 0) {
940 `${chargingStation.logPrefix()} Get composite schedule on connector id ${connectorId} is not yet supported`
942 return OCPP16Constants
.OCPP_RESPONSE_REJECTED
944 if (chargingRateUnit
!= null) {
946 `${chargingStation.logPrefix()} Get composite schedule with a specified rate unit is not yet supported, no conversion will be done`
949 const connectorStatus
= chargingStation
.getConnectorStatus(connectorId
)
951 isEmpty(connectorStatus
?.chargingProfiles
) &&
952 isEmpty(chargingStation
.getConnectorStatus(0)?.chargingProfiles
)
954 return OCPP16Constants
.OCPP_RESPONSE_REJECTED
956 const currentDate
= new Date()
957 const compositeScheduleInterval
: Interval
= {
959 end
: addSeconds(currentDate
, duration
)
961 // Get charging profiles sorted by connector id then stack level
962 const chargingProfiles
: OCPP16ChargingProfile
[] = getConnectorChargingProfiles(
966 let previousCompositeSchedule
: OCPP16ChargingSchedule
| undefined
967 let compositeSchedule
: OCPP16ChargingSchedule
| undefined
968 for (const chargingProfile
of chargingProfiles
) {
969 if (chargingProfile
.chargingSchedule
.startSchedule
== null) {
971 `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetCompositeSchedule: Charging profile id ${
972 chargingProfile.chargingProfileId
973 } has no startSchedule defined. Trying to set it to the connector current transaction start date`
975 // OCPP specifies that if startSchedule is not defined, it should be relative to start of the connector transaction
976 chargingProfile
.chargingSchedule
.startSchedule
= connectorStatus
?.transactionStart
978 if (!isDate(chargingProfile
.chargingSchedule
.startSchedule
)) {
980 `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetCompositeSchedule: Charging profile id ${
981 chargingProfile.chargingProfileId
982 } startSchedule property is not a Date instance. Trying to convert it to a Date instance`
984 chargingProfile
.chargingSchedule
.startSchedule
= convertToDate(
985 chargingProfile
.chargingSchedule
.startSchedule
988 if (chargingProfile
.chargingSchedule
.duration
== null) {
990 `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetCompositeSchedule: Charging profile id ${
991 chargingProfile.chargingProfileId
992 } has no duration defined and will be set to the maximum time allowed`
994 // OCPP specifies that if duration is not defined, it should be infinite
995 chargingProfile
.chargingSchedule
.duration
= differenceInSeconds(
997 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
998 chargingProfile
.chargingSchedule
.startSchedule
!
1002 !prepareChargingProfileKind(
1005 compositeScheduleInterval
.start
,
1006 chargingStation
.logPrefix()
1012 !canProceedChargingProfile(
1014 compositeScheduleInterval
.start
,
1015 chargingStation
.logPrefix()
1020 compositeSchedule
= OCPP16ServiceUtils
.composeChargingSchedules(
1021 previousCompositeSchedule
,
1022 chargingProfile
.chargingSchedule
,
1023 compositeScheduleInterval
1025 previousCompositeSchedule
= compositeSchedule
1027 if (compositeSchedule
!= null) {
1029 status: GenericStatus
.Accepted
,
1030 scheduleStart
: compositeSchedule
.startSchedule
,
1032 chargingSchedule
: compositeSchedule
1035 return OCPP16Constants
.OCPP_RESPONSE_REJECTED
1038 private handleRequestClearChargingProfile (
1039 chargingStation
: ChargingStation
,
1040 commandPayload
: OCPP16ClearChargingProfileRequest
1041 ): OCPP16ClearChargingProfileResponse
{
1043 !OCPP16ServiceUtils
.checkFeatureProfile(
1045 OCPP16SupportedFeatureProfiles
.SmartCharging
,
1046 OCPP16IncomingRequestCommand
.CLEAR_CHARGING_PROFILE
1049 return OCPP16Constants
.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN
1051 const { connectorId
} = commandPayload
1052 if (connectorId
!= null) {
1053 if (!chargingStation
.hasConnector(connectorId
)) {
1055 `${chargingStation.logPrefix()} Trying to clear a charging profile(s) to a non existing connector id ${connectorId}`
1057 return OCPP16Constants
.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN
1059 const connectorStatus
= chargingStation
.getConnectorStatus(connectorId
)
1060 if (isNotEmptyArray(connectorStatus
?.chargingProfiles
)) {
1061 connectorStatus
.chargingProfiles
= []
1063 `${chargingStation.logPrefix()} Charging profile(s) cleared on connector id ${connectorId}`
1065 return OCPP16Constants
.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_ACCEPTED
1068 let clearedCP
= false
1069 if (chargingStation
.hasEvses
) {
1070 for (const evseStatus
of chargingStation
.evses
.values()) {
1071 for (const status of evseStatus
.connectors
.values()) {
1072 const clearedConnectorCP
= OCPP16ServiceUtils
.clearChargingProfiles(
1075 status.chargingProfiles
1077 if (clearedConnectorCP
&& !clearedCP
) {
1083 for (const id
of chargingStation
.connectors
.keys()) {
1084 const clearedConnectorCP
= OCPP16ServiceUtils
.clearChargingProfiles(
1087 chargingStation
.getConnectorStatus(id
)?.chargingProfiles
1089 if (clearedConnectorCP
&& !clearedCP
) {
1095 return OCPP16Constants
.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_ACCEPTED
1098 return OCPP16Constants
.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN
1101 private async handleRequestChangeAvailability (
1102 chargingStation
: ChargingStation
,
1103 commandPayload
: OCPP16ChangeAvailabilityRequest
1104 ): Promise
<OCPP16ChangeAvailabilityResponse
> {
1105 const { connectorId
, type } = commandPayload
1106 if (!chargingStation
.hasConnector(connectorId
)) {
1108 `${chargingStation.logPrefix()} Trying to change the availability of a non existing connector id ${connectorId}`
1110 return OCPP16Constants
.OCPP_AVAILABILITY_RESPONSE_REJECTED
1112 const chargePointStatus
: OCPP16ChargePointStatus
=
1113 type === OCPP16AvailabilityType
.Operative
1114 ? OCPP16ChargePointStatus
.Available
1115 : OCPP16ChargePointStatus
.Unavailable
1116 if (connectorId
=== 0) {
1117 let response
: OCPP16ChangeAvailabilityResponse
| undefined
1118 if (chargingStation
.hasEvses
) {
1119 for (const evseStatus
of chargingStation
.evses
.values()) {
1120 response
= await OCPP16ServiceUtils
.changeAvailability(
1122 [...evseStatus
.connectors
.keys()],
1128 response
= await OCPP16ServiceUtils
.changeAvailability(
1130 [...chargingStation
.connectors
.keys()],
1135 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1139 (chargingStation
.isChargingStationAvailable() ||
1140 (!chargingStation
.isChargingStationAvailable() &&
1141 type === OCPP16AvailabilityType
.Inoperative
))
1143 if (chargingStation
.getConnectorStatus(connectorId
)?.transactionStarted
=== true) {
1144 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1145 chargingStation
.getConnectorStatus(connectorId
)!.availability
= type
1146 return OCPP16Constants
.OCPP_AVAILABILITY_RESPONSE_SCHEDULED
1148 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1149 chargingStation
.getConnectorStatus(connectorId
)!.availability
= type
1150 await OCPP16ServiceUtils
.sendAndSetConnectorStatus(
1155 return OCPP16Constants
.OCPP_AVAILABILITY_RESPONSE_ACCEPTED
1157 return OCPP16Constants
.OCPP_AVAILABILITY_RESPONSE_REJECTED
1160 private async handleRequestRemoteStartTransaction (
1161 chargingStation
: ChargingStation
,
1162 commandPayload
: RemoteStartTransactionRequest
1163 ): Promise
<GenericResponse
> {
1164 if (commandPayload
.connectorId
== null) {
1166 commandPayload
.connectorId
= randomInt(1, chargingStation
.getNumberOfConnectors())
1168 chargingStation
.getConnectorStatus(commandPayload
.connectorId
)?.transactionStarted
===
1170 OCPP16ServiceUtils
.hasReservation(
1172 commandPayload
.connectorId
,
1173 commandPayload
.idTag
1177 const { connectorId
: transactionConnectorId
, idTag
, chargingProfile
} = commandPayload
1178 if (!chargingStation
.hasConnector(transactionConnectorId
)) {
1179 return this.notifyRemoteStartTransactionRejected(
1181 transactionConnectorId
,
1186 !chargingStation
.isChargingStationAvailable() ||
1187 !chargingStation
.isConnectorAvailable(transactionConnectorId
)
1189 return this.notifyRemoteStartTransactionRejected(
1191 transactionConnectorId
,
1195 // idTag authorization check required
1197 chargingStation
.getAuthorizeRemoteTxRequests() &&
1198 !(await OCPP16ServiceUtils
.isIdTagAuthorized(chargingStation
, transactionConnectorId
, idTag
))
1200 return this.notifyRemoteStartTransactionRejected(
1202 transactionConnectorId
,
1207 chargingProfile
!= null &&
1208 !this.setRemoteStartTransactionChargingProfile(
1210 transactionConnectorId
,
1214 return this.notifyRemoteStartTransactionRejected(
1216 transactionConnectorId
,
1221 `${chargingStation.logPrefix()} Remote start transaction ACCEPTED on ${
1222 chargingStation.stationInfo?.chargingStationId
1223 }#${transactionConnectorId}}, idTag '${idTag}'`
1225 return OCPP16Constants
.OCPP_RESPONSE_ACCEPTED
1228 private notifyRemoteStartTransactionRejected (
1229 chargingStation
: ChargingStation
,
1230 connectorId
: number,
1232 ): GenericResponse
{
1233 const connectorStatus
= chargingStation
.getConnectorStatus(connectorId
)
1235 `${chargingStation.logPrefix()} Remote start transaction REJECTED on ${
1236 chargingStation.stationInfo?.chargingStationId
1237 }#${connectorId}, idTag '${idTag}', availability '${
1238 connectorStatus?.availability
1239 }', status '${connectorStatus?.status}'`
1241 return OCPP16Constants
.OCPP_RESPONSE_REJECTED
1244 private setRemoteStartTransactionChargingProfile (
1245 chargingStation
: ChargingStation
,
1246 connectorId
: number,
1247 chargingProfile
: OCPP16ChargingProfile
1249 if (chargingProfile
.chargingProfilePurpose
=== OCPP16ChargingProfilePurposeType
.TX_PROFILE
) {
1250 OCPP16ServiceUtils
.setChargingProfile(chargingStation
, connectorId
, chargingProfile
)
1252 `${chargingStation.logPrefix()} Charging profile(s) set at remote start transaction on ${
1253 chargingStation.stationInfo?.chargingStationId
1260 `${chargingStation.logPrefix()} Not allowed to set ${
1261 chargingProfile.chargingProfilePurpose
1262 } charging profile(s) at remote start transaction`
1267 private handleRequestRemoteStopTransaction (
1268 chargingStation
: ChargingStation
,
1269 commandPayload
: RemoteStopTransactionRequest
1270 ): GenericResponse
{
1271 const { transactionId
} = commandPayload
1272 if (chargingStation
.getConnectorIdByTransactionId(transactionId
) != null) {
1274 `${chargingStation.logPrefix()} Remote stop transaction ACCEPTED for transactionId '${transactionId}'`
1276 return OCPP16Constants
.OCPP_RESPONSE_ACCEPTED
1279 `${chargingStation.logPrefix()} Remote stop transaction REJECTED for transactionId '${transactionId}'`
1281 return OCPP16Constants
.OCPP_RESPONSE_REJECTED
1284 private handleRequestUpdateFirmware (
1285 chargingStation
: ChargingStation
,
1286 commandPayload
: OCPP16UpdateFirmwareRequest
1287 ): OCPP16UpdateFirmwareResponse
{
1289 !OCPP16ServiceUtils
.checkFeatureProfile(
1291 OCPP16SupportedFeatureProfiles
.FirmwareManagement
,
1292 OCPP16IncomingRequestCommand
.UPDATE_FIRMWARE
1296 `${chargingStation.logPrefix()} ${moduleName}.handleRequestUpdateFirmware: Cannot simulate firmware update: feature profile not supported`
1298 return OCPP16Constants
.OCPP_RESPONSE_EMPTY
1300 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1301 commandPayload
.retrieveDate
= convertToDate(commandPayload
.retrieveDate
)!
1302 const { retrieveDate
} = commandPayload
1304 chargingStation
.stationInfo
?.firmwareStatus
!= null &&
1305 chargingStation
.stationInfo
.firmwareStatus
!== OCPP16FirmwareStatus
.Installed
1308 `${chargingStation.logPrefix()} ${moduleName}.handleRequestUpdateFirmware: Cannot simulate firmware update: firmware update is already in progress`
1310 return OCPP16Constants
.OCPP_RESPONSE_EMPTY
1312 const now
= Date.now()
1313 if (retrieveDate
.getTime() <= now
) {
1314 this.updateFirmwareSimulation(chargingStation
).catch(Constants
.EMPTY_FUNCTION
)
1317 this.updateFirmwareSimulation(chargingStation
).catch(Constants
.EMPTY_FUNCTION
)
1318 }, retrieveDate
.getTime() - now
)
1320 return OCPP16Constants
.OCPP_RESPONSE_EMPTY
1323 private async updateFirmwareSimulation (
1324 chargingStation
: ChargingStation
,
1328 if (!checkChargingStation(chargingStation
, chargingStation
.logPrefix())) {
1331 if (chargingStation
.hasEvses
) {
1332 for (const [evseId
, evseStatus
] of chargingStation
.evses
) {
1334 for (const [connectorId
, connectorStatus
] of evseStatus
.connectors
) {
1335 if (connectorStatus
.transactionStarted
=== false) {
1336 await OCPP16ServiceUtils
.sendAndSetConnectorStatus(
1339 OCPP16ChargePointStatus
.Unavailable
1346 for (const connectorId
of chargingStation
.connectors
.keys()) {
1349 chargingStation
.getConnectorStatus(connectorId
)?.transactionStarted
=== false
1351 await OCPP16ServiceUtils
.sendAndSetConnectorStatus(
1354 OCPP16ChargePointStatus
.Unavailable
1359 await chargingStation
.ocppRequestService
.requestHandler
<
1360 OCPP16FirmwareStatusNotificationRequest
,
1361 OCPP16FirmwareStatusNotificationResponse
1362 >(chargingStation
, OCPP16RequestCommand
.FIRMWARE_STATUS_NOTIFICATION
, {
1363 status: OCPP16FirmwareStatus
.Downloading
1365 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1366 chargingStation
.stationInfo
!.firmwareStatus
= OCPP16FirmwareStatus
.Downloading
1368 chargingStation
.stationInfo
?.firmwareUpgrade
?.failureStatus
===
1369 OCPP16FirmwareStatus
.DownloadFailed
1371 await sleep(secondsToMilliseconds(randomInt(minDelay
, maxDelay
)))
1372 await chargingStation
.ocppRequestService
.requestHandler
<
1373 OCPP16FirmwareStatusNotificationRequest
,
1374 OCPP16FirmwareStatusNotificationResponse
1375 >(chargingStation
, OCPP16RequestCommand
.FIRMWARE_STATUS_NOTIFICATION
, {
1376 status: chargingStation
.stationInfo
.firmwareUpgrade
.failureStatus
1378 chargingStation
.stationInfo
.firmwareStatus
=
1379 chargingStation
.stationInfo
.firmwareUpgrade
.failureStatus
1382 await sleep(secondsToMilliseconds(randomInt(minDelay
, maxDelay
)))
1383 await chargingStation
.ocppRequestService
.requestHandler
<
1384 OCPP16FirmwareStatusNotificationRequest
,
1385 OCPP16FirmwareStatusNotificationResponse
1386 >(chargingStation
, OCPP16RequestCommand
.FIRMWARE_STATUS_NOTIFICATION
, {
1387 status: OCPP16FirmwareStatus
.Downloaded
1389 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1390 chargingStation
.stationInfo
!.firmwareStatus
= OCPP16FirmwareStatus
.Downloaded
1391 let wasTransactionsStarted
= false
1392 let transactionsStarted
: boolean
1394 const runningTransactions
= chargingStation
.getNumberOfRunningTransactions()
1395 if (runningTransactions
> 0) {
1396 const waitTime
= secondsToMilliseconds(15)
1398 `${chargingStation.logPrefix()} ${moduleName}.updateFirmwareSimulation: ${runningTransactions} transaction(s) in progress, waiting ${formatDurationMilliSeconds(
1400 )} before continuing firmware update simulation`
1402 await sleep(waitTime
)
1403 transactionsStarted
= true
1404 wasTransactionsStarted
= true
1406 if (chargingStation
.hasEvses
) {
1407 for (const [evseId
, evseStatus
] of chargingStation
.evses
) {
1409 for (const [connectorId
, connectorStatus
] of evseStatus
.connectors
) {
1410 if (connectorStatus
.status !== OCPP16ChargePointStatus
.Unavailable
) {
1411 await OCPP16ServiceUtils
.sendAndSetConnectorStatus(
1414 OCPP16ChargePointStatus
.Unavailable
1421 for (const connectorId
of chargingStation
.connectors
.keys()) {
1424 chargingStation
.getConnectorStatus(connectorId
)?.status !==
1425 OCPP16ChargePointStatus
.Unavailable
1427 await OCPP16ServiceUtils
.sendAndSetConnectorStatus(
1430 OCPP16ChargePointStatus
.Unavailable
1435 transactionsStarted
= false
1437 } while (transactionsStarted
)
1438 !wasTransactionsStarted
&& (await sleep(secondsToMilliseconds(randomInt(minDelay
, maxDelay
))))
1439 if (!checkChargingStation(chargingStation
, chargingStation
.logPrefix())) {
1442 await chargingStation
.ocppRequestService
.requestHandler
<
1443 OCPP16FirmwareStatusNotificationRequest
,
1444 OCPP16FirmwareStatusNotificationResponse
1445 >(chargingStation
, OCPP16RequestCommand
.FIRMWARE_STATUS_NOTIFICATION
, {
1446 status: OCPP16FirmwareStatus
.Installing
1448 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1449 chargingStation
.stationInfo
!.firmwareStatus
= OCPP16FirmwareStatus
.Installing
1451 chargingStation
.stationInfo
?.firmwareUpgrade
?.failureStatus
===
1452 OCPP16FirmwareStatus
.InstallationFailed
1454 await sleep(secondsToMilliseconds(randomInt(minDelay
, maxDelay
)))
1455 await chargingStation
.ocppRequestService
.requestHandler
<
1456 OCPP16FirmwareStatusNotificationRequest
,
1457 OCPP16FirmwareStatusNotificationResponse
1458 >(chargingStation
, OCPP16RequestCommand
.FIRMWARE_STATUS_NOTIFICATION
, {
1459 status: chargingStation
.stationInfo
.firmwareUpgrade
.failureStatus
1461 chargingStation
.stationInfo
.firmwareStatus
=
1462 chargingStation
.stationInfo
.firmwareUpgrade
.failureStatus
1465 if (chargingStation
.stationInfo
?.firmwareUpgrade
?.reset
=== true) {
1466 await sleep(secondsToMilliseconds(randomInt(minDelay
, maxDelay
)))
1467 await chargingStation
.reset(OCPP16StopTransactionReason
.REBOOT
)
1471 private async handleRequestGetDiagnostics (
1472 chargingStation
: ChargingStation
,
1473 commandPayload
: GetDiagnosticsRequest
1474 ): Promise
<GetDiagnosticsResponse
> {
1476 !OCPP16ServiceUtils
.checkFeatureProfile(
1478 OCPP16SupportedFeatureProfiles
.FirmwareManagement
,
1479 OCPP16IncomingRequestCommand
.GET_DIAGNOSTICS
1483 `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetDiagnostics: Cannot get diagnostics: feature profile not supported`
1485 return OCPP16Constants
.OCPP_RESPONSE_EMPTY
1487 const { location
} = commandPayload
1488 const uri
= new URL(location
)
1489 if (uri
.protocol
.startsWith('ftp:')) {
1490 let ftpClient
: Client
| undefined
1492 const logConfiguration
= Configuration
.getConfigurationSection
<LogConfiguration
>(
1493 ConfigurationSection
.log
1495 const logFiles
= readdirSync(
1496 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1497 resolve((fileURLToPath(import.meta
.url
), '../', dirname(logConfiguration
.file
!)))
1499 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1500 .filter(file
=> file
.endsWith(extname(logConfiguration
.file
!)))
1501 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1502 .map(file
=> join(dirname(logConfiguration
.file
!), file
))
1503 const diagnosticsArchive
= `${chargingStation.stationInfo?.chargingStationId}_logs.tar.gz`
1504 create({ gzip
: true }, logFiles
).pipe(createWriteStream(diagnosticsArchive
))
1505 ftpClient
= new Client()
1506 const accessResponse
= await ftpClient
.access({
1508 ...(isNotEmptyString(uri
.port
) && { port
: convertToInt(uri
.port
) }),
1509 ...(isNotEmptyString(uri
.username
) && { user
: uri
.username
}),
1510 ...(isNotEmptyString(uri
.password
) && { password
: uri
.password
})
1512 let uploadResponse
: FTPResponse
| undefined
1513 if (accessResponse
.code
=== 220) {
1514 ftpClient
.trackProgress(info
=> {
1516 `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetDiagnostics: ${
1518 } bytes transferred from diagnostics archive ${info.name}`
1520 chargingStation
.ocppRequestService
1522 OCPP16DiagnosticsStatusNotificationRequest
,
1523 OCPP16DiagnosticsStatusNotificationResponse
1524 >(chargingStation
, OCPP16RequestCommand
.DIAGNOSTICS_STATUS_NOTIFICATION
, {
1525 status: OCPP16DiagnosticsStatus
.Uploading
1527 .catch((error
: unknown
) => {
1529 `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetDiagnostics: Error while sending '${
1530 OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION
1536 uploadResponse
= await ftpClient
.uploadFrom(
1537 join(resolve(dirname(fileURLToPath(import.meta
.url
)), '../'), diagnosticsArchive
),
1538 `${uri.pathname}${diagnosticsArchive}`
1540 if (uploadResponse
.code
=== 226) {
1541 await chargingStation
.ocppRequestService
.requestHandler
<
1542 OCPP16DiagnosticsStatusNotificationRequest
,
1543 OCPP16DiagnosticsStatusNotificationResponse
1544 >(chargingStation
, OCPP16RequestCommand
.DIAGNOSTICS_STATUS_NOTIFICATION
, {
1545 status: OCPP16DiagnosticsStatus
.Uploaded
1548 return { fileName
: diagnosticsArchive
}
1550 throw new OCPPError(
1551 ErrorType
.GENERIC_ERROR
,
1552 `Diagnostics transfer failed with error code ${accessResponse.code}|${uploadResponse.code}`,
1553 OCPP16IncomingRequestCommand
.GET_DIAGNOSTICS
1556 throw new OCPPError(
1557 ErrorType
.GENERIC_ERROR
,
1558 `Diagnostics transfer failed with error code ${accessResponse.code}|${uploadResponse?.code}`,
1559 OCPP16IncomingRequestCommand
.GET_DIAGNOSTICS
1562 await chargingStation
.ocppRequestService
.requestHandler
<
1563 OCPP16DiagnosticsStatusNotificationRequest
,
1564 OCPP16DiagnosticsStatusNotificationResponse
1565 >(chargingStation
, OCPP16RequestCommand
.DIAGNOSTICS_STATUS_NOTIFICATION
, {
1566 status: OCPP16DiagnosticsStatus
.UploadFailed
1569 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1570 return this.handleIncomingRequestError
<GetDiagnosticsResponse
>(
1572 OCPP16IncomingRequestCommand
.GET_DIAGNOSTICS
,
1574 { errorResponse
: OCPP16Constants
.OCPP_RESPONSE_EMPTY
}
1579 `${chargingStation.logPrefix()} Unsupported protocol ${
1581 } to transfer the diagnostic logs archive`
1583 await chargingStation
.ocppRequestService
.requestHandler
<
1584 OCPP16DiagnosticsStatusNotificationRequest
,
1585 OCPP16DiagnosticsStatusNotificationResponse
1586 >(chargingStation
, OCPP16RequestCommand
.DIAGNOSTICS_STATUS_NOTIFICATION
, {
1587 status: OCPP16DiagnosticsStatus
.UploadFailed
1589 return OCPP16Constants
.OCPP_RESPONSE_EMPTY
1593 private handleRequestTriggerMessage (
1594 chargingStation
: ChargingStation
,
1595 commandPayload
: OCPP16TriggerMessageRequest
1596 ): OCPP16TriggerMessageResponse
{
1597 const { requestedMessage
, connectorId
} = commandPayload
1599 !OCPP16ServiceUtils
.checkFeatureProfile(
1601 OCPP16SupportedFeatureProfiles
.RemoteTrigger
,
1602 OCPP16IncomingRequestCommand
.TRIGGER_MESSAGE
1604 !OCPP16ServiceUtils
.isMessageTriggerSupported(chargingStation
, requestedMessage
)
1606 return OCPP16Constants
.OCPP_TRIGGER_MESSAGE_RESPONSE_NOT_IMPLEMENTED
1609 !OCPP16ServiceUtils
.isConnectorIdValid(
1611 OCPP16IncomingRequestCommand
.TRIGGER_MESSAGE
,
1612 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1616 return OCPP16Constants
.OCPP_TRIGGER_MESSAGE_RESPONSE_REJECTED
1618 switch (requestedMessage
) {
1619 case OCPP16MessageTrigger
.BootNotification
:
1620 case OCPP16MessageTrigger
.Heartbeat
:
1621 case OCPP16MessageTrigger
.StatusNotification
:
1622 return OCPP16Constants
.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED
1624 return OCPP16Constants
.OCPP_TRIGGER_MESSAGE_RESPONSE_NOT_IMPLEMENTED
1628 private handleRequestDataTransfer (
1629 chargingStation
: ChargingStation
,
1630 commandPayload
: OCPP16DataTransferRequest
1631 ): OCPP16DataTransferResponse
{
1632 const { vendorId
} = commandPayload
1634 if (Object.values(OCPP16DataTransferVendorId
).includes(vendorId
)) {
1635 return OCPP16Constants
.OCPP_DATA_TRANSFER_RESPONSE_ACCEPTED
1637 return OCPP16Constants
.OCPP_DATA_TRANSFER_RESPONSE_UNKNOWN_VENDOR_ID
1639 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1640 return this.handleIncomingRequestError
<OCPP16DataTransferResponse
>(
1642 OCPP16IncomingRequestCommand
.DATA_TRANSFER
,
1644 { errorResponse
: OCPP16Constants
.OCPP_DATA_TRANSFER_RESPONSE_REJECTED
}
1649 private async handleRequestReserveNow (
1650 chargingStation
: ChargingStation
,
1651 commandPayload
: OCPP16ReserveNowRequest
1652 ): Promise
<OCPP16ReserveNowResponse
> {
1654 !OCPP16ServiceUtils
.checkFeatureProfile(
1656 OCPP16SupportedFeatureProfiles
.Reservation
,
1657 OCPP16IncomingRequestCommand
.RESERVE_NOW
1660 return OCPP16Constants
.OCPP_RESERVATION_RESPONSE_REJECTED
1662 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1663 commandPayload
.expiryDate
= convertToDate(commandPayload
.expiryDate
)!
1664 const { reservationId
, idTag
, connectorId
} = commandPayload
1665 if (!chargingStation
.hasConnector(connectorId
)) {
1667 `${chargingStation.logPrefix()} Trying to reserve a non existing connector id ${connectorId}`
1669 return OCPP16Constants
.OCPP_RESERVATION_RESPONSE_REJECTED
1671 if (connectorId
> 0 && !chargingStation
.isConnectorAvailable(connectorId
)) {
1672 return OCPP16Constants
.OCPP_RESERVATION_RESPONSE_REJECTED
1674 if (connectorId
=== 0 && !chargingStation
.getReserveConnectorZeroSupported()) {
1675 return OCPP16Constants
.OCPP_RESERVATION_RESPONSE_REJECTED
1677 if (!(await OCPP16ServiceUtils
.isIdTagAuthorized(chargingStation
, connectorId
, idTag
))) {
1678 return OCPP16Constants
.OCPP_RESERVATION_RESPONSE_REJECTED
1680 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1681 const connectorStatus
= chargingStation
.getConnectorStatus(connectorId
)!
1682 resetAuthorizeConnectorStatus(connectorStatus
)
1683 let response
: OCPP16ReserveNowResponse
1685 await removeExpiredReservations(chargingStation
)
1686 switch (connectorStatus
.status) {
1687 case OCPP16ChargePointStatus
.Faulted
:
1688 response
= OCPP16Constants
.OCPP_RESERVATION_RESPONSE_FAULTED
1690 case OCPP16ChargePointStatus
.Preparing
:
1691 case OCPP16ChargePointStatus
.Charging
:
1692 case OCPP16ChargePointStatus
.SuspendedEV
:
1693 case OCPP16ChargePointStatus
.SuspendedEVSE
:
1694 case OCPP16ChargePointStatus
.Finishing
:
1695 response
= OCPP16Constants
.OCPP_RESERVATION_RESPONSE_OCCUPIED
1697 case OCPP16ChargePointStatus
.Unavailable
:
1698 response
= OCPP16Constants
.OCPP_RESERVATION_RESPONSE_UNAVAILABLE
1700 case OCPP16ChargePointStatus
.Reserved
:
1701 if (!chargingStation
.isConnectorReservable(reservationId
, idTag
, connectorId
)) {
1702 response
= OCPP16Constants
.OCPP_RESERVATION_RESPONSE_OCCUPIED
1705 // eslint-disable-next-line no-fallthrough
1707 if (!chargingStation
.isConnectorReservable(reservationId
, idTag
)) {
1708 response
= OCPP16Constants
.OCPP_RESERVATION_RESPONSE_OCCUPIED
1711 await chargingStation
.addReservation({
1712 id
: commandPayload
.reservationId
,
1715 response
= OCPP16Constants
.OCPP_RESERVATION_RESPONSE_ACCEPTED
1720 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1721 chargingStation
.getConnectorStatus(connectorId
)!.status = OCPP16ChargePointStatus
.Available
1722 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1723 return this.handleIncomingRequestError
<OCPP16ReserveNowResponse
>(
1725 OCPP16IncomingRequestCommand
.RESERVE_NOW
,
1727 { errorResponse
: OCPP16Constants
.OCPP_RESERVATION_RESPONSE_FAULTED
}
1732 private async handleRequestCancelReservation (
1733 chargingStation
: ChargingStation
,
1734 commandPayload
: OCPP16CancelReservationRequest
1735 ): Promise
<GenericResponse
> {
1737 !OCPP16ServiceUtils
.checkFeatureProfile(
1739 OCPP16SupportedFeatureProfiles
.Reservation
,
1740 OCPP16IncomingRequestCommand
.CANCEL_RESERVATION
1743 return OCPP16Constants
.OCPP_CANCEL_RESERVATION_RESPONSE_REJECTED
1746 const { reservationId
} = commandPayload
1747 const reservation
= chargingStation
.getReservationBy('reservationId', reservationId
)
1748 if (reservation
== null) {
1750 `${chargingStation.logPrefix()} Reservation with id ${reservationId} does not exist on charging station`
1752 return OCPP16Constants
.OCPP_CANCEL_RESERVATION_RESPONSE_REJECTED
1754 await chargingStation
.removeReservation(
1756 ReservationTerminationReason
.RESERVATION_CANCELED
1758 return OCPP16Constants
.OCPP_CANCEL_RESERVATION_RESPONSE_ACCEPTED
1760 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1761 return this.handleIncomingRequestError
<GenericResponse
>(
1763 OCPP16IncomingRequestCommand
.CANCEL_RESERVATION
,
1766 errorResponse
: OCPP16Constants
.OCPP_CANCEL_RESERVATION_RESPONSE_REJECTED