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

Link copied to clipboard
object Companion
Link copied to clipboard
data class CurrentChargingProgressInfo(val currentBatteryChargeLevel: Energy, val maximumBatteryChargeLevel: Energy, val remainingRange: Distance) : Parcelable

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

Link copied to clipboard
data class CurrentChargingStopInfo(val chargingStation: ChargingStation, val remainingChargingTime: Duration, val expectedBatteryChargePercentage: Float) : Parcelable

A data class represents the information on the current charging stop.

Link copied to clipboard
Link copied to clipboard
sealed class LogInResult : Parcelable

Contains the result of a call to logIn.

Link copied to clipboard
sealed class LogOutResult : Parcelable

Contains the result of a call to logOut.

Link copied to clipboard

The result of a prepareForCharging call.

Properties

Link copied to clipboard

Provides charging progress information including the current battery charge level and the current vehicle range. null if the vehicle is not currently charging.

Link copied to clipboard

If the vehicle is navigating along a route and there is a charging stop planned and the vehicle is approaching or at this charging stop, this will contain details about it.

Link copied to clipboard

The authentication status of each eMSP known to the system.

Link copied to clipboard

The properties of each eMSP known to the system.

Link copied to clipboard

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

Link copied to clipboard
abstract val sessionInfo: SessionInfo?

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

Functions

Link copied to clipboard

Discards preparation made for charging the vehicle using prepareForCharging. Additionally this function discards any request to start charging an electric vehicle from user that has not yet been processed by the eMSPs. This function has no effect once the user has selected the charger and plugged in the charging cable to the vehicle. Should be called when the user has interacted with UI to abandon the charging preparation process.

Link copied to clipboard

Discards a request to start charge an electric vehicle using startCharging. In addition, this function discards the request to start charging an electric vehicle from user that has not yet been processed by the eMSPs. This function has no effect once the user has plugged in the charging cable to the vehicle. Should be called when the vehicle is waiting for charging cable to be plugged in and user has interacted with UI to abandon the start charging request process.

Link copied to clipboard
abstract suspend fun logIn(serviceIdentifier: EmspIdentifier): EvChargingMediatorService.LogInResult

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.

Link copied to clipboard
abstract suspend fun logOut(serviceIdentifier: EmspIdentifier): EvChargingMediatorService.LogOutResult

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.

Link copied to clipboard

This function should be called before the startCharging to set up a charging session.

Link copied to clipboard
abstract suspend fun provideOpenIdLoginResult(result: OpenIdLoginResult)

Clients should call this API to inform the platform of the result of the login process initiated by logIn if the login process was Open ID.

Link copied to clipboard
abstract suspend fun startCharging(chargingStation: ChargingStation, chargingPointId: ChargingPointId, serviceIdentifier: EmspIdentifier?)

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

Link copied to clipboard
abstract suspend fun stopCharging()

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