admin/goodwe-addon
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

DOC-8 review: say the field guide PDF is rebuilt, still v0.1.0
checks / unit (pull_request) Successful in 40m29s
Details
infra-pin / fresh (pull_request) Successful in 1s
Details

Browse Source 
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>
This commit is contained in:
glenn schrooyen
2026-10-17 03:27:35 +02:00
co-authored by Claude Opus 5.5
parent b8b357b552
commit a4a7ff695e
3 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
FIELD-GUIDE.md
+3 -3
View File
@@ -4,9 +4,9 @@ The guide technicians carry is the PDF:
**`docs/GoodWe-RS485-Field-Guide.pdf`** — 10 pages, A4, print it double-sided. **`docs/GoodWe-RS485-Field-Guide.pdf`** — 10 pages, A4, print it double-sided.
⚠️ **Outdated: it is v0.1.0.** Its `slew_w` row is corrected in `build_guide.py` ⚠️ **Outdated: the content is still v0.1.0.** The PDF was rebuilt on 2026-10-17
and `field-guide.html`, but the PDF has not been rebuilt (see below). Where the for the EMS-port wording and the `slew_w` row only. Where the guide disagrees with
guide disagrees with `goodwe_controller/DOCS.md`, DOCS.md wins. `goodwe_controller/DOCS.md`, DOCS.md wins.
It covers, in the order the work is done: pre-visit checks, hardware, firmware, It covers, in the order the work is done: pre-visit checks, hardware, firmware,
add-on install and configuration, how to read the Web UI, the six commissioning add-on install and configuration, how to read the Web UI, the six commissioning
README.md
+1 -1
View File
@@ -30,7 +30,7 @@ goodwe_controller/ the add-on
returns, run against its own release image returns, run against its own release image
firmware/goodwe-master.yaml ESPHome config for the T-CAN485 firmware/goodwe-master.yaml ESPHome config for the T-CAN485
estop/rs485_log.py optional RS485 e-stop / bus witness estop/rs485_log.py optional RS485 e-stop / bus witness
docs/GoodWe-RS485-Field-Guide.pdf the guide techs carry (10pp, A4; outdated) docs/GoodWe-RS485-Field-Guide.pdf the guide techs carry (10pp, A4; rebuilt 2026-10-17, content still v0.1.0 and outdated)
docs/build_guide.py its single source - rebuilds the HTML and PDF docs/build_guide.py its single source - rebuilds the HTML and PDF
FIELD-GUIDE.md how to edit and rebuild the guide FIELD-GUIDE.md how to edit and rebuild the guide
docs/RELEASE.md how a change reaches the battery - `master` is docs/RELEASE.md how a change reaches the battery - `master` is
goodwe_controller/DOCS.md
+3 -2
View File
@@ -1,8 +1,9 @@
# GoodWe RS485 Controller # GoodWe RS485 Controller
Drives a GoodWe ES/BP battery inverter over its RS485 EMS port: sends it a grid Drives a GoodWe ES/BP battery inverter over its RS485 EMS port: sends it a grid
reading to hold net grid exchange at zero, and runs a monthly battery maintenance cycle so the BMS can reading to hold net grid exchange at zero, and runs a monthly battery
balance cells and recalibrate its coulomb counter. maintenance cycle so the BMS can balance cells and recalibrate its coulomb
counter.
Installers: the printed field guide (`docs/GoodWe-RS485-Field-Guide.pdf`) is Installers: the printed field guide (`docs/GoodWe-RS485-Field-Guide.pdf`) is
v0.1.0 and outdated; where it disagrees with this page, this page wins. v0.1.0 and outdated; where it disagrees with this page, this page wins.