-
-
Notifications
You must be signed in to change notification settings - Fork 501
[PXCT-1397] Re-flashing UNO Q with a new image (arduino-flasher-cli) #2661
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Binary file added
BIN
+879 KB
...t/hardware/02.uno/boards/uno-q/tutorials/04.update-image/assets/flash-uno-q.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+658 KB
content/hardware/02.uno/boards/uno-q/tutorials/04.update-image/assets/linux.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+300 KB
content/hardware/02.uno/boards/uno-q/tutorials/04.update-image/assets/macos.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+221 KB
content/hardware/02.uno/boards/uno-q/tutorials/04.update-image/assets/windows.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
112 changes: 112 additions & 0 deletions
112
content/hardware/02.uno/boards/uno-q/tutorials/04.update-image/update-image.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| --- | ||
| title: Flashing a New Image to the UNO Q | ||
| description: Learn how to flash a new image (the Linux OS) to the UNO Q board using the Arduino Flasher CLI. | ||
| tags: [UNO Q, Arduino] | ||
| author: Karl Söderby | ||
| --- | ||
|
|
||
| The [Arduino® UNO Q](https://store.arduino.cc/products/uno-q) runs a Linux operating system (OS), which comes pre-installed on the board. | ||
|
|
||
| There is often no need to re-install the OS on your board (also known as flashing an image), as the OS automatically receives updates regularly. | ||
|
|
||
| However, if we want to hard-reset the board and perform a fresh installation, it is possible. This process requires some additional tools installed on your machine. | ||
|
|
||
| ***Note that the instructions in this tutorial will wipe the board clean, and files & configurations saved on the board will be destroyed.*** | ||
|
|
||
| ## Requirements | ||
|
|
||
| ### Hardware Requirements | ||
|
|
||
| - [Arduino® UNO Q](https://store.arduino.cc/products/uno-q) | ||
| - [USB-C® cable](https://store.arduino.cc/products/usb-cable2in1-type-c) | ||
| - Female-to-female jumper wire | ||
|
|
||
| ### Software Requirements | ||
|
|
||
| To re-flash the board, we will use the **Arduino Flasher CLI** tool: | ||
|
|
||
| - Download the [Arduino Flasher CLI](https://www.arduino.cc/en/software/) | ||
|
|
||
| ***Note that this tool will download an image with a size that exceeds 1 GB. A stable Internet connection is recommended.*** | ||
|
|
||
| ## Download & Install CLI Tool | ||
|
|
||
| 1. Download the [Arduino Flasher CLI](https://www.arduino.cc/en/software/) for your OS (MacOS / Linux / Windows) | ||
| 2. Unzip the downloaded file, (you will receive a executable binary named `arduino-flasher-fli`) | ||
|
|
||
| ### Verify Tool Is Installed | ||
|
|
||
| Before flashing a new image, check that the `arduino-flasher-cli` tool is working. Below are instructions to verify the tool is installed and working on your OS. | ||
|
|
||
| #### MacOS | ||
|
|
||
| Navigate to the unzipped folder (e.g. `arduino-flasher-cli-x.x.x-darwin-arm64`), and run the following command: | ||
|
|
||
| ``` | ||
| ./arduino-flasher-cli | ||
| ``` | ||
|
|
||
| You should see something like: | ||
|
|
||
|  | ||
|
|
||
| This means it is working, and we can proceed to [flashing the board](#flash-image-to-the-board). | ||
|
|
||
| #### Linux | ||
|
|
||
| Navigate to the unzipped folder (e.g. `arduino-flasher-cli-x.x.x-darwin-arm64`), and run the following command: | ||
|
|
||
| ``` | ||
| ./arduino-flasher-cli | ||
| ``` | ||
|
|
||
| You should see something like: | ||
|
|
||
|  | ||
|
|
||
| This means it is working, and we can proceed to [flashing the board](#flash-image-to-the-board). | ||
|
|
||
| #### Windows | ||
|
|
||
| Navigate to the unzipped folder (e.g. `arduino-flasher-cli-x.x.x-darwin-arm64`), and run the following command: | ||
|
|
||
| ``` | ||
| arduino-flasher-cli | ||
| ``` | ||
|
|
||
| A new window should appear, prompting you to install the driver. Install it, and run `arduino-flasher-cli` again in the terminal. | ||
|
|
||
|  | ||
|
|
||
| This means it is working, and we can proceed to [flashing the board](#flash-image-to-the-board). | ||
|
|
||
| ## Preparing the Hardware | ||
|
|
||
| To prepare the hardware for flashing, follow the instructions below: | ||
|
|
||
| 1. Disconnect the board from your computer. | ||
| 2. Add the female-to-female jumper cable between the two pins specified in the image: | ||
|
|
||
|  | ||
|
|
||
| 3. Do **not** connect the board to the computer yet. This will need to be timed in the next step. | ||
|
|
||
| ## Flash Image to the Board | ||
|
|
||
| In this step, we will upload the new image to the board using the Arduino Flasher CLI. | ||
|
|
||
| 1. Open a terminal and navigate to the directory where you unzipped the Arduino Flasher CLI (normally `/Downloads`). | ||
| 2. Enter the following command in the terminal: `./arduino-flasher-cli flash latest` **but do not run it yet!** | ||
| 3. Connect the board to the computer, and run the above `./arduino-flasher-cli flash latest` command **directly** after connecting the board (while the board's LED matrix is making animations). | ||
karlsoderby marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 4. First, a download sequence will begin. **Please note** that this process involves downloading a large file (the image), which exceeds 1 GB. | ||
karlsoderby marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 5. Once the download is complete, it will flash the board with the new image. This will also take several minutes. Do **not** disconnect the board during this process. | ||
karlsoderby marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ***It is important to run the flashing command ONLY when the board is booting up; it does not work once the OS has finished booting.*** | ||
|
|
||
|
|
||
| ## Troubleshooting | ||
|
|
||
| - Ensure the Arduino Flasher CLI is unzipped and accessible. | ||
| - Check that the pins are correctly shorted. | ||
karlsoderby marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
karlsoderby marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - Make sure the board has not finished booting when running the flashing command (`./arduino-flasher-cli flash latest`). | ||
| - Verify that you are running the command from the correct directory where the Arduino Flasher CLI was unzipped. | ||
karlsoderby marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.