Halaman utama Jelajahi Bantuan
Masuk
RT-Thread-packages
/
esp-idf
cermin dari https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Fork 0
Berkas Masalah 0 Wiki
Pohon: 0dfe45249a
Ranting Tag
esp-idf
/
examples
He Yin Ling f5db736aa6 example: set example wifi scan method to all channel: 4 tahun lalu
..
bluetooth c0a586bdea components/bt: Set discoverable after create server 4 tahun lalu
build_system bdd7461235 examples: Move idf_as_lib sdkconfig file to the project directory 5 tahun lalu
common_components f5db736aa6 example: set example wifi scan method to all channel: 4 tahun lalu
ethernet c277240dc6 esp_wifi: Modify ESP_IF_WIFI_AP to WIFI_IF_AP 4 tahun lalu
get-started 0d5ec69adc tests: gdb_loadable_elf: adjust the breakpoint location for ESP32 ECO3 4 tahun lalu
mesh 025e2b0439 example: Scan failure should not cause system crash 5 tahun lalu
peripherals 4256b1098c twai: Temporarily disable network example test 5 tahun lalu
protocols e0c2145cc7 bugfix/mqtt examples: Updates the CA certificates used. 4 tahun lalu
provisioning c277240dc6 esp_wifi: Modify ESP_IF_WIFI_AP to WIFI_IF_AP 4 tahun lalu
security 29d5a4dcc3 examples: fix flash encryption example test 5 tahun lalu
storage 98c4c98840 spi_flash: fix flash issue of ext_flash_fatfs_example 4 tahun lalu
system 4f06532e80 Merge branch 'bugfix/python3_target_test_4.1' into 'release/v4.1' 4 tahun lalu
wifi 84f3d3e69a Merge branch 'bugfix/enable_pmf_in_iperf_test_v4.1' into 'release/v4.1' 4 tahun lalu
README.md a104bc22ae README fixes 6 tahun lalu

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.