Strona główna Odkrywaj Pomoc
Zaloguj się
RT-Thread-packages
/
esp-idf
kopia lustrzana https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Forkuj 0
Pliki Problemy 0 Wiki
Drzewo: 6540877f23
Gałęzie Tagi
esp-idf
/
examples
gengyuchao 2af64d132f example:ble_hid_device_demo fix the wrong mask value according to HID protocol 6 lat temu
..
bluetooth 2af64d132f example:ble_hid_device_demo fix the wrong mask value according to HID protocol 6 lat temu
build_system 705e4189db examples: fix idf as library example build on macOS 6 lat temu
common_components 20add7da60 esp_netif: extract wifi_netif module as an abstraction to wifi universal interface defined by if handle and callback 6 lat temu
ethernet 3f60837de2 esp_eth: make esp_eth_driver_start public API so application could start ethernet when used without esp-netif 6 lat temu
get-started 86fd13230e CI: Don't download esp32s2beta builds into example tests 6 lat temu
mesh 4857e92e2c esp_mesh: creation of wifi network interfaces for esp-mesh examples moved to used common esp_wifi_default API 6 lat temu
peripherals 81ddd9e291 CAN: Reenable example tests 6 lat temu
protocols 6e0d274f58 esp_netif: example init code fixed to assert only variables, not 6 lat temu
provisioning c00123c77b provisioning: examples updated to use esp_netif instead of tcpip_adapter 6 lat temu
security a3cbc57c19 examples/flash_encryption: use ESP32 target in example test 6 lat temu
storage eea0a6bc56 examples: Add ESP32 DUT class to ext_flash_fatfs example test 6 lat temu
system 6e0d274f58 esp_netif: example init code fixed to assert only variables, not 6 lat temu
wifi 504172e851 wifi: minor changes in scan example 6 lat temu
README.md e7dba7d7bc examples: change default build instructions in docs to CMake 6 lat temu

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