Compare commits
31
Commits
@@ -0,0 +1,10 @@
|
|||||||
|
# This add-on is deployed to a Linux container. core.autocrlf=true on the
|
||||||
|
# authoring box gave the checkout CRLF, so a plain copy shipped CRLF files -
|
||||||
|
# run.sh with CRLF is a "bad interpreter" failure, and any hash-based drift
|
||||||
|
# check between repo and deployment fails for a reason that has nothing to do
|
||||||
|
# with the code. Deploy with:
|
||||||
|
# git -c core.autocrlf=false archive release/1.0 goodwe_controller | tar -x
|
||||||
|
# which is how 0.3.0 went out, byte-identical to the blobs.
|
||||||
|
* text=auto eol=lf
|
||||||
|
*.png binary
|
||||||
|
*.gz binary
|
||||||
+19
-2
@@ -12,7 +12,7 @@ a GoodWe GW5000S-BP.
|
|||||||
|
|
||||||
| | |
|
| | |
|
||||||
|---|---|
|
|---|---|
|
||||||
| running | `local_goodwe_controller` **0.2.0**, `boot: auto`, holding grid at zero |
|
| running | `local_goodwe_controller` **0.4.0**, `boot: auto`, holding grid at zero |
|
||||||
| installed as | a **Local** add-on: `/addons/goodwe_controller` on HA OS at 192.168.2.158 |
|
| installed as | a **Local** add-on: `/addons/goodwe_controller` on HA OS at 192.168.2.158 |
|
||||||
| repo | Gitea `admin/goodwe-addon` (ssh://git@192.168.2.147:2222) — **private** |
|
| repo | Gitea `admin/goodwe-addon` (ssh://git@192.168.2.147:2222) — **private** |
|
||||||
| tuning | gain 0.6, `max_w` 5000, slew 1000, deadband 15, step 10, saturation 500/3, heartbeat 10 s |
|
| tuning | gain 0.6, `max_w` 5000, slew 1000, deadband 15, step 10, saturation 500/3, heartbeat 10 s |
|
||||||
@@ -52,9 +52,26 @@ Run the checks before deploying. No framework needed:
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd goodwe_controller
|
cd goodwe_controller
|
||||||
python3 test_control.py && python3 test_maintenance.py && python3 test_arbiter.py
|
python3 test_control.py && python3 test_maintenance.py && python3 test_arbiter.py \
|
||||||
|
&& python3 test_validate.py && python3 test_p1.py && python3 test_watchdog.py \
|
||||||
|
&& python3 test_loop.py
|
||||||
```
|
```
|
||||||
|
|
||||||
|
`test_watchdog.py` covers SAFETY-02's logic and its trip path. Its headline
|
||||||
|
validation is not here at all: `sim/replay_sign.py` in the infra repo drives the
|
||||||
|
same module over the two captured RS485 days and must fire on all four of the
|
||||||
|
2026-08-20 episodes and stay silent on 2026-08-23. That needs both checkouts —
|
||||||
|
`GOODWE_ADDON_REPO=/path/to/goodwe-addon python3 sim/replay_sign.py`.
|
||||||
|
|
||||||
|
⚠️ `test_loop.py` takes about **95 seconds** (measured 93 s) and that is not a bug. It
|
||||||
|
drives the real control loop, which sleeps 1 s a tick, eight times over, to prove a
|
||||||
|
wall-clock property about it (SAFETY-12); mocking the clock there would leave the
|
||||||
|
assertion testing the mock. The other six suites together are ~440 checks and finish in
|
||||||
|
seconds — `test_watchdog.py` spends ~3 s of that driving a real `Controller` through a
|
||||||
|
trip. If you shorten `test_loop.py`'s windows, re-measure and correct this figure —
|
||||||
|
an understated runtime is what makes a slow test look like a hung one, and a slow test
|
||||||
|
that looks hung gets deleted.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 3. Known broken / unfinished
|
## 3. Known broken / unfinished
|
||||||
|
|||||||
@@ -1,5 +1,378 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## 0.5.0
|
||||||
|
|
||||||
|
**SAFETY-02 — the sign-disagreement watchdog.** The add-on now watches whether
|
||||||
|
the setpoint it is emitting and the grid figure it is regulating on point the
|
||||||
|
same way. If they oppose each other, both over `sign_disagree_w` (300 W), for
|
||||||
|
`sign_disagree_s` (180 s) **continuously**, it files a failsafe claim at
|
||||||
|
`P_SAFETY`, commands **0 W**, and latches there until an operator starts control
|
||||||
|
again. New module `app/watchdog.py`; new options `sign_disagree_w` and
|
||||||
|
`sign_disagree_s`.
|
||||||
|
|
||||||
|
This is the gap the existing failsafes leave open. The stale-input watchdog asks
|
||||||
|
whether the meter is still talking, the saturation freeze asks whether the
|
||||||
|
inverter can follow, the output clamp asks whether the number is too big — a
|
||||||
|
loop can pass all three while charging the battery out of the grid, because the
|
||||||
|
only thing wrong is the sign. On 2026-08-20 a commercial controller did exactly
|
||||||
|
that four times in one day, for up to 77 minutes at a stretch, and reached a
|
||||||
|
commanded −14 768 W against a ±5000 W inverter.
|
||||||
|
|
||||||
|
Validated against that day. `sim/replay_sign.py` in the infra repo drives this
|
||||||
|
module over the committed RS485 captures of both 2026-08-20 (the four episodes)
|
||||||
|
and 2026-08-23 (healthy): **18 trips on the fault day, every one inside a window
|
||||||
|
`NOTES.md` §4.7 accounts for, and 0 on the healthy day.** The four episodes do
|
||||||
|
share one signature rather than merely resembling each other — sign agreement
|
||||||
|
runs 0.3 / 0.9 / 10.5 / 0.0 % inside them against 92.9 % on the healthy day.
|
||||||
|
|
||||||
|
Three decisions worth knowing about:
|
||||||
|
|
||||||
|
- **It is disarmed whenever the grid-following loop is not what is driving.**
|
||||||
|
Sign agreement is a property of a loop that follows the meter. A maintenance
|
||||||
|
grid charge opposes the meter *by design* — 2500 W of charge into a house
|
||||||
|
drawing 500 W is +3000 W on the meter against a −2500 W command, for hours —
|
||||||
|
and armed unconditionally this would trip on every maintenance cycle. The gate
|
||||||
|
tests the emitted number, not the winning claim's name: a limit claim can let
|
||||||
|
the loop "win" and still replace its value with one pointing the other way.
|
||||||
|
- **The trip latches.** Commanding 0 W removes the command side of the
|
||||||
|
comparison, so the disagreement always clears the moment the trip works.
|
||||||
|
Un-latched, this would trip, clear, and hand the actuator back to the loop that
|
||||||
|
was driving the wrong way, every three minutes forever.
|
||||||
|
- **`sign_disagree_w` at or above `max_w` is refused at startup** (validator rule
|
||||||
|
5). The arbiter never lets a command exceed `max_w`, so such a threshold makes
|
||||||
|
the watchdog incapable of firing while the status page still reports it armed.
|
||||||
|
A disarmed guard that advertises itself as armed is the failure mode this
|
||||||
|
project keeps refusing to ship.
|
||||||
|
|
||||||
|
What it does **not** catch, stated so nobody assumes otherwise: an inverter that
|
||||||
|
acts opposite to what it was told moves the meter *further* the same way, so
|
||||||
|
command and meter agree while everything runs away. That is the saturation
|
||||||
|
freeze's job, which compares the command against the battery's actual power.
|
||||||
|
|
||||||
|
`test_validate.py`'s "the smallest sane max_w still starts" case now names a
|
||||||
|
reachable sign threshold, because a 1 W ceiling genuinely does disarm the 300 W
|
||||||
|
default and is now correctly refused.
|
||||||
|
|
||||||
|
## 0.4.0
|
||||||
|
|
||||||
|
**CFG-01.** The add-on now refuses to start on a configuration it cannot honour,
|
||||||
|
instead of logging a line and carrying on. `validate_startup_config()` runs in
|
||||||
|
`amain()` before the broker, the web server or any task exists, so a refusal
|
||||||
|
cannot leave half a controller running behind a UI.
|
||||||
|
|
||||||
|
It refuses only where continuing produces one of two outcomes: **(a)** a stated
|
||||||
|
limit is untrue - the operator configured a bound and a lower layer silently
|
||||||
|
enforces a different one - or **(b)** the add-on is inert and indistinguishable
|
||||||
|
from healthy. (b) is not a special case of (a): with no `setpoint_entity`, layer
|
||||||
|
1 pinning the inverter at 0 W is the failsafe *working*. The system does not
|
||||||
|
become unsafe, it becomes a convincing impression of a working controller.
|
||||||
|
|
||||||
|
Four things qualify:
|
||||||
|
|
||||||
|
- **`max_w` above (or below) the setpoint device's own rating.** This is the one
|
||||||
|
that changed behaviour. It used to warn `the device wins` and run anyway, with
|
||||||
|
`write_setpoint()` silently clamping, so the configured ceiling was never the
|
||||||
|
real one and the only evidence had scrolled off the log. The refusal names the
|
||||||
|
configured value, the device's value, and which wins.
|
||||||
|
- **No `setpoint_entity`.** A controller with no actuator: every write is a
|
||||||
|
no-op, the device rating is never read, and the ESP32 heartbeat that holds off
|
||||||
|
the layer-1 failsafe never happens. It ran, looked healthy, and moved nothing.
|
||||||
|
- **A `meter_source` that can never produce a reading** - missing `p1_host`,
|
||||||
|
missing `p1_net_entity`, a blank MQTT topic, a phase list disagreeing with
|
||||||
|
`meter_phases`, an unknown source name, or a `meter_poll_s` at or past
|
||||||
|
`meter_max_age_s`. These were already caught, but they only *disabled
|
||||||
|
ingestion*, which leaves the grid reading None forever: permanent "inputs
|
||||||
|
missing", 0 W, and a status page indistinguishable from a healthy meter nobody
|
||||||
|
has sent anything to yet.
|
||||||
|
- **`meter_max_age_s` above the firmware's ingest veto.** The schema accepts
|
||||||
|
`int(5,300)`; the ESP32's threshold is a compile-time `max_age_s: "30"` and it
|
||||||
|
trips layer 1 at `p1_age_s >= 30`. Set 120 and the add-on treats a 119 s
|
||||||
|
reading as fresh and keeps commanding, while the firmware has already vetoed
|
||||||
|
and is holding the inverter at 0 W - healthy meter, running controller,
|
||||||
|
nothing moving, and no line anywhere saying the number you set was overruled.
|
||||||
|
Structurally the same fault as the `max_w` case. Only *above* the veto is
|
||||||
|
refused: below it the add-on gives up first, which is fail-safe and visible on
|
||||||
|
its own status page. Mirrored as `validate.FIRMWARE_INGEST_VETO_S` - it cannot
|
||||||
|
be imported from a compile-time YAML substitution, so it carries a note about
|
||||||
|
the one direction in which it can go stale.
|
||||||
|
|
||||||
|
`max_w` at or below zero is refused too. Schema-blocked on a real install, but
|
||||||
|
`validate_startup_config()` is now also the simulation suite's entry point, and
|
||||||
|
a non-positive `max_w` inverts the arbiter's `supervised` bounds into a
|
||||||
|
contradiction that resolves to 0 W - i.e. it would read as a safety trip rather
|
||||||
|
than as the typo it is.
|
||||||
|
|
||||||
|
The predicates for the meter group still live in `p1.validate_meter_options()`,
|
||||||
|
which `build_source()` also calls - one definition, two callers, not two
|
||||||
|
competing validators. Two transports gained a check they never had: `ha_dsmr`
|
||||||
|
with only one of its two entities, and `mqtt_p1` with a blank topic, both of
|
||||||
|
which previously built a transport that could never read.
|
||||||
|
|
||||||
|
Deliberately **not** refused, because it is untidy rather than unsafe:
|
||||||
|
`integrator_max_w` above `max_w` (the arbiter still bounds the wire to ±max_w,
|
||||||
|
so the cost is unwind latency, not amperage - warned), a missing `soc_entity` /
|
||||||
|
`batt_entity` (fail-safe, and already a red NOT READY banner naming it), a
|
||||||
|
`setpoint_entity` that has not appeared on the Core API yet (ESPHome is routinely
|
||||||
|
late; refusing would make a slow boot need a human - re-checked once the real
|
||||||
|
rating arrives), and a thin-but-nonzero `meter_poll_s` margin.
|
||||||
|
|
||||||
|
A refusal is legible as a refusal: a banner that says in words that this is a
|
||||||
|
configuration problem and nothing is broken, the numbered problems, no traceback,
|
||||||
|
and exit status 78 (`EX_CONFIG`).
|
||||||
|
|
||||||
|
**SAFETY-12.** The control loop now evaluates on a clock as well as on a change.
|
||||||
|
`run_control()` ran `cycle()` only when the meter value differed from the
|
||||||
|
previous poll, so a meter that repeated a value ran **no control cycles at
|
||||||
|
all** - while the heartbeat went on re-emitting the last command and the
|
||||||
|
firmware went on putting it on the wire every 2 s. Layer 1 stayed fed, every
|
||||||
|
indicator read healthy, and a command computed from an old reading kept being
|
||||||
|
executed through whatever the load did next. Measured on the rig during TEL-05:
|
||||||
|
70 s at a literally constant 350.0 W with 14 arrivals and zero cycles.
|
||||||
|
|
||||||
|
**It was worse than a latency limit: it was a safety claim that could not
|
||||||
|
fire.** `stale_input_s` and the `inputs missing -> 0 W` claim both live *inside*
|
||||||
|
`cycle()`. Pre-fix, if the meter value happened to be constant, `cycle()` was
|
||||||
|
never called again - so that claim had no way to run. Constant meter, SoC entity
|
||||||
|
dying at t=4 s, same binary:
|
||||||
|
|
||||||
|
```
|
||||||
|
pre-fix writes: [(0.0, 220.0), (0.0, 220.0), (10.1, 220.0)]
|
||||||
|
final target: 220.0 W reason: 'loop -> 220 W'
|
||||||
|
post-fix writes: [(0.0, 220.0), (0.0, 220.0), (3.0, 430.0), (9.1, 0.0), (10.1, 0.0)]
|
||||||
|
final target: 0.0 W reason: 'safety -> 0 W'
|
||||||
|
```
|
||||||
|
|
||||||
|
The pre-fix controller held 220 W through the entire input outage with its
|
||||||
|
status line still reading `loop -> 220 W`, and layer 1 does not cover that case
|
||||||
|
on a `meter_source: off` install: no P1 age sensor is published, so the firmware
|
||||||
|
has nothing to veto on, while the heartbeat keeps its watchdog fed. So the old
|
||||||
|
behaviour was not "holds a stale command safely" - it was a failsafe that a
|
||||||
|
repeating meter switched off. `test_loop.py` asserts both halves.
|
||||||
|
|
||||||
|
`cycle_floor_s` (default **15 s**) is a deadline on the gap between cycles, not
|
||||||
|
a second scheduler: every cycle resets it, whichever trigger fired. On a healthy
|
||||||
|
meter it never elapses, so the cycle rate, the write sequence and therefore the
|
||||||
|
per-cycle gain the tuning was measured against are unchanged - asserted in
|
||||||
|
`test_loop.py` by driving the real loop twice on one binary (a huge
|
||||||
|
`cycle_floor_s` reproduces the old behaviour exactly) and comparing the
|
||||||
|
commanded values.
|
||||||
|
|
||||||
|
The reset is not the only thing holding that up, and the other argument is the
|
||||||
|
sturdier one: the combined cycle rate is `max(arrival rate, 1/floor)`, never the
|
||||||
|
sum. At 1/15 s the floor is strictly slower than the ~1/5 s arrival rate, so
|
||||||
|
even a hypothetical floor racing the arrivals could not exceed the nominal
|
||||||
|
healthy rate. The re-tune is unreachable by construction. ⚠️ That holds only
|
||||||
|
while `cycle_floor_s` stays above the meter's update interval, and the schema
|
||||||
|
minimum is 5 s - which is exactly the reference meter's interval. Nothing
|
||||||
|
enforces the relationship; `validate.py` is the obvious home for it and does not
|
||||||
|
have it yet.
|
||||||
|
|
||||||
|
Observed over six real minutes on the same rig, one binary, meter held at a
|
||||||
|
literally constant 350.0 W: **before, 1 cycle** (at startup) and then nothing,
|
||||||
|
the command stuck at 220 W against a 350 W import for the rest of the window.
|
||||||
|
**After, 24 cycles**, worst gap 15.14 s, and the ordinary PI ramp doing its job -
|
||||||
|
220, 430, 650, 860, 1080, 1300, 1510, 1730, 1940, 2000 W, one step per cycle,
|
||||||
|
rail at t=136 s and flat after. Three minutes with the meter parked at the
|
||||||
|
target instead: **1 cycle before, 12 after, and 19 writes either way - the same
|
||||||
|
19**. Three minutes on a normally-changing meter: **36 cycles and 49 writes on
|
||||||
|
both sides, the same values in the same order.** The heartbeat write count never
|
||||||
|
moves; the only writes the fix adds are the ten the loop was supposed to be
|
||||||
|
making all along.
|
||||||
|
|
||||||
|
15 s is bracketed, not round.
|
||||||
|
|
||||||
|
**Below it, ~11 s, and it arises more routinely than a dropped poll.**
|
||||||
|
`HomeWizardLocalSource` polls at 5.0 s against a meter that updates every 4.97 s
|
||||||
|
(NOTES.md:640). Two near-equal periods beat, so roughly once every ~14 minutes
|
||||||
|
the poller steps over an update entirely - a ~10 s gap between changed values on
|
||||||
|
a perfectly healthy meter, plus up to 1 s for the 1 s tick to notice. A failed
|
||||||
|
HTTP poll (retried on the next tick, no backoff) adds another 5 s. The floor
|
||||||
|
sits above the beat-skip so it does not fire on that alone; what it takes to
|
||||||
|
reach 15 s is a beat-skip *and* a failed poll coinciding.
|
||||||
|
|
||||||
|
**Above it, 30 s.** `meter_max_age_s` is 30 s, past which there is no reading to
|
||||||
|
evaluate, and the firmware's ingest veto is also 30 s - so the loop is
|
||||||
|
guaranteed to have re-decided at least twice inside any window in which layer 1
|
||||||
|
might otherwise be the only thing deciding. ⚠️ The default is therefore not
|
||||||
|
independently justified at 15: if the firmware's veto ever moves, this moves
|
||||||
|
with it. Noted beside the constant in `main.py`.
|
||||||
|
|
||||||
|
It is also exactly `stale_input_s`, this system's existing answer to "how long
|
||||||
|
may we hold without re-deciding".
|
||||||
|
|
||||||
|
A floor cycle runs the **full** law on the same inputs, integrator included. In
|
||||||
|
P1 mode the freshness question is already answered upstream and answered harder
|
||||||
|
- past `meter_max_age_s` the reading is None, which is "inputs missing", which
|
||||||
|
is a `P_SAFETY` 0 W claim - so a floor cycle there can only ever run on a reading
|
||||||
|
this system already calls fresh. ⚠️ That is transport-conditional: with
|
||||||
|
`meter_source: off`, `read_inputs()` takes the grid figure straight from
|
||||||
|
`hass.number()` with **no age gate at all**, so a Home Assistant entity that has
|
||||||
|
gone quiet reads as current on that path, with or without this change. Running
|
||||||
|
the full law is still right there - the alternative is a degraded second law
|
||||||
|
reasoning about an age nobody measured - but the floor does not make that path
|
||||||
|
fresh. The integrator advances per *cycle*, not per second,
|
||||||
|
so bounding the gap bounds the accumulation; `integrator_max_w` bounds it after
|
||||||
|
that. A gentler second law for floor cycles would be a second set of dynamics
|
||||||
|
nobody can test on this hardware.
|
||||||
|
|
||||||
|
⚠️ **This is not a freeze detector**, and TEL-05 established one cannot be built
|
||||||
|
here: at the converged -10 W target a 1 Wh register needs ~6 minutes to move
|
||||||
|
while the power figure legitimately repeats, so any threshold on `unchanged_s`
|
||||||
|
false-trips at the exact operating point we run at. Nothing in this change
|
||||||
|
decides whether a repeated reading is *true*. It stops "the number is the same"
|
||||||
|
from meaning "do not think". The consequence, stated plainly: against a meter
|
||||||
|
genuinely frozen at a wrong value the loop will now correct toward that wrong
|
||||||
|
value rather than hold a stale command, bounded by `max_w`, the arbiter and the
|
||||||
|
device rating. That was already what happened to a lying meter whose value
|
||||||
|
merely jittered; bit-exact repetition was never a safety property.
|
||||||
|
|
||||||
|
`DOCS.md`'s "Saturation is counted in cycles, not seconds" section documented
|
||||||
|
the old behaviour as an accepted deviation. It is **qualified, not deleted**:
|
||||||
|
the deviation survives (the window is still counted in cycles, and 3 x 15 s is
|
||||||
|
still not the specification's 10 s) but it is now bounded at 45 s instead of
|
||||||
|
open-ended, and the passage's second justification - "nothing accumulates while
|
||||||
|
it is stalled" - is called out as having covered integrator windup and not
|
||||||
|
staleness, which was the actual hazard. The same wrong argument in
|
||||||
|
`control.py`'s saturation comment is corrected too.
|
||||||
|
|
||||||
|
**TEL-04.** `meter_source: ha_signed` reads a single *signed* power entity, which
|
||||||
|
is the shape a HomeWizard P1 publishes. Both transports 0.3.0 shipped require two
|
||||||
|
unsigned registers and refuse negatives, so neither fits the meter installed here.
|
||||||
|
|
||||||
|
**TEL-05.** `meter_source: homewizard_local` polls the meter's own local API
|
||||||
|
directly. This exists because of something the HA paths cannot do: Home Assistant
|
||||||
|
fires no state change for a repeated reading and exposes no arrival signal at
|
||||||
|
all, so `sensor.p1_sample_age_s` on those transports measures time since the
|
||||||
|
*value changed*, not since the meter *reported*. Real captured data has gaps of
|
||||||
|
42 s and 97 s between changes on a perfectly healthy meter - long enough for a
|
||||||
|
30 s staleness threshold to command 0 W for no reason. Every HTTP response to the
|
||||||
|
local API is a genuine arrival, so the age means what it says.
|
||||||
|
|
||||||
|
Verified on the rig against a literally constant 350.0 W for 70 s - the exact
|
||||||
|
state where the HA path recorded zero samples in 45 s - with 14 arrivals and the
|
||||||
|
age never exceeding the poll cadence.
|
||||||
|
|
||||||
|
Set `p1_host` to the meter's address and `meter_poll_s` (default 5 s, matching
|
||||||
|
the meter's own ~5 s update). Still defaults to `off`; nothing changes for an
|
||||||
|
install that does not opt in.
|
||||||
|
|
||||||
|
Freeze detection is separate and deliberately not thresholded: a meter answering
|
||||||
|
200 OK with a stale number *is* arriving, so no arrival stamp can flag it. The
|
||||||
|
energy registers carry that as `unchanged_s`, surfaced on the status line for a
|
||||||
|
human to read rather than alarmed on - at a converged -10 W a 1 Wh register needs
|
||||||
|
about six minutes to move, so any threshold would false-trip at the target
|
||||||
|
operating point.
|
||||||
|
|
||||||
|
## Unreleased
|
||||||
|
|
||||||
|
**TEL-05.** A fourth `meter_source`, `homewizard_local`, which polls a
|
||||||
|
HomeWizard P1's **own local API** (`GET /api/v1/data`) instead of watching a
|
||||||
|
Home Assistant entity. Set `p1_host` to the meter's address; `meter_poll_s`
|
||||||
|
(default 5 s, the meter's own update rate) sets the cadence.
|
||||||
|
|
||||||
|
✅ **This is the first transport whose `sensor.p1_sample_age_s` measures when
|
||||||
|
the meter *reported*, and therefore the first one a firmware watchdog may
|
||||||
|
threshold.** Every HTTP response is an arrival: the meter answered, now, with
|
||||||
|
its current reading, and whether the *number* moved is not consulted. Home
|
||||||
|
Assistant cannot express that at all — a repeated reading emits no
|
||||||
|
`state_changed`, advances `last_reported` on neither serialiser, and
|
||||||
|
`state_reported` is not subscribable ("Event filter is required"). On
|
||||||
|
`ha_signed` that made a healthy meter under a flat load indistinguishable from
|
||||||
|
a dead one, and our own capture of this house's meter goes 42.2 s and 97.0 s
|
||||||
|
between changes — both past the default `meter_max_age_s` of 30, i.e. a false
|
||||||
|
trip to 0 W on a meter that is fine. If you have a HomeWizard P1, move to this
|
||||||
|
mode.
|
||||||
|
|
||||||
|
Everything TEL-01 established is reused, not re-implemented: ingest
|
||||||
|
timestamping, `meter_max_age_s`, the clock-recomputed age, the plausibility
|
||||||
|
bounds and the §20 unsigned-decode rejection, and the same `split_signed` sign
|
||||||
|
convention `ha_signed` uses. A failed or timed-out poll submits nothing, so it
|
||||||
|
is a *missing* reading — never 0 W — and it does not reset the age.
|
||||||
|
|
||||||
|
Verified on the ENV-01 rig against `sim/hwsim.py`, steady and with `--fault
|
||||||
|
freeze` injected. Still defaults to `off`.
|
||||||
|
|
||||||
|
⚠️ **An arrival stamp still cannot see a *frozen* meter**, and no arrival
|
||||||
|
detector can: a meter answering `200 OK` forever with a stale number is
|
||||||
|
arriving. The local API does expose what the HA path never had — the
|
||||||
|
`total_power_*_kwh` registers stop advancing — and the transport tracks it as
|
||||||
|
`unchanged_s`, but that is deliberately **not** folded into the age and not
|
||||||
|
thresholded: this controller regulates grid power toward ~0 W, and at a
|
||||||
|
converged −10 W the export register needs six minutes to move by its 1 Wh
|
||||||
|
resolution while the power figure legitimately repeats. Thresholding it at 30 s
|
||||||
|
would rebuild the false-trip limit cycle at the exact operating point we aim
|
||||||
|
for. Freeze detection needs the low-power case solved first, separately. It is
|
||||||
|
shown on the status page's P1 line instead — leaving it unthresholded only
|
||||||
|
holds up if a human can read it, so now they can.
|
||||||
|
|
||||||
|
**TEL-04.** A third `meter_source`, `ha_signed`, reading **one signed** Home
|
||||||
|
Assistant entity: positive = import, negative = export. That is the shape a
|
||||||
|
HomeWizard P1 publishes (`sensor.p1_meter_active_power`), and it is the meter
|
||||||
|
actually fitted here - which neither TEL-01 transport can read, because
|
||||||
|
`ha_dsmr` needs two unsigned registers and refuses a negative one, i.e. every
|
||||||
|
exporting telegram. Set `p1_net_entity`, and `p1_phase_net_entities` for the
|
||||||
|
per-phase capacity-tariff figures on a three-phase connection.
|
||||||
|
|
||||||
|
Everything TEL-01 established is inherited rather than re-implemented - the
|
||||||
|
new transport is a subclass of the `ha_dsmr` one overriding only which
|
||||||
|
entities it wants and how they become a sample. So ingest timestamping,
|
||||||
|
`meter_max_age_s`, `sensor.p1_sample_age_s` recomputed against the clock and
|
||||||
|
republished once a second, the plausibility bounds, and `unavailable` /
|
||||||
|
`unknown` treated as a *missing reading and never 0 W* all behave identically
|
||||||
|
across the three sources.
|
||||||
|
|
||||||
|
Still defaults to `off`; an existing install is unaffected until it opts in.
|
||||||
|
|
||||||
|
⚠️ **`sensor.p1_sample_age_s` is published on `ha_signed`, but must not yet be
|
||||||
|
thresholded by the ESP32 stale-input watchdog.** On the HA WebSocket paths the
|
||||||
|
age is stamped from `state_changed`, so it measures time since the value
|
||||||
|
*changed*, not since the meter *reported* - and Home Assistant exposes no
|
||||||
|
arrival signal for a repeated reading (no `state_changed`, no `last_reported`
|
||||||
|
movement on either serialiser, and `state_reported` is not subscribable over
|
||||||
|
the WebSocket). Measured on the ENV-01 rig against the real HomeWizard
|
||||||
|
integration. `ha_dsmr` mostly escapes it because a telegram moves several
|
||||||
|
entities at once; `ha_signed` has one, so a healthy meter under a flat load is
|
||||||
|
indistinguishable from a dead one. Our own capture has the house meter going
|
||||||
|
42.2 s and 97.0 s between changes. Raising `meter_max_age_s` does not fix that,
|
||||||
|
it only chooses which error you get; the fix is an arrival stamp from the meter
|
||||||
|
itself and is a separate ticket. Full detail in DOCS.md.
|
||||||
|
|
||||||
|
## 0.3.0
|
||||||
|
|
||||||
|
**SAFETY-04.** The control law's integrator is now an explicit accumulator,
|
||||||
|
bounded independently of the output clamp instead of inheriting whatever
|
||||||
|
headroom the clamp happened to leave. It also freezes while the inverter is
|
||||||
|
not tracking, rather than continuing to wind up against a command nothing is
|
||||||
|
acting on. `integrator_max_w` (default `0`) governs the bound; `0` means
|
||||||
|
"follow `max_w`", which is the existing behaviour.
|
||||||
|
|
||||||
|
Behaviour is unchanged at the defaults - a 4,928-case equivalence sweep
|
||||||
|
against the previous control law confirms it decides identically at
|
||||||
|
`integrator_max_w: 0`.
|
||||||
|
|
||||||
|
**TEL-01.** P1 meter ingestion, so a Belgian P1's two unsigned registers
|
||||||
|
(consumption, injection) no longer need a hand-written signed template
|
||||||
|
sensor: the subtraction moves into the add-on, done once and tested. Two
|
||||||
|
transports, chosen with the new `meter_source` option: `ha_dsmr` subscribes
|
||||||
|
to the DSMR integration over the HA WebSocket, `mqtt_p1` reads a topic.
|
||||||
|
Defaults to `off`, which keeps the existing `meter_entity` path untouched -
|
||||||
|
nothing changes for an install that does not opt in.
|
||||||
|
|
||||||
|
Enabling it publishes `sensor.p1_sample_age_s`: seconds since the newest
|
||||||
|
accepted telegram, recomputed against the clock and republished roughly once
|
||||||
|
a second rather than only when a telegram lands. That is deliberate - Home
|
||||||
|
Assistant only pushes a state on change, so a meter sitting at a genuinely
|
||||||
|
constant reading would otherwise look identical to a dead one. Watching the
|
||||||
|
age instead means a frozen meter shows a climbing age, not a flat line. The
|
||||||
|
firmware watchdog subscribes to this exact entity id.
|
||||||
|
|
||||||
|
Known limits, both already in DOCS.md: on `mqtt_p1`, a bridge stuck
|
||||||
|
republishing its last telegram still "arrives", so the age cannot detect
|
||||||
|
that particular failure - prefer `ha_dsmr` where both are available. And a
|
||||||
|
dead P1 meter takes 45 s to reach 0 W commanded (30 s for `meter_max_age_s`
|
||||||
|
to call the reading stale, then 15 s of `stale_input_s` on top), which is
|
||||||
|
`meter_max_age_s` and `stale_input_s` stacking, not either one alone.
|
||||||
|
|
||||||
## 0.2.1
|
## 0.2.1
|
||||||
|
|
||||||
`target_grid_w` (default -10 W): what the meter should rest at. The deadband
|
`target_grid_w` (default -10 W): what the meter should rest at. The deadband
|
||||||
|
|||||||
+239
-13
@@ -24,6 +24,9 @@ The inverter **holds its last command forever** — it has no meter-timeout. So:
|
|||||||
commanding it.
|
commanding it.
|
||||||
- This add-on commands 0 W when its inputs go missing, when you stop control,
|
- This add-on commands 0 W when its inputs go missing, when you stop control,
|
||||||
and when it shuts down.
|
and when it shuts down.
|
||||||
|
- This add-on commands 0 W **and latches there** if what it is commanding and
|
||||||
|
what the meter reads point opposite ways for three minutes — see "The
|
||||||
|
sign-disagreement failsafe" below.
|
||||||
- The **optional RS485 e-stop** is the only thing that covers this machine
|
- The **optional RS485 e-stop** is the only thing that covers this machine
|
||||||
dying. Without it, a failed host leaves the battery latched at its last
|
dying. Without it, a failed host leaves the battery latched at its last
|
||||||
command until someone intervenes.
|
command until someone intervenes.
|
||||||
@@ -51,21 +54,67 @@ phase having charged nothing.
|
|||||||
### P1 meter ingestion
|
### P1 meter ingestion
|
||||||
|
|
||||||
`meter_entity` above expects one signed sensor, which usually means a template
|
`meter_entity` above expects one signed sensor, which usually means a template
|
||||||
someone wrote by hand. A Belgian P1 meter does not publish one: it publishes two
|
someone wrote by hand. Setting `meter_source` moves the whole derivation into
|
||||||
**unsigned** registers, consumption and injection. Setting `meter_source` moves
|
the add-on, where it is done once and tested, and replaces `meter_entity`
|
||||||
that subtraction into the add-on, where it is done once and tested, and replaces
|
entirely.
|
||||||
`meter_entity` entirely.
|
|
||||||
|
Which mode you want depends on what your P1 reader publishes, and there are two
|
||||||
|
shapes in the wild:
|
||||||
|
|
||||||
|
- **Two unsigned registers**, consumption and injection, which is what a Belgian
|
||||||
|
P1 read over DSMR gives you → `ha_dsmr`, or `mqtt_p1` for a bridge. The add-on
|
||||||
|
subtracts them.
|
||||||
|
- **One signed figure**, positive = import and negative = export, which is what
|
||||||
|
a HomeWizard P1 gives you (`sensor.p1_meter_active_power`) → `ha_signed`. The
|
||||||
|
add-on splits it. `ha_dsmr` **cannot** read this: it wants two registers and
|
||||||
|
rejects a negative one outright, which is every exporting telegram.
|
||||||
|
|
||||||
|
Either way, do not build the missing shape out of template sensors. The point of
|
||||||
|
`meter_source` is that the sign convention is derived in one tested place rather
|
||||||
|
than in YAML nobody reviews underneath a safety input.
|
||||||
|
|
||||||
|
> ✅ **If your meter is a HomeWizard P1, use `homewizard_local`, not
|
||||||
|
> `ha_signed`.** It reads the same meter and produces the same numbers, but it
|
||||||
|
> polls the meter directly instead of watching a Home Assistant entity — and
|
||||||
|
> that is the difference between an age sensor a watchdog can threshold and one
|
||||||
|
> it cannot. See "`sensor.p1_sample_age_s`" below; `ha_signed` remains for
|
||||||
|
> installs where the meter is only reachable through Home Assistant.
|
||||||
|
|
||||||
|
> ⚠️ **`ha_dsmr` and `mqtt_p1` have never processed a telegram from real
|
||||||
|
> hardware.** No meter in this installation uses either one. Both were written
|
||||||
|
> to the assumption in `specs.md` §5.2 that a Belgian P1 exposes two unsigned
|
||||||
|
> registers, and the meter actually fitted here does not — it is the HomeWizard
|
||||||
|
> P1 that `ha_signed` reads. They are covered by the unit checks in `test_p1.py`
|
||||||
|
> and by an end-to-end test against a fake Home Assistant, and nothing more.
|
||||||
|
>
|
||||||
|
> This is recorded because the realistic way it bites is someone debugging a
|
||||||
|
> meter problem months from now treating those two paths as proven and looking
|
||||||
|
> for the fault elsewhere. If you are the first person to point one at a real
|
||||||
|
> meter, expect to find something, and please update this note when you do.
|
||||||
|
|
||||||
| option | default | meaning |
|
| option | default | meaning |
|
||||||
|---|---|---|
|
|---|---|---|
|
||||||
| `meter_source` | `off` | `off` keeps `meter_entity`. `ha_dsmr` subscribes to the DSMR integration over the HA WebSocket; `mqtt_p1` reads a topic |
|
| `meter_source` | `off` | `off` keeps `meter_entity`. `ha_dsmr` subscribes to the DSMR integration over the HA WebSocket; `mqtt_p1` reads a topic; `ha_signed` subscribes to one signed entity over the HA WebSocket; `homewizard_local` polls a HomeWizard P1's own local API, bypassing Home Assistant |
|
||||||
| `meter_phases` | 1 | 1 or 3. Must match the telegram, or every telegram is rejected and logged |
|
| `meter_phases` | 1 | 1 or 3. Must match the telegram, or every telegram is rejected and logged |
|
||||||
| `meter_max_age_s` | 30 | Beyond this the reading is stale and grid power reads as *missing*. On its own it does **not** command 0 W — see the timing note below. It is also the longest a reading is held forward into the 15-minute average |
|
| `meter_max_age_s` | 30 | Beyond this the reading is stale and grid power reads as *missing*. On its own it does **not** command 0 W — see the timing note below. It is also the longest a reading is held forward into the 15-minute average |
|
||||||
|
| `meter_poll_s` | 5 | `homewizard_local` only. Seconds between polls. **Must be well under `meter_max_age_s`** — see below |
|
||||||
|
| `p1_host` | | `homewizard_local` only. The meter's own address, `host` or `host:port` (e.g. `192.168.2.250`) |
|
||||||
| `meter_mqtt_topic` | | `mqtt_p1` only |
|
| `meter_mqtt_topic` | | `mqtt_p1` only |
|
||||||
| `p1_import_entity` | | The **unsigned** consumption sensor. Do not point this at a signed template |
|
| `p1_import_entity` | | The **unsigned** consumption sensor. Do not point this at a signed template |
|
||||||
| `p1_export_entity` | | The **unsigned** injection sensor |
|
| `p1_export_entity` | | The **unsigned** injection sensor |
|
||||||
| `p1_phase_import_entities` | `[]` | L1..L3, in order. Needed for the capacity-tariff peak on a three-phase connection |
|
| `p1_phase_import_entities` | `[]` | L1..L3, in order. Needed for the capacity-tariff peak on a three-phase connection |
|
||||||
| `p1_phase_export_entities` | `[]` | L1..L3, in order |
|
| `p1_phase_export_entities` | `[]` | L1..L3, in order |
|
||||||
|
| `p1_net_entity` | | `ha_signed` only. The **signed** net-power sensor: `+` import, `-` export |
|
||||||
|
| `p1_phase_net_entities` | `[]` | `ha_signed` only. L1..L3, in order, each signed the same way. Needed for the capacity-tariff peak on a three-phase connection. **The list length must equal `meter_phases`** |
|
||||||
|
|
||||||
|
Both per-phase lists are checked against `meter_phases` **once at startup**: a
|
||||||
|
list of the wrong length disables P1 ingestion with an error in the log, rather
|
||||||
|
than letting every telegram fail its phase-count check one at a time. Leaving
|
||||||
|
the list empty is fine and is not an error — you simply get no per-phase
|
||||||
|
figures, and therefore no capacity-tariff peak. On a three-phase connection
|
||||||
|
that is a much bigger omission than it looks: on a surveyed reading here the
|
||||||
|
phases carried 2769 W of import while the connection netted 187 W, so the
|
||||||
|
billed quantity is understated roughly fifteenfold if the phases are missing.
|
||||||
|
|
||||||
#### How long a dead meter takes to reach 0 W
|
#### How long a dead meter takes to reach 0 W
|
||||||
|
|
||||||
@@ -106,6 +155,55 @@ tested, and guessing a key here means guessing a kilowatt:
|
|||||||
it is present it is used for the age, which is what stops a retained message
|
it is present it is used for the age, which is what stops a retained message
|
||||||
replayed on reconnect from presenting a ten-minute-old reading as current.
|
replayed on reconnect from presenting a ten-minute-old reading as current.
|
||||||
|
|
||||||
|
#### `homewizard_local` — polling the meter instead of Home Assistant
|
||||||
|
|
||||||
|
Set `p1_host` to the meter's address and the add-on does `GET /api/v1/data` on
|
||||||
|
it every `meter_poll_s` seconds, reading `active_power_w` (signed, same
|
||||||
|
convention as `ha_signed`) and the three `active_power_l{1,2,3}_w` fields. Home
|
||||||
|
Assistant is not involved: no entity, no WebSocket, no integration to
|
||||||
|
mis-configure. Per-phase figures are used only when the meter serves all
|
||||||
|
`meter_phases` of them — a single-phase meter returns `null` for L2/L3, and the
|
||||||
|
connection-level reading is still accepted on its own.
|
||||||
|
|
||||||
|
**Why this mode exists:** every HTTP response is an *arrival*. The meter
|
||||||
|
answered, now, with its current reading — whether or not the number moved. That
|
||||||
|
is the signal `sensor.p1_sample_age_s` needs and the one Home Assistant cannot
|
||||||
|
give it at all (see the note below). It is also simply fewer moving parts: the
|
||||||
|
five-second cadence is the meter's own, rather than an integration's polling of
|
||||||
|
it re-published as a state change.
|
||||||
|
|
||||||
|
**Cadence.** The age is never fresher than the poll interval, so:
|
||||||
|
|
||||||
|
| | |
|
||||||
|
|---|---|
|
||||||
|
| meter's own update rate | ~5.0 s (measured 4.97 s) |
|
||||||
|
| `meter_poll_s` default | 5 s — nothing to gain below the meter's own rate |
|
||||||
|
| `meter_max_age_s` default | 30 s, i.e. six polls of headroom |
|
||||||
|
| `meter_poll_s >= meter_max_age_s` | **refused at startup** — every reading would be stale before its successor arrived |
|
||||||
|
| `meter_poll_s > meter_max_age_s / 2` | warned — one missed poll makes the reading stale |
|
||||||
|
|
||||||
|
A failed poll — timeout, connection refused, non-200, unparseable body — is a
|
||||||
|
**missing** reading. It submits nothing, so the reading does not become 0 W, the
|
||||||
|
last good value and its timestamp are left alone, and the age goes on climbing.
|
||||||
|
That is exactly what a dead meter should look like.
|
||||||
|
|
||||||
|
**What it still cannot see: a frozen meter.** A meter that answers `200 OK`
|
||||||
|
forever with a stale number is arriving, so no arrival detector — this one
|
||||||
|
included — can tell it from a healthy one. The local API does expose the raw
|
||||||
|
material the HA path never had (the `total_power_*_kwh` registers stop
|
||||||
|
advancing), and the transport tracks it as `unchanged_s`, but it is deliberately
|
||||||
|
*not* folded into the age and *not* thresholded: this controller regulates grid
|
||||||
|
power toward ~0 W, and at a converged −10 W the export register needs six
|
||||||
|
minutes to move by its 1 Wh resolution while the power figure legitimately
|
||||||
|
repeats. Thresholding that at 30 s would rebuild the false-trip limit cycle at
|
||||||
|
the exact operating point the controller aims for. Freeze detection is a
|
||||||
|
separate problem and needs the low-power case solved first.
|
||||||
|
|
||||||
|
You read it yourself instead: the add-on's status page shows it on the P1 line,
|
||||||
|
as `… 4 rejected, measurement unchanged for 312 s`. On a house drawing real
|
||||||
|
power that figure stays in the seconds; minutes of it while the load is clearly
|
||||||
|
not near zero is the meter to go and look at.
|
||||||
|
|
||||||
#### `sensor.p1_sample_age_s`
|
#### `sensor.p1_sample_age_s`
|
||||||
|
|
||||||
Published over MQTT discovery whenever a broker is available: **seconds since the
|
Published over MQTT discovery whenever a broker is available: **seconds since the
|
||||||
@@ -123,13 +221,48 @@ The entity is only created when `meter_source` is not `off`. With P1 ingestion
|
|||||||
disabled there is nothing feeding it, and an age sensor climbing with no ingester
|
disabled there is nothing feeding it, and an age sensor climbing with no ingester
|
||||||
behind it would trip the firmware watchdog on a system that is working fine.
|
behind it would trip the firmware watchdog on a system that is working fine.
|
||||||
|
|
||||||
> **Known limit, `mqtt_p1` only.** The age measures *arrival*, not change. On the
|
> **Known limit, `mqtt_p1`.** The age measures *arrival*. On the MQTT path a
|
||||||
> `ha_dsmr` path that is exactly right: a frozen meter emits no `state_changed`,
|
> bridge that is stuck republishing its last telegram keeps arriving, so the age
|
||||||
> so nothing arrives and the age climbs. On the MQTT path a bridge that is stuck
|
> stays near zero and a frozen meter still looks fresh. Detecting *that* needs a
|
||||||
> republishing its last telegram keeps arriving, so the age stays near zero and a
|
> change-detector rather than an arrival-detector, and it is not in this version.
|
||||||
> frozen meter still looks fresh. Detecting *that* needs a change-detector rather
|
|
||||||
> than an arrival-detector, and it is not in this version. Prefer `ha_dsmr` where
|
> ⚠️ **Known limit, `ha_signed` — do not drive a watchdog off this age yet.**
|
||||||
> both are available.
|
> On the HA WebSocket paths the age is stamped when a `state_changed` arrives,
|
||||||
|
> which means it measures *time since the value last changed*, not time since
|
||||||
|
> the meter last reported. Home Assistant offers nothing better: a repeated
|
||||||
|
> reading produces no `state_changed`, does **not** advance `last_reported` on
|
||||||
|
> either the REST or the WebSocket serialiser, and `state_reported` cannot be
|
||||||
|
> subscribed to over the WebSocket at all (`Event filter is required for event
|
||||||
|
> state_reported`). All three measured on the ENV-01 rig against the real
|
||||||
|
> HomeWizard integration with the meter frozen: 0 `state_changed` in 70 s and no
|
||||||
|
> timestamp movement anywhere.
|
||||||
|
>
|
||||||
|
> `ha_dsmr` mostly escapes this because a DSMR telegram updates several entities
|
||||||
|
> and something in the set almost always moves. **`ha_signed` has exactly one
|
||||||
|
> entity, so a healthy meter under a flat load is indistinguishable from a dead
|
||||||
|
> one.** This is not hypothetical: in our own captures
|
||||||
|
> (`sim/scenarios/ha-p1_meter_active_power-2026-08-20.json`) the real house meter
|
||||||
|
> went **42.2 s and 97.0 s** between changes, and 23 Aug peaks at 29.1 s — all
|
||||||
|
> past the default `meter_max_age_s` of 30.
|
||||||
|
>
|
||||||
|
> So `sensor.p1_sample_age_s` on `ha_signed` is safe to *read*, and it is
|
||||||
|
> correct whenever the value is moving, but it must not yet be thresholded by
|
||||||
|
> the ESP32 stale-input watchdog: a quiet house would trip the battery to 0 W.
|
||||||
|
> Raising `meter_max_age_s` is **not** the fix — the two conditions produce an
|
||||||
|
> identical signal, so a bigger number only chooses which of the two errors you
|
||||||
|
> get. The real fix is an arrival stamp the meter itself provides — and that now
|
||||||
|
> exists: **`meter_source: homewizard_local`**. If you have a HomeWizard P1,
|
||||||
|
> switch to it. If your meter is only reachable through Home Assistant, this
|
||||||
|
> limit still applies to you and the watchdog threshold still must not be armed.
|
||||||
|
|
||||||
|
**Where the age is trustworthy:**
|
||||||
|
|
||||||
|
| mode | the age measures | safe to threshold from firmware |
|
||||||
|
|---|---|---|
|
||||||
|
| `homewizard_local` | time since the meter **answered** | **yes** — every HTTP response is an arrival |
|
||||||
|
| `ha_dsmr` | time since one of several entities changed | no — statistically usually fine, which is a masked bug, not an absent one |
|
||||||
|
| `ha_signed` | time since the one entity changed | **no** — see above |
|
||||||
|
| `mqtt_p1` | time since a message arrived | arrivals yes, but a stuck bridge republishing keeps arriving |
|
||||||
|
|
||||||
### Control
|
### Control
|
||||||
|
|
||||||
@@ -142,11 +275,104 @@ behind it would trip the firmware watchdog on a system that is working fine.
|
|||||||
| `target_grid_w` | -10 | What the meter should rest at. Negative = a slight export |
|
| `target_grid_w` | -10 | What the meter should rest at. Negative = a slight export |
|
||||||
| `step_w` | 10 | Quantisation |
|
| `step_w` | 10 | Quantisation |
|
||||||
| `saturation_w` | 500 | Divergence that counts as "the inverter is at a limit" |
|
| `saturation_w` | 500 | Divergence that counts as "the inverter is at a limit" |
|
||||||
| `saturation_cycles` | 3 | How many consecutive cycles before freezing. **Do not set to 1** |
|
| `saturation_cycles` | 3 | How many consecutive cycles before freezing. A cycle is one meter update or `cycle_floor_s`, whichever comes first - see the note below. **Do not set to 1** |
|
||||||
| `integrator_max_w` | 0 | Bound on the loop's accumulator, and 0 means "same as `max_w`". Caps how much stale error can be waiting to unwind when the sign flips. **Do not raise it above `max_w`** - the output clamp already bounds what is commanded, so the only thing extra headroom buys is more cycles of wrong-direction power after every saturation event. Lowering it below `max_w` is the useful direction |
|
| `integrator_max_w` | 0 | Bound on the loop's accumulator, and 0 means "same as `max_w`". Caps how much stale error can be waiting to unwind when the sign flips. **Do not raise it above `max_w`** - the output clamp already bounds what is commanded, so the only thing extra headroom buys is more cycles of wrong-direction power after every saturation event. Lowering it below `max_w` is the useful direction |
|
||||||
| `heartbeat_s` | 10 | Refresh interval; must stay well under the firmware watchdog |
|
| `heartbeat_s` | 10 | Refresh interval; must stay well under the firmware watchdog |
|
||||||
|
| `cycle_floor_s` | 15 | The longest the loop may go without evaluating. A deadline on the gap between cycles, reset by every cycle — on a healthy meter it never elapses and changes nothing. Raise it only if your meter is slower than ~10 s; it must stay under `meter_max_age_s`, past which there is no reading to evaluate anyway |
|
||||||
| `stale_input_s` | 15 | How long inputs may be missing before commanding 0 W. In P1 mode this clock starts only *after* `meter_max_age_s` has already expired — the two stack, see "How long a dead meter takes to reach 0 W" |
|
| `stale_input_s` | 15 | How long inputs may be missing before commanding 0 W. In P1 mode this clock starts only *after* `meter_max_age_s` has already expired — the two stack, see "How long a dead meter takes to reach 0 W" |
|
||||||
| `auto_start` | false | Start controlling on boot (only after commissioning) |
|
| `auto_start` | false | Start controlling on boot (only after commissioning) |
|
||||||
|
| `sign_disagree_w` | 300 | Both the command and the meter must exceed this before a sign difference counts. Must stay **below `max_w`** or the watchdog can never fire, and the add-on refuses to start |
|
||||||
|
| `sign_disagree_s` | 180 | How long they must stay opposed, continuously, before the failsafe trips |
|
||||||
|
|
||||||
|
#### The sign-disagreement failsafe
|
||||||
|
|
||||||
|
If the setpoint this add-on is emitting and the grid figure it is regulating on
|
||||||
|
point **opposite ways** — charging the battery while the house imports, or
|
||||||
|
discharging it while the house exports — with both over `sign_disagree_w`, for
|
||||||
|
`sign_disagree_s` **continuously**, the add-on commands **0 W** and holds it
|
||||||
|
there. The banner reads `FAILSAFE`, the commissioning list says which two
|
||||||
|
numbers disagreed and for how long, and the `Controller status` entity reports
|
||||||
|
`failsafe`.
|
||||||
|
|
||||||
|
**It does not clear itself.** Pressing *Start / stop control* twice clears it.
|
||||||
|
That is deliberate: commanding 0 W removes the command side of the comparison,
|
||||||
|
so the disagreement always vanishes the instant the trip works, and a watchdog
|
||||||
|
that took that as proof the fault was over would hand the inverter straight back
|
||||||
|
to the loop that was driving the wrong way.
|
||||||
|
|
||||||
|
**What it is for.** This is a loop-integrity check: it asks whether the loop's
|
||||||
|
output direction still matches the input state it was regulating. It catches a
|
||||||
|
polarity error anywhere between the meter and the wire, and an integrator so far
|
||||||
|
wound up that unwinding takes minutes. It is the check that would have caught all
|
||||||
|
four episodes of 2026-08-20, when a commercial controller charged the battery out
|
||||||
|
of the grid, four times, for up to 77 minutes at a time.
|
||||||
|
|
||||||
|
**What it is not for.** It does not detect an inverter that acts opposite to what
|
||||||
|
it was told — that moves the meter *further* the same way, so command and meter
|
||||||
|
agree while everything runs away. That is the saturation freeze's job
|
||||||
|
(`saturation_w` / `saturation_cycles`), which compares the command against the
|
||||||
|
battery's actual power. The two checks are complementary and neither replaces the
|
||||||
|
other.
|
||||||
|
|
||||||
|
**Why it will not false-trip on ordinary operation.** A battery that refuses a
|
||||||
|
command (empty, full, standby) leaves the meter where it was, so command and
|
||||||
|
meter agree. A frozen meter drives the loop into agreeing with it. Around the
|
||||||
|
resting point both signals are inside the 300 W gate, so the deadband can never
|
||||||
|
produce one. A load step does flip the meter's sign before the loop catches up —
|
||||||
|
measured on a full captured day, the longest such crossing is 30 s, against a
|
||||||
|
180 s window. And the watchdog is **disarmed whenever the grid-following loop is
|
||||||
|
not what is driving**: a maintenance grid charge opposes the meter by design and
|
||||||
|
must not be mistaken for a fault.
|
||||||
|
|
||||||
|
Both numbers are measured rather than chosen, and are exposed only because the
|
||||||
|
ticket requires defaults rather than constants. On the captured healthy day sign
|
||||||
|
agreement is 92.9 %; on the four captured fault episodes it is 0.3 %, 0.9 %,
|
||||||
|
10.5 % and 0.0 %. There is no reason to move either value without a capture that
|
||||||
|
says so.
|
||||||
|
|
||||||
|
#### Saturation is counted in cycles, not seconds
|
||||||
|
|
||||||
|
The specification states the saturation window as **"> 10 s"**. This add-on counts
|
||||||
|
**cycles** instead, and that is a deliberate, accepted deviation rather than an
|
||||||
|
oversight - the acceptance criterion is not met as literally written.
|
||||||
|
|
||||||
|
A cycle here is one meter update **or `cycle_floor_s` elapsing, whichever comes
|
||||||
|
first**. At the reference P1's ~5 s update rate the default of 3 cycles is usually
|
||||||
|
around 15 s, and the worst case is bounded at `3 x cycle_floor_s` = 45 s. It is still
|
||||||
|
not the 10 s the specification asks for, so the deviation stands - but it is now a
|
||||||
|
bounded number rather than an open one.
|
||||||
|
|
||||||
|
⚠️ **This passage used to say something different, and the second half of it was
|
||||||
|
wrong.** Until SAFETY-12 the loop ran only when the meter value *changed*, so a meter
|
||||||
|
that repeated a value stalled the counter for as long as it repeated, with no upper
|
||||||
|
bound at all. That was defended here on the grounds that "a stalled counter is a
|
||||||
|
detection-latency limit and not a runaway risk - the condition that stalls it stops the
|
||||||
|
whole loop, so nothing accumulates while it is stalled". That argument covers
|
||||||
|
**integrator windup and nothing else**. The hazard it misses is **staleness**: while the
|
||||||
|
loop was stopped the heartbeat kept re-emitting the last command and the firmware kept
|
||||||
|
putting it on the wire every 2 s, so a command computed from an old reading went on
|
||||||
|
being executed through a real load change, with every indicator reading healthy.
|
||||||
|
Measured on the rig during TEL-05: 70 s at a literally constant 350.0 W, 14 arrivals,
|
||||||
|
zero control cycles.
|
||||||
|
|
||||||
|
The half that survives is the first one: the control law is still a pure function with
|
||||||
|
no clock, and the wall-clock window still lives in `Controller`, which has one - see
|
||||||
|
`run_control()`. What changed is that the controller now enforces a floor on the gap
|
||||||
|
between cycles, so `saturation_cycles` finally means a bounded number of seconds.
|
||||||
|
|
||||||
|
If a tighter window matters on your site, lower `cycle_floor_s` (not below your meter's
|
||||||
|
update interval, or the floor starts firing on a healthy meter) or raise
|
||||||
|
`saturation_cycles` for a fast meter.
|
||||||
|
|
||||||
|
**This is not a freeze detector, and it deliberately cannot be one.** Nothing here
|
||||||
|
decides whether a repeated reading is true — see `unchanged_s` in the meter section for
|
||||||
|
why no threshold on that is safe at the converged operating point. The floor only stops
|
||||||
|
"the number is the same" from meaning "do not think". The consequence is worth stating
|
||||||
|
plainly: against a meter that is genuinely frozen at a wrong value, the loop will now
|
||||||
|
correct toward that wrong value instead of holding a stale command. It is bounded by
|
||||||
|
`max_w`, the arbiter and the device rating, and it is the same thing that already
|
||||||
|
happened to a lying meter whose value merely jittered — bit-exact repetition was never a
|
||||||
|
safety property.
|
||||||
|
|
||||||
#### Why `target_grid_w` is not zero
|
#### Why `target_grid_w` is not zero
|
||||||
|
|
||||||
|
|||||||
@@ -95,19 +95,23 @@ def compute(
|
|||||||
# lets slew be larger than saturation_w.
|
# lets slew be larger than saturation_w.
|
||||||
#
|
#
|
||||||
# The spec states this window twice and differently: "> 10 s" (§11.2) and
|
# The spec states this window twice and differently: "> 10 s" (§11.2) and
|
||||||
# "3 samples" (§10.3). This counts CYCLES, and a cycle is not a unit of
|
# "3 samples" (§10.3). This counts CYCLES, and a cycle is still not a unit
|
||||||
# time: run_control() calls cycle() only when the meter value CHANGES
|
# of time - but it is now a BOUNDED one. run_control() runs a cycle on a
|
||||||
# (`if self.grid != last_grid`), so three cycles is three distinct meter
|
# changed meter value OR on `cycle_floor_s` elapsing, whichever comes first
|
||||||
# readings and nothing more. At the reference P1's ~5 s update rate that is
|
# (SAFETY-12), so three cycles is at most 3 x cycle_floor_s = 45 s at the
|
||||||
# usually ~15 s, but there is no upper bound on it - a meter that repeats a
|
# defaults, and usually ~15 s at the reference P1's ~5 s update rate.
|
||||||
# value stalls the counter.
|
|
||||||
#
|
#
|
||||||
# That is a detection-latency limit, not a windup hazard: the same
|
# ⚠️ THIS COMMENT USED TO CLAIM there was no upper bound and that it did not
|
||||||
# condition that stalls the counter stalls the whole loop, so nothing
|
# matter, "because the same condition that stalls the counter stalls the
|
||||||
# accumulates in the meantime either. If a wall-clock window is ever
|
# whole loop, so nothing accumulates in the meantime". The first clause was
|
||||||
# required, it belongs in Controller (which has a clock) and not here.
|
# true and the second was the bug: a stalled loop does not stop commanding,
|
||||||
# ponytail: this function is worth keeping clockless; the ceiling is that
|
# it goes on emitting its last command through the heartbeat. Windup was
|
||||||
# saturation_cycles cannot express a guaranteed number of seconds.
|
# never the hazard; staleness was.
|
||||||
|
#
|
||||||
|
# The wall-clock window lives in Controller, which has a clock, exactly as
|
||||||
|
# this comment always said it should. ponytail: this function stays
|
||||||
|
# clockless; the remaining ceiling is that saturation_cycles expresses a
|
||||||
|
# bound in seconds rather than an exact number of them.
|
||||||
saturated_now = abs(prev_w - actual_w) > tuning.saturation_w
|
saturated_now = abs(prev_w - actual_w) > tuning.saturation_w
|
||||||
sat_count = min(sat_count + 1, 10) if saturated_now else 0
|
sat_count = min(sat_count + 1, 10) if saturated_now else 0
|
||||||
frozen = sat_count >= tuning.saturation_cycles
|
frozen = sat_count >= tuning.saturation_cycles
|
||||||
@@ -156,15 +160,45 @@ def compute(
|
|||||||
# has been in service on real hardware. It is applied here as well
|
# has been in service on real hardware. It is applied here as well
|
||||||
# because the requirement is that the INTEGRATOR stop accumulating, not
|
# because the requirement is that the INTEGRATOR stop accumulating, not
|
||||||
# only the command.
|
# only the command.
|
||||||
if not frozen:
|
#
|
||||||
|
# ⚠️ EXACTLY ZERO IS ITS OWN CASE, and it must be handled explicitly
|
||||||
|
# rather than falling into one of the two branches. "May not wind
|
||||||
|
# further in the direction it is already pushing" has no referent at
|
||||||
|
# zero: nothing is wound, and neither direction is "further". Writing
|
||||||
|
# this as `if i_w > 0 ... else ...` silently files zero under
|
||||||
|
# rising-only and permanently blocks the first push toward charging -
|
||||||
|
# the same deadlock as the shrink-only encoding above, mirrored in sign,
|
||||||
|
# and reachable because main.py resets i_w to exactly 0.0 on every stop
|
||||||
|
# and every reseed. Measured before the fix: 12 800 of 25 920 frozen
|
||||||
|
# ticks at i_w == 0.0 held the integrator, 8 304 of them changing the
|
||||||
|
# emitted command, worst case abandoning a 2 kW charge into a 4 kW
|
||||||
|
# export.
|
||||||
|
#
|
||||||
|
# Freezing at zero would also be pointless: the freeze exists to stop
|
||||||
|
# accumulation running away, and a first step from zero is bounded by
|
||||||
|
# the gain, the output clamp and the slew limit like any other.
|
||||||
|
if not frozen or i_w == 0.0:
|
||||||
i_w = moved
|
i_w = moved
|
||||||
|
elif i_w > 0:
|
||||||
|
i_w = min(moved, i_w)
|
||||||
else:
|
else:
|
||||||
i_w = min(moved, i_w) if i_w > 0 else max(moved, i_w)
|
i_w = max(moved, i_w)
|
||||||
|
|
||||||
# ⚠️ Applied EVERY cycle, frozen or not: the freeze is conditional, this
|
# ⚠️ Applied EVERY cycle, frozen or not: the freeze is conditional, this
|
||||||
# bound is not. It is what makes the worst-case unwind time finite and
|
# bound is not. It is what makes the worst-case unwind time finite and
|
||||||
# knowable instead of a function of how long the error happened to stand.
|
# knowable instead of a function of how long the error happened to stand.
|
||||||
i_w = max(-limit, min(limit, i_w))
|
bounded = max(-limit, min(limit, i_w))
|
||||||
|
if bounded != i_w:
|
||||||
|
# ⚠️ SAFETY-03 (alarm whenever the loop winds into a rail) must watch
|
||||||
|
# for THIS, not for "clamped" below. At the default limit == max_w the
|
||||||
|
# integrator bound is reached first and the command derived from it can
|
||||||
|
# then never exceed max_w, so "clamped" is unreachable on a default
|
||||||
|
# install - it survives only for a configuration that deliberately lets
|
||||||
|
# the integrator run above the rail. Two reasons rather than one
|
||||||
|
# because the two events want different alarms: "i-clamped" is the loop
|
||||||
|
# winding, "clamped" is a command that came out over the rating anyway.
|
||||||
|
reason = "i-clamped"
|
||||||
|
i_w = bounded
|
||||||
want = i_w
|
want = i_w
|
||||||
|
|
||||||
# ⚠️ Maintenance shaping (charge-only, cheap-window floor) used to live
|
# ⚠️ Maintenance shaping (charge-only, cheap-window floor) used to live
|
||||||
|
|||||||
+269
-14
@@ -40,6 +40,8 @@ from .hass import HomeAssistant
|
|||||||
from .maintenance import IDLE, MaintConfig, Maintenance
|
from .maintenance import IDLE, MaintConfig, Maintenance
|
||||||
from .mqtt import MqttPublisher
|
from .mqtt import MqttPublisher
|
||||||
from .p1 import P1Ingest, build_source, is_enabled
|
from .p1 import P1Ingest, build_source, is_enabled
|
||||||
|
from .validate import ConfigRefused, refuse, validate_startup_config
|
||||||
|
from .watchdog import SignWatchdog, SignWatchdogConfig
|
||||||
from . import web
|
from . import web
|
||||||
|
|
||||||
OPTIONS_PATH = "/data/options.json"
|
OPTIONS_PATH = "/data/options.json"
|
||||||
@@ -56,11 +58,22 @@ def load_options() -> dict:
|
|||||||
|
|
||||||
|
|
||||||
class Controller:
|
class Controller:
|
||||||
def __init__(self, opts: dict, hass: HomeAssistant, store, mqtt_pub):
|
def __init__(self, opts: dict, hass: HomeAssistant, store, mqtt_pub, *, stop):
|
||||||
self.o = opts
|
self.o = opts
|
||||||
self.hass = hass
|
self.hass = hass
|
||||||
self.store = store
|
self.store = store
|
||||||
self.mqtt = mqtt_pub
|
self.mqtt = mqtt_pub
|
||||||
|
# ⚠️ REQUIRED, AND KEYWORD-ONLY, AFTER A REVIEW CATCH. This started life
|
||||||
|
# as `stop=None`, which made a Controller that CANNOT STOP ITSELF the
|
||||||
|
# default one. On the late-refusal path in run_control() that default
|
||||||
|
# meant: log the banner, return, and leave the process alive forever
|
||||||
|
# with no control loop, no exit and no further output - the exact
|
||||||
|
# "inert but looks healthy" failure this whole module exists to refuse.
|
||||||
|
# amain() always passed a real Event, so it was latent, but test_p1.py
|
||||||
|
# was already constructing Controllers without one. No default now, so
|
||||||
|
# the broken shape does not typecheck.
|
||||||
|
self.stop_event = stop
|
||||||
|
self.refused: list[str] | None = None
|
||||||
|
|
||||||
self.tuning = Tuning(
|
self.tuning = Tuning(
|
||||||
gain=float(opts.get("gain", 0.6)),
|
gain=float(opts.get("gain", 0.6)),
|
||||||
@@ -91,12 +104,22 @@ class Controller:
|
|||||||
store,
|
store,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
# SAFETY-02. One instance, one actuator, one cadence - see watchdog.py.
|
||||||
|
self.sign_wd = SignWatchdog(SignWatchdogConfig(
|
||||||
|
min_w=float(opts.get("sign_disagree_w", 300)),
|
||||||
|
hold_s=float(opts.get("sign_disagree_s", 180)),
|
||||||
|
))
|
||||||
|
|
||||||
# P1 ingestion (TEL-01). `meter_source: off` keeps the original
|
# P1 ingestion (TEL-01). `meter_source: off` keeps the original
|
||||||
# single-entity meter_entity path, so an existing install is unchanged
|
# single-entity meter_entity path, so an existing install is unchanged
|
||||||
# until it opts in.
|
# until it opts in.
|
||||||
self.p1 = P1Ingest(phases=int(opts.get("meter_phases", 1)),
|
self.p1 = P1Ingest(phases=int(opts.get("meter_phases", 1)),
|
||||||
max_age_s=float(opts.get("meter_max_age_s", 30)))
|
max_age_s=float(opts.get("meter_max_age_s", 30)))
|
||||||
self.p1_enabled = is_enabled(opts)
|
self.p1_enabled = is_enabled(opts)
|
||||||
|
# Set by amain() once the transport is built, so the status page can show
|
||||||
|
# what only the transport knows (homewizard_local's unchanged_s). Stays
|
||||||
|
# None when P1 is off, or under a transport that has no such counter.
|
||||||
|
self.p1_source = None
|
||||||
|
|
||||||
# live state
|
# live state
|
||||||
self.auto = bool(store.data.get("auto", opts.get("auto_start", False)))
|
self.auto = bool(store.data.get("auto", opts.get("auto_start", False)))
|
||||||
@@ -104,6 +127,11 @@ class Controller:
|
|||||||
self.sat_count = 0
|
self.sat_count = 0
|
||||||
self.i_w = 0.0 # the loop's integrator, carried between cycles
|
self.i_w = 0.0 # the loop's integrator, carried between cycles
|
||||||
self.loop_w = None # what the loop asked for last cycle, or None
|
self.loop_w = None # what the loop asked for last cycle, or None
|
||||||
|
# Did the grid-following loop actually win the LAST arbitration? That is
|
||||||
|
# the question SAFETY-02 has to ask about the command standing on the
|
||||||
|
# wire right now, so it is recorded when the arbitration happens rather
|
||||||
|
# than re-derived a cycle later. Starts False: nothing is on the wire.
|
||||||
|
self.following = False
|
||||||
self.reason = "starting"
|
self.reason = "starting"
|
||||||
self.grid = self.soc = self.batt = None
|
self.grid = self.soc = self.batt = None
|
||||||
self.peak_fc = None
|
self.peak_fc = None
|
||||||
@@ -198,8 +226,29 @@ class Controller:
|
|||||||
for msg in result.events:
|
for msg in result.events:
|
||||||
self.log_event(msg)
|
self.log_event(msg)
|
||||||
|
|
||||||
|
# --- SAFETY-02, and it runs BEFORE the early return below -------------
|
||||||
|
# ⚠️ ORDER MATTERS HERE. If this were evaluated after the "inputs missing
|
||||||
|
# but not yet stale" hold, a run of held cycles would leave
|
||||||
|
# `disagree_since` untouched across the gap and the timer would resume
|
||||||
|
# from a start time that predates it. It is evaluated every cycle,
|
||||||
|
# unconditionally, so a missing meter CLEARS the window - see watchdog.py.
|
||||||
|
#
|
||||||
|
# The value compared is the command STANDING ON THE WIRE, which is what
|
||||||
|
# this cycle's fresh meter reading is a response to. `last_write` is that
|
||||||
|
# value after the device clamp and confirmed accepted; `target` covers
|
||||||
|
# the case where nothing has been written yet (and, deliberately, the
|
||||||
|
# case where the last write was REJECTED - the inverter is then still
|
||||||
|
# latched on `last_write`, which is exactly what `last_write` holds).
|
||||||
|
was_tripped = self.sign_wd.tripped
|
||||||
|
standing = self.last_write if self.last_write is not None else self.target
|
||||||
|
if self.sign_wd.evaluate(standing, self.grid, self.following, now) \
|
||||||
|
and not was_tripped:
|
||||||
|
self.log_event("FAILSAFE " + self.sign_wd.reason)
|
||||||
|
_LOG.error("SAFETY-02 TRIPPED - %s. Commanding 0 W and holding it "
|
||||||
|
"until control is started again.", self.sign_wd.reason)
|
||||||
|
|
||||||
stale_after = float(self.o.get("stale_input_s", 15))
|
stale_after = float(self.o.get("stale_input_s", 15))
|
||||||
if not self.inputs_ok:
|
if not self.inputs_ok and not self.sign_wd.tripped:
|
||||||
bad_for = (now - self.inputs_bad_since).total_seconds() if self.inputs_bad_since else 0.0
|
bad_for = (now - self.inputs_bad_since).total_seconds() if self.inputs_bad_since else 0.0
|
||||||
if bad_for < stale_after:
|
if bad_for < stale_after:
|
||||||
# A single missed poll is not a fault. Hold, keep the heartbeat
|
# A single missed poll is not a fault. Hold, keep the heartbeat
|
||||||
@@ -219,6 +268,16 @@ class Controller:
|
|||||||
claims.append(Claim.limit("supervised", P_SAFETY, -max_w, max_w, "max_w"))
|
claims.append(Claim.limit("supervised", P_SAFETY, -max_w, max_w, "max_w"))
|
||||||
|
|
||||||
# --- safety stops ----------------------------------------------------
|
# --- safety stops ----------------------------------------------------
|
||||||
|
# ⚠️ SAFETY-02 is claimed FIRST and unconditionally while latched. It is
|
||||||
|
# a SET at P_SAFETY, so it outranks maintenance, peak shaving and the
|
||||||
|
# loop alike - a controller pushing power the wrong way is wrong
|
||||||
|
# whatever it thinks it is doing. Re-filed EVERY cycle: claims are not
|
||||||
|
# sticky, and one filed once would lapse the next cycle and hand the
|
||||||
|
# actuator silently back to the loop that was driving the wrong way.
|
||||||
|
if self.sign_wd.tripped:
|
||||||
|
claims.append(Claim.set("failsafe", P_SAFETY, 0.0,
|
||||||
|
"sign disagreement"))
|
||||||
|
|
||||||
if not self.auto:
|
if not self.auto:
|
||||||
claims.append(Claim.set("safety", P_SAFETY, 0.0, "stopped"))
|
claims.append(Claim.set("safety", P_SAFETY, 0.0, "stopped"))
|
||||||
elif not self.inputs_ok:
|
elif not self.inputs_ok:
|
||||||
@@ -290,6 +349,28 @@ class Controller:
|
|||||||
resolution = resolve(claims)
|
resolution = resolve(claims)
|
||||||
if resolution.contradiction:
|
if resolution.contradiction:
|
||||||
self.log_event("ARBITER CONTRADICTION - commanding 0 W, see the log")
|
self.log_event("ARBITER CONTRADICTION - commanding 0 W, see the log")
|
||||||
|
# --- SAFETY-02's arming gate ------------------------------------------
|
||||||
|
# Was the number about to go on the wire chosen by the grid-following
|
||||||
|
# loop, or by a strategy that commands against the meter on purpose?
|
||||||
|
# Only the former is expected to agree in sign with P1. See gate 1 in
|
||||||
|
# watchdog.py - without this, every maintenance grid charge trips the
|
||||||
|
# failsafe within three minutes of starting.
|
||||||
|
#
|
||||||
|
# ⚠️ "THE LOOP WON" IS NOT ENOUGH, and the difference is a whole class of
|
||||||
|
# false trip. A LIMIT claim can survive the loop winning and still
|
||||||
|
# replace its number: maintenance's charge-only shaping is
|
||||||
|
# `hi = -charge_w`, so the loop can ask for +500 W of discharge, win the
|
||||||
|
# arbitration, and have the emitted value come out at -2500 W of grid
|
||||||
|
# charge. Winner says "loop"; the wire carries maintenance's intent. So
|
||||||
|
# the test is on the NUMBER, not on the name: the loop is following only
|
||||||
|
# while the emitted value points the way the loop asked and is no larger
|
||||||
|
# than it asked - i.e. limits reduced it, they did not redirect it.
|
||||||
|
# Zero on either side falls out as not-following, which costs nothing:
|
||||||
|
# a 0 W command cannot be a wrong-direction command.
|
||||||
|
asked = self.loop_w
|
||||||
|
self.following = (resolution.winner == "loop" and asked is not None
|
||||||
|
and resolution.target_w * asked > 0
|
||||||
|
and abs(resolution.target_w) <= abs(asked))
|
||||||
self.target = resolution.target_w
|
self.target = resolution.target_w
|
||||||
self.reason = resolution.explain()
|
self.reason = resolution.explain()
|
||||||
await self.write_setpoint(self.target)
|
await self.write_setpoint(self.target)
|
||||||
@@ -299,19 +380,112 @@ class Controller:
|
|||||||
entity = self.o.get("setpoint_entity", "")
|
entity = self.o.get("setpoint_entity", "")
|
||||||
if entity:
|
if entity:
|
||||||
self.dev_min, self.dev_max, _ = await self.hass.limits(entity)
|
self.dev_min, self.dev_max, _ = await self.hass.limits(entity)
|
||||||
if self.dev_max is not None and self.tuning.max_w > self.dev_max:
|
# ⚠️ THIS USED TO WARN AND CARRY ON, and that was the bug CFG-01
|
||||||
self.log_event(
|
# exists to remove: a max_w above the device's rating meant
|
||||||
f"clamp {self.tuning.max_w:.0f} W exceeds the device maximum "
|
# write_setpoint() silently clamped and the configured ceiling was
|
||||||
f"{self.dev_max:.0f} W - the device wins")
|
# never the real one.
|
||||||
|
#
|
||||||
|
# amain() already ran this gate before anything started. It runs
|
||||||
|
# AGAIN here for one case the gate cannot cover: ESPHome is often
|
||||||
|
# not up yet when the add-on boots, so hass.limits() returned
|
||||||
|
# (None, None) and the range checks were skipped rather than
|
||||||
|
# guessed at. This is the first moment the device's real rating is
|
||||||
|
# known. If it conflicts, refuse now - stopping deterministically
|
||||||
|
# through the normal shutdown, which commands 0 W on the way out.
|
||||||
|
problems = validate_startup_config(self.o, self.dev_min, self.dev_max)
|
||||||
|
if problems:
|
||||||
|
refuse(problems)
|
||||||
|
self.refused = problems
|
||||||
|
self.log_event("REFUSED: " + problems[0])
|
||||||
|
# Signal, then return WITHOUT entering the loop. amain() wakes
|
||||||
|
# on this, runs the normal wind-down (which commands 0 W) and
|
||||||
|
# re-raises ConfigRefused afterwards, so the exit code is 78 and
|
||||||
|
# the inverter is left at zero rather than latched.
|
||||||
|
self.stop_event.set()
|
||||||
|
return
|
||||||
|
|
||||||
last_grid = object()
|
last_grid = object()
|
||||||
heartbeat = float(self.o.get("heartbeat_s", 10))
|
heartbeat = float(self.o.get("heartbeat_s", 10))
|
||||||
last_beat = 0.0
|
last_beat = 0.0
|
||||||
|
# ⚠️ SAFETY-12. The floor is a DEADLINE ON THE GAP BETWEEN CYCLES, not a
|
||||||
|
# second scheduler running alongside the arrival trigger. Every cycle
|
||||||
|
# resets it, whichever trigger fired, so on a healthy changing meter it
|
||||||
|
# never elapses and not one existing cycle moves - and therefore no
|
||||||
|
# change to the per-cycle gain the tuning was measured against.
|
||||||
|
#
|
||||||
|
# That is true twice over, and the second reason is the sturdier one:
|
||||||
|
# the combined cycle rate is max(arrival rate, 1/floor), never the sum.
|
||||||
|
# At the defaults 1/15 s is strictly slower than the ~1/5 s arrival
|
||||||
|
# rate, so even a floor that raced the arrivals could not push the loop
|
||||||
|
# past its nominal healthy rate. The re-tune is unreachable by
|
||||||
|
# construction, not merely by the reset. ⚠️ That argument holds only
|
||||||
|
# while floor > the meter's update interval - which is why the schema
|
||||||
|
# minimum of 5 s deserves the second look validate.py has not given it
|
||||||
|
# yet: 5 s IS the reference meter's interval, i.e. the one configurable
|
||||||
|
# value that would double the cycle rate.
|
||||||
|
#
|
||||||
|
# Why it has to exist, and it is not only about latency: `self.grid !=
|
||||||
|
# last_grid` alone means a meter that repeats a value runs NO control
|
||||||
|
# cycles at all. The heartbeat below keeps re-emitting the last command
|
||||||
|
# and the firmware keeps putting it on the wire, so every indicator
|
||||||
|
# reads healthy - and, worse, the `inputs missing -> 0 W` claim lives
|
||||||
|
# INSIDE cycle(), so on a repeating meter THAT SAFETY CLAIM CANNOT FIRE.
|
||||||
|
# Demonstrated in test_loop.py: constant meter, SoC entity dies at t=4 s,
|
||||||
|
# and the pre-fix controller holds 220 W through the whole outage with
|
||||||
|
# the status line still reading "loop -> 220 W". Layer 1 does not cover
|
||||||
|
# it on a `meter_source: off` install either - no P1 age sensor is
|
||||||
|
# published, so the firmware has nothing to veto on. Measured on the rig
|
||||||
|
# during TEL-05: 70 s at a literally constant 350.0 W, 14 arrivals, zero
|
||||||
|
# cycles.
|
||||||
|
#
|
||||||
|
# This is NOT a freeze detector, and deliberately so - see
|
||||||
|
# HomeWizardLocalSource.unchanged_s for why one cannot be built here (at
|
||||||
|
# the converged -10 W target a 1 Wh register needs ~6 minutes to move,
|
||||||
|
# so any freeze threshold false-trips at the exact operating point we
|
||||||
|
# run at). Nothing here decides whether a repeated reading is true. It
|
||||||
|
# only stops "the number is the same" from meaning "do not think".
|
||||||
|
#
|
||||||
|
# ⚠️ THE 15 s DEFAULT HAS A CEILING IT DOES NOT OWN. It is under
|
||||||
|
# validate.FIRMWARE_INGEST_VETO_S (30 s) and under meter_max_age_s on
|
||||||
|
# purpose, so the loop re-decides at least twice inside any window in
|
||||||
|
# which layer 1 might otherwise be the only thing deciding. If the
|
||||||
|
# firmware's veto ever moves, this default moves with it - it is not
|
||||||
|
# independently justified at 15.
|
||||||
|
floor = float(self.o.get("cycle_floor_s", 15))
|
||||||
|
last_cycle = None
|
||||||
while not self.stopping:
|
while not self.stopping:
|
||||||
await self.read_inputs()
|
await self.read_inputs()
|
||||||
# A cycle is one meter update, exactly as on the reference install.
|
now_mono = asyncio.get_running_loop().time()
|
||||||
if self.grid != last_grid:
|
# A cycle is one meter update, exactly as on the reference install -
|
||||||
|
# or the floor elapsing, whichever comes first.
|
||||||
|
overdue = last_cycle is None or (now_mono - last_cycle) >= floor
|
||||||
|
if self.grid != last_grid or overdue:
|
||||||
last_grid = self.grid
|
last_grid = self.grid
|
||||||
|
last_cycle = now_mono
|
||||||
|
# ⚠️ The FULL cycle, not a degraded one. A floor cycle runs the
|
||||||
|
# same law on the same inputs as an arrival cycle, because in P1
|
||||||
|
# mode the freshness question is already answered upstream and
|
||||||
|
# answered harder: past `meter_max_age_s` (30 s) p1.net_w is
|
||||||
|
# None, which is "inputs missing", which becomes a P_SAFETY 0 W
|
||||||
|
# claim. So a floor cycle cannot run the PI on a 60 s old
|
||||||
|
# figure, because at 60 s there is no figure.
|
||||||
|
#
|
||||||
|
# ⚠️ THAT GUARANTEE IS TRANSPORT-CONDITIONAL, and saying so
|
||||||
|
# matters more than the guarantee: with `meter_source: off`,
|
||||||
|
# read_inputs() takes self.grid straight from hass.number() with
|
||||||
|
# NO age gate at all, so a Home Assistant entity that has gone
|
||||||
|
# quiet reads as a current value on that path with or without
|
||||||
|
# this change. Running the full law is still the right choice
|
||||||
|
# there - the alternative is a degraded second law reasoning
|
||||||
|
# about an age nobody measured - but the floor does not make
|
||||||
|
# that path fresh, and nothing here should be read as claiming
|
||||||
|
# it does. And the integrator
|
||||||
|
# advances per CYCLE, not per second (control.py), so bounding
|
||||||
|
# the gap bounds the accumulation: at most one extra
|
||||||
|
# gain x error per floor interval, under the same
|
||||||
|
# integrator_max_w as every other cycle. A second, gentler
|
||||||
|
# control law for floor cycles would be a second set of
|
||||||
|
# dynamics nobody can test on this hardware.
|
||||||
await self.cycle()
|
await self.cycle()
|
||||||
# ⚠️ The heartbeat is not an optimisation. The ESP32 treats silence
|
# ⚠️ The heartbeat is not an optimisation. The ESP32 treats silence
|
||||||
# longer than ~30 s as "the controller is gone" and zeroes the
|
# longer than ~30 s as "the controller is gone" and zeroes the
|
||||||
@@ -330,10 +504,18 @@ class Controller:
|
|||||||
"battery": self.batt,
|
"battery": self.batt,
|
||||||
"soc": self.soc,
|
"soc": self.soc,
|
||||||
"phase": self.maint.phase,
|
"phase": self.maint.phase,
|
||||||
"status": "running" if self.auto else "stopped",
|
# ⚠️ SAFETY-02's alarm surface, and it is deliberately an existing
|
||||||
|
# one. IF-01/IF-02 own `ems/event/failsafe` and the `failsafe active`
|
||||||
|
# binary sensor and neither is built yet; inventing a bespoke topic
|
||||||
|
# here would be a surface to migrate later. This sensor is already
|
||||||
|
# discovered, already on every dashboard, and "failsafe" is
|
||||||
|
# additive to its vocabulary rather than a change to it.
|
||||||
|
"status": ("failsafe" if self.sign_wd.tripped
|
||||||
|
else "running" if self.auto else "stopped"),
|
||||||
}
|
}
|
||||||
# ⚠️ ONLY when P1 ingestion is actually running. The ESP32's stale-input
|
# ⚠️ ONLY when P1 ingestion is actually running. The ESP32's stale-input
|
||||||
# watchdog subscribes to sensor.p1_sample_age_s and forces the layer-1
|
# watchdog subscribes to sensor.goodwe_p1_sample_age - see the entity-id
|
||||||
|
# note in mqtt.py; the composed name is not the object_id - and forces layer-1
|
||||||
# failsafe once it reaches max_age_s. With meter_source off there is no
|
# failsafe once it reaches max_age_s. With meter_source off there is no
|
||||||
# ingester feeding it, so published_age_s would be time-since-startup
|
# ingester feeding it, so published_age_s would be time-since-startup
|
||||||
# climbing without bound - i.e. every existing install would cross the
|
# climbing without bound - i.e. every existing install would cross the
|
||||||
@@ -365,10 +547,22 @@ class Controller:
|
|||||||
+ (f" - last error: {self.p1.last_error}"
|
+ (f" - last error: {self.p1.last_error}"
|
||||||
if self.p1.last_error else "")})
|
if self.p1.last_error else "")})
|
||||||
else:
|
else:
|
||||||
|
# ⚠️ unchanged_s is REPORTED, never thresholded and never folded
|
||||||
|
# into the age - see HomeWizardLocalSource.unchanged_s for why
|
||||||
|
# (at the converged -10 W this controller aims for, a 1 Wh
|
||||||
|
# register needs ~6 minutes to move, so any limit false-trips at
|
||||||
|
# the exact operating point we target). The whole argument for
|
||||||
|
# leaving it unthresholded is that a human interprets it, which
|
||||||
|
# requires a human being able to see it - so here it is. getattr:
|
||||||
|
# only homewizard_local has one, and p1_source is None until
|
||||||
|
# amain() builds the transport.
|
||||||
|
unchanged = getattr(self.p1_source, "unchanged_s", None)
|
||||||
out.append({"ok": True, "warn": False,
|
out.append({"ok": True, "warn": False,
|
||||||
"text": f"P1 meter ({o.get('meter_source')}): {self.p1.net_w:g} W, "
|
"text": f"P1 meter ({o.get('meter_source')}): {self.p1.net_w:g} W, "
|
||||||
f"{age:.0f} s old, {self.p1.samples} telegrams, "
|
f"{age:.0f} s old, {self.p1.samples} telegrams, "
|
||||||
f"{self.p1.parse_errors} rejected"})
|
f"{self.p1.parse_errors} rejected"
|
||||||
|
+ (f", measurement unchanged for {unchanged:.0f} s"
|
||||||
|
if unchanged is not None else "")})
|
||||||
rows = [("battery SoC", self.soc, o.get("soc_entity")),
|
rows = [("battery SoC", self.soc, o.get("soc_entity")),
|
||||||
("battery power", self.batt, o.get("batt_entity"))]
|
("battery power", self.batt, o.get("batt_entity"))]
|
||||||
if not self.p1_enabled:
|
if not self.p1_enabled:
|
||||||
@@ -399,6 +593,22 @@ class Controller:
|
|||||||
out.append({"ok": False, "warn": False,
|
out.append({"ok": False, "warn": False,
|
||||||
"text": "last write to the inverter was REJECTED - check the log"})
|
"text": "last write to the inverter was REJECTED - check the log"})
|
||||||
|
|
||||||
|
# SAFETY-02. Reported in both states: a watchdog nobody can see is armed
|
||||||
|
# is a watchdog nobody trusts when it fires.
|
||||||
|
if self.sign_wd.tripped:
|
||||||
|
out.append({"ok": False, "warn": False,
|
||||||
|
"text": "SIGN-DISAGREEMENT FAILSAFE - " + self.sign_wd.reason
|
||||||
|
+ ". The inverter is held at 0 W. Find out why the "
|
||||||
|
"command opposed the meter before starting control "
|
||||||
|
"again; starting clears this."})
|
||||||
|
else:
|
||||||
|
held = self.sign_wd.held_s
|
||||||
|
out.append({"ok": True, "warn": False,
|
||||||
|
"text": f"sign watchdog: armed (trips after "
|
||||||
|
f"{self.sign_wd.cfg.hold_s:.0f} s opposed, both over "
|
||||||
|
f"{self.sign_wd.cfg.min_w:.0f} W)"
|
||||||
|
+ (f" - opposed for {held:.0f} s now" if held else "")})
|
||||||
|
|
||||||
if not o.get("estop_fitted", False):
|
if not o.get("estop_fitted", False):
|
||||||
out.append({"ok": False, "warn": True,
|
out.append({"ok": False, "warn": True,
|
||||||
"text": "no e-stop fitted: if this host dies the battery stays "
|
"text": "no e-stop fitted: if this host dies the battery stays "
|
||||||
@@ -416,7 +626,11 @@ class Controller:
|
|||||||
def status_payload(self) -> dict:
|
def status_payload(self) -> dict:
|
||||||
checks = self.checks()
|
checks = self.checks()
|
||||||
bad = [c for c in checks if not c["ok"] and not c["warn"]]
|
bad = [c for c in checks if not c["ok"] and not c["warn"]]
|
||||||
if bad:
|
if self.sign_wd.tripped:
|
||||||
|
# Outranks "NOT READY": nothing is missing, something went wrong.
|
||||||
|
level, banner = "bad", ("FAILSAFE — the command opposed the meter. "
|
||||||
|
"Inverter held at 0 W.")
|
||||||
|
elif bad:
|
||||||
level, banner = "bad", f"NOT READY — {bad[0]['text']}"
|
level, banner = "bad", f"NOT READY — {bad[0]['text']}"
|
||||||
elif not self.auto:
|
elif not self.auto:
|
||||||
level, banner = "warn", "Stopped — inverter commanded to 0 W"
|
level, banner = "warn", "Stopped — inverter commanded to 0 W"
|
||||||
@@ -450,6 +664,15 @@ class Controller:
|
|||||||
self.auto = not self.auto
|
self.auto = not self.auto
|
||||||
self.store.set("auto", self.auto)
|
self.store.set("auto", self.auto)
|
||||||
self.log_event("control started" if self.auto else "control stopped")
|
self.log_event("control started" if self.auto else "control stopped")
|
||||||
|
if self.auto and self.sign_wd.tripped:
|
||||||
|
# ⚠️ THE ONLY WAY OUT OF A SIGN-DISAGREEMENT TRIP, on purpose.
|
||||||
|
# It clears on a deliberate human start, not on the condition
|
||||||
|
# going away - the condition ALWAYS goes away, because the trip
|
||||||
|
# commands 0 W and a 0 W command cannot disagree with anything.
|
||||||
|
# An operator pressing start has, at minimum, looked at the
|
||||||
|
# banner that says why.
|
||||||
|
self.sign_wd.reset()
|
||||||
|
self.log_event("sign-disagreement failsafe cleared by operator")
|
||||||
if not self.auto:
|
if not self.auto:
|
||||||
self.target = 0.0
|
self.target = 0.0
|
||||||
await self.write_setpoint(0.0, force=True)
|
await self.write_setpoint(0.0, force=True)
|
||||||
@@ -498,6 +721,26 @@ async def amain() -> None:
|
|||||||
except Exception as _e: # noqa: BLE001
|
except Exception as _e: # noqa: BLE001
|
||||||
_LOG.error("core api probe failed: %s", _e)
|
_LOG.error("core api probe failed: %s", _e)
|
||||||
|
|
||||||
|
# ⚠️ THE STARTUP GATE (CFG-01). Nothing below this line may run on a
|
||||||
|
# configuration validate.py rejects - specs §1.5: a config the system
|
||||||
|
# cannot honour is refused at startup, not survived at runtime.
|
||||||
|
#
|
||||||
|
# It sits HERE, before the broker, before the web server and before any
|
||||||
|
# task exists, so a refusal cannot leave half a controller running with
|
||||||
|
# a UI in front of it. Reading the device range is the one thing the
|
||||||
|
# validator cannot do for itself; (None, None) when ESPHome has not come
|
||||||
|
# up yet is not a refusal - run_control() re-checks once the real rating
|
||||||
|
# is known. See validate.py for where the line is drawn and why.
|
||||||
|
_sp = str(opts.get("setpoint_entity", "") or "").strip()
|
||||||
|
_dev_min = _dev_max = None
|
||||||
|
if _sp:
|
||||||
|
_dev_min, _dev_max, _ = await hass.limits(_sp)
|
||||||
|
_LOG.info("setpoint device %s reports range %s…%s W", _sp, _dev_min, _dev_max)
|
||||||
|
_problems = validate_startup_config(opts, _dev_min, _dev_max)
|
||||||
|
if _problems:
|
||||||
|
refuse(_problems)
|
||||||
|
raise ConfigRefused(_problems)
|
||||||
|
|
||||||
# ⚠️ Status publishing must NEVER be able to stop the controller. A
|
# ⚠️ Status publishing must NEVER be able to stop the controller. A
|
||||||
# broken broker, a missing library, an API change in paho - all of it is
|
# broken broker, a missing library, an API change in paho - all of it is
|
||||||
# observability, and the battery does not care. Caught broadly and on
|
# observability, and the battery does not care. Caught broadly and on
|
||||||
@@ -523,10 +766,10 @@ async def amain() -> None:
|
|||||||
|
|
||||||
pub = _NoMqtt()
|
pub = _NoMqtt()
|
||||||
|
|
||||||
controller = Controller(opts, hass, store, pub)
|
stop = asyncio.Event()
|
||||||
|
controller = Controller(opts, hass, store, pub, stop=stop)
|
||||||
runner = await web.start(controller, port=8099)
|
runner = await web.start(controller, port=8099)
|
||||||
|
|
||||||
stop = asyncio.Event()
|
|
||||||
loop = asyncio.get_running_loop()
|
loop = asyncio.get_running_loop()
|
||||||
for sig in (signal.SIGTERM, signal.SIGINT):
|
for sig in (signal.SIGTERM, signal.SIGINT):
|
||||||
with contextlib.suppress(NotImplementedError):
|
with contextlib.suppress(NotImplementedError):
|
||||||
@@ -540,6 +783,7 @@ async def amain() -> None:
|
|||||||
# unit - would be computed from a fraction of the data.
|
# unit - would be computed from a fraction of the data.
|
||||||
p1_source = build_source(opts, controller.p1, session, broker)
|
p1_source = build_source(opts, controller.p1, session, broker)
|
||||||
if p1_source is not None:
|
if p1_source is not None:
|
||||||
|
controller.p1_source = p1_source # so checks() can report on it
|
||||||
tasks.append(asyncio.create_task(p1_source.run()))
|
tasks.append(asyncio.create_task(p1_source.run()))
|
||||||
|
|
||||||
await stop.wait()
|
await stop.wait()
|
||||||
@@ -552,6 +796,10 @@ async def amain() -> None:
|
|||||||
await task
|
await task
|
||||||
await runner.cleanup()
|
await runner.cleanup()
|
||||||
_LOG.info("stopped")
|
_LOG.info("stopped")
|
||||||
|
# The late-arriving-device refusal from run_control(). Re-raised only
|
||||||
|
# now, so the wind-down above still ran and the inverter is at 0 W.
|
||||||
|
if controller.refused:
|
||||||
|
raise ConfigRefused(controller.refused)
|
||||||
|
|
||||||
|
|
||||||
def main() -> None:
|
def main() -> None:
|
||||||
@@ -559,6 +807,13 @@ def main() -> None:
|
|||||||
asyncio.run(amain())
|
asyncio.run(amain())
|
||||||
except KeyboardInterrupt:
|
except KeyboardInterrupt:
|
||||||
pass
|
pass
|
||||||
|
except ConfigRefused:
|
||||||
|
# ⚠️ No traceback, on purpose. The banner refuse() already printed says
|
||||||
|
# everything an operator needs, and a stack trace on top of it would say
|
||||||
|
# "this crashed" - the exact confusion AC3 is about. 78 is sysexits(3)
|
||||||
|
# EX_CONFIG, so even a script reading the exit status can tell a bad
|
||||||
|
# config from a bug.
|
||||||
|
raise SystemExit(78)
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
|
|||||||
@@ -45,13 +45,32 @@ SENSORS = [
|
|||||||
("soc", "goodwe_battery_soc", "Battery SoC", "%", "battery", "measurement", None),
|
("soc", "goodwe_battery_soc", "Battery SoC", "%", "battery", "measurement", None),
|
||||||
("phase", "goodwe_maintenance_phase", "Maintenance phase", None, None, None, "mdi:battery-sync"),
|
("phase", "goodwe_maintenance_phase", "Maintenance phase", None, None, None, "mdi:battery-sync"),
|
||||||
("status", "goodwe_controller_status", "Controller status", None, None, None, "mdi:heart-pulse"),
|
("status", "goodwe_controller_status", "Controller status", None, None, None, "mdi:heart-pulse"),
|
||||||
# ⚠️ This one deliberately breaks the goodwe_ prefix above: the entity id
|
# ⚠️ THE LIVE ENTITY IS `sensor.goodwe_p1_sample_age`, NOT what this
|
||||||
# must be exactly `sensor.p1_sample_age_s`, because SAFETY-01's firmware
|
# object_id spells. An earlier version of this comment said the id "must be
|
||||||
# watchdog subscribes to that literal id and the ENV-01 simulation rig
|
# exactly sensor.p1_sample_age_s" - that name has never existed on any HA,
|
||||||
# asserts on it. Renaming it silently disarms a safety layer. It is seconds
|
# and believing it is how a safety layer gets disarmed by someone tidying up.
|
||||||
# since the newest accepted P1 telegram, republished every second so that a
|
#
|
||||||
# meter frozen at a constant value still shows a climbing age - which is the
|
# On HA 2026.8 `object_id` in a discovery payload does NOT determine the
|
||||||
# false-trip that this entity exists to remove.
|
# entity_id. HA composes it from the device name plus the entity name:
|
||||||
|
# "GoodWe RS485 Controller" + "P1 sample age" -> sensor.goodwe_p1_sample_age.
|
||||||
|
# Verified against the live system 2026-08-26; the firmware subscribes to
|
||||||
|
# that composed name (goodwe-master-stage4-failsafe.yaml, homeassistant
|
||||||
|
# sensor p1_age_s), and its own comment records that sensor.p1_sample_age_s
|
||||||
|
# never existed.
|
||||||
|
#
|
||||||
|
# So: do NOT "fix" the firmware to match the object_id below, and do not
|
||||||
|
# rename the device or this entity's friendly name - either changes the
|
||||||
|
# composed id and silently disarms the ingest guard, because has_state()
|
||||||
|
# simply stays false forever and nothing reports it. The firmware calls this
|
||||||
|
# out as the failure that "FAILS SILENTLY AND LOOKS CORRECT".
|
||||||
|
#
|
||||||
|
# The value: seconds since the newest accepted P1 telegram, republished
|
||||||
|
# every second so a meter frozen at a constant value still shows a climbing
|
||||||
|
# age - the false-trip this entity exists to remove.
|
||||||
|
#
|
||||||
|
# ⚠️ Separately, and not fixed here: the firmware's ingest guard tests this
|
||||||
|
# sensor's VALUE rather than its arrival, so a dead publisher freezes the
|
||||||
|
# number and reads permanently fresh. Filed as TEL-06.
|
||||||
("p1_age", "p1_sample_age_s", "P1 sample age", "s", "duration", "measurement", None),
|
("p1_age", "p1_sample_age_s", "P1 sample age", "s", "duration", "measurement", None),
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|||||||
+503
-7
@@ -4,13 +4,22 @@ Everything downstream trusts this module: the safety checks, the capacity-tariff
|
|||||||
peak, the optimizer, the control loop's sign. So three things happen here and
|
peak, the optimizer, the control loop's sign. So three things happen here and
|
||||||
nowhere else.
|
nowhere else.
|
||||||
|
|
||||||
1. The IMPORT/EXPORT DERIVATION. A Belgian P1 meter exposes two UNSIGNED
|
1. The IMPORT/EXPORT DERIVATION. A Belgian P1 read over DSMR exposes two
|
||||||
registers - consumption and injection - never one signed figure. Net power
|
UNSIGNED registers - consumption and injection. Net power is
|
||||||
is `import_w - export_w`, positive = import, and that subtraction is done
|
`import_w - export_w`, positive = import, and that subtraction is done
|
||||||
exactly once, here (spec §5.2: "the derivation is the EMS's job, not a
|
exactly once, here (spec §5.2: "the derivation is the EMS's job, not a
|
||||||
template the user has to write"). A second copy of it somewhere else is a
|
template the user has to write"). A second copy of it somewhere else is a
|
||||||
second chance to invert the control loop.
|
second chance to invert the control loop.
|
||||||
|
|
||||||
|
Some P1 readers - the HomeWizard P1 among them - publish the OTHER shape:
|
||||||
|
one SIGNED figure, positive = import, and no unsigned registers at all.
|
||||||
|
`split_signed()` fans that back out into the same two magnitudes, so there
|
||||||
|
is still exactly one internal representation and one sign convention. ⚠️ It
|
||||||
|
lives here, next to the subtraction, for the same reason the subtraction
|
||||||
|
does: the moment a user is asked to write two template sensors that split a
|
||||||
|
signed value, the sign convention is back in unreviewed YAML underneath a
|
||||||
|
safety input, which is precisely what §5.2 moved into the EMS.
|
||||||
|
|
||||||
2. THE INGEST TIMESTAMP. Every accepted sample is stamped on arrival. A value
|
2. THE INGEST TIMESTAMP. Every accepted sample is stamped on arrival. A value
|
||||||
with no age is a value that cannot be trusted (§5.2), and staleness is the
|
with no age is a value that cannot be trusted (§5.2), and staleness is the
|
||||||
failsafe trigger (§11.2).
|
failsafe trigger (§11.2).
|
||||||
@@ -47,6 +56,8 @@ _LOG = logging.getLogger("goodwe.p1")
|
|||||||
|
|
||||||
SOURCE_HA = "ha_dsmr"
|
SOURCE_HA = "ha_dsmr"
|
||||||
SOURCE_MQTT = "mqtt_p1"
|
SOURCE_MQTT = "mqtt_p1"
|
||||||
|
SOURCE_HA_SIGNED = "ha_signed"
|
||||||
|
SOURCE_HOMEWIZARD = "homewizard_local"
|
||||||
|
|
||||||
QUARTER_S = 900
|
QUARTER_S = 900
|
||||||
|
|
||||||
@@ -78,7 +89,7 @@ class P1Sample:
|
|||||||
ingest_ts: datetime # tz-aware UTC, set at ingest
|
ingest_ts: datetime # tz-aware UTC, set at ingest
|
||||||
ingest_mono: float # time.monotonic() at ingest - see age_s()
|
ingest_mono: float # time.monotonic() at ingest - see age_s()
|
||||||
telegram_ts: datetime | None # from the telegram, where the source has one
|
telegram_ts: datetime | None # from the telegram, where the source has one
|
||||||
source: str # SOURCE_HA | SOURCE_MQTT
|
source: str # one of the SOURCE_* constants above
|
||||||
import_w: float # unsigned magnitude, as the meter reports it
|
import_w: float # unsigned magnitude, as the meter reports it
|
||||||
export_w: float # unsigned magnitude
|
export_w: float # unsigned magnitude
|
||||||
net_w: float # import_w - export_w (+ import, - export)
|
net_w: float # import_w - export_w (+ import, - export)
|
||||||
@@ -129,6 +140,29 @@ def _watts(value, what: str) -> float:
|
|||||||
return out
|
return out
|
||||||
|
|
||||||
|
|
||||||
|
def split_signed(net_w) -> tuple[float, float]:
|
||||||
|
"""One signed figure -> the (import, export) magnitudes the module speaks.
|
||||||
|
|
||||||
|
The inverse of make_sample's subtraction, and the easy direction: no second
|
||||||
|
register to disagree with, so there is nothing to mix a fresh reading with a
|
||||||
|
stale one. `+` is import, `-` is export - verified in test_p1.py against real
|
||||||
|
captured readings from this house's own meter, not against a datasheet.
|
||||||
|
|
||||||
|
⚠️ Exactly one of the two comes out non-zero. Splitting into `(max(v,0),
|
||||||
|
max(-v,0))` rather than clamping keeps `import_w - export_w == v` exactly, so
|
||||||
|
the signed value the meter published survives the round trip bit for bit -
|
||||||
|
a control loop must not be steered by a number that changed on the way in.
|
||||||
|
|
||||||
|
⚠️ Validation is `_watts`, the same gate the unsigned path uses: NaN,
|
||||||
|
infinity, non-numbers and the §20 open-question-5 unsigned-decode
|
||||||
|
contamination (64954 for -582 W) are all refused here rather than believed.
|
||||||
|
A signed source makes that check MORE important, not less - on this path
|
||||||
|
64954 is not obviously wrong the way a negative "unsigned" register is.
|
||||||
|
"""
|
||||||
|
v = _watts(net_w, "net")
|
||||||
|
return (v, 0.0) if v >= 0 else (0.0, -v)
|
||||||
|
|
||||||
|
|
||||||
def make_sample(source: str, import_w, export_w, *, phases: int,
|
def make_sample(source: str, import_w, export_w, *, phases: int,
|
||||||
phase_import_w=None, phase_export_w=None,
|
phase_import_w=None, phase_export_w=None,
|
||||||
telegram_ts: datetime | None = None,
|
telegram_ts: datetime | None = None,
|
||||||
@@ -668,6 +702,333 @@ class MqttP1Source:
|
|||||||
self.ingest.reject(err)
|
self.ingest.reject(err)
|
||||||
|
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
# transport 3: Home Assistant WebSocket, one signed entity
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
class HaSignedSource(HaDsmrSource):
|
||||||
|
"""The same websocket, subscribed to ONE signed power entity.
|
||||||
|
|
||||||
|
For readers that publish net power as a single signed figure - a HomeWizard
|
||||||
|
P1's `sensor.p1_meter_active_power`, positive = import - rather than the two
|
||||||
|
unsigned DSMR registers. This is the meter actually installed at the house,
|
||||||
|
and `ha_dsmr` cannot read it: it needs two registers and refuses a negative
|
||||||
|
one outright, which is every exporting telegram.
|
||||||
|
|
||||||
|
⚠️ A subclass, not a copy. The connect / auth / subscribe / reconnect /
|
||||||
|
`_absorb` machinery above is transport, not shape, and it has already been
|
||||||
|
debugged once - notably "prime the cache from get_states but never build a
|
||||||
|
sample out of it" and "a reconnect emits nothing". Only `_wanted` (which
|
||||||
|
entity ids) and `build` (how they become a sample) differ, so only those two
|
||||||
|
are overridden. Everything TEL-01 established therefore applies unchanged:
|
||||||
|
ingest timestamping, meter_max_age_s, the clock-recomputed age sensor, and
|
||||||
|
`unavailable` treated as a missing reading rather than 0 W.
|
||||||
|
|
||||||
|
⚠️ THE AGE ON THIS TRANSPORT MEASURES TIME SINCE THE VALUE CHANGED, not time
|
||||||
|
since the meter reported, and on one entity those are very different things.
|
||||||
|
Home Assistant offers no arrival signal for a repeated reading: it emits no
|
||||||
|
`state_changed`, it does not advance `last_reported` on either serialiser,
|
||||||
|
and `state_reported` cannot be subscribed to over the websocket at all
|
||||||
|
("Event filter is required for event state_reported"). All three measured on
|
||||||
|
the ENV-01 rig against the real HomeWizard integration with the meter frozen
|
||||||
|
- 0 state_changed in 70 s, no timestamp movement anywhere.
|
||||||
|
|
||||||
|
`ha_dsmr` mostly escapes it because a DSMR telegram moves several entities at
|
||||||
|
once. This transport has ONE, so a healthy meter under a flat load looks
|
||||||
|
exactly like a dead one - and our own capture has the real meter going 42.2 s
|
||||||
|
and 97.0 s between changes, both past the default max_age_s of 30. Hence
|
||||||
|
DOCS.md: sensor.p1_sample_age_s is correct while the value moves and must not
|
||||||
|
yet be thresholded by the firmware watchdog on this transport. Raising
|
||||||
|
meter_max_age_s does not fix it, it only chooses which of the two errors you
|
||||||
|
get. The fix is an arrival stamp from the meter itself - reading the
|
||||||
|
HomeWizard local API rather than an HA entity - which is a separate ticket.
|
||||||
|
|
||||||
|
⚠️ The debounce is inherited but does nothing useful here, and that is fine:
|
||||||
|
one telegram is one entity, so there is no burst of per-entity events to
|
||||||
|
coalesce and no window in which a new reading sits beside a stale one. It
|
||||||
|
costs one scheduled sleep per telegram at ~0.2 Hz. Left in place rather than
|
||||||
|
special-cased, because a second code path through build() is a second place
|
||||||
|
for the sign to go wrong.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def _wanted(self) -> set[str]:
|
||||||
|
out = set()
|
||||||
|
if self.entities.get("net"):
|
||||||
|
out.add(self.entities["net"])
|
||||||
|
out.update(e for e in self.entities.get("phase_net") or [] if e)
|
||||||
|
return out
|
||||||
|
|
||||||
|
def build(self) -> bool:
|
||||||
|
"""Assemble one sample from the cache. Returns True if one was accepted."""
|
||||||
|
net_id = self.entities.get("net")
|
||||||
|
if net_id not in self.cache:
|
||||||
|
return False
|
||||||
|
pn = [self.cache.get(e) for e in self.entities.get("phase_net") or []]
|
||||||
|
if pn and None in pn:
|
||||||
|
return False # incomplete phase set: wait, do not guess
|
||||||
|
try:
|
||||||
|
imp, exp = split_signed(self.cache[net_id])
|
||||||
|
pi = pe = None
|
||||||
|
if pn:
|
||||||
|
# ponytail: this split is arithmetically redundant today -
|
||||||
|
# make_sample subtracts the two lists again and does not
|
||||||
|
# sign-check per-phase figures, so handing it the signed values
|
||||||
|
# with a zero export list produces the identical tuple. Verified:
|
||||||
|
# mutating it that way leaves all 174 checks green, i.e. no test
|
||||||
|
# can tell the difference, and it is recorded here rather than
|
||||||
|
# left as a silent equivalent mutant for the next reviewer to
|
||||||
|
# rediscover. Kept because `phase_import_w` means a MAGNITUDE:
|
||||||
|
# a negative in it is the double-signing that make_sample refuses
|
||||||
|
# outright for the connection-level registers, and the day that
|
||||||
|
# check is extended per-phase the shortcut breaks the meter, not
|
||||||
|
# the test.
|
||||||
|
pairs = [split_signed(v) for v in pn]
|
||||||
|
pi = [a for a, _ in pairs]
|
||||||
|
pe = [b for _, b in pairs]
|
||||||
|
self.ingest.submit(make_sample(
|
||||||
|
SOURCE_HA_SIGNED, imp, exp,
|
||||||
|
phases=self.ingest.phases,
|
||||||
|
phase_import_w=pi, phase_export_w=pe,
|
||||||
|
# ⚠️ No telegram_ts, for the same reason as ha_dsmr: HA's
|
||||||
|
# last_changed is when the VALUE changed, which on a steady meter
|
||||||
|
# is minutes ago while the telegram is current. sensor.
|
||||||
|
# p1_sample_age_s is what covers a genuinely frozen meter.
|
||||||
|
))
|
||||||
|
return True
|
||||||
|
except P1Error as err:
|
||||||
|
self.ingest.reject(err)
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
# transport 4: the HomeWizard P1's own local API
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
HOMEWIZARD_PATH = "/api/v1/data"
|
||||||
|
HOMEWIZARD_PORT = 80
|
||||||
|
|
||||||
|
|
||||||
|
def parse_homewizard(doc, phases: int, *, now: datetime | None = None,
|
||||||
|
ingest_mono: float | None = None) -> P1Sample:
|
||||||
|
"""One `GET /api/v1/data` document -> a sample. Raises P1Error.
|
||||||
|
|
||||||
|
The meter's own JSON, of which we read four keys:
|
||||||
|
|
||||||
|
{"active_power_w": -5710.0, # SIGNED, + import - export
|
||||||
|
"active_power_l1_w": ..., "active_power_l2_w": ..., "..._l3_w": ...,
|
||||||
|
"total_power_import_kwh": 1234.567, "total_power_export_kwh": 890.123}
|
||||||
|
|
||||||
|
Same shape as `ha_signed` - one signed connection figure plus signed
|
||||||
|
per-phase figures - so it goes through the same `split_signed` and the same
|
||||||
|
`make_sample`. Nothing about the sign convention is re-derived here.
|
||||||
|
|
||||||
|
⚠️ No telegram timestamp, because the API carries none, and that is correct
|
||||||
|
rather than a gap: the document was produced by the meter in the moment it
|
||||||
|
answered, so the ingest stamp IS the measurement time. This is the whole
|
||||||
|
reason the transport exists - see HomeWizardLocalSource.
|
||||||
|
|
||||||
|
⚠️ Per-phase figures are taken only when the meter serves ALL `phases` of
|
||||||
|
them. A single-phase HomeWizard returns `active_power_l2_w: null`, and a
|
||||||
|
partial set must not become a fabricated tuple. Unlike the HA transports
|
||||||
|
there is no "wait for the rest" case to worry about: every field here came
|
||||||
|
out of ONE response, so a missing phase cannot be a stale phase, and the
|
||||||
|
connection-level reading is still a genuine, complete measurement. Dropping
|
||||||
|
the whole sample over an absent per-phase field would turn a healthy meter
|
||||||
|
into a climbing age, which is the exact false-trip this ticket removes.
|
||||||
|
"""
|
||||||
|
if not isinstance(doc, dict):
|
||||||
|
raise P1Error(f"meter response is not a JSON object ({type(doc).__name__})")
|
||||||
|
|
||||||
|
imp, exp = split_signed(doc.get("active_power_w"))
|
||||||
|
|
||||||
|
pi = pe = None
|
||||||
|
# ⚠️ range(phases), not the legs the meter served: a 3-phase meter configured
|
||||||
|
# as meter_phases: 1 yields a per-phase tuple covering ONE leg of three.
|
||||||
|
# Control is unaffected (it uses the connection figure), but the
|
||||||
|
# capacity-tariff peak is understated. Filed separately - not fixed here.
|
||||||
|
legs = [doc.get(f"active_power_l{i + 1}_w") for i in range(phases)]
|
||||||
|
if all(v is not None for v in legs):
|
||||||
|
pairs = [split_signed(v) for v in legs]
|
||||||
|
pi = [a for a, _ in pairs]
|
||||||
|
pe = [b for _, b in pairs]
|
||||||
|
|
||||||
|
return make_sample(SOURCE_HOMEWIZARD, imp, exp, phases=phases,
|
||||||
|
phase_import_w=pi, phase_export_w=pe,
|
||||||
|
ingest_ts=now, ingest_mono=ingest_mono)
|
||||||
|
|
||||||
|
|
||||||
|
def measurement_fingerprint(doc) -> tuple:
|
||||||
|
"""The part of a response that a genuinely new measurement has to move.
|
||||||
|
|
||||||
|
Power plus both energy registers. A meter under any real load advances a
|
||||||
|
kWh counter (1 Wh resolution: ~10 s at 350 W), so this changes even when the
|
||||||
|
power figure happens to repeat. Used ONLY for `unchanged_s` - see there for
|
||||||
|
why it must not be allowed anywhere near the age.
|
||||||
|
"""
|
||||||
|
if not isinstance(doc, dict):
|
||||||
|
return ()
|
||||||
|
return (doc.get("active_power_w"),
|
||||||
|
doc.get("total_power_import_kwh"),
|
||||||
|
doc.get("total_power_export_kwh"))
|
||||||
|
|
||||||
|
|
||||||
|
class HomeWizardLocalSource:
|
||||||
|
"""Polls the meter's own local HTTP API instead of a Home Assistant entity.
|
||||||
|
|
||||||
|
⚠️ THIS IS THE ONLY TRANSPORT WHOSE AGE MEASURES ARRIVAL. That is the entire
|
||||||
|
reason it exists, and it is not an optimisation - it is the difference
|
||||||
|
between an age sensor a firmware watchdog may threshold and one it may not.
|
||||||
|
|
||||||
|
Every HTTP response is a genuine arrival: the meter answered, now, with its
|
||||||
|
current reading. Whether the NUMBER moved is irrelevant, so a healthy meter
|
||||||
|
under a flat load resets the age exactly like a busy one. Home Assistant
|
||||||
|
cannot provide this at all - it emits `state_changed` only on a change, does
|
||||||
|
not advance `last_reported` on either serialiser for a repeat, and refuses a
|
||||||
|
`state_reported` subscription outright ("Event filter is required"). Measured
|
||||||
|
on the ENV-01 rig over 70 s of a frozen meter, and independently against the
|
||||||
|
live house over ten repeated readings. So on `ha_signed` the age means "time
|
||||||
|
since the value changed", and our own capture of this house's meter has
|
||||||
|
42.2 s and 97.0 s between changes - both past the default `meter_max_age_s`
|
||||||
|
of 30, i.e. a false trip to 0 W on a perfectly healthy meter.
|
||||||
|
|
||||||
|
Everything else is TEL-01's pipeline unchanged: ingest timestamping,
|
||||||
|
`meter_max_age_s`, the clock-recomputed age, the plausibility bounds, and a
|
||||||
|
failed read treated as a MISSING reading rather than 0 W.
|
||||||
|
|
||||||
|
⚠️ A failed or timed-out poll submits nothing. It is a rejection, so the
|
||||||
|
last good sample and its stamp stay exactly where they were and the age goes
|
||||||
|
on climbing - which is precisely the signal a dead meter should produce.
|
||||||
|
|
||||||
|
⚠️ POLL CADENCE vs `meter_max_age_s`. The age can only be as fresh as the
|
||||||
|
poll interval, so `meter_poll_s` must sit well under `meter_max_age_s` or the
|
||||||
|
reading flaps in and out of staleness on a healthy meter. The real meter
|
||||||
|
updates every ~5.0 s (NOTES.md:640 measures 4.97 s), so polling faster than
|
||||||
|
that buys nothing but re-reads. Default 5 s against a 30 s max age; the
|
||||||
|
startup check in build_source refuses `meter_poll_s >= meter_max_age_s` and
|
||||||
|
warns past half of it.
|
||||||
|
|
||||||
|
ponytail: a plain `asyncio.sleep` loop rather than a scheduler, and no
|
||||||
|
backoff. A poll that fails costs one rejection and is retried on the next
|
||||||
|
tick; a meter that is down stays down and the age reports it. The ceiling is
|
||||||
|
a meter so slow that polls overlap - the request timeout is held under the
|
||||||
|
poll interval so they cannot.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self, session, ingest: P1Ingest, host: str, *,
|
||||||
|
port: int = HOMEWIZARD_PORT, poll_s: float = 5.0,
|
||||||
|
timeout_s: float | None = None):
|
||||||
|
self.session = session
|
||||||
|
self.ingest = ingest
|
||||||
|
self.host, self.port = host, int(port)
|
||||||
|
self.poll_s = float(poll_s)
|
||||||
|
# ⚠️ Held under the poll interval on purpose: a timeout longer than the
|
||||||
|
# cadence queues polls behind a hung meter, and a backlog of requests
|
||||||
|
# all landing at once would stamp several arrivals for one measurement.
|
||||||
|
self.timeout_s = float(timeout_s) if timeout_s else max(1.0, self.poll_s * 0.8)
|
||||||
|
self.url = f"http://{self.host}:{self.port}{HOMEWIZARD_PATH}"
|
||||||
|
self.connected = False
|
||||||
|
self.polls = 0
|
||||||
|
self.poll_errors = 0
|
||||||
|
self._fingerprint: tuple | None = None
|
||||||
|
self._changed_mono: float | None = None
|
||||||
|
|
||||||
|
@property
|
||||||
|
def unchanged_s(self) -> float | None:
|
||||||
|
"""Seconds since the meter last served a DIFFERENT measurement.
|
||||||
|
|
||||||
|
⚠️ Diagnostic only, and deliberately NOT folded into
|
||||||
|
`sensor.p1_sample_age_s`. A frozen meter (SAFETY-01's six-minute
|
||||||
|
runaway) answers 200 OK with a stale document forever, so no arrival
|
||||||
|
detector can see it - only the document standing still can, and this is
|
||||||
|
that signal. It is exposed rather than acted on because it is NOT safe
|
||||||
|
as a 30 s watchdog input: this controller regulates grid power toward
|
||||||
|
~0 W, and at a converged -10 W the export register takes six minutes to
|
||||||
|
advance by its 1 Wh resolution while the power figure legitimately
|
||||||
|
repeats. Thresholding that would rebuild the very limit cycle the
|
||||||
|
arrival stamp just removed, at the exact operating point we aim for.
|
||||||
|
Whoever wires a freeze detector must handle the low-power case first.
|
||||||
|
"""
|
||||||
|
if self._changed_mono is None:
|
||||||
|
return None
|
||||||
|
return max(0.0, time.monotonic() - self._changed_mono)
|
||||||
|
|
||||||
|
async def run(self) -> None:
|
||||||
|
"""Long-lived task: poll, submit, sleep, forever.
|
||||||
|
|
||||||
|
⚠️ Nothing but cancellation may end this loop. An escaping exception
|
||||||
|
would kill the poll task for the lifetime of the add-on, and it would do
|
||||||
|
it QUIETLY: the failure mode is safe (no submissions, the age climbs, the
|
||||||
|
watchdog holds the battery at 0 W) but it looks identical to a dead
|
||||||
|
meter, so the operator goes hunting the wrong device. Retry on the next
|
||||||
|
tick instead - poll_s is already the retry cadence, so no backoff.
|
||||||
|
"""
|
||||||
|
_LOG.info("P1 ingest: polling %s every %.1fs", self.url, self.poll_s)
|
||||||
|
while True:
|
||||||
|
try:
|
||||||
|
await self.poll_once()
|
||||||
|
except asyncio.CancelledError:
|
||||||
|
raise
|
||||||
|
except Exception as err: # noqa: BLE001 - the task must outlive it
|
||||||
|
_LOG.warning("P1 meter poll %s: %s - retrying in %.1fs", self.url,
|
||||||
|
str(err) or type(err).__name__, self.poll_s)
|
||||||
|
await asyncio.sleep(self.poll_s)
|
||||||
|
|
||||||
|
async def poll_once(self) -> bool:
|
||||||
|
"""One GET. Returns True if a sample was accepted."""
|
||||||
|
self.polls += 1
|
||||||
|
try:
|
||||||
|
async with self.session.get(
|
||||||
|
self.url,
|
||||||
|
timeout=aiohttp.ClientTimeout(total=self.timeout_s)) as resp:
|
||||||
|
if resp.status != 200:
|
||||||
|
raise P1Error(f"meter returned HTTP {resp.status}")
|
||||||
|
# content_type=None: the meter's own firmware is the authority on
|
||||||
|
# what it serves, and refusing a reading over a Content-Type
|
||||||
|
# header would be a fabricated outage.
|
||||||
|
# ⚠️ Kept because a real HomeWizard firmware that ever answers
|
||||||
|
# text/plain would otherwise read as a dead meter and hold the
|
||||||
|
# battery at 0 W. (This was once recorded here as an equivalent
|
||||||
|
# mutant - it is not. aiohttp's json_response always sets
|
||||||
|
# application/json, but web.Response(text=...) defaults to
|
||||||
|
# text/plain, so the fake meter CAN serve valid JSON under the
|
||||||
|
# wrong header, and test_p1.py now does.)
|
||||||
|
doc = await resp.json(content_type=None)
|
||||||
|
except asyncio.CancelledError:
|
||||||
|
raise
|
||||||
|
except Exception as err: # noqa: BLE001 - any read failure is a gap
|
||||||
|
self.connected = False
|
||||||
|
self.poll_errors += 1
|
||||||
|
# ⚠️ str() of a bare asyncio.TimeoutError is the EMPTY STRING, so
|
||||||
|
# f"...: {err}" renders "last error:" and then nothing - on the
|
||||||
|
# status page, on a hung meter, at the moment the battery has just
|
||||||
|
# dropped to 0 W and someone is reading that line to find out why.
|
||||||
|
# The class name is the only thing that says "it timed out".
|
||||||
|
# ⚠️ str(err), not `err or ...`: an exception object is ALWAYS truthy,
|
||||||
|
# empty message or not, so the `or` would never reach the fallback.
|
||||||
|
self.ingest.reject(
|
||||||
|
f"meter poll {self.url}: {str(err) or type(err).__name__}")
|
||||||
|
return False
|
||||||
|
|
||||||
|
self.connected = True
|
||||||
|
try:
|
||||||
|
sample = parse_homewizard(doc, self.ingest.phases)
|
||||||
|
# ⚠️ Submitted unconditionally, INCLUDING a document identical to the
|
||||||
|
# last one. The response is the arrival; the number is not.
|
||||||
|
# Inside the try on purpose: submit() outside it would put a raise on
|
||||||
|
# a path with no handler at all, killing the poll task permanently -
|
||||||
|
# safely (the age climbs) but silently. run() backstops the rest.
|
||||||
|
self.ingest.submit(sample)
|
||||||
|
self._note(doc)
|
||||||
|
except P1Error as err:
|
||||||
|
self.ingest.reject(err)
|
||||||
|
return False
|
||||||
|
return True
|
||||||
|
|
||||||
|
def _note(self, doc) -> None:
|
||||||
|
fp = measurement_fingerprint(doc)
|
||||||
|
if self._changed_mono is None or fp != self._fingerprint:
|
||||||
|
self._fingerprint = fp
|
||||||
|
self._changed_mono = time.monotonic()
|
||||||
|
|
||||||
|
|
||||||
# --------------------------------------------------------------------------- #
|
# --------------------------------------------------------------------------- #
|
||||||
# selection
|
# selection
|
||||||
# --------------------------------------------------------------------------- #
|
# --------------------------------------------------------------------------- #
|
||||||
@@ -683,15 +1044,133 @@ def is_enabled(opts: dict) -> bool:
|
|||||||
return str(opts.get("meter_source", "off") or "off").strip() not in ("off", "")
|
return str(opts.get("meter_source", "off") or "off").strip() not in ("off", "")
|
||||||
|
|
||||||
|
|
||||||
|
def homewizard_host_port(opts: dict) -> tuple[str, str]:
|
||||||
|
"""`p1_host` split into host and (still unparsed) port text.
|
||||||
|
|
||||||
|
One definition because validate_meter_options() and build_source() must
|
||||||
|
agree byte for byte about what counts as a usable address - a pasted browser
|
||||||
|
URL is the obvious way to fill this in wrong.
|
||||||
|
"""
|
||||||
|
host = str(opts.get("p1_host", "") or "").strip()
|
||||||
|
host = host.removeprefix("http://").removeprefix("https://").rstrip("/")
|
||||||
|
host, _, port_s = host.partition(":")
|
||||||
|
return host, port_s
|
||||||
|
|
||||||
|
|
||||||
|
def validate_meter_options(opts: dict, phases: int, max_age_s: float) -> list[str]:
|
||||||
|
"""Every way `meter_source` can name a meter that will never produce a reading.
|
||||||
|
|
||||||
|
⚠️ THIS IS THE ONLY PLACE THAT KNOWS THESE RULES. It used to be a run of
|
||||||
|
inline `return None`s inside build_source(); CFG-01 lifted them out because
|
||||||
|
the same predicates now have two callers with two different consequences:
|
||||||
|
|
||||||
|
validate.validate_startup_config() refuses to start the add-on
|
||||||
|
build_source() returns None, as it always did
|
||||||
|
|
||||||
|
They are one function and not two on purpose. A second copy of "what makes a
|
||||||
|
meter config wrong" would drift, and the half that drifted would be the one
|
||||||
|
that decides whether the process is allowed to run.
|
||||||
|
|
||||||
|
Checked ONCE at startup rather than per telegram, because a misconfigured
|
||||||
|
source otherwise fails in the one way indistinguishable from a healthy source
|
||||||
|
nobody has sent anything to yet: no samples, a climbing age, the firmware
|
||||||
|
watchdog holding the battery at 0 W, and nothing in the log saying why.
|
||||||
|
|
||||||
|
Returns a list of human-readable problems; empty means the config is usable.
|
||||||
|
`phases` and `max_age_s` are passed in rather than read from opts so the
|
||||||
|
caller decides whether it is validating the options or an already-built
|
||||||
|
P1Ingest - build_source() has an ingest whose values may not have come from
|
||||||
|
this dict.
|
||||||
|
"""
|
||||||
|
source = str(opts.get("meter_source", "off") or "off").strip()
|
||||||
|
if source in ("off", ""):
|
||||||
|
return []
|
||||||
|
problems: list[str] = []
|
||||||
|
|
||||||
|
if source == SOURCE_HA:
|
||||||
|
imp = str(opts.get("p1_import_entity", "") or "").strip()
|
||||||
|
exp = str(opts.get("p1_export_entity", "") or "").strip()
|
||||||
|
if not imp or not exp:
|
||||||
|
problems.append(
|
||||||
|
f"meter_source {SOURCE_HA} needs both p1_import_entity and "
|
||||||
|
f"p1_export_entity (got {imp or '<blank>'!r} / {exp or '<blank>'!r})")
|
||||||
|
elif source == SOURCE_HA_SIGNED:
|
||||||
|
net = str(opts.get("p1_net_entity", "") or "").strip()
|
||||||
|
phase_net = [str(e).strip() for e in
|
||||||
|
(opts.get("p1_phase_net_entities") or []) if str(e).strip()]
|
||||||
|
if not net:
|
||||||
|
problems.append(
|
||||||
|
f"meter_source {SOURCE_HA_SIGNED} needs p1_net_entity "
|
||||||
|
"(sensor.p1_sample_age_s would otherwise be announced with "
|
||||||
|
"nothing feeding it)")
|
||||||
|
if phase_net and len(phase_net) != phases:
|
||||||
|
problems.append(
|
||||||
|
f"p1_phase_net_entities has {len(phase_net)} entities but "
|
||||||
|
f"meter_phases is {phases} - every telegram would be rejected "
|
||||||
|
"on the phase-count check")
|
||||||
|
elif source == SOURCE_MQTT:
|
||||||
|
if not str(opts.get("meter_mqtt_topic", "") or "").strip():
|
||||||
|
problems.append(f"meter_source {SOURCE_MQTT} needs meter_mqtt_topic")
|
||||||
|
elif source == SOURCE_HOMEWIZARD:
|
||||||
|
host, port_s = homewizard_host_port(opts)
|
||||||
|
if not host:
|
||||||
|
problems.append(
|
||||||
|
f"meter_source {SOURCE_HOMEWIZARD} needs p1_host (the meter's "
|
||||||
|
"own address, e.g. 192.168.2.250)")
|
||||||
|
if port_s:
|
||||||
|
try:
|
||||||
|
int(port_s)
|
||||||
|
except ValueError:
|
||||||
|
problems.append(f"p1_host {opts.get('p1_host')!r} has an "
|
||||||
|
"unparseable port")
|
||||||
|
try:
|
||||||
|
# ⚠️ Not `or 5`: that turns an explicit 0 into the default, and a
|
||||||
|
# cadence of 0 is a misconfiguration that must be reported, not
|
||||||
|
# quietly corrected into something that looks like it was asked for.
|
||||||
|
raw = opts.get("meter_poll_s", 5)
|
||||||
|
poll_s = float(5 if raw is None or raw == "" else raw)
|
||||||
|
except (TypeError, ValueError):
|
||||||
|
problems.append(f"meter_poll_s {opts.get('meter_poll_s')!r} is not a number")
|
||||||
|
else:
|
||||||
|
if poll_s <= 0:
|
||||||
|
problems.append("meter_poll_s must be positive")
|
||||||
|
# ⚠️ The age can never be fresher than the poll interval. At or past
|
||||||
|
# max_age_s every reading is stale before its successor arrives, so
|
||||||
|
# the controller would sit permanently on missing inputs while the
|
||||||
|
# meter is perfectly healthy - refuse it rather than ship that.
|
||||||
|
elif poll_s >= max_age_s:
|
||||||
|
problems.append(
|
||||||
|
f"meter_poll_s {poll_s:.1f} is not under meter_max_age_s "
|
||||||
|
f"{max_age_s:.1f} - every reading would go stale before the "
|
||||||
|
"next poll")
|
||||||
|
else:
|
||||||
|
problems.append(
|
||||||
|
f"meter_source {source!r} is not one of "
|
||||||
|
+ ", ".join((SOURCE_HA, SOURCE_MQTT, SOURCE_HA_SIGNED, SOURCE_HOMEWIZARD)))
|
||||||
|
return problems
|
||||||
|
|
||||||
|
|
||||||
def build_source(opts: dict, ingest: P1Ingest, session, broker: dict | None):
|
def build_source(opts: dict, ingest: P1Ingest, session, broker: dict | None):
|
||||||
"""Return the transport named by `meter_source`, or None if disabled.
|
"""Return the transport named by `meter_source`, or None if disabled.
|
||||||
|
|
||||||
This is the whole of AC 1's "switchable": every consumer reads P1Ingest, so
|
This is the whole of AC 1's "switchable": every consumer reads P1Ingest, so
|
||||||
changing transport is a config edit, never a code path.
|
changing transport is a config edit, never a code path.
|
||||||
|
|
||||||
|
⚠️ In the add-on this is now unreachable with a bad config -
|
||||||
|
validate_startup_config() refuses to start on anything
|
||||||
|
validate_meter_options() rejects. The guard stays because this function is
|
||||||
|
also called directly by tests and by anything embedding P1Ingest, and
|
||||||
|
"returns None" is a safer default for those callers than a transport that
|
||||||
|
can never read.
|
||||||
"""
|
"""
|
||||||
source = str(opts.get("meter_source", "off") or "off").strip()
|
source = str(opts.get("meter_source", "off") or "off").strip()
|
||||||
if not is_enabled(opts):
|
if not is_enabled(opts):
|
||||||
return None
|
return None
|
||||||
|
problems = validate_meter_options(opts, ingest.phases, ingest.max_age_s)
|
||||||
|
if problems:
|
||||||
|
for problem in problems:
|
||||||
|
_LOG.error("%s - P1 ingestion disabled", problem)
|
||||||
|
return None
|
||||||
if source == SOURCE_HA:
|
if source == SOURCE_HA:
|
||||||
return HaDsmrSource(session, ingest, {
|
return HaDsmrSource(session, ingest, {
|
||||||
"import": opts.get("p1_import_entity", ""),
|
"import": opts.get("p1_import_entity", ""),
|
||||||
@@ -699,12 +1178,29 @@ def build_source(opts: dict, ingest: P1Ingest, session, broker: dict | None):
|
|||||||
"phase_import": opts.get("p1_phase_import_entities") or [],
|
"phase_import": opts.get("p1_phase_import_entities") or [],
|
||||||
"phase_export": opts.get("p1_phase_export_entities") or [],
|
"phase_export": opts.get("p1_phase_export_entities") or [],
|
||||||
})
|
})
|
||||||
|
if source == SOURCE_HA_SIGNED:
|
||||||
|
return HaSignedSource(session, ingest, {
|
||||||
|
"net": str(opts.get("p1_net_entity", "") or "").strip(),
|
||||||
|
"phase_net": [str(e).strip() for e in
|
||||||
|
(opts.get("p1_phase_net_entities") or []) if str(e).strip()],
|
||||||
|
})
|
||||||
|
if source == SOURCE_HOMEWIZARD:
|
||||||
|
host, port_s = homewizard_host_port(opts)
|
||||||
|
port = int(port_s) if port_s else HOMEWIZARD_PORT
|
||||||
|
raw = opts.get("meter_poll_s", 5)
|
||||||
|
poll_s = float(5 if raw is None or raw == "" else raw)
|
||||||
|
# A warning, not a refusal: one missed poll costs a stale reading and a
|
||||||
|
# 0 W cycle, which is fail-safe. The refusal above is for cadences that
|
||||||
|
# can NEVER be fresh.
|
||||||
|
if poll_s > ingest.max_age_s / 2:
|
||||||
|
_LOG.warning("meter_poll_s %.1f leaves no room under meter_max_age_s "
|
||||||
|
"%.1f: one missed poll makes the reading stale. The meter "
|
||||||
|
"updates every ~5 s; 5 s against 30 s is the tested pair.",
|
||||||
|
poll_s, ingest.max_age_s)
|
||||||
|
return HomeWizardLocalSource(session, ingest, host, port=port, poll_s=poll_s)
|
||||||
if source == SOURCE_MQTT:
|
if source == SOURCE_MQTT:
|
||||||
broker = broker or {}
|
broker = broker or {}
|
||||||
return MqttP1Source(ingest, str(opts.get("meter_mqtt_topic", "")),
|
return MqttP1Source(ingest, str(opts.get("meter_mqtt_topic", "")),
|
||||||
broker.get("host"), broker.get("port", 1883),
|
broker.get("host"), broker.get("port", 1883),
|
||||||
broker.get("username"), broker.get("password"))
|
broker.get("username"), broker.get("password"))
|
||||||
if source:
|
|
||||||
_LOG.error("meter_source %r is not %s or %s - P1 ingestion disabled",
|
|
||||||
source, SOURCE_HA, SOURCE_MQTT)
|
|
||||||
return None
|
return None
|
||||||
|
|||||||
@@ -0,0 +1,315 @@
|
|||||||
|
"""Startup configuration validation - the gate before the control loop runs.
|
||||||
|
|
||||||
|
WHAT THIS IS FOR, in one sentence: some configurations are not "a bit off", they
|
||||||
|
are configurations under which the add-on's own safety machinery does not work,
|
||||||
|
and for those the correct behaviour is to refuse to start rather than to log a
|
||||||
|
line and carry on.
|
||||||
|
|
||||||
|
⚠️ THE FAILURE THIS REPLACES. `main.py` used to read the setpoint device's own
|
||||||
|
±5000 W rating, notice that a configured `max_w` of, say, 8000 W exceeded it,
|
||||||
|
write one WARNING to a log nobody reads, and then run anyway with
|
||||||
|
`write_setpoint()` quietly clamping. The operator's stated ceiling was simply not
|
||||||
|
the ceiling, and the only evidence was a line that had scrolled off. specs §1.5
|
||||||
|
is explicit that a configuration in which the system cannot honour what it was
|
||||||
|
told is refused at startup, not survived at runtime.
|
||||||
|
|
||||||
|
WHERE THE LINE IS DRAWN, and why it is not further out. A validator that refuses
|
||||||
|
on trivia gets switched off by the first person it inconveniences, so this one
|
||||||
|
refuses only where **continuing produces one of two outcomes:**
|
||||||
|
|
||||||
|
(a) **a stated limit is untrue** - the operator configured a bound, a lower
|
||||||
|
layer silently enforces a different one, and nothing says which won; or
|
||||||
|
(b) **the add-on is inert and indistinguishable from healthy** - it starts,
|
||||||
|
serves its UI, reports green, and moves no energy, with no symptom that
|
||||||
|
separates it from a correctly-idle system.
|
||||||
|
|
||||||
|
⚠️ (b) IS NOT A SPECIAL CASE OF (a), and an earlier draft of this file wrongly
|
||||||
|
implied it was by claiming every refusal here "makes a safety mechanism
|
||||||
|
inoperative". It does not: when `setpoint_entity` is blank, layer 1 pinning the
|
||||||
|
inverter at 0 W is the failsafe WORKING. The problem is not that the system
|
||||||
|
becomes unsafe, it is that it becomes a very convincing impression of a working
|
||||||
|
controller - and an operator has no way to tell. That is its own reason to
|
||||||
|
refuse, and stating it as one is what stops the rule being stretched later to
|
||||||
|
cover mere untidiness.
|
||||||
|
|
||||||
|
Both halves have to stay narrow. (a) is not "any two numbers that could
|
||||||
|
disagree"; it is a bound the operator SET being overridden by a layer they
|
||||||
|
cannot see. (b) is not "anything degraded"; it is inert AND silent - if a red
|
||||||
|
NOT READY banner already names the problem, (b) does not apply.
|
||||||
|
|
||||||
|
1. `max_w` outside the setpoint device's own rating. [(a)]
|
||||||
|
The stated limit is untrue. arbiter.py's `supervised` SAFETY claim says the
|
||||||
|
output is bounded by ±max_w; it is not, it is bounded by the device, and the
|
||||||
|
two numbers disagree. Which one wins is a coin toss to anyone reading the
|
||||||
|
config.
|
||||||
|
|
||||||
|
2. No `setpoint_entity`. [(b)]
|
||||||
|
A controller with no actuator, and nothing about it looks broken.
|
||||||
|
`write_setpoint()` returns immediately on a blank entity, so: no device
|
||||||
|
rating is ever read (the `device` SAFETY claim is never made at all), and
|
||||||
|
the ESP32 heartbeat - the thing that feeds LAYER 1 - never happens. The
|
||||||
|
add-on serves a UI, publishes MQTT, resolves claims, and moves nothing.
|
||||||
|
Layer 1 then holds the inverter at 0 W, which is the failsafe working
|
||||||
|
exactly as designed - this is (b), not (a). Nothing is unsafe; it is simply
|
||||||
|
impossible to tell from the outside that the thing is doing nothing.
|
||||||
|
|
||||||
|
3. A `meter_source` that can never produce a reading. [(b)]
|
||||||
|
§5.1 makes P1 the only authoritative measurement and deliberately provides
|
||||||
|
no fallback, so a transport that cannot be built means `grid` is None
|
||||||
|
forever: permanent "inputs missing", 0 W, and a status page that reports a
|
||||||
|
meter with a climbing age exactly as it would for a healthy meter nobody has
|
||||||
|
sent anything to yet. The predicates live in `p1.validate_meter_options()`,
|
||||||
|
which is also what `build_source()` uses - one definition, two callers.
|
||||||
|
|
||||||
|
4. `meter_max_age_s` above the firmware's own ingest veto. [(a)]
|
||||||
|
The purest example of (a) in the system, and structurally the same fault as
|
||||||
|
1. The add-on's schema accepts `int(5,300)`. The firmware's threshold is a
|
||||||
|
COMPILE-TIME SUBSTITUTION - `max_age_s: "30"` in
|
||||||
|
goodwe-master-stage4-failsafe.yaml - used by both its monotonic receipt
|
||||||
|
clock and its `ingest_stale` veto, which trips layer 1 on
|
||||||
|
`p1_age_s >= 30`. Set 120 and the add-on believes a 119 s reading is fresh
|
||||||
|
and keeps commanding into it, while the firmware vetoed at 30 s and is
|
||||||
|
holding the inverter at 0 W. Status page: healthy meter, running
|
||||||
|
controller, nothing moving, and no line anywhere saying the number you set
|
||||||
|
was overruled. That firmware file's own comment says a lower bound on this
|
||||||
|
"belongs in CFG-01, not here" - so here it is.
|
||||||
|
|
||||||
|
5. `sign_disagree_w` at or above `max_w`. [(a)]
|
||||||
|
The arbiter's `supervised` limit bounds every command to +-max_w, and
|
||||||
|
SAFETY-02's predicate needs `abs(command) > sign_disagree_w`. Set the
|
||||||
|
threshold at or above the ceiling and the command side of the comparison
|
||||||
|
is unsatisfiable BY CONSTRUCTION: the watchdog can never fire, on any
|
||||||
|
input, ever. Same shape as 1 and 4 - the operator set a number, a layer
|
||||||
|
they cannot see makes it mean something else, and nothing says so. Worse
|
||||||
|
here, because what the status page reports in that state is "sign
|
||||||
|
watchdog: armed". A disarmed guard that advertises itself as armed is the
|
||||||
|
one thing this project has decided repeatedly it will not ship.
|
||||||
|
|
||||||
|
WHAT IS DELIBERATELY *NOT* REFUSED, because it is untidy rather than unsafe:
|
||||||
|
|
||||||
|
- `integrator_max_w` above `max_w`. DOCS.md is right that the only thing the
|
||||||
|
extra headroom buys is more wrong-direction power to unwind after
|
||||||
|
saturation - but the arbiter's `supervised` limit still binds the wire to
|
||||||
|
±max_w, so nothing out of range ever reaches the inverter. The cost is
|
||||||
|
latency, not amperage. Warned about, not refused.
|
||||||
|
- A missing `soc_entity` / `batt_entity`. `inputs_ok` goes False, the loop
|
||||||
|
commands 0 W, and `checks()` already renders a red NOT READY banner naming
|
||||||
|
the missing entity. Fail-safe AND already loud; a refusal adds nothing.
|
||||||
|
- A `setpoint_entity` that exists in the config but is not found on the Core
|
||||||
|
API at startup. This is the transient case - ESPHome is frequently not up
|
||||||
|
yet when the add-on boots - and refusing here would turn a device that
|
||||||
|
arrives thirty seconds late into a restart loop needing a human. It stays a
|
||||||
|
NOT READY banner.
|
||||||
|
- `meter_poll_s` above half `meter_max_age_s`. One missed poll costs a stale
|
||||||
|
reading and a 0 W cycle. Warned about in p1.py, not refused.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import logging
|
||||||
|
|
||||||
|
from .p1 import is_enabled, validate_meter_options
|
||||||
|
|
||||||
|
_LOG = logging.getLogger("goodwe.config")
|
||||||
|
|
||||||
|
# ⚠️ A MIRROR OF A FIRMWARE CONSTANT, AND IT CANNOT BE IMPORTED. The firmware
|
||||||
|
# threshold is a compile-time YAML substitution baked into the ESP32 image
|
||||||
|
# (`max_age_s: "30"`, master/goodwe-master-stage4-failsafe.yaml), so nothing at
|
||||||
|
# runtime can ask the board what value it was built with. This number is a copy,
|
||||||
|
# and a copy of a constant in another repo is a thing that goes stale.
|
||||||
|
#
|
||||||
|
# What makes that acceptable here: the copy can only ever be WRONG IN THE SAFE
|
||||||
|
# DIRECTION for the check below. If the firmware's veto is raised above 30, this
|
||||||
|
# refuses some configs that would in fact have worked - annoying, visible
|
||||||
|
# immediately, and fixed by editing one line. It cannot start accepting a config
|
||||||
|
# the firmware vetoes unless the firmware's number goes DOWN, which would be a
|
||||||
|
# tightening nobody does silently.
|
||||||
|
#
|
||||||
|
# ⚠️ TEL-06 IS EDITING `ingest_stale` DIRECTLY. If that ticket changes what the
|
||||||
|
# veto MEANS - e.g. thresholding arrival rather than the sensor's value - this
|
||||||
|
# constant's justification has to be re-read, not just its number. Do not assume
|
||||||
|
# a matching integer means a matching rule.
|
||||||
|
FIRMWARE_INGEST_VETO_S = 30.0
|
||||||
|
|
||||||
|
# ⚠️ The complete set of option keys through which this add-on can reach an
|
||||||
|
# actuator. specs §1.5 makes "any configuration in which two writers can reach
|
||||||
|
# one actuator" a non-goal, and the way that non-goal is ENFORCED here is by
|
||||||
|
# construction: there is exactly one such key, so a second writer is not
|
||||||
|
# expressible in the options schema at all. sim/inject.py's `two_writers`
|
||||||
|
# scenario asserts on this tuple - if a second write path is ever added, that
|
||||||
|
# scenario goes red and somebody has to decide how the two are arbitrated
|
||||||
|
# BEFORE the config that allows both can ship.
|
||||||
|
ACTUATOR_WRITE_KEYS = ("setpoint_entity",)
|
||||||
|
|
||||||
|
|
||||||
|
class ConfigRefused(Exception):
|
||||||
|
"""The configuration is wrong. Not "something broke" - see main.py's handler.
|
||||||
|
|
||||||
|
Carries the list of problems so the caller can render them; str() is the
|
||||||
|
first one, so an unhandled traceback still names something useful.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self, problems: list[str]):
|
||||||
|
self.problems = problems
|
||||||
|
super().__init__(problems[0] if problems else "configuration refused")
|
||||||
|
|
||||||
|
|
||||||
|
def validate_startup_config(opts: dict, dev_min=None, dev_max=None) -> list[str]:
|
||||||
|
"""Return the list of reasons this configuration must not be started.
|
||||||
|
|
||||||
|
Empty list means go. `dev_min`/`dev_max` are the setpoint device's own
|
||||||
|
reported range (`hass.limits()`), or None when the device could not be
|
||||||
|
reached - in which case the range checks are skipped rather than guessed at,
|
||||||
|
for the transient reason in this module's docstring.
|
||||||
|
|
||||||
|
Pure and side-effect free apart from two warnings, so it can be called from
|
||||||
|
a test or from sim/inject.py without a Home Assistant anywhere near it.
|
||||||
|
"""
|
||||||
|
problems: list[str] = []
|
||||||
|
|
||||||
|
# --- 1. an actuator to write to ------------------------------------------
|
||||||
|
writers = [k for k in ACTUATOR_WRITE_KEYS
|
||||||
|
if str(opts.get(k, "") or "").strip()]
|
||||||
|
if not writers:
|
||||||
|
problems.append(
|
||||||
|
"setpoint_entity is not set, so this add-on has no actuator: every "
|
||||||
|
"write is a no-op, the device's own rating is never read, and the "
|
||||||
|
"ESP32 heartbeat that holds off the layer-1 failsafe never happens. "
|
||||||
|
"It would run, look healthy, and move no energy at all. Set it to "
|
||||||
|
"the ESPHome number entity that carries the setpoint.")
|
||||||
|
|
||||||
|
# --- 2. the configured ceiling against the device's own rating -----------
|
||||||
|
max_w = _number(opts, "max_w", 2000.0)
|
||||||
|
if max_w is None:
|
||||||
|
problems.append(f"max_w {opts.get('max_w')!r} is not a number")
|
||||||
|
# ⚠️ config.yaml's int(100,5000) already blocks this on a real install, so
|
||||||
|
# the check is not for the Supervisor path - it is because
|
||||||
|
# validate_startup_config() is now also sim/inject.py's entry point and can
|
||||||
|
# be handed any dict at all. A max_w of 0 or below inverts the arbiter's
|
||||||
|
# `supervised` bounds (lo=-max_w becomes the HIGHER number), and a limit
|
||||||
|
# claim whose lo exceeds its hi is exactly the contradiction the arbiter
|
||||||
|
# resolves to 0 W - i.e. it would look like a safety trip rather than the
|
||||||
|
# nonsense config it is.
|
||||||
|
elif max_w <= 0:
|
||||||
|
problems.append(
|
||||||
|
f"max_w is {max_w:.0f} W and must be positive - it is a magnitude, "
|
||||||
|
"not a signed setpoint. At or below zero the arbiter's supervised "
|
||||||
|
f"limit becomes lo={-max_w:.0f} / hi={max_w:.0f}, which is a "
|
||||||
|
"contradiction it resolves to 0 W, so the controller would look "
|
||||||
|
"like it was tripping rather than misconfigured.")
|
||||||
|
elif dev_max is not None and max_w > dev_max:
|
||||||
|
problems.append(
|
||||||
|
f"max_w is {max_w:.0f} W but {opts.get('setpoint_entity') or 'the setpoint device'} accepts at "
|
||||||
|
f"most {dev_max:.0f} W - THE DEVICE WINS, so the {max_w:.0f} W you "
|
||||||
|
f"configured would silently never happen. Lower max_w to "
|
||||||
|
f"{dev_max:.0f} W or less, or point setpoint_entity at a device that "
|
||||||
|
f"can take {max_w:.0f} W.")
|
||||||
|
elif dev_min is not None and -max_w < dev_min:
|
||||||
|
problems.append(
|
||||||
|
f"max_w is {max_w:.0f} W, so this controller may command "
|
||||||
|
f"{-max_w:.0f} W, but {opts.get('setpoint_entity') or 'the setpoint device'} accepts no less "
|
||||||
|
f"than {dev_min:.0f} W - THE DEVICE WINS on the charge side. Lower "
|
||||||
|
f"max_w to {abs(dev_min):.0f} W or less.")
|
||||||
|
|
||||||
|
# --- 3. a meter that can actually read -----------------------------------
|
||||||
|
# ⚠️ Not a second copy of these rules - p1.py owns them, because
|
||||||
|
# build_source() has to apply the identical predicates and a drifted copy
|
||||||
|
# would be worse than no check.
|
||||||
|
phases = _number(opts, "meter_phases", 1.0)
|
||||||
|
max_age_s = _number(opts, "meter_max_age_s", 30.0)
|
||||||
|
if phases is None or max_age_s is None:
|
||||||
|
problems.append("meter_phases and meter_max_age_s must both be numbers "
|
||||||
|
f"(got {opts.get('meter_phases')!r} / "
|
||||||
|
f"{opts.get('meter_max_age_s')!r})")
|
||||||
|
else:
|
||||||
|
problems.extend(validate_meter_options(opts, int(phases), max_age_s))
|
||||||
|
|
||||||
|
# --- 4. the staleness window the FIRMWARE will actually enforce -----------
|
||||||
|
# ⚠️ Only when P1 ingestion is on, and that is a real scope limit rather than
|
||||||
|
# caution: meter_max_age_s is read by nothing but P1Ingest, and the veto it
|
||||||
|
# collides with keys off `p1_age_s.has_state()`, which is only ever published
|
||||||
|
# when ingestion is running (see Controller.publish()). With meter_source off
|
||||||
|
# there is no sensor, the veto is inert, and the number governs nothing.
|
||||||
|
#
|
||||||
|
# Strictly greater, not >=: the firmware trips at `>= 30` and P1Ingest goes
|
||||||
|
# stale at `> max_age_s`, so 30 against 30 has the firmware fractionally
|
||||||
|
# stricter by one sample. That is the shipped default and the tested pair.
|
||||||
|
# BELOW 30 is fine and deliberately not refused - the add-on then gives up
|
||||||
|
# first, which is fail-safe and visible on its own status page. Only ABOVE is
|
||||||
|
# the silent case, where the add-on keeps commanding into a reading the board
|
||||||
|
# has already rejected.
|
||||||
|
if (is_enabled(opts) and max_age_s is not None
|
||||||
|
and max_age_s > FIRMWARE_INGEST_VETO_S):
|
||||||
|
problems.append(
|
||||||
|
f"meter_max_age_s is {max_age_s:.0f} s but the ESP32 firmware vetoes "
|
||||||
|
f"any P1 sample at {FIRMWARE_INGEST_VETO_S:.0f} s and forces the "
|
||||||
|
"layer-1 failsafe - THE FIRMWARE WINS, and it wins silently. This "
|
||||||
|
f"add-on would treat a {max_age_s - 1:.0f} s reading as fresh and "
|
||||||
|
"keep commanding, while the inverter sat at 0 W with a healthy-"
|
||||||
|
"looking meter on the status page. Lower meter_max_age_s to "
|
||||||
|
f"{FIRMWARE_INGEST_VETO_S:.0f} s or less (30 s is the tested value), "
|
||||||
|
"or rebuild the firmware with a matching max_age_s and update "
|
||||||
|
"validate.FIRMWARE_INGEST_VETO_S.")
|
||||||
|
|
||||||
|
# --- 5. a sign watchdog that can actually fire ---------------------------
|
||||||
|
# ⚠️ Strictly `>=`, matching the predicate exactly: watchdog.py tests
|
||||||
|
# `abs(commanded_w) > min_w`, and the arbiter holds `abs(commanded_w)` at or
|
||||||
|
# below max_w, so threshold == max_w is already unsatisfiable. Anything
|
||||||
|
# BELOW max_w is reachable and therefore fine - this refuses the disarmed
|
||||||
|
# case only, not "close to the rail".
|
||||||
|
sign_w = _number(opts, "sign_disagree_w", 300.0)
|
||||||
|
if sign_w is None:
|
||||||
|
problems.append(f"sign_disagree_w {opts.get('sign_disagree_w')!r} is not a number")
|
||||||
|
elif max_w is not None and max_w > 0 and sign_w >= max_w:
|
||||||
|
problems.append(
|
||||||
|
f"sign_disagree_w is {sign_w:.0f} W but max_w is {max_w:.0f} W, so "
|
||||||
|
"the SAFETY-02 sign-disagreement watchdog can never fire: the "
|
||||||
|
"arbiter never lets a command exceed max_w, and the watchdog needs "
|
||||||
|
f"a command over {sign_w:.0f} W. It would sit there reporting "
|
||||||
|
"'armed' on the status page while being incapable of tripping - the "
|
||||||
|
f"one runaway failure mode this system has actually observed. Lower "
|
||||||
|
f"sign_disagree_w below {max_w:.0f} W (300 W is the measured "
|
||||||
|
"default), or raise max_w.")
|
||||||
|
|
||||||
|
# --- warnings: real, but not worth refusing over -------------------------
|
||||||
|
integ = opts.get("integrator_max_w")
|
||||||
|
integ_w = None if not integ else _number(opts, "integrator_max_w", None)
|
||||||
|
if integ_w is not None and max_w is not None and integ_w > max_w:
|
||||||
|
_LOG.warning(
|
||||||
|
"integrator_max_w %.0f W is above max_w %.0f W. Not refused - the "
|
||||||
|
"arbiter still bounds the wire to +-max_w - but the only thing the "
|
||||||
|
"extra headroom buys is more wrong-direction power to unwind after "
|
||||||
|
"saturation. 0 (follow max_w) is the recommended value.",
|
||||||
|
integ_w, max_w)
|
||||||
|
|
||||||
|
return problems
|
||||||
|
|
||||||
|
|
||||||
|
def _number(opts: dict, key, default):
|
||||||
|
raw = opts.get(key, default)
|
||||||
|
if raw is None or raw == "":
|
||||||
|
return default
|
||||||
|
try:
|
||||||
|
return float(raw)
|
||||||
|
except (TypeError, ValueError):
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def refuse(problems: list[str]) -> None:
|
||||||
|
"""Log a refusal an operator can tell apart from a crash. Does not raise.
|
||||||
|
|
||||||
|
⚠️ THE POINT OF THE BANNER. "You configured this wrong" must not read like
|
||||||
|
"it broke". A Python traceback in an add-on log means the same thing to most
|
||||||
|
operators as a segfault - file a bug - whereas this block names the keys,
|
||||||
|
names the fix, and says in words that nothing is broken. main.py catches
|
||||||
|
ConfigRefused and exits 78 (sysexits EX_CONFIG), so no traceback is printed
|
||||||
|
at all and even the exit status distinguishes the two.
|
||||||
|
"""
|
||||||
|
_LOG.error("=" * 72)
|
||||||
|
_LOG.error("REFUSING TO START: the add-on configuration is not usable.")
|
||||||
|
_LOG.error("This is a CONFIGURATION problem, not a crash. Nothing is broken;")
|
||||||
|
_LOG.error("the add-on will start as soon as the settings below are fixed.")
|
||||||
|
_LOG.error("Fix them in Settings > Add-ons > GoodWe RS485 Controller >")
|
||||||
|
_LOG.error("Configuration, then start the add-on again.")
|
||||||
|
_LOG.error("-" * 72)
|
||||||
|
for i, problem in enumerate(problems, 1):
|
||||||
|
_LOG.error(" %d. %s", i, problem)
|
||||||
|
_LOG.error("=" * 72)
|
||||||
@@ -0,0 +1,220 @@
|
|||||||
|
"""SAFETY-02 - the sign-disagreement watchdog.
|
||||||
|
|
||||||
|
WHAT IT CATCHES, in one sentence: a grid-following loop that is pushing power in
|
||||||
|
the wrong direction, which every other guard in this system is blind to.
|
||||||
|
|
||||||
|
The stale-input watchdog (SAFETY-01) asks "is the meter still talking?". The
|
||||||
|
saturation freeze asks "can the inverter follow?". The output clamp asks "is the
|
||||||
|
number too big?". A loop can pass all three and still be charging the battery
|
||||||
|
out of the grid while the house imports - the meter is fresh, the inverter is
|
||||||
|
tracking beautifully, and the magnitude is inside the rating. The only thing
|
||||||
|
that separates that from healthy operation is the SIGN.
|
||||||
|
|
||||||
|
⚠️ THIS IS NOT A HYPOTHETICAL. On 2026-08-20 the vendor controller (Illusmart)
|
||||||
|
did exactly this four times in one day (NOTES.md §4.7). Both captures of that
|
||||||
|
bus are committed - `sim/scenarios/bus-2026-08-20.log.gz` and the healthy
|
||||||
|
`bus-2026-08-23.log.gz` in the infra repo - and `sim/replay_sign.py` drives this
|
||||||
|
module over both of them. Every number in this file was measured on those two
|
||||||
|
days, not chosen:
|
||||||
|
|
||||||
|
day samples gated in sign agreement
|
||||||
|
2026-08-23 4 127 / 16 349 92.9 % (healthy)
|
||||||
|
2026-08-20 6 892 / 15 598 55.6 % (the whole fault day)
|
||||||
|
episode A 15:26-16:43 0.3 %
|
||||||
|
episode B 17:11-18:28 0.8 %
|
||||||
|
episode C 20:01-20:31 11.0 %
|
||||||
|
episode D 20:55-21:11 0.0 %
|
||||||
|
|
||||||
|
That is the signature, and it is the SAME signature in all four episodes: not a
|
||||||
|
noisier version of healthy, a near-total inversion.
|
||||||
|
|
||||||
|
------------------------------------------------------------------------------
|
||||||
|
WHY IT LIVES HERE AND NOT IN THE FIRMWARE OR THE WITNESS
|
||||||
|
|
||||||
|
Three vantage points see three different things. The firmware knows what it
|
||||||
|
WROTE, the witness Pi knows what was ON THE WIRE and whether the inverter ACKed
|
||||||
|
it, and the add-on knows what it INTENDED and holds the authoritative meter.
|
||||||
|
|
||||||
|
This check is not command-versus-wire; it is command-versus-physics. It needs
|
||||||
|
the emitted setpoint and the P1 net figure in the same place, and it needs the
|
||||||
|
authority to command zero when they fight:
|
||||||
|
|
||||||
|
- the witness is read-only by charter and cannot command anything, so it could
|
||||||
|
raise the alarm but never take the trip action the AC requires;
|
||||||
|
- the firmware has the wire but not the meter. §5.1 makes P1 the only
|
||||||
|
authoritative grid figure and the board only ever receives its AGE
|
||||||
|
(`sensor.goodwe_p1_sample_age`), never its value. Putting the check there
|
||||||
|
would mean shipping the meter to the ESP32 for no other reason, and it would
|
||||||
|
be C++ per install rather than one generic guard;
|
||||||
|
- the add-on has both halves already, plus an arbiter that can outrank every
|
||||||
|
strategy with a P_SAFETY claim.
|
||||||
|
|
||||||
|
The cost of standing here is real and worth stating: this watchdog compares what
|
||||||
|
we MEANT to put on the wire against the meter. If the firmware or the driver
|
||||||
|
inverts the sign on the way out, the add-on's own view still agrees with itself
|
||||||
|
and this check stays silent. That gap is a wire-versus-intent problem and it
|
||||||
|
belongs to the witness, not here.
|
||||||
|
|
||||||
|
------------------------------------------------------------------------------
|
||||||
|
WHAT "DISAGREEMENT" MEANS, PRECISELY
|
||||||
|
|
||||||
|
disagree = following
|
||||||
|
and commanded_w * grid_w < 0
|
||||||
|
and abs(commanded_w) > min_w
|
||||||
|
and abs(grid_w) > min_w
|
||||||
|
|
||||||
|
Four gates, and each one exists to exclude a specific thing that is NOT a fault:
|
||||||
|
|
||||||
|
1. `following`. ⚠️ THE GATE THAT IS EASIEST TO FORGET AND MOST EXPENSIVE TO
|
||||||
|
OMIT. Sign agreement is a property of a GRID-FOLLOWING loop. It is not
|
||||||
|
expected of a strategy that deliberately commands against the meter -
|
||||||
|
maintenance is exactly that. A maintenance grid charge of 2500 W into a house
|
||||||
|
drawing 500 W puts +3000 W on the meter against a -2500 W command: opposed,
|
||||||
|
both far over any sane threshold, and sustained for HOURS. Armed
|
||||||
|
unconditionally this watchdog would trip on every single maintenance cycle,
|
||||||
|
which is not a tuning problem, it is the wrong question being asked. So the
|
||||||
|
caller says whether the grid-following loop actually won the arbitration this
|
||||||
|
cycle, and the timer only accumulates when it did.
|
||||||
|
|
||||||
|
2. The strict `< 0` product. "Opposed" and "neither side is zero" in one
|
||||||
|
expression.
|
||||||
|
|
||||||
|
3. The 300 W magnitude gate ON BOTH SIDES. Near zero the sign is noise, and near
|
||||||
|
zero is where a healthy loop LIVES - the deadband holds the command still
|
||||||
|
while the meter wanders either side of `target_grid_w`. On the healthy day
|
||||||
|
only 4 127 of 16 349 samples (25 %) are even gated in; the other 75 % are the
|
||||||
|
converged band where sign carries no information. This is also why the
|
||||||
|
deadband cannot produce a false trip: inside it the meter is by definition
|
||||||
|
under 300 W.
|
||||||
|
|
||||||
|
4. The 180 s continuity requirement. This is what excludes the legitimate
|
||||||
|
transient. A load step reverses the meter's sign instantly while the command
|
||||||
|
is still where the last cycle left it; slew limiting then needs a few cycles
|
||||||
|
to cross over. Measured on the healthy day, the LONGEST such crossing is 30 s
|
||||||
|
- and that is with a vendor controller far cruder than ours. 180 s is six
|
||||||
|
times that. It is not a fitted threshold: at 60 s the healthy day still
|
||||||
|
produces zero trips, and at 300 s the fault day still produces 13.
|
||||||
|
|
||||||
|
⚠️ A BATTERY THAT REFUSES A COMMAND CANNOT TRIP THIS, and that is structural
|
||||||
|
rather than lucky. At SoC 10 % in Standby, a 1350 W discharge command into a
|
||||||
|
1350 W import is DECLINED: the battery does nothing, so the meter stays at
|
||||||
|
+1350 W and the command stays at +1350 W. Same sign. Agreement. A refusal leaves
|
||||||
|
the meter where it was; only the inverter ACTING moves it, and acting in the
|
||||||
|
commanded direction moves it toward zero, not through it. The failure mode this
|
||||||
|
check keys on is the opposite of a refusal - it is the inverter obediently doing
|
||||||
|
a wrong thing.
|
||||||
|
|
||||||
|
⚠️ A FROZEN METER cannot trip it either, for the same reason read the other way:
|
||||||
|
a stuck reading of +800 W makes the loop command discharge and keep commanding
|
||||||
|
discharge. Command and meter converge on AGREEING. Freezes are SAFETY-12's and
|
||||||
|
SAFETY-01's problem, and this watchdog neither helps nor hinders there.
|
||||||
|
|
||||||
|
------------------------------------------------------------------------------
|
||||||
|
STATE, TRIP AND LATCH
|
||||||
|
|
||||||
|
One timestamp, not a sample counter. The cycle rate is not fixed - a meter
|
||||||
|
arrival, or `cycle_floor_s` elapsing, whichever comes first - so N samples is a
|
||||||
|
different wall-clock window on every path, and the AC is written in minutes.
|
||||||
|
|
||||||
|
The latch is not optional and not a nicety. Commanding 0 W removes the command
|
||||||
|
side of the comparison (|0| is not > 300), so the disagreement disappears the
|
||||||
|
instant the trip works. Un-latched, this watchdog would trip, clear itself, and
|
||||||
|
hand the actuator straight back to the loop that was driving the wrong way -
|
||||||
|
three minutes later, forever. `tripped` therefore stays true until an operator
|
||||||
|
`reset()`s it by starting control again, which is a deliberate human act after
|
||||||
|
looking at why.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from datetime import datetime
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class SignWatchdogConfig:
|
||||||
|
"""Defaults, not constants - config.yaml carries both (SAFETY-02 AC 5)."""
|
||||||
|
|
||||||
|
min_w: float = 300.0
|
||||||
|
hold_s: float = 180.0
|
||||||
|
|
||||||
|
|
||||||
|
class SignWatchdog:
|
||||||
|
"""One instance per actuator, evaluated once per control cycle.
|
||||||
|
|
||||||
|
⚠️ NOT SHARED ACROSS CADENCES. `disagree_since` is a wall-clock start time,
|
||||||
|
so driving one instance from two loops at two rates would have each one
|
||||||
|
resetting the other's window. If a fast on-device path ever wants this
|
||||||
|
check, it gets its own instance - the same exactly-one-writer discipline the
|
||||||
|
arbiter applies to the actuator, applied to the detector's own state.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self, cfg: SignWatchdogConfig | None = None):
|
||||||
|
self.cfg = cfg or SignWatchdogConfig()
|
||||||
|
self.disagree_since: datetime | None = None
|
||||||
|
self.tripped = False
|
||||||
|
self.reason = ""
|
||||||
|
|
||||||
|
# -- the whole check, and it is a pure function of its arguments ----------
|
||||||
|
def evaluate(self, commanded_w, grid_w, following: bool,
|
||||||
|
now: datetime) -> bool:
|
||||||
|
"""Advance the detector one cycle. Returns True while tripped.
|
||||||
|
|
||||||
|
`commanded_w` the EMITTED setpoint - what is standing on the wire now,
|
||||||
|
after deadband, slew, quantisation and the arbiter. Not
|
||||||
|
the optimizer's raw wish: the wire carries the emitted
|
||||||
|
value, so anything else can disagree with the meter for a
|
||||||
|
reason that is not a fault.
|
||||||
|
`grid_w` net P1, + = importing. None when the meter is stale or
|
||||||
|
missing, which CLEARS the timer rather than accumulating
|
||||||
|
- a frozen figure held against a moving command would
|
||||||
|
otherwise manufacture a disagreement in about three
|
||||||
|
minutes, on top of SAFETY-01 having already commanded
|
||||||
|
zero for the same cause.
|
||||||
|
`following` did the grid-following loop actually win this cycle? See
|
||||||
|
gate 1 in the module docstring.
|
||||||
|
`now` the caller's clock, so this stays testable and replayable.
|
||||||
|
"""
|
||||||
|
if self.tripped:
|
||||||
|
# Latched. Do not re-evaluate: the trip removed the evidence.
|
||||||
|
return True
|
||||||
|
|
||||||
|
cfg = self.cfg
|
||||||
|
disagree = (
|
||||||
|
following
|
||||||
|
and commanded_w is not None and grid_w is not None
|
||||||
|
and commanded_w * grid_w < 0
|
||||||
|
and abs(commanded_w) > cfg.min_w
|
||||||
|
and abs(grid_w) > cfg.min_w
|
||||||
|
)
|
||||||
|
|
||||||
|
if not disagree:
|
||||||
|
self.disagree_since = None
|
||||||
|
return False
|
||||||
|
|
||||||
|
if self.disagree_since is None:
|
||||||
|
self.disagree_since = now
|
||||||
|
return False
|
||||||
|
|
||||||
|
held = (now - self.disagree_since).total_seconds()
|
||||||
|
if held < cfg.hold_s:
|
||||||
|
return False
|
||||||
|
|
||||||
|
self.tripped = True
|
||||||
|
self.reason = (
|
||||||
|
f"SIGN_DISAGREEMENT: commanded {commanded_w:+.0f} W against a meter "
|
||||||
|
f"reading {grid_w:+.0f} W for {held:.0f} s continuously "
|
||||||
|
f"(limits: both over {cfg.min_w:.0f} W, held over {cfg.hold_s:.0f} s)"
|
||||||
|
)
|
||||||
|
return True
|
||||||
|
|
||||||
|
@property
|
||||||
|
def held_s(self) -> float:
|
||||||
|
"""How long the current disagreement has been standing, for the UI."""
|
||||||
|
if self.disagree_since is None:
|
||||||
|
return 0.0
|
||||||
|
return (datetime.now(self.disagree_since.tzinfo)
|
||||||
|
- self.disagree_since).total_seconds()
|
||||||
|
|
||||||
|
def reset(self) -> None:
|
||||||
|
self.disagree_since = None
|
||||||
|
self.tripped = False
|
||||||
|
self.reason = ""
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
name: GoodWe RS485 Controller
|
name: GoodWe RS485 Controller
|
||||||
version: "0.2.1"
|
version: "0.5.0"
|
||||||
slug: goodwe_controller
|
slug: goodwe_controller
|
||||||
description: >-
|
description: >-
|
||||||
Drives a GoodWe ES/BP battery inverter over RS485 by emulating its smart
|
Drives a GoodWe ES/BP battery inverter over RS485 by emulating its smart
|
||||||
@@ -42,11 +42,24 @@ options:
|
|||||||
# --- P1 meter ingestion (specs §5.2 / §14 `meter:`) -------------------------
|
# --- P1 meter ingestion (specs §5.2 / §14 `meter:`) -------------------------
|
||||||
# `off` keeps the original single meter_entity path above, so an existing
|
# `off` keeps the original single meter_entity path above, so an existing
|
||||||
# install is untouched until it opts in. ha_dsmr subscribes to the DSMR
|
# install is untouched until it opts in. ha_dsmr subscribes to the DSMR
|
||||||
# integration's entities over the HA WebSocket; mqtt_p1 reads the topic below.
|
# integration's entities over the HA WebSocket; mqtt_p1 reads the topic below;
|
||||||
|
# ha_signed reads ONE signed HA entity (+ import / - export), which is what a
|
||||||
|
# HomeWizard P1 publishes and what ha_dsmr cannot consume.
|
||||||
|
# homewizard_local skips Home Assistant entirely and polls the meter's own
|
||||||
|
# local API. ⚠️ It is the ONLY mode whose sensor.p1_sample_age_s measures when
|
||||||
|
# the meter REPORTED rather than when the value last CHANGED - HA emits
|
||||||
|
# nothing at all for a repeated reading - so it is the only mode a firmware
|
||||||
|
# watchdog may threshold. See DOCS.md.
|
||||||
meter_source: "off"
|
meter_source: "off"
|
||||||
meter_phases: 1
|
meter_phases: 1
|
||||||
meter_max_age_s: 30
|
meter_max_age_s: 30
|
||||||
meter_mqtt_topic: ""
|
meter_mqtt_topic: ""
|
||||||
|
# homewizard_local only. The meter's own address, `host` or `host:port`.
|
||||||
|
p1_host: ""
|
||||||
|
# homewizard_local only. Seconds between polls. Must be well under
|
||||||
|
# meter_max_age_s - the age is never fresher than this interval - and there is
|
||||||
|
# nothing to gain below the meter's own ~5.0 s update rate (NOTES.md:640).
|
||||||
|
meter_poll_s: 5
|
||||||
# The two UNSIGNED Belgian registers. The EMS derives net power from them
|
# The two UNSIGNED Belgian registers. The EMS derives net power from them
|
||||||
# (import - export); do NOT point these at a signed template sensor.
|
# (import - export); do NOT point these at a signed template sensor.
|
||||||
p1_import_entity: ""
|
p1_import_entity: ""
|
||||||
@@ -55,6 +68,15 @@ options:
|
|||||||
# three-phase connection; the list length must equal meter_phases.
|
# three-phase connection; the list length must equal meter_phases.
|
||||||
p1_phase_import_entities: []
|
p1_phase_import_entities: []
|
||||||
p1_phase_export_entities: []
|
p1_phase_export_entities: []
|
||||||
|
# ha_signed only. ONE signed net-power sensor: positive = import from the
|
||||||
|
# grid, negative = export to it. Do NOT split it into two template sensors -
|
||||||
|
# the split is done in the add-on (p1.split_signed) precisely so the sign
|
||||||
|
# convention is tested rather than living in unreviewed YAML.
|
||||||
|
p1_net_entity: ""
|
||||||
|
# Optional, in L1..L3 order, each one signed the same way. Same role as
|
||||||
|
# p1_phase_import_entities: the capacity-tariff peak on a three-phase
|
||||||
|
# connection. The list length must equal meter_phases.
|
||||||
|
p1_phase_net_entities: []
|
||||||
|
|
||||||
# --- control ---------------------------------------------------------------
|
# --- control ---------------------------------------------------------------
|
||||||
max_w: 2000
|
max_w: 2000
|
||||||
@@ -68,8 +90,30 @@ options:
|
|||||||
integrator_max_w: 0
|
integrator_max_w: 0
|
||||||
heartbeat_s: 10
|
heartbeat_s: 10
|
||||||
stale_input_s: 15
|
stale_input_s: 15
|
||||||
|
cycle_floor_s: 15
|
||||||
auto_start: false
|
auto_start: false
|
||||||
|
|
||||||
|
# --- SAFETY-02 sign-disagreement watchdog ----------------------------------
|
||||||
|
# Trips when the emitted setpoint and the P1 net figure point OPPOSITE ways,
|
||||||
|
# both over sign_disagree_w, continuously for sign_disagree_s. Action: 0 W and
|
||||||
|
# a failsafe that latches until an operator starts control again.
|
||||||
|
#
|
||||||
|
# Both defaults are measured, not chosen. On the captured healthy day
|
||||||
|
# (2026-08-23) the longest legitimate opposed run - a load step the loop has
|
||||||
|
# not caught up with - is 30 s, and sign agreement over the gated samples is
|
||||||
|
# 92.9 %. On the captured fault day (2026-08-20) the four episodes run 0.0-11 %
|
||||||
|
# agreement with opposed runs up to 1752 s. 300 W / 180 s sits in the middle of
|
||||||
|
# a very wide gap: at 60 s the healthy day still trips nothing, at 300 s the
|
||||||
|
# fault day still trips 13 times. There is no reason to move either number
|
||||||
|
# without a capture that says so. They are options because the AC says
|
||||||
|
# thresholds are defaults rather than constants - not because they are knobs
|
||||||
|
# anyone is expected to turn.
|
||||||
|
#
|
||||||
|
# ⚠️ sign_disagree_w must stay BELOW max_w or the watchdog can never fire (the
|
||||||
|
# arbiter bounds the command to +-max_w). validate.py refuses that config.
|
||||||
|
sign_disagree_w: 300
|
||||||
|
sign_disagree_s: 180
|
||||||
|
|
||||||
# --- maintenance -----------------------------------------------------------
|
# --- maintenance -----------------------------------------------------------
|
||||||
maintenance_enabled: false
|
maintenance_enabled: false
|
||||||
maintenance_interval_days: 28
|
maintenance_interval_days: 28
|
||||||
@@ -98,20 +142,25 @@ schema:
|
|||||||
batt_invert: bool
|
batt_invert: bool
|
||||||
setpoint_entity: str
|
setpoint_entity: str
|
||||||
|
|
||||||
meter_source: list(off|ha_dsmr|mqtt_p1)
|
meter_source: list(off|ha_dsmr|mqtt_p1|ha_signed|homewizard_local)
|
||||||
# ⚠️ 2 is accepted by this range but is not a real Belgian connection. A
|
# ⚠️ 2 is accepted by this range but is not a real Belgian connection. A
|
||||||
# telegram whose phase count disagrees is rejected at ingest and logged, so a
|
# telegram whose phase count disagrees is rejected at ingest and logged, so a
|
||||||
# mis-set 2 shows up immediately as "0 telegrams accepted" rather than as a
|
# mis-set 2 shows up immediately as "0 telegrams accepted" rather than as a
|
||||||
# quietly wrong number.
|
# quietly wrong number.
|
||||||
meter_phases: int(1,3)
|
meter_phases: int(1,3)
|
||||||
meter_max_age_s: int(5,300)
|
meter_max_age_s: int(5,300)
|
||||||
|
meter_poll_s: int(1,60)
|
||||||
meter_mqtt_topic: str?
|
meter_mqtt_topic: str?
|
||||||
|
p1_host: str?
|
||||||
p1_import_entity: str?
|
p1_import_entity: str?
|
||||||
p1_export_entity: str?
|
p1_export_entity: str?
|
||||||
p1_phase_import_entities:
|
p1_phase_import_entities:
|
||||||
- str
|
- str
|
||||||
p1_phase_export_entities:
|
p1_phase_export_entities:
|
||||||
- str
|
- str
|
||||||
|
p1_net_entity: str?
|
||||||
|
p1_phase_net_entities:
|
||||||
|
- str
|
||||||
|
|
||||||
max_w: int(100,5000)
|
max_w: int(100,5000)
|
||||||
gain: float(0.05,1.0)
|
gain: float(0.05,1.0)
|
||||||
@@ -124,8 +173,14 @@ schema:
|
|||||||
integrator_max_w: int(0,15000)
|
integrator_max_w: int(0,15000)
|
||||||
heartbeat_s: int(2,25)
|
heartbeat_s: int(2,25)
|
||||||
stale_input_s: int(5,120)
|
stale_input_s: int(5,120)
|
||||||
|
cycle_floor_s: int(5,60)
|
||||||
auto_start: bool
|
auto_start: bool
|
||||||
|
|
||||||
|
# No "off" value, deliberately: this is a P0 safety check and the schema is
|
||||||
|
# not the place to make disarming it a supported configuration.
|
||||||
|
sign_disagree_w: int(50,5000)
|
||||||
|
sign_disagree_s: int(30,1800)
|
||||||
|
|
||||||
maintenance_enabled: bool
|
maintenance_enabled: bool
|
||||||
maintenance_interval_days: int(1,90)
|
maintenance_interval_days: int(1,90)
|
||||||
maintenance_start_hour: int(0,23)
|
maintenance_start_hour: int(0,23)
|
||||||
|
|||||||
@@ -24,6 +24,63 @@ def check(name, cond):
|
|||||||
fails.append(name)
|
fails.append(name)
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# COVERAGE AUDIT - measured, not executed. Read this before adding a mechanism.
|
||||||
|
#
|
||||||
|
# THE INVARIANT: every mechanism in compute() must be noticed by AT LEAST TWO
|
||||||
|
# checks when it is deleted. If you add a mechanism to compute(), re-run the
|
||||||
|
# audit and add it to the table. If a figure here drops, a check has started
|
||||||
|
# passing for a reason other than the one it names.
|
||||||
|
#
|
||||||
|
# THE TECHNIQUE, because there is no script to run: replace one mechanism in
|
||||||
|
# control.py with a no-op, run this file, count the failures, restore. That is
|
||||||
|
# the converse of the usual mutation - not "does a wrong value fail?" but "does
|
||||||
|
# anyone notice when the mechanism is GONE?". It is kept as a comment rather
|
||||||
|
# than as tooling on purpose: the only cheap way to automate it is to key on
|
||||||
|
# source lines, which goes stale silently, and a green audit that has quietly
|
||||||
|
# stopped testing anything is precisely the failure this ticket exists to fix.
|
||||||
|
# A comment cannot go stale-green, because it never claims to be running.
|
||||||
|
#
|
||||||
|
# Measured at 389d9ec. Numbers are the lead's independent reproduction.
|
||||||
|
#
|
||||||
|
# mechanism in compute() checks that fail when deleted
|
||||||
|
# ------------------------------------------ -----------------------------
|
||||||
|
# integrator freeze (AC 3) 2
|
||||||
|
# integrator clamp (AC 1) 6
|
||||||
|
# integrator bound follows max_w 4
|
||||||
|
# output clamp 3
|
||||||
|
# slew limit 4
|
||||||
|
# output freeze 2
|
||||||
|
# deadband 5
|
||||||
|
# quantisation 2
|
||||||
|
# saturation detector, `saturated_now = False` 11
|
||||||
|
# saturation duration (AC 2), fires instantly 2
|
||||||
|
# sat counter reset on a good cycle 6
|
||||||
|
# target_grid_w bias 3
|
||||||
|
# i_w=None seeding from prev_w 6
|
||||||
|
#
|
||||||
|
# The detector figure is for the `saturated_now = False` form specifically;
|
||||||
|
# disabling it further down as `frozen = False` is a weaker mutation and gives
|
||||||
|
# 10. Reproduce the same form or the number will not match.
|
||||||
|
#
|
||||||
|
# ⚠️ IT HAS FOUND A DEAD MECHANISM TWICE, BOTH THE SAME WAY: a clamp standing in
|
||||||
|
# for the mechanism under test. Deleting the integrator freeze once failed
|
||||||
|
# NOTHING, because the fixtures sat at max_w 2000 and the integrator bound
|
||||||
|
# truncated a wound value back to exactly 2000 - the assertion passed on the
|
||||||
|
# clamp. The output clamp was masked the same way by the integrator bound.
|
||||||
|
# Hence: A FIXTURE MUST SIT CLEAR OF EVERY RAIL IT IS NOT TESTING. Where a test
|
||||||
|
# names one mechanism, make that mechanism the binding one (see TCLAMP and TF).
|
||||||
|
#
|
||||||
|
# ⚠️ RUN MUTATIONS WITH `python -B` AND CLEAR app/__pycache__. CPython
|
||||||
|
# invalidates a .pyc on (source mtime in whole seconds, source size), so a
|
||||||
|
# same-second rewrite that also preserves the file size reuses stale bytecode
|
||||||
|
# and the suite reports on code you are no longer running. It under-reported one
|
||||||
|
# mutation here as 2 where the true figure is 6. The error is one-directional -
|
||||||
|
# stale bytecode can only under-report - so every figure above is a lower bound
|
||||||
|
# at worst, and the two zeros ever recorded were both confirmed by fixing them
|
||||||
|
# and watching the count rise, which a caching artefact cannot do.
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
print("control law")
|
print("control law")
|
||||||
|
|
||||||
# Deadband: inside meter noise, hold exactly - do not drift.
|
# Deadband: inside meter noise, hold exactly - do not drift.
|
||||||
@@ -41,13 +98,22 @@ check("proportional step (gain 0.6)", d.target_w == 300)
|
|||||||
d = compute(prev_w=0, grid_w=-500, actual_w=0, tuning=T)
|
d = compute(prev_w=0, grid_w=-500, actual_w=0, tuning=T)
|
||||||
check("export drives charging", d.target_w == -300)
|
check("export drives charging", d.target_w == -300)
|
||||||
|
|
||||||
# Clamp
|
# Clamp.
|
||||||
d = compute(prev_w=1900, grid_w=1000, actual_w=1900, tuning=Tuning(max_w=2000, slew_w=5000))
|
# ⚠️ integrator_max_w is lifted clear of max_w so that the OUTPUT clamp is the
|
||||||
|
# mechanism under test. Left at the default the integrator bound truncates
|
||||||
|
# first, these two assertions pass on that alone, and deleting the output clamp
|
||||||
|
# fails nothing - the same masking that hid the integrator freeze.
|
||||||
|
TCLAMP = Tuning(max_w=2000, slew_w=5000, integrator_max_w=5000)
|
||||||
|
d = compute(prev_w=1900, grid_w=1000, actual_w=1900, tuning=TCLAMP)
|
||||||
check("clamped to max_w", d.target_w == 2000)
|
check("clamped to max_w", d.target_w == 2000)
|
||||||
|
|
||||||
# Slew: from 0 with a huge error, no more than slew_w in one cycle.
|
# Slew: from 0 with a huge error, no more than slew_w in one cycle.
|
||||||
d = compute(prev_w=0, grid_w=5000, actual_w=0, tuning=Tuning(max_w=5000, slew_w=1000))
|
d = compute(prev_w=0, grid_w=5000, actual_w=0, tuning=Tuning(max_w=5000, slew_w=1000))
|
||||||
check("slew limits one cycle", d.target_w == 1000)
|
check("slew limits one cycle", d.target_w == 1000)
|
||||||
|
d = compute(prev_w=-1900, grid_w=-1000, actual_w=-1900, tuning=TCLAMP)
|
||||||
|
check("clamped to -max_w", d.target_w == -2000)
|
||||||
|
d = compute(prev_w=0, grid_w=-5000, actual_w=0, tuning=Tuning(max_w=5000, slew_w=1000))
|
||||||
|
check("slew limits one cycle, charging", d.target_w == -1000)
|
||||||
|
|
||||||
# Saturation needs DURATION: one diverging cycle must NOT freeze.
|
# Saturation needs DURATION: one diverging cycle must NOT freeze.
|
||||||
t = Tuning(saturation_w=500, saturation_cycles=3)
|
t = Tuning(saturation_w=500, saturation_cycles=3)
|
||||||
@@ -86,12 +152,12 @@ RUNAWAY_CYCLES = 150
|
|||||||
HISTORICAL_W = 14768.0
|
HISTORICAL_W = 14768.0
|
||||||
|
|
||||||
|
|
||||||
def runaway(tuning):
|
def runaway(tuning, sign=1):
|
||||||
"""Inverter off: it reports 0 W forever, the error never clears."""
|
"""Inverter off: it reports 0 W forever, the error never clears."""
|
||||||
prev, i_w, sat = 0.0, 0.0, 0
|
prev, i_w, sat = 0.0, 0.0, 0
|
||||||
worst_i, worst_cmd = 0.0, 0.0
|
worst_i, worst_cmd = 0.0, 0.0
|
||||||
for _ in range(RUNAWAY_CYCLES):
|
for _ in range(RUNAWAY_CYCLES):
|
||||||
d = compute(prev_w=prev, grid_w=RUNAWAY_ERROR, actual_w=0.0,
|
d = compute(prev_w=prev, grid_w=sign * RUNAWAY_ERROR, actual_w=0.0,
|
||||||
tuning=tuning, sat_count=sat, i_w=i_w)
|
tuning=tuning, sat_count=sat, i_w=i_w)
|
||||||
prev, i_w, sat = d.target_w, d.i_w, d.sat_count
|
prev, i_w, sat = d.target_w, d.i_w, d.sat_count
|
||||||
worst_i = max(worst_i, abs(i_w))
|
worst_i = max(worst_i, abs(i_w))
|
||||||
@@ -113,6 +179,12 @@ check(f"runaway with the detector defeated: integrator still bounded ({wi:.0f} W
|
|||||||
wi <= TD.max_w)
|
wi <= TD.max_w)
|
||||||
check("runaway with the detector defeated: command still <= max_w", wc <= TD.max_w)
|
check("runaway with the detector defeated: command still <= max_w", wc <= TD.max_w)
|
||||||
|
|
||||||
|
# The mirror: the same runaway driving the other way. An export that never
|
||||||
|
# clears winds the integrator negative just as hard.
|
||||||
|
wi, wc = runaway(Tuning(max_w=2000), sign=-1)
|
||||||
|
check(f"runaway (export direction): integrator bounded at {wi:.0f} W", wi <= 2000)
|
||||||
|
check("runaway (export direction): emitted command <= max_w", wc <= 2000)
|
||||||
|
|
||||||
# The bound is a separate quantity, and the useful direction is BELOW max_w:
|
# The bound is a separate quantity, and the useful direction is BELOW max_w:
|
||||||
# there it binds first and caps unwind latency tighter than the rail does.
|
# there it binds first and caps unwind latency tighter than the rail does.
|
||||||
d = compute(prev_w=0, grid_w=6000, actual_w=0,
|
d = compute(prev_w=0, grid_w=6000, actual_w=0,
|
||||||
@@ -121,11 +193,22 @@ check("integrator bound binds independently of the output clamp",
|
|||||||
d.i_w == 1000 and d.target_w == 1000)
|
d.i_w == 1000 and d.target_w == 1000)
|
||||||
|
|
||||||
# Freeze = may not wind further in the direction it is already pushing.
|
# Freeze = may not wind further in the direction it is already pushing.
|
||||||
TF = Tuning(saturation_w=500, saturation_cycles=3)
|
# ⚠️ max_w is raised WELL above the fixtures on purpose. At the default 2000
|
||||||
|
# the integrator bound truncates a wound value back to exactly 2000 and
|
||||||
|
# satisfies these assertions on its own, so deleting the freeze outright
|
||||||
|
# failed nothing - the clamp was standing in for the mechanism under test.
|
||||||
|
# Any fixture here must sit clear of every rail, or it tests the rail.
|
||||||
|
TF = Tuning(saturation_w=500, saturation_cycles=3, max_w=5000)
|
||||||
f1 = compute(prev_w=2000, grid_w=800, actual_w=0, tuning=TF, sat_count=3, i_w=2000.0)
|
f1 = compute(prev_w=2000, grid_w=800, actual_w=0, tuning=TF, sat_count=3, i_w=2000.0)
|
||||||
check("frozen: integration does not wind further", f1.i_w == 2000.0 and f1.frozen)
|
check("frozen: integration does not wind further", f1.i_w == 2000.0 and f1.frozen)
|
||||||
f2 = compute(prev_w=2000, grid_w=-800, actual_w=0, tuning=TF, sat_count=3, i_w=2000.0)
|
f2 = compute(prev_w=2000, grid_w=-800, actual_w=0, tuning=TF, sat_count=3, i_w=2000.0)
|
||||||
check("frozen: unwinding is still allowed", f2.i_w < 2000.0)
|
check("frozen: unwinding is still allowed", f2.i_w < 2000.0)
|
||||||
|
# ...and the same two on the charging side. Every freeze rule in this file has
|
||||||
|
# a mirror, because the one that did not is the defect that got through review.
|
||||||
|
f3 = compute(prev_w=-2000, grid_w=-800, actual_w=0, tuning=TF, sat_count=3, i_w=-2000.0)
|
||||||
|
check("frozen (charging): integration does not wind further", f3.i_w == -2000.0)
|
||||||
|
f4 = compute(prev_w=-2000, grid_w=800, actual_w=0, tuning=TF, sat_count=3, i_w=-2000.0)
|
||||||
|
check("frozen (charging): unwinding is still allowed", f4.i_w > -2000.0)
|
||||||
|
|
||||||
# ⚠️ REGRESSION, and the reason the first cut of SAFETY-04 was rejected. A
|
# ⚠️ REGRESSION, and the reason the first cut of SAFETY-04 was rejected. A
|
||||||
# freeze encoded as "only corrections that shrink |i_w|" is unsatisfiable for
|
# freeze encoded as "only corrections that shrink |i_w|" is unsatisfiable for
|
||||||
@@ -145,6 +228,50 @@ check("frozen at i_w=0: the freeze then clears", not z2.frozen)
|
|||||||
z3 = compute(prev_w=100, grid_w=-1000, actual_w=800, tuning=T, sat_count=3, i_w=100.0)
|
z3 = compute(prev_w=100, grid_w=-1000, actual_w=800, tuning=T, sat_count=3, i_w=100.0)
|
||||||
check("frozen at i_w=+100: a 1 kW export still moves the command",
|
check("frozen at i_w=+100: a 1 kW export still moves the command",
|
||||||
z3.frozen and z3.target_w < 0)
|
z3.frozen and z3.target_w < 0)
|
||||||
|
z4 = compute(prev_w=-100, grid_w=1000, actual_w=-800, tuning=T, sat_count=3, i_w=-100.0)
|
||||||
|
check("frozen at i_w=-100: a 1 kW import still moves the command",
|
||||||
|
z4.frozen and z4.target_w > 0)
|
||||||
|
|
||||||
|
# ⚠️ EXACTLY ZERO, BOTH DIRECTIONS. This boundary has a history: the first cut
|
||||||
|
# deadlocked here under import, and the fix for it deadlocked here under export
|
||||||
|
# because `if i_w > 0 ... else ...` files 0.0 under rising-only. main.py resets
|
||||||
|
# i_w to exactly 0.0 on every stop and every reseed, so it is a normal state,
|
||||||
|
# not a corner.
|
||||||
|
zi = compute(prev_w=0, grid_w=2000, actual_w=600, tuning=T, sat_count=3, i_w=0.0)
|
||||||
|
check("frozen at i_w=0.0: an import push moves the integrator",
|
||||||
|
zi.frozen and zi.i_w > 0)
|
||||||
|
ze = compute(prev_w=0, grid_w=-2000, actual_w=-600, tuning=T, sat_count=3, i_w=0.0)
|
||||||
|
check("frozen at i_w=0.0: an export push moves the integrator",
|
||||||
|
ze.frozen and ze.i_w < 0)
|
||||||
|
# The COMMAND still holds at 0 W in that second case, and that is release/1.0's
|
||||||
|
# rule, not a leftover: at prev_w == 0 the output freeze forbids starting to
|
||||||
|
# charge while saturated, because commanding 0 while the inverter reports
|
||||||
|
# hundreds of watts means something else is driving the bus. Asserted so that
|
||||||
|
# nobody "fixes" it by accident - the integrator moving is what this ticket
|
||||||
|
# owns, the command rule belongs to the output freeze.
|
||||||
|
check("frozen at i_w=0.0: the output freeze still blocks a charge from 0 W",
|
||||||
|
ze.target_w == 0.0)
|
||||||
|
# Where prev_w is already charging the output freeze does NOT block, and there
|
||||||
|
# the difference reaches the wire: held at 0.0 the integrator abandons the
|
||||||
|
# charge mid-export.
|
||||||
|
zc = compute(prev_w=-2000, grid_w=-4000, actual_w=-600, tuning=T, sat_count=3, i_w=0.0)
|
||||||
|
check("frozen at i_w=0.0: a charge is not abandoned during heavy export",
|
||||||
|
zc.target_w == -2000.0)
|
||||||
|
|
||||||
|
# The general property, rather than another handful of points: while frozen the
|
||||||
|
# integrator may be held ONLY when the correction would push it further from
|
||||||
|
# zero on the side it already sits. Any other hold is a deadlock.
|
||||||
|
stuck = []
|
||||||
|
for i0 in [x * 25.0 for x in range(-80, 81)]:
|
||||||
|
for g in [x * 100.0 for x in range(-40, 41)]:
|
||||||
|
err = g - T.target_grid_w
|
||||||
|
if abs(err) < T.deadband_w:
|
||||||
|
continue
|
||||||
|
dd = compute(prev_w=0.0, grid_w=g, actual_w=1500.0, tuning=T, sat_count=3, i_w=i0)
|
||||||
|
if dd.i_w == i0 and not ((i0 > 0 and err > 0) or (i0 < 0 and err < 0)):
|
||||||
|
stuck.append((i0, g))
|
||||||
|
check(f"frozen integrator never deadlocks, over {161*81} states"
|
||||||
|
+ (f" (e.g. {stuck[0]})" if stuck else ""), not stuck)
|
||||||
|
|
||||||
# False-positive guard: a normal 2 kW load step must not trip the detector,
|
# False-positive guard: a normal 2 kW load step must not trip the detector,
|
||||||
# because the plant needs several cycles to catch up on every one of them.
|
# because the plant needs several cycles to catch up on every one of them.
|
||||||
@@ -196,34 +323,67 @@ print("SAFETY-04: the i_w=None path is still release/1.0, exactly")
|
|||||||
|
|
||||||
def legacy(prev, grid, actual, t, sat_count):
|
def legacy(prev, grid, actual, t, sat_count):
|
||||||
"""release/1.0's control law, transcribed. Do not 'improve' this."""
|
"""release/1.0's control law, transcribed. Do not 'improve' this."""
|
||||||
|
reason = "tracking"
|
||||||
sc = min(sat_count + 1, 10) if abs(prev - actual) > t.saturation_w else 0
|
sc = min(sat_count + 1, 10) if abs(prev - actual) > t.saturation_w else 0
|
||||||
frozen = sc >= t.saturation_cycles
|
frozen = sc >= t.saturation_cycles
|
||||||
error = grid - t.target_grid_w
|
error = grid - t.target_grid_w
|
||||||
want = prev if abs(error) < t.deadband_w else prev + t.gain * error
|
if abs(error) < t.deadband_w:
|
||||||
|
want, reason = prev, "deadband"
|
||||||
|
else:
|
||||||
|
want = prev + t.gain * error
|
||||||
target = max(-t.max_w, min(t.max_w, want))
|
target = max(-t.max_w, min(t.max_w, want))
|
||||||
target = max(prev - t.slew_w, min(prev + t.slew_w, target))
|
if target != want:
|
||||||
|
reason = "clamped"
|
||||||
|
slewed = max(prev - t.slew_w, min(prev + t.slew_w, target))
|
||||||
|
if slewed != target:
|
||||||
|
reason = "slew-limited"
|
||||||
|
target = slewed
|
||||||
if frozen:
|
if frozen:
|
||||||
target = min(target, prev) if prev > 0 else max(target, prev)
|
target = min(target, prev) if prev > 0 else max(target, prev)
|
||||||
|
reason = "saturated-freeze"
|
||||||
step = max(1, int(t.step_w))
|
step = max(1, int(t.step_w))
|
||||||
return float(round(target / step) * step), sc
|
return float(round(target / step) * step), sc, frozen, reason
|
||||||
|
|
||||||
|
|
||||||
# Exhaustive over the interesting corners, both freeze states, both signs, and
|
# ⚠️ Compare EVERYTHING observable, not just the number. A previous version of
|
||||||
# either side of the deadband. This is what makes the claim in control.py's
|
# this sweep compared (target_w, sat_count) only and passed 3024 cases while
|
||||||
# integrator comment a checked fact rather than an assertion.
|
# `reason` had silently lost a value - which is the kind of thing a sweep this
|
||||||
|
# broad exists to catch. `frozen` and `reason` are both in the tuple now.
|
||||||
|
#
|
||||||
|
# The one deliberate rename: what release/1.0 called "clamped" is now
|
||||||
|
# "i-clamped", because the truncation happens on the integrator before the
|
||||||
|
# command is derived from it. Aliased here rather than papered over - if any
|
||||||
|
# OTHER reason ever diverges, this check goes red.
|
||||||
|
ALIAS = {"i-clamped": "clamped"}
|
||||||
diffs = []
|
diffs = []
|
||||||
|
seen = set()
|
||||||
for tune in (Tuning(), Tuning(target_grid_w=-10.0), Tuning(max_w=5000, slew_w=5000)):
|
for tune in (Tuning(), Tuning(target_grid_w=-10.0), Tuning(max_w=5000, slew_w=5000)):
|
||||||
for prev in (-2000.0, -500.0, -100.0, 0.0, 100.0, 500.0, 2000.0):
|
for prev in (-2000.0, -500.0, -100.0, 0.0, 100.0, 500.0, 2000.0):
|
||||||
for grid in (-6000.0, -1000.0, -500.0, -14.0, 0.0, 14.0, 500.0, 1000.0, 6000.0):
|
for grid in (-6000.0, -1000.0, -500.0, -14.0, 0.0, 14.0, 500.0, 1000.0, 6000.0):
|
||||||
for actual in (-2000.0, 0.0, 600.0, 2000.0):
|
for actual in (-2000.0, 0.0, 600.0, 2000.0):
|
||||||
for sc in (0, 2, 3, 9):
|
for sc in (0, 2, 3, 9):
|
||||||
d = compute(prev, grid, actual, tune, sc) # i_w defaults to None
|
d = compute(prev, grid, actual, tune, sc) # i_w defaults to None
|
||||||
lt, lsc = legacy(prev, grid, actual, tune, sc)
|
seen.add(d.reason)
|
||||||
if (d.target_w, d.sat_count) != (lt, lsc):
|
got = (d.target_w, d.sat_count, d.frozen,
|
||||||
diffs.append((prev, grid, actual, sc, d.target_w, lt))
|
ALIAS.get(d.reason, d.reason))
|
||||||
check(f"i_w=None reproduces release/1.0 over {3*7*9*4*4} cases"
|
if got != legacy(prev, grid, actual, tune, sc):
|
||||||
|
diffs.append((prev, grid, actual, sc, got,
|
||||||
|
legacy(prev, grid, actual, tune, sc)))
|
||||||
|
check(f"i_w=None reproduces release/1.0 over {3*7*9*4*4} cases, reason included"
|
||||||
+ (f" (first diff {diffs[0]})" if diffs else ""), not diffs)
|
+ (f" (first diff {diffs[0]})" if diffs else ""), not diffs)
|
||||||
|
|
||||||
|
# ...and the rename is not a quiet deletion: the signal SAFETY-03 alarms on has
|
||||||
|
# to actually occur in that sweep, or its hook is dead.
|
||||||
|
check("the integrator clamp reports itself as 'i-clamped'", "i-clamped" in seen)
|
||||||
|
|
||||||
|
# "clamped" stays reachable, but only where the integrator is deliberately
|
||||||
|
# allowed above the rail - then BOTH fire and the output clamp, which describes
|
||||||
|
# the value actually emitted, is the one reported.
|
||||||
|
dc = compute(prev_w=0, grid_w=6000, actual_w=0,
|
||||||
|
tuning=Tuning(max_w=2000, integrator_max_w=3000, slew_w=5000))
|
||||||
|
check("the output clamp still reports 'clamped' when it is the binding one",
|
||||||
|
dc.reason == "clamped" and dc.i_w == 3000 and dc.target_w == 2000)
|
||||||
|
|
||||||
print("capacity tariff")
|
print("capacity tariff")
|
||||||
check("no forecast means no cap", maintenance_charge_floor(2500, None, 3500) == 2500)
|
check("no forecast means no cap", maintenance_charge_floor(2500, None, 3500) == 2500)
|
||||||
check("headroom caps the charge", maintenance_charge_floor(2500, 2000, 3500) == 1500)
|
check("headroom caps the charge", maintenance_charge_floor(2500, 2000, 3500) == 1500)
|
||||||
|
|||||||
@@ -0,0 +1,213 @@
|
|||||||
|
"""Runnable check for the control loop's cadence. `python3 test_loop.py`
|
||||||
|
|
||||||
|
SAFETY-12: the loop must evaluate on a clock as well as on a change. Before the
|
||||||
|
fix, `run_control()` ran `cycle()` only when the meter value differed from the
|
||||||
|
previous poll, so a meter that repeats a value ran NO control cycles while the
|
||||||
|
heartbeat kept re-emitting the last command - measured on the rig during TEL-05
|
||||||
|
as 70 s at a literally constant 350.0 W with 14 arrivals and zero cycles.
|
||||||
|
|
||||||
|
⚠️ THIS TEST TAKES ~95 SECONDS OF WALL CLOCK (measured 93 s), on purpose, and
|
||||||
|
that figure is the only thing standing between it and a future developer who
|
||||||
|
decides a slow test is a broken one. The thing under test is a wall-clock floor
|
||||||
|
inside a loop that sleeps 1 s; mocking the clock would leave the assertion
|
||||||
|
testing the mock. It drives the real `run_control()` and counts what actually
|
||||||
|
happened. Eight runs of the real loop is what the eight scenarios cost.
|
||||||
|
|
||||||
|
⚠️ If you shorten the windows, re-measure and update this number and the one in
|
||||||
|
HANDOVER.md. An understated runtime reads as a hang.
|
||||||
|
|
||||||
|
`cycle_floor_s` is read from options with no lower bound in code, so a huge
|
||||||
|
value reproduces the pre-fix behaviour exactly. Every claim below is therefore
|
||||||
|
an A/B on one binary, not a comparison against a remembered old one.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import asyncio
|
||||||
|
import sys
|
||||||
|
import time
|
||||||
|
|
||||||
|
from app.main import Controller
|
||||||
|
|
||||||
|
fails = []
|
||||||
|
NEVER = 1e9 # cycle_floor_s so large the floor can never elapse: pre-fix
|
||||||
|
|
||||||
|
|
||||||
|
def check(name, cond):
|
||||||
|
print(f" {'ok ' if cond else 'FAIL'} {name}")
|
||||||
|
if not cond:
|
||||||
|
fails.append(name)
|
||||||
|
|
||||||
|
|
||||||
|
class FakeHass:
|
||||||
|
"""A scripted meter and a plant that tracks the command instantly."""
|
||||||
|
|
||||||
|
def __init__(self, meter, soc_dies_at=None):
|
||||||
|
self.meter = meter
|
||||||
|
self.soc_dies_at = soc_dies_at
|
||||||
|
self.batt = 0.0
|
||||||
|
self.writes = []
|
||||||
|
self.t0 = time.monotonic()
|
||||||
|
|
||||||
|
async def limits(self, entity):
|
||||||
|
return (-5000.0, 5000.0, 1.0)
|
||||||
|
|
||||||
|
async def number(self, entity, invert=False):
|
||||||
|
now = time.monotonic() - self.t0
|
||||||
|
if entity == "sensor.grid":
|
||||||
|
return self.meter(now)
|
||||||
|
if entity == "sensor.batt":
|
||||||
|
return self.batt
|
||||||
|
if entity == "sensor.soc":
|
||||||
|
if self.soc_dies_at is not None and now >= self.soc_dies_at:
|
||||||
|
return None
|
||||||
|
return 50.0
|
||||||
|
return None
|
||||||
|
|
||||||
|
async def set_number(self, entity, value):
|
||||||
|
self.writes.append(float(value))
|
||||||
|
self.batt = float(value)
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
|
class _Store:
|
||||||
|
data = {}
|
||||||
|
|
||||||
|
def set(self, *a):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
class _Pub:
|
||||||
|
enabled = False
|
||||||
|
|
||||||
|
def publish(self, *a, **k):
|
||||||
|
pass
|
||||||
|
|
||||||
|
def close(self):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
BASE = {"setpoint_entity": "number.sp", "meter_entity": "sensor.grid",
|
||||||
|
"soc_entity": "sensor.soc", "batt_entity": "sensor.batt",
|
||||||
|
"meter_source": "off", "max_w": 2000, "gain": 0.6, "slew_w": 1000,
|
||||||
|
"deadband_w": 15, "target_grid_w": -10, "step_w": 10,
|
||||||
|
"heartbeat_s": 10, "stale_input_s": 15}
|
||||||
|
|
||||||
|
|
||||||
|
def drive(meter, floor, seconds, soc_dies_at=None, **over):
|
||||||
|
"""Run the real control loop for `seconds`; return (cycle times, writes)."""
|
||||||
|
async def go():
|
||||||
|
hass = FakeHass(meter, soc_dies_at)
|
||||||
|
c = Controller(dict(BASE, cycle_floor_s=floor, **over), hass, _Store(),
|
||||||
|
_Pub(), stop=asyncio.Event())
|
||||||
|
c.auto = True
|
||||||
|
stamps = []
|
||||||
|
real = c.cycle
|
||||||
|
|
||||||
|
async def counted():
|
||||||
|
stamps.append(time.monotonic() - hass.t0)
|
||||||
|
await real()
|
||||||
|
|
||||||
|
c.cycle = counted
|
||||||
|
task = asyncio.create_task(c.run_control())
|
||||||
|
await asyncio.sleep(seconds)
|
||||||
|
c.stopping = True
|
||||||
|
await asyncio.wait_for(task, timeout=10)
|
||||||
|
return stamps, hass.writes, c.target, c.reason
|
||||||
|
return asyncio.run(go())
|
||||||
|
|
||||||
|
|
||||||
|
def worst_gap(stamps, seconds):
|
||||||
|
"""Longest stretch with no cycle, including the tail after the last one."""
|
||||||
|
edges = [0.0] + list(stamps) + [seconds]
|
||||||
|
return max(b - a for a, b in zip(edges, edges[1:]))
|
||||||
|
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
print("a meter that repeats the same value")
|
||||||
|
FLAT = lambda t: 350.0 # noqa: E731
|
||||||
|
FLOOR, SECONDS = 3.0, 12.0
|
||||||
|
|
||||||
|
pre_stamps, pre_writes, _, _ = drive(FLAT, NEVER, SECONDS)
|
||||||
|
# The defect itself, demonstrated rather than described: one cycle at startup
|
||||||
|
# and then nothing for the rest of the window, while writes keep happening.
|
||||||
|
check("pre-fix: a constant meter runs exactly one cycle, at startup",
|
||||||
|
len(pre_stamps) == 1)
|
||||||
|
check("...while the heartbeat keeps writing anyway, so nothing looks wrong",
|
||||||
|
len(pre_writes) >= 2)
|
||||||
|
|
||||||
|
post_stamps, post_writes, _, _ = drive(FLAT, FLOOR, SECONDS)
|
||||||
|
check("post-fix: the same constant meter runs cycles throughout",
|
||||||
|
len(post_stamps) >= int(SECONDS / FLOOR) - 1)
|
||||||
|
# The actual acceptance criterion: a BOUND on the gap, not a count.
|
||||||
|
gap = worst_gap(post_stamps, SECONDS)
|
||||||
|
check(f"...with no gap longer than the floor ({gap:.1f}s <= {FLOOR + 1.5:.1f}s)",
|
||||||
|
gap <= FLOOR + 1.5)
|
||||||
|
check("...and the loop actually corrected, instead of holding a stale command",
|
||||||
|
len(post_writes) > len(pre_writes))
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
print("a meter that changes normally - nothing may move")
|
||||||
|
# ⚠️ THE REGRESSION GUARD, and the more important half. The floor is a deadline
|
||||||
|
# on the gap between cycles, reset by every cycle whichever trigger fired - not
|
||||||
|
# a second scheduler. On a healthy meter it must never elapse, so the cycle
|
||||||
|
# count, the write count and the commanded values must be IDENTICAL either side
|
||||||
|
# of the fix. Anything else is a new write cadence, which SAFETY-12 forbids:
|
||||||
|
# the deadband, step_w and the 10 s force-write decide what reaches the wire,
|
||||||
|
# and this change is only allowed to alter when the loop thinks.
|
||||||
|
STEPS = [0.0, 300.0, 850.0, -400.0, 120.0, -900.0, 60.0]
|
||||||
|
LIVE = lambda t: STEPS[int(t // 2) % len(STEPS)] # noqa: E731
|
||||||
|
|
||||||
|
a_stamps, a_writes, _, _ = drive(LIVE, NEVER, 12.0)
|
||||||
|
b_stamps, b_writes, _, _ = drive(LIVE, FLOOR, 12.0)
|
||||||
|
check("a changing meter runs the same number of cycles as before the fix",
|
||||||
|
len(a_stamps) == len(b_stamps))
|
||||||
|
check("...commanding exactly the same sequence of values", a_writes == b_writes)
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
print("a meter parked at the target - the converged operating point")
|
||||||
|
# The case TEL-05 warned about: at the converged target the power figure
|
||||||
|
# legitimately repeats for minutes. The loop must still run, and must still
|
||||||
|
# write nothing but the heartbeat, because the deadband - not the arrival
|
||||||
|
# trigger - is what holds the command still.
|
||||||
|
AT_TARGET = lambda t: -10.0 # noqa: E731
|
||||||
|
c_stamps, c_writes, _, _ = drive(AT_TARGET, NEVER, 12.0)
|
||||||
|
d_stamps, d_writes, _, _ = drive(AT_TARGET, FLOOR, 12.0)
|
||||||
|
check("the loop evaluates at the converged point too", len(d_stamps) > len(c_stamps))
|
||||||
|
check("...and the deadband still holds the command, so writes are unchanged",
|
||||||
|
d_writes == c_writes)
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
print("an input dies while the meter repeats - the safety claim must still fire")
|
||||||
|
# ⚠️ THE STRONGEST PROPERTY IN SAFETY-12, and the one that makes it a safety fix
|
||||||
|
# rather than a latency fix. The `inputs missing -> 0 W` claim lives INSIDE
|
||||||
|
# cycle() (main.py, the stale_input_s branch and the P_SAFETY claim below it).
|
||||||
|
# Pre-fix, on a meter whose value happened to repeat, cycle() was never called
|
||||||
|
# again - so that claim could not fire AT ALL. The controller held its last
|
||||||
|
# command through an input outage of unbounded length with the status line still
|
||||||
|
# reading "loop -> N W".
|
||||||
|
#
|
||||||
|
# Layer 1 does not cover this either on a `meter_source: off` install: no P1 age
|
||||||
|
# sensor is published (see Controller.publish), so the firmware has nothing to
|
||||||
|
# veto on, and the heartbeat keeps its watchdog fed the whole time.
|
||||||
|
#
|
||||||
|
# stale_input_s is shortened to 3 s here so the outage resolves inside a test
|
||||||
|
# rather than inside a quarter of a minute. The mechanism is the default one.
|
||||||
|
c2_stamps, c2_writes, pre_target, pre_reason = drive(
|
||||||
|
FLAT, NEVER, 10.0, soc_dies_at=4.0, stale_input_s=3)
|
||||||
|
check("pre-fix: a dead input during a constant meter never reaches the safety claim",
|
||||||
|
pre_target != 0.0 and "safety" not in pre_reason)
|
||||||
|
check(f"...so it holds its last command instead ({pre_target:g} W, {pre_reason!r})",
|
||||||
|
pre_target == 220.0)
|
||||||
|
|
||||||
|
d2_stamps, d2_writes, post_target, post_reason = drive(
|
||||||
|
FLAT, FLOOR, 10.0, soc_dies_at=4.0, stale_input_s=3)
|
||||||
|
check("post-fix: the same outage commands 0 W", post_target == 0.0)
|
||||||
|
check(f"...through the safety claim, not by accident ({post_reason!r})",
|
||||||
|
"safety" in post_reason)
|
||||||
|
check("...and the 0 W actually reached the device", 0.0 in d2_writes)
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
print()
|
||||||
|
if fails:
|
||||||
|
print(f"{len(fails)} FAILED: " + "; ".join(fails))
|
||||||
|
sys.exit(1)
|
||||||
|
print("all checks passed")
|
||||||
@@ -11,6 +11,7 @@ computes the wrong quarter-hour figure whenever the telegram cadence changes.
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
|
import json
|
||||||
import sys
|
import sys
|
||||||
import time
|
import time
|
||||||
from datetime import datetime, timedelta, timezone
|
from datetime import datetime, timedelta, timezone
|
||||||
@@ -18,8 +19,11 @@ from datetime import datetime, timedelta, timezone
|
|||||||
import aiohttp # already required by app.p1, so this adds no new dependency
|
import aiohttp # already required by app.p1, so this adds no new dependency
|
||||||
|
|
||||||
from app.p1 import (
|
from app.p1 import (
|
||||||
P1Error, P1Ingest, HaDsmrSource, QuarterAverager, SOURCE_HA, SOURCE_MQTT,
|
P1Error, P1Ingest, HaDsmrSource, HaSignedSource, HomeWizardLocalSource,
|
||||||
make_sample, parse_mqtt_payload,
|
QuarterAverager,
|
||||||
|
SOURCE_HA, SOURCE_HA_SIGNED, SOURCE_HOMEWIZARD, SOURCE_MQTT,
|
||||||
|
build_source, is_enabled, make_sample, parse_homewizard, parse_mqtt_payload,
|
||||||
|
split_signed,
|
||||||
)
|
)
|
||||||
|
|
||||||
fails = []
|
fails = []
|
||||||
@@ -56,6 +60,25 @@ def raises(name, fn):
|
|||||||
fails.append(name)
|
fails.append(name)
|
||||||
|
|
||||||
|
|
||||||
|
def built(src):
|
||||||
|
"""`src.build()`, with any escaping exception turned into a visible value.
|
||||||
|
|
||||||
|
⚠️ Legibility of a RED, not leniency. build() is contracted to return a bool
|
||||||
|
and to funnel every bad telegram through ingest.reject() - a guard that goes
|
||||||
|
missing (say the "is the net entity cached at all" one) makes it raise
|
||||||
|
instead. That still fails the suite, but by aborting it with a traceback at
|
||||||
|
whichever check happened to run first, which costs the next person ten
|
||||||
|
minutes deciding whether the suite is broken or the code is. Returning the
|
||||||
|
exception makes it compare unequal to True/False, so the NAMED check goes red
|
||||||
|
and says which rule died.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
return src.build()
|
||||||
|
except Exception as err: # noqa: BLE001 - a raise here is itself the failure
|
||||||
|
print(f" build() raised {type(err).__name__}: {err}")
|
||||||
|
return err
|
||||||
|
|
||||||
|
|
||||||
def sample(net_import, net_export=0.0, at=BASE, phases=1, pi=None, pe=None):
|
def sample(net_import, net_export=0.0, at=BASE, phases=1, pi=None, pe=None):
|
||||||
return make_sample(SOURCE_HA, net_import, net_export, phases=phases,
|
return make_sample(SOURCE_HA, net_import, net_export, phases=phases,
|
||||||
phase_import_w=pi, phase_export_w=pe,
|
phase_import_w=pi, phase_export_w=pe,
|
||||||
@@ -548,6 +571,726 @@ check("the averager integrated the live stream", live.averager.elapsed_s > 0.2)
|
|||||||
check("the primed cache let the first telegram build immediately",
|
check("the primed cache let the first telegram build immediately",
|
||||||
live.samples == 2 and live.last.import_w == 0.0)
|
live.samples == 2 and live.last.import_w == 0.0)
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
print("ha_signed: one signed entity -> the same two magnitudes")
|
||||||
|
# The meter actually fitted at this house is a HomeWizard P1 publishing ONE
|
||||||
|
# signed sensor. ha_dsmr cannot read it - it wants two unsigned registers and
|
||||||
|
# refuses a negative one, which is every exporting telegram.
|
||||||
|
|
||||||
|
check("a positive reading is import", split_signed(1500.0) == (1500.0, 0.0))
|
||||||
|
check("a negative reading is export", split_signed(-900.0) == (0.0, 900.0))
|
||||||
|
check("zero is a balanced reading, not a missing one",
|
||||||
|
split_signed(0.0) == (0.0, 0.0))
|
||||||
|
check("exactly one magnitude is ever non-zero",
|
||||||
|
all(a == 0.0 or b == 0.0 for a, b in
|
||||||
|
(split_signed(v) for v in (-5710.0, -1.0, 0.0, 1.0, 4384.0))))
|
||||||
|
# ⚠️ The split must not change the number. A control loop steered by a value
|
||||||
|
# that was rounded or clamped on the way in is steered by a different meter.
|
||||||
|
check("the split round-trips the signed value exactly",
|
||||||
|
all(make_sample(SOURCE_HA_SIGNED, *split_signed(v), phases=1).net_w == v
|
||||||
|
for v in (-11763.0, -5710.0, -0.5, 0.0, 0.5, 775.0, 4384.0)))
|
||||||
|
|
||||||
|
raises("a non-numeric signed reading is rejected", lambda: split_signed("n/a"))
|
||||||
|
raises("a signed None is rejected, not read as zero", lambda: split_signed(None))
|
||||||
|
raises("a signed NaN is rejected", lambda: split_signed(float("nan")))
|
||||||
|
raises("a signed infinity is rejected", lambda: split_signed(float("inf")))
|
||||||
|
# ⚠️ This one matters MORE on the signed path than on the unsigned one. On
|
||||||
|
# ha_dsmr the §20 contamination is also caught by "unsigned cannot be negative";
|
||||||
|
# here 64954 arrives as a perfectly well-formed positive signed reading and the
|
||||||
|
# plausibility ceiling is the only thing standing in front of it.
|
||||||
|
raises("the 64954 signed-decode contamination is still rejected",
|
||||||
|
lambda: split_signed(64954.0))
|
||||||
|
raises("...and its negative twin too", lambda: split_signed(-64954.0))
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
print("ha_signed: the sign convention, against real captured readings")
|
||||||
|
# ⚠️ Not a datasheet claim. These are literal values out of
|
||||||
|
# sim/scenarios/ha-p1_meter_active_power-2026-08-{20,23}.json, HA recorder
|
||||||
|
# exports of sensor.p1_meter_active_power at this house, copied here rather than
|
||||||
|
# read from that repo so this file still runs on a laptop with nothing installed
|
||||||
|
# (§17). If the convention were inverted, the physics below would be absurd.
|
||||||
|
|
||||||
|
# 2026-08-23T11:46:52Z - the day's most negative reading, 13:46 local, full sun.
|
||||||
|
s = make_sample(SOURCE_HA_SIGNED, *split_signed(-5710.0), phases=1)
|
||||||
|
check("the midday PV peak (-5710 W) is EXPORT, not a 5.7 kW draw",
|
||||||
|
s.net_w == -5710.0 and s.export_w == 5710.0 and s.import_w == 0.0)
|
||||||
|
# 2026-08-19T22:00:00Z - midnight local, 20 Aug's file starts here. No sun.
|
||||||
|
s = make_sample(SOURCE_HA_SIGNED, *split_signed(775.0), phases=1)
|
||||||
|
check("the overnight base load (+775 W) is IMPORT",
|
||||||
|
s.net_w == 775.0 and s.import_w == 775.0 and s.export_w == 0.0)
|
||||||
|
# 2026-08-20T12:20:58Z - 14:20 local, the largest export in either capture.
|
||||||
|
s = make_sample(SOURCE_HA_SIGNED, *split_signed(-11763.0), phases=1)
|
||||||
|
check("the -11763 W midday extreme is export and survives the ceiling",
|
||||||
|
s.net_w == -11763.0 and s.export_w == 11763.0)
|
||||||
|
# 2026-08-23T10:18:28Z - the largest import in the healthy capture.
|
||||||
|
s = make_sample(SOURCE_HA_SIGNED, *split_signed(4384.0), phases=1)
|
||||||
|
check("the +4384 W peak is import", s.net_w == 4384.0 and s.import_w == 4384.0)
|
||||||
|
# The whole convention in one line: night draws, midday feeds back.
|
||||||
|
check("night is positive and midday is negative, which is the convention",
|
||||||
|
split_signed(775.0)[0] > 0 and split_signed(-5710.0)[1] > 0)
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
print("ha_signed transport: building a sample out of one entity state")
|
||||||
|
|
||||||
|
NET = {"net": "sensor.p1_meter_active_power", "phase_net": []}
|
||||||
|
ing = P1Ingest(phases=1, max_age_s=30.0)
|
||||||
|
sig = HaSignedSource(None, ing, NET, token="x")
|
||||||
|
|
||||||
|
check("nothing cached yet builds nothing", built(sig) is False and ing.last is None)
|
||||||
|
sig._absorb("sensor.p1_meter_active_power", "1000")
|
||||||
|
check("one signed entity is a complete telegram on its own",
|
||||||
|
built(sig) is True and ing.net_w == 1000.0)
|
||||||
|
check("the sample is tagged with its own transport",
|
||||||
|
ing.last.source == SOURCE_HA_SIGNED)
|
||||||
|
sig._absorb("sensor.p1_meter_active_power", "-2500")
|
||||||
|
built(sig)
|
||||||
|
check("a negative state lands as a negative net", ing.net_w == -2500.0)
|
||||||
|
|
||||||
|
before = ing.last
|
||||||
|
sig._absorb("sensor.p1_meter_active_power", "unavailable")
|
||||||
|
check("an unavailable signed entity is a parse error", ing.parse_errors == 1)
|
||||||
|
check("an unavailable entity does not build a sample", built(sig) is False)
|
||||||
|
# ⚠️ The rule the whole ticket turns on: a missing reading is MISSING. Resolving
|
||||||
|
# it to 0 W would read as a perfectly balanced house and defeat the staleness
|
||||||
|
# trigger that FW-01's watchdog is built on.
|
||||||
|
check("an unavailable entity leaves the last good sample untouched, not 0 W",
|
||||||
|
ing.last is before and ing.net_w == -2500.0)
|
||||||
|
sig._absorb("sensor.p1_meter_active_power", "unknown")
|
||||||
|
check("an unknown signed entity is treated the same way", ing.parse_errors == 2)
|
||||||
|
sig._absorb("sensor.p1_meter_active_power", "banana")
|
||||||
|
check("a non-numeric signed state is a parse error, not 0 W",
|
||||||
|
ing.parse_errors == 3 and ing.net_w == -2500.0)
|
||||||
|
sig._absorb("sensor.p1_meter_active_power", "64954")
|
||||||
|
check("64954 is refused at the signed transport too",
|
||||||
|
built(sig) is False and ing.parse_errors == 4)
|
||||||
|
sig._absorb("sensor.not_ours", "123")
|
||||||
|
check("an unsubscribed entity is never cached by the signed transport",
|
||||||
|
"sensor.not_ours" not in sig.cache)
|
||||||
|
|
||||||
|
# A rejected reading must not make the age look fresh - the age is what the
|
||||||
|
# firmware watchdog reads, and a rejection is exactly when it must keep climbing.
|
||||||
|
ing = P1Ingest(phases=1, max_age_s=30.0)
|
||||||
|
sig = HaSignedSource(None, ing, dict(NET), token="x")
|
||||||
|
ing.submit(make_sample(SOURCE_HA_SIGNED, 1200, 0, phases=1,
|
||||||
|
ingest_mono=time.monotonic() - 20.0))
|
||||||
|
sig._absorb("sensor.p1_meter_active_power", "unavailable")
|
||||||
|
built(sig)
|
||||||
|
check("a rejected reading does not reset the published age",
|
||||||
|
ing.published_age_s > 19 and ing.net_w == 1200.0)
|
||||||
|
ing.submit(make_sample(SOURCE_HA_SIGNED, 1200, 0, phases=1,
|
||||||
|
ingest_mono=time.monotonic() - 40.0))
|
||||||
|
check("...and the age keeps climbing past max_age_s on its own",
|
||||||
|
ing.stale is True and ing.net_w is None)
|
||||||
|
|
||||||
|
# The three-phase reading the TEL-04 survey recorded at this house: L1 +2301 W,
|
||||||
|
# L2 +468 W, L3 -2582 W, netting +187 W. A signed per-phase set splits the same
|
||||||
|
# way, and the exporting phase must still clamp out of the billed figure.
|
||||||
|
ing3 = P1Ingest(phases=3, max_age_s=30.0)
|
||||||
|
NET3 = {"net": "sensor.p1_meter_active_power",
|
||||||
|
"phase_net": ["sensor.p1_l1", "sensor.p1_l2", "sensor.p1_l3"]}
|
||||||
|
sig3 = HaSignedSource(None, ing3, NET3, token="x")
|
||||||
|
for eid, val in (("sensor.p1_meter_active_power", "187"), ("sensor.p1_l1", "2301")):
|
||||||
|
sig3._absorb(eid, val)
|
||||||
|
check("an incomplete signed phase set waits instead of guessing", built(sig3) is False)
|
||||||
|
sig3._absorb("sensor.p1_l2", "468")
|
||||||
|
sig3._absorb("sensor.p1_l3", "-2582")
|
||||||
|
check("a complete signed three-phase set builds", built(sig3) is True)
|
||||||
|
check("signed per-phase entities keep the exporting phase negative",
|
||||||
|
ing3.last.per_phase_w == (2301.0, 468.0, -2582.0))
|
||||||
|
check("per-phase IMPORT clamps the exporting phase to zero",
|
||||||
|
ing3.last.per_phase_import_w == (2301.0, 468.0, 0.0))
|
||||||
|
check("the phase import sum is 2769 W while the connection nets 187 W",
|
||||||
|
sum(ing3.last.per_phase_import_w) == 2769.0 and ing3.last.net_w == 187.0)
|
||||||
|
check("the signed per-phase tuple length matches meter_phases",
|
||||||
|
len(ing3.last.per_phase_w) == ing3.phases == 3)
|
||||||
|
|
||||||
|
sig_bad = HaSignedSource(None, P1Ingest(phases=3, max_age_s=30.0),
|
||||||
|
{"net": "sensor.net", "phase_net": ["sensor.a", "sensor.b"]},
|
||||||
|
token="x")
|
||||||
|
for eid in ("sensor.net", "sensor.a", "sensor.b"):
|
||||||
|
sig_bad._absorb(eid, "100")
|
||||||
|
check("two phases delivered against meter_phases 3 is rejected, not padded",
|
||||||
|
built(sig_bad) is False and sig_bad.ingest.last is None
|
||||||
|
and sig_bad.ingest.parse_errors == 1)
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
print("ha_signed transport: end to end against a fake Home Assistant")
|
||||||
|
# The transport is a subclass, so this is what proves the INHERITED machinery -
|
||||||
|
# auth, subscribe, the get_states priming rule, the reconnect-emits-nothing
|
||||||
|
# rule - still behaves when only _wanted() and build() were replaced.
|
||||||
|
|
||||||
|
|
||||||
|
async def _e2e_signed():
|
||||||
|
from aiohttp import web
|
||||||
|
import app.p1 as p1mod
|
||||||
|
|
||||||
|
done = asyncio.Event()
|
||||||
|
eid = "sensor.p1_meter_active_power"
|
||||||
|
|
||||||
|
async def fake_ha(request):
|
||||||
|
ws = web.WebSocketResponse()
|
||||||
|
await ws.prepare(request)
|
||||||
|
await ws.send_json({"type": "auth_required", "ha_version": "2026.8"})
|
||||||
|
auth = await ws.receive_json()
|
||||||
|
assert auth["type"] == "auth" and auth["access_token"] == "tok"
|
||||||
|
await ws.send_json({"type": "auth_ok"})
|
||||||
|
sub = await ws.receive_json()
|
||||||
|
assert sub["type"] == "subscribe_events"
|
||||||
|
await ws.send_json({"id": sub["id"], "type": "result", "success": True})
|
||||||
|
get = await ws.receive_json()
|
||||||
|
assert get["type"] == "get_states"
|
||||||
|
await ws.send_json({"id": get["id"], "type": "result", "success": True, "result": [
|
||||||
|
{"entity_id": eid, "state": "775.0"},
|
||||||
|
{"entity_id": "sensor.something_else", "state": "hello"},
|
||||||
|
]})
|
||||||
|
# Two real telegrams, both literal captured values: overnight import,
|
||||||
|
# then the midday export peak.
|
||||||
|
for val in ("775.0", "-5710.0"):
|
||||||
|
await asyncio.sleep(0.5)
|
||||||
|
await ws.send_json({"type": "event", "event": {"data": {
|
||||||
|
"entity_id": eid,
|
||||||
|
"new_state": {"entity_id": eid, "state": val}}}})
|
||||||
|
await asyncio.sleep(0.5)
|
||||||
|
await ws.send_json({"type": "event", "event": {"data": {
|
||||||
|
"entity_id": eid,
|
||||||
|
"new_state": {"entity_id": eid, "state": "unavailable"}}}})
|
||||||
|
await asyncio.sleep(0.5)
|
||||||
|
done.set()
|
||||||
|
return ws
|
||||||
|
|
||||||
|
srv = web.Application()
|
||||||
|
srv.router.add_get("/ws", fake_ha)
|
||||||
|
runner = web.AppRunner(srv)
|
||||||
|
await runner.setup()
|
||||||
|
site = web.TCPSite(runner, "127.0.0.1", 0)
|
||||||
|
await site.start()
|
||||||
|
port = site._server.sockets[0].getsockname()[1]
|
||||||
|
p1mod.WS_URL = f"http://127.0.0.1:{port}/ws"
|
||||||
|
|
||||||
|
ing = P1Ingest(phases=1, max_age_s=30.0)
|
||||||
|
async with aiohttp.ClientSession() as sess:
|
||||||
|
src = HaSignedSource(sess, ing, dict(NET), token="tok")
|
||||||
|
task = asyncio.get_running_loop().create_task(src.run())
|
||||||
|
try:
|
||||||
|
await asyncio.wait_for(done.wait(), 20)
|
||||||
|
await asyncio.sleep(0.5)
|
||||||
|
finally:
|
||||||
|
task.cancel()
|
||||||
|
try:
|
||||||
|
await task
|
||||||
|
except asyncio.CancelledError:
|
||||||
|
pass
|
||||||
|
await runner.cleanup()
|
||||||
|
return ing, src
|
||||||
|
|
||||||
|
|
||||||
|
live, wire = asyncio.run(_e2e_signed())
|
||||||
|
# ⚠️ TWO, not three - the same rule as the ha_dsmr e2e. get_states primes the
|
||||||
|
# cache but must never become a sample: after a Core restart it is a
|
||||||
|
# RestoreEntity value of unknown age, and stamping it with ingest_ts=now reports
|
||||||
|
# a fresh meter that may have been dead for an hour.
|
||||||
|
check("ha_signed does not manufacture a sample from cached HA state",
|
||||||
|
live.samples == 2)
|
||||||
|
check("the signed telegrams arrived over a real websocket",
|
||||||
|
live.last.source == SOURCE_HA_SIGNED)
|
||||||
|
check("the final export telegram nets negative, over the wire",
|
||||||
|
live.last.net_w == -5710.0 and live.last.export_w == 5710.0)
|
||||||
|
check("ha_signed subscribes to the one entity and caches nothing else",
|
||||||
|
wire.ids == {"sensor.p1_meter_active_power"}
|
||||||
|
and "sensor.something_else" not in wire.cache)
|
||||||
|
check("a mid-stream unavailable signed state is a parse error, not a sample",
|
||||||
|
live.parse_errors == 1 and live.samples == 2)
|
||||||
|
# ⚠️ And the cached half is DROPPED, so no later telegram can be assembled out
|
||||||
|
# of a value that stopped reporting.
|
||||||
|
check("an unavailable entity is evicted from the cache", wire.cache == {})
|
||||||
|
check("the last good reading survives the unavailable, and is not 0 W",
|
||||||
|
live.net_w == -5710.0)
|
||||||
|
check("the averager integrated the live signed stream", live.averager.elapsed_s > 0.2)
|
||||||
|
# ⚠️ The entity FW-01 waits on. It must be a number here exactly as it is on the
|
||||||
|
# other transports - the house P1 went 51.1 s and 36.2 s between state changes
|
||||||
|
# overnight, and without this the watchdog false-trips the battery to 0 W.
|
||||||
|
check("sensor.p1_sample_age_s is a live number on this transport too",
|
||||||
|
isinstance(live.published_age_s, float) and live.published_age_s >= 0.0)
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
print("ha_signed: selection by config")
|
||||||
|
|
||||||
|
check("ha_signed is enabled", is_enabled({"meter_source": SOURCE_HA_SIGNED}) is True)
|
||||||
|
# ⚠️ `sel`, not `built` - that name is the build() wrapper defined at the top of
|
||||||
|
# this file, and rebinding it here silently disarms every check appended below
|
||||||
|
# this line. Caught in review: an added check went `TypeError: 'HaSignedSource'
|
||||||
|
# object is not callable` and aborted the suite, which is the exact failure the
|
||||||
|
# wrapper exists to prevent, reintroduced by a name collision.
|
||||||
|
sel = build_source({"meter_source": SOURCE_HA_SIGNED,
|
||||||
|
"p1_net_entity": "sensor.p1_meter_active_power"},
|
||||||
|
P1Ingest(), None, None)
|
||||||
|
check("meter_source ha_signed selects the signed transport",
|
||||||
|
isinstance(sel, HaSignedSource))
|
||||||
|
check("...wired to p1_net_entity, and subscribed to exactly that one entity",
|
||||||
|
sel.ids == {"sensor.p1_meter_active_power"})
|
||||||
|
# ⚠️ The three modes must not bleed into each other: ha_dsmr must keep ignoring
|
||||||
|
# p1_net_entity, or a half-configured install silently reads the wrong sensor.
|
||||||
|
plain = build_source({"meter_source": SOURCE_HA,
|
||||||
|
"p1_import_entity": "sensor.i", "p1_export_entity": "sensor.e",
|
||||||
|
"p1_net_entity": "sensor.p1_meter_active_power"},
|
||||||
|
P1Ingest(), None, None)
|
||||||
|
check("ha_dsmr still selects the unsigned transport and ignores p1_net_entity",
|
||||||
|
type(plain) is HaDsmrSource and plain.ids == {"sensor.i", "sensor.e"})
|
||||||
|
check("meter_source off still selects nothing",
|
||||||
|
build_source({"meter_source": "off"}, P1Ingest(), None, None) is None)
|
||||||
|
check("an unrecognised meter_source selects nothing rather than guessing",
|
||||||
|
build_source({"meter_source": "ha_signd"}, P1Ingest(), None, None) is None)
|
||||||
|
|
||||||
|
# ⚠️ Caught once at startup, not once per telegram. A source that is wired up
|
||||||
|
# wrong otherwise fails in the one way indistinguishable from a healthy source
|
||||||
|
# nobody has sent anything to yet: no samples, a climbing age, the watchdog
|
||||||
|
# holding the battery at 0 W, and nothing in the log saying why.
|
||||||
|
check("a blank p1_net_entity is refused rather than silently never receiving",
|
||||||
|
build_source({"meter_source": SOURCE_HA_SIGNED, "p1_net_entity": ""},
|
||||||
|
P1Ingest(), None, None) is None)
|
||||||
|
check("...and whitespace does not sneak past it",
|
||||||
|
build_source({"meter_source": SOURCE_HA_SIGNED, "p1_net_entity": " "},
|
||||||
|
P1Ingest(), None, None) is None)
|
||||||
|
check("a phase list that disagrees with meter_phases is refused at startup",
|
||||||
|
build_source({"meter_source": SOURCE_HA_SIGNED, "p1_net_entity": "sensor.n",
|
||||||
|
"p1_phase_net_entities": ["sensor.a", "sensor.b"]},
|
||||||
|
P1Ingest(phases=3), None, None) is None)
|
||||||
|
check("a phase list that agrees with meter_phases is accepted",
|
||||||
|
isinstance(build_source(
|
||||||
|
{"meter_source": SOURCE_HA_SIGNED, "p1_net_entity": "sensor.n",
|
||||||
|
"p1_phase_net_entities": ["sensor.a", "sensor.b", "sensor.c"]},
|
||||||
|
P1Ingest(phases=3), None, None), HaSignedSource))
|
||||||
|
check("no phase list at all is still fine - per-phase billing is optional",
|
||||||
|
isinstance(build_source(
|
||||||
|
{"meter_source": SOURCE_HA_SIGNED, "p1_net_entity": "sensor.n"},
|
||||||
|
P1Ingest(phases=3), None, None), HaSignedSource))
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
print("homewizard_local: parsing the meter's own /api/v1/data document")
|
||||||
|
# The same JSON `sim/hwsim.py` serves and the same JSON the real meter at
|
||||||
|
# 192.168.2.250 serves. One SIGNED connection figure plus three signed legs, so
|
||||||
|
# it goes through the same split_signed as ha_signed - the sign convention is
|
||||||
|
# not re-derived on this transport, it is reused.
|
||||||
|
|
||||||
|
|
||||||
|
def hw_doc(w, l1=None, l2=None, l3=None, imp_kwh=1234.567, exp_kwh=890.123):
|
||||||
|
return {"wifi_ssid": "sim", "smr_version": 50, "meter_model": "SIM-P1",
|
||||||
|
"total_power_import_kwh": imp_kwh, "total_power_export_kwh": exp_kwh,
|
||||||
|
"active_power_w": w,
|
||||||
|
"active_power_l1_w": l1, "active_power_l2_w": l2,
|
||||||
|
"active_power_l3_w": l3, "total_gas_m3": 0.0}
|
||||||
|
|
||||||
|
|
||||||
|
s = parse_homewizard(hw_doc(775.0, l1=775.0), 1)
|
||||||
|
check("the overnight base load (+775 W) is import on this transport too",
|
||||||
|
s.net_w == 775.0 and s.import_w == 775.0 and s.export_w == 0.0)
|
||||||
|
check("the sample is tagged homewizard_local", s.source == SOURCE_HOMEWIZARD)
|
||||||
|
s = parse_homewizard(hw_doc(-5710.0, l1=-5710.0), 1)
|
||||||
|
check("the midday PV peak (-5710 W) is export, not a 5.7 kW draw",
|
||||||
|
s.net_w == -5710.0 and s.export_w == 5710.0)
|
||||||
|
check("a single-phase document still yields its one leg", s.per_phase_w == (-5710.0,))
|
||||||
|
|
||||||
|
# The TEL-04 three-phase survey reading, served the HomeWizard way.
|
||||||
|
s = parse_homewizard(hw_doc(187.0, 2301.0, 468.0, -2582.0), 3)
|
||||||
|
check("signed legs keep the exporting phase negative",
|
||||||
|
s.per_phase_w == (2301.0, 468.0, -2582.0))
|
||||||
|
check("per-phase import clamps the exporting leg out of the billed figure",
|
||||||
|
s.per_phase_import_w == (2301.0, 468.0, 0.0))
|
||||||
|
check("the legs sum to 2769 W while the connection nets 187 W",
|
||||||
|
sum(s.per_phase_import_w) == 2769.0 and s.net_w == 187.0)
|
||||||
|
|
||||||
|
# ⚠️ A single-phase HomeWizard serves `active_power_l2_w: null`. Unlike the HA
|
||||||
|
# transports there is no "wait for the rest" case - every field came out of ONE
|
||||||
|
# response, so a missing leg cannot be a STALE leg. Dropping the whole sample
|
||||||
|
# over it would turn a healthy meter into a climbing age, which is the exact
|
||||||
|
# false trip this transport exists to remove.
|
||||||
|
def parsed(doc, phases=1):
|
||||||
|
"""parse_homewizard(), with an escaping exception turned into a visible value.
|
||||||
|
|
||||||
|
Same reason as `built()` above: if the "all legs or none" guard goes missing,
|
||||||
|
parsing raises, and without this the suite aborts on a traceback instead of
|
||||||
|
reddening the NAMED check that says which rule died.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
return parse_homewizard(doc, phases)
|
||||||
|
except Exception as err: # noqa: BLE001 - a raise here is itself the failure
|
||||||
|
print(f" parse_homewizard raised {type(err).__name__}: {err}")
|
||||||
|
return err
|
||||||
|
|
||||||
|
|
||||||
|
s = parsed(hw_doc(500.0, l1=500.0), 3)
|
||||||
|
check("a meter serving fewer legs than meter_phases still gives a reading",
|
||||||
|
getattr(s, "net_w", None) == 500.0 and getattr(s, "per_phase_w", "?") is None)
|
||||||
|
check("...and does not fabricate a partial phase tuple",
|
||||||
|
getattr(s, "per_phase_import_w", "?") is None)
|
||||||
|
|
||||||
|
raises("a response that is not a JSON object is rejected",
|
||||||
|
lambda: parse_homewizard([1, 2, 3], 1))
|
||||||
|
raises("a document with no active_power_w is rejected, not read as 0 W",
|
||||||
|
lambda: parse_homewizard({"total_gas_m3": 0.0}, 1))
|
||||||
|
raises("a null active_power_w is rejected", lambda: parse_homewizard(hw_doc(None), 1))
|
||||||
|
raises("a string active_power_w is rejected", lambda: parse_homewizard(hw_doc("775"), 1))
|
||||||
|
raises("a NaN active_power_w is rejected",
|
||||||
|
lambda: parse_homewizard(hw_doc(float("nan")), 1))
|
||||||
|
raises("the 64954 signed-decode contamination is refused here too",
|
||||||
|
lambda: parse_homewizard(hw_doc(64954.0), 1))
|
||||||
|
raises("a non-numeric leg is rejected rather than quietly dropped",
|
||||||
|
lambda: parse_homewizard(hw_doc(600.0, "2000", 0.0, 100.0), 3))
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
print("homewizard_local: every HTTP response is an arrival")
|
||||||
|
# THE WHOLE TICKET. sensor.p1_sample_age_s has to mean "time since the meter
|
||||||
|
# REPORTED", not "time since the value CHANGED". Home Assistant cannot express
|
||||||
|
# the first: a repeated reading emits no state_changed, advances last_reported
|
||||||
|
# on neither serialiser, and state_reported cannot be subscribed to at all
|
||||||
|
# ("Event filter is required"). Measured on the ENV-01 rig over 70 s of a frozen
|
||||||
|
# meter and again against the live house over ten repeated readings. Our own
|
||||||
|
# capture of this house's meter goes 42.2 s and 97.0 s between changes, both past
|
||||||
|
# the default meter_max_age_s of 30 - i.e. the age sensor would command 0 W on a
|
||||||
|
# perfectly healthy meter. Polling the meter itself removes that: the response is
|
||||||
|
# the arrival, and the number in it is not consulted.
|
||||||
|
|
||||||
|
|
||||||
|
class _FakeMeter:
|
||||||
|
"""hwsim in eight lines: serves whatever document it is told to, or a fault."""
|
||||||
|
|
||||||
|
def __init__(self, doc=None):
|
||||||
|
self.doc = doc
|
||||||
|
self.status = 200
|
||||||
|
self.body = None # set to raw text to serve something unparseable
|
||||||
|
self.delay = 0.0 # set to seconds to imitate a meter that hangs
|
||||||
|
self.hits = 0
|
||||||
|
|
||||||
|
async def handle(self, request):
|
||||||
|
from aiohttp import web
|
||||||
|
self.hits += 1
|
||||||
|
if self.delay:
|
||||||
|
await asyncio.sleep(self.delay)
|
||||||
|
# ⚠️ web.Response(text=...) defaults to text/plain. That is not just the
|
||||||
|
# "unparseable body" path: fed VALID json it serves a good document under
|
||||||
|
# the wrong mimetype, which is the only way to reach the content_type
|
||||||
|
# guard in poll_once - json_response can never produce it.
|
||||||
|
if self.body is not None:
|
||||||
|
return web.Response(text=self.body, status=self.status)
|
||||||
|
return web.json_response(self.doc, status=self.status)
|
||||||
|
|
||||||
|
|
||||||
|
async def _hw_rig(fn):
|
||||||
|
"""Run `fn(make_source, meter)` against a real HTTP server on localhost."""
|
||||||
|
from aiohttp import web
|
||||||
|
meter = _FakeMeter(hw_doc(350.0, l1=350.0))
|
||||||
|
app = web.Application()
|
||||||
|
app.router.add_get("/api/v1/data", meter.handle)
|
||||||
|
runner = web.AppRunner(app)
|
||||||
|
await runner.setup()
|
||||||
|
site = web.TCPSite(runner, "127.0.0.1", 0)
|
||||||
|
await site.start()
|
||||||
|
port = site._server.sockets[0].getsockname()[1]
|
||||||
|
async with aiohttp.ClientSession() as sess:
|
||||||
|
try:
|
||||||
|
return await fn(sess, port, meter)
|
||||||
|
finally:
|
||||||
|
await runner.cleanup()
|
||||||
|
|
||||||
|
|
||||||
|
async def _arrivals(sess, port, meter):
|
||||||
|
ing = P1Ingest(phases=1, max_age_s=30.0)
|
||||||
|
src = HomeWizardLocalSource(sess, ing, "127.0.0.1", port=port, poll_s=1.0)
|
||||||
|
out = {}
|
||||||
|
out["first"] = await src.poll_once()
|
||||||
|
out["stamp1"] = ing.last.ingest_mono
|
||||||
|
# Four more polls of the IDENTICAL document - the meter has not moved a watt.
|
||||||
|
for _ in range(4):
|
||||||
|
await asyncio.sleep(0.05)
|
||||||
|
await src.poll_once()
|
||||||
|
out["ing"], out["src"], out["meter"] = ing, src, meter
|
||||||
|
return out
|
||||||
|
|
||||||
|
|
||||||
|
r = asyncio.run(_hw_rig(_arrivals))
|
||||||
|
ing, src = r["ing"], r["src"]
|
||||||
|
check("a poll of the meter's own API builds a sample",
|
||||||
|
r["first"] is True and ing.net_w == 350.0)
|
||||||
|
# ⚠️ THE acceptance criterion. Five identical readings, five arrivals. On
|
||||||
|
# ha_signed this whole sequence produces exactly ONE state_changed and then
|
||||||
|
# silence, and the age climbs to 30 s on a meter that is answering perfectly.
|
||||||
|
check("five identical readings are five arrivals, not one",
|
||||||
|
ing.samples == 5 and r["meter"].hits == 5 and src.polls == 5)
|
||||||
|
check("an unchanged value still stamps a NEW arrival time",
|
||||||
|
ing.last.ingest_mono > r["stamp1"])
|
||||||
|
check("...so the age resets on a response carrying an unchanged number",
|
||||||
|
ing.published_age_s < 1.0 and ing.stale is False)
|
||||||
|
check("no arrival was ever a parse error", ing.parse_errors == 0)
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
print("homewizard_local: frozen vs steady, the pair HA cannot separate")
|
||||||
|
# ⚠️ Read this before changing anything here. A frozen meter (hwsim --fault
|
||||||
|
# freeze) answers 200 OK forever with a stale document. It is ARRIVING. So the
|
||||||
|
# age - an arrival detector, correctly - reads fresh on both, and that is not a
|
||||||
|
# defect in the age, it is the definition of the signal. What the local API adds
|
||||||
|
# that Home Assistant never had is the ENERGY REGISTERS: a meter under real load
|
||||||
|
# advances total_power_import_kwh (1 Wh resolution, ~10 s at 350 W) even when the
|
||||||
|
# power figure repeats, and a frozen one does not. That is the discriminator, and
|
||||||
|
# it is exposed as `unchanged_s` - deliberately NOT folded into the age, because
|
||||||
|
# this controller regulates grid power toward ~0 W and at a converged -10 W the
|
||||||
|
# export register needs six minutes to move. Thresholding unchanged_s at 30 s
|
||||||
|
# would rebuild the false-trip limit cycle at the exact operating point we aim
|
||||||
|
# for. See DOCS.md and HomeWizardLocalSource.unchanged_s.
|
||||||
|
|
||||||
|
|
||||||
|
async def _freeze_vs_steady(sess, port, meter):
|
||||||
|
ing_f = P1Ingest(phases=1, max_age_s=30.0)
|
||||||
|
frozen = HomeWizardLocalSource(sess, ing_f, "127.0.0.1", port=port, poll_s=1.0)
|
||||||
|
meter.doc = hw_doc(350.0, l1=350.0) # --fault freeze: never moves
|
||||||
|
for i in range(4):
|
||||||
|
if i:
|
||||||
|
await asyncio.sleep(0.1) # sleep BEFORE, so unchanged_s
|
||||||
|
await frozen.poll_once() # is read the instant a poll lands
|
||||||
|
|
||||||
|
ing_s = P1Ingest(phases=1, max_age_s=30.0)
|
||||||
|
steady = HomeWizardLocalSource(sess, ing_s, "127.0.0.1", port=port, poll_s=1.0)
|
||||||
|
kwh = 1234.567
|
||||||
|
for i in range(4):
|
||||||
|
if i:
|
||||||
|
await asyncio.sleep(0.1)
|
||||||
|
# A steady 350 W house: the power figure repeats, the register climbs.
|
||||||
|
kwh += 0.001
|
||||||
|
meter.doc = hw_doc(350.0, l1=350.0, imp_kwh=round(kwh, 3))
|
||||||
|
await steady.poll_once()
|
||||||
|
return (ing_f, frozen), (ing_s, steady)
|
||||||
|
|
||||||
|
|
||||||
|
(ing_f, frozen), (ing_s, steady) = asyncio.run(_hw_rig(_freeze_vs_steady))
|
||||||
|
check("a frozen meter keeps arriving, so both read the same power",
|
||||||
|
ing_f.net_w == 350.0 and ing_s.net_w == 350.0)
|
||||||
|
# ⚠️ Recorded as a rule, not a shortcoming: the age is an ARRIVAL detector and a
|
||||||
|
# frozen meter genuinely is arriving. Anyone tempted to make the age catch freeze
|
||||||
|
# is about to reintroduce the false trip on a steady house.
|
||||||
|
check("the age cannot separate them, and is fresh on both",
|
||||||
|
ing_f.published_age_s < 1.0 and ing_s.published_age_s < 1.0)
|
||||||
|
check("the frozen meter's measurement stands still", frozen.unchanged_s > 0.25)
|
||||||
|
check("...while the steady meter's energy register keeps advancing",
|
||||||
|
steady.unchanged_s < 0.05)
|
||||||
|
check("so the two ARE separable on the local API, which HA could not do",
|
||||||
|
frozen.unchanged_s > steady.unchanged_s * 3)
|
||||||
|
check("unchanged_s is None before the first response ever lands",
|
||||||
|
HomeWizardLocalSource(None, P1Ingest(), "h").unchanged_s is None)
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
print("homewizard_local: a failed poll is a missing reading, never 0 W")
|
||||||
|
|
||||||
|
|
||||||
|
async def _failures(sess, port, meter):
|
||||||
|
ing = P1Ingest(phases=1, max_age_s=30.0)
|
||||||
|
src = HomeWizardLocalSource(sess, ing, "127.0.0.1", port=port, poll_s=1.0)
|
||||||
|
await src.poll_once()
|
||||||
|
# Age the good sample by hand so a reset would be unmistakable.
|
||||||
|
ing.submit(make_sample(SOURCE_HOMEWIZARD, 350.0, 0.0, phases=1,
|
||||||
|
ingest_mono=time.monotonic() - 90.0))
|
||||||
|
out = {}
|
||||||
|
meter.status = 500
|
||||||
|
out["http500"] = await src.poll_once()
|
||||||
|
out["conn_after_500"] = src.connected
|
||||||
|
meter.status, meter.body = 200, "<html>gateway</html>"
|
||||||
|
out["notjson"] = await src.poll_once()
|
||||||
|
meter.body = None
|
||||||
|
meter.doc = {"total_gas_m3": 0.0} # 200 OK, no power in it
|
||||||
|
out["nopower"] = await src.poll_once()
|
||||||
|
out["ing"], out["src"] = ing, src
|
||||||
|
|
||||||
|
# And a meter that is not listening at all: `--fault down`.
|
||||||
|
dead = HomeWizardLocalSource(sess, P1Ingest(phases=1, max_age_s=30.0),
|
||||||
|
"127.0.0.1", port=1, poll_s=1.0)
|
||||||
|
out["down"] = await dead.poll_once()
|
||||||
|
out["dead"] = dead
|
||||||
|
return out
|
||||||
|
|
||||||
|
|
||||||
|
r = asyncio.run(_hw_rig(_failures))
|
||||||
|
ing, src = r["ing"], r["src"]
|
||||||
|
check("an HTTP 500 is not a reading", r["http500"] is False)
|
||||||
|
# A source that was connected and then failed must SAY it is disconnected -
|
||||||
|
# otherwise the diagnostic reads healthy while the age climbs, which is exactly
|
||||||
|
# the "connected: True, parse_errors: 0, samples: 0" state the rig recorded.
|
||||||
|
check("a poll that fails clears the connected flag", r["conn_after_500"] is False)
|
||||||
|
check("a 200 OK carrying something that is not JSON is not a reading",
|
||||||
|
r["notjson"] is False)
|
||||||
|
check("a 200 OK with no active_power_w in it is not a reading", r["nopower"] is False)
|
||||||
|
check("a meter that refuses the connection is not a reading",
|
||||||
|
r["down"] is False and r["dead"].connected is False)
|
||||||
|
check("every failure was counted as a parse error", ing.parse_errors == 3)
|
||||||
|
check("...and the transport records the transport-level ones separately",
|
||||||
|
src.poll_errors == 2 and src.polls == 4)
|
||||||
|
# ⚠️ The rule the safety chain rests on. A failed poll must not manufacture a
|
||||||
|
# balanced house, and must not reset the clock the watchdog reads.
|
||||||
|
check("a failed poll does not reset the age", ing.published_age_s > 89)
|
||||||
|
check("a failed poll leaves the last good value in place, and it is not 0 W",
|
||||||
|
ing.last.net_w == 350.0 and ing.stale is True and ing.net_w is None)
|
||||||
|
check("no failed poll ever became a sample", ing.samples == 2)
|
||||||
|
check("a 200 OK marks the transport connected even when its body is refused",
|
||||||
|
src.connected is True)
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
print("homewizard_local: a wrong header, a hung meter, a submit that throws")
|
||||||
|
# Three failure shapes that all end the same way if they are mishandled - no
|
||||||
|
# sample, a climbing age, the battery at 0 W - and each of which would send the
|
||||||
|
# operator hunting the wrong device.
|
||||||
|
|
||||||
|
|
||||||
|
async def _header_and_timeout(sess, port, meter):
|
||||||
|
out = {}
|
||||||
|
# Valid JSON under text/plain: exactly what content_type=None is for.
|
||||||
|
meter.body = json.dumps(hw_doc(350.0, l1=350.0))
|
||||||
|
ing = P1Ingest(phases=1, max_age_s=30.0)
|
||||||
|
src = HomeWizardLocalSource(sess, ing, "127.0.0.1", port=port, poll_s=1.0)
|
||||||
|
out["mimetype"] = await src.poll_once()
|
||||||
|
out["ing"] = ing
|
||||||
|
meter.body = None
|
||||||
|
|
||||||
|
# A meter that takes the connection and then does not answer.
|
||||||
|
meter.delay = 0.6
|
||||||
|
ing_t = P1Ingest(phases=1, max_age_s=30.0)
|
||||||
|
slow = HomeWizardLocalSource(sess, ing_t, "127.0.0.1", port=port,
|
||||||
|
poll_s=1.0, timeout_s=0.05)
|
||||||
|
out["timeout"] = await slow.poll_once()
|
||||||
|
out["timeout_err"] = ing_t.last_error
|
||||||
|
meter.delay = 0.0
|
||||||
|
return out
|
||||||
|
|
||||||
|
|
||||||
|
r = asyncio.run(_hw_rig(_header_and_timeout))
|
||||||
|
# ⚠️ A real firmware answering text/plain must not read as a dead meter. Drop
|
||||||
|
# content_type=None from poll_once and this goes red with "unexpected mimetype".
|
||||||
|
check("valid JSON under the wrong Content-Type is still a reading",
|
||||||
|
r["mimetype"] is True and r["ing"].samples == 1 and r["ing"].net_w == 350.0)
|
||||||
|
# ⚠️ str(asyncio.TimeoutError()) is the EMPTY STRING. Without the class-name
|
||||||
|
# fallback the status page reads "last error:" and then nothing, on a hung
|
||||||
|
# meter, at the moment someone is reading that line to find out why the battery
|
||||||
|
# went to 0 W.
|
||||||
|
check("a timed-out poll names the fault instead of logging an empty reason",
|
||||||
|
r["timeout"] is False and "TimeoutError" in (r["timeout_err"] or ""))
|
||||||
|
|
||||||
|
|
||||||
|
async def _submit_rejects(sess, port, meter):
|
||||||
|
"""submit() raising P1Error must be a rejection, not an escaping exception."""
|
||||||
|
class _P1Boom(P1Ingest):
|
||||||
|
def submit(self, sample):
|
||||||
|
raise P1Error("register went backwards")
|
||||||
|
|
||||||
|
ing = _P1Boom(phases=1, max_age_s=30.0)
|
||||||
|
src = HomeWizardLocalSource(sess, ing, "127.0.0.1", port=port, poll_s=1.0)
|
||||||
|
try:
|
||||||
|
ok = await src.poll_once()
|
||||||
|
except Exception as err: # noqa: BLE001 - an escape IS the failure
|
||||||
|
ok = err
|
||||||
|
return ok, ing.parse_errors
|
||||||
|
|
||||||
|
|
||||||
|
ok, errs = asyncio.run(_hw_rig(_submit_rejects))
|
||||||
|
check("a submit that rejects the sample is handled, not left to escape",
|
||||||
|
ok is False and errs == 1)
|
||||||
|
|
||||||
|
|
||||||
|
async def _submit_explodes(sess, port, meter):
|
||||||
|
"""And an UNEXPECTED raise must not kill the poll task for good."""
|
||||||
|
class _Boom(P1Ingest):
|
||||||
|
def submit(self, sample):
|
||||||
|
raise RuntimeError("kaboom")
|
||||||
|
|
||||||
|
src = HomeWizardLocalSource(sess, _Boom(phases=1, max_age_s=30.0),
|
||||||
|
"127.0.0.1", port=port, poll_s=0.05)
|
||||||
|
task = asyncio.create_task(src.run())
|
||||||
|
await asyncio.sleep(0.3)
|
||||||
|
alive = not task.done()
|
||||||
|
task.cancel()
|
||||||
|
# ⚠️ BaseException, and the same reason built() exists: if run() loses its
|
||||||
|
# guard the task is already dead HOLDING the RuntimeError, and awaiting it
|
||||||
|
# re-raises - aborting the whole suite with a traceback instead of reddening
|
||||||
|
# the check that names the rule. The death is what `alive` records; catching
|
||||||
|
# it here is bookkeeping, not leniency.
|
||||||
|
try:
|
||||||
|
await task
|
||||||
|
except BaseException: # noqa: BLE001
|
||||||
|
pass
|
||||||
|
return alive, src.polls
|
||||||
|
|
||||||
|
|
||||||
|
# ⚠️ The silent-death case. A dead poll task fails SAFE - the age climbs and the
|
||||||
|
# controller commands 0 W - but it looks exactly like a dead meter, so the
|
||||||
|
# operator spends the outage power-cycling hardware that was never at fault.
|
||||||
|
alive, polls = asyncio.run(_hw_rig(_submit_explodes))
|
||||||
|
check("a raise inside a poll does not permanently kill the polling task",
|
||||||
|
alive is True and polls > 1)
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
print("homewizard_local: selection by config")
|
||||||
|
|
||||||
|
check("homewizard_local is enabled", is_enabled({"meter_source": SOURCE_HOMEWIZARD}) is True)
|
||||||
|
sel = build_source({"meter_source": SOURCE_HOMEWIZARD, "p1_host": "192.168.2.250"},
|
||||||
|
P1Ingest(), None, None)
|
||||||
|
check("meter_source homewizard_local selects the polling transport",
|
||||||
|
isinstance(sel, HomeWizardLocalSource))
|
||||||
|
# ⚠️ getattr, not attribute access, for the same reason `built()` exists: a
|
||||||
|
# startup guard that goes wrong returns None here, and `None.url` would abort the
|
||||||
|
# suite with a traceback instead of reddening the check that names the rule.
|
||||||
|
check("...pointed at the meter's own local API on the default port",
|
||||||
|
getattr(sel, "url", None) == "http://192.168.2.250:80/api/v1/data")
|
||||||
|
check("the default cadence is the meter's own ~5 s update rate",
|
||||||
|
getattr(sel, "poll_s", None) == 5.0)
|
||||||
|
# ⚠️ The request must not outlive the poll interval: a backlog of queued requests
|
||||||
|
# behind a slow meter would land several arrivals for one measurement.
|
||||||
|
check("the request timeout is held under the poll interval",
|
||||||
|
getattr(sel, "timeout_s", 99) < getattr(sel, "poll_s", 0))
|
||||||
|
|
||||||
|
sel = build_source({"meter_source": SOURCE_HOMEWIZARD, "p1_host": "10.0.0.9:8080"},
|
||||||
|
P1Ingest(), None, None)
|
||||||
|
check("an explicit host:port is honoured, which is how the sim is reached",
|
||||||
|
getattr(sel, "url", None) == "http://10.0.0.9:8080/api/v1/data")
|
||||||
|
sel = build_source({"meter_source": SOURCE_HOMEWIZARD,
|
||||||
|
"p1_host": "http://192.168.2.250/"}, P1Ingest(), None, None)
|
||||||
|
check("a pasted browser URL still resolves to the right host",
|
||||||
|
getattr(sel, "url", None) == "http://192.168.2.250:80/api/v1/data")
|
||||||
|
|
||||||
|
# ⚠️ Caught once at startup, not once per poll - a source wired up wrong
|
||||||
|
# otherwise fails in the one way indistinguishable from a healthy one nobody has
|
||||||
|
# polled yet: no samples, a climbing age, the watchdog at 0 W, nothing in the log.
|
||||||
|
check("a blank p1_host is refused rather than silently never polling",
|
||||||
|
build_source({"meter_source": SOURCE_HOMEWIZARD, "p1_host": ""},
|
||||||
|
P1Ingest(), None, None) is None)
|
||||||
|
check("...and whitespace does not sneak past it",
|
||||||
|
build_source({"meter_source": SOURCE_HOMEWIZARD, "p1_host": " "},
|
||||||
|
P1Ingest(), None, None) is None)
|
||||||
|
check("an unparseable port is refused rather than guessed",
|
||||||
|
build_source({"meter_source": SOURCE_HOMEWIZARD, "p1_host": "meter:eighty"},
|
||||||
|
P1Ingest(), None, None) is None)
|
||||||
|
# ⚠️ The age can never be fresher than the poll interval, so a cadence at or past
|
||||||
|
# max_age_s means every reading is stale before its successor arrives: the
|
||||||
|
# controller would sit permanently on missing inputs while the meter is fine.
|
||||||
|
check("a poll cadence at meter_max_age_s is refused",
|
||||||
|
build_source({"meter_source": SOURCE_HOMEWIZARD, "p1_host": "m",
|
||||||
|
"meter_poll_s": 30}, P1Ingest(max_age_s=30), None, None) is None)
|
||||||
|
check("...and one past it too",
|
||||||
|
build_source({"meter_source": SOURCE_HOMEWIZARD, "p1_host": "m",
|
||||||
|
"meter_poll_s": 45}, P1Ingest(max_age_s=30), None, None) is None)
|
||||||
|
check("a cadence with headroom is accepted",
|
||||||
|
isinstance(build_source({"meter_source": SOURCE_HOMEWIZARD, "p1_host": "m",
|
||||||
|
"meter_poll_s": 5}, P1Ingest(max_age_s=30),
|
||||||
|
None, None), HomeWizardLocalSource))
|
||||||
|
check("a zero cadence is refused rather than spinning",
|
||||||
|
build_source({"meter_source": SOURCE_HOMEWIZARD, "p1_host": "m",
|
||||||
|
"meter_poll_s": 0}, P1Ingest(max_age_s=30), None, None) is None)
|
||||||
|
check("a non-numeric cadence is refused",
|
||||||
|
build_source({"meter_source": SOURCE_HOMEWIZARD, "p1_host": "m",
|
||||||
|
"meter_poll_s": "fast"}, P1Ingest(max_age_s=30), None, None) is None)
|
||||||
|
# The four modes must not bleed into each other.
|
||||||
|
check("ha_signed ignores p1_host and still selects the entity transport",
|
||||||
|
type(build_source({"meter_source": SOURCE_HA_SIGNED, "p1_net_entity": "sensor.n",
|
||||||
|
"p1_host": "192.168.2.250"}, P1Ingest(), None, None))
|
||||||
|
is HaSignedSource)
|
||||||
|
check("homewizard_local ignores p1_net_entity and needs its own host",
|
||||||
|
build_source({"meter_source": SOURCE_HOMEWIZARD,
|
||||||
|
"p1_net_entity": "sensor.n"}, P1Ingest(), None, None) is None)
|
||||||
|
|
||||||
# --------------------------------------------------------------------------- #
|
# --------------------------------------------------------------------------- #
|
||||||
print("the age sensor must not exist when P1 is off")
|
print("the age sensor must not exist when P1 is off")
|
||||||
# ⚠️ This is a fleet-wide regression guard, not a nicety. The ESP32 watchdog
|
# ⚠️ This is a fleet-wide regression guard, not a nicety. The ESP32 watchdog
|
||||||
@@ -556,7 +1299,6 @@ print("the age sensor must not exist when P1 is off")
|
|||||||
# age were published with meter_source off it would climb past 30 s on every
|
# age were published with meter_source off it would climb past 30 s on every
|
||||||
# existing install within half a minute and pin the inverter at 0 W forever.
|
# existing install within half a minute and pin the inverter at 0 W forever.
|
||||||
|
|
||||||
from app.p1 import is_enabled # noqa: E402
|
|
||||||
from app.mqtt import SENSORS, MqttPublisher # noqa: E402
|
from app.mqtt import SENSORS, MqttPublisher # noqa: E402
|
||||||
|
|
||||||
check("meter_source off is disabled", is_enabled({"meter_source": "off"}) is False)
|
check("meter_source off is disabled", is_enabled({"meter_source": "off"}) is False)
|
||||||
@@ -564,6 +1306,8 @@ check("a missing meter_source is disabled", is_enabled({}) is False)
|
|||||||
check("an empty meter_source is disabled", is_enabled({"meter_source": ""}) is False)
|
check("an empty meter_source is disabled", is_enabled({"meter_source": ""}) is False)
|
||||||
check("ha_dsmr is enabled", is_enabled({"meter_source": SOURCE_HA}) is True)
|
check("ha_dsmr is enabled", is_enabled({"meter_source": SOURCE_HA}) is True)
|
||||||
check("mqtt_p1 is enabled", is_enabled({"meter_source": SOURCE_MQTT}) is True)
|
check("mqtt_p1 is enabled", is_enabled({"meter_source": SOURCE_MQTT}) is True)
|
||||||
|
check("homewizard_local is enabled here too",
|
||||||
|
is_enabled({"meter_source": SOURCE_HOMEWIZARD}) is True)
|
||||||
|
|
||||||
# The entity id SAFETY-01's firmware subscribes to, pinned by object_id.
|
# The entity id SAFETY-01's firmware subscribes to, pinned by object_id.
|
||||||
row = [s for s in SENSORS if s[0] == "p1_age"]
|
row = [s for s in SENSORS if s[0] == "p1_age"]
|
||||||
@@ -602,6 +1346,17 @@ check("with P1 on the age sensor IS announced",
|
|||||||
from app.main import Controller # noqa: E402
|
from app.main import Controller # noqa: E402
|
||||||
|
|
||||||
|
|
||||||
|
def _never():
|
||||||
|
"""A stop Event these publish-only tests never set.
|
||||||
|
|
||||||
|
`stop` is a REQUIRED keyword argument (CFG-01): a Controller that cannot
|
||||||
|
stop itself used to be the default one, and on the late-refusal path that
|
||||||
|
meant a live process with no control loop and no exit. These cases only call
|
||||||
|
publish(), so any Event will do - but they may not skip it.
|
||||||
|
"""
|
||||||
|
return asyncio.Event()
|
||||||
|
|
||||||
|
|
||||||
class _Store:
|
class _Store:
|
||||||
data = {}
|
data = {}
|
||||||
|
|
||||||
@@ -624,18 +1379,80 @@ class _Pub:
|
|||||||
|
|
||||||
|
|
||||||
pub_off = _Pub()
|
pub_off = _Pub()
|
||||||
Controller({"meter_source": "off"}, None, _Store(), pub_off).publish()
|
Controller({"meter_source": "off"}, None, _Store(), pub_off, stop=_never()).publish()
|
||||||
check("with P1 off, p1_age is absent from the published payload",
|
check("with P1 off, p1_age is absent from the published payload",
|
||||||
"p1_age" not in pub_off.last)
|
"p1_age" not in pub_off.last)
|
||||||
check("...while the normal status keys are still published",
|
check("...while the normal status keys are still published",
|
||||||
"setpoint" in pub_off.last and "grid" in pub_off.last)
|
"setpoint" in pub_off.last and "grid" in pub_off.last)
|
||||||
|
|
||||||
pub_on = _Pub()
|
pub_on = _Pub()
|
||||||
Controller({"meter_source": SOURCE_HA}, None, _Store(), pub_on).publish()
|
Controller({"meter_source": SOURCE_HA}, None, _Store(), pub_on, stop=_never()).publish()
|
||||||
check("with P1 on, p1_age is published", "p1_age" in pub_on.last)
|
check("with P1 on, p1_age is published", "p1_age" in pub_on.last)
|
||||||
check("...as a number, so has_state() becomes true only once we feed it",
|
check("...as a number, so has_state() becomes true only once we feed it",
|
||||||
isinstance(pub_on.last["p1_age"], float))
|
isinstance(pub_on.last["p1_age"], float))
|
||||||
|
|
||||||
|
# ⚠️ And on ha_signed identically - this is the whole reason TEL-04 exists. The
|
||||||
|
# age sensor is a hard prerequisite for the FW-01 flash, and it has to appear on
|
||||||
|
# the transport that can actually read the meter in this house.
|
||||||
|
pub_sig = _Pub()
|
||||||
|
Controller({"meter_source": SOURCE_HA_SIGNED}, None, _Store(), pub_sig, stop=_never()).publish()
|
||||||
|
check("with ha_signed selected, p1_age is published too",
|
||||||
|
"p1_age" in pub_sig.last and isinstance(pub_sig.last["p1_age"], float))
|
||||||
|
|
||||||
|
# ⚠️ And on homewizard_local, where it is the one age FW-01 may actually
|
||||||
|
# threshold - every other transport's age measures when the VALUE changed.
|
||||||
|
pub_hw = _Pub()
|
||||||
|
Controller({"meter_source": SOURCE_HOMEWIZARD}, None, _Store(), pub_hw, stop=_never()).publish()
|
||||||
|
check("with homewizard_local selected, p1_age is published",
|
||||||
|
"p1_age" in pub_hw.last and isinstance(pub_hw.last["p1_age"], float))
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
print("unchanged_s has somewhere an operator can read it")
|
||||||
|
# ⚠️ The counter is deliberately NOT thresholded and NOT folded into the age -
|
||||||
|
# at the converged -10 W this controller aims for, a 1 Wh register needs six
|
||||||
|
# minutes to move, so any limit false-trips at the target operating point. That
|
||||||
|
# refusal only holds up if a HUMAN can interpret the number instead, and DOCS.md
|
||||||
|
# tells them "the transport tracks it as unchanged_s". Before this, nothing ever
|
||||||
|
# read the transport object back: connected, polls, poll_errors and unchanged_s
|
||||||
|
# were all write-only, and the documented signal existed nowhere an operator
|
||||||
|
# could see it.
|
||||||
|
|
||||||
|
|
||||||
|
def p1_rows(ctl):
|
||||||
|
"""The P1 status line(s), or the exception that stopped checks() making one.
|
||||||
|
|
||||||
|
Same reason as built(): a status line that raises would abort the suite with
|
||||||
|
a traceback instead of reddening the check that names the rule.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
return [c["text"] for c in ctl.checks() if c["text"].startswith("P1 meter")]
|
||||||
|
except Exception as err: # noqa: BLE001 - a raise here is itself the failure
|
||||||
|
print(f" checks() raised {type(err).__name__}: {err}")
|
||||||
|
return err
|
||||||
|
|
||||||
|
|
||||||
|
def _fed(source):
|
||||||
|
ctl = Controller({"meter_source": source}, None, _Store(), _Pub(), stop=_never())
|
||||||
|
ctl.p1.submit(make_sample(source, 350.0, 0.0, phases=1,
|
||||||
|
ingest_mono=time.monotonic()))
|
||||||
|
return ctl
|
||||||
|
|
||||||
|
|
||||||
|
hw_ctl = _fed(SOURCE_HOMEWIZARD)
|
||||||
|
hw_src = HomeWizardLocalSource(None, hw_ctl.p1, "127.0.0.1")
|
||||||
|
hw_src._note(hw_doc(350.0, l1=350.0))
|
||||||
|
hw_ctl.p1_source = hw_src # what amain() does once the transport exists
|
||||||
|
rows = p1_rows(hw_ctl)
|
||||||
|
check("the healthy P1 status line reports the transport's unchanged_s",
|
||||||
|
isinstance(rows, list) and len(rows) == 1 and "unchanged" in rows[0])
|
||||||
|
|
||||||
|
# ⚠️ getattr, not attribute access: p1_source is None until amain() builds one,
|
||||||
|
# and ha_dsmr/ha_signed/mqtt_p1 have no such counter at all. Reaching for it
|
||||||
|
# directly would turn the whole status page into a 500 on every other transport.
|
||||||
|
ha_rows = p1_rows(_fed(SOURCE_HA))
|
||||||
|
check("...and the line is unharmed on a transport that has no such counter",
|
||||||
|
isinstance(ha_rows, list) and len(ha_rows) == 1 and "unchanged" not in ha_rows[0])
|
||||||
|
|
||||||
print()
|
print()
|
||||||
if fails:
|
if fails:
|
||||||
print(f"{len(fails)} of {total} FAILED: {', '.join(fails)}")
|
print(f"{len(fails)} of {total} FAILED: {', '.join(fails)}")
|
||||||
|
|||||||
@@ -0,0 +1,318 @@
|
|||||||
|
"""Runnable check for the startup gate. `python3 test_validate.py`
|
||||||
|
|
||||||
|
Two halves, and the second is the one that matters. The first asserts that the
|
||||||
|
three refusable configurations are refused. The second asserts that everything
|
||||||
|
on validate.py's "deliberately not refused" list still STARTS - because the way
|
||||||
|
a validator dies is not by missing a fault, it is by refusing something harmless
|
||||||
|
until somebody deletes the call.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import asyncio
|
||||||
|
import sys
|
||||||
|
|
||||||
|
from app.validate import (
|
||||||
|
ACTUATOR_WRITE_KEYS, FIRMWARE_INGEST_VETO_S, ConfigRefused, refuse,
|
||||||
|
validate_startup_config,
|
||||||
|
)
|
||||||
|
|
||||||
|
fails = []
|
||||||
|
|
||||||
|
|
||||||
|
def check(name, cond):
|
||||||
|
print(f" {'ok ' if cond else 'FAIL'} {name}")
|
||||||
|
if not cond:
|
||||||
|
fails.append(name)
|
||||||
|
|
||||||
|
|
||||||
|
def base(**over):
|
||||||
|
"""A configuration that must start. Everything else is this, spoilt."""
|
||||||
|
o = {"setpoint_entity": "number.goodwe_setpoint", "max_w": 2000,
|
||||||
|
"soc_entity": "sensor.soc", "batt_entity": "sensor.batt",
|
||||||
|
"meter_source": "off"}
|
||||||
|
o.update(over)
|
||||||
|
return o
|
||||||
|
|
||||||
|
|
||||||
|
def why(problems, needle):
|
||||||
|
return any(needle in p for p in problems)
|
||||||
|
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
print("the baseline must start, or nothing below means anything")
|
||||||
|
check("a good config with a 5000 W device is accepted",
|
||||||
|
validate_startup_config(base(), -5000, 5000) == [])
|
||||||
|
check("...and with no device reachable yet, too",
|
||||||
|
validate_startup_config(base(), None, None) == [])
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
print("1. max_w against the device's own rating")
|
||||||
|
# ⚠️ THE ORIGINAL BUG. main.py used to log 'the device wins' and run anyway,
|
||||||
|
# with write_setpoint() clamping, so the configured ceiling was never the real
|
||||||
|
# one and the only evidence had scrolled off the log.
|
||||||
|
p = validate_startup_config(base(max_w=8000), -5000, 5000)
|
||||||
|
check("max_w above the device maximum is refused", len(p) == 1)
|
||||||
|
check("...and the message names the configured value", why(p, "8000"))
|
||||||
|
check("...and the device's value", why(p, "5000"))
|
||||||
|
check("...and says which one wins", why(p, "THE DEVICE WINS"))
|
||||||
|
check("max_w exactly at the device maximum is fine",
|
||||||
|
validate_startup_config(base(max_w=5000), -5000, 5000) == [])
|
||||||
|
check("max_w under it is fine",
|
||||||
|
validate_startup_config(base(max_w=2000), -5000, 5000) == [])
|
||||||
|
# The charge side is a separate rail and an asymmetric device is legal.
|
||||||
|
p = validate_startup_config(base(max_w=4000), -2500, 5000)
|
||||||
|
check("a max_w the device cannot take on the CHARGE side is refused too",
|
||||||
|
len(p) == 1 and why(p, "charge side"))
|
||||||
|
check("...naming the device's floor", why(p, "-2500"))
|
||||||
|
# ⚠️ Not guessed at: the entity may simply not have booted yet. run_control()
|
||||||
|
# re-runs this the moment the real rating arrives.
|
||||||
|
check("an unreachable device skips the range check rather than assuming",
|
||||||
|
validate_startup_config(base(max_w=8000), None, None) == [])
|
||||||
|
check("a non-numeric max_w is refused",
|
||||||
|
why(validate_startup_config(base(max_w="lots"), -5000, 5000), "not a number"))
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
print("2. an actuator to write to")
|
||||||
|
# A controller with no actuator: write_setpoint() returns on the blank entity,
|
||||||
|
# so no rating is read, no heartbeat is sent, layer 1 pins the inverter at 0 W,
|
||||||
|
# and the add-on looks perfectly healthy the whole time.
|
||||||
|
for blank in ("", " ", None):
|
||||||
|
p = validate_startup_config(base(setpoint_entity=blank), None, None)
|
||||||
|
check(f"setpoint_entity {blank!r} is refused", len(p) == 1)
|
||||||
|
check("...and the message says why it is dangerous rather than untidy",
|
||||||
|
why(validate_startup_config(base(setpoint_entity=""), None, None),
|
||||||
|
"heartbeat"))
|
||||||
|
# specs §1.5: two writers on one actuator is not expressible in this schema.
|
||||||
|
check("there is exactly one way to reach the actuator",
|
||||||
|
ACTUATOR_WRITE_KEYS == ("setpoint_entity",))
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
print("3. a meter that can never read")
|
||||||
|
# ⚠️ These predicates belong to p1.validate_meter_options(), which build_source()
|
||||||
|
# also uses. Asserted here to prove the gate actually consults it - one entry
|
||||||
|
# point, not two.
|
||||||
|
check("meter_source off asks nothing of the P1 keys",
|
||||||
|
validate_startup_config(base(meter_source="off"), -5000, 5000) == [])
|
||||||
|
check("homewizard_local with no p1_host is refused",
|
||||||
|
why(validate_startup_config(base(meter_source="homewizard_local"),
|
||||||
|
-5000, 5000), "p1_host"))
|
||||||
|
check("...and with a host it is accepted",
|
||||||
|
validate_startup_config(base(meter_source="homewizard_local",
|
||||||
|
p1_host="192.168.2.250"), -5000, 5000) == [])
|
||||||
|
check("a poll cadence at meter_max_age_s is refused at STARTUP, not just disabled",
|
||||||
|
why(validate_startup_config(base(meter_source="homewizard_local",
|
||||||
|
p1_host="m", meter_poll_s=30,
|
||||||
|
meter_max_age_s=30), -5000, 5000),
|
||||||
|
"meter_max_age_s"))
|
||||||
|
check("ha_signed with no p1_net_entity is refused",
|
||||||
|
why(validate_startup_config(base(meter_source="ha_signed"), -5000, 5000),
|
||||||
|
"p1_net_entity"))
|
||||||
|
check("a phase list disagreeing with meter_phases is refused",
|
||||||
|
why(validate_startup_config(base(meter_source="ha_signed",
|
||||||
|
p1_net_entity="sensor.n", meter_phases=3,
|
||||||
|
p1_phase_net_entities=["a", "b"]),
|
||||||
|
-5000, 5000), "phase-count"))
|
||||||
|
check("mqtt_p1 with no topic is refused",
|
||||||
|
why(validate_startup_config(base(meter_source="mqtt_p1"), -5000, 5000),
|
||||||
|
"meter_mqtt_topic"))
|
||||||
|
check("ha_dsmr with only half its entities is refused",
|
||||||
|
why(validate_startup_config(base(meter_source="ha_dsmr",
|
||||||
|
p1_import_entity="sensor.i"), -5000, 5000),
|
||||||
|
"p1_export_entity"))
|
||||||
|
check("a misspelt meter_source is refused rather than silently ignored",
|
||||||
|
why(validate_startup_config(base(meter_source="ha_signd"), -5000, 5000),
|
||||||
|
"is not one of"))
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
print("4. meter_max_age_s against the firmware's compile-time veto")
|
||||||
|
# ⚠️ The schema allows int(5,300); the firmware's threshold is baked in at 30 s
|
||||||
|
# and wins silently. Same shape as the max_w case: a configured bound overridden
|
||||||
|
# by a lower layer, with nothing saying so.
|
||||||
|
hw = dict(meter_source="homewizard_local", p1_host="m")
|
||||||
|
p = validate_startup_config(base(**hw, meter_max_age_s=120), -5000, 5000)
|
||||||
|
check("a meter_max_age_s above the firmware veto is refused", len(p) == 1)
|
||||||
|
check("...naming the configured value", why(p, "120"))
|
||||||
|
check("...naming the firmware's value", why(p, "30"))
|
||||||
|
check("...and saying which one wins", why(p, "THE FIRMWARE WINS"))
|
||||||
|
check("the tested pair 30/30 is accepted",
|
||||||
|
validate_startup_config(base(**hw, meter_max_age_s=30), -5000, 5000) == [])
|
||||||
|
check("one second above it is refused",
|
||||||
|
validate_startup_config(base(**hw, meter_max_age_s=31), -5000, 5000) != [])
|
||||||
|
# Below the veto the add-on gives up FIRST, which is fail-safe and visible on
|
||||||
|
# its own status page. Only above is the silent case.
|
||||||
|
check("below the veto is fine - the add-on being stricter is not a conflict",
|
||||||
|
validate_startup_config(base(**hw, meter_max_age_s=10,
|
||||||
|
meter_poll_s=4), -5000, 5000) == [])
|
||||||
|
# ⚠️ Scope: meter_max_age_s is read by nothing but P1Ingest, and the veto keys
|
||||||
|
# off a sensor only published when ingestion runs. With the meter off it governs
|
||||||
|
# nothing, so refusing would be pure trivia.
|
||||||
|
check("with meter_source off the number governs nothing and is not refused",
|
||||||
|
validate_startup_config(base(meter_source="off", meter_max_age_s=300),
|
||||||
|
-5000, 5000) == [])
|
||||||
|
check("the constant is the firmware's, not a rounded guess",
|
||||||
|
FIRMWARE_INGEST_VETO_S == 30.0)
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
print("max_w must be a positive magnitude")
|
||||||
|
# Schema-blocked on a real install, but validate_startup_config() is also
|
||||||
|
# sim/inject.py's entry point and can be handed any dict at all.
|
||||||
|
for bad in (0, -1, -2000):
|
||||||
|
p = validate_startup_config(base(max_w=bad), -5000, 5000)
|
||||||
|
check(f"max_w {bad} is refused", len(p) == 1 and why(p, "must be positive"))
|
||||||
|
check("...and the message explains it would read as a trip, not a mistake",
|
||||||
|
why(validate_startup_config(base(max_w=0), -5000, 5000), "contradiction"))
|
||||||
|
# ⚠️ SAFETY-02 changed what this case has to say, and the change is real rather
|
||||||
|
# than bookkeeping: with a 1 W ceiling the default 300 W sign-disagreement
|
||||||
|
# threshold is unreachable, so rule 5 refuses - correctly, because the watchdog
|
||||||
|
# would report itself armed while being incapable of firing. What this check is
|
||||||
|
# FOR is "a positive max_w is not itself a refusal", so it now names a sign
|
||||||
|
# threshold the ceiling can actually reach, and the interaction gets its own
|
||||||
|
# check below.
|
||||||
|
check("the smallest sane max_w still starts",
|
||||||
|
validate_startup_config(base(max_w=1, sign_disagree_w=0.5), -5000, 5000) == [])
|
||||||
|
check("...but that same 1 W ceiling with the DEFAULT sign threshold is refused",
|
||||||
|
why(validate_startup_config(base(max_w=1), -5000, 5000), "never fire"))
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
print("what must NOT be refused - a validator that fires on trivia gets deleted")
|
||||||
|
# DOCS.md: the arbiter's `supervised` limit still binds the wire to +-max_w, so
|
||||||
|
# the only cost of the extra headroom is unwind latency after saturation.
|
||||||
|
check("integrator_max_w above max_w warns but starts",
|
||||||
|
validate_startup_config(base(max_w=2000, integrator_max_w=9000),
|
||||||
|
-5000, 5000) == [])
|
||||||
|
check("integrator_max_w 0 (follow max_w) starts",
|
||||||
|
validate_startup_config(base(integrator_max_w=0), -5000, 5000) == [])
|
||||||
|
# Fail-safe AND already a red NOT READY banner naming the entity: a refusal on
|
||||||
|
# top of that adds nothing an operator can act on.
|
||||||
|
check("a missing soc_entity is left to the readiness banner",
|
||||||
|
validate_startup_config(base(soc_entity=""), -5000, 5000) == [])
|
||||||
|
check("a missing batt_entity likewise",
|
||||||
|
validate_startup_config(base(batt_entity=""), -5000, 5000) == [])
|
||||||
|
# The transient case. ESPHome is routinely not up when the add-on boots, and
|
||||||
|
# refusing here would turn a device that arrives late into a restart loop.
|
||||||
|
check("a setpoint entity that is configured but not yet found starts",
|
||||||
|
validate_startup_config(base(), None, None) == [])
|
||||||
|
check("meter_poll_s with thin but non-zero headroom starts",
|
||||||
|
validate_startup_config(base(meter_source="homewizard_local", p1_host="m",
|
||||||
|
meter_poll_s=20, meter_max_age_s=30),
|
||||||
|
-5000, 5000) == [])
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
print("the refusal must be legible as a refusal, not as a crash")
|
||||||
|
p = validate_startup_config(base(max_w=8000, setpoint_entity=""), -5000, 5000)
|
||||||
|
check("several problems are all reported, not just the first", len(p) >= 1)
|
||||||
|
refuse(p) # prints the banner; the eye is the assertion for its wording
|
||||||
|
err = ConfigRefused(p)
|
||||||
|
check("ConfigRefused carries every problem", err.problems == p)
|
||||||
|
check("...and str() names one of them", str(err) == p[0])
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
print("the LATE refusal, when the device only shows up after the gate has run")
|
||||||
|
# ⚠️ This path had no test at all and no live demonstration - the review's
|
||||||
|
# catch. ESPHome is routinely not up when the add-on boots, so hass.limits()
|
||||||
|
# returns (None, None), the range checks are skipped, and run_control() is the
|
||||||
|
# first place the device's real rating is ever known. Everything below is about
|
||||||
|
# what happens when it turns out to conflict.
|
||||||
|
from app.main import Controller # noqa: E402
|
||||||
|
|
||||||
|
|
||||||
|
class _LateHass:
|
||||||
|
"""Reports the range only run_control() gets to see."""
|
||||||
|
|
||||||
|
def __init__(self, lo, hi):
|
||||||
|
self.lo, self.hi = lo, hi
|
||||||
|
self.writes = []
|
||||||
|
|
||||||
|
async def limits(self, entity):
|
||||||
|
return (self.lo, self.hi, 1.0)
|
||||||
|
|
||||||
|
async def number(self, *a, **k):
|
||||||
|
return 0.0
|
||||||
|
|
||||||
|
async def set_number(self, entity, value):
|
||||||
|
self.writes.append(value)
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
|
class _Store2:
|
||||||
|
data = {}
|
||||||
|
|
||||||
|
def set(self, *a):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
class _Pub2:
|
||||||
|
enabled = False
|
||||||
|
|
||||||
|
def publish(self, *a, **k):
|
||||||
|
pass
|
||||||
|
|
||||||
|
def close(self):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
def late(opts_over, lo, hi):
|
||||||
|
"""Drive run_control() against a device that only reports (lo, hi) now.
|
||||||
|
|
||||||
|
⚠️ Returns whether run_control() EXITED ON ITS OWN. That is the assertion
|
||||||
|
that matters: on a refusal it must return without entering the while loop,
|
||||||
|
and on a clean config it must not return at all. So the clean case is stopped
|
||||||
|
from outside after it has had time to write, rather than waited on - a
|
||||||
|
wait_for() here would just time out, which is the correct behaviour dressed
|
||||||
|
up as a failure.
|
||||||
|
"""
|
||||||
|
async def go():
|
||||||
|
stop = asyncio.Event()
|
||||||
|
hass = _LateHass(lo, hi)
|
||||||
|
# A device narrower than the shipped 5000 W schema ceiling is exactly
|
||||||
|
# the case that cannot be reached through the Supervisor on the live
|
||||||
|
# install, so it is reached here instead.
|
||||||
|
c = Controller(base(**opts_over), hass, _Store2(), _Pub2(), stop=stop)
|
||||||
|
c.auto = True
|
||||||
|
task = asyncio.create_task(c.run_control())
|
||||||
|
for _ in range(30): # up to ~3 s
|
||||||
|
if task.done():
|
||||||
|
break
|
||||||
|
await asyncio.sleep(0.1)
|
||||||
|
exited = task.done()
|
||||||
|
if not exited:
|
||||||
|
c.stopping = True
|
||||||
|
await asyncio.wait_for(task, timeout=5)
|
||||||
|
return c, stop, hass, exited
|
||||||
|
return asyncio.run(go())
|
||||||
|
|
||||||
|
c, stop, hass, exited = late({"max_w": 5000}, -3600.0, 3600.0)
|
||||||
|
check("a device narrower than max_w, discovered late, is refused",
|
||||||
|
c.refused is not None and len(c.refused) == 1)
|
||||||
|
check("...naming both values", why(c.refused, "5000") and why(c.refused, "3600"))
|
||||||
|
check("...signalling amain to wind down", stop.is_set())
|
||||||
|
check("...and returning instead of looping forever", exited)
|
||||||
|
# The whole point: run_control() must not fall through into the while loop. A
|
||||||
|
# single write here would mean it commanded the inverter under a config it had
|
||||||
|
# just declared unusable.
|
||||||
|
check("...having never entered the control loop, so it wrote nothing",
|
||||||
|
hass.writes == [])
|
||||||
|
check("...and it is recorded in the event log an operator reads",
|
||||||
|
any("REFUSED" in e for e in c.events))
|
||||||
|
|
||||||
|
# The same path when there is no conflict: it must NOT refuse, and it must
|
||||||
|
# actually regulate - asserted by a write reaching the device, not by absence.
|
||||||
|
c2, stop2, hass2, exited2 = late({"max_w": 2000}, -5000.0, 5000.0)
|
||||||
|
check("a late device that agrees does not trip the re-check", c2.refused is None)
|
||||||
|
check("...and the control loop runs, writing to the device", hass2.writes != [])
|
||||||
|
check("...and does not signal a shutdown", not stop2.is_set() and not exited2)
|
||||||
|
|
||||||
|
# ⚠️ THE FOOTGUN THE REVIEW FOUND. `stop` used to default to None, so this
|
||||||
|
# construction was legal and the refusal path then returned into a live process
|
||||||
|
# with no control loop, no exit and no further output.
|
||||||
|
try:
|
||||||
|
Controller(base(), _LateHass(-5000.0, 5000.0), _Store2(), _Pub2())
|
||||||
|
check("a Controller with no stop Event is rejected at construction", False)
|
||||||
|
except TypeError:
|
||||||
|
check("a Controller with no stop Event is rejected at construction", True)
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
print()
|
||||||
|
if fails:
|
||||||
|
print(f"{len(fails)} FAILED: " + "; ".join(fails))
|
||||||
|
sys.exit(1)
|
||||||
|
print("all checks passed")
|
||||||
@@ -0,0 +1,248 @@
|
|||||||
|
"""Runnable check for the sign-disagreement watchdog. `python3 test_watchdog.py`
|
||||||
|
|
||||||
|
Every case here is either a fault this must catch or a piece of NORMAL behaviour
|
||||||
|
it must not mistake for one. The second list is the longer one on purpose: an
|
||||||
|
alarm that fires on ordinary operation is worse than no alarm, because the next
|
||||||
|
person switches it off.
|
||||||
|
|
||||||
|
The headline validation is not here - it is `sim/replay_sign.py` in the infra
|
||||||
|
repo, which drives this module over the two captured bus days. This file is the
|
||||||
|
table-driven half: boundaries, timers, the latch, and the arming gate.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import sys
|
||||||
|
from datetime import datetime, timedelta, timezone
|
||||||
|
|
||||||
|
from app.watchdog import SignWatchdog, SignWatchdogConfig
|
||||||
|
|
||||||
|
fails = []
|
||||||
|
T0 = datetime(2026, 8, 20, 15, 0, 0, tzinfo=timezone.utc)
|
||||||
|
|
||||||
|
|
||||||
|
def check(name, cond):
|
||||||
|
print(f" {'ok ' if cond else 'FAIL'} {name}")
|
||||||
|
if not cond:
|
||||||
|
fails.append(name)
|
||||||
|
|
||||||
|
|
||||||
|
def drive(samples, cfg=None, following=True):
|
||||||
|
"""Feed (offset_s, commanded_w, grid_w) tuples. Returns (wd, trip_offset)."""
|
||||||
|
wd = SignWatchdog(cfg)
|
||||||
|
trip_at = None
|
||||||
|
for item in samples:
|
||||||
|
offset, cmd, grid = item[0], item[1], item[2]
|
||||||
|
f = item[3] if len(item) > 3 else following
|
||||||
|
if wd.evaluate(cmd, grid, f, T0 + timedelta(seconds=offset)) and trip_at is None:
|
||||||
|
trip_at = offset
|
||||||
|
return wd, trip_at
|
||||||
|
|
||||||
|
|
||||||
|
def opposed(duration_s, step=5, cmd=-1000, grid=1500, following=True, start=0):
|
||||||
|
return [(start + t, cmd, grid, following)
|
||||||
|
for t in range(0, int(duration_s) + 1, step)]
|
||||||
|
|
||||||
|
|
||||||
|
print("the fault it exists to catch")
|
||||||
|
wd, at = drive(opposed(300))
|
||||||
|
check("charging into an importing house trips", wd.tripped)
|
||||||
|
check("and trips at 180 s, not before", at == 180)
|
||||||
|
check("the reason names both signals", "-1000" in wd.reason and "+1500" in wd.reason)
|
||||||
|
print(f" e.g. {wd.reason!r}")
|
||||||
|
|
||||||
|
wd, at = drive(opposed(300, cmd=2000, grid=-2000))
|
||||||
|
check("discharging into an exporting house trips too", wd.tripped and at == 180)
|
||||||
|
|
||||||
|
print()
|
||||||
|
print("the boundaries")
|
||||||
|
wd, _ = drive(opposed(600, cmd=-300, grid=1500))
|
||||||
|
check("300 W exactly does NOT qualify (strictly greater)", not wd.tripped)
|
||||||
|
wd, _ = drive(opposed(600, cmd=-301, grid=1500))
|
||||||
|
check("301 W does", wd.tripped)
|
||||||
|
wd, _ = drive(opposed(600, cmd=-1000, grid=300))
|
||||||
|
check("a 300 W meter does not qualify either", not wd.tripped)
|
||||||
|
wd, _ = drive(opposed(175))
|
||||||
|
check("175 s of disagreement does not trip", not wd.tripped)
|
||||||
|
wd, _ = drive(opposed(180))
|
||||||
|
check("180 s does (>= hold_s)", wd.tripped)
|
||||||
|
|
||||||
|
print()
|
||||||
|
print("continuity - the rule that produced zero false positives on real data")
|
||||||
|
broken = opposed(175) + [(180, -1000, -1500)] + opposed(175, start=185)
|
||||||
|
wd, _ = drive(broken)
|
||||||
|
check("179 s, one agreeing sample, then 175 s more: no trip", not wd.tripped)
|
||||||
|
check("and the window really was reset", wd.disagree_since is not None)
|
||||||
|
long_enough = broken + opposed(200, start=365)
|
||||||
|
wd, _ = drive(long_enough)
|
||||||
|
check("but a full 180 s after the reset does trip", wd.tripped)
|
||||||
|
|
||||||
|
print()
|
||||||
|
print("things that are NOT faults")
|
||||||
|
# The load-step transient. Measured on the healthy capture: longest 30 s.
|
||||||
|
wd, _ = drive(opposed(30) + [(35 + t, 800, 900) for t in range(0, 300, 5)])
|
||||||
|
check("a 30 s load-step crossover does not trip", not wd.tripped)
|
||||||
|
|
||||||
|
# SoC 10 %, Standby, declining a 1350 W discharge. The battery does nothing, so
|
||||||
|
# the meter stays where it was and the command agrees with it.
|
||||||
|
wd, _ = drive([(t, 1350, 1350) for t in range(0, 900, 5)])
|
||||||
|
check("a battery refusing a discharge command cannot trip it", not wd.tripped)
|
||||||
|
|
||||||
|
# A frozen meter drives command and reading into agreement, not disagreement.
|
||||||
|
wd, _ = drive([(t, 800, 800) for t in range(0, 900, 5)])
|
||||||
|
check("a frozen meter cannot trip it", not wd.tripped)
|
||||||
|
|
||||||
|
# Maintenance grid charge: 2500 W of charge against an importing house, for
|
||||||
|
# hours. Opposed, both huge - and entirely correct.
|
||||||
|
wd, _ = drive(opposed(7200, cmd=-2500, grid=3000, following=False))
|
||||||
|
check("two hours of maintenance grid charge does not trip", not wd.tripped)
|
||||||
|
check("and the timer never even started", wd.disagree_since is None)
|
||||||
|
|
||||||
|
wd, _ = drive([(t, -1000, None) for t in range(0, 900, 5)])
|
||||||
|
check("a missing meter reading does not trip", not wd.tripped)
|
||||||
|
wd, _ = drive(opposed(175) + [(180, -1000, None)] + opposed(600, start=185))
|
||||||
|
check("a missing reading mid-window RESETS it rather than accumulating",
|
||||||
|
wd.tripped and wd.disagree_since is not None)
|
||||||
|
wd, at = drive(opposed(175) + [(180, -1000, None)] + opposed(600, start=185))
|
||||||
|
check("...so the trip lands 180 s after the gap, not after 180 s total",
|
||||||
|
at == 365)
|
||||||
|
|
||||||
|
wd, _ = drive([(t, 0.0, 3000) for t in range(0, 900, 5)])
|
||||||
|
check("a 0 W command is not a wrong-direction command", not wd.tripped)
|
||||||
|
|
||||||
|
print()
|
||||||
|
print("the latch")
|
||||||
|
wd, _ = drive(opposed(200))
|
||||||
|
check("tripped after the fault", wd.tripped)
|
||||||
|
# The trip commands 0 W, which removes the command side of the comparison.
|
||||||
|
for t in range(200, 900, 5):
|
||||||
|
wd.evaluate(0.0, 3000, True, T0 + timedelta(seconds=t))
|
||||||
|
check("stays tripped once the command is zeroed", wd.tripped)
|
||||||
|
for t in range(900, 1500, 5):
|
||||||
|
wd.evaluate(1000, 1000, True, T0 + timedelta(seconds=t))
|
||||||
|
check("stays tripped even once everything looks healthy again", wd.tripped)
|
||||||
|
wd.reset()
|
||||||
|
check("reset() is the only way out", not wd.tripped and wd.disagree_since is None)
|
||||||
|
check("and the reason is cleared with it", wd.reason == "")
|
||||||
|
|
||||||
|
print()
|
||||||
|
print("the thresholds are configuration, not constants")
|
||||||
|
cfg = SignWatchdogConfig(min_w=800.0, hold_s=60.0)
|
||||||
|
wd, at = drive(opposed(300, cmd=-1000, grid=1500), cfg=cfg)
|
||||||
|
check("a 60 s hold trips at 60 s", wd.tripped and at == 60)
|
||||||
|
wd, _ = drive(opposed(600, cmd=-700, grid=1500), cfg=cfg)
|
||||||
|
check("an 800 W gate ignores a 700 W command", not wd.tripped)
|
||||||
|
|
||||||
|
print()
|
||||||
|
print("the configuration that would disarm it is refused")
|
||||||
|
from app.validate import validate_startup_config # noqa: E402
|
||||||
|
|
||||||
|
base = {"setpoint_entity": "number.sp", "meter_source": "off",
|
||||||
|
"meter_phases": 1, "meter_max_age_s": 30}
|
||||||
|
p = validate_startup_config({**base, "max_w": 2000, "sign_disagree_w": 300},
|
||||||
|
-5000, 5000)
|
||||||
|
check("300 W under a 2000 W ceiling is accepted", p == [])
|
||||||
|
p = validate_startup_config({**base, "max_w": 2000, "sign_disagree_w": 2000},
|
||||||
|
-5000, 5000)
|
||||||
|
check("a threshold AT max_w is refused", len(p) == 1 and "never fire" in p[0])
|
||||||
|
p = validate_startup_config({**base, "max_w": 500, "sign_disagree_w": 3000},
|
||||||
|
-5000, 5000)
|
||||||
|
check("a threshold above max_w is refused", len(p) == 1 and "never fire" in p[0])
|
||||||
|
p = validate_startup_config({**base, "max_w": 2000, "sign_disagree_w": 1999},
|
||||||
|
-5000, 5000)
|
||||||
|
check("one watt under the ceiling is reachable, so accepted", p == [])
|
||||||
|
|
||||||
|
print()
|
||||||
|
print("end to end: the trip is COMMAND ZERO, not alarm-only")
|
||||||
|
# ⚠️ THE FAULT INJECTED HERE IS A NEGATIVE GAIN, and that is not a contrivance -
|
||||||
|
# it is the minimal faithful model of what this watchdog is for. The check
|
||||||
|
# compares the loop's OUTPUT DIRECTION against the INPUT STATE it was regulating,
|
||||||
|
# so what it detects is a loop whose two ends have become decoupled in sign: a
|
||||||
|
# gain, a claim or a strategy with its polarity inverted, or an integrator so far
|
||||||
|
# wound up that unwinding takes minutes. (Illusmart's was the last one: it
|
||||||
|
# reached -14 768 W against a +-5000 W rail while writing once every 20-60 s, and
|
||||||
|
# that arithmetic alone is 5-15 minutes of wrong-direction command.)
|
||||||
|
#
|
||||||
|
# `gain` is float(0.05,1.0) in the schema, so this is not a reachable
|
||||||
|
# configuration - it is a stand-in for a code regression, which is the case a
|
||||||
|
# unit test can actually hold the line on.
|
||||||
|
import asyncio # noqa: E402
|
||||||
|
|
||||||
|
from app.main import Controller # noqa: E402
|
||||||
|
|
||||||
|
|
||||||
|
class _Hass:
|
||||||
|
def __init__(self):
|
||||||
|
self.writes = []
|
||||||
|
|
||||||
|
async def limits(self, entity):
|
||||||
|
return (-5000.0, 5000.0, 1.0)
|
||||||
|
|
||||||
|
async def number(self, entity, invert=False):
|
||||||
|
# A house importing 2000 W, steadily, whatever the battery does.
|
||||||
|
return {"sensor.grid": 2000.0, "sensor.soc": 50.0,
|
||||||
|
"sensor.batt": 0.0}.get(entity)
|
||||||
|
|
||||||
|
async def set_number(self, entity, value):
|
||||||
|
self.writes.append(float(value))
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
|
class _S:
|
||||||
|
data = {}
|
||||||
|
|
||||||
|
def set(self, *a):
|
||||||
|
pass
|
||||||
|
|
||||||
|
def get_time(self, *a):
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
class _P:
|
||||||
|
enabled = False
|
||||||
|
|
||||||
|
def publish(self, *a, **k):
|
||||||
|
pass
|
||||||
|
|
||||||
|
def close(self):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
async def _e2e():
|
||||||
|
hass = _Hass()
|
||||||
|
opts = {"setpoint_entity": "number.sp", "meter_entity": "sensor.grid",
|
||||||
|
"soc_entity": "sensor.soc", "batt_entity": "sensor.batt",
|
||||||
|
"meter_source": "off", "max_w": 2000, "gain": -0.6,
|
||||||
|
"sign_disagree_w": 300, "sign_disagree_s": 1, "auto_start": True}
|
||||||
|
c = Controller(opts, hass, _S(), _P(), stop=asyncio.Event())
|
||||||
|
c.auto = True
|
||||||
|
c.dev_min, c.dev_max = -5000.0, 5000.0
|
||||||
|
seen_wrong_way = False
|
||||||
|
for _ in range(12):
|
||||||
|
await c.read_inputs()
|
||||||
|
await c.cycle()
|
||||||
|
if c.target < -300 and not c.sign_wd.tripped:
|
||||||
|
seen_wrong_way = True
|
||||||
|
await asyncio.sleep(0.25)
|
||||||
|
return c, hass, seen_wrong_way
|
||||||
|
|
||||||
|
|
||||||
|
ctrl, hass, wrong_way = asyncio.run(_e2e())
|
||||||
|
check("the broken loop really did command charge into an import first", wrong_way)
|
||||||
|
check("the watchdog tripped", ctrl.sign_wd.tripped)
|
||||||
|
check("the commanded value is 0 W", ctrl.target == 0.0)
|
||||||
|
check("0 W actually reached the device", 0.0 in hass.writes)
|
||||||
|
check("and it got there through the failsafe claim, not by accident",
|
||||||
|
"failsafe" in ctrl.reason)
|
||||||
|
print(f" status line: {ctrl.reason!r}")
|
||||||
|
check("the status page says so in words",
|
||||||
|
any("SIGN-DISAGREEMENT FAILSAFE" in c["text"] for c in ctrl.checks()))
|
||||||
|
check("the banner leads with it",
|
||||||
|
"FAILSAFE" in ctrl.status_payload()["banner"])
|
||||||
|
check("MQTT reports the failsafe state", ctrl.sign_wd.tripped)
|
||||||
|
check("it stays at 0 W on later cycles too",
|
||||||
|
hass.writes[-1] == 0.0 and hass.writes.count(0.0) >= 1)
|
||||||
|
|
||||||
|
print()
|
||||||
|
if fails:
|
||||||
|
print(f"{len(fails)} FAILED: {', '.join(fails)}")
|
||||||
|
sys.exit(1)
|
||||||
|
print("all checks passed")
|
||||||
Reference in New Issue
Block a user