adaptive-lighting/custom_components/circadian_lighting/__init__.py

"""
Circadian Lighting Component for Home-Assistant.

This component calculates color temperature and brightness to synchronize
your color changing lights with perceived color temperature of the sky throughout
the day. This gives your environment a more natural feel, with cooler whites during
the midday and warmer tints near twilight and dawn.

In addition, the component sets your lights to a nice warm white at 1% in "Sleep" mode,
which is far brighter than starlight but won't reset your circadian rhythm or break down
too much rhodopsin in your eyes.

Human circadian rhythms are heavily influenced by ambient light levels and
hues. Hormone production, brainwave activity, mood and wakefulness are
just some of the cognitive functions tied to cyclical natural light.
http://en.wikipedia.org/wiki/Zeitgeber

Here's some further reading:

http://www.cambridgeincolour.com/tutorials/sunrise-sunset-calculator.htm
http://en.wikipedia.org/wiki/Color_temperature

Technical notes: I had to make a lot of assumptions when writing this app
    *   There are no considerations for weather or altitude, but does use your
        hub's location to calculate the sun position.
    *   The component doesn't calculate a true "Blue Hour" -- it just sets the
        lights to 2700K (warm white) until your hub goes into Night mode
"""

import logging

import voluptuous as vol

import homeassistant.helpers.config_validation as cv
from homeassistant.components.light import (
    VALID_TRANSITION, ATTR_TRANSITION)
from homeassistant.const import (
    CONF_LATITUDE, CONF_LONGITUDE, CONF_ELEVATION,
    SUN_EVENT_SUNRISE, SUN_EVENT_SUNSET)
from homeassistant.util import Throttle
from homeassistant.helpers.discovery import load_platform
from homeassistant.helpers.dispatcher import dispatcher_send
from homeassistant.helpers.event import track_sunrise, track_sunset, track_time_change
from homeassistant.util.color import (
    color_temperature_to_rgb, color_RGB_to_xy,
    color_xy_to_hs)
from homeassistant.util.dt import utcnow as dt_utcnow, as_local

from datetime import datetime, timedelta

VERSION = '1.0.10b'

_LOGGER = logging.getLogger(__name__)

DOMAIN = 'circadian_lighting'
CIRCADIAN_LIGHTING_PLATFORMS = ['sensor', 'switch']
CIRCADIAN_LIGHTING_UPDATE_TOPIC = '{0}_update'.format(DOMAIN)
DATA_CIRCADIAN_LIGHTING = 'data_cl'

CONF_MIN_CT = 'min_colortemp'
DEFAULT_MIN_CT = 2500
CONF_MAX_CT = 'max_colortemp'
DEFAULT_MAX_CT = 5500
CONF_SUNRISE_OFFSET = 'sunrise_offset'
CONF_SUNSET_OFFSET = 'sunset_offset'
CONF_SUNRISE_TIME = 'sunrise_time'
CONF_SUNSET_TIME = 'sunset_time'
CONF_INTERVAL = 'interval'
DEFAULT_INTERVAL = 300
DEFAULT_TRANSITION = 60

CONFIG_SCHEMA = vol.Schema({
    DOMAIN: vol.Schema({
        vol.Optional(CONF_MIN_CT, default=DEFAULT_MIN_CT):
            vol.All(vol.Coerce(int), vol.Range(min=1000, max=10000)),
        vol.Optional(CONF_MAX_CT, default=DEFAULT_MAX_CT):
            vol.All(vol.Coerce(int), vol.Range(min=1000, max=10000)),
        vol.Optional(CONF_SUNRISE_OFFSET): cv.time_period_str,
        vol.Optional(CONF_SUNSET_OFFSET): cv.time_period_str,
        vol.Optional(CONF_SUNRISE_TIME): cv.time,
        vol.Optional(CONF_SUNSET_TIME): cv.time,
        vol.Optional(CONF_LATITUDE): cv.latitude,
        vol.Optional(CONF_LONGITUDE): cv.longitude,
        vol.Optional(CONF_ELEVATION): float,
        vol.Optional(CONF_INTERVAL, default=DEFAULT_INTERVAL): cv.positive_int,
        vol.Optional(ATTR_TRANSITION, default=DEFAULT_TRANSITION): VALID_TRANSITION
    }),
}, extra=vol.ALLOW_EXTRA)

def setup(hass, config):
    """Set up the Circadian Lighting component."""
    conf = config[DOMAIN]
    min_colortemp = conf.get(CONF_MIN_CT)
    max_colortemp = conf.get(CONF_MAX_CT)
    sunrise_offset = conf.get(CONF_SUNRISE_OFFSET)
    sunset_offset = conf.get(CONF_SUNSET_OFFSET)
    sunrise_time = conf.get(CONF_SUNRISE_TIME)
    sunset_time = conf.get(CONF_SUNSET_TIME)

    latitude = conf.get(CONF_LATITUDE, hass.config.latitude)
    longitude = conf.get(CONF_LONGITUDE, hass.config.longitude)
    elevation = conf.get(CONF_ELEVATION, hass.config.elevation)

    load_platform(hass, 'sensor', DOMAIN, {}, config)

    interval = conf.get(CONF_INTERVAL)
    transition = conf.get(ATTR_TRANSITION)

    cl = CircadianLighting(hass, min_colortemp, max_colortemp,
                    sunrise_offset, sunset_offset, sunrise_time, sunset_time,
                    latitude, longitude, elevation,
                    interval, transition)

    hass.data[DATA_CIRCADIAN_LIGHTING] = cl

    return True

class CircadianLighting(object):
    """Calculate universal Circadian values."""

    def __init__(self, hass, min_colortemp, max_colortemp,
                    sunrise_offset, sunset_offset, sunrise_time, sunset_time,
                    latitude, longitude, elevation,
                    interval, transition):
        self.hass = hass
        self.data = {}
        self.data['min_colortemp'] = min_colortemp
        self.data['max_colortemp'] = max_colortemp
        self.data['sunrise_offset'] = sunrise_offset
        self.data['sunset_offset'] = sunset_offset
        self.data['sunrise_time'] = sunrise_time
        self.data['sunset_time'] = sunset_time
        self.data['latitude'] = latitude
        self.data['longitude'] = longitude
        self.data['elevation'] = elevation
        self.data['interval'] = interval
        self.data['transition'] = transition
        self.data['percent'] = self.calc_percent()
        self.data['colortemp'] = self.calc_colortemp()
        self.data['rgb_color'] = self.calc_rgb()
        self.data['xy_color'] = self.calc_xy()
        self.data['hs_color'] = self.calc_hs()

        self.update = Throttle(timedelta(seconds=interval))(self._update)

        if self.data['sunrise_time'] is not None:
            track_time_change(self.hass, self._update, hour=int(self.data['sunrise_time'].strftime("%H")), minute=int(self.data['sunrise_time'].strftime("%M")), second=int(self.data['sunrise_time'].strftime("%S")))
        else:
            track_sunrise(self.hass, self._update, self.data['sunrise_offset'])
        if self.data['sunset_time'] is not None:
            track_time_change(self.hass, self._update, hour=int(self.data['sunset_time'].strftime("%H")), minute=int(self.data['sunset_time'].strftime("%M")), second=int(self.data['sunset_time'].strftime("%S")))
        else:
            track_sunset(self.hass, self._update, self.data['sunset_offset'])

    def get_sunrise_sunset(self, date = None):
        if self.data['sunrise_time'] is not None and self.data['sunset_time'] is not None:
            if date is None:
                utcdate = dt_utcnow()
                date = as_local(utcdate)
            sunrise = date.replace(hour=int(self.data['sunrise_time'].strftime("%H")), minute=int(self.data['sunrise_time'].strftime("%M")), second=int(self.data['sunrise_time'].strftime("%S")), microsecond=int(self.data['sunrise_time'].strftime("%f")))
            sunset = date.replace(hour=int(self.data['sunset_time'].strftime("%H")), minute=int(self.data['sunset_time'].strftime("%M")), second=int(self.data['sunset_time'].strftime("%S")), microsecond=int(self.data['sunset_time'].strftime("%f")))
            solar_noon = sunrise + (sunset - sunrise)/2
            solar_midnight = sunset + ((sunrise + timedelta(days=1)) - sunset)/2
        else:
            import astral
            location = astral.Location()
            location.name = 'name'
            location.region = 'region'
            location.latitude = self.data['latitude']
            location.longitude = self.data['longitude']
            location.elevation = self.data['elevation']
            _LOGGER.debug("Astral location: " + str(location))
            if self.data['sunrise_time'] is not None:
                if date is None:
                    utcdate = dt_utcnow()
                    date = as_local(utcdate)
                sunrise = date.replace(hour=int(self.data['sunrise_time'].strftime("%H")), minute=int(self.data['sunrise_time'].strftime("%M")), second=int(self.data['sunrise_time'].strftime("%S")), microsecond=int(self.data['sunrise_time'].strftime("%f")))
            else:
                sunrise = location.sunrise(date)
            if self.data['sunset_time'] is not None:
                if date is None:
                    utcdate = dt_utcnow()
                    date = as_local(utcdate)
                sunset = date.replace(hour=int(self.data['sunset_time'].strftime("%H")), minute=int(self.data['sunset_time'].strftime("%M")), second=int(self.data['sunset_time'].strftime("%S")), microsecond=int(self.data['sunset_time'].strftime("%f")))
            else:
                sunset = location.sunset(date)
            solar_noon = location.solar_noon(date)
            solar_midnight = location.solar_midnight(date)
        if self.data['sunrise_offset'] is not None:
            sunrise = sunrise + self.data['sunrise_offset']
        if self.data['sunset_offset'] is not None:
            sunset = sunset + self.data['sunset_offset']
        return {
            SUN_EVENT_SUNRISE: sunrise,
            SUN_EVENT_SUNSET: sunset,
            'solar_noon': solar_noon,
            'solar_midnight': solar_midnight
        }

    def calc_percent(self):
        utcnow = dt_utcnow()
        now = as_local(utcnow)
        _LOGGER.debug("now: " + str(now))

        today_sun_times = self.get_sunrise_sunset(now)
        _LOGGER.debug("today_sun_times: " + str(today_sun_times))

        # Convert everything to epoch timestamps for easy calculation
        now_seconds = now.timestamp()
        sunrise_seconds = today_sun_times[SUN_EVENT_SUNRISE].timestamp()
        sunset_seconds = today_sun_times[SUN_EVENT_SUNSET].timestamp()
        solar_noon_seconds = today_sun_times['solar_noon'].timestamp()
        solar_midnight_seconds = today_sun_times['solar_midnight'].timestamp()

        if now < today_sun_times[SUN_EVENT_SUNRISE]: # It's before sunrise (after midnight)
            # Because it's before sunrise (and after midnight) sunset must have happend yesterday
            yesterday_sun_times = self.get_sunrise_sunset(now - timedelta(days=1))
            _LOGGER.debug("yesterday_sun_times: " + str(yesterday_sun_times))
            sunset_seconds = yesterday_sun_times[SUN_EVENT_SUNSET].timestamp()
            if today_sun_times['solar_midnight'] > today_sun_times[SUN_EVENT_SUNSET] and yesterday_sun_times['solar_midnight'] > yesterday_sun_times[SUN_EVENT_SUNSET]:
                # Solar midnight is after sunset so use yesterdays's time
                solar_midnight_seconds = yesterday_sun_times['solar_midnight'].timestamp()
        elif now > today_sun_times[SUN_EVENT_SUNSET]: # It's after sunset (before midnight)
            # Because it's after sunset (and before midnight) sunrise should happen tomorrow
            tomorrow_sun_times = self.get_sunrise_sunset(now + timedelta(days=1))
            _LOGGER.debug("tomorrow_sun_times: " + str(tomorrow_sun_times))
            sunrise_seconds = tomorrow_sun_times[SUN_EVENT_SUNRISE].timestamp()
            if today_sun_times['solar_midnight'] < today_sun_times[SUN_EVENT_SUNRISE] and tomorrow_sun_times['solar_midnight'] < tomorrow_sun_times[SUN_EVENT_SUNRISE]:
                # Solar midnight is before sunrise so use tomorrow's time
                solar_midnight_seconds = tomorrow_sun_times['solar_midnight'].timestamp()

        _LOGGER.debug("now_seconds: " + str(now_seconds))
        _LOGGER.debug("sunrise_seconds: " + str(sunrise_seconds))
        _LOGGER.debug("sunset_seconds: " + str(sunset_seconds))
        _LOGGER.debug("solar_midnight_seconds: " + str(solar_midnight_seconds))
        _LOGGER.debug("solar_noon_seconds: " + str(solar_noon_seconds))

        # Figure out where we are in time so we know which half of the parabola to calculate
        # We're generating a different sunset-sunrise parabola for before and after solar midnight
        # because it might not be half way between sunrise and sunset
        # We're also (obviously) generating a different parabola for sunrise-sunset

        # sunrise-sunset parabola
        if now_seconds > sunrise_seconds and now_seconds < sunset_seconds:
            h = solar_noon_seconds
            k = 100
            # parabola before solar_noon
            if now_seconds < solar_noon_seconds:
                x = sunrise_seconds
            # parabola after solar_noon
            else:
                x = sunset_seconds
            y = 0

        # sunset_sunrise parabola
        elif now_seconds > sunset_seconds and now_seconds < sunrise_seconds:
            h = solar_midnight_seconds
            k = -100
            # parabola before solar_midnight
            if now_seconds < solar_midnight_seconds:
                x = sunset_seconds
            # parabola after solar_midnight
            else:
                x = sunrise_seconds
            y = 0

        a = (y-k)/(h-x)**2
        percentage = a*(now_seconds-h)**2+k

        _LOGGER.debug("h: " + str(h))
        _LOGGER.debug("k: " + str(k))
        _LOGGER.debug("x: " + str(x))
        _LOGGER.debug("y: " + str(y))
        _LOGGER.debug("a: " + str(a))
        _LOGGER.debug("percentage: " + str(percentage))

        return percentage

    def calc_colortemp(self):
        if self.data['percent'] > 0:
            return ((self.data['max_colortemp'] - self.data['min_colortemp']) * (self.data['percent'] / 100)) + self.data['min_colortemp']
        else:
            return self.data['min_colortemp']

    def calc_rgb(self):
        return color_temperature_to_rgb(self.data['colortemp'])

    def calc_xy(self):
        rgb = self.calc_rgb()
        iR = rgb[0]
        iG = rgb[1]
        iB = rgb[2]

        return color_RGB_to_xy(iR, iG, iB)

    def calc_hs(self):
        xy = self.calc_xy()
        vX = xy[0]
        vY = xy[1]

        return color_xy_to_hs(vX, vY)

    def _update(self, *args, **kwargs):
        """Update Circadian Values."""
        self.data['percent'] = self.calc_percent()
        self.data['colortemp'] = self.calc_colortemp()
        self.data['rgb_color'] = self.calc_rgb()
        self.data['xy_color'] = self.calc_xy()
        self.data['hs_color'] = self.calc_hs()
        dispatcher_send(self.hass, CIRCADIAN_LIGHTING_UPDATE_TOPIC)
        _LOGGER.debug("Circadian Lighting Component Updated")