History

fuzhibo 0c2bf7c8bc rtcio: add hal for driver		2019-11-21 10:40:49 +08:00
..
bluetooth	Merge branch 'feature/remove_gcc5_support' into 'master'	2019-11-21 09:08:41 +08:00
build_system/cmake	examples: fix idf as library example build on macOS	2019-11-08 16:04:05 +08:00
common_components/protocol_examples_common	ethernet: add gpio number into config structure	2019-11-20 10:36:45 +08:00
ethernet	doc: move common Ethernet config explanation into a single file	2019-11-20 10:36:45 +08:00
get-started	CI: Don't download esp32s2beta builds into example tests	2019-11-07 06:56:03 +00:00
mesh	esp_mesh: creation of wifi network interfaces for esp-mesh examples moved to used common esp_wifi_default API	2019-11-13 12:36:26 +01:00
peripherals	rmt: refactor examples	2019-11-20 10:54:21 +08:00
protocols	esp_netif: example init code fixed to assert only variables, not	2019-11-13 12:36:25 +01:00
provisioning	provisioning: examples updated to use esp_netif instead of tcpip_adapter	2019-11-13 12:36:25 +01:00
security/flash_encryption	examples/flash_encryption: use ESP32 target in example test	2019-10-03 13:42:59 +02:00
storage	examples: Add ESP32 DUT class to ext_flash_fatfs example test	2019-10-28 18:58:05 +11:00
system	rtcio: add hal for driver	2019-11-21 10:40:49 +08:00
wifi	wifi: minor changes in scan example	2019-11-15 23:56:16 +08:00
README.md	examples: change default build instructions in docs to CMake	2019-08-02 16:32:46 +05:30

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/bluedroid contains Classic BT, BLE and coex examples using default Bluedroid host stack.
bluetooth/nimble contains BLE examples using NimBLE host stack.
bluetooth/esp_ble_mesh contains ESP BLE Mesh examples.
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.
Run idf.py menuconfig to open the project configuration menu. Most examples have a project-specific "Example Configuration" section here (for example, to set the WiFi SSID & password to use).
idf.py build to build the example.
Follow the printed instructions to flash, or run idf.py -p PORT 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.