Home Charger

Auto API
Level 13
Last Updated
Level 12
Added In
Level 6
Identifier
0x00 0x60

This page specifies the Auto API protocol for Vehicle Status. Head over to the REST API, iOS SDK, Android SDK or Node.js SDK code reference pages for platform specifics.

Charging status

id: 0x01
name: charging_status
name_cased: chargingStatus
name_pretty: Charging status
type: enum
size: 1
enum_values:
  - id: 0x00
    name: disconnected
  - id: 0x01
    name: plugged_in
  - id: 0x02
    name: charging

Example

data_component: "02"
value: charging
description: Charging is active

Authentication mechanism

id: 0x02
name: authentication_mechanism
name_cased: authenticationMechanism
name_pretty: Authentication mechanism
type: enum
size: 1
enum_values:
  - id: 0x00
    name: pin
    name_pretty: PIN
  - id: 0x01
    name: app

Example

data_component: "01"
value: app
description: Authentication mechanism is an app

Plug type

id: 0x03
name: plug_type
name_cased: plugType
name_pretty: Plug type
type: enum
size: 1
enum_values:
  - id: 0x00
    name: type_1
  - id: 0x01
    name: type_2
  - id: 0x02
    name: ccs
    name_pretty: Combined Charging System
  - id: 0x03
    name: chademo
    name_pretty: CHAdeMO

Example

data_component: "01"
value: type_2
description: Plug type is 'Type 2'

Charging power (kW)

id: 0x04
name: charging_power_kw
name_cased: chargingPowerKW
name_pretty: Charging power (kW)
deprecated:
  new_name: charging_power
  reason: removed the unit from the name
type: unit.power
size: 10
description: Charging power

Example

data_component: "14024027000000000000"
value:
  kilowatts: 11.5
description: Charging power is 11.5kW

Solar charging

id: 0x05
name: solar_charging
name_cased: solarCharging
name_pretty: Solar charging
type: types.active_state

Example

data_component: "01"
value: active
description: Solar charging is active

Wi-Fi hotspot enabled

id: 0x08
name: wi_fi_hotspot_enabled
name_cased: wifiHotspotEnabled
name_pretty: Wi-Fi hotspot enabled
type: types.enabled_state

Example

data_component: "01"
value: enabled
description: WiFi hotspot is enabled

Wi-Fi hotspot SSID

id: 0x09
name: wi_fi_hotspot_ssid
name_cased: wifiHotspotSSID
name_pretty: Wi-Fi hotspot SSID
type: string
description: The Wi-Fi Hotspot SSID

Example

data_component: "436861726765722037363132"
value: Charger 7612
description: WiFi hotspot SSID is 'Charger 7612'

Wi-Fi hotspot security

id: 0x0a
name: wi_fi_hotspot_security
name_cased: wiFiHotspotSecurity
name_pretty: Wi-Fi hotspot security
type: types.network_security

Example

data_component: "03"
value: wpa2_personal
description: WiFi hotspot security uses the WPA2-Personal algorithm

Wi-Fi hotspot password

id: 0x0b
name: wi_fi_hotspot_password
name_cased: wiFiHotspotPassword
name_pretty: Wi-Fi hotspot password
type: string
description: The Wi-Fi Hotspot password

Example

data_component: 5a57337641524e554265
value: ZW3vARNUBe
description: WiFi hotspot password is 'ZW3vARNUBe'

Authentication state

id: 0x0d
name: authentication_state
name_cased: authenticationState
name_pretty: Authentication state
type: enum
size: 1
enum_values:
  - id: 0x00
    name: unauthenticated
    verb: expire_authentication
  - id: 0x01
    name: authenticated
    verb: authenticate

Example

data_component: "01"
value: authenticated
description: Is authenticated to the charger

Charge current

id: 0x0e
name: charge_current
name_cased: chargeCurrent
name_pretty: Charge current
type: unit.electric_current
size: 10
description: The charge current

Example

data_component: 09003fe0000000000000
value:
  amperes: 0.5
description: Charger current is 0.5A

Maximum charge current

id: 0x0f
name: maximum_charge_current
name_cased: maximumChargeCurrent
name_pretty: Maximum charge current
type: unit.electric_current
size: 10
description: The maximum possible charge current

Example

data_component: 09003ff0000000000000
value:
  amperes: 1
description: Maximum charger current is 1.0A

Minimum charge current

id: 0x10
name: minimum_charge_current
name_cased: minimumChargeCurrent
name_pretty: Minimum charge current
type: unit.electric_current
size: 10
description: The minimal possible charge current

Example

data_component: 09003fb999999999999a
value:
  amperes: 0.1
description: Minimum charger current is 0.1A

Coordinates

id: 0x11
name: coordinates
name_cased: coordinates
name_pretty: Coordinates
type: types.coordinates

Example

data_component: 404a428f9f44d445402acf562174c4ce
values:
  latitude: 52.520008
  longitude: 13.404954
description: Charger is located at 52.520008:13.404954

Price tariffs

id: 0x12
name: price_tariffs
name_cased: priceTariffs
name_pretty: Price tariffs
type: types.price_tariff
multiple: true
name_singular: price_tariff

Example

data_component: "0040120000000000000003455552"
values:
  pricing_type: starting_fee
  price: 4.5
  currency: EUR
description: Charger starting fee tariff is 4.5€
data_component: 013fd33333333333330003455552
values:
  pricing_type: per_minute
  price: 0.3
  currency: EUR
description: Charger per minute fee tariff is 0.3€
data_component: 023fd33333333333330006526970706c65
values:
  pricing_type: per_kwh
  price: 0.3
  currency: Ripple
description: Charger per kWh tariff is 0.3RPL

Charging power

id: 0x13
name: charging_power
name_cased: chargingPower
name_pretty: Charging power
added: 12
type: unit.power
size: 10
description: Charging power output from the charger

Example

data_component: "14024075e00000000000"
value:
  kilowatts: 350
description: Charging power is 350.0kW