diff --git a/README.md b/README.md index b895c58..c6d7b48 100644 --- a/README.md +++ b/README.md @@ -14,14 +14,15 @@ This project is made up of two blueprints | **sunrise‑simulation** (script) | The “engine” that gradually lights up (or down) your bulbs | Uses a `repeat` loop to turn the selected lights on/off and slowly increase/decrease brightness over a configurable time span. The brightness and color curves can be configured to create more natural-looking sunrises. | | **sunrise‑alarm** (automation) | The “scheduler” that calls the simulation at a chosen time | Triggers the script at *Alarm Time – Offset* (e.g. 30 min before the clock). An `input_boolean` lets you switch the alarm on/off. | +> [!NOTE] > **Why two separate blueprints?** > The simulation can be reused in any scenario (e.g. a “morning routine” or a “sunset‑in‑30‑min” routine). The alarm automation is a thin wrapper that turns that simulation into a timed alarm. --- -## 2. Installation +## Installation -### 2.1 sunrise‑simulation +### sunrise‑simulation 1. **Import the sunrise script blueprint** @@ -40,7 +41,7 @@ This project is made up of two blueprints --- -### 2.2 sunrise‑alarm +### sunrise‑alarm 1. **Import the alarm automation blueprint** @@ -63,9 +64,9 @@ This project is made up of two blueprints --- -## 2.3 Configurable variables +## Configurable variables -### 3.1 sunrise‑simulation script variables +### sunrise‑simulation script variables | Variable | Type | Default | Description | |----------|------|---------|-------------| @@ -80,12 +81,12 @@ This project is made up of two blueprints | `curve_type` | string | `sigmoid` | `linear`, `parabolic` (quadratic), or `sigmoid` (an S-curve). As we don't perceive light intensity linearly, `sigmoid` or `parabolic` make for a more natural curve. -### 3.2 sunrise‑alarm automation variables +### sunrise‑alarm automation variables | Variable | Type | Default | Description | |----------|------|---------|-------------| | `alarm_time` | `input_datetime` | — | The time you want the alarm to ring (e.g. `07:00 AM`). | -| `offset_duration` | `time` | `"00:30:00"` | How many minutes after `alarm_time` the sunrise arc should start. A negative value would start **before** the alarm. | +| `offset_duration` | `time` | `"00:-30:00"` | How many minutes after `alarm_time` the sunrise arc should start. A negative value would start **before** the alarm. | | `alarm_enabled` | `input_boolean` | — | A switch that turns the whole alarm on/off. | | `sunrise_script` | `script` | — | The script instance created by the `sunrise‑simulation` blueprint (`script.sunrise-simulation`). | @@ -95,9 +96,12 @@ The automation uses the following logic: 2. If `Alarm Enabled` is `on`, it calls the sunrise script. 3. If `Alarm Enabled` is `off`, nothing happens. +> [!WARNING] +> You may not be able to set negative duration values via the user interface. If so, you'll need to edit the YAML directly. + --- -## 6. License +## License This repository is released under the **MIT License**. Feel free to fork, modify, or redistribute the blueprints as long as you keep the same license.