Installation guide · Home Assistant OS

Install TED directly in Home Assistant

On Home Assistant OS, TED installs as an app (formerly called add-on) on the same machine as Home Assistant: no Docker to handle, no access token to create, and TED's interface in the sidebar. Allow about fifteen minutes.

Is your Home Assistant concerned?

  • Home Assistant OS (Home Assistant Green or Yellow, Raspberry Pi, mini-PC, virtual machine) and Home Assistant Supervised: yes, follow this guide.
  • Home Assistant Container (Home Assistant in Docker) or Home Assistant Core: they cannot install apps. Install TED with Docker next to Home Assistant: NAS guide or Docker guide.

To check: if Home Assistant's Settings menu has an Apps entry (or Add-ons on versions before 2026), you can follow this guide. The exact type is shown in Settings › System › Repairs › ⋮ › System information, "Installation type" line.

Before you start

  • Your inverters and batteries visible in Home Assistant, through their brand's integration.
  • An electricity meter whose measurement (import and export) reaches Home Assistant, or a Shelly read directly by its IP address.
  • A 64-bit machine (Intel / AMD or ARM64: Raspberry Pi 4 or 5, Home Assistant Green or Yellow) with at least 1 GB of free space.
  • Internet access during installation: Home Assistant downloads Python and TED's components (about 60 MB).

No long-lived access token needed: the app automatically receives its access to Home Assistant.

Installation

The steps, in order

  1. 1

    Download the app and your license

    On the Download page, choose Home Assistant OS and enter your first name and email. You get:

    • your license file (ted-license-….json), to keep on your computer;
    • the ted-bot-v3.2-home-assistant.zip package (3,2 Mo), identical for every processor;
    • a personal command that does step 2 for you.
  2. 2

    Drop the app into Home Assistant

    The app must sit in Home Assistant's local apps folder, as a ted folder containing config.yaml. Two ways to do it.

    Method A, the simplest: the Home Assistant Terminal.

    1. Settings › Apps › button at the bottom right (app store): search for Terminal & SSH (official app), click Install, then Start. Enable Show in sidebar.
    2. Open Terminal from the sidebar.
    3. Paste the command copied from the Download page, then press Enter. It ends by listing TED's files (config.yaml, Dockerfile, app…).
    Example (copy yours from the Download page)
    D=/addons; [ -d /local_apps ] && D=/local_apps; cd "$D" && curl -fL -o ted.zip "https://ted-energy.fr/download/home-assistant/current?token=YOUR-PERSONAL-LINK" && rm -rf ted && unzip -q ted.zip && rm ted.zip && ls ted

    Method B: the network share (Samba).

    1. Install the official Samba share app; in its Configuration tab, choose a username and password, then start it.
    2. On your computer, unzip ted-bot-v3.2-home-assistant.zip: you get a ted folder.
    3. Open Home Assistant's local_apps share (formerly addons): \\homeassistant.local\local_apps in File Explorer, or smb://homeassistant.local/local_apps from Finder (Go › Connect to Server). Replace homeassistant.local with Home Assistant's IP address if needed.
    4. Copy the ted folder there: you must end up with local_apps/ted/config.yaml (not ted/ted/config.yaml).
  3. 3

    Install the TED app

    1. Settings › Apps › button at the bottom right (app store).
    2. ⋮ menu at the top right › Check for updates, then reload the browser page.
    3. At the top of the store, Local apps section: click TED Energy Pilot, then Install.

    Home Assistant then builds the app on your machine: allow 2 to 10 minutes (longer on a Raspberry Pi), without closing the page.

  4. 4

    Set start-up options and launch TED

    In the app's Info tab, enable Start on boot, Watchdog and Show in sidebar, then click Start. The Log tab then shows "TED … - application Home Assistant".

    The Configuration tab is optional: detailed log (diagnostics), log retention (14 days by default) and, under Network, the direct access port (5001 by default).

  5. 5

    Open TED and import your license

    Click TED in the sidebar (or Open web UI). In TED, Paramètres (Settings) page › Sauvegarde, restauration et licence › Importer une licence…, choose your license file.

    The connection to Home Assistant is automatic: in Paramètres › Connexion Home Assistant et compteur, the Tester button should answer "Home Assistant répond". Continue with the getting-started guide: meter, then inverters.

Day to day

Phone, updates and backups

Direct access and mobile app

TED also answers on http://HOME-ASSISTANT-ADDRESS:5001 from your local network. This is the address TED's Android app finds on its own over Wi-Fi. The app and the remote-access instructions are inside TED: Paramètres › Application mobile et accès à distance.

Updating TED

Download the new version (same page, same email) and drop it as in step 2: the Terminal command replaces the old version. Then store › ⋮ › Check for updates › TED › Update. Your settings and license are kept.

Your data and backups

TED stores its data in the local_ted folder of the app_configs share (formerly addon_configs). Home Assistant backups include it, except logs: restoring a backup also restores TED.

Migration

Already using TED with Docker?

Recover your settings, inverters, history and license by copying the runtime folder of the old installation.

  1. 1

    Stop the old TED

    For example sudo docker stop ted-bot on the NAS. Two TED instances must never control the same inverters at the same time.

  2. 2

    Install the app, then stop it

    Follow steps 1 to 4 above, start TED once to create its folder, then click Stop.

  3. 3

    Copy your data

    Copy the content of the old runtime folder (for example /volume1/docker/ted-bot/runtime) into local_ted/runtime of the app_configs share, replacing existing files.

  4. 4

    Restart the TED app

    You get your configuration and license back. The old installation's Home Assistant address and token are ignored: the connection now goes through Home Assistant.

Troubleshooting

A problem during installation?

TED does not appear in local apps

Check that the file is at local_apps/ted/config.yaml (not ted/ted/config.yaml). In the store, do ⋮ › Check for updates again, then fully reload the browser page. Errors, if any, are in Settings › System › Logs, "Supervisor" log.

The Terminal command shows an error

curl: (22) or unzip refusing the file: your personal link is no longer valid. Go back to the Download page with the same email and copy the command again. Could not resolve host: Home Assistant has no Internet access.

Installation fails or takes very long

Home Assistant must reach the Internet during installation and have at least 1 GB of free space. On a Raspberry Pi the build can take about ten minutes. If it fails, details are in the "Supervisor" log (Settings › System › Logs); then click Install again.

The meter or inverters do not show up

In TED, Paramètres › Connexion Home Assistant et compteur › Tester. If Home Assistant answers, check the exact entity names in Home Assistant (Developer tools › States). If the test fails, restart the TED app and check its Log tab.

Port 5001 is already in use

In the app's Configuration tab, Network section, enter another free port (preferably between 5000 and 5009, which the mobile app scans by itself), save and restart TED. The sidebar interface does not use this port.

How do I uninstall TED?

Settings › Apps › TED Energy Pilot › Uninstall, then delete the ted folder from local apps. Download your configuration first (in TED: Paramètres › Sauvegarde, restauration et licence).

TED running in Home Assistant? Move on to getting started.

License, meter and first inverters: the initial setup explained step by step.

Download for free