small update to documentation

This commit is contained in:
hiperman
2026-01-09 22:23:10 -05:00
parent 95779d9805
commit 35e4e6e2ac

View File

@@ -1,20 +1,15 @@
# HomeAssistant SunriseAlarm # HomeAssistant SunriseAlarm
**Turn your smart lights into a natural alarm clock** _Turn your smart lights into a natural alarm clock_
---
## Table of Contents This script turns any compatible light (or group of lights) into a softsunrise / sunset alarm.
1. [What it is & how it works](#what-it-is-&-how-it-works) It gradually ramps the brightness and the colour temperature over a userdefined period
2. [Twostep installation](#twostep-installation)
* 2.1[sunrisesimulation](#sunrisesimulation)
* 2.2[sunrisealarm](#sunrisealarm)
3. [Configurable variables](#configurable-variables)
* 3.1`sunrisesimulation` script variables
* 3.2`sunrisealarm` automation variables
4. [Customising the experience](#customising-the-experience)
5. [Troubleshooting & FAQ](#troubleshooting-&-faq)
6. [License](#license)
The script can also run in reverse mode, turning the light down to simulate a sunset.
This project is made up of two blueprints
- `sunrise-simulation.yaml`: Simulates a sunset/sunrise on a group of lights based on user-defined parameters
- `sunrise-alarm.yaml`: Thin wrapper that calls the simulation script when trigger occurs.
--- ---
## 1. What it is & how it works ## 1. What it is & how it works
@@ -64,7 +59,7 @@
2. **Create the automation** 2. **Create the automation**
* Pick an `input_datetime` that represents the clock you want to use as the alarm. * Pick an `input_datetime` that represents the clock you want to use as the alarm.
* Pick an `input_boolean` that toggles the alarm on or off. * Pick an `input_boolean` that toggles the alarm on or off.
* Choose a `offset_duration` * Choose an `offest_duration` for how long before/after to start the sunrise arc relative to the alarm time. You'll usually want this to be the same as `duration` defined in the previous script, this time _negative_, so that the peak (end) of the arc aligns with the alarm time.
* Choose the `sunrisesimulation` script you created in the previous step for the `alarm_script` field. * Choose the `sunrisesimulation` script you created in the previous step for the `alarm_script` field.
* Save you now have a readytorun alarm! * Save you now have a readytorun alarm!