remote/adaptive-lighting
1
0
Fork 0
mirror of https://github.com/basnijholt/adaptive-lighting.git synced 2026-09-27 20:34:20 +02:00
Code Issues Projects Releases Packages Wiki Activity

Squashed commit of the following:

Browse source 
commit 7069d693b8
Merge: adde5b5 a888afd
Author: Benjamin Auquite <halomastar@gmail.com>
Date:   Mon Apr 10 12:52:19 2023 -0500

    Merge branch 'main' into add-watched-lights

commit adde5b5645
Author: Benjamin Auquite <halomastar@gmail.com>
Date:   Mon Apr 10 10:34:24 2023 -0500

    fix pytest

commit 2c5eaec2d3
Author: Benjamin Auquite <halomastar@gmail.com>
Date:   Mon Apr 10 07:27:25 2023 -0500

    Revert "Update const.py"

    This reverts commit e773af07ca.

commit e773af07ca
Author: Benjamin Auquite <halomastar@gmail.com>
Date:   Mon Apr 10 07:20:23 2023 -0500

    Update const.py

commit c167f59ccd
Author: Benjamin Auquite <halomastar@gmail.com>
Date:   Mon Apr 10 06:09:14 2023 -0500

    Update docs

commit 6220df57d1
Author: Benjamin Auquite <halomastar@gmail.com>
Date:   Mon Apr 10 05:59:26 2023 -0500

    fix the test

commit ff292c2c1b
Merge: 4fdf42b 19d4468
Author: Benjamin Auquite <halomastar@gmail.com>
Date:   Mon Apr 10 05:39:17 2023 -0500

    Merge branch 'add-watched-lights' of https://github.com/basnijholt/adaptive-lighting into add-watched-lights

commit 4fdf42bea1
Author: Benjamin Auquite <halomastar@gmail.com>
Date:   Mon Apr 10 05:39:05 2023 -0500

    small fixes

commit 19d4468f63
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Date:   Mon Apr 10 10:36:54 2023 +0000

    Update README.md, strings.json, and services.yaml

commit 70c90181f0
Merge: e30b7de b6a9265
Author: Benjamin Auquite <halomastar@gmail.com>
Date:   Mon Apr 10 10:34:49 2023 +0000

    Merge b6a92650a9 into e30b7debe5

commit b6a92650a9
Merge: 784eed0 ae04ab4
Author: Benjamin Auquite <halomastar@gmail.com>
Date:   Mon Apr 10 05:34:43 2023 -0500

    Merge branch 'add-watched-lights' of https://github.com/basnijholt/adaptive-lighting into add-watched-lights

commit 784eed09b3
Author: Benjamin Auquite <halomastar@gmail.com>
Date:   Mon Apr 10 05:34:33 2023 -0500

    squash merge `alt_detect_method` again

commit ae04ab49a8
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Date:   Mon Apr 10 10:34:12 2023 +0000

    Update README.md, strings.json, and services.yaml

commit cfbd65f976
Merge: e30b7de 3c5ea73
Author: Benjamin Auquite <halomastar@gmail.com>
Date:   Mon Apr 10 10:32:34 2023 +0000

    Merge 3c5ea73341 into e30b7debe5

commit 3c5ea73341
Author: Benjamin Auquite <halomastar@gmail.com>
Date:   Mon Apr 10 05:32:27 2023 -0500

    Update switch.py

commit 2f750694d9
Merge: 429251b 7a9dc8f
Author: Benjamin Auquite <halomastar@gmail.com>
Date:   Mon Apr 10 05:31:13 2023 -0500

    Merge branch 'add-watched-lights' of https://github.com/basnijholt/adaptive-lighting into add-watched-lights

commit 429251b45f
Author: Benjamin Auquite <halomastar@gmail.com>
Date:   Mon Apr 10 05:31:04 2023 -0500

    update docs

commit 7a9dc8f24a
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Date:   Mon Apr 10 10:29:37 2023 +0000

    Update README.md, strings.json, and services.yaml

commit 37de4244b1
Merge: e30b7de d52ea53
Author: Benjamin Auquite <halomastar@gmail.com>
Date:   Mon Apr 10 10:28:01 2023 +0000

    Merge d52ea53dcc into e30b7debe5

commit d52ea53dcc
Merge: dbc47c8 e30b7de
Author: Benjamin Auquite <halomastar@gmail.com>
Date:   Mon Apr 10 05:27:43 2023 -0500

    Merge branch 'main' into add-watched-lights

commit dbc47c8a36
Author: Benjamin Auquite <halomastar@gmail.com>
Date:   Mon Apr 10 05:26:11 2023 -0500

    Update switch.py

commit 2db675a434
Author: Benjamin Auquite <halomastar@gmail.com>
Date:   Mon Apr 10 05:25:44 2023 -0500

    merge with `alt_detect_method`

    required for this PR

commit dced97b5ca
Author: Benjamin Auquite <halomastar@gmail.com>
Date:   Mon Apr 10 05:21:51 2023 -0500

    merge with `origin\main`
This commit is contained in:
Benjamin Auquite 2023-04-11 19:08:49 -05:00
commit 7895075e76
6 changed files with 297 additions and 125 deletions
Download patch file Download diff file Expand all files Collapse all files

64
README.md
View file

@ -90,37 +90,39 @@ The YAML and frontend configuration methods support all of the options listed be
<!-- START_OUTPUT -->
<!-- THIS CONTENT IS AUTOMATICALLY GENERATED -->
| Variable name | Description | Default | Type |
|:-------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------------|:-------------------------------------|
| `lights` | List of light entity_ids to be controlled (may be empty). 🌟 | `[]` | list of `entity_id`s |
| `prefer_rgb_color` | Whether to prefer RGB color adjustment over light color temperature when possible. 🌈 | `False` | `bool` |
| `include_config_in_attributes` | Show all options as attributes on the switch in Home Assistant when set to `true`. 📝 | `False` | `bool` |
| `initial_transition` | Duration of the first transition when lights turn from `off` to `on` in seconds. ⏲️ | `1` | `float` 0-6553 |
| `sleep_transition` | Duration of transition when "sleep mode" is toggled in seconds. 😴 | `1` | `float` 0-6553 |
| `transition` | Duration of transition when lights change, in seconds. 🕑 | `45` | `float` 0-6553 |
| `transition_until_sleep` | When enabled, Adaptive Lighting will treat sleep settings as the minimum, transitioning to these values after sunset. 🌙 | `False` | `bool` |
| `interval` | Frequency to adapt the lights, in seconds. 🔄 | `90` | `int > 0` |
| `min_brightness` | Minimum brightness percentage. 💡 | `1` | `int` 1-100 |
| `max_brightness` | Maximum brightness percentage. 💡 | `100` | `int` 1-100 |
| `min_color_temp` | Warmest color temperature in Kelvin. 🔥 | `2000` | `int` 1000-10000 |
| `max_color_temp` | Coldest color temperature in Kelvin. ❄️ | `5500` | `int` 1000-10000 |
| `sleep_brightness` | Brightness percentage of lights in sleep mode. 😴 | `1` | `int` 1-100 |
| `sleep_rgb_or_color_temp` | Use either `"rgb_color"` or `"color_temp"` in sleep mode. 🌙 | `color_temp` | one of `['color_temp', 'rgb_color']` |
| `sleep_color_temp` | Color temperature in sleep mode (used when `sleep_rgb_or_color_temp` is `color_temp`) in Kelvin. 😴 | `1000` | `int` 1000-10000 |
| `sleep_rgb_color` | RGB color in sleep mode (used when `sleep_rgb_or_color_temp` is "rgb_color"). 🌈 | `[255, 56, 0]` | RGB color |
| `sunrise_time` | Set a fixed time (HH:MM:SS) for sunrise. 🌅 | `None` | `str` |
| `max_sunrise_time` | Set the latest virtual sunrise time (HH:MM:SS), allowing for earlier real sunrises. 🌅 | `None` | `str` |
| `sunrise_offset` | Adjust sunrise time with a positive or negative offset in seconds. ⏰ | `0` | `int` |
| `sunset_time` | Set a fixed time (HH:MM:SS) for sunset. 🌇 | `None` | `str` |
| `min_sunset_time` | Set the earliest virtual sunset time (HH:MM:SS), allowing for later real sunsets. 🌇 | `None` | `str` |
| `sunset_offset` | Adjust sunset time with a positive or negative offset in seconds. ⏰ | `0` | `int` |
| `only_once` | Adapt lights only when they are turned on (`true`) or keep adapting them (`false`). 🔄 | `False` | `bool` |
| `take_over_control` | Disable Adaptive Lighting if another source calls `light.turn_on` while lights are on and being adapted. Note that this calls `homeassistant.update_entity` every `interval`! 🔒 | `True` | `bool` |
| `detect_non_ha_changes` | Detect non-`light.turn_on` state changes and stop adapting lights. Requires `take_over_control`. 🕵️ | `False` | `bool` |
| `separate_turn_on_commands` | Use separate `light.turn_on` calls for color and brightness, needed for some light types. 🔀 | `False` | `bool` |
| `send_split_delay` | Delay (ms) between `separate_turn_on_commands` for lights that don't support simultaneous brightness and color setting. ⏲️ | `0` | `int` 0-10000 |
| `adapt_delay` | Wait time (seconds) between light turn on and Adaptive Lighting applying changes. Might help to avoid flickering. ⏲️ | `0` | `float > 0` |
| `autoreset_control_seconds` | Automatically reset the manual control after a number of seconds. Set to 0 to disable. ⏲️ | `0` | `int` 0-31536000 |
| Variable name | Description | Default | Type |
|:-------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------------|:-------------------------------------|
| `lights` | List of light entity_ids to be controlled (may be empty). 🌟 | `[]` | list of `entity_id`s |
| `watched_lights` | Use this dictionary of lights to check for manually controlled events in addition to the main lights 🌟 Example: {light.watch_light: light.main_light} will fire manually controlled events to light.main_light | `{}` | list of `entity_id`s |
| `prefer_rgb_color` | Whether to prefer RGB color adjustment over light color temperature when possible. 🌈 | `False` | `bool` |
| `include_config_in_attributes` | Show all options as attributes on the switch in Home Assistant when set to `true`. 📝 | `False` | `bool` |
| `initial_transition` | Duration of the first transition when lights turn from `off` to `on` in seconds. ⏲️ | `1` | `float` 0-6553 |
| `sleep_transition` | Duration of transition when "sleep mode" is toggled in seconds. 😴 | `1` | `float` 0-6553 |
| `transition` | Duration of transition when lights change, in seconds. 🕑 | `45` | `float` 0-6553 |
| `transition_until_sleep` | When enabled, Adaptive Lighting will treat sleep settings as the minimum, transitioning to these values after sunset. 🌙 | `False` | `bool` |
| `interval` | Frequency to adapt the lights, in seconds. 🔄 | `90` | `int > 0` |
| `min_brightness` | Minimum brightness percentage. 💡 | `1` | `int` 1-100 |
| `max_brightness` | Maximum brightness percentage. 💡 | `100` | `int` 1-100 |
| `min_color_temp` | Warmest color temperature in Kelvin. 🔥 | `2000` | `int` 1000-10000 |
| `max_color_temp` | Coldest color temperature in Kelvin. ❄️ | `5500` | `int` 1000-10000 |
| `sleep_brightness` | Brightness percentage of lights in sleep mode. 😴 | `1` | `int` 1-100 |
| `sleep_rgb_or_color_temp` | Use either `"rgb_color"` or `"color_temp"` in sleep mode. 🌙 | `color_temp` | one of `['color_temp', 'rgb_color']` |
| `sleep_color_temp` | Color temperature in sleep mode (used when `sleep_rgb_or_color_temp` is `color_temp`) in Kelvin. 😴 | `1000` | `int` 1000-10000 |
| `sleep_rgb_color` | RGB color in sleep mode (used when `sleep_rgb_or_color_temp` is "rgb_color"). 🌈 | `[255, 56, 0]` | RGB color |
| `sunrise_time` | Set a fixed time (HH:MM:SS) for sunrise. 🌅 | `None` | `str` |
| `max_sunrise_time` | Set the latest virtual sunrise time (HH:MM:SS), allowing for earlier real sunrises. 🌅 | `None` | `str` |
| `sunrise_offset` | Adjust sunrise time with a positive or negative offset in seconds. ⏰ | `0` | `int` |
| `sunset_time` | Set a fixed time (HH:MM:SS) for sunset. 🌇 | `None` | `str` |
| `min_sunset_time` | Set the earliest virtual sunset time (HH:MM:SS), allowing for later real sunsets. 🌇 | `None` | `str` |
| `sunset_offset` | Adjust sunset time with a positive or negative offset in seconds. ⏰ | `0` | `int` |
| `only_once` | Adapt lights only when they are turned on (`true`) or keep adapting them (`false`). 🔄 | `False` | `bool` |
| `take_over_control` | Disable Adaptive Lighting if another source calls `light.turn_on` while lights are on and being adapted. Note that this calls `homeassistant.update_entity` every `interval`! 🔒 | `True` | `bool` |
| `alt_detect_method` | alt_detect_method: When true, will check for any significant changes in the opposite direction of where adaptive-lighting tried to adapt last. This is an alternative to 'detect_non_ha_changes' (default: false) | `False` | `bool` |
| `detect_non_ha_changes` | Detect non-`light.turn_on` state changes and stop adapting lights. Requires `take_over_control`. 🕵️ | `False` | `bool` |
| `separate_turn_on_commands` | Use separate `light.turn_on` calls for color and brightness, needed for some light types. 🔀 | `False` | `bool` |
| `send_split_delay` | Delay (ms) between `separate_turn_on_commands` for lights that don't support simultaneous brightness and color setting. ⏲️ | `0` | `int` 0-10000 |
| `adapt_delay` | Wait time (seconds) between light turn on and Adaptive Lighting applying changes. Might help to avoid flickering. ⏲️ | `0` | `float > 0` |
| `autoreset_control_seconds` | Automatically reset the manual control after a number of seconds. Set to 0 to disable. ⏲️ | `0` | `int` 0-31536000 |
<!-- END_OUTPUT -->