Skip to content

Commit

Permalink
updated firmwares; updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ploopyco committed Dec 11, 2024
1 parent 7b86aed commit c300c2f
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 19 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ Kits bought from the [Ploopy store](https://ploopy.co/product-category/trackpad/

The firmware for the Trackpad hasn't been merged into QMK at the time of this commit, so for now, [firmware can be found here](https://github.com/ploopyco/qmk_firmware/tree/multitouch_experiment).

The firmware hex file that ships with all Adepts is included in this repository as well, as `ploopyco_pavonis_default.uf2`.
The firmware hex file that ships with all Trackpads is included in this repository as well, as `ploopyco_pavonis_default.uf2`.

A version of the firmware that is used for debugging and development is included here, as `ploopyco_pavonis_debug.uf2`. Don't use this firmware unless you need to use the [Maxtouch Debug App](https://ploopyco.github.io/trackpad/appendices/debugapp/).

## Under what license is this released?

Expand Down
7 changes: 6 additions & 1 deletion docs/appendices/debugapp.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,16 @@ To alter them quickly and see the effects that the alterations have, [George Nor

## Debug firmware

In order to use the debug app, you'll need to rebuild the Pavonis firmware, using the `debug` keymap instead of the `default` keymap.
In order to use the debug app, you'll need to flash the `debug` firmware onto the Trackpad, available [here](https://github.com/ploopyco/trackpad/blob/main/ploopyco_pavonis_debug.uf2).

If necessary, follow the guide in [Appendix D](programming.md) to put new firmware onto the Trackpad.


## Putting the Ploopy Trackpad into bootloader mode while using the `debug` keymap firmware

Putting the Ploopy Trackpad into bootloader mode while using the `debug` firmware is very easy. Just put all five fingers down on the trackpad surface at once! The computer should state that your Trackpad was disconnected, and that a mass storage device was just plugged in. Once this is done, you should be able to drag and drop files onto the Ploopy device, as if the board was a USB drive.


## How to use it, though?

This, unfortunately, is the tricky part. Microchip places the documentation for the MXT1066 under NDA, which means that we are unable to share our copy with you. However, if you have a Microchip account, you can download the documentation for yourself quickly and easily.
Expand Down
28 changes: 11 additions & 17 deletions docs/appendices/programming.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,32 +35,26 @@ Alternatively, you can invoke the Makefile directly with the following:

For more details on building QMK firmware in general, see the [QMK firmware guide](https://docs.qmk.fm/#/newbs_building_firmware).

## Putting the Ploopy Trackpad into bootloader mode
## Putting the Ploopy device into bootloader mode

Putting the Ploopy Trackpad into bootloader mode is very easy. Just put all five fingers down on the trackpad surface at once! The computer should state that your Trackpad was disconnected, and that a mass storage device was just plugged in. Once this is done, you should be able to drag and drop files onto the Ploopy device, as if the board was a USB drive.
Putting the Ploopy device into bootloader mode is very simple and straightforward.

While plugged in this way, the Ploopy device will accept new firmware.

If you want to upload a new firmware file (a ".uf2" file, like "ploopy_trackpad_v42069" or something), just drag it into the folder, and it'll automatically install on the Ploopy device and restart itself.

Whenever you want to put new firmware onto the Ploopy device, go through these steps again.

**TIP**: If your firmware is in some kind of strange state and uploading new firmware isn't fixing it, try uploading [a flash nuke](https://learn.adafruit.com/getting-started-with-raspberry-pi-pico-circuitpython/circuitpython#flash-resetting-uf2-3083182) to the Trackpad before flashing the new firmware. It wipes the memory of the Trackpad completely clean, which can help clear a few types of errors.

## Putting the Ploopy device into bootloader mode if it's bricked

Putting the Ploopy device into bootloader mode if it's bricked is a bit more involved, but still doable.

1. Unplug it from your computer.
2. Flip it over. Unscrew the bootloader cap.
3. You should see two gold-covered holes exposed on the PCB.
1. Unplug the device from your computer.
2. Flip it over onto it's back. Unscrew the bootloader cap.
3. You should see two gold-covered holes exposed on the PCB once the cap is removed.
4. Get a paper clip (non-insulated, i.e. no plastic shit covering it) or a pair of tweezers, or some wire. Whatever you've got on hand that's metal.
5. Stick the paper clip or tweezers into the holes. You're trying to form an electrical connection between the two holes.
6. While you've got the two vias connected with your metal bridge, plug the Ploopy device into your computer.
7. The computer should recognise that a mass storage device was just plugged in. Once this is done, you should be able to drag and drop files onto the Ploopy device, as if the board was a USB drive. Feel free to remove the tweezers or paperclip at this point.

And that's it. While plugged in this way, the Ploopy device will accept new firmware.

If you want to upload a new firmware file (a ".uf2" file, like "ploopy_trackpad_v42069" or something), just drag it into the folder, and it'll automatically install on the Ploopy device and restart itself.

Whenever you want to put new firmware onto the Ploopy device, go through these steps again.

**TIP**: If your firmware is in some kind of strange state and uploading new firmware isn't fixing it, try uploading [a flash nuke](https://learn.adafruit.com/getting-started-with-raspberry-pi-pico-circuitpython/circuitpython#flash-resetting-uf2-3083182) to the Trackpad before flashing the new firmware. It wipes the memory of the Trackpad completely clean, which can help clear a few types of errors.

## And that's it!

Happy customizing!
Binary file added ploopyco_pavonis_debug.uf2
Binary file not shown.

0 comments on commit c300c2f

Please sign in to comment.