]> granicus.if.org Git - esp-idf/commitdiff
docs: Add introduction section for WiFi, replace boilerplate
authorAngus Gratton <angus@espressif.com>
Wed, 27 Sep 2017 01:13:20 +0000 (11:13 +1000)
committerAngus Gratton <gus@projectgus.com>
Wed, 15 Nov 2017 06:40:38 +0000 (17:40 +1100)
docs/api-reference/wifi/esp_wifi.rst

index 29ecb3e3b6589291a34c356dbe010268050d9bda..c8091e007849ea77345cdd62a8da5c40c556c5eb 100644 (file)
@@ -1,12 +1,18 @@
 Wi-Fi
 =====
 
-Overview
---------
+Introduction
+------------
 
-`Instructions`_
+The WiFi libraries provide support for configuring and monitoring the ESP32 WiFi networking functionality. This includes configuration for:
 
-.. _Instructions: ../template.html
+- 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).
+- Promiscuous mode monitoring of IEEE802.11 WiFi packets.
 
 Application Examples
 --------------------