Add shared code to a common module
This commit is contained in:
Pierre Ståhl
@@ -2,8 +2,6 @@
|
||||
import asyncio
|
||||
import logging
|
||||
import voluptuous as vol
|
||||
from time import time, sleep
|
||||
from threading import Lock
|
||||
|
||||
from homeassistant.config_entries import SOURCE_IMPORT, ConfigEntry
|
||||
from homeassistant.core import HomeAssistant
|
||||
@@ -18,9 +16,7 @@ from homeassistant.const import (
|
||||
CONF_ENTITIES,
|
||||
)
|
||||
import homeassistant.helpers.config_validation as cv
|
||||
from homeassistant.helpers.entity import Entity
|
||||
|
||||
from . import pytuya
|
||||
from .const import CONF_LOCAL_KEY, CONF_PROTOCOL_VERSION, DOMAIN
|
||||
|
||||
|
||||
@@ -49,30 +45,6 @@ BASE_PLATFORM_SCHEMA = {
|
||||
}
|
||||
|
||||
|
||||
def prepare_setup_entities(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 = pytuya.TuyaInterface(
|
||||
config_entry.data[CONF_DEVICE_ID],
|
||||
config_entry.data[CONF_HOST],
|
||||
config_entry.data[CONF_LOCAL_KEY],
|
||||
float(config_entry.data[CONF_PROTOCOL_VERSION]),
|
||||
)
|
||||
|
||||
for interface_config in entities_to_setup:
|
||||
# this has to be done in case the device type is type_0d
|
||||
tuyainterface.add_dps_to_request(interface_config[CONF_ID])
|
||||
|
||||
return tuyainterface, entities_to_setup
|
||||
|
||||
|
||||
def import_from_yaml(hass, config, platform):
|
||||
"""Import configuration from YAML."""
|
||||
config[CONF_PLATFORM] = platform
|
||||
@@ -129,153 +101,3 @@ async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry):
|
||||
async def update_listener(hass, config_entry):
|
||||
"""Update listener."""
|
||||
await hass.config_entries.async_reload(config_entry.entry_id)
|
||||
|
||||
|
||||
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:
|
||||
"""Cache wrapper for pytuya.TuyaInterface."""
|
||||
|
||||
def __init__(self, interface, friendly_name):
|
||||
"""Initialize the cache."""
|
||||
self._cached_status = ""
|
||||
self._cached_status_time = 0
|
||||
self._interface = interface
|
||||
self._friendly_name = friendly_name
|
||||
self._lock = Lock()
|
||||
|
||||
@property
|
||||
def unique_id(self):
|
||||
"""Return unique device identifier."""
|
||||
return self._interface.id
|
||||
|
||||
def __get_status(self):
|
||||
_LOGGER.debug("running def __get_status from TuyaDevice")
|
||||
for i in range(5):
|
||||
try:
|
||||
status = self._interface.status()
|
||||
return status
|
||||
except Exception:
|
||||
print(
|
||||
"Failed to update status of device [{}]".format(
|
||||
self._interface.address
|
||||
)
|
||||
)
|
||||
sleep(1.0)
|
||||
if i + 1 == 3:
|
||||
_LOGGER.error(
|
||||
"Failed to update status of device %s", self._interface.address
|
||||
)
|
||||
# return None
|
||||
raise ConnectionError("Failed to update status .")
|
||||
|
||||
def set_dps(self, state, dps_index):
|
||||
# _LOGGER.info("running def set_dps from cover")
|
||||
"""Change the Tuya switch status and clear the cache."""
|
||||
self._cached_status = ""
|
||||
self._cached_status_time = 0
|
||||
for i in range(5):
|
||||
try:
|
||||
return self._interface.set_dps(state, dps_index)
|
||||
except Exception:
|
||||
print(
|
||||
"Failed to set status of device [{}]".format(
|
||||
self._interface.address
|
||||
)
|
||||
)
|
||||
if i + 1 == 3:
|
||||
_LOGGER.error(
|
||||
"Failed to set status of device %s", self._interface.address
|
||||
)
|
||||
return
|
||||
|
||||
# raise ConnectionError("Failed to set status.")
|
||||
|
||||
def status(self):
|
||||
"""Get state of Tuya switch and cache the results."""
|
||||
_LOGGER.debug("running def status(self) from TuyaDevice")
|
||||
self._lock.acquire()
|
||||
try:
|
||||
now = time()
|
||||
if not self._cached_status or now - self._cached_status_time > 15:
|
||||
sleep(0.5)
|
||||
self._cached_status = self.__get_status()
|
||||
self._cached_status_time = time()
|
||||
return self._cached_status
|
||||
finally:
|
||||
self._lock.release()
|
||||
|
||||
|
||||
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._available = False
|
||||
self._dps_id = dps_id
|
||||
self._status = None
|
||||
|
||||
@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._device.unique_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 unique_id(self):
|
||||
"""Return unique device identifier."""
|
||||
return f"local_{self._device.unique_id}_{self._dps_id}"
|
||||
|
||||
@property
|
||||
def available(self):
|
||||
"""Return if device is available or not."""
|
||||
return self._available
|
||||
|
||||
def dps(self, dps_index):
|
||||
"""Return cached value for DPS index."""
|
||||
value = self._status["dps"].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 update(self):
|
||||
"""Update state of Tuya entity."""
|
||||
try:
|
||||
self._status = self._device.status()
|
||||
self.status_updated()
|
||||
except Exception:
|
||||
self._available = False
|
||||
else:
|
||||
self._available = True
|
||||
|
||||
def status_updated(self):
|
||||
"""Device status was updated.
|
||||
|
||||
Override in subclasses and update entity specific state.
|
||||
"""
|
||||
|
||||
194
custom_components/localtuya/common.py
Normal file
194
custom_components/localtuya/common.py
Normal file
@@ -0,0 +1,194 @@
|
||||
"""Code shared between all platforms."""
|
||||
import logging
|
||||
from time import time, sleep
|
||||
from threading import Lock
|
||||
|
||||
from homeassistant.helpers.entity import Entity
|
||||
|
||||
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
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
||||
def prepare_setup_entities(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 = pytuya.TuyaInterface(
|
||||
config_entry.data[CONF_DEVICE_ID],
|
||||
config_entry.data[CONF_HOST],
|
||||
config_entry.data[CONF_LOCAL_KEY],
|
||||
float(config_entry.data[CONF_PROTOCOL_VERSION]),
|
||||
)
|
||||
|
||||
for entity_config in entities_to_setup:
|
||||
# this has to be done in case the device type is type_0d
|
||||
tuyainterface.add_dps_to_request(entity_config[CONF_ID])
|
||||
|
||||
return tuyainterface, entities_to_setup
|
||||
|
||||
|
||||
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:
|
||||
"""Cache wrapper for pytuya.TuyaInterface."""
|
||||
|
||||
def __init__(self, interface, friendly_name):
|
||||
"""Initialize the cache."""
|
||||
self._cached_status = ""
|
||||
self._cached_status_time = 0
|
||||
self._interface = interface
|
||||
self._friendly_name = friendly_name
|
||||
self._lock = Lock()
|
||||
|
||||
@property
|
||||
def unique_id(self):
|
||||
"""Return unique device identifier."""
|
||||
return self._interface.id
|
||||
|
||||
def __get_status(self):
|
||||
_LOGGER.debug("running def __get_status from TuyaDevice")
|
||||
for i in range(5):
|
||||
try:
|
||||
status = self._interface.status()
|
||||
return status
|
||||
except Exception:
|
||||
print(
|
||||
"Failed to update status of device [{}]".format(
|
||||
self._interface.address
|
||||
)
|
||||
)
|
||||
sleep(1.0)
|
||||
if i + 1 == 3:
|
||||
_LOGGER.error(
|
||||
"Failed to update status of device %s", self._interface.address
|
||||
)
|
||||
# return None
|
||||
raise ConnectionError("Failed to update status .")
|
||||
|
||||
def set_dps(self, state, dps_index):
|
||||
# _LOGGER.info("running def set_dps from cover")
|
||||
"""Change the Tuya device status and clear the cache."""
|
||||
self._cached_status = ""
|
||||
self._cached_status_time = 0
|
||||
for i in range(5):
|
||||
try:
|
||||
return self._interface.set_dps(state, dps_index)
|
||||
except Exception:
|
||||
print(
|
||||
"Failed to set status of device [{}]".format(
|
||||
self._interface.address
|
||||
)
|
||||
)
|
||||
if i + 1 == 3:
|
||||
_LOGGER.error(
|
||||
"Failed to set status of device %s", self._interface.address
|
||||
)
|
||||
return
|
||||
|
||||
# raise ConnectionError("Failed to set status.")
|
||||
|
||||
def status(self):
|
||||
"""Get state of Tuya device and cache the results."""
|
||||
_LOGGER.debug("running def status(self) from TuyaDevice")
|
||||
self._lock.acquire()
|
||||
try:
|
||||
now = time()
|
||||
if not self._cached_status or now - self._cached_status_time > 15:
|
||||
sleep(0.5)
|
||||
self._cached_status = self.__get_status()
|
||||
self._cached_status_time = time()
|
||||
return self._cached_status
|
||||
finally:
|
||||
self._lock.release()
|
||||
|
||||
|
||||
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._available = False
|
||||
self._dps_id = dps_id
|
||||
self._status = None
|
||||
|
||||
@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._device.unique_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 unique_id(self):
|
||||
"""Return unique device identifier."""
|
||||
return f"local_{self._device.unique_id}_{self._dps_id}"
|
||||
|
||||
@property
|
||||
def available(self):
|
||||
"""Return if device is available or not."""
|
||||
return self._available
|
||||
|
||||
def dps(self, dps_index):
|
||||
"""Return cached value for DPS index."""
|
||||
value = self._status["dps"].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 update(self):
|
||||
"""Update state of Tuya entity."""
|
||||
try:
|
||||
self._status = self._device.status()
|
||||
self.status_updated()
|
||||
except Exception:
|
||||
self._available = False
|
||||
else:
|
||||
self._available = True
|
||||
|
||||
def status_updated(self):
|
||||
"""Device status was updated.
|
||||
|
||||
Override in subclasses and update entity specific state.
|
||||
"""
|
||||
@@ -38,18 +38,13 @@ from homeassistant.const import (
|
||||
)
|
||||
import homeassistant.helpers.config_validation as cv
|
||||
|
||||
from . import (
|
||||
BASE_PLATFORM_SCHEMA,
|
||||
TuyaDevice,
|
||||
LocalTuyaEntity,
|
||||
prepare_setup_entities,
|
||||
import_from_yaml,
|
||||
)
|
||||
from . import BASE_PLATFORM_SCHEMA, import_from_yaml
|
||||
from .const import (
|
||||
CONF_OPEN_CMD,
|
||||
CONF_CLOSE_CMD,
|
||||
CONF_STOP_CMD,
|
||||
)
|
||||
from .common import LocalTuyaEntity, TuyaDevice, prepare_setup_entities
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
||||
@@ -31,11 +31,9 @@ from homeassistant.const import CONF_ID, CONF_FRIENDLY_NAME
|
||||
|
||||
from . import (
|
||||
BASE_PLATFORM_SCHEMA,
|
||||
TuyaDevice,
|
||||
LocalTuyaEntity,
|
||||
prepare_setup_entities,
|
||||
import_from_yaml,
|
||||
)
|
||||
from .common import LocalTuyaEntity, TuyaDevice, prepare_setup_entities
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
||||
@@ -30,11 +30,10 @@ from homeassistant.components.light import (
|
||||
|
||||
from . import (
|
||||
BASE_PLATFORM_SCHEMA,
|
||||
TuyaDevice,
|
||||
LocalTuyaEntity,
|
||||
import_from_yaml,
|
||||
prepare_setup_entities,
|
||||
)
|
||||
from .common import LocalTuyaEntity, TuyaDevice, prepare_setup_entities
|
||||
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
||||
@@ -29,12 +29,10 @@ from homeassistant.const import (
|
||||
|
||||
from . import (
|
||||
BASE_PLATFORM_SCHEMA,
|
||||
TuyaDevice,
|
||||
LocalTuyaEntity,
|
||||
prepare_setup_entities,
|
||||
import_from_yaml,
|
||||
)
|
||||
from .const import CONF_SCALING
|
||||
from .common import LocalTuyaEntity, TuyaDevice, prepare_setup_entities
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
||||
@@ -43,9 +43,6 @@ import homeassistant.helpers.config_validation as cv
|
||||
|
||||
from . import (
|
||||
BASE_PLATFORM_SCHEMA,
|
||||
TuyaDevice,
|
||||
LocalTuyaEntity,
|
||||
prepare_setup_entities,
|
||||
import_from_yaml,
|
||||
)
|
||||
from .const import (
|
||||
@@ -56,6 +53,7 @@ from .const import (
|
||||
CONF_CURRENT_CONSUMPTION,
|
||||
CONF_VOLTAGE,
|
||||
)
|
||||
from .common import LocalTuyaEntity, TuyaDevice, prepare_setup_entities
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user