255 lines
7.5 KiB
Python
255 lines
7.5 KiB
Python
"""
|
|
homeassistant.components.light.hue
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
Support for Hue lights.
|
|
|
|
For more details about this platform, please refer to the documentation at
|
|
https://home-assistant.io/components/light.hue/
|
|
"""
|
|
import json
|
|
import logging
|
|
import os
|
|
import socket
|
|
from datetime import timedelta
|
|
from urllib.parse import urlparse
|
|
|
|
from homeassistant.loader import get_component
|
|
import homeassistant.util as util
|
|
import homeassistant.util.color as color_util
|
|
from homeassistant.const import CONF_HOST, DEVICE_DEFAULT_NAME
|
|
from homeassistant.components.light import (
|
|
Light, ATTR_BRIGHTNESS, ATTR_XY_COLOR, ATTR_COLOR_TEMP,
|
|
ATTR_TRANSITION, ATTR_FLASH, FLASH_LONG, FLASH_SHORT,
|
|
ATTR_EFFECT, EFFECT_COLORLOOP, ATTR_RGB_COLOR)
|
|
|
|
REQUIREMENTS = ['phue==0.8']
|
|
MIN_TIME_BETWEEN_SCANS = timedelta(seconds=10)
|
|
MIN_TIME_BETWEEN_FORCED_SCANS = timedelta(milliseconds=100)
|
|
|
|
PHUE_CONFIG_FILE = "phue.conf"
|
|
|
|
|
|
# Map ip to request id for configuring
|
|
_CONFIGURING = {}
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
def _find_host_from_config(hass):
|
|
""" Attempt to detect host based on existing configuration. """
|
|
path = hass.config.path(PHUE_CONFIG_FILE)
|
|
|
|
if not os.path.isfile(path):
|
|
return None
|
|
|
|
try:
|
|
with open(path) as inp:
|
|
return next(json.loads(''.join(inp)).keys().__iter__())
|
|
except (ValueError, AttributeError, StopIteration):
|
|
# ValueError if can't parse as JSON
|
|
# AttributeError if JSON value is not a dict
|
|
# StopIteration if no keys
|
|
return None
|
|
|
|
|
|
def setup_platform(hass, config, add_devices_callback, discovery_info=None):
|
|
""" Gets the Hue lights. """
|
|
if discovery_info is not None:
|
|
host = urlparse(discovery_info[1]).hostname
|
|
else:
|
|
host = config.get(CONF_HOST, None)
|
|
|
|
if host is None:
|
|
host = _find_host_from_config(hass)
|
|
|
|
if host is None:
|
|
_LOGGER.error('No host found in configuration')
|
|
return False
|
|
|
|
# Only act if we are not already configuring this host
|
|
if host in _CONFIGURING:
|
|
return
|
|
|
|
setup_bridge(host, hass, add_devices_callback)
|
|
|
|
|
|
def setup_bridge(host, hass, add_devices_callback):
|
|
""" Setup a phue bridge based on host parameter. """
|
|
import phue
|
|
|
|
try:
|
|
bridge = phue.Bridge(
|
|
host,
|
|
config_file_path=hass.config.path(PHUE_CONFIG_FILE))
|
|
except ConnectionRefusedError: # Wrong host was given
|
|
_LOGGER.exception("Error connecting to the Hue bridge at %s", host)
|
|
|
|
return
|
|
|
|
except phue.PhueRegistrationException:
|
|
_LOGGER.warning("Connected to Hue at %s but not registered.", host)
|
|
|
|
request_configuration(host, hass, add_devices_callback)
|
|
|
|
return
|
|
|
|
# If we came here and configuring this host, mark as done
|
|
if host in _CONFIGURING:
|
|
request_id = _CONFIGURING.pop(host)
|
|
|
|
configurator = get_component('configurator')
|
|
|
|
configurator.request_done(request_id)
|
|
|
|
lights = {}
|
|
|
|
@util.Throttle(MIN_TIME_BETWEEN_SCANS, MIN_TIME_BETWEEN_FORCED_SCANS)
|
|
def update_lights():
|
|
""" Updates the Hue light objects with latest info from the bridge. """
|
|
try:
|
|
api = bridge.get_api()
|
|
except socket.error:
|
|
# socket.error when we cannot reach Hue
|
|
_LOGGER.exception("Cannot reach the bridge")
|
|
return
|
|
|
|
api_states = api.get('lights')
|
|
|
|
if not isinstance(api_states, dict):
|
|
_LOGGER.error("Got unexpected result from Hue API")
|
|
return
|
|
|
|
new_lights = []
|
|
|
|
for light_id, info in api_states.items():
|
|
if light_id not in lights:
|
|
lights[light_id] = HueLight(int(light_id), info,
|
|
bridge, update_lights)
|
|
new_lights.append(lights[light_id])
|
|
else:
|
|
lights[light_id].info = info
|
|
|
|
if new_lights:
|
|
add_devices_callback(new_lights)
|
|
|
|
update_lights()
|
|
|
|
|
|
def request_configuration(host, hass, add_devices_callback):
|
|
""" Request configuration steps from the user. """
|
|
configurator = get_component('configurator')
|
|
|
|
# We got an error if this method is called while we are configuring
|
|
if host in _CONFIGURING:
|
|
configurator.notify_errors(
|
|
_CONFIGURING[host], "Failed to register, please try again.")
|
|
|
|
return
|
|
|
|
# pylint: disable=unused-argument
|
|
def hue_configuration_callback(data):
|
|
""" Actions to do when our configuration callback is called. """
|
|
setup_bridge(host, hass, add_devices_callback)
|
|
|
|
_CONFIGURING[host] = configurator.request_config(
|
|
hass, "Philips Hue", hue_configuration_callback,
|
|
description=("Press the button on the bridge to register Philips Hue "
|
|
"with Home Assistant."),
|
|
description_image="/static/images/config_philips_hue.jpg",
|
|
submit_caption="I have pressed the button"
|
|
)
|
|
|
|
|
|
class HueLight(Light):
|
|
""" Represents a Hue light """
|
|
|
|
def __init__(self, light_id, info, bridge, update_lights):
|
|
self.light_id = light_id
|
|
self.info = info
|
|
self.bridge = bridge
|
|
self.update_lights = update_lights
|
|
|
|
@property
|
|
def unique_id(self):
|
|
""" Returns the id of this Hue light """
|
|
return "{}.{}".format(
|
|
self.__class__, self.info.get('uniqueid', self.name))
|
|
|
|
@property
|
|
def name(self):
|
|
""" Get the mame of the Hue light. """
|
|
return self.info.get('name', DEVICE_DEFAULT_NAME)
|
|
|
|
@property
|
|
def brightness(self):
|
|
""" Brightness of this light between 0..255. """
|
|
return self.info['state']['bri']
|
|
|
|
@property
|
|
def xy_color(self):
|
|
""" XY color value. """
|
|
return self.info['state'].get('xy')
|
|
|
|
@property
|
|
def color_temp(self):
|
|
""" CT color value. """
|
|
return self.info['state'].get('ct')
|
|
|
|
@property
|
|
def is_on(self):
|
|
""" True if device is on. """
|
|
self.update_lights()
|
|
|
|
return self.info['state']['reachable'] and self.info['state']['on']
|
|
|
|
def turn_on(self, **kwargs):
|
|
""" Turn the specified or all lights on. """
|
|
command = {'on': True}
|
|
|
|
if ATTR_TRANSITION in kwargs:
|
|
command['transitiontime'] = kwargs[ATTR_TRANSITION] * 10
|
|
|
|
if ATTR_BRIGHTNESS in kwargs:
|
|
command['bri'] = kwargs[ATTR_BRIGHTNESS]
|
|
|
|
if ATTR_XY_COLOR in kwargs:
|
|
command['xy'] = kwargs[ATTR_XY_COLOR]
|
|
elif ATTR_RGB_COLOR in kwargs:
|
|
command['xy'] = color_util.color_RGB_to_xy(
|
|
*(int(val) for val in kwargs[ATTR_RGB_COLOR]))
|
|
|
|
if ATTR_COLOR_TEMP in kwargs:
|
|
command['ct'] = kwargs[ATTR_COLOR_TEMP]
|
|
|
|
flash = kwargs.get(ATTR_FLASH)
|
|
|
|
if flash == FLASH_LONG:
|
|
command['alert'] = 'lselect'
|
|
elif flash == FLASH_SHORT:
|
|
command['alert'] = 'select'
|
|
else:
|
|
command['alert'] = 'none'
|
|
|
|
effect = kwargs.get(ATTR_EFFECT)
|
|
|
|
if effect == EFFECT_COLORLOOP:
|
|
command['effect'] = 'colorloop'
|
|
else:
|
|
command['effect'] = 'none'
|
|
|
|
self.bridge.set_light(self.light_id, command)
|
|
|
|
def turn_off(self, **kwargs):
|
|
""" Turn the specified or all lights off. """
|
|
command = {'on': False}
|
|
|
|
if ATTR_TRANSITION in kwargs:
|
|
# Transition time is in 1/10th seconds and cannot exceed
|
|
# 900 seconds.
|
|
command['transitiontime'] = min(9000, kwargs[ATTR_TRANSITION] * 10)
|
|
|
|
self.bridge.set_light(self.light_id, command)
|
|
|
|
def update(self):
|
|
""" Synchronize state with bridge. """
|
|
self.update_lights(no_throttle=True)
|