mirror of https://github.com/basnijholt/adaptive-lighting.git synced 2026-09-16 00:34:04 +02:00

Bas Nijholt f5877076ce Add documentation site with Zensical framework

Create comprehensive documentation site for adaptive-lighting.nijho.lt:

- Add zensical.toml configuration with Material theme (amber/orange)
- Create docs_gen.py module for extracting README sections via markers
- Add section markers to README.md for content reuse
- Create documentation pages:
  - index.md: Home with features overview
  - getting-started.md: Installation and quick setup
  - configuration.md: Auto-generated config options table
  - services.md: Auto-generated service documentation
  - automation-examples.md: Real-world automation recipes
  - troubleshooting.md: Common issues and solutions
  - see-also.md: External resources and links
  - advanced/brightness-modes.md: Brightness mode deep dive
  - advanced/manual-control.md: Manual control system docs
  - advanced/sleep-mode.md: Sleep mode configuration
- Add GitHub Actions workflow for building and deploying to Pages
- Add custom CSS with sun-themed styling
- Add CNAME for custom domain

Uses markdown-code-runner to auto-generate content from code schemas
and extract README sections for single-source documentation.

2026-01-12 09:52:16 -08:00

3.2 KiB

Raw Blame History

icon
lucide/rocket

Getting Started

This guide will help you install and configure Adaptive Lighting for the first time.

Prerequisites

Home Assistant 2024.12.0 or newer
HACS (Home Assistant Community Store) installed

Installation

Via HACS (Recommended)

Open HACS in your Home Assistant instance
Click on Integrations
Click the + Explore & Download Repositories button
Search for "Adaptive Lighting"
Click Download
Restart Home Assistant

Or use this button to open HACS directly:

Manual Installation

Download the latest release from GitHub
Extract the adaptive_lighting folder to your config/custom_components/ directory
Restart Home Assistant

Configuration

Step 1: Add to configuration.yaml

Add the following to your configuration.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

Go to Settings → Devices & Services
Click + Add Integration
Search for "Adaptive Lighting"
Follow the setup wizard to select your lights

Step 4: Configure Your Lights

You can configure Adaptive Lighting in two ways:

=== "Via UI"

1. Go to **Settings** → **Devices & Services**
2. Find Adaptive Lighting and click **Configure**
3. Adjust settings as needed

=== "Via YAML"

```yaml
adaptive_lighting:
  - name: "Living Room"
    lights:
      - light.living_room_ceiling
      - light.living_room_lamp
    min_brightness: 20
    max_brightness: 100
    min_color_temp: 2200
    max_color_temp: 5500
```

Basic Configuration Example

Here's a simple configuration to get you started:

adaptive_lighting:
  - name: "Main Lights"
    lights:
      - light.living_room
      - light.bedroom
      - light.kitchen
    transition: 30
    min_brightness: 10
    max_brightness: 100
    min_color_temp: 2000
    max_color_temp: 5500

Verifying Installation

After configuration, you should see new switches in Home Assistant:

switch.adaptive_lighting_main_lights
switch.adaptive_lighting_sleep_mode_main_lights
switch.adaptive_lighting_adapt_brightness_main_lights
switch.adaptive_lighting_adapt_color_main_lights

Turn on switch.adaptive_lighting_main_lights to start adapting your lights!

Next Steps

Configuration Reference - Explore all available options
Services - Learn about service calls for automations
Automation Examples - See real-world automation recipes
Troubleshooting - Common issues and solutions

3.2 KiB Raw Blame History