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

feat(behaviors): Add mod-morph keep-mods

Browse Source 
* Update docs for mod-morph
* Add unit tests for mod-morph
* Add keep-mods to DT binding

Co-authored-by: Martin Aumüller <aumuell@reserv.at>
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
This commit is contained in:
Robert U
2022-10-14 21:40:28 -04:00
committed by GitHub
parent 18b8b9b3a5
commit ef2e6e9156
28 changed files with 425 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
app/tests/mod-morph/1-no-morph/events.patterns Normal file
View File

@@ -0,0 +1,8 @@
s/.*hid_listener_keycode_pressed.*keycode/pressed: keycode/p
s/.*hid_listener_keycode_released.*keycode/released: keycode/p
s/.*hid_register_mod.*Modifiers set to /reg explicit: Modifiers set to /p
s/.*hid_unregister_mod.*Modifiers set to /unreg explicit: Modifiers set to /p
s/.*hid_implicit_modifiers_press.*Modifiers set to /reg implicit: Modifiers set to /p
s/.*hid_implicit_modifiers_release.*Modifiers set to /unreg implicit: Modifiers set to /p
s/.*hid_masked_modifiers_set.*Modifiers set to /mask mods: Modifiers set to /p
s/.*hid_masked_modifiers_clear.*Modifiers set to /unmask mods: Modifiers set to /p

5
app/tests/mod-morph/1-no-morph/keycode_events.snapshot Normal file
View File

@@ -0,0 +1,5 @@
pressed: keycode 0x04 implicit_mods 0x00 explicit_mods 0x00
reg implicit: Modifiers set to 0x00
released: keycode 0x04 implicit_mods 0x00 explicit_mods 0x00
unreg implicit: Modifiers set to 0x00
unmask mods: Modifiers set to 0x00

11
app/tests/mod-morph/1-no-morph/native_posix_64.keymap Normal file
View File

@@ -0,0 +1,11 @@
#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,1,10)
ZMK_MOCK_RELEASE(0,1,10)
>;
};

8
app/tests/mod-morph/2a-masked-morph/events.patterns Normal file
View File

@@ -0,0 +1,8 @@
s/.*hid_listener_keycode_pressed.*keycode/pressed: keycode/p
s/.*hid_listener_keycode_released.*keycode/released: keycode/p
s/.*hid_register_mod.*Modifiers set to /reg explicit: Modifiers set to /p
s/.*hid_unregister_mod.*Modifiers set to /unreg explicit: Modifiers set to /p
s/.*hid_implicit_modifiers_press.*Modifiers set to /reg implicit: Modifiers set to /p
s/.*hid_implicit_modifiers_release.*Modifiers set to /unreg implicit: Modifiers set to /p
s/.*hid_masked_modifiers_set.*Modifiers set to /mask mods: Modifiers set to /p
s/.*hid_masked_modifiers_clear.*Modifiers set to /unmask mods: Modifiers set to /p

12
app/tests/mod-morph/2a-masked-morph/keycode_events.snapshot Normal file
View File

@@ -0,0 +1,12 @@
pressed: keycode 0xE1 implicit_mods 0x00 explicit_mods 0x00
reg explicit: Modifiers set to 0x02
reg implicit: Modifiers set to 0x02
mask mods: Modifiers set to 0x00
pressed: keycode 0x05 implicit_mods 0x00 explicit_mods 0x00
reg implicit: Modifiers set to 0x00
released: keycode 0x05 implicit_mods 0x00 explicit_mods 0x00
unreg implicit: Modifiers set to 0x00
unmask mods: Modifiers set to 0x02
released: keycode 0xE1 implicit_mods 0x00 explicit_mods 0x00
unreg explicit: Modifiers set to 0x00
unreg implicit: Modifiers set to 0x00

13
app/tests/mod-morph/2a-masked-morph/native_posix_64.keymap Normal file
View File

@@ -0,0 +1,13 @@
#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(1,0,10)
ZMK_MOCK_PRESS(0,1,10)
ZMK_MOCK_RELEASE(0,1,10)
ZMK_MOCK_RELEASE(1,0,10)
>;
};

8
app/tests/mod-morph/2b-masked-morph-implicit-overwrite/events.patterns Normal file
View File

@@ -0,0 +1,8 @@
s/.*hid_listener_keycode_pressed.*keycode/pressed: keycode/p
s/.*hid_listener_keycode_released.*keycode/released: keycode/p
s/.*hid_register_mod.*Modifiers set to /reg explicit: Modifiers set to /p
s/.*hid_unregister_mod.*Modifiers set to /unreg explicit: Modifiers set to /p
s/.*hid_implicit_modifiers_press.*Modifiers set to /reg implicit: Modifiers set to /p
s/.*hid_implicit_modifiers_release.*Modifiers set to /unreg implicit: Modifiers set to /p
s/.*hid_masked_modifiers_set.*Modifiers set to /mask mods: Modifiers set to /p
s/.*hid_masked_modifiers_clear.*Modifiers set to /unmask mods: Modifiers set to /p

12
app/tests/mod-morph/2b-masked-morph-implicit-overwrite/keycode_events.snapshot Normal file
View File

@@ -0,0 +1,12 @@
pressed: keycode 0xE1 implicit_mods 0x00 explicit_mods 0x00
reg explicit: Modifiers set to 0x02
reg implicit: Modifiers set to 0x02
mask mods: Modifiers set to 0x00
pressed: keycode 0x05 implicit_mods 0x02 explicit_mods 0x00
reg implicit: Modifiers set to 0x02
released: keycode 0x05 implicit_mods 0x02 explicit_mods 0x00
unreg implicit: Modifiers set to 0x00
unmask mods: Modifiers set to 0x02
released: keycode 0xE1 implicit_mods 0x00 explicit_mods 0x00
unreg explicit: Modifiers set to 0x00
unreg implicit: Modifiers set to 0x00

37
app/tests/mod-morph/2b-masked-morph-implicit-overwrite/native_posix_64.keymap Normal file
View File

@@ -0,0 +1,37 @@
#include <dt-bindings/zmk/keys.h>
#include <behaviors.dtsi>
#include <dt-bindings/zmk/kscan_mock.h>
/ {
behaviors {
mod_morph: mod_morph {
compatible = "zmk,behavior-mod-morph";
label = "MOD_MORPH_TEST";
#binding-cells = <0>;
bindings = <&kp A>, <&kp LS(B)>; // implict mod overwrite
mods = <(MOD_LSFT|MOD_RSFT)>;
};
};
keymap {
compatible = "zmk,keymap";
label ="Default keymap";
default_layer {
bindings = <
&kp LEFT_ALT &mod_morph
&kp LEFT_SHIFT &kp RIGHT_SHIFT
>;
};
};
};
&kscan {
events = <
ZMK_MOCK_PRESS(1,0,10)
ZMK_MOCK_PRESS(0,1,10)
ZMK_MOCK_RELEASE(0,1,10)
ZMK_MOCK_RELEASE(1,0,10)
>;
};

8
app/tests/mod-morph/2c-masked-morph-and-explicit-mods/events.patterns Normal file
View File

@@ -0,0 +1,8 @@
s/.*hid_listener_keycode_pressed.*keycode/pressed: keycode/p
s/.*hid_listener_keycode_released.*keycode/released: keycode/p
s/.*hid_register_mod.*Modifiers set to /reg explicit: Modifiers set to /p
s/.*hid_unregister_mod.*Modifiers set to /unreg explicit: Modifiers set to /p
s/.*hid_implicit_modifiers_press.*Modifiers set to /reg implicit: Modifiers set to /p
s/.*hid_implicit_modifiers_release.*Modifiers set to /unreg implicit: Modifiers set to /p
s/.*hid_masked_modifiers_set.*Modifiers set to /mask mods: Modifiers set to /p
s/.*hid_masked_modifiers_clear.*Modifiers set to /unmask mods: Modifiers set to /p

18
app/tests/mod-morph/2c-masked-morph-and-explicit-mods/keycode_events.snapshot Normal file
View File

@@ -0,0 +1,18 @@
pressed: keycode 0xE2 implicit_mods 0x00 explicit_mods 0x00
reg explicit: Modifiers set to 0x04
reg implicit: Modifiers set to 0x04
pressed: keycode 0xE1 implicit_mods 0x00 explicit_mods 0x00
reg explicit: Modifiers set to 0x06
reg implicit: Modifiers set to 0x06
mask mods: Modifiers set to 0x04
pressed: keycode 0x05 implicit_mods 0x00 explicit_mods 0x00
reg implicit: Modifiers set to 0x04
released: keycode 0x05 implicit_mods 0x00 explicit_mods 0x00
unreg implicit: Modifiers set to 0x04
unmask mods: Modifiers set to 0x06
released: keycode 0xE1 implicit_mods 0x00 explicit_mods 0x00
unreg explicit: Modifiers set to 0x04
unreg implicit: Modifiers set to 0x04
released: keycode 0xE2 implicit_mods 0x00 explicit_mods 0x00
unreg explicit: Modifiers set to 0x00
unreg implicit: Modifiers set to 0x00

15
app/tests/mod-morph/2c-masked-morph-and-explicit-mods/native_posix_64.keymap Normal file
View File

@@ -0,0 +1,15 @@
#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_PRESS(1,0,10)
ZMK_MOCK_PRESS(0,1,10)
ZMK_MOCK_RELEASE(0,1,10)
ZMK_MOCK_RELEASE(1,0,10)
ZMK_MOCK_RELEASE(0,0,10)
>;
};

8
app/tests/mod-morph/2d-masked-morph-into-hold-tap-tap/events.patterns Normal file
View File

@@ -0,0 +1,8 @@
s/.*hid_listener_keycode_pressed.*keycode/pressed: keycode/p
s/.*hid_listener_keycode_released.*keycode/released: keycode/p
s/.*hid_register_mod.*Modifiers set to /reg explicit: Modifiers set to /p
s/.*hid_unregister_mod.*Modifiers set to /unreg explicit: Modifiers set to /p
s/.*hid_implicit_modifiers_press.*Modifiers set to /reg implicit: Modifiers set to /p
s/.*hid_implicit_modifiers_release.*Modifiers set to /unreg implicit: Modifiers set to /p
s/.*hid_masked_modifiers_set.*Modifiers set to /mask mods: Modifiers set to /p
s/.*hid_masked_modifiers_clear.*Modifiers set to /unmask mods: Modifiers set to /p

12
app/tests/mod-morph/2d-masked-morph-into-hold-tap-tap/keycode_events.snapshot Normal file
View File

@@ -0,0 +1,12 @@
pressed: keycode 0xE1 implicit_mods 0x00 explicit_mods 0x00
reg explicit: Modifiers set to 0x02
reg implicit: Modifiers set to 0x02
mask mods: Modifiers set to 0x00
pressed: keycode 0x05 implicit_mods 0x00 explicit_mods 0x00
reg implicit: Modifiers set to 0x00
released: keycode 0x05 implicit_mods 0x00 explicit_mods 0x00
unreg implicit: Modifiers set to 0x00
unmask mods: Modifiers set to 0x02
released: keycode 0xE1 implicit_mods 0x00 explicit_mods 0x00
unreg explicit: Modifiers set to 0x00
unreg implicit: Modifiers set to 0x00

45
app/tests/mod-morph/2d-masked-morph-into-hold-tap-tap/native_posix_64.keymap Normal file
View File

@@ -0,0 +1,45 @@
#include <dt-bindings/zmk/keys.h>
#include <behaviors.dtsi>
#include <dt-bindings/zmk/kscan_mock.h>
&kscan {
events = <
/* Shift + tap &mod_morph --> expect B (but get Shift + B) */
ZMK_MOCK_PRESS(0,0,10)
ZMK_MOCK_PRESS(0,1,10)
ZMK_MOCK_RELEASE(0,1,10)
ZMK_MOCK_RELEASE(0,0,10)
>;
};
/ {
behaviors {
mod_morph: mod_morph {
compatible = "zmk,behavior-mod-morph";
label = "MOD_MORPH_TEST";
#binding-cells = <0>;
bindings = <&kp A>, <&lt 1 B>;
mods = <(MOD_LSFT|MOD_RSFT)>;
};
};
keymap {
compatible = "zmk,keymap";
label ="Default keymap";
default_layer {
bindings = <
&kp LEFT_SHIFT &mod_morph
&kp C &none
>;
};
second_layer {
bindings = <
&trans &trans
&kp D &trans
>;
};
};
};

8
app/tests/mod-morph/2e-masked-morph-into-hold-tap-hold/events.patterns Normal file
View File

@@ -0,0 +1,8 @@
s/.*hid_listener_keycode_pressed.*keycode/pressed: keycode/p
s/.*hid_listener_keycode_released.*keycode/released: keycode/p
s/.*hid_register_mod.*Modifiers set to /reg explicit: Modifiers set to /p
s/.*hid_unregister_mod.*Modifiers set to /unreg explicit: Modifiers set to /p
s/.*hid_implicit_modifiers_press.*Modifiers set to /reg implicit: Modifiers set to /p
s/.*hid_implicit_modifiers_release.*Modifiers set to /unreg implicit: Modifiers set to /p
s/.*hid_masked_modifiers_set.*Modifiers set to /mask mods: Modifiers set to /p
s/.*hid_masked_modifiers_clear.*Modifiers set to /unmask mods: Modifiers set to /p

12
app/tests/mod-morph/2e-masked-morph-into-hold-tap-hold/keycode_events.snapshot Normal file
View File

@@ -0,0 +1,12 @@
pressed: keycode 0xE1 implicit_mods 0x00 explicit_mods 0x00
reg explicit: Modifiers set to 0x02
reg implicit: Modifiers set to 0x02
mask mods: Modifiers set to 0x00
pressed: keycode 0x07 implicit_mods 0x00 explicit_mods 0x00
reg implicit: Modifiers set to 0x00
released: keycode 0x07 implicit_mods 0x00 explicit_mods 0x00
unreg implicit: Modifiers set to 0x00
unmask mods: Modifiers set to 0x02
released: keycode 0xE1 implicit_mods 0x00 explicit_mods 0x00
unreg explicit: Modifiers set to 0x00
unreg implicit: Modifiers set to 0x00

47
app/tests/mod-morph/2e-masked-morph-into-hold-tap-hold/native_posix_64.keymap Normal file
View File

@@ -0,0 +1,47 @@
#include <dt-bindings/zmk/keys.h>
#include <behaviors.dtsi>
#include <dt-bindings/zmk/kscan_mock.h>
&kscan {
events = <
/* Shift + hold &mod_morph --> expect and get D (no shift) */
ZMK_MOCK_PRESS(0,0,10)
ZMK_MOCK_PRESS(0,1,200)
ZMK_MOCK_PRESS(1,0,10)
ZMK_MOCK_RELEASE(1,0,10)
ZMK_MOCK_RELEASE(0,1,10)
ZMK_MOCK_RELEASE(0,0,10)
>;
};
/ {
behaviors {
mod_morph: mod_morph {
compatible = "zmk,behavior-mod-morph";
label = "MOD_MORPH_TEST";
#binding-cells = <0>;
bindings = <&kp A>, <&lt 1 B>;
mods = <(MOD_LSFT|MOD_RSFT)>;
};
};
keymap {
compatible = "zmk,keymap";
label ="Default keymap";
default_layer {
bindings = <
&kp LEFT_SHIFT &mod_morph
&kp C &none
>;
};
second_layer {
bindings = <
&trans &trans
&kp D &trans
>;
};
};
};

8
app/tests/mod-morph/3-unmasked-morph/events.patterns Normal file
View File

@@ -0,0 +1,8 @@
s/.*hid_listener_keycode_pressed.*keycode/pressed: keycode/p
s/.*hid_listener_keycode_released.*keycode/released: keycode/p
s/.*hid_register_mod.*Modifiers set to /reg explicit: Modifiers set to /p
s/.*hid_unregister_mod.*Modifiers set to /unreg explicit: Modifiers set to /p
s/.*hid_implicit_modifiers_press.*Modifiers set to /reg implicit: Modifiers set to /p
s/.*hid_implicit_modifiers_release.*Modifiers set to /unreg implicit: Modifiers set to /p
s/.*hid_masked_modifiers_set.*Modifiers set to /mask mods: Modifiers set to /p
s/.*hid_masked_modifiers_clear.*Modifiers set to /unmask mods: Modifiers set to /p

12
app/tests/mod-morph/3-unmasked-morph/keycode_events.snapshot Normal file
View File

@@ -0,0 +1,12 @@
pressed: keycode 0xE1 implicit_mods 0x00 explicit_mods 0x00
reg explicit: Modifiers set to 0x02
reg implicit: Modifiers set to 0x02
mask mods: Modifiers set to 0x02
pressed: keycode 0x05 implicit_mods 0x00 explicit_mods 0x00
reg implicit: Modifiers set to 0x02
released: keycode 0x05 implicit_mods 0x00 explicit_mods 0x00
unreg implicit: Modifiers set to 0x02
unmask mods: Modifiers set to 0x02
released: keycode 0xE1 implicit_mods 0x00 explicit_mods 0x00
unreg explicit: Modifiers set to 0x00
unreg implicit: Modifiers set to 0x00

37
app/tests/mod-morph/3-unmasked-morph/native_posix_64.keymap Normal file
View File

@@ -0,0 +1,37 @@
#include <dt-bindings/zmk/keys.h>
#include <behaviors.dtsi>
#include <dt-bindings/zmk/kscan_mock.h>
/ {
behaviors {
mod_morph: mod_morph {
compatible = "zmk,behavior-mod-morph";
label = "MOD_MORPH_TEST";
#binding-cells = <0>;
bindings = <&kp A>, <&kp B>;
mods = <(MOD_LSFT|MOD_RSFT)>;
keep-mods = <(MOD_LSFT|MOD_RSFT)>; // no masking
};
};
keymap {
compatible = "zmk,keymap";
label ="Default keymap";
default_layer {
bindings = <
&kp LEFT_ALT &mod_morph
&kp LEFT_SHIFT &kp RIGHT_SHIFT
>;
};
};
};
&kscan {
events = <
ZMK_MOCK_PRESS(1,0,10)
ZMK_MOCK_PRESS(0,1,10)
ZMK_MOCK_RELEASE(0,1,10)
ZMK_MOCK_RELEASE(1,0,10)
>;
};

23
app/tests/mod-morph/behavior_keymap.dtsi Normal file
View File

@@ -0,0 +1,23 @@
/ {
behaviors {
mod_morph: mod_morph {
compatible = "zmk,behavior-mod-morph";
label = "MOD_MORPH_TEST";
#binding-cells = <0>;
bindings = <&kp A>, <&kp B>;
mods = <(MOD_LSFT|MOD_RSFT)>;
};
};
keymap {
compatible = "zmk,keymap";
label ="Default keymap";
default_layer {
bindings = <
&kp LEFT_ALT &mod_morph
&kp LEFT_SHIFT &kp RIGHT_SHIFT
>;
};
};
};

2
app/tests/modifiers/mixed/kp-lctl-dn-mod-dn-lctl-up-mod-up/keycode_events.snapshot
View File

@@ -7,7 +7,7 @@ mods: Modifiers set to 0x03
released: usage_page 0x07 keycode 0xE0 implicit_mods 0x00 explicit_mods 0x00
unreg: Modifier 0 count: 0
unreg: Modifier 0 released
unreg: Modifiers set to 0x00
unreg: Modifiers set to 0x02
mods: Modifiers set to 0x00
released: usage_page 0x07 keycode 0x05 implicit_mods 0x02 explicit_mods 0x00
mods: Modifiers set to 0x00