esp-idf/docs/en/api-reference/network/index.rst

Networking APIs
***************

:link_to_translation:`zh_CN:[中文]`

Wi-Fi
=====

.. toctree::
    :maxdepth: 1

    esp_now
    :SOC_WIFI_MESH_SUPPORT: esp-wifi-mesh
    esp_smartconfig
    esp_wifi
    esp_dpp
    esp_nan

Code examples for the Wi-Fi API are provided in the :example:`wifi` directory of ESP-IDF examples.

.. only:: SOC_WIFI_MESH_SUPPORT

      Code examples for ESP-WIFI-MESH are provided in the :example:`mesh` directory of ESP-IDF examples.


Ethernet
========

.. toctree::
   :maxdepth: 1

   esp_eth

Code examples for the Ethernet API are provided in the :example:`ethernet` directory of ESP-IDF examples.

Thread
==========

.. toctree::
   :maxdepth: 1

   esp_openthread

Thread is an IPv6-based mesh networking technology for IoT.
Code examples for the Thread API are provided in the :example:`openthread` directory of ESP-IDF examples.

ESP-NETIF
=========

.. toctree::
   :maxdepth: 1

   esp_netif

IP Network Layer
================

.. toctree::
    :hidden:

    esp_netif_driver

Code examples for TCP/IP socket APIs are provided in the :example:`protocols/sockets` directory of ESP-IDF examples.

Application Layer 
=================

Documentation for Application layer network protocols (above the IP Network layer) are provided in :doc:`../protocols/index`.
-												doc: Rearrange wifi & ethernet docs into a common "network" doc

											
										
										
											2018-12-03 02:11:31 -05:00
+								Networking APIs
 								***************
-												Add Chinese translation for index.rst files and esp_wifi.rst file in api-reference following Kirill's English review, including:

-network/index.rst
-network/esp_wifi.rst
-peripherals/index.rst
-provisioning/index.rst

											
										
										
											2019-05-15 09:05:44 -04:00
+								:link_to_translation:`zh_CN:[中文]`
-												doc: Rearrange wifi & ethernet docs into a common "network" doc

											
										
										
											2018-12-03 02:11:31 -05:00
+								Wi-Fi
 								=====
 								.. toctree::
-												docs: Alphbetically sort toctree

This commit sorts the entries of variuos toctrees
alphabetically. Indentation was also fixed. The order
of some toctrees were not modified if the existing
order had some form of suggested reading order.

											
										
										
											2019-08-13 04:01:50 -04:00
+								    :maxdepth: 1
-												doc: Rearrange wifi & ethernet docs into a common "network" doc

											
										
										
											2018-12-03 02:11:31 -05:00
-												docs: Updated CN translation for index files in api-guides and api-reference

											
										
										
											2021-12-30 05:50:55 -05:00
+								    esp_now
-												doc: esp32c2 wifi programming guide doc.

											
										
										
											2022-07-07 02:13:11 -04:00
+								    :SOC_WIFI_MESH_SUPPORT: esp-wifi-mesh
-												docs: Updated CN translation for index files in api-guides and api-reference

											
										
										
											2021-12-30 05:50:55 -05:00
+								    esp_smartconfig
 								    esp_wifi
 								    esp_dpp
-												esp_wifi: Add support for NAN Discovery and Datapath

Update wifi lib with below -
1. Create NAN Discovery SM for beaconing & cluster formation
2. Create NAN interface for Tx/Rx of beacons & action frames
3. Add commands & events for NAN Services Publish/Subscribe/Followup
4. Add NAN Datapath definitions, Events, Peer structures
5. Support for forming and parsing of Datapath related attributes
6. Modules for NDP Req, Resp, Confirm, Term, Peer management
7. NAN Interface related additions in Datapath, Data Tx Q's

In addition include below changes -
1. Add netif and driver support for NAN Interface
2. Add simple examples for Publisher-Subscriber usecases
3. Add an advanced console example that supports commands
   for NAN Discovery, Services & Datapath
4. Add wifi_apps for providing better NAN API's and Peer management

Co-authored-by: Shyamal Khachane <shyamal.khachane@espressif.com>

											
										
										
											2023-02-13 23:36:40 -05:00
+								    esp_nan
-												doc: Rearrange wifi & ethernet docs into a common "network" doc

											
										
										
											2018-12-03 02:11:31 -05:00
-												Doc/review api reference indexes

											
										
										
											2019-04-28 22:53:42 -04:00
+								Code examples for the Wi-Fi API are provided in the :example:`wifi` directory of ESP-IDF examples.
-												doc: esp32c2 wifi programming guide doc.

											
										
										
											2022-07-07 02:13:11 -04:00
+								.. only:: SOC_WIFI_MESH_SUPPORT
 								      Code examples for ESP-WIFI-MESH are provided in the :example:`mesh` directory of ESP-IDF examples.
-												doc: Rearrange wifi & ethernet docs into a common "network" doc

											
										
										
											2018-12-03 02:11:31 -05:00
 								Ethernet
 								========
 								.. toctree::
 								   :maxdepth: 1
-												docs: Updated CN translation for index files in api-guides and api-reference

											
										
										
											2021-12-30 05:50:55 -05:00
+								   esp_eth
-												doc: Rearrange wifi & ethernet docs into a common "network" doc

											
										
										
											2018-12-03 02:11:31 -05:00
-												Doc/review api reference indexes

											
										
										
											2019-04-28 22:53:42 -04:00
+								Code examples for the Ethernet API are provided in the :example:`ethernet` directory of ESP-IDF examples.
-												docs: add OpenThread docs

											
										
										
											2021-07-22 23:57:40 -04:00
+								Thread
 								==========
 								.. toctree::
 								   :maxdepth: 1
-												docs: Updated CN translation for index files in api-guides and api-reference

											
										
										
											2021-12-30 05:50:55 -05:00
+								   esp_openthread
-												docs: add OpenThread docs

											
										
										
											2021-07-22 23:57:40 -04:00
 								Thread is an IPv6-based mesh networking technology for IoT.
 								Code examples for the Thread API are provided in the :example:`openthread` directory of ESP-IDF examples.
-												doc: Rearrange wifi & ethernet docs into a common "network" doc

											
										
										
											2018-12-03 02:11:31 -05:00
-												netif: added ESP-NETIF L2 TAP interface

											
										
										
											2021-06-01 12:58:30 -04:00
+								ESP-NETIF
 								=========
-												doc: Rearrange wifi & ethernet docs into a common "network" doc

											
										
										
											2018-12-03 02:11:31 -05:00
 								.. toctree::
 								   :maxdepth: 1
-												docs: Updated CN translation for index files in api-guides and api-reference

											
										
										
											2021-12-30 05:50:55 -05:00
+								   esp_netif
-												doc: Rearrange wifi & ethernet docs into a common "network" doc

											
										
										
											2018-12-03 02:11:31 -05:00
-												netif: added ESP-NETIF L2 TAP interface

											
										
										
											2021-06-01 12:58:30 -04:00
+								IP Network Layer
 								================
-												esp_netif: docs update to include tcpip_adapter migration guide

added migration guide link to the esp-netif page and network page
added redirects from tcpip_adapter to new esp_netif

											
										
										
											2019-11-18 11:04:47 -05:00
+								.. toctree::
 								    :hidden:
-												docs: Updated CN translation for index files in api-guides and api-reference

											
										
										
											2021-12-30 05:50:55 -05:00
+								    esp_netif_driver
-												esp_netif: docs update to include tcpip_adapter migration guide

added migration guide link to the esp-netif page and network page
added redirects from tcpip_adapter to new esp_netif

											
										
										
											2019-11-18 11:04:47 -05:00
-												Doc/review api reference indexes

											
										
										
											2019-04-28 22:53:42 -04:00
+								Code examples for TCP/IP socket APIs are provided in the :example:`protocols/sockets` directory of ESP-IDF examples.
-												doc: Rearrange wifi & ethernet docs into a common "network" doc

											
										
										
											2018-12-03 02:11:31 -05:00
-												Doc/review api reference indexes

											
										
										
											2019-04-28 22:53:42 -04:00
+								Application Layer
-												doc: Rearrange wifi & ethernet docs into a common "network" doc

											
										
										
											2018-12-03 02:11:31 -05:00
+								=================
-												Doc/review api reference indexes

											
										
										
											2019-04-28 22:53:42 -04:00
+								Documentation for Application layer network protocols (above the IP Network layer) are provided in :doc:`../protocols/index`.