1Wi-Fi
2=====
3
4:link_to_translation:`zh_CN:[中文]`
5
6Introduction
7------------
8
9The Wi-Fi libraries provide support for configuring and monitoring the {IDF_TARGET_NAME} Wi-Fi networking functionality. This includes configuration for:
10
11- Station mode (aka STA mode or Wi-Fi client mode). {IDF_TARGET_NAME} connects to an access point.
12- AP mode (aka Soft-AP mode or Access Point mode). Stations connect to the {IDF_TARGET_NAME}.
13- Combined AP-STA mode ({IDF_TARGET_NAME} is concurrently an access point and a station connected to another access point).
14
15- Various security modes for the above (WPA, WPA2, WEP, etc.)
16- Scanning for access points (active & passive scanning).
17- Promiscuous mode for monitoring of IEEE802.11 Wi-Fi packets.
18
19
20Application Examples
21--------------------
22
23The :example:`wifi` directory of ESP-IDF examples contains the following applications:
24
25Code examples for Wi-Fi are provided in the :example:`wifi` directory of ESP-IDF examples.
26
27In addition, there is a simple `esp-idf-template <https://github.com/espressif/esp-idf-template>`_ application to demonstrate a minimal IDF project structure.
28
29
30API Reference
31-------------
32
33.. include-build-file:: inc/esp_wifi.inc
34.. include-build-file:: inc/esp_wifi_types.inc
35
36
37