MirrorMirror
/
mouse
mirror of https://github.com/ploopyco/mouse.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Created Appendix D: QMK Firmware Programming (markdown)

ploopyco 2022-03-02 09:50:03 -05:00
parent 88c1f85fe0
commit 4f0ba194f8
1 changed files with 70 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
Appendix-D:-QMK-Firmware-Programming.md Normal file

@ -0,0 +1,70 @@
# Working with QMK
The Ploopy Mouse is fairly easy to program and reprogram, thanks to the excellent work by all of the developers and maintainers of the [QMK firmware suite](https://github.com/qmk/qmk_firmware). This guide will focus specifically on flashing firmware to the Ploopy Mouse.
## Before you begin
If you have never used QMK before, go through [all of the steps in the QMK guide to set up your environment](https://docs.qmk.fm/#/newbs_getting_started).
QMK was built for keyboards, so you'll see lots of references to code that looks like the following:
`-kb <keyboard>`
Whenever you see that, use the following syntax:
`-kb ploopyco/mouse/rev1_002`
and you'll be fine.
## Flashing a bootloader
You only need to flash a bootloader if you're building a Ploopy Mouse from scratch, or if your bootloader has become corrupted in some way.
[Follow the steps in QMK's flashing guide](https://beta.docs.qmk.fm/using-qmk/guides/keyboard-building/isp_flashing_guide). You may require hardware that we don't provide, such as an Arduino device.
You'll require the following fuse settings when programming the bootloader:
| Fuse | Setting |
|----------|-------------|
| Low | `0x52` |
| High | `0x99` |
| Extended | `0xC3` |
## Building the Ploopy Mouse firmware
With your terminal window open and pointed at your QMK build environment, compile the firmware with the following command:
`qmk compile -kb ploopyco/mouse/rev1_002 -km via`
Alternatively, you can invoke the Makefile directly with the following:
`make ploopyco/mouse/rev1_002:via`
If you wish, you can use the default keymap (with `qmk compile -kb ploopyco/mouse/rev1_002 -km default` or `make ploopyco/mouse/rev1_002:default`). However, the VIA keymap is particularly interesting because it allows for customization of the Mouse's functions without reflashing the firmware, through the use of the convenient [VIA software package](https://github.com/the-via/releases/releases). It's incredibly handy, so definitely check it out.
For more details on building QMK firmware in general, see the [QMK firmware guide](https://docs.qmk.fm/#/newbs_building_firmware).
## Putting the Ploopy Mouse into bootloader mode
Putting the Ploopy Mouse into bootloader mode is very easy.
1. Unplug it from your computer.
2. Hold the "back" button.
3. While holding the back button, plug the Ploopy Mouse into your computer. If you're using QMK Toolbox, it should show up in the console. If using `dmesg`, it'll show up as an Atmel DFU device.
And that's it. While plugged in this way, the Ploopy Mouse will accept new firmware.
## Flashing the firmware
Use your preferred method of flashing QMK firmware.
- QMK Toolbox has been verified as working.
- Using `dfu-programmer` from a terminal window has also been verified as working.
For more details, see the [QMK guide](https://docs.qmk.fm/#/newbs_flashing) on flashing firmware.
## And that's it!
Unplug it, replug it in, and you should be good to go!
Happy customizing!