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
David Čermák 07f502410a Merge branch 'bugfix/sntp_example_docs' into 'master' 
sntp example - updated ntp over dhcp code/comments (GitHub PR)

Closes IDFGH-6147

See merge request espressif/esp-idf!15897
 		2021-11-25 11:37:34 +00:00
..
bluetooth docs: fix double spelling error in bt_spp_initiator 2021-11-25 00:03:54 +08:00
build_system/cmake example: auto restart int the linux hello world example 2021-10-18 11:50:50 +08:00
common_components iperf: handle NO_MEM error in OpenThread iperf 2021-11-24 11:20:32 +08:00
custom_bootloader Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
cxx bugfix (cxx)!: added missing explicit for some strong value types 2021-11-19 16:07:32 +08:00
ethernet Merge branch 'feature/eth_ioctl_speed_duplex' into 'master' 2021-11-16 11:56:18 +00:00
get-started Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
mesh Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
network Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
openthread Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
peripherals gpio: Fixed typo in generic_gpio example 2021-11-25 00:05:23 +08:00
protocols Examples/lwip: sntp example - Make SNTP server configurable 2021-11-25 08:50:29 +01:00
provisioning Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
security/flash_encryption Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
storage Storage: Remove makefile reference from spiffsgen README 2021-11-11 15:32:36 +01:00
system console: Console example prints the correct chip model 2021-11-25 00:04:56 +08:00
wifi esp_wifi: Add example code for EAP-FAST. 2021-11-22 17:33:36 +05:30
zigbee/light_sample Zigbee: Add light example 2021-11-11 19:03:01 +08:00
README.md examples: create a new folder structure for generic network examples 2021-07-26 12:25:19 +02:00

README.md

Examples

This directory contains a range of example ESP-IDF projects. These examples are intended to demonstrate parts of the 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 Classic BT, BLE and coex examples using default Bluedroid host stack.
  • bluetooth/nimble BLE examples using NimBLE host stack.
  • bluetooth/esp_ble_mesh ESP BLE Mesh examples.
  • bluetooth/hci HCI transport (VHCI and HCI UART) examples.
  • build_system Examples of build system features.
  • cxx C++ language utilization examples and experimental components.
  • ethernet Ethernet network examples.
  • get-started Simple examples with minimal functionality. Good start point for beginners.
  • mesh Wi-Fi Mesh examples.
  • network Examples related to general network environment, test & analysis.
  • openthread OpenThread examples.
  • peripherals Examples showing driver functionality for the various onboard ESP32 peripherals.
  • protocols Examples showing network protocol interactions.
  • provisioning Wi-Fi provisioning examples.
  • security Examples about security features.
  • storage Examples showing data storage methods using SPI flash, external storage like the SD/MMC interface and flash partitioning.
  • system Demonstrates some internal chip features, or debugging & development tools.
  • wifi Advanced Wi-Fi features (For network protocol examples, see protocols instead.)

In addition to these examples, commmon_components directory contains code shared by several examples.

Using Examples

Before building an example, be sure to follow the ESP-IDF Getting Started Guide to ensure you have the required development environment.

Building an example is the same as building any other project:

  • Change into the directory of the new example you'd like to build.
  • Run idf.py set-target TARGET to select the correct chip target to build before opening the project configuration menu. By default the target is esp32. For all options see idf.py set-target --help
  • 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.