Core encoder/sensor refactor #1039

petejohanson · 2021-11-30T05:16:19Z

Some major refactors to sensors:

Refactor ec11 sensor driver to align w/ Zephyr degree channel convention, that sensor data for that channel is in degrees of change since the last event.
Refactor to allow specitying what angle delta triggers a given behavior.
Move channel data into the sensor event, instead of requiring listeners to probe the sensor themselves upon events.

ReFil · 2021-12-02T17:18:32Z

If it's alright I'll send you a revised rotr folder with a better keymap and a few definition tweaks to match the bt60s

joelspadin · 2023-04-16T18:50:43Z

app/Kconfig

@@ -482,8 +494,12 @@ config ZMK_WPM
 	bool "Calculate WPM"
 	default n

-config SENSOR
+DT_COMPAT_ZMK_KEYMAP_SENSORS := zmk,keymap-sensors


Does battery.c require SENSOR be enabled?

Sure does. Added a new commit here that creates a new ZMK_BATTERY_REPORTING Kconfig symbol:

config ZMK_BATTERY_REPORTING bool "Battery level detection/reporting" default n select SENSOR select BT_BAS if ZMK_BLE

That is implyd by ZMK_BLE automatically.

Thoughts?

docs/blog/2023-06-10-encoder-refactors.md

joelspadin · 2023-06-17T04:03:03Z

app/Kconfig

+
+if ZMK_KEYMAP_SENSORS
+
+config ZMK_KEYMAP_SENSORS_DEFAULT_TRIGGERS_PER_ROTATION


What is the difference between this and ZMK_ENCODERS_DEFAULT_TRIGGERS_PER_ROTATION? Do we need two different configs (with different defaults) that seem to be for the same thing?

app/include/drivers/behavior.h

app/src/behaviors/behavior_sensor_rotate_common.c

app/src/sensors.c

docs/blog/2023-06-10-encoder-refactors.md

* Refactor sensor events to include channel data, necessary for prop split encoders, and avoiding duplicate calls, to fetch channel data twice, etc. * More consistent behavior driver API. * Allow setting triggers per resolution at the behavior level optionally.

* Add new `steps` property to the `aips,ec11` binding, to make the driver properly report degrees in the rotation delta channel. * Handle old sensor values in sensor rotate behavior.

* Don't force on SENSOR Kconfig setting unless needed based on the detected DT.

* Bump the default stack size for the HoG processing thread to avoid issues w/ some pathways.

* Move to new steps/triggers-per-rotation config. * Leverage QDEC Nordic driver when used on Nordic DK.

* Add dedicated battery reporting Kconfig that is `imply`d by enabling ZMK_BLE.

* All sensor behaviors should see sensor data, then selectively only have some trigger their behaviors.

* Document changed configuration, support for other Zephyr drivers, next steps. Co-authored-by: Cem Aksoylar <[email protected]>

petejohanson added enhancement New feature or request core Core functionality/behavior of ZMK sensors refactor labels Nov 30, 2021

petejohanson self-assigned this Nov 30, 2021

petejohanson force-pushed the core/encoder-sensor-refactor-and-ma730-driver branch from 2eb4df3 to 0838fa9 Compare December 2, 2021 21:32

petejohanson force-pushed the core/encoder-sensor-refactor-and-ma730-driver branch 4 times, most recently from 867ef6a to ef57a53 Compare February 10, 2022 03:15

petejohanson force-pushed the core/encoder-sensor-refactor-and-ma730-driver branch 2 times, most recently from 326a540 to b45a26b Compare June 16, 2022 05:12

petejohanson force-pushed the core/encoder-sensor-refactor-and-ma730-driver branch 3 times, most recently from 98a3d97 to c87e149 Compare June 29, 2022 03:45

petejohanson force-pushed the core/encoder-sensor-refactor-and-ma730-driver branch from c87e149 to fe08e17 Compare April 6, 2023 06:45

petejohanson changed the title ~~Core/encoder sensor refactor and ma730 driver~~ Core encoder/sensor refactor Apr 6, 2023

petejohanson force-pushed the core/encoder-sensor-refactor-and-ma730-driver branch 9 times, most recently from adae294 to d557438 Compare April 10, 2023 06:27

joelspadin reviewed Apr 16, 2023

View reviewed changes

petejohanson force-pushed the core/encoder-sensor-refactor-and-ma730-driver branch 2 times, most recently from f51b3fa to dd224e1 Compare April 19, 2023 23:36

petejohanson force-pushed the core/encoder-sensor-refactor-and-ma730-driver branch 6 times, most recently from a7e2e61 to 2ea2a14 Compare May 24, 2023 05:07

petejohanson force-pushed the core/encoder-sensor-refactor-and-ma730-driver branch from f37414d to 5e4abe0 Compare May 30, 2023 02:40

caksoylar reviewed May 30, 2023

View reviewed changes

petejohanson force-pushed the core/encoder-sensor-refactor-and-ma730-driver branch from db70caf to f3450ca Compare June 1, 2023 05:49

petejohanson requested a review from joelspadin June 5, 2023 06:04

joelspadin reviewed Jun 17, 2023

View reviewed changes

petejohanson added 9 commits June 17, 2023 22:46

refactor(sensors): ec11 rotation sensor value in degrees.

0d23337

* Add new `steps` property to the `aips,ec11` binding, to make the driver properly report degrees in the rotation delta channel. * Handle old sensor values in sensor rotate behavior.

refactor(config): Select SENSOR as needed.

0529949

* Don't force on SENSOR Kconfig setting unless needed based on the detected DT.

refactor(bluetooth): Bump HoG stack size.

d8ccde6

* Bump the default stack size for the HoG processing thread to avoid issues w/ some pathways.

refactor(shields): Updated ZMK Uno encoder config.

2c457f5

* Move to new steps/triggers-per-rotation config. * Leverage QDEC Nordic driver when used on Nordic DK.

refactor(bluetooth): Add battery reporting config.

6296925

* Add dedicated battery reporting Kconfig that is `imply`d by enabling ZMK_BLE.

refactor(sensors): Split data handling from triggers.

0a386e2

* All sensor behaviors should see sensor data, then selectively only have some trigger their behaviors.

refactor(sensors): Use "sensor index" consistently

2465e3d

fix(sensors): Clean ups based on code review.

ecabd88

petejohanson force-pushed the core/encoder-sensor-refactor-and-ma730-driver branch from f3450ca to b05c1af Compare June 18, 2023 06:20

petejohanson requested a review from a team as a code owner June 18, 2023 06:20

petejohanson force-pushed the core/encoder-sensor-refactor-and-ma730-driver branch from b05c1af to 471dddb Compare June 18, 2023 06:22

petejohanson requested a review from joelspadin June 18, 2023 06:25

joelspadin approved these changes Jun 18, 2023

View reviewed changes

caksoylar approved these changes Jun 18, 2023

View reviewed changes

feat(blog): Add post about sensor refactor.

8cfbd64

* Document changed configuration, support for other Zephyr drivers, next steps. Co-authored-by: Cem Aksoylar <[email protected]>

petejohanson force-pushed the core/encoder-sensor-refactor-and-ma730-driver branch from 471dddb to 8cfbd64 Compare June 18, 2023 20:48

petejohanson merged commit 5763558 into zmkfirmware:main Jun 19, 2023

petejohanson mentioned this pull request Jun 19, 2023

feature(split): add support for sensors from peripheral #1841

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Core encoder/sensor refactor #1039

Core encoder/sensor refactor #1039

petejohanson commented Nov 30, 2021 •

edited

Loading

ReFil commented Dec 2, 2021

joelspadin Apr 16, 2023

petejohanson Apr 18, 2023

joelspadin Jun 17, 2023


		if ZMK_KEYMAP_SENSORS

		config ZMK_KEYMAP_SENSORS_DEFAULT_TRIGGERS_PER_ROTATION

Core encoder/sensor refactor #1039

Core encoder/sensor refactor #1039

Conversation

petejohanson commented Nov 30, 2021 • edited Loading

ReFil commented Dec 2, 2021

joelspadin Apr 16, 2023

Choose a reason for hiding this comment

petejohanson Apr 18, 2023

Choose a reason for hiding this comment

joelspadin Jun 17, 2023

Choose a reason for hiding this comment

petejohanson commented Nov 30, 2021 •

edited

Loading