Skip to content
EN | DE

Home Assistant

This guide describes the installation of evcc as a Home Assistant addon. Unlike the Linux installation or Docker installation, you don’t need command line knowledge here.

You need a Home Assistant installation with the Addon Store enabled. Depending on your installation type, this feature might not be available. See Home Assistant Documentation for more information.

The current stable version.

  1. Automatically add repository: Click on the following button and then on Open link, then on Add. Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.
  2. Manually add repository:
    1. Click on SettingsAddonsAdd-on Store
    2. Click on the three dotsRepositories
    3. Add the repository URL and click Add
      https://github.com/evcc-io/hassio-addon
  3. Reload the webpage
  4. Find the evcc addon and click on it
  5. Click on the INSTALL button

evcc can be configured in two ways:

Go to the Information tab in the evcc addon and activate Show in sidebar (evcc UI http://your-ha-instance-ip-address:7070)

Go to the Configuration tab and select your working directory (example):

Home Assistant addon configuration UI
Terminal window
- sqlite_file: /data/evcc.db

Leave the Network section unchanged.

Start the addon. Then open the evcc interface via the sidebar:

  • You’ll be prompted to set an administrator password
  • You can then configure your devices directly via the web interface
  • Settings are automatically saved in the database

Alternatively, you can use an evcc.yaml configuration file.

Go to the Configuration tab and add the configuration file to your working directory:

Terminal window
- config_file: /config/evcc.yaml
- sqlite_file: /data/evcc.db

Create an evcc configuration file evcc.yaml in your addon root configuration folder (/addon_configs/49686a9f_evcc). If this folder does not exist, create it manually.

To create or edit the configuration file, you have several options:

  • Visual Studio Code: Select the hamburger menu in the top left and choose “File”, “Open Folder…”, select /addon_configs/49686a9f_evcc
  • File Editor: Make sure you have disabled the “Enforce Basepath” option in the addon configuration, restart the addon and navigate to /addon_configs/49686a9f_evcc
  • Advanced SSH & Web Terminal: Navigate to /addon_configs/49686a9f_evcc and use e.g. nano

See Configuration for details on creating the configuration file.

If you want to see the system running in demo mode, just start evcc with the parameter --demo. See CLI Reference for more information.

The update to the latest version of evcc is integrated into the Home Assistant update process.

To perform the following functions, you need SSH access to Home Assistant. You can get this, for example, with the above-mentioned SSH Addon.

  • Install Advanced SSH & Web Terminal
  • Disable the “secure mode” in the Addon configuration
  • Restart the Addon
  • Open the Addon user interface

Show the files in /data:

Terminal window
docker exec addon_49686a9f_evcc ls -la /data

Copy the evcc.db to /addon_configs/49686a9f_evcc:

Terminal window
docker cp addon_49686a9f_evcc:/data/evcc.db /addon_configs/49686a9f_evcc/

Open a shell to the evcc Docker container:

Terminal window
docker exec -it addon_49686a9f_evcc /bin/sh

Run evcc CLI commands (here as an example checkconfig):

Terminal window
evcc -c /config/evcc.yaml checkconfig

Close the shell in the evcc Docker container if you are done:

Terminal window
exit

How can I use my external adapter / HAT in the Home Assistant evcc addon (Home Assistant OS, Raspberry Pi)?

Section titled “How can I use my external adapter / HAT in the Home Assistant evcc addon (Home Assistant OS, Raspberry Pi)?”

If your Home Assistant device is close to your meter (solar, battery, grid, …) you can also retrieve the data directly via Modbus (e.g. USB).

To do this, you need to enable external devices for Home Assistant, which also includes the evcc addon. To do this, uncomment the line uart = 1 in the config.txt file on the Home Assistant OS boot partition.

/config.txt
uart = 1

After a restart, your device should be available to the evcc addon (probably as /dev/ttyS0 or /dev/ttyUSB)

Once your system is running, you can set up the integration between evcc and Home Assistant. Under Integrations → Home Assistant you’ll find more information. You can visualize evcc data in Home Assistant or create automations based on evcc.