Move to single switch and UI configurable (preparation for PR into homeassistant/core)

README.md

@@ -1,69 +1,20 @@
-# Circadian Lighting [[Home Assistant](https://www.home-assistant.io/) Component]
-## Stay healthier and sleep better by syncing your lights with natural daylight to maintain your circadian rhythm!
+# Adaptive Lighting component
 
-![Circadian Light Rhythm|690x287](https://community-home-assistant-assets.s3.dualstack.us-west-2.amazonaws.com/original/3X/5/f/5fe7a780e9f8905fea4d1cbb66cdbe35858a6e36.jpg)
+Try out this code by adding https://github.com/basnijholt/adaptive-lighting to your custom repos in HACS and install it!
 
-Circadian Lighting slowly synchronizes your color changing lights with the regular naturally occurring color temperature of the sky throughout the day. This gives your environment a more natural feel, with cooler hues during the midday and warmer tints near twilight and dawn.
+I have not written any docs yet, so I recommend to use the UI to add this integration.
 
-In addition, Circadian Lighting can set your lights to a nice cool 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.
+See [this video on Reddit](https://www.reddit.com/r/homeassistant/comments/j09219/any_circadian_lighting_users_good_news_i_just/) to see how to add the integration and set the options.
 
 
-<details><summary>Expand for articles explaining the benefits of maintaining a natural Circadian rhythm</summary>
-
-* [Circadian Rhythms - National Institute of General Medical Sciences](https://www.nigms.nih.gov/Education/Pages/Factsheet_CircadianRhythms.aspx)
-* [Circadian Rhythms Linked to Aging and Well-Being | Psychology Today](https://www.psychologytoday.com/us/blog/the-athletes-way/201306/circadian-rhythms-linked-aging-and-well-being)
-* [Maintaining a daily rhythm is important for mental health, study suggests - CNN](https://www.cnn.com/2018/05/15/health/circadian-rhythm-mood-disorder-study/index.html)
-* [How Nobel Winning Circadian Rhythm Research Benefits Pregnancy](https://www.healthypregnancy.com/how-nobel-prize-winning-circadian-rhythms-research-benefits-a-healthy-pregnancy/)
-* [Body Clock & Sleep - National Sleep Foundation](https://sleepfoundation.org/sleep-topics/sleep-drive-and-your-body-clock)
-* [How our body’s circadian clocks affect our health beyond sleep](https://www.theverge.com/2018/6/12/17453398/sleep-circadian-code-satchin-panda-clock-health-science)
-
-</details>
-
-### Visit the [Wiki](https://github.com/claytonjn/hass-circadian_lighting/wiki) for more information.
-<hr>
-
-## Basic Installation/Configuration Instructions:
-
-#### Installation:
-Install `custom_component` files automatically using [HACS](https://github.com/claytonjn/hass-circadian_lighting/wiki/Installation-Instructions#hacs) or [Custom Updater](https://github.com/claytonjn/hass-circadian_lighting/wiki/Installation-Instructions#custom-updater), or install [Manually](https://github.com/claytonjn/hass-circadian_lighting/wiki/Installation-Instructions#manual-installation).
-
-[![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg?style=for-the-badge)](https://github.com/custom-components/hacs)
-
-#### Component Configuration:
-```yaml
-# Example configuration.yaml entry
-circadian_lighting:
-```
-[_Advanced Configuration_](https://github.com/claytonjn/hass-circadian_lighting/wiki/Advanced-Configuration#component-configuration-variables)
-
-#### Switch Configuration:
-```yaml
-# Example configuration.yaml entry
-switch:
-  - platform: circadian_lighting
-    lights_ct:
-      - light.desk
-      - light.lamp
-```
-Switch configuration variables:
-* **name** (_Optional_): The name to use when displaying this switch.
-* **lights_ct** (_Optional_): array: List of light entities which should be set in mireds.
-* **lights_rgb** (_Optional_): array: List of light entities which should be set in RGB.
-* **lights_xy** (_Optional_): array: List of light entities which should be set in XY.
-* **lights_brightness** (_Optional_): array: List of light entities which should only have brightness adjusted.
-
-[_Advanced Configuration_](https://github.com/claytonjn/hass-circadian_lighting/wiki/Advanced-Configuration#switch-configuration-variables)
-
-<hr>
-
 ### Graphs!
-These graphs were generated using the values calculated by the Circadian Lighting sensor/switch(es).
+These graphs were generated using the values calculated by the Adaptive Lighting sensor/switch(es).
 
 ##### Sun Position:
 ![cl_percent|690x131](https://community-home-assistant-assets.s3.dualstack.us-west-2.amazonaws.com/original/3X/6/5/657ff98beb65a94598edeb4bdfd939095db1a22c.PNG)
 
 ##### Color Temperature:
-![cl_colortemp|690x129](https://community-home-assistant-assets.s3.dualstack.us-west-2.amazonaws.com/original/3X/5/9/59e84263cbecd8e428cb08777a0413672c48dfcd.PNG)
+![cl_color_temp|690x129](https://community-home-assistant-assets.s3.dualstack.us-west-2.amazonaws.com/original/3X/5/9/59e84263cbecd8e428cb08777a0413672c48dfcd.PNG)
 
 ##### Brightness:
 ![cl_brightness|690x130](https://community-home-assistant-assets.s3.dualstack.us-west-2.amazonaws.com/original/3X/5/8/58ebd994b62a8b1abfb3497a5288d923ff4e2330.PNG)

custom_components/adaptive_lighting/__init__.py

@@ -0,0 +1,111 @@
+"""Adaptive Lighting integration in Home-Assistant.
+
+This integration calculates color temperature and brightness to synchronize
+your color-changing lights with the 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.
+
+Additionally, the integration 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.
+
+Resources:
+- http://en.wikipedia.org/wiki/Zeitgeber
+- http://www.cambridgeincolour.com/tutorials/sunrise-sunset-calculator.htm
+- http://en.wikipedia.org/wiki/Color_temperature
+
+## Notes
+* Only your location is taken into account to calculate the the sun's position.
+* Weather is not considered.
+* The integration does not calculate a true "Blue Hour" -- it just sets the
+  lights to 2700K (warm white) until your hub goes into "Sleep mode".
+"""
+import logging
+from typing import Any, Dict
+
+import voluptuous as vol
+
+from homeassistant.config_entries import SOURCE_IMPORT, ConfigEntry
+from homeassistant.const import CONF_SOURCE
+from homeassistant.core import HomeAssistant
+import homeassistant.helpers.config_validation as cv
+
+from .const import (
+    _DOMAIN_SCHEMA,
+    ATTR_TURN_ON_OFF_LISTENER,
+    CONF_NAME,
+    DOMAIN,
+    UNDO_UPDATE_LISTENER,
+)
+
+_LOGGER = logging.getLogger(__name__)
+
+PLATFORMS = ["switch"]
+
+
+def _all_unique_names(value):
+    """Validate that all entities have a unique profile name."""
+    hosts = [device[CONF_NAME] for device in value]
+    schema = vol.Schema(vol.Unique())
+    schema(hosts)
+    return value
+
+
+CONFIG_SCHEMA = vol.Schema(
+    {DOMAIN: vol.All(cv.ensure_list, [_DOMAIN_SCHEMA], _all_unique_names)},
+    extra=vol.ALLOW_EXTRA,
+)
+
+
+async def async_setup(hass: HomeAssistant, config: Dict[str, Any]):
+    """Import integration from config."""
+
+    if DOMAIN in config:
+        for entry in config[DOMAIN]:
+            hass.async_create_task(
+                hass.config_entries.flow.async_init(
+                    DOMAIN, context={CONF_SOURCE: SOURCE_IMPORT}, data=entry
+                )
+            )
+    return True
+
+
+async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry):
+    """Set up the component."""
+    data = hass.data.setdefault(DOMAIN, {})
+
+    undo_listener = config_entry.add_update_listener(async_update_options)
+    data[config_entry.entry_id] = {UNDO_UPDATE_LISTENER: undo_listener}
+    for platform in PLATFORMS:
+        hass.async_create_task(
+            hass.config_entries.async_forward_entry_setup(config_entry, platform)
+        )
+
+    return True
+
+
+async def async_update_options(hass, config_entry: ConfigEntry):
+    """Update options."""
+    await hass.config_entries.async_reload(config_entry.entry_id)
+
+
+async def async_unload_entry(hass, config_entry: ConfigEntry) -> bool:
+    """Unload a config entry."""
+    unload_ok = await hass.config_entries.async_forward_entry_unload(
+        config_entry, "switch"
+    )
+    data = hass.data[DOMAIN]
+    data[config_entry.entry_id][UNDO_UPDATE_LISTENER]()
+    if len(data) == 1:  # no more config_entries
+        turn_on_off_listener = data.pop(ATTR_TURN_ON_OFF_LISTENER)
+        turn_on_off_listener.remove_listener()
+        turn_on_off_listener.remove_listener2()
+
+    if unload_ok:
+        data.pop(config_entry.entry_id)
+
+    return unload_ok

custom_components/adaptive_lighting/config_flow.py

@@ -0,0 +1,109 @@
+"""Config flow for Adaptive Lighting integration."""
+import logging
+
+import voluptuous as vol
+
+from homeassistant import config_entries
+from homeassistant.const import CONF_NAME
+from homeassistant.core import callback
+import homeassistant.helpers.config_validation as cv
+
+from .const import (  # pylint: disable=unused-import
+    CONF_LIGHTS,
+    DOMAIN,
+    EXTRA_VALIDATION,
+    NONE_STR,
+    VALIDATION_TUPLES,
+)
+from .switch import _supported_features
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class ConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
+    """Handle a config flow for Adaptive Lighting."""
+
+    VERSION = 1
+
+    async def async_step_user(self, user_input=None):
+        """Handle the initial step."""
+        errors = {}
+
+        if user_input is not None:
+            await self.async_set_unique_id(user_input[CONF_NAME])
+            self._abort_if_unique_id_configured()
+            return self.async_create_entry(title=user_input[CONF_NAME], data=user_input)
+
+        return self.async_show_form(
+            step_id="user",
+            data_schema=vol.Schema({vol.Required(CONF_NAME): str}),
+            errors=errors,
+        )
+
+    async def async_step_import(self, user_input=None):
+        """Handle configuration by yaml file."""
+        await self.async_set_unique_id(user_input[CONF_NAME])
+        for entry in self._async_current_entries():
+            if entry.unique_id == self.unique_id:
+                self.hass.config_entries.async_update_entry(entry, data=user_input)
+                self._abort_if_unique_id_configured()
+        return self.async_create_entry(title=user_input[CONF_NAME], data=user_input)
+
+    @staticmethod
+    @callback
+    def async_get_options_flow(config_entry):
+        """Get the options flow for this handler."""
+        return OptionsFlowHandler(config_entry)
+
+
+def validate_options(user_input, errors):
+    """Validate the options in the OptionsFlow.
+
+    This is an extra validation step because the validators
+    in `EXTRA_VALIDATION` cannot be serialized to json.
+    """
+    for key, (validate, _) in EXTRA_VALIDATION.items():
+        # these are unserializable validators
+        value = user_input.get(key)
+        try:
+            if value is not None and value != NONE_STR:
+                validate(value)
+        except vol.Invalid:
+            _LOGGER.exception("Configuration option %s=%s is incorrect", key, value)
+            errors["base"] = "option_error"
+
+
+class OptionsFlowHandler(config_entries.OptionsFlow):
+    """Handle a option flow for Adaptive Lighting."""
+
+    def __init__(self, config_entry: config_entries.ConfigEntry):
+        """Initialize options flow."""
+        self.config_entry = config_entry
+
+    async def async_step_init(self, user_input=None):
+        """Handle options flow."""
+        conf = self.config_entry
+        if conf.source == config_entries.SOURCE_IMPORT:
+            return self.async_show_form(step_id="init", data_schema={})
+        errors = {}
+        if user_input is not None:
+            validate_options(user_input, errors)
+            if not errors:
+                return self.async_create_entry(title="", data=user_input)
+
+        all_lights = [
+            light
+            for light in self.hass.states.async_entity_ids("light")
+            if _supported_features(self.hass, light)
+        ]
+        to_replace = {CONF_LIGHTS: cv.multi_select(sorted(all_lights))}
+
+        options_schema = {}
+        for name, default, validation in VALIDATION_TUPLES:
+            key = vol.Optional(name, default=conf.options.get(name, default))
+            value = to_replace.get(name, validation)
+            options_schema[key] = value
+
+        return self.async_show_form(
+            step_id="init", data_schema=vol.Schema(options_schema), errors=errors
+        )