Espressif IoT Development Framework for ESP32-XX

Go to file

Ivan Grokhotkov 7447d08605 components/nvs: clear handles list on init, fix returning *length in nvs_get_{str,blob}		2016-08-23 12:08:00 +08:00
bin	esptool.py: Set higher baud rates on ESP32	2016-08-22 18:44:41 +08:00
components	components/nvs: clear handles list on init, fix returning *length in nvs_get_{str,blob}	2016-08-23 12:08:00 +08:00
docs	docs: macOS update started guide	2016-08-23 10:38:05 +08:00
make	esptool.py & Makefile: Fix compressed upload support (enabled by default)	2016-08-22 18:44:46 +08:00
tools	Use IDF_PATH instead of SDK_PATH for the environment variable pointing to esp-idf	2016-08-19 15:01:49 +08:00
.gitignore	Initial public version	2016-08-17 23:08:22 +08:00
.gitlab-ci.yml	gitlab-ci: push master to GitHub master on success	2016-08-22 18:48:03 +08:00
.gitmodules	gitlab-ci: initial version	2016-08-22 17:37:47 +08:00
Kconfig	Standardise remaining uses of SDK to ESP-IDF	2016-08-19 15:01:15 +08:00
LICENSE	Initial public version	2016-08-17 23:08:22 +08:00
README.buildenv	Use IDF_PATH instead of SDK_PATH for the environment variable pointing to esp-idf	2016-08-19 15:01:49 +08:00
README.md	make: 'make all' default target builds everything, 'make flash' flashes everything	2016-08-18 21:42:37 +08:00

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.