346 lines
11 KiB
Python
346 lines
11 KiB
Python
"""
|
|
Simple platform to locally control Tuya-based cover devices.
|
|
|
|
Sample config yaml:
|
|
|
|
cover:
|
|
- platform: localtuya #REQUIRED
|
|
host: 192.168.0.123 #REQUIRED
|
|
local_key: 1234567891234567 #REQUIRED
|
|
device_id: 123456789123456789abcd #REQUIRED
|
|
name: cover_guests #REQUIRED
|
|
friendly_name: Cover guests #REQUIRED
|
|
protocol_version: 3.3 #REQUIRED
|
|
id: 1 #OPTIONAL
|
|
icon: mdi:blinds #OPTIONAL
|
|
open_cmd: open #OPTIONAL, default is 'on'
|
|
close_cmd: close #OPTIONAL, default is 'off'
|
|
stop_cmd: stop #OPTIONAL, default is 'stop'
|
|
|
|
"""
|
|
import logging
|
|
from time import time, sleep
|
|
from threading import Lock
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.cover import (
|
|
CoverEntity,
|
|
PLATFORM_SCHEMA,
|
|
SUPPORT_CLOSE,
|
|
SUPPORT_OPEN,
|
|
SUPPORT_STOP,
|
|
SUPPORT_SET_POSITION,
|
|
)
|
|
from homeassistant.const import (
|
|
CONF_ID,
|
|
CONF_FRIENDLY_NAME,
|
|
)
|
|
import homeassistant.helpers.config_validation as cv
|
|
|
|
from . import BASE_PLATFORM_SCHEMA, prepare_setup_entities, import_from_yaml
|
|
from .const import CONF_OPEN_CMD, CONF_CLOSE_CMD, CONF_STOP_CMD
|
|
from .pytuya import TuyaDevice
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
PLATFORM = "cover"
|
|
|
|
DEFAULT_OPEN_CMD = "on"
|
|
DEFAULT_CLOSE_CMD = "off"
|
|
DEFAULT_STOP_CMD = "stop"
|
|
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(BASE_PLATFORM_SCHEMA).extend(
|
|
{
|
|
vol.Optional(CONF_OPEN_CMD, default=DEFAULT_OPEN_CMD): cv.string,
|
|
vol.Optional(CONF_CLOSE_CMD, default=DEFAULT_CLOSE_CMD): cv.string,
|
|
vol.Optional(CONF_STOP_CMD, default=DEFAULT_STOP_CMD): cv.string,
|
|
}
|
|
)
|
|
|
|
|
|
def flow_schema(dps):
|
|
"""Return schema used in config flow."""
|
|
return {
|
|
vol.Optional(CONF_OPEN_CMD, default=DEFAULT_OPEN_CMD): str,
|
|
vol.Optional(CONF_CLOSE_CMD, default=DEFAULT_CLOSE_CMD): str,
|
|
vol.Optional(CONF_STOP_CMD, default=DEFAULT_STOP_CMD): str,
|
|
}
|
|
|
|
|
|
async def async_setup_entry(hass, config_entry, async_add_entities):
|
|
"""Setup a Tuya cover based on a config entry."""
|
|
device, entities_to_setup = prepare_setup_entities(
|
|
config_entry, PLATFORM
|
|
)
|
|
if not entities_to_setup:
|
|
return
|
|
|
|
# TODO: keeping for now but should be removed
|
|
dps = {}
|
|
|
|
covers = []
|
|
for device_config in entities_to_setup:
|
|
dps[device_config[CONF_ID]] = None
|
|
covers.append(
|
|
LocaltuyaCover(
|
|
TuyaCache(device),
|
|
device_config[CONF_FRIENDLY_NAME],
|
|
device_config[CONF_ID],
|
|
device_config.get(CONF_OPEN_CMD),
|
|
device_config.get(CONF_CLOSE_CMD),
|
|
device_config.get(CONF_STOP_CMD),
|
|
)
|
|
# print('Setup localtuya cover [{}] with device ID [{}] '.format(config.get(CONF_FRIENDLY_NAME), config.get(CONF_ID)))
|
|
# _LOGGER.info("Setup localtuya cover %s with device ID=%s", config.get(CONF_FRIENDLY_NAME), config.get(CONF_ID) )
|
|
# _LOGGER.debug("Cover %s uses open_cmd=%s close_cmd=%s stop_cmd=%s", config.get(CONF_FRIENDLY_NAME), config.get(CONF_OPEN_CMD), config.get(CONF_CLOSE_CMD), config.get(CONF_STOP_CMD) )
|
|
)
|
|
|
|
device.set_dpsUsed(dps)
|
|
async_add_entities(covers, True)
|
|
|
|
def setup_platform(hass, config, add_devices, discovery_info=None):
|
|
"""Set up of the Tuya cover."""
|
|
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):
|
|
# _LOGGER.info("running def __get_status from cover")
|
|
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):
|
|
#_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:
|
|
#_LOGGER.info("Running a try from def set_dps from cover where state=%s and dps_index=%s", state, dps_index)
|
|
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."""
|
|
# _LOGGER.info("running def status(self) from cover")
|
|
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 LocaltuyaCover(CoverEntity):
|
|
"""Tuya cover devices."""
|
|
|
|
def __init__(self, device, friendly_name, switchid, open_cmd, close_cmd, stop_cmd):
|
|
self._device = device
|
|
self._available = False
|
|
self._name = friendly_name
|
|
self._switch_id = switchid
|
|
self._status = None
|
|
self._state = None
|
|
self._position = 50
|
|
self._open_cmd = open_cmd
|
|
self._close_cmd = close_cmd
|
|
self._stop_cmd = stop_cmd
|
|
#_LOGGER.info("running def __init__ of LocaltuyaCover(CoverEntity) with self=%s device=%s name=%s friendly_name=%s icon=%s switchid=%s open_cmd=%s close_cmd=%s stop_cmd=%s", self, device, name, friendly_name, icon, switchid, open_cmd, close_cmd, stop_cmd)
|
|
print(
|
|
"Initialized tuya cover [{}] 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": "SmartCover",
|
|
"sw_version": "3.3",
|
|
}
|
|
|
|
@property
|
|
def unique_id(self):
|
|
"""Return unique device identifier."""
|
|
return f"local_{self._device.unique_id}_{self._switch_id}"
|
|
|
|
@property
|
|
def name(self):
|
|
"""Get name of Tuya switch."""
|
|
return self._name
|
|
|
|
@property
|
|
def open_cmd(self):
|
|
"""Get name of open command."""
|
|
return self._open_cmd
|
|
|
|
@property
|
|
def close_cmd(self):
|
|
"""Get name of close command."""
|
|
return self._close_cmd
|
|
|
|
@property
|
|
def stop_cmd(self):
|
|
"""Get name of stop command."""
|
|
return self._stop_cmd
|
|
|
|
@property
|
|
def available(self):
|
|
"""Return if device is available or not."""
|
|
return self._available
|
|
|
|
@property
|
|
def supported_features(self):
|
|
"""Flag supported features."""
|
|
supported_features = (
|
|
SUPPORT_OPEN | SUPPORT_CLOSE | SUPPORT_STOP | SUPPORT_SET_POSITION
|
|
)
|
|
return supported_features
|
|
|
|
@property
|
|
def current_cover_position(self):
|
|
# self.update()
|
|
# state = self._state
|
|
# _LOGGER.info("curr_pos() : %i", self._position)
|
|
# print('curr_pos() : state [{}]'.format(state))
|
|
return self._position
|
|
|
|
@property
|
|
def is_opening(self):
|
|
# self.update()
|
|
state = self._state
|
|
# print('is_opening() : state [{}]'.format(state))
|
|
if state == "on":
|
|
return True
|
|
return False
|
|
|
|
@property
|
|
def is_closing(self):
|
|
# self.update()
|
|
state = self._state
|
|
# print('is_closing() : state [{}]'.format(state))
|
|
if state == "off":
|
|
return True
|
|
return False
|
|
|
|
@property
|
|
def is_closed(self):
|
|
"""Return if the cover is closed or not."""
|
|
# _LOGGER.info("running is_closed from cover")
|
|
# self.update()
|
|
state = self._state
|
|
# print('is_closed() : state [{}]'.format(state))
|
|
if state == "off":
|
|
return False
|
|
if state == "on":
|
|
return True
|
|
return None
|
|
|
|
def set_cover_position(self, **kwargs):
|
|
# _LOGGER.info("running set_cover_position from cover")
|
|
"""Move the cover to a specific position."""
|
|
|
|
newpos = float(kwargs["position"])
|
|
# _LOGGER.info("Set new pos: %f", newpos)
|
|
|
|
currpos = self.current_cover_position
|
|
posdiff = abs(newpos - currpos)
|
|
# 25 sec corrisponde alla chiusura/apertura completa
|
|
mydelay = posdiff / 2.0
|
|
if newpos > currpos:
|
|
# _LOGGER.info("Opening to %f: delay %f", newpos, mydelay )
|
|
self.open_cover()
|
|
else:
|
|
# _LOGGER.info("Closing to %f: delay %f", newpos, mydelay )
|
|
self.close_cover()
|
|
sleep(mydelay)
|
|
self.stop_cover()
|
|
self._position = 50 # newpos
|
|
|
|
# self._state = 'on'
|
|
# self._device._device.open_cover()
|
|
|
|
def open_cover(self, **kwargs):
|
|
"""Open the cover."""
|
|
#_LOGGER.info("running open_cover from cover")
|
|
self._device.set_dps(self._open_cmd, self._switch_id)
|
|
# self._state = 'on'
|
|
# self._device._device.open_cover()
|
|
|
|
def close_cover(self, **kwargs):
|
|
# _LOGGER.info("running close_cover from cover")
|
|
"""Close cover."""
|
|
#_LOGGER.info('about to set_dps from cover of off, %s', self._switch_id)
|
|
self._device.set_dps(self._close_cmd, self._switch_id)
|
|
# self._state = 'off'
|
|
# self._device._device.close_cover()
|
|
|
|
def stop_cover(self, **kwargs):
|
|
# _LOGGER.info("running stop_cover from cover")
|
|
"""Stop the cover."""
|
|
self._device.set_dps(self._stop_cmd, self._switch_id)
|
|
# self._state = 'stop'
|
|
# self._device._device.stop_cover()
|
|
|
|
def update(self):
|
|
"""Get state of Tuya switch."""
|
|
# _LOGGER.info("running update(self) from cover")
|
|
try:
|
|
self._status = self._device.status()
|
|
self._state = self._status["dps"][self._switch_id]
|
|
# print('update() : state [{}]'.format(self._state))
|
|
except Exception:
|
|
self._available = False
|
|
else:
|
|
self._available = True
|