mirror of
https://github.com/espressif/ESP8266_RTOS_SDK.git
synced 2025-05-26 03:47:53 +08:00
feat(ota): Remove raw OTA example
This commit is contained in:
Dong Heng
@ -1,9 +0,0 @@
|
||||
#
|
||||
# This is a project Makefile. It is assumed the directory this Makefile resides in is a
|
||||
# project subdirectory.
|
||||
#
|
||||
|
||||
PROJECT_NAME := ota
|
||||
|
||||
include $(IDF_PATH)/make/project.mk
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 56 KiB |
@ -1,101 +0,0 @@
|
||||
|
||||
# Simple OTA Demo
|
||||
|
||||
This example demonstrates a working OTA (over the air) firmware update workflow.
|
||||
|
||||
This example is a *simplified demonstration*, for production firmware updates you should use a secure protocol such as HTTPS.
|
||||
|
||||
---
|
||||
|
||||
# Aim
|
||||
|
||||
An app running on ESP8266 can upgrade itself by downloading a new app "image" binary file, and storing it in flash.
|
||||
|
||||
In this example, the ESP8266 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 an http 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.
|
||||
|
||||
|
||||
# Workflow
|
||||
|
||||
The OTA_workflow.png diagram demonstrates the overall workflow:
|
||||
|
||||
|
||||
|
||||
## Step 1: Connect to AP
|
||||
|
||||
Connect your host PC to the same AP that you will use for the ESP8266.
|
||||
|
||||
## Step 2: Run HTTP Server
|
||||
|
||||
Python has a built-in HTTP server that can be used for example purposes.
|
||||
|
||||
For our upgrade example OTA file, we're going to use the `get-started/project_template` example.
|
||||
|
||||
Open a new terminal to run the HTTP server, then run these commands to build the example and start the server:
|
||||
|
||||
```
|
||||
cd $IDF_PATH/examples/get-started/project_template
|
||||
make
|
||||
cd build
|
||||
python -m SimpleHTTPServer 8070
|
||||
```
|
||||
|
||||
While the server is running, the contents of the build directory can be browsed at http://localhost:8070/
|
||||
|
||||
NB: On some systems, the command may be `python2 -m SimpleHTTPServer`.
|
||||
|
||||
NB: You've probably noticed there is nothing special about the "project_template" 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 whether it is written to a factory partition or an OTA 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.
|
||||
|
||||
## Step 3: Build OTA Example
|
||||
|
||||
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
|
||||
* IP address of your host PC as "HTTP Server"
|
||||
* HTTP Port number (if using the Python HTTP server above, the default is correct)
|
||||
|
||||
If serving the "project_template" example, you can leave the default filename as-is.
|
||||
|
||||
Save your changes, and type `make` to build the example.
|
||||
|
||||
## Step 4: Flash OTA Example
|
||||
|
||||
When flashing, use the `erase_flash` target first to erase the entire flash (this deletes any leftover data in the ota_data partition). Then flash the factory image over serial:
|
||||
|
||||
```
|
||||
make erase_flash flash
|
||||
```
|
||||
|
||||
(The `make erase_flash flash` means "erase everything, then flash". `make flash` only erases the parts of flash which are being rewritten.)
|
||||
|
||||
## Step 5: Run the OTA Example
|
||||
|
||||
When the example starts up, it will print "ota: 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
|
||||
|
||||
# Troubleshooting
|
||||
|
||||
* Check your PC can ping the ESP8266 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 you can see the configured file (default project_template.bin) if you browse the file listing at http://127.0.0.1/
|
||||
* If you have another PC or a phone, try viewing the file listing from the separate host.
|
||||
|
||||
## Error "ota_begin error err=0x104"
|
||||
|
||||
If you see this error then check that the configured (and actual) flash size is large enough for the partitions in the partition table. The default "two OTA slots" partition table only works with 4MB flash size. To use OTA with smaller flash sizes, create a custom partition table CSV (look in components/partition_table) and configure it in menuconfig.
|
||||
|
||||
If changing partition layout, it is usually wise to run "make erase_flash" between steps.
|
||||
|
||||
## Production Implementation
|
||||
|
||||
If scaling this example for production use, please consider:
|
||||
|
||||
* Using an encrypted communications channel such as HTTPS.
|
||||
* Dealing with timeouts or WiFi disconnections while flashing.
|
||||
@ -1,40 +0,0 @@
|
||||
menu "Example Configuration"
|
||||
|
||||
config WIFI_SSID
|
||||
string "WiFi SSID"
|
||||
default "myssid"
|
||||
help
|
||||
SSID (network name) for the example to connect to.
|
||||
|
||||
config WIFI_PASSWORD
|
||||
string "WiFi Password"
|
||||
default "myssid"
|
||||
help
|
||||
WiFi password (WPA or WPA2) for the example to use.
|
||||
|
||||
Can be left blank if the network has no security set.
|
||||
|
||||
config SERVER_IP
|
||||
string "HTTP Server IP"
|
||||
default "192.168.0.3"
|
||||
help
|
||||
HTTP Server IP to download the image file from.
|
||||
|
||||
See example README.md for details.
|
||||
|
||||
config SERVER_PORT
|
||||
string "HTTP Server Port"
|
||||
default "8070"
|
||||
help
|
||||
HTTP Server port to connect to.
|
||||
Should be chosen not to conflict with any other port used
|
||||
on the system.
|
||||
|
||||
config EXAMPLE_FILENAME
|
||||
string "HTTP GET Filename"
|
||||
default "/hello-world.bin"
|
||||
help
|
||||
Filename of the app image file to download for
|
||||
the OTA update.
|
||||
|
||||
endmenu
|
||||
@ -1,4 +0,0 @@
|
||||
#
|
||||
# "main" pseudo-component makefile.
|
||||
#
|
||||
# (Uses default behaviour of compiling all source files in directory, adding 'include' to include path.)
|
||||
@ -1,310 +0,0 @@
|
||||
/* OTA example
|
||||
|
||||
This example code is in the Public Domain (or CC0 licensed, at your option.)
|
||||
|
||||
Unless required by applicable law or agreed to in writing, this
|
||||
software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
|
||||
CONDITIONS OF ANY KIND, either express or implied.
|
||||
*/
|
||||
#include <stdlib.h>
|
||||
#include <string.h>
|
||||
#include <sys/socket.h>
|
||||
#include <netdb.h>
|
||||
|
||||
#include "freertos/FreeRTOS.h"
|
||||
#include "freertos/task.h"
|
||||
#include "freertos/event_groups.h"
|
||||
|
||||
#include "esp_system.h"
|
||||
#include "esp_wifi.h"
|
||||
#include "esp_event_loop.h"
|
||||
#include "esp_log.h"
|
||||
#include "esp_ota_ops.h"
|
||||
|
||||
#include "nvs.h"
|
||||
#include "nvs_flash.h"
|
||||
|
||||
#define EXAMPLE_WIFI_SSID CONFIG_WIFI_SSID
|
||||
#define EXAMPLE_WIFI_PASS CONFIG_WIFI_PASSWORD
|
||||
#define EXAMPLE_SERVER_IP CONFIG_SERVER_IP
|
||||
#define EXAMPLE_SERVER_PORT CONFIG_SERVER_PORT
|
||||
#define EXAMPLE_FILENAME CONFIG_EXAMPLE_FILENAME
|
||||
#define BUFFSIZE 1500
|
||||
#define TEXT_BUFFSIZE 1024
|
||||
|
||||
static const char *TAG = "ota";
|
||||
/*an ota data write buffer ready to write to the flash*/
|
||||
static char ota_write_data[BUFFSIZE + 1] = { 0 };
|
||||
/*an packet receive buffer*/
|
||||
static char text[BUFFSIZE + 1] = { 0 };
|
||||
/* an image total length*/
|
||||
static int binary_file_length = 0;
|
||||
/*socket id*/
|
||||
static int socket_id = -1;
|
||||
|
||||
/* FreeRTOS event group to signal when we are connected & ready to make a request */
|
||||
static EventGroupHandle_t wifi_event_group;
|
||||
|
||||
/* The event group allows multiple bits for each event,
|
||||
but we only care about one event - are we connected
|
||||
to the AP with an IP? */
|
||||
const int CONNECTED_BIT = BIT0;
|
||||
|
||||
static esp_err_t event_handler(void *ctx, system_event_t *event)
|
||||
{
|
||||
switch (event->event_id) {
|
||||
case SYSTEM_EVENT_STA_START:
|
||||
esp_wifi_connect();
|
||||
break;
|
||||
case SYSTEM_EVENT_STA_GOT_IP:
|
||||
xEventGroupSetBits(wifi_event_group, CONNECTED_BIT);
|
||||
break;
|
||||
case SYSTEM_EVENT_STA_DISCONNECTED:
|
||||
/* This is a workaround as ESP32 WiFi libs don't currently
|
||||
auto-reassociate. */
|
||||
esp_wifi_connect();
|
||||
xEventGroupClearBits(wifi_event_group, CONNECTED_BIT);
|
||||
break;
|
||||
default:
|
||||
break;
|
||||
}
|
||||
return ESP_OK;
|
||||
}
|
||||
|
||||
static void initialise_wifi(void)
|
||||
{
|
||||
tcpip_adapter_init();
|
||||
wifi_event_group = xEventGroupCreate();
|
||||
ESP_ERROR_CHECK( esp_event_loop_init(event_handler, NULL) );
|
||||
wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT();
|
||||
ESP_ERROR_CHECK( esp_wifi_init(&cfg) );
|
||||
ESP_ERROR_CHECK( esp_wifi_set_storage(WIFI_STORAGE_RAM) );
|
||||
wifi_config_t wifi_config = {
|
||||
.sta = {
|
||||
.ssid = EXAMPLE_WIFI_SSID,
|
||||
.password = EXAMPLE_WIFI_PASS,
|
||||
},
|
||||
};
|
||||
ESP_LOGI(TAG, "Setting WiFi configuration SSID %s...", wifi_config.sta.ssid);
|
||||
ESP_ERROR_CHECK( esp_wifi_set_mode(WIFI_MODE_STA) );
|
||||
ESP_ERROR_CHECK( esp_wifi_set_config(ESP_IF_WIFI_STA, &wifi_config) );
|
||||
ESP_ERROR_CHECK( esp_wifi_start() );
|
||||
}
|
||||
|
||||
/*read buffer by byte still delim ,return read bytes counts*/
|
||||
static int read_until(char *buffer, char delim, int len)
|
||||
{
|
||||
// /*TODO: delim check,buffer check,further: do an buffer length limited*/
|
||||
int i = 0;
|
||||
while (buffer[i] != delim && i < len) {
|
||||
++i;
|
||||
}
|
||||
return i + 1;
|
||||
}
|
||||
|
||||
/* resolve a packet from http socket
|
||||
* return true if packet including \r\n\r\n that means http packet header finished,start to receive packet body
|
||||
* otherwise return false
|
||||
* */
|
||||
static bool read_past_http_header(char text[], int total_len, esp_ota_handle_t update_handle)
|
||||
{
|
||||
/* i means current position */
|
||||
int i = 0, i_read_len = 0;
|
||||
while (text[i] != 0 && i < total_len) {
|
||||
i_read_len = read_until(&text[i], '\n', total_len);
|
||||
// if we resolve \r\n line,we think packet header is finished
|
||||
if (i_read_len == 2) {
|
||||
int i_write_len = total_len - (i + 2);
|
||||
memset(ota_write_data, 0, BUFFSIZE);
|
||||
/*copy first http packet body to write buffer*/
|
||||
memcpy(ota_write_data, &(text[i + 2]), i_write_len);
|
||||
|
||||
esp_err_t err = esp_ota_write( update_handle, (const void *)ota_write_data, i_write_len);
|
||||
if (err != ESP_OK) {
|
||||
ESP_LOGE(TAG, "Error: esp_ota_write failed! err=0x%x", err);
|
||||
return false;
|
||||
} else {
|
||||
ESP_LOGI(TAG, "esp_ota_write header OK");
|
||||
binary_file_length += i_write_len;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
i += i_read_len;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
static bool connect_to_http_server()
|
||||
{
|
||||
ESP_LOGI(TAG, "Server IP: %s Server Port:%s", EXAMPLE_SERVER_IP, EXAMPLE_SERVER_PORT);
|
||||
|
||||
int http_connect_flag = -1;
|
||||
struct sockaddr_in sock_info;
|
||||
|
||||
socket_id = socket(AF_INET, SOCK_STREAM, 0);
|
||||
if (socket_id == -1) {
|
||||
ESP_LOGE(TAG, "Create socket failed!");
|
||||
return false;
|
||||
}
|
||||
|
||||
// set connect info
|
||||
memset(&sock_info, 0, sizeof(struct sockaddr_in));
|
||||
sock_info.sin_family = AF_INET;
|
||||
sock_info.sin_addr.s_addr = inet_addr(EXAMPLE_SERVER_IP);
|
||||
sock_info.sin_port = htons(atoi(EXAMPLE_SERVER_PORT));
|
||||
|
||||
// connect to http server
|
||||
http_connect_flag = connect(socket_id, (struct sockaddr *)&sock_info, sizeof(sock_info));
|
||||
if (http_connect_flag == -1) {
|
||||
ESP_LOGE(TAG, "Connect to server failed! errno=%d", errno);
|
||||
close(socket_id);
|
||||
return false;
|
||||
} else {
|
||||
ESP_LOGI(TAG, "Connected to server");
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
static void __attribute__((noreturn)) task_fatal_error()
|
||||
{
|
||||
ESP_LOGE(TAG, "Exiting task due to fatal error...");
|
||||
close(socket_id);
|
||||
(void)vTaskDelete(NULL);
|
||||
|
||||
while (1) {
|
||||
;
|
||||
}
|
||||
}
|
||||
|
||||
static void ota_example_task(void *pvParameter)
|
||||
{
|
||||
esp_err_t err;
|
||||
/* update handle : set by esp_ota_begin(), must be freed via esp_ota_end() */
|
||||
esp_ota_handle_t update_handle = 0 ;
|
||||
const esp_partition_t *update_partition = NULL;
|
||||
|
||||
ESP_LOGI(TAG, "Starting OTA example...");
|
||||
|
||||
const esp_partition_t *configured = esp_ota_get_boot_partition();
|
||||
const esp_partition_t *running = esp_ota_get_running_partition();
|
||||
|
||||
if (configured != running) {
|
||||
ESP_LOGW(TAG, "Configured OTA boot partition at offset 0x%08x, but running from offset 0x%08x",
|
||||
configured->address, running->address);
|
||||
ESP_LOGW(TAG, "(This can happen if either the OTA boot data or preferred boot image become corrupted somehow.)");
|
||||
}
|
||||
ESP_LOGI(TAG, "Running partition type %d subtype %d (offset 0x%08x)",
|
||||
running->type, running->subtype, running->address);
|
||||
|
||||
/* Wait for the callback to set the CONNECTED_BIT in the
|
||||
event group.
|
||||
*/
|
||||
xEventGroupWaitBits(wifi_event_group, CONNECTED_BIT,
|
||||
false, true, portMAX_DELAY);
|
||||
ESP_LOGI(TAG, "Connect to Wifi ! Start to Connect to Server....");
|
||||
|
||||
/*connect to http server*/
|
||||
if (connect_to_http_server()) {
|
||||
ESP_LOGI(TAG, "Connected to http server");
|
||||
} else {
|
||||
ESP_LOGE(TAG, "Connect to http server failed!");
|
||||
task_fatal_error();
|
||||
}
|
||||
|
||||
/*send GET request to http server*/
|
||||
const char *GET_FORMAT =
|
||||
"GET %s HTTP/1.0\r\n"
|
||||
"Host: %s:%s\r\n"
|
||||
"User-Agent: esp-idf/1.0 esp32\r\n\r\n";
|
||||
|
||||
char *http_request = NULL;
|
||||
int get_len = asprintf(&http_request, GET_FORMAT, EXAMPLE_FILENAME, EXAMPLE_SERVER_IP, EXAMPLE_SERVER_PORT);
|
||||
if (get_len < 0) {
|
||||
ESP_LOGE(TAG, "Failed to allocate memory for GET request buffer");
|
||||
task_fatal_error();
|
||||
}
|
||||
int res = send(socket_id, http_request, get_len, 0);
|
||||
free(http_request);
|
||||
|
||||
if (res < 0) {
|
||||
ESP_LOGE(TAG, "Send GET request to server failed");
|
||||
task_fatal_error();
|
||||
} else {
|
||||
ESP_LOGI(TAG, "Send GET request to server succeeded");
|
||||
}
|
||||
|
||||
update_partition = esp_ota_get_next_update_partition(NULL);
|
||||
ESP_LOGI(TAG, "Writing to partition subtype %d at offset 0x%x",
|
||||
update_partition->subtype, update_partition->address);
|
||||
assert(update_partition != NULL);
|
||||
|
||||
err = esp_ota_begin(update_partition, OTA_SIZE_UNKNOWN, &update_handle);
|
||||
if (err != ESP_OK) {
|
||||
ESP_LOGE(TAG, "esp_ota_begin failed, error=%d", err);
|
||||
task_fatal_error();
|
||||
}
|
||||
ESP_LOGI(TAG, "esp_ota_begin succeeded");
|
||||
|
||||
bool resp_body_start = false, flag = true;
|
||||
/*deal with all receive packet*/
|
||||
while (flag) {
|
||||
memset(text, 0, TEXT_BUFFSIZE);
|
||||
memset(ota_write_data, 0, BUFFSIZE);
|
||||
int buff_len = recv(socket_id, text, TEXT_BUFFSIZE, 0);
|
||||
if (buff_len < 0) { /*receive error*/
|
||||
ESP_LOGE(TAG, "Error: receive data error! errno=%d", errno);
|
||||
task_fatal_error();
|
||||
} else if (buff_len > 0 && !resp_body_start) { /*deal with response header*/
|
||||
memcpy(ota_write_data, text, buff_len);
|
||||
resp_body_start = read_past_http_header(text, buff_len, update_handle);
|
||||
} else if (buff_len > 0 && resp_body_start) { /*deal with response body*/
|
||||
memcpy(ota_write_data, text, buff_len);
|
||||
err = esp_ota_write( update_handle, (const void *)ota_write_data, buff_len);
|
||||
if (err != ESP_OK) {
|
||||
ESP_LOGE(TAG, "Error: esp_ota_write failed! err=0x%x", err);
|
||||
task_fatal_error();
|
||||
}
|
||||
binary_file_length += buff_len;
|
||||
ESP_LOGI(TAG, "Have written image length %d", binary_file_length);
|
||||
} else if (buff_len == 0) { /*packet over*/
|
||||
flag = false;
|
||||
ESP_LOGI(TAG, "Connection closed, all packets received");
|
||||
close(socket_id);
|
||||
} else {
|
||||
ESP_LOGE(TAG, "Unexpected recv result");
|
||||
}
|
||||
}
|
||||
|
||||
ESP_LOGI(TAG, "Total Write binary data length : %d", binary_file_length);
|
||||
|
||||
if (esp_ota_end(update_handle) != ESP_OK) {
|
||||
ESP_LOGE(TAG, "esp_ota_end failed!");
|
||||
task_fatal_error();
|
||||
}
|
||||
err = esp_ota_set_boot_partition(update_partition);
|
||||
if (err != ESP_OK) {
|
||||
ESP_LOGE(TAG, "esp_ota_set_boot_partition failed! err=0x%x", err);
|
||||
task_fatal_error();
|
||||
}
|
||||
ESP_LOGI(TAG, "Prepare to restart system!");
|
||||
esp_restart();
|
||||
return ;
|
||||
}
|
||||
|
||||
void app_main()
|
||||
{
|
||||
// Initialize NVS.
|
||||
esp_err_t err = nvs_flash_init();
|
||||
if (err == ESP_ERR_NVS_NO_FREE_PAGES) {
|
||||
// OTA app partition table has a smaller NVS partition size than the non-OTA
|
||||
// partition table. This size mismatch may cause NVS initialization to fail.
|
||||
// If this happens, we erase NVS partition and initialize NVS again.
|
||||
ESP_ERROR_CHECK(nvs_flash_erase());
|
||||
err = nvs_flash_init();
|
||||
}
|
||||
ESP_ERROR_CHECK( err );
|
||||
|
||||
initialise_wifi();
|
||||
xTaskCreate(&ota_example_task, "ota_example_task", 8192, NULL, 5, NULL);
|
||||
}
|
||||
@ -1,4 +0,0 @@
|
||||
# Default sdkconfig parameters to use the ESP8266 OTA
|
||||
CONFIG_ESPTOOLPY_FLASHSIZE_2MB=y
|
||||
CONFIG_PARTITION_TABLE_TWO_OTA=y
|
||||
CONFIG_LWIP_SOCKET_MULTITHREAD=
|
||||
Reference in New Issue
Block a user