e3ffcd22d5
Startup flow refactoring This set of commits changes the startup code in a way that lets the application choose if/when to initialize WiFi/BT. Application entry point is now a more familiar `main()` function. This function is executed in its own task. Application may choose to do some initialization from main function, create some tasks and then return from `main`. Simple applications may choose to do all their work from `main`. Additionally this MR splits event handling code into two parts. - One part is a set of standard handlers for WiFi and DHCP events. Most applications will use this set of handlers, and it is made available via new `esp_event_process_default` function. - Another part is the default implementation of event handling loop. Some applications may choose to use default event loop through `esp_event_loop_` set of APIs, which start an event handling task and call user-provided event callback from this task. Other applications may create an event queue and implement event loop themselves. In this case application has to provide `esp_event_send` function. In this case the implementation provided by `esp_event_loop_` module is unused. esp-idf-template has been updated to match this set of changes: https://github.com/espressif/esp-idf-template/tree/feature/init_refactoring BT example has also been updated. We need to provide examples of both event handling approaches. This will be done in a separate follow-up MR. See merge request !112 |
||
|---|---|---|
| components | ||
| docs | ||
| examples/04_ble_adv | ||
| make | ||
| tools | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| .gitmodules | ||
| add_path.sh | ||
| Kconfig | ||
| LICENSE | ||
| 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.