Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests 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
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/en/api-reference/bluetooth/index.rst
View file

@ -10,14 +10,14 @@ Bluetooth API
Bluetooth Classic <classic_bt>
To see the overview of the ESP32 Bluetooth stack architecture, follow links below:
For the overview of the ESP32 Bluetooth stack architecture, follow the links below:
* `ESP32 Bluetooth Architecture (PDF) [English] <http://espressif.com/sites/default/files/documentation/esp32_bluetooth_architecture_en.pdf>`_
* `ESP32 Bluetooth Architecture (PDF) [中文] <http://espressif.com/sites/default/files/documentation/esp32_bluetooth_architecture_cn.pdf>`_
Example code for this API section is provided in :example:`bluetooth` directory of ESP-IDF examples.
Code examples for this API section are provided in the :example:`bluetooth` directory of ESP-IDF examples.
Several examples contain detailed description. To see them please follow links below:
The following examples contain detailed walkthroughs:
* :example_file:`GATT Client Example Walkthrough <bluetooth/gatt_client/tutorial/Gatt_Client_Example_Walkthrough.md>`
* :example_file:`GATT Server Service Table Example Walkthrough <bluetooth/gatt_server_service_table/tutorial/Gatt_Server_Service_Table_Example_Walkthrough.md>`

9
docs/en/api-reference/network/esp_wifi.rst
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

14
docs/en/api-reference/network/index.rst
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`.

2
docs/en/api-reference/peripherals/index.rst
View file

@ -24,4 +24,4 @@ Peripherals API
Touch Sensor <touch_pad>
UART <uart>
Example code for this API section is provided in :example:`peripherals` directory of ESP-IDF examples.
Code examples for this API section are provided in the :example:`peripherals` directory of ESP-IDF examples.

4
docs/en/api-reference/protocols/index.rst
View file

@ -14,10 +14,10 @@ Application Protocols
ESP-MQTT <mqtt>
Modbus <modbus>
Example code for this API section is provided in :example:`protocols` directory of ESP-IDF examples.
Code examples for this API section are provided in the :example:`protocols` directory of ESP-IDF examples.
IP Network Layer
================
Documentation for IP Network Layer protocols (below the Application Protocol layer) is provided in :doc:`../network/index`.
Documentation for IP Network Layer protocols (below the Application Protocol layer) are provided in :doc:`../network/index`.

2
docs/en/api-reference/provisioning/index.rst
View file

@ -8,4 +8,4 @@ Provisioning API
Protocol Communication <protocomm>
Wi-Fi Provisioning <wifi_provisioning>
Example code for this API section is provided in :example:`provisioning` directory of ESP-IDF examples.
Code examples for this API section are provided in the :example:`provisioning` directory of ESP-IDF examples.