Current section
Files
Jump to
Current section
Files
specs/capabilities/home_charger.json
{
"name": "home_charger",
"name_cased": "homeCharger",
"name_pretty": "Home Charger",
"category": "infrastructure",
"authorization": true,
"identifier": {
"msb": 0,
"lsb": 96
},
"api": {
"intro": 6,
"update": 12
},
"getters": {},
"setters": [
{
"name": "set_charge_current",
"mandatory": [
14
],
"description": "Set the charge current of the home charger."
},
{
"name": "set_price_tariffs",
"mandatory": [
18
],
"description": "Set the price tariffs of the home charger."
},
{
"name": "activate_deactivate_solar_charging",
"mandatory": [
5
],
"description": "Activate or deactivate charging from solar power."
},
{
"name": "enable_disable_wi_fi_hotspot",
"mandatory": [
8
],
"description": "Enable or disable the Wi-Fi Hotspot."
},
{
"name": "authenticate_expire",
"mandatory": [
13
],
"description": "Authenticate or expire the charging session. Only if the session is authenticated can the charging be started by the vehicle."
}
],
"state": "all",
"properties": [
{
"id": 1,
"name": "charging_status",
"name_cased": "chargingStatus",
"name_pretty": "Charging status",
"type": "enum",
"size": 1,
"enum_values": [
{
"id": 0,
"name": "disconnected"
},
{
"id": 1,
"name": "plugged_in"
},
{
"id": 2,
"name": "charging"
}
],
"examples": [
{
"data_component": "02",
"value": "charging",
"description": "Charging is active"
}
]
},
{
"id": 2,
"name": "authentication_mechanism",
"name_cased": "authenticationMechanism",
"name_pretty": "Authentication mechanism",
"type": "enum",
"size": 1,
"enum_values": [
{
"id": 0,
"name": "pin",
"name_pretty": "PIN"
},
{
"id": 1,
"name": "app"
}
],
"examples": [
{
"data_component": "01",
"value": "app",
"description": "Authentication mechanism is an app"
}
]
},
{
"id": 3,
"name": "plug_type",
"name_cased": "plugType",
"name_pretty": "Plug type",
"type": "enum",
"size": 1,
"enum_values": [
{
"id": 0,
"name": "type_1"
},
{
"id": 1,
"name": "type_2"
},
{
"id": 2,
"name": "ccs",
"name_pretty": "Combined Charging System"
},
{
"id": 3,
"name": "chademo",
"name_pretty": "CHAdeMO"
}
],
"examples": [
{
"data_component": "01",
"value": "type_2",
"description": "Plug type is 'Type 2'"
}
]
},
{
"id": 4,
"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",
"examples": [
{
"data_component": "14024027000000000000",
"value": {
"kilowatts": 11.5
},
"description": "Charging power is 11.5kW"
}
]
},
{
"id": 5,
"name": "solar_charging",
"name_cased": "solarCharging",
"name_pretty": "Solar charging",
"type": "types.active_state",
"examples": [
{
"data_component": "01",
"value": "active",
"description": "Solar charging is active"
}
]
},
{
"id": 8,
"name": "wi_fi_hotspot_enabled",
"name_cased": "wifiHotspotEnabled",
"name_pretty": "Wi-Fi hotspot enabled",
"type": "types.enabled_state",
"examples": [
{
"data_component": "01",
"value": "enabled",
"description": "WiFi hotspot is enabled"
}
]
},
{
"id": 9,
"name": "wi_fi_hotspot_ssid",
"name_cased": "wifiHotspotSSID",
"name_pretty": "Wi-Fi hotspot SSID",
"type": "string",
"description": "The Wi-Fi Hotspot SSID",
"examples": [
{
"data_component": "436861726765722037363132",
"value": "Charger 7612",
"description": "WiFi hotspot SSID is 'Charger 7612'"
}
]
},
{
"id": 10,
"name": "wi_fi_hotspot_security",
"name_cased": "wiFiHotspotSecurity",
"name_pretty": "Wi-Fi hotspot security",
"type": "types.network_security",
"examples": [
{
"data_component": "03",
"value": "wpa2_personal",
"description": "WiFi hotspot security uses the WPA2-Personal algorithm"
}
]
},
{
"id": 11,
"name": "wi_fi_hotspot_password",
"name_cased": "wiFiHotspotPassword",
"name_pretty": "Wi-Fi hotspot password",
"type": "string",
"description": "The Wi-Fi Hotspot password",
"examples": [
{
"data_component": "5a57337641524e554265",
"value": "ZW3vARNUBe",
"description": "WiFi hotspot password is 'ZW3vARNUBe'"
}
]
},
{
"id": 13,
"name": "authentication_state",
"name_cased": "authenticationState",
"name_pretty": "Authentication state",
"type": "enum",
"size": 1,
"enum_values": [
{
"id": 0,
"name": "unauthenticated",
"verb": "expire_authentication"
},
{
"id": 1,
"name": "authenticated",
"verb": "authenticate"
}
],
"examples": [
{
"data_component": "01",
"value": "authenticated",
"description": "Is authenticated to the charger"
}
]
},
{
"id": 14,
"name": "charge_current",
"name_cased": "chargeCurrent",
"name_pretty": "Charge current",
"type": "unit.electric_current",
"size": 10,
"description": "The charge current",
"examples": [
{
"data_component": "09003fe0000000000000",
"value": {
"amperes": 0.5
},
"description": "Charger current is 0.5A"
}
]
},
{
"id": 15,
"name": "maximum_charge_current",
"name_cased": "maximumChargeCurrent",
"name_pretty": "Maximum charge current",
"type": "unit.electric_current",
"size": 10,
"description": "The maximum possible charge current",
"examples": [
{
"data_component": "09003ff0000000000000",
"value": {
"amperes": 1.0
},
"description": "Maximum charger current is 1.0A"
}
]
},
{
"id": 16,
"name": "minimum_charge_current",
"name_cased": "minimumChargeCurrent",
"name_pretty": "Minimum charge current",
"type": "unit.electric_current",
"size": 10,
"description": "The minimal possible charge current",
"examples": [
{
"data_component": "09003fb999999999999a",
"value": {
"amperes": 0.1
},
"description": "Minimum charger current is 0.1A"
}
]
},
{
"id": 17,
"name": "coordinates",
"name_cased": "coordinates",
"name_pretty": "Coordinates",
"type": "types.coordinates",
"examples": [
{
"data_component": "404a428f9f44d445402acf562174c4ce",
"values": {
"latitude": 52.520008,
"longitude": 13.404954
},
"description": "Charger is located at 52.520008:13.404954"
}
]
},
{
"id": 18,
"name": "price_tariffs",
"name_cased": "priceTariffs",
"name_pretty": "Price tariffs",
"type": "types.price_tariff",
"multiple": true,
"name_singular": "price_tariff",
"examples": [
{
"data_component": "0040120000000000000003455552",
"values": {
"pricing_type": "starting_fee",
"price": 4.5,
"currency": "EUR"
},
"description": "Charger starting fee tariff is 4.5\u20ac"
},
{
"data_component": "013fd33333333333330003455552",
"values": {
"pricing_type": "per_minute",
"price": 0.3,
"currency": "EUR"
},
"description": "Charger per minute fee tariff is 0.3\u20ac"
},
{
"data_component": "023fd33333333333330006526970706c65",
"values": {
"pricing_type": "per_kwh",
"price": 0.3,
"currency": "Ripple"
},
"description": "Charger per kWh tariff is 0.3RPL"
}
]
},
{
"id": 19,
"name": "charging_power",
"name_cased": "chargingPower",
"name_pretty": "Charging power",
"added": 12,
"type": "unit.power",
"size": 10,
"description": "Charging power output from the charger",
"examples": [
{
"data_component": "14024075e00000000000",
"value": {
"kilowatts": 350.0
},
"description": "Charging power is 350.0kW"
}
]
}
]
}