Jacob/zmk
1
0
Fork 0
forked from kofal.net/zmk
Code Pull Requests Activity

feat: Allow layer behaviors to "lock" layers on (#2717)

Browse Source 
* refactor(core)!: Allow layer behaviors to "lock" layers on

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>

* docs: Added documentation note on locking layers

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>

---------

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
This commit is contained in:
Nicolas Munnich
2025-11-14 22:13:35 +00:00
committed by GitHub
parent f9be3ed9c0
commit 5138c6fb14
34 changed files with 433 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
app/tests/conditional-layer/locked-layers-2/events.patterns Normal file
View File

@@ -0,0 +1,4 @@
s/.*hid_listener_keycode/kp/p
s/.*mo_keymap_binding/mo/p
s/.*tog_keymap_binding/tog/p
s/.*conditional_layer/cl/p

17
app/tests/conditional-layer/locked-layers-2/keycode_events.snapshot Normal file
View File

@@ -0,0 +1,17 @@
kp_pressed: usage_page 0x07 keycode 0x04 implicit_mods 0x00 explicit_mods 0x00
kp_released: usage_page 0x07 keycode 0x04 implicit_mods 0x00 explicit_mods 0x00
tog_pressed: position 2 layer 1
tog_released: position 2 layer 1
kp_pressed: usage_page 0x07 keycode 0x05 implicit_mods 0x00 explicit_mods 0x00
kp_released: usage_page 0x07 keycode 0x05 implicit_mods 0x00 explicit_mods 0x00
mo_pressed: position 3 layer 2
cl_activate: layer 3
kp_pressed: usage_page 0x07 keycode 0x07 implicit_mods 0x00 explicit_mods 0x00
kp_released: usage_page 0x07 keycode 0x07 implicit_mods 0x00 explicit_mods 0x00
tog_pressed: position 1 layer 3
tog_released: position 1 layer 3
kp_pressed: usage_page 0x07 keycode 0x07 implicit_mods 0x00 explicit_mods 0x00
kp_released: usage_page 0x07 keycode 0x07 implicit_mods 0x00 explicit_mods 0x00
mo_released: position 3 layer 2
kp_pressed: usage_page 0x07 keycode 0x07 implicit_mods 0x00 explicit_mods 0x00
kp_released: usage_page 0x07 keycode 0x07 implicit_mods 0x00 explicit_mods 0x00

66
app/tests/conditional-layer/locked-layers-2/native_posix_64.keymap Normal file
View File

@@ -0,0 +1,66 @@
#include <behaviors.dtsi>
#include <dt-bindings/zmk/keys.h>
#include <dt-bindings/zmk/kscan_mock.h>
&tog {
toggle-mode = "on";
};
/ {
conditional_layers {
compatible = "zmk,conditional-layers";
tri_layer {
if-layers = <1 2>;
then-layer = <3>;
};
};
keymap {
compatible = "zmk,keymap";
default_layer {
bindings = <
&kp A &tog 3
&tog 1 &mo 2
>;
};
layer_1 {
bindings = <
&kp B &trans
&trans &trans
>;
};
layer_2 {
bindings = <
&kp C &trans
&trans &trans
>;
};
layer_3 {
bindings = <
&kp D &trans
&trans &trans
>;
};
};
};
&kscan {
events = <
ZMK_MOCK_PRESS(0,0,10)
ZMK_MOCK_RELEASE(0,0,10)
ZMK_MOCK_PRESS(1,0,10)
ZMK_MOCK_RELEASE(1,0,10)
ZMK_MOCK_PRESS(0,0,10)
ZMK_MOCK_RELEASE(0,0,10)
ZMK_MOCK_PRESS(1,1,10)
ZMK_MOCK_PRESS(0,0,10)
ZMK_MOCK_RELEASE(0,0,10)
ZMK_MOCK_PRESS(0,1,10)
ZMK_MOCK_RELEASE(0,1,10)
ZMK_MOCK_PRESS(0,0,10)
ZMK_MOCK_RELEASE(0,0,10)
ZMK_MOCK_RELEASE(1,1,10)
ZMK_MOCK_PRESS(0,0,10)
ZMK_MOCK_RELEASE(0,0,10)
>;
};

4
app/tests/conditional-layer/locked-layers/events.patterns Normal file
View File

@@ -0,0 +1,4 @@
s/.*hid_listener_keycode/kp/p
s/.*mo_keymap_binding/mo/p
s/.*tog_keymap_binding/tog/p
s/.*conditional_layer/cl/p

20
app/tests/conditional-layer/locked-layers/keycode_events.snapshot Normal file
View File

@@ -0,0 +1,20 @@
kp_pressed: usage_page 0x07 keycode 0x04 implicit_mods 0x00 explicit_mods 0x00
kp_released: usage_page 0x07 keycode 0x04 implicit_mods 0x00 explicit_mods 0x00
tog_pressed: position 2 layer 1
tog_released: position 2 layer 1
kp_pressed: usage_page 0x07 keycode 0x05 implicit_mods 0x00 explicit_mods 0x00
kp_released: usage_page 0x07 keycode 0x05 implicit_mods 0x00 explicit_mods 0x00
tog_pressed: position 3 layer 2
cl_activate: layer 3
tog_released: position 3 layer 2
kp_pressed: usage_page 0x07 keycode 0x07 implicit_mods 0x00 explicit_mods 0x00
kp_released: usage_page 0x07 keycode 0x07 implicit_mods 0x00 explicit_mods 0x00
mo_pressed: position 1 layer 3
mo_released: position 1 layer 3
kp_pressed: usage_page 0x07 keycode 0x07 implicit_mods 0x00 explicit_mods 0x00
kp_released: usage_page 0x07 keycode 0x07 implicit_mods 0x00 explicit_mods 0x00
tog_pressed: position 2 layer 1
cl_deactivate: layer 3
tog_released: position 2 layer 1
kp_pressed: usage_page 0x07 keycode 0x06 implicit_mods 0x00 explicit_mods 0x00
kp_released: usage_page 0x07 keycode 0x06 implicit_mods 0x00 explicit_mods 0x00

64
app/tests/conditional-layer/locked-layers/native_posix_64.keymap Normal file
View File

@@ -0,0 +1,64 @@
#include <behaviors.dtsi>
#include <dt-bindings/zmk/keys.h>
#include <dt-bindings/zmk/kscan_mock.h>
/ {
conditional_layers {
compatible = "zmk,conditional-layers";
tri_layer {
if-layers = <1 2>;
then-layer = <3>;
};
};
keymap {
compatible = "zmk,keymap";
default_layer {
bindings = <
&kp A &mo 3
&tog 1 &tog 2
>;
};
layer_1 {
bindings = <
&kp B &trans
&trans &trans
>;
};
layer_2 {
bindings = <
&kp C &trans
&trans &trans
>;
};
layer_3 {
bindings = <
&kp D &trans
&trans &trans
>;
};
};
};
&kscan {
events = <
ZMK_MOCK_PRESS(0,0,10)
ZMK_MOCK_RELEASE(0,0,10)
ZMK_MOCK_PRESS(1,0,10)
ZMK_MOCK_RELEASE(1,0,10)
ZMK_MOCK_PRESS(0,0,10)
ZMK_MOCK_RELEASE(0,0,10)
ZMK_MOCK_PRESS(1,1,10)
ZMK_MOCK_RELEASE(1,1,10)
ZMK_MOCK_PRESS(0,0,10)
ZMK_MOCK_RELEASE(0,0,10)
ZMK_MOCK_PRESS(0,1,10)
ZMK_MOCK_RELEASE(0,1,10)
ZMK_MOCK_PRESS(0,0,10)
ZMK_MOCK_RELEASE(0,0,10)
ZMK_MOCK_PRESS(1,0,10)
ZMK_MOCK_RELEASE(1,0,10)
ZMK_MOCK_PRESS(0,0,10)
ZMK_MOCK_RELEASE(0,0,10)
>;
};

2
app/tests/encoders/layers-1/keycode_events.snapshot
View File

@@ -1,3 +1,3 @@
layer_changed: layer 2 state 1
layer_changed: layer 2 state 1 locked 1
pressed: usage_page 0x07 keycode 0x06 implicit_mods 0x00 explicit_mods 0x00
released: usage_page 0x07 keycode 0x06 implicit_mods 0x00 explicit_mods 0x00

4
app/tests/encoders/layers-2/keycode_events.snapshot
View File

@@ -1,4 +1,4 @@
layer_changed: layer 1 state 1
layer_changed: layer 2 state 1
layer_changed: layer 1 state 1 locked 1
layer_changed: layer 2 state 1 locked 1
pressed: usage_page 0x07 keycode 0x06 implicit_mods 0x00 explicit_mods 0x00
released: usage_page 0x07 keycode 0x06 implicit_mods 0x00 explicit_mods 0x00

4
app/tests/pointing/mouse-move/processors/temp_layer/1-deactivate-layer-timeout/keycode_events.snapshot
View File

@@ -1,4 +1,4 @@
layer_changed: layer 1 state 1
layer_changed: layer 1 state 1 locked 0
Dispatching handle_layer_state_changed
movement_set: Mouse movement set to -1/0
scroll_set: Mouse scroll set to 0/0
@@ -12,5 +12,5 @@ movement_set: Mouse movement set to 0/0
movement_set: Mouse movement set to -3/0
scroll_set: Mouse scroll set to 0/0
movement_set: Mouse movement set to 0/0
layer_changed: layer 1 state 0
layer_changed: layer 1 state 0 locked 0
Dispatching handle_layer_state_changed

4
app/tests/pointing/mouse-move/processors/temp_layer/2a-deactivate-layer-position-trigger/keycode_events.snapshot
View File

@@ -1,6 +1,6 @@
Dispatching handle_position_state_changed
Position excluded, continuing
layer_changed: layer 1 state 1
layer_changed: layer 1 state 1 locked 0
Dispatching handle_layer_state_changed
movement_set: Mouse movement set to -1/0
scroll_set: Mouse scroll set to 0/0
@@ -17,7 +17,7 @@ movement_set: Mouse movement set to 0/0
Dispatching handle_position_state_changed
Dispatching handle_position_state_changed
Position not excluded, deactivating layer
layer_changed: layer 1 state 0
layer_changed: layer 1 state 0 locked 0
Dispatching handle_layer_state_changed
Position excluded, continuing
Dispatching handle_position_state_changed

2
app/tests/pointing/mouse-move/processors/temp_layer/2b-deactivate-layer-position-not-trigger/keycode_events.snapshot
View File

@@ -1,6 +1,6 @@
Dispatching handle_position_state_changed
Position excluded, continuing
layer_changed: layer 1 state 1
layer_changed: layer 1 state 1 locked 0
Dispatching handle_layer_state_changed
movement_set: Mouse movement set to -1/0
scroll_set: Mouse scroll set to 0/0

4
app/tests/pointing/mouse-move/processors/temp_layer/3-require-prior-idle-ms/keycode_events.snapshot
View File

@@ -27,7 +27,7 @@ movement_set: Mouse movement set to 0/0
movement_set: Mouse movement set to -1/0
scroll_set: Mouse scroll set to 0/0
movement_set: Mouse movement set to 0/0
layer_changed: layer 1 state 1
layer_changed: layer 1 state 1 locked 0
Dispatching handle_layer_state_changed
movement_set: Mouse movement set to -2/0
scroll_set: Mouse scroll set to 0/0
@@ -146,5 +146,5 @@ movement_set: Mouse movement set to 0/0
movement_set: Mouse movement set to -9/0
scroll_set: Mouse scroll set to 0/0
movement_set: Mouse movement set to 0/0
layer_changed: layer 1 state 0
layer_changed: layer 1 state 0 locked 0
Dispatching handle_layer_state_changed

6
app/tests/pointing/mouse-move/processors/temp_layer/4-deactivated-layer-externally/keycode_events.snapshot
View File

@@ -1,4 +1,4 @@
layer_changed: layer 1 state 1
layer_changed: layer 1 state 1 locked 0
Dispatching handle_layer_state_changed
movement_set: Mouse movement set to -1/0
scroll_set: Mouse scroll set to 0/0
@@ -12,10 +12,10 @@ movement_set: Mouse movement set to 0/0
movement_set: Mouse movement set to -3/0
scroll_set: Mouse scroll set to 0/0
movement_set: Mouse movement set to 0/0
layer_changed: layer 1 state 0
layer_changed: layer 1 state 0 locked 0
Dispatching handle_layer_state_changed
Deactivating layer that was activated by this processor
layer_changed: layer 1 state 1
layer_changed: layer 1 state 1 locked 0
Dispatching handle_layer_state_changed
movement_set: Mouse movement set to -1/0
scroll_set: Mouse scroll set to 0/0

8
app/tests/to-layer/normal/keycode_events.snapshot
View File

@@ -1,18 +1,18 @@
kp_pressed: usage_page 0x07 keycode 0x16 implicit_mods 0x00 explicit_mods 0x00
kp_released: usage_page 0x07 keycode 0x16 implicit_mods 0x00 explicit_mods 0x00
to_pressed: position 1 layer 1
layer_changed: layer 1 state 1
layer_changed: layer 1 state 1 locked 1
to_released: position 1 layer 1
kp_pressed: usage_page 0x07 keycode 0x0E implicit_mods 0x00 explicit_mods 0x00
kp_released: usage_page 0x07 keycode 0x0E implicit_mods 0x00 explicit_mods 0x00
to_pressed: position 0 layer 0
layer_changed: layer 1 state 0
layer_changed: layer 0 state 1
layer_changed: layer 1 state 0 locked 1
layer_changed: layer 0 state 1 locked 1
to_released: position 0 layer 0
kp_pressed: usage_page 0x07 keycode 0x16 implicit_mods 0x00 explicit_mods 0x00
kp_released: usage_page 0x07 keycode 0x16 implicit_mods 0x00 explicit_mods 0x00
to_pressed: position 0 layer 0
to_released: position 0 layer 0
to_pressed: position 1 layer 1
layer_changed: layer 1 state 1
layer_changed: layer 1 state 1 locked 1
to_released: position 1 layer 1

16
app/tests/toggle-layer/behavior_keymap.dtsi
View File

@@ -3,13 +3,23 @@
#include <dt-bindings/zmk/kscan_mock.h>
/ {
behaviors {
tog_off: toggle_layer_off_only {
compatible = "zmk,behavior-toggle-layer";
#binding-cells = <1>;
display-name = "Toggle Layer Off";
toggle-mode = "off";
locking;
};
};
keymap {
compatible = "zmk,keymap";
default_layer {
bindings = <
&kp B &tog 1
&kp D &to 1>;
&mo 2 &to 1>;
};
lower_layer {
@@ -20,8 +30,8 @@
raise_layer {
bindings = <
&kp W &kp U
&kp X &kp M>;
&kp W &tog 2
&tog_off 2 &mo 2>;
};
};
};

3
app/tests/toggle-layer/locking/events.patterns Normal file
View File

@@ -0,0 +1,3 @@
s/.*hid_listener_keycode/kp/p
s/.*tog_keymap_binding/tog/p
s/.*mo_keymap_binding/mo/p

16
app/tests/toggle-layer/locking/keycode_events.snapshot Normal file
View File

@@ -0,0 +1,16 @@
kp_pressed: usage_page 0x07 keycode 0x05 implicit_mods 0x00 explicit_mods 0x00
kp_released: usage_page 0x07 keycode 0x05 implicit_mods 0x00 explicit_mods 0x00
mo_pressed: position 2 layer 2
tog_pressed: position 1 layer 2
tog_released: position 1 layer 2
mo_released: position 2 layer 2
kp_pressed: usage_page 0x07 keycode 0x1A implicit_mods 0x00 explicit_mods 0x00
kp_released: usage_page 0x07 keycode 0x1A implicit_mods 0x00 explicit_mods 0x00
mo_pressed: position 3 layer 2
mo_released: position 3 layer 2
kp_pressed: usage_page 0x07 keycode 0x1A implicit_mods 0x00 explicit_mods 0x00
kp_released: usage_page 0x07 keycode 0x1A implicit_mods 0x00 explicit_mods 0x00
tog_pressed: position 1 layer 2
tog_released: position 1 layer 2
kp_pressed: usage_page 0x07 keycode 0x05 implicit_mods 0x00 explicit_mods 0x00
kp_released: usage_page 0x07 keycode 0x05 implicit_mods 0x00 explicit_mods 0x00

25
app/tests/toggle-layer/locking/native_posix_64.keymap Normal file
View File

@@ -0,0 +1,25 @@
#include <dt-bindings/zmk/keys.h>
#include <behaviors.dtsi>
#include <dt-bindings/zmk/kscan_mock.h>
#include "../behavior_keymap.dtsi"
&kscan {
events = <
ZMK_MOCK_PRESS(0,0,10)
ZMK_MOCK_RELEASE(0,0,10)
ZMK_MOCK_PRESS(1,0,10)
ZMK_MOCK_PRESS(0,1,10)
ZMK_MOCK_RELEASE(0,1,10)
ZMK_MOCK_RELEASE(1,0,10)
ZMK_MOCK_PRESS(0,0,10)
ZMK_MOCK_RELEASE(0,0,10)
ZMK_MOCK_PRESS(1,1,10)
ZMK_MOCK_RELEASE(1,1,10)
ZMK_MOCK_PRESS(0,0,10)
ZMK_MOCK_RELEASE(0,0,10)
ZMK_MOCK_PRESS(0,1,10)
ZMK_MOCK_RELEASE(0,1,10)
ZMK_MOCK_PRESS(0,0,10)
ZMK_MOCK_RELEASE(0,0,10)
>;
};

4
app/tests/toggle-layer/toggle-mode-off/keycode_events.snapshot
View File

@@ -3,12 +3,12 @@ tog_released: position 1 layer 1
kp_pressed: usage_page 0x07 keycode 0x05 implicit_mods 0x00 explicit_mods 0x00
kp_released: usage_page 0x07 keycode 0x05 implicit_mods 0x00 explicit_mods 0x00
to_pressed: position 3 layer 1
layer_changed: layer 1 state 1
layer_changed: layer 1 state 1 locked 1
to_released: position 3 layer 1
kp_pressed: usage_page 0x0C keycode 0xB5 implicit_mods 0x00 explicit_mods 0x00
kp_released: usage_page 0x0C keycode 0xB5 implicit_mods 0x00 explicit_mods 0x00
tog_pressed: position 1 layer 1
layer_changed: layer 1 state 0
layer_changed: layer 1 state 0 locked 1
tog_released: position 1 layer 1
kp_pressed: usage_page 0x07 keycode 0x05 implicit_mods 0x00 explicit_mods 0x00
kp_released: usage_page 0x07 keycode 0x05 implicit_mods 0x00 explicit_mods 0x00