EvChargingService

@IviExperimental(reasons = [])
interface EvChargingService

An EvChargingService manages the charging of the electric vehicle at the charging station and allows the user to start the charging process and stop this process when required.

More than one EvChargingService can exist in the system at any one time, each implemented as a discoverable IVI service. Typically a EvChargingService implementation will support vehicle charging from a single specific e-Mobility Service Provider (eMSP).

See also

for more information

Types

Link copied to clipboard

Contains the result of a call to getChargingStationTariffs.

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The current status of the authentication process for this eMSP.

Link copied to clipboard

eMSP service information: name of the service provider and the icon associated with it.

Link copied to clipboard
abstract val sessionInfo: SessionInfo?

Information about the active session initiated by the driver. null if there is no session available.

Functions

Link copied to clipboard

Requests information about the tariffs for the specific chargingStationId.

Link copied to clipboard
abstract suspend fun logIn(): EvChargingResult

Request to authenticate with this eMSP service. The result of the authentication request can be monitored by observing the emspAuthenticationStatus.

Link copied to clipboard
abstract suspend fun logOut()

Logs the user out of the EvCharging service if they were previously logged in. The result of this process can be monitored by observing the emspAuthenticationStatus.

Link copied to clipboard

Receives the result of an OpenId authentication process. The authentication process would have been initiated by a call to logIn.

Link copied to clipboard
abstract suspend fun resetCharging(): EvChargingResult

This function resets the internal states of the service. Should be called when the electrical vehicle is neither currently being charged nor in the process of starting or stopping a charging session. Additionally it can be called following a failure.

Link copied to clipboard
abstract suspend fun startCharging(chargingStationId: ChargingStationId, chargingPointId: ChargingPointId, connectorId: ConnectorId): EvChargingResult

Initiates a charging session. The session is either terminated by the driver using the stopCharging or by the EVSE when the desired charging level is reached or the battery is full. The current state of the charging session can be monitored by observing sessionInfo.

Link copied to clipboard
abstract suspend fun stopCharging(): EvChargingResult

Terminates an active charging session, initiated using startCharging.