Skip to content

docs: align default branch README with v2.0.0b17 beta release and expanded community credits - #859

Merged
GreenGrassBlueOcean merged 3 commits into
masterfrom
chore/master-readme-2.0.0b17
Nov 8, 2026
Merged

GreenGrassBlueOcean merged 3 commits into
masterfrom
chore/master-readme-2.0.0b17

Conversation

@GreenGrassBlueOcean

@GreenGrassBlueOcean GreenGrassBlueOcean commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

What is the problem

The default branch master displays the landing README.md for users and prospective contributors visiting the repository. Following the release of v2.0.0b17 ("in traces we find the truth"), the master landing comparison table, installation scripts, badge metrics, and community credits were still pointing to v2.0.0b16 (and 4,393 tests instead of 5,324 tests).

What is the solution

  1. Badge, Metric & Documentation Links Refresh:

    • Bumped active beta badge from v2.0.0b16 to v2.0.0b17 linking to the new release tag.
    • Updated passing test count badge to 5,324 passing (up from 4,393 in b16) and release compare link to 61 PRs.
    • Preserved V2 documentation links on https://openwebnet-ha.github.io/MyHOME/beta/ (where 2.0.0b17 is deployed on gh-pages, while latest remains aliased to legacy v0.9.4 until stable v2.0.0 merges).
  2. Alert Box, Comparison Table & Domain Overview Progression:

    • Updated the technical comparison table columns to compare Legacy Stable (v0.9.4 on master), Previous Beta (v2.0.0b16), and Latest Beta (v2.0.0b17) (keeping unchanged subsystems such as CEN / CEN+ & Scenarios identical between b16 and b17).
    • Added OWNd==2.0.0b13 protocol engine reference and UI Config/Options/Subentry Flow enhancements (#804, #817, #829).
    • Documented v2.0.0b17 product capabilities across subsystems with verified PR links:
      • Covers: End-stop settle recomputation & 0.5 s limit-stop cutoff from known positions (#834, #847), configurable min_position_delta (1–5 %, default 2 %, #778), and calibration configurator cutoffs (#843).
      • Climate: BTicino 3550 Central Unit startup hydration, diagnostic flags & actionable repair alerts (#846), probe-less WHO=4 thermo actuator switches & ghost pump suppression (#817, #825), and Dimension 22 crash-form & interface routing guards (#816, #849).
      • Sound System / Tuner (media_player, number, button): F500/F500N FM tuner manual frequency number input (87.50–108.00 MHz), seek up/down button entities, Media Browser, preset storage & WHO=22 command parity (#839), and WHO=16 station range validation (#844).
      • Burglar Alarm: HomeKit-compatible arm-away read-only auxiliary panel mode (#842).
      • Door Entry: WHO=6 gateway boundary containment (#835) preventing cross-gateway broadcast leaks.
      • Gateways: Legrand 067292 / 573958 / 078479 touchscreen profile aliases (H4890 profile, #854) and per-firmware startup sweep filtering (#794).
      • Lighting: Coarse preset brightness curve correction (#828), fine dimmer preset echo Dimension 1 refresh (#852), and shared-address light + motion sensor coexistence (#781).
  3. Installation Instructions:

    • Updated verified installation one-liner shell script and Docker commands to download 2.0.0b17/myhome.zip.
    • Updated HACS and manual download references.
  4. Expanded Community & Trace Contributor Attribution:

    • Mirrored the expanded community credits from PR V2 phase1 architecture #232 and 2.0.0b17 trace fixtures, crediting @xtimmy86x, @gdluck, @TheDarkWizard, @wave68runner, @Interstellar0verdrive, @fedem95, @GianlucaCh, @nicolacavallo84, @andrea-mag, @eC0y0te, @manfredgittmaier-afk, @Yvan13120, @emil-d, @gimprota76, and all community trace providers ("In traces we find the truth").

State Diagram

flowchart LR
    A["Legacy Stable (v0.9.4)"] -->|"Zero-friction YAML / ID migration"| B["Beta v2.0.0b16 (4,393 tests)"]
    B -->|"End-stop settling, 3550 hydration, FM tuner, min delta"| C["Latest Beta v2.0.0b17 (5,324 tests)"]
    C -->|"Upcoming PR #232 merge"| D["Stable v2.0.0 on master"]
Loading

Hardware Verification

N/A (Documentation update for master default branch landing page).

How is it tested

  • Verified markdown formatting, diff boundaries, and anchor links.
  • Cross-checked every /pull/<N>, /issues/<N>, /orgs/OpenWebNet-HA/discussions/<N>, and /MyHOME/beta/... URL against the 2.0.0b16..2.0.0b17 merge history (61 PRs) and gh-pages/versions.json.
  • Verified test count badge (5,324 passing) matches tests/ suite output in v2.0.0b17.
  • Verified release download URL (releases/download/2.0.0b17/myhome.zip) exists and is accessible.

Where are the traces

N/A (Documentation PR).

What does the Firmware Oracle / Encyclopedia say

N/A (Documentation PR).

Checklist

  • Base branch is master.
  • All badges, PR/issue/discussion references, and /beta/ documentation links verified for v2.0.0b17.
  • Test count accurately updated to 5,324 tests.
  • Community and trace contributors credited accurately against their fixture captures.

@Interstellar0verdrive Interstellar0verdrive left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for keeping the landing page in step with b17. One mix-up in the cover/scenario references:

  • In the comparison table, the CEN / CEN+ & Scenarios row credits #843 for "deterministic event sequence ordering". #843 is the cover fix that refuses every configurator run-time limit in calibrate_cover (fixes #837), so that row needs the PR that actually changed the CEN event ordering.
  • In the Covers row, "calibration configurator cutoffs" links to /pull/837, which is the issue. The fix is #843.

Everything else I checked in the cover row matches the merged PRs.

@GreenGrassBlueOcean

Copy link
Copy Markdown
Contributor Author

Thanks for catching that, @Interstellar0verdrive!

Fixed in commit d914c48d:

  • Covers row: Updated "calibration configurator cutoffs" to link to the fix PR #843 (which resolved issue [Bug]: calibrate_cover stores the F411 120 s cutoff (M=1) as a travel time #837). Also aligned the Architectural Highlights section reference.
  • CEN / CEN+ & Scenarios row: Updated "deterministic event sequence ordering" to link to #784 (fix/flaky-test-746-cen-order), which ensures deterministic bus event collection on the event loop.

Also updated the PR description summary to match.

@Interstellar0verdrive

Copy link
Copy Markdown
Member

Thanks, both links now point to the right PR.

One thing on the CEN row: #784 only touches tests/test_issue_746_mh200n_trace.py. It makes a flaky test collect its events on the event loop, and it doesn't change how the integration orders CEN / CEN+ events. Listing it as a b17 feature ("deterministic event sequence ordering") reads as a product change that isn't there. I'd drop that claim from the b17 column, or keep the row the same as b16.

The cover row and the Architectural Highlights references look right to me now.

@GreenGrassBlueOcean

Copy link
Copy Markdown
Contributor Author

Good catch, thank you @Interstellar0verdrive!

Updated in 7a7850d4:

  • CEN / CEN+ & Scenarios: Dropped the non-product "deterministic event sequence ordering" (#784) claim from the b17 comparison column (keeping it identical to b16), the device_trigger domain row, and the PR description.
  • Full link & attribution audit across README.md: While checking the remaining b17 references end-to-end against 2.0.0b16..2.0.0b17 (61 PRs) and gh-pages/versions.json, also corrected:
    • min_position_delta (#842 → #778), HomeKit ARM_AWAY (#830 → #842), WHO=6 gateway boundary containment (#840 → #835), 3550 Central Unit hydration/diagnostics (404 /pull/819 → #846), WHO=4 thermo actuator switches & Dimension 22 guards (#785/#803 → #817, #825, #816, #849), and Legrand 067292 H4890 touchscreen alias (#832 → #854).
    • Restored /MyHOME/beta/ on V2 documentation links (latest on gh-pages still aliases legacy 0.9.4 until 2.0.0 merges, so V2 paths under /latest/ were 404ing).
    • Aligned trace contributor credits (@wave68runner, @andrea-mag, @eC0y0te, @manfredgittmaier-afk, @Yvan13120, @emil-d) with their exact tests/fixtures/ captures.

@Interstellar0verdrive Interstellar0verdrive left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the thorough pass. The CEN row now matches b16, and every cover reference points to the merged fix. Thanks also for catching #842 → #778 for min_position_delta, which I had missed in the cover row. Looks good to me.

@GreenGrassBlueOcean
GreenGrassBlueOcean merged commit d8b363b into master Nov 8, 2026
7 checks passed
@GreenGrassBlueOcean
GreenGrassBlueOcean deleted the chore/master-readme-2.0.0b17 branch November 8, 2026 12:00
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.

2 participants