mirror of
https://github.com/qmk/qmk_firmware
synced 2024-11-18 18:04:57 +00:00
c66df16644
* Branch point for 2020 November 28 Breaking Change * Remove matrix_col_t to allow MATRIX_ROWS > 32 (#10183) * Add support for soft serial to ATmega32U2 (#10204) * Change MIDI velocity implementation to allow direct control of velocity value (#9940) * Add ability to build a subset of all keyboards based on platform. * Actually use eeprom_driver_init(). * Make bootloader_jump weak for ChibiOS. (#10417) * Joystick 16-bit support (#10439) * Per-encoder resolutions (#10259) * Share button state from mousekey to pointing_device (#10179) * Add hotfix for chibios keyboards not wake (#10088) * Add advanced/efficient RGB Matrix Indicators (#8564) * Naming change. * Support for STM32 GPIOF,G,H,I,J,K (#10206) * Add milc as a dependency and remove the installed milc (#10563) * ChibiOS upgrade: early init conversions (#10214) * ChibiOS upgrade: configuration file migrator (#9952) * Haptic and solenoid cleanup (#9700) * XD75 cleanup (#10524) * OLED display update interval support (#10388) * Add definition based on currently-selected serial driver. (#10716) * New feature: Retro Tapping per key (#10622) * Allow for modification of output RGB values when using rgblight/rgb_matrix. (#10638) * Add housekeeping task callbacks so that keyboards/keymaps are capable of executing code for each main loop iteration. (#10530) * Rescale both ChibiOS and AVR backlighting. * Reduce Helix keyboard build variation (#8669) * Minor change to behavior allowing display updates to continue between task ticks (#10750) * Some GPIO manipulations in matrix.c change to atomic. (#10491) * qmk cformat (#10767) * [Keyboard] Update the Speedo firmware for v3.0 (#10657) * Maartenwut/Maarten namechange to evyd13/Evy (#10274) * [quantum] combine repeated lines of code (#10837) * Add step sequencer feature (#9703) * aeboards/ext65 refactor (#10820) * Refactor xelus/dawn60 for Rev2 later (#10584) * add DEBUG_MATRIX_SCAN_RATE_ENABLE to common_features.mk (#10824) * [Core] Added `add_oneshot_mods` & `del_oneshot_mods` (#10549) * update chibios os usb for the otg driver (#8893) * Remove HD44780 References, Part 4 (#10735) * [Keyboard] Add Valor FRL TKL (+refactor) (#10512) * Fix cursor position bug in oled_write_raw functions (#10800) * Fixup version.h writing when using SKIP_VERSION=yes (#10972) * Allow for certain code in the codebase assuming length of string. (#10974) * Add AT90USB support for serial.c (#10706) * Auto shift: support repeats and early registration (#9826) * Rename ledmatrix.h to match .c file (#7949) * Split RGB_MATRIX_ENABLE into _ENABLE and _DRIVER (#10231) * Split LED_MATRIX_ENABLE into _ENABLE and _DRIVER (#10840) * Merge point for 2020 Nov 28 Breaking Change
146 lines
8.1 KiB
Markdown
146 lines
8.1 KiB
Markdown
# Mouse keys
|
||
|
||
Mouse keys is a feature that allows you to emulate a mouse using your keyboard. You can move the pointer at different speeds, press 5 buttons and scroll in 8 directions.
|
||
|
||
## Adding mouse keys to your keyboard
|
||
|
||
To use mouse keys, you must at least enable mouse keys support and map mouse actions to keys on your keyboard.
|
||
|
||
### Enabling mouse keys
|
||
|
||
To enable mouse keys, add the following line to your keymap’s `rules.mk`:
|
||
|
||
```c
|
||
MOUSEKEY_ENABLE = yes
|
||
```
|
||
|
||
### Mapping mouse actions
|
||
|
||
In your keymap you can use the following keycodes to map key presses to mouse actions:
|
||
|
||
|Key |Aliases |Description |
|
||
|----------------|---------|-----------------|
|
||
|`KC_MS_UP` |`KC_MS_U`|Move cursor up |
|
||
|`KC_MS_DOWN` |`KC_MS_D`|Move cursor down |
|
||
|`KC_MS_LEFT` |`KC_MS_L`|Move cursor left |
|
||
|`KC_MS_RIGHT` |`KC_MS_R`|Move cursor right|
|
||
|`KC_MS_BTN1` |`KC_BTN1`|Press button 1 |
|
||
|`KC_MS_BTN2` |`KC_BTN2`|Press button 2 |
|
||
|`KC_MS_BTN3` |`KC_BTN3`|Press button 3 |
|
||
|`KC_MS_BTN4` |`KC_BTN4`|Press button 4 |
|
||
|`KC_MS_BTN5` |`KC_BTN5`|Press button 5 |
|
||
|`KC_MS_WH_UP` |`KC_WH_U`|Move wheel up |
|
||
|`KC_MS_WH_DOWN` |`KC_WH_D`|Move wheel down |
|
||
|`KC_MS_WH_LEFT` |`KC_WH_L`|Move wheel left |
|
||
|`KC_MS_WH_RIGHT`|`KC_WH_R`|Move wheel right |
|
||
|`KC_MS_ACCEL0` |`KC_ACL0`|Set speed to 0 |
|
||
|`KC_MS_ACCEL1` |`KC_ACL1`|Set speed to 1 |
|
||
|`KC_MS_ACCEL2` |`KC_ACL2`|Set speed to 2 |
|
||
|
||
## Configuring mouse keys
|
||
|
||
Mouse keys supports three different modes to move the cursor:
|
||
|
||
* **Accelerated (default):** Holding movement keys accelerates the cursor until it reaches its maximum speed.
|
||
* **Constant:** Holding movement keys moves the cursor at constant speeds.
|
||
* **Combined:** Holding movement keys accelerates the cursor until it reaches its maximum speed, but holding acceleration and movement keys simultaneously moves the cursor at constant speeds.
|
||
|
||
The same principle applies to scrolling.
|
||
|
||
Configuration options that are times, intervals or delays are given in milliseconds. Scroll speed is given as multiples of the default scroll step. For example, a scroll speed of 8 means that each scroll action covers 8 times the length of the default scroll step as defined by your operating system or application.
|
||
|
||
### Accelerated mode
|
||
|
||
This is the default mode. You can adjust the cursor and scrolling acceleration using the following settings in your keymap’s `config.h` file:
|
||
|
||
|Define |Default|Description |
|
||
|----------------------------|-------|---------------------------------------------------------|
|
||
|`MOUSEKEY_DELAY` |300 |Delay between pressing a movement key and cursor movement|
|
||
|`MOUSEKEY_INTERVAL` |50 |Time between cursor movements |
|
||
|`MOUSEKEY_MAX_SPEED` |10 |Maximum cursor speed at which acceleration stops |
|
||
|`MOUSEKEY_TIME_TO_MAX` |20 |Time until maximum cursor speed is reached |
|
||
|`MOUSEKEY_WHEEL_DELAY` |300 |Delay between pressing a wheel key and wheel movement |
|
||
|`MOUSEKEY_WHEEL_INTERVAL` |100 |Time between wheel movements |
|
||
|`MOUSEKEY_WHEEL_MAX_SPEED` |8 |Maximum number of scroll steps per scroll action |
|
||
|`MOUSEKEY_WHEEL_TIME_TO_MAX`|40 |Time until maximum scroll speed is reached |
|
||
|
||
Tips:
|
||
|
||
* Setting `MOUSEKEY_DELAY` too low makes the cursor unresponsive. Setting it too high makes small movements difficult.
|
||
* For smoother cursor movements, lower the value of `MOUSEKEY_INTERVAL`. If the refresh rate of your display is 60Hz, you could set it to `16` (1/60). As this raises the cursor speed significantly, you may want to lower `MOUSEKEY_MAX_SPEED`.
|
||
* Setting `MOUSEKEY_TIME_TO_MAX` or `MOUSEKEY_WHEEL_TIME_TO_MAX` to `0` will disable acceleration for the cursor or scrolling respectively. This way you can make one of them constant while keeping the other accelerated, which is not possible in constant speed mode.
|
||
* Setting `MOUSEKEY_WHEEL_INTERVAL` too low will make scrolling too fast. Setting it too high will make scrolling too slow when the wheel key is held down.
|
||
|
||
Cursor acceleration uses the same algorithm as the X Window System MouseKeysAccel feature. You can read more about it [on Wikipedia](https://en.wikipedia.org/wiki/Mouse_keys).
|
||
|
||
### Constant mode
|
||
|
||
In this mode you can define multiple different speeds for both the cursor and the mouse wheel. There is no acceleration. `KC_ACL0`, `KC_ACL1` and `KC_ACL2` change the cursor and scroll speed to their respective setting.
|
||
|
||
You can choose whether speed selection is momentary or tap-to-select:
|
||
|
||
* **Momentary:** The chosen speed is only active while you hold the respective key. When the key is raised, mouse keys returns to the unmodified speed.
|
||
* **Tap-to-select:** The chosen speed is activated when you press the respective key and remains active even after the key has been raised. The default speed is that of `KC_ACL1`. There is no unmodified speed.
|
||
|
||
The default speeds from slowest to fastest are as follows:
|
||
|
||
* **Momentary:** `KC_ACL0` < `KC_ACL1` < *unmodified* < `KC_ACL2`
|
||
* **Tap-to-select:** `KC_ACL0` < `KC_ACL1` < `KC_ACL2`
|
||
|
||
To use constant speed mode, you must at least define `MK_3_SPEED` in your keymap’s `config.h` file:
|
||
|
||
```c
|
||
#define MK_3_SPEED
|
||
```
|
||
|
||
To enable momentary mode, also define `MK_MOMENTARY_ACCEL`:
|
||
|
||
```c
|
||
#define MK_MOMENTARY_ACCEL
|
||
```
|
||
|
||
Use the following settings if you want to adjust cursor movement or scrolling:
|
||
|
||
|Define |Default |Description |
|
||
|---------------------|-------------|-------------------------------------------|
|
||
|`MK_3_SPEED` |*Not defined*|Enable constant cursor speeds |
|
||
|`MK_MOMENTARY_ACCEL` |*Not defined*|Enable momentary speed selection |
|
||
|`MK_C_OFFSET_UNMOD` |16 |Cursor offset per movement (unmodified) |
|
||
|`MK_C_INTERVAL_UNMOD`|16 |Time between cursor movements (unmodified) |
|
||
|`MK_C_OFFSET_0` |1 |Cursor offset per movement (`KC_ACL0`) |
|
||
|`MK_C_INTERVAL_0` |32 |Time between cursor movements (`KC_ACL0`) |
|
||
|`MK_C_OFFSET_1` |4 |Cursor offset per movement (`KC_ACL1`) |
|
||
|`MK_C_INTERVAL_1` |16 |Time between cursor movements (`KC_ACL1`) |
|
||
|`MK_C_OFFSET_2` |32 |Cursor offset per movement (`KC_ACL2`) |
|
||
|`MK_C_INTERVAL_2` |16 |Time between cursor movements (`KC_ACL2`) |
|
||
|`MK_W_OFFSET_UNMOD` |1 |Scroll steps per scroll action (unmodified)|
|
||
|`MK_W_INTERVAL_UNMOD`|40 |Time between scroll steps (unmodified) |
|
||
|`MK_W_OFFSET_0` |1 |Scroll steps per scroll action (`KC_ACL0`) |
|
||
|`MK_W_INTERVAL_0` |360 |Time between scroll steps (`KC_ACL0`) |
|
||
|`MK_W_OFFSET_1` |1 |Scroll steps per scroll action (`KC_ACL1`) |
|
||
|`MK_W_INTERVAL_1` |120 |Time between scroll steps (`KC_ACL1`) |
|
||
|`MK_W_OFFSET_2` |1 |Scroll steps per scroll action (`KC_ACL2`) |
|
||
|`MK_W_INTERVAL_2` |20 |Time between scroll steps (`KC_ACL2`) |
|
||
|
||
### Combined mode
|
||
|
||
This mode functions like **Accelerated** mode, however, you can hold `KC_ACL0`, `KC_ACL1` and `KC_ACL2`
|
||
to momentarily (while held) set the cursor and scroll speeds to constant speeds. When no acceleration
|
||
keys are held, this mode is identical to **Accelerated** mode, and can be modified using all of the
|
||
relevant settings.
|
||
|
||
* **KC_ACL0:** This acceleration sets your cursor to the slowest possible speed. This is useful for very
|
||
small and detailed movements of the cursor.
|
||
* **KC_ACL1:** This acceleration sets your cursor to half the maximum (user defined) speed.
|
||
* **KC_ACL2:** This acceleration sets your cursor to the maximum (computer defined) speed. This is
|
||
useful for moving the cursor large distances without much accuracy.
|
||
|
||
To use constant speed mode, you must at least define `MK_COMBINED` in your keymap’s `config.h` file:
|
||
|
||
```c
|
||
#define MK_COMBINED
|
||
```
|
||
|
||
## Use with PS/2 Mouse and Pointing Device
|
||
|
||
Mouse keys button state is shared with [PS/2 mouse](feature_ps2_mouse.md) and [pointing device](feature_pointing_device.md) so mouse keys button presses can be used for clicks and drags.
|