DOC-8: say EMS port, not meter bus #201

Merged
admin merged 4 commits from DOC-8 into release/1.0 2026-10-17 04:09:34 +02:00
Owner

The add-on is wired to the inverter's RS485 port labelled EMS, not METER. Rewords README, DOCS.md, config.yaml description, main.py docstring, field guide source (build_guide.py) and field-guide.html. No behaviour change, no CHANGELOG/version change.

HA manufacturer string (mqtt.py:32) left unchanged: test_mqtt.py byte-pins it in BASELINE. Field-guide PDF not rebuilt (already outdated).

🤖 Generated with Claude Code

https://claude.ai/code/session_01Bdqr7PiaHcBnzPituu2yTC

The add-on is wired to the inverter's RS485 port labelled EMS, not METER. Rewords README, DOCS.md, config.yaml description, main.py docstring, field guide source (build_guide.py) and field-guide.html. No behaviour change, no CHANGELOG/version change. HA manufacturer string (mqtt.py:32) left unchanged: test_mqtt.py byte-pins it in BASELINE. Field-guide PDF not rebuilt (already outdated). 🤖 Generated with [Claude Code](https://claude.com/claude-code) https://claude.ai/code/session_01Bdqr7PiaHcBnzPituu2yTC
admin added 1 commit 2026-10-17 01:09:45 +02:00
DOC-8: say EMS port, not meter bus
checks / unit (pull_request) Successful in 40m22s
infra-pin / fresh (pull_request) Successful in 1s
fd08090360
The add-on is wired to the inverter's RS485 port labelled EMS. Reword
README, DOCS, config description, field guide source and HTML. The HA
manufacturer string is left unchanged: test_mqtt pins it byte for byte.

Co-Authored-By: Claude <noreply@anthropic.com>
admin added 1 commit 2026-10-17 01:53:36 +02:00
DOC-8: HA manufacturer says EMS port; rebuild field guide PDF
checks / unit (pull_request) Failing after 41m1s
infra-pin / fresh (pull_request) Successful in 1s
4584502adb
Device id (identifiers) is unchanged; only the display text moves.
test_mqtt baseline updated for that one string.

Co-Authored-By: Claude <noreply@anthropic.com>
admin added 1 commit 2026-10-17 02:16:36 +02:00
DOC-8: update test_mqtt digest pins for the new manufacturer string
infra-pin / fresh (pull_request) Successful in 2s
checks / unit (pull_request) Successful in 40m23s
b8b357b552
Both digests hash the discovery payloads, which carry the manufacturer.
Values regenerated; nothing else changes.

Co-Authored-By: Claude <noreply@anthropic.com>
admin added 1 commit 2026-10-17 03:27:55 +02:00
DOC-8 review: say the field guide PDF is rebuilt, still v0.1.0
checks / unit (pull_request) Successful in 40m29s
infra-pin / fresh (pull_request) Successful in 1s
a4a7ff695e
README and FIELD-GUIDE.md said the PDF was not rebuilt; it was, on
2026-10-17. Its content is still v0.1.0 and outdated. Rewrap the
DOCS.md intro line. Text only.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Author
Owner

DOC-8 review (head reviewed b8b357b, plus reviewer text fix a4a7ff6)

Checks:

  • Wording: every changed sentence says the EMS port and is true; the mechanism (a made-up grid reading over that port) is unchanged. Short and plain.
  • Manufacturer: putting the old string back in app/mqtt.py:32 gives back the old pins exactly (eb5022b0455158d7, 501a7d93782a260b). So the new pins differ only by that string. The device id goodwe_rs485_controller is unchanged. With the old string, test_mqtt fails (15 checks).
  • PDF: rebuilding with the unmodified docs/build_guide.py (Linux Chrome path swapped in a scratch wrapper) gives a field-guide.html identical to the committed one. The PDF has 10 pages and the same words as the committed PDF. It has no "meter port" or "meter bus" text.
  • No code behaviour change. No CHANGELOG or version change.

Findings:

  • Low, fixed in a4a7ff6: README.md:33 and FIELD-GUIDE.md:7-9 said the PDF was not rebuilt. They now say it was rebuilt on 2026-10-17 and its content is still v0.1.0 and outdated.
  • Nit, fixed in a4a7ff6: goodwe_controller/DOCS.md:4 was an over-long line. Rewrapped it; the text did not change.
  • Info, left: HANDOVER.md:169 "a G2 unit's meter bus" is about an unsupported G2 unit, not our wiring.
  • Info, left: "meter emulation" is the name of the mechanism in app/allocator.py:4, test_alloc.py:4 and CHANGELOG history. These sentences are true.
  • Info, left: "no meter-timeout" (README, DOCS, guide) means the reading has no timeout. It does not name a port.
  • Info, existing before this PR: docs/build_guide.py:24 has a Windows Chrome path, and the URL it builds at :531 only works on Windows. FIELD-GUIDE.md already says this. Out of scope.
**DOC-8 review (head reviewed b8b357b, plus reviewer text fix a4a7ff6)** Checks: - Wording: every changed sentence says the EMS port and is true; the mechanism (a made-up grid reading over that port) is unchanged. Short and plain. - Manufacturer: putting the old string back in `app/mqtt.py:32` gives back the old pins exactly (`eb5022b0455158d7`, `501a7d93782a260b`). So the new pins differ only by that string. The device id `goodwe_rs485_controller` is unchanged. With the old string, test_mqtt fails (15 checks). - PDF: rebuilding with the unmodified `docs/build_guide.py` (Linux Chrome path swapped in a scratch wrapper) gives a `field-guide.html` identical to the committed one. The PDF has 10 pages and the same words as the committed PDF. It has no "meter port" or "meter bus" text. - No code behaviour change. No CHANGELOG or version change. Findings: - Low, fixed in a4a7ff6: `README.md:33` and `FIELD-GUIDE.md:7-9` said the PDF was not rebuilt. They now say it was rebuilt on 2026-10-17 and its content is still v0.1.0 and outdated. - Nit, fixed in a4a7ff6: `goodwe_controller/DOCS.md:4` was an over-long line. Rewrapped it; the text did not change. - Info, left: `HANDOVER.md:169` "a G2 unit's meter bus" is about an unsupported G2 unit, not our wiring. - Info, left: "meter emulation" is the name of the mechanism in `app/allocator.py:4`, `test_alloc.py:4` and CHANGELOG history. These sentences are true. - Info, left: "no meter-timeout" (README, DOCS, guide) means the reading has no timeout. It does not name a port. - Info, existing before this PR: `docs/build_guide.py:24` has a Windows Chrome path, and the URL it builds at :531 only works on Windows. FIELD-GUIDE.md already says this. Out of scope.
admin merged commit 243a756e7b into release/1.0 2026-10-17 04:09:34 +02:00
Sign in to join this conversation.
No Reviewers
No labels
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: admin/goodwe-addon#201