infrared-protocols 1.0.0__tar.gz

infrared_protocols-1.0.0/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.

infrared_protocols-1.0.0/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.4
+Name: infrared-protocols
+Version: 1.0.0
+Summary: Library to decode and encode infrared signals.
+License: MIT
+Project-URL: Homepage, https://github.com/home-assistant-libs/infrared-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 Infrared Protocols for Home Assistant
+
+Python package to decode and encode infrared signals for use in Home Assistant.

infrared_protocols-1.0.0/README.md

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

infrared_protocols-1.0.0/infrared_protocols/__init__.py

@@ -0,0 +1,9 @@
+"""Library to decode and encode infrared signals."""
+
+from .commands import Command, NECCommand, Timing
+
+__all__ = [
+    "Command",
+    "NECCommand",
+    "Timing",
+]

infrared_protocols-1.0.0/infrared_protocols/commands.py

@@ -0,0 +1,121 @@
+"""Common IR command definitions."""
+
+import abc
+from dataclasses import dataclass
+from typing import override
+
+
+@dataclass(frozen=True, slots=True)
+class Timing:
+    """High/low signal timing."""
+
+    high_us: int
+    low_us: int
+
+
+class Command(abc.ABC):
+    """Base class for IR commands."""
+
+    repeat_count: int
+    modulation: int
+
+    def __init__(self, *, modulation: int, repeat_count: int = 0) -> None:
+        """Initialize the IR command."""
+        self.modulation = modulation
+        self.repeat_count = repeat_count
+
+    @abc.abstractmethod
+    def get_raw_timings(self) -> list[Timing]:
+        """Get raw timings for the command."""
+
+
+class NECCommand(Command):
+    """NEC IR command."""
+
+    address: int
+    command: int
+
+    def __init__(
+        self, *, address: int, command: int, modulation: int, repeat_count: int = 0
+    ) -> None:
+        """Initialize the NEC IR command."""
+        super().__init__(modulation=modulation, repeat_count=repeat_count)
+        self.address = address
+        self.command = command
+
+    @override
+    def get_raw_timings(self) -> list[Timing]:
+        """Get raw timings for the NEC command.
+
+        NEC protocol timing (in microseconds):
+        - Leader pulse: 9000µs high, 4500µs low
+        - Logical '0': 562µs high, 562µs low
+        - Logical '1': 562µs high, 1687µs low
+        - End pulse: 562µs high
+        - Repeat code: 9000µs high, 2250µs low, 562µs end pulse
+        - Frame gap: ~96ms between end pulse and next frame (total frame ~108ms)
+
+        Data format (32 bits, LSB first):
+        - Standard NEC: address (8-bit) + ~address (8-bit) + command (8-bit)
+          + ~command (8-bit)
+        - Extended NEC: address_low (8-bit) + address_high (8-bit) + command (8-bit)
+          + ~command (8-bit)
+        """
+        # NEC timing constants (microseconds)
+        leader_high = 9000
+        leader_low = 4500
+        bit_high = 562
+        zero_low = 562
+        one_low = 1687
+        repeat_low = 2250
+        frame_gap = 96000  # Gap to make total frame ~108ms
+
+        timings: list[Timing] = [Timing(high_us=leader_high, low_us=leader_low)]
+
+        # Determine if standard (8-bit) or extended (16-bit) address
+        if self.address <= 0xFF:
+            # Standard NEC: address + inverted address
+            address_low = self.address & 0xFF
+            address_high = (~self.address) & 0xFF
+        else:
+            # Extended NEC: 16-bit address (no inversion)
+            address_low = self.address & 0xFF
+            address_high = (self.address >> 8) & 0xFF
+
+        command_byte = self.command & 0xFF
+        command_inverted = (~self.command) & 0xFF
+
+        # Build 32-bit command data (LSB first in transmission)
+        data = (
+            address_low
+            | (address_high << 8)
+            | (command_byte << 16)
+            | (command_inverted << 24)
+        )
+
+        for _ in range(32):
+            bit = data & 1
+            if bit:
+                timings.append(Timing(high_us=bit_high, low_us=one_low))
+            else:
+                timings.append(Timing(high_us=bit_high, low_us=zero_low))
+            data >>= 1
+
+        # End pulse
+        timings.append(Timing(high_us=bit_high, low_us=0))
+
+        # Add repeat codes if requested
+        for _ in range(self.repeat_count):
+            # Replace the last timing's low_us with the frame gap
+            last_timing = timings[-1]
+            timings[-1] = Timing(high_us=last_timing.high_us, low_us=frame_gap)
+
+            # Repeat code: leader burst + shorter space + end pulse
+            timings.extend(
+                [
+                    Timing(high_us=leader_high, low_us=repeat_low),
+                    Timing(high_us=bit_high, low_us=0),
+                ]
+            )
+
+        return timings

infrared_protocols-1.0.0/infrared_protocols.egg-info/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.4
+Name: infrared-protocols
+Version: 1.0.0
+Summary: Library to decode and encode infrared signals.
+License: MIT
+Project-URL: Homepage, https://github.com/home-assistant-libs/infrared-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 Infrared Protocols for Home Assistant
+
+Python package to decode and encode infrared signals for use in Home Assistant.

infrared_protocols-1.0.0/infrared_protocols.egg-info/SOURCES.txt

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

infrared_protocols-1.0.0/infrared_protocols.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

infrared_protocols-1.0.0/infrared_protocols.egg-info/requires.txt

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

infrared_protocols-1.0.0/infrared_protocols.egg-info/top_level.txt

@@ -0,0 +1 @@
+infrared_protocols

infrared_protocols-1.0.0/pyproject.toml

@@ -0,0 +1,47 @@
+[build-system]
+requires = ["setuptools>=78.1.1,<83.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name         = "infrared-protocols"
+version      = "1.0.0"
+license      = {text = "MIT"}
+description  = "Library to decode and encode infrared 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/infrared-protocols"
+
+[tool.setuptools]
+include-package-data = false
+
+[tool.setuptools.packages.find]
+include = ["infrared_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"]

infrared_protocols-1.0.0/setup.cfg

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

infrared_protocols-1.0.0/tests/test_commands.py

@@ -0,0 +1,124 @@
+"""Tests for the Infrared protocol definitions."""
+
+from infrared_protocols import NECCommand, Timing
+
+
+def test_nec_command_get_raw_timings_standard() -> None:
+    """Test NEC command raw timings generation for standard 8-bit address."""
+    expected_raw_timings = [
+        Timing(high_us=9000, low_us=4500),
+        Timing(high_us=562, low_us=562),
+        Timing(high_us=562, low_us=562),
+        Timing(high_us=562, low_us=1687),
+        Timing(high_us=562, low_us=562),
+        Timing(high_us=562, low_us=562),
+        Timing(high_us=562, low_us=562),
+        Timing(high_us=562, low_us=562),
+        Timing(high_us=562, low_us=562),
+        Timing(high_us=562, low_us=1687),
+        Timing(high_us=562, low_us=1687),
+        Timing(high_us=562, low_us=562),
+        Timing(high_us=562, low_us=1687),
+        Timing(high_us=562, low_us=1687),
+        Timing(high_us=562, low_us=1687),
+        Timing(high_us=562, low_us=1687),
+        Timing(high_us=562, low_us=1687),
+        Timing(high_us=562, low_us=562),
+        Timing(high_us=562, low_us=562),
+        Timing(high_us=562, low_us=562),
+        Timing(high_us=562, low_us=1687),
+        Timing(high_us=562, low_us=562),
+        Timing(high_us=562, low_us=562),
+        Timing(high_us=562, low_us=562),
+        Timing(high_us=562, low_us=562),
+        Timing(high_us=562, low_us=1687),
+        Timing(high_us=562, low_us=1687),
+        Timing(high_us=562, low_us=1687),
+        Timing(high_us=562, low_us=562),
+        Timing(high_us=562, low_us=1687),
+        Timing(high_us=562, low_us=1687),
+        Timing(high_us=562, low_us=1687),
+        Timing(high_us=562, low_us=1687),
+        Timing(high_us=562, low_us=0),
+    ]
+    command = NECCommand(address=0x04, command=0x08, modulation=38000, repeat_count=0)
+    timings = command.get_raw_timings()
+    assert timings == expected_raw_timings
+
+    # Same command now with 2 repeats
+    command_with_repeats = NECCommand(
+        address=command.address,
+        command=command.command,
+        modulation=command.modulation,
+        repeat_count=2,
+    )
+    timings_with_repeats = command_with_repeats.get_raw_timings()
+    assert timings_with_repeats == [
+        *expected_raw_timings[:-1],
+        Timing(high_us=562, low_us=96000),
+        Timing(high_us=9000, low_us=2250),
+        Timing(high_us=562, low_us=96000),
+        Timing(high_us=9000, low_us=2250),
+        Timing(high_us=562, low_us=0),
+    ]
+
+
+def test_nec_command_get_raw_timings_extended() -> None:
+    """Test NEC command raw timings generation for extended 16-bit address."""
+    expected_raw_timings = [
+        Timing(high_us=9000, low_us=4500),
+        Timing(high_us=562, low_us=1687),
+        Timing(high_us=562, low_us=1687),
+        Timing(high_us=562, low_us=562),
+        Timing(high_us=562, low_us=1687),
+        Timing(high_us=562, low_us=1687),
+        Timing(high_us=562, low_us=1687),
+        Timing(high_us=562, low_us=1687),
+        Timing(high_us=562, low_us=1687),
+        Timing(high_us=562, low_us=562),
+        Timing(high_us=562, low_us=562),
+        Timing(high_us=562, low_us=1687),
+        Timing(high_us=562, low_us=562),
+        Timing(high_us=562, low_us=562),
+        Timing(high_us=562, low_us=562),
+        Timing(high_us=562, low_us=562),
+        Timing(high_us=562, low_us=562),
+        Timing(high_us=562, low_us=562),
+        Timing(high_us=562, low_us=562),
+        Timing(high_us=562, low_us=562),
+        Timing(high_us=562, low_us=1687),
+        Timing(high_us=562, low_us=562),
+        Timing(high_us=562, low_us=562),
+        Timing(high_us=562, low_us=562),
+        Timing(high_us=562, low_us=562),
+        Timing(high_us=562, low_us=1687),
+        Timing(high_us=562, low_us=1687),
+        Timing(high_us=562, low_us=1687),
+        Timing(high_us=562, low_us=562),
+        Timing(high_us=562, low_us=1687),
+        Timing(high_us=562, low_us=1687),
+        Timing(high_us=562, low_us=1687),
+        Timing(high_us=562, low_us=1687),
+        Timing(high_us=562, low_us=0),
+    ]
+
+    command = NECCommand(address=0x04FB, command=0x08, modulation=38000, repeat_count=0)
+    timings = command.get_raw_timings()
+    assert timings == expected_raw_timings
+
+    # Same command now with 2 repeats
+    command_with_repeats = NECCommand(
+        address=command.address,
+        command=command.command,
+        modulation=command.modulation,
+        repeat_count=2,
+    )
+    timings_with_repeats = command_with_repeats.get_raw_timings()
+    assert timings_with_repeats == [
+        *expected_raw_timings[:-1],
+        Timing(high_us=562, low_us=96000),
+        Timing(high_us=9000, low_us=2250),
+        Timing(high_us=562, low_us=96000),
+        Timing(high_us=9000, low_us=2250),
+        Timing(high_us=562, low_us=0),
+    ]