Почетна Преглед Помоћ
Пријавите се
RT-Thread-packages
/
esp-idf
огледало од https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Креирај огранак 0
Датотеке Дискусије 0 Вики
Дрво: 74cd8dac9d
Гране Ознаке
esp-idf
/
examples
Ivan Grokhotkov a2d59525e5 mdns: use esp_event library to handle events пре 7 година
..
bluetooth c159984264 separate rom from esp32 component to esp_rom пре 6 година
build_system 09d7383180 example: Add SPIFFS image generation from build system example пре 6 година
ethernet c159984264 separate rom from esp32 component to esp_rom пре 6 година
get-started 94594af13f examples: Move blink code to main task пре 7 година
mesh 37126d3451 Correct Kconfigs according to the coding style пре 7 година
peripherals e37b0ad648 esp_event: move trailing semicolons out of defines пре 6 година
protocols a2d59525e5 mdns: use esp_event library to handle events пре 6 година
provisioning f4f3b6088a provisioning examples : typos fixed and minor change in timer callback execution пре 7 година
storage b5ac319160 vfs: Adds example for semihosting VFS driver пре 6 година
system e37b0ad648 esp_event: move trailing semicolons out of defines пре 6 година
wifi b1d1e37f87 event loop: re-implement based on esp_event library пре 6 година
README.md 90f5432f2a examples: generic cmake support examples пре 7 година

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.)
  • 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.
  • 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.