pioduino/esp-idf
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doc/review api reference indexes

Browse Source
This commit is contained in:
Kirill Chalov
2019-04-29 10:53:42 +08:00
committed by Krzysztof Budzynski
parent eb3791faba
commit b672002a5f
6 changed files with 20 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/api-reference/network/esp_wifi.rst
+5 -4
View File
@@ -12,16 +12,17 @@ The WiFi libraries provide support for configuring and monitoring the ESP32 WiFi
- 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.
- Promiscuous mode for monitoring of IEEE802.11 WiFi packets.
Application Examples
--------------------
See :example:`wifi` directory of ESP-IDF examples that contains the following applications:
The :example:`wifi` directory of ESP-IDF examples contains the following applications:
* Simple application showing how to connect ESP32 module to an Access Point - `esp-idf-template <https://github.com/espressif/esp-idf-template>`_.
Code examples for Wi-Fi are provided in the :example:`wifi` directory of ESP-IDF examples.
* Using power save mode of Wi-Fi - :example:`wifi/power_save`.
In addition, there is a simple `esp-idf-template <https://github.com/espressif/esp-idf-template>`_ application that shows how to connect ESP32 module to an Access Point.
API Reference
docs/en/api-reference/network/index.rst
+8 -6
View File
@@ -12,9 +12,10 @@ Wi-Fi
ESP-NOW <esp_now>
ESP Mesh <esp_mesh>
Example code for the Wi-Fi API is provided in :example:`wifi` directory of ESP-IDF examples.
Code examples for the Wi-Fi API are provided in the :example:`wifi` directory of ESP-IDF examples.
Code examples for ESP-MESH are provided in the :example:`mesh` directory of ESP-IDF examples.
Example code for ESP Mesh is provided in :example:`mesh` directory of ESP-IDF examples.
Ethernet
========
@@ -24,7 +25,8 @@ Ethernet
Ethernet <esp_eth>
Example code for the Ethernet API is provided in :example:`ethernet` directory of ESP-IDF examples.
Code examples for the Ethernet API are provided in the :example:`ethernet` directory of ESP-IDF examples.
IP Network Layer
================
@@ -34,9 +36,9 @@ IP Network Layer
TCP/IP Adapter <tcpip_adapter.rst>
Example code for TCP/IP socket APIs is provided in :example:`protocols/sockets` directory of ESP-IDF examples.
Code examples for TCP/IP socket APIs are provided in the :example:`protocols/sockets` directory of ESP-IDF examples.
Application Layer
Application Layer 
=================
Documentation for application layer network protocols (above the IP network layer) is provided in :doc:`../protocols/index`.
Documentation for Application layer network protocols (above the IP Network layer) are provided in :doc:`../protocols/index`.