Skip to content

Commit 3ddbdb9

Browse files
committed
Remove outdated gotchas from AGENTS.md for clarity and conciseness
1 parent 60823be commit 3ddbdb9

1 file changed

Lines changed: 0 additions & 17 deletions

File tree

AGENTS.md

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -77,23 +77,6 @@ A feature isn't done when it compiles and tests pass. Also:
7777
intent methods, catalogs, snapshots), not raw DTOs.
7878
3. Update `CHANGELOG.md`.
7979

80-
## Current gotchas
81-
82-
- **`seg` object vs array form.** `"seg": { … }` targets the *selected* segments (no id);
83-
`"seg": [{ "id": N, … }]` targets explicit ids. WLED infers `id:0` for an array entry
84-
that omits its id, so the object form is the only way to address "the selected
85-
segments". Use `SegmentPayload.Selected`/`List`, `StateUpdate.SelectedSegments(...)` for
86-
the object form and `StateUpdate.Segment(id, ...)` for the array form. Mixing the two in
87-
one update throws.
88-
- **`transition`/`tt` are `ushort`** (0–65535, one unit = 100ms).
89-
- **Reserved effects/palettes.** Entries named `RSVD` or `-` are placeholders that fall
90-
back to Solid; filter them out of UI. `EffectCatalog`/`PaletteCatalog` expose
91-
`IsReserved`/`AvailableOnly()` for this.
92-
- **Effect metadata** (`/json/fxdata`) describes which controls each effect uses and their
93-
defaults; `EffectMetadata` is aligned by id with the (reserved-filtered) effects list.
94-
- **`GetDevice()`** is the recommended read path: it issues a single `GET /json` and
95-
exposes state, info and effect/palette catalogs as one coherent snapshot.
96-
9780
## Reference material
9881

9982
- WLED JSON API docs: <https://kno.wled.ge/interfaces/json-api/>

0 commit comments

Comments
 (0)