Implement kinetic mouse movement algorithm #6739

jceb · 2019-09-15T11:55:09Z

Description

I implemented the kinetic/quadratic mouse acceleration algorithm. The algorithm is not the one from the UHK but a newly created one that's able to compute the current speed at any given time instead of relying on a compounding mechanism that just computes the increment.
Overall, the cursor acceleration feels very similar to the UHK. However, feedback and improvements are welcome in order to make it as usable as possible.

This algorithm requires a very low MOUSEKEY_INTERVAL in order to produce smooth movements. What's possible highly depends on the micro processor. I did my tests on the elite-c which is pro micro compatible. It was able to deliver 125 events per second which I set as the default value if MK_KINETIC_SPEED is defined.

I wrote a small utility https://github.com/jceb/bin/blob/master/mouseevents that helps to measure the maximum number of mouse events that can be sent by the micro processor. If you try out this algorithm it should help find the right setting for MOUSEKEY_INTERVAL.

Types of Changes

Issues Fixed or Closed by This PR

Add UHK's kinetic mouse movement Add UHK's kinetic mouse movement #6738

Checklist

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
I have tested the changes and verified that they work and don't break anything (as well as I can manage).

tmk_core/common/mousekey.c

jceb · 2019-09-29T18:30:18Z

Any updates on this pull request?

hugovk

I reviewed the docs and comments, all look good, just a teeny-tiny suggestion

tmk_core/common/mousekey.c

thiagoyeds

Hi @jceb, I reviewed your code, very well documented and implemented.

thiagoyeds

I have a suggestion, please review it.

tmk_core/common/mousekey.c

lf-

Code looks good, documentation confused me before I read the code, which I have suggested changes for improving to make it clear how kinetic mode is different from acceleration mode.

docs/feature_mouse_keys.md

samagragupta

jceb · 2019-10-27T07:27:12Z

Docs are in place, no requests have been raised. I think it just needs a little more time. @drashna what do you think about merging it?

drashna · 2020-12-17T03:51:23Z

This PR needs to be rebased.

jceb · 2020-12-21T16:08:31Z

Rebase done.
@sahalsaad somehow github says that there are still open comments from you but I can't find them. Could you point me to the open items or close them?
@tzarc @zvecr do you have any questions regarding this PR that are standing in the way of a sign-off?

Erovia · 2020-12-21T18:03:16Z

Not sure if the github ui is slow a bit today or something, but it still shows one conflict (tmk_core/common/mousekey.c) for me.

Co-Authored-By: lf <software@lfcode.ca>

jceb · 2020-12-22T09:32:46Z

Not sure if the github ui is slow a bit today or something, but it still shows one conflict (tmk_core/common/mousekey.c) for me.

Thank you for the hint. Somehow I couldn't get my git to force-push the changes. Very strange but now it worked :-D

kareltucek · 2021-03-28T15:07:55Z

Overall, the cursor acceleration feels very similar to the UHK. However, feedback and improvements are welcome in order to make it as usable as possible.

If I may:

I see you are not handling your float remainders, which means that achievability of low speed and high smoothness is governed by the Heisenberg's principle (literally). While I agree that the sweet spot (where both the properties are acceptable for regular use) can be achieved, finding feasible combination of parameters would be much easier if you simply stashed the remainders between the calls.
For some reason, changing interval changes acceleration. I may have some local problems in the code due to which this observation might be incorrect, but if the observation is correct, it would be better if acceleration did not depend on the mousekey interval.
Documentation (https://beta.docs.qmk.fm/using-qmk/advanced-keycodes/feature_mouse_keys) is missing interpretation of the mouse delta, so figuring out that it is actually the linear step per 50 ms is up to the reader. Two ways out:
- (easier) to fix the docs
- (conceptually correct) to expose the acceleration in some human interprettable units whose interpretation won't change depending on internal implementation details (and fix the docs)

(I am looking into the older qmk/master code, fixed by hand in order to expose your algorithm... thence the possibility of errors.)

jceb · 2021-03-30T08:00:10Z

Thank you for your feedback. There's another kinetic implementation at https://github.com/liyang/qmk_firmware that might be of interest to you.

kareltucek · 2021-03-30T08:11:21Z

Honestly? I've got your implementation running and am happy with it, and don't want to waste any more time on another O:-).

But thanks nevertheless!

Lilalas · 2021-08-18T22:56:59Z

How could the double space in line 114 slip through? It was one of the very first suggestions to remove it.

fauxpark · 2021-08-19T02:40:34Z

Unfortunately GitHub doesn't tell you when a suggestion is resolved manually or by it actually being applied.

Lilalas · 2021-08-19T10:25:50Z

@fauxpark Am I looking in the wrong branch? What I meant to say is it’s not actually applied. Or rather it had been applied and somebody must have undone it.

fauxpark · 2021-08-19T10:47:01Z

That's right, it doesn't seem to have been applied, but the suggestion is marked as resolved. Maybe it was applied but got lost during one of the rebases that appear to have happened here. Or maybe the PR author marked it resolved and forgot to do it themselves. It's impossible to tell at this point because either way GitHub just shows this:

* Implement kinetic mouse movement algorithm * Adjust mouse wheel speed * Remove unused math.h include * Wrap mouse_timer definition in ifdef * Replace double space by single space * Clarify documentation of kinetic mouse speed Co-Authored-By: lf <software@lfcode.ca> * Clarify documentation of kinetic mouse speed Co-Authored-By: lf <software@lfcode.ca> * Remove superfluous definition of speed * fix(variable): remove unused variable Co-authored-by: lf <software@lfcode.ca>

fauxpark mentioned this pull request Sep 18, 2019

Signum 3 0 enable kinetic speed #6740

Merged

13 tasks

fauxpark added documentation enhancement labels Sep 18, 2019

fauxpark requested a review from a team September 18, 2019 04:29

drashna requested changes Sep 18, 2019

View reviewed changes

tmk_core/common/mousekey.c Show resolved Hide resolved

drashna approved these changes Sep 19, 2019

View reviewed changes

noroadsleft added the core label Sep 19, 2019

drashna requested a review from a team September 30, 2019 19:26

jackhumbert added the hacktoberfest-accepted All the good issues to tackle during Hacktoberfest! label Sep 30, 2019

hugovk approved these changes Oct 6, 2019

View reviewed changes

tmk_core/common/mousekey.c Show resolved Hide resolved

thiagoyeds reviewed Oct 6, 2019

View reviewed changes

thiagoyeds approved these changes Oct 6, 2019

View reviewed changes

pranshuchittora approved these changes Oct 6, 2019

View reviewed changes

thiagoyeds suggested changes Oct 7, 2019

View reviewed changes

tmk_core/common/mousekey.c Show resolved Hide resolved

lf- suggested changes Oct 7, 2019

View reviewed changes

docs/feature_mouse_keys.md Outdated Show resolved Hide resolved

docs/feature_mouse_keys.md Outdated Show resolved Hide resolved

lf- approved these changes Oct 7, 2019

View reviewed changes

qmk deleted a comment from rishav142k Oct 8, 2019

qmk deleted a comment from SyntaxError-exe Oct 8, 2019

qmk deleted a comment from D3v3sh5ingh Oct 9, 2019

qmk deleted a comment from chamodshehanka Oct 11, 2019

qmk deleted a comment from sumitkharche Oct 13, 2019

aakashjhawar approved these changes Oct 19, 2019

View reviewed changes

samagragupta approved these changes Oct 19, 2019

View reviewed changes

qmk deleted a comment from PrathamGoyal Oct 22, 2019

thiagoyeds approved these changes Oct 23, 2019

View reviewed changes

qmk deleted a comment from raghavdhingra Oct 23, 2019

Erovia requested a review from a team November 23, 2020 19:47

noroadsleft closed this Nov 28, 2020

noroadsleft deleted the branch qmk:develop November 28, 2020 20:02

tzarc reopened this Nov 28, 2020

noroadsleft force-pushed the develop branch from 7d3841e to 3cc7d22 Compare November 30, 2020 11:32

jceb force-pushed the feature_kinetic_mouse_movement branch from 229e7f7 to 1e40fb5 Compare December 21, 2020 15:57

Jan Christoph Ebersbach and others added 9 commits December 22, 2020 10:28

Implement kinetic mouse movement algorithm

83c62de

Adjust mouse wheel speed

e8677b5

Remove unused math.h include

79c8a46

Wrap mouse_timer definition in ifdef

e03b4e1

Replace double space by single space

22bd42f

Clarify documentation of kinetic mouse speed

081e7e1

Co-Authored-By: lf <software@lfcode.ca>

Clarify documentation of kinetic mouse speed

12dfa1b

Co-Authored-By: lf <software@lfcode.ca>

Remove superfluous definition of speed

fbb9356

fix(variable): remove unused variable

56e6906

jceb force-pushed the feature_kinetic_mouse_movement branch from 1e40fb5 to 56e6906 Compare December 22, 2020 09:31

drashna merged commit 010271d into qmk:develop Dec 24, 2020

mohammedari mentioned this pull request Mar 2, 2021

[Bug] MK_KINETIC_SPEED seems not to be fully functional #12082

Closed

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement kinetic mouse movement algorithm #6739

Implement kinetic mouse movement algorithm #6739

jceb commented Sep 15, 2019

jceb commented Sep 29, 2019

hugovk left a comment

thiagoyeds left a comment •

edited

Loading

thiagoyeds left a comment

lf- left a comment

samagragupta left a comment •

edited by yanfali

Loading

jceb commented Oct 27, 2019

drashna commented Dec 17, 2020

jceb commented Dec 21, 2020

Erovia commented Dec 21, 2020

jceb commented Dec 22, 2020

kareltucek commented Mar 28, 2021 •

edited

Loading

jceb commented Mar 30, 2021

kareltucek commented Mar 30, 2021 •

edited

Loading

Lilalas commented Aug 18, 2021

fauxpark commented Aug 19, 2021

Lilalas commented Aug 19, 2021

fauxpark commented Aug 19, 2021 •

edited

Loading

Implement kinetic mouse movement algorithm #6739

Implement kinetic mouse movement algorithm #6739

Conversation

jceb commented Sep 15, 2019

Description

Types of Changes

Issues Fixed or Closed by This PR

Checklist

jceb commented Sep 29, 2019

hugovk left a comment

Choose a reason for hiding this comment

thiagoyeds left a comment • edited Loading

Choose a reason for hiding this comment

thiagoyeds left a comment

Choose a reason for hiding this comment

lf- left a comment

Choose a reason for hiding this comment

samagragupta left a comment • edited by yanfali Loading

Choose a reason for hiding this comment

jceb commented Oct 27, 2019

drashna commented Dec 17, 2020

jceb commented Dec 21, 2020

Erovia commented Dec 21, 2020

jceb commented Dec 22, 2020

kareltucek commented Mar 28, 2021 • edited Loading

jceb commented Mar 30, 2021

kareltucek commented Mar 30, 2021 • edited Loading

Lilalas commented Aug 18, 2021

fauxpark commented Aug 19, 2021

Lilalas commented Aug 19, 2021

fauxpark commented Aug 19, 2021 • edited Loading

thiagoyeds left a comment •

edited

Loading

samagragupta left a comment •

edited by yanfali

Loading

kareltucek commented Mar 28, 2021 •

edited

Loading

kareltucek commented Mar 30, 2021 •

edited

Loading

fauxpark commented Aug 19, 2021 •

edited

Loading