Skip to content

Commit 6a6e9cd

Browse files
supreetd21supreetd21
committed
feature/esp_https_ota: Added the esp_https_ota component from idf.
1 parent d5f14db commit 6a6e9cd

File tree

14 files changed

+393
-0
lines changed

14 files changed

+393
-0
lines changed

‎components/esp_https_ota/.DS_Store

6 KB
Binary file not shown.

‎components/esp_https_ota/CMakeLists.txt

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
set(COMPONENT_ADD_INCLUDEDIRS include)
2+
set(COMPONENT_SRCS "src/esp_https_ota.c")
3+
4+
set(COMPONENT_REQUIRES esp_http_client)
5+
set(COMPONENT_PRIV_REQUIRES log app_update)
6+
7+
register_component()

‎components/esp_https_ota/component.mk

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
COMPONENT_SRCDIRS := src
2+
3+
COMPONENT_ADD_INCLUDEDIRS := include

‎components/esp_https_ota/include/esp_https_ota.h

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
// Copyright 2017-2018 Espressif Systems (Shanghai) PTE LTD
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
15+
#pragma once
16+
17+
#include <esp_http_client.h>
18+
19+
#ifdef __cplusplus
20+
extern "C" {
21+
#endif
22+
23+
/**
24+
* @brief HTTPS OTA Firmware upgrade.
25+
*
26+
* This function performs HTTPS OTA Firmware upgrade
27+
*
28+
* @param[in] config pointer to esp_http_client_config_t structure.
29+
*
30+
* @note For secure HTTPS updates, the `cert_pem` member of `config`
31+
* structure must be set to the server certificate.
32+
*
33+
* @return
34+
* - ESP_OK: OTA data updated, next reboot will use specified partition.
35+
* - ESP_FAIL: For generic failure.
36+
* - ESP_ERR_OTA_VALIDATE_FAILED: Invalid app image
37+
* - ESP_ERR_NO_MEM: Cannot allocate memory for OTA operation.
38+
* - ESP_ERR_FLASH_OP_TIMEOUT or ESP_ERR_FLASH_OP_FAIL: Flash write failed.
39+
* - For other return codes, refer OTA documentation in esp-idf's app_update component.
40+
*/
41+
esp_err_t esp_https_ota(const esp_http_client_config_t *config);
42+
43+
#ifdef __cplusplus
44+
}
45+
#endif

‎components/esp_https_ota/src/esp_https_ota.c

+130
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
// Copyright 2017-2018 Espressif Systems (Shanghai) PTE LTD
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
15+
#include <stdio.h>
16+
#include <stdlib.h>
17+
#include <string.h>
18+
#include <esp_https_ota.h>
19+
#include <esp_ota_ops.h>
20+
#include <esp_log.h>
21+
22+
#define OTA_BUF_SIZE 256
23+
static const char *TAG = "esp_https_ota";
24+
25+
static void http_cleanup(esp_http_client_handle_t client)
26+
{
27+
esp_http_client_close(client);
28+
esp_http_client_cleanup(client);
29+
}
30+
31+
esp_err_t esp_https_ota(const esp_http_client_config_t *config)
32+
{
33+
if (!config) {
34+
ESP_LOGE(TAG, "esp_http_client config not found");
35+
return ESP_ERR_INVALID_ARG;
36+
}
37+
38+
if (!config->cert_pem) {
39+
ESP_LOGE(TAG, "Server certificate not found in esp_http_client config");
40+
return ESP_FAIL;
41+
}
42+
43+
esp_http_client_handle_t client = esp_http_client_init(config);
44+
if (client == NULL) {
45+
ESP_LOGE(TAG, "Failed to initialise HTTP connection");
46+
return ESP_FAIL;
47+
}
48+
49+
if (esp_http_client_get_transport_type(client) != HTTP_TRANSPORT_OVER_SSL) {
50+
ESP_LOGE(TAG, "Transport is not over HTTPS");
51+
return ESP_FAIL;
52+
}
53+
54+
esp_err_t err = esp_http_client_open(client, 0);
55+
if (err != ESP_OK) {
56+
esp_http_client_cleanup(client);
57+
ESP_LOGE(TAG, "Failed to open HTTP connection: %s", esp_err_to_name(err));
58+
return err;
59+
}
60+
esp_http_client_fetch_headers(client);
61+
62+
esp_ota_handle_t update_handle = 0;
63+
const esp_partition_t *update_partition = NULL;
64+
ESP_LOGI(TAG, "Starting OTA...");
65+
update_partition = esp_ota_get_next_update_partition(NULL);
66+
if (update_partition == NULL) {
67+
ESP_LOGE(TAG, "Passive OTA partition not found");
68+
http_cleanup(client);
69+
return ESP_FAIL;
70+
}
71+
ESP_LOGI(TAG, "Writing to partition subtype %d at offset 0x%x",
72+
update_partition->subtype, update_partition->address);
73+
74+
err = esp_ota_begin(update_partition, OTA_SIZE_UNKNOWN, &update_handle);
75+
if (err != ESP_OK) {
76+
ESP_LOGE(TAG, "esp_ota_begin failed, error=%d", err);
77+
http_cleanup(client);
78+
return err;
79+
}
80+
ESP_LOGI(TAG, "esp_ota_begin succeeded");
81+
ESP_LOGI(TAG, "Please Wait. This may take time");
82+
83+
esp_err_t ota_write_err = ESP_OK;
84+
char *upgrade_data_buf = (char *)malloc(OTA_BUF_SIZE);
85+
if (!upgrade_data_buf) {
86+
ESP_LOGE(TAG, "Couldn't allocate memory to upgrade data buffer");
87+
return ESP_ERR_NO_MEM;
88+
}
89+
int binary_file_len = 0;
90+
while (1) {
91+
int data_read = esp_http_client_read(client, upgrade_data_buf, OTA_BUF_SIZE);
92+
if (data_read == 0) {
93+
ESP_LOGI(TAG, "Connection closed,all data received");
94+
break;
95+
}
96+
if (data_read < 0) {
97+
ESP_LOGE(TAG, "Error: SSL data read error");
98+
break;
99+
}
100+
if (data_read > 0) {
101+
ota_write_err = esp_ota_write( update_handle, (const void *)upgrade_data_buf, data_read);
102+
if (ota_write_err != ESP_OK) {
103+
break;
104+
}
105+
binary_file_len += data_read;
106+
ESP_LOGD(TAG, "Written image length %d", binary_file_len);
107+
}
108+
}
109+
free(upgrade_data_buf);
110+
http_cleanup(client);
111+
ESP_LOGD(TAG, "Total binary data length writen: %d", binary_file_len);
112+
113+
esp_err_t ota_end_err = esp_ota_end(update_handle);
114+
if (ota_write_err != ESP_OK) {
115+
ESP_LOGE(TAG, "Error: esp_ota_write failed! err=0x%d", err);
116+
return ota_write_err;
117+
} else if (ota_end_err != ESP_OK) {
118+
ESP_LOGE(TAG, "Error: esp_ota_end failed! err=0x%d. Image is invalid", ota_end_err);
119+
return ota_end_err;
120+
}
121+
122+
err = esp_ota_set_boot_partition(update_partition);
123+
if (err != ESP_OK) {
124+
ESP_LOGE(TAG, "esp_ota_set_boot_partition failed! err=0x%d", err);
125+
return err;
126+
}
127+
ESP_LOGI(TAG, "esp_ota_set_boot_partition succeeded");
128+
129+
return ESP_OK;
130+
}

‎examples/system/simple_ota_example/CMakeLists.txt

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# The following lines of boilerplate have to be in your project's CMakeLists
2+
# in this exact order for cmake to work correctly
3+
cmake_minimum_required(VERSION 3.5)
4+
5+
include($ENV{IDF_PATH}/tools/cmake/project.cmake)
6+
project(simple_ota)

‎examples/system/simple_ota_example/Makefile

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
#
2+
# This is a project Makefile. It is assumed the directory this Makefile resides in is a
3+
# project subdirectory.
4+
#
5+
6+
PROJECT_NAME := simple_ota
7+
8+
include $(IDF_PATH)/make/project.mk
9+

‎examples/system/simple_ota_example/README.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Simple OTA example
2+
3+
This example is based on `esp_https_ota` component's APIs.
4+
5+
## Configuration
6+
7+
Refer README.md in the parent directory for setup details

‎examples/system/simple_ota_example/main/CMakeLists.txt

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
set(COMPONENT_SRCS "simple_ota_example.c")
2+
set(COMPONENT_ADD_INCLUDEDIRS ".")
3+
4+
5+
# Embed the server root certificate into the final binary
6+
set(COMPONENT_EMBED_TXTFILES ${PROJECT_PATH}/server_certs/ca_cert.pem)
7+
8+
register_component()

‎examples/system/simple_ota_example/main/Kconfig.projbuild

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
menu "Example Configuration"
2+
3+
config WIFI_SSID
4+
string "WiFi SSID"
5+
default "myssid"
6+
help
7+
SSID (network name) for the example to connect to.
8+
9+
config WIFI_PASSWORD
10+
string "WiFi Password"
11+
default "mypassword"
12+
help
13+
WiFi password (WPA or WPA2) for the example to use.
14+
15+
config FIRMWARE_UPGRADE_URL
16+
string "firmware upgrade url endpoint"
17+
default "https://192.168.0.3:8070/hello-world.bin"
18+
help
19+
URL of server which hosts the firmware
20+
image.
21+
endmenu

‎examples/system/simple_ota_example/main/component.mk

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#
2+
# "main" pseudo-component makefile.
3+
#
4+
# (Uses default behaviour of compiling all source files in directory, adding 'include' to include path.)
5+
6+
COMPONENT_EMBED_TXTFILES := ${PROJECT_PATH}/server_certs/ca_cert.pem

0 commit comments

Comments
 (0)