aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Madison <dmadison@users.noreply.github.com>2019-03-09 17:17:34 -0500
committerGitHub <noreply@github.com>2019-03-09 17:17:34 -0500
commitd9c3f16a6edab9131d2c08b8d4ebeb320410b9f8 (patch)
tree5fc14aa6c06a2bd7d3d491ffc7ed5804c8a60ff3
parent4804dce9482cfb189e01710e44f78c71166d43ac (diff)
Re-wrote uploading section of README
The "hold and then release" reset process is what Arduino recommends but it never worked for me, the double reset is much more reliable.
-rw-r--r--README.md22
1 files changed, 15 insertions, 7 deletions
diff --git a/README.md b/README.md
index bb5fdb5..3f1c357 100644
--- a/README.md
+++ b/README.md
@@ -36,16 +36,24 @@ To uninstall, delete the 'xinput' folder in the 'hardware' directory, and then r
Due to the nature of how the XInput USB mode works, Arduinos that have XInput sketches on them will ***not*** automatically reset when programmed by the IDE! You will need to reset the board by hand every time you upload new code.
+You can ignore this section if you're using an external programmer.
+
+### How to Upload
+
+Connect the board to your computer using a USB cable, and make sure you have the proper board selected in the IDE's 'boards' menu (with or without XInput). If the board already has an XInput sketch on it, you do *not* need to select a serial port. You should also turn on 'verbose output' for uploading in the Arduino IDE's preferences (`File -> Preferences`). This makes it easier to time the manual reset and see if the upload succeeded.
+
+Lastly, you need to know where the 'reset' button is on your Arduino. If your board does not have a 'reset' button, you can wire your own by momentarily connecting the 'reset' pin to ground.
+
To upload to the board:
-* Connect the board via USB
-* Make sure the proper board is selected in the IDE
-* Hold the 'reset' button
-* Press 'Upload' in the IDE
-* Release the 'reset' button
+* Press the 'Upload' button in the IDE
+* Wait until the status bar says "Uploading..."
+* Press the reset button twice, quickly
+
+If you did these steps properly, the board should reset to the bootloader and the upload should begin. AVRDUDE will do its thing and you should see `avrdude done. Thank you.` near the bottom of the output window.
-If you did these steps properly, the board should reset to the bootloader and the upload should begin. If your board does not have a 'reset' button, you can wire your own by connecting the 'reset' pin to ground.
+Note that the IDE may say that it "Couldn't find a Board on the selected port" even if the upload succeeded. This is why it's important to turn on the verbose uploading output - look for the `avrdude` message.
-**Do *not* upload XInput sketches to your Arduino unless you know how to reset it!**
+**Do *not* upload XInput sketches to your Arduino unless you know how to reset it!** Otherwise you will not be able to program it anymore and you'll have to [reflash the bootloader](https://learn.sparkfun.com/tutorials/installing-an-arduino-bootloader/all) with an external programmer.
## Supported Boards