Skip to content

[PC-1864] Portenta X8: Documentation Repository & Instructions Update #2150

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
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion content/hardware/04.pro/boards/portenta-x8/essentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,15 @@
</EssentialsColumn>

<EssentialsColumn title="Suggested Repositories">
<EssentialElement link="https://github.com/arduino/portenta-containers" title="Portenta X8 containers" type="article">

<EssentialElement link="https://github.com/arduino/portenta-containers/" title="Portenta X8 containers" type="article">
Some containers examples for Portenta X8, these containers are accessible through your Foundries.io factory.
</EssentialElement>

<EssentialElement link="https://github.com/arduino/meta-partner-arduino/" title="Meta Partner Arduino layer" type="article">
This repository contains Yocto recipes for building a Linux image for the Arduino Portenta X8.
</EssentialElement>

</EssentialsColumn>

<EssentialsColumn title="Firmware Images">
Expand Down
Binary file not shown.
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,17 @@ For security purposes, we recommend that you rotate your FoundriesFactory keys.
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:

```bash
fioctl keys rotate-root --initial /absolute/path/to/root.keys.tgz
fioctl keys tuf rotate-offline-keys -r root -k /absolute/path/to/root.keys.tgz
```

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

```bash
fioctl keys rotate-targets /absolute/path/to/root.keys.tgz
fioctl keys tuf rotate-offline-keys -r targets -k /absolute/path/to/root.keys.tgz
```

***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).***

And finally, for security reasons, we separating the target keys from the root using the following command:

```bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ hardware:

## Overview

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.
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.

***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.***

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

#### Build the Docker Image

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:
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:

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

```bash
git clone https://github.com/arduino/lmp-manifest.git
Expand Down Expand Up @@ -111,9 +111,17 @@ cd /dockerVolume
```

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

If no specific branch is mentioned, the command could default to:

```bash
repo init -u https://github.com/arduino/lmp-manifest.git -m arduino.xml
```

This would implicitly use the default branch, which is typically the *main* in repositories these days.

![Git-repo initialization](assets/repo_init.png)

Proceed to download the necessary files by synchronizing the repositories:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,13 +130,13 @@ sudo su -
// Head to directory and mount the container
cd /home/fio/py-serialrpc
#py-serialrpc sudo docker build . -t py-serialrpc
#py-serialrpc sudo docker-compose up -d
#py-serialrpc sudo docker compose up -d
```

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

```bash
sudo docker-compose logs -f --tail 20
sudo docker compose logs -f --tail 20
```

***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)***
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ The `-d` flag runs the containers in the background; omitting it will tie the co
The installation of the **WordPress** and **MariaDB** containers will begin and may take some time. To monitor the installation process, use:

```bash
docker-compose logs -f
docker compose logs -f
```

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