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

Merge 722189718f into 8568d02b0b

This commit is contained in:
Nick Conway 2025-12-25 10:15:30 +06:00 committed by GitHub
parent 8568d02b0b 722189718f
commit b79eda899a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 89 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
app/dts/bindings/behaviors/zmk,behavior-hold-tap.yaml
View File

@ -43,6 +43,15 @@ properties:
type: boolean
retro-tap:
type: boolean
retro-tap-behavior:
type: string
default: ""
retro-tap-param1:
type: int
default: 0
retro-tap-param2:
type: int
default: 0
hold-trigger-key-positions:
type: array
required: false

55
app/src/behaviors/behavior_hold_tap.c
View File

@ -39,6 +39,7 @@ enum flavor {
enum status {
STATUS_UNDECIDED,
STATUS_TAP,
STATUS_RETRO_TAP,
STATUS_HOLD_INTERRUPT,
STATUS_HOLD_TIMER,
};
@ -62,6 +63,9 @@ struct behavior_hold_tap_config {
bool hold_while_undecided;
bool hold_while_undecided_linger;
bool retro_tap;
char *retro_tap_behavior_dev;
uint32_t retro_tap_param1;
uint32_t retro_tap_param2;
bool hold_trigger_on_release;
int32_t hold_trigger_key_positions_len;
int32_t hold_trigger_key_positions[];
@ -430,6 +434,21 @@ static int press_tap_binding(struct active_hold_tap *hold_tap) {
return zmk_behavior_invoke_binding(&binding, event, true);
}
static int press_retro_tap_binding(struct active_hold_tap *hold_tap) {
struct zmk_behavior_binding_event event = {
.position = hold_tap->position,
.timestamp = hold_tap->timestamp,
#if IS_ENABLED(CONFIG_ZMK_SPLIT)
.source = hold_tap->source,
#endif
};
struct zmk_behavior_binding binding = {.behavior_dev = hold_tap->config->retro_tap_behavior_dev,
.param1 = hold_tap->config->retro_tap_param1,
.param2 = hold_tap->config->retro_tap_param2};
return zmk_behavior_invoke_binding(&binding, event, true);
}
static int release_hold_binding(struct active_hold_tap *hold_tap) {
struct zmk_behavior_binding_event event = {
.position = hold_tap->position,
@ -458,6 +477,21 @@ static int release_tap_binding(struct active_hold_tap *hold_tap) {
return zmk_behavior_invoke_binding(&binding, event, false);
}
static int release_retro_tap_binding(struct active_hold_tap *hold_tap) {
struct zmk_behavior_binding_event event = {
.position = hold_tap->position,
.timestamp = hold_tap->timestamp,
#if IS_ENABLED(CONFIG_ZMK_SPLIT)
.source = hold_tap->source,
#endif
};
struct zmk_behavior_binding binding = {.behavior_dev = hold_tap->config->retro_tap_behavior_dev,
.param1 = hold_tap->config->retro_tap_param1,
.param2 = hold_tap->config->retro_tap_param2};
return zmk_behavior_invoke_binding(&binding, event, false);
}
static int press_binding(struct active_hold_tap *hold_tap) {
if (hold_tap->config->retro_tap && hold_tap->status == STATUS_HOLD_TIMER) {
return 0;
@ -470,6 +504,9 @@ static int press_binding(struct active_hold_tap *hold_tap) {
} else {
return press_hold_binding(hold_tap);
}
} else if (hold_tap->status == STATUS_RETRO_TAP) {
store_last_hold_tapped(hold_tap);
return 0;
} else {
if (hold_tap->config->hold_while_undecided &&
!hold_tap->config->hold_while_undecided_linger) {
@ -487,6 +524,13 @@ static int release_binding(struct active_hold_tap *hold_tap) {
if (hold_tap->status == STATUS_HOLD_TIMER || hold_tap->status == STATUS_HOLD_INTERRUPT) {
return release_hold_binding(hold_tap);
} else if (hold_tap->status == STATUS_RETRO_TAP) {
if (hold_tap->config->hold_while_undecided) {
release_hold_binding(hold_tap);
}
press_retro_tap_binding(hold_tap);
return release_retro_tap_binding(hold_tap);
} else {
return release_tap_binding(hold_tap);
}
@ -578,10 +622,16 @@ static void decide_retro_tap(struct active_hold_tap *hold_tap) {
if (!hold_tap->config->retro_tap) {
return;
}
if (hold_tap->status == STATUS_HOLD_TIMER) {
release_binding(hold_tap);
LOG_DBG("%d retro tap", hold_tap->position);
hold_tap->status = STATUS_TAP;
if (strcmp(hold_tap->config->retro_tap_behavior_dev, "") == 0) {
hold_tap->status = STATUS_TAP;
} else {
hold_tap->status = STATUS_RETRO_TAP;
LOG_DBG("%d RETRO TAP", hold_tap->position);
}
press_binding(hold_tap);
return;
}
@ -870,6 +920,9 @@ static int behavior_hold_tap_init(const struct device *dev) {
.hold_while_undecided = DT_INST_PROP(n, hold_while_undecided), \
.hold_while_undecided_linger = DT_INST_PROP(n, hold_while_undecided_linger), \
.retro_tap = DT_INST_PROP(n, retro_tap), \
.retro_tap_behavior_dev = DT_INST_PROP(n, retro_tap_behavior), \
.retro_tap_param1 = DT_INST_PROP(n, retro_tap_param1), \
.retro_tap_param2 = DT_INST_PROP(n, retro_tap_param2), \
.hold_trigger_on_release = DT_INST_PROP(n, hold_trigger_on_release), \
.hold_trigger_key_positions = DT_INST_PROP(n, hold_trigger_key_positions), \
.hold_trigger_key_positions_len = DT_INST_PROP_LEN(n, hold_trigger_key_positions), \

26
docs/docs/keymaps/behaviors/hold-tap.mdx
View File

@ -460,3 +460,29 @@ For example, if you press `&mt LEFT_SHIFT A` and then release it without pressin
retro-tap;
};
```
To define a behavior to use instead of the tap behavior, include `retro-tap-behavior`, `retro-tap-param1`, and/or `retro-tap-param2` in your hold-tap definition.
- `retro-tap-behavior` refers to the label string of the desired behavior. See below for a list of these label strings for built-in behaviors.
- `retro-tap-param1` refers to the first thing that comes after the behavior in your keymap. e.g. for `&mt LSHFT A`, LSHFT will be param1.
- `retro-tap-param2` refers to the second thing that comes after the behavior in your keymap. e.g. for `&mt LSHFT A`, A will be param2.
List of built-in behaviors and their corresponding label strings:
- &bl - "BCKLGHT"
- &bt - "BLUETOOTH"
- &caps_word - "CAPS_WORD"
- &ext_power - "EXTPOWER"
- &gresc - "GRAVE_ESCAPE"
- &kp - "KEY_PRESS"
- &key_repeat - "KEY_REPEAT"
- &none - "NONE"
- &out - "OUTPUTS"
- &reset - "RESET"
- &bootloader - "BOOTLOAD"
- &rgb_ug - "RGB_UG"
- &sk - "STICKY_KEY"
- &sl - "STICKY_LAYER"
- &to - "TO_LAYER"
- &tog - "TOGGLE_LAYER"
- &trans - "TRANS"