Add support Relay Switch 1 and Relay Switch 1PM (#263)

Co-authored-by: J. Nick Koston <[email protected]>

Author: greyeee

switchbot/__init__.py

@@ -26,6 +26,7 @@
 from .devices.light_strip import SwitchbotLightStrip
 from .devices.lock import SwitchbotLock
 from .devices.plug import SwitchbotPlugMini
+from .devices.relay_switch import SwitchbotRelaySwitch
 from .discovery import GetSwitchbotDevices
 from .models import SwitchBotAdvertisement
 
@@ -54,4 +55,5 @@
     "SwitchbotModel",
     "SwitchbotLock",
     "SwitchbotBlindTilt",
+    "SwitchbotRelaySwitch",
 ]

switchbot/adv_parser.py

@@ -23,6 +23,10 @@
 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_1plus,
+    process_worelay_switch_1pm,
+)
 from .const import SwitchbotModel
 from .models import SwitchBotAdvertisement
 
@@ -173,6 +177,18 @@ class SwitchbotSupportedType(TypedDict):
         "func": process_woblindtilt,
         "manufacturer_id": 2409,
     },
+    "<": {
+        "modelName": SwitchbotModel.RelaySwitch1PM,
+        "modelFriendlyName": "Relay Switch 1PM",
+        "func": process_worelay_switch_1pm,
+        "manufacturer_id": 2409,
+    },
+    ";": {
+        "modelName": SwitchbotModel.RelaySwitch1Plus,
+        "modelFriendlyName": "Relay Switch 1",
+        "func": process_worelay_switch_1plus,
+        "manufacturer_id": 2409,
+    },
 }
 
 _SWITCHBOT_MODEL_TO_CHAR = {

switchbot/adv_parsers/relay_switch.py

@@ -0,0 +1,31 @@
+"""Relay Switch adv parser."""
+from __future__ import annotations
+
+
+def process_worelay_switch_1pm(
+    data: bytes | None, mfr_data: bytes | None
+) -> dict[str, bool | int]:
+    """Process WoStrip services data."""
+    if mfr_data is None:
+        return {}
+    return {
+        "switchMode": True,  # for compatibility, useless
+        "sequence_number": mfr_data[6],
+        "isOn": bool(mfr_data[7] & 0b10000000),
+        "power": ((mfr_data[10] << 8) + mfr_data[11]) / 10,
+        "voltage": 0,
+        "current": 0,
+    }
+
+
+def process_worelay_switch_1plus(
+    data: bytes | None, mfr_data: bytes | None
+) -> dict[str, bool | int]:
+    """Process WoStrip services data."""
+    if mfr_data is None:
+        return {}
+    return {
+        "switchMode": True,  # for compatibility, useless
+        "sequence_number": mfr_data[6],
+        "isOn": bool(mfr_data[7] & 0b10000000),
+    }

switchbot/const.py

@@ -52,6 +52,8 @@ class SwitchbotModel(StrEnum):
     LOCK_PRO = "WoLockPro"
     BLIND_TILT = "WoBlindTilt"
     HUB2 = "WoHub2"
+    RelaySwitch1PM = "Relay Switch 1PM"
+    RelaySwitch1Plus = "Relay Switch 1"
 
 
 class LockStatus(Enum):

switchbot/devices/relay_switch.py

@@ -0,0 +1,155 @@
+import time
+from typing import Any
+
+from bleak.backends.device import BLEDevice
+from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
+
+from ..const import SwitchbotModel
+from .device import SwitchbotSequenceDevice
+
+COMMAND_HEADER = "57"
+COMMAND_GET_CK_IV = f"{COMMAND_HEADER}0f2103"
+COMMAND_TURN_OFF = f"{COMMAND_HEADER}0f70010000"
+COMMAND_TURN_ON = f"{COMMAND_HEADER}0f70010100"
+COMMAND_TOGGLE = f"{COMMAND_HEADER}0f70010200"
+COMMAND_GET_VOLTAGE_AND_CURRENT = f"{COMMAND_HEADER}0f7106000000"
+PASSIVE_POLL_INTERVAL = 1 * 60
+
+
+class SwitchbotRelaySwitch(SwitchbotSequenceDevice):
+    """Representation of a Switchbot relay switch 1pm."""
+
+    def __init__(
+        self,
+        device: BLEDevice,
+        key_id: str,
+        encryption_key: str,
+        interface: int = 0,
+        model: SwitchbotModel = SwitchbotModel.RelaySwitch1PM,
+        **kwargs: Any,
+    ) -> None:
+        if len(key_id) == 0:
+            raise ValueError("key_id is missing")
+        elif len(key_id) != 2:
+            raise ValueError("key_id is invalid")
+        if len(encryption_key) == 0:
+            raise ValueError("encryption_key is missing")
+        elif len(encryption_key) != 32:
+            raise ValueError("encryption_key is invalid")
+        self._iv = None
+        self._cipher = None
+        self._key_id = key_id
+        self._encryption_key = bytearray.fromhex(encryption_key)
+        self._model: SwitchbotModel = model
+        super().__init__(device, None, interface, **kwargs)
+
+    async def update(self, interface: int | None = None) -> None:
+        """Update state of device."""
+        if info := await self.get_voltage_and_current():
+            self._last_full_update = time.monotonic()
+            self._update_parsed_data(info)
+            self._fire_callbacks()
+
+    async def get_voltage_and_current(self) -> dict[str, Any] | None:
+        """Get voltage and current because advtisement don't have these"""
+        result = await self._send_command(COMMAND_GET_VOLTAGE_AND_CURRENT)
+        ok = self._check_command_result(result, 0, {1})
+        if ok:
+            return {
+                "voltage": (result[9] << 8) + result[10],
+                "current": (result[11] << 8) + result[12],
+            }
+        return None
+
+    def poll_needed(self, seconds_since_last_poll: float | None) -> bool:
+        """Return if device needs polling."""
+        if (
+            seconds_since_last_poll is not None
+            and seconds_since_last_poll < PASSIVE_POLL_INTERVAL
+        ):
+            return False
+        time_since_last_full_update = time.monotonic() - self._last_full_update
+        if time_since_last_full_update < PASSIVE_POLL_INTERVAL:
+            return False
+        return True
+
+    async def turn_on(self) -> bool:
+        """Turn device on."""
+        result = await self._send_command(COMMAND_TURN_ON)
+        ok = self._check_command_result(result, 0, {1})
+        if ok:
+            self._override_state({"isOn": True})
+            self._fire_callbacks()
+        return ok
+
+    async def turn_off(self) -> bool:
+        """Turn device off."""
+        result = await self._send_command(COMMAND_TURN_OFF)
+        ok = self._check_command_result(result, 0, {1})
+        if ok:
+            self._override_state({"isOn": False})
+            self._fire_callbacks()
+        return ok
+
+    async def async_toggle(self, **kwargs) -> bool:
+        """Toggle device."""
+        result = await self._send_command(COMMAND_TOGGLE)
+        status = self._check_command_result(result, 0, {1})
+        return status
+
+    def is_on(self) -> bool | None:
+        """Return switch state from cache."""
+        return self._get_adv_value("isOn")
+
+    async def _send_command(
+        self, key: str, retry: int | None = None, encrypt: bool = True
+    ) -> bytes | None:
+        if not encrypt:
+            return await super()._send_command(key[:2] + "000000" + key[2:], retry)
+
+        result = await self._ensure_encryption_initialized()
+        if not result:
+            return None
+
+        encrypted = (
+            key[:2] + self._key_id + self._iv[0:2].hex() + self._encrypt(key[2:])
+        )
+        result = await super()._send_command(encrypted, retry)
+        return result[:1] + self._decrypt(result[4:])
+
+    async def _ensure_encryption_initialized(self) -> bool:
+        if self._iv is not None:
+            return True
+
+        result = await self._send_command(
+            COMMAND_GET_CK_IV + self._key_id, encrypt=False
+        )
+        ok = self._check_command_result(result, 0, {1})
+        if ok:
+            self._iv = result[4:]
+
+        return ok
+
+    async def _execute_disconnect(self) -> None:
+        await super()._execute_disconnect()
+        self._iv = None
+        self._cipher = None
+
+    def _get_cipher(self) -> Cipher:
+        if self._cipher is None:
+            self._cipher = Cipher(
+                algorithms.AES128(self._encryption_key), modes.CTR(self._iv)
+            )
+        return self._cipher
+
+    def _encrypt(self, data: str) -> str:
+        if len(data) == 0:
+            return ""
+        encryptor = self._get_cipher().encryptor()
+        return (encryptor.update(bytearray.fromhex(data)) + encryptor.finalize()).hex()
+
+    def _decrypt(self, data: bytearray) -> bytes:
+        if len(data) == 0:
+            return b""
+        decryptor = self._get_cipher().decryptor()
+        return decryptor.update(data) + decryptor.finalize()