Added osramlightify groups. #7376
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,6 +4,7 @@ | |
| For more details about this platform, please refer to the documentation at | ||
| https://home-assistant.io/components/light.osramlightify/ | ||
| """ | ||
| import sys | ||
| import logging | ||
| import socket | ||
| import random | ||
|
|
@@ -15,33 +16,40 @@ | |
| from homeassistant.const import CONF_HOST | ||
| from homeassistant.components.light import ( | ||
| Light, ATTR_BRIGHTNESS, ATTR_COLOR_TEMP, ATTR_EFFECT, ATTR_RGB_COLOR, | ||
| ATTR_XY_COLOR, ATTR_TRANSITION, EFFECT_RANDOM, SUPPORT_BRIGHTNESS, | ||
| SUPPORT_EFFECT, SUPPORT_XY_COLOR, SUPPORT_COLOR_TEMP, SUPPORT_RGB_COLOR, | ||
| SUPPORT_TRANSITION, PLATFORM_SCHEMA) | ||
| from homeassistant.util.color import ( | ||
| color_temperature_mired_to_kelvin, color_temperature_kelvin_to_mired, | ||
| color_xy_brightness_to_RGB) | ||
| import homeassistant.helpers.config_validation as cv | ||
|
|
||
| REQUIREMENTS = ['https://github.com/tfriedel/python-lightify/archive/' | ||
| '1bb1db0e7bd5b14304d7bb267e2398cd5160df46.zip#lightify==1.0.5'] | ||
|
|
||
| _LOGGER = logging.getLogger(__name__) | ||
|
|
||
| MIN_TIME_BETWEEN_SCANS = timedelta(seconds=10) | ||
| MIN_TIME_BETWEEN_FORCED_SCANS = timedelta(milliseconds=100) | ||
| CONF_ALLOW_LIGHTIFY_GROUPS = "allow_lightify_groups" | ||
| DEFAULT_ALLOW_LIGHTIFY_GROUPS = True | ||
|
|
||
| SUPPORT_OSRAMLIGHTIFY = (SUPPORT_BRIGHTNESS | SUPPORT_COLOR_TEMP | | ||
| SUPPORT_EFFECT | SUPPORT_RGB_COLOR | | ||
| SUPPORT_TRANSITION | SUPPORT_XY_COLOR) | ||
|
|
||
| PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({ | ||
| vol.Required(CONF_HOST): cv.string, | ||
| vol.Optional(CONF_ALLOW_LIGHTIFY_GROUPS, | ||
| default=DEFAULT_ALLOW_LIGHTIFY_GROUPS): cv.boolean, | ||
| }) | ||
|
|
||
|
|
||
| def setup_platform(hass, config, add_devices, discovery_info=None): | ||
| """Setup the Osram Lightify lights.""" | ||
| import lightify | ||
| host = config.get(CONF_HOST) | ||
| add_groups = config.get(CONF_ALLOW_LIGHTIFY_GROUPS) | ||
| if host: | ||
| try: | ||
| bridge = lightify.Lightify(host) | ||
|
|
@@ -50,20 +58,26 @@ def setup_platform(hass, config, add_devices, discovery_info=None): | |
| str(err)) | ||
| _LOGGER.exception(msg) | ||
| return False | ||
| setup_bridge(bridge, add_devices, add_groups) | ||
| else: | ||
| _LOGGER.error('No host found in configuration') | ||
| return False | ||
|
|
||
|
|
||
| def setup_bridge(bridge, add_devices_callback, add_groups): | ||
| """Setup the Lightify bridge.""" | ||
|
Contributor
Author
There was a problem hiding this comment. If I remove it, the |
||
| lights = {} | ||
|
|
||
| @util.Throttle(MIN_TIME_BETWEEN_SCANS, MIN_TIME_BETWEEN_FORCED_SCANS) | ||
| def update_lights(): | ||
| """Update the lights objects with latest info from bridge.""" | ||
| try: | ||
| bridge.update_all_light_status() | ||
| bridge.update_group_list() | ||
| except TimeoutError: | ||
| _LOGGER.error('Timeout during updating of lights.') | ||
| except OSError: | ||
| _LOGGER.error('OSError during updating of lights.') | ||
|
|
||
| new_lights = [] | ||
|
|
||
|
|
@@ -77,22 +91,31 @@ def update_lights(): | |
| else: | ||
| lights[light_id].light = light | ||
|
|
||
| if add_groups: | ||
| for (group_name, group) in bridge.groups().items(): | ||
| if group_name not in lights: | ||
| osram_group = OsramLightifyGroup(group, bridge, | ||
| update_lights) | ||
| lights[group_name] = osram_group | ||
| new_lights.append(osram_group) | ||
| else: | ||
| lights[group_name].group = group | ||
|
|
||
| if new_lights: | ||
| add_devices_callback(new_lights) | ||
|
|
||
| update_lights() | ||
|
|
||
|
|
||
| class Luminary(Light): | ||
| """ABS for Lightify Lights and Groups.""" | ||
|
|
||
| def __init__(self, luminary, update_lights): | ||
| """Init Luminary object.""" | ||
| self.update_lights = update_lights | ||
| self._luminary = luminary | ||
| self._brightness = None | ||
| self._rgb = [None] | ||
| self._name = None | ||
| self._temperature = None | ||
| self._state = False | ||
|
|
@@ -106,8 +129,6 @@ def name(self): | |
| @property | ||
| def rgb_color(self): | ||
| """Last RGB color value set.""" | ||
| return self._rgb | ||
|
|
||
| @property | ||
|
|
@@ -118,29 +139,27 @@ def color_temp(self): | |
| @property | ||
| def brightness(self): | ||
| """Brightness of this light between 0..255.""" | ||
| return self._brightness | ||
|
|
||
| @property | ||
| def is_on(self): | ||
| """Update Status to True if device is on.""" | ||
| return self._state | ||
|
|
||
| @property | ||
| def supported_features(self): | ||
| """Flag supported features.""" | ||
| return SUPPORT_OSRAMLIGHTIFY | ||
|
|
||
| @property | ||
| def effect_list(self): | ||
| """List of supported effects.""" | ||
| return [EFFECT_RANDOM] | ||
|
|
||
| def turn_on(self, **kwargs): | ||
| """Turn the device on.""" | ||
| self._luminary.set_onoff(1) | ||
| self._state = True | ||
|
|
||
| if ATTR_TRANSITION in kwargs: | ||
| transition = int(kwargs[ATTR_TRANSITION] * 10) | ||
|
|
@@ -158,30 +177,41 @@ def turn_on(self, **kwargs): | |
| _LOGGER.debug("turn_on requested ATTR_RGB_COLOR for light:" | ||
| " %s is: %s %s %s ", | ||
| self._name, red, green, blue) | ||
| self._luminary.set_rgb(red, green, blue, transition) | ||
|
|
||
| if ATTR_XY_COLOR in kwargs: | ||
| x_mired, y_mired = kwargs[ATTR_XY_COLOR] | ||
| _LOGGER.debug("turn_on requested ATTR_XY_COLOR for light:" | ||
| " %s is: %s,%s", self._name, x_mired, y_mired) | ||
| red, green, blue = color_xy_brightness_to_RGB( | ||
| x_mired, y_mired, self._brightness | ||
| ) | ||
| self._luminary.set_rgb(red, green, blue, transition) | ||
|
|
||
| if ATTR_COLOR_TEMP in kwargs: | ||
| color_t = kwargs[ATTR_COLOR_TEMP] | ||
| kelvin = int(color_temperature_mired_to_kelvin(color_t)) | ||
| _LOGGER.debug("turn_on requested set_temperature for light:" | ||
| " %s: %s ", self._name, kelvin) | ||
| self._luminary.set_temperature(kelvin, transition) | ||
|
|
||
| if ATTR_BRIGHTNESS in kwargs: | ||
| self._brightness = kwargs[ATTR_BRIGHTNESS] | ||
| _LOGGER.debug("turn_on requested brightness for light: %s is: %s ", | ||
| self._name, self._brightness) | ||
| self._brightness = self._luminary.set_luminance( | ||
| int(self._brightness / 2.55), | ||
| transition) | ||
|
|
||
| if ATTR_EFFECT in kwargs: | ||
| effect = kwargs.get(ATTR_EFFECT) | ||
| if effect == EFFECT_RANDOM: | ||
| self._luminary.set_rgb( | ||
| random.randrange(0, 255), | ||
| random.randrange(0, 255), | ||
| random.randrange(0, 255), | ||
| transition | ||
| ) | ||
| _LOGGER.debug("turn_on requested random effect for light:" | ||
| " %s with transition %s ", | ||
| self._name, transition) | ||
|
|
@@ -197,26 +227,72 @@ def turn_off(self, **kwargs): | |
| _LOGGER.debug("turn_off requested transition time for light:" | ||
| " %s is: %s ", | ||
| self._name, transition) | ||
| self._luminary.set_luminance(0, transition) | ||
| else: | ||
| transition = 0 | ||
| _LOGGER.debug("turn_off requested transition time for light:" | ||
| " %s is: %s ", | ||
| self._name, transition) | ||
| self._luminary.set_onoff(0) | ||
| self._state = False | ||
| self.schedule_update_ha_state() | ||
|
Member
There was a problem hiding this comment. Can you remove this line? it's not needed since should_poll is defaulting to True and so this is automatically called.
Contributor
Author
There was a problem hiding this comment. You mean the
Member
There was a problem hiding this comment. It's not something that we should fix in a platform but instead fix for everyone at once. We already wait 2 seconds for a status update: https://github.com/home-assistant/home-assistant-polymer/blob/master/src/components/entity/ha-entity-toggle.html#L135-L136 Please remove this line. |
||
|
|
||
| def update(self): | ||
| """Synchronize state with bridge.""" | ||
| self.update_lights(no_throttle=True) | ||
| self._name = self._luminary.name() | ||
|
|
||
|
|
||
| class OsramLightifyLight(Luminary): | ||
| """Representation of an Osram Lightify Light.""" | ||
|
|
||
| def __init__(self, light_id, light, update_lights): | ||
| """Initialize the light.""" | ||
| self._light_id = light_id | ||
| super().__init__(light, update_lights) | ||
|
|
||
| def update(self): | ||
| """Update status of a Light.""" | ||
| super().update() | ||
| self._state = self._luminary.on() | ||
| self._rgb = self._luminary.rgb() | ||
| o_temp = self._luminary.temp() | ||
| if o_temp == 0: | ||
| self._temperature = None | ||
| else: | ||
| self._temperature = color_temperature_kelvin_to_mired( | ||
| self._luminary.temp() | ||
| ) | ||
| self._brightness = int(self._luminary.lum() * 2.55) | ||
|
|
||
|
|
||
| class OsramLightifyGroup(Luminary): | ||
| """Representation of an Osram Lightify Group.""" | ||
|
|
||
| def __init__(self, group, bridge, update_lights): | ||
| """Init light group.""" | ||
| self._bridge = bridge | ||
| self._light_ids = [] | ||
| super().__init__(group, update_lights) | ||
|
|
||
| def _get_state(self): | ||
| """Get state of group. | ||
|
|
||
| The group is on, if any of the lights in on. | ||
| """ | ||
| lights = self._bridge.lights() | ||
| return any(lights[light_id].on() for light_id in self._light_ids) | ||
|
|
||
| def update(self): | ||
| """Update group status.""" | ||
| super().update() | ||
| self._light_ids = self._luminary.lights() | ||
|
Member
There was a problem hiding this comment. What is I think that things are getting very complicated because of the inheritance.
Contributor
Author
There was a problem hiding this comment.
I first stared out without, but my code became 90% redundant and so I splittend i t up. The only difference between the two is the
Well its the main interface to the lightify API. Essentially all communication with the lights goes through the |
||
| light = self._bridge.lights()[self._light_ids[0]] | ||
| self._brightness = int(light.lum() * 2.55) | ||
| self._rgb = light.rgb() | ||
| o_temp = light.temp() | ||
| if o_temp == 0: | ||
| self._temperature = None | ||
| else: | ||
| self._temperature = color_temperature_kelvin_to_mired(o_temp) | ||
| self._state = light.on() | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
'sys' imported but unused
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed