adminandClaude Opus 5.5
29ca9b5157
checks / unit (pull_request) Successful in 8m8s
- DOCS.md / config.yaml: the watchdog's P1 age entity is sensor.goodwe_p1_sample_age (device "GoodWe" + "P1 sample age", as app/mqtt.py announces and the live install recorded), not sensor.p1_sample_age_s. - DOCS.md: the inverters: example and per-entry table carry the required bms_soc_floor (and capacity_kwh); config.yaml's schema comment says four required keys, not three. - Field guide: marked v0.1.0/outdated; slew_w row no longer recommends the 1000 W that SAFETY-39 now refuses. HTML regenerated; the PDF is NOT rebuilt (no Chrome here). README/DOCS pointers fixed. - test_docs.py: the documented roster must pass app/validate.py and the schema's per-entry keys; the documented entity id must equal the id composed from app/mqtt.py; the wrong id may appear in no shipped doc. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BwRLw7eKYj2byVdwB6kbjU
126 lines
5.8 KiB
Markdown
126 lines
5.8 KiB
Markdown
# GoodWe RS485 Controller — Home Assistant add-on repository
|
|
|
|
Replaces a GoodWe battery inverter's vendor controller with a local one: holds
|
|
net grid exchange at zero by emulating the inverter's smart meter over RS485,
|
|
and runs the monthly battery maintenance cycle the vendor box was doing.
|
|
|
|
```
|
|
repository.yaml add-on repository metadata
|
|
goodwe_controller/ the add-on
|
|
config.yaml manifest + options schema (the per-site config form)
|
|
app/ the controller
|
|
control.py the control law — pure functions, no I/O
|
|
maintenance.py the monthly cycle state machine
|
|
hass.py Supervisor/Core API access
|
|
store.py persistent state in /data
|
|
mqtt.py optional status entities
|
|
web.py ingress UI — routes only, status and configuration
|
|
config_page.py the configuration page's markup, style and script
|
|
configui.py its field model, built from the Supervisor's own
|
|
schema + translations — owns no key, label or rule
|
|
selfconfig.py reading and writing this add-on's own options,
|
|
with the validate-first / compare-and-swap gate
|
|
main.py orchestration, heartbeat, failsafe behaviour
|
|
test_control.py runnable checks — no framework needed
|
|
test_maintenance.py runnable checks — walks a full cycle in fake time
|
|
DOCS.md the add-on's documentation tab
|
|
MUTATION.md how to run a mutation so the result means something
|
|
tools/mutation_run.sh the mutation harness - purges bytecode, then grades
|
|
tools/supervisor_selfapi_probe.py what the Supervisor really permits and
|
|
returns, run against its own release image
|
|
firmware/goodwe-master.yaml ESPHome config for the T-CAN485
|
|
estop/rs485_log.py optional RS485 e-stop / bus witness
|
|
docs/GoodWe-RS485-Field-Guide.pdf the guide techs carry (10pp, A4; outdated)
|
|
docs/build_guide.py its single source - rebuilds the HTML and PDF
|
|
FIELD-GUIDE.md how to edit and rebuild the guide
|
|
docs/RELEASE.md how a change reaches the battery - `master` is
|
|
protected, releases go via PR from `release/1.0`
|
|
```
|
|
|
|
**Picking this up after a break? Read `HANDOVER.md` first** — current state,
|
|
what is known broken, and what to do next.
|
|
|
|
## Install
|
|
|
|
Settings → Add-ons → Add-on store → ⋮ → **Repositories** → add
|
|
|
|
```
|
|
https://gittea.kammenstraatha.duckdns.org/admin/goodwe-addon
|
|
```
|
|
|
|
then install **GoodWe RS485 Controller**.
|
|
|
|
⚠️ **The repository must be PUBLIC for this to work.** Home Assistant clones it
|
|
anonymously; against a private repo the store shows nothing and gives no useful
|
|
error. If it must stay private, install locally instead: copy
|
|
`goodwe_controller/` into the machine's `/addons/` folder, then
|
|
`ha store reload` — it appears as a Local add-on.
|
|
|
|
⚠️ **Bump `version:` in `goodwe_controller/config.yaml` for every change.**
|
|
Supervisor keys the built image by that version, so without a bump it silently
|
|
reuses the old image and your fix appears not to work — on your bench and on
|
|
every client's machine.
|
|
|
|
Requires **Home Assistant OS or Supervised**. Add-ons cannot be installed on HA
|
|
Container or Core.
|
|
|
|
## Read this first
|
|
|
|
**The inverter holds its last command forever.** It has no meter-timeout of its
|
|
own — a controller that dies mid-command leaves the battery running until a
|
|
human intervenes. Measured on real hardware: 5 kW of discharge held for 113
|
|
seconds after a controller went silent.
|
|
|
|
Three layers exist because of that, and only the third covers the Home Assistant
|
|
machine itself dying:
|
|
|
|
1. **ESP32 watchdog** — no fresh setpoint for ~30 s → command 0 W, and keep
|
|
commanding it.
|
|
2. **Wind-down before firmware updates** — 0 W written before the update starts.
|
|
3. **RS485 e-stop (optional)** — writes 0 W after 30 s of total bus silence.
|
|
|
|
Sites sold without the e-stop must have the client acknowledgement in the field
|
|
guide (Step 7b) signed.
|
|
|
|
## Development
|
|
|
|
The control law and the maintenance machine are pure Python with no Home
|
|
Assistant imports, so they run anywhere:
|
|
|
|
```bash
|
|
cd goodwe_controller
|
|
python3 test_control.py
|
|
python3 test_maintenance.py
|
|
```
|
|
|
|
Both must pass before shipping any change. To prove a check *bites* - the way
|
|
almost every claim in this repository was established - mutate the module and
|
|
run `tools/mutation_run.sh`, which clears `__pycache__` first. It is not
|
|
optional: a same-size edit reverted inside one second leaves CPython reusing the
|
|
old bytecode, and the run grades code that is not there. `goodwe_controller/MUTATION.md`
|
|
has the mechanism, the measurement, and what the flags do not do. They are not unit-test theatre —
|
|
each assertion corresponds to a rule whose absence produced an observed failure
|
|
on real hardware, and the comments in `control.py` say which.
|
|
|
|
## Compatibility
|
|
|
|
**Check the serial number, not the model name.** Characters 6-8 of the serial are
|
|
the platform tag:
|
|
|
|
| tag | platform | verdict |
|
|
|---|---|---|
|
|
| `ESU EMU ESA BPS BPU EMJ IJL` | 105 — ES/EM/BP, AA55-era meter bus | **supported** |
|
|
| `SPB SPN` | 745 — SBP **G2** (`GW…-SBP-20`) | no |
|
|
| `ESN ESC` | 745 — ES **G2** (`GW…-ES-20`) | no |
|
|
| `ETU EHU BTU …` | 205/745/753 — ET/EH/BT hybrids | no |
|
|
| `SDT DST MSU NSU …` | PV-only inverters — no battery to control | no |
|
|
|
|
A "-20" or "G2" suffix means a different platform with a different meter
|
|
protocol. The tags come from the `goodwe` library's `PLATFORM_105_MODELS`, which
|
|
is also what Home Assistant's own integration uses to pick a protocol.
|
|
|
|
- GoodWe **ES / BP family** inverters (AA55 / RS485 meter-bus generation)
|
|
- The protocol is **reverse-engineered**. There is no vendor contract, and a
|
|
firmware change on GoodWe's side could break every installation at once. Say
|
|
so when you sell it.
|