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()
843 if (keyToChange
.reboot
=== true) {
844 return OCPP16Constants
.OCPP_CONFIGURATION_RESPONSE_REBOOT_REQUIRED
846 return OCPP16Constants
.OCPP_CONFIGURATION_RESPONSE_ACCEPTED
848 return OCPP16Constants
.OCPP_CONFIGURATION_RESPONSE_NOT_SUPPORTED
851 private handleRequestSetChargingProfile (
852 chargingStation
: ChargingStation
,
853 commandPayload
: SetChargingProfileRequest
854 ): SetChargingProfileResponse
{
856 !OCPP16ServiceUtils
.checkFeatureProfile(
858 OCPP16SupportedFeatureProfiles
.SmartCharging
,
859 OCPP16IncomingRequestCommand
.SET_CHARGING_PROFILE
862 return OCPP16Constants
.OCPP_SET_CHARGING_PROFILE_RESPONSE_NOT_SUPPORTED
864 const { connectorId
, csChargingProfiles
} = commandPayload
865 if (!chargingStation
.hasConnector(connectorId
)) {
867 `${chargingStation.logPrefix()} Trying to set charging profile(s) to a non existing connector id ${connectorId}`
869 return OCPP16Constants
.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED
872 csChargingProfiles
.chargingProfilePurpose
===
873 OCPP16ChargingProfilePurposeType
.CHARGE_POINT_MAX_PROFILE
&&
876 return OCPP16Constants
.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED
879 csChargingProfiles
.chargingProfilePurpose
=== OCPP16ChargingProfilePurposeType
.TX_PROFILE
&&
883 `${chargingStation.logPrefix()} Trying to set transaction charging profile(s) on connector ${connectorId}`
885 return OCPP16Constants
.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED
887 const connectorStatus
= chargingStation
.getConnectorStatus(connectorId
)
889 csChargingProfiles
.chargingProfilePurpose
=== OCPP16ChargingProfilePurposeType
.TX_PROFILE
&&
891 connectorStatus
?.transactionStarted
=== false
894 `${chargingStation.logPrefix()} Trying to set transaction charging profile(s) on connector ${connectorId} without a started transaction`
896 return OCPP16Constants
.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED
899 csChargingProfiles
.chargingProfilePurpose
=== OCPP16ChargingProfilePurposeType
.TX_PROFILE
&&
901 connectorStatus
?.transactionStarted
=== true &&
902 csChargingProfiles
.transactionId
!== connectorStatus
.transactionId
905 `${chargingStation.logPrefix()} Trying to set transaction charging profile(s) on connector ${connectorId} with a different transaction id ${
906 csChargingProfiles.transactionId
907 } than the started transaction id ${connectorStatus.transactionId}`
909 return OCPP16Constants
.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED
911 OCPP16ServiceUtils
.setChargingProfile(chargingStation
, connectorId
, csChargingProfiles
)
913 `${chargingStation.logPrefix()} Charging profile(s) set on connector id ${connectorId}: %j`,
916 return OCPP16Constants
.OCPP_SET_CHARGING_PROFILE_RESPONSE_ACCEPTED
919 private handleRequestGetCompositeSchedule (
920 chargingStation
: ChargingStation
,
921 commandPayload
: OCPP16GetCompositeScheduleRequest
922 ): OCPP16GetCompositeScheduleResponse
{
924 !OCPP16ServiceUtils
.checkFeatureProfile(
926 OCPP16SupportedFeatureProfiles
.SmartCharging
,
927 OCPP16IncomingRequestCommand
.GET_COMPOSITE_SCHEDULE
930 return OCPP16Constants
.OCPP_RESPONSE_REJECTED
932 const { connectorId
, duration
, chargingRateUnit
} = commandPayload
933 if (!chargingStation
.hasConnector(connectorId
)) {
935 `${chargingStation.logPrefix()} Trying to get composite schedule to a non existing connector id ${connectorId}`
937 return OCPP16Constants
.OCPP_RESPONSE_REJECTED
939 if (connectorId
=== 0) {
941 `${chargingStation.logPrefix()} Get composite schedule on connector id ${connectorId} is not yet supported`
943 return OCPP16Constants
.OCPP_RESPONSE_REJECTED
945 if (chargingRateUnit
!= null) {
947 `${chargingStation.logPrefix()} Get composite schedule with a specified rate unit is not yet supported, no conversion will be done`
950 const connectorStatus
= chargingStation
.getConnectorStatus(connectorId
)
952 isEmpty(connectorStatus
?.chargingProfiles
) &&
953 isEmpty(chargingStation
.getConnectorStatus(0)?.chargingProfiles
)
955 return OCPP16Constants
.OCPP_RESPONSE_REJECTED
957 const currentDate
= new Date()
958 const compositeScheduleInterval
: Interval
= {
960 end
: addSeconds(currentDate
, duration
)
962 // Get charging profiles sorted by connector id then stack level
963 const chargingProfiles
: OCPP16ChargingProfile
[] = getConnectorChargingProfiles(
967 let previousCompositeSchedule
: OCPP16ChargingSchedule
| undefined
968 let compositeSchedule
: OCPP16ChargingSchedule
| undefined
969 for (const chargingProfile
of chargingProfiles
) {
970 if (chargingProfile
.chargingSchedule
.startSchedule
== null) {
972 `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetCompositeSchedule: Charging profile id ${
973 chargingProfile.chargingProfileId
974 } has no startSchedule defined. Trying to set it to the connector current transaction start date`
976 // OCPP specifies that if startSchedule is not defined, it should be relative to start of the connector transaction
977 chargingProfile
.chargingSchedule
.startSchedule
= connectorStatus
?.transactionStart
979 if (!isDate(chargingProfile
.chargingSchedule
.startSchedule
)) {
981 `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetCompositeSchedule: Charging profile id ${
982 chargingProfile.chargingProfileId
983 } startSchedule property is not a Date instance. Trying to convert it to a Date instance`
985 chargingProfile
.chargingSchedule
.startSchedule
= convertToDate(
986 chargingProfile
.chargingSchedule
.startSchedule
989 if (chargingProfile
.chargingSchedule
.duration
== null) {
991 `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetCompositeSchedule: Charging profile id ${
992 chargingProfile.chargingProfileId
993 } has no duration defined and will be set to the maximum time allowed`
995 // OCPP specifies that if duration is not defined, it should be infinite
996 chargingProfile
.chargingSchedule
.duration
= differenceInSeconds(
998 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
999 chargingProfile
.chargingSchedule
.startSchedule
!
1003 !prepareChargingProfileKind(
1006 compositeScheduleInterval
.start
,
1007 chargingStation
.logPrefix()
1013 !canProceedChargingProfile(
1015 compositeScheduleInterval
.start
,
1016 chargingStation
.logPrefix()
1021 compositeSchedule
= OCPP16ServiceUtils
.composeChargingSchedules(
1022 previousCompositeSchedule
,
1023 chargingProfile
.chargingSchedule
,
1024 compositeScheduleInterval
1026 previousCompositeSchedule
= compositeSchedule
1028 if (compositeSchedule
!= null) {
1030 status: GenericStatus
.Accepted
,
1031 scheduleStart
: compositeSchedule
.startSchedule
,
1033 chargingSchedule
: compositeSchedule
1036 return OCPP16Constants
.OCPP_RESPONSE_REJECTED
1039 private handleRequestClearChargingProfile (
1040 chargingStation
: ChargingStation
,
1041 commandPayload
: OCPP16ClearChargingProfileRequest
1042 ): OCPP16ClearChargingProfileResponse
{
1044 !OCPP16ServiceUtils
.checkFeatureProfile(
1046 OCPP16SupportedFeatureProfiles
.SmartCharging
,
1047 OCPP16IncomingRequestCommand
.CLEAR_CHARGING_PROFILE
1050 return OCPP16Constants
.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN
1052 const { connectorId
} = commandPayload
1053 if (connectorId
!= null) {
1054 if (!chargingStation
.hasConnector(connectorId
)) {
1056 `${chargingStation.logPrefix()} Trying to clear a charging profile(s) to a non existing connector id ${connectorId}`
1058 return OCPP16Constants
.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN
1060 const connectorStatus
= chargingStation
.getConnectorStatus(connectorId
)
1061 if (isNotEmptyArray(connectorStatus
?.chargingProfiles
)) {
1062 connectorStatus
.chargingProfiles
= []
1064 `${chargingStation.logPrefix()} Charging profile(s) cleared on connector id ${connectorId}`
1066 return OCPP16Constants
.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_ACCEPTED
1069 let clearedCP
= false
1070 if (chargingStation
.hasEvses
) {
1071 for (const evseStatus
of chargingStation
.evses
.values()) {
1072 for (const status of evseStatus
.connectors
.values()) {
1073 const clearedConnectorCP
= OCPP16ServiceUtils
.clearChargingProfiles(
1076 status.chargingProfiles
1078 if (clearedConnectorCP
&& !clearedCP
) {
1084 for (const id
of chargingStation
.connectors
.keys()) {
1085 const clearedConnectorCP
= OCPP16ServiceUtils
.clearChargingProfiles(
1088 chargingStation
.getConnectorStatus(id
)?.chargingProfiles
1090 if (clearedConnectorCP
&& !clearedCP
) {
1096 return OCPP16Constants
.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_ACCEPTED
1099 return OCPP16Constants
.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN
1102 private async handleRequestChangeAvailability (
1103 chargingStation
: ChargingStation
,
1104 commandPayload
: OCPP16ChangeAvailabilityRequest
1105 ): Promise
<OCPP16ChangeAvailabilityResponse
> {
1106 const { connectorId
, type } = commandPayload
1107 if (!chargingStation
.hasConnector(connectorId
)) {
1109 `${chargingStation.logPrefix()} Trying to change the availability of a non existing connector id ${connectorId}`
1111 return OCPP16Constants
.OCPP_AVAILABILITY_RESPONSE_REJECTED
1113 const chargePointStatus
: OCPP16ChargePointStatus
=
1114 type === OCPP16AvailabilityType
.Operative
1115 ? OCPP16ChargePointStatus
.Available
1116 : OCPP16ChargePointStatus
.Unavailable
1117 if (connectorId
=== 0) {
1118 let response
: OCPP16ChangeAvailabilityResponse
| undefined
1119 if (chargingStation
.hasEvses
) {
1120 for (const evseStatus
of chargingStation
.evses
.values()) {
1121 response
= await OCPP16ServiceUtils
.changeAvailability(
1123 [...evseStatus
.connectors
.keys()],
1129 response
= await OCPP16ServiceUtils
.changeAvailability(
1131 [...chargingStation
.connectors
.keys()],
1136 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1140 (chargingStation
.isChargingStationAvailable() ||
1141 (!chargingStation
.isChargingStationAvailable() &&
1142 type === OCPP16AvailabilityType
.Inoperative
))
1144 if (chargingStation
.getConnectorStatus(connectorId
)?.transactionStarted
=== true) {
1145 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1146 chargingStation
.getConnectorStatus(connectorId
)!.availability
= type
1147 return OCPP16Constants
.OCPP_AVAILABILITY_RESPONSE_SCHEDULED
1149 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1150 chargingStation
.getConnectorStatus(connectorId
)!.availability
= type
1151 await OCPP16ServiceUtils
.sendAndSetConnectorStatus(
1156 return OCPP16Constants
.OCPP_AVAILABILITY_RESPONSE_ACCEPTED
1158 return OCPP16Constants
.OCPP_AVAILABILITY_RESPONSE_REJECTED
1161 private async handleRequestRemoteStartTransaction (
1162 chargingStation
: ChargingStation
,
1163 commandPayload
: RemoteStartTransactionRequest
1164 ): Promise
<GenericResponse
> {
1165 if (commandPayload
.connectorId
== null) {
1167 let connectorId
= 1;
1168 connectorId
<= chargingStation
.getNumberOfConnectors();
1172 chargingStation
.getConnectorStatus(connectorId
)?.transactionStarted
=== false &&
1173 !OCPP16ServiceUtils
.hasReservation(chargingStation
, connectorId
, commandPayload
.idTag
)
1175 commandPayload
.connectorId
= connectorId
1179 if (commandPayload
.connectorId
== null) {
1181 `${chargingStation.logPrefix()} Remote start transaction REJECTED on ${
1182 chargingStation.stationInfo?.chargingStationId
1183 }, idTag '${commandPayload.idTag}': no available connector found`
1185 return OCPP16Constants
.OCPP_RESPONSE_REJECTED
1188 const { connectorId
: transactionConnectorId
, idTag
, chargingProfile
} = commandPayload
1189 if (!chargingStation
.hasConnector(transactionConnectorId
)) {
1190 return this.notifyRemoteStartTransactionRejected(
1192 transactionConnectorId
,
1197 !chargingStation
.isChargingStationAvailable() ||
1198 !chargingStation
.isConnectorAvailable(transactionConnectorId
)
1200 return this.notifyRemoteStartTransactionRejected(
1202 transactionConnectorId
,
1206 // idTag authorization check required
1208 chargingStation
.getAuthorizeRemoteTxRequests() &&
1209 !(await OCPP16ServiceUtils
.isIdTagAuthorized(chargingStation
, transactionConnectorId
, idTag
))
1211 return this.notifyRemoteStartTransactionRejected(
1213 transactionConnectorId
,
1218 chargingProfile
!= null &&
1219 !this.setRemoteStartTransactionChargingProfile(
1221 transactionConnectorId
,
1225 return this.notifyRemoteStartTransactionRejected(
1227 transactionConnectorId
,
1232 `${chargingStation.logPrefix()} Remote start transaction ACCEPTED on ${
1233 chargingStation.stationInfo?.chargingStationId
1234 }#${transactionConnectorId}}, idTag '${idTag}'`
1236 return OCPP16Constants
.OCPP_RESPONSE_ACCEPTED
1239 private notifyRemoteStartTransactionRejected (
1240 chargingStation
: ChargingStation
,
1241 connectorId
: number,
1243 ): GenericResponse
{
1244 const connectorStatus
= chargingStation
.getConnectorStatus(connectorId
)
1246 `${chargingStation.logPrefix()} Remote start transaction REJECTED on ${
1247 chargingStation.stationInfo?.chargingStationId
1248 }#${connectorId}, idTag '${idTag}', availability '${
1249 connectorStatus?.availability
1250 }', status '${connectorStatus?.status}'`
1252 return OCPP16Constants
.OCPP_RESPONSE_REJECTED
1255 private setRemoteStartTransactionChargingProfile (
1256 chargingStation
: ChargingStation
,
1257 connectorId
: number,
1258 chargingProfile
: OCPP16ChargingProfile
1260 if (chargingProfile
.chargingProfilePurpose
=== OCPP16ChargingProfilePurposeType
.TX_PROFILE
) {
1261 OCPP16ServiceUtils
.setChargingProfile(chargingStation
, connectorId
, chargingProfile
)
1263 `${chargingStation.logPrefix()} Charging profile(s) set at remote start transaction on ${
1264 chargingStation.stationInfo?.chargingStationId
1271 `${chargingStation.logPrefix()} Not allowed to set ${
1272 chargingProfile.chargingProfilePurpose
1273 } charging profile(s) at remote start transaction`
1278 private handleRequestRemoteStopTransaction (
1279 chargingStation
: ChargingStation
,
1280 commandPayload
: RemoteStopTransactionRequest
1281 ): GenericResponse
{
1282 const { transactionId
} = commandPayload
1283 if (chargingStation
.getConnectorIdByTransactionId(transactionId
) != null) {
1285 `${chargingStation.logPrefix()} Remote stop transaction ACCEPTED for transactionId '${transactionId}'`
1287 return OCPP16Constants
.OCPP_RESPONSE_ACCEPTED
1290 `${chargingStation.logPrefix()} Remote stop transaction REJECTED for transactionId '${transactionId}'`
1292 return OCPP16Constants
.OCPP_RESPONSE_REJECTED
1295 private handleRequestUpdateFirmware (
1296 chargingStation
: ChargingStation
,
1297 commandPayload
: OCPP16UpdateFirmwareRequest
1298 ): OCPP16UpdateFirmwareResponse
{
1300 !OCPP16ServiceUtils
.checkFeatureProfile(
1302 OCPP16SupportedFeatureProfiles
.FirmwareManagement
,
1303 OCPP16IncomingRequestCommand
.UPDATE_FIRMWARE
1307 `${chargingStation.logPrefix()} ${moduleName}.handleRequestUpdateFirmware: Cannot simulate firmware update: feature profile not supported`
1309 return OCPP16Constants
.OCPP_RESPONSE_EMPTY
1311 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1312 commandPayload
.retrieveDate
= convertToDate(commandPayload
.retrieveDate
)!
1313 const { retrieveDate
} = commandPayload
1315 chargingStation
.stationInfo
?.firmwareStatus
!= null &&
1316 chargingStation
.stationInfo
.firmwareStatus
!== OCPP16FirmwareStatus
.Installed
1319 `${chargingStation.logPrefix()} ${moduleName}.handleRequestUpdateFirmware: Cannot simulate firmware update: firmware update is already in progress`
1321 return OCPP16Constants
.OCPP_RESPONSE_EMPTY
1323 const now
= Date.now()
1324 if (retrieveDate
.getTime() <= now
) {
1325 this.updateFirmwareSimulation(chargingStation
).catch(Constants
.EMPTY_FUNCTION
)
1328 this.updateFirmwareSimulation(chargingStation
).catch(Constants
.EMPTY_FUNCTION
)
1329 }, retrieveDate
.getTime() - now
)
1331 return OCPP16Constants
.OCPP_RESPONSE_EMPTY
1334 private async updateFirmwareSimulation (
1335 chargingStation
: ChargingStation
,
1339 if (!checkChargingStation(chargingStation
, chargingStation
.logPrefix())) {
1342 if (chargingStation
.hasEvses
) {
1343 for (const [evseId
, evseStatus
] of chargingStation
.evses
) {
1345 for (const [connectorId
, connectorStatus
] of evseStatus
.connectors
) {
1346 if (connectorStatus
.transactionStarted
=== false) {
1347 await OCPP16ServiceUtils
.sendAndSetConnectorStatus(
1350 OCPP16ChargePointStatus
.Unavailable
1357 for (const connectorId
of chargingStation
.connectors
.keys()) {
1360 chargingStation
.getConnectorStatus(connectorId
)?.transactionStarted
=== false
1362 await OCPP16ServiceUtils
.sendAndSetConnectorStatus(
1365 OCPP16ChargePointStatus
.Unavailable
1370 await chargingStation
.ocppRequestService
.requestHandler
<
1371 OCPP16FirmwareStatusNotificationRequest
,
1372 OCPP16FirmwareStatusNotificationResponse
1373 >(chargingStation
, OCPP16RequestCommand
.FIRMWARE_STATUS_NOTIFICATION
, {
1374 status: OCPP16FirmwareStatus
.Downloading
1376 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1377 chargingStation
.stationInfo
!.firmwareStatus
= OCPP16FirmwareStatus
.Downloading
1379 chargingStation
.stationInfo
?.firmwareUpgrade
?.failureStatus
===
1380 OCPP16FirmwareStatus
.DownloadFailed
1382 await sleep(secondsToMilliseconds(randomInt(minDelay
, maxDelay
)))
1383 await chargingStation
.ocppRequestService
.requestHandler
<
1384 OCPP16FirmwareStatusNotificationRequest
,
1385 OCPP16FirmwareStatusNotificationResponse
1386 >(chargingStation
, OCPP16RequestCommand
.FIRMWARE_STATUS_NOTIFICATION
, {
1387 status: chargingStation
.stationInfo
.firmwareUpgrade
.failureStatus
1389 chargingStation
.stationInfo
.firmwareStatus
=
1390 chargingStation
.stationInfo
.firmwareUpgrade
.failureStatus
1393 await sleep(secondsToMilliseconds(randomInt(minDelay
, maxDelay
)))
1394 await chargingStation
.ocppRequestService
.requestHandler
<
1395 OCPP16FirmwareStatusNotificationRequest
,
1396 OCPP16FirmwareStatusNotificationResponse
1397 >(chargingStation
, OCPP16RequestCommand
.FIRMWARE_STATUS_NOTIFICATION
, {
1398 status: OCPP16FirmwareStatus
.Downloaded
1400 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1401 chargingStation
.stationInfo
!.firmwareStatus
= OCPP16FirmwareStatus
.Downloaded
1402 let wasTransactionsStarted
= false
1403 let transactionsStarted
: boolean
1405 const runningTransactions
= chargingStation
.getNumberOfRunningTransactions()
1406 if (runningTransactions
> 0) {
1407 const waitTime
= secondsToMilliseconds(15)
1409 `${chargingStation.logPrefix()} ${moduleName}.updateFirmwareSimulation: ${runningTransactions} transaction(s) in progress, waiting ${formatDurationMilliSeconds(
1411 )} before continuing firmware update simulation`
1413 await sleep(waitTime
)
1414 transactionsStarted
= true
1415 wasTransactionsStarted
= true
1417 if (chargingStation
.hasEvses
) {
1418 for (const [evseId
, evseStatus
] of chargingStation
.evses
) {
1420 for (const [connectorId
, connectorStatus
] of evseStatus
.connectors
) {
1421 if (connectorStatus
.status !== OCPP16ChargePointStatus
.Unavailable
) {
1422 await OCPP16ServiceUtils
.sendAndSetConnectorStatus(
1425 OCPP16ChargePointStatus
.Unavailable
1432 for (const connectorId
of chargingStation
.connectors
.keys()) {
1435 chargingStation
.getConnectorStatus(connectorId
)?.status !==
1436 OCPP16ChargePointStatus
.Unavailable
1438 await OCPP16ServiceUtils
.sendAndSetConnectorStatus(
1441 OCPP16ChargePointStatus
.Unavailable
1446 transactionsStarted
= false
1448 } while (transactionsStarted
)
1449 !wasTransactionsStarted
&& (await sleep(secondsToMilliseconds(randomInt(minDelay
, maxDelay
))))
1450 if (!checkChargingStation(chargingStation
, chargingStation
.logPrefix())) {
1453 await chargingStation
.ocppRequestService
.requestHandler
<
1454 OCPP16FirmwareStatusNotificationRequest
,
1455 OCPP16FirmwareStatusNotificationResponse
1456 >(chargingStation
, OCPP16RequestCommand
.FIRMWARE_STATUS_NOTIFICATION
, {
1457 status: OCPP16FirmwareStatus
.Installing
1459 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1460 chargingStation
.stationInfo
!.firmwareStatus
= OCPP16FirmwareStatus
.Installing
1462 chargingStation
.stationInfo
?.firmwareUpgrade
?.failureStatus
===
1463 OCPP16FirmwareStatus
.InstallationFailed
1465 await sleep(secondsToMilliseconds(randomInt(minDelay
, maxDelay
)))
1466 await chargingStation
.ocppRequestService
.requestHandler
<
1467 OCPP16FirmwareStatusNotificationRequest
,
1468 OCPP16FirmwareStatusNotificationResponse
1469 >(chargingStation
, OCPP16RequestCommand
.FIRMWARE_STATUS_NOTIFICATION
, {
1470 status: chargingStation
.stationInfo
.firmwareUpgrade
.failureStatus
1472 chargingStation
.stationInfo
.firmwareStatus
=
1473 chargingStation
.stationInfo
.firmwareUpgrade
.failureStatus
1476 if (chargingStation
.stationInfo
?.firmwareUpgrade
?.reset
=== true) {
1477 await sleep(secondsToMilliseconds(randomInt(minDelay
, maxDelay
)))
1478 await chargingStation
.reset(OCPP16StopTransactionReason
.REBOOT
)
1482 private async handleRequestGetDiagnostics (
1483 chargingStation
: ChargingStation
,
1484 commandPayload
: GetDiagnosticsRequest
1485 ): Promise
<GetDiagnosticsResponse
> {
1487 !OCPP16ServiceUtils
.checkFeatureProfile(
1489 OCPP16SupportedFeatureProfiles
.FirmwareManagement
,
1490 OCPP16IncomingRequestCommand
.GET_DIAGNOSTICS
1494 `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetDiagnostics: Cannot get diagnostics: feature profile not supported`
1496 return OCPP16Constants
.OCPP_RESPONSE_EMPTY
1498 const { location
} = commandPayload
1499 const uri
= new URL(location
)
1500 if (uri
.protocol
.startsWith('ftp:')) {
1501 let ftpClient
: Client
| undefined
1503 const logConfiguration
= Configuration
.getConfigurationSection
<LogConfiguration
>(
1504 ConfigurationSection
.log
1506 const logFiles
= readdirSync(
1507 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1508 resolve((fileURLToPath(import.meta
.url
), '../', dirname(logConfiguration
.file
!)))
1510 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1511 .filter(file
=> file
.endsWith(extname(logConfiguration
.file
!)))
1512 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1513 .map(file
=> join(dirname(logConfiguration
.file
!), file
))
1514 const diagnosticsArchive
= `${chargingStation.stationInfo?.chargingStationId}_logs.tar.gz`
1515 create({ gzip
: true }, logFiles
).pipe(createWriteStream(diagnosticsArchive
))
1516 ftpClient
= new Client()
1517 const accessResponse
= await ftpClient
.access({
1519 ...(isNotEmptyString(uri
.port
) && { port
: convertToInt(uri
.port
) }),
1520 ...(isNotEmptyString(uri
.username
) && { user
: uri
.username
}),
1521 ...(isNotEmptyString(uri
.password
) && { password
: uri
.password
})
1523 let uploadResponse
: FTPResponse
| undefined
1524 if (accessResponse
.code
=== 220) {
1525 ftpClient
.trackProgress(info
=> {
1527 `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetDiagnostics: ${
1529 } bytes transferred from diagnostics archive ${info.name}`
1531 chargingStation
.ocppRequestService
1533 OCPP16DiagnosticsStatusNotificationRequest
,
1534 OCPP16DiagnosticsStatusNotificationResponse
1535 >(chargingStation
, OCPP16RequestCommand
.DIAGNOSTICS_STATUS_NOTIFICATION
, {
1536 status: OCPP16DiagnosticsStatus
.Uploading
1538 .catch((error
: unknown
) => {
1540 `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetDiagnostics: Error while sending '${
1541 OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION
1547 uploadResponse
= await ftpClient
.uploadFrom(
1548 join(resolve(dirname(fileURLToPath(import.meta
.url
)), '../'), diagnosticsArchive
),
1549 `${uri.pathname}${diagnosticsArchive}`
1551 if (uploadResponse
.code
=== 226) {
1552 await chargingStation
.ocppRequestService
.requestHandler
<
1553 OCPP16DiagnosticsStatusNotificationRequest
,
1554 OCPP16DiagnosticsStatusNotificationResponse
1555 >(chargingStation
, OCPP16RequestCommand
.DIAGNOSTICS_STATUS_NOTIFICATION
, {
1556 status: OCPP16DiagnosticsStatus
.Uploaded
1559 return { fileName
: diagnosticsArchive
}
1561 throw new OCPPError(
1562 ErrorType
.GENERIC_ERROR
,
1563 `Diagnostics transfer failed with error code ${accessResponse.code}|${uploadResponse.code}`,
1564 OCPP16IncomingRequestCommand
.GET_DIAGNOSTICS
1567 throw new OCPPError(
1568 ErrorType
.GENERIC_ERROR
,
1569 `Diagnostics transfer failed with error code ${accessResponse.code}|${uploadResponse?.code}`,
1570 OCPP16IncomingRequestCommand
.GET_DIAGNOSTICS
1573 await chargingStation
.ocppRequestService
.requestHandler
<
1574 OCPP16DiagnosticsStatusNotificationRequest
,
1575 OCPP16DiagnosticsStatusNotificationResponse
1576 >(chargingStation
, OCPP16RequestCommand
.DIAGNOSTICS_STATUS_NOTIFICATION
, {
1577 status: OCPP16DiagnosticsStatus
.UploadFailed
1580 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1581 return handleIncomingRequestError
<GetDiagnosticsResponse
>(
1583 OCPP16IncomingRequestCommand
.GET_DIAGNOSTICS
,
1585 { errorResponse
: OCPP16Constants
.OCPP_RESPONSE_EMPTY
}
1590 `${chargingStation.logPrefix()} Unsupported protocol ${
1592 } to transfer the diagnostic logs archive`
1594 await chargingStation
.ocppRequestService
.requestHandler
<
1595 OCPP16DiagnosticsStatusNotificationRequest
,
1596 OCPP16DiagnosticsStatusNotificationResponse
1597 >(chargingStation
, OCPP16RequestCommand
.DIAGNOSTICS_STATUS_NOTIFICATION
, {
1598 status: OCPP16DiagnosticsStatus
.UploadFailed
1600 return OCPP16Constants
.OCPP_RESPONSE_EMPTY
1604 private handleRequestTriggerMessage (
1605 chargingStation
: ChargingStation
,
1606 commandPayload
: OCPP16TriggerMessageRequest
1607 ): OCPP16TriggerMessageResponse
{
1608 const { requestedMessage
, connectorId
} = commandPayload
1610 !OCPP16ServiceUtils
.checkFeatureProfile(
1612 OCPP16SupportedFeatureProfiles
.RemoteTrigger
,
1613 OCPP16IncomingRequestCommand
.TRIGGER_MESSAGE
1615 !OCPP16ServiceUtils
.isMessageTriggerSupported(chargingStation
, requestedMessage
)
1617 return OCPP16Constants
.OCPP_TRIGGER_MESSAGE_RESPONSE_NOT_IMPLEMENTED
1620 !OCPP16ServiceUtils
.isConnectorIdValid(
1622 OCPP16IncomingRequestCommand
.TRIGGER_MESSAGE
,
1623 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1627 return OCPP16Constants
.OCPP_TRIGGER_MESSAGE_RESPONSE_REJECTED
1629 switch (requestedMessage
) {
1630 case OCPP16MessageTrigger
.BootNotification
:
1631 case OCPP16MessageTrigger
.Heartbeat
:
1632 case OCPP16MessageTrigger
.StatusNotification
:
1633 return OCPP16Constants
.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED
1635 return OCPP16Constants
.OCPP_TRIGGER_MESSAGE_RESPONSE_NOT_IMPLEMENTED
1639 private handleRequestDataTransfer (
1640 chargingStation
: ChargingStation
,
1641 commandPayload
: OCPP16DataTransferRequest
1642 ): OCPP16DataTransferResponse
{
1643 const { vendorId
} = commandPayload
1645 if (Object.values(OCPP16DataTransferVendorId
).includes(vendorId
)) {
1646 return OCPP16Constants
.OCPP_DATA_TRANSFER_RESPONSE_ACCEPTED
1648 return OCPP16Constants
.OCPP_DATA_TRANSFER_RESPONSE_UNKNOWN_VENDOR_ID
1650 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1651 return handleIncomingRequestError
<OCPP16DataTransferResponse
>(
1653 OCPP16IncomingRequestCommand
.DATA_TRANSFER
,
1655 { errorResponse
: OCPP16Constants
.OCPP_DATA_TRANSFER_RESPONSE_REJECTED
}
1660 private async handleRequestReserveNow (
1661 chargingStation
: ChargingStation
,
1662 commandPayload
: OCPP16ReserveNowRequest
1663 ): Promise
<OCPP16ReserveNowResponse
> {
1665 !OCPP16ServiceUtils
.checkFeatureProfile(
1667 OCPP16SupportedFeatureProfiles
.Reservation
,
1668 OCPP16IncomingRequestCommand
.RESERVE_NOW
1671 return OCPP16Constants
.OCPP_RESERVATION_RESPONSE_REJECTED
1673 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1674 commandPayload
.expiryDate
= convertToDate(commandPayload
.expiryDate
)!
1675 const { reservationId
, idTag
, connectorId
} = commandPayload
1676 if (!chargingStation
.hasConnector(connectorId
)) {
1678 `${chargingStation.logPrefix()} Trying to reserve a non existing connector id ${connectorId}`
1680 return OCPP16Constants
.OCPP_RESERVATION_RESPONSE_REJECTED
1682 if (connectorId
> 0 && !chargingStation
.isConnectorAvailable(connectorId
)) {
1683 return OCPP16Constants
.OCPP_RESERVATION_RESPONSE_REJECTED
1685 if (connectorId
=== 0 && !chargingStation
.getReserveConnectorZeroSupported()) {
1686 return OCPP16Constants
.OCPP_RESERVATION_RESPONSE_REJECTED
1688 if (!(await OCPP16ServiceUtils
.isIdTagAuthorized(chargingStation
, connectorId
, idTag
))) {
1689 return OCPP16Constants
.OCPP_RESERVATION_RESPONSE_REJECTED
1691 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1692 const connectorStatus
= chargingStation
.getConnectorStatus(connectorId
)!
1693 resetAuthorizeConnectorStatus(connectorStatus
)
1694 let response
: OCPP16ReserveNowResponse
1696 await removeExpiredReservations(chargingStation
)
1697 switch (connectorStatus
.status) {
1698 case OCPP16ChargePointStatus
.Faulted
:
1699 response
= OCPP16Constants
.OCPP_RESERVATION_RESPONSE_FAULTED
1701 case OCPP16ChargePointStatus
.Preparing
:
1702 case OCPP16ChargePointStatus
.Charging
:
1703 case OCPP16ChargePointStatus
.SuspendedEV
:
1704 case OCPP16ChargePointStatus
.SuspendedEVSE
:
1705 case OCPP16ChargePointStatus
.Finishing
:
1706 response
= OCPP16Constants
.OCPP_RESERVATION_RESPONSE_OCCUPIED
1708 case OCPP16ChargePointStatus
.Unavailable
:
1709 response
= OCPP16Constants
.OCPP_RESERVATION_RESPONSE_UNAVAILABLE
1711 case OCPP16ChargePointStatus
.Reserved
:
1712 if (!chargingStation
.isConnectorReservable(reservationId
, idTag
, connectorId
)) {
1713 response
= OCPP16Constants
.OCPP_RESERVATION_RESPONSE_OCCUPIED
1716 // eslint-disable-next-line no-fallthrough
1718 if (!chargingStation
.isConnectorReservable(reservationId
, idTag
)) {
1719 response
= OCPP16Constants
.OCPP_RESERVATION_RESPONSE_OCCUPIED
1722 await chargingStation
.addReservation({
1723 id
: commandPayload
.reservationId
,
1726 response
= OCPP16Constants
.OCPP_RESERVATION_RESPONSE_ACCEPTED
1731 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1732 chargingStation
.getConnectorStatus(connectorId
)!.status = OCPP16ChargePointStatus
.Available
1733 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1734 return handleIncomingRequestError
<OCPP16ReserveNowResponse
>(
1736 OCPP16IncomingRequestCommand
.RESERVE_NOW
,
1738 { errorResponse
: OCPP16Constants
.OCPP_RESERVATION_RESPONSE_FAULTED
}
1743 private async handleRequestCancelReservation (
1744 chargingStation
: ChargingStation
,
1745 commandPayload
: OCPP16CancelReservationRequest
1746 ): Promise
<GenericResponse
> {
1748 !OCPP16ServiceUtils
.checkFeatureProfile(
1750 OCPP16SupportedFeatureProfiles
.Reservation
,
1751 OCPP16IncomingRequestCommand
.CANCEL_RESERVATION
1754 return OCPP16Constants
.OCPP_CANCEL_RESERVATION_RESPONSE_REJECTED
1757 const { reservationId
} = commandPayload
1758 const reservation
= chargingStation
.getReservationBy('reservationId', reservationId
)
1759 if (reservation
== null) {
1761 `${chargingStation.logPrefix()} Reservation with id ${reservationId} does not exist on charging station`
1763 return OCPP16Constants
.OCPP_CANCEL_RESERVATION_RESPONSE_REJECTED
1765 await chargingStation
.removeReservation(
1767 ReservationTerminationReason
.RESERVATION_CANCELED
1769 return OCPP16Constants
.OCPP_CANCEL_RESERVATION_RESPONSE_ACCEPTED
1771 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1772 return handleIncomingRequestError
<GenericResponse
>(
1774 OCPP16IncomingRequestCommand
.CANCEL_RESERVATION
,
1777 errorResponse
: OCPP16Constants
.OCPP_CANCEL_RESERVATION_RESPONSE_REJECTED