zmkfirmware
/
zmk
mirror of https://github.com/zmkfirmware/zmk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge 7339326e2b into ac7f75b859

This commit is contained in:
rianadon 2026-02-01 16:24:35 -06:00 committed by GitHub
parent ac7f75b859 7339326e2b
commit ff072af542
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
14 changed files with 498 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
app/CMakeLists.txt
View File

@ -30,6 +30,7 @@ target_sources(app PRIVATE src/behavior.c)
target_sources_ifdef(CONFIG_ZMK_KSCAN_SIDEBAND_BEHAVIORS app PRIVATE src/kscan_sideband_behaviors.c)
target_sources(app PRIVATE src/matrix_transform.c)
target_sources(app PRIVATE src/physical_layouts.c)
target_sources(app PRIVATE src/reset.c)
target_sources(app PRIVATE src/sensors.c)
target_sources_ifdef(CONFIG_ZMK_WPM app PRIVATE src/wpm.c)
target_sources(app PRIVATE src/event_manager.c)

9
app/Kconfig
View File

@ -691,6 +691,15 @@ config ZMK_KEYMAP_SENSORS_DEFAULT_TRIGGERS_PER_ROTATION
endif # ZMK_KEYMAP_SENSORS
config ZMK_BOOT_MAGIC_COMBO
bool "Enable actions when keys are held at boot"
default y
depends on DT_HAS_ZMK_BOOT_MAGIC_COMBO_ENABLED
config ZMK_BOOT_MAGIC_COMBO_TIMEOUT_MS
int "Milliseconds to wait for a boot magic combo at startup"
default 500
module = ZMK
module-str = zmk
source "subsys/logging/Kconfig.template.log_config"

2
app/dts/behaviors/reset.dtsi
View File

@ -18,7 +18,7 @@
// Behavior can be invoked on peripherals, so name must be <= 8 characters.
bootloader: bootload {
compatible = "zmk,behavior-reset";
type = <RST_UF2>;
type = <ZMK_RESET_BOOTLOADER>;
bootloader;
#binding-cells = <0>;
display-name = "Bootloader";

23
app/dts/bindings/zmk,boot-magic-combo.yaml Normal file
View File

@ -0,0 +1,23 @@
# Copyright (c) 2026, The ZMK Contributors
# SPDX-License-Identifier: MIT
description: |
Triggers one or more actions if a combination of keys is held while the keyboard boots.
This is typically used for recovering a keyboard in cases such as &bootloader
being missing from the keymap or a split peripheral which isn't connected to
the central, and therefore can't process the keymap.
compatible: "zmk,boot-magic-combo"
properties:
combo-positions:
type: array
required: true
description: Zero-based indices of the keys which must be simultaneously pressed to trigger the action(s).
# Boot magic actions:
jump-to-bootloader:
type: boolean
description: Reboots into the bootloader.
reset-settings:
type: boolean
description: Clears settings and reboots.

10
app/include/dt-bindings/zmk/reset.h
View File

@ -4,10 +4,6 @@
* SPDX-License-Identifier: MIT
*/
#define RST_WARM 0x00
#define RST_COLD 0x01
// AdaFruit nrf52 Bootloader Specific. See
// https://github.com/adafruit/Adafruit_nRF52_Bootloader/blob/d6b28e66053eea467166f44875e3c7ec741cb471/src/main.c#L107
#define RST_UF2 0x57
#define ZMK_RESET_WARM 0
#define ZMK_RESET_COLD 1
#define ZMK_RESET_BOOTLOADER 2

2
app/include/zmk/ble.h
View File

@ -40,7 +40,7 @@ bool zmk_ble_active_profile_is_open(void);
bool zmk_ble_active_profile_is_connected(void);
char *zmk_ble_active_profile_name(void);
int zmk_ble_unpair_all(void);
void zmk_ble_unpair_all(void);
int zmk_ble_set_device_name(char *name);

25
app/include/zmk/reset.h Normal file
View File

@ -0,0 +1,25 @@
/*
* Copyright (c) 2023 The ZMK Contributors
*
* SPDX-License-Identifier: MIT
*/
#pragma once
#include <zephyr/toolchain.h>
#include <dt-bindings/zmk/reset.h>
/**
* Reboot the system.
* @param type If CONFIG_RETENTION_BOOT_MODE is set: A BOOT_MODE_TYPE_* value indicating which type
* of reboot. Otherwise, A ZMK_RESET_* value indicating how to reboot.
*/
void zmk_reset(int type);
/**
* Clear all persistent settings.
*
* This should typically be followed by a call to zmk_reset() to ensure that
* all subsystems are properly reset.
*/
void zmk_reset_settings(void);

15
app/src/behaviors/behavior_reset.c
View File

@ -7,12 +7,12 @@
#define DT_DRV_COMPAT zmk_behavior_reset
#include <zephyr/device.h>
#include <zephyr/sys/reboot.h>
#include <zephyr/logging/log.h>
#include <drivers/behavior.h>
#include <zmk/behavior.h>
#include <zmk/reset.h>
#if IS_ENABLED(CONFIG_RETENTION_BOOT_MODE)
@ -37,19 +37,10 @@ static int on_keymap_binding_pressed(struct zmk_behavior_binding *binding,
const struct behavior_reset_config *cfg = dev->config;
#if IS_ENABLED(CONFIG_RETENTION_BOOT_MODE)
int ret = bootmode_set(cfg->boot_mode);
if (ret < 0) {
LOG_ERR("Failed to set the bootloader mode (%d)", ret);
return ZMK_BEHAVIOR_OPAQUE;
}
sys_reboot(SYS_REBOOT_WARM);
zmk_reset(cfg->boot_mode);
#else
// See
// https://github.com/adafruit/Adafruit_nRF52_Bootloader/blob/d6b28e66053eea467166f44875e3c7ec741cb471/src/main.c#L107
sys_reboot(cfg->type);
zmk_reset(cfg->type);
#endif /* IS_ENABLED(CONFIG_RETENTION_BOOT_MODE) */
return ZMK_BEHAVIOR_OPAQUE;
}

53
app/src/ble.c
View File

@ -336,6 +336,32 @@ int zmk_ble_prof_disconnect(uint8_t index) {
return result;
}
void zmk_ble_unpair_all(void) {
LOG_WRN("Clearing all existing BLE bond information from the keyboard");
int err = bt_unpair(BT_ID_DEFAULT, NULL);
if (err) {
LOG_ERR("Failed to unpair default identity: %d", err);
}
for (int i = 0; i < 8; i++) {
char setting_name[32];
sprintf(setting_name, "ble/profiles/%d", i);
int err = settings_delete(setting_name);
if (err) {
LOG_ERR("Failed to delete profile setting: %d", err);
}
sprintf(setting_name, "ble/peripheral_addresses/%d", i);
err = settings_delete(setting_name);
if (err) {
LOG_ERR("Failed to delete peripheral setting: %d", err);
}
}
}
bt_addr_le_t *zmk_ble_active_profile_addr(void) { return &profiles[active_profile].peer; }
struct bt_conn *zmk_ble_active_profile_conn(void) {
@ -692,32 +718,7 @@ static void zmk_ble_ready(int err) {
static int zmk_ble_complete_startup(void) {
#if IS_ENABLED(CONFIG_ZMK_BLE_CLEAR_BONDS_ON_START)
LOG_WRN("Clearing all existing BLE bond information from the keyboard");
bt_unpair(BT_ID_DEFAULT, NULL);
for (int i = 0; i < 8; i++) {
char setting_name[15];
sprintf(setting_name, "ble/profiles/%d", i);
int err = settings_delete(setting_name);
if (err) {
LOG_ERR("Failed to delete setting: %d", err);
}
}
// Hardcoding a reasonable hardcoded value of peripheral addresses
// to clear so we properly clear a split central as well.
for (int i = 0; i < 8; i++) {
char setting_name[32];
sprintf(setting_name, "ble/peripheral_addresses/%d", i);
int err = settings_delete(setting_name);
if (err) {
LOG_ERR("Failed to delete setting: %d", err);
}
}
zmk_ble_unpair_all();
#endif // IS_ENABLED(CONFIG_ZMK_BLE_CLEAR_BONDS_ON_START)
bt_conn_cb_register(&conn_callbacks);

1
app/src/boot/CMakeLists.txt
View File

@ -2,3 +2,4 @@
target_sources_ifdef(CONFIG_ZMK_BOOTMODE_TO_MAGIC_VALUE_MAPPER app PRIVATE bootmode_to_magic_mapper.c)
target_sources_ifdef(CONFIG_ZMK_DBL_TAP_BOOTLOADER app PRIVATE dbl_tap_bootloader.c)
target_sources_ifdef(CONFIG_ZMK_BOOT_STM32_ENFORCE_NBOOT_SEL app PRIVATE stm32_enforce_nboot_sel.c)
target_sources_ifdef(CONFIG_ZMK_BOOT_MAGIC_COMBO app PRIVATE boot_magic_combo.c)

126
app/src/boot/boot_magic_combo.c Normal file
View File

@ -0,0 +1,126 @@
/*
* Copyright (c) 2026 The ZMK Contributors
*
* SPDX-License-Identifier: MIT
*/
#define DT_DRV_COMPAT zmk_boot_magic_combo
#include <zephyr/device.h>
#include <zephyr/devicetree.h>
#include <zephyr/init.h>
#include <zephyr/kernel.h>
#include <zephyr/toolchain.h>
#include <zephyr/logging/log.h>
#include <zmk/reset.h>
#include <zmk/event_manager.h>
#include <zmk/events/position_state_changed.h>
#if IS_ENABLED(CONFIG_RETENTION_BOOT_MODE)
#include <zephyr/retention/bootmode.h>
#endif /* IS_ENABLED(CONFIG_RETENTION_BOOT_MODE) */
LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL);
#if DT_HAS_COMPAT_STATUS_OKAY(DT_DRV_COMPAT)
#define _COMBO_LEN(inst) uint8_t _CONCAT(_len_, inst)[DT_INST_PROP_LEN(inst, combo_positions)];
#define MAX_BOOT_COMBO_LEN sizeof(union {DT_INST_FOREACH_STATUS_OKAY(_COMBO_LEN)})
struct boot_key_config {
const uint16_t *combo_positions;
uint8_t combo_positions_len;
bool jump_to_bootloader;
bool reset_settings;
};
#define BOOT_KEY_COMBO_POSITIONS(n) \
static const uint16_t boot_key_combo_positions_##n[] = DT_INST_PROP(n, combo_positions);
#define BOOT_KEY_CONFIG(n) \
BOOT_KEY_COMBO_POSITIONS(n){ \
.combo_positions = boot_key_combo_positions_##n, \
.combo_positions_len = DT_INST_PROP_LEN(n, combo_positions), \
.jump_to_bootloader = DT_INST_PROP_OR(n, jump_to_bootloader, false), \
.reset_settings = DT_INST_PROP_OR(n, reset_settings, false), \
},
static struct boot_key_config boot_keys[] = {DT_INST_FOREACH_STATUS_OKAY(BOOT_KEY_CONFIG)};
static bool boot_key_states[ARRAY_SIZE(boot_keys)][MAX_BOOT_COMBO_LEN] = {};
static int64_t timeout_uptime;
static int timeout_init(const struct device *device) {
timeout_uptime = k_uptime_get() + CONFIG_ZMK_BOOT_MAGIC_COMBO_TIMEOUT_MS;
return 0;
}
SYS_INIT(timeout_init, APPLICATION, CONFIG_APPLICATION_INIT_PRIORITY);
static void trigger_boot_key(const struct boot_key_config *config) {
if (config->reset_settings) {
LOG_INF("Boot key: resetting settings");
zmk_reset_settings();
}
if (config->jump_to_bootloader) {
LOG_INF("Boot key: jumping to bootloader");
#if IS_ENABLED(CONFIG_RETENTION_BOOT_MODE)
zmk_reset(BOOT_MODE_TYPE_BOOTLOADER);
#else
zmk_reset(ZMK_RESET_BOOTLOADER);
#endif /* IS_ENABLED(CONFIG_RETENTION_BOOT_MODE) */
} else if (config->reset_settings) {
// If resetting settings but not jumping to bootloader, we need to reboot
// to ensure all subsystems are properly reset.
#if IS_ENABLED(CONFIG_RETENTION_BOOT_MODE)
zmk_reset(BOOT_MODE_TYPE_NORMAL);
#else
zmk_reset(ZMK_RESET_WARM);
#endif /* IS_ENABLED(CONFIG_RETENTION_BOOT_MODE) */
}
}
static int event_listener(const zmk_event_t *eh) {
if (likely(k_uptime_get() > timeout_uptime)) {
return ZMK_EV_EVENT_BUBBLE;
}
const struct zmk_position_state_changed *ev = as_zmk_position_state_changed(eh);
if (!ev) {
return ZMK_EV_EVENT_BUBBLE;
}
for (int i = 0; i < ARRAY_SIZE(boot_keys); i++) {
const struct boot_key_config *config = &boot_keys[i];
for (int j = 0; j < config->combo_positions_len; j++) {
if (ev->position == config->combo_positions[j]) {
boot_key_states[i][j] = ev->state;
if (ev->state) {
bool all_keys_pressed = true;
for (int k = 0; k < config->combo_positions_len; k++) {
if (!boot_key_states[i][k]) {
all_keys_pressed = false;
break;
}
}
if (all_keys_pressed) {
trigger_boot_key(config);
}
}
break;
}
}
}
return ZMK_EV_EVENT_BUBBLE;
}
ZMK_LISTENER(boot_magic_combo, event_listener);
ZMK_SUBSCRIPTION(boot_magic_combo, zmk_position_state_changed);
#endif /* DT_HAS_COMPAT_STATUS_OKAY(DT_DRV_COMPAT) */

63
app/src/reset.c Normal file
View File

@ -0,0 +1,63 @@
/*
* Copyright (c) 2023 The ZMK Contributors
*
* SPDX-License-Identifier: MIT
*/
#include <zephyr/sys/reboot.h>
#include <zephyr/logging/log.h>
#include <zephyr/sys/util.h>
#if IS_ENABLED(CONFIG_ZMK_BLE)
#include <zmk/ble.h>
#endif
#include <zmk/reset.h>
#if IS_ENABLED(CONFIG_RETENTION_BOOT_MODE)
#include <zephyr/retention/bootmode.h>
#endif /* IS_ENABLED(CONFIG_RETENTION_BOOT_MODE) */
LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL);
// AdaFruit nrf52 Bootloader Specific. See
// https://github.com/adafruit/Adafruit_nRF52_Bootloader/blob/d6b28e66053eea467166f44875e3c7ec741cb471/src/main.c#L107
#define ADAFRUIT_MAGIC_UF2 0x57
void zmk_reset(int type) {
#if IS_ENABLED(CONFIG_RETENTION_BOOT_MODE)
int ret = bootmode_set(type);
if (ret < 0) {
LOG_ERR("Failed to set the bootloader mode (%d)", ret);
} else {
sys_reboot(SYS_REBOOT_WARM);
}
#else
switch (type) {
case ZMK_RESET_WARM:
sys_reboot(SYS_REBOOT_WARM);
break;
case ZMK_RESET_COLD:
sys_reboot(SYS_REBOOT_COLD);
break;
case ZMK_RESET_BOOTLOADER:
// TODO: Add support for other types of bootloaders.
sys_reboot(ADAFRUIT_MAGIC_UF2);
break;
default:
LOG_ERR("Unknown reset type %d", type);
break;
}
#endif /* IS_ENABLED(CONFIG_RETENTION_BOOT_MODE) */
}
void zmk_reset_settings(void) {
#if IS_ENABLED(CONFIG_ZMK_BLE)
zmk_ble_unpair_all();
#endif
// TODO: clear settings for all subsystems.
}

11
docs/docs/config/system.md
View File

@ -13,11 +13,12 @@ Definition file: [zmk/app/Kconfig](https://github.com/zmkfirmware/zmk/blob/main/
### General
| Config | Type | Description | Default |
| --------------------------- | ------ | -------------------------------------------- | ------- |
| `CONFIG_ZMK_KEYBOARD_NAME` | string | The name of the keyboard (max 16 characters) | |
| `CONFIG_ZMK_WPM` | bool | Enable calculating words per minute | n |
| `CONFIG_HEAP_MEM_POOL_SIZE` | int | Size of the heap memory pool | 8192 |
| Config | Type | Description | Default |
| -------------------------------------- | ------ | ------------------------------------------------------------------------------------- | ------- |
| `CONFIG_ZMK_KEYBOARD_NAME` | string | The name of the keyboard (max 16 characters) | |
| `CONFIG_ZMK_BOOT_MAGIC_COMBO_TIMEOUT_MS` | int | Milliseconds to watch for [boot magic combos](../features/boot-magic-combo.md) at startup | 500 |
| `CONFIG_ZMK_WPM` | bool | Enable calculating words per minute | n |
| `CONFIG_HEAP_MEM_POOL_SIZE` | int | Size of the heap memory pool | 8192 |
:::info

209
docs/docs/features/boot-magic-combo.md Normal file
View File

@ -0,0 +1,209 @@
---
title: Boot Magic Combo
sidebar_label: Boot Magic Combo
---
A boot magic combo performs one or more actions if a combination of keys is held while powering on the keyboard. This is useful for recovering a keyboard which doesn't have a physical reset button. It also works on the peripheral side of a split keyboard, even when it isn't connected to the central side.
## Magic Keys
To define a boot magic combo on a new board or shield, add a `zmk,boot-magic-combo` node to your board's `.dts` file or shield's `.overlay` file and select which keys will trigger it with the `combo-positions` property. All keys in the combo must be held simultaneously to trigger the action.
You can also enable the feature for any keyboard by adding it to your `.keymap` file.
```c
/ {
...
bootloader_key: bootloader_key {
compatible = "zmk,boot-magic-combo";
combo-positions = <0 1>;
};
...
};
```
:::info
Key positions are numbered like the keys in your keymap, starting at 0. So, if the first key in your keymap is `Q`, this key is in position `0`. The next key (possibly `W`) will have position 1, etcetera.
The `combo-positions` property accepts an array of key positions. All keys in the array must be held simultaneously during boot to trigger the action.
:::
Next, you should add properties to determine what the magic key will do:
### Jump to Bootloader
If a boot magic combo has a `jump-to-bootloader` property, it will reboot to the bootloader:
```c
/ {
...
bootloader_key: bootloader_key {
compatible = "zmk,boot-magic-combo";
...
jump-to-bootloader;
};
...
};
```
### Reset Settings
If a boot magic combo has a `reset-settings` property, it will reset persistent settings and then reboot:
```c
/ {
...
reset_settings_key: reset_settings_key {
compatible = "zmk,boot-magic-combo";
...
reset-settings;
};
...
};
```
:::info
This clears all BLE bonds. You will need to re-pair the keyboard with any hosts after using this.
:::
:::caution
Currently this action _only_ clears BLE bonds. It will be updated to reset all settings in the future.
:::
## Multiple Actions
If you want a single boot magic combo to perform multiple actions, simply add properties for each action to the same `zmk,boot-magic-combo` node. The order of the properties does not matter.
For example, to make a key that resets settings and then reboots to the bootloader, add both `reset-settings` and `jump-to-bootloader`:
```c
/ {
...
recovery_key: recovery_key {
compatible = "zmk,boot-magic-combo";
jump-to-bootloader;
reset-settings;
};
...
};
```
:::info
You may define multiple `zmk,boot-magic-combo` nodes for different keys, but note that if you hold multiple keys at boot, they will be run in an arbitrary order. If one of them reboots the keyboard, the rest of the keys will not run.
:::
## Split Keyboards
For split keyboards, you can define multiple boot magic combos and then only enable the correct key(s) for each side. For example, if key 0 is the top-left key on the left side and key 11 is the top-right key on the right side, you could use:
**shield.dtsi**
```c
/ {
...
bootloader_key_left: bootloader_key_left {
compatible = "zmk,boot-magic-combo";
combo-positions = <0>;
jump-to-bootloader;
status = "disabled";
};
bootloader_key_right: bootloader_key_right {
compatible = "zmk,boot-magic-combo";
combo-positions = <11>;
jump-to-bootloader;
status = "disabled";
};
...
};
```
**shield_left.overlay**
```c
#include "shield.dtsi"
&bootloader_key_left {
status = "okay";
};
```
**shield_right.overlay**
```c
#include "shield.dtsi"
&bootloader_key_right {
status = "okay";
};
```
## Key Positions and Alternate Layouts
Key positions are affected by the [matrix transform](../config/kscan.md#matrix-transform), so if your keyboard has multiple transforms for alternate layouts, you may need to adjust positions according to the user's selected transform. There is no automatic way to do this, but one way to simplify things for users is to add a block of commented out code to the keymap which selects the transform and updates the key positions to match if uncommented.
For example, consider a split keyboard which has 6 columns per side by default but supports a 5-column layout, and assume you want the top-left key on the left side and the top-right key on the right side to be boot magic combos. The top-left key will be position 0 regardless of layout, but the top-right key will be position 11 by default and position 9 in the 5-column layout.
**shield.dtsi**
```c
/ {
chosen {
zmk,matrix_transform = &default_transform;
};
bootloader_key_left: bootloader_key_left {
compatible = "zmk,boot-magic-combo";
combo-positions = <0>;
jump-to-bootloader;
status = "disabled";
};
bootloader_key_right: bootloader_key_right {
compatible = "zmk,boot-magic-combo";
combo-positions = <11>;
jump-to-bootloader;
status = "disabled";
};
...
};
```
**shield.keymap**
```c
// Uncomment this block if using the 5-column layout
// / {
// chosen {
// zmk,matrix_transform = &five_column_transform;
// };
// bootloader_key_right {
// combo-positions = <9>;
// };
// };
```
## Startup Timeout
By default, the keyboard processes boot magic combos for 500 ms. You can change this timeout with `CONFIG_ZMK_BOOT_MAGIC_COMBO_TIMEOUT_MS` if it isn't reliably triggering, for example if you have some board-specific initialization code which takes a while.
To change the value for a new board or shield, set this option in your `Kconfig.defconfig` file:
```
config ZMK_BOOT_MAGIC_COMBO_TIMEOUT_MS
default 1000
```
You can also set it from your keyboard's `.conf` file in a user config repo:
```ini
CONFIG_ZMK_BOOT_MAGIC_COMBO_TIMEOUT_MS=1000
```