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.

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

Improve mouse keys docs and constant speed mode #3375

Merged
merged 1 commit into from
Apr 19, 2019
Merged

Improve mouse keys docs and constant speed mode #3375

merged 1 commit into from
Apr 19, 2019

Conversation

Markus00000
Copy link
Contributor

@Markus00000 Markus00000 commented Jul 11, 2018

General changes

  • Make default speed settings more consistent across modes:
    • In accelerated and constant+momentary mode, one setting is faster than unmodified speed and two settings are slower
    • In constant+tap-to-select mode, there is no unmodified speed
  • Improve documentation

Changes to constant speed modes

  • Add an unmodified speed that is used in momentary mode when no KC_ACLx key is pressed
    • This gives users another speed setting without introducing new key codes
    • Previously, one key code (KC_ACL1) had no effect because its speed was identical to the unmodified speed, which could confuse users and made one key code useless
  • The speeds are named 0, 1, 2, thus corresponding to their respective key codes KC_ACL0, KC_ACL1, KC_ACL2
    • Easier to configure as one no longer needs to translate between speed descriptions (“SLOW”) and numbers (KC_ACL0) and, for example, a user’s fastest speed can no longer have SLOW in its variable name
    • Furthermore, the SLOW, MEDIUM, FAST naming scheme did not indicate where the unmodified speed in momentary mode should be placed in the series
  • Use sensible default settings (YMMV…)

(The original PR has since been merged. Consequently, the following description is no longer useful.)

This recreates pull request #2246 from @JonArintok (unresolved conflicts) with few changes.

Mousekeys can be configured to use three different, constant speeds for cursor movements and wheel scrolling.

(I am not sure if the long if-else blocks in mousekey.c and mousekey.h should be refactored.)

Copy link
Member

@skullydazed skullydazed left a comment

Choose a reason for hiding this comment

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

The code looks great. If we can fix up the docs a little bit this will be a perfect PR.

docs/feature_mouse_keys.md Outdated Show resolved Hide resolved
docs/feature_mouse_keys.md Outdated Show resolved Hide resolved
docs/feature_mouse_keys.md Outdated Show resolved Hide resolved
docs/feature_mouse_keys.md Outdated Show resolved Hide resolved
@Markus00000
Copy link
Contributor Author

Markus00000 commented Oct 10, 2018

@skullydazed I have incorporated your suggestions.

I have made numerous changes to the documentation and renamed MK_MOMENTARY_ACCEL to MK_MOMENTARY_SPEED as there is no acceleration involved.

Would it be useful to add the configuration options in a format that allows copy and paste into config.h? Writing 14 definitions is cumbersome.

#define MK_3_SPEED
#define MK_MOMENTARY_SPEED
#define MK_C_OFFSET_SLOW   1
#define MK_C_INTERVAL_SLOW 100
...

Please let me know if you notice any issues or if you have suggestions.

@Markus00000 Markus00000 changed the title Add Mousekeys support for constant speeds Improve constant speed mode of mouse keys Mar 31, 2019
@Markus00000 Markus00000 changed the title Improve constant speed mode of mouse keys Improve mouse keys docs and constant speed mode Mar 31, 2019
@drashna drashna merged commit e3a9400 into qmk:master Apr 19, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants