platypush/platypush/plugins/switchbot/__init__.py

import queue
import threading
from typing import Any, Collection, Dict, List, Optional, Union

import requests

from platypush.entities import (
    DimmerEntityManager,
    EnumSwitchEntityManager,
    Entity,
    SwitchEntityManager,
)
from platypush.entities.devices import Device
from platypush.entities.dimmers import Dimmer
from platypush.entities.humidity import HumiditySensor
from platypush.entities.motion import MotionSensor
from platypush.entities.sensors import BinarySensor, EnumSensor, Sensor
from platypush.entities.switches import EnumSwitch
from platypush.entities.temperature import TemperatureSensor
from platypush.plugins import RunnablePlugin, action
from platypush.schemas.switchbot import DeviceSchema, DeviceStatusSchema, SceneSchema


class SwitchbotPlugin(
    RunnablePlugin,
    SwitchEntityManager,
    DimmerEntityManager,
    EnumSwitchEntityManager,
):
    """
    Plugin to interact with the devices registered to a Switchbot
    (https://www.switch-bot.com/) account/hub.

    The difference between this plugin and
    :class:`platypush.plugins.switchbot.bluetooth.SwitchbotBluetoothPlugin` is
    that the latter acts like a Bluetooth hub/bridge that interacts directly
    with your Switchbot devices, while this plugin requires the devices to be
    connected to a Switchbot Hub and it controls them through your cloud
    account.

    In order to use this plugin:

        - Set up a Switchbot Hub and configure your devices through the
          Switchbot app.
        - Follow the steps on the `Switchbot API repo
          <https://github.com/OpenWonderLabs/SwitchBotAPI#getting-started>`_ to
          get an API token from the app.

    """

    def __init__(self, api_token: str, **kwargs):
        """
        :param api_token: API token (see
            `Getting started with the Switchbot API
             <https://github.com/OpenWonderLabs/SwitchBotAPI#getting-started>`_).
        """
        super().__init__(**kwargs)
        self._api_token = api_token
        self._devices_by_id: Dict[str, dict] = {}
        self._devices_by_name: Dict[str, dict] = {}

    @staticmethod
    def _url_for(*args, device=None):
        url = 'https://api.switch-bot.com/v1.0/'
        if device:
            url += f'devices/{device["id"]}/'
        url += '/'.join(args)
        return url

    # pylint: disable=keyword-arg-before-vararg
    def _run(self, method: str = 'get', *args, device=None, **kwargs):
        response = getattr(requests, method)(
            self._url_for(*args, device=device),
            headers={
                'Authorization': self._api_token,
                'Accept': 'application/json',
                'Content-Type': 'application/json; charset=utf-8',
            },
            timeout=10,
            **kwargs,
        )

        response.raise_for_status()
        response = response.json()
        assert (
            response.get('statusCode') == 100
        ), f'Switchbot API request failed: {response.get("statusCode")}: {response.get("message")}'

        return response.get('body')

    def _get_device(self, device: str, use_cache=True):
        if not use_cache:
            self.devices()

        if device in self._devices_by_id:
            return self._devices_by_id[device]
        if device in self._devices_by_name:
            return self._devices_by_name[device]

        assert use_cache, f'Device not found: {device}'
        return self._get_device(device, use_cache=False)

    @action
    def devices(self) -> List[dict]:
        """
        Get the list of devices associated to the specified Switchbot API account.

        :return: .. schema:: switchbot.DeviceSchema(many=True)
        """
        devices = self._run('get', 'devices')
        devices = [
            DeviceSchema().dump(
                {
                    **device,
                    'is_virtual': False,
                }
            )
            for device in devices.get('deviceList', [])
        ] + [
            DeviceSchema().dump(
                {
                    **device,
                    'is_virtual': True,
                }
            )
            for device in devices.get('infraredRemoteList', [])
        ]

        for device in devices:
            self._devices_by_id[device['id']] = device
            self._devices_by_name[device['name']] = device

        return devices

    @staticmethod
    def _get_device_metadata(device: dict) -> dict:
        return {
            "device_type": device.get("device_type"),
            "is_virtual": device.get("is_virtual", False),
            "hub_id": device.get("hub_id"),
        }

    @classmethod
    def _get_device_base(cls, device_dict: dict) -> Device:
        args: Dict[str, Any] = {
            'data': cls._get_device_metadata(device_dict),
        }

        return Device(
            id=f'{device_dict["id"]}',
            name=f'{device_dict["name"]}',
            **args,
        )

    @classmethod
    def _get_bots(cls, *entities: dict) -> List[EnumSwitch]:
        return [
            EnumSwitch(
                id=dev["id"],
                name=dev["name"],
                value="on" if dev.get("on") else "off",
                values=["on", "off", "press"],
                is_write_only=True,
                data=cls._get_device_metadata(dev),
            )
            for dev in (entities or [])
            if dev.get('device_type') == 'Bot'
        ]

    @classmethod
    def _get_curtains(cls, *entities: dict) -> List[Dimmer]:
        return [
            Dimmer(
                id=dev["id"],
                name=dev["name"],
                value=dev.get("position"),
                min=0,
                max=100,
                unit='%',
                data=cls._get_device_metadata(dev),
            )
            for dev in (entities or [])
            if dev.get('device_type') == 'Curtain'
        ]

    @classmethod
    def _get_meters(cls, device_dict: dict) -> List[Device]:
        devices = [cls._get_device_base(device_dict)]
        if device_dict.get('temperature') is not None:
            devices[0].children.append(
                TemperatureSensor(
                    id=f'{device_dict["id"]}:temperature',
                    name='Temperature',
                    value=device_dict['temperature'],
                    unit='C',
                )
            )

        if device_dict.get('humidity') is not None:
            devices[0].children.append(
                HumiditySensor(
                    id=f'{device_dict["id"]}:humidity',
                    name='Humidity',
                    value=device_dict['humidity'],
                    min=0,
                    max=100,
                    unit='%',
                )
            )

        if not devices[0].children:
            return []
        return devices

    @classmethod
    def _get_motion_sensors(cls, device_dict: dict) -> List[Device]:
        devices = [cls._get_device_base(device_dict)]
        if device_dict.get('moveDetected') is not None:
            devices[0].children.append(
                MotionSensor(
                    id=f'{device_dict["id"]}:motion',
                    name='Motion Detected',
                    value=bool(device_dict['moveDetected']),
                )
            )

        if device_dict.get('brightness') is not None:
            devices[0].children.append(
                BinarySensor(
                    id=f'{device_dict["id"]}:brightness',
                    name='Bright',
                    value=device_dict['brightness'] == 'bright',
                )
            )

        if not devices[0].children:
            return []
        return devices

    @classmethod
    def _get_contact_sensors(cls, device_dict: dict) -> List[Device]:
        devices = cls._get_motion_sensors(device_dict)
        if not devices:
            return []

        if device_dict.get('openState') is not None:
            devices[0].children.append(
                EnumSensor(
                    id=f'{device_dict["id"]}:open',
                    name='Open State',
                    value=device_dict['openState'],
                    values=['open', 'close', 'timeOutNotClose'],
                )
            )

        return devices

    @classmethod
    def _get_sensors(cls, *entities: dict) -> List[Sensor]:
        sensors: List[Sensor] = []
        for dev in entities:
            if dev.get('device_type') in {'Meter', 'Meter Plus'}:
                sensors.extend(cls._get_meters(dev))
            elif dev.get('device_type') == 'Motion Sensor':
                sensors.extend(cls._get_motion_sensors(dev))
            elif dev.get('device_type') == 'Contact Sensor':
                sensors.extend(cls._get_contact_sensors(dev))

        return sensors

    def transform_entities(self, entities: Collection[dict]) -> Collection[Entity]:
        return [
            *self._get_bots(*entities),
            *self._get_curtains(*entities),
            *self._get_sensors(*entities),
        ]

    def _worker(  # pylint: disable=keyword-arg-before-vararg
        self,
        q: queue.Queue,
        method: str = 'get',
        *args,
        device: Optional[dict] = None,
        **kwargs,
    ):
        schema = DeviceStatusSchema()
        try:
            if (
                method == 'get'
                and args
                and args[0] == 'status'
                and device
                and device.get('is_virtual')
            ):
                res = schema.load(device)
            else:
                res = self._run(method, *args, device=device, **kwargs)

            q.put(schema.dump(res))
        except Exception as e:
            self.logger.exception(e)
            q.put(e)

    @action
    # pylint: disable=arguments-differ
    def status(
        self, device: Optional[str] = None, publish_entities: bool = True, **_
    ) -> Union[dict, List[dict]]:
        """
        Get the status of all the registered devices or of a specific device.

        :param device: Filter by device ID or name.
        :return: .. schema:: switchbot.DeviceStatusSchema(many=True)
        """
        devices = self.devices().output
        if device:
            device_info = self._get_device(device)
            status = (
                {}
                if device_info['is_virtual']
                else self._run('get', 'status', device=device_info)
            )
            return {
                **device_info,
                **status,
            }

        devices_by_id = {dev['id']: dev for dev in devices}
        queues: List[queue.Queue] = [queue.Queue()] * len(devices)
        workers = [
            threading.Thread(
                target=self._worker,
                args=(queues[i], 'get', 'status'),
                kwargs={'device': dev},
            )
            for i, dev in enumerate(devices)
        ]

        results = []
        for worker in workers:
            worker.start()

        for q in queues:
            response = q.get()
            if not response:
                continue

            assert not isinstance(response, Exception), str(response)
            results.append(
                {
                    **devices_by_id.get(response.get('id'), {}),
                    **response,
                }
            )

        for worker in workers:
            worker.join()

        if publish_entities:
            self.publish_entities(results)
        return results

    @action
    def press(self, device: str):
        """
        Send a press-button command to a device.

        :param device: Device name or ID.
        """
        device = self._get_device(device)
        return self._run('post', 'commands', device=device, json={'command': 'press'})

    @action
    def toggle(self, device: str, **_):  # pylint: disable=arguments-differ
        """
        Shortcut for :meth:`.press`.

        :param device: Device name or ID.
        """
        return self.press(device)

    @action
    def on(self, device: str, **_):  # pylint: disable=arguments-differ
        """
        Send a turn-on command to a device

        :param device: Device name or ID.
        """
        device = self._get_device(device)
        return self._run('post', 'commands', device=device, json={'command': 'turnOn'})

    @action
    def off(self, device: str, **_):  # pylint: disable=arguments-differ
        """
        Send a turn-off command to a device

        :param device: Device name or ID.
        """
        device = self._get_device(device)
        return self._run('post', 'commands', device=device, json={'command': 'turnOff'})

    @action
    def set_curtain_position(self, device: str, position: int):
        """
        Set the position of a curtain device.

        :param device: Device name or ID.
        :param position: An integer between 0 (open) and 100 (closed).
        """
        device = self._get_device(device)
        return self._run(
            'post',
            'commands',
            device=device,
            json={
                'command': 'setPosition',
                'commandType': 'command',
                'parameter': f'0,ff,{position}',
            },
        )

    @action
    def set_humidifier_efficiency(self, device: str, efficiency: Union[int, str]):
        """
        Set the nebulization efficiency of a humidifier device.

        :param device: Device name or ID.
        :param efficiency: An integer between 0 and 100, or `auto`.
        """
        device = self._get_device(device)
        return self._run(
            'post',
            'commands',
            device=device,
            json={
                'command': 'setMode',
                'commandType': 'command',
                'parameter': efficiency,
            },
        )

    @action
    def set_fan_speed(self, device: str, speed: int):
        """
        Set the speed of a fan.

        :param device: Device name or ID.
        :param speed: Speed between 1 and 4.
        """
        status = self.status(device=device).output
        mode = status.get('mode')
        swing_range = status.get('swing_range')
        return self._run(
            'post',
            'commands',
            device=device,
            json={
                'command': 'set',
                'commandType': 'command',
                'parameter': ','.join(['on', str(mode), str(speed), str(swing_range)]),
            },
        )

    @action
    def set_fan_mode(self, device: str, mode: int):
        """
        Set the mode of a fan.

        :param device: Device name or ID.
        :param mode: Fan mode (1 or 2).
        """
        status = self.status(device=device).output
        speed = status.get('speed')
        swing_range = status.get('swing_range')
        return self._run(
            'post',
            'commands',
            device=device,
            json={
                'command': 'set',
                'commandType': 'command',
                'parameter': ','.join(['on', str(mode), str(speed), str(swing_range)]),
            },
        )

    @action
    def set_swing_range(self, device: str, swing_range: int):
        """
        Set the swing range of a fan.

        :param device: Device name or ID.
        :param swing_range: Swing range angle, between 0 and 120.
        """
        status = self.status(device=device).output
        speed = status.get('speed')
        mode = status.get('mode')
        return self._run(
            'post',
            'commands',
            device=device,
            json={
                'command': 'set',
                'commandType': 'command',
                'parameter': ','.join(['on', str(mode), str(speed), str(swing_range)]),
            },
        )

    @action
    def set_temperature(self, device: str, temperature: float):
        """
        Set the temperature of an air conditioner.

        :param device: Device name or ID.
        :param temperature: Temperature, in Celsius.
        """
        status = self.status(device=device).output
        mode = status.get('mode')
        fan_speed = status.get('fan_speed')
        return self._run(
            'post',
            'commands',
            device=device,
            json={
                'command': 'setAll',
                'commandType': 'command',
                'parameter': ','.join(
                    [str(temperature), str(mode), str(fan_speed), 'on']
                ),
            },
        )

    @action
    def set_ac_mode(self, device: str, mode: int):
        """
        Set the mode of an air conditioner.

        :param device: Device name or ID.
        :param mode: Air conditioner mode. Supported values:

            * 1: ``auto``
            * 2: ``cool``
            * 3: ``dry``
            * 4: ``fan``
            * 5: ``heat``

        """
        status = self.status(device=device).output
        temperature = status.get('temperature')
        fan_speed = status.get('fan_speed')
        return self._run(
            'post',
            'commands',
            device=device,
            json={
                'command': 'setAll',
                'commandType': 'command',
                'parameter': ','.join(
                    [str(temperature), str(mode), str(fan_speed), 'on']
                ),
            },
        )

    @action
    def set_ac_fan_speed(self, device: str, fan_speed: int):
        """
        Set the fan speed for an air conditioner.

        :param device: Device name or ID.
        :param fan_speed: Possible values:

            * 1: ``auto``
            * 2: ``low``
            * 3: ``medium``
            * 4: ``high``

        """
        status = self.status(device=device).output
        temperature = status.get('temperature')
        mode = status.get('mode')
        return self._run(
            'post',
            'commands',
            device=device,
            json={
                'command': 'setAll',
                'commandType': 'command',
                'parameter': ','.join(
                    [str(temperature), str(mode), str(fan_speed), 'on']
                ),
            },
        )

    @action
    def set_channel(self, device: str, channel: int):
        """
        Set the channel on a TV, IPTV/Streamer, Set Top Box device.

        :param device: Device name or ID.
        :param channel: Channel number.
        """
        device = self._get_device(device)
        return self._run(
            'post',
            'commands',
            device=device,
            json={
                'command': 'SetChannel',
                'commandType': 'command',
                'parameter': [str(channel)],
            },
        )

    @action
    def volup(self, device: str):
        """
        Send volume up IR event to a device (for TV, IPTV/Streamer, Set Top Box, DVD and Speaker).

        :param device: Device name or ID.
        """
        device = self._get_device(device)
        return self._run(
            'post',
            'commands',
            device=device,
            json={
                'command': 'volumeAdd',
                'commandType': 'command',
            },
        )

    @action
    def voldown(self, device: str):
        """
        Send volume down IR event to a device (for TV, IPTV/Streamer, Set Top Box, DVD and Speaker).

        :param device: Device name or ID.
        """
        device = self._get_device(device)
        return self._run(
            'post',
            'commands',
            device=device,
            json={
                'command': 'volumeSub',
                'commandType': 'command',
            },
        )

    @action
    def mute(self, device: str):
        """
        Send mute/unmute IR event to a device (for TV, IPTV/Streamer, Set Top Box, DVD and Speaker).

        :param device: Device name or ID.
        """
        device = self._get_device(device)
        return self._run(
            'post',
            'commands',
            device=device,
            json={
                'command': 'setMute',
                'commandType': 'command',
            },
        )

    @action
    def channel_next(self, device: str):
        """
        Send next channel IR event to a device (for TV, IPTV/Streamer, and Set Top Box).

        :param device: Device name or ID.
        """
        device = self._get_device(device)
        return self._run(
            'post',
            'commands',
            device=device,
            json={
                'command': 'channelAdd',
                'commandType': 'command',
            },
        )

    @action
    def channel_prev(self, device: str):
        """
        Send previous channel IR event to a device (for TV, IPTV/Streamer, and Set Top Box).

        :param device: Device name or ID.
        """
        device = self._get_device(device)
        return self._run(
            'post',
            'commands',
            device=device,
            json={
                'command': 'channelSub',
                'commandType': 'command',
            },
        )

    @action
    def play(self, device: str):
        """
        Send play IR event to a device (for DVD and Speaker).

        :param device: Device name or ID.
        """
        device = self._get_device(device)
        return self._run(
            'post',
            'commands',
            device=device,
            json={
                'command': 'Play',
                'commandType': 'command',
            },
        )

    @action
    def pause(self, device: str):
        """
        Send pause IR event to a device (for DVD and Speaker).

        :param device: Device name or ID.
        """
        device = self._get_device(device)
        return self._run(
            'post',
            'commands',
            device=device,
            json={
                'command': 'Pause',
                'commandType': 'command',
            },
        )

    @action
    def ir_stop(self, device: str):
        """
        Send stop IR event to a device (for DVD and Speaker).

        :param device: Device name or ID.
        """
        device = self._get_device(device)
        return self._run(
            'post',
            'commands',
            device=device,
            json={
                'command': 'Stop',
                'commandType': 'command',
            },
        )

    @action
    def forward(self, device: str):
        """
        Send forward IR event to a device (for DVD and Speaker).

        :param device: Device name or ID.
        """
        device = self._get_device(device)
        return self._run(
            'post',
            'commands',
            device=device,
            json={
                'command': 'FastForward',
                'commandType': 'command',
            },
        )

    @action
    def back(self, device: str):
        """
        Send backward IR event to a device (for DVD and Speaker).

        :param device: Device name or ID.
        """
        device = self._get_device(device)
        return self._run(
            'post',
            'commands',
            device=device,
            json={
                'command': 'Rewind',
                'commandType': 'command',
            },
        )

    @action
    def next(self, device: str):
        """
        Send next IR event to a device (for DVD and Speaker).

        :param device: Device name or ID.
        """
        device = self._get_device(device)
        return self._run(
            'post',
            'commands',
            device=device,
            json={
                'command': 'Next',
                'commandType': 'command',
            },
        )

    @action
    def previous(self, device: str):
        """
        Send previous IR event to a device (for DVD and Speaker).

        :param device: Device name or ID.
        """
        device = self._get_device(device)
        return self._run(
            'post',
            'commands',
            device=device,
            json={
                'command': 'Previous',
                'commandType': 'command',
            },
        )

    @action
    def scenes(self) -> List[dict]:
        """
        Get the list of registered scenes.

        :return: .. schema:: switchbot.SceneSchema(many=True)
        """
        return SceneSchema().dump(self._run('get', 'scenes'), many=True)

    @action
    def run_scene(self, scene: str):
        """
        Execute a scene.

        :param scene: Scene ID or name.
        """
        scenes = [
            s
            for s in self.scenes().output
            if s.get('id') == scene or s.get('name') == scene
        ]

        assert scenes, f'No such scene: {scene}'
        return self._run('post', 'scenes', scenes[0]['id'], 'execute')

    @action
    # pylint: disable=redefined-builtin,arguments-differ
    def set_value(self, device: str, property=None, data=None, **__):
        dev = self._get_device(device)
        entities = list(self.transform_entities([dev]))
        assert entities, f'The device {device} is not mapped to a compatible entity'

        entity = entities[0]

        # SwitchBot case
        if isinstance(entity, EnumSwitch):
            method = getattr(self, data, None)
            assert method, f'No such action available for device "{device}": "{data}"'

            return method(entity.id)

        # Curtain case
        if isinstance(entity, Dimmer):
            return self.set_curtain_position(entity.id, data)

        self.logger.warning(
            'Could not find a suitable action for device "%s" of type "%s"',
            device,
            type(entity.__class__.__name__),
        )

    def main(self):
        entities = {}

        while not self.should_stop():
            new_entities = {
                e['id']: e for e in self.status(publish_entities=False).output
            }

            updated_entities = {
                id: e
                for id, e in new_entities.items()
                if any(v != entities.get(id, {}).get(k) for k, v in e.items())
            }

            if updated_entities:
                self.publish_entities(updated_entities.values())

            entities = new_entities
            self.wait_stop(self.poll_interval)


# vim:sw=4:ts=4:et: