kaco-modbus 0.1.0__tar.gz

kaco_modbus-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,15 @@
+name: CI
+on:
+  push: {branches: [main]}
+  pull_request:
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - run: uv sync
+      - run: uv run ruff check
+      - run: uv run ruff format --check
+      - run: uv run mypy
+      - run: uv run pytest -v

kaco_modbus-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,89 @@
+name: Release Please
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: "Tag to publish to PyPI (e.g. v0.1.0). Leave empty to run release-please only."
+        required: false
+        type: string
+
+permissions: {}
+
+concurrency:
+  group: release
+  cancel-in-progress: false
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    permissions:
+      contents: write
+      pull-requests: write
+    outputs:
+      release_created: ${{ steps.release.outputs.release_created }}
+      tag_name: ${{ steps.release.outputs.tag_name }}
+    steps:
+      - uses: googleapis/release-please-action@v5
+        id: release
+        with:
+          release-type: python
+
+      # release-please bumps the version in pyproject.toml but does not refresh
+      # uv.lock (which records the project's own version). Left stale, every
+      # later `uv run` rewrites uv.lock and dirties the tree / blocks commits.
+      # Regenerate it on the release PR branch so the bump and lockfile land
+      # together. Idempotent: re-runs each time release-please updates the PR.
+      - if: ${{ steps.release.outputs.prs_created == 'true' }}
+        uses: actions/checkout@v6
+        with:
+          ref: release-please--branches--${{ github.ref_name }}
+      - if: ${{ steps.release.outputs.prs_created == 'true' }}
+        uses: astral-sh/setup-uv@v8.1.0
+      - if: ${{ steps.release.outputs.prs_created == 'true' }}
+        name: Sync uv.lock on the release PR
+        run: |
+          uv lock
+          if ! git diff --quiet -- uv.lock; then
+            git config user.name "github-actions[bot]"
+            git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+            git add uv.lock
+            git commit -m "chore: sync uv.lock with release version"
+            git push origin HEAD:release-please--branches--${{ github.ref_name }}
+          fi
+
+  publish:
+    needs: release-please
+    if: needs.release-please.outputs.release_created == 'true' || inputs.tag != ''
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          ref: ${{ inputs.tag || needs.release-please.outputs.tag_name }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v8.1.0
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          verbose: true
+          skip-existing: true

kaco_modbus-0.1.0/.gitignore

@@ -0,0 +1,8 @@
+__pycache__/
+.venv/
+dist/
+*.egg-info/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+.superpowers/

kaco_modbus-0.1.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.1.0"
+}

kaco_modbus-0.1.0/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog
+
+## 0.1.0 (2026-07-11)
+
+
+### Features
+
+* dump CLI for on-site register capture ([fd5d4c6](https://github.com/g4bri3lDev/kaco-modbus/commit/fd5d4c6f23f2ab43f1407f2a1945e725e32d4e16))
+* KacoInverter entrypoint with setup probe ([af7f6ff](https://github.com/g4bri3lDev/kaco-modbus/commit/af7f6ff710991748327b56b5b507c7878a337d41))
+* registers_from_dump loader closing the capture-replay loop ([d545982](https://github.com/g4bri3lDev/kaco-modbus/commit/d54598230c58b76db18a5cecc181de5e2197d189))
+* SunSpec base discovery and model-chain walker ([7664172](https://github.com/g4bri3lDev/kaco-modbus/commit/7664172b4f60ead8c45ca2662b6e6b973ff76268))
+* SunSpec common model component ([5045579](https://github.com/g4bri3lDev/kaco-modbus/commit/5045579a8849b91b2f7e30c2c894278d25863f8c))
+* SunSpec inverter model component and enums ([bc9acb0](https://github.com/g4bri3lDev/kaco-modbus/commit/bc9acb0d1847daaa869d56d560792a408f001a1a))
+* SunSpec model 160 per-MPPT-string monitoring ([7969465](https://github.com/g4bri3lDev/kaco-modbus/commit/7969465c24147735ce627147590dbf7d33ff98c4))
+
+
+### Bug Fixes
+
+* consistent None scale-factor policy ([5d71246](https://github.com/g4bri3lDev/kaco-modbus/commit/5d71246cb3a3dd961975032858e33feaf9bb1e17))
+
+
+### Documentation
+
+* README and architecture document ([9a4a73b](https://github.com/g4bri3lDev/kaco-modbus/commit/9a4a73ba0bbdb0964e8b35f4987c575b8fcd44e5))

kaco_modbus-0.1.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.

kaco_modbus-0.1.0/PKG-INFO

@@ -0,0 +1,110 @@
+Metadata-Version: 2.4
+Name: kaco-modbus
+Version: 0.1.0
+Summary: Read a KACO blueplanet inverter over SunSpec Modbus TCP.
+Project-URL: Homepage, https://github.com/g4bri3lDev/kaco-modbus
+Author-email: g4bri3lDev <admin@g4bri3l.de>
+License: Apache-2.0
+License-File: LICENSE
+Keywords: blueplanet,home-assistant,kaco,modbus,solar,sunspec
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Home Automation
+Requires-Python: >=3.13
+Requires-Dist: modbus-connection<4,>=3.4
+Provides-Extra: cli
+Requires-Dist: modbus-connection[tmodbus]<4,>=3.4; extra == 'cli'
+Description-Content-Type: text/markdown
+
+# kaco-modbus
+
+Read a KACO blueplanet inverter over SunSpec Modbus TCP. This library discovers the device's register layout at runtime using SunSpec, then provides typed access to identity and live data. Built on the [modbus-connection](https://home-assistant-libs.github.io/modbus-connection/) library, it is the core device integration behind the [kaco Home Assistant integration](https://github.com/g4bri3lDev/kaco-modbus-hass).
+
+## Installation
+
+```bash
+pip install kaco-modbus
+```
+
+For the `dump` CLI tool (below), install with the `cli` extra:
+
+```bash
+pip install "kaco-modbus[cli]"
+```
+
+Note: The package is not yet published to PyPI; for now, install from the GitHub repository or build locally with `uv`.
+
+## Usage
+
+```python
+import asyncio
+from modbus_connection.tmodbus import connect_tcp
+from kaco_modbus import KacoInverter
+
+async def main():
+    connection = await connect_tcp("192.168.1.50", port=502)
+    try:
+        unit = connection.for_unit(1)
+        probe = await KacoInverter.async_probe(unit)
+        device = KacoInverter(unit, probe)
+        await device.async_update()
+        
+        print(f"AC Power: {device.inverter.ac_power} W")
+        print(f"Energy Total: {device.inverter.energy_total} kWh")
+        print(f"State: {device.inverter.state}")
+    finally:
+        await connection.close()
+
+asyncio.run(main())
+```
+
+## Dump CLI
+
+The `dump` tool reads your inverter's complete SunSpec register image. This is useful for:
+- Capturing on-device ground-truth data for test fixtures
+- Verifying Modbus connectivity
+- Debugging SunSpec layout issues
+
+Run it directly on the inverter's LAN:
+
+```bash
+uv run --extra cli python -m kaco_modbus.dump 192.168.1.50 --json dump.json
+```
+
+The command prints live data (AC power, energy, state, temperatures) and optionally saves the raw register image as JSON for analysis.
+
+**Important:** Modbus TCP must be enabled on the inverter. In the inverter's menu (local GUI or WebGUI), navigate to **MODBUS / SunSpec protocol** and enable it (default port 502). The inverter's Modbus server is single-threaded, so sharing a connection across multiple clients (via modbus-connection) is more reliable than opening separate TCP connections.
+
+## Supported Devices
+
+| Device Series | Models | SunSpec IDs | Firmware |
+|---|---|---|---|
+| KACO blueplanet TL1 | TL1.5 – TL8.6 | 1, 101/102/103 | ≥ V2.02 |
+| KACO blueplanet TL3 | TL3.0 – TL10.0 | 1, 101/102/103 | ≥ V2.02 |
+| KACO Powador TL3 | TL3.0 – TL15.0 | 1, 101/102/103 | ≥ V2.02 |
+
+Data based on KACO's "MODBUS Protocol Application Note, Tx1 and Tx3 Series" (v180730) and SunSpec specs. Other firmware versions and models may expose additional SunSpec models (e.g., 112, 113, 160); the library skips unknown models and will discover them in future versions.
+
+## Development
+
+Clone and set up:
+
+```bash
+git clone https://github.com/g4bri3lDev/kaco-modbus
+cd kaco-modbus
+uv sync
+```
+
+Run tests, type checks, and lint:
+
+```bash
+uv run pytest -v
+uv run mypy
+uv run ruff check
+uv run ruff format --check
+```
+
+See [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) for a detailed explanation of the library's design, module responsibilities, and layering.
+
+## License
+
+Apache License 2.0. See [LICENSE](LICENSE) for details.

kaco_modbus-0.1.0/README.md

@@ -0,0 +1,93 @@
+# kaco-modbus
+
+Read a KACO blueplanet inverter over SunSpec Modbus TCP. This library discovers the device's register layout at runtime using SunSpec, then provides typed access to identity and live data. Built on the [modbus-connection](https://home-assistant-libs.github.io/modbus-connection/) library, it is the core device integration behind the [kaco Home Assistant integration](https://github.com/g4bri3lDev/kaco-modbus-hass).
+
+## Installation
+
+```bash
+pip install kaco-modbus
+```
+
+For the `dump` CLI tool (below), install with the `cli` extra:
+
+```bash
+pip install "kaco-modbus[cli]"
+```
+
+Note: The package is not yet published to PyPI; for now, install from the GitHub repository or build locally with `uv`.
+
+## Usage
+
+```python
+import asyncio
+from modbus_connection.tmodbus import connect_tcp
+from kaco_modbus import KacoInverter
+
+async def main():
+    connection = await connect_tcp("192.168.1.50", port=502)
+    try:
+        unit = connection.for_unit(1)
+        probe = await KacoInverter.async_probe(unit)
+        device = KacoInverter(unit, probe)
+        await device.async_update()
+        
+        print(f"AC Power: {device.inverter.ac_power} W")
+        print(f"Energy Total: {device.inverter.energy_total} kWh")
+        print(f"State: {device.inverter.state}")
+    finally:
+        await connection.close()
+
+asyncio.run(main())
+```
+
+## Dump CLI
+
+The `dump` tool reads your inverter's complete SunSpec register image. This is useful for:
+- Capturing on-device ground-truth data for test fixtures
+- Verifying Modbus connectivity
+- Debugging SunSpec layout issues
+
+Run it directly on the inverter's LAN:
+
+```bash
+uv run --extra cli python -m kaco_modbus.dump 192.168.1.50 --json dump.json
+```
+
+The command prints live data (AC power, energy, state, temperatures) and optionally saves the raw register image as JSON for analysis.
+
+**Important:** Modbus TCP must be enabled on the inverter. In the inverter's menu (local GUI or WebGUI), navigate to **MODBUS / SunSpec protocol** and enable it (default port 502). The inverter's Modbus server is single-threaded, so sharing a connection across multiple clients (via modbus-connection) is more reliable than opening separate TCP connections.
+
+## Supported Devices
+
+| Device Series | Models | SunSpec IDs | Firmware |
+|---|---|---|---|
+| KACO blueplanet TL1 | TL1.5 – TL8.6 | 1, 101/102/103 | ≥ V2.02 |
+| KACO blueplanet TL3 | TL3.0 – TL10.0 | 1, 101/102/103 | ≥ V2.02 |
+| KACO Powador TL3 | TL3.0 – TL15.0 | 1, 101/102/103 | ≥ V2.02 |
+
+Data based on KACO's "MODBUS Protocol Application Note, Tx1 and Tx3 Series" (v180730) and SunSpec specs. Other firmware versions and models may expose additional SunSpec models (e.g., 112, 113, 160); the library skips unknown models and will discover them in future versions.
+
+## Development
+
+Clone and set up:
+
+```bash
+git clone https://github.com/g4bri3lDev/kaco-modbus
+cd kaco-modbus
+uv sync
+```
+
+Run tests, type checks, and lint:
+
+```bash
+uv run pytest -v
+uv run mypy
+uv run ruff check
+uv run ruff format --check
+```
+
+See [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) for a detailed explanation of the library's design, module responsibilities, and layering.
+
+## License
+
+Apache License 2.0. See [LICENSE](LICENSE) for details.