diff --git a/Appendix-D:-QMK-Firmware-Programming.md b/Appendix-D:-QMK-Firmware-Programming.md index 6093b96..681b09f 100644 --- a/Appendix-D:-QMK-Firmware-Programming.md +++ b/Appendix-D:-QMK-Firmware-Programming.md @@ -1,6 +1,6 @@ # Working with QMK -The Ploopy Mini Trackball 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 Trackball. +The Ploopy Nano Trackball 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 Trackball. ## Before you begin @@ -12,13 +12,13 @@ QMK was built for keyboards, so you'll see lots of references to code that looks Whenever you see that, use the following syntax: -`-kb ploopyco/trackball_mini/rev1_001` +`-kb ploopyco/trackball_nano/rev1_001` and you'll be fine. ## Flashing a bootloader -You only need to flash a bootloader if you're building a Ploopy Mini Trackball from scratch, or if your bootloader has become corrupted in some way. +You only need to flash a bootloader if you're building a Ploopy Nano Trackball 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. @@ -34,25 +34,26 @@ You'll require the following fuse settings when programming the bootloader: With your terminal window open and pointed at your QMK build environment, compile the firmware with the following command: -`qmk compile -kb ploopyco/trackball_mini/rev1_001 -km via` +`qmk compile -kb ploopyco/trackball_nano/rev1_001 -km via` Alternatively, you can invoke the Makefile directly with the following: -`make ploopyco/trackball_mini/rev1_001:via` +`make ploopyco/trackball_nano/rev1_001:via` -If you wish, you can use the default keymap (with `qmk compile -kb ploopyco/trackball_mini/rev1_001 -km default` or `make ploopyco/trackball_mini/rev1_001:default`). However, the VIA keymap is particularly interesting because it allows for customization of the trackball'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. +If you wish, you can use the default keymap (with `qmk compile -kb ploopyco/trackball_nano/rev1_001 -km default` or `make ploopyco/trackball_nano/rev1_001:default`). However, the VIA keymap is particularly interesting because it allows for customization of the trackball'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 Trackball into bootloader mode +## Putting the Ploopy Nano Trackball into bootloader mode Putting the Ploopy Trackball into bootloader mode is very easy. 1. Unplug it from your computer. -2. Hold the "forward" button. This is the button just to the right of the ball; it normally sits under your ring (fourth) finger. -3. While holding the forward button, plug the Ploopy Mini Trackball 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. +2. Open it by removing the screw in the base. +3. Hold the hardware reset button. It's the only tactile push buttons switch on the board. +4. While holding the hardware reset button, plug the Ploopy Nano Trackball 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 Mini Trackball will accept new firmware. +And that's it. While plugged in this way, the Ploopy Nano Trackball will accept new firmware. ## Flashing the firmware