6ae3fa40cf
This is more in line with how one would expect light temperature transitions to take place, but still allows for a user defined stop_time.
280 lines
10 KiB
Python
280 lines
10 KiB
Python
"""
|
|
Flux for Home-Assistant.
|
|
|
|
The idea was taken from https://github.com/KpaBap/hue-flux/
|
|
|
|
For more details about this component, please refer to the documentation at
|
|
https://home-assistant.io/components/switch.flux/
|
|
"""
|
|
import datetime
|
|
import logging
|
|
|
|
import voluptuous as vol
|
|
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.components.light import (
|
|
is_on, turn_on, VALID_TRANSITION, ATTR_TRANSITION)
|
|
from homeassistant.components.switch import DOMAIN, SwitchDevice
|
|
from homeassistant.const import (
|
|
CONF_NAME, CONF_PLATFORM, CONF_LIGHTS, CONF_MODE)
|
|
from homeassistant.helpers.event import track_time_change
|
|
from homeassistant.helpers.sun import get_astral_event_date
|
|
from homeassistant.util import slugify
|
|
from homeassistant.util.color import (
|
|
color_temperature_to_rgb, color_RGB_to_xy,
|
|
color_temperature_kelvin_to_mired)
|
|
from homeassistant.util.dt import now as dt_now
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
CONF_START_TIME = 'start_time'
|
|
CONF_STOP_TIME = 'stop_time'
|
|
CONF_START_CT = 'start_colortemp'
|
|
CONF_SUNSET_CT = 'sunset_colortemp'
|
|
CONF_STOP_CT = 'stop_colortemp'
|
|
CONF_BRIGHTNESS = 'brightness'
|
|
CONF_DISABLE_BRIGHTNESS_ADJUST = 'disable_brightness_adjust'
|
|
CONF_INTERVAL = 'interval'
|
|
|
|
MODE_XY = 'xy'
|
|
MODE_MIRED = 'mired'
|
|
MODE_RGB = 'rgb'
|
|
DEFAULT_MODE = MODE_XY
|
|
DEPENDENCIES = ['light']
|
|
|
|
|
|
PLATFORM_SCHEMA = vol.Schema({
|
|
vol.Required(CONF_PLATFORM): 'flux',
|
|
vol.Required(CONF_LIGHTS): cv.entity_ids,
|
|
vol.Optional(CONF_NAME, default="Flux"): cv.string,
|
|
vol.Optional(CONF_START_TIME): cv.time,
|
|
vol.Optional(CONF_STOP_TIME): cv.time,
|
|
vol.Optional(CONF_START_CT, default=4000):
|
|
vol.All(vol.Coerce(int), vol.Range(min=1000, max=40000)),
|
|
vol.Optional(CONF_SUNSET_CT, default=3000):
|
|
vol.All(vol.Coerce(int), vol.Range(min=1000, max=40000)),
|
|
vol.Optional(CONF_STOP_CT, default=1900):
|
|
vol.All(vol.Coerce(int), vol.Range(min=1000, max=40000)),
|
|
vol.Optional(CONF_BRIGHTNESS):
|
|
vol.All(vol.Coerce(int), vol.Range(min=0, max=255)),
|
|
vol.Optional(CONF_DISABLE_BRIGHTNESS_ADJUST): cv.boolean,
|
|
vol.Optional(CONF_MODE, default=DEFAULT_MODE):
|
|
vol.Any(MODE_XY, MODE_MIRED, MODE_RGB),
|
|
vol.Optional(CONF_INTERVAL, default=30): cv.positive_int,
|
|
vol.Optional(ATTR_TRANSITION, default=30): VALID_TRANSITION
|
|
})
|
|
|
|
|
|
def set_lights_xy(hass, lights, x_val, y_val, brightness, transition):
|
|
"""Set color of array of lights."""
|
|
for light in lights:
|
|
if is_on(hass, light):
|
|
turn_on(hass, light,
|
|
xy_color=[x_val, y_val],
|
|
brightness=brightness,
|
|
transition=transition)
|
|
|
|
|
|
def set_lights_temp(hass, lights, mired, brightness, transition):
|
|
"""Set color of array of lights."""
|
|
for light in lights:
|
|
if is_on(hass, light):
|
|
turn_on(hass, light,
|
|
color_temp=int(mired),
|
|
brightness=brightness,
|
|
transition=transition)
|
|
|
|
|
|
def set_lights_rgb(hass, lights, rgb, transition):
|
|
"""Set color of array of lights."""
|
|
for light in lights:
|
|
if is_on(hass, light):
|
|
turn_on(hass, light,
|
|
rgb_color=rgb,
|
|
transition=transition)
|
|
|
|
|
|
# pylint: disable=unused-argument
|
|
def setup_platform(hass, config, add_devices, discovery_info=None):
|
|
"""Set up the Flux switches."""
|
|
name = config.get(CONF_NAME)
|
|
lights = config.get(CONF_LIGHTS)
|
|
start_time = config.get(CONF_START_TIME)
|
|
stop_time = config.get(CONF_STOP_TIME)
|
|
start_colortemp = config.get(CONF_START_CT)
|
|
sunset_colortemp = config.get(CONF_SUNSET_CT)
|
|
stop_colortemp = config.get(CONF_STOP_CT)
|
|
brightness = config.get(CONF_BRIGHTNESS)
|
|
disable_brightness_adjust = config.get(CONF_DISABLE_BRIGHTNESS_ADJUST)
|
|
mode = config.get(CONF_MODE)
|
|
interval = config.get(CONF_INTERVAL)
|
|
transition = config.get(ATTR_TRANSITION)
|
|
flux = FluxSwitch(name, hass, lights, start_time, stop_time,
|
|
start_colortemp, sunset_colortemp, stop_colortemp,
|
|
brightness, disable_brightness_adjust, mode, interval,
|
|
transition)
|
|
add_devices([flux])
|
|
|
|
def update(call=None):
|
|
"""Update lights."""
|
|
flux.flux_update()
|
|
|
|
service_name = slugify("{} {}".format(name, 'update'))
|
|
hass.services.register(DOMAIN, service_name, update)
|
|
|
|
|
|
class FluxSwitch(SwitchDevice):
|
|
"""Representation of a Flux switch."""
|
|
|
|
def __init__(self, name, hass, lights, start_time, stop_time,
|
|
start_colortemp, sunset_colortemp, stop_colortemp,
|
|
brightness, disable_brightness_adjust, mode, interval,
|
|
transition):
|
|
"""Initialize the Flux switch."""
|
|
self._name = name
|
|
self.hass = hass
|
|
self._lights = lights
|
|
self._start_time = start_time
|
|
self._stop_time = stop_time
|
|
self._start_colortemp = start_colortemp
|
|
self._sunset_colortemp = sunset_colortemp
|
|
self._stop_colortemp = stop_colortemp
|
|
self._brightness = brightness
|
|
self._disable_brightness_adjust = disable_brightness_adjust
|
|
self._mode = mode
|
|
self._interval = interval
|
|
self._transition = transition
|
|
self.unsub_tracker = None
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the device if any."""
|
|
return self._name
|
|
|
|
@property
|
|
def is_on(self):
|
|
"""Return true if switch is on."""
|
|
return self.unsub_tracker is not None
|
|
|
|
def turn_on(self, **kwargs):
|
|
"""Turn on flux."""
|
|
if self.is_on:
|
|
return
|
|
|
|
# Make initial update
|
|
self.flux_update()
|
|
|
|
self.unsub_tracker = track_time_change(
|
|
self.hass, self.flux_update, second=[0, self._interval])
|
|
|
|
self.schedule_update_ha_state()
|
|
|
|
def turn_off(self, **kwargs):
|
|
"""Turn off flux."""
|
|
if self.unsub_tracker is not None:
|
|
self.unsub_tracker()
|
|
self.unsub_tracker = None
|
|
|
|
self.schedule_update_ha_state()
|
|
|
|
def flux_update(self, now=None):
|
|
"""Update all the lights using flux."""
|
|
if now is None:
|
|
now = dt_now()
|
|
|
|
sunset = get_astral_event_date(self.hass, 'sunset', now.date())
|
|
start_time = self.find_start_time(now)
|
|
stop_time = self.find_stop_time(now)
|
|
|
|
if stop_time <= start_time:
|
|
# stop_time does not happen in the same day as start_time
|
|
if start_time < now:
|
|
# stop time is tomorrow
|
|
stop_time += datetime.timedelta(days=1)
|
|
elif now < start_time:
|
|
# stop_time was yesterday since the new start_time is not reached
|
|
stop_time -= datetime.timedelta(days=1)
|
|
|
|
if start_time < now < sunset:
|
|
# Daytime
|
|
time_state = 'day'
|
|
temp_range = abs(self._start_colortemp - self._sunset_colortemp)
|
|
day_length = int(sunset.timestamp() - start_time.timestamp())
|
|
seconds_from_start = int(now.timestamp() - start_time.timestamp())
|
|
percentage_complete = seconds_from_start / day_length
|
|
temp_offset = temp_range * percentage_complete
|
|
if self._start_colortemp > self._sunset_colortemp:
|
|
temp = self._start_colortemp - temp_offset
|
|
else:
|
|
temp = self._start_colortemp + temp_offset
|
|
else:
|
|
# Night time
|
|
time_state = 'night'
|
|
|
|
if now < stop_time:
|
|
if stop_time < start_time and stop_time.day == sunset.day:
|
|
# we need to use yesterday's sunset time
|
|
sunset_time = sunset - datetime.timedelta(days=1)
|
|
else:
|
|
sunset_time = sunset
|
|
|
|
# pylint: disable=no-member
|
|
night_length = int(stop_time.timestamp() -
|
|
sunset_time.timestamp())
|
|
seconds_from_sunset = int(now.timestamp() -
|
|
sunset_time.timestamp())
|
|
percentage_complete = seconds_from_sunset / night_length
|
|
else:
|
|
percentage_complete = 1
|
|
|
|
temp_range = abs(self._sunset_colortemp - self._stop_colortemp)
|
|
temp_offset = temp_range * percentage_complete
|
|
if self._sunset_colortemp > self._stop_colortemp:
|
|
temp = self._sunset_colortemp - temp_offset
|
|
else:
|
|
temp = self._sunset_colortemp + temp_offset
|
|
rgb = color_temperature_to_rgb(temp)
|
|
x_val, y_val, b_val = color_RGB_to_xy(*rgb)
|
|
brightness = self._brightness if self._brightness else b_val
|
|
if self._disable_brightness_adjust:
|
|
brightness = None
|
|
if self._mode == MODE_XY:
|
|
set_lights_xy(self.hass, self._lights, x_val,
|
|
y_val, brightness, self._transition)
|
|
_LOGGER.info("Lights updated to x:%s y:%s brightness:%s, %s%% "
|
|
"of %s cycle complete at %s", x_val, y_val,
|
|
brightness, round(
|
|
percentage_complete * 100), time_state, now)
|
|
elif self._mode == MODE_RGB:
|
|
set_lights_rgb(self.hass, self._lights, rgb, self._transition)
|
|
_LOGGER.info("Lights updated to rgb:%s, %s%% "
|
|
"of %s cycle complete at %s", rgb,
|
|
round(percentage_complete * 100), time_state, now)
|
|
else:
|
|
# Convert to mired and clamp to allowed values
|
|
mired = color_temperature_kelvin_to_mired(temp)
|
|
set_lights_temp(self.hass, self._lights, mired, brightness,
|
|
self._transition)
|
|
_LOGGER.info("Lights updated to mired:%s brightness:%s, %s%% "
|
|
"of %s cycle complete at %s", mired, brightness,
|
|
round(percentage_complete * 100), time_state, now)
|
|
|
|
def find_start_time(self, now):
|
|
"""Return sunrise or start_time if given."""
|
|
if self._start_time:
|
|
sunrise = now.replace(
|
|
hour=self._start_time.hour, minute=self._start_time.minute,
|
|
second=0)
|
|
else:
|
|
sunrise = get_astral_event_date(self.hass, 'sunrise', now.date())
|
|
return sunrise
|
|
|
|
def find_stop_time(self, now):
|
|
"""Return dusk or stop_time if given."""
|
|
if self._stop_time:
|
|
dusk = now.replace(
|
|
hour=self._stop_time.hour, minute=self._stop_time.minute,
|
|
second=0)
|
|
else:
|
|
dusk = get_astral_event_date(self.hass, 'dusk', now.date())
|
|
return dusk
|