PySwitchbot 2.4.1__tar.gz → 2.6.0__tar.gz

{pyswitchbot-2.4.1 → pyswitchbot-2.6.0}/PKG-INFO

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

{pyswitchbot-2.4.1 → pyswitchbot-2.6.0}/pyproject.toml

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

{pyswitchbot-2.4.1 → pyswitchbot-2.6.0}/switchbot/__init__.py

@@ -14,6 +14,7 @@ from .const import (
     AirQualityLevel,
     BulbColorMode,
     CeilingLightColorMode,
+    CirculatorFanProMode,
     ClimateAction,
     ClimateMode,
     ColorMode,
@@ -48,7 +49,11 @@ from .devices.device import (
     fetch_cloud_devices,
 )
 from .devices.evaporative_humidifier import SwitchbotEvaporativeHumidifier
-from .devices.fan import SwitchbotFan, SwitchbotStandingFan
+from .devices.fan import (
+    SwitchbotCirculatorFanPro,
+    SwitchbotFan,
+    SwitchbotStandingFan,
+)
 from .devices.humidifier import SwitchbotHumidifier
 from .devices.keypad_vision import SwitchbotKeypadVision
 from .devices.light_strip import (
@@ -70,6 +75,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
@@ -79,6 +85,7 @@ __all__ = [
     "AirQualityLevel",
     "BulbColorMode",
     "CeilingLightColorMode",
+    "CirculatorFanProMode",
     "ClimateAction",
     "ClimateMode",
     "ColorMode",
@@ -105,6 +112,7 @@ __all__ = [
     "SwitchbotBulb",
     "SwitchbotCandleWarmerLamp",
     "SwitchbotCeilingLight",
+    "SwitchbotCirculatorFanPro",
     "SwitchbotCurtain",
     "SwitchbotDevice",
     "SwitchbotEncryptedDevice",
@@ -131,6 +139,7 @@ __all__ = [
     "SwitchbotStandingFan",
     "SwitchbotStripLight3",
     "SwitchbotSupportedType",
+    "SwitchbotUniversalRemote",
     "SwitchbotVacuum",
     "VerticalOscillationAngle",
     "close_stale_connections",

pyswitchbot-2.6.0/switchbot/__version__.py

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

{pyswitchbot-2.4.1 → pyswitchbot-2.6.0}/switchbot/adv_parser.py

@@ -20,7 +20,11 @@ from .adv_parsers.ceiling_light import process_woceiling
 from .adv_parsers.climate_panel import process_climate_panel
 from .adv_parsers.contact import process_wocontact
 from .adv_parsers.curtain import process_wocurtain
-from .adv_parsers.fan import process_fan, process_standing_fan
+from .adv_parsers.fan import (
+    process_circulator_fan_pro,
+    process_fan,
+    process_standing_fan,
+)
 from .adv_parsers.hub2 import process_wohub2
 from .adv_parsers.hub3 import process_hub3
 from .adv_parsers.hubmini_matter import process_hubmini_matter
@@ -51,7 +55,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 +406,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",
@@ -702,6 +718,18 @@ SUPPORTED_TYPES: dict[str | bytes, SwitchbotSupportedType] = {
         "func": process_rgbicww_ceiling_light,
         "manufacturer_id": 2409,
     },
+    b"\x00\x11\xb3@": {
+        "modelName": SwitchbotModel.CIRCULATOR_FAN_PRO,
+        "modelFriendlyName": "Circulator Fan Pro",
+        "func": process_circulator_fan_pro,
+        "manufacturer_id": 2409,
+    },
+    b"\x01\x11\xb3@": {
+        "modelName": SwitchbotModel.CIRCULATOR_FAN_PRO,
+        "modelFriendlyName": "Circulator Fan Pro",
+        "func": process_circulator_fan_pro,
+        "manufacturer_id": 2409,
+    },
     b"\x00\x10\xd0\xb7": {
         "modelName": SwitchbotModel.PERMANENT_OUTDOOR_LIGHT,
         "modelFriendlyName": "Permanent Outdoor Light",

{pyswitchbot-2.4.1 → pyswitchbot-2.6.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.4.1 → pyswitchbot-2.6.0}/switchbot/adv_parsers/fan.py

@@ -2,12 +2,15 @@
 
 from __future__ import annotations
 
-from ..const.fan import FanMode, StandingFanMode
+from ..const.fan import CirculatorFanProMode, FanMode, StandingFanMode
 
 _FAN_MODE_MAP: dict[int, str] = {m.value: m.name.lower() for m in FanMode}
 _STANDING_FAN_MODE_MAP: dict[int, str] = {
     m.value: m.name.lower() for m in StandingFanMode
 }
+_CIRCULATOR_FAN_PRO_MODE_MAP: dict[int, str] = {
+    m.value: m.name.lower() for m in CirculatorFanProMode
+}
 
 
 def _parse_fan(
@@ -60,3 +63,48 @@ def process_standing_fan(
 ) -> dict[str, bool | int | str | None]:
     """Process Standing Fan services data (modes 1-5; adds CUSTOM_NATURAL)."""
     return _parse_fan(mfr_data, _STANDING_FAN_MODE_MAP, with_charging=True)
+
+
+def process_circulator_fan_pro(
+    data: bytes | None, mfr_data: bytes | None
+) -> dict[str, bool | int | str | None]:
+    """
+    Process Circulator Fan Pro (W1160) advertisement.
+
+    The Pro shares the W1071 Modern Ceiling Fan broadcast layout, which differs
+    from the legacy Circulator Fan: battery and the fan-state byte are swapped.
+    The fan-state byte carries a two-level night light (bit2 = on/off, bit3 =
+    level: 0 high / 1 low). Byte offsets are relative to the manufacturer data,
+    after the leading 6-byte MAC.
+    """
+    if mfr_data is None or len(mfr_data) < 10:
+        return {}
+
+    device_data = mfr_data[6:]
+
+    _seq_num = device_data[0]
+    _charging = bool(device_data[1] & 0b10000000)
+    _battery = device_data[1] & 0b01111111
+    _state = device_data[2]
+    _isOn = bool(_state & 0b10000000)
+    _mode = (_state & 0b01110000) >> 4
+    _night_light_on = bool(_state & 0b00000100)
+    # bit3: 0 = level 1 (high / bright), 1 = level 2 (low / dim)
+    _night_light_level = 2 if _state & 0b00001000 else 1
+    _oscillate_left_and_right = bool(_state & 0b00000010)
+    _oscillate_up_and_down = bool(_state & 0b00000001)
+    _speed = device_data[3] & 0b01111111
+
+    return {
+        "sequence_number": _seq_num,
+        "isOn": _isOn,
+        "mode": _CIRCULATOR_FAN_PRO_MODE_MAP.get(_mode),
+        "night_light_is_on": _night_light_on,
+        "night_light_level": _night_light_level if _night_light_on else 0,
+        "oscillating": _oscillate_left_and_right or _oscillate_up_and_down,
+        "oscillating_horizontal": _oscillate_left_and_right,
+        "oscillating_vertical": _oscillate_up_and_down,
+        "battery": _battery,
+        "charging": _charging,
+        "speed": _speed,
+    }

pyswitchbot-2.6.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.1 → pyswitchbot-2.6.0}/switchbot/const/__init__.py

@@ -11,6 +11,7 @@ from .evaporative_humidifier import (
     HumidifierWaterLevel,
 )
 from .fan import (
+    CirculatorFanProMode,
     FanMode,
     HorizontalOscillationAngle,
     NightLightState,
@@ -82,10 +83,12 @@ 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"
     CIRCULATOR_FAN = "Circulator Fan"
+    CIRCULATOR_FAN_PRO = "Circulator Fan Pro"
     STANDING_FAN = "Standing Fan"
     K20_VACUUM = "K20 Vacuum"
     S10_VACUUM = "S10 Vacuum"
@@ -134,6 +137,7 @@ __all__ = [
     "AirQualityLevel",
     "BulbColorMode",
     "CeilingLightColorMode",
+    "CirculatorFanProMode",
     "ClimateAction",
     "ClimateMode",
     "ColorMode",

{pyswitchbot-2.4.1 → pyswitchbot-2.6.0}/switchbot/const/fan.py

@@ -26,6 +26,23 @@ class StandingFanMode(Enum):
         return [mode.name.lower() for mode in cls]
 
 
+class CirculatorFanProMode(Enum):
+    """
+    Circulator Fan Pro (W1160) running modes.
+
+    Mode 0x04 is hurricane, not the baby mode of the legacy fan.
+    """
+
+    NORMAL = 1
+    NATURAL = 2
+    SLEEP = 3
+    HURRICANE = 4
+
+    @classmethod
+    def get_modes(cls) -> list[str]:
+        return [mode.name.lower() for mode in cls]
+
+
 class NightLightState(Enum):
     """Standing Fan night-light command values."""
 

{pyswitchbot-2.4.1 → pyswitchbot-2.6.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,
@@ -104,6 +105,7 @@ API_MODEL_TO_ENUM: dict[str, SwitchbotModel] = {
     "W1102004": SwitchbotModel.RGBICWW_FLOOR_LAMP,
     "W1163000": SwitchbotModel.RGBICWW_LIGHT_BARS,
     "W1162000": SwitchbotModel.RGBICWW_CEILING_LIGHT,
+    "W1160000": SwitchbotModel.CIRCULATOR_FAN_PRO,
     "W1104000": SwitchbotModel.PLUG_MINI_EU,
     "W1128000": SwitchbotModel.SMART_THERMOSTAT_RADIATOR,
     "W1111000": SwitchbotModel.CLIMATE_PANEL,

{pyswitchbot-2.4.1 → pyswitchbot-2.6.0}/switchbot/devices/fan.py

@@ -6,7 +6,9 @@ import logging
 from enum import Enum
 from typing import Any, ClassVar
 
+from ..const import SwitchbotModel
 from ..const.fan import (
+    CirculatorFanProMode,
     FanMode,
     HorizontalOscillationAngle,
     NightLightState,
@@ -15,6 +17,7 @@ from ..const.fan import (
 )
 from .device import (
     DEVICE_GET_BASIC_SETTINGS_KEY,
+    SwitchbotEncryptedDevice,
     SwitchbotSequenceDevice,
     update_after_operation,
 )
@@ -186,6 +189,11 @@ class SwitchbotFan(SwitchbotSequenceDevice):
         """Return cached mode."""
         return self._get_adv_value("mode")
 
+    @property
+    def fan_modes(self) -> list[str]:
+        """Return the supported preset (wind) modes for this device."""
+        return self._mode_enum.get_modes()
+
 
 class SwitchbotStandingFan(SwitchbotFan):
     """Representation of a Switchbot Standing Fan (FAN2)."""
@@ -309,3 +317,114 @@ class SwitchbotStandingFan(SwitchbotFan):
     def get_auto_recenter(self) -> bool | None:
         """Return cached auto-recenter (return-to-center) state."""
         return self._get_adv_value("auto_recenter")
+
+
+class SwitchbotCirculatorFanPro(SwitchbotEncryptedDevice, SwitchbotFan):
+    """
+    Representation of a Switchbot Circulator Fan Pro (W1160).
+
+    The Pro uses extended commands (``57 0F <subcmd> …``) with a control-source
+    byte (0x29 = Home Assistant), wrapped in the encrypted command shell, so it
+    extends SwitchbotEncryptedDevice. Fan power uses subcommand 0x41 (open/close
+    sub-op 0x11); the night light uses subcommand 0x96 and supports on/off plus
+    a choice between two brightness levels via ``turn_on_light(low=...)``
+    (level 1 / bright or level 2 / dim).
+    """
+
+    _model = SwitchbotModel.CIRCULATOR_FAN_PRO
+
+    # Fan power: ext 0x0F, subcmd 0x41, 0x11 = power, 0x29 = control source
+    # (Home Assistant), byte5 0x01 = on / 0x00 = off / 0x02 = toggle.
+    _turn_on_command = "570f41112901"
+    _turn_off_command = "570f41112900"
+    # Preset mode: the 0x11 power command also carries the running mode in byte6
+    # (turning the fan on). The Pro's mode 0x04 is hurricane, not the legacy baby.
+    _mode_enum: ClassVar[type[Enum]] = CirculatorFanProMode
+    _command_set_mode: ClassVar[dict[str, str]] = {
+        mode.name.lower(): f"570f41112901{mode.value:02X}"
+        for mode in CirculatorFanProMode
+    }
+    # Night light: ext 0x0F, subcmd 0x96, byte3 0x0A, byte4 0x02, then a state
+    # byte: bit0 = on/off (0 off / 1 on), bit1 = level (0 high / 1 low).
+    # off = 0x00, on high = 0x01, on low = 0x03.
+    _night_light_command = "570f960a02{}"
+    # Oscillation: ext 0x0F, subcmd 0x02, 0x29 = control source (Home Assistant),
+    # then per-axis action bytes [horizontal, vertical] where 0x01 = start,
+    # 0x02 = stop, 0xFF = keep current. The Pro is dual-axis, so the all-axes
+    # start/stop variants toggle both axes at once.
+    _command_start_oscillation: ClassVar[str] = "570f4102290101"
+    _command_stop_oscillation: ClassVar[str] = "570f4102290202"
+    _command_start_horizontal_oscillation: ClassVar[str] = "570f41022901ff"
+    _command_stop_horizontal_oscillation: ClassVar[str] = "570f41022902ff"
+    _command_start_vertical_oscillation: ClassVar[str] = "570f410229ff01"
+    _command_stop_vertical_oscillation: ClassVar[str] = "570f410229ff02"
+
+    async def get_basic_info(self) -> dict[str, Any] | None:
+        """
+        Get device basic info.
+
+        The Pro carries all runtime state (fan + night light) in its
+        advertisement, so only the firmware is read here.
+        """
+        if not (_data1 := await self._get_basic_info(DEVICE_GET_BASIC_SETTINGS_KEY)):
+            return None
+        if len(_data1) <= 2:
+            return None
+        return {"firmware": _data1[2] / 10.0}
+
+    @update_after_operation
+    async def set_percentage(self, percentage: int) -> bool:
+        """
+        Set the fan speed (1-100).
+
+        Speed lives in byte7 of the 0x11 power command and only applies in
+        direct mode, so this sends "on + direct mode + speed".
+        """
+        percentage = max(1, min(100, percentage))
+        result = await self._send_command(f"570f4111290101{percentage:02X}")
+        return self._check_command_result(result, 0, {1})
+
+    @update_after_operation
+    async def set_horizontal_oscillation(self, oscillating: bool) -> bool:
+        """Send command to set fan horizontal (left-right) oscillation only."""
+        cmd = (
+            self._command_start_horizontal_oscillation
+            if oscillating
+            else self._command_stop_horizontal_oscillation
+        )
+        result = await self._send_command(cmd)
+        return self._check_command_result(result, 0, {1})
+
+    @update_after_operation
+    async def set_vertical_oscillation(self, oscillating: bool) -> bool:
+        """Send command to set fan vertical (up-down) oscillation only."""
+        cmd = (
+            self._command_start_vertical_oscillation
+            if oscillating
+            else self._command_stop_vertical_oscillation
+        )
+        result = await self._send_command(cmd)
+        return self._check_command_result(result, 0, {1})
+
+    @update_after_operation
+    async def turn_on_light(self, low: bool = False) -> bool:
+        """Turn the night light on (low selects level 2 / dim, else level 1 / bright)."""
+        state = 0x03 if low else 0x01
+        result = await self._send_command(
+            self._night_light_command.format(f"{state:02X}")
+        )
+        return self._check_command_result(result, 0, {1})
+
+    @update_after_operation
+    async def turn_off_light(self) -> bool:
+        """Turn the night light off."""
+        result = await self._send_command(self._night_light_command.format("00"))
+        return self._check_command_result(result, 0, {1})
+
+    def is_night_light_on(self) -> bool | None:
+        """Return the cached night-light power state."""
+        return self._get_adv_value("night_light_is_on")
+
+    def get_night_light_level(self) -> int | None:
+        """Return the cached night-light level (1 high, 2 low, 0 off)."""
+        return self._get_adv_value("night_light_level")

pyswitchbot-2.6.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.1/switchbot/__version__.py

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

pyswitchbot-2.4.1/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,
-    }