History

Renz Christian Bagaporo 0c2202ef3e examples: fix idf as library example build on macOS GCC prefixes underscore on symbol names on macOS, and so the set undefined symbol `-u app_main` won't work. However, this is unecessary, as the source file that defines it is specified directly to the executable, and not through a static library. Closes https://github.com/espressif/esp-idf/issues/4168		2019-11-11 18:09:52 +08:00
..
stubs	examples: fix idf as library example build on macOS	2019-11-11 18:09:52 +08:00
build-esp32.sh	examples: update idf_as_lib example to use new api	2019-05-14 18:01:14 +08:00
build.sh	examples: update idf_as_lib example to use new api	2019-05-14 18:01:14 +08:00
CMakeLists.txt	examples: update idf_as_lib example to use new api	2019-05-14 18:01:14 +08:00
main.c	examples: generic cmake support examples	2018-11-27 13:59:26 +08:00
README.md	docs: Make CMake build system default, mark GNU Make as legacy option	2019-07-09 14:32:26 +10:00
run-esp32.sh	examples: update idf_as_lib example to use new api	2019-05-14 18:01:14 +08:00
run.sh	examples: update idf_as_lib example to use new api	2019-05-14 18:01:14 +08:00

README.md

Using ESP-IDF in Custom CMake Projects

This example illustrates using ESP-IDF components as libraries in custom CMake projects. The application in this example can run on either host or on an ESP32, and the appropriate libraries are linked to the executable depending on which target is specified. If the target is an ESP32, the libraries created from ESP-IDF components are linked. On the other hand, stub libraries are linked if example is meant to be run on the host to simulate the same application behavior.

The application in this example is equivalent to the hello_world example under examples/get-started/hello_world.

Example Flow

Users looking at this example should focus on the top-level CMakeLists.txt file. This builds an application that can run on the target without relying on the typical ESP-IDF application template.

Output

Hello world!
This is ESP32 chip with 2 CPU cores, WiFi/BT/BLE, silicon revision 0, 4MB external flash
Restarting in 10 seconds...
Restarting in 9 seconds...
Restarting in 8 seconds...
Restarting in 7 seconds...
Restarting in 6 seconds...
Restarting in 5 seconds...
Restarting in 4 seconds...
Restarting in 3 seconds...
Restarting in 2 seconds...
Restarting in 1 seconds...
Restarting in 0 seconds...

Building this Example

To build this example, the user can either run build-esp32.sh to build for the ESP32 or run build.sh to build for the host:

# Builds the example for ESP32
./build-esp32.sh

# Builds the example to run on host
./build.sh

Flashing and Running this Example

To flash and run the example, users can run either run-esp32.sh or run.sh depending on what the example was built for. In the case of run-esp32.sh, the port needs to be specified:

# Run the example on device connected to /dev/ttyUSB1
./run-esp32.sh /dev/ttyUSB1

# Run the example on the host
./run.sh

There is a discussion on using ESP-IDF in custom CMake projects in the programming guide under API Guides -> Build System -> Using ESP-IDF in Custom CMake Projects