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
Guillaume Souchere 32db5e4f6b Merge branch 'tests/esp32p4-console-support' into 'master' 
test(console): add esp32p4 target support to console tests and example

Closes IDF-8105 and IDF-8078

See merge request espressif/esp-idf!28834
 		2024-03-06 10:09:03 +08:00
..
bluetooth fix(nimble): Corrected acl data handling code in bleprph_host_only 2024-02-28 19:48:34 +05:30
build_system build: bypass build issues 2024-01-10 15:34:50 +01:00
common_components feat(freertos): Introduced new Kconfig option CONFIG_FREERTOS_NUMBER_OF_CORES 2024-02-09 09:11:28 +01:00
custom_bootloader feat(ci): Enable p4 example, test_apps and unit tests CI build 2023-08-24 12:51:19 +08:00
cxx feat(ci): Enable p4 example, test_apps and unit tests CI build 2023-08-24 12:51:19 +08:00
ethernet feat(esp_eth): added configuration of SPI ETH for ESP32P4 ETH examples 2024-03-04 16:23:40 +01:00
get-started feat(blink): add sdkconfig defaults for each target 2024-02-07 10:32:22 +08:00
ieee802154 feat(ieee802154): make the receive done handler feature mandatory 2024-01-25 20:27:03 +08:00
mesh example: add custom partition table for mesh manual networking 2024-02-27 09:45:21 +08:00
network ci(esp_eth): run iperf over longer period for SPI ETH bridge 2024-02-01 15:39:57 +01:00
openthread Merge branch 'feature/ot_enable_rcp_uart_for_br_by_default' into 'master' 2024-03-01 19:28:38 +08:00
peripherals revert(usb_host): Revert temporary disable cdc_acm_vcp test for P4 2024-03-05 10:04:10 +01:00
phy feat(examples): add local components via idf_component.yml 2023-09-19 10:38:24 +02:00
protocols docs: Update restful server example README file 2024-02-28 16:52:11 +05:30
provisioning docs(wifi_provisioning): Use heap to allocate memory for the response 2024-03-04 16:34:27 +05:30
security feat: add example to re-enable jtag using hmac peripheral 2024-03-04 15:42:33 +05:30
storage fix(examples): Disable formatting SD cards in storage examples by default 2024-02-07 13:40:40 +01:00
system feat(soc): Add soc_caps macros for sleep support 2024-03-05 07:05:40 +01:00
wifi feat(esp_wifi): Add support of Network Introduction Protocol in DPP 2024-02-21 12:47:32 +05:30
zigbee feat(ieee802154): make the receive done handler feature mandatory 2024-01-25 20:27:03 +08:00
README.md feat(ieee802154): Add ieee802154 CLI example 2024-01-03 19:05:16 +08: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.
  • ieee802154 IEEE802.15.4 examples.
  • 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.)
  • Zigbee Zigbee 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 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.

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.