Skip to content

Commit 3e2d1af

Browse files
committed
Documentation content update
1 parent f77dec5 commit 3e2d1af

9 files changed

+36
-3
lines changed

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

Lines changed: 36 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,7 @@ It is recommended that you check every now and then to see if your Portenta X8 i
132132
In the next sections, four major ways to update your Portenta X8 are described:
133133

134134
* Update for OS release V.399
135+
* Update through Out-of-the-box experience
135136
* Update through Portenta X8 Manager in your Arduino Cloud for Business account (available for all OS releases)
136137
* Update using the `uuu` tool (compatible with custom images)
137138

@@ -183,6 +184,34 @@ Arduino provides this tool for free for any Portenta X8 user to enable offline s
183184

184185
After the update process is finalized, your Portenta X8 will start running the latest OS release immediately.
185186

187+
### Update Through Out-Of-The-Box Experience
188+
189+
Leverage the integrated Out-of-the-box experience to update your Portenta X8 to the latest release.
190+
191+
***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.***
192+
193+
Open your Out-of-the-box as explained in [this section](#first-use-of-your-portenta-x8).
194+
195+
![Out-of-the-box homepage](assets/OOTB_homepage_update_button.png "Out-of-the-box homepage")
196+
197+
Click on **CHECK FOR UPDATES** in the lower right corner.
198+
199+
At this point, you have to select whether you would like to proceed with the update. If yes, click on **UPDATE**.
200+
201+
![Proceed with update](assets/OOTB_update_select.png "Proceed with update")
202+
203+
Please do not turn off your Portenta X8 or disconnect it from the network during the update. This process may take a few minutes.
204+
205+
![Successful update](assets/OOTB-succesful-OS-update.png "Successful update")
206+
207+
Once the update is finished, your Portenta X8 will automatically restart with the new Linux image in place.
208+
209+
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 command `adb forward tcp:8080 tcp:80` again. Now open your browser, go to [http://localhost:8080](http://localhost:8080), and the same Out-of-the-box dashboard will appear.
210+
211+
In case you try to update the Portenta X8 and it has the latest available image, you will get following message:
212+
213+
![Latest update in place](assets/OOTB_homepage_update_latest.png "Latest update in place")
214+
186215
#### Troubleshooting
187216

188217
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).
@@ -215,7 +244,7 @@ You can now start interacting with your Portenta X8. Portenta X8 has an embedded
215244

216245
### Power The Board
217246

218-
Connect the Portenta X8 to your PC via a USB-C® cable (either USB-C® to USB-A or USB-C® to USB-C®).
247+
Connect the Portenta X8 to your PC via a [USB-C® cable (either USB-C® to USB-A)](https://store.arduino.cc/products/usb-cable2in1-type-c).
219248

220249
Once connected, you will see the Portenta X8 LEDs start blinking. Portenta X8 features two LEDs, a Power LED, and a Status LED, which can blink in parallel.
221250

@@ -469,11 +498,11 @@ To complete the registration of the Board with the FoundriesFactory, copy the co
469498

470499
![Out-of-the-box Factory code challenge](assets/OOTB_board_manager_factory_challenge.png "Out-of-the-box Factory code challenge")
471500

472-
Click on **COMPLETE REGISTRATION** to be re-directed to the Foundries.io activation page.
501+
Click on **COMPLETE REGISTRATION** to be re-directed to the *Foundries.io* activation page.
473502

474503
Paste your token in the text box and press **Next**.
475504

476-
***The token code is valid for 15 minutes; if you do not paste it in this time span, you will have to repeat all the above registration steps in your Out-of-the-box to generate a new code.***
505+
***The token code is valid for __15 minutes__. If you do not use it in this time span, you will have to repeat all the above registration steps in your Out-of-the-box to generate a new code.***
477506

478507
![FoundriesFactory pasted token](assets/web_board_manager_factory_challenge.png "FoundriesFactory pasted token")
479508

@@ -495,6 +524,10 @@ To verify your device status, click on your FoundriesFactory, go to the **Device
495524

496525
![FoundriesFactory device overview](assets/web_board_manager_factory_device-overview.png "FoundriesFactory device overview")
497526

527+
You can also check within the Out-of-the-box home screen for factory registration if it was successfully registered.
528+
529+
![Out-of-the-box Factory registration confirmation](assets/OOTB_board_manager_factory_confirm.png "Out-of-the-box Factory registration confirmation")
530+
498531
***If you want to learn more about Portenta X8 Manager features, check the dedicated section of this user manual called [Working with Portenta X8 Board Manager](#working-with-portenta-x8-board-manager).***
499532

500533
## Working with Linux

0 commit comments

Comments
 (0)