280 lines
7.9 KiB
Python
280 lines
7.9 KiB
Python
"""
|
|
Simple platform to control LOCALLY Tuya switch devices.
|
|
|
|
Sample config yaml
|
|
|
|
switch:
|
|
- platform: localtuya
|
|
host: 192.168.0.1
|
|
local_key: 1234567891234567
|
|
device_id: 12345678912345671234
|
|
name: tuya_01
|
|
friendly_name: tuya_01
|
|
protocol_version: 3.3
|
|
switches:
|
|
sw01:
|
|
name: main_plug
|
|
friendly_name: Main Plug
|
|
id: 1
|
|
current: 18
|
|
current_consumption: 19
|
|
voltage: 20
|
|
sw02:
|
|
name: usb_plug
|
|
friendly_name: USB Plug
|
|
id: 7
|
|
"""
|
|
import logging
|
|
from time import time, sleep
|
|
from threading import Lock
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.switch import (
|
|
SwitchEntity,
|
|
PLATFORM_SCHEMA,
|
|
)
|
|
from homeassistant.const import (
|
|
CONF_ID,
|
|
CONF_SWITCHES,
|
|
CONF_FRIENDLY_NAME,
|
|
CONF_NAME,
|
|
)
|
|
import homeassistant.helpers.config_validation as cv
|
|
|
|
from . import BASE_PLATFORM_SCHEMA, prepare_setup_entities, import_from_yaml
|
|
from .const import (
|
|
ATTR_CURRENT,
|
|
ATTR_CURRENT_CONSUMPTION,
|
|
ATTR_VOLTAGE,
|
|
CONF_CURRENT,
|
|
CONF_CURRENT_CONSUMPTION,
|
|
CONF_VOLTAGE,
|
|
)
|
|
from .pytuya import TuyaDevice
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
PLATFORM = "switch"
|
|
|
|
DEFAULT_ID = "1"
|
|
|
|
# TODO: This will eventully merge with flow_schema
|
|
SWITCH_SCHEMA = vol.Schema(
|
|
{
|
|
vol.Optional(CONF_ID, default=DEFAULT_ID): cv.string,
|
|
vol.Optional(CONF_NAME): cv.string, # Deprecated: not used
|
|
vol.Required(CONF_FRIENDLY_NAME): cv.string,
|
|
vol.Optional(CONF_CURRENT, default="-1"): cv.string,
|
|
vol.Optional(CONF_CURRENT_CONSUMPTION, default="-1"): cv.string,
|
|
vol.Optional(CONF_VOLTAGE, default="-1"): cv.string,
|
|
}
|
|
)
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(BASE_PLATFORM_SCHEMA).extend(
|
|
{
|
|
vol.Optional(CONF_CURRENT, default="-1"): cv.string,
|
|
vol.Optional(CONF_CURRENT_CONSUMPTION, default="-1"): cv.string,
|
|
vol.Optional(CONF_VOLTAGE, default="-1"): cv.string,
|
|
vol.Optional(CONF_SWITCHES, default={}): vol.Schema({cv.slug: SWITCH_SCHEMA}),
|
|
}
|
|
)
|
|
|
|
|
|
def flow_schema(dps):
|
|
"""Return schema used in config flow."""
|
|
return {
|
|
vol.Optional(CONF_CURRENT): vol.In(dps),
|
|
vol.Optional(CONF_CURRENT_CONSUMPTION): vol.In(dps),
|
|
vol.Optional(CONF_VOLTAGE): vol.In(dps),
|
|
}
|
|
|
|
|
|
async def async_setup_entry(hass, config_entry, async_add_entities):
|
|
"""Setup a Tuya switch based on a config entry."""
|
|
device, entities_to_setup = prepare_setup_entities(
|
|
config_entry, PLATFORM
|
|
)
|
|
if not entities_to_setup:
|
|
return
|
|
|
|
switches = []
|
|
for device_config in entities_to_setup:
|
|
switches.append(
|
|
LocaltuyaSwitch(
|
|
TuyaCache(device),
|
|
device_config[CONF_FRIENDLY_NAME],
|
|
device_config[CONF_ID],
|
|
device_config.get(CONF_CURRENT),
|
|
device_config.get(CONF_CURRENT_CONSUMPTION),
|
|
device_config.get(CONF_VOLTAGE),
|
|
)
|
|
)
|
|
|
|
async_add_entities(switches, True)
|
|
|
|
|
|
def setup_platform(hass, config, add_devices, discovery_info=None):
|
|
"""Set up of the Tuya switch."""
|
|
return import_from_yaml(hass, config, PLATFORM)
|
|
|
|
|
|
class TuyaCache:
|
|
"""Cache wrapper for pytuya.TuyaDevice"""
|
|
|
|
def __init__(self, device):
|
|
"""Initialize the cache."""
|
|
self._cached_status = ""
|
|
self._cached_status_time = 0
|
|
self._device = device
|
|
self._lock = Lock()
|
|
|
|
@property
|
|
def unique_id(self):
|
|
"""Return unique device identifier."""
|
|
return self._device.id
|
|
|
|
def __get_status(self):
|
|
for i in range(5):
|
|
try:
|
|
status = self._device.status()
|
|
return status
|
|
except Exception:
|
|
print(
|
|
"Failed to update status of device [{}]".format(
|
|
self._device.address
|
|
)
|
|
)
|
|
sleep(1.0)
|
|
if i + 1 == 3:
|
|
_LOGGER.error(
|
|
"Failed to update status of device %s", self._device.address
|
|
)
|
|
# return None
|
|
raise ConnectionError("Failed to update status .")
|
|
|
|
def set_dps(self, state, dps_index):
|
|
"""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._device.set_dps(state, dps_index)
|
|
except Exception:
|
|
print(
|
|
"Failed to set status of device [{}]".format(self._device.address)
|
|
)
|
|
if i + 1 == 3:
|
|
_LOGGER.error(
|
|
"Failed to set status of device %s", self._device.address
|
|
)
|
|
return
|
|
|
|
# raise ConnectionError("Failed to set status.")
|
|
|
|
def status(self):
|
|
"""Get state of Tuya switch and cache the results."""
|
|
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 LocaltuyaSwitch(SwitchEntity):
|
|
"""Representation of a Tuya switch."""
|
|
|
|
def __init__(
|
|
self,
|
|
device,
|
|
friendly_name,
|
|
switchid,
|
|
attr_current,
|
|
attr_consumption,
|
|
attr_voltage,
|
|
):
|
|
"""Initialize the Tuya switch."""
|
|
self._device = device
|
|
self._name = friendly_name
|
|
self._available = False
|
|
self._switch_id = switchid
|
|
self._attr_current = attr_current
|
|
self._attr_consumption = attr_consumption
|
|
self._attr_voltage = attr_voltage
|
|
self._status = None
|
|
self._state = None
|
|
print(
|
|
"Initialized tuya switch [{}] with switch status [{}] and state [{}]".format(
|
|
self._name, self._status, self._state
|
|
)
|
|
)
|
|
|
|
@property
|
|
def device_info(self):
|
|
return {
|
|
"identifiers": {
|
|
# Serial numbers are unique identifiers within a specific domain
|
|
("LocalTuya", f"local_{self._device.unique_id}")
|
|
},
|
|
"name": self._device._device.friendly_name,
|
|
"manufacturer": "Tuya generic",
|
|
"model": "SmartSwitch",
|
|
"sw_version": "3.3",
|
|
}
|
|
|
|
@property
|
|
def name(self):
|
|
"""Get name of Tuya switch."""
|
|
return self._name
|
|
|
|
@property
|
|
def unique_id(self):
|
|
"""Return unique device identifier."""
|
|
return f"local_{self._device.unique_id}_{self._switch_id}"
|
|
|
|
@property
|
|
def available(self):
|
|
"""Return if device is available or not."""
|
|
return self._available
|
|
|
|
@property
|
|
def is_on(self):
|
|
"""Check if Tuya switch is on."""
|
|
return self._state
|
|
|
|
@property
|
|
def device_state_attributes(self):
|
|
attrs = {}
|
|
if self._attr_current:
|
|
attrs[ATTR_CURRENT] = self._status["dps"][self._attr_current]
|
|
if self._attr_consumption:
|
|
attrs[ATTR_CURRENT_CONSUMPTION] = (
|
|
self._status["dps"][self._attr_consumption] / 10
|
|
)
|
|
if self._attr_voltage:
|
|
attrs[ATTR_VOLTAGE] = self._status["dps"][self._attr_voltage] / 10
|
|
return attrs
|
|
|
|
def turn_on(self, **kwargs):
|
|
"""Turn Tuya switch on."""
|
|
self._device.set_dps(True, self._switch_id)
|
|
|
|
def turn_off(self, **kwargs):
|
|
"""Turn Tuya switch off."""
|
|
self._device.set_dps(False, self._switch_id)
|
|
|
|
def update(self):
|
|
"""Get state of Tuya switch."""
|
|
try:
|
|
self._status = self._device.status()
|
|
self._state = self._status["dps"][self._switch_id]
|
|
except Exception:
|
|
self._available = False
|
|
else:
|
|
self._available = True
|