From 29e54185e3218d0692cd7a3f3be7607f411cc71c Mon Sep 17 00:00:00 2001 From: Bas Nijholt Date: Fri, 12 May 2023 11:36:24 -0700 Subject: [PATCH] Add "See also" to README (#591) * Add "See also" section * Add date * chore(docs): update TOC * Add YouTube videos * Add components.cloud * verbose loggin --------- Co-authored-by: basnijholt --- .github/workflows/pytest.yaml | 3 +- README.md | 56 +++++++++++++++++++---------------- test_dependencies.py | 1 + 3 files changed, 34 insertions(+), 26 deletions(-) diff --git a/.github/workflows/pytest.yaml b/.github/workflows/pytest.yaml index 394acef3..4973849f 100644 --- a/.github/workflows/pytest.yaml +++ b/.github/workflows/pytest.yaml @@ -14,7 +14,7 @@ jobs: fail-fast: false matrix: python-version: ["3.10"] - core-version: ["2023.2.5", "2023.3.6", "2023.4.6", "dev"] + core-version: ["2023.2.5", "2023.3.6", "2023.4.6", "2023.5.2", "dev"] steps: - name: Check out code from GitHub uses: actions/checkout@v3 @@ -54,6 +54,7 @@ jobs: run: | cd core python3 -X dev -m pytest \ + -vvv \ -qq \ --timeout=9 \ --durations=10 \ diff --git a/README.md b/README.md index 9ba7cc03..d1895b91 100644 --- a/README.md +++ b/README.md @@ -41,27 +41,28 @@ The `adaptive_lighting.manual_control` event is fired when a light is marked as - - [:gear: Configuration](#gear-configuration) - - [:memo: Options](#memo-options) - - [:hammer_and_wrench: Services](#hammer_and_wrench-services) - - [`adaptive_lighting.apply`](#adaptive_lightingapply) - - [`adaptive_lighting.set_manual_control`](#adaptive_lightingset_manual_control) - - [`adaptive_lighting.change_switch_settings`](#adaptive_lightingchange_switch_settings) - - [:robot: Automation examples](#robot-automation-examples) +- [:gear: Configuration](#gear-configuration) + - [:memo: Options](#memo-options) + - [:hammer_and_wrench: Services](#hammer_and_wrench-services) + - [`adaptive_lighting.apply`](#adaptive_lightingapply) + - [`adaptive_lighting.set_manual_control`](#adaptive_lightingset_manual_control) + - [`adaptive_lighting.change_switch_settings`](#adaptive_lightingchange_switch_settings) +- [:robot: Automation examples](#robot-automation-examples) - [Additional Information](#additional-information) - [:sos: Troubleshooting](#sos-troubleshooting) - [:exclamation: Common Problems & Solutions](#exclamation-common-problems--solutions) - [:bulb: Lights Not Responding or Turning On by Themselves](#bulb-lights-not-responding-or-turning-on-by-themselves) - - [:signal_strength: WiFi Networks](#signal_strength-wifi-networks) - - [:spider_web: Zigbee, Z-Wave, and Other Mesh Networks](#spider_web-zigbee-z-wave-and-other-mesh-networks) + - [:signal_strength: WiFi Networks](#signal_strength-wifi-networks) + - [:spider_web: Zigbee, Z-Wave, and Other Mesh Networks](#spider_web-zigbee-z-wave-and-other-mesh-networks) - [:rainbow: Light Colors Not Matching](#rainbow-light-colors-not-matching) - [:bulb: Bulb-Specific Issues](#bulb-bulb-specific-issues) - - [:bar_chart: Graphs!](#bar_chart-graphs) - - [:sunny: Sun Position](#sunny-sun-position) - - [:thermometer: Color Temperature](#thermometer-color-temperature) - - [:high_brightness: Brightness](#high_brightness-brightness) - - [While using `transition_until_sleep: true`](#while-using-transition_until_sleep-true) - - [:busts_in_silhouette: Contributors](#busts_in_silhouette-contributors) +- [:bar_chart: Graphs!](#bar_chart-graphs) + - [:sunny: Sun Position](#sunny-sun-position) + - [:thermometer: Color Temperature](#thermometer-color-temperature) + - [:high_brightness: Brightness](#high_brightness-brightness) + - [While using `transition_until_sleep: true`](#while-using-transition_until_sleep-true) +- [:eyes: See also](#eyes-see-also) +- [:busts_in_silhouette: Contributors](#busts_in_silhouette-contributors) @@ -310,13 +311,13 @@ iphone_carly_wakeup: -# Additional Information +## Additional Information For more details on adding the integration and setting options, refer to the [documentation of the PR](https://deploy-preview-14877--home-assistant-docs.netlify.app/integrations/adaptive_lighting/) and [this video tutorial on Reddit](https://www.reddit.com/r/homeassistant/comments/jabhso/ha_has_it_before_apple_has_even_finished_it_i/). Adaptive Lighting was initially inspired by @claytonjn's [hass-circadian\_lighting](https://github.com/claytonjn/hass-circadian_lighting), but has since been entirely rewritten and expanded with new features. -# :sos: Troubleshooting +## :sos: Troubleshooting Encountering issues? Enable debug logging in your `configuration.yaml`: @@ -329,9 +330,9 @@ logger: After the issue occurs, create a new issue report with the log (`/config/home-assistant.log`). -## :exclamation: Common Problems & Solutions +### :exclamation: Common Problems & Solutions -### :bulb: Lights Not Responding or Turning On by Themselves +#### :bulb: Lights Not Responding or Turning On by Themselves Adaptive Lighting sends more commands to lights than a typical human user would. If your light control network is unhealthy, you may experience: @@ -353,7 +354,7 @@ For most Zigbee networks, **using groups is essential for optimal performance**. As a rule of thumb, if you always control lights together (e.g., bulbs in a ceiling fixture), they should be in a Zigbee group. Expose only the group (not individual bulbs) in Home Assistant Dashboards and external systems like Google Home or Apple HomeKit. -### :rainbow: Light Colors Not Matching +#### :rainbow: Light Colors Not Matching Bulbs from different manufacturers or models may have varying color temperature specifications. For instance, if you have two Adaptive Lighting configurations—one with only Philips Hue White Ambiance bulbs and another with a mix of Philips Hue White Ambiance and Sengled bulbs—the Philips Hue bulbs may appear to have different color temperatures despite having identical settings. @@ -362,7 +363,7 @@ To resolve this: 1. Include only bulbs of the same make and model in a single Adaptive Lighting configuration. 2. Rearrange bulbs so that different color temperatures are not visible simultaneously. -### :bulb: Bulb-Specific Issues +#### :bulb: Bulb-Specific Issues Certain bulbs may have issues with long light transition commands: @@ -372,18 +373,23 @@ Certain bulbs may have issues with long light transition commands: ## :bar_chart: Graphs! These graphs were generated using the values calculated by the Adaptive Lighting sensor/switch(es). -#### :sunny: Sun Position +### :sunny: Sun Position ![cl_percent|690x131](https://community-home-assistant-assets.s3.dualstack.us-west-2.amazonaws.com/original/3X/6/5/657ff98beb65a94598edeb4bdfd939095db1a22c.PNG) -#### :thermometer: Color Temperature +### :thermometer: Color Temperature ![cl_color_temp|690x129](https://community-home-assistant-assets.s3.dualstack.us-west-2.amazonaws.com/original/3X/5/9/59e84263cbecd8e428cb08777a0413672c48dfcd.PNG) -#### :high_brightness: Brightness +### :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 `transition_until_sleep: true` +### While using `transition_until_sleep: true` ![image](https://user-images.githubusercontent.com/2219836/228949675-f9699624-8abc-466c-bb04-250ce0f495b8.png) +## :eyes: See also + +- [*Sleep better with Adaptive Lighting in Home Assistant*](https://wartner.io/sleep-better-with-adaptive-lightning-in-home-assistant/) by Florian Wartner on 2023-02-23 (blog post 📜) +- [*Automatic smart light brightness and color based on the sun*](https://www.youtube.com/watch?v=Rg3zI1Oyk3c) by Home Automation Guy on 2022-08-31 (YouTube video 📺) +- [*Adaptive Lighting Blew My Mind in Home Assistant - How to set it up*](https://www.youtube.com/watch?v=c1cnccmgl3k) by Smart Home Junkie on 2022-06-26 (YouTube video 📺) ## :busts_in_silhouette: Contributors diff --git a/test_dependencies.py b/test_dependencies.py index a4dc0e89..58b4718f 100644 --- a/test_dependencies.py +++ b/test_dependencies.py @@ -25,6 +25,7 @@ required = [ "components.http", "components.stream", "components.conversation", + "components.cloud", ] to_install = [] for r in required: