|
|
@@ -1,124 +1,108 @@
|
|
|
-# OTA Demo
|
|
|
+# OTA Example
|
|
|
|
|
|
-## Introduction
|
|
|
+**Notes:** *This guide is common for all ota examples*
|
|
|
|
|
|
-Over The Air (OTA) updates can be performed in esp32 in two ways:
|
|
|
+## Overview
|
|
|
|
|
|
-- Using native APIs which are part of OTA component.
|
|
|
-- Using simplified APIs which are part of `esp_https_ota`, it's an abstraction layer over OTA APIs to perform updates using HTTPS.
|
|
|
+ESP32 application can do upgrading at runtime by downloading new image from specific server through Wi-Fi or Ethernet and then flash it into some partitions. There’re two ways in ESP-IDF to perform Over The Air (OTA) upgrading:
|
|
|
|
|
|
-Both these methods are demonstrated in OTA Demo under `native_ota_example` and `simple_ota_example` respectively.
|
|
|
+- Using the native APIs provided by `app_update` component.
|
|
|
+- Using simplified APIs provided by `esp_https_ota` component, which adds an abstraction layer over the native OTA APIs in order to upgrading with HTTPS protocol.
|
|
|
|
|
|
-*Note: This guide is common for both the examples*
|
|
|
+Both methods are demonstrated in OTA Demos under `native_ota_example` and `simple_ota_example` respectively.
|
|
|
|
|
|
----
|
|
|
+For simplicity, the OTA examples choose the pre-defined partition table by enabling `CONFIG_PARTITION_TABLE_TWO_OTA` option in menuconfig, which supports three app partitions: factory, OTA_0 and OTA_1. For more information about partition table, please refer to [Partition Tables](https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/partition-tables.html).
|
|
|
|
|
|
-## Aim
|
|
|
+On first boot, the bootloader will load the factory app image (i.e. the example image) and then triggers an OTA upgrading. It will download a new image from HTTPS server and save it into the OTA_0 partition. It will update the ota_data partition automatically as well to indicate which app should boot from in the next reset. The bootloader will read the content in ota_data partition and run the selected application.
|
|
|
|
|
|
-An app running on ESP32 can upgrade itself by downloading a new app "image" binary file, and storing it in flash.
|
|
|
+The OTA workflow can be demonstrated as in the following diagram:
|
|
|
|
|
|
-In this example, the ESP32 has 3 images in flash: factory, OTA_0, OTA_1. Each of these is a self-contained partition. The number of OTA image partition is determined by the partition table layout.
|
|
|
+
|
|
|
|
|
|
-Flashing the example over serial with "make flash" updates the factory app image. On first boot, the bootloader loads this factory app image which then performs an OTA update (triggered in the example code). The update downloads a new image from a HTTPS server and saves it into the OTA_0 partition. At this point the example code updates the ota_data partition to indicate the new app partition, and resets. The bootloader reads ota_data, determines the new OTA image has been selected, and runs it.
|
|
|
+## How to use the examples
|
|
|
|
|
|
+### Hardware Required
|
|
|
|
|
|
-## Workflow
|
|
|
+To run the OTA examples, you need an ESP32 dev board (e.g. ESP32-WROVER Kit) or ESP32 core board (e.g. ESP32-DevKitC). If you want to test the OTA with Ethernet, make sure your board has set up the Ethernet correctly. For extra information about setting up Ethernet, please refer to Ethernet examples.
|
|
|
|
|
|
-The OTA_workflow.png diagram demonstrates the overall workflow:
|
|
|
+### Configure the project
|
|
|
|
|
|
-
|
|
|
+Enter `make menuconfig` if you are using GNU Make based build system or enter `idf.py menuconfig` if you are using CMake based build system.
|
|
|
|
|
|
-### Step 1: Connect to AP
|
|
|
+In the `Example Connection Configuration` menu:
|
|
|
|
|
|
-Connect your host PC to the same AP that you will use for the ESP32.
|
|
|
+* Choose the network interface in `Connect using` option based on your board. Currently we support both Wi-Fi and Ethernet.
|
|
|
+* If you have selected the Wi-Fi interface, you also have to set:
|
|
|
+ * Wi-Fi SSID and Wi-Fi password that your ESP32 will connect to
|
|
|
+* If you have selected the Ethernet interface, you also have to set:
|
|
|
+ * PHY model in `Ethernet PHY` option, e.g. IP101
|
|
|
+ * PHY address in `PHY Address` option, which should be determined by your board schematic
|
|
|
+ * EMAC Clock mode, SMI GPIOs
|
|
|
|
|
|
-### Step 2: Run HTTPS Server
|
|
|
+In the `Example Configuration` menu:
|
|
|
|
|
|
-For our upgrade example OTA file, we're going to use the `get-started/hello_world` example.
|
|
|
+* Set the URL of the new firmware that you will download from in the `Firmware Upgrade URL` option, whose format should be `https://<host-ip-address>:<host-port>/<firmware-image-filename>`, e.g. `https://192.168.2.106:8070/hello-world.bin`
|
|
|
+ * **Notes:** The server part of this URL (e.g. `192.168.2.106`) must match the **CN** field used when [generating the certificate and key](#run-https-server).
|
|
|
|
|
|
-Open a new terminal to run the HTTP server, then run these commands to build the example and start the server:
|
|
|
+### Build and Flash
|
|
|
|
|
|
-Build the example:
|
|
|
+Enter `make -j4 flash monitor` if you are using GNU Make based build system or enter `idf.py build flash monitor` if you are using CMake based build system. This command will find if partition table has ota_data partition (as in our case) then ota_data will erase to initial. It allows to run the newly loaded app from a factory partition.
|
|
|
|
|
|
-```
|
|
|
-cd $IDF_PATH/examples/get-started/hello_world
|
|
|
-make
|
|
|
-cd build
|
|
|
-```
|
|
|
+(To exit the serial monitor, type ``Ctrl-]``.)
|
|
|
|
|
|
-Generate self-signed certificate and key:
|
|
|
+See the [Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/index.html) for full steps to configure and use ESP-IDF to build projects.
|
|
|
|
|
|
-*NOTE: `Common Name` of server certificate should be host-name of your server.*
|
|
|
+## Example Output
|
|
|
|
|
|
-```
|
|
|
-openssl req -x509 -newkey rsa:2048 -keyout ca_key.pem -out ca_cert.pem -days 365
|
|
|
+### Run HTTPS Server
|
|
|
|
|
|
-```
|
|
|
+After a successful build, we need to create a self-signed certificate and run a simple HTTPS server as follows:
|
|
|
|
|
|
-* openssl configuration may require you to enter a passphrase for the key.
|
|
|
-* When prompted for the `Common Name (CN)`, enter the name of the server that the ESP32 will connect to. For this local example, it is probably the IP address. The HTTPS client will make sure that the `CN` matches the address given in the HTTPS URL (see Step 3).
|
|
|
+
|
|
|
|
|
|
+* Enter a directory where holds the root of the HTTPS server, e.g. `cd build`.
|
|
|
+* To create a new self-signed certificate and key, you can simply run command `openssl req -x509 -newkey rsa:2048 -keyout ca_key.pem -out ca_cert.pem -days 365 -nodes`.
|
|
|
+ * When prompted for the `Common Name (CN)`, enter the name of the server that the ESP32 will connect to. Regarding this example, it is probably the IP address. The HTTPS client will make sure that the `CN` matches the address given in the HTTPS URL.
|
|
|
+* To start the HTTPS server, you can simply run command `openssl s_server -WWW -key ca_key.pem -cert ca_cert.pem -port 8070`.
|
|
|
+* In the same directory, there should be the firmware (e.g. hello-world.bin) that ESP32 will download later. It can be any other ESP-IDF application as well, as long as you also update the `Firmware Upgrade URL` in the menuconfig. The only difference is that when flashed via serial the binary is flashed to the "factory" app partition, and an OTA update flashes to an OTA app partition.
|
|
|
+* **Notes:** If you have any firewall software running that will block incoming access to port *8070*, configure it to allow access while running the example.
|
|
|
+* **Notes:** For Windows users, you should add `winpty` before `openssl` command:
|
|
|
+ * `winpty openssl req -x509 -newkey rsa:2048 -keyout ca_key.pem -out ca_cert.pem -days 365 -nodes`
|
|
|
+ * `winpty openssl s_server -WWW -key ca_key.pem -cert ca_cert.pem -port 8070`
|
|
|
|
|
|
-Copy the certificate to `server_certs` directory inside OTA example directory:
|
|
|
-
|
|
|
-```
|
|
|
-cp ca_cert.pem /path/to/ota/example/server_certs/
|
|
|
-```
|
|
|
-
|
|
|
+### Flash Certificate to ESP32
|
|
|
|
|
|
-Start the HTTPS server:
|
|
|
+Before you flash the example, make sure to copy the generated certificate to `server_certs` directory inside OTA example directory so that it can be flashed into ESP32 together with the firmware, e.g. `cp ca_cert.pem ../server_certs/`.
|
|
|
|
|
|
```
|
|
|
-openssl s_server -WWW -key ca_key.pem -cert ca_cert.pem -port 8070
|
|
|
+cp ca_cert.pem /path/to/ota/example/server_certs/
|
|
|
```
|
|
|
|
|
|
-NB: You've probably noticed there is nothing special about the "hello world" example when used for OTA updates. This is because any .bin app file which is built by esp-idf can be used as an app image for OTA. The only difference is that when flashed via serial the binary is flashed to the "factory" app partition, and an OTA update flashes to an OTA app partition.
|
|
|
-
|
|
|
-If you have any firewall software running that will block incoming access to port 8070, configure it to allow access while running the example.
|
|
|
+### Internal workflow of the OTA Example
|
|
|
|
|
|
-### Step 3: Build OTA Example
|
|
|
+When the example starts up, it will print "Starting OTA example" to the console and then:
|
|
|
|
|
|
-Change back to the OTA example directory, and type `make menuconfig` to configure the OTA example. Under the "Example Configuration" submenu, fill in the following details:
|
|
|
-
|
|
|
-* WiFi SSID & Password
|
|
|
-* Firmware Upgrade URL. The URL will be look like this:
|
|
|
-
|
|
|
-```
|
|
|
-https://<host-ip-address>:<host-port>/<firmware-image-filename>
|
|
|
-
|
|
|
-for e.g,
|
|
|
-https://192.168.0.3:8070/hello-world.bin
|
|
|
-```
|
|
|
-
|
|
|
-Note: The server part of this URL (e.g. `192.168.0.3`) must match the CN used when generating the certificate and key in Step 2.
|
|
|
+1. Connect to the AP with configured SSID and Password (Wi-Fi case) or just by Ethernet.
|
|
|
+2. Connect to the HTTPS server and download the new image.
|
|
|
+3. Write the image to flash, and configure the next boot from this image.
|
|
|
+4. Reboot
|
|
|
|
|
|
-Save your changes, and type `make` to build the example.
|
|
|
+If you want to rollback to factory app (or the first OTA partition when the factory partition do not exist) after the upgrade, then run the command `make erase_otadata` or `idf.py erase_otadata`. It can erase the ota_data partition to initial state.
|
|
|
|
|
|
-### Step 4: Flash OTA Example
|
|
|
+**Notes:** This assumes that the partition table of this project is the one that is on the device.
|
|
|
|
|
|
-When flashing, use the `make flash` to flash the factory image. This command will find if partition table has ota_data partition (as in our case) then ota_data will erase to initial.
|
|
|
-It allows to run the newly loaded app from a factory partition.
|
|
|
+### Output from HTTPS server
|
|
|
|
|
|
-```
|
|
|
-make flash
|
|
|
+```bash
|
|
|
+FILE:hello-world.bin
|
|
|
+ACCEPT
|
|
|
```
|
|
|
|
|
|
-After first update, if you want to return back to factory app (or the first OTA partition, if factory partition is not present) then use the command `make erase_otadata`.
|
|
|
-It erases the ota_data partition to initial state. **Take note that this assumes that the partition table of this project is the one that is on the device**.
|
|
|
|
|
|
-### Step 5: Run the OTA Example
|
|
|
+## Support rollback
|
|
|
|
|
|
-When the example starts up, it will print "Starting OTA example..." then:
|
|
|
-
|
|
|
-1. Connect to the AP with configured SSID and password.
|
|
|
-2. Connect to the HTTP server and download the new image.
|
|
|
-3. Write the image to flash, and configure the next boot from this image.
|
|
|
-4. Reboot
|
|
|
-
|
|
|
-## Support the rollback
|
|
|
-
|
|
|
-This feature allows you to roll back to the previous firmware if the app is not operable. Option :ref:`CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE` allows you to track the first boot of the application (see the``Over The Air Updates (OTA)`` article).
|
|
|
-For ``native_ota_example``, added a bit of code to demonstrate how a rollback works. To use it, you need enable the :ref:`CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE` option in Kconfig and under the "Example Configuration" submenu to set "Number of the GPIO input for diagnostic" to manage the rollback process.
|
|
|
+This feature allows you to roll back to the previous firmware if the app is not operable. Option `CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE` allows you to track the first boot of the application (see the ``Over The Air Updates (OTA)`` article).
|
|
|
+For ``native_ota_example``, added a bit of code to demonstrate how a rollback works. To use it, you need enable the `CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE` option in menuconfig and under the "Example Configuration" submenu to set "Number of the GPIO input for diagnostic" to manage the rollback process.
|
|
|
|
|
|
To trigger a rollback, this GPIO must be pulled low while the message `Diagnostics (5 sec)...` which will be on first boot.
|
|
|
If GPIO is not pulled low then the operable of the app will be confirmed.
|
|
|
@@ -138,12 +122,7 @@ In ``native_ota_example``, ``$PROJECT_PATH/version.txt`` is used to define the v
|
|
|
|
|
|
* Check your PC can ping the ESP32 at its IP, and that the IP, AP and other configuration settings are correct in menuconfig.
|
|
|
* Check if any firewall software is preventing incoming connections on the PC.
|
|
|
-* Check whether you can see the configured file (default hello-world.bin), by checking the output of following command:
|
|
|
-
|
|
|
- ```
|
|
|
- curl -v https://<host-ip-address>:<host-port>/<firmware-image-filename>
|
|
|
- ```
|
|
|
-
|
|
|
+* Check whether you can see the configured file (default hello-world.bin), by checking the output of the command `curl -v https://<host-ip-address>:<host-port>/<firmware-image-filename>`
|
|
|
* If you have another PC or a phone, try viewing the file listing from the separate host.
|
|
|
|
|
|
### Error "ota_begin error err=0x104"
|
suda-morris
