Repository navigation
v1.0.0
Release v1.0.0 - Initial Public Release 馃殌
We are excited to announce the first official release of聽ESP32-OTA-Client! This lightweight library simplifies the implementation of Over-The-Air (OTA) firmware updates for ESP32 devices using a custom JSON API backend.
馃専 Key Features
-
Smart Update Checking:
hasUpdate(): Check for updates without downloading (perfect for UI notifications).update(): Perform the update immediately if available.checkUpdate(): Legacy one-step check and update.
-
User Feedback: Built-in聽聽callback to display download percentage via Serial, LCD, or Web UI.
onProgress -
JSON API Support: Works seamlessly with a simple JSON backend structure.
-
Flexible Triggers: Support for Manual (Button press), Periodic (Timer-based), or On-Boot update checks.
-
Robust Error Handling: Handles WiFi connection status and download integrity.
馃摝 Installation
PlatformIO:聽Add the following to your
platformio.ini
:
ini
lib_deps =
https://github.com/LEKPCSTEAM/ESP32-OTA-Client.git
馃摎 Usage Example
cpp
#include "ESP32OTAClient.h"
// Initialize with your API Endpoint
OTAClient ota("http://your-server/api/update", "1.0.0");
void setup() {
// Optional: Monitor progress
ota.onProgress([](int percent, int written, int total) {
Serial.printf("Progress: %d%%\n", percent);
});
}
void loop() {
// Check and update if available
ota.loop();
}
馃敆 Documentation
See the
README聽for full API documentation and check the
examples/
folder for ready-to-use sketches.
Created by聽[LEKPCSTEAM](https://github.com/LEKPCSTEAM)