feat: Sticky keys behavior

zmkfirmware · Nov 6, 2020 · 252ff14 · 252ff14
1 parent a4dc92a
commit 252ff14
Show file tree

Hide file tree

Showing 32 changed files with 483 additions and 17 deletions.
diff --git a/app/CMakeLists.txt b/app/CMakeLists.txt
@@ -42,6 +42,7 @@ if (NOT CONFIG_ZMK_SPLIT_BLE_ROLE_PERIPHERAL)
   target_sources(app PRIVATE src/behaviors/behavior_key_press.c)
   target_sources(app PRIVATE src/behaviors/behavior_reset.c)
   target_sources(app PRIVATE src/behaviors/behavior_hold_tap.c)
+  target_sources(app PRIVATE src/behaviors/behavior_sticky_key.c)
   target_sources(app PRIVATE src/behaviors/behavior_momentary_layer.c)
   target_sources(app PRIVATE src/behaviors/behavior_outputs.c)
   target_sources(app PRIVATE src/behaviors/behavior_toggle_layer.c)

diff --git a/app/dts/behaviors.dtsi b/app/dts/behaviors.dtsi
@@ -3,6 +3,7 @@
 #include <behaviors/none.dtsi>
 #include <behaviors/mod_tap.dtsi>
 #include <behaviors/layer_tap.dtsi>
+#include <behaviors/sticky_key.dtsi>
 #include <behaviors/momentary_layer.dtsi>
 #include <behaviors/toggle_layer.dtsi>
 #include <behaviors/reset.dtsi>

diff --git a/app/dts/behaviors/sticky_key.dtsi b/app/dts/behaviors/sticky_key.dtsi
@@ -0,0 +1,20 @@
+/ {
+	behaviors {
+		sk: behavior_sticky_key {
+			compatible = "zmk,behavior-sticky-key";
+			label = "STICKY_KEY";
+			#binding-cells = <1>;
+			release-after-ms = <1000>;
+			bindings = <&kp>;
+		};
+		sl: behavior_sticky_layer {
+			compatible = "zmk,behavior-sticky-key";
+			label = "STICKY_LAYER";
+			#binding-cells = <1>;
+			release-after-ms = <1000>;
+			bindings = <&mo>;
+		};
+	};
+
+};
+
diff --git a/app/dts/bindings/behaviors/zmk,behavior-sticky-key.yaml b/app/dts/bindings/behaviors/zmk,behavior-sticky-key.yaml
@@ -0,0 +1,15 @@
+# Copyright (c) 2020 The ZMK Contributors
+# SPDX-License-Identifier: MIT
+
+description: One Shot behavior
+
+compatible: "zmk,behavior-sticky-key"
+
+include: one_param.yaml
+
+properties:
+  bindings:
+    type: phandles
+    required: true
+  release-after-ms:
+    type: int 
diff --git a/app/include/drivers/behavior.h b/app/include/drivers/behavior.h
@@ -23,7 +23,7 @@
 typedef int (*behavior_keymap_binding_callback_t)(struct zmk_behavior_binding *binding,
                                                   struct zmk_behavior_binding_event event);
 typedef int (*behavior_sensor_keymap_binding_callback_t)(struct zmk_behavior_binding *binding,
-                                                         struct device *sensor);
+                                                         struct device *sensor, s64_t timestamp);
 
 __subsystem struct behavior_driver_api {
     behavior_keymap_binding_callback_t binding_pressed;
@@ -92,19 +92,19 @@ static inline int z_impl_behavior_keymap_binding_released(struct zmk_behavior_bi
  * @retval Negative errno code if failure.
  */
 __syscall int behavior_sensor_keymap_binding_triggered(struct zmk_behavior_binding *binding,
-                                                       struct device *sensor);
+                                                       struct device *sensor, s64_t timestamp);
 
 static inline int
 z_impl_behavior_sensor_keymap_binding_triggered(struct zmk_behavior_binding *binding,
-                                                struct device *sensor) {
+                                                struct device *sensor, s64_t timestamp) {
     struct device *dev = device_get_binding(binding->behavior_dev);
     const struct behavior_driver_api *api = (const struct behavior_driver_api *)dev->driver_api;
 
     if (api->sensor_binding_triggered == NULL) {
         return -ENOTSUP;
     }
 
-    return api->sensor_binding_triggered(binding, sensor);
+    return api->sensor_binding_triggered(binding, sensor, timestamp);
 }
 
 /**

diff --git a/app/include/zmk/events/keycode-state-changed.h b/app/include/zmk/events/keycode-state-changed.h
@@ -18,12 +18,13 @@ struct keycode_state_changed {
     u32_t keycode;
     u8_t implicit_modifiers;
     bool state;
+    s64_t timestamp;
 };
 
 ZMK_EVENT_DECLARE(keycode_state_changed);
 
-static inline struct keycode_state_changed *keycode_state_changed_from_encoded(u32_t encoded,
-                                                                               bool pressed) {
+static inline struct keycode_state_changed *
+keycode_state_changed_from_encoded(u32_t encoded, bool pressed, s64_t timestamp) {
     u16_t page = HID_EXT_USAGE_PAGE(encoded) & 0xFF;
     u16_t id = HID_EXT_USAGE_ID(encoded);
     zmk_mod_flags implicit_mods = SELECT_MODS(encoded);
@@ -37,5 +38,6 @@ static inline struct keycode_state_changed *keycode_state_changed_from_encoded(u
     ev->keycode = id;
     ev->implicit_modifiers = implicit_mods;
     ev->state = pressed;
+    ev->timestamp = timestamp;
     return ev;
 }
diff --git a/app/src/behaviors/behavior_key_press.c b/app/src/behaviors/behavior_key_press.c
@@ -21,15 +21,15 @@ static int behavior_key_press_init(struct device *dev) { return 0; };
 static int on_keymap_binding_pressed(struct zmk_behavior_binding *binding,
                                      struct zmk_behavior_binding_event event) {
     LOG_DBG("position %d keycode 0x%02X", event.position, binding->param1);
-
-    return ZMK_EVENT_RAISE(keycode_state_changed_from_encoded(binding->param1, true));
+    return ZMK_EVENT_RAISE(
+        keycode_state_changed_from_encoded(binding->param1, true, event.timestamp));
 }
 
 static int on_keymap_binding_released(struct zmk_behavior_binding *binding,
                                       struct zmk_behavior_binding_event event) {
     LOG_DBG("position %d keycode 0x%02X", event.position, binding->param1);
-
-    return ZMK_EVENT_RAISE(keycode_state_changed_from_encoded(binding->param1, false));
+    return ZMK_EVENT_RAISE(
+        keycode_state_changed_from_encoded(binding->param1, false, event.timestamp));
 }
 
 static const struct behavior_driver_api behavior_key_press_driver_api = {

diff --git a/app/src/behaviors/behavior_sensor_rotate_key_press.c b/app/src/behaviors/behavior_sensor_rotate_key_press.c
@@ -18,8 +18,8 @@ LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL);
 
 static int behavior_sensor_rotate_key_press_init(struct device *dev) { return 0; };
 
-static int on_sensor_binding_triggered(struct zmk_behavior_binding *binding,
-                                       struct device *sensor) {
+static int on_sensor_binding_triggered(struct zmk_behavior_binding *binding, struct device *sensor,
+                                       s64_t timestamp) {
     struct sensor_value value;
     int err;
     u32_t keycode;
@@ -45,12 +45,12 @@ static int on_sensor_binding_triggered(struct zmk_behavior_binding *binding,
 
     LOG_DBG("SEND %d", keycode);
 
-    ZMK_EVENT_RAISE(keycode_state_changed_from_encoded(keycode, true));
+    ZMK_EVENT_RAISE(keycode_state_changed_from_encoded(keycode, true, timestamp));
 
     // TODO: Better way to do this?
     k_msleep(5);
 
-    return ZMK_EVENT_RAISE(keycode_state_changed_from_encoded(keycode, false));
+    return ZMK_EVENT_RAISE(keycode_state_changed_from_encoded(keycode, false, timestamp));
 }
 
 static const struct behavior_driver_api behavior_sensor_rotate_key_press_driver_api = {