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
Angus Gratton 3caa54e546 Merge branch 'feature/add_ping_example' into 'master' 
add ping example

Closes WIFI-1196 and IDF-1068

See merge request espressif/esp-idf!6340
 		2019-10-24 11:37:38 +08:00
..
bluetooth components/bt: Add support of NimBLE host in ESP BLE Mesh 2019-10-21 20:18:21 +08:00
build_system/cmake tools: Mass fixing of empty prototypes (for -Wstrict-prototypes) 2019-08-01 16:28:56 +07:00
common_components/protocol_examples_common ethernet: support OpenCores ethernet MAC 2019-10-13 17:05:26 +02:00
ethernet console: fix wrong param passed to esp_err_to_name 2019-10-14 19:49:19 +08:00
get-started Support ELF files loadable with gdb 2019-09-24 07:19:50 +00:00
mesh driver: Remove features deprecated pre-IDF V4.0 2019-09-13 09:44:07 +10:00
peripherals console: fix wrong param passed to esp_err_to_name 2019-10-14 19:49:19 +08:00
protocols Merge branch 'feature/add_ping_example' into 'master' 2019-10-24 11:37:38 +08:00
provisioning esp_wifi: wifi support new event mechanism 2019-08-20 09:39:51 +00:00
security/flash_encryption spi_flash: remove duplicate definition of spi_flash_unlock 2019-08-23 12:37:55 +08:00
storage examples/ext_flash_fatfs: print out data partitions, add CI test 2019-09-30 17:53:14 +02:00
system ping: refactor with new esp_ping_xxx APIs 2019-10-22 04:38:09 +00:00
wifi esp_wifi: Additional code snippets in esp_wifi_scan_example 2019-10-23 14:12:32 +08:00
README.md examples: change default build instructions in docs to CMake 2019-08-02 16:32:46 +05:30

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.