feat(behaviors): Swapper implementation #1366

nickconway · 2022-06-28T02:22:03Z

Implementation of #997. Smart interrupt is probably not the name we should use, but I was out of ideas, help wanted!

caksoylar · 2022-07-21T05:45:02Z

I have been testing the window swapper implementation as in the example for the last day and it is working well so far. It neatly fixes #997 using a combination of first and second approaches proposed in there.

petejohanson

Thanks for this! Love the idea, and the general approach.

A few thoughts on implementation details/changes added here.

As far as naming.... Let me ponder. "Smart Interrupt" certainly feels better than "Swapper", but I'm curious if anyone has any other ideas for a better name. I also think "smart" is superfluous... A lot of what ZMK does is "smart", so it feels odd to include it in the naming for just this one behavior.

"Three Phase Behavior"
*Tri-Phase Behavior"
"Start/Continue/End Behavior"
"Tri-State Behavior"

Just a few that come to mind as food for thought.

app/dts/bindings/behaviors/zmk,behavior-smart-interrupt.yaml

docs/docs/behaviors/smart-interrupt.md

app/dts/bindings/behaviors/zmk,behavior-smart-interrupt.yaml

app/src/behaviors/behavior_smart_interrupt.c

petejohanson · 2022-07-27T12:40:36Z

app/src/behaviors/behavior_smart_interrupt.c

+    struct zmk_behavior_binding *behaviors;
+    int32_t shared_layers[32];
+    int32_t timeout_ms;
+    int32_t shared_key_positions[];


Ditto, could be a bitmask instead of this "sparse" array.

From the discussion on discord this is a bit tricky since the keymap can be any length. I've changed it to 8-bit ints for now but will keep working on a better solution.

app/src/behaviors/behavior_smart_interrupt.c

caksoylar · 2022-07-31T05:38:30Z

About the "tri-state" naming: It might be confusable with the "tri-layer" (lower+raise = adjust) pattern that we support with conditional layers.

nickconway · 2022-08-02T01:43:49Z

About the "tri-state" naming: It might be confusable with the "tri-layer" (lower+raise = adjust) pattern that we support with conditional layers.

Maybe three-phase would be better, or would 'triplex' or 'treble' work here? Start/Continue/End Behavior gets the point across, but I feel like it's a bit too specific.

caksoylar · 2022-08-02T03:49:03Z

I like the "bookend"/"sandwich" suggestions from @petejohanson personally, since it is like the repeatable "continue" behavior is bookended by special start and end events. Three-phase also sounds good.

petejohanson

An implementation comment... And then a bump again on naming... I'm on the fence on tri-state. @nickconway I didn't see you're thought on "bookend" concept for the name?

petejohanson · 2022-10-02T03:43:35Z

app/src/behaviors/behavior_tri_state.c

+        behavior_keymap_binding_pressed((struct zmk_behavior_binding *)&cfg->start_behavior, event);
+        behavior_keymap_binding_released((struct zmk_behavior_binding *)&cfg->start_behavior,
+                                         event);


I know we do this for hold taps right now, but any reason not to use the behavior queue here?

petejohanson · 2022-10-02T03:44:15Z

app/src/behaviors/behavior_tri_state.c

+                                         event);
+        tri_state->first_press = false;
+    }
+    behavior_keymap_binding_pressed((struct zmk_behavior_binding *)&cfg->continue_behavior, event);


petejohanson · 2022-10-02T03:44:41Z

app/src/behaviors/behavior_tri_state.c

+                behavior_keymap_binding_released(
+                    (struct zmk_behavior_binding *)&tri_state->config->continue_behavior, event);
+            }
+            behavior_keymap_binding_pressed(
+                (struct zmk_behavior_binding *)&tri_state->config->end_behavior, event);
+            behavior_keymap_binding_released(
+                (struct zmk_behavior_binding *)&tri_state->config->end_behavior, event);


nickconway · 2022-10-18T02:29:57Z

@petejohanson Apologies for the delay. I think the bookend name is much better. As for the behavior queue, my understanding was that the keymap_* functions would be used here since we want the action taken immediately?

danielo515 · 2023-05-16T09:07:05Z

@danielo515 can you shed some light onto your magic alt-tab implementation? I looked into your config and I'm a bit lost :) would love just general explanation how you've managed to pull it off. Thanks!

It is very simple in reality. I have a key that moves to app switch layer, which has all keys to make me leave that layer, except the ones I want to use (left, right, and Q for quit). Here is the layer:
https://github.com/danielo515/glove80-zmk-config/blob/40d69811521b449946ec341afe3eadedeb2a846e/config/glove80.keymap#L460-L471

And the relevant macros are this ones:
https://github.com/danielo515/glove80-zmk-config/blob/40d69811521b449946ec341afe3eadedeb2a846e/config/glove80.keymap#L156-L180

kaievns · 2023-05-16T09:36:59Z

It is very simple in reality. I have a key that moves to app switch layer, which has all keys to make me leave that layer, except the ones I want to use (left, right, and Q for quit).

Ah, so it's not really a one key swapper like QMK, it's just a new layer with different keys that you use to switch between the windows, right?

urob · 2023-05-16T11:02:25Z

You can make it a one-key swapper if you want. Just don't bind the arrows. The docs included with this PR feature an example.

petejohanson · 2023-06-05T22:28:46Z

@petejohanson Apologies for the delay. I think the bookend name is much better. As for the behavior queue, my understanding was that the keymap_* functions would be used here since we want the action taken immediately?

I say we go w/ bookend term, barring any major disagreement. Can you update this with naming, docs, etc that reflect that?

burgessa23 · 2023-06-09T21:32:29Z

I'm trying to use &swap on an encoder and can't seem to get it to fire although it compiles fine... any ideas?

bryanforbes · 2023-09-15T17:15:18Z

I have this running on my Glove80 and it's working pretty well so far, but I'm running into an issue. I have the following definition:

macswap: macswap {
    label = "macswap";
    compatible = "zmk,behavior-tri-state";
    #binding-cells = <0>;
    bindings = <&kt LGUI>, <&kp TAB>, <&kt LGUI>;
    ignored-key-positions = <38>; // shift
}

In my layout, I have a key with &sk LGUI and a key with &macswap next to each other. The problem I'm running into is if I accidentally hit &sk LGUI before &macswap, LGUI is permanently sticky and I have to turn the keyboard off in order to reset it.

lttb

I've tried to compile zmk with the latest main and zephyr 3.5 with this behaviour, and had a few compilation errors.

for anyone interested, there are a few changes that made it work for me (you can find a complete patch in lttb@2b856c5)

lttb · 2024-02-25T21:32:18Z

app/src/behaviors/behavior_tri_state.c

+}
+
+void behavior_tri_state_timer_handler(struct k_work *item) {
+    struct active_tri_state *tri_state = CONTAINER_OF(item, struct active_tri_state, release_timer);


from Zephyr v3.5.0 Migration Guide

CONTAINER_OF now performs type checking, this was very commonly misused to obtain user structure from k_work pointers without passing from k_work_delayable. This would now result in a build error and have to be done correctly using k_work_delayable_from_work().

Suggested change

struct active_tri_state *tri_state = CONTAINER_OF(item, struct active_tri_state, release_timer);

struct k_work_delayable *ditem = k_work_delayable_from_work(item);

struct active_tri_state *tri_state = CONTAINER_OF(ditem, struct active_tri_state, release_timer);

lttb · 2024-02-25T21:43:04Z

app/src/behaviors/behavior_tri_state.c

+
+#define _TRANSFORM_ENTRY(idx, node)                                                                \
+    {                                                                                              \
+        .behavior_dev = DT_LABEL(DT_INST_PHANDLE_BY_IDX(node, bindings, idx)),                     \


in Zephyr 3.2 Upgrade #1499, DT_LABEL was migrated to DT_PROP

and then in refactor!: Remove deprecated label property #2028, DT_PROP was migrated to DEVICE_DT_NAME

Suggested change

.behavior_dev = DT_LABEL(DT_INST_PHANDLE_BY_IDX(node, bindings, idx)), \

.behavior_dev = DEVICE_DT_NAME(DT_INST_PHANDLE_BY_IDX(node, bindings, idx)), \

lttb · 2024-02-25T21:45:22Z

app/src/behaviors/behavior_tri_state.c

+        .start_behavior = _TRANSFORM_ENTRY(0, n),                                                  \
+        .continue_behavior = _TRANSFORM_ENTRY(1, n),                                               \
+        .end_behavior = _TRANSFORM_ENTRY(2, n)};                                                   \
+    DEVICE_DT_INST_DEFINE(n, behavior_tri_state_init, NULL, NULL, &behavior_tri_state_config_##n,  \


in #2028 DEVICE_DT_INST_DEFINE was migrated to BEHAVIOR_DT_INST_DEFINE in behaviours

Suggested change

DEVICE_DT_INST_DEFINE(n, behavior_tri_state_init, NULL, NULL, &behavior_tri_state_config_##n, \

BEHAVIOR_DT_INST_DEFINE(n, behavior_tri_state_init, NULL, NULL, &behavior_tri_state_config_##n, \

davidsteinberger · 2024-03-21T06:53:37Z

Thank you very much for all the effort. I gave it a try. Works when added directly to the keymap. When I add it via a combo though, it doesn't work. Does anybody have the same problem or a workaround?

urob · 2024-03-21T10:44:52Z

Thank you very much for all the effort. I gave it a try. Works when added directly to the keymap. When I add it via a combo though, it doesn't work. Does anybody have the same problem or a workaround?

You have to include the combo locations in the ignore-positions. See #1366 (comment)

davidsteinberger · 2024-03-21T13:12:41Z

@urob thank you very much!!! I just noticed my mistake. For others that want to use it with zmk-nodefree-config, here's how it works.

ZMK_COMBO(sw_app, &swapper, 21 22 23, ALL, 100)
// Alt+Tab swapper, requires PR #1366
ZMK_BEHAVIOR(swapper, tri_state,
    bindings = <&kt LGUI>, <&kp TAB>, <&kt LGUI>;
    timeout-ms = <500>;
    ignored-key-positions = <21 22 23>;
)

dxmh added behaviors enhancement New feature or request labels Jun 30, 2022

caksoylar added a commit to caksoylar/zmk-config that referenced this pull request Jul 20, 2022

Try swapper with zmkfirmware/zmk#1366

d117d7a

caksoylar added a commit to caksoylar/zmk-config that referenced this pull request Jul 20, 2022

Try swapper with zmkfirmware/zmk#1366

d3b7a06

caksoylar added a commit to caksoylar/zmk-config that referenced this pull request Jul 20, 2022

Try swapper with zmkfirmware/zmk#1366

666579d

caksoylar added a commit to caksoylar/zmk-config that referenced this pull request Jul 20, 2022

Try swapper with zmkfirmware/zmk#1366

aa9325f

caksoylar added a commit to caksoylar/zmk-config that referenced this pull request Jul 21, 2022

Try swapper with zmkfirmware/zmk#1366

abc166d

petejohanson requested changes Jul 27, 2022

View reviewed changes

nickconway force-pushed the smart-interrupt branch from 93e215c to 69a3948 Compare July 30, 2022 22:45

caksoylar added a commit to caksoylar/zmk-config that referenced this pull request Jul 31, 2022

Try swapper with zmkfirmware/zmk#1366

1bfd8b1

caksoylar added a commit to caksoylar/zmk-config that referenced this pull request Aug 8, 2022

Try swapper with zmkfirmware/zmk#1366

181b672

caksoylar added a commit to caksoylar/zmk-config that referenced this pull request Aug 9, 2022

Try swapper with zmkfirmware/zmk#1366

91167ec

caksoylar added a commit to caksoylar/zmk-config that referenced this pull request Sep 1, 2022

Try swapper with zmkfirmware/zmk#1366

36d04be

caksoylar added a commit to caksoylar/zmk-config that referenced this pull request Sep 1, 2022

Try swapper with zmkfirmware/zmk#1366

2207aba

petejohanson reviewed Oct 2, 2022

View reviewed changes

petejohanson self-assigned this Oct 8, 2022

caksoylar pushed a commit to caksoylar/zmk that referenced this pull request Oct 15, 2022

Apply swapper PR zmkfirmware#1366

5405832

caksoylar pushed a commit to caksoylar/zmk that referenced this pull request Nov 1, 2022

Apply swapper PR zmkfirmware#1366

79d0e61

johnm added a commit to johnm/zmk that referenced this pull request Nov 6, 2022

nickconway/smart-interrupt zmkfirmware#1366

0218244

caksoylar pushed a commit to caksoylar/zmk that referenced this pull request Nov 7, 2022

Apply swapper PR zmkfirmware#1366

5e80368

caksoylar mentioned this pull request Nov 14, 2022

Feature request: Automatically held/released mods for certain keycodes for Alt-Tab window switching #997

Open

jdart pushed a commit to jdart/zmk that referenced this pull request Nov 18, 2022

Apply swapper PR zmkfirmware#1366

5defda1

caksoylar pushed a commit to caksoylar/zmk that referenced this pull request Nov 27, 2022

Apply swapper PR zmkfirmware#1366

588d469

caksoylar pushed a commit to caksoylar/zmk that referenced this pull request Dec 5, 2022

Apply swapper PR zmkfirmware#1366

ad25d53

caksoylar pushed a commit to caksoylar/zmk that referenced this pull request Dec 11, 2022

Apply swapper PR zmkfirmware#1366

c2c8975

This was referenced May 18, 2023

feat(behaviors): Add macro-pause-for-layer behavior #1804

Open

Alt-Tab again #1806

Closed

nickconway force-pushed the smart-interrupt branch from 7f34dc4 to 54a2252 Compare June 3, 2023 00:57

yuanbin added a commit to yuanbin/zmk that referenced this pull request Jun 15, 2023

Apply tri-state (PR zmkfirmware#1366)

6f2def8

allymparker added a commit to allymparker/zmk that referenced this pull request Jul 16, 2023

Apply tri-state (PR zmkfirmware#1366)

6b40e91

ghostbuster91 mentioned this pull request Jul 26, 2023

Better swapper ghostbuster91/Dilemma3x6_3-zmk#1

Open

j-w-e added a commit to j-w-e/zmk that referenced this pull request Aug 17, 2023

Adding tri-state / swapper function (PR zmkfirmware#1366)

0df6546

pipex added a commit to pipex/zmk-corne that referenced this pull request Aug 31, 2023

Use swapper from zmkfirmware/zmk#1366

ef8e0a1

j-w-e added a commit to j-w-e/zmk that referenced this pull request Sep 23, 2023

Adding tri-state / swapper function (PR zmkfirmware#1366)

bb5d1fd

allymparker added a commit to allymparker/zmk that referenced this pull request Oct 6, 2023

Apply tri-state (PR zmkfirmware#1366)

66bfeee

allymparker added a commit to allymparker/zmk that referenced this pull request Oct 6, 2023

Apply tri-state (PR zmkfirmware#1366)

132e586

allymparker added a commit to allymparker/zmk that referenced this pull request Oct 6, 2023

Apply tri-state (PR zmkfirmware#1366)

55bb6aa

caksoylar mentioned this pull request Nov 4, 2023

Question: Zen v2 or Zen v1 caksoylar/zmk-config#2

Closed

allymparker added a commit to allymparker/zmk that referenced this pull request Nov 21, 2023

Apply tri-state (PR zmkfirmware#1366)

49ca9b1

allymparker added a commit to allymparker/zmk that referenced this pull request Jan 23, 2024

Apply tri-state (PR zmkfirmware#1366)

95c3aed

lttb reviewed Feb 25, 2024

View reviewed changes

Tri-state behavior

0876cbc

nickconway force-pushed the smart-interrupt branch from 54a2252 to 0876cbc Compare April 15, 2024 21:14

nickconway requested a review from a team as a code owner April 15, 2024 21:14

nickconway added 2 commits April 15, 2024 17:15

Fix for 3.5

1bb06c6

Run pre-commit checks

6afccca

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(behaviors): Swapper implementation #1366

feat(behaviors): Swapper implementation #1366

nickconway commented Jun 28, 2022

caksoylar commented Jul 21, 2022

petejohanson left a comment

petejohanson Jul 27, 2022

nickconway Jul 30, 2022

caksoylar commented Jul 31, 2022

nickconway commented Aug 2, 2022

caksoylar commented Aug 2, 2022

petejohanson left a comment •

edited

petejohanson Oct 2, 2022

petejohanson Oct 2, 2022

petejohanson Oct 2, 2022

nickconway commented Oct 18, 2022

danielo515 commented May 16, 2023

kaievns commented May 16, 2023

urob commented May 16, 2023

petejohanson commented Jun 5, 2023

burgessa23 commented Jun 9, 2023

bryanforbes commented Sep 15, 2023

lttb left a comment •

edited

lttb Feb 25, 2024

lttb Feb 25, 2024

lttb Feb 25, 2024

davidsteinberger commented Mar 21, 2024

urob commented Mar 21, 2024

davidsteinberger commented Mar 21, 2024 •

edited

	struct active_tri_state *tri_state = CONTAINER_OF(item, struct active_tri_state, release_timer);
	struct k_work_delayable *ditem = k_work_delayable_from_work(item);
	struct active_tri_state *tri_state = CONTAINER_OF(ditem, struct active_tri_state, release_timer);

	.behavior_dev = DT_LABEL(DT_INST_PHANDLE_BY_IDX(node, bindings, idx)), \
	.behavior_dev = DEVICE_DT_NAME(DT_INST_PHANDLE_BY_IDX(node, bindings, idx)), \

	DEVICE_DT_INST_DEFINE(n, behavior_tri_state_init, NULL, NULL, &behavior_tri_state_config_##n, \
	BEHAVIOR_DT_INST_DEFINE(n, behavior_tri_state_init, NULL, NULL, &behavior_tri_state_config_##n, \

feat(behaviors): Swapper implementation #1366

Are you sure you want to change the base?

feat(behaviors): Swapper implementation #1366

Conversation

nickconway commented Jun 28, 2022

caksoylar commented Jul 21, 2022

petejohanson left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

caksoylar commented Jul 31, 2022

nickconway commented Aug 2, 2022

caksoylar commented Aug 2, 2022

petejohanson left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nickconway commented Oct 18, 2022

danielo515 commented May 16, 2023

kaievns commented May 16, 2023

urob commented May 16, 2023

petejohanson commented Jun 5, 2023

burgessa23 commented Jun 9, 2023

bryanforbes commented Sep 15, 2023

lttb left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

davidsteinberger commented Mar 21, 2024

urob commented Mar 21, 2024

davidsteinberger commented Mar 21, 2024 • edited

petejohanson left a comment •

edited

lttb left a comment •

edited

davidsteinberger commented Mar 21, 2024 •

edited