esp-idf/examples/wifi
Roland Dobai 46e37515b8 Merge branch 'feat/examples_minimal_build' into 'master'
switch examples to build just with required components

Closes IDF-11308, IDF-7940, and IDF-11289

See merge request espressif/esp-idf!33825
2024-11-25 16:27:29 +08:00
..
espnow
fast_scan
ftm
getting_started
iperf
itwt
power_save
roaming
scan
smart_config
softap_sta
wifi_aware
wifi_eap_fast
wifi_easy_connect/dpp-enrollee
wifi_enterprise
wps
wps_softap_registrar
.build-test-rules.yml
README.md

README.md

Supported Targets ESP32 ESP32-C2 ESP32-C3 ESP32-C6 ESP32-S2 ESP32-S3

Wi-Fi Examples

This directory contains a range of examples ESP-IDF projects. These are intended to demonstrate the Wi-Fi functionality, and to provide code that you can copy and adapt into your own projects.

Example Layout

The examples are grouped into sub-directories by category. Each category directory contains one or more example projects:

  • espnow is the connectionless Wi-Fi communication protocol.
  • fast_scan shows how to use fast scan while connecting to an AP.
  • ftm is a how to use FTM (Fine Timing Measurement) feature to calculate distance between devices.
  • getting_started contains the basic examples for using Wi-Fi in STA and AP mode.
  • iperf shows the common performance measurements for two ESP running this example.
  • power_save contains a how to use power save mode of Wi-Fi.
  • roaming contains 2 examples that demonstrate roaming capabilities.
  • scan shows how to scan for all the available APs.
  • smart_config shows how ESP connects to a target AP with ESPTOUCH.
  • wifi_eap_fast shows how ESP connects to AP with Wi-Fi enterprise encryption using the EAP-FAST method.
  • wifi_easy_connect shows how to configure an ESP device as an enrollee using Device Provisioning Protocol (DPP).
  • wpa2_enterprise shows how ESP connects to AP with WPA2 enterprise encryption.
  • wps contains a how to use the Wi-Fi Protected Setup protocol.

More

See the README.md file in the upper level examples directory for more information about examples.