8000 [PC-1864] Portenta X8: Documentation Repository & Instructions Update… · CoolCoderBhavya/docs-content@27594b6 · GitHub
[go: up one dir, main page]
Skip to content

Commit 27594b6

Browse files
ArduinoBotTaddyHC
ArduinoBot
and
TaddyHC
authored
[PC-1864] Portenta X8: Documentation Repository & Instructions Update (arduino#2150)
* Initial commit - Portenta X8 Repo commands and instructions update * Fleet waves management commands update Foundries * RPC content container requirement file updated * Image building content commands additional update * Multiprotocol gateway commands minor update * Wordpress commands minor update --------- Co-authored-by: TaddyHC <k.hochung@arduino.cc>
1 parent b03bdc6 commit 27594b6

File tree

7 files changed

+26
-10
lines changed

7 files changed

+26
-10
lines changed

‎content/hardware/04.pro/boards/portenta-x8/essentials.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,15 @@
1111
</EssentialsColumn>
1212

1313
<EssentialsColumn title="Suggested Repositories">
14-
<EssentialElement link="https://github.com/arduino/portenta-containers" title="Portenta X8 containers" type="article">
14+
15+
<EssentialElement link="https://github.com/arduino/portenta-containers/" title="Portenta X8 containers" type="article">
1516
Some containers examples for Portenta X8, these containers are accessible through your Foundries.io factory.
1617
</EssentialElement>
18+
19+
<EssentialElement link="https://github.com/arduino/meta-partner-arduino/" title="Meta Partner Arduino layer" type="article">
20+
This repository contains Yocto recipes for building a Linux image for the Arduino Portenta X8.
21+
</EssentialElement>
22+
1723
</EssentialsColumn>
1824

1925
<EssentialsColumn title="Firmware Images">

‎content/hardware/04.pro/boards/portenta-x8/tutorials/04.python-arduino-data-exchange/assets/py-serialrpc.zip

-505 Bytes
Binary file not shown.

‎content/hardware/04.pro/boards/portenta-x8/tutorials/04.python-arduino-data-exchange/assets/python-sensor-rpc.zip

257 Bytes
Binary file not shown.

‎content/hardware/04.pro/boards/portenta-x8/tutorials/06.waves-fleet-managment/content.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,15 +47,17 @@ For security purposes, we recommend that you rotate your FoundriesFactory keys.
4747
First, we will rotate the root keys. These are the most important keys, as they are used to create new target keys. Rotate them with the command:
4848

4949
```bash
50-
fioctl keys rotate-root --initial /absolute/path/to/root.keys.tgz
50+
fioctl keys tuf rotate-offline-keys -r root -k /absolute/path/to/root.keys.tgz
5151
```
5252

5353
Now we can rotate the target-only keys with following command:
5454

5555
```bash
56-
fioctl keys rotate-targets /absolute/path/to/root.keys.tgz
56+
fioctl keys tuf rotate-offline-keys -r targets -k /absolute/path/to/root.keys.tgz
5757
```
5858

59+
***The above commands have been updated from the older __fioctl keys rotate-root__ and __fioctl keys rotate-targets__ commands to reflect the latest security practices recommended by [Foundries.io](https://docs.foundries.io/latest/reference-manual/security/offline-keys.html).***
60+
5961
And finally, for security reasons, we separating the target keys from the root using the following command:
6062

6163
```bash

‎content/hardware/04.pro/boards/portenta-x8/tutorials/08.image-building/content.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ hardware:
1414

1515
## Overview
1616

17-
In this tutorial, you will learn how to build an image for the Portenta X8 with the source code provided at our [GitHub repository for lmp-manifest](https://github.com/arduino/lmp-manifest). It is an ideal approach for debugging system elements like the bootloader or kernel support by building images locally.
17+
In this tutorial, you will learn how to build an image for the Portenta X8 with the source code provided at our [GitHub repository for lmp-manifest](https://github.com/arduino/lmp-manifest/). It is an ideal approach for debugging system elements like the bootloader or kernel support by building images locally.
1818

1919
***Images built locally cannot register with FoundriesFactory and will not be OTA compatible, but this is a good alternative for those who do not have a FoundriesFactory subscription.***
2020

@@ -40,9 +40,9 @@ This tutorial targets customers that are not FoundriesFactory subscribers, but s
4040

4141
#### Build the Docker Image
4242

43-
You will start by creating a Docker image with the necessary dependencies to build your device image. This involves cloning the [lmp-manifest repository](https://github.com/arduino/lmp-manifest) from Arduino's GitHub. Follow these steps:
43+
You will start by creating a Docker image with the necessary dependencies to build your device image. This involves cloning the [lmp-manifest repository](https://github.com/arduino/lmp-manifest/) from Arduino's GitHub. Follow these steps:
4444

45-
Clone the [lmp-manifest repository](https://github.com/arduino/lmp-manifest) using the command below:
45+
Clone the [lmp-manifest repository](https://github.com/arduino/lmp-manifest/) using the command below:
4646

4747
```bash
4848
git clone https://github.com/arduino/lmp-manifest.git
@@ -111,9 +111,17 @@ cd /dockerVolume
111111
```
112112

113113
```bash
114-
repo init -u https://github.com/arduino/lmp-manifest.git -m arduino.xml -b release
114+
repo init -u https://github.com/arduino/lmp-manifest.git -m arduino.xml -b main
115115
```
116116

117+
If no specific branch is mentioned, the command could default to:
118+
119+
```bash
120+
repo init -u https://github.com/arduino/lmp-manifest.git -m arduino.xml
121+
```
122+
123+
This would implicitly use the default branch, which is typically the *main* in repositories these days.
124+
117125
![Git-repo initialization](assets/repo_init.png)
118126

119127
Proceed to download the necessary files by synchronizing the repositories:

‎content/hardware/04.pro/boards/portenta-x8/tutorials/12.multi-protocol-gateway/content.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,13 +130,13 @@ sudo su -
130130
// Head to directory and mount the container
131131
cd /home/fio/py-serialrpc
132132
#py-serialrpc sudo docker build . -t py-serialrpc
133-
#py-serialrpc sudo docker-compose up -d
133+
#py-serialrpc sudo docker compose up -d
134134
```
135135

136136
To access the logs of `py-serialrpc` service, while maintaining the same directory, execute the following command.
137137

138138
```bash
139-
sudo docker-compose logs -f --tail 20
139+
sudo docker compose logs -f --tail 20
140140
```
141141

142142
***For more details about how data exchange between Arduino and Linux layer works and to understand how to debug, please read [Data Exchange Between Python® on Linux and an Arduino Sketch](https://docs.arduino.cc/tutorials/portenta-x8/python-arduino-data-exchange)***

‎content/hardware/04.pro/boards/portenta-x8/tutorials/13.wordpress-webserver/content.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ The `-d` flag runs the containers in the background; omitting it will tie the co
134134
The installation of the **WordPress** and **MariaDB** containers will begin and may take some time. To monitor the installation process, use:
135135

136136
```bash
137-
docker-compose logs -f
137+
docker compose logs -f
138138
```
139139

140140
Upon completion, your WordPress site will be accessible from the Portenta X8.

0 commit comments

Comments
 (0)
0