espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2026-05-04 20:05:25 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'doc/esp_wifi_types' into 'master'

Browse Source 
docs: Add esp_wifi_types.h items to wifi API reference

See merge request !1320
This commit is contained in:
Angus Gratton
2017-11-15 15:03:02 +08:00
parent da141a2c7e c40dc36814
commit b83792f504
5 changed files with 72 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api-reference/wifi/esp_wifi.rst
+12 -4
View 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
--------------------
@@ -22,4 +28,6 @@ API Reference
-------------
.. include:: /_build/inc/esp_wifi.inc
.. include:: /_build/inc/esp_wifi_types.inc