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: 92caddb501
Ranting Tag
esp-idf
/
examples
Ivan Grokhotkov 0663ab7609 Merge branch 'feature/uart_rs485_test' into 'master' 7 tahun lalu
..
bluetooth 9784df1c3a asio: examples renamed to have consistent binary names when build in make and CMake 7 tahun lalu
ethernet 7bc36d23e1 ethernet: add iperf example to test real bandwidth 7 tahun lalu
get-started d9939cedd9 cmake: make main a component again 7 tahun lalu
mesh 9784df1c3a asio: examples renamed to have consistent binary names when build in make and CMake 7 tahun lalu
peripherals 6d1e23796f i2c/i2c-tools: add i2c-tools example 7 tahun lalu
protocols 0663ab7609 Merge branch 'feature/uart_rs485_test' into 'master' 7 tahun lalu
provisioning 84f094453b Examples : Added provisioning examples, tests and client tool. 7 tahun lalu
storage d9939cedd9 cmake: make main a component again 7 tahun lalu
system 9784df1c3a asio: examples renamed to have consistent binary names when build in make and CMake 7 tahun lalu
wifi 900b69a33e example: add console command for wifi sniffer 7 tahun lalu
README.md df4e227855 docs: Add "Creating Examples" docs page, template example README 7 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 contains Bluetooth (BLE & BT Classic) 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.)

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.
  • make menuconfig to configure the example. Most examples have a project-specific "Example Configuration" section here (for example, to set the WiFi SSID & password to use).
  • make to build the example.
  • Follow the printed instructions to flash, or run make 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.