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
,
109 handleIncomingRequestError
,
115 } from
'../../../utils/index.js'
116 import { OCPPIncomingRequestService
} from
'../OCPPIncomingRequestService.js'
117 import { OCPP16Constants
} from
'./OCPP16Constants.js'
118 import { OCPP16ServiceUtils
} from
'./OCPP16ServiceUtils.js'
120 const moduleName
= 'OCPP16IncomingRequestService'
122 export class OCPP16IncomingRequestService
extends OCPPIncomingRequestService
{
123 protected payloadValidateFunctions
: Map
<OCPP16IncomingRequestCommand
, ValidateFunction
<JsonType
>>
125 private readonly incomingRequestHandlers
: Map
<
126 OCPP16IncomingRequestCommand
,
127 IncomingRequestHandler
130 public constructor () {
131 // if (new.target.name === moduleName) {
132 // throw new TypeError(`Cannot construct ${new.target.name} instances directly`)
134 super(OCPPVersion
.VERSION_16
)
135 this.incomingRequestHandlers
= new Map
<OCPP16IncomingRequestCommand
, IncomingRequestHandler
>([
137 OCPP16IncomingRequestCommand
.RESET
,
138 this.handleRequestReset
.bind(this) as unknown
as IncomingRequestHandler
141 OCPP16IncomingRequestCommand
.CLEAR_CACHE
,
142 this.handleRequestClearCache
.bind(this) as IncomingRequestHandler
145 OCPP16IncomingRequestCommand
.UNLOCK_CONNECTOR
,
146 this.handleRequestUnlockConnector
.bind(this) as unknown
as IncomingRequestHandler
149 OCPP16IncomingRequestCommand
.GET_CONFIGURATION
,
150 this.handleRequestGetConfiguration
.bind(this) as IncomingRequestHandler
153 OCPP16IncomingRequestCommand
.CHANGE_CONFIGURATION
,
154 this.handleRequestChangeConfiguration
.bind(this) as unknown
as IncomingRequestHandler
157 OCPP16IncomingRequestCommand
.GET_COMPOSITE_SCHEDULE
,
158 this.handleRequestGetCompositeSchedule
.bind(this) as unknown
as IncomingRequestHandler
161 OCPP16IncomingRequestCommand
.SET_CHARGING_PROFILE
,
162 this.handleRequestSetChargingProfile
.bind(this) as unknown
as IncomingRequestHandler
165 OCPP16IncomingRequestCommand
.CLEAR_CHARGING_PROFILE
,
166 this.handleRequestClearChargingProfile
.bind(this) as IncomingRequestHandler
169 OCPP16IncomingRequestCommand
.CHANGE_AVAILABILITY
,
170 this.handleRequestChangeAvailability
.bind(this) as unknown
as IncomingRequestHandler
173 OCPP16IncomingRequestCommand
.REMOTE_START_TRANSACTION
,
174 this.handleRequestRemoteStartTransaction
.bind(this) as unknown
as IncomingRequestHandler
177 OCPP16IncomingRequestCommand
.REMOTE_STOP_TRANSACTION
,
178 this.handleRequestRemoteStopTransaction
.bind(this) as unknown
as IncomingRequestHandler
181 OCPP16IncomingRequestCommand
.GET_DIAGNOSTICS
,
182 this.handleRequestGetDiagnostics
.bind(this) as IncomingRequestHandler
185 OCPP16IncomingRequestCommand
.TRIGGER_MESSAGE
,
186 this.handleRequestTriggerMessage
.bind(this) as unknown
as IncomingRequestHandler
189 OCPP16IncomingRequestCommand
.DATA_TRANSFER
,
190 this.handleRequestDataTransfer
.bind(this) as unknown
as IncomingRequestHandler
193 OCPP16IncomingRequestCommand
.UPDATE_FIRMWARE
,
194 this.handleRequestUpdateFirmware
.bind(this) as unknown
as IncomingRequestHandler
197 OCPP16IncomingRequestCommand
.RESERVE_NOW
,
198 this.handleRequestReserveNow
.bind(this) as unknown
as IncomingRequestHandler
201 OCPP16IncomingRequestCommand
.CANCEL_RESERVATION
,
202 this.handleRequestCancelReservation
.bind(this) as unknown
as IncomingRequestHandler
205 this.payloadValidateFunctions
= new Map
<
206 OCPP16IncomingRequestCommand
,
207 ValidateFunction
<JsonType
>
210 OCPP16IncomingRequestCommand
.RESET
,
213 OCPP16ServiceUtils
.parseJsonSchemaFile
<ResetRequest
>(
214 'assets/json-schemas/ocpp/1.6/Reset.json',
222 OCPP16IncomingRequestCommand
.CLEAR_CACHE
,
225 OCPP16ServiceUtils
.parseJsonSchemaFile
<OCPP16ClearCacheRequest
>(
226 'assets/json-schemas/ocpp/1.6/ClearCache.json',
234 OCPP16IncomingRequestCommand
.UNLOCK_CONNECTOR
,
237 OCPP16ServiceUtils
.parseJsonSchemaFile
<UnlockConnectorRequest
>(
238 'assets/json-schemas/ocpp/1.6/UnlockConnector.json',
246 OCPP16IncomingRequestCommand
.GET_CONFIGURATION
,
249 OCPP16ServiceUtils
.parseJsonSchemaFile
<GetConfigurationRequest
>(
250 'assets/json-schemas/ocpp/1.6/GetConfiguration.json',
258 OCPP16IncomingRequestCommand
.CHANGE_CONFIGURATION
,
261 OCPP16ServiceUtils
.parseJsonSchemaFile
<ChangeConfigurationRequest
>(
262 'assets/json-schemas/ocpp/1.6/ChangeConfiguration.json',
270 OCPP16IncomingRequestCommand
.GET_DIAGNOSTICS
,
273 OCPP16ServiceUtils
.parseJsonSchemaFile
<GetDiagnosticsRequest
>(
274 'assets/json-schemas/ocpp/1.6/GetDiagnostics.json',
282 OCPP16IncomingRequestCommand
.GET_COMPOSITE_SCHEDULE
,
285 OCPP16ServiceUtils
.parseJsonSchemaFile
<OCPP16GetCompositeScheduleRequest
>(
286 'assets/json-schemas/ocpp/1.6/GetCompositeSchedule.json',
294 OCPP16IncomingRequestCommand
.SET_CHARGING_PROFILE
,
297 OCPP16ServiceUtils
.parseJsonSchemaFile
<SetChargingProfileRequest
>(
298 'assets/json-schemas/ocpp/1.6/SetChargingProfile.json',
306 OCPP16IncomingRequestCommand
.CLEAR_CHARGING_PROFILE
,
309 OCPP16ServiceUtils
.parseJsonSchemaFile
<OCPP16ClearChargingProfileRequest
>(
310 'assets/json-schemas/ocpp/1.6/ClearChargingProfile.json',
318 OCPP16IncomingRequestCommand
.CHANGE_AVAILABILITY
,
321 OCPP16ServiceUtils
.parseJsonSchemaFile
<OCPP16ChangeAvailabilityRequest
>(
322 'assets/json-schemas/ocpp/1.6/ChangeAvailability.json',
330 OCPP16IncomingRequestCommand
.REMOTE_START_TRANSACTION
,
333 OCPP16ServiceUtils
.parseJsonSchemaFile
<RemoteStartTransactionRequest
>(
334 'assets/json-schemas/ocpp/1.6/RemoteStartTransaction.json',
342 OCPP16IncomingRequestCommand
.REMOTE_STOP_TRANSACTION
,
345 OCPP16ServiceUtils
.parseJsonSchemaFile
<RemoteStopTransactionRequest
>(
346 'assets/json-schemas/ocpp/1.6/RemoteStopTransaction.json',
354 OCPP16IncomingRequestCommand
.TRIGGER_MESSAGE
,
357 OCPP16ServiceUtils
.parseJsonSchemaFile
<OCPP16TriggerMessageRequest
>(
358 'assets/json-schemas/ocpp/1.6/TriggerMessage.json',
366 OCPP16IncomingRequestCommand
.DATA_TRANSFER
,
369 OCPP16ServiceUtils
.parseJsonSchemaFile
<OCPP16DataTransferRequest
>(
370 'assets/json-schemas/ocpp/1.6/DataTransfer.json',
378 OCPP16IncomingRequestCommand
.UPDATE_FIRMWARE
,
381 OCPP16ServiceUtils
.parseJsonSchemaFile
<OCPP16UpdateFirmwareRequest
>(
382 'assets/json-schemas/ocpp/1.6/UpdateFirmware.json',
390 OCPP16IncomingRequestCommand
.RESERVE_NOW
,
393 OCPP16ServiceUtils
.parseJsonSchemaFile
<OCPP16ReserveNowRequest
>(
394 'assets/json-schemas/ocpp/1.6/ReserveNow.json',
402 OCPP16IncomingRequestCommand
.CANCEL_RESERVATION
,
405 OCPP16ServiceUtils
.parseJsonSchemaFile
<OCPP16CancelReservationRequest
>(
406 'assets/json-schemas/ocpp/1.6/CancelReservation.json',
414 // Handle incoming request events
416 OCPP16IncomingRequestCommand
.REMOTE_START_TRANSACTION
,
418 chargingStation
: ChargingStation
,
419 request
: RemoteStartTransactionRequest
,
420 response
: GenericResponse
422 if (response
.status === GenericStatus
.Accepted
) {
423 const { connectorId
, idTag
} = request
424 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
425 chargingStation
.getConnectorStatus(connectorId
!)!.transactionRemoteStarted
= true
426 chargingStation
.ocppRequestService
427 .requestHandler
<Partial
<OCPP16StartTransactionRequest
>, OCPP16StartTransactionResponse
>(
429 OCPP16RequestCommand
.START_TRANSACTION
,
436 if (response
.idTagInfo
.status === OCPP16AuthorizationStatus
.ACCEPTED
) {
438 `${chargingStation.logPrefix()} Remote start transaction ACCEPTED on ${
439 chargingStation.stationInfo?.chargingStationId
440 }#${connectorId} for idTag '${idTag}'`
444 `${chargingStation.logPrefix()} Remote start transaction REJECTED on ${
445 chargingStation.stationInfo?.chargingStationId
446 }#${connectorId} for idTag '${idTag}'`
450 .catch((error
: unknown
) => {
452 `${chargingStation.logPrefix()} ${moduleName}.constructor: Remote start transaction error:`,
460 OCPP16IncomingRequestCommand
.REMOTE_STOP_TRANSACTION
,
462 chargingStation
: ChargingStation
,
463 request
: RemoteStopTransactionRequest
,
464 response
: GenericResponse
466 if (response
.status === GenericStatus
.Accepted
) {
467 const { transactionId
} = request
468 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
469 const connectorId
= chargingStation
.getConnectorIdByTransactionId(transactionId
)!
470 OCPP16ServiceUtils
.remoteStopTransaction(chargingStation
, connectorId
)
472 if (response
.status === GenericStatus
.Accepted
) {
474 `${chargingStation.logPrefix()} Remote stop transaction ACCEPTED on ${
475 chargingStation.stationInfo?.chargingStationId
476 }#${connectorId} for transaction '${transactionId}'`
480 `${chargingStation.logPrefix()} Remote stop transaction REJECTED on ${
481 chargingStation.stationInfo?.chargingStationId
482 }#${connectorId} for transaction '${transactionId}'`
486 .catch((error
: unknown
) => {
488 `${chargingStation.logPrefix()} ${moduleName}.constructor: Remote stop transaction error:`,
496 OCPP16IncomingRequestCommand
.TRIGGER_MESSAGE
,
498 chargingStation
: ChargingStation
,
499 request
: OCPP16TriggerMessageRequest
,
500 response
: OCPP16TriggerMessageResponse
502 if (response
.status !== OCPP16TriggerMessageStatus
.ACCEPTED
) {
505 const { requestedMessage
, connectorId
} = request
506 const errorHandler
= (error
: unknown
): void => {
508 `${chargingStation.logPrefix()} ${moduleName}.constructor: Trigger ${requestedMessage} error:`,
512 switch (requestedMessage
) {
513 case OCPP16MessageTrigger
.BootNotification
:
514 chargingStation
.ocppRequestService
516 OCPP16BootNotificationRequest
,
517 OCPP16BootNotificationResponse
518 >(chargingStation
, OCPP16RequestCommand
.BOOT_NOTIFICATION
, chargingStation
.bootNotificationRequest
as OCPP16BootNotificationRequest
, { skipBufferingOnError
: true, triggerMessage
: true })
521 case OCPP16MessageTrigger
.Heartbeat
:
522 chargingStation
.ocppRequestService
523 .requestHandler
<OCPP16HeartbeatRequest
, OCPP16HeartbeatResponse
>(
525 OCPP16RequestCommand
.HEARTBEAT
,
533 case OCPP16MessageTrigger
.StatusNotification
:
534 if (connectorId
!= null) {
535 chargingStation
.ocppRequestService
536 .requestHandler
<OCPP16StatusNotificationRequest
, OCPP16StatusNotificationResponse
>(
538 OCPP16RequestCommand
.STATUS_NOTIFICATION
,
541 errorCode
: OCPP16ChargePointErrorCode
.NO_ERROR
,
542 status: chargingStation
.getConnectorStatus(connectorId
)
543 ?.status as OCPP16ChargePointStatus
550 } else if (chargingStation
.hasEvses
) {
551 for (const evseStatus
of chargingStation
.evses
.values()) {
552 for (const [id
, connectorStatus
] of evseStatus
.connectors
) {
553 chargingStation
.ocppRequestService
555 OCPP16StatusNotificationRequest
,
556 OCPP16StatusNotificationResponse
559 OCPP16RequestCommand
.STATUS_NOTIFICATION
,
562 errorCode
: OCPP16ChargePointErrorCode
.NO_ERROR
,
563 status: connectorStatus
.status as OCPP16ChargePointStatus
573 for (const [id
, connectorStatus
] of chargingStation
.connectors
) {
574 chargingStation
.ocppRequestService
576 OCPP16StatusNotificationRequest
,
577 OCPP16StatusNotificationResponse
580 OCPP16RequestCommand
.STATUS_NOTIFICATION
,
583 errorCode
: OCPP16ChargePointErrorCode
.NO_ERROR
,
584 status: connectorStatus
.status as OCPP16ChargePointStatus
597 this.validatePayload
= this.validatePayload
.bind(this)
600 public async incomingRequestHandler
<ReqType
extends JsonType
, ResType
extends JsonType
>(
601 chargingStation
: ChargingStation
,
603 commandName
: OCPP16IncomingRequestCommand
,
604 commandPayload
: ReqType
606 let response
: ResType
608 chargingStation
.stationInfo
?.ocppStrictCompliance
=== true &&
609 chargingStation
.inPendingState() &&
610 (commandName
=== OCPP16IncomingRequestCommand
.REMOTE_START_TRANSACTION
||
611 commandName
=== OCPP16IncomingRequestCommand
.REMOTE_STOP_TRANSACTION
)
614 ErrorType
.SECURITY_ERROR
,
615 `${commandName} cannot be issued to handle request PDU ${JSON.stringify(
619 )} while the charging station is in pending state on the central server`,
625 chargingStation
.isRegistered() ||
626 (chargingStation
.stationInfo
?.ocppStrictCompliance
=== false &&
627 chargingStation
.inUnknownState())
630 this.incomingRequestHandlers
.has(commandName
) &&
631 OCPP16ServiceUtils
.isIncomingRequestCommandSupported(chargingStation
, commandName
)
634 this.validatePayload(chargingStation
, commandName
, commandPayload
)
635 // Call the method to build the response
636 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
637 const incomingRequestHandler
= this.incomingRequestHandlers
.get(commandName
)!
638 if (isAsyncFunction(incomingRequestHandler
)) {
639 response
= (await incomingRequestHandler(chargingStation
, commandPayload
)) as ResType
641 response
= incomingRequestHandler(chargingStation
, commandPayload
) as ResType
646 `${chargingStation.logPrefix()} ${moduleName}.incomingRequestHandler: Handle incoming request error:`,
654 ErrorType
.NOT_IMPLEMENTED
,
655 `${commandName} is not implemented to handle request PDU ${JSON.stringify(
666 ErrorType
.SECURITY_ERROR
,
667 `${commandName} cannot be issued to handle request PDU ${JSON.stringify(
671 )} while the charging station is not registered on the central server`,
676 // Send the built response
677 await chargingStation
.ocppRequestService
.sendResponse(
683 // Emit command name event to allow delayed handling
684 this.emit(commandName
, chargingStation
, commandPayload
, response
)
687 private validatePayload (
688 chargingStation
: ChargingStation
,
689 commandName
: OCPP16IncomingRequestCommand
,
690 commandPayload
: JsonType
692 if (this.payloadValidateFunctions
.has(commandName
)) {
693 return this.validateIncomingRequestPayload(chargingStation
, commandName
, commandPayload
)
696 `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema validation function found for command '${commandName}' PDU validation`
701 // Simulate charging station restart
702 private handleRequestReset (
703 chargingStation
: ChargingStation
,
704 commandPayload
: ResetRequest
706 const { type } = commandPayload
708 .reset(`${type}Reset` as OCPP16StopTransactionReason
)
709 .catch(Constants
.EMPTY_FUNCTION
)
711 `${chargingStation.logPrefix()} ${type} reset command received, simulating it. The station will be back online in ${formatDurationMilliSeconds(
712 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
713 chargingStation.stationInfo!.resetTime!
716 return OCPP16Constants
.OCPP_RESPONSE_ACCEPTED
719 private async handleRequestUnlockConnector (
720 chargingStation
: ChargingStation
,
721 commandPayload
: UnlockConnectorRequest
722 ): Promise
<UnlockConnectorResponse
> {
723 const { connectorId
} = commandPayload
724 if (!chargingStation
.hasConnector(connectorId
)) {
726 `${chargingStation.logPrefix()} Trying to unlock a non existing connector id ${connectorId}`
728 return OCPP16Constants
.OCPP_RESPONSE_UNLOCK_NOT_SUPPORTED
730 if (connectorId
=== 0) {
731 logger
.error(`${chargingStation.logPrefix()} Trying to unlock connector id ${connectorId}`)
732 return OCPP16Constants
.OCPP_RESPONSE_UNLOCK_NOT_SUPPORTED
734 if (chargingStation
.getConnectorStatus(connectorId
)?.transactionStarted
=== true) {
735 const stopResponse
= await chargingStation
.stopTransactionOnConnector(
737 OCPP16StopTransactionReason
.UNLOCK_COMMAND
739 if (stopResponse
.idTagInfo
?.status === OCPP16AuthorizationStatus
.ACCEPTED
) {
740 return OCPP16Constants
.OCPP_RESPONSE_UNLOCKED
742 return OCPP16Constants
.OCPP_RESPONSE_UNLOCK_FAILED
744 await OCPP16ServiceUtils
.sendAndSetConnectorStatus(
747 OCPP16ChargePointStatus
.Available
749 return OCPP16Constants
.OCPP_RESPONSE_UNLOCKED
752 private handleRequestGetConfiguration (
753 chargingStation
: ChargingStation
,
754 commandPayload
: GetConfigurationRequest
755 ): GetConfigurationResponse
{
756 const { key
} = commandPayload
757 const configurationKey
: OCPPConfigurationKey
[] = []
758 const unknownKey
: string[] = []
760 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
761 for (const configKey
of chargingStation
.ocppConfiguration
!.configurationKey
!) {
762 if (!OCPP16ServiceUtils
.isConfigurationKeyVisible(configKey
)) {
765 configurationKey
.push({
767 readonly: configKey
.readonly,
768 value
: configKey
.value
771 } else if (isNotEmptyArray(key
)) {
772 for (const k
of key
) {
773 const keyFound
= getConfigurationKey(chargingStation
, k
, true)
774 if (keyFound
!= null) {
775 if (!OCPP16ServiceUtils
.isConfigurationKeyVisible(keyFound
)) {
778 configurationKey
.push({
780 readonly: keyFound
.readonly,
781 value
: keyFound
.value
794 private handleRequestChangeConfiguration (
795 chargingStation
: ChargingStation
,
796 commandPayload
: ChangeConfigurationRequest
797 ): ChangeConfigurationResponse
{
798 const { key
, value
} = commandPayload
799 const keyToChange
= getConfigurationKey(chargingStation
, key
, true)
800 if (keyToChange
?.readonly === true) {
801 return OCPP16Constants
.OCPP_CONFIGURATION_RESPONSE_REJECTED
802 } else if (keyToChange
?.readonly === false) {
803 let valueChanged
= false
804 if (keyToChange
.value
!== value
) {
805 setConfigurationKeyValue(chargingStation
, key
, value
, true)
808 let triggerHeartbeatRestart
= false
810 (keyToChange
.key
as OCPP16StandardParametersKey
) ===
811 OCPP16StandardParametersKey
.HeartBeatInterval
&&
814 setConfigurationKeyValue(
816 OCPP16StandardParametersKey
.HeartbeatInterval
,
819 triggerHeartbeatRestart
= true
822 (keyToChange
.key
as OCPP16StandardParametersKey
) ===
823 OCPP16StandardParametersKey
.HeartbeatInterval
&&
826 setConfigurationKeyValue(
828 OCPP16StandardParametersKey
.HeartBeatInterval
,
831 triggerHeartbeatRestart
= true
833 if (triggerHeartbeatRestart
) {
834 chargingStation
.restartHeartbeat()
837 (keyToChange
.key
as OCPP16StandardParametersKey
) ===
838 OCPP16StandardParametersKey
.WebSocketPingInterval
&&
841 chargingStation
.restartWebSocketPing()
844 (keyToChange
.key
as OCPP16StandardParametersKey
) ===
845 OCPP16StandardParametersKey
.MeterValueSampleInterval
&&
846 chargingStation
.getNumberOfRunningTransactions() > 0 &&
851 connectorId
<= chargingStation
.getNumberOfConnectors();
854 if (chargingStation
.getConnectorStatus(connectorId
)?.transactionStarted
=== true) {
855 chargingStation
.restartMeterValues(
857 secondsToMilliseconds(convertToInt(value
))
862 if (keyToChange
.reboot
=== true) {
863 return OCPP16Constants
.OCPP_CONFIGURATION_RESPONSE_REBOOT_REQUIRED
865 return OCPP16Constants
.OCPP_CONFIGURATION_RESPONSE_ACCEPTED
867 return OCPP16Constants
.OCPP_CONFIGURATION_RESPONSE_NOT_SUPPORTED
870 private handleRequestSetChargingProfile (
871 chargingStation
: ChargingStation
,
872 commandPayload
: SetChargingProfileRequest
873 ): SetChargingProfileResponse
{
875 !OCPP16ServiceUtils
.checkFeatureProfile(
877 OCPP16SupportedFeatureProfiles
.SmartCharging
,
878 OCPP16IncomingRequestCommand
.SET_CHARGING_PROFILE
881 return OCPP16Constants
.OCPP_SET_CHARGING_PROFILE_RESPONSE_NOT_SUPPORTED
883 const { connectorId
, csChargingProfiles
} = commandPayload
884 if (!chargingStation
.hasConnector(connectorId
)) {
886 `${chargingStation.logPrefix()} Trying to set charging profile(s) to a non existing connector id ${connectorId}`
888 return OCPP16Constants
.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED
891 csChargingProfiles
.chargingProfilePurpose
===
892 OCPP16ChargingProfilePurposeType
.CHARGE_POINT_MAX_PROFILE
&&
895 return OCPP16Constants
.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED
898 csChargingProfiles
.chargingProfilePurpose
=== OCPP16ChargingProfilePurposeType
.TX_PROFILE
&&
902 `${chargingStation.logPrefix()} Trying to set transaction charging profile(s) on connector ${connectorId}`
904 return OCPP16Constants
.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED
906 const connectorStatus
= chargingStation
.getConnectorStatus(connectorId
)
908 csChargingProfiles
.chargingProfilePurpose
=== OCPP16ChargingProfilePurposeType
.TX_PROFILE
&&
910 connectorStatus
?.transactionStarted
=== false
913 `${chargingStation.logPrefix()} Trying to set transaction charging profile(s) on connector ${connectorId} without a started transaction`
915 return OCPP16Constants
.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED
918 csChargingProfiles
.chargingProfilePurpose
=== OCPP16ChargingProfilePurposeType
.TX_PROFILE
&&
920 connectorStatus
?.transactionStarted
=== true &&
921 csChargingProfiles
.transactionId
!= null &&
922 csChargingProfiles
.transactionId
!== connectorStatus
.transactionId
925 `${chargingStation.logPrefix()} Trying to set transaction charging profile(s) on connector ${connectorId} with a different transaction id ${
926 csChargingProfiles.transactionId
927 } than the started transaction id ${connectorStatus.transactionId}`
929 return OCPP16Constants
.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED
931 OCPP16ServiceUtils
.setChargingProfile(chargingStation
, connectorId
, csChargingProfiles
)
933 `${chargingStation.logPrefix()} Charging profile(s) set on connector id ${connectorId}: %j`,
936 return OCPP16Constants
.OCPP_SET_CHARGING_PROFILE_RESPONSE_ACCEPTED
939 private handleRequestGetCompositeSchedule (
940 chargingStation
: ChargingStation
,
941 commandPayload
: OCPP16GetCompositeScheduleRequest
942 ): OCPP16GetCompositeScheduleResponse
{
944 !OCPP16ServiceUtils
.checkFeatureProfile(
946 OCPP16SupportedFeatureProfiles
.SmartCharging
,
947 OCPP16IncomingRequestCommand
.GET_COMPOSITE_SCHEDULE
950 return OCPP16Constants
.OCPP_RESPONSE_REJECTED
952 const { connectorId
, duration
, chargingRateUnit
} = commandPayload
953 if (!chargingStation
.hasConnector(connectorId
)) {
955 `${chargingStation.logPrefix()} Trying to get composite schedule to a non existing connector id ${connectorId}`
957 return OCPP16Constants
.OCPP_RESPONSE_REJECTED
959 if (connectorId
=== 0) {
961 `${chargingStation.logPrefix()} Get composite schedule on connector id ${connectorId} is not yet supported`
963 return OCPP16Constants
.OCPP_RESPONSE_REJECTED
965 if (chargingRateUnit
!= null) {
967 `${chargingStation.logPrefix()} Get composite schedule with a specified rate unit is not yet supported, no conversion will be done`
970 const connectorStatus
= chargingStation
.getConnectorStatus(connectorId
)
972 isEmpty(connectorStatus
?.chargingProfiles
) &&
973 isEmpty(chargingStation
.getConnectorStatus(0)?.chargingProfiles
)
975 return OCPP16Constants
.OCPP_RESPONSE_REJECTED
977 const currentDate
= new Date()
978 const compositeScheduleInterval
: Interval
= {
980 end
: addSeconds(currentDate
, duration
)
982 // Get charging profiles sorted by connector id then stack level
983 const chargingProfiles
: OCPP16ChargingProfile
[] = getConnectorChargingProfiles(
987 let previousCompositeSchedule
: OCPP16ChargingSchedule
| undefined
988 let compositeSchedule
: OCPP16ChargingSchedule
| undefined
989 for (const chargingProfile
of chargingProfiles
) {
990 if (chargingProfile
.chargingSchedule
.startSchedule
== null) {
992 `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetCompositeSchedule: Charging profile id ${
993 chargingProfile.chargingProfileId
994 } has no startSchedule defined. Trying to set it to the connector current transaction start date`
996 // OCPP specifies that if startSchedule is not defined, it should be relative to start of the connector transaction
997 chargingProfile
.chargingSchedule
.startSchedule
= connectorStatus
?.transactionStart
999 if (!isDate(chargingProfile
.chargingSchedule
.startSchedule
)) {
1001 `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetCompositeSchedule: Charging profile id ${
1002 chargingProfile.chargingProfileId
1003 } startSchedule property is not a Date instance. Trying to convert it to a Date instance`
1005 chargingProfile
.chargingSchedule
.startSchedule
= convertToDate(
1006 chargingProfile
.chargingSchedule
.startSchedule
1009 if (chargingProfile
.chargingSchedule
.duration
== null) {
1011 `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetCompositeSchedule: Charging profile id ${
1012 chargingProfile.chargingProfileId
1013 } has no duration defined and will be set to the maximum time allowed`
1015 // OCPP specifies that if duration is not defined, it should be infinite
1016 chargingProfile
.chargingSchedule
.duration
= differenceInSeconds(
1018 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1019 chargingProfile
.chargingSchedule
.startSchedule
!
1023 !prepareChargingProfileKind(
1026 compositeScheduleInterval
.start
,
1027 chargingStation
.logPrefix()
1033 !canProceedChargingProfile(
1035 compositeScheduleInterval
.start
,
1036 chargingStation
.logPrefix()
1041 compositeSchedule
= OCPP16ServiceUtils
.composeChargingSchedules(
1042 previousCompositeSchedule
,
1043 chargingProfile
.chargingSchedule
,
1044 compositeScheduleInterval
1046 previousCompositeSchedule
= compositeSchedule
1048 if (compositeSchedule
!= null) {
1050 status: GenericStatus
.Accepted
,
1051 scheduleStart
: compositeSchedule
.startSchedule
,
1053 chargingSchedule
: compositeSchedule
1056 return OCPP16Constants
.OCPP_RESPONSE_REJECTED
1059 private handleRequestClearChargingProfile (
1060 chargingStation
: ChargingStation
,
1061 commandPayload
: OCPP16ClearChargingProfileRequest
1062 ): OCPP16ClearChargingProfileResponse
{
1064 !OCPP16ServiceUtils
.checkFeatureProfile(
1066 OCPP16SupportedFeatureProfiles
.SmartCharging
,
1067 OCPP16IncomingRequestCommand
.CLEAR_CHARGING_PROFILE
1070 return OCPP16Constants
.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN
1072 const { connectorId
} = commandPayload
1073 if (connectorId
!= null) {
1074 if (!chargingStation
.hasConnector(connectorId
)) {
1076 `${chargingStation.logPrefix()} Trying to clear a charging profile(s) to a non existing connector id ${connectorId}`
1078 return OCPP16Constants
.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN
1080 const connectorStatus
= chargingStation
.getConnectorStatus(connectorId
)
1081 if (isNotEmptyArray(connectorStatus
?.chargingProfiles
)) {
1082 connectorStatus
.chargingProfiles
= []
1084 `${chargingStation.logPrefix()} Charging profile(s) cleared on connector id ${connectorId}`
1086 return OCPP16Constants
.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_ACCEPTED
1089 let clearedCP
= false
1090 if (chargingStation
.hasEvses
) {
1091 for (const evseStatus
of chargingStation
.evses
.values()) {
1092 for (const status of evseStatus
.connectors
.values()) {
1093 const clearedConnectorCP
= OCPP16ServiceUtils
.clearChargingProfiles(
1096 status.chargingProfiles
1098 if (clearedConnectorCP
&& !clearedCP
) {
1104 for (const id
of chargingStation
.connectors
.keys()) {
1105 const clearedConnectorCP
= OCPP16ServiceUtils
.clearChargingProfiles(
1108 chargingStation
.getConnectorStatus(id
)?.chargingProfiles
1110 if (clearedConnectorCP
&& !clearedCP
) {
1116 return OCPP16Constants
.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_ACCEPTED
1119 return OCPP16Constants
.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN
1122 private async handleRequestChangeAvailability (
1123 chargingStation
: ChargingStation
,
1124 commandPayload
: OCPP16ChangeAvailabilityRequest
1125 ): Promise
<OCPP16ChangeAvailabilityResponse
> {
1126 const { connectorId
, type } = commandPayload
1127 if (!chargingStation
.hasConnector(connectorId
)) {
1129 `${chargingStation.logPrefix()} Trying to change the availability of a non existing connector id ${connectorId}`
1131 return OCPP16Constants
.OCPP_AVAILABILITY_RESPONSE_REJECTED
1133 const chargePointStatus
: OCPP16ChargePointStatus
=
1134 type === OCPP16AvailabilityType
.Operative
1135 ? OCPP16ChargePointStatus
.Available
1136 : OCPP16ChargePointStatus
.Unavailable
1137 if (connectorId
=== 0) {
1138 let response
: OCPP16ChangeAvailabilityResponse
| undefined
1139 if (chargingStation
.hasEvses
) {
1140 for (const evseStatus
of chargingStation
.evses
.values()) {
1141 response
= await OCPP16ServiceUtils
.changeAvailability(
1143 [...evseStatus
.connectors
.keys()],
1149 response
= await OCPP16ServiceUtils
.changeAvailability(
1151 [...chargingStation
.connectors
.keys()],
1156 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1160 (chargingStation
.isChargingStationAvailable() ||
1161 (!chargingStation
.isChargingStationAvailable() &&
1162 type === OCPP16AvailabilityType
.Inoperative
))
1164 if (chargingStation
.getConnectorStatus(connectorId
)?.transactionStarted
=== true) {
1165 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1166 chargingStation
.getConnectorStatus(connectorId
)!.availability
= type
1167 return OCPP16Constants
.OCPP_AVAILABILITY_RESPONSE_SCHEDULED
1169 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1170 chargingStation
.getConnectorStatus(connectorId
)!.availability
= type
1171 await OCPP16ServiceUtils
.sendAndSetConnectorStatus(
1176 return OCPP16Constants
.OCPP_AVAILABILITY_RESPONSE_ACCEPTED
1178 return OCPP16Constants
.OCPP_AVAILABILITY_RESPONSE_REJECTED
1181 private async handleRequestRemoteStartTransaction (
1182 chargingStation
: ChargingStation
,
1183 commandPayload
: RemoteStartTransactionRequest
1184 ): Promise
<GenericResponse
> {
1185 if (commandPayload
.connectorId
== null) {
1187 let connectorId
= 1;
1188 connectorId
<= chargingStation
.getNumberOfConnectors();
1192 chargingStation
.getConnectorStatus(connectorId
)?.transactionStarted
=== false &&
1193 !OCPP16ServiceUtils
.hasReservation(chargingStation
, connectorId
, commandPayload
.idTag
)
1195 commandPayload
.connectorId
= connectorId
1199 if (commandPayload
.connectorId
== null) {
1201 `${chargingStation.logPrefix()} Remote start transaction REJECTED on ${
1202 chargingStation.stationInfo?.chargingStationId
1203 }, idTag '${commandPayload.idTag}': no available connector found`
1205 return OCPP16Constants
.OCPP_RESPONSE_REJECTED
1208 const { connectorId
: transactionConnectorId
, idTag
, chargingProfile
} = commandPayload
1209 if (!chargingStation
.hasConnector(transactionConnectorId
)) {
1210 return this.notifyRemoteStartTransactionRejected(
1212 transactionConnectorId
,
1217 !chargingStation
.isChargingStationAvailable() ||
1218 !chargingStation
.isConnectorAvailable(transactionConnectorId
)
1220 return this.notifyRemoteStartTransactionRejected(
1222 transactionConnectorId
,
1226 // idTag authorization check required
1228 chargingStation
.getAuthorizeRemoteTxRequests() &&
1229 !(await OCPP16ServiceUtils
.isIdTagAuthorized(chargingStation
, transactionConnectorId
, idTag
))
1231 return this.notifyRemoteStartTransactionRejected(
1233 transactionConnectorId
,
1238 chargingProfile
!= null &&
1239 !this.setRemoteStartTransactionChargingProfile(
1241 transactionConnectorId
,
1245 return this.notifyRemoteStartTransactionRejected(
1247 transactionConnectorId
,
1252 `${chargingStation.logPrefix()} Remote start transaction ACCEPTED on ${
1253 chargingStation.stationInfo?.chargingStationId
1254 }#${transactionConnectorId}}, idTag '${idTag}'`
1256 return OCPP16Constants
.OCPP_RESPONSE_ACCEPTED
1259 private notifyRemoteStartTransactionRejected (
1260 chargingStation
: ChargingStation
,
1261 connectorId
: number,
1263 ): GenericResponse
{
1264 const connectorStatus
= chargingStation
.getConnectorStatus(connectorId
)
1266 `${chargingStation.logPrefix()} Remote start transaction REJECTED on ${
1267 chargingStation.stationInfo?.chargingStationId
1268 }#${connectorId}, idTag '${idTag}', availability '${
1269 connectorStatus?.availability
1270 }', status '${connectorStatus?.status}'`
1272 return OCPP16Constants
.OCPP_RESPONSE_REJECTED
1275 private setRemoteStartTransactionChargingProfile (
1276 chargingStation
: ChargingStation
,
1277 connectorId
: number,
1278 chargingProfile
: OCPP16ChargingProfile
1281 chargingProfile
.chargingProfilePurpose
=== OCPP16ChargingProfilePurposeType
.TX_PROFILE
&&
1282 chargingProfile
.transactionId
== null
1284 OCPP16ServiceUtils
.setChargingProfile(chargingStation
, connectorId
, chargingProfile
)
1286 `${chargingStation.logPrefix()} Charging profile(s) set at remote start transaction on ${
1287 chargingStation.stationInfo?.chargingStationId
1294 `${chargingStation.logPrefix()} Not allowed to set ${
1295 chargingProfile.chargingProfilePurpose
1296 } charging profile(s)${chargingProfile.transactionId != null ? ' with transactionId set' : ''} at remote start transaction`
1301 private handleRequestRemoteStopTransaction (
1302 chargingStation
: ChargingStation
,
1303 commandPayload
: RemoteStopTransactionRequest
1304 ): GenericResponse
{
1305 const { transactionId
} = commandPayload
1306 if (chargingStation
.getConnectorIdByTransactionId(transactionId
) != null) {
1308 `${chargingStation.logPrefix()} Remote stop transaction ACCEPTED for transactionId '${transactionId}'`
1310 return OCPP16Constants
.OCPP_RESPONSE_ACCEPTED
1313 `${chargingStation.logPrefix()} Remote stop transaction REJECTED for transactionId '${transactionId}'`
1315 return OCPP16Constants
.OCPP_RESPONSE_REJECTED
1318 private handleRequestUpdateFirmware (
1319 chargingStation
: ChargingStation
,
1320 commandPayload
: OCPP16UpdateFirmwareRequest
1321 ): OCPP16UpdateFirmwareResponse
{
1323 !OCPP16ServiceUtils
.checkFeatureProfile(
1325 OCPP16SupportedFeatureProfiles
.FirmwareManagement
,
1326 OCPP16IncomingRequestCommand
.UPDATE_FIRMWARE
1330 `${chargingStation.logPrefix()} ${moduleName}.handleRequestUpdateFirmware: Cannot simulate firmware update: feature profile not supported`
1332 return OCPP16Constants
.OCPP_RESPONSE_EMPTY
1334 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1335 commandPayload
.retrieveDate
= convertToDate(commandPayload
.retrieveDate
)!
1336 const { retrieveDate
} = commandPayload
1338 chargingStation
.stationInfo
?.firmwareStatus
!= null &&
1339 chargingStation
.stationInfo
.firmwareStatus
!== OCPP16FirmwareStatus
.Installed
1342 `${chargingStation.logPrefix()} ${moduleName}.handleRequestUpdateFirmware: Cannot simulate firmware update: firmware update is already in progress`
1344 return OCPP16Constants
.OCPP_RESPONSE_EMPTY
1346 const now
= Date.now()
1347 if (retrieveDate
.getTime() <= now
) {
1348 this.updateFirmwareSimulation(chargingStation
).catch(Constants
.EMPTY_FUNCTION
)
1351 this.updateFirmwareSimulation(chargingStation
).catch(Constants
.EMPTY_FUNCTION
)
1352 }, retrieveDate
.getTime() - now
)
1354 return OCPP16Constants
.OCPP_RESPONSE_EMPTY
1357 private async updateFirmwareSimulation (
1358 chargingStation
: ChargingStation
,
1362 if (!checkChargingStation(chargingStation
, chargingStation
.logPrefix())) {
1365 if (chargingStation
.hasEvses
) {
1366 for (const [evseId
, evseStatus
] of chargingStation
.evses
) {
1368 for (const [connectorId
, connectorStatus
] of evseStatus
.connectors
) {
1369 if (connectorStatus
.transactionStarted
=== false) {
1370 await OCPP16ServiceUtils
.sendAndSetConnectorStatus(
1373 OCPP16ChargePointStatus
.Unavailable
1380 for (const connectorId
of chargingStation
.connectors
.keys()) {
1383 chargingStation
.getConnectorStatus(connectorId
)?.transactionStarted
=== false
1385 await OCPP16ServiceUtils
.sendAndSetConnectorStatus(
1388 OCPP16ChargePointStatus
.Unavailable
1393 await chargingStation
.ocppRequestService
.requestHandler
<
1394 OCPP16FirmwareStatusNotificationRequest
,
1395 OCPP16FirmwareStatusNotificationResponse
1396 >(chargingStation
, OCPP16RequestCommand
.FIRMWARE_STATUS_NOTIFICATION
, {
1397 status: OCPP16FirmwareStatus
.Downloading
1399 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1400 chargingStation
.stationInfo
!.firmwareStatus
= OCPP16FirmwareStatus
.Downloading
1402 chargingStation
.stationInfo
?.firmwareUpgrade
?.failureStatus
===
1403 OCPP16FirmwareStatus
.DownloadFailed
1405 await sleep(secondsToMilliseconds(randomInt(minDelay
, maxDelay
)))
1406 await chargingStation
.ocppRequestService
.requestHandler
<
1407 OCPP16FirmwareStatusNotificationRequest
,
1408 OCPP16FirmwareStatusNotificationResponse
1409 >(chargingStation
, OCPP16RequestCommand
.FIRMWARE_STATUS_NOTIFICATION
, {
1410 status: chargingStation
.stationInfo
.firmwareUpgrade
.failureStatus
1412 chargingStation
.stationInfo
.firmwareStatus
=
1413 chargingStation
.stationInfo
.firmwareUpgrade
.failureStatus
1416 await sleep(secondsToMilliseconds(randomInt(minDelay
, maxDelay
)))
1417 await chargingStation
.ocppRequestService
.requestHandler
<
1418 OCPP16FirmwareStatusNotificationRequest
,
1419 OCPP16FirmwareStatusNotificationResponse
1420 >(chargingStation
, OCPP16RequestCommand
.FIRMWARE_STATUS_NOTIFICATION
, {
1421 status: OCPP16FirmwareStatus
.Downloaded
1423 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1424 chargingStation
.stationInfo
!.firmwareStatus
= OCPP16FirmwareStatus
.Downloaded
1425 let wasTransactionsStarted
= false
1426 let transactionsStarted
: boolean
1428 const runningTransactions
= chargingStation
.getNumberOfRunningTransactions()
1429 if (runningTransactions
> 0) {
1430 const waitTime
= secondsToMilliseconds(15)
1432 `${chargingStation.logPrefix()} ${moduleName}.updateFirmwareSimulation: ${runningTransactions} transaction(s) in progress, waiting ${formatDurationMilliSeconds(
1434 )} before continuing firmware update simulation`
1436 await sleep(waitTime
)
1437 transactionsStarted
= true
1438 wasTransactionsStarted
= true
1440 if (chargingStation
.hasEvses
) {
1441 for (const [evseId
, evseStatus
] of chargingStation
.evses
) {
1443 for (const [connectorId
, connectorStatus
] of evseStatus
.connectors
) {
1444 if (connectorStatus
.status !== OCPP16ChargePointStatus
.Unavailable
) {
1445 await OCPP16ServiceUtils
.sendAndSetConnectorStatus(
1448 OCPP16ChargePointStatus
.Unavailable
1455 for (const connectorId
of chargingStation
.connectors
.keys()) {
1458 chargingStation
.getConnectorStatus(connectorId
)?.status !==
1459 OCPP16ChargePointStatus
.Unavailable
1461 await OCPP16ServiceUtils
.sendAndSetConnectorStatus(
1464 OCPP16ChargePointStatus
.Unavailable
1469 transactionsStarted
= false
1471 } while (transactionsStarted
)
1472 !wasTransactionsStarted
&& (await sleep(secondsToMilliseconds(randomInt(minDelay
, maxDelay
))))
1473 if (!checkChargingStation(chargingStation
, chargingStation
.logPrefix())) {
1476 await chargingStation
.ocppRequestService
.requestHandler
<
1477 OCPP16FirmwareStatusNotificationRequest
,
1478 OCPP16FirmwareStatusNotificationResponse
1479 >(chargingStation
, OCPP16RequestCommand
.FIRMWARE_STATUS_NOTIFICATION
, {
1480 status: OCPP16FirmwareStatus
.Installing
1482 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1483 chargingStation
.stationInfo
!.firmwareStatus
= OCPP16FirmwareStatus
.Installing
1485 chargingStation
.stationInfo
?.firmwareUpgrade
?.failureStatus
===
1486 OCPP16FirmwareStatus
.InstallationFailed
1488 await sleep(secondsToMilliseconds(randomInt(minDelay
, maxDelay
)))
1489 await chargingStation
.ocppRequestService
.requestHandler
<
1490 OCPP16FirmwareStatusNotificationRequest
,
1491 OCPP16FirmwareStatusNotificationResponse
1492 >(chargingStation
, OCPP16RequestCommand
.FIRMWARE_STATUS_NOTIFICATION
, {
1493 status: chargingStation
.stationInfo
.firmwareUpgrade
.failureStatus
1495 chargingStation
.stationInfo
.firmwareStatus
=
1496 chargingStation
.stationInfo
.firmwareUpgrade
.failureStatus
1499 if (chargingStation
.stationInfo
?.firmwareUpgrade
?.reset
=== true) {
1500 await sleep(secondsToMilliseconds(randomInt(minDelay
, maxDelay
)))
1501 await chargingStation
.reset(OCPP16StopTransactionReason
.REBOOT
)
1505 private async handleRequestGetDiagnostics (
1506 chargingStation
: ChargingStation
,
1507 commandPayload
: GetDiagnosticsRequest
1508 ): Promise
<GetDiagnosticsResponse
> {
1510 !OCPP16ServiceUtils
.checkFeatureProfile(
1512 OCPP16SupportedFeatureProfiles
.FirmwareManagement
,
1513 OCPP16IncomingRequestCommand
.GET_DIAGNOSTICS
1517 `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetDiagnostics: Cannot get diagnostics: feature profile not supported`
1519 return OCPP16Constants
.OCPP_RESPONSE_EMPTY
1521 const { location
} = commandPayload
1522 const uri
= new URL(location
)
1523 if (uri
.protocol
.startsWith('ftp:')) {
1524 let ftpClient
: Client
| undefined
1526 const logConfiguration
= Configuration
.getConfigurationSection
<LogConfiguration
>(
1527 ConfigurationSection
.log
1529 const logFiles
= readdirSync(
1530 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1531 resolve((fileURLToPath(import.meta
.url
), '../', dirname(logConfiguration
.file
!)))
1533 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1534 .filter(file
=> file
.endsWith(extname(logConfiguration
.file
!)))
1535 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1536 .map(file
=> join(dirname(logConfiguration
.file
!), file
))
1537 const diagnosticsArchive
= `${chargingStation.stationInfo?.chargingStationId}_logs.tar.gz`
1538 create({ gzip
: true }, logFiles
).pipe(createWriteStream(diagnosticsArchive
))
1539 ftpClient
= new Client()
1540 const accessResponse
= await ftpClient
.access({
1542 ...(isNotEmptyString(uri
.port
) && { port
: convertToInt(uri
.port
) }),
1543 ...(isNotEmptyString(uri
.username
) && { user
: uri
.username
}),
1544 ...(isNotEmptyString(uri
.password
) && { password
: uri
.password
})
1546 let uploadResponse
: FTPResponse
| undefined
1547 if (accessResponse
.code
=== 220) {
1548 ftpClient
.trackProgress(info
=> {
1550 `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetDiagnostics: ${
1552 } bytes transferred from diagnostics archive ${info.name}`
1554 chargingStation
.ocppRequestService
1556 OCPP16DiagnosticsStatusNotificationRequest
,
1557 OCPP16DiagnosticsStatusNotificationResponse
1558 >(chargingStation
, OCPP16RequestCommand
.DIAGNOSTICS_STATUS_NOTIFICATION
, {
1559 status: OCPP16DiagnosticsStatus
.Uploading
1561 .catch((error
: unknown
) => {
1563 `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetDiagnostics: Error while sending '${
1564 OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION
1570 uploadResponse
= await ftpClient
.uploadFrom(
1571 join(resolve(dirname(fileURLToPath(import.meta
.url
)), '../'), diagnosticsArchive
),
1572 `${uri.pathname}${diagnosticsArchive}`
1574 if (uploadResponse
.code
=== 226) {
1575 await chargingStation
.ocppRequestService
.requestHandler
<
1576 OCPP16DiagnosticsStatusNotificationRequest
,
1577 OCPP16DiagnosticsStatusNotificationResponse
1578 >(chargingStation
, OCPP16RequestCommand
.DIAGNOSTICS_STATUS_NOTIFICATION
, {
1579 status: OCPP16DiagnosticsStatus
.Uploaded
1582 return { fileName
: diagnosticsArchive
}
1584 throw new OCPPError(
1585 ErrorType
.GENERIC_ERROR
,
1586 `Diagnostics transfer failed with error code ${accessResponse.code}|${uploadResponse.code}`,
1587 OCPP16IncomingRequestCommand
.GET_DIAGNOSTICS
1590 throw new OCPPError(
1591 ErrorType
.GENERIC_ERROR
,
1592 `Diagnostics transfer failed with error code ${accessResponse.code}|${uploadResponse?.code}`,
1593 OCPP16IncomingRequestCommand
.GET_DIAGNOSTICS
1596 await chargingStation
.ocppRequestService
.requestHandler
<
1597 OCPP16DiagnosticsStatusNotificationRequest
,
1598 OCPP16DiagnosticsStatusNotificationResponse
1599 >(chargingStation
, OCPP16RequestCommand
.DIAGNOSTICS_STATUS_NOTIFICATION
, {
1600 status: OCPP16DiagnosticsStatus
.UploadFailed
1603 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1604 return handleIncomingRequestError
<GetDiagnosticsResponse
>(
1606 OCPP16IncomingRequestCommand
.GET_DIAGNOSTICS
,
1608 { errorResponse
: OCPP16Constants
.OCPP_RESPONSE_EMPTY
}
1613 `${chargingStation.logPrefix()} Unsupported protocol ${
1615 } to transfer the diagnostic logs archive`
1617 await chargingStation
.ocppRequestService
.requestHandler
<
1618 OCPP16DiagnosticsStatusNotificationRequest
,
1619 OCPP16DiagnosticsStatusNotificationResponse
1620 >(chargingStation
, OCPP16RequestCommand
.DIAGNOSTICS_STATUS_NOTIFICATION
, {
1621 status: OCPP16DiagnosticsStatus
.UploadFailed
1623 return OCPP16Constants
.OCPP_RESPONSE_EMPTY
1627 private handleRequestTriggerMessage (
1628 chargingStation
: ChargingStation
,
1629 commandPayload
: OCPP16TriggerMessageRequest
1630 ): OCPP16TriggerMessageResponse
{
1631 const { requestedMessage
, connectorId
} = commandPayload
1633 !OCPP16ServiceUtils
.checkFeatureProfile(
1635 OCPP16SupportedFeatureProfiles
.RemoteTrigger
,
1636 OCPP16IncomingRequestCommand
.TRIGGER_MESSAGE
1638 !OCPP16ServiceUtils
.isMessageTriggerSupported(chargingStation
, requestedMessage
)
1640 return OCPP16Constants
.OCPP_TRIGGER_MESSAGE_RESPONSE_NOT_IMPLEMENTED
1643 !OCPP16ServiceUtils
.isConnectorIdValid(
1645 OCPP16IncomingRequestCommand
.TRIGGER_MESSAGE
,
1646 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1650 return OCPP16Constants
.OCPP_TRIGGER_MESSAGE_RESPONSE_REJECTED
1652 switch (requestedMessage
) {
1653 case OCPP16MessageTrigger
.BootNotification
:
1654 case OCPP16MessageTrigger
.Heartbeat
:
1655 case OCPP16MessageTrigger
.StatusNotification
:
1656 return OCPP16Constants
.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED
1658 return OCPP16Constants
.OCPP_TRIGGER_MESSAGE_RESPONSE_NOT_IMPLEMENTED
1662 private handleRequestDataTransfer (
1663 chargingStation
: ChargingStation
,
1664 commandPayload
: OCPP16DataTransferRequest
1665 ): OCPP16DataTransferResponse
{
1666 const { vendorId
} = commandPayload
1668 if (Object.values(OCPP16DataTransferVendorId
).includes(vendorId
)) {
1669 return OCPP16Constants
.OCPP_DATA_TRANSFER_RESPONSE_ACCEPTED
1671 return OCPP16Constants
.OCPP_DATA_TRANSFER_RESPONSE_UNKNOWN_VENDOR_ID
1673 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1674 return handleIncomingRequestError
<OCPP16DataTransferResponse
>(
1676 OCPP16IncomingRequestCommand
.DATA_TRANSFER
,
1678 { errorResponse
: OCPP16Constants
.OCPP_DATA_TRANSFER_RESPONSE_REJECTED
}
1683 private async handleRequestReserveNow (
1684 chargingStation
: ChargingStation
,
1685 commandPayload
: OCPP16ReserveNowRequest
1686 ): Promise
<OCPP16ReserveNowResponse
> {
1688 !OCPP16ServiceUtils
.checkFeatureProfile(
1690 OCPP16SupportedFeatureProfiles
.Reservation
,
1691 OCPP16IncomingRequestCommand
.RESERVE_NOW
1694 return OCPP16Constants
.OCPP_RESERVATION_RESPONSE_REJECTED
1696 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1697 commandPayload
.expiryDate
= convertToDate(commandPayload
.expiryDate
)!
1698 const { reservationId
, idTag
, connectorId
} = commandPayload
1699 if (!chargingStation
.hasConnector(connectorId
)) {
1701 `${chargingStation.logPrefix()} Trying to reserve a non existing connector id ${connectorId}`
1703 return OCPP16Constants
.OCPP_RESERVATION_RESPONSE_REJECTED
1705 if (connectorId
> 0 && !chargingStation
.isConnectorAvailable(connectorId
)) {
1706 return OCPP16Constants
.OCPP_RESERVATION_RESPONSE_REJECTED
1708 if (connectorId
=== 0 && !chargingStation
.getReserveConnectorZeroSupported()) {
1709 return OCPP16Constants
.OCPP_RESERVATION_RESPONSE_REJECTED
1711 if (!(await OCPP16ServiceUtils
.isIdTagAuthorized(chargingStation
, connectorId
, idTag
))) {
1712 return OCPP16Constants
.OCPP_RESERVATION_RESPONSE_REJECTED
1714 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1715 const connectorStatus
= chargingStation
.getConnectorStatus(connectorId
)!
1716 resetAuthorizeConnectorStatus(connectorStatus
)
1717 let response
: OCPP16ReserveNowResponse
1719 await removeExpiredReservations(chargingStation
)
1720 switch (connectorStatus
.status) {
1721 case OCPP16ChargePointStatus
.Faulted
:
1722 response
= OCPP16Constants
.OCPP_RESERVATION_RESPONSE_FAULTED
1724 case OCPP16ChargePointStatus
.Preparing
:
1725 case OCPP16ChargePointStatus
.Charging
:
1726 case OCPP16ChargePointStatus
.SuspendedEV
:
1727 case OCPP16ChargePointStatus
.SuspendedEVSE
:
1728 case OCPP16ChargePointStatus
.Finishing
:
1729 response
= OCPP16Constants
.OCPP_RESERVATION_RESPONSE_OCCUPIED
1731 case OCPP16ChargePointStatus
.Unavailable
:
1732 response
= OCPP16Constants
.OCPP_RESERVATION_RESPONSE_UNAVAILABLE
1734 case OCPP16ChargePointStatus
.Reserved
:
1735 if (!chargingStation
.isConnectorReservable(reservationId
, idTag
, connectorId
)) {
1736 response
= OCPP16Constants
.OCPP_RESERVATION_RESPONSE_OCCUPIED
1739 // eslint-disable-next-line no-fallthrough
1741 if (!chargingStation
.isConnectorReservable(reservationId
, idTag
)) {
1742 response
= OCPP16Constants
.OCPP_RESERVATION_RESPONSE_OCCUPIED
1745 await chargingStation
.addReservation({
1746 id
: commandPayload
.reservationId
,
1749 response
= OCPP16Constants
.OCPP_RESERVATION_RESPONSE_ACCEPTED
1754 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1755 chargingStation
.getConnectorStatus(connectorId
)!.status = OCPP16ChargePointStatus
.Available
1756 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1757 return handleIncomingRequestError
<OCPP16ReserveNowResponse
>(
1759 OCPP16IncomingRequestCommand
.RESERVE_NOW
,
1761 { errorResponse
: OCPP16Constants
.OCPP_RESERVATION_RESPONSE_FAULTED
}
1766 private async handleRequestCancelReservation (
1767 chargingStation
: ChargingStation
,
1768 commandPayload
: OCPP16CancelReservationRequest
1769 ): Promise
<GenericResponse
> {
1771 !OCPP16ServiceUtils
.checkFeatureProfile(
1773 OCPP16SupportedFeatureProfiles
.Reservation
,
1774 OCPP16IncomingRequestCommand
.CANCEL_RESERVATION
1777 return OCPP16Constants
.OCPP_CANCEL_RESERVATION_RESPONSE_REJECTED
1780 const { reservationId
} = commandPayload
1781 const reservation
= chargingStation
.getReservationBy('reservationId', reservationId
)
1782 if (reservation
== null) {
1784 `${chargingStation.logPrefix()} Reservation with id ${reservationId} does not exist on charging station`
1786 return OCPP16Constants
.OCPP_CANCEL_RESERVATION_RESPONSE_REJECTED
1788 await chargingStation
.removeReservation(
1790 ReservationTerminationReason
.RESERVATION_CANCELED
1792 return OCPP16Constants
.OCPP_CANCEL_RESERVATION_RESPONSE_ACCEPTED
1794 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1795 return handleIncomingRequestError
<GenericResponse
>(
1797 OCPP16IncomingRequestCommand
.CANCEL_RESERVATION
,
1800 errorResponse
: OCPP16Constants
.OCPP_CANCEL_RESERVATION_RESPONSE_REJECTED