doc: updated readme

This commit is contained in:
aZholtikov committed 2026-08-16 09:12:31 +03:00
1 parent 9521a78d13
commit b5b27a1937
1 file changed
+18 -39
+18 -39
View File
@@ -1,5 +1,9 @@
# ESP32 ESP-IDF component for simple OTA server # ESP32 ESP-IDF component for simple OTA server
## Wiki
[EN](WIKI_EN.md) | [RU](WIKI_RU.md)
## Tested on ## Tested on
1. [ESP32 ESP-IDF v6.0.0](https://docs.espressif.com/projects/esp-idf/en/v6.0/esp32/index.html) 1. [ESP32 ESP-IDF v6.0.0](https://docs.espressif.com/projects/esp-idf/en/v6.0/esp32/index.html)
@@ -8,6 +12,17 @@
[PVS-Studio](https://pvs-studio.com/pvs-studio/?utm_source=website&utm_medium=github&utm_campaign=open_source) - static analyzer for C, C++, C#, and Java code. [PVS-Studio](https://pvs-studio.com/pvs-studio/?utm_source=website&utm_medium=github&utm_campaign=open_source) - static analyzer for C, C++, C#, and Java code.
## Features
1. HTTP-based OTA firmware updates via standard HTTP POST requests.
2. Automatic partition management with next available OTA partition detection.
3. Embedded web interface for browser-based firmware uploads.
4. Automatic boot activation and device reboot after successful update.
5. Chunked data reception with 1000-byte blocks for efficient memory usage.
6. Seamless integration with ESP-IDF HTTP server and OTA APIs.
7. Comprehensive error handling with detailed ESP_LOGE logging.
8. Low memory footprint with minimal RAM consumption.
## Using ## Using
In an existing project, run the following command to install the component: In an existing project, run the following command to install the component:
@@ -17,48 +32,12 @@ cd ../your_project/components
git clone https://github.com/aZholtikov/zh_ota_server git clone https://github.com/aZholtikov/zh_ota_server
``` ```
In the application, add the component: In the application, include the header:
```c ```c
#include "zh_ota_server.h" #include "zh_ota_server.h"
``` ```
## Example ## Examples
OTA server by address <http://192.168.4.1/ota> See Wiki [EN](WIKI_EN.md#usage-examples) | [RU](WIKI_RU.md#примеры-использования)
```c
#include "nvs_flash.h"
#include "esp_wifi.h"
#include "zh_ota_server.h"
#define WIFI_SSID "SSID"
#define WIFI_PASS "password"
static httpd_handle_t http_server_handle = NULL;
void app_main(void)
{
esp_log_level_set("zh_ota_server", ESP_LOG_ERROR);
nvs_flash_init();
esp_event_loop_create_default();
esp_netif_init();
esp_netif_create_default_wifi_ap();
wifi_init_config_t wifi_config = WIFI_INIT_CONFIG_DEFAULT();
esp_wifi_init(&wifi_config);
wifi_config_t ap_config = {
.ap = {
.ssid = WIFI_SSID,
.password = WIFI_PASS,
.max_connection = 4,
.authmode = WIFI_AUTH_WPA2_PSK,
},
};
esp_wifi_set_mode(WIFI_MODE_AP);
esp_wifi_set_config(WIFI_IF_AP, &ap_config);
esp_wifi_start();
httpd_config_t config = HTTPD_DEFAULT_CONFIG();
httpd_start(&http_server_handle, &config);
zh_ota_server_init(http_server_handle, "/ota");
}
```