PySwitchbot 0.62.2__tar.gz → 0.64.0__tar.gz

{pyswitchbot-0.62.2 → pyswitchbot-0.64.0}/PKG-INFO

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

{pyswitchbot-0.62.2 → pyswitchbot-0.64.0}/PySwitchbot.egg-info/PKG-INFO

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

{pyswitchbot-0.62.2 → pyswitchbot-0.64.0}/PySwitchbot.egg-info/SOURCES.txt

@@ -25,6 +25,7 @@ switchbot/adv_parsers/contact.py
 switchbot/adv_parsers/curtain.py
 switchbot/adv_parsers/fan.py
 switchbot/adv_parsers/hub2.py
+switchbot/adv_parsers/hub3.py
 switchbot/adv_parsers/hubmini_matter.py
 switchbot/adv_parsers/humidifier.py
 switchbot/adv_parsers/keypad.py
@@ -43,6 +44,7 @@ switchbot/const/air_purifier.py
 switchbot/const/evaporative_humidifier.py
 switchbot/const/fan.py
 switchbot/const/hub2.py
+switchbot/const/hub3.py
 switchbot/const/lock.py
 switchbot/devices/__init__.py
 switchbot/devices/air_purifier.py
@@ -75,6 +77,8 @@ tests/test_curtain.py
 tests/test_evaporative_humidifier.py
 tests/test_fan.py
 tests/test_hub2.py
+tests/test_hub3.py
+tests/test_lock.py
 tests/test_relay_switch.py
 tests/test_roller_shade.py
 tests/test_vacuum.py

{pyswitchbot-0.62.2 → pyswitchbot-0.64.0}/setup.py

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

{pyswitchbot-0.62.2 → pyswitchbot-0.64.0}/switchbot/adv_parser.py

@@ -19,12 +19,13 @@ from .adv_parsers.contact import process_wocontact
 from .adv_parsers.curtain import process_wocurtain
 from .adv_parsers.fan import process_fan
 from .adv_parsers.hub2 import process_wohub2
+from .adv_parsers.hub3 import process_hub3
 from .adv_parsers.hubmini_matter import process_hubmini_matter
 from .adv_parsers.humidifier import process_evaporative_humidifier, process_wohumidifier
 from .adv_parsers.keypad import process_wokeypad
 from .adv_parsers.leak import process_leak
 from .adv_parsers.light_strip import process_wostrip
-from .adv_parsers.lock import process_wolock, process_wolock_pro
+from .adv_parsers.lock import process_lock2, process_wolock, process_wolock_pro
 from .adv_parsers.meter import process_wosensorth, process_wosensorth_c
 from .adv_parsers.motion import process_wopresence
 from .adv_parsers.plug import process_woplugmini
@@ -57,7 +58,7 @@ class SwitchbotSupportedType(TypedDict):
     manufacturer_data_length: int | None
 
 
-SUPPORTED_TYPES: dict[str, SwitchbotSupportedType] = {
+SUPPORTED_TYPES: dict[str | bytes, SwitchbotSupportedType] = {
     "d": {
         "modelName": SwitchbotModel.CONTACT_SENSOR,
         "modelFriendlyName": "Contact Sensor",
@@ -293,6 +294,24 @@ SUPPORTED_TYPES: dict[str, SwitchbotSupportedType] = {
         "func": process_air_purifier,
         "manufacturer_id": 2409,
     },
+    b"\x00\x10\xb9\x40": {
+        "modelName": SwitchbotModel.HUB3,
+        "modelFriendlyName": "Hub3",
+        "func": process_hub3,
+        "manufacturer_id": 2409,
+    },
+    "-": {
+        "modelName": SwitchbotModel.LOCK_LITE,
+        "modelFriendlyName": "Lock Lite",
+        "func": process_wolock,
+        "manufacturer_id": 2409,
+    },
+    b"\x00\x10\xa5\xb8": {
+        "modelName": SwitchbotModel.LOCK_ULTRA,
+        "modelFriendlyName": "Lock Ultra",
+        "func": process_lock2,
+        "manufacturer_id": 2409,
+    },
 }
 
 _SWITCHBOT_MODEL_TO_CHAR = {
@@ -371,6 +390,12 @@ def _parse_data(
             if model_data.get("manufacturer_data_length") == len(_mfr_data):
                 _model = model_chr
                 break
+    if (
+        _service_data
+        and len(_service_data) > 5
+        and _service_data[-4:] in SUPPORTED_TYPES
+    ):
+        _model = _service_data[-4:]
 
     if not _model:
         return None

pyswitchbot-0.64.0/switchbot/adv_parsers/hub3.py

@@ -0,0 +1,56 @@
+"""Hub3 adv parser."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from ..const.hub3 import LIGHT_INTENSITY_MAP
+
+
+def process_hub3(data: bytes | None, mfr_data: bytes | None) -> dict[str, Any]:
+    """Process hub3 sensor manufacturer data."""
+    if mfr_data is None:
+        return {}
+    device_data = mfr_data[6:]
+
+    seq_num = device_data[0]
+    network_state = (device_data[6] & 0b11000000) >> 6
+    sensor_inserted = not bool(device_data[6] & 0b00100000)
+    light_level = device_data[6] & 0b00001111
+    illuminance = calculate_light_intensity(light_level)
+    temperature_alarm = bool(device_data[7] & 0b11000000)
+    humidity_alarm = bool(device_data[7] & 0b00110000)
+
+    temp_data = device_data[7:10]
+    _temp_sign = 1 if temp_data[1] & 0b10000000 else -1
+    _temp_c = _temp_sign * (
+        (temp_data[1] & 0b01111111) + ((temp_data[0] & 0b00001111) / 10)
+    )
+    _temp_f = round(((_temp_c * 9 / 5) + 32), 1)
+    humidity = temp_data[2] & 0b01111111
+    motion_detected = bool(device_data[10] & 0b10000000)
+
+    return {
+        "sequence_number": seq_num,
+        "network_state": network_state,
+        "sensor_inserted": sensor_inserted,
+        "lightLevel": light_level,
+        "illuminance": illuminance,
+        "temperature_alarm": temperature_alarm,
+        "humidity_alarm": humidity_alarm,
+        "temp": {"c": _temp_c, "f": _temp_f},
+        "temperature": _temp_c,
+        "humidity": humidity,
+        "motion_detected": motion_detected,
+    }
+
+
+def calculate_light_intensity(light_level: int) -> int:
+    """
+    Convert Hub 3 light level (1-10) to actual light intensity value
+    Args:
+        light_level: Integer from 1-10
+    Returns:
+        Corresponding light intensity value or 0 if invalid input
+    """
+    return LIGHT_INTENSITY_MAP.get(max(0, min(light_level, 10)), 0)

pyswitchbot-0.64.0/switchbot/adv_parsers/lock.py

@@ -0,0 +1,85 @@
+"""Lock parser."""
+
+from __future__ import annotations
+
+import logging
+
+from ..const.lock import LockStatus
+
+_LOGGER = logging.getLogger(__name__)
+
+
+def process_wolock(data: bytes | None, mfr_data: bytes | None) -> dict[str, bool | int]:
+    """Support for lock and lock lite process data."""
+    if mfr_data is None:
+        return {}
+
+    _LOGGER.debug("mfr_data: %s", mfr_data.hex())
+    if data:
+        _LOGGER.debug("data: %s", data.hex())
+
+    return {
+        "sequence_number": mfr_data[6],
+        "battery": data[2] & 0b01111111 if data else None,
+        "calibration": bool(mfr_data[7] & 0b10000000),
+        "status": LockStatus((mfr_data[7] & 0b01110000) >> 4),
+        "update_from_secondary_lock": bool(mfr_data[7] & 0b00001000),
+        "door_open": bool(mfr_data[7] & 0b00000100),
+        "double_lock_mode": bool(mfr_data[8] & 0b10000000),
+        "unclosed_alarm": bool(mfr_data[8] & 0b00100000),
+        "unlocked_alarm": bool(mfr_data[8] & 0b00010000),
+        "auto_lock_paused": bool(mfr_data[8] & 0b00000010),
+        "night_latch": bool(mfr_data[9] & 0b00000001) if len(mfr_data) > 9 else False,
+    }
+
+
+def parse_common_data(mfr_data: bytes | None) -> dict[str, bool | int]:
+    if mfr_data is None:
+        return {}
+
+    return {
+        "sequence_number": mfr_data[6],
+        "calibration": bool(mfr_data[7] & 0b10000000),
+        "status": LockStatus((mfr_data[7] & 0b01111000) >> 4),
+        "update_from_secondary_lock": bool(mfr_data[8] & 0b11000000),
+        "door_open_from_secondary_lock": bool(mfr_data[8] & 0b00100000),
+        "door_open": bool(mfr_data[8] & 0b00010000),
+        "auto_lock_paused": bool(mfr_data[8] & 0b00001000),
+        "battery": mfr_data[9] & 0b01111111,
+        "double_lock_mode": bool(mfr_data[10] & 0b10000000),
+        "is_secondary_lock": bool(mfr_data[10] & 0b01000000),
+        "manual_unlock_linkage": bool(mfr_data[10] & 0b00100000),
+        "unclosed_alarm": bool(mfr_data[11] & 0b10000000),
+        "unlocked_alarm": bool(mfr_data[11] & 0b01000000),
+        "night_latch": False,
+    }
+
+
+def process_wolock_pro(
+    data: bytes | None, mfr_data: bytes | None
+) -> dict[str, bool | int]:
+    """Support for lock pro process data."""
+    common_data = parse_common_data(mfr_data)
+    if not common_data:
+        return {}
+
+    lock_pro_data = {
+        "low_temperature_alarm": bool(mfr_data[11] & 0b00100000),
+        "left_battery_compartment_alarm": mfr_data[11] & 0b000000100,
+        "right_battery_compartment_alarm": mfr_data[11] & 0b000000010,
+    }
+    return common_data | lock_pro_data
+
+
+def process_lock2(data: bytes | None, mfr_data: bytes | None) -> dict[str, bool | int]:
+    """Support for lock2 process data."""
+    common_data = parse_common_data(mfr_data)
+    if not common_data:
+        return {}
+
+    lock2_data = {
+        "power_alarm": bool(mfr_data[11] & 0b00010000),
+        "battery_status": mfr_data[11] & 0b00000111,
+    }
+
+    return common_data | lock2_data

{pyswitchbot-0.62.2 → pyswitchbot-0.64.0}/switchbot/const/__init__.py

@@ -75,6 +75,9 @@ class SwitchbotModel(StrEnum):
     K10_PRO_COMBO_VACUUM = "K10+ Pro Combo Vacuum"
     AIR_PURIFIER = "Air Purifier"
     AIR_PURIFIER_TABLE = "Air Purifier Table"
+    HUB3 = "Hub3"
+    LOCK_ULTRA = "Lock Ultra"
+    LOCK_LITE = "Lock Lite"
 
 
 __all__ = [

pyswitchbot-0.64.0/switchbot/const/hub3.py

@@ -0,0 +1,18 @@
+"""
+Mapping of light levels to lux measurement values for SwitchBot Hub 3.
+
+Source: After-sales consultation, line chart data provided by switchbot developers
+"""
+
+LIGHT_INTENSITY_MAP = {
+    1: 0,
+    2: 50,
+    3: 90,
+    4: 205,
+    5: 317,
+    6: 510,
+    7: 610,
+    8: 707,
+    9: 801,
+    10: 1023,
+}

{pyswitchbot-0.62.2 → pyswitchbot-0.64.0}/switchbot/const/lock.py

@@ -11,3 +11,4 @@ class LockStatus(Enum):
     LOCKING_STOP = 4  # LOCKING_BLOCKED
     UNLOCKING_STOP = 5  # UNLOCKING_BLOCKED
     NOT_FULLY_LOCKED = 6  # LATCH_LOCKED - Only EU lock type
+    HALF_LOCKED = 7  # Only Lock2 EU lock type

{pyswitchbot-0.62.2 → pyswitchbot-0.64.0}/switchbot/devices/lock.py

@@ -10,24 +10,32 @@ from bleak.backends.device import BLEDevice
 
 from ..const import SwitchbotModel
 from ..const.lock import LockStatus
-from .device import SwitchbotEncryptedDevice
+from .device import SwitchbotEncryptedDevice, SwitchbotSequenceDevice
 
 COMMAND_HEADER = "57"
 COMMAND_LOCK_INFO = {
     SwitchbotModel.LOCK: f"{COMMAND_HEADER}0f4f8101",
+    SwitchbotModel.LOCK_LITE: f"{COMMAND_HEADER}0f4f8101",
     SwitchbotModel.LOCK_PRO: f"{COMMAND_HEADER}0f4f8102",
+    SwitchbotModel.LOCK_ULTRA: f"{COMMAND_HEADER}0f4f8102",
 }
 COMMAND_UNLOCK = {
     SwitchbotModel.LOCK: f"{COMMAND_HEADER}0f4e01011080",
+    SwitchbotModel.LOCK_LITE: f"{COMMAND_HEADER}0f4e01011080",
     SwitchbotModel.LOCK_PRO: f"{COMMAND_HEADER}0f4e0101000080",
+    SwitchbotModel.LOCK_ULTRA: f"{COMMAND_HEADER}0f4e0101000080",
 }
 COMMAND_UNLOCK_WITHOUT_UNLATCH = {
     SwitchbotModel.LOCK: f"{COMMAND_HEADER}0f4e010110a0",
+    SwitchbotModel.LOCK_LITE: f"{COMMAND_HEADER}0f4e010110a0",
     SwitchbotModel.LOCK_PRO: f"{COMMAND_HEADER}0f4e01010000a0",
+    SwitchbotModel.LOCK_ULTRA: f"{COMMAND_HEADER}0f4e01010000a0",
 }
 COMMAND_LOCK = {
     SwitchbotModel.LOCK: f"{COMMAND_HEADER}0f4e01011000",
+    SwitchbotModel.LOCK_LITE: f"{COMMAND_HEADER}0f4e01011000",
     SwitchbotModel.LOCK_PRO: f"{COMMAND_HEADER}0f4e0101000000",
+    SwitchbotModel.LOCK_ULTRA: f"{COMMAND_HEADER}0f4e0101000000",
 }
 COMMAND_ENABLE_NOTIFICATIONS = f"{COMMAND_HEADER}0e01001e00008101"
 COMMAND_DISABLE_NOTIFICATIONS = f"{COMMAND_HEADER}0e00"
@@ -44,7 +52,7 @@ COMMAND_RESULT_EXPECTED_VALUES = {1, 6}
 # The return value of the command is 6 when the command is successful but the battery is low.
 
 
-class SwitchbotLock(SwitchbotEncryptedDevice):
+class SwitchbotLock(SwitchbotSequenceDevice, SwitchbotEncryptedDevice):
     """Representation of a Switchbot Lock."""
 
     def __init__(
@@ -56,7 +64,12 @@ class SwitchbotLock(SwitchbotEncryptedDevice):
         model: SwitchbotModel = SwitchbotModel.LOCK,
         **kwargs: Any,
     ) -> None:
-        if model not in (SwitchbotModel.LOCK, SwitchbotModel.LOCK_PRO):
+        if model not in (
+            SwitchbotModel.LOCK,
+            SwitchbotModel.LOCK_PRO,
+            SwitchbotModel.LOCK_LITE,
+            SwitchbotModel.LOCK_ULTRA,
+        ):
             raise ValueError("initializing SwitchbotLock with a non-lock model")
         self._notifications_enabled: bool = False
         super().__init__(device, key_id, encryption_key, model, interface, **kwargs)