Skip to content

Commit e259a98

Browse files
[PC-1023] Getting Started Tutorial review (#365)
* [PC-1023] Grammar fixes Some grammar fixes in the tutorial. * [PC-1023] Documentation Fix FIxing some URLs * Update content/hardware/04.pro/boards/portenta-x8/tutorials/out-of-the-box/content.md Co-authored-by: Pablo Marquínez Ferrándiz <[email protected]> * Revert "Update content/hardware/04.pro/boards/portenta-x8/tutorials/out-of-the-box/content.md" This reverts commit 74800a2c819e3b170f84166e72158f80ec8a7b5a. * [PC-1023] Adding information about IP address Adding images and information about how to connect to the Portenta X8 webpage when the default IP on the tutorial is not working properly. --------- Co-authored-by: Pablo Marquínez Ferrándiz <[email protected]>
1 parent 9fd45f6 commit e259a98

File tree

3 files changed

+34
-18
lines changed

3 files changed

+34
-18
lines changed
Loading
Loading

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

+34-18
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,31 @@ software:
2929

3030
## Connecting to the Board
3131

32-
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. It can take up to 15 seconds for the board to boot up and make the page available. This web page is hosted on the Portenta X8, from this dashboard you will be able to:
32+
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. It can take up to 15 seconds for the board to boot up and make the page available.
3333

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

36+
This web page is hosted on the Portenta X8, from this dashboard you will be able to:
37+
3638
* [Configure Wi-Fi](#connecting-to-your-wi-fi)
3739
* [Add your device to FoundriesFactory (OTA)](#add-a-new-device-to-your-factory)
3840
* Board details
3941
* Shell (alpine Python®)
4042

43+
***If those IP addresses do not work for you, you will need to follow the steps below:***
44+
45+
First you will need to connect to your board via ADB as described in [this section](#adb) of the tutorial.
46+
47+
Once you have connected to your board via ADB you should be able to run the next command: `ifconfig`. Among the list of interfaces that appears, look for "wlan0" as shown in the following image.
48+
49+
![ADB ifconfig](assets/adb-ifconfig.PNG)
50+
51+
Then copy the IP address next to "inet" and paste it into your web browser. You should be able to log in successfully this way.
52+
53+
![Connecting through ip](assets/x8-ip-connect.PNG)
54+
55+
Once you have successfully accessed this web page, you will be able to connect the board to your Wi-Fi network.
56+
4157
## Connecting to Your Wi-Fi
4258

4359
Click the Wi-Fi button to start configuring your network connection.
@@ -46,7 +62,7 @@ Click the Wi-Fi button to start configuring your network connection.
4662

4763
Select your Wi-Fi SSID.
4864

49-
![Wi-Fi ssid set up](assets/x8-oob-wifi-ssid.png)
65+
![Wi-Fi SSID set up](assets/x8-oob-wifi-ssid.png)
5066

5167
Type the password.
5268

@@ -56,15 +72,15 @@ Once it is connected, you should see the Wi-Fi status bullet in the bottom left
5672

5773
![Wi-Fi connection done](assets/x8-oob-wifi-sucess.png)
5874

59-
***You can change your network by clicking on the button again and repeat the above steps***
75+
***You can change your network by clicking on the button again and repeating the above steps***
6076

6177
## Connect to FoundriesFactory
6278

6379
### Register a FoundriesFactory on Foundries.io
6480

65-
***The integration with Foundries.io requires the Arduino Pro Cloud Subscription, subscribe at [Arduino PRO Cloud for Business](https://cloud.arduino.cc/plans), or learn more on the [Arduino Pro Page](https://www.arduino.cc/pro/hardware/product/portenta-x8#pro-cloud)***
81+
***Integration with Foundries.io is not required to use your Portenta X8 Board, but if you are going to use it, it requires a subscription to the Arduino Pro Cloud; you can subscribe at [Arduino PRO Cloud for Business](https://cloud.arduino.cc/plans), or learn more on the [Arduino Pro Page](https://www.arduino.cc/pro/hardware-product-portenta-x8/)***
6682

67-
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 did not have one before. You will not be able to be change the name later, so use one that you can remember and write easily.
83+
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 did not have one before. You will not be able to change the name later, so use one that you can remember and write easily.
6884

6985
![Arduino Cloud integration](assets/cloud-main.png)
7086

@@ -76,7 +92,7 @@ Then you can go to [https://app.foundries.io/factories](https://app.foundries.io
7692

7793
![Foundries Factories](assets/foundries-factories.png)
7894

79-
After you have created your FoundriesFactory you need to go back to the Portenta-X8 web dashboard to add a new device into your new Factory.
95+
After you have created your FoundriesFactory you need to go back to the Portenta-X8 web dashboard to add a new device to your new Factory.
8096

8197
### Add A New Device To Your Factory
8298

@@ -100,7 +116,7 @@ Confirm the addition of the new device by pressing "Connect"
100116

101117
![Foundries device confirmation](assets/foundries-activation-prompt.png)
102118

103-
Finally you will see a confirmation which means that your device now is attached to the new Factory.
119+
Finally, you will see a confirmation which means that your device now is attached to the new Factory.
104120

105121
![Dashboard with a Factory attached](assets/foundries-activation-success.png)
106122

@@ -110,7 +126,7 @@ Once it is completed, the Factory button on the Portenta X8 dashboard will turn
110126

111127
#### Check Your FoundriesFactory
112128

113-
Have a look to your factories by going to [Foundries.io factories page](https://app.foundries.io/factories)
129+
Have a look at your factories by going to [Foundries.io factories page](https://app.foundries.io/factories)
114130

115131
![Foundries.io factories page](assets/foundries-factories.png)
116132

@@ -130,11 +146,11 @@ Then choose the device you want to check by clicking on its box and it will open
130146

131147
## Controlling Portenta X8 Through the Terminal
132148

133-
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.
149+
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.
134150

135151
### ADB
136152

137-
First of all make sure you have the latest **Mbed OS Portenta Core**, which contains the adb program.
153+
First of all make sure you have the latest **Mbed OS Portenta Core**, which contains the ADB program.
138154

139155
You can go to its directory inside the **Arduino15/packages/arduino/tools/adb/32.0.0**. To check the tool you can use your terminal and type `adb`, you should get feedback from the tool when typing this.
140156

@@ -146,33 +162,33 @@ If you only see one device you can try and type `adb shell`, you are now communi
146162

147163
### SSH
148164

149-
SSH is commonly used for remote control on different kinds of devices running different set ups through TCP-IP.
165+
SSH is commonly used for remote control on different kinds of devices running different setups through TCP-IP.
150166

151-
To communicate with your board, you will need to know the IP of it, and just type `ssh fio@<IP>`, then the terminal workaround should be the same as ADB. The password is `fio`.
167+
To communicate with your board, you will need to know its IP, and just type `ssh fio@<IP>`, then the terminal workaround should be the same as ADB. The password is `fio`.
152168

153169
![SSH connection](assets/ssh-connection.png)
154170

155-
As it is a linux device, you can do normal stuff like creating files, changing directory, etc.
171+
As it is a Linux device, you can do normal stuff like creating files, changing between directories, etc.
156172

157-
To gain admin (root) access, type `sudo su -` and the password is `fio` after that the terminal prefix should turn red.
173+
To gain admin (root) access, type `sudo su -` and the password is `fio` after that the terminal prefix should turn red.
158174

159175
![CLI configured](assets/ssh-connection-admin.png)
160176

161177
### CLI Commands
162178

163179
### Connect to a Wi-Fi Access Point
164180

165-
Using the network manager tool `nmcli`:
181+
Using the network management tool `nmcli`:
166182

167-
`nmcli device wifi connect <SSID> password <PASSWORD>`
183+
`nmcli device Wi-Fi connect <SSID> password <PASSWORD>`
168184

169185
To check your manager connection status, use this command:
170186

171187
`nmcli de`
172188

173189
### Register Device to the FoundriesFactory
174190

175-
***The integration with Foundries.io requires the Arduino Pro Cloud Subscription, subscribe at [Arduino PRO Cloud for Business](https://cloud.arduino.cc/plans), or learn more on the [Arduino Pro Page](https://www.arduino.cc/pro/hardware/product/portenta-x8#pro-cloud)***
191+
***The integration with Foundries.io requires the Arduino Pro Cloud Subscription, subscribe at [Arduino PRO Cloud for Business](https://cloud.arduino.cc/plans), or learn more on the [Arduino Pro Page](https://www.arduino.cc/pro/hardware-product-portenta-x8/)***
176192

177193
Make sure the name is not already being used in your Factory.
178194

@@ -185,7 +201,7 @@ Make sure the name is not already being used in your Factory.
185201
`sudo systemctl stop fioconfig.service`
186202
`sudo rm /var/sota/sql.db`
187203

188-
### Inspecting Real Time Tasks
204+
### Inspecting Real-Time Tasks
189205

190206
Run: `journalctl -f` to see what's going on on the device
191207

0 commit comments

Comments
 (0)