20156f9702
Changes argument parsing mechanism from argparse to a new one, that provides better support for extensions and options that are only applicable to specific subcommands, Breaking changes: 1. All global options should go before subcommands, i.e. `idf.py build -C ~/some/project` will not work anymore, only `idf.py -C ~/some/project build` is acceptable 2. To provide multiple values to an option like `--define-cache-entry` it's necessary to repeat option many times, i.e. `idf.py -D entry1 entry2 entry3` will not work, right way is: `idf.py -D entry1 -D entry2 -D entry3` At the moment there are 3 options like this: `--define-cache-entry` in base list and `--test-components` and `--test-exclude-components` in the unit test extensions 3. Drops `defconfig` and `bootloader-clean` subcommands Closes https://github.com/espressif/esp-idf/issues/3570 Closes https://github.com/espressif/esp-idf/issues/3571 |
||
|---|---|---|
| .. | ||
| bluetooth | ||
| build_system/cmake | ||
| common_components/protocol_examples_common | ||
| ethernet | ||
| get-started | ||
| mesh | ||
| peripherals | ||
| protocols | ||
| provisioning | ||
| storage | ||
| system | ||
| wifi | ||
| 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:
bluetoothcontains Bluetooth (BLE & BT Classic) examples.ethernetcontains Ethernet examples.get-startedcontains some very simple examples with minimal functionality.meshcontains Wi-Fi Mesh examples.peripheralscontains examples showing driver functionality for the various onboard ESP32 peripherals.protocolscontains examples showing network protocol interactions.storagecontains examples showing data storage methods using SPI flash or external storage like the SD/MMC interface.systemcontains examples which demonstrate some internal chip features, or debugging & development tools.wificontains examples of advanced Wi-Fi features. (For network protocol examples, seeprotocolsinstead.)build_systemcontains 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 menuconfigto configure the example. Most examples have a project-specific "Example Configuration" section here (for example, to set the WiFi SSID & password to use).maketo 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.