Adaptive Lighting component for Home Assistant
Try out this code by adding 
GitHub - basnijholt/adaptive-lighting: Adaptive Lighting custom component for Home Assistant to your custom repos in HACS and install it!
This custom_component is also being added to core, see this PR, although it might take a looooooong time before it makes it in.
The adaptive_lighting platform changes the settings of your lights throughout the day.
It uses the position of the sun to calculate the color temperature and brightness that is most fitting for that time of the day.
Scientific research has shown that this helps to maintain your natural circadian rhythm (your biological clock) and might lead to improved sleep, mood, and general well-being.
In practical terms, this means that after the sun sets, the brightness of your lights will decrease to a certain minimum brightness, while the color temperature will be at its coolest color temperature at noon, after which it will decrease and reach its warmest color at sunset.
Around sunrise, the opposite will happen.
Additionally, the integration provides a way to define and set your lights in āsleep modeā.
When āsleep modeā is enabled, the lights will be at a minimal brightness and have a very warm color.
The integration creates 4 switches (in this example the componentās name is "living_room"):
switch.adaptive_lighting_living_room, which turns the Adaptive Lighting integration on or off. It has several attributes that show the current light settings.switch.adaptive_lighting_sleep_mode_living_room, which when activated, turns on āsleep modeā (you can set a specificsleep_brightnessandsleep_color_temp).switch.adaptive_lighting_adapt_brightness_living_room, which sets whether the integration should adapt the brightness of the lights (if supported by the light).switch.adaptive_lighting_adapt_color_living_room, which sets whether the integration should adapt the color of the lights (if supported by the light).
This integration was originally based on the great work of @claytonjn GitHub - claytonjn/hass-circadian_lighting: Circadian Lighting custom component for Home Assistant, but has been 100% rewritten and extended with new features.
Taking back control
Although having your lights automatically adapt is great most of the time, there might be times at which you want to set the lights to a different color/brightness and keep it that way.
For this purpose, the integration (when take_over_control is enabled) automatically detects whether someone (e.g., person toggling the light switch) or something (automation) changes the lights.
If this happens and the light is already on, the light that was changed gets marked as āmanually controlledā and the Adaptive Lighting component will stop adapting that light until it turns off and on again (or if you use the service call adaptive_lighting.set_manual_control).
This mechanism works by listening to all light.turn_on calls that change the color or brightness and by noting that the component did not make the call.
Additionally, there is an option to detect all state changes (when detect_non_ha_changes is enabled), so also changes to the lights that were not made by a light.turn_on call (e.g., through an app or via something outside of Home Assistant.)
It does this by comparing a lightās state to Adaptive Lightingās previously used settings.
Whenever a light gets marked as āmanually controlledā, an adaptive_lighting.manual_control event is fired, such that one can use this information in automations.
Configuration
This app shows the effect of the sun-color-brigthness related settings Shiny App :
This integration is both fully configurable through YAML and the frontend. (Configuration ā Integrations ā Adaptive Lighting, Adaptive Lighting ā Options)
Here, the options in the frontend and in YAML have the same names.
# Example configuration.yaml entry
adaptive_lighting:
lights:
- light.living_room_lights
Options
| option | description | required | default | type |
|---|---|---|---|---|
| name | The name to use when displaying this switch. | False | default | string |
| lights | List of light entities for Adaptive Lighting to control (may be empty). | False | list | |
| prefer_rgb_color | Whether to use RGB color adjustment instead of native light color temperature. | False | False | boolean |
| initial_transition | How long the first transition is when the lights go from off to on (or when āsleep modeā is toggled). |
False | 1 | time |
| transition | How long the transition is when the lights change, in seconds. | False | 45 | integer |
| interval | How often to adapt the lights, in seconds. | False | 90 | integer |
| min_brightness | The minimum percent of brightness to set the lights to. | False | 1 | integer |
| max_brightness | The maximum percent of brightness to set the lights to. | False | 100 | integer |
| min_color_temp | The warmest color temperature to set the lights to, in Kelvin. | False | 2000 | integer |
| max_color_temp | The coldest color temperature to set the lights to, in Kelvin. | False | 5500 | integer |
| sleep_brightness | Brightness of lights while the sleep mode is enabled. | False | 1 | integer |
| sleep_color_temp | Color temperature of lights while the sleep mode is enabled. | False | 1000 | integer |
| sunrise_time | Override the sunrise time with a fixed time. | False | time | |
| sunrise_offset | Change the sunrise time with a positive or negative offset. | False | 0 | time |
| sunset_time | Override the sunset time with a fixed time. | False | time | |
| sunset_offset | Change the sunset time with a positive or negative offset. | False | 0 | time |
| only_once | Whether to keep adapting the lights (false) or to only adapt the lights as soon as they are turned on (true). | False | False | boolean |
| take_over_control | If another source calls light.turn_on while the lights are on and being adapted, disable Adaptive Lighting. |
False | True | boolean |
| detect_non_ha_changes | Whether to detect state changes and stop adapting lights, even not from light.turn_on. Needs take_over_control to be enabled. Note that by enabling this option, it calls āhomeassistant.update_entityā every āintervalā! |
False | False | boolean |
| separate_turn_on_commands | Whether to use separate light.turn_on calls for color and brightness, needed for some types of lights |
False | False | boolean |
Full example:
# Example configuration.yaml entry
adaptive_lighting:
- name: "default"
lights: []
prefer_rgb_color: false
transition: 45
initial_transition: 1
interval: 90
min_brightness: 1
max_brightness: 100
min_color_temp: 2000
max_color_temp: 5500
sleep_brightness: 1
sleep_color_temp: 1000
sunrise_time: "08:00:00" # override the sunrise time
sunrise_offset:
sunset_time:
sunset_offset: 1800 # in seconds or '00:15:00'
take_over_control: true
detect_non_ha_changes: false
separate_turn_on_commands: false
only_once: false
Services
adaptive_lighting.apply applies Adaptive Lighting settings to lights on demand.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id |
no | The entity_id of the switch with the settings to apply. |
lights |
no | A light (or list of lights) to apply the settings to. |
transition |
yes | The number of seconds for the transition. |
adapt_brightness |
yes | Whether to change the brightness of the light or not. |
adapt_color |
yes | Whether to adapt the color on supporting lights. |
prefer_rgb_color |
yes | Whether to prefer RGB color adjustment over of native light color temperature when possible. |
turn_on_lights |
yes | Whether to turn on lights that are currently off. |
adaptive_lighting.set_manual_control can mark (or unmark) whether a light is āmanually controlledā, meaning that when a light has manual_control, the light is not adapted.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id |
no | The entity_id of the switch in which to (un)mark the light as being āmanually controlledā. |
lights |
no | A light (or list of lights) to apply the settings to. |
manual_control |
no | Whether to mark (true) or unmark (false) the light as āmanually controlledā, when not specified it selects all lights in the switch. |
Automation examples
Reset the manual_control status of a light after an hour.
- alias: "Adaptive lighting: reset manual_control after 1 hour"
mode: parallel
trigger:
platform: event
event_type: adaptive_lighting.manual_control
variables:
light: "{{ trigger.event.data.entity_id }}"
switch: "{{ trigger.event.data.switch }}"
action:
- delay: "01:00:00"
- condition: template
value_template: "{{ light in state_attr(switch, 'manual_control') }}"
- service: adaptive_lighting.set_manual_control
data:
entity_id: "{{ switch }}"
lights: "{{ light }}"
manual_control: false
Toggle multiple Adaptive Lighting switches to āsleep modeā using an input_boolean.sleep_mode.
- alias: "Adaptive lighting: toggle 'sleep mode'"
trigger:
- platform: state
entity_id: input_boolean.sleep_mode
- platform: homeassistant
event: start # in case the states aren't properly restored
variables:
sleep_mode: "{{ states('input_boolean.sleep_mode') }}"
action:
service: "switch.turn_{{ sleep_mode }}"
entity_id:
- switch.adaptive_lighting_sleep_mode_living_room
- switch.adaptive_lighting_sleep_mode_bedroom
Other
See the documentation of the PR at Adaptive Lighting - Home Assistant and this video on Reddit to see how to add the integration and set the options.
The was already another topic on the forums (New Adaptive Lighting Integration) by @dbrunt. I opened a new one to be able to control the first post with docs.
Having problems?
Please enable debug logging by putting this in configuration.yaml:
logger:
default: warning
logs:
custom_components.adaptive_lighting: debug
and after the problem occurs please create an issue with the log (/config/home-assistant.log).
Graphs!
These graphs were generated using the values calculated by the Adaptive Lighting sensor/switch(es).
