From 9a96c8379e542ed17ece7436924f34ba3ce85c5e Mon Sep 17 00:00:00 2001 From: Angus Gratton Date: Wed, 27 Sep 2017 11:13:20 +1000 Subject: [PATCH] docs: Add introduction section for WiFi, replace boilerplate --- docs/api-reference/wifi/esp_wifi.rst | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/api-reference/wifi/esp_wifi.rst b/docs/api-reference/wifi/esp_wifi.rst index 29ecb3e3b..c8091e007 100644 --- a/docs/api-reference/wifi/esp_wifi.rst +++ b/docs/api-reference/wifi/esp_wifi.rst @@ -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 --------------------