summaryrefslogtreecommitdiff
path: root/docs/features/pointing_device.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/features/pointing_device.md')
-rw-r--r--docs/features/pointing_device.md928
1 files changed, 928 insertions, 0 deletions
diff --git a/docs/features/pointing_device.md b/docs/features/pointing_device.md
new file mode 100644
index 0000000000..a6bf521a18
--- /dev/null
+++ b/docs/features/pointing_device.md
@@ -0,0 +1,928 @@
1# Pointing Device {#pointing-device}
2
3Pointing Device is a generic name for a feature intended to be generic: moving the system pointer around. There are certainly other options for it - like mousekeys - but this aims to be easily modifiable and hardware driven. You can implement custom keys to control functionality, or you can gather information from other peripherals and insert it directly here - let QMK handle the processing for you.
4
5To enable Pointing Device, add the following line in your rules.mk and specify one of the driver options below.
6
7```make
8POINTING_DEVICE_ENABLE = yes
9```
10
11## Sensor Drivers
12
13There are a number of sensors that are supported by default. Note that only one sensor can be enabled by `POINTING_DEVICE_DRIVER` at a time. If you need to enable more than one sensor, then you need to implement it manually, using the `custom` driver.
14
15### ADNS 5050 Sensor
16
17To use the ADNS 5050 sensor, add this to your `rules.mk`
18
19```make
20POINTING_DEVICE_DRIVER = adns5050
21```
22
23The ADNS 5050 sensor uses a serial type protocol for communication, and requires an additional light source.
24
25| Setting (`config.h`) | Description | Default |
26| -------------------- | ------------------------------------------------------------------ | -------------------------- |
27| `ADNS5050_SCLK_PIN` | (Required) The pin connected to the clock pin of the sensor. | `POINTING_DEVICE_SCLK_PIN` |
28| `ADNS5050_SDIO_PIN` | (Required) The pin connected to the data pin of the sensor. | `POINTING_DEVICE_SDIO_PIN` |
29| `ADNS5050_CS_PIN` | (Required) The pin connected to the Chip Select pin of the sensor. | `POINTING_DEVICE_CS_PIN` |
30
31
32
33The CPI range is 125-1375, in increments of 125. Defaults to 500 CPI.
34
35### ADNS 9800 Sensor
36
37To use the ADNS 9800 sensor, add this to your `rules.mk`
38
39```make
40POINTING_DEVICE_DRIVER = adns9800
41```
42
43The ADNS 9800 is an SPI driven optical sensor, that uses laser output for surface tracking.
44
45| Setting (`config.h`) | Description | Default |
46| ----------------------- | ---------------------------------------------------------------------- | ------------------------ |
47| `ADNS9800_CLOCK_SPEED` | (Optional) Sets the clock speed that the sensor runs at. | `2000000` |
48| `ADNS9800_SPI_LSBFIRST` | (Optional) Sets the Least/Most Significant Byte First setting for SPI. | `false` |
49| `ADNS9800_SPI_MODE` | (Optional) Sets the SPI Mode for the sensor. | `3` |
50| `ADNS9800_SPI_DIVISOR` | (Optional) Sets the SPI Divisor used for SPI communication. | _varies_ |
51| `ADNS9800_CS_PIN` | (Required) Sets the Chip Select pin connected to the sensor. | `POINTING_DEVICE_CS_PIN` |
52
53
54The CPI range is 800-8200, in increments of 200. Defaults to 1800 CPI.
55
56### Analog Joystick
57
58To use an analog joystick to control the pointer, add this to your `rules.mk`
59
60```make
61POINTING_DEVICE_DRIVER = analog_joystick
62```
63
64The Analog Joystick is an analog (ADC) driven sensor. There are a variety of joysticks that you can use for this.
65
66| Setting (`config.h`) | Description | Default |
67| --------------------------------- | -------------------------------------------------------------------------- | ------------- |
68| `ANALOG_JOYSTICK_X_AXIS_PIN` | (Required) The pin used for the vertical/X axis. | _not defined_ |
69| `ANALOG_JOYSTICK_Y_AXIS_PIN` | (Required) The pin used for the horizontal/Y axis. | _not defined_ |
70| `ANALOG_JOYSTICK_AXIS_MIN` | (Optional) Sets the lower range to be considered movement. | `0` |
71| `ANALOG_JOYSTICK_AXIS_MAX` | (Optional) Sets the upper range to be considered movement. | `1023` |
72| `ANALOG_JOYSTICK_AUTO_AXIS` | (Optional) Sets ranges to be considered movement automatically. | _not defined_ |
73| `ANALOG_JOYSTICK_SPEED_REGULATOR` | (Optional) The divisor used to slow down movement. (lower makes it faster) | `20` |
74| `ANALOG_JOYSTICK_READ_INTERVAL` | (Optional) The interval in milliseconds between reads. | `10` |
75| `ANALOG_JOYSTICK_SPEED_MAX` | (Optional) The maximum value used for motion. | `2` |
76| `ANALOG_JOYSTICK_CLICK_PIN` | (Optional) The pin wired up to the press switch of the analog stick. | _not defined_ |
77| `ANALOG_JOYSTICK_WEIGHTS` | (Optional) Use custom weights for lever positions. | _not defined_ |
78| `ANALOG_JOYSTICK_CUTOFF` | (Optional) Cut off movement when joystick returns to start position. | _not defined_ |
79
80If `ANALOG_JOYSTICK_AUTO_AXIS` is used, then `ANALOG_JOYSTICK_AXIS_MIN` and `ANALOG_JOYSTICK_AXIS_MAX` are ignored.
81
82By default analog joystick implementation uses `x^2` weighting for lever positions. `ANALOG_JOYSTICK_WEIGHTS` allows to experiment with different configurations that might feel better.
83
84E.g. This is weights for `((x-0.4)^3+0.064)/0.282`:
85
86```c
87#define ANALOG_JOYSTICK_WEIGHTS {0,2,4,5,7,8,9,10,12,13,14,15,15,16,17,18,18,19,19,20,20,21,21,21,22,22,22,22,23,23,23,23,23,23,23,23,23,23,23,23,23,23,23,23,23,23,23,23,23,23,24,24,24,24,24,24,25,25,25,26,26,26,27,28,28,29,29,30,31,32,33,34,35,36,37,38,40,41,43,44,46,48,49,51,53,56,58,60,62,65,68,70,73,76,79,82,85,89,92,96,100}
88```
89
90You can use following JS code to generate weights for different formulas:
91
92```js
93JSON.stringify(Array.from(Array(101).keys()).map(x => Math.ceil((((x/100-0.4)**3+0.064)/0.282*100))))
94```
95
96### Azoteq IQS5XX Trackpad
97
98To use a Azoteq IQS5XX trackpad, add this to your `rules.mk`:
99
100```make
101POINTING_DEVICE_DRIVER = azoteq_iqs5xx
102```
103
104This supports the IQS525, IQS550 and IQS572 controllers, with the latter two being used in the TPS43 and TPS65 trackpads.
105
106#### Device settings
107
108Specific device profiles are provided which set the required values for dimensions and resolution.
109
110| Setting | Description |
111| -------------------------------- | ---------------------------------------------------------- |
112| `AZOTEQ_IQS5XX_TPS43` | (Pick One) Sets resolution/mm to TPS43 specifications. |
113| `AZOTEQ_IQS5XX_TPS65` | (Pick One) Sets resolution/mm to TPS65 specifications. |
114
115::: tip
116If using one of the above defines you can skip to gesture settings.
117:::
118
119| Setting | Description | Default |
120| -------------------------------- | ---------------------------------------------------------- | ------------- |
121| `AZOTEQ_IQS5XX_WIDTH_MM` | (Required) Width of the trackpad sensor in millimeters. | _not defined_ |
122| `AZOTEQ_IQS5XX_HEIGHT_MM` | (Required) Height of the trackpad sensor in millimeters. | _not defined_ |
123| `AZOTEQ_IQS5XX_RESOLUTION_X` | (Optional) Specify X resolution for CPI calculation. | _not defined_ |
124| `AZOTEQ_IQS5XX_RESOLUTION_Y` | (Optional) Specify Y resolution for CPI calculation. | _not defined_ |
125
126**`AZOTEQ_IQS5XX_RESOLUTION_X/Y`** fall back resolutions are provided within the driver based on controller model.
127
128| I2C Setting | Description | Default |
129| ------------------------- | ------------------------------------------------------------------------------- | ------- |
130| `AZOTEQ_IQS5XX_ADDRESS` | (Optional) Sets the I2C Address for the Azoteq trackpad | `0xE8` |
131| `AZOTEQ_IQS5XX_TIMEOUT_MS`| (Optional) The timeout for i2c communication with in milliseconds. | `10` |
132
133#### Gesture settings
134
135| Setting | Description | Default |
136| ----------------------------------------- | ------------------------------------------------------------------------------------ | ----------- |
137| `AZOTEQ_IQS5XX_TAP_ENABLE` | (Optional) Enable single finger tap. (Left click) | `true` |
138| `AZOTEQ_IQS5XX_TWO_FINGER_TAP_ENABLE` | (Optional) Enable two finger tap. (Right click) | `true` |
139| `AZOTEQ_IQS5XX_PRESS_AND_HOLD_ENABLE` | (Optional) Emulates holding left click to select text. | `false` |
140| `AZOTEQ_IQS5XX_SWIPE_X_ENABLE` | (Optional) Enable swipe gestures X+ (Mouse Button 5) / X- (Mouse Button 4) | `false` |
141| `AZOTEQ_IQS5XX_SWIPE_Y_ENABLE` | (Optional) Enable swipe gestures Y+ (Mouse Button 3) / Y- (Mouse Button 6) | `false` |
142| `AZOTEQ_IQS5XX_ZOOM_ENABLE` | (Optional) Enable zoom gestures Zoom Out (Mouse Button 7) / Zoom In (Mouse Button 8) | `false` |
143| `AZOTEQ_IQS5XX_SCROLL_ENABLE` | (Optional) Enable scrolling using two fingers. | `true` |
144| `AZOTEQ_IQS5XX_TAP_TIME` | (Optional) Maximum time in ms for tap to be registered. | `150` |
145| `AZOTEQ_IQS5XX_TAP_DISTANCE` | (Optional) Maximum deviation in pixels before single tap is no longer valid. | `25` |
146| `AZOTEQ_IQS5XX_HOLD_TIME` | (Optional) Minimum time in ms for press and hold. | `300` |
147| `AZOTEQ_IQS5XX_SWIPE_INITIAL_TIME` | (Optional) Maximum time to travel initial distance before swipe is registered. | `150` |
148| `AZOTEQ_IQS5XX_SWIPE_INITIAL_DISTANCE` | (Optional) Minimum travel in pixels before swipe is registered. | `300` |
149| `AZOTEQ_IQS5XX_SWIPE_CONSECUTIVE_TIME` | (Optional) Maximum time to travel consecutive distance before swipe is registered. | `0` |
150| `AZOTEQ_IQS5XX_SWIPE_CONSECUTIVE_DISTANCE`| (Optional) Minimum travel in pixels before a consecutive swipe is registered. | `2000` |
151| `AZOTEQ_IQS5XX_SCROLL_INITIAL_DISTANCE` | (Optional) Minimum travel in pixels before scroll is registered. | `50` |
152| `AZOTEQ_IQS5XX_ZOOM_INITIAL_DISTANCE` | (Optional) Minimum travel in pixels before zoom is registered. | `50` |
153| `AZOTEQ_IQS5XX_ZOOM_CONSECUTIVE_DISTANCE` | (Optional) Maximum time to travel zoom distance before zoom is registered. | `25` |
154
155#### Rotation settings
156
157| Setting | Description | Default |
158| ---------------------------- | ---------------------------------------------------------- | ------------- |
159| `AZOTEQ_IQS5XX_ROTATION_90` | (Optional) Configures hardware for 90 degree rotation. | _not defined_ |
160| `AZOTEQ_IQS5XX_ROTATION_180` | (Optional) Configures hardware for 180 degree rotation. | _not defined_ |
161| `AZOTEQ_IQS5XX_ROTATION_270` | (Optional) Configures hardware for 270 degree rotation. | _not defined_ |
162
163### Cirque Trackpad
164
165To use the Cirque Trackpad sensor, add this to your `rules.mk`:
166
167```make
168POINTING_DEVICE_DRIVER = cirque_pinnacle_i2c
169```
170
171or
172
173```make
174POINTING_DEVICE_DRIVER = cirque_pinnacle_spi
175```
176
177
178This supports the Cirque Pinnacle 1CA027 Touch Controller, which is used in the TM040040, TM035035 and the TM023023 trackpads. These are I2C or SPI compatible, and both configurations are supported.
179
180#### Common settings
181
182| Setting | Description | Default |
183| ------------------------------------ | ---------------------------------------------------------- | ------------------------------------------- |
184| `CIRQUE_PINNACLE_DIAMETER_MM` | (Optional) Diameter of the trackpad sensor in millimeters. | `40` |
185| `CIRQUE_PINNACLE_ATTENUATION` | (Optional) Sets the attenuation of the sensor data. | `EXTREG__TRACK_ADCCONFIG__ADC_ATTENUATE_4X` |
186| `CIRQUE_PINNACLE_CURVED_OVERLAY` | (Optional) Applies settings tuned for curved overlay. | _not defined_ |
187| `CIRQUE_PINNACLE_POSITION_MODE` | (Optional) Mode of operation. | _not defined_ |
188| `CIRQUE_PINNACLE_SKIP_SENSOR_CHECK` | (Optional) Skips sensor presence check | _not defined_ |
189
190**`CIRQUE_PINNACLE_ATTENUATION`** is a measure of how much data is suppressed in regards to sensitivity. The higher the attenuation, the less sensitive the touchpad will be.
191
192Default attenuation is set to 4X, although if you are using a thicker overlay (such as the curved overlay) you will want a lower attenuation such as 2X. The possible values are:
193* `EXTREG__TRACK_ADCCONFIG__ADC_ATTENUATE_4X`: Least sensitive
194* `EXTREG__TRACK_ADCCONFIG__ADC_ATTENUATE_3X`
195* `EXTREG__TRACK_ADCCONFIG__ADC_ATTENUATE_2X`
196* `EXTREG__TRACK_ADCCONFIG__ADC_ATTENUATE_1X`: Most sensitive
197
198**`CIRQUE_PINNACLE_POSITION_MODE`** can be `CIRQUE_PINNACLE_ABSOLUTE_MODE` or `CIRQUE_PINNACLE_RELATIVE_MODE`. Modes differ in supported features/gestures.
199
200* `CIRQUE_PINNACLE_ABSOLUTE_MODE`: Reports absolute x, y, z (touch pressure) coordinates and up to 5 hw buttons connected to the trackpad
201* `CIRQUE_PINNACLE_RELATIVE_MODE`: Reports x/y deltas, scroll and up to 3 buttons (2 of them can be from taps, see gestures) connected to trackpad. Supports taps on secondary side of split. Saves about 2k of flash compared to absolute mode with all features.
202
203| I2C Setting | Description | Default |
204| ------------------------- | ------------------------------------------------------------------------------- | ------- |
205| `CIRQUE_PINNACLE_ADDR` | (Required) Sets the I2C Address for the Cirque Trackpad | `0x2A` |
206| `CIRQUE_PINNACLE_TIMEOUT` | (Optional) The timeout for i2c communication with the trackpad in milliseconds. | `20` |
207
208| SPI Setting | Description | Default |
209| ------------------------------ | ---------------------------------------------------------------------- | ------------------------ |
210| `CIRQUE_PINNACLE_CLOCK_SPEED` | (Optional) Sets the clock speed that the sensor runs at. | `1000000` |
211| `CIRQUE_PINNACLE_SPI_LSBFIRST` | (Optional) Sets the Least/Most Significant Byte First setting for SPI. | `false` |
212| `CIRQUE_PINNACLE_SPI_MODE` | (Optional) Sets the SPI Mode for the sensor. | `1` |
213| `CIRQUE_PINNACLE_SPI_DIVISOR` | (Optional) Sets the SPI Divisor used for SPI communication. | _varies_ |
214| `CIRQUE_PINNACLE_SPI_CS_PIN` | (Required) Sets the Chip Select pin connected to the sensor. | `POINTING_DEVICE_CS_PIN` |
215
216Default Scaling is 1024. Actual CPI depends on trackpad diameter.
217
218Also see the `POINTING_DEVICE_TASK_THROTTLE_MS`, which defaults to 10ms when using Cirque Pinnacle, which matches the internal update rate of the position registers (in standard configuration). Advanced configuration for pen/stylus usage might require lower values.
219
220#### Absolute mode settings
221
222| Setting | Description | Default |
223|-----------------------------------------|-------------------------------------------------------------------------|-------------|
224| `CIRQUE_PINNACLE_X_LOWER` | (Optional) The minimum reachable X value on the sensor. | `127` |
225| `CIRQUE_PINNACLE_X_UPPER` | (Optional) The maximum reachable X value on the sensor. | `1919` |
226| `CIRQUE_PINNACLE_Y_LOWER` | (Optional) The minimum reachable Y value on the sensor. | `63` |
227| `CIRQUE_PINNACLE_Y_UPPER` | (Optional) The maximum reachable Y value on the sensor. | `1471` |
228| `CIRQUE_PINNACLE_REACHABLE_CALIBRATION` | (Optional) Enable console messages to aide in calibrating above values. | not defined |
229
230#### Absolute mode gestures
231
232| Gesture Setting | Description | Default |
233| ---------------------------------------------- | ------------------------------------------------------------------------------ | -------------------- |
234| `CIRQUE_PINNACLE_TAP_ENABLE` | (Optional) Enable tap to click. This currently only works on the master side. | _not defined_ |
235| `CIRQUE_PINNACLE_TAPPING_TERM` | (Optional) Length of time that a touch can be to be considered a tap. | `TAPPING_TERM`/`200` |
236| `CIRQUE_PINNACLE_TOUCH_DEBOUNCE` | (Optional) Length of time that a touch can be to be considered a tap. | `TAPPING_TERM`/`200` |
237
238`POINTING_DEVICE_GESTURES_SCROLL_ENABLE` in this mode enables circular scroll. Touch originating in outer ring can trigger scroll by moving along the perimeter. Near side triggers vertical scroll and far side triggers horizontal scroll.
239
240Additionally, `POINTING_DEVICE_GESTURES_CURSOR_GLIDE_ENABLE` is supported in this mode.
241
242#### Relative mode gestures
243
244| Gesture Setting (`config.h`) | Description | Default |
245| -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
246| `CIRQUE_PINNACLE_TAP_ENABLE` | (Optional) Enable tap to "left click". Works on both sides of a split keyboard. | _not defined_ |
247| `CIRQUE_PINNACLE_SECONDARY_TAP_ENABLE` | (Optional) Tap in upper right corner (half of the finger needs to be outside of the trackpad) of the trackpad will result in "right click". `CIRQUE_PINNACLE_TAP_ENABLE` must be enabled. | _not defined_ |
248
249Tapping term and debounce are not configurable in this mode since it's handled by trackpad internally.
250
251`POINTING_DEVICE_GESTURES_SCROLL_ENABLE` in this mode enables side scroll. Touch originating on the right side can trigger vertical scroll (IntelliSense trackpad style).
252
253### PAW 3204 Sensor
254
255To use the paw 3204 sensor, add this to your `rules.mk`
256
257```make
258POINTING_DEVICE_DRIVER = paw3204
259```
260
261The paw 3204 sensor uses a serial type protocol for communication, and requires an additional light source.
262
263| Setting (`config.h`) | Description | Default |
264| -------------------- |--------------------------------------------------------------- | -------------------------- |
265| `PAW3204_SCLK_PIN` | (Required) The pin connected to the clock pin of the sensor. | `POINTING_DEVICE_SCLK_PIN` |
266| `PAW3204_SDIO_PIN` | (Required) The pin connected to the data pin of the sensor. | `POINTING_DEVICE_SDIO_PIN` |
267
268The CPI range is 400-1600, with supported values of (400, 500, 600, 800, 1000, 1200 and 1600). Defaults to 1000 CPI.
269
270### Pimoroni Trackball
271
272To use the Pimoroni Trackball module, add this to your `rules.mk`:
273
274```make
275POINTING_DEVICE_DRIVER = pimoroni_trackball
276```
277
278The Pimoroni Trackball module is a I2C based breakout board with an RGB enable trackball.
279
280| Setting (`config.h`) | Description | Default |
281| ------------------------------------ | ---------------------------------------------------------------------------------- | ------- |
282| `PIMORONI_TRACKBALL_ADDRESS` | (Required) Sets the I2C Address for the Pimoroni Trackball. | `0x0A` |
283| `PIMORONI_TRACKBALL_TIMEOUT` | (Optional) The timeout for i2c communication with the trackball in milliseconds. | `100` |
284| `PIMORONI_TRACKBALL_SCALE` | (Optional) The multiplier used to generate reports from the sensor. | `5` |
285| `PIMORONI_TRACKBALL_DEBOUNCE_CYCLES` | (Optional) The number of scan cycles used for debouncing on the ball press. | `20` |
286| `PIMORONI_TRACKBALL_ERROR_COUNT` | (Optional) Specifies the number of read/write errors until the sensor is disabled. | `10` |
287
288### PMW3320 Sensor
289
290To use the PMW3320 sensor, add this to your `rules.mk`
291
292```make
293POINTING_DEVICE_DRIVER = pmw3320
294```
295
296The PMW3320 sensor uses a serial type protocol for communication, and requires an additional light source (it could work without one, but expect it to be out of service early).
297
298| Setting | Description | Default |
299| ------------------- | ------------------------------------------------------------------- | -------------------------- |
300| `PMW3320_SCLK_PIN` | (Required) The pin connected to the clock pin of the sensor. | `POINTING_DEVICE_SCLK_PIN` |
301| `PMW3320_SDIO_PIN` | (Required) The pin connected to the data pin of the sensor. | `POINTING_DEVICE_SDIO_PIN` |
302| `PMW3320_CS_PIN` | (Required) The pin connected to the cable select pin of the sensor. | `POINTING_DEVICE_CS_PIN` |
303
304The CPI range is 500-3500, in increments of 250. Defaults to 1000 CPI.
305
306### PMW 3360 and PMW 3389 Sensor
307
308This drivers supports both the PMW 3360 and PMW 3389 sensor as well as multiple sensors of the same type _per_ controller, so 2 can be attached at the same side for split keyboards (or unsplit keyboards).
309
310To use the **PMW 3360** sensor, add this to your `rules.mk`
311
312```make
313POINTING_DEVICE_DRIVER = pmw3360
314```
315
316The CPI range is 100-12000, in increments of 100. Defaults to 1600 CPI.
317
318To use the **PMW 3389** sensor, add this to your `rules.mk`
319
320```make
321POINTING_DEVICE_DRIVER = pmw3389
322```
323
324The CPI range is 50-16000, in increments of 50. Defaults to 2000 CPI.
325
326Both PMW 3360 and PMW 3389 are SPI driven optical sensors, that use a built in IR LED for surface tracking.
327If you have different CS wiring on each half you can use `PMW33XX_CS_PIN_RIGHT` or `PMW33XX_CS_PINS_RIGHT` in combination with `PMW33XX_CS_PIN` or `PMW33XX_CS_PINS` to configure both sides independently. If `_RIGHT` values aren't provided, they default to be the same as the left ones.
328
329| Setting (`config.h`) | Description | Default |
330| ---------------------------- | ------------------------------------------------------------------------------------------- | ------------------------ |
331| `PMW33XX_CS_PIN` | (Required) Sets the Chip Select pin connected to the sensor. | `POINTING_DEVICE_CS_PIN` |
332| `PMW33XX_CS_PINS` | (Alternative) Sets the Chip Select pins connected to multiple sensors. | `{PMW33XX_CS_PIN}` |
333| `PMW33XX_CS_PIN_RIGHT` | (Optional) Sets the Chip Select pin connected to the sensor on the right half. | `PMW33XX_CS_PIN` |
334| `PMW33XX_CS_PINS_RIGHT` | (Optional) Sets the Chip Select pins connected to multiple sensors on the right half. | `{PMW33XX_CS_PIN_RIGHT}` |
335| `PMW33XX_CPI` | (Optional) Sets counts per inch sensitivity of the sensor. | _varies_ |
336| `PMW33XX_CLOCK_SPEED` | (Optional) Sets the clock speed that the sensor runs at. | `2000000` |
337| `PMW33XX_SPI_DIVISOR` | (Optional) Sets the SPI Divisor used for SPI communication. | _varies_ |
338| `PMW33XX_LIFTOFF_DISTANCE` | (Optional) Sets the lift off distance at run time | `0x02` |
339| `ROTATIONAL_TRANSFORM_ANGLE` | (Optional) Allows for the sensor data to be rotated +/- 127 degrees directly in the sensor. | `0` |
340
341To use multiple sensors, instead of setting `PMW33XX_CS_PIN` you need to set `PMW33XX_CS_PINS` and also handle and merge the read from this sensor in user code.
342Note that different (per sensor) values of CPI, speed liftoff, rotational angle or flipping of X/Y is not currently supported.
343
344```c
345// in config.h:
346#define PMW33XX_CS_PINS { B5, B6 }
347// in keyboard.c:
348#ifdef POINTING_DEVICE_ENABLE
349void pointing_device_init_kb(void) {
350 pmw33xx_init(1); // index 1 is the second device.
351 pmw33xx_set_cpi(0, 800); // applies to first sensor
352 pmw33xx_set_cpi(1, 800); // applies to second sensor
353 pointing_device_init_user();
354}
355
356// Contains report from sensor #0 already, need to merge in from sensor #1
357report_mouse_t pointing_device_task_kb(report_mouse_t mouse_report) {
358 pmw33xx_report_t report = pmw33xx_read_burst(1);
359 if (!report.motion.b.is_lifted && report.motion.b.is_motion) {
360// From quantum/pointing_device_drivers.c
361#define constrain_hid(amt) ((amt) < -127 ? -127 : ((amt) > 127 ? 127 : (amt)))
362 mouse_report.x = constrain_hid(mouse_report.x + report.delta_x);
363 mouse_report.y = constrain_hid(mouse_report.y + report.delta_y);
364 }
365 return pointing_device_task_user(mouse_report);
366}
367#endif
368
369```
370
371### Custom Driver
372
373If you have a sensor type that isn't supported above, a custom option is available by adding the following to your `rules.mk`
374
375```make
376POINTING_DEVICE_DRIVER = custom
377```
378
379Using the custom driver will require implementing the following functions:
380
381```c
382void pointing_device_driver_init(void) {}
383report_mouse_t pointing_device_driver_get_report(report_mouse_t mouse_report) { return mouse_report; }
384uint16_t pointing_device_driver_get_cpi(void) { return 0; }
385void pointing_device_driver_set_cpi(uint16_t cpi) {}
386```
387
388::: warning
389Ideally, new sensor hardware should be added to `drivers/sensors/` and `quantum/pointing_device_drivers.c`, but there may be cases where it's very specific to the hardware. So these functions are provided, just in case.
390:::
391
392## Common Configuration
393
394| Setting | Description | Default |
395| ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ------------- |
396| `MOUSE_EXTENDED_REPORT` | (Optional) Enables support for extended mouse reports. (-32767 to 32767, instead of just -127 to 127). | _not defined_ |
397| `POINTING_DEVICE_ROTATION_90` | (Optional) Rotates the X and Y data by 90 degrees. | _not defined_ |
398| `POINTING_DEVICE_ROTATION_180` | (Optional) Rotates the X and Y data by 180 degrees. | _not defined_ |
399| `POINTING_DEVICE_ROTATION_270` | (Optional) Rotates the X and Y data by 270 degrees. | _not defined_ |
400| `POINTING_DEVICE_INVERT_X` | (Optional) Inverts the X axis report. | _not defined_ |
401| `POINTING_DEVICE_INVERT_Y` | (Optional) Inverts the Y axis report. | _not defined_ |
402| `POINTING_DEVICE_MOTION_PIN` | (Optional) If supported, will only read from sensor if pin is active. | _not defined_ |
403| `POINTING_DEVICE_MOTION_PIN_ACTIVE_LOW` | (Optional) If defined then the motion pin is active-low. | _varies_ |
404| `POINTING_DEVICE_TASK_THROTTLE_MS` | (Optional) Limits the frequency that the sensor is polled for motion. | _not defined_ |
405| `POINTING_DEVICE_GESTURES_CURSOR_GLIDE_ENABLE` | (Optional) Enable inertial cursor. Cursor continues moving after a flick gesture and slows down by kinetic friction. | _not defined_ |
406| `POINTING_DEVICE_GESTURES_SCROLL_ENABLE` | (Optional) Enable scroll gesture. The gesture that activates the scroll is device dependent. | _not defined_ |
407| `POINTING_DEVICE_CS_PIN` | (Optional) Provides a default CS pin, useful for supporting multiple sensor configs. | _not defined_ |
408| `POINTING_DEVICE_SDIO_PIN` | (Optional) Provides a default SDIO pin, useful for supporting multiple sensor configs. | _not defined_ |
409| `POINTING_DEVICE_SCLK_PIN` | (Optional) Provides a default SCLK pin, useful for supporting multiple sensor configs. | _not defined_ |
410
411::: warning
412When using `SPLIT_POINTING_ENABLE` the `POINTING_DEVICE_MOTION_PIN` functionality is not supported and `POINTING_DEVICE_TASK_THROTTLE_MS` will default to `1`. Increasing this value will increase transport performance at the cost of possible mouse responsiveness.
413:::
414
415The `POINTING_DEVICE_CS_PIN`, `POINTING_DEVICE_SDIO_PIN`, and `POINTING_DEVICE_SCLK_PIN` provide a convenient way to define a single pin that can be used for an interchangeable sensor config. This allows you to have a single config, without defining each device. Each sensor allows for this to be overridden with their own defines.
416
417::: warning
418Any pointing device with a lift/contact status can integrate inertial cursor feature into its driver, controlled by `POINTING_DEVICE_GESTURES_CURSOR_GLIDE_ENABLE`. e.g. PMW3360 can use Lift_Stat from Motion register. Note that `POINTING_DEVICE_MOTION_PIN` cannot be used with this feature; continuous polling of `get_report()` is needed to generate glide reports.
419:::
420
421## Split Keyboard Configuration
422
423The following configuration options are only available when using `SPLIT_POINTING_ENABLE` see [data sync options](split_keyboard#data-sync-options). The rotation and invert `*_RIGHT` options are only used with `POINTING_DEVICE_COMBINED`. If using `POINTING_DEVICE_LEFT` or `POINTING_DEVICE_RIGHT` use the common configuration above to configure your pointing device.
424
425| Setting | Description | Default |
426| ------------------------------------ | ----------------------------------------------------------------------------------------------------- | ------------- |
427| `POINTING_DEVICE_LEFT` | Pointing device on the left side (Required - pick one only) | _not defined_ |
428| `POINTING_DEVICE_RIGHT` | Pointing device on the right side (Required - pick one only) | _not defined_ |
429| `POINTING_DEVICE_COMBINED` | Pointing device on both sides (Required - pick one only) | _not defined_ |
430| `POINTING_DEVICE_ROTATION_90_RIGHT` | (Optional) Rotates the X and Y data by 90 degrees. | _not defined_ |
431| `POINTING_DEVICE_ROTATION_180_RIGHT` | (Optional) Rotates the X and Y data by 180 degrees. | _not defined_ |
432| `POINTING_DEVICE_ROTATION_270_RIGHT` | (Optional) Rotates the X and Y data by 270 degrees. | _not defined_ |
433| `POINTING_DEVICE_INVERT_X_RIGHT` | (Optional) Inverts the X axis report. | _not defined_ |
434| `POINTING_DEVICE_INVERT_Y_RIGHT` | (Optional) Inverts the Y axis report. | _not defined_ |
435
436::: warning
437If there is a `_RIGHT` configuration option or callback, the [common configuration](pointing_device#common-configuration) option will work for the left. For correct left/right detection you should setup a [handedness option](split_keyboard#setting-handedness), `EE_HANDS` is usually a good option for an existing board that doesn't do handedness by hardware.
438:::
439
440
441## Callbacks and Functions
442
443| Function | Description |
444| ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
445| `pointing_device_init_kb(void)` | Callback to allow for keyboard level initialization. Useful for additional hardware sensors. |
446| `pointing_device_init_user(void)` | Callback to allow for user level initialization. Useful for additional hardware sensors. |
447| `pointing_device_task_kb(mouse_report)` | Callback that sends sensor data, so keyboard code can intercept and modify the data. Returns a mouse report. |
448| `pointing_device_task_user(mouse_report)` | Callback that sends sensor data, so user code can intercept and modify the data. Returns a mouse report. |
449| `pointing_device_handle_buttons(buttons, pressed, button)` | Callback to handle hardware button presses. Returns a `uint8_t`. |
450| `pointing_device_get_cpi(void)` | Gets the current CPI/DPI setting from the sensor, if supported. |
451| `pointing_device_set_cpi(uint16_t)` | Sets the CPI/DPI, if supported. |
452| `pointing_device_get_report(void)` | Returns the current mouse report (as a `report_mouse_t` data structure). |
453| `pointing_device_set_report(mouse_report)` | Sets the mouse report to the assigned `report_mouse_t` data structured passed to the function. |
454| `pointing_device_send(void)` | Sends the current mouse report to the host system. Function can be replaced. |
455| `has_mouse_report_changed(new_report, old_report)` | Compares the old and new `report_mouse_t` data and returns true only if it has changed. |
456| `pointing_device_adjust_by_defines(mouse_report)` | Applies rotations and invert configurations to a raw mouse report. |
457
458
459## Split Keyboard Callbacks and Functions
460
461The combined functions below are only available when using `SPLIT_POINTING_ENABLE` and `POINTING_DEVICE_COMBINED`. The 2 callbacks `pointing_device_task_combined_*` replace the single sided equivalents above. See the [combined pointing devices example](pointing_device#combined-pointing-devices)
462
463| Function | Description |
464| --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
465| `pointing_device_set_shared_report(mouse_report)` | Sets the shared mouse report to the assigned `report_mouse_t` data structured passed to the function. |
466| `pointing_device_set_cpi_on_side(bool, uint16_t)` | Sets the CPI/DPI of one side, if supported. Passing `true` will set the left and `false` the right |
467| `pointing_device_combine_reports(left_report, right_report)` | Returns a combined mouse_report of left_report and right_report (as a `report_mouse_t` data structure) |
468| `pointing_device_task_combined_kb(left_report, right_report)` | Callback, so keyboard code can intercept and modify the data. Returns a combined mouse report. |
469| `pointing_device_task_combined_user(left_report, right_report)` | Callback, so user code can intercept and modify. Returns a combined mouse report using `pointing_device_combine_reports` |
470| `pointing_device_adjust_by_defines_right(mouse_report)` | Applies right side rotations and invert configurations to a raw mouse report. |
471
472
473# Manipulating Mouse Reports
474
475The report_mouse_t (here "mouseReport") has the following properties:
476
477* `mouseReport.x` - this is a signed int from -127 to 127 (not 128, this is defined in USB HID spec) representing movement (+ to the right, - to the left) on the x axis.
478* `mouseReport.y` - this is a signed int from -127 to 127 (not 128, this is defined in USB HID spec) representing movement (+ upward, - downward) on the y axis.
479* `mouseReport.v` - this is a signed int from -127 to 127 (not 128, this is defined in USB HID spec) representing vertical scrolling (+ upward, - downward).
480* `mouseReport.h` - this is a signed int from -127 to 127 (not 128, this is defined in USB HID spec) representing horizontal scrolling (+ right, - left).
481* `mouseReport.buttons` - this is a uint8_t in which all 8 bits are used. These bits represent the mouse button state - bit 0 is mouse button 1, and bit 7 is mouse button 8.
482
483To manually manipulate the mouse reports outside of the `pointing_device_task_*` functions, you can use:
484
485* `pointing_device_get_report()` - Returns the current report_mouse_t that represents the information sent to the host computer
486* `pointing_device_set_report(report_mouse_t mouse_report)` - Overrides and saves the report_mouse_t to be sent to the host computer
487* `pointing_device_send()` - Sends the mouse report to the host and zeroes out the report.
488
489When the mouse report is sent, the x, y, v, and h values are set to 0 (this is done in `pointing_device_send()`, which can be overridden to avoid this behavior). This way, button states persist, but movement will only occur once. For further customization, both `pointing_device_init` and `pointing_device_task` can be overridden.
490
491Additionally, by default, `pointing_device_send()` will only send a report when the report has actually changed. This prevents it from continuously sending mouse reports, which will keep the host system awake. This behavior can be changed by creating your own `pointing_device_send()` function.
492
493Also, you use the `has_mouse_report_changed(new_report, old_report)` function to check to see if the report has changed.
494
495## Examples
496
497### Custom Mouse Keycode
498
499In this example, a custom key is used to click the mouse and scroll 127 units vertically and horizontally, then undo all of that when released - because that's a totally useful function.
500
501```c
502case MS_SPECIAL:
503 report_mouse_t currentReport = pointing_device_get_report();
504 if (record->event.pressed) {
505 currentReport.v = 127;
506 currentReport.h = 127;
507 currentReport.buttons |= MOUSE_BTN1; // this is defined in report.h
508 } else {
509 currentReport.v = -127;
510 currentReport.h = -127;
511 currentReport.buttons &= ~MOUSE_BTN1;
512 }
513 pointing_device_set_report(currentReport);
514 pointing_device_send();
515 break;
516```
517
518Recall that the mouse report is set to zero (except the buttons) whenever it is sent, so the scrolling would only occur once in each case.
519
520### Drag Scroll or Mouse Scroll
521
522A very common implementation is to use the mouse movement to scroll instead of moving the cursor on the system. This uses the `pointing_device_task_user` callback to intercept and modify the mouse report before it's sent to the host system.
523
524```c
525enum custom_keycodes {
526 DRAG_SCROLL = SAFE_RANGE,
527};
528
529bool set_scrolling = false;
530
531report_mouse_t pointing_device_task_user(report_mouse_t mouse_report) {
532 if (set_scrolling) {
533 mouse_report.h = mouse_report.x;
534 mouse_report.v = mouse_report.y;
535 mouse_report.x = 0;
536 mouse_report.y = 0;
537 }
538 return mouse_report;
539}
540
541bool process_record_user(uint16_t keycode, keyrecord_t *record) {
542 if (keycode == DRAG_SCROLL && record->event.pressed) {
543 set_scrolling = !set_scrolling;
544 }
545 return true;
546}
547```
548
549This allows you to toggle between scrolling and cursor movement by pressing the DRAG_SCROLL key.
550
551### Advanced Drag Scroll
552
553Sometimes, like with the Cirque trackpad, you will run into issues where the scrolling may be too fast.
554
555Here is a slightly more advanced example of drag scrolling. You will be able to change the scroll speed based on the values in set in `SCROLL_DIVISOR_H` and `SCROLL_DIVISOR_V`. This bit of code is also set up so that instead of toggling the scrolling state with set_scrolling = !set_scrolling, the set_scrolling variable is set directly to record->event.pressed. This way, the drag scrolling will only be active while the DRAG_SCROLL button is held down.
556
557```c
558enum custom_keycodes {
559 DRAG_SCROLL = SAFE_RANGE,
560};
561
562bool set_scrolling = false;
563
564// Modify these values to adjust the scrolling speed
565#define SCROLL_DIVISOR_H 8.0
566#define SCROLL_DIVISOR_V 8.0
567
568// Variables to store accumulated scroll values
569float scroll_accumulated_h = 0;
570float scroll_accumulated_v = 0;
571
572// Function to handle mouse reports and perform drag scrolling
573report_mouse_t pointing_device_task_user(report_mouse_t mouse_report) {
574 // Check if drag scrolling is active
575 if (set_scrolling) {
576 // Calculate and accumulate scroll values based on mouse movement and divisors
577 scroll_accumulated_h += (float)mouse_report.x / SCROLL_DIVISOR_H;
578 scroll_accumulated_v += (float)mouse_report.y / SCROLL_DIVISOR_V;
579
580 // Assign integer parts of accumulated scroll values to the mouse report
581 mouse_report.h = (int8_t)scroll_accumulated_h;
582 mouse_report.v = (int8_t)scroll_accumulated_v;
583
584 // Update accumulated scroll values by subtracting the integer parts
585 scroll_accumulated_h -= (int8_t)scroll_accumulated_h;
586 scroll_accumulated_v -= (int8_t)scroll_accumulated_v;
587
588 // Clear the X and Y values of the mouse report
589 mouse_report.x = 0;
590 mouse_report.y = 0;
591 }
592 return mouse_report;
593}
594
595// Function to handle key events and enable/disable drag scrolling
596bool process_record_user(uint16_t keycode, keyrecord_t *record) {
597 switch (keycode) {
598 case DRAG_SCROLL:
599 // Toggle set_scrolling when DRAG_SCROLL key is pressed or released
600 set_scrolling = record->event.pressed;
601 break;
602 default:
603 break;
604 }
605 return true;
606}
607
608// Function to handle layer changes and disable drag scrolling when not in AUTO_MOUSE_DEFAULT_LAYER
609layer_state_t layer_state_set_user(layer_state_t state) {
610 // Disable set_scrolling if the current layer is not the AUTO_MOUSE_DEFAULT_LAYER
611 if (get_highest_layer(state) != AUTO_MOUSE_DEFAULT_LAYER) {
612 set_scrolling = false;
613 }
614 return state;
615}
616
617```
618
619
620## Split Examples
621
622The following examples make use the `SPLIT_POINTING_ENABLE` functionality and show how to manipulate the mouse report for a scrolling mode.
623
624### Single Pointing Device
625
626The following example will work with either `POINTING_DEVICE_LEFT` or `POINTING_DEVICE_RIGHT` and enables scrolling mode while on a particular layer.
627
628```c
629
630static bool scrolling_mode = false;
631
632layer_state_t layer_state_set_user(layer_state_t state) {
633 switch (get_highest_layer(state)) {
634 case _RAISE: // If we're on the _RAISE layer enable scrolling mode
635 scrolling_mode = true;
636 pointing_device_set_cpi(2000);
637 break;
638 default:
639 if (scrolling_mode) { // check if we were scrolling before and set disable if so
640 scrolling_mode = false;
641 pointing_device_set_cpi(8000);
642 }
643 break;
644 }
645 return state;
646}
647
648report_mouse_t pointing_device_task_user(report_mouse_t mouse_report) {
649 if (scrolling_mode) {
650 mouse_report.h = mouse_report.x;
651 mouse_report.v = mouse_report.y;
652 mouse_report.x = 0;
653 mouse_report.y = 0;
654 }
655 return mouse_report;
656}
657```
658
659### Combined Pointing Devices
660
661The following example requires `POINTING_DEVICE_COMBINED` and sets the left side pointing device to scroll only.
662
663```c
664void keyboard_post_init_user(void) {
665 pointing_device_set_cpi_on_side(true, 1000); //Set cpi on left side to a low value for slower scrolling.
666 pointing_device_set_cpi_on_side(false, 8000); //Set cpi on right side to a reasonable value for mousing.
667}
668
669report_mouse_t pointing_device_task_combined_user(report_mouse_t left_report, report_mouse_t right_report) {
670 left_report.h = left_report.x;
671 left_report.v = left_report.y;
672 left_report.x = 0;
673 left_report.y = 0;
674 return pointing_device_combine_reports(left_report, right_report);
675}
676```
677
678# Troubleshooting
679
680If you are having issues with pointing device drivers debug messages can be enabled that will give you insights in the inner workings. To enable these add to your keyboards `config.h` file:
681
682```c
683#define POINTING_DEVICE_DEBUG
684```
685
686::: tip
687The messages will be printed out to the `CONSOLE` output. For additional information, refer to [Debugging/Troubleshooting QMK](../faq_debug).
688:::
689
690
691---
692# Automatic Mouse Layer {#pointing-device-auto-mouse}
693
694When using a pointing device combined with a keyboard the mouse buttons are often kept on a separate layer from the default keyboard layer, which requires pressing or holding a key to change layers before using the mouse. To make this easier and more efficient an additional pointing device feature may be enabled that will automatically activate a target layer as soon as the pointing device is active _(in motion, mouse button pressed etc.)_ and deactivate the target layer after a set time.
695
696Additionally if any key that is defined as a mouse key is pressed then the layer will be held as long as the key is pressed and the timer will be reset on key release. When a non-mouse key is pressed then the layer is deactivated early _(with some exceptions see below)_. Mod, mod tap, and one shot mod keys are ignored _(i.e. don't hold or activate layer but do not deactivate the layer either)_ when sending a modifier keycode _(e.g. hold for mod tap)_ allowing for mod keys to be used with the mouse without activating the target layer when typing.
697
698All of the standard layer keys (tap toggling, toggle, toggle on, one_shot, layer tap, layer mod) that activate the current target layer are uniquely handled to ensure they behave as expected _(see layer key table below)_. The target layer that can be changed at any point during by calling the `set_auto_mouse_layer(<new_target_layer>);` function.
699
700### Behaviour of Layer keys that activate the target layer
701| Layer key as in `keymap.c` | Auto Mouse specific behaviour |
702| -------------------------- | --------------------------------------------------------------------------------------------------------------------- |
703| `MO(<target_layer>)` | Treated as a mouse key holding the layer while pressed |
704| `LT(<target_layer>)` | When tapped will be treated as non mouse key and mouse key when held |
705| `LM(<target_layer>)` | Treated as a mouse key |
706| `TG(<target_layer>)` | Will set flag preventing target layer deactivation or removal until pressed again |
707| `TO(<target_layer>)` | Same as `TG(<target_layer>)` |
708| `TT(<target_layer>)` | Treated as a mouse key when `tap.count < TAPPING_TOGGLE` and as `TG` when `tap.count == TAPPING_TOGGLE` |
709| `DF(<target_layer>)` | Skips auto mouse key processing similar to mod keys |
710| `OSL(<target_layer>)` | Skips, but if current one shot layer is the target layer then it will prevent target layer deactivation or removal |
711
712
713## How to enable:
714
715```c
716// in config.h:
717#define POINTING_DEVICE_AUTO_MOUSE_ENABLE
718// only required if not setting mouse layer elsewhere
719#define AUTO_MOUSE_DEFAULT_LAYER <index of your mouse layer>
720
721// in keymap.c:
722void pointing_device_init_user(void) {
723 set_auto_mouse_layer(<mouse_layer>); // only required if AUTO_MOUSE_DEFAULT_LAYER is not set to index of <mouse_layer>
724 set_auto_mouse_enable(true); // always required before the auto mouse feature will work
725}
726```
727
728Because the auto mouse feature can be disabled/enabled during runtime and starts as disabled by default it must be enabled by calling `set_auto_mouse_enable(true);` somewhere in firmware before the feature will work.
729_Note: for setting the target layer during initialization either setting `AUTO_MOUSE_DEFAULT_LAYER` in `config.h` or calling `set_auto_mouse_layer(<mouse_layer>)` can be used._
730
731
732## How to Customize:
733
734There are a few ways to control the auto mouse feature with both `config.h` options and functions for controlling it during runtime.
735
736### `config.h` Options:
737| Define | Description | Range | Units | Default |
738| ----------------------------------- | --------------------------------------------------------------------- | :------------------: | :---------: | -------------------------: |
739| `POINTING_DEVICE_AUTO_MOUSE_ENABLE` | (Required) Enables auto mouse layer feature | | _None_ | _Not defined_ |
740| `AUTO_MOUSE_DEFAULT_LAYER` | (Optional) Index of layer to use as default target layer | 0 - `LAYER_MAX` | _`uint8_t`_ | `1` |
741| `AUTO_MOUSE_TIME` | (Optional) Time layer remains active after activation | _ideally_ (250-1000) | _ms_ | `650 ms` |
742| `AUTO_MOUSE_DELAY` | (Optional) Lockout time after non-mouse key is pressed | _ideally_ (100-1000) | _ms_ | `TAPPING_TERM` or `200 ms` |
743| `AUTO_MOUSE_DEBOUNCE` | (Optional) Time delay from last activation to next update | _ideally_ (10 - 100) | _ms_ | `25 ms` |
744| `AUTO_MOUSE_THRESHOLD` | (Optional) Amount of mouse movement required to switch layers | 0 - | _units_ | `10 units` |
745
746### Adding mouse keys
747
748While all default mouse keys and layer keys(for current mouse layer) are treated as mouse keys, additional Keyrecords can be added to mouse keys by adding them to the is_mouse_record_* stack.
749
750#### Callbacks for setting up additional key codes as mouse keys:
751| Callback | Description |
752| -------------------------------------------------------------------- | -------------------------------------------------- |
753| `bool is_mouse_record_kb(uint16_t keycode, keyrecord_t* record)` | keyboard level callback for adding mouse keys |
754| `bool is_mouse_record_user(uint16_t keycode, keyrecord_t* record)` | user/keymap level callback for adding mouse keys |
755
756##### To use the callback function to add mouse keys:
757
758The following code will cause the enter key and all of the arrow keys to be treated as mouse keys (hold target layer while they are pressed and reset active layer timer).
759```c
760
761// in <keyboard>.c:
762bool is_mouse_record_kb(uint16_t keycode, keyrecord_t* record) {
763 switch(keycode) {
764 case KC_ENT:
765 return true;
766 case KC_RIGHT ... KC_UP:
767 return true;
768 default:
769 return false;
770 }
771 return is_mouse_record_user(keycode, record);
772}
773```
774
775
776## Advanced control
777
778There are several functions that allow for more advanced interaction with the auto mouse feature allowing for greater control.
779
780### Functions to control auto mouse enable and target layer:
781| Function | Description | Aliases | Return type |
782| :--------------------------------------------------------- | ------------------------------------------------------------------------------------ | ------------------------- | --------------: |
783| `set_auto_mouse_enable(bool enable)` | Enable or disable auto mouse (true:enable, false:disable) | | `void`(None) |
784| `get_auto_mouse_enable(void)` | Return auto mouse enable state (true:enabled, false:disabled) | `AUTO_MOUSE_ENABLED` | `bool` |
785| `set_auto_mouse_layer(uint8_t LAYER)` | Change/set the target layer for auto mouse | | `void`(None) |
786| `get_auto_mouse_layer(void)` | Return auto mouse target layer index | `AUTO_MOUSE_TARGET_LAYER` | `uint8_t` |
787| `remove_auto_mouse_layer(layer_state_t state, bool force)` | Return `state` with target layer removed if appropriate (ignore criteria if `force`) | | `layer_state_t` |
788| `auto_mouse_layer_off(void)` | Disable target layer if appropriate will call (makes call to `layer_state_set`) | | `void`(None) |
789| `auto_mouse_toggle(void)` | Toggle on/off target toggle state (disables layer deactivation when true) | | `void`(None) |
790| `get_auto_mouse_toggle(void)` | Return value of toggling state variable | | `bool` |
791| `set_auto_mouse_timeout(uint16_t timeout)` | Change/set the timeout for turing off the layer | | `void`(None) |
792| `get_auto_mouse_timeout(void)` | Return the current timeout for turing off the layer | | `uint16_t` |
793| `set_auto_mouse_debounce(uint16_t timeout)` | Change/set the debounce for preventing layer activation | | `void`(None) |
794| `get_auto_mouse_debounce(void)` | Return the current debounce for preventing layer activation | | `uint8_t` |
795| `is_auto_mouse_active(void)` | Returns the active state of the auto mouse layer (eg if the layer has been triggered)| | `bool` |
796| `get_auto_mouse_key_tracker(void)` | Gets the current count for the auto mouse key tracker. | | `int8_t` |
797| `set_auto_mouse_key_tracker(int8_t key_tracker)` | Sets/Overrides the current count for the auto mouse key tracker. | | `void`(None) |
798
799_NOTES:_
800 - _Due to the nature of how some functions work, the `auto_mouse_trigger_reset`, and `auto_mouse_layer_off` functions should never be called in the `layer_state_set_*` stack as this can cause indefinite loops._
801 - _It is recommended that `remove_auto_mouse_layer` is used in the `layer_state_set_*` stack of functions and `auto_mouse_layer_off` is used everywhere else_
802 - _`remove_auto_mouse_layer(state, false)` or `auto_mouse_layer_off()` should be called before any instance of `set_auto_mouse_enabled(false)` or `set_auto_mouse_layer(layer)` to ensure that the target layer will be removed appropriately before disabling auto mouse or changing target to avoid a stuck layer_
803
804### Functions for handling custom key events:
805| Function | Description | Return type |
806| :--------------------------------------------------------- | -------------------------------------------------------------------------------- | --------------: |
807| `auto_mouse_keyevent(bool pressed)` | Auto mouse mouse key event (true: key down, false: key up) | `void`(None) |
808| `auto_mouse_trigger_reset(bool pressed)` | Reset auto mouse status on key down and start delay timer (non-mouse key event) | `void`(None) |
809| `auto_mouse_toggle(void)` | Toggle on/off target toggle state (disables layer deactivation when true) | `void`(None) |
810| `get_auto_mouse_toggle(void)` | Return value of toggling state variable | `bool` |
811_NOTE: Generally it would be preferable to use the `is_mouse_record_*` functions to add any additional keys that should act as mouse keys rather than adding `auto_mouse_keyevent(record.event->pressed)` to `process_records_*`_
812
813### Advanced control examples
814
815#### Disable auto mouse on certain layers:
816
817The auto mouse feature can be disabled any time and this can be helpful if you want to disable the auto mouse feature under certain circumstances such as when particular layers are active. One issue however is the handling of the target layer, it needs to be removed appropriately **before** disabling auto mouse _(see notes under control functions above)_. The following function would disable the auto_mouse feature whenever the layers `_LAYER5` through `_LAYER7` are active as the top most layer _(ignoring target layer)_.
818
819```c
820// in keymap.c:
821layer_state_t layer_state_set_user(layer_state_t state) {
822 // checks highest layer other than target layer
823 switch(get_highest_layer(remove_auto_mouse_layer(state, true))) {
824 case _LAYER5 ... _LAYER7:
825 // remove_auto_mouse_target must be called to adjust state *before* setting enable
826 state = remove_auto_mouse_layer(state, false);
827 set_auto_mouse_enable(false);
828 break;
829 default:
830 set_auto_mouse_enable(true);
831 break;
832 }
833 // recommend that any code that makes adjustment based on auto mouse layer state would go here
834 return state;
835}
836```
837
838#### Set different target layer when a particular layer is active:
839
840The below code will change the auto mouse layer target to `_MOUSE_LAYER_2` when `_DEFAULT_LAYER_2` is highest default layer state.
841
842*NOTE: that `auto_mouse_layer_off` is used here instead of `remove_auto_mouse_layer` as `default_layer_state_set_*` stack is separate from the `layer_state_set_*` stack*, if something similar was to be done in `layer_state_set_user`, `state = remove_auto_mouse_layer(state, false)` should be used instead.
843
844*ADDITIONAL NOTE: `AUTO_MOUSE_TARGET_LAYER` is checked if already set to avoid deactivating the target layer unless needed*.
845
846```c
847// in keymap.c
848layer_state_t default_layer_state_set_user(layer_state_t state) {
849 // switch on change in default layer need to check if target layer already set to avoid turning off layer needlessly
850 switch(get_highest_layer(state)) {
851 case _DEFAULT_LAYER_2:
852 if ((AUTO_MOUSE_TARGET_LAYER) == _MOUSE_LAYER_2) break;
853 auto_mouse_layer_off();
854 set_auto_mouse_layer(_MOUSE_LAYER_2);
855 break;
856
857 default:
858 if((AUTO_MOUSE_TARGET_LAYER) == _MOUSE_LAYER_1) break;
859 auto_mouse_layer_off();
860 set_auto_mouse_layer(_MOUSE_LAYER_1);
861 }
862 return state;
863}
864```
865
866### Use custom keys to control auto mouse:
867Custom key records could also be created that control the auto mouse feature.
868The code example below would create a custom key that would toggle the auto mouse feature on and off when pressed while also setting a bool that could be used to disable other code that may turn it on such as the layer code above.
869
870```c
871// in config.h:
872enum user_custom_keycodes {
873 AM_Toggle = SAFE_RANGE
874};
875
876// in keymap.c:
877// set up global bool to adjust other user code
878bool auto_mouse_tg_off = !AUTO_MOUSE_ENABLED;
879
880bool process_record_user(uint16_t keycode, keyrecord_t* record) {
881 switch (keycode) {
882 // toggle auto mouse enable key
883 case AM_Toggle:
884 if(record->event.pressed) { // key down
885 auto_mouse_layer_off(); // disable target layer if needed
886 set_auto_mouse_enabled((AUTO_MOUSE_ENABLED) ^ 1);
887 auto_mouse_tg_off = !get_auto_mouse_enabled();
888 } // do nothing on key up
889 return false; // prevent further processing of keycode
890 }
891}
892```
893
894
895## Customize Target Layer Activation
896
897Layer activation can be customized by overwriting the `auto_mouse_activation` function. This function is checked every time `pointing_device_task` is called when inactive and every `AUTO_MOUSE_DEBOUNCE` ms when active, and will evaluate pointing device level conditions that trigger target layer activation. When it returns true, the target layer will be activated barring the usual exceptions _(e.g. delay time has not expired)_.
898
899By default it will return true if any of the `mouse_report` axes `x`,`y`,`h`,`v` are non zero, or if there is any mouse buttons active in `mouse_report`.
900_Note: The Cirque pinnacle track pad already implements a custom activation function that will activate on touchdown as well as movement all of the default conditions, currently this only works for the master side of split keyboards._
901
902| Function | Description | Return type |
903| :--------------------------------------------------------- | -------------------------------------------------------------------------------- | --------------: |
904| `auto_mouse_activation(report_mouse_t mouse_report)` | Overwritable function that controls target layer activation (when true) | `bool` |
905
906## Auto Mouse for Custom Pointing Device Task
907
908When using a custom pointing device (overwriting `pointing_device_task`) the following code should be somewhere in the `pointing_device_task_*` stack:
909
910```c
911bool pointing_device_task(void) {
912 //...Custom pointing device task code
913
914 // handle automatic mouse layer (needs report_mouse_t as input)
915 pointing_device_task_auto_mouse(local_mouse_report);
916
917 //...More custom pointing device task code
918
919 return pointing_device_send();
920}
921```
922
923In general the following two functions must be implemented in appropriate locations for auto mouse to function:
924
925| Function | Description | Suggested location |
926| -------------------------------------------------------------- | ------------------------------------------------------------ | ---------------------------: |
927| `pointing_device_task_auto_mouse(report_mouse_t mouse_report)` | handles target layer activation and is_active status updates | `pointing_device_task` stack |
928| `process_auto_mouse(uint16_t keycode, keyrecord_t* record)` | Keycode processing for auto mouse | `process_record` stack |
generated by cgit v1.2.3 (git 2.25.1) at 2026-09-03 07:45:59 +0000