TractionBattery Signals

IsHeaterActive

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

body

object

Show body properties

value

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.

body

object

Show body properties

unit

string

value

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.

body

object

Show body properties

source

string

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

capacity

number

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

availableCapacities

array

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

Show Array item properties

capacity

number

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

description

string

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

unit

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.

body

object

Show body properties

type

string

required

Possible values: DEFAULT

value

number

required

additionalValues

array

required

Show Array item properties

type

string

required

Possible values: IDEAL_CONDITIONS, ESTIMATED, RATED

value

number

required

unit

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).

body

object

Show body properties

unit

string

value

number

Example

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

Smartcar Signals & Attributes

Documentation Index

​IsHeaterActive

​MaxRangeChargeCounter

​NominalCapacity

​Range

​StateOfCharge

IsHeaterActive

MaxRangeChargeCounter

NominalCapacity

Range

StateOfCharge