forked from kofal.net/zmk
refactor(docs): Convert the keymaps section into a base folder (#2430)
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
This commit is contained in:
71
docs/docs/keymaps/behaviors/mouse-emulation.md
Normal file
71
docs/docs/keymaps/behaviors/mouse-emulation.md
Normal file
@@ -0,0 +1,71 @@
|
||||
---
|
||||
title: Mouse Emulation Behaviors
|
||||
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.
|
||||
|
||||
:::warning[Refreshing the HID descriptor]
|
||||
|
||||
Enabling or disabling the mouse emulation feature modifies the HID report descriptor and requires it to be [refreshed](../../features/bluetooth.md#refreshing-the-hid-descriptor).
|
||||
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:
|
||||
|
||||
```
|
||||
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
|
||||
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>
|
||||
```
|
||||
|
||||
## Mouse Button Press
|
||||
|
||||
This behavior can press/release up to 5 mouse buttons.
|
||||
|
||||
### Behavior Binding
|
||||
|
||||
- Reference: `&mkp`
|
||||
- Parameter: A `uint8` with bits 0 through 4 each referring to a button.
|
||||
|
||||
The following defines can be passed for the parameter:
|
||||
|
||||
| Define | Action |
|
||||
| :------------ | :------------- |
|
||||
| `MB1`, `LCLK` | Left click |
|
||||
| `MB2`, `RCLK` | Right click |
|
||||
| `MB3`, `MCLK` | Middle click |
|
||||
| `MB4` | Mouse button 4 |
|
||||
| `MB5` | Mouse button 5 |
|
||||
|
||||
Mouse buttons 4 and 5 typically map to "back" and "forward" actions in most applications.
|
||||
|
||||
### Examples
|
||||
|
||||
The following will send a left click press when the binding is triggered:
|
||||
|
||||
```
|
||||
&mkp LCLK
|
||||
```
|
||||
|
||||
This example will send press of the fourth mouse button when the binding is triggered:
|
||||
|
||||
```
|
||||
&mkp MB4
|
||||
```
|
||||
Reference in New Issue
Block a user