esp-idf/examples/wifi
Chen Jian Xing c4562571e2 Merge branch 'docs/update_multi_antenna_switch_docs' into 'master'
Docs/update multi antenna switch docs

Closes WIFI-5582, WIFI-5561, and DOC-2914

See merge request espressif/esp-idf!22937
2023-08-03 21:27:46 +08:00
..
antenna esp_wifi: update multi antenna switch docs 2023-07-12 12:54:02 +08:00
espnow esp_wifi: fix ret when setting channel at wifi not started, fix timer callback 2023-06-27 21:34:53 +08:00
fast_scan
ftm fix(esp_wifi): Enable FTM for ESP32C2, fix other FTM issues 2023-07-10 10:41:37 +05:30
getting_started ci(example): disable softap in wifi station example 2023-07-10 03:19:28 +00:00
iperf feat(external coex): add set tx line flag api 2023-07-12 19:24:29 +08:00
itwt feat(wifi): itwt support itwt wake duration unit 2023-07-13 11:15:17 +08:00
power_save
roaming all: Removes unnecessary newline character in logs 2023-06-09 03:31:21 +08:00
scan all: Removes unnecessary newline character in logs 2023-06-09 03:31:21 +08:00
smart_config
softap_sta examples:Added example for NAT from Wifi AP to STA. 2023-06-21 00:25:53 +10:00
wifi_aware
wifi_eap_fast
wifi_easy_connect/dpp-enrollee all: Removes unnecessary newline character in logs 2023-06-09 03:31:21 +08:00
wifi_enterprise feat(certs): Add python script for generating certificate 2023-06-26 22:38:33 +08:00
wps
wps_softap_registrar
.build-test-rules.yml Merge branch 'ci/wifi_station_only_example_test' into 'master' 2023-07-19 15:10:12 +08:00
README.md examples:Added example for NAT from Wifi AP to STA. 2023-06-21 00:25:53 +10:00

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 a example using 802.11k and 802.11v APIs.
  • 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.