2fc60ba938
* branch master: (51 commits) fix typos callback: add a void* pointer with each callback header: callbacks use "void *" as arguments header: format and fix typos add wifi api comments add wifi api comments components/spi_flash: call SPIUnlock only once components/spi_flash: improve comments and readability esp32 cpu_start: Include rom/uart.h, remove inline ROM function declarations bootloader: Add bootloader Kconfig Fix bug where nesting vTaskEnterCritical calls would not re-enable interrupts after vTaskExitCritical sections. installed gitlab key in global before_script, don't need to overwrite in template before_script ci: Use github repo for wifi libraries on master branch, gitlab repo otherwise components/esp32,spi_flash: update some comments components/esp32: remove dependency of WIFI_ENABLED on FREERTOS_UNICORE esp32/lib: Bump WiFi revision update ci: build ssc with idf submodule wifi lib components/esp32: add inter-processor call API and implement spi_flash through it add MACRO to get flash pad number from efuse value add comments to register read/write operations ... |
||
|---|---|---|
| components | ||
| docs | ||
| make | ||
| tools | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| .gitmodules | ||
| Kconfig | ||
| LICENSE | ||
| README.md | ||
| add_path.sh | ||
README.md
Using Espressif IoT Development Framework with the ESP32
Prerequisites
Configuring your project
make menuconfig
Compiling your project
make all
... will compile app, bootloader and generate a partition table based on the config.
Flashing your project
When make all finishes, it will print a command line to use esptool.py to flash the chip. However you can also do this from make by running:
make flash
This will flash the entire project (app, bootloader and partition table) to a new chip. The settings for serial port flashing can be configured with make menuconfig.
You don't need to run make all before running make flash, make flash will automatically rebuild anything which needs it.
Compiling & Flashing Just the App
After the initial flash, you may just want to build and flash just your app, not the bootloader and partition table:
make app- build just the app.make app-flash- flash just the app.
make app-flash will automatically rebuild the app if it needs it.
(There's no downside to reflashing the bootloader and partition table each time, if they haven't changed.)
The Partition Table
Once you've compiled your project, the "build" directory will contain a binary file with a name like "my_app.bin". This is an ESP32 image binary that can be loaded by the bootloader.
A single ESP32's flash can contain multiple apps, as well as many different kinds of data (calibration data, filesystems, parameter storage, etc). For this reason a partition table is flashed to offset 0x4000 in the flash.
Each entry in the partition table has a name (label), type (app, data, or something else), subtype and the offset in flash where the partition is loaded.
The simplest way to use the partition table is to make menuconfig and choose one of the simple predefined partition tables:
- "Single factory app, no OTA"
- "Factory app, two OTA definitions"
In both cases the factory app is flashed at offset 0x10000. If you make partition_table then it will print a summary of the partition table.
For more details about partition tables and how to create custom variations, view the docs/partition_tables.rst file.
Resources
-
The docs directory of the esp-idf repository contains esp-idf documentation.
-
The esp32.com forum is a place to ask questions and find community resources.
-
Check the Issues section on github if you find a bug or have a feature request. Please check existing Issues before opening a new one.