PySwitchbot 0.64.1__tar.gz → 0.65.0__tar.gz

{pyswitchbot-0.64.1 → pyswitchbot-0.65.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PySwitchbot
-Version: 0.64.1
+Version: 0.65.0
 Summary: A library to communicate with Switchbot
 Home-page: https://github.com/sblibs/pySwitchbot/
 Author: Daniel Hjelseth Hoyer

{pyswitchbot-0.64.1 → pyswitchbot-0.65.0}/PySwitchbot.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PySwitchbot
-Version: 0.64.1
+Version: 0.65.0
 Summary: A library to communicate with Switchbot
 Home-page: https://github.com/sblibs/pySwitchbot/
 Author: Daniel Hjelseth Hoyer

{pyswitchbot-0.64.1 → pyswitchbot-0.65.0}/PySwitchbot.egg-info/SOURCES.txt

@@ -76,6 +76,7 @@ tests/test_blind_tilt.py
 tests/test_curtain.py
 tests/test_evaporative_humidifier.py
 tests/test_fan.py
+tests/test_helpers.py
 tests/test_hub2.py
 tests/test_hub3.py
 tests/test_lock.py

{pyswitchbot-0.64.1 → pyswitchbot-0.65.0}/setup.py

@@ -20,7 +20,7 @@ setup(
         "cryptography>=39.0.0",
         "pyOpenSSL>=23.0.0",
     ],
-    version="0.64.1",
+    version="0.65.0",
     description="A library to communicate with Switchbot",
     long_description=long_description,
     long_description_content_type="text/markdown",

{pyswitchbot-0.64.1 → pyswitchbot-0.65.0}/switchbot/__init__.py

@@ -12,6 +12,9 @@ from .adv_parser import SwitchbotSupportedType, parse_advertisement_data
 from .const import (
     AirPurifierMode,
     FanMode,
+    HumidifierAction,
+    HumidifierMode,
+    HumidifierWaterLevel,
     LockStatus,
     SwitchbotAccountConnectionError,
     SwitchbotApiError,
@@ -32,7 +35,7 @@ from .devices.humidifier import SwitchbotHumidifier
 from .devices.light_strip import SwitchbotLightStrip
 from .devices.lock import SwitchbotLock
 from .devices.plug import SwitchbotPlugMini
-from .devices.relay_switch import SwitchbotRelaySwitch
+from .devices.relay_switch import SwitchbotRelaySwitch, SwitchbotRelaySwitch2PM
 from .devices.roller_shade import SwitchbotRollerShade
 from .devices.vacuum import SwitchbotVacuum
 from .discovery import GetSwitchbotDevices
@@ -43,6 +46,9 @@ __all__ = [
     "ColorMode",
     "FanMode",
     "GetSwitchbotDevices",
+    "HumidifierAction",
+    "HumidifierMode",
+    "HumidifierWaterLevel",
     "LockStatus",
     "SwitchBotAdvertisement",
     "Switchbot",
@@ -68,6 +74,7 @@ __all__ = [
     "SwitchbotPlugMini",
     "SwitchbotPlugMini",
     "SwitchbotRelaySwitch",
+    "SwitchbotRelaySwitch2PM",
     "SwitchbotRollerShade",
     "SwitchbotSupportedType",
     "SwitchbotSupportedType",

{pyswitchbot-0.64.1 → pyswitchbot-0.65.0}/switchbot/adv_parser.py

@@ -30,8 +30,9 @@ from .adv_parsers.meter import process_wosensorth, process_wosensorth_c
 from .adv_parsers.motion import process_wopresence
 from .adv_parsers.plug import process_woplugmini
 from .adv_parsers.relay_switch import (
-    process_worelay_switch_1,
-    process_worelay_switch_1pm,
+    process_garage_door_opener,
+    process_relay_switch_2pm,
+    process_relay_switch_common_data,
 )
 from .adv_parsers.remote import process_woremote
 from .adv_parsers.roller_shade import process_worollershade
@@ -115,13 +116,13 @@ SUPPORTED_TYPES: dict[str | bytes, SwitchbotSupportedType] = {
     },
     "4": {
         "modelName": SwitchbotModel.METER_PRO,
-        "modelFriendlyName": "Meter",
+        "modelFriendlyName": "Meter Pro",
         "func": process_wosensorth,
         "manufacturer_id": 2409,
     },
     "5": {
         "modelName": SwitchbotModel.METER_PRO_C,
-        "modelFriendlyName": "Meter",
+        "modelFriendlyName": "Meter Pro CO2",
         "func": process_wosensorth_c,
         "manufacturer_id": 2409,
     },
@@ -207,13 +208,13 @@ SUPPORTED_TYPES: dict[str | bytes, SwitchbotSupportedType] = {
     "<": {
         "modelName": SwitchbotModel.RELAY_SWITCH_1PM,
         "modelFriendlyName": "Relay Switch 1PM",
-        "func": process_worelay_switch_1pm,
+        "func": process_relay_switch_common_data,
         "manufacturer_id": 2409,
     },
     ";": {
         "modelName": SwitchbotModel.RELAY_SWITCH_1,
         "modelFriendlyName": "Relay Switch 1",
-        "func": process_worelay_switch_1,
+        "func": process_relay_switch_common_data,
         "manufacturer_id": 2409,
     },
     "b": {
@@ -312,6 +313,18 @@ SUPPORTED_TYPES: dict[str | bytes, SwitchbotSupportedType] = {
         "func": process_lock2,
         "manufacturer_id": 2409,
     },
+    ">": {
+        "modelName": SwitchbotModel.GARAGE_DOOR_OPENER,
+        "modelFriendlyName": "Garage Door Opener",
+        "func": process_garage_door_opener,
+        "manufacturer_id": 2409,
+    },
+    "=": {
+        "modelName": SwitchbotModel.RELAY_SWITCH_2PM,
+        "modelFriendlyName": "Relay Switch 2PM",
+        "func": process_relay_switch_2pm,
+        "manufacturer_id": 2409,
+    },
 }
 
 _SWITCHBOT_MODEL_TO_CHAR = {

{pyswitchbot-0.64.1 → pyswitchbot-0.65.0}/switchbot/adv_parsers/hub2.py

@@ -5,6 +5,7 @@ from __future__ import annotations
 from typing import Any
 
 from ..const.hub2 import LIGHT_INTENSITY_MAP
+from ..helpers import celsius_to_fahrenheit
 
 
 def process_wohub2(data: bytes | None, mfr_data: bytes | None) -> dict[str, Any]:
@@ -22,7 +23,7 @@ def process_wohub2(data: bytes | None, mfr_data: bytes | None) -> dict[str, Any]
     _temp_c = _temp_sign * (
         (temp_data[1] & 0b01111111) + ((temp_data[0] & 0b00001111) / 10)
     )
-    _temp_f = (_temp_c * 9 / 5) + 32
+    _temp_f = celsius_to_fahrenheit(_temp_c)
     _temp_f = (_temp_f * 10) / 10
     humidity = temp_data[2] & 0b01111111
     light_level = status & 0b11111

{pyswitchbot-0.64.1 → pyswitchbot-0.65.0}/switchbot/adv_parsers/hub3.py

@@ -5,6 +5,7 @@ from __future__ import annotations
 from typing import Any
 
 from ..const.hub3 import LIGHT_INTENSITY_MAP
+from ..helpers import celsius_to_fahrenheit
 
 
 def process_hub3(data: bytes | None, mfr_data: bytes | None) -> dict[str, Any]:
@@ -26,7 +27,7 @@ def process_hub3(data: bytes | None, mfr_data: bytes | None) -> dict[str, Any]:
     _temp_c = _temp_sign * (
         (temp_data[1] & 0b01111111) + ((temp_data[0] & 0b00001111) / 10)
     )
-    _temp_f = round(((_temp_c * 9 / 5) + 32), 1)
+    _temp_f = round(celsius_to_fahrenheit(_temp_c), 1)
     humidity = temp_data[2] & 0b01111111
     motion_detected = bool(device_data[10] & 0b10000000)
 

{pyswitchbot-0.64.1 → pyswitchbot-0.65.0}/switchbot/adv_parsers/hubmini_matter.py

@@ -4,6 +4,8 @@ from __future__ import annotations
 
 from typing import Any
 
+from ..helpers import celsius_to_fahrenheit
+
 
 def process_hubmini_matter(
     data: bytes | None, mfr_data: bytes | None
@@ -21,7 +23,7 @@ def process_hubmini_matter(
     _temp_c = _temp_sign * (
         (temp_data[1] & 0b01111111) + ((temp_data[0] & 0b00001111) / 10)
     )
-    _temp_f = (_temp_c * 9 / 5) + 32
+    _temp_f = celsius_to_fahrenheit(_temp_c)
     _temp_f = (_temp_f * 10) / 10
     humidity = temp_data[2] & 0b01111111
 

pyswitchbot-0.65.0/switchbot/adv_parsers/humidifier.py

@@ -0,0 +1,107 @@
+"""Humidifier adv parser."""
+
+from __future__ import annotations
+
+import logging
+from datetime import timedelta
+
+from ..const.evaporative_humidifier import (
+    HumidifierMode,
+    HumidifierWaterLevel,
+)
+from ..helpers import celsius_to_fahrenheit
+
+_LOGGER = logging.getLogger(__name__)
+
+# mfr_data: 943cc68d3d2e
+# data: 650000cd802b6300
+# data: 650000cd802b6300
+# data: 658000c9802b6300
+
+
+# Low:  658000c5222b6300
+# Med:  658000c5432b6300
+# High: 658000c5642b6300
+
+
+def calculate_temperature_and_humidity(
+    data: bytes, is_meter_binded: bool = True
+) -> tuple[float | None, float | None, int | None]:
+    """Calculate temperature and humidity based on the given flag."""
+    if len(data) < 3 or not is_meter_binded:
+        return None, None, None
+
+    humidity = data[0] & 0b01111111
+    if humidity > 100:
+        return None, None, None
+
+    _temp_sign = 1 if data[1] & 0b10000000 else -1
+    _temp_c = _temp_sign * ((data[1] & 0b01111111) + ((data[2] >> 4) / 10))
+    _temp_f = celsius_to_fahrenheit(_temp_c)
+
+    return _temp_c, _temp_f, humidity
+
+
+def process_wohumidifier(
+    data: bytes | None, mfr_data: bytes | None
+) -> dict[str, bool | int]:
+    """Process WoHumi services data."""
+    if data is None:
+        return {
+            "isOn": None,
+            "level": None,
+            "switchMode": True,
+        }
+
+    return {
+        "isOn": bool(data[1]),
+        "level": data[4],
+        "switchMode": True,
+    }
+
+
+def process_evaporative_humidifier(
+    data: bytes | None, mfr_data: bytes | None
+) -> dict[str, bool | int]:
+    """Process WoHumi services data."""
+    if mfr_data is None:
+        return {}
+
+    seq_number = mfr_data[6]
+    is_on = bool(mfr_data[7] & 0b10000000)
+    mode = HumidifierMode(mfr_data[7] & 0b00001111)
+    over_humidify_protection = bool(mfr_data[8] & 0b10000000)
+    child_lock = bool(mfr_data[8] & 0b00100000)
+    tank_removed = bool(mfr_data[8] & 0b00000100)
+    tilted_alert = bool(mfr_data[8] & 0b00000010)
+    filter_missing = bool(mfr_data[8] & 0b00000001)
+    is_meter_binded = bool(mfr_data[9] & 0b10000000)
+
+    _temp_c, _temp_f, humidity = calculate_temperature_and_humidity(
+        mfr_data[9:12], is_meter_binded
+    )
+
+    water_level = HumidifierWaterLevel(mfr_data[11] & 0b00000011).name.lower()
+    filter_run_time = timedelta(
+        hours=int.from_bytes(mfr_data[12:14], byteorder="big") & 0xFFF
+    )
+    target_humidity = mfr_data[16] & 0b01111111
+
+    return {
+        "seq_number": seq_number,
+        "isOn": is_on,
+        "mode": mode,
+        "over_humidify_protection": over_humidify_protection,
+        "child_lock": child_lock,
+        "tank_removed": tank_removed,
+        "tilted_alert": tilted_alert,
+        "filter_missing": filter_missing,
+        "is_meter_binded": is_meter_binded,
+        "humidity": humidity,
+        "temperature": _temp_c,
+        "temp": {"c": _temp_c, "f": _temp_f},
+        "water_level": water_level,
+        "filter_run_time": filter_run_time,
+        "filter_alert": filter_run_time.days >= 10,
+        "target_humidity": target_humidity,
+    }

{pyswitchbot-0.64.1 → pyswitchbot-0.65.0}/switchbot/adv_parsers/meter.py

@@ -5,6 +5,8 @@ from __future__ import annotations
 import struct
 from typing import Any
 
+from ..helpers import celsius_to_fahrenheit
+
 CO2_UNPACK = struct.Struct(">H").unpack_from
 
 
@@ -28,7 +30,7 @@ def process_wosensorth(data: bytes | None, mfr_data: bytes | None) -> dict[str,
     _temp_c = _temp_sign * (
         (temp_data[1] & 0b01111111) + ((temp_data[0] & 0b00001111) / 10)
     )
-    _temp_f = (_temp_c * 9 / 5) + 32
+    _temp_f = celsius_to_fahrenheit(_temp_c)
     _temp_f = (_temp_f * 10) / 10
     humidity = temp_data[2] & 0b01111111
 

{pyswitchbot-0.64.1 → pyswitchbot-0.65.0}/switchbot/adv_parsers/plug.py

@@ -2,6 +2,8 @@
 
 from __future__ import annotations
 
+from ..helpers import parse_power_data
+
 
 def process_woplugmini(
     data: bytes | None, mfr_data: bytes | None
@@ -13,5 +15,5 @@ def process_woplugmini(
         "switchMode": True,
         "isOn": mfr_data[7] == 0x80,
         "wifi_rssi": -mfr_data[9],
-        "power": (((mfr_data[10] << 8) + mfr_data[11]) & 0x7FFF) / 10,  # W
+        "power": parse_power_data(mfr_data, 10, 10.0, 0x7FFF),  # W
     }

pyswitchbot-0.65.0/switchbot/adv_parsers/relay_switch.py

@@ -0,0 +1,48 @@
+"""Relay Switch adv parser."""
+
+from __future__ import annotations
+
+from typing import Any
+
+
+def process_relay_switch_common_data(
+    data: bytes | None, mfr_data: bytes | None
+) -> dict[str, Any]:
+    """Process relay switch 1 and 1PM common data."""
+    if mfr_data is None:
+        return {}
+    return {
+        "switchMode": True,  # for compatibility, useless
+        "sequence_number": mfr_data[6],
+        "isOn": bool(mfr_data[7] & 0b10000000),
+    }
+
+
+def process_garage_door_opener(
+    data: bytes | None, mfr_data: bytes | None
+) -> dict[str, Any]:
+    """Process garage door opener services data."""
+    if mfr_data is None:
+        return {}
+    common_data = process_relay_switch_common_data(data, mfr_data)
+    common_data["door_open"] = not bool(mfr_data[7] & 0b00100000)
+    return common_data
+
+
+def process_relay_switch_2pm(
+    data: bytes | None, mfr_data: bytes | None
+) -> dict[int, dict[str, Any]]:
+    """Process Relay Switch 2PM services data."""
+    if mfr_data is None:
+        return {}
+
+    return {
+        1: {
+            **process_relay_switch_common_data(data, mfr_data),
+        },
+        2: {
+            "switchMode": True,  # for compatibility, useless
+            "sequence_number": mfr_data[6],
+            "isOn": bool(mfr_data[7] & 0b01000000),
+        },
+    }

{pyswitchbot-0.64.1 → pyswitchbot-0.65.0}/switchbot/const/__init__.py

@@ -4,6 +4,11 @@ from __future__ import annotations
 
 from ..enum import StrEnum
 from .air_purifier import AirPurifierMode
+from .evaporative_humidifier import (
+    HumidifierAction,
+    HumidifierMode,
+    HumidifierWaterLevel,
+)
 from .fan import FanMode
 
 # Preserve old LockStatus export for backwards compatibility
@@ -78,6 +83,8 @@ class SwitchbotModel(StrEnum):
     HUB3 = "Hub3"
     LOCK_ULTRA = "Lock Ultra"
     LOCK_LITE = "Lock Lite"
+    GARAGE_DOOR_OPENER = "Garage Door Opener"
+    RELAY_SWITCH_2PM = "Relay Switch 2PM"
 
 
 __all__ = [
@@ -86,6 +93,9 @@ __all__ = [
     "DEFAULT_SCAN_TIMEOUT",
     "AirPurifierMode",
     "FanMode",
+    "HumidifierAction",
+    "HumidifierMode",
+    "HumidifierWaterLevel",
     "LockStatus",
     "SwitchbotAccountConnectionError",
     "SwitchbotApiError",

{pyswitchbot-0.64.1 → pyswitchbot-0.65.0}/switchbot/const/evaporative_humidifier.py

@@ -13,6 +13,10 @@ class HumidifierMode(Enum):
     AUTO = 7
     DRYING_FILTER = 8
 
+    @classmethod
+    def get_modes(cls) -> list[str]:
+        return [mode.name.lower() for mode in cls]
+
 
 class HumidifierWaterLevel(Enum):
     EMPTY = 0
@@ -20,6 +24,16 @@ class HumidifierWaterLevel(Enum):
     MEDIUM = 2
     HIGH = 3
 
+    @classmethod
+    def get_levels(cls) -> list[str]:
+        return [level.name.lower() for level in cls]
+
+
+class HumidifierAction(Enum):
+    OFF = 0
+    HUMIDIFYING = 1
+    DRYING = 2
+
 
 OVER_HUMIDIFY_PROTECTION_MODES = {
     HumidifierMode.QUIET,

{pyswitchbot-0.64.1 → pyswitchbot-0.65.0}/switchbot/devices/device.py

@@ -116,7 +116,9 @@ def _merge_data(old_data: dict[str, Any], new_data: dict[str, Any]) -> dict[str,
     """Merge data but only add None keys if they are missing."""
     merged = old_data.copy()
     for key, value in new_data.items():
-        if value is not None or key not in old_data:
+        if isinstance(value, dict) and isinstance(old_data.get(key), dict):
+            merged[key] = _merge_data(old_data[key], value)
+        elif value is not None or key not in old_data:
             merged[key] = value
     return merged
 
@@ -538,7 +540,7 @@ class SwitchbotBaseDevice:
         self._override_adv_data.update(state)
         self._update_parsed_data(state)
 
-    def _get_adv_value(self, key: str) -> Any:
+    def _get_adv_value(self, key: str, channel: int | None = None) -> Any:
         """Return value from advertisement data."""
         if self._override_adv_data and key in self._override_adv_data:
             _LOGGER.debug(
@@ -550,6 +552,8 @@ class SwitchbotBaseDevice:
             return self._override_adv_data[key]
         if not self._sb_adv_data:
             return None
+        if channel is not None:
+            return self._sb_adv_data.data["data"].get(channel, {}).get(key)
         return self._sb_adv_data.data["data"].get(key)
 
     def get_battery_percent(self) -> Any:
@@ -583,11 +587,11 @@ class SwitchbotBaseDevice:
 
         return self._sb_adv_data
 
-    async def _get_basic_info(self) -> bytes | None:
+    async def _get_basic_info(
+        self, cmd: str = DEVICE_GET_BASIC_SETTINGS_KEY
+    ) -> bytes | None:
         """Return basic info of device."""
-        _data = await self._send_command(
-            key=DEVICE_GET_BASIC_SETTINGS_KEY, retry=self._retry_count
-        )
+        _data = await self._send_command(key=cmd, retry=self._retry_count)
 
         if _data in (b"\x07", b"\x00"):
             _LOGGER.error("Unsuccessful, please try again")