Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Nicolas Munnich <[email protected]>
Co-authored-by: Cem Aksoylar <[email protected]>
  • Loading branch information
3 people authored Dec 6, 2024
1 parent a1f72ff commit ccd8696
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/docs/config/pointing.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ Applies to: `compatible = "zmk,input-listener"`
Definition file: [zmk/app/dts/bindings/zmk,input-listener.yaml](https://github.com/zmkfirmware/zmk/blob/main/app/dts/bindings/zmk%2Cinput-listener.yaml)

| Property | Type | Description |
| ------------------ | ------ | ------------------------------------------------------------------- | --- |
| ------------------ | ------ | ------------------------------------------------------------------- |
| `device` | phandle | Input device handle |
| `input-processors` | phandle-array | List of input processors (with parameters) to apply to input events | |
| `input-processors` | phandle-array | List of input processors (with parameters) to apply to input events |

#### Child Properties

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/development/hardware-integration/pointing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ title: Pointing Devices
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

ZMK's pointer support builds upon the Zephyr [input API](https://docs.zephyrproject.org/3.5.0/services/input/index.html) to offer pointer/mouse functionality with various hardware. A limited number of input drivers are available in the Zephyr 3.5 version currently used by ZMK, but additional drivers can be found in [external modules](../../features/modules.mdx) for a variety of hardware.
ZMK's pointing device support builds upon the Zephyr [input API](https://docs.zephyrproject.org/3.5.0/services/input/index.html) to offer pointing/mouse functionality with various hardware. A limited number of input drivers are available in the Zephyr 3.5 version currently used by ZMK, but additional drivers can be found in [external modules](../../features/modules.mdx) for a variety of hardware.

The details will depend on if you are adding a pointing device to a [split peripheral](../../features/split-keyboards.md#central-and-peripheral-roles) or to a unibody keyboard or split central part:
The details will depend on if you are adding a pointing device to a [split peripheral](../../features/split-keyboards.md#central-and-peripheral-roles) as opposed to a unibody keyboard or split central part:

<Tabs
defaultValue="central"
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/keymaps/behaviors/mouse-emulation.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ The following predefined values can be passed for the parameter:
| `MOVE_LEFT` | Move left |
| `MOVE_RIGHT` | Move right |

Additionally, if you want to pass a different max speed than the default for the `MOVE_*` defines, custom X and Y velocity values can be passed with `MOVE_X` and `MOVE_Y`, e.g. `MOVE_X(100)` or `MOVE_Y(-100)`.
Additionally, if you want to pass a different max speed than the default for the `MOVE_*` defines, custom X and Y velocity values can be passed with `MOVE_X` and `MOVE_Y`, e.g. `MOVE_X(100)` or `MOVE_Y(-100)`. Positive values indicate movement directions right or down.

### Examples

Expand Down Expand Up @@ -148,7 +148,7 @@ The following defines can be passed for the parameter:
| `SCRL_LEFT` | Scroll left |
| `SCRL_RIGHT` | Scroll right |

Additionally, if you want to pass a different max speed than the default for the `SCRL_*` defines, custom X and Y velocity values can be passed with `MOVE_X` and `MOVE_Y`, e.g. `MOVE_X(5)` or `MOVE_Y(-5)`.
Additionally, if you want to pass a different max speed than the default for the `SCRL_*` defines, custom X and Y velocity values can be passed with `MOVE_X` and `MOVE_Y`, e.g. `MOVE_X(5)` or `MOVE_Y(-5)`. Positive values indicate scroll directions right or up.

### Examples

Expand Down
2 changes: 2 additions & 0 deletions docs/docs/keymaps/input-processors/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,5 @@ If you want to have later overrides, or your base processors applied _after_ you
};
}
```

For more details, see the [Input Listener configuration](../../config/pointing.md#input-listener) section.

0 comments on commit ccd8696

Please sign in to comment.