ecowitt-modbus 0.2.0__tar.gz

ecowitt_modbus-0.2.0/.github/workflows/ci.yml

@@ -0,0 +1,52 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - develop
+      - main
+  pull_request:
+    branches:
+      - develop
+
+permissions:
+  contents: read
+
+jobs:
+  quality:
+    name: Quality checks
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - name: Install package and test tools
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e .
+          python -m pip install \
+            "pytest>=8,<10" \
+            "pytest-asyncio>=0.24,<2" \
+            "ruff==0.15.22" \
+            "build>=1,<2"
+
+      - name: Check formatting
+        run: python -m ruff format --check .
+
+      - name: Run Ruff
+        run: python -m ruff check .
+
+      - name: Compile sources
+        run: python -m compileall -q src tests
+
+      - name: Run tests
+        run: python -m pytest
+
+      - name: Build package
+        run: python -m build

ecowitt_modbus-0.2.0/.github/workflows/enforce-develop.yml

@@ -0,0 +1,32 @@
+name: Reject PRs to main
+
+on:
+  pull_request:
+    branches:
+      - main
+    types:
+      - opened
+      - edited
+      - synchronize
+      - reopened
+      - ready_for_review
+
+permissions:
+  contents: read
+
+jobs:
+  guard:
+    name: Only develop may target main
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Block PRs to main unless the source is local develop
+        if: >-
+          ${{
+            github.event.pull_request.head.ref != 'develop' ||
+            github.event.pull_request.head.repo.full_name != github.repository
+          }}
+        run: |
+          echo "❌ PRs to :main can only be created from the local :develop branch."
+          echo "Please create the PR against :develop instead."
+          exit 1

ecowitt_modbus-0.2.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

ecowitt_modbus-0.2.0/.gitignore

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

ecowitt_modbus-0.2.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]

ecowitt_modbus-0.2.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.

ecowitt_modbus-0.2.0/PKG-INFO

@@ -0,0 +1,122 @@
+Metadata-Version: 2.5
+Name: ecowitt-modbus
+Version: 0.2.0
+Summary: Read Fine Offset / Ecowitt weather sensors over Modbus.
+Project-URL: Homepage, https://github.com/iainchesworth/ecowitt-modbus
+Author: ecowitt-modbus contributors
+License: Apache-2.0
+License-File: LICENSE
+Keywords: ecowitt,fine-offset,home-assistant,modbus,weather,wn69lp,ws90
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Home Automation
+Requires-Python: >=3.12
+Requires-Dist: modbus-connection<5,>=4.8.1
+Provides-Extra: cli
+Requires-Dist: modbus-connection[tmodbus]<5,>=4.8.1; extra == 'cli'
+Description-Content-Type: text/markdown
+
+# `ecowitt-modbus` Python library
+
+[![CI](https://github.com/iainchesworth/ecowitt-modbus/actions/workflows/ci.yml/badge.svg?branch=develop)](https://github.com/iainchesworth/ecowitt-modbus/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/ecowitt-modbus.svg)](https://pypi.org/project/ecowitt-modbus/)
+[![Python](https://img.shields.io/pypi/pyversions/ecowitt-modbus.svg)](https://pypi.org/project/ecowitt-modbus/)
+[![License](https://img.shields.io/github/license/iainchesworth/ecowitt-modbus.svg)](LICENSE)
+
+`ecowitt-modbus` is an asynchronous, transport-independent Python library for communicating with **Fine Offset / Ecowitt** weather sensors over Modbus RTU (including RTU-over-TCP, the common way these sensors are bridged onto a network).
+
+The library was developed as the backend for a corresponding Home Assistant integration. As it is kept independent of Home Assistant, it can also be used by other Python applications and projects.
+
+## Supported devices
+
+| Device | Specification | Default address | Comments |
+| :----- | :------------ | :-------------- | :------- |
+| Fine Offset / Ecowitt WS90 | Modbus RTU V1.0.6 | `0x90` (144) | All-in-one weather sensor array with no moving parts (light, UV, temperature, humidity, wind, rain, pressure) |
+| Fine Offset / Ecowitt WN69LP | Modbus RTU V1.0.2 | `0x24` (36) | Wired RS485 7-in-1 sensor array with a mechanical anemometer and tipping-bucket rain gauge |
+
+The two devices share almost no register layout. They are modelled separately and only present a common interface, not common internals.
+
+## Usage
+
+Construct the model you have with a [`modbus_connection.ModbusUnit`](https://github.com/home-assistant-libs/modbus-connection), confirm the right device answered, then poll it:
+
+```python
+from ecowitt_modbus import WS90
+
+device = WS90(unit)
+await device.async_probe()
+await device.async_update()
+
+print(device.sensors.temperature)   # 26.2
+print(device.sensors.wind_speed)    # 1.2
+```
+
+An application that lets a user pick the model can look the class up by name instead of branching:
+
+```python
+from ecowitt_modbus import SUPPORTED_MODELS
+
+device = SUPPORTED_MODELS["WN69LP"](unit)
+```
+
+`async_probe()` raises `NotThisDeviceError` when something answers but is not the model asked for. How much it can confirm depends on the device — see [Identifying a device](#identifying-a-device) below.
+
+## Data provided by the library
+
+Every supported model reports light, UV index, temperature, humidity, wind speed, gust speed, wind direction, rainfall, and absolute pressure. Beyond that they differ:
+
+| | WS90 | WN69LP |
+| :-- | :--- | :----- |
+| Rainfall resolution | 0.1mm, plus a 0.01mm counter | 0.254mm (0.01in tipping bucket) |
+| UV index encoding | tenths | whole numbers |
+| Battery / supply voltage | archived history only | live registers |
+| 30-minute rolling history | yes, 11 parameters at one sample per minute | no |
+| Recent-rainfall register | no | yes |
+| Firmware version | not reported | reported (specification V1.0.2 and later) |
+
+Both models also expose their RS-485 settings, and accept validated writes to the two settable identity registers (baud rate and device address).
+
+The WS90's history block is 330 registers wide and changes once a minute, so it is polled separately from the live readings:
+
+```python
+await device.async_update_history()
+print(device.history.battery_voltage)
+```
+
+### Identifying a device
+
+The two models differ in how confidently a caller can tell what it is talking to, which matters for any application that needs to recognise a device again later:
+
+- The **WS90** reports a fixed device code and a 32-bit device ID. `async_probe()` is a positive identification, and `device.serial_number` is stable across changes of host, port, and device address.
+- The **WN69LP** reports neither. `device.serial_number` is always `None`, and `async_probe()` can only reject a responder whose readings fall outside the physical ranges the specification documents (for example over 100% humidity). That rules out most unrelated devices, but it cannot distinguish a WN69LP from another device whose registers happen to decode plausibly at the same addresses.
+
+## Scope
+
+The library reads live weather readings, RS-485 communication settings, and — on the WS90 — the 30-minute rolling history the sensor archives internally.
+
+It does not implement:
+
+- the WS90's "on-demand measurement" command registers (`0x9C92`-`0x9C9A`), which duplicate the live readings with tighter timing at the cost of a write-then-wait-then-read sequence,
+- the WN69LP's automatic reporting mode (register `0x162`), which has the device push readings unprompted rather than answer polls,
+- either device's write-only command registers (rainfall reset, software reset),
+- the recovery command that reads or sets the baud rate and address when they are unknown, which is a non-Modbus framed exchange.
+
+The library does **not** create or own the Modbus transport. Applications provide a [`modbus_connection.ModbusUnit`](https://github.com/home-assistant-libs/modbus-connection) and may use any backend `modbus-connection` supports (pymodbus, tmodbus, ...).
+
+## Testing and validation
+
+Decode logic (scale, offset, and invalid-value handling) is cross-checked against the manufacturers' own worked examples in the WS90 Modbus RTU V1.0.6 and WN69LP Modbus RTU V1.0.2 specifications. The WS90 model is additionally verified against a live sensor.
+
+Software tests run against an in-memory mock Modbus backend (via `modbus-connection`'s pytest plugin) — no real device or server is needed to run the test suite. The register images those tests use are exported as `ecowitt_modbus.testing` so consuming applications can reuse them.
+
+## Documentation, development and contribution guidelines
+
+Run `script/run_checks.sh` before opening a pull request — it mirrors the CI workflow (formatting, lint, compile, tests, build) in one command. `script/format_code.sh` applies formatting and safe lint fixes only. `script/query.py` is a standalone CLI for querying a real sensor over TCP or serial; run it with `--help` for usage.
+
+Contributions target the `develop` branch; `main` only ever receives fast-forwards from `develop` (enforced in CI).
+
+## Related projects
+
+This library is one of three repositories for Ecowitt Modbus support in Home Assistant:
+
+* [`ha-ecowitt-modbus`](https://github.com/iainchesworth/ha-ecowitt-modbus) — a HACS-installable custom integration, vendoring this library.
+* [`ha-core-ws90`](https://github.com/iainchesworth/ha-core-ws90) — a `home-assistant/core` fork adding this as a built-in integration (branch `ecowitt-ws90-integration`).

ecowitt_modbus-0.2.0/README.md

@@ -0,0 +1,105 @@
+# `ecowitt-modbus` Python library
+
+[![CI](https://github.com/iainchesworth/ecowitt-modbus/actions/workflows/ci.yml/badge.svg?branch=develop)](https://github.com/iainchesworth/ecowitt-modbus/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/ecowitt-modbus.svg)](https://pypi.org/project/ecowitt-modbus/)
+[![Python](https://img.shields.io/pypi/pyversions/ecowitt-modbus.svg)](https://pypi.org/project/ecowitt-modbus/)
+[![License](https://img.shields.io/github/license/iainchesworth/ecowitt-modbus.svg)](LICENSE)
+
+`ecowitt-modbus` is an asynchronous, transport-independent Python library for communicating with **Fine Offset / Ecowitt** weather sensors over Modbus RTU (including RTU-over-TCP, the common way these sensors are bridged onto a network).
+
+The library was developed as the backend for a corresponding Home Assistant integration. As it is kept independent of Home Assistant, it can also be used by other Python applications and projects.
+
+## Supported devices
+
+| Device | Specification | Default address | Comments |
+| :----- | :------------ | :-------------- | :------- |
+| Fine Offset / Ecowitt WS90 | Modbus RTU V1.0.6 | `0x90` (144) | All-in-one weather sensor array with no moving parts (light, UV, temperature, humidity, wind, rain, pressure) |
+| Fine Offset / Ecowitt WN69LP | Modbus RTU V1.0.2 | `0x24` (36) | Wired RS485 7-in-1 sensor array with a mechanical anemometer and tipping-bucket rain gauge |
+
+The two devices share almost no register layout. They are modelled separately and only present a common interface, not common internals.
+
+## Usage
+
+Construct the model you have with a [`modbus_connection.ModbusUnit`](https://github.com/home-assistant-libs/modbus-connection), confirm the right device answered, then poll it:
+
+```python
+from ecowitt_modbus import WS90
+
+device = WS90(unit)
+await device.async_probe()
+await device.async_update()
+
+print(device.sensors.temperature)   # 26.2
+print(device.sensors.wind_speed)    # 1.2
+```
+
+An application that lets a user pick the model can look the class up by name instead of branching:
+
+```python
+from ecowitt_modbus import SUPPORTED_MODELS
+
+device = SUPPORTED_MODELS["WN69LP"](unit)
+```
+
+`async_probe()` raises `NotThisDeviceError` when something answers but is not the model asked for. How much it can confirm depends on the device — see [Identifying a device](#identifying-a-device) below.
+
+## Data provided by the library
+
+Every supported model reports light, UV index, temperature, humidity, wind speed, gust speed, wind direction, rainfall, and absolute pressure. Beyond that they differ:
+
+| | WS90 | WN69LP |
+| :-- | :--- | :----- |
+| Rainfall resolution | 0.1mm, plus a 0.01mm counter | 0.254mm (0.01in tipping bucket) |
+| UV index encoding | tenths | whole numbers |
+| Battery / supply voltage | archived history only | live registers |
+| 30-minute rolling history | yes, 11 parameters at one sample per minute | no |
+| Recent-rainfall register | no | yes |
+| Firmware version | not reported | reported (specification V1.0.2 and later) |
+
+Both models also expose their RS-485 settings, and accept validated writes to the two settable identity registers (baud rate and device address).
+
+The WS90's history block is 330 registers wide and changes once a minute, so it is polled separately from the live readings:
+
+```python
+await device.async_update_history()
+print(device.history.battery_voltage)
+```
+
+### Identifying a device
+
+The two models differ in how confidently a caller can tell what it is talking to, which matters for any application that needs to recognise a device again later:
+
+- The **WS90** reports a fixed device code and a 32-bit device ID. `async_probe()` is a positive identification, and `device.serial_number` is stable across changes of host, port, and device address.
+- The **WN69LP** reports neither. `device.serial_number` is always `None`, and `async_probe()` can only reject a responder whose readings fall outside the physical ranges the specification documents (for example over 100% humidity). That rules out most unrelated devices, but it cannot distinguish a WN69LP from another device whose registers happen to decode plausibly at the same addresses.
+
+## Scope
+
+The library reads live weather readings, RS-485 communication settings, and — on the WS90 — the 30-minute rolling history the sensor archives internally.
+
+It does not implement:
+
+- the WS90's "on-demand measurement" command registers (`0x9C92`-`0x9C9A`), which duplicate the live readings with tighter timing at the cost of a write-then-wait-then-read sequence,
+- the WN69LP's automatic reporting mode (register `0x162`), which has the device push readings unprompted rather than answer polls,
+- either device's write-only command registers (rainfall reset, software reset),
+- the recovery command that reads or sets the baud rate and address when they are unknown, which is a non-Modbus framed exchange.
+
+The library does **not** create or own the Modbus transport. Applications provide a [`modbus_connection.ModbusUnit`](https://github.com/home-assistant-libs/modbus-connection) and may use any backend `modbus-connection` supports (pymodbus, tmodbus, ...).
+
+## Testing and validation
+
+Decode logic (scale, offset, and invalid-value handling) is cross-checked against the manufacturers' own worked examples in the WS90 Modbus RTU V1.0.6 and WN69LP Modbus RTU V1.0.2 specifications. The WS90 model is additionally verified against a live sensor.
+
+Software tests run against an in-memory mock Modbus backend (via `modbus-connection`'s pytest plugin) — no real device or server is needed to run the test suite. The register images those tests use are exported as `ecowitt_modbus.testing` so consuming applications can reuse them.
+
+## Documentation, development and contribution guidelines
+
+Run `script/run_checks.sh` before opening a pull request — it mirrors the CI workflow (formatting, lint, compile, tests, build) in one command. `script/format_code.sh` applies formatting and safe lint fixes only. `script/query.py` is a standalone CLI for querying a real sensor over TCP or serial; run it with `--help` for usage.
+
+Contributions target the `develop` branch; `main` only ever receives fast-forwards from `develop` (enforced in CI).
+
+## Related projects
+
+This library is one of three repositories for Ecowitt Modbus support in Home Assistant:
+
+* [`ha-ecowitt-modbus`](https://github.com/iainchesworth/ha-ecowitt-modbus) — a HACS-installable custom integration, vendoring this library.
+* [`ha-core-ws90`](https://github.com/iainchesworth/ha-core-ws90) — a `home-assistant/core` fork adding this as a built-in integration (branch `ecowitt-ws90-integration`).

ecowitt_modbus-0.2.0/pyproject.toml

@@ -0,0 +1,53 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "ecowitt-modbus"
+version = "0.2.0"
+description = "Read Fine Offset / Ecowitt weather sensors over Modbus."
+readme = "README.md"
+requires-python = ">=3.12"
+license = { text = "Apache-2.0" }
+authors = [{ name = "ecowitt-modbus contributors" }]
+keywords = ["modbus", "ecowitt", "fine-offset", "ws90", "wn69lp", "weather", "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>=4.8.1,<5"]
+
+[project.optional-dependencies]
+# Concrete backend for the script/query.py CLI (pip install ecowitt-modbus[cli]).
+cli = ["modbus-connection[tmodbus]>=4.8.1,<5"]
+
+[project.urls]
+Homepage = "https://github.com/iainchesworth/ecowitt-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/ecowitt_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"]
+
+[tool.ruff.lint.isort]
+combine-as-imports = true

ecowitt_modbus-0.2.0/script/format_code.sh

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
+PYTHON_BIN="${PYTHON_BIN:-python}"
+
+cd "$ROOT_DIR"
+
+if ! "$PYTHON_BIN" -m ruff --version >/dev/null 2>&1; then
+    echo "==> Installing Ruff"
+    "$PYTHON_BIN" -m pip install \
+        --root-user-action=ignore \
+        "ruff>=0.15,<0.16"
+fi
+
+echo "==> Applying safe Ruff fixes"
+"$PYTHON_BIN" -m ruff check --fix .
+
+echo "==> Formatting files"
+"$PYTHON_BIN" -m ruff format .
+
+echo "==> Verifying Ruff checks"
+"$PYTHON_BIN" -m ruff check .
+
+echo "==> Formatting completed"