|
|
@@ -173,9 +173,22 @@ Observed on the Impact 80:
|
|
|
|
|
|
| Zone | Channel | Brightness | Speed |
|
|
|
|---|---|---|---|
|
|
|
-| `logo` | `0x02` | clamps at 160 | any value above 0 becomes 4 |
|
|
|
+| `logo` | `0x02` | clamps at 160 | `0` stops the animation, `1` is the slowest movement, above 1 becomes 4 |
|
|
|
| `backlight` | `0x03` | scales up, saturating at 255 | applied as given |
|
|
|
-| `side` | `0x04` | clamps at 160 | any value above 0 becomes 4 |
|
|
|
+| `side` | `0x04` | clamps at 160 | `0` stops the animation, `1` is the slowest movement, above 1 becomes 4 |
|
|
|
+
|
|
|
+Speed is not a smooth dial on `logo` and `side`. Only three outcomes are
|
|
|
+reachable there, and the value range the vendor's own VIA definition offers for
|
|
|
+those two channels is `[0, 4]`, not 0–255:
|
|
|
+
|
|
|
+| Requested | Stored | Effect |
|
|
|
+|---:|---:|---|
|
|
|
+| `0` | `0` | the animation is frozen, the color stands still |
|
|
|
+| `1` | `1` | the slowest movement |
|
|
|
+| `2` and above | `4` | twice as fast; this is where every larger request lands |
|
|
|
+
|
|
|
+The freeze at `0` was observed on `logo`; `side` reports the same range and the
|
|
|
+same collapse to 4. `backlight` is the only channel with a usable 0–255 range.
|
|
|
|
|
|
The command exits 0 either way: a value the firmware cannot represent is not a
|
|
|
failure, but the summary line always states the value that was actually applied.
|
|
|
@@ -246,14 +259,19 @@ Effects fall into categories that behave differently:
|
|
|
|
|
|
- **Static** effects (`solid_color`, `none`) display a steady output. The color is set by `color` and is constant.
|
|
|
- **Reactive** effects (`solid_reactive*`) light up on key press. They honor the color set by `color` — the pressed key's LEDs flash in the configured color. Use `speed` to adjust how long the illumination lasts.
|
|
|
-- **Breathing** effects (`breathing`, `hue_breathing`) slowly fade in and out. They do not honor `color` directly; `hue_breathing` cycles through the full hue range.
|
|
|
-- **Dynamic/stream** effects (`band_*`, `cycle_*`, `rainbow_*`, `starlight*`, `raindrops`, `jellybean_raindrops`, `flower_blooming`, `pixel_flow`, `riverflow`) animate independently. Most ignore `color` and use their own color palettes. `hue_breathing`, `hue_pendulum`, and `hue_wave` cycle through hues.
|
|
|
+- **Breathing** effects (`breathing`, `hue_breathing`) slowly fade in and out, and both honor `color`. `breathing` keeps the hue and saturation and pulses the brightness of that color; `hue_breathing` swings the hue around the hue you set by a narrow amount instead of running through the full range.
|
|
|
+- **Dynamic/stream** effects (`band_*`, `cycle_*`, `rainbow_*`, `starlight*`, `raindrops`, `jellybean_raindrops`, `flower_blooming`, `pixel_flow`, `riverflow`) animate independently. Most ignore `color` and use their own color palettes. `hue_pendulum` and `hue_wave` cycle through hues.
|
|
|
- **Splash** effects (`splash`, `multisplash`, `solid_splash`, `solid_multisplash`) react to key presses like reactive effects but with a splash pattern. `solid_splash` and `solid_multisplash` honor `color`.
|
|
|
- **Gradient** effects (`gradient_up_down`, `gradient_left_right`) create a color gradient across the keyboard. They do not honor `color`.
|
|
|
- **Alphas mods** (`alphas_mods`) colors modifier keys differently from alphanumeric keys. The colors are built-in and cannot be changed.
|
|
|
|
|
|
To set a permanent color, use `solid_color` and then `color <hex>`.
|
|
|
|
|
|
+The `logo` and `side` catalogs hold only seven effects each, and the color you
|
|
|
+set is shown by three of them: `fixed_wave`, `breathing` and `light`. `wave`,
|
|
|
+`spectrum` and `shutdown` run their own color sequence, so a color set on them is
|
|
|
+stored but not displayed.
|
|
|
+
|
|
|
## Compatibility Aliases
|
|
|
Effect names are resolved independently for each target zone. Compatibility
|
|
|
aliases are `off` → `none`, `breathe` → `breathing`, `rainbow` → `spectrum`
|
|
|
@@ -360,7 +378,7 @@ Two models are listed in `keyboards.json`:
|
|
|
| `qmk-rgb-tool effect <name>` | Set a zone-aware effect by name |
|
|
|
| `qmk-rgb-tool effect --list` | List every effect per zone (JSON) |
|
|
|
| `qmk-rgb-tool brightness <val>` | Set brightness (0–255) on selected zones, verified by read-back |
|
|
|
-| `qmk-rgb-tool speed <val>` | Set effect speed (0–255) on selected zones, verified by read-back |
|
|
|
+| `qmk-rgb-tool speed <val>` | Set effect speed (0–255) on selected zones, verified by read-back; on `logo` and `side` only 0, 1 and 4 are reachable |
|
|
|
| `qmk-rgb-tool color <hex>` | Set color (e.g. `ff0000`) on selected zones |
|
|
|
| `qmk-rgb-tool color rgb:<hex>` | The same hex color, written out |
|
|
|
| `qmk-rgb-tool color hsv:<h>,<s>,<v>` | Set hue and saturation (0–255) and write `v` to the brightness of the same zones |
|