From c915bda9b94896a8016f69436a1b4b2af7cf9432 Mon Sep 17 00:00:00 2001 From: Benjamin Auquite Date: Mon, 3 Apr 2023 01:57:12 -0500 Subject: [PATCH 01/12] Autoreset_Control_Time - small changes (#515) * small changes * Update README.md * trivial comment change --------- Co-authored-by: github-actions[bot] Co-authored-by: Bas Nijholt --- README.md | 2 +- custom_components/adaptive_lighting/const.py | 2 +- custom_components/adaptive_lighting/switch.py | 1 + 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6c03f1f7..037a6b05 100644 --- a/README.md +++ b/README.md @@ -119,7 +119,7 @@ The YAML and frontend configuration methods support all of the options listed be | `separate_turn_on_commands` | Use separate `light.turn_on` calls for color and brightness, needed for some light types. 🔀 | `False` | `bool` | | `send_split_delay` | Wait time (milliseconds) between commands when using `separate_turn_on_commands`. Helps ensure correct handling. ⏲️ | `0` | `int` 0-10000 | | `adapt_delay` | Wait time (seconds) between light turn on and Adaptive Lighting applying changes. Helps 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-604800 | +| `autoreset_control_seconds` | Automatically reset the manual control after a number of seconds. Set to 0 to disable. ⏲️ | `0` | `int` 0-31536000 | diff --git a/custom_components/adaptive_lighting/const.py b/custom_components/adaptive_lighting/const.py index eb29fa13..471d593c 100644 --- a/custom_components/adaptive_lighting/const.py +++ b/custom_components/adaptive_lighting/const.py @@ -228,7 +228,7 @@ VALIDATION_TUPLES = [ ( CONF_AUTORESET_CONTROL, DEFAULT_AUTORESET_CONTROL, - int_between(0, 7 * 24 * 60 * 60), # 7 days max + int_between(0, 365 * 24 * 60 * 60), # 1 year max ), ] diff --git a/custom_components/adaptive_lighting/switch.py b/custom_components/adaptive_lighting/switch.py index 5cf17122..6527b73d 100644 --- a/custom_components/adaptive_lighting/switch.py +++ b/custom_components/adaptive_lighting/switch.py @@ -822,6 +822,7 @@ class AdaptiveSwitch(SwitchEntity, RestoreEntity): self._adapt_delay = data[CONF_ADAPT_DELAY] self._send_split_delay = data[CONF_SEND_SPLIT_DELAY] self._auto_reset_manual_control_time = data[CONF_AUTORESET_CONTROL] + self._expand_light_groups() # updates manual control timers _loc = get_astral_location(self.hass) if isinstance(_loc, tuple): # Astral v2.2 From 9caf3048f1889129d8225a90a35384721f671830 Mon Sep 17 00:00:00 2001 From: igiannakas <59056762+igiannakas@users.noreply.github.com> Date: Mon, 3 Apr 2023 08:27:07 +0100 Subject: [PATCH 02/12] Continue to adapt color temperature down to the sleep temperature after sunset (#87) * Update switch.py Continue to adapt color temperature down to the sleep temperature after sunset. Results in a gradually warming light during the night time rather than a fixed color temperature throughout the night time. * Run pre-commit * Merge branch 'master' into pr/87 * add config option bool `adapt_until_sleep` defaulting to `false` --------- Co-authored-by: Bas Nijholt Co-authored-by: Bas Nijholt Co-authored-by: Benjamin Auquite --- README.md | 6 ++++++ custom_components/adaptive_lighting/const.py | 10 ++++++++++ custom_components/adaptive_lighting/strings.json | 1 + custom_components/adaptive_lighting/switch.py | 10 +++++++++- 4 files changed, 26 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 037a6b05..c354153d 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,7 @@ The `adaptive_lighting.manual_control` event is fired when a light is marked as - [:sunny: Sun Position](#sunny-sun-position) - [:thermometer: Color Temperature](#thermometer-color-temperature) - [:high_brightness: Brightness](#high_brightness-brightness) + - [While using `adapt_until_sleep: true`](#while-using-adapt_until_sleep-true) - [:busts_in_silhouette: Contributors](#busts_in_silhouette-contributors) @@ -95,6 +96,7 @@ The YAML and frontend configuration methods support all of the options listed be | `lights` | List of light entities to be controlled by Adaptive Lighting (may be empty). 🌟 | `[]` | list of `entity_id`s | | `prefer_rgb_color` | Use RGB color adjustment instead of native light color temperature. 🌈 | `False` | `bool` | | `include_config_in_attributes` | Show all options as attributes on the switch in Home Assistant when set to `true`. 📝 | `False` | `bool` | +| `adapt_until_sleep` | When `true`, Adaptive Lighting will use the sleep settings as the minimum, and transition to these values past the sunset | `False` | `bool` | | `initial_transition` | Duration of the first transition when lights turn from `off` to `on`. ⏲️ | `1` | `float` 0-6553 | | `sleep_transition` | Duration of transition when 'sleep mode' is toggled. 😴 | `1` | `float` 0-6553 | | `transition` | Duration of transition when lights change, in seconds. 🕑 | `45` | `float` 0-6553 | @@ -364,6 +366,10 @@ These graphs were generated using the values calculated by the Adaptive Lighting #### :high_brightness: Brightness ![cl_brightness|690x130](https://community-home-assistant-assets.s3.dualstack.us-west-2.amazonaws.com/original/3X/5/8/58ebd994b62a8b1abfb3497a5288d923ff4e2330.PNG) +#### While using `adapt_until_sleep: true` +![image](https://user-images.githubusercontent.com/2219836/228949675-f9699624-8abc-466c-bb04-250ce0f495b8.png) + + ## :busts_in_silhouette: Contributors diff --git a/custom_components/adaptive_lighting/const.py b/custom_components/adaptive_lighting/const.py index 471d593c..a5a5f2c1 100644 --- a/custom_components/adaptive_lighting/const.py +++ b/custom_components/adaptive_lighting/const.py @@ -140,6 +140,15 @@ DOCS[CONF_TAKE_OVER_CONTROL] = ( CONF_TRANSITION, DEFAULT_TRANSITION = "transition", 45 DOCS[CONF_TRANSITION] = "Duration of transition when lights change, in seconds. 🕑" +CONF_ADAPT_UNTIL_SLEEP, DEFAULT_ADAPT_UNTIL_SLEEP = ( + "transition_until_sleep", + False, +) +DOCS[CONF_ADAPT_UNTIL_SLEEP] = ( + "When checked, Adaptive Lighting will use the sleep settings as the minimum," + " and transition to these values past the sunset" +) + CONF_ADAPT_DELAY, DEFAULT_ADAPT_DELAY = "adapt_delay", 0 DOCS[CONF_ADAPT_DELAY] = ( "Wait time (seconds) between light turn on and Adaptive Lighting applying " @@ -190,6 +199,7 @@ VALIDATION_TUPLES = [ (CONF_INITIAL_TRANSITION, DEFAULT_INITIAL_TRANSITION, VALID_TRANSITION), (CONF_SLEEP_TRANSITION, DEFAULT_SLEEP_TRANSITION, VALID_TRANSITION), (CONF_TRANSITION, DEFAULT_TRANSITION, VALID_TRANSITION), + (CONF_ADAPT_UNTIL_SLEEP, DEFAULT_ADAPT_UNTIL_SLEEP, bool), (CONF_INTERVAL, DEFAULT_INTERVAL, cv.positive_int), (CONF_MIN_BRIGHTNESS, DEFAULT_MIN_BRIGHTNESS, int_between(1, 100)), (CONF_MAX_BRIGHTNESS, DEFAULT_MAX_BRIGHTNESS, int_between(1, 100)), diff --git a/custom_components/adaptive_lighting/strings.json b/custom_components/adaptive_lighting/strings.json index 5a8ef6af..2ebd96d0 100644 --- a/custom_components/adaptive_lighting/strings.json +++ b/custom_components/adaptive_lighting/strings.json @@ -22,6 +22,7 @@ "lights": "lights", "initial_transition": "initial_transition: When lights turn 'off' to 'on'. (seconds)", "include_config_in_attributes": "include_config_in_attributes: All config options will be listed as attributes under the adaptive-lighting switch this integration creates. (default: false)", + "adapt_until_sleep": "adapt_until_sleep: When checked, Adaptive Lighting will use the sleep settings as the minimum, and transition to these values past the sunset (default: false)", "sleep_transition": "sleep_transition: When 'sleep_state' changes. (seconds)", "interval": "interval: Time between switch updates. (seconds)", "max_brightness": "max_brightness: Highest brightness of lights during a cycle. (%)", diff --git a/custom_components/adaptive_lighting/switch.py b/custom_components/adaptive_lighting/switch.py index 6527b73d..75361965 100644 --- a/custom_components/adaptive_lighting/switch.py +++ b/custom_components/adaptive_lighting/switch.py @@ -97,6 +97,7 @@ from .const import ( ATTR_ADAPT_COLOR, ATTR_TURN_ON_OFF_LISTENER, CONF_ADAPT_DELAY, + CONF_ADAPT_UNTIL_SLEEP, CONF_AUTORESET_CONTROL, CONF_DETECT_NON_HA_CHANGES, CONF_INCLUDE_CONFIG_IN_ATTRIBUTES, @@ -834,6 +835,7 @@ class AdaptiveSwitch(SwitchEntity, RestoreEntity): self._sun_light_settings = SunLightSettings( name=self._name, astral_location=location, + adapt_until_sleep=data[CONF_ADAPT_UNTIL_SLEEP], max_brightness=data[CONF_MAX_BRIGHTNESS], max_color_temp=data[CONF_MAX_COLOR_TEMP], min_brightness=data[CONF_MIN_BRIGHTNESS], @@ -1325,6 +1327,7 @@ class SunLightSettings: name: str astral_location: astral.Location + adapt_until_sleep: bool max_brightness: int max_color_temp: int min_brightness: int @@ -1474,7 +1477,12 @@ class SunLightSettings: delta = self.max_color_temp - self.min_color_temp ct = (delta * percent) + self.min_color_temp return 5 * round(ct / 5) # round to nearest 5 - return self.min_color_temp + if percent == 0 or not self.adapt_until_sleep: + return self.min_color_temp + if self.adapt_until_sleep and percent < 0: + delta = abs(self.min_color_temp - self.sleep_color_temp) + ct = (delta * abs(1 + percent)) + self.sleep_color_temp + return 5 * round(ct / 5) # round to nearest 5 def get_settings( self, is_sleep, transition From cdc3585a66969211a08762eb05ae36ab3f070130 Mon Sep 17 00:00:00 2001 From: "allcontributors[bot]" <46447321+allcontributors[bot]@users.noreply.github.com> Date: Mon, 3 Apr 2023 07:58:20 +0000 Subject: [PATCH 03/12] docs: add igiannakas as a contributor for code (#517) * docs: update README.md * docs: update .all-contributorsrc --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> --- .all-contributorsrc | 9 +++++++++ README.md | 3 ++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/.all-contributorsrc b/.all-contributorsrc index 063b429c..344b3112 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -429,6 +429,15 @@ "contributions": [ "code" ] + }, + { + "login": "igiannakas", + "name": "igiannakas", + "avatar_url": "https://avatars.githubusercontent.com/u/59056762?v=4", + "profile": "https://github.com/igiannakas", + "contributions": [ + "code" + ] } ], "contributorsPerLine": 7, diff --git a/README.md b/README.md index c354153d..9ebc7397 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ [![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg?style=for-the-badge)](https://github.com/hacs/integration) ![Version](https://img.shields.io/github/v/release/basnijholt/adaptive-lighting?style=for-the-badge) -[![All Contributors](https://img.shields.io/badge/all_contributors-46-orange.svg?style=flat-square)](#contributors-) +[![All Contributors](https://img.shields.io/badge/all_contributors-47-orange.svg?style=flat-square)](#contributors-) # 🌞 Adaptive Lighting: Enhance Your Home's Atmosphere with Smart, Sun-Synchronized Lighting 🌙 @@ -436,6 +436,7 @@ These graphs were generated using the values calculated by the Adaptive Lighting Skyler Carlson
Skyler Carlson
📖 Chris
Chris
💻 Raman Gupta
Raman Gupta
💻 + igiannakas
igiannakas
💻 From 19fcb1d6b9c1c0a0abcb0a88bc16b05839818726 Mon Sep 17 00:00:00 2001 From: Bas Nijholt Date: Mon, 3 Apr 2023 00:58:39 -0700 Subject: [PATCH 04/12] Automatically generate more service tables in the README (#509) * Automatically sync more data * Automatically generate apply table * Generate manual control * Add manual control docs * Update README.md * Move docs functions to separate file * Update code * simple * no path * link paths * Fix link * missed * cd core * Update README.md * Allow alternative docs * update readme * More special * Fx * Update README.md * Remove common descriptions * Update README.md * Update README.md * Rephrase * Update README.md --------- Co-authored-by: github-actions[bot] --- .github/workflows/pytest.yaml | 8 +- .github/workflows/update-readme.yml | 7 +- README.md | 75 ++++---- .../adaptive_lighting/_docs_helpers.py | 116 ++++++++++++ custom_components/adaptive_lighting/const.py | 142 +++++++-------- .../adaptive_lighting/services.yaml | 168 +++++++++--------- custom_components/adaptive_lighting/switch.py | 28 +-- 7 files changed, 333 insertions(+), 211 deletions(-) create mode 100644 custom_components/adaptive_lighting/_docs_helpers.py diff --git a/.github/workflows/pytest.yaml b/.github/workflows/pytest.yaml index 47d4df8a..02bf93e3 100644 --- a/.github/workflows/pytest.yaml +++ b/.github/workflows/pytest.yaml @@ -31,8 +31,8 @@ jobs: echo "::notice::### 4. ERROR:homeassistant.setup:Setup failed for 'component': Unable to import component: No module named ''module'' ###" echo "::notice::### 5. add 'component'.'module' (without the '') from the above log into the 'required' list inside of 'test_dependencies.py' ###" echo "::notice::### 6. Try again! If more issues persist they should be easily solvable by reading the verbose logs now. ###" - - name: Run pytest - timeout-minutes: 60 + + - name: Link custom_components/adaptive_lighting run: | cd core @@ -46,6 +46,10 @@ jobs: ln -fs ../../../tests adaptive_lighting cd - + - name: Run pytest + timeout-minutes: 60 + run: | + cd core python3 -X dev -m pytest \ -qq \ --timeout=9 \ diff --git a/.github/workflows/update-readme.yml b/.github/workflows/update-readme.yml index 4d4c4530..bc31bb94 100644 --- a/.github/workflows/update-readme.yml +++ b/.github/workflows/update-readme.yml @@ -22,10 +22,15 @@ jobs: with: python_version: "3.10" - - name: Install pandas and tabulate + - name: Install markdown-code-runner and README code dependencies run: | pip install markdown-code-runner pandas tabulate + - name: Link custom_components/adaptive_lighting + run: | + cd core/homeassistant/components + ln -fs ../../../custom_components/adaptive_lighting adaptive_lighting + - name: Run markdown-code-runner run: markdown-code-runner --debug README.md diff --git a/README.md b/README.md index 9ebc7397..5b98de8b 100644 --- a/README.md +++ b/README.md @@ -82,11 +82,8 @@ All of the configuration options are listed below, along with their default valu The YAML and frontend configuration methods support all of the options listed below. - - - - - + + @@ -94,27 +91,27 @@ The YAML and frontend configuration methods support all of the options listed be | Variable name | Description | Default | Type | |:-------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------------|:-------------------------------------| | `lights` | List of light entities to be controlled by Adaptive Lighting (may be empty). 🌟 | `[]` | list of `entity_id`s | -| `prefer_rgb_color` | Use RGB color adjustment instead of native light color temperature. 🌈 | `False` | `bool` | +| `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` | -| `adapt_until_sleep` | When `true`, Adaptive Lighting will use the sleep settings as the minimum, and transition to these values past the sunset | `False` | `bool` | -| `initial_transition` | Duration of the first transition when lights turn from `off` to `on`. ⏲️ | `1` | `float` 0-6553 | -| `sleep_transition` | Duration of transition when 'sleep mode' is toggled. 😴 | `1` | `float` 0-6553 | +| `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 of lights in sleep mode. 😴 | `1` | `int` 1-100 | +| `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`). 😴 | `1000` | `int` 1000-10000 | +| `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 for sunrise. 🌅 | `None` | `str` | -| `max_sunrise_time` | Set the latest virtual sunrise time, allowing for earlier real sunrises. 🌅 | `None` | `str` | -| `sunrise_offset` | Adjust sunrise time with a positive or negative offset. ⏰ | `0` | `int` | -| `sunset_time` | Set a fixed time for sunset. 🌇 | `None` | `str` | -| `min_sunset_time` | Set the earliest virtual sunset time, allowing for later real sunsets. 🌇 | `None` | `str` | -| `sunset_offset` | Adjust sunset time with a positive or negative offset. ⏰ | `0` | `int` | +| `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` | @@ -158,26 +155,42 @@ adaptive_lighting: `adaptive_lighting.apply` applies Adaptive Lighting settings to lights on demand. -| Service data attribute | Required | Description | -| ---------------------- | -------- | -------------------------------------------------------------------------------------------- | -| `entity_id` | ✅ | The `entity_id` of the switch with the settings to apply. | -| `lights` | ❌ | A light (or list of lights) to apply the settings to. | -| `transition` | ❌ | The number of seconds for the transition. | -| `adapt_brightness` | ❌ | Whether to change the brightness of the light or not. | -| `adapt_color` | ❌ | Whether to adapt the color on supporting lights. | -| `prefer_rgb_color` | ❌ | Whether to prefer RGB color adjustment over of native light color temperature when possible. | -| `turn_on_lights` | ❌ | Whether to turn on lights that are currently off. | + + + + + + +| Service data attribute | Description | Required | Type | +|:-------------------------|:-------------------------------------------------------------------------------------|:-----------|:---------------------| +| `entity_id` | The `entity_id` of the switch with the settings to apply. 📝 | ✅ | list of `entity_id`s | +| `lights` | A light (or list of lights) to apply the settings to. 💡 | ❌ | list of `entity_id`s | +| `transition` | Duration of transition when lights change, in seconds. 🕑 | ❌ | `float` 0-6553 | +| `adapt_brightness` | Whether to adapt the brightness of the light. 🌞 | ❌ | bool | +| `adapt_color` | Whether to adapt the color on supporting lights. 🌈 | ❌ | bool | +| `prefer_rgb_color` | Whether to prefer RGB color adjustment over light color temperature when possible. 🌈 | ❌ | bool | +| `turn_on_lights` | Whether to turn on lights that are currently off. 🔆 | ❌ | bool | + + #### `adaptive_lighting.set_manual_control` `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 | Required | Description | -| ---------------------- | -------- | --------------------------------------------------------------------------------------------------- | -| `entity_id` | ✅ | The `entity_id` of the switch in which to (un)mark the light as being "manually controlled". | -| `lights` | ❌ | entity_id(s) of lights, if not specified, all lights in the switch are selected. | -| `manual_control` | ❌ | Whether to add ('true') or remove ('false') the light from the 'manual_control' list, default: true | + + + + + + +| Service data attribute | Description | Required | Type | +|:-------------------------|:-----------------------------------------------------------------------------------------------|:-----------|:---------------------| +| `entity_id` | The `entity_id` of the switch in which to (un)mark the light as being `manually controlled`. 📝 | ✅ | list of `entity_id`s | +| `lights` | entity_id(s) of lights, if not specified, all lights in the switch are selected. 💡 | ❌ | list of `entity_id`s | +| `manual_control` | Whether to add ('true') or remove ('false') the light from the 'manual_control' list. 🔒 | ❌ | bool | + + #### `adaptive_lighting.change_switch_settings` `adaptive_lighting.change_switch_settings` (new in 1.7.0) Change any of the above configuration options of Adaptive Lighting (such as `sunrise_time` or `prefer_rgb_color`) with a service call directly from your script/automation. diff --git a/custom_components/adaptive_lighting/_docs_helpers.py b/custom_components/adaptive_lighting/_docs_helpers.py new file mode 100644 index 00000000..40afc235 --- /dev/null +++ b/custom_components/adaptive_lighting/_docs_helpers.py @@ -0,0 +1,116 @@ +from typing import Any + +from homeassistant.helpers import selector +import homeassistant.helpers.config_validation as cv +import pandas as pd +import voluptuous as vol + +from .const import ( + DOCS, + DOCS_APPLY, + DOCS_MANUAL_CONTROL, + SET_MANUAL_CONTROL_SCHEMA, + VALIDATION_TUPLES, + apply_service_schema, +) + + +def _format_voluptuous_instance(instance): + coerce_type = None + min_val = None + max_val = None + + for validator in instance.validators: + if isinstance(validator, vol.Coerce): + coerce_type = validator.type.__name__ + elif isinstance(validator, (vol.Clamp, vol.Range)): + min_val = validator.min + max_val = validator.max + + if min_val is not None and max_val is not None: + return f"`{coerce_type}` {min_val}-{max_val}" + elif min_val is not None: + return f"`{coerce_type} > {min_val}`" + elif max_val is not None: + return f"`{coerce_type} < {max_val}`" + else: + return f"`{coerce_type}`" + + +def _type_to_str(type_: Any) -> str: + """Convert a (voluptuous) type to a string.""" + if type_ == cv.entity_ids: + return "list of `entity_id`s" + elif type_ in (bool, int, float, str): + return f"`{type_.__name__}`" + elif type_ == cv.boolean: + return "bool" + elif isinstance(type_, vol.All): + return _format_voluptuous_instance(type_) + elif isinstance(type_, vol.In): + return f"one of `{type_.container}`" + elif isinstance(type_, selector.SelectSelector): + return f"one of `{type_.config['options']}`" + elif isinstance(type_, selector.ColorRGBSelector): + return "RGB color" + else: + raise ValueError(f"Unknown type: {type_}") + + +def generate_config_markdown_table(): + import pandas as pd + + rows = [] + for k, default, type_ in VALIDATION_TUPLES: + description = DOCS[k] + row = { + "Variable name": f"`{k}`", + "Description": description, + "Default": f"`{default}`", + "Type": _type_to_str(type_), + } + rows.append(row) + + df = pd.DataFrame(rows) + return df.to_markdown(index=False) + + +def _schema_to_dict(schema: vol.Schema) -> dict[str, tuple[Any, Any]]: + result = {} + for key, value in schema.schema.items(): + if isinstance(key, vol.Optional): + default_value = key.default + result[key.schema] = (default_value, value) + return result + + +def _generate_service_markdown_table( + schema: dict[str, tuple[Any, Any]], alternative_docs: dict[str, str] = None +): + schema = _schema_to_dict(schema) + rows = [] + for k, (default, type_) in schema.items(): + if alternative_docs is not None and k in alternative_docs: + description = alternative_docs[k] + else: + description = DOCS[k] + row = { + "Service data attribute": f"`{k}`", + "Description": description, + "Required": "✅" if default == vol.UNDEFINED else "❌", + "Type": _type_to_str(type_), + } + rows.append(row) + + df = pd.DataFrame(rows) + return df.to_markdown(index=False) + + +def generate_apply_markdown_table(): + return _generate_service_markdown_table(apply_service_schema(), DOCS_APPLY) + + +def generate_set_manual_control_markdown_table(): + return _generate_service_markdown_table( + SET_MANUAL_CONTROL_SCHEMA, DOCS_MANUAL_CONTROL + ) diff --git a/custom_components/adaptive_lighting/const.py b/custom_components/adaptive_lighting/const.py index a5a5f2c1..bb0c07cd 100644 --- a/custom_components/adaptive_lighting/const.py +++ b/custom_components/adaptive_lighting/const.py @@ -1,6 +1,7 @@ """Constants for the Adaptive Lighting integration.""" from homeassistant.components.light import VALID_TRANSITION +from homeassistant.const import CONF_ENTITY_ID from homeassistant.helpers import selector import homeassistant.helpers.config_validation as cv import voluptuous as vol @@ -14,7 +15,7 @@ DOMAIN = "adaptive_lighting" SUN_EVENT_NOON = "solar_noon" SUN_EVENT_MIDNIGHT = "solar_midnight" -DOCS = {} +DOCS = {CONF_ENTITY_ID: "Entity ID of the switch. 📝"} CONF_NAME, DEFAULT_NAME = "name", "default" @@ -45,11 +46,14 @@ DOCS[CONF_INCLUDE_CONFIG_IN_ATTRIBUTES] = ( CONF_INITIAL_TRANSITION, DEFAULT_INITIAL_TRANSITION = "initial_transition", 1 DOCS[CONF_INITIAL_TRANSITION] = ( - "Duration of the first transition when lights turn " "from `off` to `on`. ⏲️" + "Duration of the first transition when lights turn " + "from `off` to `on` in seconds. ⏲️" ) CONF_SLEEP_TRANSITION, DEFAULT_SLEEP_TRANSITION = "sleep_transition", 1 -DOCS[CONF_SLEEP_TRANSITION] = "Duration of transition when 'sleep mode' is toggled. 😴" +DOCS[CONF_SLEEP_TRANSITION] = ( + "Duration of transition when 'sleep mode' is toggled " "in seconds. 😴" +) CONF_INTERVAL, DEFAULT_INTERVAL = "interval", 90 DOCS[CONF_INTERVAL] = "Frequency to adapt the lights, in seconds. 🔄" @@ -73,9 +77,10 @@ DOCS[CONF_ONLY_ONCE] = ( ) CONF_PREFER_RGB_COLOR, DEFAULT_PREFER_RGB_COLOR = "prefer_rgb_color", False -DOCS[ - CONF_PREFER_RGB_COLOR -] = "Use RGB color adjustment instead of native light color temperature. 🌈" +DOCS[CONF_PREFER_RGB_COLOR] = ( + "Whether to prefer RGB color adjustment over " + "light color temperature when possible. 🌈" +) CONF_SEPARATE_TURN_ON_COMMANDS, DEFAULT_SEPARATE_TURN_ON_COMMANDS = ( "separate_turn_on_commands", @@ -87,12 +92,12 @@ DOCS[CONF_SEPARATE_TURN_ON_COMMANDS] = ( ) CONF_SLEEP_BRIGHTNESS, DEFAULT_SLEEP_BRIGHTNESS = "sleep_brightness", 1 -DOCS[CONF_SLEEP_BRIGHTNESS] = "Brightness of lights in sleep mode. 😴" +DOCS[CONF_SLEEP_BRIGHTNESS] = "Brightness percentage of lights in sleep mode. 😴" CONF_SLEEP_COLOR_TEMP, DEFAULT_SLEEP_COLOR_TEMP = "sleep_color_temp", 1000 DOCS[CONF_SLEEP_COLOR_TEMP] = ( "Color temperature in sleep mode (used when `sleep_rgb_or_color_temp` is " - "`color_temp`). 😴" + "`color_temp`) in Kelvin. 😴" ) CONF_SLEEP_RGB_COLOR, DEFAULT_SLEEP_RGB_COLOR = "sleep_rgb_color", [255, 56, 0] @@ -104,30 +109,36 @@ CONF_SLEEP_RGB_OR_COLOR_TEMP, DEFAULT_SLEEP_RGB_OR_COLOR_TEMP = ( "sleep_rgb_or_color_temp", "color_temp", ) -DOCS[ - CONF_SLEEP_RGB_OR_COLOR_TEMP -] = "Use either `'rgb_color'` or `'color_temp'` in sleep mode. 🌙" +DOCS[CONF_SLEEP_RGB_OR_COLOR_TEMP] = ( + "Use either `'rgb_color'` or `'color_temp'` " "in sleep mode. 🌙" +) CONF_SUNRISE_OFFSET, DEFAULT_SUNRISE_OFFSET = "sunrise_offset", 0 -DOCS[CONF_SUNRISE_OFFSET] = "Adjust sunrise time with a positive or negative offset. ⏰" +DOCS[CONF_SUNRISE_OFFSET] = ( + "Adjust sunrise time with a positive or negative offset " "in seconds. ⏰" +) CONF_SUNRISE_TIME = "sunrise_time" -DOCS[CONF_SUNRISE_TIME] = "Set a fixed time for sunrise. 🌅" +DOCS[CONF_SUNRISE_TIME] = "Set a fixed time (HH:MM:SS) for sunrise. 🌅" CONF_MAX_SUNRISE_TIME = "max_sunrise_time" DOCS[CONF_MAX_SUNRISE_TIME] = ( - "Set the latest virtual sunrise time, allowing" " for earlier real sunrises. 🌅" + "Set the latest virtual sunrise time (HH:MM:SS), allowing" + " for earlier real sunrises. 🌅" ) CONF_SUNSET_OFFSET, DEFAULT_SUNSET_OFFSET = "sunset_offset", 0 -DOCS[CONF_SUNSET_OFFSET] = "Adjust sunset time with a positive or negative offset. ⏰" +DOCS[ + CONF_SUNSET_OFFSET +] = "Adjust sunset time with a positive or negative offset in seconds. ⏰" CONF_SUNSET_TIME = "sunset_time" -DOCS[CONF_SUNSET_TIME] = "Set a fixed time for sunset. 🌇" +DOCS[CONF_SUNSET_TIME] = "Set a fixed time (HH:MM:SS) for sunset. 🌇" CONF_MIN_SUNSET_TIME = "min_sunset_time" DOCS[CONF_MIN_SUNSET_TIME] = ( - "Set the earliest virtual sunset time, allowing" " for later real sunsets. 🌇" + "Set the earliest virtual sunset time (HH:MM:SS), allowing" + " for later real sunsets. 🌇" ) CONF_TAKE_OVER_CONTROL, DEFAULT_TAKE_OVER_CONTROL = "take_over_control", True @@ -145,8 +156,8 @@ CONF_ADAPT_UNTIL_SLEEP, DEFAULT_ADAPT_UNTIL_SLEEP = ( False, ) DOCS[CONF_ADAPT_UNTIL_SLEEP] = ( - "When checked, Adaptive Lighting will use the sleep settings as the minimum," - " and transition to these values past the sunset" + "When enabled, Adaptive Lighting will treat sleep settings as the minimum, " + "transitioning to these values after sunset. 🌙" ) CONF_ADAPT_DELAY, DEFAULT_ADAPT_DELAY = "adapt_delay", 0 @@ -174,18 +185,36 @@ ATTR_TURN_ON_OFF_LISTENER = "turn_on_off_listener" UNDO_UPDATE_LISTENER = "undo_update_listener" NONE_STR = "None" ATTR_ADAPT_COLOR = "adapt_color" +DOCS[ATTR_ADAPT_COLOR] = "Whether to adapt the color on supporting lights. 🌈" ATTR_ADAPT_BRIGHTNESS = "adapt_brightness" +DOCS[ATTR_ADAPT_BRIGHTNESS] = "Whether to adapt the brightness of the light. 🌞" SERVICE_SET_MANUAL_CONTROL = "set_manual_control" CONF_MANUAL_CONTROL = "manual_control" +DOCS[CONF_MANUAL_CONTROL] = "Whether to manually control the lights. 🔒" SERVICE_APPLY = "apply" CONF_TURN_ON_LIGHTS = "turn_on_lights" +DOCS[CONF_TURN_ON_LIGHTS] = "Whether to turn on lights that are currently off. 🔆" SERVICE_CHANGE_SWITCH_SETTINGS = "change_switch_settings" CONF_USE_DEFAULTS = "use_defaults" - +DOCS[CONF_USE_DEFAULTS] = "Whether to use default settings for the switches. ⚙️" TURNING_OFF_DELAY = 5 +DOCS_MANUAL_CONTROL = { + CONF_ENTITY_ID: "The `entity_id` of the switch in which to (un)mark the " + "light as being `manually controlled`. 📝", + CONF_LIGHTS: "entity_id(s) of lights, if not specified, all lights in the " + "switch are selected. 💡", + CONF_MANUAL_CONTROL: "Whether to add ('true') or remove ('false') the " + "light from the 'manual_control' list. 🔒", +} + +DOCS_APPLY = { + CONF_ENTITY_ID: "The `entity_id` of the switch with the settings to apply. 📝", + CONF_LIGHTS: "A light (or list of lights) to apply the settings to. 💡", +} + def int_between(min_int, max_int): """Return an integer between 'min_int' and 'max_int'.""" @@ -290,55 +319,28 @@ _DOMAIN_SCHEMA = vol.Schema( ) -def _format_voluptuous_instance(instance): - coerce_type = None - min_val = None - max_val = None - - for validator in instance.validators: - if isinstance(validator, vol.Coerce): - coerce_type = validator.type.__name__ - elif isinstance(validator, (vol.Clamp, vol.Range)): - min_val = validator.min - max_val = validator.max - - if min_val is not None and max_val is not None: - return f"`{coerce_type}` {min_val}-{max_val}" - elif min_val is not None: - return f"`{coerce_type} > {min_val}`" - elif max_val is not None: - return f"`{coerce_type} < {max_val}`" - else: - return f"`{coerce_type}`" - - -def generate_markdown_table(): - import pandas as pd - - rows = [] - for k, default, type_ in VALIDATION_TUPLES: - description = DOCS[k] - if type_ == cv.entity_ids: - type_ = "list of `entity_id`s" - elif type_ in (bool, int, float, str): - type_ = f"`{type_.__name__}`" - elif isinstance(type_, vol.All): - type_ = _format_voluptuous_instance(type_) - elif isinstance(type_, vol.In): - type_ = f"one of `{type_.container}`" - elif isinstance(type_, selector.SelectSelector): - type_ = f"one of `{type_.config['options']}`" - elif isinstance(type_, selector.ColorRGBSelector): - type_ = "RGB color" - else: - raise ValueError(f"Unknown type: {type_}") - row = { - "Variable name": f"`{k}`", - "Description": description, - "Default": f"`{default}`", - "Type": type_, +def apply_service_schema(initial_transition: int = 1): + """Return the schema for the apply service.""" + return vol.Schema( + { + vol.Optional(CONF_ENTITY_ID): cv.entity_ids, + vol.Optional(CONF_LIGHTS, default=[]): cv.entity_ids, + vol.Optional( + CONF_TRANSITION, + default=initial_transition, + ): VALID_TRANSITION, + vol.Optional(ATTR_ADAPT_BRIGHTNESS, default=True): cv.boolean, + vol.Optional(ATTR_ADAPT_COLOR, default=True): cv.boolean, + vol.Optional(CONF_PREFER_RGB_COLOR, default=False): cv.boolean, + vol.Optional(CONF_TURN_ON_LIGHTS, default=False): cv.boolean, } - rows.append(row) + ) - df = pd.DataFrame(rows) - return df.to_markdown(index=False) + +SET_MANUAL_CONTROL_SCHEMA = vol.Schema( + { + vol.Optional(CONF_ENTITY_ID): cv.entity_ids, + vol.Optional(CONF_LIGHTS, default=[]): cv.entity_ids, + vol.Optional(CONF_MANUAL_CONTROL, default=True): cv.boolean, + } +) diff --git a/custom_components/adaptive_lighting/services.yaml b/custom_components/adaptive_lighting/services.yaml index 373e796a..89c112e3 100755 --- a/custom_components/adaptive_lighting/services.yaml +++ b/custom_components/adaptive_lighting/services.yaml @@ -2,7 +2,7 @@ apply: description: Applies the current Adaptive Lighting settings to lights. fields: entity_id: - description: entity_id of the Adaptive Lighting switch. If not specified, the current Adaptive Lighting switch will be used. + description: "Entity ID of the switch. \U0001F4DD" example: switch.adaptive_lighting_default selector: entity: @@ -10,43 +10,42 @@ apply: domain: switch multiple: false lights: - description: entity_id(s) of lights, if not specified, all lights in the switch are selected. + description: "List of light entities to be controlled by Adaptive Lighting (may be empty). \U0001F31F" example: light.bedroom_ceiling selector: entity: domain: light multiple: true transition: - description: Transition of the lights. + description: "Duration of transition when lights change, in seconds. \U0001F551" example: 10 selector: - text: + text: null adapt_brightness: - description: "Adapt the 'brightness', default: true" + description: "Whether to adapt the brightness of the light. \U0001F31E" example: true selector: - boolean: + boolean: null adapt_color: - description: "Adapt the color_temp/color_rgb, default: true" + description: "Whether to adapt the color of the light. \U0001F308" example: true selector: - boolean: + boolean: null prefer_rgb_color: - description: "Prefer to use color_rgb over color_temp if possible, default: false" + description: "Use RGB color adjustment instead of native light color temperature. \U0001F308" example: false selector: - boolean: + boolean: null turn_on_lights: - description: "Turn on the lights that are off, default: false" + description: "Whether to turn on lights if they are off. \U0001F506" example: false selector: - boolean: - + boolean: null set_manual_control: description: Mark whether a light is 'manually controlled'. fields: entity_id: - description: entity_id of the Adaptive Lighting switch. If not specified, the current Adaptive Lighting switch will be used. + description: "Entity ID of the switch. \U0001F4DD" example: switch.adaptive_lighting_default selector: entity: @@ -54,138 +53,137 @@ set_manual_control: domain: switch multiple: false lights: - description: entity_id(s) of lights, if not specified, all lights in the switch are selected. + description: "List of light entities to be controlled by Adaptive Lighting (may be empty). \U0001F31F" example: light.bedroom_ceiling selector: entity: domain: light multiple: true manual_control: - description: "Whether to add ('true') or remove ('false') the light from the 'manual_control' list, default: true" + description: "Whether to manually control the lights. \U0001F512" example: true default: true selector: - boolean: - + boolean: null change_switch_settings: - description: "Change any settings you'd like in the switch. All options here are the same as in the config flow." + description: Change any settings you'd like in the switch. All options here are the same as in the config flow. fields: entity_id: - description: "entity_id of the Adaptive Lighting switch." + description: "Entity ID of the switch. \U0001F4DD" required: true selector: entity: domain: switch use_defaults: - description: "(default: 'current' for current settings) You can set this to 'factory', 'configuration', or 'current' to reset the variables not being set with this service call. 'current' leaves them as is, 'configuration' resets to whatever already initializes at startup, 'factory' resets to the default values listed in the documentation." - example: "current" + description: "Whether to use default settings for the switches. \u2699\uFE0F" + example: current required: false - default: "current" + default: current selector: select: options: - - "current" - - "configuration" - - "factory" + - current + - configuration + - factory include_config_in_attributes: - description: "include_config_in_attributes: All config options will be listed as attributes under the adaptive-lighting switch this integration creates. (default: false)" + description: "Show all options as attributes on the switch in Home Assistant when set to `true`. \U0001F4DD" required: false selector: - boolean: + boolean: null turn_on_lights: - description: "Turn on the lights that are off, default: false" + description: "Whether to turn on lights if they are off. \U0001F506" example: false required: false selector: - boolean: + boolean: null initial_transition: - description: "initial_transition: When lights turn 'off' to 'on'. (seconds)" + description: "Duration of the first transition when lights turn from `off` to `on` in seconds. \u23F2\uFE0F" example: 1 required: false selector: - text: + text: null sleep_transition: - description: "sleep_transition: When 'sleep_state' changes. (seconds)" + description: "Duration of transition when 'sleep mode' is toggled in seconds. \U0001F634" example: 1 required: false selector: - text: + text: null max_brightness: - description: "max_brightness: Highest brightness of lights during a cycle. (%)" + description: "Maximum brightness percentage. \U0001F4A1" required: false example: 100 selector: - text: + text: null max_color_temp: - description: "max_color_temp: Coldest hue of the color temperature cycle. (Kelvin)" + description: "Coldest color temperature in Kelvin. \u2744\uFE0F" required: false example: 5500 selector: - text: + text: null min_brightness: - description: "min_brightness: Lowest brightness of lights during a cycle. (%)" + description: "Minimum brightness percentage. \U0001F4A1" required: false example: 1 selector: - text: + text: null min_color_temp: - description: "min_color_temp, Warmest hue of the color temperature cycle. (Kelvin)" + description: "Warmest color temperature in Kelvin. \U0001F525" required: false example: 2000 selector: - text: + text: null only_once: - description: "only_once: Only adapt the lights when turning them on." + description: "Adapt lights only when they are turned on (`true`) or keep adapting them (`false`). \U0001F504" example: false required: false selector: - boolean: + boolean: null prefer_rgb_color: - description: "prefer_rgb_color: Use 'rgb_color' rather than 'color_temp' when possible." + description: "Use RGB color adjustment instead of native light color temperature. \U0001F308" required: false example: false selector: - boolean: + boolean: null separate_turn_on_commands: - description: "separate_turn_on_commands: Separate the commands for each attribute (color, brightness, etc.) in 'light.turn_on' (required for some lights)." + description: "Use separate `light.turn_on` calls for color and brightness, needed for some light types. \U0001F500" required: false example: false selector: - boolean: + boolean: null send_split_delay: - description: "send_split_delay: wait between commands (milliseconds), when separate_turn_on_commands is used. May ensure that both commands are handled by the bulb correctly." + description: "Wait time (milliseconds) between commands when using `separate_turn_on_commands`. Helps ensure correct handling. \u23F2\uFE0F" required: false example: 0 selector: - boolean: + boolean: null sleep_brightness: - description: "sleep_brightness, Brightness setting for Sleep Mode. (%)" + description: "Brightness percentage of lights in sleep mode. \U0001F634" required: false example: 1 selector: - text: + text: null sleep_rgb_or_color_temp: - description: "sleep_rgb_or_color_temp, use 'rgb_color' or 'color_temp'" + description: "Use either `'rgb_color'` or `'color_temp'` in sleep mode. \U0001F319" required: false - example: "color_temp" + example: color_temp selector: select: options: - - "rgb_color" - - "color_temp" + - rgb_color + - color_temp sleep_rgb_color: - description: "sleep_rgb_color, in RGB" + description: "RGB color in sleep mode (used when `sleep_rgb_or_color_temp` is 'rgb_color'). \U0001F308" required: false selector: - color_rgb: + color_rgb: null sleep_color_temp: - description: "sleep_color_temp: Color temperature setting for Sleep Mode. (Kelvin)" + description: "Color temperature in sleep mode (used when `sleep_rgb_or_color_temp` is `color_temp`) in Kelvin. \U0001F634" required: false example: 1000 selector: - text: + text: null sunrise_offset: - description: sunrise_offset, in +/- seconds (integer) + description: "Adjust sunrise time with a positive or negative offset in seconds. \u23F0" required: false example: 0 selector: @@ -193,64 +191,64 @@ change_switch_settings: min: 0 max: 86300 sunrise_time: - description: sunrise_time, in 'HH:MM:SS' format (if 'None', it uses the actual sunrise time at your location) + description: "Set a fixed time (HH:MM:SS) for sunrise. \U0001F305" required: false - example: "" + example: '' selector: - time: + time: null sunset_offset: - description: sunset_offset, in +/- seconds (integer) + description: "Adjust sunset time with a positive or negative offset in seconds. \u23F0" required: false - example: "" + example: '' selector: number: min: 0 max: 86300 sunset_time: - description: sunset_time, in 'HH:MM:SS' format (if 'None', it uses the actual sunset time at your location) - example: "" + description: "Set a fixed time (HH:MM:SS) for sunset. \U0001F307" + example: '' required: false selector: - time: + time: null max_sunrise_time: - description: "max_sunrise_time: Manual override of the maximum sunrise time, if 'None', it uses the actual sunrise time at your location (HH:MM:SS)" - example: "" + description: "Set the latest virtual sunrise time (HH:MM:SS), allowing for earlier real sunrises. \U0001F305" + example: '' required: false selector: - time: + time: null min_sunset_time: - description: "min_sunset_time: Manual override of the minimum sunset time, if 'None', it uses the actual sunset time at your location (HH:MM:SS)" - example: "" + description: "Set the earliest virtual sunset time (HH:MM:SS), allowing for later real sunsets. \U0001F307" + example: '' required: false selector: - time: + time: null take_over_control: - description: "take_over_control: If anything but Adaptive Lighting calls 'light.turn_on' when a light is already on, stop adapting that light until it (or the switch) toggles off -> on." + description: "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`! \U0001F512" required: false example: true selector: - boolean: + boolean: null detect_non_ha_changes: - description: "detect_non_ha_changes: detects all >10% changes made to the lights (also outside of HA), requires 'take_over_control' to be enabled (calls 'homeassistant.update_entity' every 'interval'!)" + description: "Detect non-`light.turn_on` state changes and stop adapting lights. Requires `take_over_control`. \U0001F575\uFE0F" required: false example: false selector: - boolean: + boolean: null transition: - description: "Transition time when applying a change to the lights (seconds)" + description: "Duration of transition when lights change, in seconds. \U0001F551" required: false example: 45 selector: - text: + text: null adapt_delay: - description: "adapt_delay: wait time between light turn on (seconds), and Adaptive Lights applying changes to the light state. May avoid flickering." + description: "Wait time (seconds) between light turn on and Adaptive Lighting applying changes. Helps avoid flickering. \u23F2\uFE0F" required: false example: 0 selector: - text: + text: null autoreset_control_seconds: - description: "autoreset_control_seconds: wait time (seconds) before Adaptive Lighting resets `manual_control` status of any light (default: 0)" + description: "Automatically reset the manual control after a number of seconds. Set to 0 to disable. \u23F2\uFE0F" required: false example: 0 selector: - text: + text: null diff --git a/custom_components/adaptive_lighting/switch.py b/custom_components/adaptive_lighting/switch.py index 75361965..3e1c86db 100644 --- a/custom_components/adaptive_lighting/switch.py +++ b/custom_components/adaptive_lighting/switch.py @@ -39,7 +39,6 @@ from homeassistant.components.light import ( SUPPORT_COLOR, SUPPORT_COLOR_TEMP, SUPPORT_TRANSITION, - VALID_TRANSITION, is_on, ) from homeassistant.components.light import DOMAIN as LIGHT_DOMAIN @@ -137,11 +136,13 @@ from .const import ( SERVICE_APPLY, SERVICE_CHANGE_SWITCH_SETTINGS, SERVICE_SET_MANUAL_CONTROL, + SET_MANUAL_CONTROL_SCHEMA, SLEEP_MODE_SWITCH, SUN_EVENT_MIDNIGHT, SUN_EVENT_NOON, TURNING_OFF_DELAY, VALIDATION_TUPLES, + apply_service_schema, replace_none_str, ) @@ -495,20 +496,9 @@ async def async_setup_entry( domain=DOMAIN, service=SERVICE_APPLY, service_func=handle_apply, - schema=vol.Schema( - { - vol.Optional("entity_id"): cv.entity_ids, - vol.Optional(CONF_LIGHTS, default=[]): cv.entity_ids, - vol.Optional( - CONF_TRANSITION, - default=switch._initial_transition, # pylint: disable=protected-access - ): VALID_TRANSITION, - vol.Optional(ATTR_ADAPT_BRIGHTNESS, default=True): cv.boolean, - vol.Optional(ATTR_ADAPT_COLOR, default=True): cv.boolean, - vol.Optional(CONF_PREFER_RGB_COLOR, default=False): cv.boolean, - vol.Optional(CONF_TURN_ON_LIGHTS, default=False): cv.boolean, - } - ), + schema=apply_service_schema( + switch._initial_transition + ), # pylint: disable=protected-access ) # Register `set_manual_control` service @@ -516,13 +506,7 @@ async def async_setup_entry( domain=DOMAIN, service=SERVICE_SET_MANUAL_CONTROL, service_func=handle_set_manual_control, - schema=vol.Schema( - { - vol.Optional("entity_id"): cv.entity_ids, - vol.Optional(CONF_LIGHTS, default=[]): cv.entity_ids, - vol.Optional(CONF_MANUAL_CONTROL, default=True): cv.boolean, - } - ), + schema=SET_MANUAL_CONTROL_SCHEMA, ) args = {vol.Optional(CONF_USE_DEFAULTS, default="current"): cv.string} From 87391e6d24752141b1559ff65c95478b405ef185 Mon Sep 17 00:00:00 2001 From: Bas Nijholt Date: Mon, 3 Apr 2023 01:01:58 -0700 Subject: [PATCH 05/12] Bump to 1.9.0 (#518) --- custom_components/adaptive_lighting/manifest.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/custom_components/adaptive_lighting/manifest.json b/custom_components/adaptive_lighting/manifest.json index 39276752..803069a7 100644 --- a/custom_components/adaptive_lighting/manifest.json +++ b/custom_components/adaptive_lighting/manifest.json @@ -8,5 +8,5 @@ "iot_class": "calculated", "issue_tracker": "https://github.com/basnijholt/adaptive-lighting/issues", "requirements": [], - "version": "1.8.0" + "version": "1.9.0" } From c6a6cd323f701f356decbcca4a75a03500ca7f6b Mon Sep 17 00:00:00 2001 From: Benjamin Auquite Date: Mon, 3 Apr 2023 03:02:06 -0500 Subject: [PATCH 06/12] Basic community fixes PR (#460) * Fixes #423 #423 * Do not adapt lights turned on with custom payloads. * Update switch.py * Issue fixes #423, #378, #403, #449 * quickly test #274 * Revert feature requests, this branch only has fixes. Reverted FR 274 * pre-commit fix * Create automerge.yaml * test * Delete automerge.yaml My bad. * Fix #460 and #408 * see @basnijholt 's comment in #450. * @basnijholt requested changes. --------- Co-authored-by: Bas Nijholt --- .../adaptive_lighting/services.yaml | 4 ---- custom_components/adaptive_lighting/switch.py | 21 ++++++++++++++++--- tests/test_switch.py | 11 ++++++++-- 3 files changed, 27 insertions(+), 9 deletions(-) mode change 100755 => 100644 custom_components/adaptive_lighting/services.yaml diff --git a/custom_components/adaptive_lighting/services.yaml b/custom_components/adaptive_lighting/services.yaml old mode 100755 new mode 100644 index 89c112e3..351fe5b5 --- a/custom_components/adaptive_lighting/services.yaml +++ b/custom_components/adaptive_lighting/services.yaml @@ -3,7 +3,6 @@ apply: fields: entity_id: description: "Entity ID of the switch. \U0001F4DD" - example: switch.adaptive_lighting_default selector: entity: integration: adaptive_lighting @@ -11,7 +10,6 @@ apply: multiple: false lights: description: "List of light entities to be controlled by Adaptive Lighting (may be empty). \U0001F31F" - example: light.bedroom_ceiling selector: entity: domain: light @@ -46,7 +44,6 @@ set_manual_control: fields: entity_id: description: "Entity ID of the switch. \U0001F4DD" - example: switch.adaptive_lighting_default selector: entity: integration: adaptive_lighting @@ -54,7 +51,6 @@ set_manual_control: multiple: false lights: description: "List of light entities to be controlled by Adaptive Lighting (may be empty). \U0001F31F" - example: light.bedroom_ceiling selector: entity: domain: light diff --git a/custom_components/adaptive_lighting/switch.py b/custom_components/adaptive_lighting/switch.py index 3e1c86db..4b9e1856 100644 --- a/custom_components/adaptive_lighting/switch.py +++ b/custom_components/adaptive_lighting/switch.py @@ -582,7 +582,7 @@ def _expand_light_groups(hass: HomeAssistant, lights: list[str]) -> list[str]: def _supported_features(hass: HomeAssistant, light: str): state = hass.states.get(light) - supported_features = state.attributes[ATTR_SUPPORTED_FEATURES] + supported_features = state.attributes.get(ATTR_SUPPORTED_FEATURES, 0) supported = { key for key, value in _SUPPORT_OPTS.items() if supported_features & value } @@ -1017,7 +1017,8 @@ class AdaptiveSwitch(SwitchEntity, RestoreEntity): if prefer_rgb_color is None: prefer_rgb_color = self._prefer_rgb_color - if "transition" in features: + # Check transition == 0 to fix #378 + if "transition" in features and transition > 0: service_data[ATTR_TRANSITION] = transition # The switch might be off and not have _settings set. @@ -1064,7 +1065,18 @@ class AdaptiveSwitch(SwitchEntity, RestoreEntity): ) ): return - self.turn_on_off_listener.last_service_data[light] = service_data + # See #80. Doesn't check if transitions differ but it does the job. + last_service_data = self.turn_on_off_listener.last_service_data + if light in last_service_data and last_service_data[light] == service_data: + _LOGGER.debug( + "%s: Cancelling adapt to light %s, there's no new values to set (context.id='%s')", + self._name, + light, + context.id, + ) + return + else: + self.turn_on_off_listener.last_service_data[light] = service_data async def turn_on(service_data): _LOGGER.debug( @@ -1489,11 +1501,14 @@ class SunLightSettings: rgb_color: tuple[float, float, float] = color_temperature_to_rgb( color_temp_kelvin ) + # backwards compatibility for versions < 1.3.1 - see #403 + color_temp_mired: float = math.floor(1000000 / color_temp_kelvin) xy_color: tuple[float, float] = color_RGB_to_xy(*rgb_color) hs_color: tuple[float, float] = color_xy_to_hs(*xy_color) return { "brightness_pct": brightness_pct, "color_temp_kelvin": color_temp_kelvin, + "color_temp_mired": color_temp_mired, "rgb_color": rgb_color, "xy_color": xy_color, "hs_color": hs_color, diff --git a/tests/test_switch.py b/tests/test_switch.py index 5b74c94c..212cea82 100644 --- a/tests/test_switch.py +++ b/tests/test_switch.py @@ -527,11 +527,18 @@ async def test_manual_control(hass): await turn_switch(True, entity_id) assert not manual_control[ENTITY_LIGHT] + # Check that manual control is still enabled if set while bulb is off. + # Test issue #37 + await turn_light(False) + await change_manual_control(True) + await turn_light(True) + assert manual_control[ENTITY_LIGHT] + # Check that when 'adapt_brightness' is off, changing the brightness # doesn't mark it as manually controlled but changing color_temp # does - await turn_light(False) # reset manually controlled status - await turn_light(True) + await turn_light(False) + await turn_light(True) # reset manually controlled status assert not manual_control[ENTITY_LIGHT] await switch.adapt_brightness_switch.async_turn_off() await turn_light(True, brightness=increased_brightness()) From 0958feb744d503c2a7680476e9c80dcdc44d0b75 Mon Sep 17 00:00:00 2001 From: Bas Nijholt Date: Mon, 3 Apr 2023 01:47:01 -0700 Subject: [PATCH 07/12] Undo accidental changes introduced in #509, but adds the changes from #460 (#521) --- .../adaptive_lighting/services.yaml | 168 +++++++++--------- 1 file changed, 85 insertions(+), 83 deletions(-) mode change 100644 => 100755 custom_components/adaptive_lighting/services.yaml diff --git a/custom_components/adaptive_lighting/services.yaml b/custom_components/adaptive_lighting/services.yaml old mode 100644 new mode 100755 index 351fe5b5..c22d1f76 --- a/custom_components/adaptive_lighting/services.yaml +++ b/custom_components/adaptive_lighting/services.yaml @@ -2,184 +2,186 @@ apply: description: Applies the current Adaptive Lighting settings to lights. fields: entity_id: - description: "Entity ID of the switch. \U0001F4DD" + description: entity_id of the Adaptive Lighting switch. If not specified, the current Adaptive Lighting switch will be used. selector: entity: integration: adaptive_lighting domain: switch multiple: false lights: - description: "List of light entities to be controlled by Adaptive Lighting (may be empty). \U0001F31F" + description: entity_id(s) of lights, if not specified, all lights in the switch are selected. selector: entity: domain: light multiple: true transition: - description: "Duration of transition when lights change, in seconds. \U0001F551" + description: Transition of the lights. example: 10 selector: - text: null + text: adapt_brightness: - description: "Whether to adapt the brightness of the light. \U0001F31E" + description: "Adapt the 'brightness', default: true" example: true selector: - boolean: null + boolean: adapt_color: - description: "Whether to adapt the color of the light. \U0001F308" + description: "Adapt the color_temp/color_rgb, default: true" example: true selector: - boolean: null + boolean: prefer_rgb_color: - description: "Use RGB color adjustment instead of native light color temperature. \U0001F308" + description: "Prefer to use color_rgb over color_temp if possible, default: false" example: false selector: - boolean: null + boolean: turn_on_lights: - description: "Whether to turn on lights if they are off. \U0001F506" + description: "Turn on the lights that are off, default: false" example: false selector: - boolean: null + boolean: + set_manual_control: description: Mark whether a light is 'manually controlled'. fields: entity_id: - description: "Entity ID of the switch. \U0001F4DD" + description: entity_id of the Adaptive Lighting switch. If not specified, the current Adaptive Lighting switch will be used. selector: entity: integration: adaptive_lighting domain: switch multiple: false lights: - description: "List of light entities to be controlled by Adaptive Lighting (may be empty). \U0001F31F" + description: entity_id(s) of lights, if not specified, all lights in the switch are selected. selector: entity: domain: light multiple: true manual_control: - description: "Whether to manually control the lights. \U0001F512" + description: "Whether to add ('true') or remove ('false') the light from the 'manual_control' list, default: true" example: true default: true selector: - boolean: null + boolean: + change_switch_settings: - description: Change any settings you'd like in the switch. All options here are the same as in the config flow. + description: "Change any settings you'd like in the switch. All options here are the same as in the config flow." fields: entity_id: - description: "Entity ID of the switch. \U0001F4DD" + description: "entity_id of the Adaptive Lighting switch." required: true selector: entity: domain: switch use_defaults: - description: "Whether to use default settings for the switches. \u2699\uFE0F" - example: current + description: "(default: 'current' for current settings) You can set this to 'factory', 'configuration', or 'current' to reset the variables not being set with this service call. 'current' leaves them as is, 'configuration' resets to whatever already initializes at startup, 'factory' resets to the default values listed in the documentation." + example: "current" required: false - default: current + default: "current" selector: select: options: - - current - - configuration - - factory + - "current" + - "configuration" + - "factory" include_config_in_attributes: - description: "Show all options as attributes on the switch in Home Assistant when set to `true`. \U0001F4DD" + description: "include_config_in_attributes: All config options will be listed as attributes under the adaptive-lighting switch this integration creates. (default: false)" required: false selector: - boolean: null + boolean: turn_on_lights: - description: "Whether to turn on lights if they are off. \U0001F506" + description: "Turn on the lights that are off, default: false" example: false required: false selector: - boolean: null + boolean: initial_transition: - description: "Duration of the first transition when lights turn from `off` to `on` in seconds. \u23F2\uFE0F" + description: "initial_transition: When lights turn 'off' to 'on'. (seconds)" example: 1 required: false selector: - text: null + text: sleep_transition: - description: "Duration of transition when 'sleep mode' is toggled in seconds. \U0001F634" + description: "sleep_transition: When 'sleep_state' changes. (seconds)" example: 1 required: false selector: - text: null + text: max_brightness: - description: "Maximum brightness percentage. \U0001F4A1" + description: "max_brightness: Highest brightness of lights during a cycle. (%)" required: false example: 100 selector: - text: null + text: max_color_temp: - description: "Coldest color temperature in Kelvin. \u2744\uFE0F" + description: "max_color_temp: Coldest hue of the color temperature cycle. (Kelvin)" required: false example: 5500 selector: - text: null + text: min_brightness: - description: "Minimum brightness percentage. \U0001F4A1" + description: "min_brightness: Lowest brightness of lights during a cycle. (%)" required: false example: 1 selector: - text: null + text: min_color_temp: - description: "Warmest color temperature in Kelvin. \U0001F525" + description: "min_color_temp, Warmest hue of the color temperature cycle. (Kelvin)" required: false example: 2000 selector: - text: null + text: only_once: - description: "Adapt lights only when they are turned on (`true`) or keep adapting them (`false`). \U0001F504" + description: "only_once: Only adapt the lights when turning them on." example: false required: false selector: - boolean: null + boolean: prefer_rgb_color: - description: "Use RGB color adjustment instead of native light color temperature. \U0001F308" + description: "prefer_rgb_color: Use 'rgb_color' rather than 'color_temp' when possible." required: false example: false selector: - boolean: null + boolean: separate_turn_on_commands: - description: "Use separate `light.turn_on` calls for color and brightness, needed for some light types. \U0001F500" + description: "separate_turn_on_commands: Separate the commands for each attribute (color, brightness, etc.) in 'light.turn_on' (required for some lights)." required: false example: false selector: - boolean: null + boolean: send_split_delay: - description: "Wait time (milliseconds) between commands when using `separate_turn_on_commands`. Helps ensure correct handling. \u23F2\uFE0F" + description: "send_split_delay: wait between commands (milliseconds), when separate_turn_on_commands is used. May ensure that both commands are handled by the bulb correctly." required: false example: 0 selector: - boolean: null + boolean: sleep_brightness: - description: "Brightness percentage of lights in sleep mode. \U0001F634" + description: "sleep_brightness, Brightness setting for Sleep Mode. (%)" required: false example: 1 selector: - text: null + text: sleep_rgb_or_color_temp: - description: "Use either `'rgb_color'` or `'color_temp'` in sleep mode. \U0001F319" + description: "sleep_rgb_or_color_temp, use 'rgb_color' or 'color_temp'" required: false - example: color_temp + example: "color_temp" selector: select: options: - - rgb_color - - color_temp + - "rgb_color" + - "color_temp" sleep_rgb_color: - description: "RGB color in sleep mode (used when `sleep_rgb_or_color_temp` is 'rgb_color'). \U0001F308" + description: "sleep_rgb_color, in RGB" required: false selector: - color_rgb: null + color_rgb: sleep_color_temp: - description: "Color temperature in sleep mode (used when `sleep_rgb_or_color_temp` is `color_temp`) in Kelvin. \U0001F634" + description: "sleep_color_temp: Color temperature setting for Sleep Mode. (Kelvin)" required: false example: 1000 selector: - text: null + text: sunrise_offset: - description: "Adjust sunrise time with a positive or negative offset in seconds. \u23F0" + description: sunrise_offset, in +/- seconds (integer) required: false example: 0 selector: @@ -187,64 +189,64 @@ change_switch_settings: min: 0 max: 86300 sunrise_time: - description: "Set a fixed time (HH:MM:SS) for sunrise. \U0001F305" + description: sunrise_time, in 'HH:MM:SS' format (if 'None', it uses the actual sunrise time at your location) required: false - example: '' + example: "" selector: - time: null + time: sunset_offset: - description: "Adjust sunset time with a positive or negative offset in seconds. \u23F0" + description: sunset_offset, in +/- seconds (integer) required: false - example: '' + example: "" selector: number: min: 0 max: 86300 sunset_time: - description: "Set a fixed time (HH:MM:SS) for sunset. \U0001F307" - example: '' + description: sunset_time, in 'HH:MM:SS' format (if 'None', it uses the actual sunset time at your location) + example: "" required: false selector: - time: null + time: max_sunrise_time: - description: "Set the latest virtual sunrise time (HH:MM:SS), allowing for earlier real sunrises. \U0001F305" - example: '' + description: "max_sunrise_time: Manual override of the maximum sunrise time, if 'None', it uses the actual sunrise time at your location (HH:MM:SS)" + example: "" required: false selector: - time: null + time: min_sunset_time: - description: "Set the earliest virtual sunset time (HH:MM:SS), allowing for later real sunsets. \U0001F307" - example: '' + description: "min_sunset_time: Manual override of the minimum sunset time, if 'None', it uses the actual sunset time at your location (HH:MM:SS)" + example: "" required: false selector: - time: null + time: take_over_control: - description: "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`! \U0001F512" + description: "take_over_control: If anything but Adaptive Lighting calls 'light.turn_on' when a light is already on, stop adapting that light until it (or the switch) toggles off -> on." required: false example: true selector: - boolean: null + boolean: detect_non_ha_changes: - description: "Detect non-`light.turn_on` state changes and stop adapting lights. Requires `take_over_control`. \U0001F575\uFE0F" + description: "detect_non_ha_changes: detects all >10% changes made to the lights (also outside of HA), requires 'take_over_control' to be enabled (calls 'homeassistant.update_entity' every 'interval'!)" required: false example: false selector: - boolean: null + boolean: transition: - description: "Duration of transition when lights change, in seconds. \U0001F551" + description: "Transition time when applying a change to the lights (seconds)" required: false example: 45 selector: - text: null + text: adapt_delay: - description: "Wait time (seconds) between light turn on and Adaptive Lighting applying changes. Helps avoid flickering. \u23F2\uFE0F" + description: "adapt_delay: wait time between light turn on (seconds), and Adaptive Lights applying changes to the light state. May avoid flickering." required: false example: 0 selector: - text: null + text: autoreset_control_seconds: - description: "Automatically reset the manual control after a number of seconds. Set to 0 to disable. \u23F2\uFE0F" + description: "autoreset_control_seconds: wait time (seconds) before Adaptive Lighting resets `manual_control` status of any light (default: 0)" required: false example: 0 selector: - text: null + text: From d768a1e825302b593c7a01f5d57256a04fd30463 Mon Sep 17 00:00:00 2001 From: Bas Nijholt Date: Mon, 3 Apr 2023 02:07:05 -0700 Subject: [PATCH 08/12] Release 1.9.1 (#522) * Bump to 1.9.1 * Add CODEOWNERS --- .github/CODEOWNERS | 1 + custom_components/adaptive_lighting/manifest.json | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) create mode 100644 .github/CODEOWNERS diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 00000000..847961cb --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @basnijholt diff --git a/custom_components/adaptive_lighting/manifest.json b/custom_components/adaptive_lighting/manifest.json index 803069a7..cb7ba6e1 100644 --- a/custom_components/adaptive_lighting/manifest.json +++ b/custom_components/adaptive_lighting/manifest.json @@ -8,5 +8,5 @@ "iot_class": "calculated", "issue_tracker": "https://github.com/basnijholt/adaptive-lighting/issues", "requirements": [], - "version": "1.9.0" + "version": "1.9.1" } From 26974c8fd5db90f800592912080eca4b816f5710 Mon Sep 17 00:00:00 2001 From: Bas Nijholt Date: Mon, 3 Apr 2023 11:32:38 -0700 Subject: [PATCH 09/12] Simplify if-statement, (small #460 fix) (#526) --- custom_components/adaptive_lighting/switch.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/custom_components/adaptive_lighting/switch.py b/custom_components/adaptive_lighting/switch.py index 4b9e1856..031396fe 100644 --- a/custom_components/adaptive_lighting/switch.py +++ b/custom_components/adaptive_lighting/switch.py @@ -1067,7 +1067,7 @@ class AdaptiveSwitch(SwitchEntity, RestoreEntity): return # See #80. Doesn't check if transitions differ but it does the job. last_service_data = self.turn_on_off_listener.last_service_data - if light in last_service_data and last_service_data[light] == service_data: + if last_service_data.get(light) == service_data: _LOGGER.debug( "%s: Cancelling adapt to light %s, there's no new values to set (context.id='%s')", self._name, From b730c7cc9009be3b7a9a187e15286dcb4d06c6ef Mon Sep 17 00:00:00 2001 From: Bas Nijholt Date: Mon, 3 Apr 2023 14:59:14 -0700 Subject: [PATCH 10/12] Add scripts to auto update en.json, strings.json and services.yaml (#520) * Add scripts to auto update strings.json and services.yaml * Run services * simplify * Run strings * rerun * revert * allow unicode * Add CODEOWNERS * Update CODEOWNERS * set CONF_USE_DEFAULTS docs * add field_name * Auto run scripts * Update desc * Update README.md, strings.json, and services.yaml * double quotes * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Update README.md, strings.json, and services.yaml * Add newline * sync changes between en.json and strings.json * Update README.md, strings.json, and services.yaml * double quotes * fix * Update README.md, strings.json, and services.yaml * Add comments * Remove comments * shorter * Update README.md, strings.json, and services.yaml * Rephrase * Update README.md, strings.json, and services.yaml * remove key from desc --------- Co-authored-by: Benjamin Auquite Co-authored-by: github-actions[bot] Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> --- .github/update-services.py | 25 +++ .github/update-strings.py | 31 ++++ .github/workflows/update-readme.yml | 14 +- README.md | 14 +- custom_components/adaptive_lighting/const.py | 26 +-- .../adaptive_lighting/services.yaml | 169 +++++++++--------- .../adaptive_lighting/strings.json | 60 +++---- .../adaptive_lighting/translations/en.json | 58 +++--- 8 files changed, 231 insertions(+), 166 deletions(-) create mode 100644 .github/update-services.py create mode 100644 .github/update-strings.py mode change 100755 => 100644 custom_components/adaptive_lighting/services.yaml diff --git a/.github/update-services.py b/.github/update-services.py new file mode 100644 index 00000000..df4c7b30 --- /dev/null +++ b/.github/update-services.py @@ -0,0 +1,25 @@ +from pathlib import Path +import sys + +import yaml + +sys.path.append(str(Path(__file__).parent.parent)) + +from custom_components.adaptive_lighting import const # noqa: E402 + +services_filename = "custom_components/adaptive_lighting/services.yaml" +with open(services_filename) as f: + services = yaml.safe_load(f) + +for service_name, dct in services.items(): + _docs = {"set_manual_control": const.DOCS_MANUAL_CONTROL, "apply": const.DOCS_APPLY} + alternative_docs = _docs.get(service_name, const.DOCS) + for field_name, field in dct["fields"].items(): + description = alternative_docs.get(field_name, const.DOCS[field_name]) + field["description"] = description + +comment = "# This file is auto-generated by .github/update-services.py." + +with open(services_filename, "w") as f: + f.write(comment + "\n") + yaml.dump(services, f, sort_keys=False, width=1000, allow_unicode=True) diff --git a/.github/update-strings.py b/.github/update-strings.py new file mode 100644 index 00000000..aabc7443 --- /dev/null +++ b/.github/update-strings.py @@ -0,0 +1,31 @@ +import json +from pathlib import Path +import sys + +sys.path.append(str(Path(__file__).parent.parent)) + +from custom_components.adaptive_lighting import const # noqa: E402 + +strings_fname = "custom_components/adaptive_lighting/strings.json" +en_fname = "custom_components/adaptive_lighting/translations/en.json" +with open(strings_fname) as f: + strings = json.load(f) + +data = {k: f"{k}: {const.DOCS[k]}" for k, _, _ in const.VALIDATION_TUPLES} +strings["options"]["step"]["init"]["data"] = data + +with open(strings_fname, "w") as f: + json.dump(strings, f, indent=2, ensure_ascii=False) + f.write("\n") + + +# Sync changes from strings.json to en.json +with open(en_fname) as f: + en = json.load(f) + +en["config"]["step"]["user"] = strings["config"]["step"]["user"] +en["options"]["step"]["init"]["data"] = data + +with open(en_fname, "w") as f: + json.dump(en, f, indent=2, ensure_ascii=False) + f.write("\n") diff --git a/.github/workflows/update-readme.yml b/.github/workflows/update-readme.yml index bc31bb94..bec8cb4c 100644 --- a/.github/workflows/update-readme.yml +++ b/.github/workflows/update-readme.yml @@ -34,17 +34,23 @@ jobs: - name: Run markdown-code-runner run: markdown-code-runner --debug README.md - - name: Commit updated README.md + - name: Run update strings.json + run: python .github/update-strings.py + + - name: Run update services.yaml + run: python .github/update-services.py + + - name: Commit updated README.md, strings.json, and services.yaml id: commit run: | - git add README.md + git add -u . git config --local user.email "github-actions[bot]@users.noreply.github.com" git config --local user.name "github-actions[bot]" if git diff --quiet && git diff --staged --quiet; then - echo "No changes in README.md, skipping commit." + echo "No changes in README.md, strings.json, and services.yaml, skipping commit." echo "commit_status=skipped" >> $GITHUB_ENV else - git commit -m "Update README.md" + git commit -m "Update README.md, strings.json, and services.yaml" echo "commit_status=committed" >> $GITHUB_ENV fi diff --git a/README.md b/README.md index 5b98de8b..c7a873d0 100644 --- a/README.md +++ b/README.md @@ -90,11 +90,11 @@ The YAML and frontend configuration methods support all of the options listed be | Variable name | Description | Default | Type | |:-------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------------|:-------------------------------------| -| `lights` | List of light entities to be controlled by Adaptive Lighting (may be empty). 🌟 | `[]` | list of `entity_id`s | +| `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 | +| `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` | @@ -103,9 +103,9 @@ The YAML and frontend configuration methods support all of the options listed be | `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_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 | +| `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` | @@ -116,8 +116,8 @@ The YAML and frontend configuration methods support all of the options listed be | `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` | Wait time (milliseconds) between commands when using `separate_turn_on_commands`. Helps ensure correct handling. ⏲️ | `0` | `int` 0-10000 | -| `adapt_delay` | Wait time (seconds) between light turn on and Adaptive Lighting applying changes. Helps avoid flickering. ⏲️ | `0` | `float > 0` | +| `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 | @@ -188,7 +188,7 @@ adaptive_lighting: |:-------------------------|:-----------------------------------------------------------------------------------------------|:-----------|:---------------------| | `entity_id` | The `entity_id` of the switch in which to (un)mark the light as being `manually controlled`. 📝 | ✅ | list of `entity_id`s | | `lights` | entity_id(s) of lights, if not specified, all lights in the switch are selected. 💡 | ❌ | list of `entity_id`s | -| `manual_control` | Whether to add ('true') or remove ('false') the light from the 'manual_control' list. 🔒 | ❌ | bool | +| `manual_control` | Whether to add ("true") or remove ("false") the light from the "manual_control" list. 🔒 | ❌ | bool | #### `adaptive_lighting.change_switch_settings` diff --git a/custom_components/adaptive_lighting/const.py b/custom_components/adaptive_lighting/const.py index bb0c07cd..64620927 100644 --- a/custom_components/adaptive_lighting/const.py +++ b/custom_components/adaptive_lighting/const.py @@ -22,9 +22,7 @@ CONF_NAME, DEFAULT_NAME = "name", "default" DOCS[CONF_NAME] = "Display name for this switch. 📝" CONF_LIGHTS, DEFAULT_LIGHTS = "lights", [] -DOCS[CONF_LIGHTS] = ( - "List of light entities to be controlled by Adaptive " "Lighting (may be empty). 🌟" -) +DOCS[CONF_LIGHTS] = "List of light entity_ids to be controlled (may be empty). 🌟" CONF_DETECT_NON_HA_CHANGES, DEFAULT_DETECT_NON_HA_CHANGES = ( "detect_non_ha_changes", @@ -52,7 +50,7 @@ DOCS[CONF_INITIAL_TRANSITION] = ( CONF_SLEEP_TRANSITION, DEFAULT_SLEEP_TRANSITION = "sleep_transition", 1 DOCS[CONF_SLEEP_TRANSITION] = ( - "Duration of transition when 'sleep mode' is toggled " "in seconds. 😴" + 'Duration of transition when "sleep mode" is toggled ' "in seconds. 😴" ) CONF_INTERVAL, DEFAULT_INTERVAL = "interval", 90 @@ -102,7 +100,7 @@ DOCS[CONF_SLEEP_COLOR_TEMP] = ( CONF_SLEEP_RGB_COLOR, DEFAULT_SLEEP_RGB_COLOR = "sleep_rgb_color", [255, 56, 0] DOCS[CONF_SLEEP_RGB_COLOR] = ( - "RGB color in sleep mode (used when " "`sleep_rgb_or_color_temp` is 'rgb_color'). 🌈" + "RGB color in sleep mode (used when " '`sleep_rgb_or_color_temp` is "rgb_color"). 🌈' ) CONF_SLEEP_RGB_OR_COLOR_TEMP, DEFAULT_SLEEP_RGB_OR_COLOR_TEMP = ( @@ -110,7 +108,7 @@ CONF_SLEEP_RGB_OR_COLOR_TEMP, DEFAULT_SLEEP_RGB_OR_COLOR_TEMP = ( "color_temp", ) DOCS[CONF_SLEEP_RGB_OR_COLOR_TEMP] = ( - "Use either `'rgb_color'` or `'color_temp'` " "in sleep mode. 🌙" + 'Use either `"rgb_color"` or `"color_temp"` ' "in sleep mode. 🌙" ) CONF_SUNRISE_OFFSET, DEFAULT_SUNRISE_OFFSET = "sunrise_offset", 0 @@ -163,13 +161,13 @@ DOCS[CONF_ADAPT_UNTIL_SLEEP] = ( CONF_ADAPT_DELAY, DEFAULT_ADAPT_DELAY = "adapt_delay", 0 DOCS[CONF_ADAPT_DELAY] = ( "Wait time (seconds) between light turn on and Adaptive Lighting applying " - "changes. Helps avoid flickering. ⏲️" + "changes. Might help to avoid flickering. ⏲️" ) CONF_SEND_SPLIT_DELAY, DEFAULT_SEND_SPLIT_DELAY = "send_split_delay", 0 DOCS[CONF_SEND_SPLIT_DELAY] = ( - "Wait time (milliseconds) between commands when using `separate_turn_on_commands`. " - "Helps ensure correct handling. ⏲️" + "Delay (ms) between `separate_turn_on_commands` for lights that don't support " + "simultaneous brightness and color setting. ⏲️" ) CONF_AUTORESET_CONTROL, DEFAULT_AUTORESET_CONTROL = "autoreset_control_seconds", 0 @@ -197,7 +195,11 @@ CONF_TURN_ON_LIGHTS = "turn_on_lights" DOCS[CONF_TURN_ON_LIGHTS] = "Whether to turn on lights that are currently off. 🔆" SERVICE_CHANGE_SWITCH_SETTINGS = "change_switch_settings" CONF_USE_DEFAULTS = "use_defaults" -DOCS[CONF_USE_DEFAULTS] = "Whether to use default settings for the switches. ⚙️" +DOCS[CONF_USE_DEFAULTS] = ( + "Sets the default values not specified in this service call. Options: " + '"current" (default, retains current values), "factory" (resets to ' + 'documented defaults), or "configuration" (reverts to switch config defaults). ⚙️' +) TURNING_OFF_DELAY = 5 @@ -206,8 +208,8 @@ DOCS_MANUAL_CONTROL = { "light as being `manually controlled`. 📝", CONF_LIGHTS: "entity_id(s) of lights, if not specified, all lights in the " "switch are selected. 💡", - CONF_MANUAL_CONTROL: "Whether to add ('true') or remove ('false') the " - "light from the 'manual_control' list. 🔒", + CONF_MANUAL_CONTROL: 'Whether to add ("true") or remove ("false") the ' + 'light from the "manual_control" list. 🔒', } DOCS_APPLY = { diff --git a/custom_components/adaptive_lighting/services.yaml b/custom_components/adaptive_lighting/services.yaml old mode 100755 new mode 100644 index c22d1f76..cd25811b --- a/custom_components/adaptive_lighting/services.yaml +++ b/custom_components/adaptive_lighting/services.yaml @@ -1,187 +1,186 @@ +# This file is auto-generated by .github/update-services.py. apply: description: Applies the current Adaptive Lighting settings to lights. fields: entity_id: - description: entity_id of the Adaptive Lighting switch. If not specified, the current Adaptive Lighting switch will be used. + description: The `entity_id` of the switch with the settings to apply. 📝 selector: entity: integration: adaptive_lighting domain: switch multiple: false lights: - description: entity_id(s) of lights, if not specified, all lights in the switch are selected. + description: A light (or list of lights) to apply the settings to. 💡 selector: entity: domain: light multiple: true transition: - description: Transition of the lights. + description: Duration of transition when lights change, in seconds. 🕑 example: 10 selector: - text: + text: null adapt_brightness: - description: "Adapt the 'brightness', default: true" + description: Whether to adapt the brightness of the light. 🌞 example: true selector: - boolean: + boolean: null adapt_color: - description: "Adapt the color_temp/color_rgb, default: true" + description: Whether to adapt the color on supporting lights. 🌈 example: true selector: - boolean: + boolean: null prefer_rgb_color: - description: "Prefer to use color_rgb over color_temp if possible, default: false" + description: Whether to prefer RGB color adjustment over light color temperature when possible. 🌈 example: false selector: - boolean: + boolean: null turn_on_lights: - description: "Turn on the lights that are off, default: false" + description: Whether to turn on lights that are currently off. 🔆 example: false selector: - boolean: - + boolean: null set_manual_control: description: Mark whether a light is 'manually controlled'. fields: entity_id: - description: entity_id of the Adaptive Lighting switch. If not specified, the current Adaptive Lighting switch will be used. + description: The `entity_id` of the switch in which to (un)mark the light as being `manually controlled`. 📝 selector: entity: integration: adaptive_lighting domain: switch multiple: false lights: - description: entity_id(s) of lights, if not specified, all lights in the switch are selected. + description: entity_id(s) of lights, if not specified, all lights in the switch are selected. 💡 selector: entity: domain: light multiple: true manual_control: - description: "Whether to add ('true') or remove ('false') the light from the 'manual_control' list, default: true" + description: Whether to add ("true") or remove ("false") the light from the "manual_control" list. 🔒 example: true default: true selector: - boolean: - + boolean: null change_switch_settings: - description: "Change any settings you'd like in the switch. All options here are the same as in the config flow." + description: Change any settings you'd like in the switch. All options here are the same as in the config flow. fields: entity_id: - description: "entity_id of the Adaptive Lighting switch." + description: Entity ID of the switch. 📝 required: true selector: entity: domain: switch use_defaults: - description: "(default: 'current' for current settings) You can set this to 'factory', 'configuration', or 'current' to reset the variables not being set with this service call. 'current' leaves them as is, 'configuration' resets to whatever already initializes at startup, 'factory' resets to the default values listed in the documentation." - example: "current" + description: 'Sets the default values not specified in this service call. Options: "current" (default, retains current values), "factory" (resets to documented defaults), or "configuration" (reverts to switch config defaults). ⚙️' + example: current required: false - default: "current" + default: current selector: select: options: - - "current" - - "configuration" - - "factory" + - current + - configuration + - factory include_config_in_attributes: - description: "include_config_in_attributes: All config options will be listed as attributes under the adaptive-lighting switch this integration creates. (default: false)" + description: Show all options as attributes on the switch in Home Assistant when set to `true`. 📝 required: false selector: - boolean: + boolean: null turn_on_lights: - description: "Turn on the lights that are off, default: false" + description: Whether to turn on lights that are currently off. 🔆 example: false required: false selector: - boolean: + boolean: null initial_transition: - description: "initial_transition: When lights turn 'off' to 'on'. (seconds)" + description: Duration of the first transition when lights turn from `off` to `on` in seconds. ⏲️ example: 1 required: false selector: - text: + text: null sleep_transition: - description: "sleep_transition: When 'sleep_state' changes. (seconds)" + description: Duration of transition when "sleep mode" is toggled in seconds. 😴 example: 1 required: false selector: - text: + text: null max_brightness: - description: "max_brightness: Highest brightness of lights during a cycle. (%)" + description: Maximum brightness percentage. 💡 required: false example: 100 selector: - text: + text: null max_color_temp: - description: "max_color_temp: Coldest hue of the color temperature cycle. (Kelvin)" + description: Coldest color temperature in Kelvin. ❄️ required: false example: 5500 selector: - text: + text: null min_brightness: - description: "min_brightness: Lowest brightness of lights during a cycle. (%)" + description: Minimum brightness percentage. 💡 required: false example: 1 selector: - text: + text: null min_color_temp: - description: "min_color_temp, Warmest hue of the color temperature cycle. (Kelvin)" + description: Warmest color temperature in Kelvin. 🔥 required: false example: 2000 selector: - text: + text: null only_once: - description: "only_once: Only adapt the lights when turning them on." + description: Adapt lights only when they are turned on (`true`) or keep adapting them (`false`). 🔄 example: false required: false selector: - boolean: + boolean: null prefer_rgb_color: - description: "prefer_rgb_color: Use 'rgb_color' rather than 'color_temp' when possible." + description: Whether to prefer RGB color adjustment over light color temperature when possible. 🌈 required: false example: false selector: - boolean: + boolean: null separate_turn_on_commands: - description: "separate_turn_on_commands: Separate the commands for each attribute (color, brightness, etc.) in 'light.turn_on' (required for some lights)." + description: Use separate `light.turn_on` calls for color and brightness, needed for some light types. 🔀 required: false example: false selector: - boolean: + boolean: null send_split_delay: - description: "send_split_delay: wait between commands (milliseconds), when separate_turn_on_commands is used. May ensure that both commands are handled by the bulb correctly." + description: Delay (ms) between `separate_turn_on_commands` for lights that don't support simultaneous brightness and color setting. ⏲️ required: false example: 0 selector: - boolean: + boolean: null sleep_brightness: - description: "sleep_brightness, Brightness setting for Sleep Mode. (%)" + description: Brightness percentage of lights in sleep mode. 😴 required: false example: 1 selector: - text: + text: null sleep_rgb_or_color_temp: - description: "sleep_rgb_or_color_temp, use 'rgb_color' or 'color_temp'" + description: Use either `"rgb_color"` or `"color_temp"` in sleep mode. 🌙 required: false - example: "color_temp" + example: color_temp selector: select: options: - - "rgb_color" - - "color_temp" + - rgb_color + - color_temp sleep_rgb_color: - description: "sleep_rgb_color, in RGB" + description: RGB color in sleep mode (used when `sleep_rgb_or_color_temp` is "rgb_color"). 🌈 required: false selector: - color_rgb: + color_rgb: null sleep_color_temp: - description: "sleep_color_temp: Color temperature setting for Sleep Mode. (Kelvin)" + description: Color temperature in sleep mode (used when `sleep_rgb_or_color_temp` is `color_temp`) in Kelvin. 😴 required: false example: 1000 selector: - text: + text: null sunrise_offset: - description: sunrise_offset, in +/- seconds (integer) + description: Adjust sunrise time with a positive or negative offset in seconds. ⏰ required: false example: 0 selector: @@ -189,64 +188,64 @@ change_switch_settings: min: 0 max: 86300 sunrise_time: - description: sunrise_time, in 'HH:MM:SS' format (if 'None', it uses the actual sunrise time at your location) + description: Set a fixed time (HH:MM:SS) for sunrise. 🌅 required: false - example: "" + example: '' selector: - time: + time: null sunset_offset: - description: sunset_offset, in +/- seconds (integer) + description: Adjust sunset time with a positive or negative offset in seconds. ⏰ required: false - example: "" + example: '' selector: number: min: 0 max: 86300 sunset_time: - description: sunset_time, in 'HH:MM:SS' format (if 'None', it uses the actual sunset time at your location) - example: "" + description: Set a fixed time (HH:MM:SS) for sunset. 🌇 + example: '' required: false selector: - time: + time: null max_sunrise_time: - description: "max_sunrise_time: Manual override of the maximum sunrise time, if 'None', it uses the actual sunrise time at your location (HH:MM:SS)" - example: "" + description: Set the latest virtual sunrise time (HH:MM:SS), allowing for earlier real sunrises. 🌅 + example: '' required: false selector: - time: + time: null min_sunset_time: - description: "min_sunset_time: Manual override of the minimum sunset time, if 'None', it uses the actual sunset time at your location (HH:MM:SS)" - example: "" + description: Set the earliest virtual sunset time (HH:MM:SS), allowing for later real sunsets. 🌇 + example: '' required: false selector: - time: + time: null take_over_control: - description: "take_over_control: If anything but Adaptive Lighting calls 'light.turn_on' when a light is already on, stop adapting that light until it (or the switch) toggles off -> on." + description: 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`! 🔒 required: false example: true selector: - boolean: + boolean: null detect_non_ha_changes: - description: "detect_non_ha_changes: detects all >10% changes made to the lights (also outside of HA), requires 'take_over_control' to be enabled (calls 'homeassistant.update_entity' every 'interval'!)" + description: Detect non-`light.turn_on` state changes and stop adapting lights. Requires `take_over_control`. 🕵️ required: false example: false selector: - boolean: + boolean: null transition: - description: "Transition time when applying a change to the lights (seconds)" + description: Duration of transition when lights change, in seconds. 🕑 required: false example: 45 selector: - text: + text: null adapt_delay: - description: "adapt_delay: wait time between light turn on (seconds), and Adaptive Lights applying changes to the light state. May avoid flickering." + description: Wait time (seconds) between light turn on and Adaptive Lighting applying changes. Might help to avoid flickering. ⏲️ required: false example: 0 selector: - text: + text: null autoreset_control_seconds: - description: "autoreset_control_seconds: wait time (seconds) before Adaptive Lighting resets `manual_control` status of any light (default: 0)" + description: Automatically reset the manual control after a number of seconds. Set to 0 to disable. ⏲️ required: false example: 0 selector: - text: + text: null diff --git a/custom_components/adaptive_lighting/strings.json b/custom_components/adaptive_lighting/strings.json index 2ebd96d0..54af5e11 100644 --- a/custom_components/adaptive_lighting/strings.json +++ b/custom_components/adaptive_lighting/strings.json @@ -2,7 +2,7 @@ "config": { "step": { "user": { - "title": "Choose a name for the Adaptive Lighting", + "title": "Choose a name for the Adaptive Lighting instance", "description": "Every instance can contain multiple lights!", "data": { "name": "Name" @@ -19,35 +19,35 @@ "title": "Adaptive Lighting options", "description": "All settings for a Adaptive Lighting component. The option names correspond with the YAML settings. No options are shown if you have this entry defined in YAML.", "data": { - "lights": "lights", - "initial_transition": "initial_transition: When lights turn 'off' to 'on'. (seconds)", - "include_config_in_attributes": "include_config_in_attributes: All config options will be listed as attributes under the adaptive-lighting switch this integration creates. (default: false)", - "adapt_until_sleep": "adapt_until_sleep: When checked, Adaptive Lighting will use the sleep settings as the minimum, and transition to these values past the sunset (default: false)", - "sleep_transition": "sleep_transition: When 'sleep_state' changes. (seconds)", - "interval": "interval: Time between switch updates. (seconds)", - "max_brightness": "max_brightness: Highest brightness of lights during a cycle. (%)", - "max_color_temp": "max_color_temp: Coldest hue of the color temperature cycle. (Kelvin)", - "min_brightness": "min_brightness: Lowest brightness of lights during a cycle. (%)", - "min_color_temp": "min_color_temp, Warmest hue of the color temperature cycle. (Kelvin)", - "only_once": "only_once: Only adapt the lights when turning them on.", - "prefer_rgb_color": "prefer_rgb_color: Use 'rgb_color' rather than 'color_temp' when possible.", - "separate_turn_on_commands": "separate_turn_on_commands: Separate the commands for each attribute (color, brightness, etc.) in 'light.turn_on' (required for some lights).", - "send_split_delay": "send_split_delay: wait between commands (milliseconds), when separate_turn_on_commands is used. May ensure that both commands are handled by the bulb correctly.", - "sleep_brightness": "sleep_brightness, Brightness setting for Sleep Mode. (%)", - "sleep_rgb_or_color_temp": "sleep_rgb_or_color_temp, use 'rgb_color' or 'color_temp'", - "sleep_rgb_color": "sleep_rgb_color, in RGB", - "sleep_color_temp": "sleep_color_temp: Color temperature setting for Sleep Mode. (Kelvin)", - "sunrise_offset": "sunrise_offset: How long before(-) or after(+) to define the sunrise point of the cycle (+/- seconds)", - "sunrise_time": "sunrise_time: Manual override of the sunrise time, if 'None', it uses the actual sunrise time at your location (HH:MM:SS)", - "max_sunrise_time": "max_sunrise_time: Manual override of the maximum sunrise time, if 'None', it uses the actual sunrise time at your location (HH:MM:SS)", - "sunset_offset": "sunset_offset: How long before(-) or after(+) to define the sunset point of the cycle (+/- seconds)", - "sunset_time": "sunset_time: Manual override of the sunset time, if 'None', it uses the actual sunset time at your location (HH:MM:SS)", - "min_sunset_time": "min_sunset_time: Manual override of the minimum sunset time, if 'None', it uses the actual sunset time at your location (HH:MM:SS)", - "take_over_control": "take_over_control: If anything but Adaptive Lighting calls 'light.turn_on' when a light is already on, stop adapting that light until it (or the switch) toggles off -> on.", - "detect_non_ha_changes": "detect_non_ha_changes: detects all >10% changes made to the lights (also outside of HA), requires 'take_over_control' to be enabled (calls 'homeassistant.update_entity' every 'interval'!)", - "transition": "Transition time when applying a change to the lights (seconds)", - "adapt_delay": "adapt_delay: wait time between light turn on (seconds), and Adaptive Lights applying changes to the light state. May avoid flickering.", - "autoreset_control_seconds": "autoreset_control_seconds: wait time (seconds) before Adaptive Lighting resets `manual_control` status of any light (default: 0)" + "lights": "lights: List of light entity_ids to be controlled (may be empty). 🌟", + "prefer_rgb_color": "prefer_rgb_color: Whether to prefer RGB color adjustment over light color temperature when possible. 🌈", + "include_config_in_attributes": "include_config_in_attributes: Show all options as attributes on the switch in Home Assistant when set to `true`. 📝", + "initial_transition": "initial_transition: Duration of the first transition when lights turn from `off` to `on` in seconds. ⏲️", + "sleep_transition": "sleep_transition: Duration of transition when \"sleep mode\" is toggled in seconds. 😴", + "transition": "transition: Duration of transition when lights change, in seconds. 🕑", + "transition_until_sleep": "transition_until_sleep: When enabled, Adaptive Lighting will treat sleep settings as the minimum, transitioning to these values after sunset. 🌙", + "interval": "interval: Frequency to adapt the lights, in seconds. 🔄", + "min_brightness": "min_brightness: Minimum brightness percentage. 💡", + "max_brightness": "max_brightness: Maximum brightness percentage. 💡", + "min_color_temp": "min_color_temp: Warmest color temperature in Kelvin. 🔥", + "max_color_temp": "max_color_temp: Coldest color temperature in Kelvin. ❄️", + "sleep_brightness": "sleep_brightness: Brightness percentage of lights in sleep mode. 😴", + "sleep_rgb_or_color_temp": "sleep_rgb_or_color_temp: Use either `\"rgb_color\"` or `\"color_temp\"` in sleep mode. 🌙", + "sleep_color_temp": "sleep_color_temp: Color temperature in sleep mode (used when `sleep_rgb_or_color_temp` is `color_temp`) in Kelvin. 😴", + "sleep_rgb_color": "sleep_rgb_color: RGB color in sleep mode (used when `sleep_rgb_or_color_temp` is \"rgb_color\"). 🌈", + "sunrise_time": "sunrise_time: Set a fixed time (HH:MM:SS) for sunrise. 🌅", + "max_sunrise_time": "max_sunrise_time: Set the latest virtual sunrise time (HH:MM:SS), allowing for earlier real sunrises. 🌅", + "sunrise_offset": "sunrise_offset: Adjust sunrise time with a positive or negative offset in seconds. ⏰", + "sunset_time": "sunset_time: Set a fixed time (HH:MM:SS) for sunset. 🌇", + "min_sunset_time": "min_sunset_time: Set the earliest virtual sunset time (HH:MM:SS), allowing for later real sunsets. 🌇", + "sunset_offset": "sunset_offset: Adjust sunset time with a positive or negative offset in seconds. ⏰", + "only_once": "only_once: Adapt lights only when they are turned on (`true`) or keep adapting them (`false`). 🔄", + "take_over_control": "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`! 🔒", + "detect_non_ha_changes": "detect_non_ha_changes: Detect non-`light.turn_on` state changes and stop adapting lights. Requires `take_over_control`. 🕵️", + "separate_turn_on_commands": "separate_turn_on_commands: Use separate `light.turn_on` calls for color and brightness, needed for some light types. 🔀", + "send_split_delay": "send_split_delay: Delay (ms) between `separate_turn_on_commands` for lights that don't support simultaneous brightness and color setting. ⏲️", + "adapt_delay": "adapt_delay: Wait time (seconds) between light turn on and Adaptive Lighting applying changes. Might help to avoid flickering. ⏲️", + "autoreset_control_seconds": "autoreset_control_seconds: Automatically reset the manual control after a number of seconds. Set to 0 to disable. ⏲️" } } }, diff --git a/custom_components/adaptive_lighting/translations/en.json b/custom_components/adaptive_lighting/translations/en.json index 51311d64..38fb7b0e 100644 --- a/custom_components/adaptive_lighting/translations/en.json +++ b/custom_components/adaptive_lighting/translations/en.json @@ -4,7 +4,7 @@ "step": { "user": { "title": "Choose a name for the Adaptive Lighting instance", - "description": "Pick a name for this instance. You can run several instances of Adaptive lighting, each of these can contain multiple lights!", + "description": "Every instance can contain multiple lights!", "data": { "name": "Name" } @@ -20,33 +20,35 @@ "title": "Adaptive Lighting options", "description": "All settings for a Adaptive Lighting component. The option names correspond with the YAML settings. No options are shown if you have the adaptive_lighting entry defined in your YAML configuration.", "data": { - "lights": "lights", - "initial_transition": "initial_transition: When lights turn 'off' to 'on'. (seconds)", - "include_config_in_attributes": "include_config_in_attributes: All config options will be listed as attributes under the adaptive-lighting switch this integration creates. (default: false)", - "sleep_transition": "sleep_transition: When 'sleep_state' changes. (seconds)", - "interval": "interval: Time between switch updates. (seconds)", - "max_brightness": "max_brightness: Highest brightness of lights during a cycle. (%)", - "max_color_temp": "max_color_temp: Coldest hue of the color temperature cycle. (Kelvin)", - "min_brightness": "min_brightness: Lowest brightness of lights during a cycle. (%)", - "min_color_temp": "min_color_temp, Warmest hue of the color temperature cycle. (Kelvin)", - "only_once": "only_once: Only adapt the lights when turning them on.", - "prefer_rgb_color": "prefer_rgb_color: Use 'rgb_color' rather than 'color_temp' when possible.", - "separate_turn_on_commands": "separate_turn_on_commands: Separate the commands for each attribute (color, brightness, etc.) in 'light.turn_on' (required for some lights).", - "send_split_delay": "send_split_delay: wait between commands (milliseconds), when separate_turn_on_commands is used. May ensure that both commands are handled by the bulb correctly.", - "sleep_brightness": "sleep_brightness, Brightness setting for Sleep Mode. (%)", - "sleep_rgb_or_color_temp": "sleep_rgb_or_color_temp, use 'rgb_color' or 'color_temp'", - "sleep_rgb_color": "sleep_rgb_color, in RGB", - "sleep_color_temp": "sleep_color_temp: Color temperature setting for Sleep Mode. (Kelvin)", - "sunrise_offset": "sunrise_offset: How long before(-) or after(+) to define the sunrise point of the cycle (+/- seconds)", - "sunrise_time": "sunrise_time: Manual override of the sunrise time, if 'None', it uses the actual sunrise time at your location (HH:MM:SS)", - "max_sunrise_time": "max_sunrise_time: Manual override of the maximum sunrise time, if 'None', it uses the actual sunrise time at your location (HH:MM:SS)", - "sunset_offset": "sunset_offset: How long before(-) or after(+) to define the sunset point of the cycle (+/- seconds)", - "sunset_time": "sunset_time: Manual override of the sunset time, if 'None', it uses the actual sunset time at your location (HH:MM:SS)", - "min_sunset_time": "min_sunset_time: Manual override of the minimum sunset time, if 'None', it uses the actual sunset time at your location (HH:MM:SS)", - "take_over_control": "take_over_control: If anything but Adaptive Lighting calls 'light.turn_on' when a light is already on, stop adapting that light until it (or the switch) toggles off -> on.", - "detect_non_ha_changes": "detect_non_ha_changes: detects all >10% changes made to the lights (also outside of HA), requires 'take_over_control' to be enabled (calls 'homeassistant.update_entity' every 'interval'!)", - "transition": "Transition time when applying a change to the lights (seconds)", - "adapt_delay": "adapt_delay: wait time between light turn on (seconds), and Adaptive Lights applying changes to the light state. May avoid flickering." + "lights": "lights: List of light entity_ids to be controlled (may be empty). 🌟", + "prefer_rgb_color": "prefer_rgb_color: Whether to prefer RGB color adjustment over light color temperature when possible. 🌈", + "include_config_in_attributes": "include_config_in_attributes: Show all options as attributes on the switch in Home Assistant when set to `true`. 📝", + "initial_transition": "initial_transition: Duration of the first transition when lights turn from `off` to `on` in seconds. ⏲️", + "sleep_transition": "sleep_transition: Duration of transition when \"sleep mode\" is toggled in seconds. 😴", + "transition": "transition: Duration of transition when lights change, in seconds. 🕑", + "transition_until_sleep": "transition_until_sleep: When enabled, Adaptive Lighting will treat sleep settings as the minimum, transitioning to these values after sunset. 🌙", + "interval": "interval: Frequency to adapt the lights, in seconds. 🔄", + "min_brightness": "min_brightness: Minimum brightness percentage. 💡", + "max_brightness": "max_brightness: Maximum brightness percentage. 💡", + "min_color_temp": "min_color_temp: Warmest color temperature in Kelvin. 🔥", + "max_color_temp": "max_color_temp: Coldest color temperature in Kelvin. ❄️", + "sleep_brightness": "sleep_brightness: Brightness percentage of lights in sleep mode. 😴", + "sleep_rgb_or_color_temp": "sleep_rgb_or_color_temp: Use either `\"rgb_color\"` or `\"color_temp\"` in sleep mode. 🌙", + "sleep_color_temp": "sleep_color_temp: Color temperature in sleep mode (used when `sleep_rgb_or_color_temp` is `color_temp`) in Kelvin. 😴", + "sleep_rgb_color": "sleep_rgb_color: RGB color in sleep mode (used when `sleep_rgb_or_color_temp` is \"rgb_color\"). 🌈", + "sunrise_time": "sunrise_time: Set a fixed time (HH:MM:SS) for sunrise. 🌅", + "max_sunrise_time": "max_sunrise_time: Set the latest virtual sunrise time (HH:MM:SS), allowing for earlier real sunrises. 🌅", + "sunrise_offset": "sunrise_offset: Adjust sunrise time with a positive or negative offset in seconds. ⏰", + "sunset_time": "sunset_time: Set a fixed time (HH:MM:SS) for sunset. 🌇", + "min_sunset_time": "min_sunset_time: Set the earliest virtual sunset time (HH:MM:SS), allowing for later real sunsets. 🌇", + "sunset_offset": "sunset_offset: Adjust sunset time with a positive or negative offset in seconds. ⏰", + "only_once": "only_once: Adapt lights only when they are turned on (`true`) or keep adapting them (`false`). 🔄", + "take_over_control": "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`! 🔒", + "detect_non_ha_changes": "detect_non_ha_changes: Detect non-`light.turn_on` state changes and stop adapting lights. Requires `take_over_control`. 🕵️", + "separate_turn_on_commands": "separate_turn_on_commands: Use separate `light.turn_on` calls for color and brightness, needed for some light types. 🔀", + "send_split_delay": "send_split_delay: Delay (ms) between `separate_turn_on_commands` for lights that don't support simultaneous brightness and color setting. ⏲️", + "adapt_delay": "adapt_delay: Wait time (seconds) between light turn on and Adaptive Lighting applying changes. Might help to avoid flickering. ⏲️", + "autoreset_control_seconds": "autoreset_control_seconds: Automatically reset the manual control after a number of seconds. Set to 0 to disable. ⏲️" } } }, From c7f44e472ff672512e027f7e8bbe43dbd095558f Mon Sep 17 00:00:00 2001 From: Benjamin Auquite Date: Mon, 3 Apr 2023 19:04:06 -0500 Subject: [PATCH 11/12] Correctly wait for transitions (#510) * Add auto_reset_manual_control with async timer * cherry-pick wait for transition stuff * Update switch.py * not renamed in this branch yet. * Update switch.py * update tests * Update switch.py * merge related fix * cleanup * Revert "cleanup" This reverts commit 3aa2f3242b06370c0f84248d2c2c21a2556bb5ec. * Update switch.py * Update switch.py * Update switch.py * Small refactor * Move test to old position for better diffs * Revert "Small refactor" This reverts commit b986b3f77cba921cbfb07647dea1d6f876883dd4. * Update README.md * fix the test last_state_change isn't updated quick enough. * #510 changes (#516) * Change (WIP) * Update test_switch.py * Refactor * Revert "Revert "Small refactor"" This reverts commit 3731c9993676b0a831af12da25bfd8c07ff2a148. * Update README.md * Fix the test * Bump to 1.9.0 (#518) * Basic community fixes PR (#460) * Fixes #423 #423 * Do not adapt lights turned on with custom payloads. * Update switch.py * Issue fixes #423, #378, #403, #449 * quickly test #274 * Revert feature requests, this branch only has fixes. Reverted FR 274 * pre-commit fix * Create automerge.yaml * test * Delete automerge.yaml My bad. * Fix #460 and #408 * see @basnijholt 's comment in #450. * @basnijholt requested changes. --------- Co-authored-by: Bas Nijholt * Undo accidental changes introduced in #509, but adds the changes from #460 (#521) * Release 1.9.1 (#522) * Bump to 1.9.1 * Add CODEOWNERS --------- Co-authored-by: Benjamin Auquite Co-authored-by: github-actions[bot] * No need to wrap the reset * Remove unused attrs * Shorter log message * revert unrelated tests change * remove unused function * Use patch * Bump to 1.10.0 --------- Co-authored-by: Bas Nijholt Co-authored-by: github-actions[bot] Co-authored-by: Bas Nijholt --- .../adaptive_lighting/manifest.json | 2 +- custom_components/adaptive_lighting/switch.py | 261 +++++++++++------- tests/test_switch.py | 67 ++++- 3 files changed, 211 insertions(+), 119 deletions(-) diff --git a/custom_components/adaptive_lighting/manifest.json b/custom_components/adaptive_lighting/manifest.json index cb7ba6e1..33564f23 100644 --- a/custom_components/adaptive_lighting/manifest.json +++ b/custom_components/adaptive_lighting/manifest.json @@ -8,5 +8,5 @@ "iot_class": "calculated", "issue_tracker": "https://github.com/basnijholt/adaptive-lighting/issues", "requirements": [], - "version": "1.9.1" + "version": "1.10.0" } diff --git a/custom_components/adaptive_lighting/switch.py b/custom_components/adaptive_lighting/switch.py index 031396fe..52821774 100644 --- a/custom_components/adaptive_lighting/switch.py +++ b/custom_components/adaptive_lighting/switch.py @@ -4,7 +4,7 @@ from __future__ import annotations import asyncio import base64 import bisect -from collections import defaultdict +from collections.abc import Callable, Coroutine from copy import deepcopy from dataclasses import dataclass import datetime @@ -802,10 +802,19 @@ class AdaptiveSwitch(SwitchEntity, RestoreEntity): self._only_once = data[CONF_ONLY_ONCE] self._prefer_rgb_color = data[CONF_PREFER_RGB_COLOR] self._separate_turn_on_commands = data[CONF_SEPARATE_TURN_ON_COMMANDS] - self._take_over_control = data[CONF_TAKE_OVER_CONTROL] self._transition = data[CONF_TRANSITION] self._adapt_delay = data[CONF_ADAPT_DELAY] self._send_split_delay = data[CONF_SEND_SPLIT_DELAY] + self._take_over_control = data[CONF_TAKE_OVER_CONTROL] + self._detect_non_ha_changes = data[CONF_DETECT_NON_HA_CHANGES] + if not data[CONF_TAKE_OVER_CONTROL] and data[CONF_DETECT_NON_HA_CHANGES]: + _LOGGER.warning( + "%s: Config mismatch: 'detect_non_ha_changes: true' " + "requires 'take_over_control' to be enabled. Adjusting config " + "and continuing setup with `take_over_control: true`.", + self._name, + ) + self._take_over_control = True self._auto_reset_manual_control_time = data[CONF_AUTORESET_CONTROL] self._expand_light_groups() # updates manual control timers _loc = get_astral_location(self.hass) @@ -1128,11 +1137,23 @@ class AdaptiveSwitch(SwitchEntity, RestoreEntity): ) ) self.async_write_ha_state() + if lights is None: lights = self._lights - if (self._only_once and not force) or not lights: + + if not force and self._only_once: return - await self._adapt_lights(lights, transition, force, context) + + filtered_lights = [] + for light in lights: + # Don't adapt lights that haven't finished prior transitions. + if force or not self.turn_on_off_listener.transition_timers.get(light): + filtered_lights.append(light) + + if not filtered_lights: + return + + await self._adapt_lights(filtered_lights, transition, force, context) async def _adapt_lights( self, @@ -1532,8 +1553,6 @@ class TurnOnOffListener: self.sleep_tasks: dict[str, asyncio.Task] = {} # Tracks which lights are manually controlled self.manual_control: dict[str, bool] = {} - # Counts the number of times (in a row) a light had a changed state. - self.cnt_significant_changes: dict[str, int] = defaultdict(int) # Track 'state_changed' events of self.lights resulting from this integration self.last_state_change: dict[str, list[State]] = {} # Track last 'service_data' to 'light.turn_on' resulting from this integration @@ -1543,9 +1562,8 @@ class TurnOnOffListener: self.auto_reset_manual_control_timers: dict[str, _AsyncSingleShotTimer] = {} self.auto_reset_manual_control_times: dict[str, float] = {} - # When a state is different `max_cnt_significant_changes` times in a row, - # mark it as manually_controlled. - self.max_cnt_significant_changes = 2 + # Track light transitions + self.transition_timers: dict[str, _AsyncSingleShotTimer] = {} self.remove_listener = self.hass.bus.async_listen( EVENT_CALL_SERVICE, self.turn_on_off_event_listener @@ -1554,6 +1572,56 @@ class TurnOnOffListener: EVENT_STATE_CHANGED, self.state_changed_event_listener ) + def _handle_timer( + self, + light: str, + timers_dict: dict[str, _AsyncSingleShotTimer], + delay: float | None, + reset_coroutine: Callable[[], Coroutine[Any, Any, None]], + ) -> None: + timer = timers_dict.get(light) + if timer is not None: + if delay is None: # Timer object exists, but should not anymore + timer.cancel() + timers_dict.pop(light) + else: # Timer object already exists, just update the delay and restart it + timer.delay = delay + timer.start() + elif delay is not None: # Timer object does not exist, create it + timer = _AsyncSingleShotTimer(delay, reset_coroutine) + timers_dict[light] = timer + timer.start() + + def start_transition_timer(self, light: str) -> None: + """Mark a light as manually controlled.""" + _LOGGER.debug("Start transition timer for %s", light) + last_service_data = self.last_service_data + if ( + not last_service_data + or light not in last_service_data + or ATTR_TRANSITION not in last_service_data[light] + ): + return + + delay = last_service_data[light][ATTR_TRANSITION] + + async def reset(): + _LOGGER.debug( + "Transition finished for light %s", + light, + ) + switches = _get_switches_with_lights(self.hass, [light]) + for switch in switches: + if not switch.is_on: + continue + await switch._update_attrs_and_maybe_adapt_lights( + [light], + force=False, + context=switch.create_context("transit"), + ) + + self._handle_timer(light, self.transition_timers, delay, reset) + def set_auto_reset_manual_control_times(self, lights: list[str], time: float): """Set the time after which the lights are automatically reset.""" if time == 0: @@ -1576,40 +1644,28 @@ class TurnOnOffListener: _LOGGER.debug("Marking '%s' as manually controlled.", light) self.manual_control[light] = True delay = self.auto_reset_manual_control_times.get(light) - timer = self.auto_reset_manual_control_timers.get(light) - if timer is not None: - if delay is None: # Timer object exists, but should not anymore - timer.cancel() - self.auto_reset_manual_control_timers.pop(light) - else: # Timer object already exists, just update the delay and restart it - timer.delay = delay - timer.start() - elif delay is not None: # Timer object does not exist, create it - async def reset(): - self.reset(light) - switches = _get_switches_with_lights(self.hass, [light]) - for switch in switches: - if not switch.is_on: - continue - # pylint: disable=protected-access - await switch._update_attrs_and_maybe_adapt_lights( - [light], - transition=switch._initial_transition, - force=True, - context=switch.create_context("autoreset"), - ) - _LOGGER.debug( - "Auto resetting 'manual_control' status of '%s' because" - " it was not manually controlled for %s seconds.", - light, - delay, + async def reset(): + self.reset(light) + switches = _get_switches_with_lights(self.hass, [light]) + for switch in switches: + if not switch.is_on: + continue + await switch._update_attrs_and_maybe_adapt_lights( + [light], + transition=switch._initial_transition, + force=True, + context=switch.create_context("autoreset"), ) - assert not self.manual_control[light] + _LOGGER.debug( + "Auto resetting 'manual_control' status of '%s' because" + " it was not manually controlled for %s seconds.", + light, + delay, + ) + assert not self.manual_control[light] - timer = _AsyncSingleShotTimer(delay, reset) - self.auto_reset_manual_control_timers[light] = timer - timer.start() + self._handle_timer(light, self.auto_reset_manual_control_timers, delay, reset) def reset(self, *lights, reset_manual_control=True) -> None: """Reset the 'manual_control' status of the lights.""" @@ -1621,7 +1677,6 @@ class TurnOnOffListener: timer.cancel() self.last_state_change.pop(light, None) self.last_service_data.pop(light, None) - self.cnt_significant_changes[light] = 0 async def turn_on_off_event_listener(self, event: Event) -> None: """Track 'light.turn_off' and 'light.turn_on' service calls.""" @@ -1700,11 +1755,7 @@ class TurnOnOffListener: new_state.context.id, ) - if ( - new_state is not None - and new_state.state == STATE_ON - and is_our_context(new_state.context) - ): + if new_state is not None and new_state.state == STATE_ON: # It is possible to have multiple state change events with the same context. # This can happen because a `turn_on.light(brightness_pct=100, transition=30)` # event leads to an instant state change of @@ -1717,21 +1768,29 @@ class TurnOnOffListener: # incorrect 'min_kelvin' and 'max_kelvin', which happens e.g., for # Philips Hue White GU10 Bluetooth lights). old_state: list[State] | None = self.last_state_change.get(entity_id) - if ( - old_state is not None - and old_state[0].context.id == new_state.context.id - ): - # If there is already a state change event from this event (with this - # context) then append it to the already existing list. - _LOGGER.debug( - "State change event of '%s' is already in 'self.last_state_change' (%s)" - " adding this state also", - entity_id, - new_state.context.id, - ) + if is_our_context(new_state.context): + if ( + old_state is not None + and old_state[0].context.id == new_state.context.id + ): + _LOGGER.debug( + "TurnOnOffListener: State change event of '%s' is already" + " in 'self.last_state_change' (%s)" + " adding this state also", + entity_id, + new_state.context.id, + ) + self.last_state_change[entity_id].append(new_state) + else: + _LOGGER.debug( + "TurnOnOffListener: New adapt '%s' found for %s", + new_state, + entity_id, + ) + self.last_state_change[entity_id] = [new_state] + self.start_transition_timer(entity_id) + elif old_state is not None: self.last_state_change[entity_id].append(new_state) - else: - self.last_state_change[entity_id] = [new_state] def is_manually_controlled( self, @@ -1786,64 +1845,58 @@ class TurnOnOffListener: detected, we mark the light as 'manually controlled' until the light or switch is turned 'off' and 'on' again. """ - if light not in self.last_state_change: - return False - old_states: list[State] = self.last_state_change[light] - await self.hass.helpers.entity_component.async_update_entity(light) - new_state = self.hass.states.get(light) + last_service_data = self.last_service_data.get(light) + if last_service_data is None: + return compare_to = functools.partial( _attributes_have_changed, light=light, - new_attributes=new_state.attributes, adapt_brightness=adapt_brightness, adapt_color=adapt_color, context=context, ) - for index, old_state in enumerate(old_states): - changed = compare_to(old_attributes=old_state.attributes) - if not changed: - _LOGGER.debug( - "State of '%s' didn't change wrt change event nr. %s (context.id=%s)", - light, - index, - context.id, - ) - break - - last_service_data = self.last_service_data.get(light) - if changed and last_service_data is not None: - # It can happen that the state change events that are associated - # with the last 'light.turn_on' call by this integration were not - # final states. Possibly a later EVENT_STATE_CHANGED happened, where - # the correct target brightness/color was reached. - changed = compare_to(old_attributes=last_service_data) - if not changed: + # Update state and check for a manual change not done in HA. + # Ensure HASS is correctly updating your light's state with + # light.turn_on calls if any problems arise. This + # can happen e.g. using zigbee2mqtt with 'report: false' in device settings. + if switch._detect_non_ha_changes: + _LOGGER.debug( + "%s: 'detect_non_ha_changes: true', calling update_entity(%s)" + " and check if it's last adapt succeeded.", + switch._name, + light, + ) + # This update_entity probably isn't necessary now that we're checking + # if transitions finished from our last adapt. + await self.hass.helpers.entity_component.async_update_entity(light) + refreshed_state = self.hass.states.get(light) + _LOGGER.debug( + "%s: Current state of %s: %s", + switch._name, + light, + refreshed_state, + ) + changed = compare_to( + old_attributes=last_service_data, + new_attributes=refreshed_state.attributes, + ) + if changed: _LOGGER.debug( "State of '%s' didn't change wrt 'last_service_data' (context.id=%s)", light, context.id, ) - - n_changes = self.cnt_significant_changes[light] - if changed: - self.cnt_significant_changes[light] += 1 - if n_changes >= self.max_cnt_significant_changes: - # Only mark a light as significantly changing, if changed==True - # N times in a row. We do this because sometimes a state changes - # happens only *after* a new update interval has already started. self.mark_as_manual_control(light) _fire_manual_control_event(switch, light, context, is_async=False) - else: - if n_changes > 1: - _LOGGER.debug( - "State of '%s' had 'cnt_significant_changes=%s' but the state" - " changed to the expected settings now", - light, - n_changes, - ) - self.cnt_significant_changes[light] = 0 - - return changed + return True + _LOGGER.debug( + "%s: Light '%s' correctly matches our last adapt's service data, continuing..." + " context.id=%s.", + switch._name, + light, + context.id, + ) + return False async def maybe_cancel_adjusting( self, entity_id: str, off_to_on_event: Event, on_to_off_event: Event | None diff --git a/tests/test_switch.py b/tests/test_switch.py index 212cea82..9e88b332 100644 --- a/tests/test_switch.py +++ b/tests/test_switch.py @@ -56,6 +56,7 @@ from homeassistant.config_entries import ConfigEntryState from homeassistant.const import ( ATTR_AREA_ID, ATTR_ENTITY_ID, + ATTR_SUPPORTED_FEATURES, CONF_LIGHTS, CONF_NAME, CONF_PLATFORM, @@ -769,25 +770,63 @@ async def test_significant_change(hass): ) await hass.async_block_till_done() - switch, (bed_light_instance, *_) = await setup_lights_and_switch(hass) + async def set_brightness(val: int): + hass.states.async_set( + ENTITY_LIGHT, "on", {ATTR_BRIGHTNESS: val, ATTR_SUPPORTED_FEATURES: 1} + ) + await hass.async_block_till_done() + + switch, _ = await setup_lights_and_switch(hass) + _LOGGER.debug("Test detect_non_ha_changes:") + switch._take_over_control = True + assert switch._take_over_control + switch._detect_non_ha_changes = True + assert switch._detect_non_ha_changes + + # build last service data + await update(force=False) + + # force=True should not reset manual control. + await turn_light(True, brightness=40) + await turn_light(True, brightness=20) + await update(force=False) + assert switch.turn_on_off_listener.manual_control[ENTITY_LIGHT] + await update(force=True) + assert switch.turn_on_off_listener.manual_control[ENTITY_LIGHT] + + # turn light off then on should reset manual control. + await turn_light(False) await turn_light(True) - await update(force=True) # removes manual control assert not switch.turn_on_off_listener.manual_control[ENTITY_LIGHT] - # Change brightness by setting state (not using 'light.turn_on') - attributes = hass.states.get(ENTITY_LIGHT).attributes - new_attributes = attributes.copy() - new_brightness = (attributes[ATTR_BRIGHTNESS] + 100) % 255 - new_attributes[ATTR_BRIGHTNESS] = new_brightness - bed_light_instance._brightness = new_brightness + # Assert last_service_data got filled from update() + await update(force=True) assert switch.turn_on_off_listener.last_service_data.get(ENTITY_LIGHT) is not None - for _ in range(switch.turn_on_off_listener.max_cnt_significant_changes): + + # Simulate a transition to 255 where the update() is already using brightness 255. + await set_brightness(240) + await set_brightness(244) + await set_brightness(247) + await set_brightness(250) + + # last_state_change should have our state changes. + # Change brightness by async_set (not using 'light.turn_on') + new_brightness = 50 + await set_brightness(new_brightness) + _LOGGER.debug("Test: Brightness set to %s", new_brightness) + + # mock homeassistant.core.HomeAssistant.helpers.entity_component.async_update_entity + # Otherwise what happens is update_entity() refreshes the state to the last call of + # light.turn_on(). This is because we are not using hass.states.async_set() to + # set the brightness of the light. We mock `async_update_ha_state` because + # `async_update_entity` calls it. + with patch("homeassistant.helpers.entity.Entity.async_update_ha_state"): + # On next update ENTITY_LIGHT should be marked as manually controlled await update(force=False) - assert not switch.turn_on_off_listener.manual_control[ENTITY_LIGHT] - # On next update the light should be marked as manually controlled - await update(force=False) - # TODO: the state should be `bool(manual_control) is True` - assert not switch.turn_on_off_listener.manual_control[ENTITY_LIGHT] + assert ( + switch.turn_on_off_listener.last_service_data.get(ENTITY_LIGHT) is not None + ) + assert switch.turn_on_off_listener.manual_control[ENTITY_LIGHT] def test_color_difference_redmean(): From 981287edb96d04e012c5ab689bc15bb981135b89 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 3 Apr 2023 17:30:07 -0700 Subject: [PATCH 12/12] [pre-commit.ci] pre-commit autoupdate (#531) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit updates: - [github.com/psf/black: 23.1.0 → 23.3.0](https://github.com/psf/black/compare/23.1.0...23.3.0) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 2f8938a7..462e0dc2 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -12,7 +12,7 @@ repos: hooks: - id: flake8 - repo: https://github.com/psf/black - rev: 23.1.0 + rev: 23.3.0 hooks: - id: black - repo: https://github.com/asottile/pyupgrade