Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feature: pointer movement/scrolling #2027

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

Feature: pointer movement/scrolling #2027

wants to merge 14 commits into from
+1,690 −319

Conversation

petejohanson
Copy link
Contributor

@petejohanson petejohanson commented Nov 17, 2023 •
edited

Continuation of the incremental integration of the great work from @krikun98 in #778 with the movement and scrolling pieces next. Based on the rebased work from @caksoylar and and the split acceleration from @bryanforbes

TODO

  • Docs update
  • Review acceleration curves/functions configurability
  • Review @manna-harbour Discord discussion on per-device scaling factors.
  • Review @manna-harbour Discord note on storing float values, and on send of the report discard whole values, but retain the fractional remainder to be included in the follow up calculations, to avoid jerkiness/jumpiness.

@petejohanson petejohanson added enhancement New feature or request pointers Pointer related functionality labels Nov 17, 2023
@petejohanson petejohanson self-assigned this Nov 17, 2023
krikun98
krikun98 reviewed Nov 17, 2023
View reviewed changes
app/src/mouse/key_listener.c Outdated
k_work_submit_to_queue(zmk_mouse_work_q(), &mouse_tick);
}

K_TIMER_DEFINE(mouse_timer, mouse_timer_cb, mouse_clear_cb);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The part that initially made me bang my head against the wall with all this is the fact that Zephyr sometimes seems to de-prioritize these timers if the system is under load.
This is (as far as I was able to understand) the primary cause of the instability with mouse movement - reports can be sent out at random intervals or dropped entirely.
I was exploring re-writing this system to use a dedicated thread, but I wasn't skilled enough at C at the time.
I'm not sure this basis for the tick system is robust enough for general use.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So... timers should be using the hardware timers to trigger, and happen in ISR context. The queue has a certain priority, can be preempted, etc. Tweaking that thread priority might help, but I'll play a bit to see what I can determine. Thanks for the insight!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is most certainly not definitive - it's a half-remembered conclusion from an investigation I wasn't skilled enough to perform two years ago, just food for thought. I distinctly remember reports being delayed or dropped and that causing instability. hog.c:335 might also be worth taking a look at.

caksoylar
caksoylar reviewed Nov 18, 2023
View reviewed changes
app/include/dt-bindings/zmk/mouse.h

/* Mouse move behavior */
#define MOVE_Y(vert) ((vert)&0xFFFF)
#define MOVE_Y_DECODE(encoded) (int16_t)((encoded)&0x0000FFFF)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it might make sense to move these decode defines outside the dt-bindings header, and to either plain mouse.h or the corresponding event headers they are used in.

@petejohanson petejohanson force-pushed the feat/pointers-move-scroll branch 9 times, most recently from 32ed133 to c2bf21b Compare November 25, 2023 00:46
englmaxi added a commit to englmaxi/zmk that referenced this pull request Nov 26, 2023
@englmaxi
Feature: pointer movement/scrolling zmkfirmware#2027
ff04928
englmaxi added a commit to englmaxi/zmk that referenced this pull request Nov 26, 2023
@englmaxi
Feature: pointer movement/scrolling zmkfirmware#2027
78b3b89
@krikun98
Copy link
Contributor

krikun98 commented Dec 4, 2023

Could you please change the target to https://github.com/petejohanson/zmk/tree/core/zephyr-3.5-update here? The review is unnecessarily cluttered.

@petejohanson
Copy link
Contributor Author

Could you please change the target to https://github.com/petejohanson/zmk/tree/core/zephyr-3.5-update here? The review is unnecessarily cluttered.

Unfortunately, that will move the PR into a different GH fork, and make a bit of a mess. I recommend reviewing each commit for clarity for now, until the Zephyr 3.5 bits are merged into ZMK main.

@petejohanson petejohanson force-pushed the feat/pointers-move-scroll branch 5 times, most recently from 505343b to d837c95 Compare December 4, 2023 23:01
krikun98
krikun98 reviewed Dec 4, 2023
View reviewed changes
app/src/mouse/main.c Outdated Show resolved Hide resolved
caksoylar
caksoylar reviewed Dec 7, 2023
View reviewed changes
Copy link
Contributor

@caksoylar caksoylar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think these are some missed updates for the rebase to account for 36eda571b

app/src/behaviors/behavior_mouse_key_press.c Outdated Show resolved Hide resolved
app/src/behaviors/behavior_mouse_key_press.c Outdated Show resolved Hide resolved
app/src/behaviors/behavior_input_two_axis.c Outdated Show resolved Hide resolved
app/src/behaviors/behavior_input_two_axis.c Outdated Show resolved Hide resolved
@seansfkelley seansfkelley mentioned this pull request Mar 16, 2024
Open
valdar added a commit to valdar/zmk-sweep that referenced this pull request Mar 18, 2024
@valdar
Switched to zmkfirmware/zmk#2027 branch.
c6897c6
valdar added a commit to valdar/zmk-sweep that referenced this pull request Mar 18, 2024
@valdar
Switched to zmkfirmware/zmk#2027 branch.
30d3e52
valdar added a commit to valdar/zmk-sweep that referenced this pull request Mar 18, 2024
@valdar
Switched to zmkfirmware/zmk#2027 branch.
64ada27
valdar added a commit to valdar/zmk-sweep that referenced this pull request Mar 18, 2024
@valdar
Switched to zmkfirmware/zmk#2027 branch.
81d9af0
valdar added a commit to valdar/zmk-sweep that referenced this pull request Mar 18, 2024
@valdar
Switched to zmkfirmware/zmk#2027 branch.
b93717c
valdar added a commit to valdar/zmk-sweep that referenced this pull request Mar 18, 2024
@valdar
Switched to zmkfirmware/zmk#2027 branch.
3712a41
valdar added a commit to valdar/zmk-sweep that referenced this pull request Mar 18, 2024
@valdar
Switched to zmkfirmware/zmk#2027 branch.
1a158c7
greedysnakeDRV added a commit to greedysnakeDRV/zmk-configV2 that referenced this pull request Mar 29, 2024
@greedysnakeDRV
Update cradio.keymap
c8a21f1 
Update posted with mouse settings per zmkfirmware/zmk#2027
caksoylar and others added 10 commits April 6, 2024 21:30
@caksoylar @krikun98
@urob @ftc @petejohanson
feat(mouse): Add mouse move and scroll support [WIP]
2eba88d 
Co-authored-by: Alexander Krikun <krikun98@gmail.com>
Co-authored-by: Robert U <urob@users.noreply.github.com>
Co-authored-by: Shawn Meier <ftc@users.noreply.github.com>
@caksoylar @petejohanson
feat(mouse): Split move/scroll & x/y acceleration
9a68b37
@caksoylar @petejohanson
fix(mouse): Bump up default mouse tick duration to prevent crashes
96ad160
@petejohanson
refactor: Use input system for pointer events.
0ba8a29
@petejohanson
feat(mouse): Add input configs for data mods.
368f98c 
* Add ability to swap X/Y, invert X and Y values, and apply a
  scalar multiplier/divisor.
@petejohanson
refactor(mouse): Remove mouse work queue, Kconfig
664a61e 
* Remove now-unused mouse work queue and related mouse main file.
* Move ticks config into a DTS property on the two axis input behavior.
@petejohanson
fix(mouse): Fixes for logging.
3ff6051 
* Corrected logging for two-axis input timestamps.
@petejohanson
refactor: Proper per-device input listeners.
36c7827 
* Buffer data from input devices and only surface to HID once synd'd.
@petejohanson
chore: Minor input behavior clean-up.
ca28e83
@petejohanson
fix: Testing fixes for listener refactor.
f446ab4
@petejohanson
refactor(mouse): Tweak behavior inclusion, listener code
4ea55c3 
* Always import mouse keys behavior and their associated listeners.
* Tweak listener code to only add listener nodes when
  listener and the associated input device are enabled.
@petejohanson petejohanson marked this pull request as ready for review April 10, 2024 05:27
@petejohanson petejohanson requested a review from a team as a code owner April 10, 2024 05:27
@petejohanson
refactor(mouse): Lots of mouse refactors.
1974fe9 
* Dedicated mouse source directory.
* Split mouse HID into dedicated USB endpoint and HoG service.
* Enable composite USB device automatically, tweak the
  various default sizes.
@petejohanson
fix(mouse): Fix up tests and make ZMK_MOUSE explicit.
0b1d513
@petejohanson
feat(mouse): Updated mouse keys docs.
dbbeb70
VivekaNinja added a commit to VivekaNinja/Adv360-Pro-ZMK that referenced this pull request Apr 11, 2024
@VivekaNinja
Update west.yml
797ea67 
zmkfirmware/zmk#2027
@pmalecka pmalecka mentioned this pull request Apr 28, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fabiobaltieri fabiobaltieri fabiobaltieri left review comments

@caksoylar caksoylar caksoylar left review comments

@krikun98 krikun98 krikun98 left review comments

At least 1 approving review is required to merge this pull request.

Assignees

@petejohanson petejohanson

Labels
enhancement New feature or request pointers Pointer related functionality
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
7 participants
@petejohanson @krikun98 @manna-harbour @arturo182 @tokyo2006 @caksoylar @fabiobaltieri