2016-11-05 12:18:25 -04:00
Wi-Fi
=====
2016-10-24 14:44:57 -04:00
2019-05-15 09:05:44 -04:00
:link_to_translation:`zh_CN:[中文]`
2017-09-26 21:13:20 -04:00
Introduction
------------
2016-10-26 15:08:36 -04:00
2017-09-26 21:13:20 -04:00
The WiFi libraries provide support for configuring and monitoring the ESP32 WiFi networking functionality. This includes configuration for:
2016-10-26 15:08:36 -04:00
2017-09-26 21:13:20 -04:00
- Station mode (aka STA mode or WiFi client mode). ESP32 connects to an access point.
- AP mode (aka Soft-AP mode or Access Point mode). Stations connect to the ESP32.
- Combined AP-STA mode (ESP32 is concurrently an access point and a station connected to another access point).
- Various security modes for the above (WPA, WPA2, WEP, etc.)
- Scanning for access points (active & passive scanning).
2019-04-28 22:53:42 -04:00
- Promiscuous mode for monitoring of IEEE802.11 WiFi packets.
2017-01-17 13:12:48 -05:00
2017-05-02 04:36:01 -04:00
Application Examples
--------------------
2016-10-26 15:08:36 -04:00
2019-04-28 22:53:42 -04:00
The :example: `wifi` directory of ESP-IDF examples contains the following applications:
2016-10-26 15:08:36 -04:00
2019-04-28 22:53:42 -04:00
Code examples for Wi-Fi are provided in the :example: `wifi` directory of ESP-IDF examples.
2016-10-24 14:44:57 -04:00
2019-11-18 16:13:07 -05:00
In addition, there is a simple `esp-idf-template <https://github.com/espressif/esp-idf-template> `_ application to demonstrate a minimal IDF project structure.
2016-10-24 14:44:57 -04:00
2017-05-02 04:36:01 -04:00
API Reference
-------------
2016-11-05 12:18:25 -04:00
2017-05-02 04:36:01 -04:00
.. include :: /_build/inc/esp_wifi.inc
2017-09-26 03:02:52 -04:00
.. include :: /_build/inc/esp_wifi_types.inc
2016-11-05 12:18:25 -04:00