pyrtl-433 0.1.0__tar.gz

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

pyrtl_433-0.1.0/NOTICE

@@ -0,0 +1,13 @@
+pyrtl_433
+Copyright 2026 Andrew Berry
+
+This product includes software extracted from the rtl-433-hass/rtl_433 Home
+Assistant integration (https://github.com/rtl-433-hass/rtl_433), licensed under
+the Apache License, Version 2.0.
+
+The following modules of that integration were the source of this library's code:
+
+  - custom_components/rtl_433/coordinator/base.py
+  - custom_components/rtl_433/normalizer.py
+  - custom_components/rtl_433/coordinator/_events.py
+  - custom_components/rtl_433/sdr_settings.py

pyrtl_433-0.1.0/PKG-INFO

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: pyrtl_433
+Version: 0.1.0
+Summary: Standalone async client for the rtl_433 WebSocket/HTTP API.
+Author: Andrew Berry
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/rtl-433-hass/pyrtl_433
+Project-URL: Repository, https://github.com/rtl-433-hass/pyrtl_433
+Project-URL: Documentation, https://rtl-433-hass.github.io/pyrtl_433/
+Project-URL: Issues, https://github.com/rtl-433-hass/pyrtl_433/issues
+Keywords: rtl_433,rtl-sdr,websocket,aiohttp,asyncio,sdr
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: AsyncIO
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Home Automation
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: aiohttp
+Dynamic: license-file
+
+# 📻 pyrtl_433
+
+A standalone, dependency-light async client for the rtl_433 HTTP server's
+WebSocket + `/cmd` API.
+
+`pyrtl_433` speaks the *transport/protocol* half of an rtl_433 receiver: it
+connects to one server over a WebSocket, parses the JSON event stream, and drives
+the HTTP `/cmd` endpoint that reports and controls the SDR configuration.
+
+Deliberate non-scope: this is a client, not a policy engine. It does **not**
+include the Home Assistant integration's entity model, desired-state store, SDR
+adoption/enforcement, or availability watchdog. It emits normalized,
+replay-classified events and gives you the `/cmd` setter primitive plus the SDR
+value transforms — you build any higher-level policy on top.
+
+**Full documentation:** <https://rtl-433-hass.github.io/pyrtl_433/latest/>
+
+## Install
+
+This project is [uv](https://docs.astral.sh/uv/)-first. Not yet published to
+PyPI; once it is:
+
+```sh
+uv add pyrtl_433
+```
+
+From a clone of this repository: `uv pip install .`. See the
+[installation guide](https://rtl-433-hass.github.io/pyrtl_433/latest/installation/)
+for pip and other options.
+
+## Quick start
+
+Inject an `aiohttp.ClientSession`, construct the client, and consume events with
+`async for event in client` (or an `on_event` callback):
+
+```python
+import asyncio
+
+import aiohttp
+
+from pyrtl_433 import Rtl433Client
+
+
+async def main() -> None:
+    async with aiohttp.ClientSession() as session:
+        client = Rtl433Client("192.0.2.10", session=session)
+        await client.start()
+        try:
+            async for event in client:
+                if event.is_replay:
+                    continue  # already-seen / stale-gap frame; seed only, don't act
+                print(event.device_key, event.model, event.fields)
+        finally:
+            await client.stop()
+
+
+asyncio.run(main())
+```
+
+See the
+[Quick Start](https://rtl-433-hass.github.io/pyrtl_433/latest/quickstart/) guide
+for the callback style, the full constructor signature, and SDR `/cmd` writes.
+
+## Documentation
+
+- [Full documentation](https://rtl-433-hass.github.io/pyrtl_433/latest/)
+- [Quick Start](https://rtl-433-hass.github.io/pyrtl_433/latest/quickstart/)
+- [API Reference](https://rtl-433-hass.github.io/pyrtl_433/latest/api-reference/)
+- [Protocol Reference](https://rtl-433-hass.github.io/pyrtl_433/latest/protocol-reference/)
+- [Development](https://rtl-433-hass.github.io/pyrtl_433/latest/development/)
+- [Issue tracker](https://github.com/rtl-433-hass/pyrtl_433/issues)
+
+## License
+
+Apache-2.0. This library was extracted from the transport/protocol code of the
+rtl-433-hass/rtl_433 Home Assistant integration. See [`LICENSE`](LICENSE) and
+[`NOTICE`](NOTICE) for the source modules and attribution.

pyrtl_433-0.1.0/README.md

@@ -0,0 +1,77 @@
+# 📻 pyrtl_433
+
+A standalone, dependency-light async client for the rtl_433 HTTP server's
+WebSocket + `/cmd` API.
+
+`pyrtl_433` speaks the *transport/protocol* half of an rtl_433 receiver: it
+connects to one server over a WebSocket, parses the JSON event stream, and drives
+the HTTP `/cmd` endpoint that reports and controls the SDR configuration.
+
+Deliberate non-scope: this is a client, not a policy engine. It does **not**
+include the Home Assistant integration's entity model, desired-state store, SDR
+adoption/enforcement, or availability watchdog. It emits normalized,
+replay-classified events and gives you the `/cmd` setter primitive plus the SDR
+value transforms — you build any higher-level policy on top.
+
+**Full documentation:** <https://rtl-433-hass.github.io/pyrtl_433/latest/>
+
+## Install
+
+This project is [uv](https://docs.astral.sh/uv/)-first. Not yet published to
+PyPI; once it is:
+
+```sh
+uv add pyrtl_433
+```
+
+From a clone of this repository: `uv pip install .`. See the
+[installation guide](https://rtl-433-hass.github.io/pyrtl_433/latest/installation/)
+for pip and other options.
+
+## Quick start
+
+Inject an `aiohttp.ClientSession`, construct the client, and consume events with
+`async for event in client` (or an `on_event` callback):
+
+```python
+import asyncio
+
+import aiohttp
+
+from pyrtl_433 import Rtl433Client
+
+
+async def main() -> None:
+    async with aiohttp.ClientSession() as session:
+        client = Rtl433Client("192.0.2.10", session=session)
+        await client.start()
+        try:
+            async for event in client:
+                if event.is_replay:
+                    continue  # already-seen / stale-gap frame; seed only, don't act
+                print(event.device_key, event.model, event.fields)
+        finally:
+            await client.stop()
+
+
+asyncio.run(main())
+```
+
+See the
+[Quick Start](https://rtl-433-hass.github.io/pyrtl_433/latest/quickstart/) guide
+for the callback style, the full constructor signature, and SDR `/cmd` writes.
+
+## Documentation
+
+- [Full documentation](https://rtl-433-hass.github.io/pyrtl_433/latest/)
+- [Quick Start](https://rtl-433-hass.github.io/pyrtl_433/latest/quickstart/)
+- [API Reference](https://rtl-433-hass.github.io/pyrtl_433/latest/api-reference/)
+- [Protocol Reference](https://rtl-433-hass.github.io/pyrtl_433/latest/protocol-reference/)
+- [Development](https://rtl-433-hass.github.io/pyrtl_433/latest/development/)
+- [Issue tracker](https://github.com/rtl-433-hass/pyrtl_433/issues)
+
+## License
+
+Apache-2.0. This library was extracted from the transport/protocol code of the
+rtl-433-hass/rtl_433 Home Assistant integration. See [`LICENSE`](LICENSE) and
+[`NOTICE`](NOTICE) for the source modules and attribution.

pyrtl_433-0.1.0/pyproject.toml

@@ -0,0 +1,120 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pyrtl_433"
+version = "0.1.0"
+description = "Standalone async client for the rtl_433 WebSocket/HTTP API."
+readme = "README.md"
+requires-python = ">=3.14"
+license = "Apache-2.0"
+authors = [{ name = "Andrew Berry" }]
+keywords = ["rtl_433", "rtl-sdr", "websocket", "aiohttp", "asyncio", "sdr"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Framework :: AsyncIO",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Home Automation",
+]
+dependencies = ["aiohttp"]
+
+[project.urls]
+Homepage = "https://github.com/rtl-433-hass/pyrtl_433"
+Repository = "https://github.com/rtl-433-hass/pyrtl_433"
+Documentation = "https://rtl-433-hass.github.io/pyrtl_433/"
+Issues = "https://github.com/rtl-433-hass/pyrtl_433/issues"
+
+# uv-first dev tooling: `uv sync` installs this group by default; `uv run <tool>`
+# executes them. There are no pip-style requirements*.txt files.
+[dependency-groups]
+dev = [
+    "pytest>=9",
+    "pytest-asyncio>=1",
+    "pytest-aiohttp>=1.1",
+    "pytest-cov>=7",
+    "pytest-xdist>=3",
+    "mutmut==3.6.0",
+    "ruff==0.15.20",
+    "mypy>=1.19",
+]
+
+[tool.setuptools]
+packages = ["pyrtl_433"]
+
+[tool.mypy]
+strict = true
+files = ["pyrtl_433"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+addopts = "-ra -q --strict-markers"
+markers = [
+    "unit: Unit tests (fast, no external dependencies)",
+    "integration: Integration tests (may use a running rtl_433 endpoint)",
+]
+filterwarnings = [
+    # Treat warnings as errors to catch issues early
+    "error",
+]
+
+[tool.coverage.run]
+source = ["pyrtl_433"]
+omit = ["tests/*"]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if TYPE_CHECKING:",
+    "@overload",
+]
+
+[tool.ruff]
+# Based on https://github.com/home-assistant/core/blob/dev/pyproject.toml
+target-version = "py314"
+line-length = 88
+
+[tool.ruff.lint]
+select = [
+    "B",   # flake8-bugbear
+    "E",   # pycodestyle errors
+    "F",   # pyflakes
+    "I",   # isort
+    "SIM", # flake8-simplify
+    "UP",  # pyupgrade
+]
+ignore = [
+    "E501", # line too long (handled by the formatter)
+]
+
+[tool.ruff.lint.isort]
+force-sort-within-sections = true
+known-first-party = ["pyrtl_433"]
+combine-as-imports = true
+split-on-trailing-comma = false
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = [
+    "S101",    # assert is fine in tests
+    "PLR2004", # Magic values are fine in tests
+]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+line-ending = "lf"
+docstring-code-format = true
+
+[tool.mutmut]
+# Mutation testing config (mutmut 3.x). mutmut copies source_paths plus the
+# auto-included tests/ + pyproject.toml into a mutants/ working copy and runs the
+# pytest suite there, forking once per mutant. The whole package must be in scope
+# so intra-package imports resolve inside mutants/.
+source_paths = ["pyrtl_433/"]
+pytest_add_cli_args_test_selection = ["tests/"]

pyrtl_433-0.1.0/pyrtl_433/__init__.py

@@ -0,0 +1,21 @@
+"""pyrtl_433 -- a standalone async client for the rtl_433 WebSocket/HTTP API.
+
+The framework-agnostic protocol helpers extracted from the rtl-433-hass Home
+Assistant integration (Apache-2.0). Nothing here imports Home Assistant.
+"""
+
+from __future__ import annotations
+
+from .client import CannotConnect, Rtl433Client
+from .normalizer import NormalizedEvent, device_key, normalize
+from .replay import ReplayVerdict, classify_replay
+
+__all__ = [
+    "CannotConnect",
+    "NormalizedEvent",
+    "ReplayVerdict",
+    "Rtl433Client",
+    "classify_replay",
+    "device_key",
+    "normalize",
+]

pyrtl_433-0.1.0/pyrtl_433/_urls.py

@@ -0,0 +1,45 @@
+"""URL builders and getter-response unwrapping for the rtl_433 client.
+
+Extracted from custom_components/rtl_433/coordinator/base.py of
+rtl-433-hass/rtl_433 (Apache-2.0): the module-level ``_build_ws_url`` /
+``_build_cmd_url`` helpers and the ``_unwrap_result`` staticmethod.
+"""
+
+from __future__ import annotations
+
+from typing import Any
+
+
+def build_ws_url(host: str, port: int, path: str, *, secure: bool = False) -> str:
+    """Build a ``ws(s)://host:port/path`` URL from connection parameters."""
+    scheme = "wss" if secure else "ws"
+    if not path.startswith("/"):
+        path = f"/{path}"
+    return f"{scheme}://{host}:{port}{path}"
+
+
+def build_cmd_url(host: str, port: int, *, secure: bool = False) -> str:
+    """Build the ``http(s)://host:port/cmd`` URL (server root, never the WS path).
+
+    The ``/cmd`` endpoint always lives at the server root regardless of the
+    configured WebSocket ``path``; graceful degradation behind a proxy that hides
+    ``/cmd`` depends on this never being derived from the WebSocket path.
+    ``secure`` maps ``wss`` => ``https`` and ``ws`` => ``http``.
+    """
+    scheme = "https" if secure else "http"
+    return f"{scheme}://{host}:{port}/cmd"
+
+
+def unwrap_result(payload: Any) -> Any:
+    """Unwrap a ``{"result": <value>}`` getter response to its raw value.
+
+    The HTTP ``/cmd`` responder (``rpc_response_jsoncmd``) wraps **every** getter
+    reply in a ``result`` envelope -- not just the scalar getters
+    (``get_gain``/``get_ppm_error``) but the JSON-payload getters
+    (``get_meta``/``get_stats``) too. (Only the WebSocket framing sends those two
+    as a bare object; this client uses ``/cmd``.) A bare value is accepted too, so
+    this is safe across transports -- read defensively.
+    """
+    if isinstance(payload, dict) and "result" in payload:
+        return payload["result"]
+    return payload