summaryrefslogtreecommitdiff
path: root/keyboards/ploopyco/mouse/readme.md
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2020-10-26 23:09:11 -0700
committerGitHub <noreply@github.com>2020-10-27 17:09:11 +1100
commit33074bcbadbafa3a359efda5a45a9412e4eca7d2 (patch)
tree5682dd93d88aa91a91b2e111f1b2a1e5604d7633 /keyboards/ploopyco/mouse/readme.md
parent555b1640b26fa09ea5f6b5bc7ea07dc654a326f9 (diff)
[Keyboard] Bug fixes and improvements to PloopyCo devices (#10573)
Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/ploopyco/mouse/readme.md')
-rw-r--r--keyboards/ploopyco/mouse/readme.md17
1 files changed, 13 insertions, 4 deletions
diff --git a/keyboards/ploopyco/mouse/readme.md b/keyboards/ploopyco/mouse/readme.md
index abfa643a44..a9b4b581a3 100644
--- a/keyboards/ploopyco/mouse/readme.md
+++ b/keyboards/ploopyco/mouse/readme.md
@@ -1,6 +1,6 @@
# Ploopyco Mouse
-![Ploopyco Mouse](https://i.redd.it/bf7bkzqzeti51.jpg)
+![Ploopyco Mouse](https://www.ploopy.co/uploads/1/2/7/6/127652558/s905404500980887952_p10_i19_w1414.jpeg)
It's a DIY, QMK Powered Trackball!!!!
@@ -14,7 +14,7 @@ Make example for this keyboard (after setting up your build environment):
make ploopyco/mouse:default:flash
-To jump to the bootloader, hold down "Button 4" (immediate right of the Mouse)
+To jump to the bootloader, hold down "Button 4" (the "forward" button on the left side)
See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
@@ -40,9 +40,18 @@ This should allow you to more heavily customize the behavior.
Alternatively, the `process_wheel` and `process_mouse` functions can both be replaced too, to allow for even more functionality.
-Additionally, you can change the DPI/CPI or speed of the Mouse by calling `pmw_set_cpi` at any time. And tThe default can be changed by adding a define to the keymap's `config.h` file:
+Additionally, you can change the DPI/CPI or speed of the krackball by calling `pmw_set_cpi` at any time. Additionally, there is a `DPI_CONFIG` macro that will cycle through an array of options for the DPI. This is set to 1200, 1600, and 2400, but can be changed. 1600 is also set to the default.
+
+To configure/set your own array, there are two defines to use, `PLOOPY_DPI_OPTIONS` to set the array, and `PLOOPY_DPI_DEFAULT`.
+
+```c
+#define PLOOPY_DPI_OPTIONS { 1200, 1600, 2400 }
+#define PLOOPY_DPI_DEFAULT 1
+```
+The `PLOOPY_DPI_OPTIONS` array sets the values that you want to be able to cycle through, and the order they are in. The "default" define lets the firmware know which of these options is the default and should be loaded by default.
+
+The `DPI_CONFIG` macro will cycle through the values in the array, each time you hit it. And it stores this value in persistent memory, so it will load it the next time the device powers up.
- #define PMW_CPI 1600
# Programming QMK-DFU onto the PloopyCo Mouse