Skip to content

Commit 41f4066

Browse files
committed
Documentation content update post checklist review
1 parent 86024a3 commit 41f4066

File tree

8 files changed

+132
-119
lines changed

8 files changed

+132
-119
lines changed

content/hardware/04.pro/boards/portenta-x8/tutorials/01.user-manual/content.md

+7-113
Original file line numberDiff line numberDiff line change
@@ -131,123 +131,17 @@ The Portenta X8 offers a powerful, versatile platform by combining Linux capabil
131131

132132
It is recommended that you check every now and then to see if your Portenta X8 image version is up to date to have the latest security updates.
133133

134-
In the next sections, four ways to update your Portenta X8 are described:
134+
***To review the image version history, refer to the [__Portenta X8 firmware release notes__](https://docs.arduino.cc/tutorials/portenta-x8/x8-firmware-release-notes/).***
135135

136-
* [Update for OS release V.399](#update-for-os-release-v399)
137-
* [Update through Out-of-the-box experience](#update-through-out-of-the-box-experience)
138-
* [Update through Portenta X8 Manager in your Arduino Cloud for Business account (available for all OS releases)](#update-with-portenta-x8-board-manager)
139-
* [Update using the `uuu` tool (compatible with custom images)](#update-using-uuu-tool)
136+
There are four ways to update your Portenta X8 are described:
140137

141-
### Check Portenta X8 OS Release
142-
143-
To verify which OS release is flashed on your Portenta X8, you need to connect to your board through **ADB**, as explained in [this section](#working-with-linux) of this user manual.
144-
145-
You can type `cat /etc/os-release` in your command line window to get the OS release currently running on your device.
146-
147-
![Get OS release](assets/adb-shell-os-release.png "Get OS Release")
148-
149-
As shown in the image above, the OS release of this Portenta X8 corresponds to `IMAGE_VERSION=569`.
150-
151-
### Update For OS Release V.399
152-
153-
Open a new Command Line window and connect to your Portenta X8, as explained [here](#working-with-linux). At this point, verify that your Portenta X8 is connected to the Internet and type the following commands:
154-
155-
```bash
156-
wget https://downloads.arduino.cc/portentax8image/399-install-update
157-
```
158-
159-
```bash
160-
chmod +x 399-install-update
161-
```
162-
163-
```bash
164-
sudo ./399-install-update
165-
```
166-
167-
Now, you need to reboot the board by pressing its pushbutton for around 10 seconds. After that, connect again to your Portenta X8 through the Command Line and type the following commands:
168-
169-
```bash
170-
wget https://downloads.arduino.cc/portentax8image/399-finalize-update
171-
```
172-
173-
```bash
174-
chmod +x 399-finalize-update
175-
```
176-
177-
```bash
178-
sudo ./399-finalize-update
179-
```
180-
181-
These commands will make your V.399 compatible with the [aklite-offline](https://docs.foundries.io/latest/user-guide/offline-update/offline-update.html) tool. They will then allow you to update your Portenta X8 to the latest image version of Arduino released.
182-
183-
Arduino provides this tool for free for any Portenta X8 user to enable offline secure updates to all devices, even if those devices are not connected to any FoundriesFactory.
184-
185-
After the update process has finished, your Portenta X8 will start running the latest OS release immediately.
186-
187-
***If your Portenta X8 has the _OS release V.399_ and you have a carrier compatible with Portenta X8 (like Portenta Breakout). In that case, we recommend you update it to the latest image release by going to [flashing with `uuu tool`](#update-using-uuu-tool) section and follow the instructions found within the dedicated tutorial here: [__How To Flash Your Portenta X8__](https://docs.arduino.cc/tutorials/portenta-x8/image-flashing).***
188-
189-
### Update Through Out-Of-The-Box Experience
190-
191-
Leverage the integrated Out-of-the-box experience to update your Portenta X8 to the latest release.
192-
193-
***Warning: The Out-of-the-box update feature is not a complete Over-The-Air (OTA) update. It allows users to update only the Portenta X8 default image and containers. It will overwrite any custom container application. Thus, it is recommended to make a local copy of your containers before updating your Portenta X8.***
194-
195-
Open your Out-of-the-box as explained in [this section](#first-use-of-your-portenta-x8).
196-
197-
![Out-of-the-box homepage](assets/OOTB_homepage_update_button.png "Out-of-the-box homepage")
198-
199-
Click on **CHECK FOR UPDATES** in the lower right corner.
200-
201-
At this point, you have to select whether you would like to proceed with the update. If yes, click on **UPDATE**.
202-
203-
![Proceed with update](assets/OOTB_update_select.png "Proceed with update")
204-
205-
Please do not turn off your Portenta X8 or disconnect it from the network during the update. This process may take a few minutes.
206-
207-
![Successful update](assets/OOTB-succesful-OS-update.png "Successful update")
208-
209-
Once the update is finished, your Portenta X8 will automatically restart with the new Linux image in place.
210-
211-
At this point, if you want to continue using your Out-of-the-box, you can open a new command line window and launch the following command againg:
212-
213-
```bash
214-
adb forward tcp:8080 tcp:80
215-
```
216-
217-
Now open your browser, go to [**http://localhost:8080**](http://localhost:8080), and the same Out-of-the-box dashboard will appear.
218-
219-
In case you try to update the Portenta X8 and it has the latest available image, you will get following message:
220-
221-
![Latest update in place](assets/OOTB_homepage_update_latest.png "Latest update in place")
222-
223-
#### Troubleshooting
224-
225-
If something goes wrong during the update, you can manually flash your Portenta X8 with the latest Linux image provided at [this link](https://github.com/arduino/lmp-manifest/releases).
226-
227-
You can follow [this section](#update-using-uuu-tool) to learn to use the `uuu` tool and update your device manually with the latest OS Image version. Follow [this dedicated tutorial](https://docs.arduino.cc/tutorials/portenta-x8/image-flashing) to learn how to flash your device manually.
228-
229-
### Update With Portenta X8 Board Manager
230-
231-
If you have an **Arduino Cloud for Business** account with the Portenta X8 Manager, check if the target installed on your Portenta X8 is the latest one available in your FoundriesFactory.  
232-
233-
![FoundriesFactory device overview](assets/web_board_manager_factory_device-overview.png "FoundriesFactory device overview")
234-
235-
If this is not the case, you can update your device using FoundriesFactory **Waves** functionality. Check [this tutorial](https://docs.arduino.cc/tutorials/portenta-x8/waves-fleet-managment) to read the complete instructions.
236-
237-
More information about Waves can be found in the official Foundries documentation at [this link](https://docs.foundries.io/latest/reference-manual/factory/fioctl/fioctl_waves.html?highlight=wave).
238-
239-
### Update Using `uuu` Tool
240-
241-
An alternative method to update the Portenta X8 with the latest OS image is to use the `uuu` tool (or `uuu_mac` for macOS). This approach is particularly useful for users who have built a custom image or prefer a manual update process. The image files can be downloaded from the [Arduino repository](https://downloads.arduino.cc/portentax8image/image-latest.tar.gz) and extracted into a specific directory.
138+
* [Update for OS release V.399](https://docs.arduino.cc/tutorials/portenta-x8/image-flashing/#update-for-os-release-v399)
139+
* [Update through Out-of-the-box experience](https://docs.arduino.cc/tutorials/portenta-x8/image-flashing/#update-through-out-of-the-box-experience)
140+
* [Update through Portenta X8 Manager in your Arduino Cloud for Business account (available for all OS releases)](https://docs.arduino.cc/tutorials/portenta-x8/image-flashing/#update-with-portenta-x8-board-manager)
141+
* [Update using the `uuu` tool (compatible with custom images)](https://docs.arduino.cc/tutorials/portenta-x8/image-flashing/#update-using-uuu-tool)
242142

243143
You can find more details in the dedicated tutorial here: [**How To Flash Your Portenta X8**](https://docs.arduino.cc/tutorials/portenta-x8/image-flashing).
244144

245-
Depending on the carrier being used (e.g., Max Carrier, Breakout, Hat, or Mid Carrier), DIP switch settings must be adjusted to enter programming mode or specific commands can be executed via ADB for a barebone setup. Once the board is in programming mode, you can navigate to the extracted image files and run the `uuu full_image.uuu` command to begin the flashing process.
246-
247-
If not using a carrier, ensure the tool is running before cycling the power on the Portenta X8. Upon successful completion, reset the DIP switches or recycle the power to confirm the update.
248-
249-
***For a detailed guide, refer to the [Flashing Portenta X8 tutorial](https://docs.arduino.cc/tutorials/portenta-x8/image-flashing).***
250-
251145
## First Use Of Your Portenta X8
252146

253147
You can now start interacting with your Portenta X8. Portenta X8 has an embedded configuration console that will guide you step-by-step in configuring your board.  
@@ -756,7 +650,7 @@ You may want to build a custom image for the Portenta X8 with the source code pr
756650

757651
***Have a look at [this dedicated tutorial](https://docs.arduino.cc/tutorials/portenta-x8/image-building) to understand how to build your own custom image.***
758652

759-
### Interacting with Tenta-Config
653+
### Using the Integrated Overlay Configurator
760654

761655
**tenta-config** is a configuration tool for managing hardware settings and device tree overlays on compatible carriers. It provides a graphical interface for customizing system configurations with compatible carriers, such as peripheral management, adjusting video output settings, and managing pin mappings.
762656

content/hardware/04.pro/boards/portenta-x8/tutorials/09.image-flashing/content.md

+125-6
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ hardware:
1313

1414
## Overview
1515

16-
In this tutorial, you will learn how to manually flash your Portenta X8 with the image provided by Arduino. You will flash your board through USB using the Terminal. The instructions below are meant to be used with a **Windows Operating System**.
16+
In this tutorial, you will learn the different methods to flash your Portenta X8 with the image provided by Arduino. The process involves using the terminal to perform a USB based flashing procedure on a **Windows Operating System**. By the end, you will be able to update your Portenta X8 to the latest version, ensuring optimal performance and security.
1717

1818
## Goals
1919

20-
- Learn how to get the required files
21-
- Learn how to set up the correct structure of the files
22-
- Learn how to set up the board
23-
- Learn how to flash the device
20+
- Understand how to download and organize the required files for the flashing process
21+
- Learn how to set up the correct structure of the image files
22+
- Learn how to configure the board to enter programming mode
23+
- Learn how to run the flashing process through the terminal and verify a successful update
2424

2525
### Required Hardware and Software
2626

@@ -32,8 +32,127 @@ In this tutorial, you will learn how to manually flash your Portenta X8 with the
3232
- [Arduino Portenta Hat Carrier](https://store.arduino.cc/products/portenta-hat-carrier)
3333
- [Arduino Portenta Mid Carrier](https://store.arduino.cc/products/portenta-mid-carrier)
3434

35+
***Using a USB-C® to USB-C® cable may cause compatibility issues during the flashing process, so it is recommended to use a [__USB-C® to USB-A cable__](https://store.arduino.cc/products/usb-cable2in1-type-c).***
36+
3537
## Instructions
3638

39+
It is recommended to periodically check if your Portenta X8 image version is up to date to ensure you have the latest security updates. Four methods are available for updating your Portenta X8:
40+
41+
* [Update for OS release V.399](#update-for-os-release-v399)
42+
* [Update through Out-of-the-box experience](#update-through-out-of-the-box-experience)
43+
* [Update through Portenta X8 Manager in your Arduino Cloud for Business account (available for all OS releases)](#update-with-portenta-x8-board-manager)
44+
* [Update using the `uuu` tool (compatible with custom images)](#update-using-uuu-tool)
45+
46+
## Check Portenta X8 OS Release
47+
48+
To verify which OS release is flashed on your Portenta X8, you need to connect to your board through **ADB**.
49+
50+
***If you have not yet read how to work with Linux on the Portenta X8, please check out [this section](https://docs.arduino.cc/tutorials/portenta-x8/user-manual/#working-with-linux) of the Portenta X8 user manual.***
51+
52+
You can type the following command in the command line window to get the OS release currently running on your device.
53+
54+
```bash
55+
cat /etc/os-release
56+
```
57+
58+
![Get OS release](assets/adb-shell-os-release.png "Get OS Release")
59+
60+
As shown in the image above, the OS release of this Portenta X8 corresponds to **`IMAGE_VERSION=569`**.
61+
62+
## Update For OS Release V.399
63+
64+
Open a new Command Line window and connect to your Portenta X8. At this point, verify that your Portenta X8 is connected to a network and use the following commands:
65+
66+
```bash
67+
wget https://downloads.arduino.cc/portentax8image/399-install-update
68+
```
69+
70+
```bash
71+
chmod +x 399-install-update
72+
```
73+
74+
```bash
75+
sudo ./399-install-update
76+
```
77+
78+
Now, you need to reboot the board by pressing its pushbutton for around *10 seconds*. After that, connect again to your Portenta X8 through the Command Line and type the following commands:
79+
80+
```bash
81+
wget https://downloads.arduino.cc/portentax8image/399-finalize-update
82+
```
83+
84+
```bash
85+
chmod +x 399-finalize-update
86+
```
87+
88+
```bash
89+
sudo ./399-finalize-update
90+
```
91+
92+
These commands will make your V.399 Portenta X8 compatible with the [aklite-offline](https://docs.foundries.io/latest/user-guide/offline-update/offline-update.html) tool. It will then allow you to update your Portenta X8 to the latest image version of Arduino released.
93+
94+
Arduino provides this tool for free for any Portenta X8 user to enable offline secure updates to all devices, even if those devices are not connected to any *FoundriesFactory*.
95+
96+
When the update process has finished, your Portenta X8 will start running the latest OS release immediately.
97+
98+
***If your Portenta X8 is running _OS release V.399_ and is connected to a compatible carrier board, like the Portenta Breakout, it is recommended to update it to the latest image release by following the instructions in the [flashing with `uuu tool`](#update-using-uuu-tool) section.***
99+
100+
## Update Through Out-Of-The-Box Experience
101+
102+
Leverage the integrated Out-of-the-box experience to update your Portenta X8 to the latest release.
103+
104+
***Warning: The Out-of-the-box update feature is not a complete Over-The-Air (OTA) update. It only updates the default Portenta X8 image and containers, overwriting any custom container applications. Therefore, it is recommended to back up your containers locally before updating your Portenta X8.***
105+
106+
Open your Out-of-the-box page.
107+
108+
***If you have not yet learned how to use the Out-of-the-box on the Portenta X8, please refer to [this section](https://docs.arduino.cc/tutorials/portenta-x8/user-manual/#first-use-of-your-portenta-x8) of the Portenta X8 user manual.***
109+
110+
![Out-of-the-box homepage](assets/OOTB_homepage_update_button.png "Out-of-the-box homepage")
111+
112+
Click on **CHECK FOR UPDATES** in the lower right corner.
113+
114+
If an update is available and you wish to proceed, click **UPDATE**.
115+
116+
![Proceed with update](assets/OOTB_update_select.png "Proceed with update")
117+
118+
Do not turn off your Portenta X8 or disconnect it from the network during the update process, which may take a few minutes.
119+
120+
![Successful update](assets/OOTB-succesful-OS-update.png "Successful update")
121+
122+
Once the update is complete, your Portenta X8 will automatically restart with the new Linux image.
123+
124+
To continue using the Out-of-the-box feature, open a new command line window and enter:
125+
126+
```bash
127+
adb forward tcp:8080 tcp:80
128+
```
129+
130+
Then, open your browser and access the Out-of-the-box dashboard at [**http://localhost:8080**](http://localhost:8080).
131+
132+
If your Portenta X8 is already running the latest image, you will see the following message:
133+
134+
![Latest update in place](assets/OOTB_homepage_update_latest.png "Latest update in place")
135+
136+
### Troubleshooting
137+
138+
If something goes wrong during the update, you can manually flash your Portenta X8 with the latest Linux image provided at [this link](https://github.com/arduino/lmp-manifest/releases).
139+
140+
You can follow [this section](#update-using-uuu-tool) to learn to use the `uuu` tool and update your device manually with the latest OS Image version.
141+
142+
## Update With Portenta X8 Board Manager
143+
144+
If you have an **Arduino Cloud for Business** account with the Portenta X8 Manager, check if the target installed on your Portenta X8 is the latest one available in your FoundriesFactory.  
145+
146+
![FoundriesFactory device overview](assets/web_board_manager_factory_device-overview.png "FoundriesFactory device overview")
147+
148+
If your device is not up to date, you can update it using the FoundriesFactory **Waves** functionality. For detailed instructions, refer to [this tutorial](https://docs.arduino.cc/tutorials/portenta-x8/waves-fleet-managment).
149+
150+
For more information about **Waves**, you can visit the official *Foundries* documentation at [this link](https://docs.foundries.io/latest/reference-manual/factory/fioctl/fioctl_waves.html?highlight=wave).
151+
152+
## Update Using `uuu` Tool
153+
154+
An alternative method to update the Portenta X8 with the latest OS image is to use the `uuu` tool (or `uuu_mac` for macOS). This approach is particularly useful for users who have built a custom image or prefer a manual update process. The image files can be downloaded from the [Arduino repository](https://downloads.arduino.cc/portentax8image/image-latest.tar.gz) and extracted into a specific directory.
155+
37156
### Arduino's Download Repository
38157

39158
Go to [Arduino Download repository](https://downloads.arduino.cc/portentax8image/image-latest.tar.gz), and a compressed `.tar.gz` with the latest version of all the required OS image files will be there to download.
@@ -152,7 +271,7 @@ If the Portenta X8 was flashed barebone, you will need to recycle the power and
152271

153272
## Conclusion
154273

155-
In this tutorial, you have learned to flash the Portenta X8 by getting the latest image, setting up the adequate file structure and the board, and finally flashing the board with these files.
274+
In this tutorial, you have learned how to flash the Portenta X8 by getting the latest image, setting up the adequate file structure, configuring the board, and completing the flashing process via USB. By following these steps, you now have the tools to update your device to the latest firmware, ensuring it operates with the latest features and security patches.
156275

157276
## Troubleshooting
158277

0 commit comments

Comments
 (0)