summaryrefslogtreecommitdiff
path: root/docs/feature_pointing_device.md
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2022-07-19 17:46:22 -0700
committerGitHub <noreply@github.com>2022-07-19 17:46:22 -0700
commit12eb6444c67456d522c815120de8eed431ead2f8 (patch)
tree50445a98e7f06d531cefd2648455ca6ce2576b84 /docs/feature_pointing_device.md
parent6992efb2291f8b78cb5feb5c750bab616640045d (diff)
downloadqmk_firmware-12eb6444c67456d522c815120de8eed431ead2f8.tar.gz
qmk_firmware-12eb6444c67456d522c815120de8eed431ead2f8.zip
Add support for PAW3204 Optical Sensor (#17669)
Co-authored-by: gompa <gompa@h-bomb.nl> Co-authored-by: Stefan Kerkmann <karlk90@pm.me>
Diffstat (limited to 'docs/feature_pointing_device.md')
-rw-r--r--docs/feature_pointing_device.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/feature_pointing_device.md b/docs/feature_pointing_device.md
index 6343ed073d..f0463a131d 100644
--- a/docs/feature_pointing_device.md
+++ b/docs/feature_pointing_device.md
@@ -136,6 +136,24 @@ Also see the `POINTING_DEVICE_TASK_THROTTLE_MS`, which defaults to 10ms when usi
**`POINTING_DEVICE_GESTURES_CURSOR_GLIDE_ENABLE`** is not specific to Cirque trackpad; any pointing device with a lift/contact status can integrate this gesture into its driver. 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 `pointing_device_get_report()` is needed to generate glide reports.
+### PAW 3204 Sensor
+
+To use the paw 3204 sensor, add this to your `rules.mk`
+
+```make
+POINTING_DEVICE_DRIVER = paw3204
+```
+
+The paw 3204 sensor uses a serial type protocol for communication, and requires an additional light source.
+
+| Setting | Description |
+|--------------------|---------------------------------------------------------------------|
+|`PAW3204_SCLK_PIN` | (Required) The pin connected to the clock pin of the sensor. |
+|`PAW3204_SDIO_PIN` | (Required) The pin connected to the data pin of the sensor. |
+
+The CPI range is 400-1600, with supported values of (400, 500, 600, 800, 1000, 1200 and 1600). Defaults to 1000 CPI.
+
+
### Pimoroni Trackball
To use the Pimoroni Trackball module, add this to your `rules.mk`: