mirror of
https://github.com/basnijholt/adaptive-lighting.git
synced 2026-09-15 08:14:04 +02:00
docs: reconcile number-entity count to five (add ramp_half_width) (#1)
The README What's-new callout and the CHANGELOG 2.1.0 entry still said four number entities, while the README table/intro and the runtime-range-controls spec say five (the four range bounds plus ramp_half_width). Update the callout to list all five and add a CHANGELOG entry for the fifth entity; leave the historical 2.1.0 'four' entry intact. Docs only -- code and spec already reflect five. Filed as openspec change fix-number-entity-count-docs.
This commit is contained in:
parent
8152eb3b63
commit
f4ec31ecc8
6 changed files with 48 additions and 1 deletions
|
|
@ -47,6 +47,13 @@ maintainers who can actually fix them for everyone.
|
|||
(rare; can happen during very early HA startup), the sensor renders
|
||||
as `unknown` for that tick — the other two sensors continue updating
|
||||
normally.
|
||||
- **Fifth live-tunable `number` entity: `ramp_half_width`** (5–120 min) —
|
||||
completes the runtime curve-control set alongside the four range bounds
|
||||
(`min_brightness`, `max_brightness`, `min_color_temp`, `max_color_temp`).
|
||||
It tunes the tanh ramp half-width around each sun event live and persists
|
||||
via `RestoreNumber`; unlike the four range fields it is not surfaced in the
|
||||
options dialog. Shipped earlier without a changelog entry — recorded here
|
||||
for completeness.
|
||||
|
||||
### Changed
|
||||
|
||||
|
|
|
|||
|
|
@ -67,13 +67,14 @@
|
|||
>
|
||||
> ## ✨ What's new in 2.1
|
||||
>
|
||||
> Each profile now exposes **four live-tunable sliders** as `number`
|
||||
> Each profile now exposes **five live-tunable sliders** as `number`
|
||||
> entities you can drop on any Lovelace card:
|
||||
>
|
||||
> - `number.<profile>_min_brightness` — night-floor brightness (1–100 %)
|
||||
> - `number.<profile>_max_brightness` — peak-day brightness (1–100 %)
|
||||
> - `number.<profile>_min_color_temp` — warmest tone (1000–10000 K)
|
||||
> - `number.<profile>_max_color_temp` — coolest tone (1000–10000 K)
|
||||
> - `number.<profile>_ramp_half_width` — curve ramp half-width (5–120 min)
|
||||
>
|
||||
> **Slider position is the runtime truth.** Move a slider on the dashboard
|
||||
> and the curve picks it up on the next tick — no integration reload, no
|
||||
|
|
@ -93,6 +94,7 @@
|
|||
> - number.dining_mvp_max_brightness
|
||||
> - number.dining_mvp_min_color_temp
|
||||
> - number.dining_mvp_max_color_temp
|
||||
> - number.dining_mvp_ramp_half_width
|
||||
> ```
|
||||
>
|
||||
> Also in 2.1: **entity friendly names are now readable.** A profile named
|
||||
|
|
|
|||
|
|
@ -0,0 +1,2 @@
|
|||
schema: spec-driven
|
||||
created: 2026-07-08
|
||||
3
openspec/changes/fix-number-entity-count-docs/README.md
Normal file
3
openspec/changes/fix-number-entity-count-docs/README.md
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
# fix-number-entity-count-docs
|
||||
|
||||
Reconcile CHANGELOG and README to five number entities (adds ramp_half_width)
|
||||
24
openspec/changes/fix-number-entity-count-docs/proposal.md
Normal file
24
openspec/changes/fix-number-entity-count-docs/proposal.md
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
## Why
|
||||
|
||||
The count of `number` entities per profile is inconsistent across the Adaptive Lighting docs. The integration exposes **five** live-tunable `number` entities per profile — the four range bounds (`min_brightness`, `max_brightness`, `min_color_temp`, `max_color_temp`) plus `ramp_half_width` — as stated in the README reference table ("Number entities (5)") and intro ("five live-tunable sliders"), and as required by the `runtime-range-controls` spec ("exposes five runtime curve entities"). But two doc locations still say four: the README's top callout block ("four live-tunable sliders", listing only the four range entities) and the `CHANGELOG.md` `2.1.0-cdit.1` "Added" entry, which introduced the original four and was never followed by an entry recording the fifth (`ramp_half_width`). A reader gets contradictory counts inside the same README.
|
||||
|
||||
## What Changes
|
||||
|
||||
- **README**: update the top callout block (the "four live-tunable sliders" section) to list all five entities, adding `number.<profile>_ramp_half_width`, so it matches the reference table and intro further down the same file.
|
||||
- **CHANGELOG**: add an entry under the appropriate unreleased version documenting the `ramp_half_width` number entity as the fifth live-tunable slider. Leave the historical `2.1.0-cdit.1` "four" entry intact — it accurately records the release that introduced the first four; the gap is the missing later entry, not a wrong historical one.
|
||||
- No source change: the implementation already creates five entities.
|
||||
- No spec change: `runtime-range-controls` already specifies five (its "four range entities" wording refers to the range subset, distinct from the ramp control).
|
||||
|
||||
## Capabilities
|
||||
|
||||
### New Capabilities
|
||||
|
||||
None. Documentation-only correction.
|
||||
|
||||
### Modified Capabilities
|
||||
|
||||
None. `runtime-range-controls` already reflects five entities; behavior is unchanged.
|
||||
|
||||
## Impact
|
||||
|
||||
- `Adaptive_lighting/README.md` (top callout block) and `Adaptive_lighting/CHANGELOG.md` (one added entry). No source or spec files change.
|
||||
9
openspec/changes/fix-number-entity-count-docs/tasks.md
Normal file
9
openspec/changes/fix-number-entity-count-docs/tasks.md
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
# Tasks
|
||||
|
||||
## 1. Reconcile the number-entity count across the docs
|
||||
|
||||
- [x] 1.1 In `README.md`, update the top callout block that says "four live-tunable sliders" to list all five entities, adding `number.<profile>_ramp_half_width`
|
||||
- [x] 1.2 In `CHANGELOG.md`, add an entry under the current unreleased version documenting the `ramp_half_width` number entity as the fifth live-tunable slider; leave the historical `2.1.0-cdit.1` "four" entry unchanged
|
||||
- [x] 1.3 Verify the README intro ("five live-tunable sliders") and the reference table ("Number entities (5)") now agree with the corrected callout
|
||||
- [x] 1.4 Grep the repo for other stale "four ... number"/"four ... slider" doc references and fix any stragglers
|
||||
- [x] 1.5 Leave source and the `runtime-range-controls` spec untouched (both already reflect five entities)
|
||||
Loading…
Add table
Add a link
Reference in a new issue