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
37154d4c08
esp-idf/examples
History
suda-morris 14dd44c05f doc: move common Ethernet config explanation into a single file
2019-12-03 15:53:39 +08:00
..
bluetooth ble_mesh: miscellaneous modifications 2019-11-14 11:59:21 +08:00
build_system/cmake examples: fix idf as library example build on macOS 2019-11-11 18:09:52 +08:00
common_components/protocol_examples_common ethernet: add gpio number into config structure 2019-12-03 15:53:39 +08:00
ethernet doc: move common Ethernet config explanation into a single file 2019-12-03 15:53:39 +08:00
get-started build system: Use CMake-based build system as default when describing commands 2019-07-08 17:31:27 +10:00
mesh driver: Remove features deprecated pre-IDF V4.0 2019-09-19 18:47:15 +10:00
peripherals ci: Temporarily ignore CAN example test failures 2019-10-26 16:45:23 +08:00
protocols asio: fix asio test code to start the test after ip address received from common example code 2019-11-14 12:12:15 +08:00
provisioning examples: change default build instructions in docs to CMake 2019-08-06 17:25:25 +05:30
security/flash_encryption examples/flash_encryption: refactor, add test 2019-09-10 17:19:44 +02:00
storage examples/ext_flash_fatfs: print out data partitions, add CI test 2019-10-18 11:15:10 +02:00
system examples: change default build instructions in docs to CMake 2019-08-06 17:25:25 +05:30
wifi espnow: fix the bug for calling esp_wifi_set_channel(), this function only can be called after Wi-Fi started and sniffer enabled. 2019-11-13 17:37:26 +08:00
README.md examples: change default build instructions in docs to CMake 2019-08-06 17:25:25 +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.