alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
4b42f535ed
esp-idf/examples
History
Hrishikesh Dhayagude cba69dd088 Bluetooth examples restructuring 
The existing Bluetooth examples are split as:

1. examples/bluetooth/bluedroid - Bluedroid Host (BT + BLE) examples
   a. examples/bluetooth/bluedroid/classic_bt - Classic BT examples
   b. examples/bluetooth/bluedroid/ble - BLE examples
   c. examples/bluetooth/bluedroid/coex - Classic BT and BLE coex examples
   d. examples/bluetooth/bluedroid/hci - VHCI and HCI UART examples
      i. Rename ble_adv to controller_vhci_ble_adv and move it in hci folder
2. examples/bluetooth/nimble - NimBLE BLE Host + NimBLE Mesh examples
3. examples/bluetooth/esp_ble_mesh - ESP BLE Mesh examples
4. Update documentation references
2019-07-01 19:21:57 +08:00
..
bluetooth Bluetooth examples restructuring 2019-07-01 19:21:57 +08:00
build_system/cmake examples: use new component registration api 2019-06-21 19:53:29 +08:00
common_components/protocol_examples_common add esp_eth component 2019-06-26 10:19:23 +08:00
ethernet add esp_eth component 2019-06-26 10:19:23 +08:00
get-started examples: use new component registration api 2019-06-21 19:53:29 +08:00
mesh examples: use new component registration api 2019-06-21 19:53:29 +08:00
peripherals examples: use new component registration api 2019-06-21 19:53:29 +08:00
protocols example/https_server: Add default sdkconfig 2019-06-25 23:43:35 +00:00
provisioning wifi_provisioning : Added Wi-Fi Scan list feature to Provisioning Manager 2019-06-26 05:24:20 +00:00
security/flash_encryption Improve flash encryption documentation and add Development & Release modes 2019-06-25 23:41:18 +00:00
storage examples: use new component registration api 2019-06-21 19:53:29 +08:00
system add esp_eth component 2019-06-26 10:19:23 +08:00
wifi supplicant/esp_wifi: move supplicant to idf 2019-06-29 22:46:52 +08:00
README.md Bluetooth examples restructuring 2019-07-01 19:21:57 +08:00

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