TractionBattery Signals

IsHeaterActive

GET /vehicles/{vehicleId}/signals/tractionbattery-isheateractive A boolean flag indicating whether the high voltage battery’s heating system is currently operating.

object

Show body properties

boolean

Example

{
  "value": false
}

MaxRangeChargeCounter

GET /vehicles/{vehicleId}/signals/tractionbattery-maxrangechargecounter A counter tracking the number of times the vehicle has been charged to its maximum range capacity.

object

Show body properties

string

integer

Example

{
  "value": 42
}

NominalCapacity

GET /vehicles/{vehicleId}/signals/tractionbattery-nominalcapacity An object containing the gross battery capacity and a list of multiple available gross capacity configurations for the high voltage battery.

object

Show body properties

string

Identifies the origin or method used to determine the battery’s gross capacity.Possible values: SMARTCAR, USER_SELECTED

number

The total gross energy storage capacity of the high voltage battery, typically measured in kilowatt-hours (kWh).

array

An array containing multiple available gross capacity configurations for the high voltage battery.

Show Array item properties

number

The total gross energy storage capacity of the high voltage battery, typically measured in kilowatt-hours (kWh).

string

A description of the specific battery capacity configuration, usually the trim of the vehicle.

string

Example

{
  "source": "SMARTCAR",
  "capacity": 75,
  "availableCapacities": [
    {
      "capacity": 55,
      "description": "Standard Range"
    },
    {
      "capacity": 75,
      "description": "Long Range"
    },
    {
      "capacity": 100,
      "description": "Performance"
    }
  ],
  "unit": "kWh"
}

Range

GET /vehicles/{vehicleId}/signals/tractionbattery-range Returns the most accurate real world estimate that is available. Estimated > Ideal > Rated.

object

Show body properties

string

required

Possible values: DEFAULT

number

required

array

required

Show Array item properties

string

required

Possible values: IDEAL_CONDITIONS, ESTIMATED, RATED

number

required

string

Example

{
  "value": 123.45,
  "type": "DEFAULT",
  "additionalValues": [
    {
      "type": "IDEAL_CONDITIONS",
      "value": 150
    },
    {
      "type": "ESTIMATED",
      "value": 140.75
    },
    {
      "type": "RATED",
      "value": 130.25
    }
  ],
  "unit": "km"
}

StateOfCharge

GET /vehicles/{vehicleId}/signals/tractionbattery-stateofcharge The current charge level of the high voltage battery, expressed as a percentage (0 - 100).

object

Show body properties

string

number

Example

{
  "value": 78,
  "unit": "percent"
}

​IsHeaterActive

​MaxRangeChargeCounter

​NominalCapacity

​Range

​StateOfCharge

IsHeaterActive

MaxRangeChargeCounter

NominalCapacity

Range

StateOfCharge