feat(beahviors): Allow encoders to use any behavior #1275

nickconway · 2022-04-27T18:47:38Z

This PR adds the sensor-rotate behavior, which will allow for encoders to use any behavior in addition to basic keypresses.

In the documentation I have assumed this will deprecate the existing &inc_dec_kp behavior.

This has not been tested extensively but is confirmed to be working with RGB behaviors.

eXsoR65 · 2022-04-28T02:18:40Z

Working with rgb behavior:

IMG_3420.mov

kurtis-lew

Looking good so far! I'm currently unable to get this feature working on my local hardware, but in the meantime I have a few comments.

app/dts/bindings/behaviors/zmk,behavior-sensor-rotate.yaml

app/src/behaviors/behavior_sensor_rotate.c

docs/docs/behaviors/sensor-rotate.md

docs/docs/features/encoders.md

kurtis-lew · 2022-04-28T03:22:23Z

Another thing that I'm picking up when I build firmware locally using this PR is the error in the image above. In my case, when I rotate my encoder clockwise or counterclockwise, I'm unable to get the correct behavior binding to register. Perhaps the incompatible pointer types may be the reason for this issue. I'll continue to debug things from my end and see if I can confirm this.

Edit: Can confirm that the updated sensor-rotate behavior works with &kp as a binding. Just had to rename my encoder on my test board. Thanks for this contribution!

eXsoR65 · 2022-04-28T11:47:48Z

Another thing that I'm picking up when I build firmware locally using this PR is the error in the image above. In my case, when I rotate my encoder clockwise or counterclockwise, I'm unable to get the correct behavior binding to register. Perhaps the incompatible pointer types may be the reason for this issue. I'll continue to debug things from my end and see if I can confirm this.

I too get the same warning during the build process though Its still working.
https://github.com/eXsoR65/bdn9_zmk_config/runs/6198384676?check_suite_focus=true#step:9:65

Here my config: https://github.com/eXsoR65/bdn9_zmk_config

kurtis-lew

Did another pass through this PR to make some more minor suggestions. Thanks for the updates based on the first review!

docs/docs/features/encoders.md

docs/docs/behaviors/sensor-rotate.md

app/src/behaviors/behavior_sensor_rotate.c

petejohanson

Thanks for working on this! A few minor comments, and one higher level change we might want to roll into this.

app/src/behaviors/behavior_sensor_rotate.c

docs/docs/features/encoders.md

petejohanson

Comment on the behavior queue usage, naming tweaks.

I don't love the code duplication between the parameterized version and not, but the amount duplicated is so minimal, I'd say it's fine.

app/src/behaviors/behavior_sensor_rotate_var.c

app/dts/bindings/behaviors/zmk,behavior-sensor-rotate.yaml

app/dts/bindings/behaviors/zmk,behavior-sensor-rotate-var.yaml

app/src/behaviors/behavior_sensor_rotate.c

app/src/behaviors/behavior_sensor_rotate_var.c

nickconway · 2022-05-23T20:36:09Z

I don't love the code duplication between the parameterized version and not, but the amount duplicated is so minimal, I'd say it's fine.

We could the duplicated code to another file that gets included in each behavior?

petejohanson

One more thought...

petejohanson · 2022-06-13T03:04:32Z

app/src/behaviors/behavior_sensor_rotate_var.c

+    zmk_behavior_queue_add(0, triggered_binding, true, cfg->tap_ms);
+    zmk_behavior_queue_add(0, triggered_binding, false, 0);


Instead of simulating this at the zeroth key position, perhaps better to simulate it at "max key position + sensor position" so there are actually unique? May be necessary for some code that tracks state tied to key position (or might actually break them.... hmmm...)

This got fixed in the non-var version, but not this one.

ReFil · 2022-06-22T10:41:34Z

Excited to see this as it will make the defeault layer shifting stuff i'vebeen working on much neater. Iimplemented a rudimentary sensor behaviour but universall sensor beaviours are even better

petejohanson

Couple minor things. Want to give this a test before merging though.

Thanks for the work on this!

app/src/keymap.c

app/src/behaviors/behavior_sensor_rotate_var.c

app/src/behaviors/behavior_sensor_rotate.c

petejohanson · 2022-10-27T20:45:36Z

@nickconway can you please rebase to pull in the docs build fixes?

Co-authored-by: Pete Johanson <peter@peterjohanson.com>

nickconway · 2022-10-29T23:40:18Z

@petejohanson done.

petejohanson

A few minor fixes needed.

Also, we probably need to remove app/dts/bindings/behaviors/zmk,behavior-sensor-rotate-key-press.yaml in this PR as well as the driver code itself.

petejohanson · 2022-11-03T15:28:35Z

docs/docs/behaviors/sensor-rotate.md

+### Configuration
+
+An example implementation of an encoder that changes RGB brightness is shown below:
+


We need an example for the -var and non-var variants here.

petejohanson · 2022-11-03T15:29:20Z

app/src/behaviors/behavior_sensor_rotate_var.c

+    zmk_behavior_queue_add(0, triggered_binding, true, cfg->tap_ms);
+    zmk_behavior_queue_add(0, triggered_binding, false, 0);


This got fixed in the non-var version, but not this one.

joelspadin · 2023-03-23T05:57:58Z

app/src/behaviors/behavior_sensor_rotate.c

+
+    LOG_DBG("Sensor binding: %s", log_strdup(binding->behavior_dev));
+
+    zmk_behavior_queue_add(ZMK_KEYMAP_LEN + event.position, *triggered_binding, true, cfg->tap_ms);


I think this will overlap with combo positions?

petejohanson · 2023-04-22T04:14:16Z

Merged in the updated PR #1758

kurtis-lew reviewed Apr 28, 2022

View reviewed changes

drzony mentioned this pull request Apr 28, 2022

feat(behaviors): Add encoder layer switching #1259

Closed

kurtis-lew approved these changes Apr 30, 2022

View reviewed changes

kurtis-lew suggested changes Apr 30, 2022

View reviewed changes

docs/docs/features/encoders.md Outdated Show resolved Hide resolved

docs/docs/behaviors/sensor-rotate.md Outdated Show resolved Hide resolved

drzony reviewed May 1, 2022

View reviewed changes

docs/docs/behaviors/sensor-rotate.md Outdated Show resolved Hide resolved

docs/docs/behaviors/sensor-rotate.md Outdated Show resolved Hide resolved

joelspadin reviewed May 1, 2022

View reviewed changes

app/src/behaviors/behavior_sensor_rotate.c Outdated Show resolved Hide resolved

app/src/behaviors/behavior_sensor_rotate.c Outdated Show resolved Hide resolved

app/src/behaviors/behavior_sensor_rotate.c Outdated Show resolved Hide resolved

kurtis-lew mentioned this pull request May 2, 2022

feat(docs): Add New Behavior Guide #1268

Merged

4 tasks

petejohanson requested changes May 17, 2022

View reviewed changes

nickconway force-pushed the configurable-sensor-bindings branch 6 times, most recently from 733da73 to cb7da72 Compare May 18, 2022 21:49

petejohanson requested changes May 23, 2022

View reviewed changes

nickconway force-pushed the configurable-sensor-bindings branch 3 times, most recently from c4cbbaf to e7fd119 Compare May 23, 2022 20:33

petejohanson reviewed Jun 13, 2022

View reviewed changes

nickconway force-pushed the configurable-sensor-bindings branch from 848a15e to 507fdcf Compare June 16, 2022 05:23

petejohanson reviewed Jun 26, 2022

View reviewed changes

app/src/keymap.c Outdated Show resolved Hide resolved

app/src/behaviors/behavior_sensor_rotate_var.c Outdated Show resolved Hide resolved

app/src/behaviors/behavior_sensor_rotate.c Outdated Show resolved Hide resolved

caksoylar added enhancement New feature or request behaviors sensors encoders labels Jul 4, 2022

nickconway requested a review from petejohanson August 2, 2022 01:54

petejohanson self-assigned this Oct 27, 2022

nickconway and others added 5 commits October 29, 2022 19:23

Add configurable sensor bindings

41d2c5c

Update api for sensor bindings

7f19804

Add matrix include

a8e58ae

Apply suggestions from code review

b97737a

Co-authored-by: Pete Johanson <peter@peterjohanson.com>

Fix formatting

22818e6

nickconway force-pushed the configurable-sensor-bindings branch from 1d2f4a8 to 22818e6 Compare October 29, 2022 23:24

petejohanson requested changes Nov 3, 2022

View reviewed changes

This was referenced Nov 14, 2022

Keymap fine tuning t4corun/zmk-config#13

Closed

Put in aliases for encoders t4corun/zmk-config#17

Closed

joelspadin mentioned this pull request Feb 11, 2023

refactor(encoder): use behavior queue to archive key taps for encoder #1658

Closed

11 tasks

joelspadin reviewed Mar 23, 2023

View reviewed changes

joelspadin mentioned this pull request Mar 23, 2023

Add virtual key positions for sensors #1659

Merged

petejohanson mentioned this pull request Apr 17, 2023

feat(behaviors): Add reusable sensor behaviors. #1758

Merged

petejohanson closed this Apr 22, 2023

nickconway deleted the configurable-sensor-bindings branch June 6, 2023 20:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(beahviors): Allow encoders to use any behavior #1275

feat(beahviors): Allow encoders to use any behavior #1275

nickconway commented Apr 27, 2022

eXsoR65 commented Apr 28, 2022

kurtis-lew left a comment

kurtis-lew commented Apr 28, 2022 •

edited

eXsoR65 commented Apr 28, 2022 •

edited

kurtis-lew left a comment

petejohanson left a comment

petejohanson left a comment

nickconway commented May 23, 2022

petejohanson left a comment

petejohanson Jun 13, 2022

petejohanson Nov 3, 2022

ReFil commented Jun 22, 2022

petejohanson left a comment

petejohanson commented Oct 27, 2022

nickconway commented Oct 29, 2022

petejohanson left a comment

petejohanson Nov 3, 2022

petejohanson Nov 3, 2022

joelspadin Mar 23, 2023

petejohanson commented Apr 22, 2023

		zmk_behavior_queue_add(0, triggered_binding, true, cfg->tap_ms);
		zmk_behavior_queue_add(0, triggered_binding, false, 0);

		### Configuration

		An example implementation of an encoder that changes RGB brightness is shown below:


		LOG_DBG("Sensor binding: %s", log_strdup(binding->behavior_dev));

		zmk_behavior_queue_add(ZMK_KEYMAP_LEN + event.position, *triggered_binding, true, cfg->tap_ms);

feat(beahviors): Allow encoders to use any behavior #1275

feat(beahviors): Allow encoders to use any behavior #1275

Conversation

nickconway commented Apr 27, 2022

eXsoR65 commented Apr 28, 2022

kurtis-lew left a comment

Choose a reason for hiding this comment

kurtis-lew commented Apr 28, 2022 • edited

eXsoR65 commented Apr 28, 2022 • edited

kurtis-lew left a comment

Choose a reason for hiding this comment

petejohanson left a comment

Choose a reason for hiding this comment

petejohanson left a comment

Choose a reason for hiding this comment

nickconway commented May 23, 2022

petejohanson left a comment

Choose a reason for hiding this comment

petejohanson Jun 13, 2022

Choose a reason for hiding this comment

petejohanson Nov 3, 2022

Choose a reason for hiding this comment

ReFil commented Jun 22, 2022

petejohanson left a comment

Choose a reason for hiding this comment

petejohanson commented Oct 27, 2022

nickconway commented Oct 29, 2022

petejohanson left a comment

Choose a reason for hiding this comment

petejohanson Nov 3, 2022

Choose a reason for hiding this comment

petejohanson Nov 3, 2022

Choose a reason for hiding this comment

joelspadin Mar 23, 2023

Choose a reason for hiding this comment

petejohanson commented Apr 22, 2023

kurtis-lew commented Apr 28, 2022 •

edited

eXsoR65 commented Apr 28, 2022 •

edited