PySwitchbot 2.4.0__tar.gz → 2.5.0__tar.gz

{pyswitchbot-2.4.0 → pyswitchbot-2.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PySwitchbot
-Version: 2.4.0
+Version: 2.5.0
 Summary: A library to communicate with Switchbot
 License: MIT
 License-File: LICENSE

{pyswitchbot-2.4.0 → pyswitchbot-2.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "PySwitchbot"
-version = "2.4.0"
+version = "2.5.0"
 description = "A library to communicate with Switchbot"
 authors = ["Daniel Hjelseth Hoyer"]
 license = "MIT"

{pyswitchbot-2.4.0 → pyswitchbot-2.5.0}/switchbot/__init__.py

@@ -70,6 +70,7 @@ from .devices.relay_switch import (
 )
 from .devices.roller_shade import SwitchbotRollerShade
 from .devices.smart_thermostat_radiator import SwitchbotSmartThermostatRadiator
+from .devices.universal_remote import SwitchbotUniversalRemote
 from .devices.vacuum import SwitchbotVacuum
 from .discovery import GetSwitchbotDevices
 from .models import SwitchBotAdvertisement
@@ -131,6 +132,7 @@ __all__ = [
     "SwitchbotStandingFan",
     "SwitchbotStripLight3",
     "SwitchbotSupportedType",
+    "SwitchbotUniversalRemote",
     "SwitchbotVacuum",
     "VerticalOscillationAngle",
     "close_stale_connections",

pyswitchbot-2.5.0/switchbot/__version__.py

@@ -0,0 +1 @@
+__version__ = "2.5.0"

{pyswitchbot-2.4.0 → pyswitchbot-2.5.0}/switchbot/adv_parser.py

@@ -51,7 +51,7 @@ from .adv_parsers.relay_switch import (
     process_relay_switch_2pm,
     process_relay_switch_common_data,
 )
-from .adv_parsers.remote import process_woremote
+from .adv_parsers.remote import process_woremote, process_wouniversal_remote
 from .adv_parsers.roller_shade import process_worollershade
 from .adv_parsers.smart_thermostat_radiator import process_smart_thermostat_radiator
 from .adv_parsers.vacuum import process_vacuum, process_vacuum_k
@@ -402,6 +402,18 @@ SUPPORTED_TYPES: dict[str | bytes, SwitchbotSupportedType] = {
         "func": process_woremote,
         "manufacturer_id": 89,
     },
+    "\x07": {
+        "modelName": SwitchbotModel.UNIVERSAL_REMOTE,
+        "modelFriendlyName": "Universal Remote",
+        "func": process_wouniversal_remote,
+        "manufacturer_id": 2409,
+    },
+    "'": {
+        "modelName": SwitchbotModel.UNIVERSAL_REMOTE,
+        "modelFriendlyName": "Universal Remote",
+        "func": process_wouniversal_remote,
+        "manufacturer_id": 2409,
+    },
     ",": {
         "modelName": SwitchbotModel.ROLLER_SHADE,
         "modelFriendlyName": "Roller Shade",

{pyswitchbot-2.4.0 → pyswitchbot-2.5.0}/switchbot/adv_parsers/climate_panel.py

@@ -28,6 +28,18 @@ def process_climate_panel(
     pir_state = bool(mfr_data[15] & 0x80)
     is_light = ((mfr_data[15] >> 1) & 0x03) == 0x02
 
+    # Keystate bytes report physical ON/OFF button presses. For each byte,
+    # Bit[7:5] is the press mode (0: power-on init, 1: single, 2: double,
+    # 3: long) and Bit[4:0] is a 1-30 cyclic counter that resets to 1 when the
+    # mode changes. A value of 0x00 is the power-on state and must not trigger.
+    # The raw byte is also exposed so consumers can watch it for any change.
+    on_keystate = mfr_data[13]
+    off_keystate = mfr_data[14]
+    on_keystate_mode = (on_keystate >> 5) & 0x07
+    on_keystate_counter = on_keystate & 0x1F
+    off_keystate_mode = (off_keystate >> 5) & 0x07
+    off_keystate_counter = off_keystate & 0x1F
+
     result = {
         "sequence_number": seq_number,
         "isOn": isOn,
@@ -38,6 +50,12 @@ def process_climate_panel(
         "humidity_alarm": humidity_alarm,
         "motion_detected": pir_state,
         "is_light": is_light,
+        "on_keystate": on_keystate,
+        "off_keystate": off_keystate,
+        "on_keystate_mode": on_keystate_mode,
+        "on_keystate_counter": on_keystate_counter,
+        "off_keystate_mode": off_keystate_mode,
+        "off_keystate_counter": off_keystate_counter,
     }
 
     _LOGGER.debug(

pyswitchbot-2.5.0/switchbot/adv_parsers/remote.py

@@ -0,0 +1,42 @@
+"""Remote adv parser."""
+
+from __future__ import annotations
+
+import logging
+
+_LOGGER = logging.getLogger(__name__)
+
+
+def process_woremote(
+    data: bytes | None, mfr_data: bytes | None
+) -> dict[str, int | None]:
+    """Process WoRemote adv data."""
+    if data is None or len(data) < 3:
+        return {
+            "battery": None,
+        }
+
+    _LOGGER.debug("data: %s", data.hex())
+
+    return {
+        "battery": data[2] & 0b01111111,
+    }
+
+
+def process_wouniversal_remote(
+    data: bytes | None, mfr_data: bytes | None
+) -> dict[str, bool | int | None]:
+    """Process Universal Remote adv data."""
+    if mfr_data is None or len(mfr_data) < 8:
+        return {
+            "battery": None,
+            "charging": None,
+        }
+
+    _LOGGER.debug("mfr_data: %s", mfr_data.hex())
+
+    # mfr_data[7]: bit 7 is charging; bits 6-0 are battery percentage.
+    return {
+        "battery": mfr_data[7] & 0b01111111,
+        "charging": bool((mfr_data[7] >> 7) & 1),
+    }

{pyswitchbot-2.4.0 → pyswitchbot-2.5.0}/switchbot/const/__init__.py

@@ -82,6 +82,7 @@ class SwitchbotModel(StrEnum):
     RELAY_SWITCH_1PM = "Relay Switch 1PM"
     RELAY_SWITCH_1 = "Relay Switch 1"
     REMOTE = "WoRemote"
+    UNIVERSAL_REMOTE = "WoUniversalRemote"
     EVAPORATIVE_HUMIDIFIER = "Evaporative Humidifier"
     ROLLER_SHADE = "Roller Shade"
     HUBMINI_MATTER = "HubMini Matter"

{pyswitchbot-2.4.0 → pyswitchbot-2.5.0}/switchbot/const/fan.py

@@ -60,3 +60,9 @@ class VerticalOscillationAngle(Enum):
     ANGLE_30 = 30
     ANGLE_60 = 60
     ANGLE_90 = 95
+
+    @classmethod
+    def _missing_(cls, value: int) -> VerticalOscillationAngle | None:
+        if value == 90:
+            return cls.ANGLE_90
+        return None

{pyswitchbot-2.4.0 → pyswitchbot-2.5.0}/switchbot/devices/device.py

@@ -74,6 +74,7 @@ API_MODEL_TO_ENUM: dict[str, SwitchbotModel] = {
     "WoBlindTilt": SwitchbotModel.BLIND_TILT,
     "WoIOSensor": SwitchbotModel.IO_METER,  # Outdoor Meter
     "WoButton": SwitchbotModel.REMOTE,  # Remote button
+    "WoUniversalRemote": SwitchbotModel.UNIVERSAL_REMOTE,  # Universal Remote
     "WoLinkMini": SwitchbotModel.HUBMINI_MATTER,  # Hub Mini
     "WoFan2": SwitchbotModel.CIRCULATOR_FAN,
     "WoHub2": SwitchbotModel.HUB2,

pyswitchbot-2.5.0/switchbot/devices/universal_remote.py

@@ -0,0 +1,23 @@
+"""Library to handle connection with Switchbot Universal Remote."""
+
+from __future__ import annotations
+
+import logging
+from typing import Any
+
+from .device import SwitchbotDevice
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class SwitchbotUniversalRemote(SwitchbotDevice):
+    """Representation of a Switchbot Universal Remote."""
+
+    async def get_basic_info(self) -> dict[str, Any] | None:
+        """Get device basic settings."""
+        if not (_data := await self._get_basic_info()):
+            return None
+        return {
+            "battery": _data[1],
+            "charging": bool(_data[12]),
+        }

pyswitchbot-2.4.0/switchbot/__version__.py

@@ -1 +0,0 @@
-__version__ = "2.4.0"

pyswitchbot-2.4.0/switchbot/adv_parsers/remote.py

@@ -1,23 +0,0 @@
-"""Remote adv parser."""
-
-from __future__ import annotations
-
-import logging
-
-_LOGGER = logging.getLogger(__name__)
-
-
-def process_woremote(
-    data: bytes | None, mfr_data: bytes | None
-) -> dict[str, int | None]:
-    """Process WoRemote adv data."""
-    if data is None or len(data) < 3:
-        return {
-            "battery": None,
-        }
-
-    _LOGGER.debug("data: %s", data.hex())
-
-    return {
-        "battery": data[2] & 0b01111111,
-    }