Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit be9fb7c

Browse files
TaddyHCjcarolinares
andauthored
Portenta X8: Global Post Update (#902)
* Initial commit - Global Portenta X8 content update (User Manual) * General X8 content update * Global X8 content update * Global X8 content update * Global X8 content minor update * Global X8 content update * Update content/hardware/04.pro/boards/portenta-x8/tutorials/01.user-manual/content.md Co-authored-by: Julián Caro Linares <jcarolinares@gmail.com> * Update content/hardware/04.pro/boards/portenta-x8/tutorials/01.user-manual/content.md Co-authored-by: Julián Caro Linares <jcarolinares@gmail.com> --------- Co-authored-by: Julián Caro Linares <jcarolinares@gmail.com>
1 parent f0f6f38 commit be9fb7c

File tree

9 files changed

+247
-216
lines changed

9 files changed

+247
-216
lines changed

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

Lines changed: 223 additions & 194 deletions
Large diffs are not rendered by default.

‎content/hardware/04.pro/boards/portenta-x8/tutorials/04.python-arduino-data-exchange/content.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ hardware:
1313

1414
The container infrastructure provided by Arduino contains a pre-built Python® image that you can use to run Python® applications on the Portenta X8. In this tutorial, we're going to build a container based on a provided one.
1515

16-
While all the peripherals are accessible from the iMX8 processor running the Linux environment, it can be useful to let the onboard microcontroller take care of certain peripheral handling and exchange only the required data between the microcontroller and the Python® application.
16+
While all the peripherals are accessible from the iMX8 processor running the Linux environment, it can be useful to let the onboard microcontroller take care of certain peripheral handling and exchange only the required data between the microcontroller and the Python® application.
1717

18-
Thus you will learn how to do that. If you haven't done so, read through the [user manual](/tutorials/portenta-x8/user-manual) to understand the fundamental concepts of the X8 and the provided infrastructure.
18+
Thus you will learn how to do that. If you haven't done so, read through the [user manual](https://docs.arduino.cc/tutorials/portenta-x8/user-manual) to understand the fundamental concepts of the X8 and the provided infrastructure.
1919

2020
## Goals
2121

@@ -74,7 +74,7 @@ Make sure you have installed the "Arduino Mbed OS Portenta Boards" core and uplo
7474

7575
### Debugging the Arduino Sketch
7676

77-
To check if the Arduino sketch is working correctly, you may want to read the messages from the `Serial.println` statements. You cannot currently read them directly in the serial monitor of the Arduino IDE. Instead, you can use a simple service called `py-serialrpc`, which listens for those messages and prints them to the console.
77+
To check if the Arduino sketch is working correctly, you may want to read the messages from the `Serial.println` statements. You cannot currently read them directly in the serial monitor of the Arduino IDE. Instead, you can use a simple service called `py-serialrpc`, which listens for those messages and prints them to the console.
7878

7979
This service needs to run on the Linux side of the X8. You can get the files [here](assets/py-serialrpc.zip). From the command prompt of your local machine, navigate to the adb tool folder and upload the files to the X8 with `adb push <local directory path>/py-serialrpc /home/fio`.
8080

‎content/hardware/04.pro/boards/portenta-x8/tutorials/05.docker-container/content.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ In this tutorial, we will go through the steps of how to install, run and remove
3434
- [Arduino® Portenta X8](https://store.arduino.cc/products/portenta-x8)
3535
- USB-C® cable (either USB-C® to USB-A or USB-C® to USB-C®)
3636
- Wi-Fi® Access Point with Internet Access
37-
- ADB, [Check how to connect to your Portenta X8](/tutorials/portenta-x8/out-of-the-box#controlling-portenta-x8-through-the-terminal)
37+
- ADB: [Check how to connect to your Portenta X8](https://docs.arduino.cc/tutorials/portenta-x8/user-manual#out-of-the-box-experience)
3838
- [Arduino IDE 1.8.10+](https://www.arduino.cc/en/software), [Arduino IDE 2.0+](https://www.arduino.cc/en/software), or [Arduino Web Editor](https://create.arduino.cc/editor)
3939

4040
***Make sure to have the Portenta X8 with the latest image as well as bootloader. Please check [how to flash your Portenta X8](/tutorials/portenta-x8/image-flashing) to have latest version.***
@@ -47,7 +47,7 @@ The Portenta X8 provides Docker CLI by default. The following command will help
4747
docker -v
4848
```
4949

50-
***To use this tool, you will need to connect to your device first. Check [how to connect using adb/ssh](/tutorials/portenta-x8/out-of-the-box#controlling-portenta-x8-through-the-terminal).***
50+
***To use this tool, you will need to connect to your device first. Check [how to connect using adb/ssh](https://docs.arduino.cc/tutorials/portenta-x8/user-manual#out-of-the-box-experience).***
5151

5252
You can check the Docker's reference documentation, which covers all the features of the tool in depth at [docs.docker.com](https://docs.docker.com/).
5353

@@ -133,4 +133,4 @@ In this tutorial, you have learned how to use Docker with Portenta X8. You have
133133

134134
- Now that you have the base of the workflow to use [Docker](https://docker.com), go to its docs page and make sure you understand all the features.
135135
- Look for a container image from [Docker hub](http://hub.docker.com), install it and make your own application out of it.
136-
- Create a container to run your custom made application. For this, it may interest you [Create and Upload a Custom Container to the Portenta X8](tutorials/portenta-x8/custom-container) tutorial.
136+
- Create a container to run your custom made application. For this, it may interest you [Deploy a Custom Container with Portenta X8 Manager](tutorials/portenta-x8/custom-container) tutorial.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,13 @@ This tutorial will show you how to define fleets and how to construct a Wave tha
3030
- Arduino Create account
3131
- Arduino Cloud for business subscription with Portenta X8 Manager add-on: [Learn more about here](https://cloud.arduino.cc/plans#business)
3232
- Foundries.ioTM account (linked with the Arduino Cloud for business subscription)
33-
- FoundriesFactory® and devices already attached to your Factory ([Check the Getting Started tutorial](https://docs.arduino.cc/tutorials/portenta-x8/out-of-the-box))
33+
- FoundriesFactory® and devices already attached to your Factory ([User Manual for Out-of-the-box experience](https://docs.arduino.cc/tutorials/portenta-x8/user-manual#out-of-the-box-experience))
3434

3535
## Instructions
3636

3737
### Setting Up the Terminal
3838

39-
Waves fleet management requires us to have the X8 setup with FoundriesFactory. If you have not done so, please follow our [Getting Started tutorial](https://docs.arduino.cc/tutorials/portenta-x8/out-of-the-box), as it will walk you through setting up the X8 with your Factory.
39+
Waves fleet management requires us to have the X8 setup with FoundriesFactory. If you have not done so, please follow our [User Manual for Out-of-the-experience](https://docs.arduino.cc/tutorials/portenta-x8/user-manual#out-of-the-box-experience), as it will walk you through setting up the X8 with your Factory.
4040

4141
To use Waves, you need to have fioctl installed and configured. Follow this [guide](https://docs.foundries.io/latest/getting-started/install-fioctl/index.html) to do so. Creating Waves and device groups will be done via the host, which is your factory. As such, the following commands will be entered in a terminal using fioctl to connect to your Factory.
4242

‎content/hardware/04.pro/boards/portenta-x8/tutorials/07.custom-container/content.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ In this tutorial, we will create a simple container and upload it to the Arduino
2222
### Required Hardware and Software
2323

2424
- [Portenta X8](https://store.arduino.cc/portenta-x8)
25-
- ADB
25+
- ADB: [Check how to connect to your Portenta X8](https://docs.arduino.cc/tutorials/portenta-x8/user-manual#out-of-the-box-experience)
2626
- USB-C® cable (either USB-C® to USB-A or USB-C® to USB-C®)
2727
- Arduino Pro Cloud Subscription [Learn more about the Pro Cloud](https://www.arduino.cc/pro/hardware/product/portenta-x8#pro-cloud)
2828
- [Arduino IDE 1.8.10+](https://www.arduino.cc/en/software), [Arduino IDE 2.0+](https://www.arduino.cc/en/software), or [Arduino Web Editor](https://create.arduino.cc/editor)
@@ -57,6 +57,7 @@ TEST_CMD="python3 --help"
5757
```
5858

5959
### Container File: Docker-compose.yml
60+
6061
This file defines the app name through the Factory, permissions, and settings for the involved containers. The argument in the image tag will make it, so our image file builds locally.
6162

6263
```python
@@ -128,7 +129,7 @@ if __name__ == '__main__':
128129

129130
## Uploading the Container Folder
130131

131-
First, you will need to set up your board to a Factory setting, as shown in the [Portenta X8 Out of the Box tutorial](https://docs.arduino.cc/tutorials/portenta-x8/out-of-the-box).
132+
First, you will need to set up your board to a Factory setting, as shown in the Portenta X8 [Out-of-the-box experience from the User Manual](https://docs.arduino.cc/tutorials/portenta-x8/user-manual#out-of-the-box-experience).
132133

133134
Once finished, we will push our folder to a repository within the Factory. Let us place our folder "x8-custom-test" inside the "containers.git" repository. You can find this repository inside your Factory page under "Source". Then, on "container.git", the page URL will be used in the following command.
134135

@@ -217,5 +218,5 @@ To get a better understanding of how to manage containers with Docker, take a lo
217218

218219
Here are some errors that might occur in the process of this tutorial:
219220

220-
- Make sure you have followed our other tutorials that shows how to set up the [Portenta X8 out of the box](https://docs.arduino.cc/tutorials/portenta-x8/out-of-the-box)
221+
- Make sure you have followed our other tutorials that shows how to set up the Portenta X8 with [Out-of-the-box experience from the User Manual](https://docs.arduino.cc/tutorials/portenta-x8/user-manual#out-of-the-box-experience)
221222
- If you are having issues with the adb shell, don't forget to try and use `sudo` and `su`

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ In this tutorial, you will learn how to manually flash your Portenta X8 with the
2727
- [Arduino Portenta X8](https://store.arduino.cc/products/portenta-x8)
2828
- [Portenta Breakout Board](https://store.arduino.cc/products/arduino-portenta-breakout) or [Arduino Portenta Max Carrier](https://store.arduino.cc/products/portenta-max-carrier)
2929
- USB-C® cable (either USB-C® to USB-A or USB-C® to USB-C®)
30-
30+
3131
## Instructions
3232

3333
### Arduino's Download Repository

‎content/hardware/04.pro/boards/portenta-x8/tutorials/10.datalogging-iot/content.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ These four blocks will be running locally on the [Arduino® Portenta X8](https:/
4747
- Command-line interface
4848
- [Arduino IDE 2.0](https://www.arduino.cc/en/software)
4949

50-
***If you are new to the Portenta X8 board, check out this [getting started tutorial](/tutorials/portenta-x8/out-of-the-box#controlling-portenta-x8-through-the-terminal) on controlling your board using a terminal or command-line interface.***
50+
***If you are new to the Portenta X8 board, check out this [User Manual](https://docs.arduino.cc/tutorials/portenta-x8/user-manual) on controlling your board using a terminal or command-line interface.***
5151

5252
## IoT Architecture Basics
5353

@@ -276,7 +276,7 @@ We can now proceed to configure InfluxDB.
276276

277277
## Installing InfluxDB
278278

279-
InfluxDB is an open-source, high-performance, time series database; with InfluxDB data can be written and read in real-time, and data can be processed in the background for extract, transform, and load (ETL) purposes or for monitoring and alerting purposes. User dashboards for visualizing and exploring data can also be set up.
279+
InfluxDB is an open-source, high-performance, time series database; with InfluxDB data can be written and read in real-time, and data can be processed in the background for extract, transform, and load (ETL) purposes or for monitoring and alerting purposes. User dashboards for visualizing and exploring data can also be set up.
280280

281281
The simplest form to run InfluxDB with Docker is by using the following command:
282282

@@ -516,7 +516,7 @@ If everything is ok, we should see the following in the Serial monitor of the Ar
516516

517517
![Debug messages in the Arduino IDE 2.0 Serial Monitor.](assets/x8-data-logging-img_25.png)
518518

519-
Check out now the Grafana dashboard we configured earlier; we should see data coming from the MKR WiFi 1010 board.
519+
Check out now the Grafana dashboard we configured earlier; we should see data coming from the MKR WiFi 1010 board.
520520

521521
## Conclusion
522522

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

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ In this tutorial, we will go through the steps on how to set up both the Linux a
3535
- USB-C® cable (either USB-C® to USB-A or USB-C® to USB-C®)
3636
- Wi-Fi® Access Point with Internet Access
3737
- 868-915 MHz antenna with SMA connector
38-
- ADB or SSH [Check how to connect to your Portenta X8](https://docs.arduino.cc/tutorials/portenta-x8/out-of-the-box#controlling-portenta-x8-through-the-terminal)
38+
- ADB: [Check how to connect to your Portenta X8](https://docs.arduino.cc/tutorials/portenta-x8/user-manual#out-of-the-box-experience)
3939
- [Multi-protocol gateway example code](assets/Multi_Protocol_Gateway_X8.zip)
4040
- [Arduino IDE 1.8.10+](https://www.arduino.cc/en/software), [Arduino IDE 2.0+](https://www.arduino.cc/en/software), or [Arduino Web Editor](https://create.arduino.cc/editor)
4141

@@ -73,7 +73,7 @@ Foremost, you will learn how the multi-protocol gateway is implemented with a Po
7373

7474
The Arduino layer extends within the M4 Core, which is the layer dedicated to real-time operations development. Thus, you can use the Arduino layer to perform Proportional-Integral-Derivative (PID) tasks and make the RPC calls to exchange data with the Linux layer. An example could be a temperature sensor driven with PID controller, which will use the actual reading as input and compare with the desired temperature target to provide an output for the control element.
7575

76-
***To learn in-depth about how to exchange data using RPC between Arduino and Linux layer, please check out [User Manual: Communication Between Linux And Arduino](tutorials/portenta-x8/what-is-portenta-x8) or [Data Exchange Between Python® on Linux and an Arduino Sketch](https://docs.arduino.cc/tutorials/portenta-x8/python-arduino-data-exchange)***
76+
***To learn in-depth about how to exchange data using RPC between Arduino and Linux layer, please check out the [User Manual: Communication Between Linux And Arduino](https://docs.arduino.cc/tutorials/portenta-x8/user-manual#communication-between-linux-and-arduino) or [Data Exchange Between Python® on Linux and an Arduino Sketch](https://docs.arduino.cc/tutorials/portenta-x8/python-arduino-data-exchange)***
7777

7878
## The Linux Layer
7979

@@ -103,7 +103,7 @@ Before setting up the software, it is necessary to configure the hardware to be
103103

104104
![Multi-Protocol Gateway Hardware Setup](assets/multi-protocol-hardware.png)
105105

106-
***If you have not set up your Portenta X8, please have a look at [Portenta X8 Getting Started](https://docs.arduino.cc/tutorials/portenta-x8/out-of-the-box) tutorial***
106+
***If you have not set up your Portenta X8, please have a look at [User Manual's Out-of-the-box experience](https://docs.arduino.cc/tutorials/portenta-x8/user-manual#out-of-the-box-experience)***
107107

108108
### Setting Up The Portenta X8
109109

@@ -146,15 +146,15 @@ If you have not configured internal Wi-Fi® connectivity within the system, plea
146146
nmcli device wifi connect "SSID" password "PASSWORD"
147147
```
148148

149-
### Setting Up *The Things Network*
149+
### Setting Up The Things Network
150150

151151
You now have the prerequisites for the Portenta X8 ready, but since you are using the LoRa® connectivity, you will need a platform capable of receiving data transmitted from the Portenta X8 and Max Carrier. **The Things Network** will be the platform we will use to communicate using LoRaWAN®. On the platform, you will need to create an application to add the Portenta Max Carrier as an End-Device.
152152

153153
**Manual** option will be used when adding the End-Device. The Portenta Max Carrier will be added under Arduino SA to be included within the LoRaWAN® Device Repository. The LoRaWAN® version and parameters compatible with the Portenta Max Carrier are as follows. The frequency plan will depend on the region in which you are going to install the device.
154154

155155
![General End-Device Configuration](assets/ttn-end-device.png)
156156

157-
***To learn more about LoRa® and LoRaWAN®, please have a look at our [Arduino Guide to LoRa® and LoRaWAN®](https://docs.arduino.cc/learn/communication/lorawan-101). Additionally, if you wish to learn how to properly set up the End-Device in *The Things Network*, please read [this tutorial](https://docs.arduino.cc/tutorials/mkr-wan-1310/the-things-network) reference***
157+
***To learn more about LoRa® and LoRaWAN®, please have a look at our [Arduino Guide to LoRa® and LoRaWAN®](https://docs.arduino.cc/learn/communication/lorawan-101). Additionally, if you wish to learn how to properly set up the End-Device in The Things Network, please read [this tutorial](https://docs.arduino.cc/tutorials/mkr-wan-1310/the-things-network) reference***
158158

159159
We will now build a multi-protocol gateway using Portenta X8 and Max Carrier.
160160

@@ -551,6 +551,7 @@ If you are curious about what to expect from the build you have made in this tut
551551
In this tutorial, you have learned how to set up a Multi-Protocol Gateway composed of MQTT protocol, RPC, and LoRaWAN®, by using the Portenta X8 and the Portenta Max Carrier. You have built the gateway that will connect to *The Things Network* to send the desired data. Also, the gateway is capable of exchanging data between Arduino and Linux layers using RPC, in which you have exposed the ports to be able to receive data from the local sensor to be sent directly to *The Things Network*.
552552

553553
### Next Steps
554+
554555
- Now that you have developed a multi-protocol gateway, using Wi-Fi® and LoRaWAN® connectivity, expand the gateway's capability by adding other connectivity types such as Cat. M1 and NB-IoT.
555556
- Expand functionalities for data processing using RPC while using multi-protocol architecture.
556557

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The Arduino Portenta X8 is a powerful board that has many features that can be e
3131

3232
## Instructions
3333

34-
First, make sure your Portenta X8 is set up correctly by following the [getting started tutorial](https://docs.arduino.cc/tutorials/portenta-x8/out-of-the-box).
34+
First, make sure your Portenta X8 is set up correctly by following the [User Manual's Out-of-the-box experience](https://docs.arduino.cc/tutorials/portenta-x8/user-manual#out-of-the-box-experience).
3535

3636
### Creating the Docker-compose.yml File
3737

@@ -96,7 +96,7 @@ When you are in the correct directory and no other container is running on the p
9696

9797
### Connecting to the WordPress Site
9898

99-
To connect to the WordPress setup site, you simply need to access it with your Portenta X8s unique id and port. So for example: `http://portenta-x8-<uuid>.local:<port>`, where you would substitute the `<uuid>` with your Portenta X8's unique id and the port chosen for the WordPress container with `<port>`. The `<uuid>` can be found on the setup page that is shown in the [Getting started tutorial](https://docs.arduino.cc/tutorials/portenta-x8/out-of-the-box), but you can also see it in the terminal when running `adb` or you can go to `http://192.168.7.1:8000` if you use Windows and Linux, on MacOS use `http://192.168.8.1:8000`.
99+
To connect to the WordPress setup site, you simply need to access it with your Portenta X8s unique id and port. So for example: `http://portenta-x8-<uuid>.local:<port>`, where you would substitute the `<uuid>` with your Portenta X8's unique id and the port chosen for the WordPress container with `<port>`. The `<uuid>` can be found on the setup page that is shown in the [User Manual's Out-of-the-box experience](https://docs.arduino.cc/tutorials/portenta-x8/user-manual#out-of-the-box-experience), but you can also see it in the terminal when running `adb` or you can go to `http://192.168.7.1:8000` if you use Windows and Linux, on MacOS use `http://192.168.8.1:8000`.
100100

101101
When you connect, you should get some feedback in the terminal. Text will begin printing in the terminal, showing you information about the connection that has just been established as shown in the image below.
102102

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /