Procházet zdrojové kódy

Document profile persistence and EEPROM limitation

Paul Klumpp před 2 týdny
rodič
revize
4ff94ed942
1 změnil soubory, kde provedl 16 přidání a 1 odebrání
  1. 16 1
      README.md

+ 16 - 1
README.md

@@ -124,7 +124,10 @@ alias for `solid`.
 The effect catalog is consistent with the QMK RGB Matrix firmware. The
 keyboard implements the VIA protocol (version 3) and its 46 backlight effect
 names match the QMK RGB Matrix effect catalog exactly — verified through live
-testing.
+testing. The animations are defined in
+[QMK `rgb_matrix/animations/`](https://github.com/qmk/qmk_firmware/tree/master/quantum/rgb_matrix/animations),
+where each effect has its own header file (e.g.
+`digital_rain_anim.h`, `solid_reactive_anim.h`, `riverflow_anim.h`).
 
 ID 39 is `multisplash`; ID 41 is the distinct `solid_multisplash` name.
 
@@ -210,6 +213,18 @@ New keyboards can be added to `keyboards.json`.
 | `wobkey rgb mode <index>`       | Set a raw zone-specific effect ID        |
 | `wobkey rgb --zone <zone> ...`  | Target `logo`, `backlight`, or `side`     |
 | `wobkey rgb --device <path> ...`| Specify HID device path                  |
+| `wobkey rgb save [name]`        | Save current RGB state to `profiles/<name>.json` |
+| `wobkey rgb load [name]`        | Load and apply a profile from `profiles/` |
+| `wobkey rgb list`               | List saved profiles                        |
+| `wobkey rgb delete [name]`      | Delete a saved profile                     |
+
+## Profiles
+
+Profiles store RGB state (effect, brightness, speed, color) per zone as JSON
+files in the `profiles/` directory. They are the only way to persist RGB
+settings across reboots. The keyboard's VIA protocol does not expose a
+standard command to save RGB state to internal EEPROM, so profiles rely on
+files instead.
 
 ## Architecture