python-broadlink 1.0.2__py3-none-any.whl → 1.0.3__py3-none-any.whl

broadlink/__init__.py

@@ -1,16 +1,14 @@
-#!/usr/bin/env python3
 """The python-broadlink library."""
 
 import contextlib
 from collections.abc import AsyncIterator
-from typing import Optional, Union
 
 from . import exceptions as e
 from .alarm import S1C
 from .climate import hvac, hysen
 from .const import DEFAULT_BCAST_ADDR, DEFAULT_PORT, DEFAULT_TIMEOUT
 from .cover import dooya, dooya2, wser
-from .device import Device, _open_endpoint, ping, scan
+from .device import Device, ping, scan, send_setup_packet
 from .hub import s3
 from .light import lb1, lb2
 from .remote import rm, rm4, rm4mini, rm4pro, rm5plus, rmmini, rmminib, rmpro
@@ -340,8 +338,4 @@ async def setup(
     payload[0x20] = checksum & 0xFF  # Checksum 1 position
     payload[0x21] = checksum >> 8  # Checksum 2 position
 
-    transport, _ = await _open_endpoint(broadcast=True)
-    try:
-        transport.sendto(payload, (ip_address, DEFAULT_PORT))
-    finally:
-        transport.close()
+    await send_setup_packet(bytes(payload), ip_address)

broadlink/device.py

@@ -56,10 +56,12 @@ class _Protocol(asyncio.DatagramProtocol):
         self.queue: asyncio.Queue[tuple[bytes, tuple[str, int]]] = asyncio.Queue()
         self.transport: asyncio.DatagramTransport | None = None
 
-    def connection_made(self, transport) -> None:  # type: ignore[override]
-        self.transport = transport
+    def connection_made(self, transport: asyncio.BaseTransport) -> None:
+        """Keep the transport; the endpoint sends through it."""
+        self.transport = transport  # type: ignore[assignment]
 
     def datagram_received(self, data: bytes, addr: tuple[str, int]) -> None:
+        """Queue every datagram for the request that is waiting."""
         self.queue.put_nowait((data, addr))
 
     def error_received(self, exc: Exception) -> None:
@@ -68,7 +70,7 @@ class _Protocol(asyncio.DatagramProtocol):
         pass
 
     def connection_lost(self, exc: Exception | None) -> None:
-        pass
+        """Nothing to do; a waiting request is told through the queue."""
 
     def drain(self) -> None:
         """Drop anything that arrived before the current request."""
@@ -161,6 +163,17 @@ async def scan(
         transport.close()
 
 
+async def send_setup_packet(
+    payload: bytes, ip_address: str, port: int = DEFAULT_PORT
+) -> None:
+    """Broadcast one Wi-Fi provisioning packet to a device in AP mode."""
+    transport, _ = await _open_endpoint(broadcast=True)
+    try:
+        transport.sendto(payload, (ip_address, port))
+    finally:
+        transport.close()
+
+
 async def ping(ip_address: str, port: int = DEFAULT_PORT) -> None:
     """Send a ping packet to an address.
 
@@ -213,12 +226,13 @@ class Device:
         self.aes = None
         self.update_aes(bytes.fromhex(self.__INIT_KEY))
 
-        self._lock: asyncio.Lock | None = None
+        self._lock = asyncio.Lock()
         self._transport: asyncio.DatagramTransport | None = None
         self._protocol: _Protocol | None = None
         self._endpoint_addr: tuple[str, int] | None = None
         self._recent: collections.deque[int] = collections.deque(maxlen=_RECENT_MAX)
-        self._reauth_lock: asyncio.Lock | None = None
+        self._reauth_lock = asyncio.Lock()
+        self._closes = 0  # Bumped by aclose(); guards an open racing a close.
         self._auth_generation = 0
 
     def __repr__(self) -> str:
@@ -277,9 +291,6 @@ class Device:
         packet[0x2D] = 0x01
         packet[0x30:0x36] = b"Test 1"
 
-        if self._lock is None:
-            self._lock = asyncio.Lock()
-            self._reauth_lock = asyncio.Lock()
         async with self._lock:
             self.id = 0
             self.update_aes(bytes.fromhex(self.__INIT_KEY))
@@ -292,7 +303,7 @@ class Device:
         _LOGGER.debug("%s: authenticated, session id %d", self.host[0], self.id)
         return True
 
-    async def hello(self, local_ip_address=None) -> bool:
+    async def hello(self, local_ip_address: str | None = None) -> bool:
         """Send a hello message to the device.
 
         Device information is checked before updating name and lock status.
@@ -385,6 +396,7 @@ class Device:
         A request in flight fails at once with ``ConnectionClosedError``
         rather than waiting out its timeout.
         """
+        self._closes += 1
         transport, protocol = self._transport, self._protocol
         self._transport = None
         self._protocol = None
@@ -401,7 +413,15 @@ class Device:
             # old address, so drop it.
             await self.aclose()
         if self._transport is None or self._transport.is_closing():
-            self._transport, self._protocol = await _open_endpoint(remote_addr=self.host)
+            closes = self._closes
+            transport, protocol = await _open_endpoint(remote_addr=self.host)
+            if self._closes != closes:
+                # aclose() ran while the socket was being opened.
+                transport.close()
+                raise e.EndpointClosedError(
+                    -4013, "Endpoint closed", "The device endpoint was closed"
+                )
+            self._transport, self._protocol = transport, protocol
             self._endpoint_addr = self.host
             _LOGGER.debug("%s: endpoint opened", self.host[0])
         return self._transport, self._protocol  # type: ignore[return-value]
@@ -507,27 +527,33 @@ class Device:
                     f"No response received within {timeout}s",
                 ) from None
 
-    async def send_packet(self, packet_type: int, payload: bytes) -> bytes:
+    async def send_packet(self, packet_type: int, payload: bytes | bytearray) -> bytes:
         """Send a packet to the device and return the raw response frame.
 
         If the device answers that the session key is no longer valid, the
         session is re-authenticated once and the request is sent again.
         Concurrent callers that hit the same expired key share one
-        re-authentication and each retry once.
+        re-authentication and each retry once. If that re-authentication
+        fails (for example the device has been locked in the app), the
+        original reply is returned unchanged, so the caller sees the same
+        error the original library raised and can run its own recovery.
         """
-        if self._lock is None:
-            self._lock = asyncio.Lock()
-            self._reauth_lock = asyncio.Lock()
-        generation = self._auth_generation
         async with self._lock:
+            generation = self._auth_generation
             resp = await self._exchange(self._frame(packet_type, bytes(payload)))
 
         code = int.from_bytes(resp[0x22:0x24], "little", signed=True)
         if code in _REAUTH_CODES:
             _LOGGER.debug("%s: device answered %d, re-authenticating", self.host[0], code)
-            async with self._reauth_lock:  # type: ignore[union-attr]
+            async with self._reauth_lock:
                 if self._auth_generation == generation:
-                    await self.auth()
+                    try:
+                        await self.auth()
+                    except e.BroadlinkException as err:
+                        _LOGGER.debug(
+                            "%s: re-authentication failed: %s", self.host[0], err
+                        )
+                        return resp
             async with self._lock:
                 resp = await self._exchange(self._frame(packet_type, bytes(payload)))
         return resp

broadlink/exceptions.py

@@ -168,6 +168,6 @@ def exception(err_code: int) -> BroadlinkException:
 
 def check_error(error: bytes) -> None:
     """Raise exception if an error occurred."""
-    error_code = struct.unpack("h", error)[0]
+    error_code = struct.unpack("<h", error)[0]
     if error_code:
         raise exception(error_code)

broadlink/remote.py

@@ -8,6 +8,7 @@ import time
 import weakref
 from collections.abc import AsyncIterator, Awaitable, Callable
 from dataclasses import dataclass, field
+from typing import Self
 
 from . import exceptions as e
 from .device import Device
@@ -53,10 +54,11 @@ class SignalKind(enum.IntEnum):
 
     @property
     def is_rf(self) -> bool:
+        """True for the radio bands."""
         return self is not SignalKind.IR
 
     @classmethod
-    def classify(cls, type_byte: int) -> "SignalKind":
+    def classify(cls, type_byte: int) -> Self:
         """Map a packet's raw first byte to a kind, tolerantly.
 
         The RF learn path returns bytes in the 0xB_ (433 MHz) and 0xD_
@@ -139,7 +141,7 @@ class ParsedPacket:
 
     kind: SignalKind
     repeat: int
-    pulses: list[int]
+    pulses: tuple[int, ...]
     type_byte: int
 
 
@@ -152,7 +154,7 @@ def parse_packet(data: bytes, tick: float = TICK) -> ParsedPacket:
     if len(data) < 4:
         raise ValueError("Malformed data.")
     kind = SignalKind.classify(data[0x00])
-    return ParsedPacket(kind, data[0x01], data_to_pulses(data, tick), data[0x00])
+    return ParsedPacket(kind, data[0x01], tuple(data_to_pulses(data, tick)), data[0x00])
 
 
 @dataclass(frozen=True)
@@ -170,7 +172,7 @@ class CapturedSignal:
 
     packet: bytes
     kind: SignalKind
-    pulses: list[int] = field(repr=False)
+    pulses: tuple[int, ...] = field(repr=False)
     repeat: int = 0
     frequency_mhz: float | None = None
     type_byte: int | None = None
@@ -183,7 +185,7 @@ class CapturedSignal:
         frequency_mhz: float | None = None,
         *,
         kind: SignalKind | None = None,
-    ) -> "CapturedSignal":
+    ) -> Self:
         """Build a signal from a device-returned packet.
 
         ``kind`` overrides the band read from the packet's type byte. A
@@ -200,7 +202,7 @@ class CapturedSignal:
         return cls(
             bytes(packet),
             kind,
-            data_to_pulses(packet),
+            tuple(data_to_pulses(packet)),
             packet[0x01],
             frequency_mhz,
             type_byte,
@@ -259,6 +261,9 @@ class rmmini(Device):
                     raise e.CaptureInProgressError(
                         "A capture window is already open; close it with aclose() first"
                     )
+                if self._window is not prev:
+                    # Another claimant got in during the two turns above.
+                    raise e.CaptureInProgressError("A capture window is already open")
         self._window = new
 
     async def _send(self, command: int, data: bytes = b"") -> bytes:

{python_broadlink-1.0.2.dist-info → python_broadlink-1.0.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-broadlink
-Version: 1.0.2
+Version: 1.0.3
 Summary: Python API for controlling Broadlink devices
 Author: DAB-LABS
 Author-email: Matthew Garrett <mjg59@srcf.ucam.org>
@@ -51,8 +51,9 @@ Every call that reaches a device is a coroutine and must be awaited. That
 is the main change from the original library's API: method names and
 arguments are the same, and so are return values, with the small
 exceptions listed in `CHANGELOG.md` (the IR tick constant, `pulses_to_data`
-returning `bytes`, the unused `Device.lock` attribute removed, and
-`timeout` parameters typed as floats).
+returning `bytes`, the unused `Device.lock` attribute removed, `timeout`
+parameters typed as floats, and the `mac` in a hello response typed as
+`bytes`).
 
 ```python
 import asyncio
@@ -81,11 +82,11 @@ The following devices are supported:
 - **Switches**: MCB1, SC1, SCB1E, SCB2
 - **Outlets**: BG 800, BG 900
 - **Power strips**: MP1-1K3S2U, MP1-1K4S, MP2
-- **Environment sensors**: A1
+- **Environment sensors**: A1, A2
 - **Alarm kits**: S1C, S2KIT
 - **Light bulbs**: LB1, LB26 R1, LB27 R1, SB800TD, LEDVANCE SMART+ WIFI CEILING TW 24W
 - **Curtain motors**: Dooya DT360E-45/20
-- **Thermostats**: Hysen HY02B05H
+- **Thermostats**: Hysen HY02/HY03
 - **Hubs**: S3
 
 ## Timing
@@ -204,6 +205,17 @@ After discovering the device, call the `auth()` method to obtain the authenticat
 await device.auth()
 ```
 
+The session key expires on the device after a while. When a request comes
+back with an expired-key answer, the library authenticates again and
+repeats the request once, so a long-running program does not need to
+handle that itself. If the second authentication fails, for example
+because the device was locked in the app in the meantime, the call raises
+the error the device gave the first time, the same `AuthorizationError`
+or `ConnectionClosedError` the original library raised, and it is up to
+the caller to decide what to do. In the worst case one call can wait out
+three timeouts (the request, the authentication, and the repeat), each
+bounded by `device.timeout`.
+
 ### Closing
 
 Each device keeps one UDP socket open for its lifetime (the original

{python_broadlink-1.0.2.dist-info → python_broadlink-1.0.3.dist-info}/RECORD

@@ -1,19 +1,19 @@
-broadlink/__init__.py,sha256=ZCQ3wBkaqDYpBsUBPBC0p-2Ys65qSzUe1xBfy9UQEO8,10986
+broadlink/__init__.py,sha256=wXL3gDxcmE563q4Kjsx9vzWn8Jgopj9Ls7kl4sC0qNQ,10821
 broadlink/alarm.py,sha256=tmeNI-AaPna5nbgoTqz_AGmuQVItGTmt7zyNiRLsSlQ,1260
 broadlink/climate.py,sha256=fciXwQ0P2_kOaJiXAprfXuDyhLdHU--mE6pCYkVWdF8,15592
 broadlink/const.py,sha256=Y0XSxYr1k27FKqHWBirJsUB0HGxQ1riIZ9rfVEJaIL4,120
 broadlink/cover.py,sha256=-wW1BPmf5Z8oeLuqDVEpUyU-PgId5CJ91M3g3RjgVAU,5448
-broadlink/device.py,sha256=ZoMV1HnoZRMj4HWLu_NYx5X3eGI9x1571vzpzMCj2jE,20223
-broadlink/exceptions.py,sha256=Sc43yKhN8yUD_PBUMXf0eZYUQcsM5daeeMhEzNTk71o,5225
+broadlink/device.py,sha256=dP2RbnxZve_m9bJsis51KfDwPNxxJuGapPltYuWF50M,21507
+broadlink/exceptions.py,sha256=S8xOGdzyFGd6ULXUlblDwE-MADoJIR49itEo0j_fZNU,5226
 broadlink/helpers.py,sha256=Zbw7lNRMB08P5FPAtKMJLExBjts_Gq64tJbR7-JwxX8,1294
 broadlink/hub.py,sha256=e78lDKcdtDNqSOZkQRqLMPMFR0PgT2g3E7VgULCq-QM,2869
 broadlink/light.py,sha256=fWCoaf6JmDfcc7ggRmehss9D3cp66evUDlcB50Iu2LI,7660
 broadlink/protocol.py,sha256=eRCm0fGdApVp5ko_fOP79lazQklda8N6x30ty6P0TiA,1848
-broadlink/remote.py,sha256=rdX97BsBtMDWhxLQrGC_yRLaHzrkSzHkD7cA3FjoKGg,22142
+broadlink/remote.py,sha256=1TO3xo_rhp9_Zt8yFRL3Im_IUH9Nbvt9pwyn9gstk18,22418
 broadlink/sensor.py,sha256=dhetprwgv45gkyvHgS2jJrYVuSQ2z-IXJynykgXo_2k,2701
 broadlink/switch.py,sha256=0VurdoGf3CTrYBSQU4ahVSLC_FYHqIRWr3dLkBwIatI,14985
-python_broadlink-1.0.2.dist-info/licenses/LICENSE,sha256=h0N_LWq34pY0W-Ky3ayO6Re5ejG0XvutPlW-GL8eG5I,1111
-python_broadlink-1.0.2.dist-info/METADATA,sha256=uPKS6KIH1ikvqNGa8m6t7Lg1_WvIvpcSIBZiUd6MPBQ,14321
-python_broadlink-1.0.2.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
-python_broadlink-1.0.2.dist-info/top_level.txt,sha256=_Qx7d8oNTOLeDkAN-HHDoq1FlRNlsiaMZlyMWgHXAVc,10
-python_broadlink-1.0.2.dist-info/RECORD,,
+python_broadlink-1.0.3.dist-info/licenses/LICENSE,sha256=h0N_LWq34pY0W-Ky3ayO6Re5ejG0XvutPlW-GL8eG5I,1111
+python_broadlink-1.0.3.dist-info/METADATA,sha256=YQblobXPiUvcd2rGgxclX3M_JuFMp77kB4d6uSAuJNs,15046
+python_broadlink-1.0.3.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+python_broadlink-1.0.3.dist-info/top_level.txt,sha256=_Qx7d8oNTOLeDkAN-HHDoq1FlRNlsiaMZlyMWgHXAVc,10
+python_broadlink-1.0.3.dist-info/RECORD,,