Skip to content

Latest commit

 

History

History

esp_delta_ota

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
detools @ 074929b
detools @ 074929b
 
 
examples/https_delta_ota
examples/https_delta_ota
 
 
include
include
 
 
src
src
 
 
test
test
 
 
CHANGELOG.md
CHANGELOG.md
 
 
CMakeLists.txt
CMakeLists.txt
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
idf_component.yml
idf_component.yml
 
 
image_format.png
image_format.png
 
 

README.md

ESP Delta OTA

Getting Started

Compressed Delta OTA Updates aims at enabling Over-the-Air firmware update with compressed delta binaries.

Compressed Delta Image for OTA

Image Format

Advantages of using this design for OTA update:

  • Patch file have smaller size than the original firmware file. This reduces the time and network usage to download the file from server.
  • No additional storage partition is required for the "patch".
  • Only firmware level changes are required for integrating this component. No bootloader related changes required.
  • This scheme can be implemented for the existing devices in the field.

Prerequisites

  • ESP-IDF v4.3 and above

    You can visit the ESP-IDF Programmming Guide for the installation steps.

  • detools v0.49.0 and above

    Binary delta encoding in Python 3.6+. You can install detools using the following command:

    pip install -r examples/https_delta_ota/tools/requirements.txt

    More information about the package here.

Usage

Refer to the https_delta_ota example to see the use of esp_delta_ota component for OTA updates.

API Reference

To learn more about how to use this component, please check API Documentation from header file esp_delta_ota.h

License

  • Distributed under the Apache-2.0 License. Refer esp_delta_ota LICENSE for more information.
  • detools : Distributed under the BSD 2-Clause License. Refer detools LICENSE for more information.
  • heatshrink : Distributed under the ISC License. Refer heatshrink LICENSE for more information.