Skip to content

Commit 7d71e18

Browse files
0xAHAclaude
andcommitted
docs: make the issue-reporting page generic
Stripped the war stories from the user-facing page. Readers need the instruction, not the history behind it -- specific register numbers, scan-row counts and version numbers only date the page and read as insider detail to someone trying to report a problem. Kept every actionable point: compare against another source, take a second reading at a different operating point, disable the integration before scanning, and that correcting an earlier report is welcome. Co-Authored-By: Claude <noreply@anthropic.com>
1 parent f289ba6 commit 7d71e18

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

docs/troubleshooting/raising-an-issue.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ You don't need to fill in a long form. These two cover the majority of reports.
1212

1313
**Settings → Devices & Services → Growatt Modbus → ⋮ → Download diagnostics**
1414

15-
Attach the JSON file to your issue. It already contains almost everything that used to be asked for by hand: integration version, inverter model and profile, connection type, block size, poll interval, how many polls have failed, which register ranges responded, and the last full set of decoded values.
15+
Attach the JSON file to your issue. It contains almost everything needed to diagnose a problem: integration version, inverter model and profile, connection type, block size, poll interval, how many polls have failed, which register ranges responded, and the last full set of decoded values.
1616

1717
Your **IP address, serial number and device path are removed automatically** before the file is written.
1818

@@ -23,7 +23,7 @@ Your **IP address, serial number and device path are removed automatically** bef
2323
Please paste log lines as text in a code block rather than a screenshot. Screenshots can't be searched, and the useful detail is often a register number or a count in the middle of a long line.
2424

2525
!!! tip "Is there anything under Settings → Repairs?"
26-
Since v1.5.0 the integration raises repair notices for problems it can detect itself, such as an inverter reverting your settings or a gateway returning malformed responses. If one is showing, say so — it usually names the cause outright.
26+
The integration raises repair notices for problems it can detect itself, such as an inverter reverting your settings or a gateway returning malformed responses. If one is showing, say so — it usually names the cause outright.
2727

2828
---
2929

@@ -35,9 +35,9 @@ Different symptoms need different evidence. Find yours below.
3535

3636
Say **which sensor**, **what it reads**, and **what you believe it should be** — the last part matters most, and it's the part most often left out.
3737

38-
If you can compare against another source — the ShinePhone app, the Growatt portal, a utility meter — that comparison is the single most valuable thing you can provide. It has repeatedly settled questions that register tables could not, including one register everyone assumed was battery temperature that turned out to be the inverter's DC-DC converter stage.
38+
If you can compare against another source — the ShinePhone app, the Growatt portal, a utility meter — that comparison is the single most valuable thing you can provide. It settles questions that a register table cannot.
3939

40-
**One reading proves very little.** Two registers can hold identical values by coincidence at one moment and diverge completely an hour later. If you're reporting that a value looks wrong, a second reading at a different time of dayor a different battery or solar state turns a guess into evidence.
40+
**One reading proves very little.** Two values can look identical by coincidence at one moment and differ completely an hour later. A second reading at a different time of day, or at a different battery or solar state, turns a guess into evidence.
4141

4242
### A sensor is missing, or you think a register is mapped wrongly
4343

@@ -46,7 +46,7 @@ Run the [Universal Register Scanner](diagnostic-service.md) and attach the CSV.
4646
!!! warning "Disable the integration before scanning"
4747
**⋮ → Disable**, wait about 30 seconds, run the scan, then re-enable. Don't delete it.
4848

49-
The scanner opens its own connection. If the integration is still polling, the two compete for the same adapter and the results are meaningless — one scan came back with 9 usable rows out of 1304 on a system that was working perfectly.
49+
The scanner opens its own connection. If the integration is still polling, the two compete for the same adapter and most reads fail — producing a scan that looks like a broken inverter on a system that is working perfectly.
5050

5151
### The connection drops, or entities go unavailable
5252

@@ -68,9 +68,9 @@ Attach a register scan (see above) and tell us the **exact model from the invert
6868

6969
## Things that genuinely help
7070

71-
- **Correcting yourself.** Several of the most valuable reports have been people revisiting their own findings after measuring properly. It's never unwelcome it has repeatedly stopped a working register being "fixed" into a broken one.
72-
- **Saying what you already ruled out**, and how. It prevents the same ground being covered twice.
73-
- **Telling us it's working.** Confirmation that a fix landed is what lets an issue close, and a report that something works on hardware nobody else has is genuinely useful data.
71+
- **Correcting yourself.** If a later measurement contradicts what you first reported, say so. It is never unwelcome, and it prevents a working register being "fixed" into a broken one.
72+
- **Saying what you already ruled out**, and how. It stops the same ground being covered twice.
73+
- **Telling us it's working.** Confirmation that a fix landed is what lets an issue close, and a report that something works on hardware nobody else has is useful in its own right.
7474

7575
## Things that slow it down
7676

0 commit comments

Comments
 (0)