From a4a7ff695e2d819e2f9ea6adf6a86f47ca7302c8 Mon Sep 17 00:00:00 2001 From: glenn schrooyen Date: Sat, 17 Oct 2026 03:27:35 +0200 Subject: [PATCH] DOC-8 review: say the field guide PDF is rebuilt, still v0.1.0 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 --- FIELD-GUIDE.md | 6 +++--- README.md | 2 +- goodwe_controller/DOCS.md | 5 +++-- 3 files changed, 7 insertions(+), 6 deletions(-) diff --git a/FIELD-GUIDE.md b/FIELD-GUIDE.md index 1d71b4b..3e1524f 100644 --- a/FIELD-GUIDE.md +++ b/FIELD-GUIDE.md @@ -4,9 +4,9 @@ The guide technicians carry is the PDF: **`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` -and `field-guide.html`, but the PDF has not been rebuilt (see below). Where the -guide disagrees with `goodwe_controller/DOCS.md`, DOCS.md wins. +⚠️ **Outdated: the content is still v0.1.0.** The PDF was rebuilt on 2026-10-17 +for the EMS-port wording and the `slew_w` row only. Where the guide disagrees with +`goodwe_controller/DOCS.md`, DOCS.md wins. 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 diff --git a/README.md b/README.md index c1f52b2..d9711d4 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ goodwe_controller/ the add-on returns, run against its own release image firmware/goodwe-master.yaml ESPHome config for the T-CAN485 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 FIELD-GUIDE.md how to edit and rebuild the guide docs/RELEASE.md how a change reaches the battery - `master` is diff --git a/goodwe_controller/DOCS.md b/goodwe_controller/DOCS.md index 34777bc..fb1be9c 100644 --- a/goodwe_controller/DOCS.md +++ b/goodwe_controller/DOCS.md @@ -1,8 +1,9 @@ # GoodWe RS485 Controller 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 -balance cells and recalibrate its coulomb counter. +reading to hold net grid exchange at zero, and runs a monthly battery +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 v0.1.0 and outdated; where it disagrees with this page, this page wins.