add Leak Detector (#262)

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

Author: 3 people

switchbot/adv_parser.py

@@ -19,6 +19,7 @@
 from .adv_parsers.hub2 import process_wohub2
 from .adv_parsers.humidifier import 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.meter import process_wosensorth, process_wosensorth_c
@@ -178,6 +179,12 @@ class SwitchbotSupportedType(TypedDict):
         "func": process_woblindtilt,
         "manufacturer_id": 2409,
     },
+    "3": {
+        "modelName": SwitchbotModel.LEAK,
+        "modelFriendlyName": "Leak Detector",
+        "func": process_leak,
+        "manufacturer_id": 2409,
+    },
     "y": {
         "modelName": SwitchbotModel.KEYPAD,
         "modelFriendlyName": "Keypad",

switchbot/adv_parsers/leak.py

@@ -0,0 +1,29 @@
+"""Leak detector adv parser."""
+
+
+def process_leak(data: bytes | None, mfr_data: bytes | None) -> dict[str, bool | int]:
+    """Process SwitchBot Water Leak Detector advertisement data."""
+    if data is None or len(data) < 3 or mfr_data is None or len(mfr_data) < 2:
+        return {}
+
+    water_leak_detected = None
+    device_tampered = None
+    battery_level = None
+    low_battery = None
+
+    # Byte 1: Event Flags
+    event_flags = mfr_data[8]
+    water_leak_detected = bool(event_flags & 0b00000001)  # Bit 0
+    device_tampered = bool(event_flags & 0b00000010)  # Bit 1
+
+    # Byte 2: Battery Info
+    battery_info = mfr_data[7]
+    battery_level = battery_info & 0b01111111  # Bits 0-6
+    low_battery = bool(battery_info & 0b10000000)  # Bit 7
+
+    return {
+        "leak": water_leak_detected,
+        "tampered": device_tampered,
+        "battery": battery_level,
+        "low_battery": low_battery,
+    }

switchbot/const.py

@@ -53,6 +53,7 @@ class SwitchbotModel(StrEnum):
     LOCK_PRO = "WoLockPro"
     BLIND_TILT = "WoBlindTilt"
     HUB2 = "WoHub2"
+    LEAK = "Leak Detector"
     KEYPAD = "WoKeypad"
     RELAY_SWITCH_1PM = "Relay Switch 1PM"
     RELAY_SWITCH_1 = "Relay Switch 1"

tests/test_adv_parser.py

@@ -1737,3 +1737,151 @@ def test_parse_advertisement_data_relay_switch_1():
         rssi=-67,
         active=True,
     )
+
+
+def test_leak_active():
+    """Test parse_advertisement_data for the leak detector."""
+    ble_device = generate_ble_device("aa:bb:cc:dd:ee:ff", "any")
+    adv_data = generate_advertisement_data(
+        manufacturer_data={2409: b"\xc4407Lz\x18N\x98g^\x94Q<\x05\x00\x00\x00\x00"},
+        service_data={"0000fd3d-0000-1000-8000-00805f9b34fb": b"&\x00N"},
+        rssi=-72,
+    )
+    result = parse_advertisement_data(ble_device, adv_data, SwitchbotModel.LEAK)
+    assert result == SwitchBotAdvertisement(
+        address="aa:bb:cc:dd:ee:ff",
+        data={
+            "data": {
+                "leak": False,
+                "tampered": False,
+                "battery": 78,
+                "low_battery": False,
+            },
+            "isEncrypted": False,
+            "model": "3",
+            "modelFriendlyName": "Leak Detector",
+            "modelName": SwitchbotModel.LEAK,
+            "rawAdvData": b"&\x00N",
+        },
+        device=ble_device,
+        rssi=-72,
+        active=True,
+    )
+
+
+def test_leak_passive():
+    """Test parse_advertisement_data for the leak detector."""
+    ble_device = generate_ble_device("aa:bb:cc:dd:ee:ff", "any")
+    adv_data = generate_advertisement_data(
+        manufacturer_data={2409: b"\xc4407Lz\x18N\x98g^\x94Q<\x05\x00\x00\x00\x00"},
+        rssi=-72,
+    )
+    result = parse_advertisement_data(ble_device, adv_data, SwitchbotModel.LEAK)
+    assert result == SwitchBotAdvertisement(
+        address="aa:bb:cc:dd:ee:ff",
+        data={
+            "data": {},
+            "isEncrypted": False,
+            "model": "3",
+            "rawAdvData": None,
+        },
+        device=ble_device,
+        rssi=-72,
+        active=False,
+    )
+
+
+def test_leak_no_leak_detected():
+    """Test parse_advertisement_data for the leak detector."""
+    ble_device = generate_ble_device("aa:bb:cc:dd:ee:ff", "Any")
+    adv_data = generate_advertisement_data(
+        manufacturer_data={
+            2409: b"\xc4407LzJd\x98ga\xc4\n<\x05\x00\x00\x00\x00"
+        },  # no leak, batt
+        service_data={"0000fd3d-0000-1000-8000-00805f9b34fb": b"&\x00d"},
+        rssi=-73,
+    )
+    result = parse_advertisement_data(ble_device, adv_data, SwitchbotModel.LEAK)
+    assert result == SwitchBotAdvertisement(
+        address="aa:bb:cc:dd:ee:ff",
+        data={
+            "data": {
+                "leak": False,
+                "tampered": False,
+                "battery": 100,
+                "low_battery": False,
+            },
+            "isEncrypted": False,
+            "model": "3",
+            "modelFriendlyName": "Leak Detector",
+            "modelName": SwitchbotModel.LEAK,
+            "rawAdvData": b"&\x00d",
+        },
+        device=ble_device,
+        rssi=-73,
+        active=True,
+    )
+
+
+def test_leak_leak_detected():
+    """Test parse_advertisement_data for the leak detector."""
+    ble_device = generate_ble_device("aa:bb:cc:dd:ee:ff", "Any")
+    adv_data = generate_advertisement_data(
+        manufacturer_data={
+            2409: b"\xc4407LzGd\xf9ga\xc4\x08<\x05\x00\x00\x00\x00"
+        },  # leak, batt
+        service_data={"0000fd3d-0000-1000-8000-00805f9b34fb": b"&\x00d"},
+        rssi=-73,
+    )
+    result = parse_advertisement_data(ble_device, adv_data, SwitchbotModel.LEAK)
+    assert result == SwitchBotAdvertisement(
+        address="aa:bb:cc:dd:ee:ff",
+        data={
+            "data": {
+                "leak": True,
+                "tampered": False,
+                "battery": 100,
+                "low_battery": False,
+            },
+            "isEncrypted": False,
+            "model": "3",
+            "modelFriendlyName": "Leak Detector",
+            "modelName": SwitchbotModel.LEAK,
+            "rawAdvData": b"&\x00d",
+        },
+        device=ble_device,
+        rssi=-73,
+        active=True,
+    )
+
+
+def test_leak_low_battery():
+    """Test parse_advertisement_data for the leak detector."""
+    ble_device = generate_ble_device("aa:bb:cc:dd:ee:ff", "Any")
+    adv_data = generate_advertisement_data(
+        manufacturer_data={
+            2409: b"\xc4407Lz\x02\t\x98\x00\x00\x00\x00<\x05\x00\x00\x00\x00"
+        },  # no leak, low battery
+        service_data={"0000fd3d-0000-1000-8000-00805f9b34fb": b"&\x00d"},
+        rssi=-73,
+    )
+    result = parse_advertisement_data(ble_device, adv_data, SwitchbotModel.LEAK)
+    assert result == SwitchBotAdvertisement(
+        address="aa:bb:cc:dd:ee:ff",
+        data={
+            "data": {
+                "leak": False,
+                "tampered": False,
+                "battery": 9,
+                "low_battery": False,
+            },
+            "isEncrypted": False,
+            "model": "3",
+            "modelFriendlyName": "Leak Detector",
+            "modelName": SwitchbotModel.LEAK,
+            "rawAdvData": b"&\x00d",
+        },
+        device=ble_device,
+        rssi=-73,
+        active=True,
+    )