303 lines
9.5 KiB
Python
303 lines
9.5 KiB
Python
"""Code shared between all platforms."""
|
|
import asyncio
|
|
import logging
|
|
from random import randrange
|
|
|
|
from homeassistant.core import callback
|
|
from homeassistant.helpers.entity import Entity
|
|
from homeassistant.helpers.dispatcher import (
|
|
async_dispatcher_connect,
|
|
async_dispatcher_send,
|
|
)
|
|
|
|
from homeassistant.const import (
|
|
CONF_DEVICE_ID,
|
|
CONF_ID,
|
|
CONF_FRIENDLY_NAME,
|
|
CONF_HOST,
|
|
CONF_PLATFORM,
|
|
CONF_ENTITIES,
|
|
)
|
|
|
|
from . import pytuya
|
|
from .const import CONF_LOCAL_KEY, CONF_PROTOCOL_VERSION, DOMAIN, TUYA_DEVICE
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
BACKOFF_TIME_UPPER_LIMIT = 300 # Five minutes
|
|
|
|
|
|
def prepare_setup_entities(hass, config_entry, platform):
|
|
"""Prepare ro setup entities for a platform."""
|
|
entities_to_setup = [
|
|
entity
|
|
for entity in config_entry.data[CONF_ENTITIES]
|
|
if entity[CONF_PLATFORM] == platform
|
|
]
|
|
if not entities_to_setup:
|
|
return None, None
|
|
|
|
tuyainterface = hass.data[DOMAIN][config_entry.entry_id][TUYA_DEVICE]
|
|
|
|
return tuyainterface, entities_to_setup
|
|
|
|
|
|
async def async_setup_entry(
|
|
domain, entity_class, flow_schema, hass, config_entry, async_add_entities
|
|
):
|
|
"""Set up a Tuya platform based on a config entry.
|
|
|
|
This is a generic method and each platform should lock domain and
|
|
entity_class with functools.partial.
|
|
"""
|
|
tuyainterface, entities_to_setup = prepare_setup_entities(
|
|
hass, config_entry, domain
|
|
)
|
|
if not entities_to_setup:
|
|
return
|
|
|
|
dps_config_fields = list(get_dps_for_platform(flow_schema))
|
|
|
|
entities = []
|
|
for device_config in entities_to_setup:
|
|
# Add DPS used by this platform to the request list
|
|
for dp_conf in dps_config_fields:
|
|
if dp_conf in device_config:
|
|
tuyainterface._dps_to_request[device_config[dp_conf]] = None
|
|
|
|
entities.append(
|
|
entity_class(
|
|
tuyainterface,
|
|
config_entry,
|
|
device_config[CONF_ID],
|
|
)
|
|
)
|
|
|
|
async_add_entities(entities)
|
|
|
|
|
|
def get_dps_for_platform(flow_schema):
|
|
"""Return config keys for all platform keys that depends on a datapoint."""
|
|
for key, value in flow_schema(None).items():
|
|
if hasattr(value, "container") and value.container is None:
|
|
yield key.schema
|
|
|
|
|
|
def get_entity_config(config_entry, dps_id):
|
|
"""Return entity config for a given DPS id."""
|
|
for entity in config_entry.data[CONF_ENTITIES]:
|
|
if entity[CONF_ID] == dps_id:
|
|
return entity
|
|
raise Exception(f"missing entity config for id {dps_id}")
|
|
|
|
|
|
class TuyaDevice(pytuya.TuyaListener):
|
|
"""Cache wrapper for pytuya.TuyaInterface."""
|
|
|
|
def __init__(self, hass, config_entry):
|
|
"""Initialize the cache."""
|
|
self._hass = hass
|
|
self._config_entry = config_entry
|
|
self._interface = None
|
|
self._status = {}
|
|
self._dps_to_request = {}
|
|
self._is_closing = False
|
|
self._connect_task = None
|
|
self._connection_attempts = 0
|
|
|
|
# This has to be done in case the device type is type_0d
|
|
for entity in config_entry[CONF_ENTITIES]:
|
|
self._dps_to_request[entity[CONF_ID]] = None
|
|
|
|
def connect(self):
|
|
"""Connet to device if not already connected."""
|
|
if not self._is_closing and self._connect_task is None and not self._interface:
|
|
_LOGGER.debug(
|
|
"Connecting to %s (%s)",
|
|
self._config_entry[CONF_HOST],
|
|
self._config_entry[CONF_DEVICE_ID],
|
|
)
|
|
self._connect_task = asyncio.ensure_future(self._make_connection())
|
|
else:
|
|
_LOGGER.debug(
|
|
"Already connecting to %s (%s) - %s, %s, %s",
|
|
self._config_entry[CONF_HOST],
|
|
self._config_entry[CONF_DEVICE_ID],
|
|
self._is_closing,
|
|
self._connect_task,
|
|
self._interface,
|
|
)
|
|
|
|
async def _make_connection(self):
|
|
backoff = min(
|
|
randrange(2 ** self._connection_attempts), BACKOFF_TIME_UPPER_LIMIT
|
|
)
|
|
|
|
_LOGGER.debug("Waiting %d seconds before connecting", backoff)
|
|
await asyncio.sleep(backoff)
|
|
|
|
try:
|
|
_LOGGER.debug("Connecting to %s", self._config_entry[CONF_HOST])
|
|
self._interface = await pytuya.connect(
|
|
self._config_entry[CONF_HOST],
|
|
self._config_entry[CONF_DEVICE_ID],
|
|
self._config_entry[CONF_LOCAL_KEY],
|
|
float(self._config_entry[CONF_PROTOCOL_VERSION]),
|
|
self,
|
|
)
|
|
self._interface.add_dps_to_request(self._dps_to_request)
|
|
|
|
_LOGGER.debug("Retrieving initial state")
|
|
status = await self._interface.status()
|
|
if status is None:
|
|
raise Exception("failed to retrieve status")
|
|
|
|
self.status_updated(status)
|
|
self._connection_attempts = 0
|
|
except Exception:
|
|
_LOGGER.exception("connect failed")
|
|
self._connection_attempts += 1
|
|
if self._interface is not None:
|
|
self._interface.close()
|
|
self._interface = None
|
|
self._hass.loop.call_soon(self.connect)
|
|
self._connect_task = None
|
|
|
|
def close(self):
|
|
"""Close connection and stop re-connect loop."""
|
|
self._is_closing = True
|
|
if self._connect_task:
|
|
self._connect_task.cancel()
|
|
if self._interface:
|
|
self._interface.close()
|
|
|
|
async def set_dps(self, state, dps_index):
|
|
"""Change value of a DP of the Tuya device."""
|
|
if self._interface is not None:
|
|
try:
|
|
await self._interface.set_dps(state, dps_index)
|
|
except Exception:
|
|
_LOGGER.exception("Failed to set DP %d to %d", dps_index, state)
|
|
else:
|
|
_LOGGER.error(
|
|
"Not connected to device %s", self._config_entry[CONF_FRIENDLY_NAME]
|
|
)
|
|
|
|
@callback
|
|
def status_updated(self, status):
|
|
"""Device updated status."""
|
|
if "dps" in status:
|
|
self._status.update(status["dps"])
|
|
|
|
signal = f"localtuya_{self._config_entry[CONF_DEVICE_ID]}"
|
|
async_dispatcher_send(self._hass, signal, self._status)
|
|
|
|
@callback
|
|
def disconnected(self, exc):
|
|
"""Device disconnected."""
|
|
_LOGGER.debug(
|
|
"Disconnected from %s: %s", self._config_entry[CONF_DEVICE_ID], exc
|
|
)
|
|
|
|
signal = f"localtuya_{self._config_entry[CONF_DEVICE_ID]}"
|
|
async_dispatcher_send(self._hass, signal, None)
|
|
|
|
self._interface = None
|
|
self.connect()
|
|
|
|
|
|
class LocalTuyaEntity(Entity):
|
|
"""Representation of a Tuya entity."""
|
|
|
|
def __init__(self, device, config_entry, dps_id, **kwargs):
|
|
"""Initialize the Tuya entity."""
|
|
self._device = device
|
|
self._config_entry = config_entry
|
|
self._config = get_entity_config(config_entry, dps_id)
|
|
self._dps_id = dps_id
|
|
self._status = {}
|
|
|
|
async def async_added_to_hass(self):
|
|
"""Subscribe localtuya events."""
|
|
await super().async_added_to_hass()
|
|
|
|
def _update_handler(status):
|
|
"""Update entity state when status was updated."""
|
|
if status is not None:
|
|
self._status = status
|
|
self.status_updated()
|
|
else:
|
|
self._status = {}
|
|
|
|
self.schedule_update_ha_state()
|
|
|
|
signal = f"localtuya_{self._config_entry.data[CONF_DEVICE_ID]}"
|
|
self.async_on_remove(
|
|
async_dispatcher_connect(self.hass, signal, _update_handler)
|
|
)
|
|
|
|
@property
|
|
def device_info(self):
|
|
"""Return device information for the device registry."""
|
|
return {
|
|
"identifiers": {
|
|
# Serial numbers are unique identifiers within a specific domain
|
|
(DOMAIN, f"local_{self._config_entry.data[CONF_DEVICE_ID]}")
|
|
},
|
|
"name": self._config_entry.data[CONF_FRIENDLY_NAME],
|
|
"manufacturer": "Unknown",
|
|
"model": "Tuya generic",
|
|
"sw_version": self._config_entry.data[CONF_PROTOCOL_VERSION],
|
|
}
|
|
|
|
@property
|
|
def name(self):
|
|
"""Get name of Tuya entity."""
|
|
return self._config[CONF_FRIENDLY_NAME]
|
|
|
|
@property
|
|
def should_poll(self):
|
|
"""Return if platform should poll for updates."""
|
|
return False
|
|
|
|
@property
|
|
def unique_id(self):
|
|
"""Return unique device identifier."""
|
|
return f"local_{self._config_entry.data[CONF_DEVICE_ID]}_{self._dps_id}"
|
|
|
|
def has_config(self, attr):
|
|
"""Return if a config parameter has a valid value."""
|
|
value = self._config.get(attr, "-1")
|
|
return value is not None and value != "-1"
|
|
|
|
@property
|
|
def available(self):
|
|
"""Return if device is available or not."""
|
|
return str(self._dps_id) in self._status
|
|
|
|
def dps(self, dps_index):
|
|
"""Return cached value for DPS index."""
|
|
value = self._status.get(str(dps_index))
|
|
if value is None:
|
|
_LOGGER.warning(
|
|
"Entity %s is requesting unknown DPS index %s",
|
|
self.entity_id,
|
|
dps_index,
|
|
)
|
|
|
|
return value
|
|
|
|
def dps_conf(self, conf_item):
|
|
"""Return value of datapoint for user specified config item.
|
|
|
|
This method looks up which DP a certain config item uses based on
|
|
user configuration and returns its value.
|
|
"""
|
|
return self.dps(self._config.get(conf_item))
|
|
|
|
def status_updated(self):
|
|
"""Device status was updated.
|
|
|
|
Override in subclasses and update entity specific state.
|
|
"""
|