Skip to content

Commit 8a09d8b

Browse files
committed
docs: add verified/unverified inverter model table
Replace the family-level summary with a per-model table listing all 12 registered inverter drivers, each marked ✅ Verified or ⚠️ Unverified. Add a 'help verify' section inviting users of unverified models to report logs so we can confirm and correct their register maps.
1 parent 5470069 commit 8a09d8b

1 file changed

Lines changed: 41 additions & 8 deletions

File tree

‎README.md‎

Lines changed: 41 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -48,24 +48,57 @@ This project is actively running on private hardware monitoring an EG4 6000XP in
4848

4949
lux-mon speaks the **Luxpower SNA** and **18KPV** register families. EG4
5050
inverters are Luxpower rebadges, so the full EG4 lineup is supported via two
51-
families:
52-
53-
| Family | Models | Register map | Status |
54-
|--------|--------|--------------|--------|
55-
| **SNA** (2-MPPT, single-phase off-grid) | EG4 6000XP, 12000XP, 6500EX-48, 3000EHV-48, Luxpower SNA | `collector/registers.py` | ✅ Capture-validated on the 6000XP |
56-
| **18KPV** (3-MPPT, split-phase 120/240V, AFCI, generator) | EG4 18KPV, 12kPV | `collector/drivers/eg4_18kpv.py` | ⚠️ Document-derived, not yet capture-validated |
51+
families. Each model below maps to one of those two register maps.
52+
53+
> **Verified vs. unverified.** A model is **✅ Verified** only when its
54+
> register map has been confirmed against a live unit (real captures, not just
55+
> the vendor's protocol document). **⚠️ Unverified** models share a register
56+
> map with a verified sibling but have *not* been independently confirmed —
57+
> they may expose extra data fields or decode some registers differently.
58+
> Treat unverified models as best-effort and report any discrepancies.
59+
60+
| Model | Setting value | Register family | Status |
61+
|-------|---------------|-----------------|--------|
62+
| EG4 6000XP | `eg4_6000xp` | SNA | ✅ Verified (reference) |
63+
| Luxpower SNA | `luxpower_sna` | SNA | ✅ Verified |
64+
| EG4 12000XP | `eg4_12000xp` | SNA | ⚠️ Unverified |
65+
| EG4 6500EX-48 | `eg4_6500ex` | SNA | ⚠️ Unverified |
66+
| EG4 3000EHV-48 | `eg4_3000ehv` | SNA | ⚠️ Unverified (legacy/discontinued) |
67+
| LuxPower LXP 6K | `lxp_6k` | SNA | ⚠️ Unverified |
68+
| BigBattery SNA-US 6K | `bigbattery_sna_6k` | SNA | ⚠️ Unverified |
69+
| EG4 18KPV | `eg4_18kpv` | 18KPV | ⚠️ Unverified (document-derived) |
70+
| EG4 12kPV | `eg4_12kpv` | 18KPV | ⚠️ Unverified |
71+
| LuxPower LXP 12K | `lxp_12k` | 18KPV | ⚠️ Unverified |
72+
| LuxPower LXP 18K | `lxp_18k` | 18KPV | ⚠️ Unverified |
73+
| Fortress Envy True 12K | `fortress_envy_12k` | 18KPV | ⚠️ Unverified |
5774

5875
- **SNA family** is the validated reference — the 6000XP map was
5976
reverse-engineered from live captures. The 12000XP, 6500EX-48, and
6077
3000EHV-48 (legacy, discontinued) share the exact same register layout.
6178
- **18KPV family** is derived from the official EG4 Modbus protocol document
62-
and has **not** been validated against a live unit. The 12kPV shares the
63-
18KPV map. Community feedback will identify any gaps.
79+
and has **not** been validated against a live unit. The 12kPV, LXP 12K/18K,
80+
and Fortress Envy True 12K share the 18KPV map.
6481
- **FlexBOSS18/21 and GridBOSS** are a *new* platform (not a Luxpower SNA
6582
rebadge) with an unknown register map. They are intentionally **not**
6683
aliased to either family — doing so would silently decode garbage. A
6784
dedicated driver is needed once their protocol is documented.
6885

86+
#### Help verify an unverified model
87+
88+
Running an unverified model? We'd love to confirm it against your hardware.
89+
If your inverter is on the list above but marked ⚠️ Unverified, please:
90+
91+
1. Set `LUX_INVERTER_MODEL` to your model's setting value and run lux-mon.
92+
2. Compare the decoded values against your inverter's own display / the
93+
vendor's monitoring app.
94+
3. If anything looks off (wrong values, missing fields, extra registers),
95+
**open a GitHub issue** (or email us the collector logs) with a redacted
96+
log excerpt so we can validate and correct the register map.
97+
98+
Confirmed-good reports let us flip a model from ⚠️ Unverified to ✅ Verified
99+
and document any model-specific differences (e.g. extra data fields the
100+
6000XP doesn't expose).
101+
69102
### In progress / near-term
70103

71104
- **Inverter Edit Mode page** — manual Read/Set for every editable EG4 6000XP holding register, mirroring the EG4 Monitor Maintenance tab.

0 commit comments

Comments
 (0)