5bd6696557
usb: Add HID device example Closes IDFGH-7637, IDFGH-5054, IDF-581, and IDFGH-6013 See merge request espressif/esp-idf!19177 |
||
|---|---|---|
| .. | ||
| bluetooth | ||
| build_system | ||
| common_components | ||
| custom_bootloader | ||
| cxx | ||
| ethernet | ||
| get-started | ||
| mesh | ||
| network | ||
| openthread | ||
| peripherals | ||
| protocols | ||
| provisioning | ||
| security | ||
| storage | ||
| system | ||
| wifi | ||
| zigbee | ||
| 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/bluedroidClassic BT, BLE and coex examples using default Bluedroid host stack.bluetooth/nimbleBLE examples using NimBLE host stack.bluetooth/esp_ble_meshESP BLE Mesh examples.bluetooth/hciHCI transport (VHCI and HCI UART) examples.build_systemExamples of build system features.cxxC++ language utilization examples and experimental components.ethernetEthernet network examples.get-startedSimple examples with minimal functionality. Good start point for beginners.meshWi-Fi Mesh examples.networkExamples related to general network environment, test & analysis.openthreadOpenThread examples.peripheralsExamples showing driver functionality for the various onboard ESP32 peripherals.protocolsExamples showing network protocol interactions.provisioningWi-Fi provisioning examples.securityExamples about security features.storageExamples showing data storage methods using SPI flash, external storage like the SD/MMC interface and flash partitioning.systemDemonstrates some internal chip features, or debugging & development tools.wifiAdvanced Wi-Fi features (For network protocol examples, seeprotocolsinstead.)ZigbeeZigbee network and device examples.
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 TARGETto select the correct chip target to build before opening the project configuration menu. By default the target isesp32. For all options seeidf.py set-target --help - Run
idf.py menuconfigto 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 buildto build the example.- Follow the printed instructions to flash, or run
idf.py -p PORT flash.
Running Test Python Script (ttfw)
Some of the examples have ..._test.py scripts that are used to test that the example works as expected. These scripts run automatically in the internal test queue. They are not intended to be run by ESP-IDF users but sometimes you may want to run them locally. The following requirements must be met in the IDF python virtual environment.
- ttfw needs to be in the
PYTHONPATH. Add it like this:export PYTHONPATH=$PYTHONPATH:$IDF_PATH/tools/ci/python_packages - Install all requirements from
tools/ci/python_packages/ttfw_idf/requirements.txt:python -m pip install -r $IDF_PATH/tools/ci/python_packages/ttfw_idf/requirements.txt
These commands help solve the issue with ModuleNotFoundError: No module named 'ttfw_idf' and ModuleNotFoundError: No module named 'tiny_test_fw'.
Some examples might fail due to other missing packages. You might need to install them manually: pip install websocket.
Running Test Python Script (pytest)
Some of the examples have pytest_....py scripts that are using the pytest as the test framework. For detailed information, please refer to the "Run the Tests Locally" Section under ESP-IDF tests in Pytest documentation
Using pytest is the recommended way to write new tests. We will migrate all the example test scripts to this new framework soon.
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.