diff --git a/README.md b/README.md index 185182c..a5875e7 100644 --- a/README.md +++ b/README.md @@ -8,28 +8,40 @@ Use this tool to install your initial WiFiCom files or to update an existing WiF - MacOS Sonoma before 14.4 corrupts files on CIRCUITPY drives! Put your WiFiCom in Drive Mode first, then use the workaround on [this page](https://learn.adafruit.com/welcome-to-circuitpython/troubleshooting) before running `wificom-update-tool`. ## Updating +- See the bottom section if any of these steps look different on your device! - Back up the files on your CIRCUITPY drive if you changed anything important. This tool aims to preserve previous WiFiCom config and only delete/overwrite specific files, but be cautious about any files you don't want to lose. -- Put your WiFiCom into Drive Mode using the menu. - - If you cannot do this (because it is a screenless unit, or because something has gone wrong), then use Dev Mode instead: connect the WiFiCom to USB while holding the C button (the only button on screenless units) then release the button promptly when the LED comes on. +- Put the WiFiCom into Drive Mode using the menu. - Run the update tool and select an option. - If a CircuitPython upgrade/downgrade is recommended, the tool will link to the appropriate file. - Choose "Download UF2 file" to save the file using your web browser. - Eject (safely remove) the CIRCUITPY drive from your computer. - - Put the unit into bootloader mode: - - On Pi Pico W, disconnect the USB / power supply, and reconnect while holding the BOOT button. - - On Xanthos's premade units, the BOOT button is on the back. You may need a tool to press it. - - On Arduino Nano RP2040 Connect, double-click the RESET button. + - Exit Drive Mode by holding the C button. + - Put the unit into bootloader mode using the option in the Settings menu. - Copy the UF2 file into the RPI-RP2 drive that appears. - - Re-run the update tool and select the same option as before. + - When the WiFiCom has rebooted, put it back into drive mode, and re-run the update tool with the same option as before. - Wait for the update to complete. - Eject (safely remove) the CIRCUITPY drive from your computer. -- If the WiFiCom is in "Drive Mode", select another option from the menu. If it is a screenless unit or in "Dev Mode", disconnect and reconnect the USB / power supply, or press the RESET button once if you have one. +- Exit Drive Mode by holding the C button. ## Installing on a new build -- Install the appropriate version of CircuitPython (see [wificom-lib](https://github.com/mechawrench/wificom-lib)) using the instructions above. On a fresh board, the RPI-RP2 drive appears by default. +- Install the appropriate version of CircuitPython (see [wificom-lib](https://github.com/mechawrench/wificom-lib)). On a fresh board, the RPI-RP2 drive appears by default. Otherwise, enter bootloader mode using the instructions below. - If you are using a custom circuit layout, modify "board_config.py" from wificom-lib and save it to your CIRCUITPY drive. - Run the update tool and select an option. - Wait for the installation to complete. - Create a new WiFiCom on https://wificom.dev/ and follow the "Credentials Download" instructions on the page that appears. - Eject (safely remove) the CIRCUITPY drive from your computer. -- Disconnect and reconnect the USB / power supply, or press the RESET button once if you have one. +- Disconnect and reconnect the USB / power supply. + +## Exceptions (P-Com, older versions, non-bootable) +### Making the CIRCUITPY drive writeable +- WiFiCom Dev Mode: connect the unit to USB while holding the C button (or the only button) then release the button promptly when the LED comes on. +- P-Com with no LED: connect the unit to USB while holding the main button, and keep holding until the CIRCUITPY drive appears. +### Rebooting into normal mode (make CIRCUITPY read-only again) +- **First** eject (safely remove) the CIRCUITPY drive from your computer. +- Older WiFiCom firmware in "Drive Mode": select a different mode from the menu. +- Screenless units / WiFiCom in "Dev Mode" / not running: disconnect and reconnect the USB / power supply. +- Arduino Nano RP2040 Connect: press the RESET button once. +### Bootloader mode +- Most boards: disconnect the USB / power supply, reconnect while holding the BOOT button, and keep holding until the RPI-RP2 drive appears. +- Xanthos's premade units: the BOOT button is on the back. On battery units you will need to detach the battery module. You may need a tool to press the button. +- Arduino Nano RP2040 Connect: double-click the RESET button.