trovis-modbus Python library

trovis-modbus is an asynchronous, transport-independent Python library for communicating with SAMSON TROVIS 557x heating and district heating controllers and compatible OEM variants over Modbus.

The library was developed primarily as the backend for the corresponding Samson Trovis 557x Home Assistant Integration. However, as it is strictly kept independent of Home Assistant, it can also be used by other applications and projects.

👉 Purpose and scope of this library

trovis-modbus is intended for operational monitoring and occasional fine tuning of already commissioned heating systems. It does not attempt to reproduce every controller menu, parameter level, special function, register, or coil (there are thousands of them). It is also not intended as an initial commissioning tool for new heating systems - please use the free SAMSON TROVIS-VIEW software for this.

The library:

• provides the auto-discovery and auto-configuration logic required to determine the controller model and its capabilities, the configured hydronic system, sensor and input assignments, and the relevant controller functions, parameters, and configuration settings,

• contains the controller-specific data model, including valid registers and coils, their data types and metadata, and the rules required for safe reads and writes,

• determines which datapoints are valid for the actual installation based on the detected controller model, configured hydronic system, active functions and parameters, and physical sensor/input assignments,

• does not create or own the Modbus transport. Applications using the library provide a modbus_connection.ModbusUnit and may use any backend supported by modbus-connection (pymodbus, tmodbus, ...).

An example script query.py in the code of the library shows how to build an application that can query any TROVIS heating controller by using Modbus/TCP, Modbus/RTU with ser2net, or direct serial connection.

Supported controllers

^{Note: Not all non-SAMSON models have yet been tested. The figures are based on the currently available documentation.}

👉 Data provided by the library

Depending on the controller model and its configuration, trovis-modbus provides:

• controller identity, firmware, hardware, serial, and system information,

• the current hydronic system,

• measured temperatures and other physical sensor inputs (analog, pulse, etc.),

• controller-wide functions and parameters,

• technical control circuits Rk1 through Rk4 together with their hydronic roles and data (known roles: pre-control, heating, domestic hot water, buffer, solar),

• operating modes, setpoints, pump and valve states, and controller date/time,

• derived operating information, including automatically calculated heating curves for all applicable heating circuits and an overall controller status indicator,

• neutral datapoint metadata such as unit, scale, limits, step, enum options, invalid values, and writable state,

• grouped reads and validated writes, including TROVIS write-access handling and the mechanisms required to write-enable special/protected registers.

The exact datapoints exposed for a controller therefore reflect the capabilities and configuration of the actual installation rather than a static model-wide register list.

👉 Testing and validation

All releases of the library are tested with the following hardware setup:

• 1× TROVIS 5578: dedicated testing device, Anlage 6.1 (fully equipped with 17 Pt1000 sensors),

• 1× TROVIS 5579: dedicated testing device, Anlage 5.1 (fully equipped with 17 Pt1000 sensors),

• 1× TROVIS 5576: live heating controller, Anlage 2.1 (4 required + 4 additional Pt1000 sensors).

Additional software-based tests are part of the project to ensure code quality and consistency.

👉 Manual installation

End users shouldn't have to install the library manually - it should normally be downloaded and installed automatically from pypi.org by the application using it.

For developers, or if you still want to install it manually, use:

pip install trovis-modbus

👉 Documentation, development, contributions, issue and bug reporting

The central project documentation for the entire SAMSON TROVIS 557x project, including usage and developer guidelines for all sub-projects, is maintained in the TROVIS project Wiki.

That central repository can also be used for issue and bug reporting in the Discussions section. Please use Discussions instead of opening an Issue. Thank you! :)