rf-protocols 4.0.1__tar.gz → 4.2.0__tar.gz

{rf_protocols-4.0.1 → rf_protocols-4.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rf-protocols
-Version: 4.0.1
+Version: 4.2.0
 Summary: Library to decode and encode radio frequency signals.
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/home-assistant-libs/rf-protocols

{rf_protocols-4.0.1 → rf_protocols-4.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name         = "rf-protocols"
-version      = "4.0.1"
+version      = "4.2.0"
 license      = "MIT"
 description  = "Library to decode and encode radio frequency signals."
 readme       = "README.md"

rf_protocols-4.2.0/rf_protocols/codes/harbor_breeze/a25/__init__.py

@@ -0,0 +1,34 @@
+"""Harbor Breeze A25 command identifiers."""
+
+from enum import IntEnum
+
+from ....commands.harbor_breeze_a25 import HarborBreezeA25Command
+
+
+class HarborBreezeA25Button(IntEnum):
+    """Known Harbor Breeze A25 button codes.
+
+    Values are the decoded 6-bit command field found in the normalized frame.
+    """
+
+    BLOW = 0b111010
+    BREEZE = 0b000110
+    FAN_1 = 0b011110
+    FAN_2 = 0b101110
+    FAN_3 = 0b001110
+    FAN_4 = 0b110110
+    FAN_5 = 0b010110
+    FAN_6 = 0b100110
+    HOME = 0b000011
+    LIGHT = 0b011010
+    POWER = 0b111110
+    SUCK = 0b111000
+    TIMER = 0b001000
+    TIMER_2H = 0b011011
+    TIMER_4H = 0b101011
+    TIMER_8H = 0b001011
+
+    def to_command(self, *, address: int) -> HarborBreezeA25Command:
+        """Build a Harbor Breeze command for this button and address."""
+        return HarborBreezeA25Command(address=address, command=self.value)
+

rf_protocols-4.2.0/rf_protocols/commands/harbor_breeze_a25.py

@@ -0,0 +1,71 @@
+"""Harbor Breeze A25 RF command encoder."""
+
+from __future__ import annotations
+
+from typing import override
+
+from . import ModulationType, RadioFrequencyCommand
+
+_DEFAULT_FREQUENCY = 315_000_000
+_DEFAULT_FRAME_COUNT = 6
+
+
+class HarborBreezeA25Command(RadioFrequencyCommand):
+    """Encode Harbor Breeze A25 transmissions.
+
+    The frame layout consists of a three-symbol preamble, a 13-bit address,
+    two fixed bits, a 6-bit command field, two fixed trailer bits, and a final
+    inter-frame gap. The complete frame is emitted six times per transmission.
+    """
+
+    address: int
+    command: int
+
+    def __init__(
+        self,
+        *,
+        address: int,
+        command: int,
+        frequency: int = _DEFAULT_FREQUENCY,
+    ) -> None:
+        """Initialize the Harbor Breeze command.
+
+        Args:
+            address: 13-bit receiver address (0..8191).
+            command: 6-bit command value (0..63).
+            frequency: RF frequency in Hz.
+        """
+        if address < 0 or address >= (1 << 13):
+            raise ValueError("address must be in range 0..8191 (13-bit)")
+        if command < 0 or command >= (1 << 6):
+            raise ValueError("command must be in range 0..63 (6-bit)")
+
+        super().__init__(
+            frequency=frequency,
+            modulation=ModulationType.OOK,
+            repeat_count=0,
+        )
+        self.address = address
+        self.command = command
+
+    @override
+    def get_raw_timings(self) -> list[int]:
+        """Compute the repeated Harbor Breeze transmission timings."""
+        short_us = 493
+        long_us = 952
+        frame_gap_us = 10_936
+
+        payload_bits = f"{self.address:013b}00{self.command:06b}10"
+
+        frame: list[int] = [short_us, -long_us, short_us]
+        for bit in payload_bits:
+            if bit == "0":
+                frame.extend([-long_us, short_us])
+            else:
+                frame.extend([-short_us, long_us])
+        frame.append(-frame_gap_us)
+
+        timings: list[int] = []
+        for _ in range(_DEFAULT_FRAME_COUNT):
+            timings.extend(frame)
+        return timings

rf_protocols-4.2.0/rf_protocols/commands/marantec.py

@@ -0,0 +1,76 @@
+"""Encoder for Marantec garage door / gate RF remotes.
+
+868.35 MHz OOK (433.92 MHz variant available), Manchester-coded. Encodes a
+static, indefinitely valid (non-rolling) 49-bit code. Does not cover
+rolling-code Marantec systems or the unrelated 24-bit "Marantec24" cloner
+protocol.
+"""
+
+from __future__ import annotations
+
+from typing import override
+
+from . import ModulationType, RadioFrequencyCommand
+
+_MARANTEC_FREQUENCY = 868_350_000
+_MARANTEC_REPEAT_COUNT = 4
+
+_TE_SHORT = 1000
+_TE_LONG = 2000
+_HEADER_LOW = _TE_LONG * 5
+
+_BIT_COUNT = 49
+
+
+class MarantecCommand(RadioFrequencyCommand):
+    """Encode a Marantec static-code garage door / gate frame."""
+
+    code: int
+
+    def __init__(
+        self,
+        *,
+        code: int,
+        frequency: int = _MARANTEC_FREQUENCY,
+    ) -> None:
+        """Initialize the Marantec command."""
+        if code < 0 or code >= (1 << _BIT_COUNT):
+            raise ValueError("code must be a 49-bit value (0..2**49-1)")
+        super().__init__(
+            frequency=frequency,
+            modulation=ModulationType.OOK,
+            repeat_count=_MARANTEC_REPEAT_COUNT,
+        )
+        self.code = code
+
+    @override
+    def get_raw_timings(self) -> list[int]:
+        """Compute the frame timings as signed mark/space microseconds.
+
+        Manchester (bit 0 = mark then space, bit 1 = space then mark), 49 bits,
+        trailing inter-frame gap. Frame starts on a mark so polarity (assigned
+        by index parity) stays correct; the first bit's leading space and the
+        gap are reconstructed across the repeated transmissions.
+        """
+        timings: list[int] = []
+
+        def add(us: int) -> None:
+            if timings and (us > 0) == (timings[-1] > 0):
+                timings[-1] += us
+            else:
+                timings.append(us)
+
+        for idx in range(_BIT_COUNT):
+            bit = (self.code >> (_BIT_COUNT - 1 - idx)) & 1
+            if idx == 0 and bit:
+                add(_TE_SHORT)
+                continue
+            if bit:
+                add(-_TE_SHORT)
+                add(_TE_SHORT)
+            else:
+                add(_TE_SHORT)
+                add(-_TE_SHORT)
+
+        add(-_HEADER_LOW)
+        return timings

{rf_protocols-4.0.1 → rf_protocols-4.2.0}/rf_protocols.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rf-protocols
-Version: 4.0.1
+Version: 4.2.0
 Summary: Library to decode and encode radio frequency signals.
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/home-assistant-libs/rf-protocols

{rf_protocols-4.0.1 → rf_protocols-4.2.0}/rf_protocols.egg-info/SOURCES.txt

@@ -9,6 +9,7 @@ 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
+rf_protocols/codes/harbor_breeze/a25/__init__.py
 rf_protocols/codes/honeywell/string_lights/__init__.py
 rf_protocols/codes/honeywell/string_lights/turn_off.sub
 rf_protocols/codes/honeywell/string_lights/turn_on.sub
@@ -16,7 +17,9 @@ rf_protocols/codes/novy/cooker_hood/__init__.py
 rf_protocols/codes/somfy/rts/__init__.py
 rf_protocols/commands/__init__.py
 rf_protocols/commands/ev1527.py
+rf_protocols/commands/harbor_breeze_a25.py
 rf_protocols/commands/kaku.py
+rf_protocols/commands/marantec.py
 rf_protocols/commands/novy.py
 rf_protocols/commands/ook.py
 rf_protocols/commands/pilota_casa.py