pySwitchbot/switchbot/__init__.py

"""Library to handle connection with Switchbot."""
from __future__ import annotations

import binascii
import logging
from threading import Lock
import time
from typing import Any

import bluepy

DEFAULT_RETRY_COUNT = 3
DEFAULT_RETRY_TIMEOUT = 1
DEFAULT_SCAN_TIMEOUT = 5

# Keys common to all device types
DEVICE_GET_BASIC_SETTINGS_KEY = "5702"
DEVICE_SET_MODE_KEY = "5703"
DEVICE_SET_EXTENDED_KEY = "570f"

# Bot keys
PRESS_KEY = "570100"
ON_KEY = "570101"
OFF_KEY = "570102"
DOWN_KEY = "570103"
UP_KEY = "570104"

# Curtain keys
OPEN_KEY = "570f450105ff00"  # 570F4501010100
CLOSE_KEY = "570f450105ff64"  # 570F4501010164
POSITION_KEY = "570F450105ff"  # +actual_position ex: 570F450105ff32 for 50%
STOP_KEY = "570F450100ff"
CURTAIN_EXT_SUM_KEY = "570f460401"
CURTAIN_EXT_ADV_KEY = "570f460402"
CURTAIN_EXT_CHAIN_INFO_KEY = "570f468101"

# Base key when encryption is set
KEY_PASSWORD_PREFIX = "571"

_LOGGER = logging.getLogger(__name__)
CONNECT_LOCK = Lock()


def _sb_uuid(comms_type: str = "service") -> bluepy.btle.UUID:
    """Return Switchbot UUID."""

    _uuid = {"tx": "002", "rx": "003", "service": "d00"}

    if comms_type in _uuid:
        return bluepy.btle.UUID(f"cba20{_uuid[comms_type]}-224d-11e6-9fb8-0002a5d5c51b")

    return "Incorrect type, choose between: tx, rx or service"


def _process_wohand(data: bytes) -> dict[str, bool | int]:
    """Process woHand/Bot services data."""
    _switch_mode = bool(data[1] & 0b10000000)

    _bot_data = {
        "switchMode": _switch_mode,
        "isOn": not bool(data[1] & 0b01000000) if _switch_mode else False,
        "battery": data[2] & 0b01111111,
    }

    return _bot_data


def _process_wocurtain(data: bytes, reverse: bool = True) -> dict[str, bool | int]:
    """Process woCurtain/Curtain services data."""

    _position = max(min(data[3] & 0b01111111, 100), 0)

    _curtain_data = {
        "calibration": bool(data[1] & 0b01000000),
        "battery": data[2] & 0b01111111,
        "inMotion": bool(data[3] & 0b10000000),
        "position": (100 - _position) if reverse else _position,
        "lightLevel": (data[4] >> 4) & 0b00001111,
        "deviceChain": data[4] & 0b00000111,
    }

    return _curtain_data


def _process_wosensorth(data: bytes) -> dict[str, object]:
    """Process woSensorTH/Temp sensor services data."""

    _temp_sign = 1 if data[4] & 0b10000000 else -1
    _temp_c = _temp_sign * ((data[4] & 0b01111111) + (data[3] / 10))
    _temp_f = (_temp_c * 9 / 5) + 32
    _temp_f = (_temp_f * 10) / 10

    _wosensorth_data = {
        "temp": {"c": _temp_c, "f": _temp_f},
        "fahrenheit": bool(data[5] & 0b10000000),
        "humidity": data[5] & 0b01111111,
        "battery": data[2] & 0b01111111,
    }

    return _wosensorth_data


def _process_btle_adv_data(dev: bluepy.btle.ScanEntry) -> dict[str, Any]:
    """Process bt le adv data."""
    _adv_data = {"mac_address": dev.addr}
    _data = dev.getValue(22)[2:]

    supported_types: dict[str, dict[str, Any]] = {
        "H": {"modelName": "WoHand", "func": _process_wohand},
        "c": {"modelName": "WoCurtain", "func": _process_wocurtain},
        "T": {"modelName": "WoSensorTH", "func": _process_wosensorth},
    }

    _model = chr(_data[0] & 0b01111111)
    _adv_data["isEncrypted"] = bool(_data[0] & 0b10000000)
    _adv_data["model"] = _model
    if _model in supported_types:
        _adv_data["data"] = supported_types[_model]["func"](_data)
        _adv_data["data"]["rssi"] = dev.rssi
        _adv_data["modelName"] = supported_types[_model]["modelName"]
    else:
        _adv_data["rawAdvData"] = dev.getValueText(22)

    return _adv_data


class GetSwitchbotDevices:
    """Scan for all Switchbot devices and return by type."""

    def __init__(self, interface: int = 0) -> None:
        """Get switchbot devices class constructor."""
        self._interface = interface
        self._adv_data: dict[str, Any] = {}

    def discover(
        self,
        retry: int = DEFAULT_RETRY_COUNT,
        scan_timeout: int = DEFAULT_SCAN_TIMEOUT,
        passive: bool = False,
        mac: str | None = None,
    ) -> dict[str, Any]:
        """Find switchbot devices and their advertisement data."""
        devices = None

        with CONNECT_LOCK:
            try:
                devices = bluepy.btle.Scanner(self._interface).scan(
                    scan_timeout, passive
                )
            except bluepy.btle.BTLEManagementError:
                _LOGGER.error("Error scanning for switchbot devices", exc_info=True)

        if devices is None:
            if retry < 1:
                _LOGGER.error(
                    "Scanning for Switchbot devices failed. Stop trying", exc_info=True
                )
                return self._adv_data

            _LOGGER.warning(
                "Error scanning for Switchbot devices. Retrying (remaining: %d)",
                retry,
            )
            time.sleep(DEFAULT_RETRY_TIMEOUT)
            return self.discover(
                retry=retry - 1,
                scan_timeout=scan_timeout,
                passive=passive,
                mac=mac,
            )

        for dev in devices:
            if dev.getValueText(7) == str(_sb_uuid()):
                dev_id = dev.addr.replace(":", "")
                if mac:
                    if dev.addr.lower() == mac.lower():
                        self._adv_data[dev_id] = _process_btle_adv_data(dev)
                else:
                    self._adv_data[dev_id] = _process_btle_adv_data(dev)

        return self._adv_data

    def get_curtains(self) -> dict:
        """Return all WoCurtain/Curtains devices with services data."""
        if not self._adv_data:
            self.discover()

        _curtain_devices = {
            device: data
            for device, data in self._adv_data.items()
            if data.get("model") == "c"
        }

        return _curtain_devices

    def get_bots(self) -> dict:
        """Return all WoHand/Bot devices with services data."""
        if not self._adv_data:
            self.discover()

        _bot_devices = {
            device: data
            for device, data in self._adv_data.items()
            if data.get("model") == "H"
        }

        return _bot_devices

    def get_tempsensors(self) -> dict:
        """Return all WoSensorTH/Temp sensor devices with services data."""
        if not self._adv_data:
            self.discover()

        _bot_temp = {
            device: data
            for device, data in self._adv_data.items()
            if data.get("model") == "T"
        }

        return _bot_temp

    def get_device_data(self, mac: str) -> dict:
        """Return data for specific device."""
        if not self._adv_data:
            self.discover()

        _switchbot_data = {
            device: data
            for device, data in self._adv_data.items()
            if data.get("mac_address") == mac
        }

        return _switchbot_data


class SwitchbotDevice(bluepy.btle.Peripheral):
    """Base Representation of a Switchbot Device."""

    def __init__(
        self,
        mac: str,
        password: str | None = None,
        interface: int = 0,
        **kwargs: Any,
    ) -> None:
        """Switchbot base class constructor."""
        bluepy.btle.Peripheral.__init__(
            self,
            deviceAddr=None,
            addrType=bluepy.btle.ADDR_TYPE_RANDOM,
            iface=interface,
        )
        self._interface = interface
        self._mac = mac.replace("-", ":").lower()
        self._sb_adv_data: dict[str, Any] = {}
        self._scan_timeout: int = kwargs.pop("scan_timeout", DEFAULT_SCAN_TIMEOUT)
        self._retry_count: int = kwargs.pop("retry_count", DEFAULT_RETRY_COUNT)
        if password is None or password == "":
            self._password_encoded = None
        else:
            self._password_encoded = "%x" % (
                binascii.crc32(password.encode("ascii")) & 0xFFFFFFFF
            )

    # pylint: disable=arguments-differ
    def _connect(self, retry: int, timeout: int | None = None) -> None:
        _LOGGER.debug("Connecting to Switchbot")

        if retry < 1:  # failsafe
            self._stopHelper()
            raise bluepy.btle.BTLEDisconnectError(
                "Failed to connect to peripheral %s" % self._mac
            )

        if self._helper is None:
            self._startHelper(self._interface)

        self._writeCmd("conn %s %s\n" % (self._mac, bluepy.btle.ADDR_TYPE_RANDOM))

        rsp = self._getResp(["stat", "err"], timeout)

        while rsp and rsp["state"][0] in [
            "tryconn",
            "scan",
        ]:  # Wait for any operations to finish.
            rsp = self._getResp(["stat", "err"], timeout)

        # If operation in progress, disc is returned.
        # Bluepy helper can't handle state. Execute stop, wait and retry.
        if rsp and rsp["state"][0] == "disc":
            _LOGGER.warning("Bluepy busy, waiting before retry")
            self._stopHelper()
            time.sleep(self._scan_timeout)
            return self._connect(retry - 1, timeout)

        if rsp and rsp["rsp"][0] == "err":
            errcode = rsp["code"][0]
            _LOGGER.debug(
                "Error trying to connect to peripheral %s, error: %s",
                self._mac,
                errcode,
            )

            if errcode == "connfail":  # not terminal, can retry connection.
                return self._connect(retry - 1, timeout)

            if errcode == "nomgmt":
                raise bluepy.btle.BTLEManagementError(
                    "Management not available (permissions problem?)", rsp
                )
            if errcode == "atterr":
                raise bluepy.btle.BTLEGattError("Bluetooth command failed", rsp)

            raise bluepy.btle.BTLEException(
                "Error from bluepy-helper (%s)" % errcode, rsp
            )

        if rsp is None or rsp["state"][0] != "conn":
            self._stopHelper()

            if rsp is None:
                _LOGGER.warning(
                    "Timed out while trying to connect to peripheral %s", self._mac
                )

            _LOGGER.warning("Bluehelper returned unable to connect state: %s", rsp)

            raise bluepy.btle.BTLEDisconnectError(
                "Failed to connect to peripheral %s, rsp: %s" % (self._mac, rsp)
            )

    def _commandkey(self, key: str) -> str:
        if self._password_encoded is None:
            return key
        key_action = key[3]
        key_suffix = key[4:]
        return KEY_PASSWORD_PREFIX + key_action + self._password_encoded + key_suffix

    def _writekey(self, key: str) -> bool:
        _LOGGER.debug("Prepare to send")
        if self._helper is None or self.getState() == "disc":
            return False
        try:
            hand = self.getCharacteristics(uuid=_sb_uuid("tx"))[0]
            _LOGGER.debug("Sending command, %s", key)
            hand.write(bytes.fromhex(key), withResponse=False)
        except bluepy.btle.BTLEException:
            _LOGGER.warning("Error sending command to Switchbot", exc_info=True)
            raise
        else:
            _LOGGER.info("Successfully sent command to Switchbot (MAC: %s)", self._mac)

        return True

    def _subscribe(self) -> bool:
        _LOGGER.debug("Subscribe to notifications")
        if self._helper is None or self.getState() == "disc":
            return False
        enable_notify_flag = b"\x01\x00"  # standard gatt flag to enable notification
        try:
            handle = self.getCharacteristics(uuid=_sb_uuid("rx"))[0]
            notify_handle = handle.getHandle() + 1
            self.writeCharacteristic(
                notify_handle, enable_notify_flag, withResponse=False
            )
        except bluepy.btle.BTLEException:
            _LOGGER.warning(
                "Error while enabling notifications on Switchbot", exc_info=True
            )
            raise

        return True

    def _readkey(self) -> bytes:
        _LOGGER.debug("Prepare to read notification from switchbot")
        if self._helper is None:
            return b"\x00"
        try:
            receive_handle = self.getCharacteristics(uuid=_sb_uuid("rx"))
        except bluepy.btle.BTLEException:
            _LOGGER.warning(
                "Error while reading notifications from Switchbot", exc_info=True
            )
        else:
            for char in receive_handle:
                read_result: bytes = char.read()
            return read_result

        # Could disconnect before reading response. Assume it worked as this is executed after issueing command.
        if self._helper and self.getState() == "disc":
            return b"\x01"

        return b"\x00"

    def _sendcommand(self, key: str, retry: int, timeout: int | None = 40) -> bytes:
        command = self._commandkey(key)
        send_success = False
        notify_msg = None
        _LOGGER.debug("Sending command to switchbot %s", command)

        if len(self._mac.split(":")) != 6:
            raise ValueError("Expected MAC address, got %s" % repr(self._mac))

        with CONNECT_LOCK:
            try:
                self._connect(retry, timeout)
                send_success = self._subscribe()
            except bluepy.btle.BTLEException:
                _LOGGER.warning("Error connecting to Switchbot", exc_info=True)
            else:
                try:
                    send_success = self._writekey(command)
                except bluepy.btle.BTLEException:
                    _LOGGER.warning(
                        "Error sending commands to Switchbot", exc_info=True
                    )
                else:
                    notify_msg = self._readkey()
            finally:
                self.disconnect()

        if notify_msg and send_success:
            if notify_msg == b"\x07":
                _LOGGER.error("Password required")
            elif notify_msg == b"\t":
                _LOGGER.error("Password incorrect")
            return notify_msg

        if retry < 1:
            _LOGGER.error(
                "Switchbot communication failed. Stopping trying", exc_info=True
            )
            return b"\x00"
        _LOGGER.warning("Cannot connect to Switchbot. Retrying (remaining: %d)", retry)
        time.sleep(DEFAULT_RETRY_TIMEOUT)
        return self._sendcommand(key, retry - 1)

    def get_mac(self) -> str:
        """Return mac address of device."""
        return self._mac

    def get_battery_percent(self) -> Any:
        """Return device battery level in percent."""
        if not self._sb_adv_data.get("data"):
            return None
        return self._sb_adv_data["data"].get("battery")

    def get_device_data(
        self,
        retry: int = DEFAULT_RETRY_COUNT,
        interface: int | None = None,
        passive: bool = False,
    ) -> dict[str, Any]:
        """Find switchbot devices and their advertisement data."""
        _interface: int = interface if interface else self._interface

        dev_id = self._mac.replace(":", "")

        _data = GetSwitchbotDevices(interface=_interface).discover(
            retry=retry,
            scan_timeout=self._scan_timeout,
            passive=passive,
            mac=self._mac,
        )

        if _data.get(dev_id):
            self._sb_adv_data = _data[dev_id]

        return self._sb_adv_data


class Switchbot(SwitchbotDevice):
    """Representation of a Switchbot."""

    def __init__(self, *args: Any, **kwargs: Any) -> None:
        """Switchbot Bot/WoHand constructor."""
        super().__init__(*args, **kwargs)
        self._inverse: bool = kwargs.pop("inverse_mode", False)
        self._settings: dict[str, Any] = {}

    def update(self, interface: int | None = None, passive: bool = False) -> None:
        """Update mode, battery percent and state of device."""
        self.get_device_data(
            retry=self._retry_count, interface=interface, passive=passive
        )

    def turn_on(self) -> bool:
        """Turn device on."""
        result = self._sendcommand(ON_KEY, self._retry_count)

        if result[0] == 1:
            return True

        if result[0] == 5:
            _LOGGER.debug("Bot is in press mode and doesn't have on state")
            return True

        return False

    def turn_off(self) -> bool:
        """Turn device off."""
        result = self._sendcommand(OFF_KEY, self._retry_count)
        if result[0] == 1:
            return True

        if result[0] == 5:
            _LOGGER.debug("Bot is in press mode and doesn't have off state")
            return True

        return False

    def hand_up(self) -> bool:
        """Raise device arm."""
        result = self._sendcommand(UP_KEY, self._retry_count)
        if result[0] == 1:
            return True

        if result[0] == 5:
            _LOGGER.debug("Bot is in press mode")
            return True

        return False

    def hand_down(self) -> bool:
        """Lower device arm."""
        result = self._sendcommand(DOWN_KEY, self._retry_count)
        if result[0] == 1:
            return True

        if result[0] == 5:
            _LOGGER.debug("Bot is in press mode")
            return True

        return False

    def press(self) -> bool:
        """Press command to device."""
        result = self._sendcommand(PRESS_KEY, self._retry_count)
        if result[0] == 1:
            return True

        if result[0] == 5:
            _LOGGER.debug("Bot is in switch mode")
            return True

        return False

    def set_switch_mode(
        self, switch_mode: bool = False, strength: int = 100, inverse: bool = False
    ) -> bool:
        """Change bot mode."""
        mode_key = format(switch_mode, "b") + format(inverse, "b")
        strength_key = f"{strength:0{2}x}"  # to hex with padding to double digit

        result = self._sendcommand(
            DEVICE_SET_MODE_KEY + strength_key + mode_key, self._retry_count
        )

        if result[0] == 1:
            return True

        return False

    def set_long_press(self, duration: int = 0) -> bool:
        """Set bot long press duration."""
        duration_key = f"{duration:0{2}x}"  # to hex with padding to double digit

        result = self._sendcommand(
            DEVICE_SET_EXTENDED_KEY + "08" + duration_key, self._retry_count
        )

        if result[0] == 1:
            return True

        return False

    def get_basic_info(self) -> dict[str, Any] | None:
        """Get device basic settings."""
        _data = self._sendcommand(
            key=DEVICE_GET_BASIC_SETTINGS_KEY, retry=self._retry_count
        )

        if _data in (b"\x07", b"\x00"):
            _LOGGER.error("Unsuccessfull, please try again")
            return None

        self._settings = {
            "battery": _data[1],
            "firmware": _data[2] / 10.0,
            "strength": _data[3],
            "timers": _data[8],
            "switchMode": bool(_data[9] & 16),
            "inverseDirection": bool(_data[9] & 1),
            "holdSeconds": _data[10],
        }

        return self._settings

    def switch_mode(self) -> Any:
        """Return true or false from cache."""
        # To get actual position call update() first.
        if not self._sb_adv_data.get("data"):
            return None
        return self._sb_adv_data.get("switchMode")

    def is_on(self) -> Any:
        """Return switch state from cache."""
        # To get actual position call update() first.
        if not self._sb_adv_data.get("data"):
            return None

        if self._inverse:
            return not self._sb_adv_data["data"].get("isOn")

        return self._sb_adv_data["data"].get("isOn")


class SwitchbotCurtain(SwitchbotDevice):
    """Representation of a Switchbot Curtain."""

    def __init__(self, *args: Any, **kwargs: Any) -> None:
        """Switchbot Curtain/WoCurtain constructor."""

        # The position of the curtain is saved returned with 0 = open and 100 = closed.
        # This is independent of the calibration of the curtain bot (Open left to right/
        # Open right to left/Open from the middle).
        # The parameter 'reverse_mode' reverse these values,
        # if 'reverse_mode' = True, position = 0 equals close
        # and position = 100 equals open. The parameter is default set to True so that
        # the definition of position is the same as in Home Assistant.

        super().__init__(*args, **kwargs)
        self._reverse: bool = kwargs.pop("reverse_mode", True)
        self._settings: dict[str, Any] = {}
        self.ext_info_sum: dict[str, Any] = {}
        self.ext_info_adv: dict[str, Any] = {}

    def open(self) -> bool:
        """Send open command."""
        result = self._sendcommand(OPEN_KEY, self._retry_count)
        if result[0] == 1:
            return True

        return False

    def close(self) -> bool:
        """Send close command."""
        result = self._sendcommand(CLOSE_KEY, self._retry_count)
        if result[0] == 1:
            return True

        return False

    def stop(self) -> bool:
        """Send stop command to device."""
        result = self._sendcommand(STOP_KEY, self._retry_count)
        if result[0] == 1:
            return True

        return False

    def set_position(self, position: int) -> bool:
        """Send position command (0-100) to device."""
        position = (100 - position) if self._reverse else position
        hex_position = "%0.2X" % position
        result = self._sendcommand(POSITION_KEY + hex_position, self._retry_count)
        if result[0] == 1:
            return True

        return False

    def update(self, interface: int | None = None, passive: bool = False) -> None:
        """Update position, battery percent and light level of device."""
        self.get_device_data(
            retry=self._retry_count, interface=interface, passive=passive
        )

    def get_position(self) -> Any:
        """Return cached position (0-100) of Curtain."""
        # To get actual position call update() first.
        if not self._sb_adv_data.get("data"):
            return None
        return self._sb_adv_data["data"].get("position")

    def get_basic_info(self) -> dict[str, Any] | None:
        """Get device basic settings."""
        _data = self._sendcommand(
            key=DEVICE_GET_BASIC_SETTINGS_KEY, retry=self._retry_count
        )

        if _data in (b"\x07", b"\x00"):
            _LOGGER.error("Unsuccessfull, please try again")
            return None

        _position = max(min(_data[6], 100), 0)

        self._settings = {
            "battery": _data[1],
            "firmware": _data[2] / 10.0,
            "chainLength": _data[3],
            "openDirection": (
                "right_to_left" if _data[4] & 0b10000000 == 128 else "left_to_right"
            ),
            "touchToOpen": bool(_data[4] & 0b01000000),
            "light": bool(_data[4] & 0b00100000),
            "fault": bool(_data[4] & 0b00001000),
            "solarPanel": bool(_data[5] & 0b00001000),
            "calibrated": bool(_data[5] & 0b00000100),
            "inMotion": bool(_data[5] & 0b01000011),
            "position": (100 - _position) if self._reverse else _position,
            "timers": _data[7],
        }

        return self._settings

    def get_extended_info_summary(self) -> dict[str, Any] | None:
        """Get basic info for all devices in chain."""
        _data = self._sendcommand(key=CURTAIN_EXT_SUM_KEY, retry=self._retry_count)

        if _data in (b"\x07", b"\x00"):
            _LOGGER.error("Unsuccessfull, please try again")
            return None

        self.ext_info_sum["device0"] = {
            "openDirectionDefault": not bool(_data[1] & 0b10000000),
            "touchToOpen": bool(_data[1] & 0b01000000),
            "light": bool(_data[1] & 0b00100000),
            "openDirection": (
                "left_to_right" if _data[1] & 0b00010000 == 1 else "right_to_left"
            ),
        }

        # if grouped curtain device present.
        if _data[2] != 0:
            self.ext_info_sum["device1"] = {
                "openDirectionDefault": not bool(_data[1] & 0b10000000),
                "touchToOpen": bool(_data[1] & 0b01000000),
                "light": bool(_data[1] & 0b00100000),
                "openDirection": (
                    "left_to_right" if _data[1] & 0b00010000 else "right_to_left"
                ),
            }

        return self.ext_info_sum

    def get_extended_info_adv(self) -> dict[str, Any] | None:
        """Get advance page info for device chain."""
        _data = self._sendcommand(key=CURTAIN_EXT_ADV_KEY, retry=self._retry_count)

        if _data in (b"\x07", b"\x00"):
            _LOGGER.error("Unsuccessfull, please try again")
            return None

        _state_of_charge = [
            "not_charging",
            "charging_by_adapter",
            "charging_by_solar",
            "fully_charged",
            "solar_not_charging",
            "charging_error",
        ]

        self.ext_info_adv["device0"] = {
            "battery": _data[1],
            "firmware": _data[2] / 10.0,
            "stateOfCharge": _state_of_charge[_data[3]],
        }

        # If grouped curtain device present.
        if _data[4]:
            self.ext_info_adv["device1"] = {
                "battery": _data[4],
                "firmware": _data[5] / 10.0,
                "stateOfCharge": _state_of_charge[_data[6]],
            }

        return self.ext_info_adv

    def get_light_level(self) -> Any:
        """Return cached light level."""
        # To get actual light level call update() first.
        if not self._sb_adv_data.get("data"):
            return None
        return self._sb_adv_data["data"].get("lightLevel")

    def is_reversed(self) -> bool:
        """Return True if curtain position is opposite from SB data."""
        return self._reverse

    def is_calibrated(self) -> Any:
        """Return True curtain is calibrated."""
        # To get actual light level call update() first.
        if not self._sb_adv_data.get("data"):
            return None
        return self._sb_adv_data["data"].get("calibration")