SAFETY-10: the whole decision path runs and nothing reaches the inverter
checks / unit (pull_request) Successful in 7m58s

Every optimiser defect this project has found was invisible from outside
while it was happening, and each was paid for at the meter first: SAFETY-45's
28 charge onsets an hour against a binding peak_cap_w, TARIFF-14's wrong
quarter-hour for 45 minutes in every 60, SAFETY-46's 598 Wh spent to gain
310 Wh. There was no way to watch what the optimiser WOULD do without letting
it do it.

`shadow_mode` runs strategies, arbiter, clamps and guards, records the
decision with its reason, and commands nothing.

⚠️ IT WRITES. It writes 0 W, on the ordinary heartbeat, through the ordinary
single writer. The inverter holds its last command forever - it has no meter
timeout - so "commands nothing" implemented as "stops writing" would leave
whatever was standing when shadow mode came on standing for as long as it was
left on, under a page saying nothing is being commanded. That is the failure
this repository keeps finding. Refreshing 0 W is also what
firmware/goodwe-master.yaml's 30 s stale-input watchdog requires of us; going
quiet would keep that board tripped for the whole run, which is an alarm being
used as a mode.

⚠️ IT IS NOT A SECOND WRITE PATH. No claim, no transport, no arithmetic of its
own. It is a substitution inside Controller._write_unit() - the single choke
point every write already reaches - in the same form as the three above it,
and it is the LAST of them, so SAFETY-28's gate and SAFETY-03's clamp still
grade the number the decision path produced.

⚠️ THE DEFAULT IS `auto`, NOT `true`, AND THAT IS THE CARD'S REAL CONTENT. The
Supervisor composes options as {**config.yaml defaults, **stored user
options}, so a new key with a new default reaches EVERY EXISTING INSTALL on
the next update - including the one regulating a real battery. A boolean
default-on would have stopped it silently. There is no mechanism by which one
key can default differently for a new install and an existing one, so
"default-on for new" is a value the add-on RESOLVES: `auto` is shadow while
control is STOPPED and live once it is STARTED. A fresh install ships
`auto_start: false` and comes up observing; an install that is controlling is
started and does not change by one watt.

THE FAILSAFES. Sign watchdogs (SAFETY-02/30): INERT - they grade
Inverter.standing_w(), which shadow mode holds at 0 W. Fed the shadow decision
they would disagree with a meter that never saw it and LATCH A TRIP THAT
SURVIVES INTO LIVE OPERATION AND A RESTART. Clamp (SAFETY-03), write gate
(SAFETY-28), meter freeze (SAFETY-18), peak guard: OBSERVE. Circulation
(SAFETY-31) and delivery (SAFETY-42): observe and may legitimately latch,
because their evidence is measured power. The operator stop is the one
deliberate change: enforced at the wire rather than as a P_SAFETY claim, which
would otherwise make every recorded decision read "stopped".

⚠️ RECORDED LIMITATION: _shadow_settle() re-seeds the carried command to what
stands on the wire, which makes the exit safe by construction - and therefore
the loop leg's shadow decision is ONE SLEW STEP, not a trajectory. A shadow
run answers "what would it command now", not "what would it have done next".
The strategies are unaffected; all three defects above are visible from one.

Graded on the writes and on the rendered surface, never on the flag: 22
mutations, no survivors, including one that lets a write escape and one that
goes silent instead of commanding 0 W. Closed loop on TEST-23 stage 3's rig,
same hour twice: live drives the pack to -2000 W and SoC 50.000 -> 62.331 %;
shadow commands 0 W throughout, SoC stays 50.0 exactly, and the arbitrage
decision is identical in action, instant, signed power, reason and arbiter
winner.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BwRLw7eKYj2byVdwB6kbjU
This commit is contained in:
Claude
2026-09-14 17:25:43 +02:00
parent 8f82dd4e06
commit 8fa4febfef
13 changed files with 1767 additions and 7 deletions
+253 -3
View File
@@ -66,6 +66,7 @@ from .mqtt import (MqttPublisher, announced_units, unit_slugs,
unit_state_key)
from . import peakguard
from . import packshare
from . import shadow
from .p1 import P1Ingest, build_source, is_enabled
from .price import Uncertainty, price_option, provider_configured
from .price_history import PriceHistory
@@ -830,6 +831,24 @@ class Controller:
# live state
self.auto = bool(store.data.get("auto", opts.get("auto_start", False)))
# --- SAFETY-10 -------------------------------------------------------
# What the decision path reached on the last shadow cycle, in W, or
# None before the first one. ⚠️ IT IS KEPT SEPARATELY FROM
# `self.target` BECAUSE THEY ARE DIFFERENT FACTS: `self.target` is what
# is STANDING ON THE WIRE - held at `shadow.WIRE_W` for the whole of a
# shadow run, and re-seeded to it at the end of every shadow cycle so
# the loop and the sign watchdogs track reality - and this is what a
# live controller WOULD have put there. Folding them into one field is
# how a shadow run starts telling an operator a number nothing is
# doing.
self.shadow_would_w = None
# Edge state for the action log, both of them. `_shadow_was` is None
# until the first cycle, so an install that comes up IN shadow mode
# says so in the log it will be read from rather than leaving the
# operator to infer it from a page nobody is looking at yet. Coming up
# LIVE is silent - see `_shadow_settle()`, which says why.
self._shadow_was = None
self._shadow_winner = None
self.target = 0.0
self.sat_count = 0
self.i_w = 0.0 # the loop's integrator, carried between cycles
@@ -1739,6 +1758,42 @@ class Controller:
"reports a different value.",
inv.name, inv.batt_fresh.reason)
@property
def shadow(self) -> bool:
"""SAFETY-10. Is the battery being left alone right now?
⚠️ A PROPERTY, NOT A FIELD, AND FOR THE REASON `self.units` IS ONE.
Three surfaces ask this question at three different moments - the
cycle, the write, and the status page rendered between two cycles - and
a cached flag is a fourth answer that can disagree with the option and
the button it is derived from. Derived, they cannot.
⚠️ AND THE WRITE GATE ASKS THIS, NOT A PARAMETER PASSED DOWN TO IT. A
suppression that had to be threaded through `write_setpoint()` would be
absent from every call site that forgot it - the heartbeat, the stop
button, `shutdown()` - which is exactly the shape of hole this add-on's
single choke point exists to close.
"""
return shadow.engaged(self.o, control_started=self.auto)
def shadow_latches(self) -> tuple:
"""The failsafe latches that are UP, named, for the shadow banner.
A latch that is standing while the controller is inert is standing when
it stops being inert. `shadow.banner()` carries them so an operator who
turns shadow mode off is not handed a battery that will not move and a
page that never mentioned why.
"""
out = []
if self.circ_wd.tripped:
out.append("circulating power")
if self.site_sign_wd.tripped and len(self.inverters) > 1:
out.append("site sign watchdog")
for inv in self.inverters:
if inv.sign_wd.tripped:
out.append(f"{inv.name} sign watchdog")
return tuple(out)
def write_refusal(self, value: float, inv=None) -> str | None:
"""Why `value` may NOT be written to `inv` right now, or None if it may.
@@ -1930,6 +1985,40 @@ class Controller:
self.log_event(f"{inv.name}: {result.describe()}")
value = result.applied_w
# --- SAFETY-10: AND THIS IS THE LAST THING BEFORE THE WIRE -----------
# Shadow mode runs the whole decision path and commands nothing. The
# suppression is HERE, in the one method every write in this add-on
# reaches - the cycle, the heartbeat, the stop button, shutdown() and
# maint_abort() alike - so there is no call site that can route round
# it. app/shadow.py carries the whole argument; three things about the
# placement belong here:
#
# ⚠️ IT IS A SUBSTITUTION, NOT A RETURN, exactly like the two refusals
# above it. Returning would leave the inverter LATCHED ON ITS LAST
# COMMAND with the ESP32's heartbeat still being fed - a battery held
# at whatever it was doing when shadow mode was switched on, under a
# status page saying nothing is being commanded. That is the failure
# this add-on keeps finding, and shadow mode must not be a new way to
# reach it. `shadow.WIRE_W` is 0.0 W and it is REFRESHED on the
# ordinary heartbeat, which is also what firmware/goodwe-master.yaml's
# 30 s stale-input watchdog requires of us.
#
# ⚠️ IT IS BELOW SAFETY-28's GATE AND BELOW SAFETY-03's CLAMP, so both
# still grade the number the decision path actually produced. A shadow
# run that could not say "it would have hit the rating here" would be
# answering a different question from the one it is for.
#
# ⚠️ IT IS NOT A SECOND WRITER. No claim is filed, no transport is
# opened and no arithmetic of its own reaches the wire: one actuator,
# one writer, and this is that writer emitting the value it emits for
# every other refusal.
if self.shadow and value != shadow.WIRE_W:
_LOG.info("SHADOW MODE: not commanding %+.0f W to %s - holding "
"%+.0f W. The decision was reached and recorded; "
"nothing was sent to the inverter.",
value, inv.name, shadow.WIRE_W)
value = shadow.WIRE_W
changed = (inv.last_write is None or value != inv.last_write)
if not (changed or force):
return
@@ -2549,7 +2638,16 @@ class Controller:
# operator switching control off for the whole site; "inputs missing" is
# the SITE's own telemetry gone - the meter this controller regulates
# against. Neither is about a pack, and both must stop every inverter.
if not self.auto:
# ⚠️ SAFETY-10: `and not self.shadow`, AND IT IS THE ONE FAILSAFE THIS
# CARD CHANGES. `P_SAFETY` out-ranks every other claim, so leaving the
# stop claim in while shadow mode is engaged would make the recorded
# decision "stopped" on every cycle - a shadow run that answers the
# wrong question, which is the same as no shadow run. The actuator ends
# at the same number either way, and the substitution in `_write_unit()`
# that replaces it is STRICTLY STRONGER than this claim: a claim can be
# out-ranked by a higher priority, and the wire gate cannot be
# out-ranked by anything.
if not self.auto and not self.shadow:
claims.append(Claim.set("safety", P_SAFETY, 0.0, "stopped",
actuator=self.actuator_of("safety")))
elif not self.inputs_ok:
@@ -2893,7 +2991,14 @@ class Controller:
inv)))
# --- the grid-following loop -----------------------------------------
if self.auto and self.inputs_ok:
# ⚠️ SAFETY-10: `or self.shadow`. The loop is the leg a shadow run most
# needs and the one that is switched off by `auto_start: false`, so
# without this an install in `auto` shadow mode would record every
# strategy's decision and a permanent silence where the grid-following
# loop should be. It is safe because the loop's `prev_w` is
# `self.target`, which the end of this method re-seeds to what is
# actually standing on the wire.
if (self.auto or self.shadow) and self.inputs_ok:
# ⚠️ prev is the ARBITER's last output, not the loop's own last
# wish. If something outranked the loop, that is what the hardware
# actually did, and the controller must track reality or it jumps
@@ -3227,6 +3332,116 @@ class Controller:
# reads only `self.p1`, which no line in this method writes.
self.peak.sync(self.p1)
# --- SAFETY-10, AND IT IS LAST FOR A REASON THAT IS NOT TIDINESS -----
# Every guard above has now read `self.target` - the resolved intent -
# and SAFETY-18 in particular grades exactly that. Re-seeding before
# them would hand each one a 0 W that no decision produced. Re-seeding
# AFTER them hands the NEXT cycle, and the sign watchdogs, what is
# actually standing on the wire. See `_shadow_settle()`.
self._shadow_settle(resolution)
def _shadow_settle(self, resolution) -> None:
"""SAFETY-10. Record the decision, then re-seed the carried command.
TWO JOBS, AND THEY ARE IN THIS ORDER BECAUSE THE SECOND DESTROYS THE
FIRST'S EVIDENCE.
1. THE RECORD. A shadow run is only worth running if it answers "what
would it have done, and why". `self.shadow_would_w` and
`Resolution.explain()` are that answer, and the action log gets one
line per CHANGE OF DECISION rather than one per cycle - the log
holds 40 rows, and a level-logged shadow run would flush the context
of its own findings inside four minutes at a 15 s cycle floor. The
same edge rule the peak guard and the arbitrage strategy already
use, for the same reason.
2. THE RE-SEED. `self.target` and each `inv.target` are set back to
`shadow.WIRE_W` - what the write gate actually put on the wire.
⚠️ WHY THE RE-SEED IS A SAFETY PROPERTY AND NOT BOOKKEEPING. Three
machines read the carried command as a statement about the HARDWARE:
* `compute(prev_w=self.target, ...)` - the loop's slew limiter and
its integrator. Left holding a shadow decision, the first cycle
after shadow mode is turned off would slew from a base that never
existed: up to a full `slew_w` step onto a battery sitting at 0 W.
Re-seeded, the exit is safe BY CONSTRUCTION and needs no separate
transition code - the carried command already equals the standing
one.
* `Inverter.standing_w()`, which is what SAFETY-02/30's sign
watchdogs grade. Fed a shadow decision they would compare a number
against a meter that never saw it, disagree for as long as the
decision asked for power, and LATCH A TRIP THAT SURVIVES INTO LIVE
OPERATION AND A RESTART. Shadow mode would manufacture the failsafe
it exists to help debug. ⚠️ THIS ONE IS ALREADY HELD BY THE WIRE
GATE - `standing_w()` prefers `last_write`, and that is the 0.0 W
the gate accepted - so the re-seed is the SECOND rung, covering
the fallback before any write has been accepted. Two rungs
answering one question is MUTATION.md's masking shape, and the
mutation that reproduces the hazard has to defeat BOTH: driven
singly, dropping this line leaves the detector inert and names
nothing about the latch. Measured.
* SAFETY-42's delivery watchdog compares `inv.target` against what
the pack is producing. A share nothing was told to produce is a
delinquency report on every cycle of every shadow run.
⚠️ AND EVERY CYCLE'S DECISION IS THEREFORE COMPUTED FROM WHERE THE
PLANT REALLY IS, not from a counterfactual plant that drifts further
from reality every tick. "What would this controller command NOW,
given this meter and a battery at 0 W" is a true statement about the
present; "what would the eleventh cycle of a run that never happened
have commanded" is not a statement about anything.
"""
engaged = self.shadow
if engaged != self._shadow_was:
# ⚠️ `first` EXISTS SO A LIVE INSTALL'S FIRST CYCLE IS SILENT. The
# edge is against `None` on cycle one, and an install that comes up
# CONTROLLING has nothing to report - a "shadow mode off" line at
# every start is one more row of boilerplate in a 40-row log, and
# it was measured pushing a real clamp episode's context out of
# test_clamp.py part 2's ring. Coming up IN shadow mode is the
# other direction and it is always worth a line: it is the log an
# operator reads to find out why nothing is being commanded.
first = self._shadow_was is None
self._shadow_was = engaged
if engaged:
self.log_event(
"SHADOW MODE ON - " + shadow.why(
self.o, control_started=self.auto)
+ f"; inverter held at {shadow.WIRE_W:.0f} W")
_LOG.warning(
"SAFETY-10 SHADOW MODE IS ON. The full decision path runs "
"and NOTHING is commanded: every inverter is held at "
"%+.0f W on the ordinary heartbeat. %s", shadow.WIRE_W,
shadow.why(self.o, control_started=self.auto))
elif not first:
self.log_event(
"SHADOW MODE OFF - the battery is being controlled again, "
f"resuming from {shadow.WIRE_W:.0f} W")
_LOG.warning(
"SAFETY-10 shadow mode is OFF. This controller is "
"commanding the battery again, starting from the "
"%+.0f W that was standing on the wire.", shadow.WIRE_W)
if not engaged:
self.shadow_would_w = None
self._shadow_winner = None
return
self.shadow_would_w = float(resolution.target_w)
# ⚠️ THE WINNER AND THE ROUNDED WATTS, NOT THE WATTS ALONE. A decision
# that moves from the loop to the peak guard at the same number is a
# different decision and the operator needs the line; a loop target
# that wanders by a watt is not, and 15 s of those would be the whole
# log.
edge = (resolution.winner, round(float(resolution.target_w)))
if edge != self._shadow_winner:
self._shadow_winner = edge
self.log_event(
f"SHADOW: would have commanded {resolution.target_w:+.0f} W - "
+ resolution.explain())
self.target = shadow.WIRE_W
for inv in self.inverters:
inv.target = shadow.WIRE_W
async def check_output_clamp(self) -> None:
"""SAFETY-03. Alarm whenever a clamp actually engaged this cycle.
@@ -4016,6 +4231,14 @@ class Controller:
or (self.site_sign_wd.tripped
and len(self.inverters) > 1)
or self.circ_wd.tripped
# SAFETY-10: "shadow" is its own value and not a
# flavour of "stopped". A fleet dashboard reporting a
# shadow install as `running` would be calling a
# battery nobody is controlling healthy; one reporting
# it as `stopped` would lose the fact that the decision
# path is live and being recorded. ⚠️ BELOW `failsafe`:
# a latch that is up is up, and shadow does not clear it.
else "shadow" if self.shadow
else "running" if self.auto else "stopped"),
# SAFETY-31. ⚠️ MEASURED, not the allocation record - see
# `site_circulating_w`. `publish()` drops None values, so a cycle
@@ -4516,7 +4739,24 @@ class Controller:
def status_payload(self) -> dict:
checks = self.checks()
bad = [c for c in checks if not c["ok"] and not c["warn"]]
if self.circ_wd.tripped:
# --- SAFETY-10, AND IT IS FIRST IN THE CASCADE -----------------------
# "The battery is NOT being controlled" is the one sentence on this
# page that may never be displaced by another condition. A banner that
# can be out-ranked does not STATE a thing plainly; it states it
# whenever nothing else is happening, which is the half of the time
# nobody needs telling.
#
# ⚠️ AND IT CARRIES A STANDING LATCH RATHER THAN HIDING ONE. The three
# `bad` branches below all say some version of "held at 0 W", which is
# still true in shadow mode - but an operator who turns shadow mode off
# with a latch up gets a battery that will not move and a page that
# never mentioned it. `shadow.banner()` names the latch and goes red
# for it, so nothing this cascade would have said is lost.
_shadow = shadow.banner(self.o, control_started=self.auto,
latched=self.shadow_latches())
if _shadow is not None:
level, banner = _shadow
elif self.circ_wd.tripped:
# ⚠️ ABOVE THE SIGN FAILSAFE, and the order is a decision. Both are
# latched P_SAFETY stops, so the site is at 0 W either way and the
# banner can only carry one sentence. This one goes first because it
@@ -4616,6 +4856,16 @@ class Controller:
("State of charge", "—" if self.pack_floor_soc is None
else f"{self.pack_floor_soc:g} %"),
("Commanded", w(self.target)),
# SAFETY-10, and it sits BETWEEN the two rows it reconciles.
# "Commanded 0 W" above and a "Why" below that explains a trade is
# the exact pair an operator would otherwise have to guess at; this
# row is what makes the two of them consistent, and it is rendered
# in EVERY state - including `off`, where it says the battery IS
# being controlled - because a surface whose ABSENCE is how you
# learn something is a surface you have to already know about.
("Shadow mode", shadow.words(
self.o, control_started=self.auto,
would_w=self.shadow_would_w, reason=self.reason)),
("Why", self.reason),
("Maintenance phase", self.maint.phase if len(self.inverters) <= 1
else f"{self.maint.phase} ({self.maint_unit.name})"),
+361
View File
@@ -0,0 +1,361 @@
"""SAFETY-10 - shadow mode: the whole decision path, and no command.
WHAT DEFECT THIS PREVENTS
=========================
Not one defect - the CLASS of them. Every optimiser fault this repository has
found was invisible from outside while it was happening, and each one was paid
for at the meter before anybody could see it:
* SAFETY-45 arbitrage against a binding `peak_cap_w` ran 28 charge onsets an
hour, the grid swinging -455 .. +3200 W, and put a billed
quarter 59 W over the cap;
* TARIFF-14 the price lookup answered for the wrong quarter-hour 45 minutes
in every 60, and traded on it;
* SAFETY-46 the SoC ceiling churns 598 Wh to gain 310 Wh, no hysteresis.
There was no way to WATCH what the optimiser would do without letting it do it.
A commissioning engineer could arm arbitrage and find out, or not arm it and
learn nothing. Shadow mode is the third option: strategies, arbiter, clamps and
guards all run, the decision is recorded with its reason, and NOTHING THE
CONTROLLER DECIDES REACHES THE INVERTER.
⚠️ "REACHES NOTHING" IS NOT "WRITES NOTHING", AND THE DIFFERENCE IS THE WHOLE
SAFETY ARGUMENT
=======================================================================
The inverter holds its last command FOREVER - it has no meter timeout
(HANDOVER.md §6), and firmware/goodwe-master.yaml's header records what that
cost when a controller stopped refreshing: Illusmart went silent mid-command
and the inverter held +5000 W for 113 s. main.py's own header carries the same
measurement. So a shadow mode that
simply stopped writing would leave whatever was standing when it was switched
on standing for as long as it was left on. That is the exact failure this
repository keeps finding - LOOKS HEALTHY BUT IS INERT - with the status page
calmly reporting that nothing is being commanded.
So shadow mode does write, and it writes ONE number:
the actuator is held at WIRE_W (0.0 W), refreshed on the ordinary
heartbeat, by the ordinary single writer.
That is a DEFINED, SAFE actuator state, it is the same state the operator's
stop button reaches, and it honours the contract firmware/goodwe-master.yaml
§"CONTRACT CHANGE" imposes on us - HA must rewrite the setpoint every ~10 s or
the ESP32's 30 s stale-input watchdog cannot tell "steady" from "dead". Going
silent would put that board into a tripped-watchdog state for the whole shadow
run, which is an ALARM being used as a MODE: the operator who learns that
`wd_tripped` is normal during shadow runs is the operator who ignores it when
the add-on has actually died.
⚠️ AND IT IS NOT A SECOND WRITE PATH. SAFETY-28's rule is one actuator, one
writer. Shadow mode files no claim, owns no transport and calls nothing in
hass.py. It is a SUBSTITUTION inside `Controller._write_unit()` - the single
choke point every write in this add-on already goes through - in exactly the
form the three substitutions above it take (non-finite -> 0 W, unauthorised ->
0 W, clamped -> the rating). It is the LAST of them, so SAFETY-28's
authorisation gate and SAFETY-03's clamp still grade the number the decision
path actually produced, and a shadow run therefore records that the clamp WOULD
have engaged.
THE DEFAULT, AND WHY IT IS NOT A PLAIN `true` (§ the ticket's own warning)
==========================================================================
The card is titled "default-on". Taken literally - `shadow_mode: true` in
`config.yaml`'s `options:` block - it is the worst change in this repository's
history. Home Assistant's Supervisor composes an add-on's effective options as
`{**config.yaml defaults, **the stored user options}`, so a NEW key with a new
default reaches EVERY install on the next update, including the one regulating
a real battery in the author's house today. Literal default-on silently stops
an existing install from controlling, and the only symptom is a battery that
has stopped doing anything.
There is no mechanism in the add-on options system that lets one key default
differently for a new install and an existing one: `options:` IS the default,
and there is exactly one of it. So "default-on for new" has to be expressed as
a value the add-on RESOLVES, not as a constant the Supervisor merges.
Hence three values rather than two, defaulting to `auto`:
off never shadow. The controller commands the battery.
on always shadow, whatever the start/stop button says.
auto shadow WHILE CONTROL IS STOPPED; live once it is started.
`auto` is default-on for a new install and a no-op for an existing one, and it
is that without any persisted marker, any migration, and any guess:
* a FRESH install ships `auto_start: false` and has no stored `auto` key, so
it comes up stopped -> shadow. It observes a day of decisions before it is
ever allowed to command anything. That is the card's intent, delivered.
* an install that is CONTROLLING - `auto_start: true`, or the operator has
pressed *Start / stop control* and the store carries `auto: true` - is
started, so `auto` resolves to LIVE and its behaviour does not change by
one watt.
* an install that is STOPPED keeps its actuator at 0 W exactly as before -
the same number, from the same writer, on the same heartbeat - and gains
the recording. The only thing that changes for it is what the status page
and the action log SAY.
⚠️ AND `auto` MEANS THE START BUTTON LEAVES SHADOW MODE. That is deliberate:
under `auto` the button reads "Start / stop control" and pressing Start is the
operator saying "control the battery". An operator who wants the decisions
recorded WHILE the loop runs sets `shadow_mode: on` explicitly - that is the
configuration this card exists to make possible, and it is the one that cannot
be reached by accident.
⚠️ AN UNRECOGNISED VALUE RESOLVES TO SHADOW, NOT TO LIVE. `validate.py` refuses
it at startup so this is not meant to be reachable, but the fail-safe direction
for "the operator's intent is unreadable" is the one that does not move energy.
THE FAILSAFES, ONE BY ONE (the card asks for each to be decided and recorded)
============================================================================
| failsafe | in shadow mode |
|--------------------------------|-------------------------------------------|
| SAFETY-02/30 sign watchdogs | INERT, and by construction rather than by |
| (per-unit and site) | a special case. They grade |
| | `Inverter.standing_w()` - what this |
| | controller has standing on the wire - and |
| | shadow mode holds that at 0 W. A 0 W |
| | command cannot oppose a meter, so the |
| | detector never arms. ⚠️ THIS IS THE ONE |
| | THAT HAD TO BE GOT RIGHT: fed the SHADOW |
| | decision instead, every shadow run would |
| | latch a trip within `sign_disagree_s` - |
| | the decision opposes a meter that never |
| | saw it - and that latch SURVIVES INTO |
| | LIVE OPERATION and a restart. Shadow mode |
| | would manufacture the failsafe it is |
| | meant to help debug. |
| SAFETY-03 clamp | OBSERVES. It runs on the number the |
| | decision path produced, `clamp_last` is |
| | set and every engagement goes to the |
| | action log, because "it would have hit |
| | the rating" is part of what a shadow run |
| | is for. It changes no command: the value |
| | it narrows is replaced by 0 W below it. |
| SAFETY-28 write authorisation | OBSERVES, for the same reason and in the |
| | same place - above the substitution, so |
| | it still asks who chose the number. |
| SAFETY-18 meter freeze | OBSERVES, unchanged. It takes no action |
| | in live operation either; it grades the |
| | resolved intent against a meter that has |
| | stopped moving, and both halves are as |
| | true in shadow as out of it. |
| SAFETY-07/24/25 peak guard | OBSERVES. Level-triggered, unlatched, and |
| | it files its claim as usual so the |
| | recorded decision is the real one. |
| | SAFETY-45's limit cycle is visible from a |
| | shadow run; that is the point. |
| SAFETY-31 circulation | OBSERVES AND MAY LATCH, legitimately. Its |
| SAFETY-42 delivery | evidence is MEASURED power, not a |
| | command: packs pushing against each other |
| | while every one of them is told 0 W is a |
| | real fault and a latch is the right |
| | answer to it. |
| operator stop (`auto` False) | SUPPRESSED AS A CLAIM, ENFORCED AT THE |
| | WIRE. It is the one deliberate change. |
| | Its `P_SAFETY` 0 W claim out-ranks |
| | everything, so leaving it in would make |
| | the recorded decision "stopped" on every |
| | cycle - the shadow run would answer the |
| | wrong question. The actuator state is |
| | identical either way, and the wire |
| | substitution is STRICTLY STRONGER than |
| | the claim: a claim can be out-ranked, and |
| | this cannot. |
| inputs missing, non-finite, | UNCHANGED. All of them resolve to 0 W, |
| allocator refusal, arbiter | which is what the wire gets in shadow |
| contradiction | mode anyway, so they act redundantly and |
| | are recorded as they always were. |
⚠️ MAINTENANCE IS NOT IN THAT TABLE BECAUSE SHADOW MODE DOES NOT TOUCH IT. The
state machines are ticked on every cycle today whether control is started or
not, so a stopped install already runs them against a battery that does not
move. Shadow mode inherits that, unchanged and unimproved; it is a pre-existing
property of `auto_start: false` and it is recorded here rather than quietly
fixed under another card's name.
LEAVING SHADOW MODE
===================
`Controller.cycle()` re-seeds its carried command (`self.target` and each
`inv.target`) to WIRE_W at the END of every shadow cycle, AFTER every in-cycle
guard has read the decision. Two things follow, and both are safety properties:
* the loop's `prev_w` and its integrator track WHAT IS ACTUALLY STANDING ON
THE WIRE, so every shadow cycle answers "from where the plant really is,
what would this controller do NOW" - a true statement about the present,
rather than a simulation of a counterfactual plant that drifts further from
reality every tick;
* the exit is safe BY CONSTRUCTION. The carried command already equals the
standing command, so the first live cycle slews from 0 W like any other
cycle. Carrying the shadow decision instead would let the slew limiter
depart from a base that never existed - up to a full `slew_w` step onto a
battery sitting at zero.
The entry is safe for the ordinary reason: the substitution happens on the very
first write of the very first shadow cycle, and `last_write` was not 0 W, so
that write is issued rather than skipped as unchanged.
"""
from __future__ import annotations
# ⚠️ CFG-03's mirror. `test_defaults_pin.py` part 2 discovers every
# module-level name ending in OPTION_DEFAULTS and asserts each value
# reproduces config.yaml EXACTLY, so this table cannot drift from the shipped
# default. Nothing in the add-on may carry a literal fallback for a key a
# mirror answers for - part 3 scans for that - which is why `main.py` asks the
# functions below and never reads `shadow_mode` itself.
SHADOW_OPTION_DEFAULTS = {
"shadow_mode": "auto",
}
#: The three values `shadow_mode` may take, in the order config.yaml's schema
#: lists them. `validate.py` refuses anything else by name.
MODES = ("auto", "on", "off")
#: What stands on the wire while shadow mode is engaged. ⚠️ A NUMBER, NOT A
#: SILENCE - see this module's header. It is 0.0 W for the same reason every
#: other refusal in this add-on is 0.0 W: fail toward inaction, and keep
#: commanding it so the inverter cannot be left latched on anything else.
WIRE_W = 0.0
def mode(opts: dict) -> str:
"""The configured `shadow_mode`, normalised to one of `MODES`.
⚠️ AN UNRECOGNISED VALUE ANSWERS `"on"`, NOT `"auto"` AND NOT `"off"`.
`validate.py` refuses such a value at startup, so this branch is not meant
to be reachable at all; it exists because the fail-safe direction for "the
operator's intent cannot be read" is the one that does not move energy. A
typo that silently resolved to `off` would put a battery under a controller
whose configuration nobody could parse.
"""
raw = opts.get("shadow_mode", SHADOW_OPTION_DEFAULTS["shadow_mode"])
text = str("" if raw is None else raw).strip().lower()
if text in MODES:
return text
return "on"
def engaged(opts: dict, *, control_started: bool) -> bool:
"""Is the battery being left alone right now?
`control_started` is `Controller.auto` - the persisted start/stop state,
which a fresh install gets from `auto_start` and an operator moves with the
*Start / stop control* button. See the header on why `auto` reads it.
"""
m = mode(opts)
if m == "off":
return False
if m == "on":
return True
return not control_started
def why(opts: dict, *, control_started: bool) -> str:
"""Which rung decided, in the words an operator can act on.
⚠️ THE REASON, NOT ONLY THE VERDICT - MUTATION.md's masking rule. `on` and
`auto`-while-stopped produce the same boolean and want different operator
actions: one is turned off by editing an option, the other by pressing a
button. A surface that showed only "shadow" would make a mutation that
swapped the two rungs invisible.
"""
# ⚠️ THE LIVE SENTENCES SAY "NOT IN SHADOW MODE", NOT "THE BATTERY IS
# BEING CONTROLLED". The second is FALSE on a stopped install with
# `shadow_mode: off` - nothing is regulating there either - and a row that
# is false in one of the four live states is a row an operator learns to
# discount. What is true in every live state is that what this add-on
# decides reaches the inverter; whether control is RUNNING is the
# `Stopped` banner's question and it is answered there.
m = mode(opts)
if m == "off":
return ("off (shadow_mode: off) - NOT in shadow mode: what this "
"add-on decides DOES reach the inverter")
if m == "on":
return ("on (shadow_mode: on) - decisions are recorded and nothing "
"is commanded")
if control_started:
return ("off (shadow_mode: auto, control is started) - NOT in shadow "
"mode: what this add-on decides DOES reach the inverter")
return ("on (shadow_mode: auto, control is stopped) - decisions are "
"recorded and nothing is commanded")
def words(opts: dict, *, control_started: bool, would_w: float | None,
reason: str = "") -> str:
"""The status page's `Shadow mode` row.
⚠️ THE ROW IS RENDERED IN EVERY STATE, INCLUDING `off`. A surface whose
ABSENCE is how you learn which mode you are in is a surface an operator
has to already know about; TARIFF-11's rule is that the rendered text is
what gets graded, so there has to be text in both states.
`would_w` is the decision the path reached this cycle - what a live
controller would have put on the wire - and `reason` is
`Resolution.explain()`, the same sentence the `Why` row carries. Together
they are the whole of "what would it have done, and why"; without them the
row would say a shadow run happened and nothing about what it found.
"""
head = why(opts, control_started=control_started)
if not engaged(opts, control_started=control_started):
return head
if would_w is None:
return (f"{head}; no decision has been reached yet - the inverter is "
f"held at {WIRE_W:.0f} W")
# ⚠️ THE THOUSANDS SEPARATOR IS SWAPPED ON THE NUMBER ALONE. Applied to
# the whole sentence it ate the comma out of `head` - and `head` is the
# half that says WHICH RUNG decided, which is the claim MUTATION.md's
# masking rule says must survive.
num = f"{float(would_w):+,.0f}".replace(",", " ")
out = (f"{head}; WOULD HAVE COMMANDED {num} W, inverter held at "
f"{WIRE_W:.0f} W")
if reason:
out += f" - {reason}"
return out
def banner(opts: dict, *, control_started: bool, latched: tuple = ()) -> tuple:
"""`(level, text)` for the top of the status page, or `None` when live.
⚠️ IT NAMES A STANDING LATCH AND GOES RED FOR ONE. The shadow banner sits
ABOVE every other branch of the cascade, because "the battery is not being
controlled" is the one sentence that may never be displaced - but a
failsafe latch that is up while the controller is inert is up when it
stops being inert, and an operator who turns shadow mode off without
clearing it gets a battery that will not move and a green page that
never mentioned why. So the latch is carried INTO the shadow banner
rather than losing its own.
"""
if not engaged(opts, control_started=control_started):
return None
text = ("SHADOW MODE - the battery is NOT being controlled. Every "
f"inverter is held at {WIRE_W:.0f} W and nothing this add-on "
"decides reaches the inverter.")
if latched:
return ("bad", text + " ⚠️ A FAILSAFE LATCH IS STILL UP ("
+ ", ".join(latched) + ") and it will still be up when shadow "
"mode is turned off.")
return ("warn", text)
def problems(opts: dict) -> list:
"""`validate.py`'s rule: `shadow_mode` must be one of the three values.
⚠️ THE SENTENCE SPELLS `shadow_mode`. `configui.problems_by_field()` files
a refusal under the field whose key its text contains; a rule that never
names a key lands in the page's top-level block instead, where the operator
cannot see which control is wrong. UX-02's whole point is that the shipped
validator is the only rule surface, so the rule has to be readable there.
⚠️ AND IT IS A REFUSAL RATHER THAN A COERCION. `mode()` resolves an
unreadable value to shadow, which is the safe direction but is also a
SILENT reinterpretation of what the operator wrote - and an install left in
shadow mode by a typo commands nothing at all, indefinitely.
"""
raw = opts.get("shadow_mode", SHADOW_OPTION_DEFAULTS["shadow_mode"])
text = str("" if raw is None else raw).strip().lower()
if text in MODES:
return []
return [f"shadow_mode is {raw!r}, which is not one of "
+ ", ".join(f"'{m}'" for m in MODES)
+ ". 'auto' leaves the battery alone while control is stopped and "
"commands it once control is started; 'on' records every "
"decision and commands nothing at all; 'off' is ordinary "
"control."]
+13
View File
@@ -334,6 +334,7 @@ from .peakguard import PEAK_OPTION_DEFAULTS
from .price import (
PRICE_OPTION_DEFAULTS, PROVIDERS, RETIRED_PROVIDERS,
SUPERSEDED_TAXES_DEFAULTS_EUR_KWH)
from .shadow import problems as shadow_problems
from .static_tariff import (
ProfileInvalid, TAXES_PROFILE_OPTION, parse_static_profile,
parse_taxes_profile)
@@ -840,6 +841,18 @@ def validate_startup_config(opts: dict, dev_min=None, dev_max=None) -> list[str]
# missing rating one line up.
problems.extend(_roster_problems(opts))
# --- 11. SAFETY-10's shadow mode, and it is a REFUSAL ---------------------
# `shadow_mode` decides whether this controller commands the battery at all,
# so an unreadable value is not a detail to log and carry on past.
# `shadow.mode()` resolves an unrecognised one to SHADOW - the direction
# that does not move energy - and an install silently reinterpreted that way
# commands nothing, indefinitely, while its status page calmly explains
# that this is intentional. UX-02 made this validator the ONE rule surface
# both editors read, so the refusal belongs here rather than in a coercion
# nobody can see. The sentence spells `shadow_mode` so
# `configui.problems_by_field()` can file it under the field.
problems.extend(shadow_problems(opts))
# --- 2. the configured ceiling against the device's own rating -----------
# ⚠️ THE FLAT `max_w`, AND ONLY THE FLAT ONE. `dev_min`/`dev_max` are ONE
# device's range - the flat `setpoint_entity`'s - so this rule can only ever