User Guide
From nothing installed to a battery being planned — and what to check when it is not.
Start here
Four steps, in order. Each is its own page, and the row above keeps them within one click of each other.
1 · Install
Home Assistant add-on, Docker or source — and the one volume mount worth getting right.
2 · First run
What the wizard asks, why in that order, and what it deliberately leaves for later.
3 · Living with it
Reading the dashboard, overriding the battery by hand, and what the system has learned.
4 · Troubleshooting
Sorted by the symptom you actually see, from startup crashes to sensors that read nothing.
What you need before you start
None of these is strictly required — EOS Connect starts with defaults and a demo solar curve so you can look around. They are what it takes to have it do something useful.
- Somewhere to run it: Home Assistant, a Docker host, or Python 3.13.
- A way to read your house: Home Assistant or openHAB, with a sensor reporting household consumption in watts.
- Your battery's capacity and its state-of-charge sensor.
- For control rather than advice: a supported inverter, or EVCC in front of one.
- An electricity tariff — a dynamic one is where this earns its keep, but a fixed rate works.
I want to…
- …install it as a Home Assistant add-on
- …run it in Docker without losing my settings on the next update
- …know what the wizard is going to ask me
- …understand why I cannot see a setting someone mentioned
- …override what the battery is doing right now
- …see what the forecast correction has learned
- …find out why my settings reverted after an update
- …work out why a sensor reads nothing
- …look up what a particular setting does
Beyond the guide
- Configuration — every setting, one page per topic, plus the full list to look a name up in.
- Advanced — REST API, MQTT topics and automation.
- What is EOS Connect — what it actually does with all of this.
- Discussions — ask a question.