tuya-local/custom_components/tuya_local/device.py

"""
API for Tuya Local devices.
"""

import json
import logging
from threading import Lock, Timer
from time import time

from homeassistant.const import TEMP_CELSIUS
from homeassistant.core import HomeAssistant

from .const import (
    DOMAIN,
    API_PROTOCOL_VERSIONS,
    CONF_TYPE_DEHUMIDIFIER,
    CONF_TYPE_FAN,
    CONF_TYPE_GECO_HEATER,
    CONF_TYPE_GPCV_HEATER,
    CONF_TYPE_GPPH_HEATER,
    CONF_TYPE_KOGAN_HEATER,
    CONF_TYPE_KOGAN_SWITCH,
)

_LOGGER = logging.getLogger(__name__)


class TuyaLocalDevice(object):
    def __init__(self, name, dev_id, address, local_key, hass: HomeAssistant):
        """
        Represents a Tuya-based device.

        Args:
            dev_id (str): The device id.
            address (str): The network address.
            local_key (str): The encryption key.
        """
        import pytuya

        self._name = name
        self._api_protocol_version_index = None
        self._api_protocol_working = False
        self._api = pytuya.Device(dev_id, address, local_key, "device")
        self._refresh_task = None
        self._rotate_api_protocol_version()

        self._fixed_properties = {}
        self._reset_cached_state()

        self._TEMPERATURE_UNIT = TEMP_CELSIUS
        self._hass = hass

        # API calls to update Tuya devices are asynchronous and non-blocking. This means
        # you can send a change and immediately request an updated state (like HA does),
        # but because it has not yet finished processing you will be returned the old state.
        # The solution is to keep a temporary list of changed properties that we can overlay
        # onto the state while we wait for the board to update its switches.
        self._FAKE_IT_TIL_YOU_MAKE_IT_TIMEOUT = 10
        self._CACHE_TIMEOUT = 20
        self._CONNECTION_ATTEMPTS = 4
        self._lock = Lock()

    @property
    def name(self):
        return self._name

    @property
    def unique_id(self):
        """Return the unique id for this device (the dev_id)."""
        return self._api.id

    @property
    def device_info(self):
        """Return the device information for this device."""
        return {
            "identifiers": {(DOMAIN, self.unique_id)},
            "name": self.name,
            "manufacturer": "Tuya",
        }

    @property
    def temperature_unit(self):
        return self._TEMPERATURE_UNIT

    async def async_inferred_type(self):
        cached_state = self._get_cached_state()
        if "1" not in cached_state and "3" not in cached_state:
            await self.async_refresh()
            cached_state = self._get_cached_state()

        _LOGGER.debug(f"Inferring device type from cached state: {cached_state}")
        if "1" not in cached_state:
            _LOGGER.info(f"Detecting {self.name} as Kogan Heater")
            return CONF_TYPE_KOGAN_HEATER
        if "5" in cached_state and "3" not in cached_state and "103" in cached_state:
            _LOGGER.info(f"Detecting {self.name} as Goldair Dehumidifier")
            return CONF_TYPE_DEHUMIDIFIER
        if "8" in cached_state:
            _LOGGER.info(f"Detecting {self.name} as Goldair Fan")
            return CONF_TYPE_FAN
        if "5" in cached_state and "3" not in cached_state:
            _LOGGER.info(f"Detecting {self.name} as Kogan Switch")
            return CONF_TYPE_KOGAN_SWITCH
        if "106" in cached_state:
            _LOGGER.info(f"Detecting {self.name} as Goldair GPPH Heater")
            return CONF_TYPE_GPPH_HEATER
        if "7" in cached_state:
            _LOGGER.info(f"Detecting {self.name} as Goldair GPCV Heater")
            return CONF_TYPE_GPCV_HEATER
        if "3" in cached_state:
            _LOGGER.info(f"Detecting {self.name} as Goldair GECO Heater")
            return CONF_TYPE_GECO_HEATER
        _LOGGER.warning(f"Detection for {self.name} failed")
        return None

    def set_fixed_properties(self, fixed_properties):
        self._fixed_properties = fixed_properties
        set_fixed_properties = Timer(
            10, lambda: self._set_properties(self._fixed_properties)
        )
        set_fixed_properties.start()

    async def async_refresh(self):
        last_updated = self._get_cached_state()["updated_at"]
        try:
            self._lock.aquire()
            if self._refresh_task is None or time() - last_updated >= self._CACHE_TIMEOUT:
                self._cached_state["updated_at"] = time()
                self._refresh_task = self._hass.async_add_executor_job(self.refresh)
        finally:
            self._lock.release()

        await self._refresh_task

    def refresh(self):
        _LOGGER.debug(f"Refreshing device state for {self.name}.")
        self._retry_on_failed_connection(
            lambda: self._refresh_cached_state(),
            f"Failed to refresh device state for {self.name}.",
        )

    def get_property(self, dps_id):
        cached_state = self._get_cached_state()
        if dps_id in cached_state:
            return cached_state[dps_id]
        else:
            return None

    def set_property(self, dps_id, value):
        self._set_properties({dps_id: value})

    async def async_set_property(self, dps_id, value):
        await self._hass.async_add_executor_job(self.set_property, dps_id, value)

    def anticipate_property_value(self, dps_id, value):
        """
        Update a value in the cached state only. This is good for when you know the device will reflect a new state in
        the next update, but don't want to wait for that update for the device to represent this state.

        The anticipated value will be cleared with the next update.
        """
        self._cached_state[dps_id] = value

    def _reset_cached_state(self):
        self._cached_state = {"updated_at": 0}
        self._pending_updates = {}

    def _refresh_cached_state(self):
        try:
            self._lock.acquire()
            new_state = self._api.status()
            self._cached_state = new_state["dps"]
            self._cached_state["updated_at"] = time()
            _LOGGER.debug(f"refreshed device state: {json.dumps(new_state)}")
            _LOGGER.debug(
                f"new cache state (including pending properties): {json.dumps(self._get_cached_state())}"
            )
        finally:
            self._lock.release()

    def _set_properties(self, properties):
        if len(properties) == 0:
            return

        self._add_properties_to_pending_updates(properties)
        self._debounce_sending_updates()

    def _add_properties_to_pending_updates(self, properties):
        now = time()
        properties = {**properties, **self._fixed_properties}

        pending_updates = self._get_pending_updates()
        for key, value in properties.items():
            pending_updates[key] = {"value": value, "updated_at": now}

        _LOGGER.debug(f"new pending updates: {json.dumps(self._pending_updates)}")

    def _debounce_sending_updates(self):
        try:
            self._debounce.cancel()
        except AttributeError:
            pass
        self._debounce = Timer(1, self._send_pending_updates)
        self._debounce.start()

    def _send_pending_updates(self):
        pending_properties = self._get_pending_properties()
        payload = self._api.generate_payload("set", pending_properties)

        _LOGGER.debug(f"sending dps update: {json.dumps(pending_properties)}")

        self._retry_on_failed_connection(
            lambda: self._send_payload(payload), "Failed to update device state."
        )

    def _send_payload(self, payload):
        try:
            self._lock.acquire()
            self._api._send_receive(payload)
            self._cached_state["updated_at"] = 0
            now = time()
            pending_updates = self._get_pending_updates()
            for key, value in pending_updates.items():
                pending_updates[key]["updated_at"] = now
        finally:
            self._lock.release()

    def _retry_on_failed_connection(self, func, error_message):
        for i in range(self._CONNECTION_ATTEMPTS):
            try:
                func()
                self._api_protocol_working = True
                break
            except Exception as e:
                _LOGGER.info(f"Retrying after exception {e}")
                if i + 1 == self._CONNECTION_ATTEMPTS:
                    self._reset_cached_state()
                    self._api_protocol_working = False
                    _LOGGER.error(error_message)
                else:
                    self._rotate_api_protocol_version()

    def _get_cached_state(self):
        cached_state = self._cached_state.copy()
        return {**cached_state, **self._get_pending_properties()}

    def _get_pending_properties(self):
        return {key: info["value"] for key, info in self._get_pending_updates().items()}

    def _get_pending_updates(self):
        now = time()
        self._pending_updates = {
            key: value
            for key, value in self._pending_updates.items()
            if now - value["updated_at"] < self._FAKE_IT_TIL_YOU_MAKE_IT_TIMEOUT
        }
        return self._pending_updates

    def _rotate_api_protocol_version(self):
        if self._api_protocol_version_index is None:
            self._api_protocol_version_index = 0
        elif self._api_protocol_working is False:
            self._api_protocol_version_index += 1

        if self._api_protocol_version_index >= len(API_PROTOCOL_VERSIONS):
            self._api_protocol_version_index = 0

        new_version = API_PROTOCOL_VERSIONS[self._api_protocol_version_index]
        _LOGGER.info(f"Setting protocol version for {self.name} to {new_version}.")
        self._api.set_version(new_version)

    @staticmethod
    def get_key_for_value(obj, value, fallback=None):
        keys = list(obj.keys())
        values = list(obj.values())
        return keys[values.index(value)] or fallback