You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/hardware/04.pro/boards/portenta-h7/tutorials/over-the-air-update/content.md
+23-23Lines changed: 23 additions & 23 deletions
Original file line number
Diff line number
Diff line change
@@ -23,9 +23,9 @@ software:
23
23
---
24
24
25
25
## Overview
26
-
In this tutorial, you will learn how to use and allow firmware updates via **OTA (Over-The-Air)** feature with the **Arduino Portenta H7**. With this tutorial, you will be able to create a binary file to be used with the OTA feature, and use the internal **QSPI** or a external **SD card** to accomplish the OTA (Over-The-Air) process.
26
+
In this tutorial, you will learn how to use and allow firmware updates via **OTA (Over-The-Air)** feature with the **Arduino Portenta H7**. With this tutorial, you will be able to create a binary file to be used with the OTA feature and use the internal **QSPI** or a external **SD card** to accomplish the OTA (Over-The-Air) process.
27
27
28
-
***To proceed with OTA using a SD Card, you will need to use a carrier or shield with a SD card slot, e.g Portenta Breakout, Portenta Vision shield.***
28
+
***To proceed with OTA using a SD Card, you will need to use a carrier or shield with a SD card slot, e.g Portenta Breakout, Portenta Max Carrier, Portenta Vision shield.***
29
29
30
30
## Goals
31
31
The goals of this tutorial are:
@@ -38,17 +38,17 @@ The goals of this tutorial are:
38
38
- USB-C type cable (either USB-A to USB-C or USB-C to USB-C)
39
39
- Arduino IoT Cloud and Arduino_Portenta_OTA libraries
40
40
- SD card (optional, you can use QSPI instead)
41
-
- Carrier or shield compatible with the Portenta H7 with a SD Card slot, in case you chose to use the SD Card.
41
+
- Carrier or shield compatible with the Portenta H7 with a SD Card slot, in case you choose to use the SD Card.
42
42
43
43
## What OTA Means
44
-
**OTA** (Over-The-Air) is a method of distributing wirelessly to end devices to update their firmware, configuration, or security-related protocols. The purpose of this method is to change a device’s behavior or its settings for better performance, for adding new features, or to change its targeted usage.
44
+
**OTA** (Over-The-Air) is a method of distributing wirelessly to end devices to update their firmware, configuration or security-related protocols. The purpose of this method is to change a device’s behavior or its settings for better performance, for adding new features or to change its targeted usage.
45
45
46
46
## Instructions
47
47
48
-
We will explain briefly the steps required to be able to use OTA (Over-The-Air) process with Arduino Portenta H7, in which will consist of firmware OTA file creation and use of preferred storage mode (QSPI or SD card).
48
+
We will explain briefly the steps required to be able to use OTA (Over-The-Air) process with Arduino Portenta H7. It will consist of firmware OTA file creation and use of preferred storage mode (QSPI or SD card).
49
49
50
50
### Firmware OTA File Creation
51
-
We will create the binary file required for the OTA (Over-The-Air) process to be able to be used with either storage option stated previously. For the purpose of this tutorial, we will use the following script to create the binary file.
51
+
You will need to create the binary file required for the OTA (Over-The-Air) process to be able use it with either storage option stated previously. For the purpose of this tutorial, you will have to use the following script to create the binary file.
52
52
53
53
```cpp
54
54
/*
@@ -94,15 +94,15 @@ void loop()
94
94
}
95
95
```
96
96
97
-
This script will light up the RGB LED with 3 different colors in sequence. This code will need to be uploaded to the Arduino Portenta H7 firsthand. This is to verify the sketch compiles and is working correctly. After verifying this, in Arduino IDE, you will search for **Sketch > Export Compiled Binary**.
97
+
This script will light up the RGB LED with 3 different colors in sequence. This code will need to be uploaded to the Arduino Portenta H7 firsthand. This is to verify whether the sketch compiles and is working correctly. After verifying this, in Arduino IDE, you will search for **Sketch > Export Compiled Binary**.
98
98
99
99

100
100
101
-
With the binary file created, we can now create the ota file needed to complete the process. For this, you will need to have an extra tool which can be found at the following link.
101
+
With the binary file ready, you can now create the OTA file needed to complete the process. For this, you will need to have an extra tool which can be found at the following link.
You will have to have to extract the library at a preferred location to be able to use the tools. Then you will need to run on the terminal following commands in sequence to be able to create the ota file.
105
+
You will have to extract the library at a preferred location to be able to use the tools. Then, you will need to run on the terminal the following commands in sequence to be able to create the OTA file.
106
106
107
107
Copy the binary file into the library tool's folder
108
108
@@ -144,9 +144,9 @@ Convert your encoded file into `.ota` format
We are using`OTA_Usage_Portenta.ino.PORTENTA_H7_M7` as a sketch name and for facilitated identification of the file. After this you will have the `.ota` file of the sketch that we would like to use with the OTA process.
147
+
You can use`OTA_Usage_Portenta.ino.PORTENTA_H7_M7` as a sketch name for facilitated identification of the file. After this, you will have the `.ota` file of the sketch that you will use with the OTA process.
148
148
149
-
***Now you have two options to choose, use QSPI, or use an SD Card to storage your OTA file. You can use the left side index to jump to the option that you may need.***
149
+
***Now you have two options to choose, use QSPI or use an SD Card to storage your OTA file. You can use the left side index to jump to the option that you may need.***
150
150
151
151
### QSPI Storage Mode
152
152
@@ -158,16 +158,16 @@ To use internal **QSPI** storage for downloading the binary file via OTA (Over-T
158
158
#### Writing the Script
159
159
To proceed with a OTA using the QSPI flash, you can open the sketch from **Examples >Arduino_Portenta_OTA > OTA_Qspi_Flash**.
160
160
161
-
***Do not forget to fill your Wi-Fi AP SSID, and password on the `arduino_secrets.h` tab.***
161
+
***Do not forget to fill your Wi-Fi AP SSID and password on the `arduino_secrets.h` tab.***
162
162
163
-
This sketch will connect to your Wi-Fi, check if the OTA feature is available by checking the installed firmware on your Portenta.
163
+
This sketch will connect to your Wi-Fi, verify whether the OTA feature is available by checking the installed firmware on your Portenta.
164
164
165
-
Then prepare the OTA storage, download the .ota file from the internet, decompress it, reset the board so after the reboot it will swipe the new firmware, and you will notice it by checking the Built-in LED flashing on red, green and blue.
165
+
Then prepare the OTA storage, download the .ota file from the internet, decompress it, reset the board so after the reboot it will swipe the new firmware and you will notice it by checking the Built-in LED flashing on red, green and blue.
166
166
167
167
### SD Card Storage Mode
168
168
169
169
#### Setting Up
170
-
To use the **SD card** as the preferred OTA (Over-The-Air) storage device, we will use the Arduino Portenta Vision Shield and Portenta H7 connected via **HD (High-Density)** Connectors.
170
+
To use the **SD card** as the preferred OTA (Over-The-Air) storage device, you can use the Arduino Portenta Vision Shield and Portenta H7 connected via **HD (High-Density)** Connectors.
171
171
172
172

173
173
@@ -176,14 +176,14 @@ With this, you will need the Arduino Portenta H7 board connected to the computer
176
176
#### Writing the Script
177
177
As same as QSPI storage mode, to proceed with a OTA using the SD Card, you can open the sketch from **Examples > Arduino_Portenta_OTA > OTA_SD_Portenta**.
178
178
179
-
***Do not forget to fill your Wi-Fi AP SSID, and password on the `arduino_secrets.h` tab.***
179
+
***Do not forget to fill your Wi-Fi AP SSID and password on the `arduino_secrets.h` tab.***
180
180
181
-
This sketch will connect to your Wi-Fi, check if the OTA feature is available by checking the installed firmware on your Portenta.
181
+
This sketch will connect to your Wi-Fi, verify whether the OTA feature is available by checking the installed firmware on your Portenta.
182
182
183
-
Then prepare the OTA storage, download the .ota file from the internet, decompress it, reset the board so after the reboot it will swipe the new firmware, and you will notice it by checking the Built-in LED flashing on red, green and blue.
183
+
Then prepare the OTA storage, download the .ota file from the internet, decompress it, reset the board so after the reboot it will swipe the new firmware and you will notice it by checking the Built-in LED flashing on red, green and blue.
184
184
185
185
## Testing the Code
186
-
Having successfully uploaded the code and completed the OTA process, you will be able to see the Arduino Portenta H7 blinking LED with Red, Blue, Green in a cyclic manner. You will also be able to see in the Serial monitor provided by Arduino IDE process log for more details.
186
+
Having successfully uploaded the code and completed the OTA process, you will be able to see the Arduino Portenta H7 blinking LED Red, Blue, Green in a cyclic manner. You will also be able to see process log in the Serial Monitor provided by Arduino IDE for more details.
187
187
188
188

189
189
@@ -192,10 +192,10 @@ Having successfully uploaded the code and completed the OTA process, you will be
192
192

193
193
194
194
## Conclusion
195
-
You have now learned how to use the OTA feature provided by the Arduino Portenta H7, by updating its firmware. You will now be able to create the OTA file with the sketch designed by yourself, and use this to update Arduino Portenta H7’s firmware via OTA (Over-The-Air) feature with either QSPI or SD card storage mechanism.
195
+
You have now learned how to use the OTA feature provided by the Arduino Portenta H7, by updating its firmware. You will now be able to create the OTA file with the sketch designed by yourself and use this to update Arduino Portenta H7’s firmware via OTA (Over-The-Air) feature with either QSPI or SD card storage mechanism.
196
196
197
197
### Next Steps
198
-
Now with the OTA capability in place, you can now design future-proof system based on Arduino Portenta H7 or try different system disciplines using the OTA capability.
198
+
Now, with the OTA capability in place, you can design future-proof system based on Arduino Portenta H7 or try different system disciplines using the OTA capability.
199
199
200
200
## Full Sketches
201
201
The complete script is as follows.
@@ -400,5 +400,5 @@ void loop()
400
400
## Troubleshooting
401
401
For troubleshooting the issues that might have arose following the tutorial, you can use following tips to solve the issue.
402
402
403
-
- If it logs there has been an issue with Wi-Fi module, means the device may have suffered from losing the Wi-Fi firmware partition. To solve this, you will have to use **PortentaWiFiFirmwareupdater** sketch found on Arduino IDE examples to fix the issue.
404
-
- QSPI storage may throw error -3 while running Portenta H7 OTA QSPI example. To fix this you can use this guide of [Reading and Writing Flash Memory](https://docs.arduino.cc/tutorials/portenta-h7/reading-writing-flash-memory) in the section **Programming the QSPI Flash**. After this, run the example and it should have been solved by eliminating error -3 (OTA Storage initialization error).
403
+
- If there has been an issue with Wi-Fi module, it means the device may have suffered from losing the Wi-Fi firmware partition. To solve this, you will have to use **PortentaWiFiFirmwareupdater** sketch found on Arduino IDE examples to fix the issue.
404
+
- QSPI storage may throw error -3 while running Portenta H7 OTA QSPI example. To fix this, you can use this guide of [Reading and Writing Flash Memory](https://docs.arduino.cc/tutorials/portenta-h7/reading-writing-flash-memory) in the section **Programming the QSPI Flash**. At this point, run the example and it should have been solved by eliminating error -3 (OTA Storage initialization error).
0 commit comments