Skip to content

Commit 8c14d11

Browse files
0xAHAclaude
andcommitted
docs: replace the single-name contributor table with docs shortcuts and open thanks
The Hardware Contributors table had exactly one entry. With one name it reads as if nobody else has contributed, and as more are added it becomes a maintenance burden that quietly excludes whoever was missed. Replaced with a Thanks section that describes the kind of contribution that actually moves this project -- scans at two operating points, a noticed 0.0 C reading, a protocol document obtained from Growatt -- and points at where credit already lives: the release notes, the originating issue, and comments beside the registers each report established. That keeps attribution attached to the thing it explains instead of in a list that goes stale. Also adds a Documentation table linking the eight most useful pages. The site was linked once at the top with no indication of what is on it. All nine URLs verified 200. Co-Authored-By: Claude <noreply@anthropic.com>
1 parent a83f850 commit 8c14d11

1 file changed

Lines changed: 35 additions & 7 deletions

File tree

README.md

Lines changed: 35 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,21 @@ The setup wizard runs auto-detection automatically for VPP-capable inverters. Fo
4949

5050
---
5151

52+
## Documentation
53+
54+
| Page | What it covers |
55+
| --- | --- |
56+
| [Supported Models](https://0xaha.github.io/Growatt_ModbusTCP/hardware/models/) | Which profile matches your inverter |
57+
| [Auto-Detection](https://0xaha.github.io/Growatt_ModbusTCP/hardware/autodetection/) | How the profile is chosen, and how to override it |
58+
| [Entity Reference](https://0xaha.github.io/Growatt_ModbusTCP/controls/entity-reference/) | Every sensor and control, and what it means |
59+
| [Battery & Scheduling](https://0xaha.github.io/Growatt_ModbusTCP/controls/battery-scheduling/) | Charge/discharge limits and time-of-use periods |
60+
| [RS485 Gateways](https://0xaha.github.io/Growatt_ModbusTCP/troubleshooting/rs485-gateways/) | Which adapters work, and diagnosing one that doesn't |
61+
| [DTC Debugging](https://0xaha.github.io/Growatt_ModbusTCP/troubleshooting/dtc-debugging/) | Device type codes and profile mappings |
62+
| [Raising an Issue](https://0xaha.github.io/Growatt_ModbusTCP/troubleshooting/raising-an-issue/) | What to include so it can actually be diagnosed |
63+
| [Protocol Reference](https://0xaha.github.io/Growatt_ModbusTCP/developer/protocol-vpp/) | Register maps for V1.39, VPP and off-grid |
64+
65+
---
66+
5267
## Support
5368

5469
- **Issues & bug reports:** [GitHub Issues](https://github.com/0xAHA/Growatt_ModbusTCP/issues)
@@ -62,14 +77,27 @@ MIT License — see [LICENSE](LICENSE)
6277

6378
---
6479

65-
**Made with ☀️ and ☕ by [@0xAHA](https://github.com/0xAHA)**
80+
## Thanks
6681

67-
---
82+
This integration is built almost entirely on evidence from people's own hardware. Register
83+
maps get confirmed because someone ran a scan at two different times of day; wrong mappings
84+
get found because someone noticed a battery reading 0.0 °C and said so; whole model
85+
families get supported because someone asked Growatt for a protocol document and shared it.
6886

69-
## Hardware Contributors
87+
Several of the most useful reports were people **correcting their own earlier findings**
88+
after measuring properly — which is what stopped working registers being "fixed" into
89+
broken ones.
7090

71-
The following community members contributed live hardware testing, field diagnostics, and official protocol documentation that directly shaped this integration:
91+
Contributions are credited where they're used: in the
92+
[release notes](https://github.com/0xAHA/Growatt_ModbusTCP/releases), in the issue each one
93+
came from, and in comments beside the registers they established. That keeps the credit
94+
attached to the thing it explains, rather than in a list that goes stale and quietly
95+
excludes whoever was added last.
7296

73-
| Contributor | Hardware | Contribution |
74-
| --- | --- | --- |
75-
| [@Wojak129](https://github.com/Wojak129) | WIT 15KTL3 + DIY 32 kWh battery (EVE 314Ah / JK BMS) | DTC 5603 field-confirmation, VPP register scanning, safety limit discovery (reg 30201 fault trigger), official VPP protocol documentation obtained from Growatt service |
97+
If you have an inverter model or gateway that isn't well covered,
98+
[a register scan](https://0xaha.github.io/Growatt_ModbusTCP/troubleshooting/diagnostic-service/)
99+
is the single most useful thing you can contribute.
100+
101+
---
102+
103+
**Made with ☀️ and ☕ by [@0xAHA](https://github.com/0xAHA)**

0 commit comments

Comments
 (0)