Skip to content

docs: describe battery cell struct registers and bat_mng_struct profile layouts #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pluskal wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: describe battery cell struct registers and bat_mng_struct profile layouts #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
38f8390
docs: describe battery cell struct registers and bat_mng_struct profiles
Aug 15, 2026
a5d5ce2
registry: type profile_* payloads as UNKNOWN, not STRING
pluskal Aug 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/inverter_registry.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,31 @@ as an instance ``REGISTRY`` in the ``registry`` module and can be imported where
The following list is a complete index of all the object IDs currently maintained by the registry for use with official
vendor devices.

Struct-type registers
=====================

Some object IDs return binary structures instead of scalar values. The following layouts were determined by
reverse-engineering and verified live against a *Power Storage 6.0* (BMS software ``5615``, 4 battery modules) using
the port 8899 protocol:

* ``battery.cells[N]``: 96 bytes, 24 records of 4 bytes each: temperature (uint8, °C), cell voltage (uint16
little-endian, mV) and a status byte. Decoded by :func:`~rctclient.utils.decode_value` as ``BATTERY_MODULE_STATUS``.
Verified against ``battery.min_cell_voltage`` / ``battery.max_cell_voltage`` (matches to 0.1 mV) and
``battery.temperature``.
* ``battery.cells_resist[N]``: 96 bytes, 24 records of 4 bytes each: per-cell internal resistance (uint16 big-endian,
unit 1/256 mOhm) followed by 2 bytes of padding. Decoded as ``BATTERY_MODULE_RESISTANCE``. Format determined by
`@sfudeus <https://github.com/sfudeus>`__ (branch ``cell_resist``).
* ``battery.cells_stat[N]``: 48 bytes, four records ``u_min``, ``u_max``, ``t_min`` and ``t_max``, each consisting of
the cell index (uint32 little-endian, 0-based), a UNIX timestamp (uint32 little-endian) and the value (float32
little-endian). Decoded as ``BATTERY_MODULE_STATISTICS``. Format determined by `@sfudeus
<https://github.com/sfudeus>`__ (branch ``battery_data_decoding``); the values match the granular
``battery.cells_stat[N].*`` registers.
* ``bat_mng_struct.profile_pdc``, ``profile_pdc_max``, ``profile_load`` and ``profile_pext``: 192 bytes each,
48 float32 little-endian values (``struct`` format ``<48f``), one Watt value per 30-minute slot of the day starting
at 00:00. These are the device's internal estimates based on historic data, first described by `@SaxonWood
<https://github.com/SaxonWood>`__ in `#49 <https://github.com/svalouch/python-rctclient/issues/49>`__. No decoder is
implemented for these yet.

.. the following tables are generated from the registry in registry.py using generate_registry.py

acc_conv
Expand Down
Loading