patrick/ha-sunrise-alarm
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

polish docs

Browse Source
This commit is contained in:
hiperman
2026-01-09 22:44:13 -05:00
parent 35e4e6e2ac
commit 9258db2ea0
1 changed files with 27 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@@ -2,21 +2,39 @@
# Home‑Assistant Sunrise Alarm
_Turn your smart lights into a natural alarm clock_
This script turns any compatible light (or group of lights) into a soft‑sunrise / sunset alarm.
It gradually ramps the brightness and the colour temperature over a user‑defined period
The script can also run in reverse mode, turning the light down to simulate a sunset.
<div align="center">
<table>
<tr>
<td align="center">
<strong>Script</strong><br>
<div>
<a href="https://my.home-assistant.io/redirect/blueprint_import/?blueprint_url=https://git.jaroszew.ski/patrick/ha-sunrise-alarm/raw/branch/main/sunrise-simulation.yaml">
<img src="https://my.home-assistant.io/badges/blueprint_import.svg" alt="Import sunrise‑simulation">
</a>
</div>
</td>
<td align="center">
<strong>Automation</strong><br>
<div>
<a href="https://my.home-assistant.io/redirect/blueprint_import/?blueprint_url=https://git.jaroszew.ski/patrick/ha-sunrise-alarm/raw/branch/main/sunrise-alarm.yaml">
<img src="https://my.home-assistant.io/badges/blueprint_import.svg" alt="Import sunrise‑alarm">
</a>
</div>
</td>
</tr>
</table>
</div>
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.
- `sunrise-simulation.yaml`: This script turns any compatible light (or group of lights) into a soft‑sunrise / sunset alarm. It gradually ramps the brightness and the colour temperature over a user‑defined period.
- `sunrise-alarm.yaml`: Thin wrapper that calls the simulation script when the alarm occurs (or some configured time before/after).
---
## 1. What it is & how it works
| Component | Purpose | What it does |
|-----------|---------|--------------|
| **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. |
| **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. |
> **Why two separate blueprints?**
@@ -28,7 +46,7 @@ This project is made up of two blueprints
### 2.1 sunrise‑simulation
1. **Import the blueprint**
1. **Import the sunrise script blueprint**
<div>
@@ -63,7 +81,7 @@ This project is made up of two blueprints
* Choose the `sunrise‑simulation` script you created in the previous step for the `alarm_script` field.
* Save – you now have a ready‑to‑run alarm!
> **Tip** – If you want a *sunset* alarm, simply copy the `sunrise‑simulation` script (or create a new script from the blueprint if you want to define a different arc) and reverse it by setting direction with the `reversed` flag set to `true`. You'll also want to create a new automation that calls it with a negative `offset_duration`.
> **Tip** If you want a *sunset* alarm, simply copy the `sunrise‑simulation` script (or create a new script from the blueprint if you want to define a different arc) and reverse it by setting direction with the `reversed` flag set to `true`. You'll also want to create a new automation that calls it with a negative `offset_duration`.
---