Skip to content

docs: regenerate the Gateway Discovery table for the F461 and MyHomeServer1 without WHO 16 (companion to OWNd#142) - #830

Closed
gdluck wants to merge 1 commit into
OpenWebNet-HA:v2-phase1-architecturefrom
gdluck:docs/discovery-table-f461-mhs1-no-who16
Closed

gdluck wants to merge 1 commit into
OpenWebNet-HA:v2-phase1-architecturefrom
gdluck:docs/discovery-table-f461-mhs1-no-who16

Conversation

@gdluck

@gdluck gdluck commented Oct 28, 2026

Copy link
Copy Markdown

Requested by A

Before: the startup-discovery table in docs/getting-started/hardware-compatibility.md lists WHO 16 among the WHOs queried on the F461 and MyHomeServer1, and *#16*0*5## among the frames their firmware drops.

After: the two rows follow the OWNd profiles of OpenWebNet-HA/OWNd#142, which drop WHO 16 from both gateways: queried WHOs 1, 2, 4, 18, and only *#4*0## listed as dropped.

Companion to OpenWebNet-HA/OWNd#142. Nothing else changes.

What is the problem

scripts/sync_documentation.py generates the Gateway Startup Discovery Capabilities table from OWNd's gateway profiles. OpenWebNet-HA/OWNd#142 removes WHO 16 from the F461 and MyHomeServer1 profiles (both gateways refuse every WHO 16 frame; sound is WHO 22 only, own-firmware-oracle 020011 and 028206, confirmed live on 2.0.11 and 3.87.13). With that OWNd checkout, tests/test_sync_documentation.py::test_check_all_documentation_real_tree fails here with "Gateway Discovery table out of sync", which is what the MyHOME conformance / MyHOME test suite job on OWNd#142 reports (5072 passed, 1 failed).

Fixes nothing in the integration; documentation only.


What is the solution

  1. docs/getting-started/hardware-compatibility.md:
    • Regenerated with python scripts/sync_documentation.py --update while the OWNd#142 branch (fix/profiles-f461-mhs1-no-who16, head 2210296) was on PYTHONPATH. No hand edits; the row text is the generator's.

State Diagram

N/A — docs change only.


Hardware Verification

N/A for this PR. The underlying evidence is on OpenWebNet-HA/OWNd#142 (live F461 2.0.11 and MyHomeServer1 3.87.13 captures of the WHO 16 refusals).


How is it tested

  • python scripts/sync_documentation.py --check with OWNd#142 on PYTHONPATH: all checks in sync after this change, "Gateway Discovery table out of sync" before it.
  • With OWNd master on PYTHONPATH the same check reports the table out of sync, as expected: this PR and OWNd#142 have to land together. Merging this first turns the OWNd#142 conformance job green; merging it after leaves this repository's check red until OWNd#142 is in a release that MyHOME pins.

Where are the traces

N/A (no protocol change). OWNd#142 links the live captures.


What does the Firmware Oracle / Encyclopedia say

  1. OpenWebNet Encyclopedia: N/A, no frame semantics change.
  2. Firmware Oracle: 020011 (F461) and 028206 (MyHomeServer1) have no WHO 16 verdict other than refusal; the generator already carries that in its notes column.

Checklist

  • PR Description: Follows the structured sections above.
  • Trace-Backed (if protocol/device change): N/A, docs only.
  • V2 Architecture: N/A, no entity change.
  • Tests & Linters: scripts/sync_documentation.py --check passes against OWNd#142; no Python changed, so pytest, ruff and verify_ha_standards.py are unaffected.

🤖 Generated with Claude Code

…erver1 profiles without WHO 16

Companion to OpenWebNet-HA/OWNd#142, which drops WHO 16 from the F461 and
MyHomeServer1 gateway profiles. MyHOME's startup discovery table is generated
from those profiles, so the real-tree documentation check on the OWNd side
(MyHOME conformance / MyHOME test suite) fails until this table follows.

Generated with scripts/sync_documentation.py --update against the OWNd
fix/profiles-f461-mhs1-no-who16 branch; no hand edits.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@gdluck

gdluck commented Oct 28, 2026

Copy link
Copy Markdown
Author

Closing: this is premature. The repository already handles OWNd#142 at the pin bump (tests/test_gateway_profiles.py::test_discovery_table_with_ownd_matches_the_committed_docs and the pinned_whos rows in scripts/update_gateway_profiles.py, 1e346c3 / ccda545): the committed table must match the pinned OWNd==2.0.0b11, and the F461 / MyHomeServer1 rows are regenerated together with pinned_whos when the pin moves to a release that carries OWNd#142. Regenerating the table now breaks the six no-OWNd and pinned-OWNd jobs, as CI shows. Sorry for the noise.

@gdluck gdluck closed this Oct 28, 2026
@gdluck
gdluck deleted the docs/discovery-table-f461-mhs1-no-who16 branch October 28, 2026 16:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant