feat: Added optional flags to toggling behaviors allowing them to be …

…explicitly toggle on or toggle off.

app/dts/bindings/behaviors/zmk,behavior-key-toggle.yaml

@@ -6,3 +6,13 @@ description: Key toggle behavior
 compatible: "zmk,behavior-key-toggle"
 
 include: one_param.yaml
+
+properties:
+  toggle-mode:
+    type: string
+    required: false
+    default: "on-off"
+    enum:
+      - "on"
+      - "off"
+      - "on-off"

app/dts/bindings/behaviors/zmk,behavior-toggle-layer.yaml

@@ -6,3 +6,13 @@ description: Toggle Layer
 compatible: "zmk,behavior-toggle-layer"
 
 include: one_param.yaml
+
+properties:
+  toggle-mode:
+    type: string
+    required: false
+    default: "on-off"
+    enum:
+      - "on"
+      - "off"
+      - "on-off"

app/src/behaviors/behavior_key_toggle.c

@@ -17,18 +17,44 @@
 
 LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL);
 
+enum toggle_mode {
+    ON,
+    OFF,
+    ON_OFF,
+};
+
+struct behavior_key_toggle_config {
+    enum toggle_mode toggle_mode;
+};
+
 static int behavior_key_toggle_init(const 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);
     bool pressed = zmk_hid_is_pressed(binding->param1);
-    return raise_zmk_keycode_state_changed_from_encoded(binding->param1, !pressed, event.timestamp);
+    const struct behavior_key_toggle_config *cfg =
+        zmk_behavior_get_binding(binding->behavior_dev)->config;
+    switch (cfg->toggle_mode) {
+    case ON:
+        return !pressed ? raise_zmk_keycode_state_changed_from_encoded(binding->param1, true,
+                                                                       event.timestamp)
+                        : ZMK_BEHAVIOR_OPAQUE;
+    case OFF:
+        return pressed ? raise_zmk_keycode_state_changed_from_encoded(binding->param1, false,
+                                                                      event.timestamp)
+                       : ZMK_BEHAVIOR_OPAQUE;
+    case ON_OFF:
+        return raise_zmk_keycode_state_changed_from_encoded(binding->param1, !pressed,
+                                                            event.timestamp);
+    default:
+        return -ENOTSUP;
+    };
 }
 
 static int on_keymap_binding_released(struct zmk_behavior_binding *binding,
                                       struct zmk_behavior_binding_event event) {
-    return 0;
+    return ZMK_BEHAVIOR_OPAQUE;
 }
 
 #if IS_ENABLED(CONFIG_ZMK_BEHAVIOR_METADATA)
@@ -61,7 +87,11 @@ static const struct behavior_driver_api behavior_key_toggle_driver_api = {
 };
 
 #define KT_INST(n)                                                                                 \
-    BEHAVIOR_DT_INST_DEFINE(n, behavior_key_toggle_init, NULL, NULL, NULL, POST_KERNEL,            \
+    static const struct behavior_key_toggle_config behavior_key_toggle_config_##n = {              \
+        .toggle_mode = DT_ENUM_IDX(DT_DRV_INST(n), toggle_mode),                                   \
+    };                                                                                             \
+    BEHAVIOR_DT_INST_DEFINE(n, behavior_key_toggle_init, NULL, NULL,                               \
+                            &behavior_key_toggle_config_##n, POST_KERNEL,                          \
                             CONFIG_KERNEL_INIT_PRIORITY_DEFAULT, &behavior_key_toggle_driver_api);
 
 DT_INST_FOREACH_STATUS_OKAY(KT_INST)

app/src/behaviors/behavior_toggle_layer.c

@@ -17,22 +17,41 @@ LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL);
 
 #if DT_HAS_COMPAT_STATUS_OKAY(DT_DRV_COMPAT)
 
-struct behavior_tog_config {};
-struct behavior_tog_data {};
+enum toggle_mode {
+    ON,
+    OFF,
+    ON_OFF,
+};
 
-static int behavior_tog_init(const struct device *dev) { return 0; };
+struct behavior_toggle_layer_config {
+    enum toggle_mode toggle_mode;
+};
 
-static int tog_keymap_binding_pressed(struct zmk_behavior_binding *binding,
-                                      struct zmk_behavior_binding_event event) {
+static int behavior_toggle_layer_init(const 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 layer %d", event.position, binding->param1);
-    return zmk_keymap_layer_toggle(binding->param1);
+
+    const struct behavior_toggle_layer_config *cfg =
+        zmk_behavior_get_binding(binding->behavior_dev)->config;
+    switch (cfg->toggle_mode) {
+    case ON:
+        return zmk_keymap_layer_activate(binding->param1);
+    case OFF:
+        return zmk_keymap_layer_deactivate(binding->param1);
+    case ON_OFF:
+        return zmk_keymap_layer_toggle(binding->param1);
+    default:
+        return -ENOTSUP;
+    };
 }
 
-static int tog_keymap_binding_released(struct zmk_behavior_binding *binding,
-                                       struct zmk_behavior_binding_event event) {
+static int on_keymap_binding_released(struct zmk_behavior_binding *binding,
+                                      struct zmk_behavior_binding_event event) {
     LOG_DBG("position %d layer %d", event.position, binding->param1);
     return ZMK_BEHAVIOR_OPAQUE;
-}
+};
 
 #if IS_ENABLED(CONFIG_ZMK_BEHAVIOR_METADATA)
 
@@ -55,19 +74,22 @@ static const struct behavior_parameter_metadata metadata = {
 
 #endif
 
-static const struct behavior_driver_api behavior_tog_driver_api = {
-    .binding_pressed = tog_keymap_binding_pressed,
-    .binding_released = tog_keymap_binding_released,
+static const struct behavior_driver_api behavior_toggle_layer_driver_api = {
+    .binding_pressed = on_keymap_binding_pressed,
+    .binding_released = on_keymap_binding_released,
 #if IS_ENABLED(CONFIG_ZMK_BEHAVIOR_METADATA)
     .parameter_metadata = &metadata,
 #endif // IS_ENABLED(CONFIG_ZMK_BEHAVIOR_METADATA)
 };
 
-static const struct behavior_tog_config behavior_tog_config = {};
-
-static struct behavior_tog_data behavior_tog_data;
+#define KT_INST(n)                                                                                 \
+    static const struct behavior_toggle_layer_config behavior_toggle_layer_config_##n = {          \
+        .toggle_mode = DT_ENUM_IDX(DT_DRV_INST(n), toggle_mode),                                   \
+    };                                                                                             \
+    BEHAVIOR_DT_INST_DEFINE(                                                                       \
+        n, behavior_toggle_layer_init, NULL, NULL, &behavior_toggle_layer_config_##n, POST_KERNEL, \
+        CONFIG_KERNEL_INIT_PRIORITY_DEFAULT, &behavior_toggle_layer_driver_api);
 
-BEHAVIOR_DT_INST_DEFINE(0, behavior_tog_init, NULL, &behavior_tog_data, &behavior_tog_config,
-                        POST_KERNEL, CONFIG_KERNEL_INIT_PRIORITY_DEFAULT, &behavior_tog_driver_api);
+DT_INST_FOREACH_STATUS_OKAY(KT_INST)
 
 #endif /* DT_HAS_COMPAT_STATUS_OKAY(DT_DRV_COMPAT) */

docs/docs/keymaps/behaviors/key-toggle.md

@@ -24,3 +24,25 @@ Example:
 
 You can use any keycode that works for `&kp` as parameter to `&kt`, however, [modified keys](../modifiers.mdx#modifier-functions) such as `LA(A)` will be toggled based on the status of the base keycode (in this case `A`).
 In other words, modifiers are ignored when determining whether or not the key is currently pressed.
+
+### Configuration
+
+#### Toggle mode
+
+If you wish to ensure that a key is pressed or released, rather than merely toggling, then you can do so with the `toggle-mode` property.
+Define a new behavior and assign `"on"` or `"off"` to `toggle-mode`:
+
+```dts
+/ {
+    behaviors {
+        kt_on: key_toggle_on_only {
+            compatible = "zmk,behavior-key-toggle";
+            #binding-cells = <1>;
+            display-name = "Key Toggle On";
+            toggle-mode = "on";
+        };
+    };
+};
+```
+
+You can then use `&kt_on` in place of `&kt` whenever you wish to only toggle a key on, and not toggle it off. The `"off"` version is analogous.

docs/docs/keymaps/behaviors/layers.md

@@ -116,6 +116,28 @@ Example:
 &tog LOWER
 ```
 
+### Configuration
+
+#### Toggle mode
+
+If you wish to ensure that a layer is toggled on or off specifically, rather than switching between the two states, then you can do so with the `toggle-mode` property.
+Define a new behavior and assign `"on"` or `"off"` to `toggle-mode`:
+
+```dts
+/ {
+    behaviors {
+        tog_on: toggle_layer_on_only {
+            compatible = "zmk,behavior-toggle-layer";
+            #binding-cells = <1>;
+            display-name = "Toggle Layer On";
+            toggle-mode = "on";
+        };
+    };
+};
+```
+
+You can then use `&tog_on` in place of `&tog` whenever you wish to only toggle a layer on, and not toggle it off. The `"off"` version is analogous.
+
 ## Conditional Layers
 
 The "conditional layers" feature enables a particular layer when all layers in a specified set are active.