Vehicle Integration Library/com.tomtom.automotive.integration.vehicle.client.api.vehicleinfo.batteryinfo/BatteryInfoParameters

BatteryInfoParameters

@Since(version = 1)
@JsonClass(generateAdapter = true)
data class BatteryInfoParameters(val currentBatteryCapacity: Energy, val stateOfEnergy: Energy, val stateOfCharge: Double, val batteryChargeCurve: List<BatteryInfoParameters.Point>)

Data class representing Electric Vehicle (EV) information. See LDEVR integration documentation for data semantics. All parameters in this class are dynamic and can change during the lifetime of the application. This data is critical for the navigation application startup, specifically for EV and Hybrid vehicles.

Constructors

Link copied to clipboard
constructor(currentBatteryCapacity: Energy, stateOfEnergy: Energy, stateOfCharge: Double, batteryChargeCurve: List<BatteryInfoParameters.Point>)

Types

Link copied to clipboard
@Since(version = 1)
@JsonClass(generateAdapter = true)
data class Point(val energy: Energy, val power: Power)

Data class representing a point in the charging curve. See LDEVR integration documentation for data semantics.

Properties

Link copied to clipboard
val batteryChargeCurve: List<BatteryInfoParameters.Point>

The battery charge curve.

Link copied to clipboard
val currentBatteryCapacity: Energy

Current Battery Capacity in Wh.

Link copied to clipboard
val stateOfCharge: Double

State of Charge (SoC) in percentage. The Current Battery Percentage as displayed to the user on the instrument cluster. Value range (0…100). Values outside this range are considered invalid.

Link copied to clipboard
val stateOfEnergy: Energy

State of Energy (SoE) in Wh.