docs: adding documentation for the auto endpoint/ext_power saving flags
This commit is contained in:
parent
54527fc0d2
commit
3b7428ad85
3 changed files with 4 additions and 0 deletions
docs/docs
|
@ -47,6 +47,7 @@ The output selection behavior changes the preferred output on press.
|
|||
:::note[Output selection persistence]
|
||||
The endpoint that is selected by the `&out` behavior will be saved to flash storage and hence persist across restarts and firmware flashes.
|
||||
However it 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.
|
||||
This can be disabled by unsetting [`CONFIG_ZMK_SETTINGS_SAVE_ENDPOINTS`](../config/system.md#general)
|
||||
:::
|
||||
|
||||
### Examples
|
||||
|
|
|
@ -46,6 +46,7 @@ Here is a table describing the command for each define:
|
|||
:::note[External power state persistence]
|
||||
The on/off state that is set by the `&ext_power` behavior will be saved to flash storage and hence persist across restarts and firmware flashes.
|
||||
However it 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.
|
||||
This can be disabled by unsetting [`CONFIG_ZMK_SETTINGS_SAVE_EXT_POWER`](../config/system.md#general)
|
||||
:::
|
||||
|
||||
### Example:
|
||||
|
|
|
@ -20,6 +20,8 @@ Definition file: [zmk/app/Kconfig](https://github.com/zmkfirmware/zmk/blob/main/
|
|||
| `CONFIG_ZMK_SETTINGS_SAVE_DEBOUNCE` | int | Milliseconds to wait after a setting change before writing it to flash memory | 60000 |
|
||||
| `CONFIG_ZMK_WPM` | bool | Enable calculating words per minute | n |
|
||||
| `CONFIG_HEAP_MEM_POOL_SIZE` | int | Size of the heap memory pool | 8192 |
|
||||
| `CONFIG_ZMK_SETTINGS_SAVE_ENDPOINTS` | bool | Enable automatic saving of the selected endpoint (USB / BT) | y |
|
||||
| `CONFIG_ZMK_SETTINGS_SAVE_EXT_POWER` | bool | Enable automatic saving of the selected ext_power persistance state | y |
|
||||
|
||||
### HID
|
||||
|
||||
|
|
Loading…
Add table
Reference in a new issue