Skip to content

Commit b075d18

Browse files
authored
Merge pull request #159 from arduino/marqdevx/portenta-X8/GS-update
Portenta X8: Getting Started update [PC-889]
2 parents c4e313f + 4cfe750 commit b075d18

20 files changed

+86
-25
lines changed
Loading
Loading

content/hardware/04.pro/boards/portenta-x8/tutorials/out-of-the-box/content.md

Lines changed: 86 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,14 @@ software:
2020

2121
## Connecting to the Board
2222

23-
Once the Portenta X8 is plugged in via USB, you can open your browser and go to http://192.168.7.1 and see a web page which is hosted by the board, from this dashboard you will be able to:
23+
Once the Portenta X8 is plugged in via USB, you can open your browser and go to http://192.168.7.1 if you use Windows and Linux or http://192.168.8.1 on MacOS. This web page is hosted on the Portenta X8, from this dashboard you will be able to:
2424

2525
![Board set up page](assets/x8-oob-main.png)
2626

27-
2827
* [Configure Wi-Fi](#connecting-to-your-wi-fi)
29-
* [Register the factory (OTA)](#registering-a-factory)
28+
* [Add your device to a factory (OTA)](#add-a-new-device-to-your-factory)
3029
* Board details
31-
* Shell
30+
* Shell (alpine python)
3231

3332
## Connecting to Your Wi-Fi
3433

@@ -44,45 +43,95 @@ Type the password.
4443

4544
![Wifi password set up](assets/x8-oob-wifi-pass.png)
4645

47-
Once its connected you should see the Wi-Fi status dot in the bottom left turn green.
46+
Once it is connected, you should see the Wi-Fi status bullet in the bottom left turning green.
4847

4948
![Wifi connection done](assets/x8-oob-wifi-sucess.png)
5049

50+
***You can change your network by clicking on the button again and repeat the above steps***
5151

52-
***You can change your network by clicking on the button again and repeat the steps***
52+
## Connect to a Factory
5353

54-
## Registering a Factory
54+
### Register the Factory on Foundries.io
5555

56-
Click the "Register with Factory" button.
56+
Go to [https://create.arduino.cc](https://create.arduino.cc) and click on portenta-X8 board manager, you will get prompted to set a new `Factory` name if you didn't have one before. You will not be able to be change the name later, so use one that you can remember and write easily.
5757

58-
![Register with factory](assets/x8-oob-main-factory.png)
58+
![Arduino Cloud integration](assets/cloud-main.png)
5959

60-
And set your new factory name.
60+
It will redirect you to the Foundries.io factory registration page.
6161

62-
![Name your factory](assets/x8-oob-factory-name.png)
62+
![Foundries Factory creation](assets/foundries-create-factory.png)
6363

64-
Click register, now you will get a code that you need to paste into your factory page by opening [Arduino Create Cloud](https://create.arduino.cc) in your browser and click the "Portenta X8 Board Manager" inside the integrations section.
65-
![Complete factory page](assets/x8-oob-factory-register.png)
66-
![Arduino Cloud integration](assets/cloud-main.png)
64+
Then you can go to [https://app.foundries.io/factories](https://app.foundries.io/factories) and it will show the factory you just created.
65+
66+
![Foundries Factories](assets/foundries-factories.png)
67+
68+
After you have created your Foundries.io factory you need to go back to the Portenta-X8 web dashboard to add a new device into your new factory.
69+
70+
### Add A New Device To Your Factory
71+
72+
Click the "Register Factory name" button.
73+
74+
![Register factory button](assets/x8-oob-main-factory.png)
75+
76+
![Factory connection](assets/x8-oob-factory-name.png)
77+
78+
The next panel gives you a code that you need to copy.
79+
80+
![Device factory token](assets/x8-oob-factory-register.png)
81+
82+
Click on the "Complete registration" button on the Portenta X8 dashboard
83+
84+
The button will open the Foundries.io activation page. Paste your token in the text box and press continue.
85+
86+
![Foundries device link](assets/foundries-activation-token.png)
87+
88+
Confirm the addition of the new device by pressing "Connect"
89+
90+
![Foundries device confirmation](assets/foundries-activation-prompt.png)
91+
92+
Finally you will see a confirmation which means that your device now is attached to the new factory.
93+
94+
![Dashboard with a factory attached](assets/foundries-activation-success.png)
95+
96+
Once it is completed, the factory button on the Portenta X8 dashboard will turn green.
97+
98+
![Successful connection](assets/x8-oob-factory-success.png)
6799

68-
Once it is completed the factory button will turn green.
100+
#### Check Your Factory
69101

70-
![Successful connection](assets/x8-oob-wifi-sucess.png)
102+
Have a look to your factories by going to [Foundries.io factories page](https://app.foundries.io/factories)
71103

104+
![Foundries.io factories page](assets/foundries-factories.png)
105+
106+
Select the factory that you want to check and it will open its dashboard.
107+
108+
![Foundries.io Factory dashboard](assets/foundries-factory-dashboard.png)
109+
110+
#### Check Your Device
111+
112+
You can check if your device is fully connected to your factory by going to the "devices" tab.
113+
114+
![Foundries.io factory devices page](assets/foundries-factory-devices.png)
115+
116+
Then choose the device you want to check by clicking on its box and it will open its page.
117+
118+
![Foundries new device activation page](assets/foundries-activation-device-page.png)
72119

73120
## Controlling Portenta X8 Through the Terminal
74121

75122
You have plenty of ways to communicate with your board, be it wirelessly or with a cable. Next we are going to show how to use adb and ssh.
76123

77124
### ADB
78125

79-
First of all make sure you have the latest **Mbed OS Portenta Core**, which contains the adb program.
126+
First of all, make sure you have the latest **Mbed OS Portenta Core**, which contains the adb program.
80127
You can go to its directory inside the **Arduino15/packages/arduino/tools/adb/32.0.0**. To check the tool you can use your teminal and type `adb`, you should get feedback from the tool when typing this.
81128

82129
To know the list of devices that can be accessed type `adb devices`.
83130

84131
If you only see one device you can try and type `adb shell`, you are now communicating with your Portenta X8.
85132

133+
![Terminal using ADB](assets/adb-connection.png)
134+
86135
### SSH
87136

88137
SSH is commonly used for remote control on different kinds of devices running different set ups through TCP-IP.
@@ -96,18 +145,30 @@ To gain admin (root) access, type `sudo su -` and the password is `fio` after t
96145

97146
![CLI configured](assets/ssh-connection-admin.png)
98147

99-
### Inspecting Real Time Tasks
148+
### CLI Commands
100149

101-
Run: `journalctl -f` to see what's going on on the device
150+
### Connect to a Wi-Fi Access Point
102151

103-
![Real time tasks on CLI](assets/command-journalctl.png)
152+
Using the network manager tool `nmcli`:
153+
154+
`nmcli device wifi connect <SSID> password <PASSWORD>`
155+
156+
To check your manager connection status, use this command:
157+
158+
`nmcli de`
159+
160+
### Register Device to the Factory
104161

105-
## Uploading an Arduino Sketch
162+
Make sure the name is not already being used in your Factory.
106163

107-
Make sure you have the latest mbed Core and as every other board you can select the board inside the `mbed Portenta`.
164+
`lmp-device-register -n <newDeviceName>`
108165

109-
![Board selected in Arduino IDE](assets/IDE-boards.png)
166+
**Not recommended:** In case you cannot register the new device, you can erase the current device info by removing `/var/sota/sql.db`
110167

111-
And click compile and upload.
168+
`sudo rm /var/sota/sql.db`
112169

113-
***Make sure you don't share GPIOs on the linux side and the Arduino sketch, this will avoid possible errors***
170+
### Inspecting Real Time Tasks
171+
172+
Run: `journalctl -f` to see what's going on on the device
173+
174+
![Real time tasks on CLI](assets/command-journalctl.png)

0 commit comments

Comments
 (0)