Skip to content

Commit 29e5418

Browse files
authored
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 <[email protected]>
1 parent 9caf645 commit 29e5418

File tree

3 files changed

+34
-26
lines changed

3 files changed

+34
-26
lines changed

.github/workflows/pytest.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ jobs:
1414
fail-fast: false
1515
matrix:
1616
python-version: ["3.10"]
17-
core-version: ["2023.2.5", "2023.3.6", "2023.4.6", "dev"]
17+
core-version: ["2023.2.5", "2023.3.6", "2023.4.6", "2023.5.2", "dev"]
1818
steps:
1919
- name: Check out code from GitHub
2020
uses: actions/checkout@v3
@@ -54,6 +54,7 @@ jobs:
5454
run: |
5555
cd core
5656
python3 -X dev -m pytest \
57+
-vvv \
5758
-qq \
5859
--timeout=9 \
5960
--durations=10 \

README.md

Lines changed: 31 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -41,27 +41,28 @@ The `adaptive_lighting.manual_control` event is fired when a light is marked as
4141
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
4242
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
4343

44-
- [:gear: Configuration](#gear-configuration)
45-
- [:memo: Options](#memo-options)
46-
- [:hammer_and_wrench: Services](#hammer_and_wrench-services)
47-
- [`adaptive_lighting.apply`](#adaptive_lightingapply)
48-
- [`adaptive_lighting.set_manual_control`](#adaptive_lightingset_manual_control)
49-
- [`adaptive_lighting.change_switch_settings`](#adaptive_lightingchange_switch_settings)
50-
- [:robot: Automation examples](#robot-automation-examples)
44+
- [:gear: Configuration](#gear-configuration)
45+
- [:memo: Options](#memo-options)
46+
- [:hammer_and_wrench: Services](#hammer_and_wrench-services)
47+
- [`adaptive_lighting.apply`](#adaptive_lightingapply)
48+
- [`adaptive_lighting.set_manual_control`](#adaptive_lightingset_manual_control)
49+
- [`adaptive_lighting.change_switch_settings`](#adaptive_lightingchange_switch_settings)
50+
- [:robot: Automation examples](#robot-automation-examples)
5151
- [Additional Information](#additional-information)
5252
- [:sos: Troubleshooting](#sos-troubleshooting)
5353
- [:exclamation: Common Problems & Solutions](#exclamation-common-problems--solutions)
5454
- [:bulb: Lights Not Responding or Turning On by Themselves](#bulb-lights-not-responding-or-turning-on-by-themselves)
55-
- [:signal_strength: WiFi Networks](#signal_strength-wifi-networks)
56-
- [:spider_web: Zigbee, Z-Wave, and Other Mesh Networks](#spider_web-zigbee-z-wave-and-other-mesh-networks)
55+
- [:signal_strength: WiFi Networks](#signal_strength-wifi-networks)
56+
- [:spider_web: Zigbee, Z-Wave, and Other Mesh Networks](#spider_web-zigbee-z-wave-and-other-mesh-networks)
5757
- [:rainbow: Light Colors Not Matching](#rainbow-light-colors-not-matching)
5858
- [:bulb: Bulb-Specific Issues](#bulb-bulb-specific-issues)
59-
- [:bar_chart: Graphs!](#bar_chart-graphs)
60-
- [:sunny: Sun Position](#sunny-sun-position)
61-
- [:thermometer: Color Temperature](#thermometer-color-temperature)
62-
- [:high_brightness: Brightness](#high_brightness-brightness)
63-
- [While using `transition_until_sleep: true`](#while-using-transition_until_sleep-true)
64-
- [:busts_in_silhouette: Contributors](#busts_in_silhouette-contributors)
59+
- [:bar_chart: Graphs!](#bar_chart-graphs)
60+
- [:sunny: Sun Position](#sunny-sun-position)
61+
- [:thermometer: Color Temperature](#thermometer-color-temperature)
62+
- [:high_brightness: Brightness](#high_brightness-brightness)
63+
- [While using `transition_until_sleep: true`](#while-using-transition_until_sleep-true)
64+
- [:eyes: See also](#eyes-see-also)
65+
- [:busts_in_silhouette: Contributors](#busts_in_silhouette-contributors)
6566

6667
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
6768

@@ -310,13 +311,13 @@ iphone_carly_wakeup:
310311

311312
</details>
312313

313-
# Additional Information
314+
## Additional Information
314315

315316
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/).
316317

317318
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.
318319

319-
# :sos: Troubleshooting
320+
## :sos: Troubleshooting
320321

321322
Encountering issues? Enable debug logging in your `configuration.yaml`:
322323

@@ -329,9 +330,9 @@ logger:
329330

330331
After the issue occurs, create a new issue report with the log (`/config/home-assistant.log`).
331332

332-
## :exclamation: Common Problems & Solutions
333+
### :exclamation: Common Problems & Solutions
333334

334-
### :bulb: Lights Not Responding or Turning On by Themselves
335+
#### :bulb: Lights Not Responding or Turning On by Themselves
335336

336337
Adaptive Lighting sends more commands to lights than a typical human user would. If your light control network is unhealthy, you may experience:
337338

@@ -353,7 +354,7 @@ For most Zigbee networks, **using groups is essential for optimal performance**.
353354

354355
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.
355356

356-
### :rainbow: Light Colors Not Matching
357+
#### :rainbow: Light Colors Not Matching
357358

358359
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.
359360

@@ -362,7 +363,7 @@ To resolve this:
362363
1. Include only bulbs of the same make and model in a single Adaptive Lighting configuration.
363364
2. Rearrange bulbs so that different color temperatures are not visible simultaneously.
364365

365-
### :bulb: Bulb-Specific Issues
366+
#### :bulb: Bulb-Specific Issues
366367

367368
Certain bulbs may have issues with long light transition commands:
368369

@@ -372,18 +373,23 @@ Certain bulbs may have issues with long light transition commands:
372373
## :bar_chart: Graphs!
373374
These graphs were generated using the values calculated by the Adaptive Lighting sensor/switch(es).
374375

375-
#### :sunny: Sun Position
376+
### :sunny: Sun Position
376377
![cl_percent|690x131](https://community-home-assistant-assets.s3.dualstack.us-west-2.amazonaws.com/original/3X/6/5/657ff98beb65a94598edeb4bdfd939095db1a22c.PNG)
377378

378-
#### :thermometer: Color Temperature
379+
### :thermometer: Color Temperature
379380
![cl_color_temp|690x129](https://community-home-assistant-assets.s3.dualstack.us-west-2.amazonaws.com/original/3X/5/9/59e84263cbecd8e428cb08777a0413672c48dfcd.PNG)
380381

381-
#### :high_brightness: Brightness
382+
### :high_brightness: Brightness
382383
![cl_brightness|690x130](https://community-home-assistant-assets.s3.dualstack.us-west-2.amazonaws.com/original/3X/5/8/58ebd994b62a8b1abfb3497a5288d923ff4e2330.PNG)
383384

384-
#### While using `transition_until_sleep: true`
385+
### While using `transition_until_sleep: true`
385386
![image](https://user-images.githubusercontent.com/2219836/228949675-f9699624-8abc-466c-bb04-250ce0f495b8.png)
386387

388+
## :eyes: See also
389+
390+
- [*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 📜)
391+
- [*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 📺)
392+
- [*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 📺)
387393

388394
## :busts_in_silhouette: Contributors
389395

test_dependencies.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
"components.http",
2626
"components.stream",
2727
"components.conversation",
28+
"components.cloud",
2829
]
2930
to_install = []
3031
for r in required:

0 commit comments

Comments
 (0)