Fix kinetic mouse mode

[yorickpeterse]

Description

Kinetic mouse mode is currently broken, as described in #12082 and #13711.

The PR #11766 introduced a set of fixes in early 2021. This PR was closed in favour of ongoing refactoring of QMK's mouse code (see #11766 (comment) and #12082 (comment)).

Since the mentioned comments, it appears nothing has been merged in order to fix kinetic mode, meaning kinetic mode is still broken. This commit adopts the changes from the pull request that was originally supposed to fix the problem, and updates the changes to handle recent changes to the mousekey.c file.

These changes have been tested with my personal keyboard, and result in kinetic mode working as advertised.

Types of Changes

• Core
• Bugfix
• New feature
• Enhancement/optimization
• Keyboard (addition or update)
• Keymap/layout/userspace (addition or update)
• Documentation

Issues Fixed or Closed by This PR

Fixes #12082
Fixes #13711

Checklist

• My code follows the code style of this project: C, Python
• I have read the PR Checklist document and have made the appropriate changes.
• I have read the CONTRIBUTING document.
• I have tested the changes and verified that they work and don't break anything (as well as I can manage).

[filterpaper]

Are you using the default kinetic mode settings in the documentation? They seem rather slow with MK_KINETIC_SPEED defined. If you have more optimal speed settings that are good baseline, can you set them as core defaults and in the documentation too?

[yorickpeterse]

@filterpaper Honestly I think that's out of the scope of these changes. This PR simply fixes kinetic scrolling, which right now doesn't work as advertised. If we also start changing the defaults, this has a risk of dragging out the PR as people start arguing what those defaults should be. As such, changing the defaults is best done separately (if needed at all).

[tzarc]

As such, changing the defaults is best done separately (if needed at all).

Sounds like a plan.

Anyways, thanks for the addition!

[drashna]

Unfortunately, this seems to break the scrolling. It moves one tick, and then stops.

[yorickpeterse]

@drashna That's not the behaviour I'm seeing: scrolling when kinetic scrolling is enabled is working fine for me. Are you sure it's not caused by something else?

[drashna]

I'm not sure it's effecting the mouse movement, but it is with the scroll.

I tried it on several different boards, and even different architectures (avr, arm). And it's consistent between them. I noticed this on my tractyl manuform initially. The scroll keys work fine on the encoder, because it sends them repeatedly. But in the keymap...

And because that does use the pointing device stuff, I wasn't sure if it was some sort of overlap.

However, testing this out on other boards produces the same issue.

For now, it's being reverted, so that we don't risk causing issues for people when develop lands in a couple of weeks. But I am interested in pursuing this issue and getting things working properly.

[filterpaper]

Unfortunately, this seems to break the scrolling. It moves one tick, and then stops.

I didn't tried it initially but I can confirm that mouse wheel moves only a single tick when KC_WH_D/KC_WH_U is held down. This is tested on both AVR and RP2040.

[filterpaper]

This should restore the mouse wheel scroll function:

 static uint8_t wheel_unit(void) {
     float speed = MOUSEKEY_WHEEL_INITIAL_MOVEMENTS;

     if (mousekey_accel & ((1 << 0) | (1 << 2))) {
         speed = mousekey_accel & (1 << 2) ? MOUSEKEY_WHEEL_ACCELERATED_MOVEMENTS : MOUSEKEY_WHEEL_DECELERATED_MOVEMENTS;
-    } else if (mousekey_repeat && mouse_timer) {
+    } else if (mousekey_wheel_repeat && mouse_timer) {
         if (mk_wheel_interval != MOUSEKEY_WHEEL_BASE_MOVEMENTS) {
             const float time_elapsed = timer_elapsed(mouse_timer) / 50;
             speed                    = MOUSEKEY_WHEEL_INITIAL_MOVEMENTS + 1 * time_elapsed + 1 * 0.5 * time_elapsed * time_elapsed;
@@ -164,10 +167,12 @@ static uint8_t wheel_unit(void) {

     mk_wheel_interval = 1000.0f / speed;

-    return 1;
+    return speed > MOUSEKEY_WHEEL_INITIAL_MOVEMENTS ? 2 : 1;
 }