diff --git a/docs/docs/behaviors/mouse-emulation.md b/docs/docs/behaviors/mouse-emulation.md new file mode 100644 index 00000000000..e3b74048eda --- /dev/null +++ b/docs/docs/behaviors/mouse-emulation.md @@ -0,0 +1,69 @@ +--- +title: Mouse Emulation Behaviors +sidebar_label: Mouse Emulation +--- + +## Summary + +Mouse emulation behaviors send mouse movements, button presses or wheel 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. + +## 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 +``` + +Doing so allows using a set of defines such as `MOVE_UP`, `MOVE_DOWN`, `LCLK` and `WHEEL_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 Wheel + +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 WHEEL_UP +``` diff --git a/docs/docs/behaviors/mouse-move.md b/docs/docs/behaviors/mouse-move.md deleted file mode 100644 index 91ef666fdfe..00000000000 --- a/docs/docs/behaviors/mouse-move.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Mouse Move Behavior -sidebar_label: Mouse Move ---- - -## Summary - -Mouse move behavior allows to send keycode signals of mouse movement. - -Please visit 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. - -## 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 -``` - -Doing so makes a set of defines such as `MOVE_UP`, `MOVE_DOWN`, `MOVE_LEFT` and `MOVE_RIGHT` available for use with these behaviors. - -## Mouse press - -The "mouse move" behavior sends standard keycodes on press/release. - -### Behavior Binding - -- Reference: `&mmv` -- Parameter: The keycode usage ID. - -Example: - -``` -&mmv MOVE_UP -``` diff --git a/docs/docs/behaviors/mouse-press.md b/docs/docs/behaviors/mouse-press.md deleted file mode 100644 index 3fad8e5d4cd..00000000000 --- a/docs/docs/behaviors/mouse-press.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Mouse Press Behavior -sidebar_label: Mouse Press ---- - -## Summary - -Mouse press behavior allows to send keycode presses and releases of mouse buttons. - -Please visit view [`dt-bindings/zmk/mouse.h`](https://github.com/zmkfirmware/zmk/blob/main/app/include/dt-bindings/zmk/mouse.h) for a comprehensive list. - -## 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 -``` - -Doing so makes a set of defines such as `LCLK`, `RCLK`, etc. available for use with these behaviors - -## Mouse press - -The "mouse press" behavior sends standard keycodes on press/release. - -### Behavior Binding - -- Reference: `&mp` -- Parameter: The keycode usage ID. - -Example: - -``` -&mp LCLK -``` diff --git a/docs/docs/behaviors/mouse-wheel.md b/docs/docs/behaviors/mouse-wheel.md deleted file mode 100644 index 5bf21e4cde3..00000000000 --- a/docs/docs/behaviors/mouse-wheel.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Mouse Wheel Behavior -sidebar_label: Mouse Wheel ---- - -## Summary - -Mouse wheel behavior allows to send keycode signals of mouse wheel scrolling. - -## 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 -``` - -Doing so makes a set of defines such as `WHEEL_UP`, `WHEEL_DOWN`, `WHEEL_LEFT` and `WHEEL_RIGHT` available for use with these behaviors. - -## Mouse wheel - -The "mouse wheel" behavior sends standard keycodes on press/release. - -### Behavior Binding - -- Reference: `&mwh` -- Parameter: The keycode usage ID. - -Example: - -``` -&mwh WHEEL_UP -```