kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

feat(mouse): Updated mouse keys docs.

Browse source
This commit is contained in:
Peter Johanson 2024-04-10 04:55:14 +00:00
parent 37ba9eb527
commit d45cb3c26f
2 changed files with 68 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/docs/behaviors/index.mdx
View file

@ -43,6 +43,8 @@ Below is a summary of pre-defined behavior bindings and user-definable behaviors
| Binding | Behavior | Description |
| ------- | ----------------------------------------------------------- | ------------------------------- |
| `&mkp` | [Mouse Button Press](mouse-emulation.md#mouse-button-press) | Emulates pressing mouse buttons |
| `&mmv` | [Mouse Button Press](mouse-emulation.md#mouse-move) | Emulates mouse movement |
| `&msc` | [Mouse Button Press](mouse-emulation.md#mouse-scroll) | Emulates mouse scrolling |
## Reset Behaviors

71
docs/docs/behaviors/mouse-emulation.md
View file

@ -5,8 +5,7 @@ sidebar_label: Mouse Emulation
## Summary
Mouse emulation behaviors send mouse events. Currently, only mouse button presses are supported, but movement
and scroll action support is planned for the future.
Mouse emulation behaviors send mouse events, including mouse button presses, cursor movement and scrolling.
:::warning[Refreshing the HID descriptor]
@ -17,14 +16,12 @@ The mouse functionality will not work over BLE until that is done.
## Configuration Option
This feature can be enabled or disabled explicitly via a config option:
To use any of the behaviors documented here, the ZMK mouse feature must be enabled explicitly via a config option:
```
CONFIG_ZMK_MOUSE=y
```
If you use the mouse key press behavior in your keymap, the feature will automatically be enabled for you.
## Mouse Button Defines
To make it easier to encode the HID mouse button numeric values, include
@ -69,3 +66,67 @@ This example will send press of the fourth mouse button when the binding is trig
```
&mkp MB4
```
## Mouse Move
This behavior sends mouse X/Y movement events to the connected host.
### Behavior Binding
- Reference: `&mmv`
- Parameter: A `uint32` with 16-bits each used for vertical and horizontal velocity.
The following defines can be passed for the parameter:
| Define | Action |
| :----------- | :--------- |
| `MOVE_UP` | Move up |
| `MOVE_DOWN` | Move down |
| `MOVE_LEFT` | Move left |
| `MOVE_RIGHT` | Move right |
### Examples
The following will send a scroll down event to the host when pressed/held:
```
&mmv MOVE_DOWN
```
The following will send a scroll left event to the host when pressed/held:
```
&mmv MOVE_LEFT
```
## Mouse Scroll
This behavior sends vertical and horizontal scroll events to the connected host.
### Behavior Binding
- Reference: `&msc`
- Parameter: A `uint32` with 16-bits each used for vertical and horizontal velocity.
The following defines can be passed for the parameter:
| Define | Action |
| :----------- | :--------- |
| `MOVE_UP` | Move up |
| `MOVE_DOWN` | Move down |
| `MOVE_LEFT` | Move left |
| `MOVE_RIGHT` | Move right |
### Examples
The following will send a scroll down event to the host when pressed/held:
```
&msc MOVE_DOWN
```
The following will send a scroll left event to the host when pressed/held:
```
&msc MOVE_LEFT
```