weider-modbus 0.1.0__tar.gz

weider_modbus-0.1.0/.gitignore

@@ -0,0 +1,220 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+*.lcov
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# uv
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs/Zensical documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore that
+#   can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, you
+#   could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

weider_modbus-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 schadom
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

weider_modbus-0.1.0/PKG-INFO

@@ -0,0 +1,160 @@
+Metadata-Version: 2.5
+Name: weider-modbus
+Version: 0.1.0
+Summary: Async Python library for the Modbus TCP interface of Weider heat pumps, built on modbus-connection
+Project-URL: Homepage, https://github.com/schadom/weider-modbus
+Project-URL: Source, https://github.com/schadom/weider-modbus
+Project-URL: Issues, https://github.com/schadom/weider-modbus/issues
+Author: schadom
+License-Expression: MIT
+License-File: LICENSE
+Keywords: heat pump,home-assistant,modbus,weider,wt16
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Home Automation
+Classifier: Typing :: Typed
+Requires-Python: >=3.13
+Requires-Dist: modbus-connection>=4.12.1
+Description-Content-Type: text/markdown
+
+# weider-modbus
+
+Async Python library for the Modbus TCP interface of Weider WT16 heat pumps,
+built on [modbus-connection](https://github.com/home-assistant-libs/modbus-connection).
+
+> [!IMPORTANT]
+> This library is not affiliated with Weider Wärmepumpen GmbH and is provided
+> as-is and without warranty.
+
+The library only reads and writes registers. It takes a `ModbusUnit` and never
+opens a connection itself, so it works over any modbus-connection backend
+(tmodbus, pymodbus, or the in-memory mock). It is used by the
+[Weider WT16 Home Assistant integration](https://github.com/schadom/hacs_weider).
+
+## Installation
+
+```bash
+pip install weider-modbus
+```
+
+The library depends only on the backend-neutral `modbus-connection`
+interface. To open a connection yourself, also install a backend:
+
+```bash
+pip install "modbus-connection[tmodbus]"
+```
+
+## Usage
+
+```python
+import asyncio
+
+from modbus_connection import ModbusTcpParams
+from modbus_connection.tmodbus import ModbusConnection
+
+from weider_modbus import WeiderWT16, plausible_temperature
+
+
+async def main() -> None:
+    connection = ModbusConnection(ModbusTcpParams(host="192.168.1.50", port=502))
+    try:
+        device = WeiderWT16(connection.for_unit(1))
+        await device.async_update()
+
+        print("Hot water:", device.measurements.hot_water_temperature)
+        outdoor = plausible_temperature(device.measurements.outdoor_temperature)
+        print("Outdoor:", outdoor)
+        print("Compressor running:", device.digital_inputs.compressor)
+        print("SG Ready mode:", device.sg_ready_mode)
+
+        await device.async_set_hot_water_target(47.5)
+    finally:
+        await connection.close()
+
+
+asyncio.run(main())
+```
+
+### Components
+
+| Attribute | Modbus space | Content |
+| --- | --- | --- |
+| `device.measurements` | Input registers (FC04) | Temperatures, volume flow, runtimes, mixer position, active error text |
+| `device.settings` | Holding registers (FC03/FC16) | Hot water and room target temperatures |
+| `device.digital_inputs` | Discrete inputs (FC02) | Compressor, pumps, valves, blocks, SG Ready inputs |
+
+A value reads as `None` until the first successful poll, or if the device
+does not provide the register.
+
+### Optional registers
+
+Some firmware versions do not provide every register. The room temperature,
+room target, mixer position, runtimes, active error text and any digital input
+are optional. If the device rejects one of them with an illegal data address,
+the library drops that register on the first poll and stops reading it. Any
+other register error still raises, so real problems are not hidden.
+
+### Errors
+
+`async_update()` raises a `modbus_connection.ModbusError` subclass (or
+`TimeoutError` / `OSError` from the transport) when a poll fails. The shared
+connection reopens on the next request, so the caller can simply retry.
+
+The target setters raise `ValueError` for a value outside the allowed range
+(hot water 15–55 °C, room 15–35 °C), before anything is written.
+
+### Helpers
+
+- `plausible_temperature(value)` returns `None` for the placeholder values the
+  device reports for an unconnected sensor (outside −45 to 150 °C).
+- `clean_error_text(value)` strips the padding from the active error text and
+  returns `None` when there is no error.
+- `sg_ready_mode(...)` and `device.sg_ready_mode` derive the SG Ready operating
+  state (BZ1–BZ4) from the digital inputs.
+
+## Hardware verification
+
+The register addresses, the signed 0.1 °C temperature format and the
+multi-register word order come from the existing integration. Confirm them
+against your WT16 documentation, especially for negative temperatures. The
+test simulator checks the software against this map, not the map against a
+real heat pump.
+
+## Development
+
+Requires Python 3.13 or newer and [uv](https://docs.astral.sh/uv/).
+
+```bash
+uv sync
+uv run pytest
+uv run ruff check .
+uv run ruff format --check .
+uv run mypy
+```
+
+To run the synthetic WT16 on port 5020 for manual testing:
+
+```bash
+uv run python -m tests.simulator
+```
+
+## Releasing
+
+Releases are published to PyPI from GitHub Actions with
+[trusted publishing](https://docs.pypi.org/trusted-publishers/).
+
+1. Set the new `version` in `pyproject.toml` and merge it to `main`.
+2. Create a GitHub release with a tag equal to that version (for example
+   `0.1.0`).
+3. The `Publish` workflow builds the package and uploads it to PyPI.
+
+A version number can be published only once.
+
+## License
+
+MIT. See [LICENSE](LICENSE).

weider_modbus-0.1.0/README.md

@@ -0,0 +1,136 @@
+# weider-modbus
+
+Async Python library for the Modbus TCP interface of Weider WT16 heat pumps,
+built on [modbus-connection](https://github.com/home-assistant-libs/modbus-connection).
+
+> [!IMPORTANT]
+> This library is not affiliated with Weider Wärmepumpen GmbH and is provided
+> as-is and without warranty.
+
+The library only reads and writes registers. It takes a `ModbusUnit` and never
+opens a connection itself, so it works over any modbus-connection backend
+(tmodbus, pymodbus, or the in-memory mock). It is used by the
+[Weider WT16 Home Assistant integration](https://github.com/schadom/hacs_weider).
+
+## Installation
+
+```bash
+pip install weider-modbus
+```
+
+The library depends only on the backend-neutral `modbus-connection`
+interface. To open a connection yourself, also install a backend:
+
+```bash
+pip install "modbus-connection[tmodbus]"
+```
+
+## Usage
+
+```python
+import asyncio
+
+from modbus_connection import ModbusTcpParams
+from modbus_connection.tmodbus import ModbusConnection
+
+from weider_modbus import WeiderWT16, plausible_temperature
+
+
+async def main() -> None:
+    connection = ModbusConnection(ModbusTcpParams(host="192.168.1.50", port=502))
+    try:
+        device = WeiderWT16(connection.for_unit(1))
+        await device.async_update()
+
+        print("Hot water:", device.measurements.hot_water_temperature)
+        outdoor = plausible_temperature(device.measurements.outdoor_temperature)
+        print("Outdoor:", outdoor)
+        print("Compressor running:", device.digital_inputs.compressor)
+        print("SG Ready mode:", device.sg_ready_mode)
+
+        await device.async_set_hot_water_target(47.5)
+    finally:
+        await connection.close()
+
+
+asyncio.run(main())
+```
+
+### Components
+
+| Attribute | Modbus space | Content |
+| --- | --- | --- |
+| `device.measurements` | Input registers (FC04) | Temperatures, volume flow, runtimes, mixer position, active error text |
+| `device.settings` | Holding registers (FC03/FC16) | Hot water and room target temperatures |
+| `device.digital_inputs` | Discrete inputs (FC02) | Compressor, pumps, valves, blocks, SG Ready inputs |
+
+A value reads as `None` until the first successful poll, or if the device
+does not provide the register.
+
+### Optional registers
+
+Some firmware versions do not provide every register. The room temperature,
+room target, mixer position, runtimes, active error text and any digital input
+are optional. If the device rejects one of them with an illegal data address,
+the library drops that register on the first poll and stops reading it. Any
+other register error still raises, so real problems are not hidden.
+
+### Errors
+
+`async_update()` raises a `modbus_connection.ModbusError` subclass (or
+`TimeoutError` / `OSError` from the transport) when a poll fails. The shared
+connection reopens on the next request, so the caller can simply retry.
+
+The target setters raise `ValueError` for a value outside the allowed range
+(hot water 15–55 °C, room 15–35 °C), before anything is written.
+
+### Helpers
+
+- `plausible_temperature(value)` returns `None` for the placeholder values the
+  device reports for an unconnected sensor (outside −45 to 150 °C).
+- `clean_error_text(value)` strips the padding from the active error text and
+  returns `None` when there is no error.
+- `sg_ready_mode(...)` and `device.sg_ready_mode` derive the SG Ready operating
+  state (BZ1–BZ4) from the digital inputs.
+
+## Hardware verification
+
+The register addresses, the signed 0.1 °C temperature format and the
+multi-register word order come from the existing integration. Confirm them
+against your WT16 documentation, especially for negative temperatures. The
+test simulator checks the software against this map, not the map against a
+real heat pump.
+
+## Development
+
+Requires Python 3.13 or newer and [uv](https://docs.astral.sh/uv/).
+
+```bash
+uv sync
+uv run pytest
+uv run ruff check .
+uv run ruff format --check .
+uv run mypy
+```
+
+To run the synthetic WT16 on port 5020 for manual testing:
+
+```bash
+uv run python -m tests.simulator
+```
+
+## Releasing
+
+Releases are published to PyPI from GitHub Actions with
+[trusted publishing](https://docs.pypi.org/trusted-publishers/).
+
+1. Set the new `version` in `pyproject.toml` and merge it to `main`.
+2. Create a GitHub release with a tag equal to that version (for example
+   `0.1.0`).
+3. The `Publish` workflow builds the package and uploads it to PyPI.
+
+A version number can be published only once.
+
+## License
+
+MIT. See [LICENSE](LICENSE).

weider_modbus-0.1.0/pyproject.toml

@@ -0,0 +1,70 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "weider-modbus"
+version = "0.1.0"
+description = "Async Python library for the Modbus TCP interface of Weider heat pumps, built on modbus-connection"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "schadom" }]
+requires-python = ">=3.13"
+keywords = ["weider", "heat pump", "wt16", "modbus", "home-assistant"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Framework :: AsyncIO",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Home Automation",
+    "Typing :: Typed",
+]
+# Only the backend-neutral interface. The consumer (e.g. Home Assistant)
+# owns the connection and picks the backend.
+dependencies = ["modbus-connection>=4.12.1"]
+
+[project.urls]
+Homepage = "https://github.com/schadom/weider-modbus"
+Source = "https://github.com/schadom/weider-modbus"
+Issues = "https://github.com/schadom/weider-modbus/issues"
+
+[dependency-groups]
+dev = [
+    "modbus-connection[tmodbus]>=4.12.1",
+    "mypy>=1.19",
+    "pymodbus>=3.13,<4",
+    "pytest>=8.4",
+    "pytest-asyncio>=1.0",
+    "ruff>=0.15",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/weider_modbus"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src", "tests", "README.md", "LICENSE"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+testpaths = ["tests"]
+
+[tool.mypy]
+python_version = "3.13"
+files = ["src"]
+strict = true
+
+[tool.ruff]
+target-version = "py313"
+src = ["src"]
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "UP", "B", "D", "SIM", "RUF"]
+ignore = ["D203", "D213"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = ["D"]

weider_modbus-0.1.0/src/weider_modbus/__init__.py

@@ -0,0 +1,36 @@
+"""Async Python library for the Modbus TCP interface of Weider WT16 heat pumps."""
+
+from .components import DigitalInputs, Measurements, Settings
+from .const import (
+    HOT_WATER_TARGET_MAX,
+    HOT_WATER_TARGET_MIN,
+    MANUFACTURER,
+    MAX_PLAUSIBLE_TEMPERATURE,
+    MIN_PLAUSIBLE_TEMPERATURE,
+    MODEL,
+    ROOM_TARGET_MAX,
+    ROOM_TARGET_MIN,
+    TARGET_STEP,
+)
+from .device import WeiderWT16
+from .helpers import SgReadyMode, clean_error_text, plausible_temperature, sg_ready_mode
+
+__all__ = [
+    "HOT_WATER_TARGET_MAX",
+    "HOT_WATER_TARGET_MIN",
+    "MANUFACTURER",
+    "MAX_PLAUSIBLE_TEMPERATURE",
+    "MIN_PLAUSIBLE_TEMPERATURE",
+    "MODEL",
+    "ROOM_TARGET_MAX",
+    "ROOM_TARGET_MIN",
+    "TARGET_STEP",
+    "DigitalInputs",
+    "Measurements",
+    "Settings",
+    "SgReadyMode",
+    "WeiderWT16",
+    "clean_error_text",
+    "plausible_temperature",
+    "sg_ready_mode",
+]