platform_evcharging_api_service_evchargingmediator/com.tomtom.ivi.platform.evcharging.api.service.evchargingmediator/EvChargingMediatorService

EvChargingMediatorService

@IviExperimental(reasons = [])

interface EvChargingMediatorService

Service responsible for providing access to e-Mobility Service Providers (eMSPs) in the system. One or more eMSPs may be available and can be used to charge the vehicle.

Types

BatteryAndRangeInfo

data class BatteryAndRangeInfo(val currentChargeLevel: Int, val percentageChargeLevel: Int, val normalizedChargeLevel: Double, val remainingRange: Long) : Parcelable

A data class that represents information on battery charge level and remaining range.

Companion

object Companion

Properties

batteryAndRangeInfo

abstract val batteryAndRangeInfo: EvChargingMediatorService.BatteryAndRangeInfo?

emspAuthenticationStatus

abstract val emspAuthenticationStatus: MirrorableMap<EmspIdentifier, EmspAuthenticationStatus>

The authentication status of each eMSP known to the system.

emspInfos

abstract val emspInfos: MirrorableMap<EmspIdentifier, EmspServiceInfo>

The properties of each eMSP known to the system.

evChargingState

abstract val evChargingState: ChargingState

Indicates the charging state for UI flow shown to end-user.

isEvChargingModalPanelShown

abstract val isEvChargingModalPanelShown: Boolean

Indicates that whether or not Modal panel should be shown to end-user.

sessionInfo

abstract val sessionInfo: SessionInfo?

Session information: active charging point, session id and receipt of the charging session.

Functions

abstract suspend fun logIn(serviceIdentifier: EmspIdentifier)

Request to start the authentication process for the specified eMSP. serviceIdentifiers are the keys returned by EvChargingMediatorService.emspInfos. The exact flow of events that form the authentication process is dependent upon the eMSP integration.

logOut

abstract suspend fun logOut(serviceIdentifier: EmspIdentifier)

Request to log out of the eMSP service. The actual handling of this request should be implemented in the eMSP service plugin. See also EvChargingService.

onBatteryIconClicked

abstract suspend fun onBatteryIconClicked()

Called when the user clicks on the icon to open the EV charging UI.

onDismissEvChargingModalPanel

abstract suspend fun onDismissEvChargingModalPanel()

Called when the user has dismissed the EV charging modal panel.

startCharging

abstract suspend fun startCharging(chargingStation: ChargingStation, chargingPointId: ChargingPointId, serviceIdentifier: EmspIdentifier?)

Called when the user has interacted with the UI to initiate a charging session.

stopCharging

abstract suspend fun stopCharging()

Called when the user has interacted with the UI to stop an active charging session.