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
cb47c3fbc1
esp-idf/examples
History
chenjianhua 4ea33bbdba examples: fix ble hid led output report
2022-12-19 20:05:50 +08:00
..
bluetooth examples: fix ble hid led output report 2022-12-19 20:05:50 +08:00
build_system/cmake examples: Add the component manager example 2022-02-02 16:44:44 +01:00
common_components/protocol_examples_common Bugfix: Connect example to add scan mode config 2022-01-14 14:26:02 +08:00
cxx ci: Modify some dut-unrelated example tests env tag from Example_WIFI to Example_GENERIC 2020-07-15 16:54:03 +08:00
ethernet eth2ap: Fix eth2ap example crash issue 2021-07-29 11:12:40 +08:00
get-started docs: Add explanation of hello_world folder contents (v4.2) 2020-10-14 07:22:09 +00:00
mesh esp_wifi_mesh: add non mesh connections access 2022-06-30 21:19:23 +08:00
peripherals sdio/example: fixed the essl return type issue 2022-09-26 19:42:24 +08:00
protocols mDNS: Fix example test in CI using retries 2022-10-26 06:06:14 +00:00
provisioning ble-wifi-example-tests: Add fixes and cleanups to ble and wifi tests 2021-06-01 12:43:59 +05:30
security/flash_encryption ci: fix flash encryption example test esptool args 2021-05-13 11:05:32 +08:00
storage Examples/Storage: provide sufficient timeout for SD card formatting 2021-10-29 15:44:53 +08:00
system test/examples: Fixes expected GDB message upon thread hit breakpoint 2022-08-15 19:06:19 +03:00
wifi fix write to null pointer if malloc failed 2022-08-02 20:30:30 +08:00
README.md README fixes 2019-11-22 11:11:37 +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.
  • bluetooth/hci contains HCI transport (VHCI and HCI UART) 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.