You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
111 lines
2.4 KiB
111 lines
2.4 KiB
2 years ago
|
---
|
||
|
|
title: Mouse Emulation Behaviors
|
||
|
|
sidebar_label: Mouse Emulation
|
||
|
|
---
|
||
|
|
|
||
|
|
## Summary
|
||
|
|
|
||
|
|
Mouse emulation behaviors send mouse movements, button presses or scroll actions.
|
||
|
|
|
||
|
|
Please view [`dt-bindings/zmk/mouse.h`](https://github.com/zmkfirmware/zmk/blob/main/app/include/dt-bindings/zmk/mouse.h) for a comprehensive list of signals.
|
||
|
|
|
||
|
|
## Configuration options
|
||
|
|
|
||
|
|
This feature should be enabled via a config option:
|
||
|
|
|
||
|
|
```
|
||
|
|
CONFIG_ZMK_MOUSE=y
|
||
|
|
```
|
||
|
|
|
||
|
|
This option enables several others.
|
||
|
|
|
||
|
|
### Dedicated thread processing
|
||
|
|
|
||
|
|
`CONFIG_ZMK_MOUSE_WORK_QUEUE_DEDICATED` is enabled by default and separates the processing of mouse signals into a dedicated thread, significantly improving performance.
|
||
|
|
|
||
|
|
### Tick rate configuration
|
||
|
|
|
||
|
|
`CONFIG_ZMK_MOUSE_TICK_DURATION` sets the tick rate for mouse polling. It is set to 8 ms. by default.
|
||
|
|
|
||
|
|
## Keycode Defines
|
||
|
|
|
||
|
|
To make it easier to encode the HID keycode numeric values, most keymaps include
|
||
|
|
the [`dt-bindings/zmk/mouse.h`](https://github.com/zmkfirmware/zmk/blob/main/app/include/dt-bindings/zmk/mouse.h) header
|
||
|
|
provided by ZMK near the top:
|
||
|
|
|
||
|
|
```
|
||
|
|
#include <dt-bindings/zmk/mouse.h>
|
||
|
|
```
|
||
|
|
|
||
|
|
Doing so allows using a set of defines such as `MOVE_UP`, `MOVE_DOWN`, `LCLK` and `SCROLL_UP` with these behaviors.
|
||
|
|
|
||
|
|
## Mouse Button Press
|
||
|
|
|
||
|
|
This behavior can press/release up to 16 mouse buttons.
|
||
|
|
|
||
|
|
### Behavior Binding
|
||
|
|
|
||
|
|
- Reference: `&mkp`
|
||
|
|
- Parameter: A `uint16` with each bit referring to a button.
|
||
|
|
|
||
|
|
Example:
|
||
|
|
|
||
|
|
```
|
||
|
|
&mkp LCLK
|
||
|
|
```
|
||
|
|
|
||
|
|
## Mouse Movement
|
||
|
|
|
||
|
|
This behavior is used to manipulate the cursor.
|
||
|
|
|
||
|
|
### Behavior Binding
|
||
|
|
|
||
|
|
- Reference: `&mmv`
|
||
|
|
- Parameter: A `uint32` with the first 16 bits relating to horizontal movement
|
||
|
|
and the last 16 - to vertical movement.
|
||
|
|
|
||
|
|
Example:
|
||
|
|
|
||
|
|
```
|
||
|
|
&mmv MOVE_UP
|
||
|
|
```
|
||
|
|
|
||
|
|
## Mouse Scrolling
|
||
|
|
|
||
|
|
This behaviour is used to scroll, both horizontally and vertically.
|
||
|
|
|
||
|
|
### Behavior Binding
|
||
|
|
|
||
|
|
- Reference: `&mwh`
|
||
|
|
- Parameter: A `uint16` with the first 8 bits relating to horizontal movement
|
||
|
|
and the last 8 - to vertical movement.
|
||
|
|
|
||
|
|
Example:
|
||
|
|
|
||
|
|
```
|
||
|
|
&mwh SCROLL_UP
|
||
|
|
```
|
||
|
|
|
||
|
|
## Acceleration
|
||
|
|
|
||
|
|
Both mouse movement and scrolling have independently configurable acceleration profiles with three parameters: delay before movement, time to max speed and the acceleration exponent.
|
||
|
|
The exponent is usually set to 0 for constant speed, 1 for uniform acceleration or 2 for uniform jerk.
|
||
|
|
|
||
|
|
These profiles can be configured inside your keymap:
|
||
|
|
|
||
|
|
```
|
||
|
|
&mmv {
|
||
|
|
time-to-max-speed-ms = <500>;
|
||
|
|
};
|
||
|
|
|
||
|
|
&mwh {
|
||
|
|
acceleration-exponent=<1>;
|
||
|
|
};
|
||
|
|
|
||
|
|
/ {
|
||
|
|
keymap {
|
||
|
|
...
|
||
|
|
};
|
||
|
|
};
|
||
|
|
```
|