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

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

:link_to_translation:`zh_CN:[中文]`

Wi-Fi
=====

.. toctree::
    :maxdepth: 1

    Wi-Fi <esp_wifi>
    SmartConfig <esp_smartconfig>
    ESP-NOW <esp_now>
    ESP Mesh <esp_mesh>

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.


Ethernet
========

.. toctree::
   :maxdepth: 1

   Ethernet <esp_eth>

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


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

.. toctree::
   :maxdepth: 1

   ESP-NETIF <esp_netif.rst>

.. toctree::
    :hidden:

    TCP/IP Adapter Migration Guide <tcpip_adapter_migration.rst>
    ESP-NETIF Custom I/O Driver <esp_netif_driver.rst>

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

The TCP/IP Adapter (legacy network interface library) has been deprecated, please consult the :doc:`/api-reference/network/tcpip_adapter_migration`
to update existing IDF applications.

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: 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
+								    Wi-Fi <esp_wifi>
-												Provide a brief description of SmartConfig and add link to example

											
										
										
											2020-05-17 13:02:04 -04:00
+								    SmartConfig <esp_smartconfig>
-												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
+								    ESP-NOW <esp_now>
 								    ESP Mesh <esp_mesh>
-												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.
 								Code examples for ESP-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
 								   Ethernet <esp_eth>
-												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.
-												doc: Rearrange wifi & ethernet docs into a common "network" doc

											
										
										
											2018-12-03 02:11:31 -05:00
 								IP Network Layer
 								================
 								.. toctree::
 								   :maxdepth: 1
-												esp_netif: documentation udpated and grouped the esp-netif API
structure. Updated rst documenentation and diagram of esp-netif
cooperation with other components.

											
										
										
											2019-09-12 03:24:56 -04:00
+								   ESP-NETIF <esp_netif.rst>
-												doc: Rearrange wifi & ethernet docs into a common "network" doc

											
										
										
											2018-12-03 02:11:31 -05:00
-												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:
 								    TCP/IP Adapter Migration Guide <tcpip_adapter_migration.rst>
-												esp_netif, docs: Added programmer's manual section

Also added guide for creating a custom network capable I/O driver
And added notes about default wifi interfaces and implications of using
default short-hand creation functions.

											
										
										
											2019-11-25 10:40:56 -05:00
+								    ESP-NETIF Custom I/O Driver <esp_netif_driver.rst>
-												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
-												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
+								The TCP/IP Adapter (legacy network interface library) has been deprecated, please consult the :doc:`/api-reference/network/tcpip_adapter_migration`
 								to update existing IDF applications.
-												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`.