alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
Espressif IoT Development Framework. Official development framework for Espressif SoCs. https://docs.espressif.com/projects/esp-idf/en/stable/esp32/index.html
21 Commits 20 Branches 148 Tags 384 MiB
C 95.6%
Python 2.1%
C++ 1.2%
CMake 0.7%
Assembly 0.3%
00eed0deed
Go to file
Ivan Grokhotkov 00eed0deed docs: macOS update started guide 
fix URL to use HTTPS
fix typo
mention that compiling toolchain is optional
mention how to find the serial port
2016-08-23 10:38:05 +08:00
bin Initial public version 2016-08-17 23:08:22 +08:00
components Merge branch 'default_freq' into 'master' 2016-08-22 17:38:00 +08:00
docs docs: macOS update started guide 2016-08-23 10:38:05 +08:00
make Use IDF_PATH instead of SDK_PATH for the environment variable pointing to esp-idf 2016-08-19 15:01:49 +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
.gitmodules Initial public version 2016-08-17 23:08:22 +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.