Charge Signals - smartcar

Amperage

Signal code: charge-amperage Current amperage flowing to the electric vehicle during a charging session, measured in amps.

unit

string

value

number

Example

{
  "unit": "amps",
  "value": 32
}

Max Amperage

Signal code: charge-amperagemax The maximum available amps available to charge.

unit

string

value

number

Example

{
  "unit": "amps",
  "value": 48
}

Amperage Requested

Signal code: charge-amperagerequested The requested amps to charge the vehicle.

unit

string

value

number

Example

{
  "unit": "amps",
  "value": 32
}

Charge Limits

Signal code: charge-chargelimits Object containing the default (global) charge limit configuration and configurations based on location, and charge connector type

values

array

Array of charge limit configurations, each representing a different context (global, location-based, or connector-based).

Show Array item properties

type

string

The type of charge limit configuration. “global” applies universally, “location” is specific to a location, and “connector” is specific to a charging connector type.Possible values: GLOBAL, LOCATION, CONNECTOR

limit

number

The maximum state of charge (SoC) limit configured for this context, expressed as a percentage (0-100).

condition

object

Additional context for location or connector-based charge limits. Null for global configurations.

Show condition properties

name

string

Name of the location or charging station where this limit applies.

address

string

Street address of the location where this limit applies.

latitude

number

Geographic latitude coordinate of the location where this limit applies.

longitude

number

Geographic longitude coordinate of the location where this limit applies.

connectorType

string

Type of charging connector where this limit applies (only used when type is “connector”).

activeLimit

number

Maximum state of charge (SoC) limit currently being applied to the vehicle, expressed as a percentage (0-100). This field will contain a numeric value when the vehicle is plugged in and charging, indicating which of the configured charge limits is currently active. When the vehicle is not plugged in or the active limit cannot be determined, this field will be null.

unit

string

The unit of measurement for the charge limits.

Example

{
  "values": [
    {
      "type": "global",
      "limit": 80,
      "condition": null
    },
    {
      "type": "location",
      "limit": 90,
      "condition": {
        "name": "Home",
        "address": "123 Main St",
        "latitude": 37.7749,
        "longitude": -122.4194
      }
    }
  ],
  "activeLimit": 100,
  "unit": "percent"
}

Charge Port Status Color

Signal code: charge-chargeportstatuscolor Current status indicator color displayed on or around the vehicle’s charging port.

value

string

Possible values: GREEN, BLUE, ORANGE, ETC

Example

{
  "value": "GREEN"
}

Charge Rate

Signal code: charge-chargerate Current rate at which range is being added to the vehicle during an active charging session

unit

string

value

number

Example

{
  "unit": "miles_per_hour",
  "value": 25
}

Records

Signal code: charge-chargerecords Collection of historical charging session data stored by the vehicle.

values

array

required

Array of individual charging session records, each representing a completed or ongoing charging event.

Show Array item properties

string

Unique OEM identifier assigned to the specific charging session.

cost

object

Detailed breakdown of the charging session costs.

Show cost properties

currency

string

Three-letter currency code (e.g., “USD”, “EUR”) representing the monetary unit used for the charging session transaction.

energyAmount

number

Cost specifically for the electrical energy consumed during the charging session.

otherAmount

number

Additional non-energy related charges (e.g., connection fees, parking fees) associated with the charging session.

endTime

string

ISO-8601 timestamp marking when a charging session was completed or terminated.

location

object

Details about where the charging session took place.

Show location properties

name

string

Descriptive name of the charging location (e.g., “Home Charger”, “Public Station 123”).

address

string

Street address of the charging location.

latitude

number

Geographic latitude coordinate of the charging location.

longitude

number

Geographic longitude coordinate of the charging location.

startTime

string

ISO-8601 timestamp marking when a charging session was initiated.

energyAdded

number

Total amount of electrical energy delivered during the charging session, measured in kilowatt-hours (kWh).

connectorType

string

Identifier for the type of charging connector used (e.g., “J1772”, “CCS”, “CHAdeMO”).

isPublicCharger

boolean

Indicates whether the charging occurred at a public charging station (true) or private location (false).

endStateOfCharge

number

Battery’s state of charge (0-100%) at the end of the charging session.

startStateOfCharge

number

Battery’s state of charge (0-100%) at the start of the charging session.

Example

{
  "values": [
    {
      "id": "CHG123",
      "cost": {
        "currency": "USD",
        "otherAmount": 2,
        "energyAmount": 10.5
      },
      "endTime": "2023-10-15T08:00:00Z",
      "location": {
        "name": "Home Charger",
        "address": "123 Main St",
        "latitude": 37.7749,
        "longitude": -122.4194
      },
      "startTime": "2023-10-15T00:00:00Z",
      "energyAdded": 40.5,
      "connectorType": "J1772",
      "isPublicCharger": false,
      "endStateOfCharge": 90,
      "startStateOfCharge": 20
    }
  ]
}

Charge Timers

Signal code: charge-chargetimers Object containing the default (global) charge timer configuration and configurations based on location, and charge connector type

values

array

Array of charging timer configurations, each defining either scheduled charging times or departure times.

Show Array item properties

type

string

The type of charging timer configuration. “global” applies universally, “location” is specific to a location, and “connector” is specific to a charging connector type.Possible values: GLOBAL, LOCATION, CONNECTOR

condition

object

Additional context for location or connector-based charging timers. Null for global configurations.

Show condition properties

name

string

Name of the location or charging station where this timer configuration applies.

address

string

Street address of the location where this timer configuration applies.

latitude

number

Geographic latitude coordinate of the location where this timer configuration applies.

longitude

number

Geographic longitude coordinate of the location where this timer configuration applies.

connectorType

string

Type of charging connector where this timer configuration applies (only used when type is “connector”).

schedules

array

Array of time windows during which charging should occur, defined by start and end times on specific days.

Show Array item properties

end

string

The time when the charging window should end, in 24-hour format (HH:MM:SS).

days

array

List of days of the week when this charging schedule should be active.

start

string

The time when the charging window should begin, in 24-hour format (HH:MM:SS).

departureTimers

array

Array of target departure times when the vehicle should be charged and ready to use.

Show Array item properties

days

array

List of days of the week when this departure timer should be active.

time

string

The target time when the vehicle should be fully charged and ready, in 24-hour format (HH:MM:SS).

isOEMOptimizationEnabled

boolean

Indicates whether the vehicle manufacturer’s smart charging optimization features are enabled for this timer configuration.

Charger Phases

Signal code: charge-chargerphases The number of phases available from the connected charger.

unit

string

value

integer

Example

{
  "unit": "count",
  "value": 3
}

Charging Connector Type

Signal code: charge-chargingconnectortype Identifier for the type of charging connector/inlet equipped on the vehicle.

value

string

Example

{
  "value": "J1772"
}

Detailed Charging Status

Signal code: charge-detailedchargingstatus String value that provides detailed information about the current state of the charging process.

value

string

required

Possible values: CHARGING, NOT_CHARGING, FULLY_CHARGED

Example

{
  "value": "CHARGING"
}

Energy Added

Signal code: charge-energyadded Cumulative amount of electrical energy delivered to the vehicle during the current or most recent charging session, measured in kilowatt-hours (kWh).

unit

string

value

number

Example

{
  "unit": "kilowatt_hours",
  "value": 25.5
}

Fast Charger Type

Signal code: charge-fastchargertype Identifier for the specific DC fast charging standard currently connected to the vehicle. Indicates the protocol being used for high-power charging

value

string

Example

{
  "value": "CCS"
}

Is Charging

Signal code: charge-ischarging Boolean indicator that shows whether the electric vehicle is actively receiving power from a charging station or outlet.

value

boolean

Example

{
  "value": true
}

Is Charging Cable Connected

Signal code: charge-ischargingcableconnected Boolean indicator that shows whether a charging cable is physically connected to the vehicle’s charging port.

value

boolean

Example

{
  "value": true
}

Is Charging Cable Latched

Signal code: charge-ischargingcablelatched Boolean indicator that shows whether the charging cable is securely locked to the vehicle’s charging port.

value

boolean

Example

{
  "value": true
}

Is Charging Port Flap Open

Signal code: charge-ischargingportflapopen Boolean indicator that shows whether the vehicle’s charging port access door or flap is currently open.

value

boolean

Example

{
  "value": true
}

Is Fast Charger Present

Signal code: charge-isfastchargerpresent Boolean indicator that shows whether the vehicle is connected to a DC fast charging station.

value

boolean

Example

{
  "value": true
}

Time To Complete

Signal code: charge-timetocomplete Estimated time remaining until the charging session reaches the activeLimit in minutes.

unit

string

value

number

Example

{
  "value": 45
}

Voltage

Signal code: charge-voltage Current voltage level being supplied to the electric vehicle during a charging session, measured in volts.

unit

string

value

number

Example

{
  "unit": "volts",
  "value": 240
}

Wattage

Signal code: charge-wattage Current power delivery rate to the electric vehicle during a charging session, measured in watts.

unit

string

value

number

Example

{
  "unit": "watts",
  "value": 250
}

Smartcar Signals & Attributes

​Amperage

​Max Amperage

​Amperage Requested

​Charge Limits

​Charge Port Status Color

​Charge Rate

​Records

​Charge Timers

​Charger Phases

​Charging Connector Type

​Detailed Charging Status

​Energy Added

​Fast Charger Type

​Is Charging

​Is Charging Cable Connected

​Is Charging Cable Latched

​Is Charging Port Flap Open

​Is Fast Charger Present

​Time To Complete

​Voltage

​Wattage

Amperage

Max Amperage

Amperage Requested

Charge Limits

Charge Port Status Color

Charge Rate

Records

Charge Timers

Charger Phases

Charging Connector Type

Detailed Charging Status

Energy Added

Fast Charger Type

Is Charging

Is Charging Cable Connected

Is Charging Cable Latched

Is Charging Port Flap Open

Is Fast Charger Present

Time To Complete

Voltage

Wattage