Introduced cover support

This commit is contained in:
root
2020-03-23 10:15:26 +01:00
parent 161e0d9bfb
commit 1d9b5eb07a
4 changed files with 1322 additions and 697 deletions

View File

@@ -0,0 +1,208 @@
"""
Simple platform to control LOCALLY Tuya cover devices.
Sample config yaml
switch:
- platform: localtuya
host: 192.168.0.123
local_key: 1234567891234567
device_id: 123456789123456789abcd
name: Cover guests
protocol_version: 3.3
id: 1
"""
import logging
import requests
import voluptuous as vol
from homeassistant.components.cover import (
CoverDevice,
PLATFORM_SCHEMA,
SUPPORT_CLOSE,
SUPPORT_OPEN,
SUPPORT_STOP,
)
"""from . import DATA_TUYA, TuyaDevice"""
"""from homeassistant.components.cover import CoverDevice, PLATFORM_SCHEMA"""
from homeassistant.const import (CONF_HOST, CONF_ID, CONF_FRIENDLY_NAME, CONF_ICON, CONF_NAME)
import homeassistant.helpers.config_validation as cv
from time import time, sleep
from threading import Lock
_LOGGER = logging.getLogger(__name__)
DEFAULT_NAME = 'localtuyacover'
REQUIREMENTS = ['pytuya==7.0.7']
CONF_DEVICE_ID = 'device_id'
CONF_LOCAL_KEY = 'local_key'
CONF_PROTOCOL_VERSION = 'protocol_version'
DEFAULT_ID = '1'
DEFAULT_PROTOCOL_VERSION = 3.3
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
vol.Optional(CONF_ICON): cv.icon,
vol.Required(CONF_HOST): cv.string,
vol.Required(CONF_DEVICE_ID): cv.string,
vol.Required(CONF_LOCAL_KEY): cv.string,
vol.Required(CONF_NAME): cv.string,
vol.Required(CONF_PROTOCOL_VERSION, default=DEFAULT_PROTOCOL_VERSION): vol.Coerce(float),
vol.Optional(CONF_ID, default=DEFAULT_ID): cv.string,
})
def setup_platform(hass, config, add_entities, discovery_info=None):
"""Set up Tuya cover devices."""
from . import pytuya
covers = []
localtuyadevice = pytuya.CoverDevice(config.get(CONF_DEVICE_ID), config.get(CONF_HOST), config.get(CONF_LOCAL_KEY))
localtuyadevice.set_version(float(config.get(CONF_PROTOCOL_VERSION)))
cover_device = TuyaCoverCache(localtuyadevice)
covers.append(
TuyaDevice(
cover_device,
config.get(CONF_NAME),
config.get(CONF_ICON),
config.get(CONF_ID),
)
)
print('Setup localtuya cover [{}] with device ID [{}] '.format(config.get(CONF_NAME), config.get(CONF_ID)))
add_entities(covers)
class TuyaCoverCache:
"""Cache wrapper for pytuya.CoverDevice"""
def __init__(self, device):
"""Initialize the cache."""
self._cached_status = ''
self._cached_status_time = 0
self._device = device
self._lock = Lock()
def __get_status(self):
for i in range(20):
try:
status = self._device.status()
return status
except ConnectionError:
if i+1 == 3:
raise ConnectionError("Failed to update status.")
def set_status(self, state, switchid):
"""Change the Tuya switch status and clear the cache."""
self._cached_status = ''
self._cached_status_time = 0
for i in range(20):
try:
return self._device.set_status(state, switchid)
except ConnectionError:
if i+1 == 5:
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 > 30:
sleep(0.5)
self._cached_status = self.__get_status()
self._cached_status_time = time()
return self._cached_status
finally:
self._lock.release()
class TuyaDevice(CoverDevice):
"""Tuya cover devices."""
def __init__(self, device, name, icon, switchid):
self._device = device
self._name = name
self._icon = icon
self._switch_id = switchid
#self.entity_id = ENTITY_ID_FORMAT.format(_device.object_id())
self._status = self._device.status()
self._state = self._status['dps'][self._switch_id]
print('Initialized tuya cover [{}] with switch status [{}] and state [{}]'.format(self._name, self._status, self._state))
@property
def name(self):
"""Get name of Tuya switch."""
return self._name
@property
def supported_features(self):
"""Flag supported features."""
supported_features = SUPPORT_OPEN | SUPPORT_CLOSE | SUPPORT_STOP
return supported_features
@property
def icon(self):
"""Return the icon."""
return self._icon
@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."""
#self.update()
state = self._state
#print('is_closed() : state [{}]'.format(state))
if state == 'off':
return False
if state == 'on':
return True
return None
def open_cover(self, **kwargs):
"""Open the cover."""
self._device.set_status('on', self._switch_id)
# self._state = 'on'
# self._device._device.open_cover()
def close_cover(self, **kwargs):
"""Close cover."""
self._device.set_status('off', self._switch_id)
# self._state = 'off'
# self._device._device.close_cover()
def stop_cover(self, **kwargs):
"""Stop the cover."""
self._device.set_status('stop', self._switch_id)
# self._state = 'stop'
# self._device._device.stop_cover()
def update(self):
"""Get state of Tuya switch."""
self._status = self._device.status()
self._state = self._status['dps'][self._switch_id]
#print('update() : state [{}]'.format(self._state))

View File

@@ -0,0 +1,288 @@
"""
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
protocol_version: 3.3
"""
import voluptuous as vol
from homeassistant.const import (CONF_HOST, CONF_ID, CONF_SWITCHES, CONF_FRIENDLY_NAME, CONF_ICON, CONF_NAME)
import homeassistant.helpers.config_validation as cv
from time import time, sleep
from threading import Lock
import logging
from homeassistant.components.light import (
ATTR_BRIGHTNESS,
ATTR_COLOR_TEMP,
ATTR_HS_COLOR,
ENTITY_ID_FORMAT,
SUPPORT_BRIGHTNESS,
SUPPORT_COLOR,
SUPPORT_COLOR_TEMP,
Light,
PLATFORM_SCHEMA
)
from homeassistant.util import color as colorutil
import socket
REQUIREMENTS = ['pytuya==7.0.4']
CONF_DEVICE_ID = 'device_id'
CONF_LOCAL_KEY = 'local_key'
CONF_PROTOCOL_VERSION = 'protocol_version'
# IMPORTANT, id is used as key for state and turning on and off, 1 was fine switched apparently but my bulbs need 20, other feature attributes count up from this, e.g. 21 mode, 22 brightnes etc, see my pytuya modification.
DEFAULT_ID = '1'
DEFAULT_PROTOCOL_VERSION = 3.3
MIN_MIRED = 153
MAX_MIRED = 370
UPDATE_RETRY_LIMIT = 3
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
vol.Optional(CONF_ICON): cv.icon,
vol.Required(CONF_HOST): cv.string,
vol.Required(CONF_DEVICE_ID): cv.string,
vol.Required(CONF_LOCAL_KEY): cv.string,
vol.Required(CONF_NAME): cv.string,
vol.Required(CONF_PROTOCOL_VERSION, default=DEFAULT_PROTOCOL_VERSION): vol.Coerce(float),
vol.Optional(CONF_ID, default=DEFAULT_ID): cv.string,
})
log = logging.getLogger(__name__)
log.setLevel(level=logging.DEBUG) # Debug hack!
def setup_platform(hass, config, add_devices, discovery_info=None):
"""Set up of the Tuya switch."""
from . import pytuya
lights = []
pytuyadevice = pytuya.BulbDevice(config.get(CONF_DEVICE_ID), config.get(CONF_HOST), config.get(CONF_LOCAL_KEY))
pytuyadevice.set_version(float(config.get(CONF_PROTOCOL_VERSION)))
bulb_device = TuyaCache(pytuyadevice)
lights.append(
TuyaDevice(
bulb_device,
config.get(CONF_NAME),
config.get(CONF_ICON),
config.get(CONF_ID)
)
)
add_devices(lights)
class TuyaCache:
"""Cache wrapper for pytuya.BulbDevice"""
def __init__(self, device):
"""Initialize the cache."""
self._cached_status = ''
self._cached_status_time = 0
self._device = device
self._lock = Lock()
def __get_status(self, switchid):
for _ in range(UPDATE_RETRY_LIMIT):
try:
status = self._device.status()['dps'][switchid]
return status
except ConnectionError:
pass
except socket.timeout:
pass
log.warn(
"Failed to get status after {} tries".format(UPDATE_RETRY_LIMIT))
def set_status(self, state, switchid):
"""Change the Tuya switch status and clear the cache."""
self._cached_status = ''
self._cached_status_time = 0
for _ in range(UPDATE_RETRY_LIMIT):
try:
return self._device.set_status(state, switchid)
except ConnectionError:
pass
except socket.timeout:
pass
log.warn(
"Failed to set status after {} tries".format(UPDATE_RETRY_LIMIT))
def status(self, switchid):
"""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 > 30:
sleep(0.5)
self._cached_status = self.__get_status(switchid)
self._cached_status_time = time()
return self._cached_status
finally:
self._lock.release()
def cached_status(self):
return self._cached_status
def support_color(self):
return self._device.support_color()
def support_color_temp(self):
return self._device.support_color_temp()
def brightness(self):
for _ in range(UPDATE_RETRY_LIMIT):
try:
return self._device.brightness()
except ConnectionError:
pass
except socket.timeout:
pass
log.warn(
"Failed to get brightness after {} tries".format(UPDATE_RETRY_LIMIT))
def color_temp(self):
for _ in range(UPDATE_RETRY_LIMIT):
try:
return self._device.colourtemp()
except ConnectionError:
pass
except socket.timeout:
pass
log.warn(
"Failed to get color temp after {} tries".format(UPDATE_RETRY_LIMIT))
def set_brightness(self, brightness):
for _ in range(UPDATE_RETRY_LIMIT):
try:
return self._device.set_brightness(brightness)
except ConnectionError:
pass
except socket.timeout:
pass
log.warn(
"Failed to set brightness after {} tries".format(UPDATE_RETRY_LIMIT))
def set_color_temp(self, color_temp):
for _ in range(UPDATE_RETRY_LIMIT):
try:
return self._device.set_colourtemp(color_temp)
except ConnectionError:
pass
except socket.timeout:
pass
log.warn(
"Failed to set color temp after {} tries".format(UPDATE_RETRY_LIMIT))
def state(self):
self._device.state();
def turn_on(self):
self._device.turn_on();
def turn_off(self):
self._device.turn_off();
class TuyaDevice(Light):
"""Representation of a Tuya switch."""
def __init__(self, device, name, icon, bulbid):
"""Initialize the Tuya switch."""
self._device = device
self._name = name
self._state = False
self._brightness = 127
self._color_temp = 127
self._icon = icon
self._bulb_id = bulbid
@property
def name(self):
"""Get name of Tuya switch."""
return self._name
@property
def is_on(self):
"""Check if Tuya switch is on."""
return self._state
@property
def icon(self):
"""Return the icon."""
return self._icon
def update(self):
"""Get state of Tuya switch."""
status = self._device.status(self._bulb_id)
self._state = status
try:
brightness = int(self._device.brightness())
if brightness > 254:
brightness = 255
if brightness < 25:
brightness = 25
self._brightness = brightness
except TypeError:
pass
self._color_temp = self._device.color_temp()
@property
def brightness(self):
"""Return the brightness of the light."""
return self._brightness
# @property
# def hs_color(self):
# """Return the hs_color of the light."""
# return (self._device.color_hsv()[0],self._device.color_hsv()[1])
@property
def color_temp(self):
"""Return the color_temp of the light."""
try:
return int(MAX_MIRED - (((MAX_MIRED - MIN_MIRED) / 255) * self._color_temp))
except TypeError:
pass
@property
def min_mireds(self):
"""Return color temperature min mireds."""
return MIN_MIRED
@property
def max_mireds(self):
"""Return color temperature max mireds."""
return MAX_MIRED
def turn_on(self, **kwargs):
"""Turn on or control the light."""
log.debug("Turning on, state: " + str(self._device.cached_status()))
if not self._device.cached_status():
self._device.set_status(True, self._bulb_id)
if ATTR_BRIGHTNESS in kwargs:
converted_brightness = int(kwargs[ATTR_BRIGHTNESS])
if converted_brightness <= 25:
converted_brightness = 25
self._device.set_brightness(converted_brightness)
if ATTR_HS_COLOR in kwargs:
raise ValueError(" TODO implement RGB from HS")
if ATTR_COLOR_TEMP in kwargs:
color_temp = int(255 - (255 / (MAX_MIRED - MIN_MIRED)) * (int(kwargs[ATTR_COLOR_TEMP]) - MIN_MIRED))
self._device.set_color_temp(color_temp)
def turn_off(self, **kwargs):
"""Turn Tuya switch off."""
self._device.set_status(False, self._bulb_id)
@property
def supported_features(self):
"""Flag supported features."""
supports = SUPPORT_BRIGHTNESS
#if self._device.support_color():
# supports = supports | SUPPORT_COLOR
supports = supports | SUPPORT_COLOR_TEMP
return supports

File diff suppressed because it is too large Load Diff

View File

@@ -1,168 +1,175 @@
""" """
Simple platform to control **SOME** Tuya switch devices. Simple platform to control LOCALLY Tuya switch devices.
For more details about this platform, please refer to the documentation at Sample config yaml
https://home-assistant.io/components/switch.tuya/
""" switch:
import voluptuous as vol - platform: localtuya
from homeassistant.components.switch import SwitchDevice, PLATFORM_SCHEMA host: 192.168.0.1
from homeassistant.const import (CONF_NAME, CONF_HOST, CONF_ID, CONF_SWITCHES, CONF_FRIENDLY_NAME, CONF_ICON) local_key: 1234567891234567
import homeassistant.helpers.config_validation as cv device_id: 12345678912345671234
from time import time name: tuya_01
from threading import Lock protocol_version: 3.3
"""
REQUIREMENTS = ['pytuya==7.0.4'] import voluptuous as vol
from homeassistant.components.switch import SwitchDevice, PLATFORM_SCHEMA
CONF_DEVICE_ID = 'device_id' from homeassistant.const import (CONF_HOST, CONF_ID, CONF_SWITCHES, CONF_FRIENDLY_NAME, CONF_ICON, CONF_NAME)
CONF_LOCAL_KEY = 'local_key' import homeassistant.helpers.config_validation as cv
from time import time, sleep
DEFAULT_ID = '1' from threading import Lock
ATTR_CURRENT = 'current' REQUIREMENTS = ['pytuya==7.0.7']
ATTR_CURRENT_CONSUMPTION = 'current_consumption'
ATTR_VOLTAGE = 'voltage' CONF_DEVICE_ID = 'device_id'
CONF_LOCAL_KEY = 'local_key'
SWITCH_SCHEMA = vol.Schema({ CONF_PROTOCOL_VERSION = 'protocol_version'
vol.Optional(CONF_ID, default=DEFAULT_ID): cv.string, CONF_CURRENT = 'current'
vol.Optional(CONF_FRIENDLY_NAME): cv.string, CONF_CURRENT_CONSUMPTION = 'current_consumption'
}) CONF_VOLTAGE = 'voltage'
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({ DEFAULT_ID = '1'
vol.Optional(CONF_NAME): cv.string, DEFAULT_PROTOCOL_VERSION = 3.3
vol.Optional(CONF_ICON): cv.icon,
vol.Required(CONF_HOST): cv.string, ATTR_CURRENT = 'current'
vol.Required(CONF_DEVICE_ID): cv.string, ATTR_CURRENT_CONSUMPTION = 'current_consumption'
vol.Required(CONF_LOCAL_KEY): cv.string, ATTR_VOLTAGE = 'voltage'
vol.Optional(CONF_ID, default=DEFAULT_ID): cv.string,
vol.Optional(CONF_SWITCHES, default={}): PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
vol.Schema({cv.slug: SWITCH_SCHEMA}), vol.Optional(CONF_ICON): cv.icon,
}) vol.Required(CONF_HOST): cv.string,
vol.Required(CONF_DEVICE_ID): cv.string,
vol.Required(CONF_LOCAL_KEY): cv.string,
def setup_platform(hass, config, add_devices, discovery_info=None): vol.Required(CONF_NAME): cv.string,
"""Set up of the Tuya switch.""" vol.Required(CONF_PROTOCOL_VERSION, default=DEFAULT_PROTOCOL_VERSION): vol.Coerce(float),
import pytuya vol.Optional(CONF_ID, default=DEFAULT_ID): cv.string,
vol.Optional(CONF_CURRENT, default='4'): cv.string,
devices = config.get(CONF_SWITCHES) vol.Optional(CONF_CURRENT_CONSUMPTION, default='5'): cv.string,
switches = [] vol.Optional(CONF_VOLTAGE, default='6'): cv.string,
})
outlet_device = TuyaCache(
pytuya.OutletDevice(
config.get(CONF_DEVICE_ID), def setup_platform(hass, config, add_devices, discovery_info=None):
config.get(CONF_HOST), """Set up of the Tuya switch."""
config.get(CONF_LOCAL_KEY) from . import pytuya
)
) switches = []
pytuyadevice = pytuya.OutletDevice(config.get(CONF_DEVICE_ID), config.get(CONF_HOST), config.get(CONF_LOCAL_KEY))
for object_id, device_config in devices.items(): pytuyadevice.set_version(float(config.get(CONF_PROTOCOL_VERSION)))
switches.append(
TuyaDevice( outlet_device = TuyaCache(pytuyadevice)
outlet_device, switches.append(
device_config.get(CONF_FRIENDLY_NAME, object_id), TuyaDevice(
device_config.get(CONF_ICON), outlet_device,
device_config.get(CONF_ID) config.get(CONF_NAME),
) config.get(CONF_ICON),
) config.get(CONF_ID),
config.get(CONF_CURRENT),
name = config.get(CONF_NAME) config.get(CONF_CURRENT_CONSUMPTION),
if name: config.get(CONF_VOLTAGE)
switches.append( )
TuyaDevice( )
outlet_device, #print('Setup localtuya switch [{}] with device ID [{}] '.format(config.get(CONF_NAME), config.get(CONF_ID)))
name,
config.get(CONF_ICON), add_devices(switches)
config.get(CONF_ID)
) class TuyaCache:
) """Cache wrapper for pytuya.OutletDevice"""
add_devices(switches) def __init__(self, device):
"""Initialize the cache."""
class TuyaCache: self._cached_status = ''
"""Cache wrapper for pytuya.OutletDevice""" self._cached_status_time = 0
self._device = device
def __init__(self, device): self._lock = Lock()
"""Initialize the cache."""
self._cached_status = '' def __get_status(self):
self._cached_status_time = 0 for i in range(20):
self._device = device try:
self._lock = Lock() status = self._device.status()
return status
def __get_status(self): except ConnectionError:
for i in range(3): if i+1 == 3:
try: raise ConnectionError("Failed to update status.")
status = self._device.status()
return status def set_status(self, state, switchid):
except ConnectionError: """Change the Tuya switch status and clear the cache."""
if i+1 == 3: self._cached_status = ''
raise ConnectionError("Failed to update status.") self._cached_status_time = 0
for i in range(20):
def set_status(self, state, switchid): try:
"""Change the Tuya switch status and clear the cache.""" return self._device.set_status(state, switchid)
self._cached_status = '' except ConnectionError:
self._cached_status_time = 0 if i+1 == 5:
return self._device.set_status(state, switchid) raise ConnectionError("Failed to set status.")
def status(self): def status(self):
"""Get state of Tuya switch and cache the results.""" """Get state of Tuya switch and cache the results."""
self._lock.acquire() self._lock.acquire()
try: try:
now = time() now = time()
if not self._cached_status or now - self._cached_status_time > 20: if not self._cached_status or now - self._cached_status_time > 30:
self._cached_status = self.__get_status() sleep(0.5)
self._cached_status_time = time() self._cached_status = self.__get_status()
return self._cached_status self._cached_status_time = time()
finally: return self._cached_status
self._lock.release() finally:
self._lock.release()
class TuyaDevice(SwitchDevice):
"""Representation of a Tuya switch.""" class TuyaDevice(SwitchDevice):
"""Representation of a Tuya switch."""
def __init__(self, device, name, icon, switchid):
"""Initialize the Tuya switch.""" def __init__(self, device, name, icon, switchid, attr_current, attr_consumption, attr_voltage):
self._device = device """Initialize the Tuya switch."""
self._name = name self._device = device
self._state = False self._name = name
self._icon = icon self._icon = icon
self._switchid = switchid self._switch_id = switchid
self._status = self._device.status() self._attr_current = attr_current
self._attr_consumption = attr_consumption
@property self._attr_voltage = attr_voltage
def name(self): self._status = self._device.status()
"""Get name of Tuya switch.""" self._state = self._status['dps'][self._switch_id]
return self._name print('Initialized tuya switch [{}] with switch status [{}] and state [{}]'.format(self._name, self._status, self._state))
@property @property
def is_on(self): def name(self):
"""Check if Tuya switch is on.""" """Get name of Tuya switch."""
return self._state return self._name
@property @property
def device_state_attributes(self): def is_on(self):
attrs = {} """Check if Tuya switch is on."""
try: return self._state
attrs[ATTR_CURRENT] = "{}".format(self._status['dps']['104'])
attrs[ATTR_CURRENT_CONSUMPTION] = "{}".format(self._status['dps']['105']/10) @property
attrs[ATTR_VOLTAGE] = "{}".format(self._status['dps']['106']/10) def device_state_attributes(self):
except KeyError: attrs = {}
pass try:
return attrs attrs[ATTR_CURRENT] = "{}".format(self._status['dps'][self._attr_current])
#print('attrs[ATTR_CURRENT]: [{}]'.format(attrs[ATTR_CURRENT]))
@property attrs[ATTR_CURRENT_CONSUMPTION] = "{}".format(self._status['dps'][self._attr_consumption]/10)
def icon(self): #print('attrs[ATTR_CURRENT_CONSUMPTION]: [{}]'.format(attrs[ATTR_CURRENT_CONSUMPTION]))
"""Return the icon.""" attrs[ATTR_VOLTAGE] = "{}".format(self._status['dps'][self._attr_voltage]/10)
return self._icon #print('attrs[ATTR_VOLTAGE]: [{}]'.format(attrs[ATTR_VOLTAGE]))
def turn_on(self, **kwargs): except KeyError:
"""Turn Tuya switch on.""" pass
self._device.set_status(True, self._switchid) return attrs
def turn_off(self, **kwargs): @property
"""Turn Tuya switch off.""" def icon(self):
self._device.set_status(False, self._switchid) """Return the icon."""
return self._icon
def update(self):
"""Get state of Tuya switch.""" def turn_on(self, **kwargs):
status = self._device.status() """Turn Tuya switch on."""
self._status= status self._device.set_status(True, self._switch_id)
self._state = status['dps'][self._switchid]
def turn_off(self, **kwargs):
"""Turn Tuya switch off."""
self._device.set_status(False, self._switch_id)
def update(self):
"""Get state of Tuya switch."""
self._status = self._device.status()
self._state = self._status['dps'][self._switch_id]