mirror
/
esp-idf
kopia lustrzana https://github.com/espressif/esp-idf
1
0
Forkuj 0
Kod Zgłoszenia Projekty Wydania Wiki Aktywność
esp-idf/examples
Historia
Ivan Grokhotkov feaf29a340 examples/protocols: fix compilation when CONFIG_EXAMPLE_USE_OPENETH=y 
The code checked CONFIG_ETH_USE_SPI_ETHERNET (which is usually set),
but CONFIG_EXAMPLE_ETH_SPI_xxx_GPIO options are only defined if
CONFIG_EXAMPLE_USE_SPI_ETHERNET is set. Fix the ifdef accordingly.
Regression from aea901f0.
 		2021-10-26 12:39:46 +02:00
..
bluetooth add README.md for demo controller_hci_uart_demo 2021-10-19 21:57:45 +08:00
build_system/cmake build system: don't add GCC-specific options when building with clang 2021-01-24 12:48:29 +01:00
common_components examples/protocols: fix compilation when CONFIG_EXAMPLE_USE_OPENETH=y 2021-10-26 12:39:46 +02:00
cxx [cxx]: Added virtual desctructor in I2C class 2021-10-12 10:21:26 +08:00
ethernet eth2ap: Fix eth2ap example crash issue 2021-07-29 10:44:06 +08:00
get-started ci: run Example_GENERIC for C3 2021-05-20 14:32:47 +10:00
mesh esp_wifi_mesh: add non mesh connections access 2021-07-30 14:32:48 +08:00
peripherals Merge branch 'bugfix/timer_example_crashed_not_calling_timer_group_set_alarm_value_in_isr_v4.3' into 'release/v4.3' 2021-10-16 15:59:26 +00:00
protocols freemodbus: check/fix reinitialization issues (tcp master and slave examples) 2021-10-15 16:50:33 +08:00
provisioning ESP32C3: Fix for provisioning failure with ble transport mode and bluedriod stack for v4.3 2021-09-21 19:34:13 +05:30
security/flash_encryption style: format python files with isort and double-quote-string-fixer 2021-01-26 10:49:01 +08:00
storage example/storage: fix incorrect SDSPI DMA setting on c3 2021-10-08 11:53:18 +08:00
system gcov: enable single core tests 2021-09-17 23:19:27 +03:00
wifi esp_wifi: Fix PMF and FTM issues 2021-08-09 18:54:07 +05:30
README.md
…

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.