History

Angus Gratton 20db198401 ci: Temporarily ignore CAN example test failures Due to internal CI issue.		2019-10-28 14:54:21 +08:00
..
bluetooth	NimBLE: Port NimBLE stack to IDF Release v3.3 (Backport v3.3)	2019-10-18 13:23:24 +08:00
build_system/cmake	examples: generic cmake support examples	2018-11-27 13:59:26 +08:00
ethernet	ethernet: add kconfig help for GPIO0 output mode	2019-10-08 02:41:40 +00:00
get-started	examples: Move blink code to main task	2019-02-28 12:12:24 +05:30
mesh	Correct Kconfigs according to the coding style	2019-01-29 13:37:01 +01:00
peripherals	ci: Temporarily ignore CAN example test failures	2019-10-28 14:54:21 +08:00
protocols	mqtt: updated to latest version to include latest fixes, support for global CA store, extended error structure to receive mqtt specific errors. updated idf ssl example to use this error struct	2019-10-21 12:56:18 +00:00
provisioning	esp_prov : Minor refactoring in argument dependent logic	2019-07-07 12:45:06 +05:30
storage	test: get bin path from `dut.app.flash_files` instead of `dut.download_config`	2019-01-03 09:57:47 +08:00
system	example/simple_ota_example: Fix python formatting and KConfig	2019-10-09 14:02:48 +00:00
wifi	examples: fix iperf exit error	2019-04-22 19:56:15 +08:00
README.md	NimBLE: Port NimBLE stack to IDF Release v3.3 (Backport v3.3)	2019-10-18 13:23:24 +08:00

README.md

Examples

This directory contains a range of example ESP-IDF projects. These are intended to demonstrate parts of ESP-IDF functionality, and to provide code that you can copy and adapt into your own projects.

Example Layout

The examples are grouped into subdirectories by category. Each category directory contains one or more example projects:

bluetooth contains Bluetooth (BLE & BT Classic) examples using default Bluedroid host stack.
bluetooth/nimble contains BLE examples using NimBLE host stack
ethernet contains Ethernet examples.
get-started contains some very simple examples with minimal functionality.
mesh contains Wi-Fi Mesh examples.
peripherals contains examples showing driver functionality for the various onboard ESP32 peripherals.
protocols contains examples showing network protocol interactions.
storage contains examples showing data storage methods using SPI flash or external storage like the SD/MMC interface.
system contains examples which demonstrate some internal chip features, or debugging & development tools.
wifi contains examples of advanced Wi-Fi features. (For network protocol examples, see protocols instead.)
build_system contains examples of build system features

Using Examples

Building an example is the same as building any other project:

Follow the Getting Started instructions which include building the "Hello World" example.
Change into the directory of the new example you'd like to build.
make menuconfig to configure the example. Most examples have a project-specific "Example Configuration" section here (for example, to set the WiFi SSID & password to use).
make to build the example.
Follow the printed instructions to flash, or run make flash.

Copying Examples

Each example is a standalone project. The examples do not have to be inside the esp-idf directory. You can copy an example directory to anywhere on your computer in order to make a copy that you can modify and work with.

The IDF_PATH environment variable is the only thing that connects the example to the rest of ESP-IDF.

If you're looking for a more bare-bones project to start from, try esp-idf-template.

Contributing Examples

If you have a new example you think we'd like, please consider sending it to us as a Pull Request.

In the ESP-IDF documentation, you can find a "Creating Examples" page which lays out the steps to creating a top quality example.