Home Assistant

← Vehicles

This page shows the nightly version. Switch to the release version.

Home Assistant instances in your network will be auto-discovered and suitable vehicle entities and services (e.g. sensor.*) will be suggested.

Parameters

Name	Description	Value	Level
uri	Home Assistant URI Example: http://homeassistant.local:8123		optional
soc	State of charge [%] Entity ID for the vehicle's battery state of charge in percent Example: sensor.vehicle_soc		optional
title	Title Will be displayed in the user interface		optional
capacity [kWh]	Battery capacity Example: 50		optional
range	Remaining range [km] Entity ID for the vehicle's remaining range in kilometers Example: sensor.vehicle_range		optional
status	Charging status Entity ID for charging status (A=disconnected, B=connected, C=charging) Example: sensor.vehicle_charging		optional
limitSoc	Target state of charge [%] Entity ID for the vehicle's target state of charge in percent (number or input_number entity) Example: number.vehicle_target_state_of_charge		optional
odometer	Odometer [km] Entity ID for the vehicle's odometer reading in kilometers Example: sensor.vehicle_odometer		optional
climater	Climatisation active Entity ID for the vehicle's climatisation state (binary_sensor with on/off state) Example: binary_sensor.vehicle_climater		optional
finishTime	Finish time Entity ID for the estimated charging finish time (ISO8601 or Unix timestamp) Example: sensor.vehicle_finish_time		optional
start_charging	Service to start charging Entity ID for a script or a switch that starts charging the vehicle. Only useful with the docs.evcc.io. If a switch is provided, Service to stop charging must be left empty. Example: script.vehicle_start_charge; switch.vehicle_charger		optional
stop_charging	Service to stop charging Entity ID for a script that stops charging the vehicle. Only useful with the docs.evcc.io. Example: script.vehicle_stop_charge		optional
wakeup	Service to wake up vehicle Entity ID for a script or a button that wakes up the vehicle Example: script.vehicle_wakeup; button.wakeup_vehicle		optional
setMaxCurrent	Set charging current [A] Entity ID for setting the maximum charging current in amperes (number or input_number entity) Example: number.vehicle_charging_current		optional
icon	Icon Will be displayed in the user interface Default: car	carbikebusmopedmotorcyclerocketscootertaxitractorrickshawshuttlevanairpurifierbatterybulbclimatecoffeemakercomputecookingcoolerdesktopdevicedishwasherdryerfloorlampgenericheaterheatexchangeheatpumpkettlelaundrylaundry2machinemetermicrowavepumpsmartconsumertoolwaterheater	advanced
phases	Maximum number of phases Used to determine the minimum solar surplus and plan duration.	123	advanced
mode	Default charging mode Applied when a vehicle is connected. Leave empty to keep the current mode.		advanced
minCurrent [A]	Minimum current The minimum current per connected phase that can be used Example: 6		advanced
maxCurrent [A]	Maximum current The maximum current per connected phase that can be used Example: 16		advanced
maxPower [W]	Maximum charging power hint Defines the maximum charging power of the vehicle. Helps improve charge plan accuracy when the vehicle typically uses less than the offered current or supports higher single-phase current compared to three-phase. The offered current of the loadpoint is not affected. Example: 10000		advanced
identifiers	RFID identification Used to assign the vehicle to a loadpoint via RFID card. The identifier is shown on the loadpoint. Copy the value from there. Learn more.		advanced
priority	Priority Priority of the loadpoint or vehicle in relation to other loadpoints or vehicles for allocating surplus energy (higher values, higher priority).		advanced
coarsecurrent	1A current control Vehicle supports 1A current steps only		advanced
streaming	Supports streaming Streaming data is received asynchronously Default: true		advanced
welcomecharge	Charge on connection Charger will enable charging for short time when vehicle is connected, irrespective of configured charge mode. This is useful for vehicles that require power supply when connecting.		advanced
climaterdisabled	Disable climater detection Ignore the vehicle's climater state for charge control, so charging stops at the SoC or energy limit even when the vehicle signals an active climater request.		advanced

Configuration example for evcc.yaml

If you don't want to configure via the UI, you can alternatively use this YAML block.

vehicles:
    - name: my_car
      type: template
      template: homeassistant
      uri: http://homeassistant.local:8123 # Home Assistant URI
      soc: sensor.vehicle_soc # State of charge [%], Entity ID for the vehicle's battery state of charge in percent
      title: # Title, Will be displayed in the user interface (optional)
      capacity: 50 # Battery capacity (kWh), optional
      range: sensor.vehicle_range # Remaining range [km], Entity ID for the vehicle's remaining range in kilometers (optional)
      status: sensor.vehicle_charging # Charging status, Entity ID for charging status (A=disconnected, B=connected, C=charging) (optional)
      limitSoc: number.vehicle_target_state_of_charge # Target state of charge [%], Entity ID for the vehicle's target state of charge in percent (`number` or `input_number` entity) (optional)
      odometer: sensor.vehicle_odometer # Odometer [km], Entity ID for the vehicle's odometer reading in kilometers (optional)
      climater: binary_sensor.vehicle_climater # Climatisation active, Entity ID for the vehicle's climatisation state (`binary_sensor` with `on`/`off` state) (optional)
      finishTime: sensor.vehicle_finish_time # Finish time, Entity ID for the estimated charging finish time (ISO8601 or Unix timestamp) (optional)
      start_charging: script.vehicle_start_charge; switch.vehicle_charger # Service to start charging, Entity ID for a script or a switch that starts charging the vehicle. Only useful with the [docs.evcc.io](https://docs.evcc.io/en/docs/devices/chargers#vehicle-api-only-charger). If a switch is provided, Service to stop charging must be left empty. (optional)
      stop_charging: script.vehicle_stop_charge # Service to stop charging, Entity ID for a script that stops charging the vehicle. Only useful with the [docs.evcc.io](https://docs.evcc.io/en/docs/devices/chargers#vehicle-api-only-charger). (optional)
      wakeup: script.vehicle_wakeup; button.wakeup_vehicle # Service to wake up vehicle, Entity ID for a script or a button that wakes up the vehicle (optional)
      setMaxCurrent: number.vehicle_charging_current # Set charging current [A], Entity ID for setting the maximum charging current in amperes (`number` or `input_number` entity) (optional)
      icon: car # Icon, Will be displayed in the user interface [car, bike, bus, moped, motorcycle, rocket, scooter, taxi, tractor, rickshaw, shuttle, van, airpurifier, battery, bulb, climate, coffeemaker, compute, cooking, cooler, desktop, device, dishwasher, dryer, floorlamp, generic, heater, heatexchange, heatpump, kettle, laundry, laundry2, machine, meter, microwave, pump, smartconsumer, tool, waterheater] (optional)
      phases: # Maximum number of phases, Used to determine the minimum solar surplus and plan duration. [1, 2, 3] (optional)
      mode: # Default charging mode, Applied when a vehicle is connected. Leave empty to keep the current mode. (optional)
      minCurrent: 6 # Minimum current (A), The minimum current per connected phase that can be used (optional)
      maxCurrent: 16 # Maximum current (A), The maximum current per connected phase that can be used (optional)
      maxPower: 10000 # Maximum charging power hint (W), Defines the maximum charging power of the vehicle. Helps improve charge plan accuracy when the vehicle typically uses less than the offered current or supports higher single-phase current compared to three-phase. _The offered current of the loadpoint is not affected._ (optional)
      identifiers: # RFID identification, Used to assign the vehicle to a loadpoint via RFID card. The identifier is shown on the loadpoint. Copy the value from there. [Learn more.](https://docs.evcc.io/en/docs/features/vehicle) (optional)
      priority: # Priority, Priority of the loadpoint or vehicle in relation to other loadpoints or vehicles for allocating surplus energy (higher values, higher priority). (optional)
      coarsecurrent: # 1A current control, Vehicle supports 1A current steps only (optional)
      streaming: true # Supports streaming, Streaming data is received asynchronously (optional)
      welcomecharge: # Charge on connection, Charger will enable charging for short time when vehicle is connected, irrespective of configured charge mode. This is useful for vehicles that require power supply when connecting. (optional)
      climaterdisabled: # Disable climater detection, Ignore the vehicle's climater state for charge control, so charging stops at the SoC or energy limit even when the vehicle signals an active climater request. (optional)