mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
da471dfcd1
Updated main examples README to add missing examples folders and Getting Started links Updated wifi/fastscan example README Updated wifi examples README Updated wifi main examples README Added instructions and removed obviousness from examples README Updates on example README in peripherals, system and wifi Updates on example README in peripherals and added wave form pictures on wave_gen example Updates and review on example README Revision on unit style convention Added the getting started link for each supported version Readme review and recommended enhancements Added the default note on the wave form option info Added the ESP32-C3 support information on the temperature sensor example README Added Getting Started information for ESP32-S2 and ESP32-C3 Issue fixed on the supported target on README Resolved merge conflict |
||
---|---|---|
.. | ||
espnow | ||
fast_scan | ||
ftm | ||
getting_started | ||
iperf | ||
power_save | ||
roaming | ||
scan | ||
simple_sniffer | ||
smart_config | ||
wifi_easy_connect/dpp-enrollee | ||
wpa2_enterprise | ||
wps | ||
README.md |
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.simple_sniffer
demonstrates basic usage of WiFi sniffer mode by saving packets into SD card with pcap format.smart_config
shows how ESP connects to a target AP with ESPTOUCH.wifi_easy_connect
shows how to configure an ESP device as an enrollee using Device Provisioning Protocol (DPP).wpa2_enterprise
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.