diff options
author | Drashna Jaelre <drashna@live.com> | 2020-09-27 15:11:41 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-09-27 15:11:41 -0700 |
commit | fbdc65e2e956e9d51c94fecdbce1f0abc2817950 (patch) | |
tree | f7e31480856b1ce14a70941bc0641cb6647b688f /keyboards/ploopyco/mouse/readme.md | |
parent | 34b9c51d9cb9694e2e1d0667758f33054a2aad81 (diff) |
[Keyboard] Add PloopyCo devices (#7935)
* Initial Commit for Ploopyco Trackball
This is a WIP at this point. Most of it compiles, but the SPI commands are non-functioning as they come from Arduino, so don't exist in LUFA
* Convert SPI commands from arduino to LUFA
But I have no idea if this is actually correct or not
* Update keyboard readme
* Clean up ploopyco trackball
* Update readme
* Update mouse key stuff
* last minutue cleanup
* Add caveat about scroll wheel
* Fixup to code
* Additional fixup
* Add movement multiplier
* Rename folders
* mid changes
* temp
* Got it working!!!!!
* Additional cleanup of code
* Make unused pin calls more compact
* Rotation info
* Add debouncing checks
* Make everything replaceable
* Add info.json
* Include ISP flashing info
* Better handling for user customization
* Reconfigure CPI stuff
* fix issues with debug printing
* Fix tiny scroll issue
* Add and update scroll code from ploopy mouse
* Update licensing
* Add PloopyCo Mouse
* Cleanup and layout stuff
* Move common files to main folder for reuse
* Increase polling rate
* Update image for mouse
* Apply changes from code review
* Add VIA support
Diffstat (limited to 'keyboards/ploopyco/mouse/readme.md')
-rw-r--r-- | keyboards/ploopyco/mouse/readme.md | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/keyboards/ploopyco/mouse/readme.md b/keyboards/ploopyco/mouse/readme.md new file mode 100644 index 0000000000..abfa643a44 --- /dev/null +++ b/keyboards/ploopyco/mouse/readme.md @@ -0,0 +1,68 @@ +# Ploopyco Mouse + +![Ploopyco Mouse](https://i.redd.it/bf7bkzqzeti51.jpg) + +It's a DIY, QMK Powered Trackball!!!! + +Everything works. However the scroll wheel has some issues and acts very odd. + +* Keyboard Maintainer: [PloopyCo](https://github.com/ploopyco), [Drashna Jael're](https://github.com/drashna/), [Germ](https://github.com/germ/) +* Hardware Supported: ATMega32u4 8MHz(3.3v) +* Hardware Availability: [Store](https://ploopy.co), [GitHub](https://github.com/ploopyco) + +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) + +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). + +# Customzing your PloopyCo Trackball + +While the defaults are designed so that it can be plugged in and used right away, there are a number of things that you may want to change. Such as adding DPI control, or to use the ball to scroll while holding a button. To allow for this sort of control, there is a callback for both the scroll wheel and the mouse censor. + +The default behavior for this is: + +```c +void process_wheel_user(report_mouse_t* mouse_report, int16_t h, int16_t v) { + mouse_report->h = h; + mouse_report->v = v; +} + +void process_mouse_user(report_mouse_t* mouse_report, int16_t x, int16_t y) { + mouse_report->x = x; + mouse_report->y = y; +} +``` + +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: + + #define PMW_CPI 1600 + +# Programming QMK-DFU onto the PloopyCo Mouse + +If you would rather have DFU on this board, you can use the QMK-DFU bootloader on the device. To do so, you want to run: + + make ploopyco/trackball:default:production + +Once you have that, you'll need to [ISP Flash](https://docs.qmk.fm/#/isp_flashing_guide) the chip with the new bootloader hex file created (or the production hex), and set the fuses: + + +| Fuse | Setting | +|----------|------------------| +| Low | `0xDF` | +| High | `0xD8` or `0x98` | +| Extended | `0xCB` | + +Original (Caterina) settings: + +| Fuse | Setting | +|----------|------------------| +| Low | `0xFF` | +| High | `0xD8` | +| Extended | `0xFE` | |