Add lock series products (#340)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: zerzhang

switchbot/adv_parser.py

@@ -25,7 +25,7 @@
 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
@@ -300,6 +300,18 @@ class SwitchbotSupportedType(TypedDict):
         "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 = {

switchbot/adv_parsers/hub3.py

@@ -1,4 +1,4 @@
-"""Air Purifier adv parser."""
+"""Hub3 adv parser."""
 
 from __future__ import annotations
 

switchbot/adv_parsers/lock.py

@@ -10,7 +10,7 @@
 
 
 def process_wolock(data: bytes | None, mfr_data: bytes | None) -> dict[str, bool | int]:
-    """Process woLock services data."""
+    """Support for lock and lock lite process data."""
     if mfr_data is None:
         return {}
 
@@ -19,6 +19,7 @@ def process_wolock(data: bytes | None, mfr_data: bytes | None) -> dict[str, bool
         _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),
@@ -32,26 +33,53 @@ def process_wolock(data: bytes | None, mfr_data: bytes | None) -> dict[str, bool
     }
 
 
-def process_wolock_pro(
-    data: bytes | None, mfr_data: bytes | None
-) -> dict[str, bool | int]:
-    _LOGGER.debug("mfr_data: %s", mfr_data.hex())
-    if data:
-        _LOGGER.debug("data: %s", data.hex())
+def parse_common_data(mfr_data: bytes | None) -> dict[str, bool | int]:
+    if mfr_data is None:
+        return {}
 
-    res = {
-        "battery": data[2] & 0b01111111 if data else None,
+    return {
+        "sequence_number": mfr_data[6],
         "calibration": bool(mfr_data[7] & 0b10000000),
-        "status": LockStatus((mfr_data[7] & 0b00111000) >> 3),
-        "door_open": bool(mfr_data[8] & 0b01100000),
-        # Double lock mode is not supported on Lock Pro
-        "update_from_secondary_lock": False,
-        "double_lock_mode": False,
+        "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),
-        "auto_lock_paused": bool(mfr_data[8] & 0b100000),
-        # Looks like night latch bit is not anymore in ADV
         "night_latch": False,
     }
-    _LOGGER.debug(res)
-    return res
+
+
+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

switchbot/const/__init__.py

@@ -76,6 +76,8 @@ class SwitchbotModel(StrEnum):
     AIR_PURIFIER = "Air Purifier"
     AIR_PURIFIER_TABLE = "Air Purifier Table"
     HUB3 = "Hub3"
+    LOCK_ULTRA = "Lock Ultra"
+    LOCK_LITE = "Lock Lite"
 
 
 __all__ = [

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

switchbot/devices/lock.py

@@ -10,24 +10,32 @@
 
 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 @@
 # 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 @@ def __init__(
         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)

tests/__init__.py

@@ -4,10 +4,10 @@
 
 
 @dataclass
-class AirPurifierTestCase:
-    manufacturer_data: bytes
+class AdvTestCase:
+    manufacturer_data: bytes | None
     service_data: bytes
     data: dict
-    model: str
+    model: str | bytes
     modelFriendlyName: str
     modelName: SwitchbotModel