Skip to content

Commit 3d8bdb4

Browse files
committed
Portenta X8: Standardize FoundriesFactory and Foundries.io
Signed-off-by: Vanessa Maegima <vanessa.maegima@foundries.io>
1 parent ca23f4d commit 3d8bdb4

File tree

6 files changed

+26
-26
lines changed

6 files changed

+26
-26
lines changed

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

+5-5
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ TEST_CMD="python3 --help"
5555
```
5656

5757
### Docker-compose.yml
58-
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.
58+
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.
5959

6060
```python
6161
version: '3.6'
@@ -122,9 +122,9 @@ if __name__ == '__main__':
122122

123123
## Uploading the Container Folder
124124

125-
First, you have to have set up your board to a factory, as shown in the [Portenta X8 Out of the Box tutorial](https://docs.arduino.cc/tutorials/portenta-x8/out-of-the-box).
125+
First, you have to have set up your board to a Factory, as shown in the [Portenta X8 Out of the Box tutorial](https://docs.arduino.cc/tutorials/portenta-x8/out-of-the-box).
126126

127-
Once this is done, we will push our folder to a repository within the factory. Lets place our folder "x8-custom-test" inside the "containers.git" repository. You can find this repository inside your factory page, if you click on "Source". And then on "container.git", the url of this page will be used in the next command.
127+
Once this is done, we will push our folder to a repository within the Factory. Lets place our folder "x8-custom-test" inside the "containers.git" repository. You can find this repository inside your Factory page, if you click on "Source". And then on "container.git", the url of this page will be used in the next command.
128128

129129
![Source on Foundries.io Factory page](assets/custom-factory-page.png)
130130

@@ -138,7 +138,7 @@ In order to pull or push repositories you have to generate an API key. This can
138138

139139
![Token section in user settings](assets/token-page.png)
140140

141-
Use the following command in a Linux shell, like ADB which the previously mentioned tutorial showed how to set up. To get the repository on your board, replace "YOUR_FACTORY" with the name of your factory. The "-b" parameter specifies a branch to checkout after cloning the repository. Running this command will get the container repository, where we will put our folder.
141+
Use the following command in a Linux shell, like ADB which the previously mentioned tutorial showed how to set up. To get the repository on your board, replace "YOUR_FACTORY" with the name of your Factory. The "-b" parameter specifies a branch to checkout after cloning the repository. Running this command will get the container repository, where we will put our folder.
142142

143143
```
144144
git clone https://source.foundries.io/factories/YOUR_FACTORY/containers.git -b devel
@@ -182,7 +182,7 @@ docker-compose stop
182182

183183
## Conclusion
184184

185-
This tutorial went through what goes into a container, how the folder should be built and what files it should contain. It then explained what each files purpose is and what they should contain for this example. Then we went through how this relates back to the factory, and how Foundries.io makes the whole process easier for us. We then showed how to build the container and run it on the Portenta X8. Lastly, we showed a useful testing feature with docker-compose. Which lets us test our container with a faster process.
185+
This tutorial went through what goes into a container, how the folder should be built and what files it should contain. It then explained what each files purpose is and what they should contain for this example. Then we went through how this relates back to the Factory, and how Foundries.io makes the whole process easier for us. We then showed how to build the container and run it on the Portenta X8. Lastly, we showed a useful testing feature with docker-compose. Which lets us test our container with a faster process.
186186

187187
### Next Steps
188188

content/hardware/04.pro/boards/portenta-x8/tutorials/display-output-webgl/content.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ The Arduino Portenta X8's processor **NXP® i.MX 8M Mini Processor** can be used
4040

4141
There are two ways to get the container, either through `foundriesFactories` or downloading the container from [portenta-containers repository](https://github.com/arduino/portenta-containers)
4242

43-
**With Foundries:**
43+
**With Foundries.io:**
4444

4545
If you use [Foundries.io](https://www.foundries.io) you can switch the current `target` of your device to `x-kiosk-imx8-webgl` by switching the app from a terminal on your computer:
4646

@@ -176,7 +176,7 @@ To save the changes press the **ESC** key and type `:wq` this will write and qui
176176

177177
## Conclusion
178178

179-
In this tutorial we went through how to connect the board and display something on a screen. Using a container from foundriesFactories or by downloading it and uploading it to your Portenta X8. Lastly, we showed how to edit the video output by editing the container.
179+
In this tutorial we went through how to connect the board and display something on a screen. Using a container from FoundriesFactories or by downloading it and uploading it to your Portenta X8. Lastly, we showed how to edit the video output by editing the container.
180180

181181
### Next Steps
182182

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ To get those files:
5757

5858
Go to the `lmp-manifest` [GitHub repository](https://github.com/arduino/lmp-manifest) and open the [releases](https://github.com/arduino/lmp-manifest/releases) section, there you will find a compressed `.tar.gz` with all the required files.
5959

60-
#### Through Foundries
60+
#### Through Foundries.io
6161

6262
Open your FoundriesFactory®.
6363

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

+16-16
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Once the Portenta X8 is plugged in via USB, you can open your browser and go to
3535
![Board set up page](assets/x8-oob-main.png)
3636

3737
* [Configure Wi-Fi](#connecting-to-your-wi-fi)
38-
* [Add your device to a factory (OTA)](#add-a-new-device-to-your-factory)
38+
* [Add your device to a FoundriesFactory (OTA)](#add-a-new-device-to-your-factory)
3939
* Board details
4040
* Shell (alpine python)
4141

@@ -59,36 +59,36 @@ Once it is connected, you should see the Wi-Fi status bullet in the bottom left
5959

6060
***You can change your network by clicking on the button again and repeat the above steps***
6161

62-
## Connect to a Factory
62+
## Connect to a FoundriesFactory
6363

64-
### Register the Factory on Foundries.io
64+
### Register the FoundriesFactory on Foundries.io
6565

6666
***The integration with Foundries.io requires the Arduino Pro Cloud Subscription, contact us at [Arduino Pro Inquiries](https://www.arduino.cc/pro/contact-us), or learn more on the [Arduino Pro Page](https://www.arduino.cc/pro/hardware/product/portenta-x8#pro-cloud)***
6767
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.
6868

6969
![Arduino Cloud integration](assets/cloud-main.png)
7070

71-
It will redirect you to the Foundries.io factory registration page.
71+
It will redirect you to the FoundriesFactory registration page.
7272

7373
![Foundries Factory creation](assets/foundries-create-factory.png)
7474

75-
Then you can go to [https://app.foundries.io/factories](https://app.foundries.io/factories) and it will show the factory you just created.
75+
Then you can go to [https://app.foundries.io/factories](https://app.foundries.io/factories) and it will show the Factory you just created.
7676

7777
![Foundries Factories](assets/foundries-factories.png)
7878

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

8181
### Add A New Device To Your Factory
8282

8383
Click the "Register Factory name" button.
8484

85-
![Register factory button](assets/x8-oob-main-factory.png)
85+
![Register Factory button](assets/x8-oob-main-factory.png)
8686

8787
![Factory connection](assets/x8-oob-factory-name.png)
8888

8989
The next panel gives you a code that you need to copy.
9090

91-
![Device factory token](assets/x8-oob-factory-register.png)
91+
![Device Factory token](assets/x8-oob-factory-register.png)
9292

9393
Click on the "Complete registration" button on the Portenta X8 dashboard
9494

@@ -100,29 +100,29 @@ Confirm the addition of the new device by pressing "Connect"
100100

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

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

105-
![Dashboard with a factory attached](assets/foundries-activation-success.png)
105+
![Dashboard with a Factory attached](assets/foundries-activation-success.png)
106106

107-
Once it is completed, the factory button on the Portenta X8 dashboard will turn green.
107+
Once it is completed, the Factory button on the Portenta X8 dashboard will turn green.
108108

109109
![Successful connection](assets/x8-oob-factory-success.png)
110110

111-
#### Check Your Factory
111+
#### Check Your FoundriesFactory
112112

113113
Have a look to your factories by going to [Foundries.io factories page](https://app.foundries.io/factories)
114114

115115
![Foundries.io factories page](assets/foundries-factories.png)
116116

117-
Select the factory that you want to check and it will open its dashboard.
117+
Select the Factory that you want to check and it will open its dashboard.
118118

119119
![Foundries.io Factory dashboard](assets/foundries-factory-dashboard.png)
120120

121121
#### Check Your Device
122122

123-
You can check if your device is fully connected to your factory by going to the "devices" tab.
123+
You can check if your device is fully connected to your Factory by going to the "devices" tab.
124124

125-
![Foundries.io factory devices page](assets/foundries-factory-devices.png)
125+
![Foundries.io Factory devices page](assets/foundries-factory-devices.png)
126126

127127
Then choose the device you want to check by clicking on its box and it will open its page.
128128

@@ -170,7 +170,7 @@ To check your manager connection status, use this command:
170170

171171
`nmcli de`
172172

173-
### Register Device to the Factory
173+
### Register Device to the FoundriesFactory
174174

175175
Make sure the name is not already being used in your Factory.
176176

content/hardware/04.pro/boards/portenta-x8/tutorials/x8-fundamentals/portenta-x8-fundamentals.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ On the "source" page of your Factory, you can find the four repositories that ar
5353

5454
- **ci-scripts.git**: Scripts that define the platform and container build jobs to the FoundriesFactory continuous integration system.
5555
- **lmp-manifest.git**: The repo manifest for the platform build. It defines which layer versions are included in the platform image. This includes **meta-partner-arduino**, the layer containing Arduino specific customizations (machine definition, device drivers, etc).
56-
- **meta-subscriber-overrides.git**: OE layer that defines what is included into your factory image. You can add board specific customizations and overrides, add and remove packages provided in the default Linux microPlatform base.
56+
- **meta-subscriber-overrides.git**: OE layer that defines what is included into your Factory image. You can add board specific customizations and overrides, add and remove packages provided in the default Linux microPlatform base.
5757
- **containers.git**: This is where containers and docker-compose apps are defined. It allows you to define what containers to build, and how to orchestrate them on the platform.
5858

5959
While the "targets" page contains the images built by the Continuous integration system each time something is committed in the repositories. Committing to **lmp-manifest.git** or **meta-subscriber-overrides.git** repositories will create a platform target, while committing to **containers.git** will create a container target. These targets will generate the artifacts for the platforms as specified in the **ci-scripts.git**, including all the required files to program the target in case of platform builds. You can inspect your FoundriesFactory targets in the "targets" page.

content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/x8-getting-started/content.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ The Portenta Max Carrier and the Portenta X8 are connected with High Density con
116116

117117
If you wish to use the Portenta X8 and Max Carrier with the Arduino IDE, please follow our [Uploading sketches to Arduino Portenta X8 tutorial](./tutorials/uploading-sketches-m4). Also, make sure that you have the latest version of the Portenta Core installed. Go to **Tools > Boards > board manager...** and search for **Arduino Mbed OS Portenta boards**. When this is installed and your Portenta X8 board is connected to the computer, the board should be assigned a port in the Arduino IDE.
118118

119-
If you want to use the Portenta X8 and Max Carrier with a Foundries.io Factory, python scripts and Linux containers, Please take a look at our [Portenta X8 Getting started tutorial](./tutorials/portenta-x8/out-of-the-box). You may also find our tutorial on how to [manage dockers on the Portenta X8](https://docs.arduino.cc/tutorials/portenta-x8/docker-container) useful.
119+
If you want to use the Portenta X8 and Max Carrier with a FoundriesFactory, python scripts and Linux containers, Please take a look at our [Portenta X8 Getting started tutorial](./tutorials/portenta-x8/out-of-the-box). You may also find our tutorial on how to [manage dockers on the Portenta X8](https://docs.arduino.cc/tutorials/portenta-x8/docker-container) useful.
120120

121121

122122
## Quick Reference Tables for the Portenta Max Carrier

0 commit comments

Comments
 (0)