technicalkiwi/led-controller
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(ui): switch user-facing spelling to colour

Browse Source 
Made-with: Cursor
This commit is contained in:
Jimmy
2026-03-22 00:00:12 +13:00
parent 9479d0d292
commit b7c45fd72c
6 changed files with 78 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/API.md
View File

@@ -16,7 +16,7 @@ All JSON APIs use `Content-Type: application/json` for bodies and responses unle
The main UI has two modes controlled by the mode toggle:
- **Run mode**: optimized for operation (tab/preset selection and profile apply).
- **Edit mode**: shows editing/management controls (tabs, presets, patterns, color palette, send presets, and profile management actions).
- **Edit mode**: shows editing/management controls (tabs, presets, patterns, colour palette, send presets, and profile management actions).
Profiles are available in both modes, but behavior differs:
@@ -117,8 +117,8 @@ Response on success includes `presets_sent`, `messages_sent` (chunking splits pa
Stored preset records can include:
- `colors`: resolved hex colors for editor/display.
- `palette_refs`: optional array of palette indexes parallel to `colors`. If a slot contains an integer index, the color is linked to the current profile palette at that index.
- `colors`: resolved hex colours for editor/display.
- `palette_refs`: optional array of palette indexes parallel to `colors`. If a slot contains an integer index, the colour is linked to the current profile palette at that index.
### Tabs — `/tabs`
@@ -137,10 +137,10 @@ Stored preset records can include:
| Method | Path | Description |
|--------|------|-------------|
| GET | `/palettes` | Map of id → color list. |
| GET | `/palettes` | Map of id → colour list. |
| GET | `/palettes/<id>` | `{"colors": [...], "id": "<id>"}` |
| POST | `/palettes` | Body may include `colors`. Returns palette object with `id`, 201. |
| PUT | `/palettes/<id>` | Update colors (`name` ignored). |
| PUT | `/palettes/<id>` | Update colours (`name` ignored). |
| DELETE | `/palettes/<id>` | Delete palette. |
### Groups — `/groups`
@@ -217,7 +217,7 @@ On the wire, presets use **short keys** (saves space in the ≤240-byte chunks):
| Key | Meaning | Notes |
|-----|---------|--------|
| `p` | Pattern id | `off`, `on`, `blink`, `rainbow`, `pulse`, `transition`, `chase`, `circle` |
| `c` | Colors | Array of `"#RRGGBB"` hex strings; converted to RGB on device |
| `c` | Colours | Array of `"#RRGGBB"` hex strings; converted to RGB on device |
| `d` | Delay ms | Default 100 |
| `b` | Preset brightness | 0–255; combined with global `b` on the device |
| `a` | Auto | `true`: run continuously; `false`: one step/cycle per “beat” |
@@ -228,7 +228,7 @@ The HTTP app’s **`POST /presets/send`** path builds this from stored presets v
### Pattern-specific parameters (`n1`–`n6`)
#### Rainbow
- **`n1`**: Step increment on the color wheel per update (default 1).
- **`n1`**: Step increment on the colour wheel per update (default 1).
#### Pulse
- **`n1`**: Attack (fade in) ms
@@ -240,8 +240,8 @@ The HTTP app’s **`POST /presets/send`** path builds this from stored presets v
- **`d`**: Transition duration ms
#### Chase
- **`n1`**: LEDs with first color
- **`n2`**: LEDs with second color
- **`n1`**: LEDs with first colour
- **`n2`**: LEDs with second colour
- **`n3`**: Movement on even steps (may be negative)
- **`n4`**: Movement on odd steps (may be negative)
@@ -299,7 +299,7 @@ The HTTP app’s **`POST /presets/send`** path builds this from stored presets v
1. Reject if `v != "1"`.
2. Apply optional top-level **`b`** (global brightness).
3. For each entry in **`presets`**, normalize colors and upsert preset by id.
3. For each entry in **`presets`**, normalize colours and upsert preset by id.
4. If this device’s **`name`** appears in **`select`**, run selection (optional step).
5. If **`default`** is set, store startup preset id.
6. If **`save`** is set, persist presets.