ContextQMD
Back to Esp Idf

Wi-Fi

docs/en/api-reference/network/esp_wifi.rst

6.1-dev1.4 KB
Original Source

Wi-Fi

:link_to_translation:zh_CN:[中文]

Introduction

The Wi-Fi libraries provide support for configuring and monitoring the {IDF_TARGET_NAME} Wi-Fi networking functionality. This includes configuration for:

  • Station mode (aka STA mode or Wi-Fi client mode). {IDF_TARGET_NAME} connects to an access point.

  • AP mode (aka Soft-AP mode or Access Point mode). Stations connect to the {IDF_TARGET_NAME}.

  • Station/AP-coexistence mode ({IDF_TARGET_NAME} is concurrently an access point and a station connected to another access point).

  • Various security modes for the above (WPA, WPA2, WPA3, etc.)

  • Scanning for access points (active & passive scanning).

  • Promiscuous mode for monitoring of IEEE802.11 Wi-Fi packets.

Application Examples

Several application examples demonstrating the functionality of Wi-Fi library are provided in :example:wifi directory of ESP-IDF repository. Please check the :example_file:README <wifi/README.md> for more details.

API Reference

.. include-build-file:: inc/esp_wifi.inc .. include-build-file:: inc/esp_wifi_types.inc .. include-build-file:: inc/esp_wifi_types_generic.inc .. include-build-file:: inc/esp_eap_client.inc .. include-build-file:: inc/esp_wps.inc .. include-build-file:: inc/esp_rrm.inc .. include-build-file:: inc/esp_wnm.inc .. include-build-file:: inc/esp_mbo.inc