rf-protocols 0.0.1__tar.gz

rf_protocols-0.0.1/LICENSE

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

rf_protocols-0.0.1/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.4
+Name: rf-protocols
+Version: 0.0.1
+Summary: Library to decode and encode radio frequency signals.
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/home-assistant-libs/rf-protocols
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.13.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: prek; extra == "dev"
+Dynamic: license-file
+
+# Python RF Protocols for Home Assistant
+
+Python package to decode and encode radio frequency signals for use in Home Assistant.

rf_protocols-0.0.1/README.md

@@ -0,0 +1,3 @@
+# Python RF Protocols for Home Assistant
+
+Python package to decode and encode radio frequency signals for use in Home Assistant.

rf_protocols-0.0.1/pyproject.toml

@@ -0,0 +1,46 @@
+[build-system]
+requires = ["setuptools>=78.1.1,<83.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name         = "rf-protocols"
+version      = "0.0.1"
+license      = "MIT"
+description  = "Library to decode and encode radio frequency signals."
+readme       = "README.md"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+requires-python = ">=3.13.0"
+
+[project.urls]
+"Homepage" = "https://github.com/home-assistant-libs/rf-protocols"
+
+[tool.setuptools]
+include-package-data = false
+
+[tool.setuptools.packages.find]
+include = ["rf_protocols*"]
+
+[tool.ruff.lint]
+select = [
+    # pycodestyle
+    "E",
+    # Pyflakes
+    "F",
+    # pyupgrade
+    "UP",
+    # flake8-bugbear
+    "B",
+    # isort
+    "I",]
+
+[tool.ruff.lint.mccabe]
+max-complexity = 25
+
+[tool.pyright]
+typeCheckingMode = "standard"
+
+[project.optional-dependencies]
+dev = ["pytest", "prek"]

rf_protocols-0.0.1/rf_protocols/__init__.py

@@ -0,0 +1,10 @@
+"""Library to decode and encode radio frequency signals."""
+
+from .commands import ModulationType, OOKCommand, RadioFrequencyCommand, Timing
+
+__all__ = [
+    "ModulationType",
+    "OOKCommand",
+    "RadioFrequencyCommand",
+    "Timing",
+]

rf_protocols-0.0.1/rf_protocols/commands.py

@@ -0,0 +1,80 @@
+"""Common RF command definitions."""
+
+import abc
+from dataclasses import dataclass
+from enum import StrEnum
+from typing import override
+
+
+class ModulationType(StrEnum):
+    """RF modulation type."""
+
+    OOK = "OOK"
+
+
+@dataclass(frozen=True, slots=True)
+class Timing:
+    """High/low signal timing for OOK modulation."""
+
+    high_us: int
+    low_us: int
+
+
+class RadioFrequencyCommand(abc.ABC):
+    """Base class for RF commands."""
+
+    frequency: int
+    repeat_count: int
+    modulation: ModulationType
+    symbol_rate: int | None
+    output_power: float | None
+
+    def __init__(
+        self,
+        *,
+        frequency: int,
+        modulation: ModulationType,
+        repeat_count: int = 0,
+        symbol_rate: int | None = None,
+        output_power: float | None = None,
+    ) -> None:
+        """Initialize the RF command."""
+        self.frequency = frequency
+        self.modulation = modulation
+        self.repeat_count = repeat_count
+        self.symbol_rate = symbol_rate
+        self.output_power = output_power
+
+    @abc.abstractmethod
+    def get_raw_timings(self) -> list[Timing]:
+        """Get raw timings for OOK commands."""
+
+
+class OOKCommand(RadioFrequencyCommand):
+    """OOK command with raw timings."""
+
+    timings: list[Timing]
+
+    def __init__(
+        self,
+        *,
+        frequency: int,
+        timings: list[Timing],
+        repeat_count: int = 0,
+        symbol_rate: int | None = None,
+        output_power: float | None = None,
+    ) -> None:
+        """Initialize the OOK command."""
+        super().__init__(
+            frequency=frequency,
+            modulation=ModulationType.OOK,
+            repeat_count=repeat_count,
+            symbol_rate=symbol_rate,
+            output_power=output_power,
+        )
+        self.timings = timings
+
+    @override
+    def get_raw_timings(self) -> list[Timing]:
+        """Get raw timings."""
+        return self.timings

rf_protocols-0.0.1/rf_protocols.egg-info/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.4
+Name: rf-protocols
+Version: 0.0.1
+Summary: Library to decode and encode radio frequency signals.
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/home-assistant-libs/rf-protocols
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.13.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: prek; extra == "dev"
+Dynamic: license-file
+
+# Python RF Protocols for Home Assistant
+
+Python package to decode and encode radio frequency signals for use in Home Assistant.

rf_protocols-0.0.1/rf_protocols.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+pyproject.toml
+rf_protocols/__init__.py
+rf_protocols/commands.py
+rf_protocols.egg-info/PKG-INFO
+rf_protocols.egg-info/SOURCES.txt
+rf_protocols.egg-info/dependency_links.txt
+rf_protocols.egg-info/requires.txt
+rf_protocols.egg-info/top_level.txt
+tests/test_commands.py

rf_protocols-0.0.1/rf_protocols.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

rf_protocols-0.0.1/rf_protocols.egg-info/requires.txt

@@ -0,0 +1,4 @@
+
+[dev]
+pytest
+prek

rf_protocols-0.0.1/rf_protocols.egg-info/top_level.txt

@@ -0,0 +1 @@
+rf_protocols

rf_protocols-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

rf_protocols-0.0.1/tests/test_commands.py

@@ -0,0 +1,114 @@
+"""Tests for the RF protocol definitions."""
+
+from rf_protocols import ModulationType, OOKCommand, RadioFrequencyCommand, Timing
+
+
+def test_modulation_type_ook() -> None:
+    """Test ModulationType enum has OOK value."""
+    assert ModulationType.OOK == "OOK"
+    assert ModulationType.OOK.value == "OOK"
+
+
+def test_timing_frozen() -> None:
+    """Test Timing is a frozen dataclass."""
+    timing = Timing(high_us=350, low_us=1050)
+    assert timing.high_us == 350
+    assert timing.low_us == 1050
+
+
+def test_timing_equality() -> None:
+    """Test Timing equality comparison."""
+    assert Timing(high_us=350, low_us=1050) == Timing(high_us=350, low_us=1050)
+    assert Timing(high_us=350, low_us=1050) != Timing(high_us=350, low_us=350)
+
+
+class _MockCommand(RadioFrequencyCommand):
+    """Simple concrete command for testing the base class."""
+
+    def __init__(
+        self,
+        *,
+        frequency: int = 433_920_000,
+        modulation: ModulationType = ModulationType.OOK,
+        repeat_count: int = 0,
+        symbol_rate: int | None = None,
+        output_power: float | None = None,
+    ) -> None:
+        super().__init__(
+            frequency=frequency,
+            modulation=modulation,
+            repeat_count=repeat_count,
+            symbol_rate=symbol_rate,
+            output_power=output_power,
+        )
+
+    def get_raw_timings(self) -> list[Timing]:
+        """Return a simple test pattern."""
+        return [Timing(high_us=350, low_us=1050), Timing(high_us=350, low_us=350)]
+
+
+def test_command_defaults() -> None:
+    """Test RadioFrequencyCommand default values."""
+    cmd = _MockCommand()
+    assert cmd.frequency == 433_920_000
+    assert cmd.repeat_count == 0
+    assert cmd.modulation == ModulationType.OOK
+    assert cmd.symbol_rate is None
+    assert cmd.output_power is None
+
+
+def test_command_custom_values() -> None:
+    """Test RadioFrequencyCommand with custom values."""
+    cmd = _MockCommand(
+        frequency=868_000_000,
+        repeat_count=3,
+        symbol_rate=4800,
+        output_power=10.0,
+    )
+    assert cmd.frequency == 868_000_000
+    assert cmd.repeat_count == 3
+    assert cmd.modulation == ModulationType.OOK
+    assert cmd.symbol_rate == 4800
+    assert cmd.output_power == 10.0
+
+
+def test_command_get_raw_timings() -> None:
+    """Test get_raw_timings returns expected timings."""
+    cmd = _MockCommand()
+    timings = cmd.get_raw_timings()
+    assert timings == [
+        Timing(high_us=350, low_us=1050),
+        Timing(high_us=350, low_us=350),
+    ]
+
+
+def test_ook_command() -> None:
+    """Test OOKCommand with raw timings."""
+    timings = [
+        Timing(high_us=350, low_us=1050),
+        Timing(high_us=350, low_us=350),
+        Timing(high_us=350, low_us=0),
+    ]
+    cmd = OOKCommand(frequency=433_920_000, timings=timings)
+    assert cmd.frequency == 433_920_000
+    assert cmd.modulation == ModulationType.OOK
+    assert cmd.repeat_count == 0
+    assert cmd.get_raw_timings() == timings
+
+
+def test_ook_command_custom_values() -> None:
+    """Test OOKCommand with custom radio parameters."""
+    timings = [Timing(high_us=500, low_us=1000)]
+    cmd = OOKCommand(
+        frequency=868_000_000,
+        timings=timings,
+        repeat_count=2,
+        symbol_rate=4800,
+        output_power=10.0,
+    )
+    assert cmd.frequency == 868_000_000
+    assert cmd.modulation == ModulationType.OOK
+    assert cmd.repeat_count == 2
+    assert cmd.symbol_rate == 4800
+    assert cmd.output_power == 10.0
+    assert cmd.get_raw_timings() == timings