pywmswebcontrolpro 0.1.0__tar.gz

pywmswebcontrolpro-0.1.0/.github/workflows/release.yaml

@@ -0,0 +1,79 @@
+---
+name: Release
+on: [ push ]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: astral-sh/setup-uv@v5
+      - run: uv build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: Packages
+          path: dist
+  test-pypi:
+    runs-on: ubuntu-latest
+    needs: build
+    environment:
+      name: test-pypi
+      url: https://test.pypi.org/p/pywmswebcontrolpro
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: Packages
+          path: dist
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          skip-existing: true
+          print-hash: true
+  github-release:
+    if: github.ref_type == 'tag'
+    runs-on: ubuntu-latest
+    needs: test-pypi
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/download-artifact@v4
+        with:
+          name: Packages
+          path: dist
+      - uses: sigstore/gh-action-sigstore-python@v3.0.0
+        with:
+          inputs: dist/*
+      - run: >
+          gh release create "${{ github.ref_name }}" dist/*
+          --target "${{ github.sha }}"
+          --generate-notes
+          --verify-tag
+          --prerelease
+          --draft
+        env:
+          GH_TOKEN: "${{ github.token }}"
+  prod-pypi:
+    if: github.ref_type == 'tag'
+    runs-on: ubuntu-latest
+    needs: github-release
+    environment:
+      name: prod-pypi
+      url: https://pypi.org/p/pywmswebcontrolpro
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: Packages
+          path: dist
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          print-hash: true
+...

pywmswebcontrolpro-0.1.0/.github/workflows/validate.yaml

@@ -0,0 +1,30 @@
+---
+name: Validate
+on:
+  push:
+  pull_request:
+jobs:
+  lint:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.14"
+          cache: pip
+          cache-dependency-path: requirements_lint.txt
+      - run: python -m pip install -r requirements_lint.txt
+      - run: ruff check .
+      - run: ruff format --check .
+  test:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.14"
+          cache: pip
+          cache-dependency-path: requirements_test.txt
+      - run: python -m pip install -r requirements_test.txt
+      - run: python -m pytest -v
+...

pywmswebcontrolpro-0.1.0/.gitignore

@@ -0,0 +1,8 @@
+.DS_Store
+simulator/diagnostics/
+dist/
+*.pyc
+__pycache__/
+.pytest_cache/
+.ruff_cache/
+*.egg-info/

pywmswebcontrolpro-0.1.0/.python-version

@@ -0,0 +1 @@
+3.14

pywmswebcontrolpro-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.

pywmswebcontrolpro-0.1.0/PKG-INFO

@@ -0,0 +1,79 @@
+Metadata-Version: 2.5
+Name: pywmswebcontrolpro
+Version: 0.1.0
+Summary: Python library for the Warema WMS WebControl pro API
+Author-email: Marc Hoersken <info@marc-hoersken.de>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: warema,webcontrol,wms
+Requires-Python: >=3.14
+Requires-Dist: aiofiles>=24.1.0
+Requires-Dist: aiohttp>=3.14.1
+Description-Content-Type: text/markdown
+
+# pywmswebcontrolpro
+
+Python library for the Warema WMS WebControl pro API. It is the companion library of the
+Home Assistant integration `ha_wms_webcontrol_pro`.
+
+Reference: https://media.warema.com/dokumente/anleitungen-handbuecher/966664/warema_2064534_alhb_de_v0.pdf
+
+## Origin and license
+
+This project is a fork of [`pywmspro`](https://github.com/mback2k/pywmspro) by
+Marc Hoersken, licensed under the Apache License 2.0. The full history of the original
+is kept in this repository. All files changed since the fork are changed by this
+project's contributors; see the git history for details. The license text is in
+`LICENSE` and applies to this repository unchanged.
+
+## Example usage
+
+See the main section in `pywmswebcontrolpro/webcontrol.py`.
+
+## Status refresh
+
+`Destination.refresh(retries=2)` requests the status of a destination and returns a
+`RefreshOutcome` with the result (`ok`, `busy`, `empty` or `error`) and the values
+of the actions. Only a "radio busy" answer is retried; with `retries=0` exactly one
+request is sent. On any failure the previous values stay unchanged. The outcome is
+truthy only for `ok`.
+
+`WebControlPro(request_spacing=...)` sets the minimum pause between two status requests
+to the hub (default 0.5 seconds).
+
+Failed refreshes are counted per destination (`Destination.stats`, also part of
+`diag()`) instead of being logged. A warning is logged once when a destination has
+failed continuously for `stale_warning_after` (default 24 hours) and once when it
+delivers data again.
+
+## Settings, movement model and stored state
+
+Each action keeps its data in `<persist>/<destination id>/<action id>.json`, the file
+that already holds the `overwrites` (for example the rotation limits). A drive action
+(for example `AwningDrive`, `ValanceDrive` or `RollerShutterBlindDrive`) stores in it:
+
+- `settings`: the travel times for a full drive, open and close, in seconds
+  (`Action.set_travel_time`, 0 means unknown).
+- `state`: the last known position and tilt and the target of a running drive.
+
+The file is written atomically and serialized against concurrent access, unknown keys
+and the `overwrites` of older versions are kept. Without a persist path nothing is
+stored.
+
+`Action.model` is the movement model of the cover driven by this action: `start_move`,
+`stop`, `set_tilt` and `apply_measurement` calculate the displayed position, which is
+replaced by a measured value when the cover stands still. Because the model belongs to
+the drive action, an awning and its valance, which share a destination, move
+independently. After a restart the position is restored from the file and marked as
+`restored` until a measurement arrives. Call `Action.sync()` after commands and
+measurements to store changes; `Destination.refresh` does it as well.
+
+## Development
+
+```bash
+python -m pip install -r requirements_lint.txt -r requirements_test.txt
+ruff check . && ruff format --check .
+python -m pytest
+```
+
+The version is derived from git tags (`hatch-vcs`).

pywmswebcontrolpro-0.1.0/README.md

@@ -0,0 +1,66 @@
+# pywmswebcontrolpro
+
+Python library for the Warema WMS WebControl pro API. It is the companion library of the
+Home Assistant integration `ha_wms_webcontrol_pro`.
+
+Reference: https://media.warema.com/dokumente/anleitungen-handbuecher/966664/warema_2064534_alhb_de_v0.pdf
+
+## Origin and license
+
+This project is a fork of [`pywmspro`](https://github.com/mback2k/pywmspro) by
+Marc Hoersken, licensed under the Apache License 2.0. The full history of the original
+is kept in this repository. All files changed since the fork are changed by this
+project's contributors; see the git history for details. The license text is in
+`LICENSE` and applies to this repository unchanged.
+
+## Example usage
+
+See the main section in `pywmswebcontrolpro/webcontrol.py`.
+
+## Status refresh
+
+`Destination.refresh(retries=2)` requests the status of a destination and returns a
+`RefreshOutcome` with the result (`ok`, `busy`, `empty` or `error`) and the values
+of the actions. Only a "radio busy" answer is retried; with `retries=0` exactly one
+request is sent. On any failure the previous values stay unchanged. The outcome is
+truthy only for `ok`.
+
+`WebControlPro(request_spacing=...)` sets the minimum pause between two status requests
+to the hub (default 0.5 seconds).
+
+Failed refreshes are counted per destination (`Destination.stats`, also part of
+`diag()`) instead of being logged. A warning is logged once when a destination has
+failed continuously for `stale_warning_after` (default 24 hours) and once when it
+delivers data again.
+
+## Settings, movement model and stored state
+
+Each action keeps its data in `<persist>/<destination id>/<action id>.json`, the file
+that already holds the `overwrites` (for example the rotation limits). A drive action
+(for example `AwningDrive`, `ValanceDrive` or `RollerShutterBlindDrive`) stores in it:
+
+- `settings`: the travel times for a full drive, open and close, in seconds
+  (`Action.set_travel_time`, 0 means unknown).
+- `state`: the last known position and tilt and the target of a running drive.
+
+The file is written atomically and serialized against concurrent access, unknown keys
+and the `overwrites` of older versions are kept. Without a persist path nothing is
+stored.
+
+`Action.model` is the movement model of the cover driven by this action: `start_move`,
+`stop`, `set_tilt` and `apply_measurement` calculate the displayed position, which is
+replaced by a measured value when the cover stands still. Because the model belongs to
+the drive action, an awning and its valance, which share a destination, move
+independently. After a restart the position is restored from the file and marked as
+`restored` until a measurement arrives. Call `Action.sync()` after commands and
+measurements to store changes; `Destination.refresh` does it as well.
+
+## Development
+
+```bash
+python -m pip install -r requirements_lint.txt -r requirements_test.txt
+ruff check . && ruff format --check .
+python -m pytest
+```
+
+The version is derived from git tags (`hatch-vcs`).

pywmswebcontrolpro-0.1.0/pyproject.toml

@@ -0,0 +1,31 @@
+[project]
+name = "pywmswebcontrolpro"
+dynamic = ["version"]
+description = "Python library for the Warema WMS WebControl pro API"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [
+    { name = "Marc Hoersken", email = "info@marc-hoersken.de" }
+]
+readme = "README.md"
+repository = "https://github.com/zomtec/pywmswebcontrolpro"
+keywords = ["warema", "wms", "webcontrol"]
+requires-python = ">=3.14"
+dependencies = [
+    "aiofiles>=24.1.0",
+    "aiohttp>=3.14.1",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["pywmswebcontrolpro"]
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.version.raw-options]
+git_describe_command = ["git", "describe", "--tags"]
+local_scheme = "no-local-version"
+
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"

pywmswebcontrolpro-0.1.0/pytest.ini

@@ -0,0 +1,4 @@
+[pytest]
+asyncio_mode = auto
+asyncio_default_fixture_loop_scope = function
+testpaths = tests