Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: adding separate settings for automatic saving of the selected endpoint / ext_power state #2308

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions app/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -645,6 +645,14 @@ config ZMK_SETTINGS_SAVE_DEBOUNCE
int "Milliseconds to debounce settings saves"
default 60000

config ZMK_SETTINGS_SAVE_ENDPOINTS
bool "save endpoints configuration"
default y

config ZMK_SETTINGS_SAVE_EXT_POWER
bool "save ext power state"
default y

#SETTINGS
endif

Expand Down
2 changes: 1 addition & 1 deletion app/src/endpoints.c
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ static struct k_work_delayable endpoints_save_work;
#endif

static int endpoints_save_preferred(void) {
#if IS_ENABLED(CONFIG_SETTINGS)
#if IS_ENABLED(CONFIG_ZMK_SETTINGS_SAVE_ENDPOINTS)
return k_work_reschedule(&endpoints_save_work, K_MSEC(CONFIG_ZMK_SETTINGS_SAVE_DEBOUNCE));
#else
return 0;
Expand Down
2 changes: 1 addition & 1 deletion app/src/ext_power_generic.c
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ static struct k_work_delayable ext_power_save_work;
#endif

int ext_power_save_state(void) {
#if IS_ENABLED(CONFIG_SETTINGS)
#if IS_ENABLED(CONFIG_ZMK_SETTINGS_SAVE_EXT_POWER)
int ret = k_work_reschedule(&ext_power_save_work, K_MSEC(CONFIG_ZMK_SETTINGS_SAVE_DEBOUNCE));
return MIN(ret, 0);
#else
Expand Down
1 change: 1 addition & 0 deletions docs/docs/behaviors/outputs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/docs/behaviors/power.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/config/system.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down