From 8f78233e11d83b70eadde2cf95a48c12dfcdc2e3 Mon Sep 17 00:00:00 2001 From: Marijn Eken Date: Sun, 6 Sep 2026 10:43:37 +0200 Subject: [PATCH] docs: clarify that UI setup needs no YAML entry (#1031) * Fixed outdated info in README.md The README says to always add an adaptive_lighting: entry in the YAML, where this seems to be no longer needed (or even preferred). * docs: clarify YAML is optional for UI setup --------- Co-authored-by: Bas Nijholt Co-authored-by: Bas Nijholt --- README.md | 2 +- docs/configuration.md | 10 ++-------- docs/getting-started.md | 41 +++++++++++++---------------------------- docs/index.md | 15 ++------------- 4 files changed, 18 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index d3e3ed2c..72a77484 100644 --- a/README.md +++ b/README.md @@ -107,7 +107,7 @@ adaptive_lighting: lights: - light.living_room_lights ``` -Note: If you plan to strictly use the UI, the `adaptive_lighting:` entry must still be added to the YAML. +If you configure Adaptive Lighting through the UI, no `adaptive_lighting:` entry is needed in `configuration.yaml`. Instances configured through YAML must be edited in YAML. Transform your home's atmosphere with Adaptive Lighting 🏠, and experience the benefits of intelligent, sun-synchronized lighting today! diff --git a/docs/configuration.md b/docs/configuration.md index 21c7028e..237a53ae 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -8,17 +8,11 @@ Adaptive Lighting supports configuration through both YAML and the Home Assistan ## Basic Configuration -The minimal configuration requires only adding the integration to your `configuration.yaml`: - -```yaml -adaptive_lighting: -``` - -You can then configure everything through the UI at **Settings** → **Devices & Services** → **Adaptive Lighting** → **Configure**. +The simplest setup uses the Home Assistant UI. Go to **Settings** → **Devices & Services** → **Add Integration** → **Adaptive Lighting**. No `adaptive_lighting:` entry is needed in `configuration.yaml`. ## YAML Configuration -For YAML configuration, you can specify lights and options directly: +Alternatively, you can specify lights and options in `configuration.yaml`: ```yaml adaptive_lighting: diff --git a/docs/getting-started.md b/docs/getting-started.md index 68c253eb..48826e84 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -34,40 +34,23 @@ Or use this button to open HACS directly: ## Configuration -### Step 1: Add to configuration.yaml - -Add the following to your `configuration.yaml`: - -```yaml -adaptive_lighting: -``` - -> [!NOTE] -> This entry is required even if you plan to configure everything through the UI. - -### Step 2: Restart Home Assistant - -Restart Home Assistant for the changes to take effect. - -### Step 3: Add the Integration - -1. Go to **Settings** → **Devices & Services** -2. Click **+ Add Integration** -3. Search for "Adaptive Lighting" -4. Follow the setup wizard to select your lights - -### Step 4: Configure Your Lights - -You can configure Adaptive Lighting in two ways: +Choose one of two configuration methods: === "Via UI" 1. Go to **Settings** → **Devices & Services** - 2. Find Adaptive Lighting and click **Configure** - 3. Adjust settings as needed + 2. Click **+ Add Integration** + 3. Search for "Adaptive Lighting" + 4. Follow the setup wizard to name your Adaptive Lighting instance + 5. Find Adaptive Lighting and click **Configure** + 6. Select your lights and adjust the settings + + No `adaptive_lighting:` entry is needed in `configuration.yaml`. === "Via YAML" + Instances configured through YAML must be edited in YAML. + ```yaml adaptive_lighting: - name: "Living Room" @@ -80,7 +63,9 @@ You can configure Adaptive Lighting in two ways: max_color_temp: 5500 ``` -## Basic Configuration Example + Restart Home Assistant after changing the YAML configuration. + +## Basic YAML Configuration Example Here's a simple configuration to get you started: diff --git a/docs/index.md b/docs/index.md index bc3acebe..f01cbfa2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -46,19 +46,8 @@ Adaptive Lighting provides four switches (using "living_room" as an example comp ## Quick Start 1. **Install via HACS**: Search for "Adaptive Lighting" in the [Home Assistant Community Store](https://hacs.xyz/) -2. **Add to configuration**: Add `adaptive_lighting:` to your `configuration.yaml` -3. **Configure**: Go to **Settings** → **Devices & Services** → **Add Integration** → **Adaptive Lighting** -4. **Select your lights**: Choose which lights to control and enjoy automatic adaptation! - -```yaml -# Minimal configuration.yaml entry -adaptive_lighting: - lights: - - light.living_room -``` - -> [!TIP] -> **Using the UI exclusively?** Even if you plan to configure everything through the UI, the `adaptive_lighting:` entry must still be present in your `configuration.yaml`. +2. **Add the integration**: Go to **Settings** → **Devices & Services** → **Add Integration** → **Adaptive Lighting**, then name your instance +3. **Configure**: Open Adaptive Lighting, click **Configure**, select your lights, and adjust the settings. No YAML entry is needed. [Get Started →](getting-started.md){ .md-button .md-button--primary } [View All Options →](configuration.md){ .md-button }