Skip to main content

Linux (Debian, Ubuntu, Raspberry Pi)

caution

This guide is aimed specifically at APT-based distributions. For distributions using other package managers, please install using Docker or Manual Installation.

Installation Guide​

note

The "evcc" user is created during installation - please make sure this user doesn't already exist!

  • Open a terminal

  • Install required dependencies:

    sudo apt install -y debian-keyring debian-archive-keyring apt-transport-https curl

  • Add the evcc APT repository:

Current stable release

curl -1sLf 'https://dl.evcc.io/public/evcc/stable/setup.deb.sh' | sudo -E bash
note

Hosted By: Cloudsmith

We would like to thank Cloudsmith for hosting the repository! Cloudsmith provides services to support the development of free software and platforms.

  • Update the package list:

    sudo apt update

  • Install evcc:

    sudo apt install -y evcc

  • Start the evcc server:

    sudo systemctl start evcc

  • Now check the installation by opening a browser to http://localhost:7070. You should see the evcc web interface in demo mode.

  • Stop the server:

    sudo systemctl stop evcc

  • You can now start the configuration wizard - simply follow the prompts in your terminal!

    evcc configure

    Once all devices are configured, you can continue on.

    tip

    The Configuration wizard is not available under the Home Assistant environment. You may find it easier to install evcc on another Windows or Linux system, use evcc configure there, and then copy the generated evcc.yaml to the desired system.

    note

    Advanced users (those with evcc experience & some technical know-how) might want to use the advanced configurator:

    evcc configure --advanced

    This mode offers some further, more technically-involved options.

  • Test to make sure your new configuration works:

    evcc -c evcc.yaml

    Open a browser and head to http://localhost:7070: the evcc interface should now show your own devices.

  • If everything's working, press CTRL+C to stop the server.

  • Move the generated configuration to its home:

    sudo mv evcc.yaml /etc

  • Start evcc:

    sudo systemctl start evcc

  • Go back to your browser and refresh to make sure everything's working as it should be!

Upgrades​

To update to the latest version of evcc, follow this guide:

  • Check the releases for breaking changes (BC) for your installation

  • Open a terminal

  • Update the package list:

    sudo apt update

  • Upgrade evcc:

    sudo apt --only-upgrade install -y evcc
info

If the unstable repository (nightly versions) has been added, the update will always be updated to the latest available nightly version. If this is no longer desired, the unstable repository can be removed using sudo rm /etc/apt/sources.list.d/evcc-unstable.list.

Downgrade​

If you need to go backwards for any reason, you can do so with this command:

  sudo apt install evcc=x.xxx.x # Version Number

Managing the Service​

evcc runs as a background system service. Here's some useful commands to control it:

sudo systemctl status evcc # shows status
sudo systemctl start evcc # start the service, if it isn't already running
sudo systemctl stop evcc # stops the service
sudo systemctl restart evcc # restart the service
sudo systemctl enable evcc # sets the service to run at boot
sudo systemctl disable evcc # stops the service running at boot

Useful Commands​

  • Show the service status:

    sudo systemctl status evcc

  • Show all log entries since yesterday:

    sudo journalctl -u evcc --since "yesterday"

  • Validate the meter configuration:

    sudo evcc -l debug meter

  • Validate the charger configuration:

    sudo evcc -l debug charger

  • Validate the vehicle configuration:

    sudo evcc -l debug vehicle