From 2334e98806ee548c021457b6c37721a517e98295 Mon Sep 17 00:00:00 2001 From: Raphael Date: Fri, 14 May 2021 15:41:13 -0400 Subject: [PATCH] Add Etekcity VeSync light bulbs to Homeassistant (#50272) --- homeassistant/components/vesync/common.py | 4 + homeassistant/components/vesync/light.py | 173 +++++++++++++++++----- 2 files changed, 143 insertions(+), 34 deletions(-) diff --git a/homeassistant/components/vesync/common.py b/homeassistant/components/vesync/common.py index fcab5bb5a63..d51da7a375b 100644 --- a/homeassistant/components/vesync/common.py +++ b/homeassistant/components/vesync/common.py @@ -21,6 +21,10 @@ async def async_process_devices(hass, manager): devices[VS_FANS].extend(manager.fans) _LOGGER.info("%d VeSync fans found", len(manager.fans)) + if manager.bulbs: + devices[VS_LIGHTS].extend(manager.bulbs) + _LOGGER.info("%d VeSync lights found", len(manager.bulbs)) + if manager.outlets: devices[VS_SWITCHES].extend(manager.outlets) _LOGGER.info("%d VeSync outlets found", len(manager.outlets)) diff --git a/homeassistant/components/vesync/light.py b/homeassistant/components/vesync/light.py index b98c87e5a7f..b747c10ee4e 100644 --- a/homeassistant/components/vesync/light.py +++ b/homeassistant/components/vesync/light.py @@ -1,9 +1,11 @@ -"""Support for VeSync dimmers.""" +"""Support for VeSync bulbs and wall dimmers.""" import logging from homeassistant.components.light import ( ATTR_BRIGHTNESS, - SUPPORT_BRIGHTNESS, + ATTR_COLOR_TEMP, + COLOR_MODE_BRIGHTNESS, + COLOR_MODE_COLOR_TEMP, LightEntity, ) from homeassistant.core import callback @@ -15,8 +17,10 @@ from .const import DOMAIN, VS_DISCOVERY, VS_DISPATCHERS, VS_LIGHTS _LOGGER = logging.getLogger(__name__) DEV_TYPE_TO_HA = { - "ESD16": "light", - "ESWD16": "light", + "ESD16": "walldimmer", + "ESWD16": "walldimmer", + "ESL100": "bulb-dimmable", + "ESL100CW": "bulb-tunable-white", } @@ -40,8 +44,10 @@ def _async_setup_entities(devices, async_add_entities): """Check if device is online and add entity.""" entities = [] for dev in devices: - if DEV_TYPE_TO_HA.get(dev.device_type) == "light": - entities.append(VeSyncDimmerHA(dev)) + if DEV_TYPE_TO_HA.get(dev.device_type) in ("walldimmer", "bulb-dimmable"): + entities.append(VeSyncDimmableLightHA(dev)) + elif DEV_TYPE_TO_HA.get(dev.device_type) in ("bulb-tunable-white"): + entities.append(VeSyncTunableWhiteLightHA(dev)) else: _LOGGER.debug( "%s - Unknown device type - %s", dev.device_name, dev.device_type @@ -51,34 +57,133 @@ def _async_setup_entities(devices, async_add_entities): async_add_entities(entities, update_before_add=True) -class VeSyncDimmerHA(VeSyncDevice, LightEntity): - """Representation of a VeSync dimmer.""" - - def __init__(self, dimmer): - """Initialize the VeSync dimmer device.""" - super().__init__(dimmer) - self.dimmer = dimmer - - def turn_on(self, **kwargs): - """Turn the device on.""" - if ATTR_BRIGHTNESS in kwargs: - # get brightness from HA data - brightness = int(kwargs[ATTR_BRIGHTNESS]) - # convert to percent that vesync api expects - brightness = round((brightness / 255) * 100) - # clamp to 1-100 - brightness = max(1, min(brightness, 100)) - self.dimmer.set_brightness(brightness) - # Avoid turning device back on if this is just a brightness adjustment - if not self.is_on: - self.device.turn_on() - - @property - def supported_features(self): - """Get supported features for this entity.""" - return SUPPORT_BRIGHTNESS +class VeSyncBaseLight(VeSyncDevice, LightEntity): + """Base class for VeSync Light Devices Representations.""" @property def brightness(self): - """Get dimmer brightness.""" - return round((int(self.dimmer.brightness) / 100) * 255) + """Get light brightness.""" + # get value from pyvesync library api, + result = self.device.brightness + try: + # check for validity of brightness value received + brightness_value = int(result) + except ValueError: + # deal if any unexpected/non numeric value + _LOGGER.debug( + "VeSync - received unexpected 'brightness' value from pyvesync api: %s", + result, + ) + return 0 + # convert percent brightness to ha expected range + return round((max(1, brightness_value) / 100) * 255) + + def turn_on(self, **kwargs): + """Turn the device on.""" + attribute_adjustment_only = False + # set white temperature + if self.color_mode in (COLOR_MODE_COLOR_TEMP) and ATTR_COLOR_TEMP in kwargs: + # get white temperature from HA data + color_temp = int(kwargs[ATTR_COLOR_TEMP]) + # ensure value between min-max supported Mireds + color_temp = max(self.min_mireds, min(color_temp, self.max_mireds)) + # convert Mireds to Percent value that api expects + color_temp = round( + ((color_temp - self.min_mireds) / (self.max_mireds - self.min_mireds)) + * 100 + ) + # flip cold/warm to what pyvesync api expects + color_temp = 100 - color_temp + # ensure value between 0-100 + color_temp = max(0, min(color_temp, 100)) + # call pyvesync library api method to set color_temp + self.device.set_color_temp(color_temp) + # flag attribute_adjustment_only, so it doesn't turn_on the device redundantly + attribute_adjustment_only = True + # set brightness level + if ( + self.color_mode in (COLOR_MODE_BRIGHTNESS, COLOR_MODE_COLOR_TEMP) + and ATTR_BRIGHTNESS in kwargs + ): + # get brightness from HA data + brightness = int(kwargs[ATTR_BRIGHTNESS]) + # ensure value between 1-255 + brightness = max(1, min(brightness, 255)) + # convert to percent that vesync api expects + brightness = round((brightness / 255) * 100) + # ensure value between 1-100 + brightness = max(1, min(brightness, 100)) + # call pyvesync library api method to set brightness + self.device.set_brightness(brightness) + # flag attribute_adjustment_only, so it doesn't turn_on the device redundantly + attribute_adjustment_only = True + # check flag if should skip sending the turn_on command + if attribute_adjustment_only: + return + # send turn_on command to pyvesync api + self.device.turn_on() + + +class VeSyncDimmableLightHA(VeSyncBaseLight, LightEntity): + """Representation of a VeSync dimmable light device.""" + + @property + def color_mode(self): + """Set color mode for this entity.""" + return COLOR_MODE_BRIGHTNESS + + @property + def supported_color_modes(self): + """Flag supported color_modes (in an array format).""" + return [COLOR_MODE_BRIGHTNESS] + + +class VeSyncTunableWhiteLightHA(VeSyncBaseLight, LightEntity): + """Representation of a VeSync Tunable White Light device.""" + + @property + def color_temp(self): + """Get device white temperature.""" + # get value from pyvesync library api, + result = self.device.color_temp_pct + try: + # check for validity of brightness value received + color_temp_value = int(result) + except ValueError: + # deal if any unexpected/non numeric value + _LOGGER.debug( + "VeSync - received unexpected 'color_temp_pct' value from pyvesync api: %s", + result, + ) + return 0 + # flip cold/warm + color_temp_value = 100 - color_temp_value + # ensure value between 0-100 + color_temp_value = max(0, min(color_temp_value, 100)) + # convert percent value to Mireds + color_temp_value = round( + self.min_mireds + + ((self.max_mireds - self.min_mireds) / 100 * color_temp_value) + ) + # ensure value between minimum and maximum Mireds + return max(self.min_mireds, min(color_temp_value, self.max_mireds)) + + @property + def min_mireds(self): + """Set device coldest white temperature.""" + return 154 # 154 Mireds ( 1,000,000 divided by 6500 Kelvin = 154 Mireds) + + @property + def max_mireds(self): + """Set device warmest white temperature.""" + return 370 # 370 Mireds ( 1,000,000 divided by 2700 Kelvin = 370 Mireds) + + @property + def color_mode(self): + """Set color mode for this entity.""" + return COLOR_MODE_COLOR_TEMP + + @property + def supported_color_modes(self): + """Flag supported color_modes (in an array format).""" + return [COLOR_MODE_COLOR_TEMP]