rf-protocols 0.0.1__py3-none-any.whl

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/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.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,7 @@
+rf_protocols/__init__.py,sha256=A6fDLZLWnR3kqlmZkr3B4ypUwZ0yPpiOhLRdTCdJmTc,239
+rf_protocols/commands.py,sha256=RW8LzrdeRCm8drTdJDn324kGgCJV-qE1uN0rLOA46JI,1911
+rf_protocols-0.0.1.dist-info/licenses/LICENSE,sha256=oaPjui5ki5qjpewrjX0k1Qg5PaPVc83QpgCX7VbKx6E,1076
+rf_protocols-0.0.1.dist-info/METADATA,sha256=CsnuXWfFe7TgbGMFaTG9mpFr8YVujqshLtRSpMEhQh4,647
+rf_protocols-0.0.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+rf_protocols-0.0.1.dist-info/top_level.txt,sha256=YAKSQ0xrIVumaK94bUe1vHlOYAvhnvrix5Rwf10K-CU,13
+rf_protocols-0.0.1.dist-info/RECORD,,

rf_protocols-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

rf_protocols-0.0.1.dist-info/licenses/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.dist-info/top_level.txt

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