1.6 KiB
Gen Compressed OTA
When using the compressed OTA, we need to generate the compressed app firmware. This document mainly describes how to generate the compressed app firmware.
For more information about compressed OTA, refer to bootloader_support_plus.
Use
In order to use this feature, you need to include the needed CMake file in your project's CMakeLists.txt after project(XXXX).
project(XXXX)
include(gen_compressed_ota)
Generate the compressed app firmware in an ESP-IDF "project" directory by running:
idf.py gen_compressed_ota
This command will compile your project first, then it will generate the compressed app firmware. For example, run the command under the project simple_ota_examples folder. If there are no errors, the custom_ota_binaries folder will be created and contains the following files:
simple_ota.bin.xz
simple_ota.bin.xz.packed
The file named simple_ota.bin.xz.packed is the actual compressed app binary file to be transferred.
In addition, if secure boot is enabled, the command will generate the signed compressed app binary file:
simple_ota.bin.xz.packed.signed
you can also use the script gen_custom_ota.py to compress the specified app:
python3 gen_custom_ota.py -i simple_ota.bin