trovis-modbus 1.0.0__tar.gz

trovis_modbus-1.0.0/.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+      - name: Ruff format
+        run: uvx ruff format --check .
+      - name: Ruff lint
+        run: uvx ruff check .
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+      - name: Install dependencies
+        run: uv sync
+      - name: Run tests
+        run: uv run pytest

trovis_modbus-1.0.0/.github/workflows/publish.yml

@@ -0,0 +1,34 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+      - name: Set package version from release tag
+        env:
+          RELEASE_TAG: ${{ github.event.release.tag_name }}
+        run: sed -i "s/^version = \"0\\.0\\.0\"$/version = \"${RELEASE_TAG}\"/" pyproject.toml
+      - run: uv build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

trovis_modbus-1.0.0/.gitignore

@@ -0,0 +1,11 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+.venv/
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.coverage
+uv.lock

trovis_modbus-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+# Run with prek (https://github.com/j178/prek): `prek install` then commits are
+# auto-formatted; `prek run --all-files` to check everything.
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.18
+    hooks:
+      - id: ruff-format
+      - id: ruff-check
+        args: [--fix]

trovis_modbus-1.0.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

trovis_modbus-1.0.0/PKG-INFO

@@ -0,0 +1,143 @@
+Metadata-Version: 2.4
+Name: trovis-modbus
+Version: 1.0.0
+Summary: Read a Samson Trovis 557x heating controller over Modbus.
+Project-URL: Homepage, https://github.com/balloob/trovis-modbus
+Author: Trovis Modbus contributors
+License: Apache-2.0
+License-File: LICENSE
+Keywords: heating,home-assistant,modbus,samson,trovis
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Home Automation
+Requires-Python: >=3.12
+Requires-Dist: modbus-connection<4,>=3.0
+Provides-Extra: cli
+Requires-Dist: modbus-connection[pymodbus]<4,>=3.0; extra == 'cli'
+Description-Content-Type: text/markdown
+
+# trovis-modbus
+
+A standalone Python library that reads a **Samson Trovis 557x** heating
+controller over Modbus, exposed as a normal, object-oriented Python API.
+
+Addresses, scales and data types are taken from the canonical Trovis 557x point
+list (the [Tom-Bom-badil](https://github.com/Tom-Bom-badil/samson_trovis_557x)
+SmartHomeNG plugin) and **verified in tests** against a vendored copy of that
+table (`tests/reference/canonical_points.json`).
+
+## Design
+
+- It **consumes the connection abstraction**, not a backend: the API takes a
+  [`modbus_connection.ModbusUnit`](../modbus-connection) and reads/writes through
+  it. You choose the backend (pymodbus, tmodbus, …).
+- A `Trovis557x` is a tree of independently-updatable **sub-systems**, each a
+  `Component` that knows its own registers:
+
+  | Attribute | What |
+  | --- | --- |
+  | `info` | model, firmware/hardware version, serial → `DeviceInfo` |
+  | `controller` | faults, rotary switches, summer mode, frost limit, locks |
+  | `clock` | date/time as native `datetime` objects |
+  | `sensors` | every temperature input (outside, flow, return, room, storage, remote) |
+  | `heating_circuit_1` / `_2` / `_3` | space-heating circuits (RK1-3) |
+  | `hot_water` | domestic hot water (HK4): setpoints, charging, disinfection |
+
+- Each sub-system can refresh on its own and has its **own update listeners**, so
+  a single Home Assistant entity can subscribe to just the part it shows
+  (e.g. one climate entity per heating circuit).
+- Units of measurement live in each property's docstring, not in the value.
+
+## Use
+
+```python
+import asyncio
+from modbus_connection.pymodbus import connect_tcp
+from trovis_modbus import Trovis557x, OperatingMode
+
+
+async def main() -> None:
+    conn = await connect_tcp("192.168.1.50", port=502)
+    try:
+        trovis = Trovis557x(conn.for_unit(1))     # unit 1 = the controller's Modbus address
+        await trovis.async_update()
+
+        print("Outside:", trovis.sensors.outside_1, "°C")
+        print("HK1 mode:", trovis.heating_circuit_1.mode)
+        print("HK1 target:", trovis.heating_circuit_1.room_setpoint_active, "°C")
+        print("HK1 pump:", trovis.heating_circuit_1.pump_running)
+        print("HK1 curve:", trovis.heating_circuit_1.heating_curve())
+        print("Hot water:", trovis.hot_water.setpoint_active, "charging:", trovis.hot_water.charge_pump_running)
+        print("Clock:", trovis.clock.datetime)
+
+        # Writes (reverse the scaling/encoding automatically)
+        await trovis.heating_circuit_1.set_room_setpoint_day(21.5)
+        await trovis.heating_circuit_1.set_mode(OperatingMode.DAY)
+        await trovis.hot_water.start_forced_charge()
+    finally:
+        await conn.close()
+
+
+asyncio.run(main())
+```
+
+### Updating just one sub-system
+
+```python
+await trovis.hot_water.async_update()              # only reads the HK4 registers
+unsub = trovis.hot_water.add_update_listener(refresh_my_entity)
+```
+
+## Command-line tool
+
+`script/query.py` connects to a controller, reads it once, and prints every
+value — handy for checking a real device without Home Assistant. It needs a
+concrete backend, so install the `cli` extra (`pip install trovis-modbus[cli]`,
+or run via `uv run --extra cli`):
+
+```bash
+# Network gateway (RTU-over-TCP by default — how Trovis gateways work):
+uv run --extra cli python script/query.py tcp 192.168.1.50 --unit 246
+
+# Serial / USB (defaults to the Trovis 19200 8N1 line):
+uv run --extra cli python script/query.py serial /dev/ttyUSB0 --unit 246
+```
+
+Use `--port`, `--framer {rtu,socket}` (TCP) or `--baudrate`/`--parity`/… (serial)
+to override defaults; `--help` lists them all. Output is grouped by sub-system:
+
+```text
+Device
+------
+  model             Trovis 5579
+  firmware_version  3.05
+  ...
+
+Heating circuit 1
+-----------------
+  mode                  automatic
+  room_temperature      20.0 °C
+  room_setpoint_active  21.0 °C
+  flow_temperature      55.0 °C
+  pump_running          True
+  ...
+```
+
+## Develop / test
+
+```bash
+uv sync
+uv run pytest
+```
+
+The suite cross-checks every field against the canonical point list and
+exercises decoding, the heating curve, writes and listeners against the
+in-memory mock backend that ships with `modbus-connection` (its `mock_modbus_unit`
+pytest fixture) — no real Modbus server or backend is needed.
+
+Formatting/linting is [ruff](https://docs.astral.sh/ruff/); install the commit
+hook with [prek](https://github.com/j178/prek):
+
+```bash
+uvx prek install
+uvx prek run --all-files
+```

trovis_modbus-1.0.0/README.md

@@ -0,0 +1,126 @@
+# trovis-modbus
+
+A standalone Python library that reads a **Samson Trovis 557x** heating
+controller over Modbus, exposed as a normal, object-oriented Python API.
+
+Addresses, scales and data types are taken from the canonical Trovis 557x point
+list (the [Tom-Bom-badil](https://github.com/Tom-Bom-badil/samson_trovis_557x)
+SmartHomeNG plugin) and **verified in tests** against a vendored copy of that
+table (`tests/reference/canonical_points.json`).
+
+## Design
+
+- It **consumes the connection abstraction**, not a backend: the API takes a
+  [`modbus_connection.ModbusUnit`](../modbus-connection) and reads/writes through
+  it. You choose the backend (pymodbus, tmodbus, …).
+- A `Trovis557x` is a tree of independently-updatable **sub-systems**, each a
+  `Component` that knows its own registers:
+
+  | Attribute | What |
+  | --- | --- |
+  | `info` | model, firmware/hardware version, serial → `DeviceInfo` |
+  | `controller` | faults, rotary switches, summer mode, frost limit, locks |
+  | `clock` | date/time as native `datetime` objects |
+  | `sensors` | every temperature input (outside, flow, return, room, storage, remote) |
+  | `heating_circuit_1` / `_2` / `_3` | space-heating circuits (RK1-3) |
+  | `hot_water` | domestic hot water (HK4): setpoints, charging, disinfection |
+
+- Each sub-system can refresh on its own and has its **own update listeners**, so
+  a single Home Assistant entity can subscribe to just the part it shows
+  (e.g. one climate entity per heating circuit).
+- Units of measurement live in each property's docstring, not in the value.
+
+## Use
+
+```python
+import asyncio
+from modbus_connection.pymodbus import connect_tcp
+from trovis_modbus import Trovis557x, OperatingMode
+
+
+async def main() -> None:
+    conn = await connect_tcp("192.168.1.50", port=502)
+    try:
+        trovis = Trovis557x(conn.for_unit(1))     # unit 1 = the controller's Modbus address
+        await trovis.async_update()
+
+        print("Outside:", trovis.sensors.outside_1, "°C")
+        print("HK1 mode:", trovis.heating_circuit_1.mode)
+        print("HK1 target:", trovis.heating_circuit_1.room_setpoint_active, "°C")
+        print("HK1 pump:", trovis.heating_circuit_1.pump_running)
+        print("HK1 curve:", trovis.heating_circuit_1.heating_curve())
+        print("Hot water:", trovis.hot_water.setpoint_active, "charging:", trovis.hot_water.charge_pump_running)
+        print("Clock:", trovis.clock.datetime)
+
+        # Writes (reverse the scaling/encoding automatically)
+        await trovis.heating_circuit_1.set_room_setpoint_day(21.5)
+        await trovis.heating_circuit_1.set_mode(OperatingMode.DAY)
+        await trovis.hot_water.start_forced_charge()
+    finally:
+        await conn.close()
+
+
+asyncio.run(main())
+```
+
+### Updating just one sub-system
+
+```python
+await trovis.hot_water.async_update()              # only reads the HK4 registers
+unsub = trovis.hot_water.add_update_listener(refresh_my_entity)
+```
+
+## Command-line tool
+
+`script/query.py` connects to a controller, reads it once, and prints every
+value — handy for checking a real device without Home Assistant. It needs a
+concrete backend, so install the `cli` extra (`pip install trovis-modbus[cli]`,
+or run via `uv run --extra cli`):
+
+```bash
+# Network gateway (RTU-over-TCP by default — how Trovis gateways work):
+uv run --extra cli python script/query.py tcp 192.168.1.50 --unit 246
+
+# Serial / USB (defaults to the Trovis 19200 8N1 line):
+uv run --extra cli python script/query.py serial /dev/ttyUSB0 --unit 246
+```
+
+Use `--port`, `--framer {rtu,socket}` (TCP) or `--baudrate`/`--parity`/… (serial)
+to override defaults; `--help` lists them all. Output is grouped by sub-system:
+
+```text
+Device
+------
+  model             Trovis 5579
+  firmware_version  3.05
+  ...
+
+Heating circuit 1
+-----------------
+  mode                  automatic
+  room_temperature      20.0 °C
+  room_setpoint_active  21.0 °C
+  flow_temperature      55.0 °C
+  pump_running          True
+  ...
+```
+
+## Develop / test
+
+```bash
+uv sync
+uv run pytest
+```
+
+The suite cross-checks every field against the canonical point list and
+exercises decoding, the heating curve, writes and listeners against the
+in-memory mock backend that ships with `modbus-connection` (its `mock_modbus_unit`
+pytest fixture) — no real Modbus server or backend is needed.
+
+Formatting/linting is [ruff](https://docs.astral.sh/ruff/); install the commit
+hook with [prek](https://github.com/j178/prek):
+
+```bash
+uvx prek install
+uvx prek run --all-files
+```

trovis_modbus-1.0.0/pyproject.toml

@@ -0,0 +1,50 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "trovis-modbus"
+version = "1.0.0"
+description = "Read a Samson Trovis 557x heating controller over Modbus."
+readme = "README.md"
+requires-python = ">=3.12"
+license = { text = "Apache-2.0" }
+authors = [{ name = "Trovis Modbus contributors" }]
+keywords = ["modbus", "trovis", "samson", "heating", "home-assistant"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Topic :: Home Automation",
+]
+# Protocol + the device-modelling framework (modbus_connection.model). The caller
+# injects a ModbusUnit built from whichever backend they choose.
+dependencies = ["modbus-connection>=3.0,<4"]
+
+[project.optional-dependencies]
+# Concrete backend for the script/query.py CLI (pip install trovis-modbus[cli]).
+cli = ["modbus-connection[pymodbus]>=3.0,<4"]
+
+[project.urls]
+Homepage = "https://github.com/balloob/trovis-modbus"
+
+[dependency-groups]
+dev = [
+    "pytest>=8",
+    "pytest-asyncio>=0.24",
+    # Tests run against the in-memory mock backend that ships with
+    # modbus-connection (its pytest plugin is auto-registered); no real backend
+    # or server is needed.
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/trovis_modbus"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+
+[tool.ruff]
+target-version = "py312"
+src = ["src"]
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "UP", "B"]