afiqzudinhadi/zmk
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

feat(docs): Document persisted settings and debouncing

Browse source
This commit is contained in:
Cem Aksoylar 2023-09-02 15:26:00 -07:00 • committed by Pete Johanson
parent b20d3178b9
commit 4e18b879bd
5 changed files with 27 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/docs/behaviors/underglow.md
View file

@ -55,6 +55,12 @@ Value Limits:
:::
:::note RGB settings persistence
The RGB settings that are changed via the `&rgb_ug` behavior will be saved to flash storage and hence persist across restarts and firmware flashes.
They will also override the start values set by [`CONFIG_ZMK_RGB_*_START` settings](../config/underglow.md#kconfig).
However the settings will only be saved after [`CONFIG_ZMK_SETTINGS_SAVE_DEBOUNCE`](../config/system.md#general) milliseconds in order to reduce potential wear on the flash memory.
:::
## Examples
1. Toggle underglow on/off