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

连网 API
***************

:link_to_translation:`en:[English]`

.. only:: SOC_WIFI_SUPPORTED

   Wi-Fi
   =====

   .. toctree::
      :maxdepth: 1

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

   本部分的 Wi-Fi API 示例代码存放在 ESP-IDF 示例项目的 :example:`wifi` 目录下。

.. only:: SOC_WIFI_MESH_SUPPORT

      ESP-WIFI-MESH 的示例代码存放在 ESP-IDF 示例项目的 :example:`mesh` 目录下。


以太网
========

.. toctree::
   :maxdepth: 1

   esp_eth

本部分的以太网 API 示例代码存放在 ESP-IDF 示例项目的 :example:`ethernet` 目录下。

Thread
========

.. toctree::
   :maxdepth: 1

   esp_openthread

Thread 是一种基于 IPv6 的物联网网状网络技术。

本部分的 Thread API 示例代码存放在 ESP-IDF 示例项目的 :example:`openthread` 目录下。

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

.. toctree::
   :maxdepth: 1

   esp_netif

IP 网络层协议
================

.. toctree::
   :hidden:

   esp_netif_driver

TCP/IP 套接字 API 的示例代码存放在 ESP-IDF 示例项目的 :example:`protocols/sockets` 目录下。

应用层协议 
===========

应用层网络协议（IP 网络层协议之上）的相关文档存放在 :doc:`../protocols/index` 目录下。
-												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
+								连网 API
 								***************
 								:link_to_translation:`en:[English]`
-												feat(doc): update wifi sections for H2

											
										
										
											2023-08-30 23:31:07 -04:00
+								.. only:: SOC_WIFI_SUPPORTED
-												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
-												feat(doc): update wifi sections for H2

											
										
										
											2023-08-30 23:31:07 -04:00
+								   Wi-Fi
 								   =====
-												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
-												feat(doc): update wifi sections for H2

											
										
										
											2023-08-30 23:31:07 -04:00
+								   .. toctree::
 								      :maxdepth: 1
-												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
-												feat(doc): update wifi sections for H2

											
										
										
											2023-08-30 23:31:07 -04:00
+								      esp_now
 								      :SOC_WIFI_MESH_SUPPORT: esp-wifi-mesh
 								      esp_smartconfig
 								      esp_wifi
 								      esp_dpp
-												docs(esp_wifi): Fix inconsistency in NAN documentation

											
										
										
											2023-11-20 04:36:34 -05:00
+								      :SOC_WIFI_NAN_SUPPORT: esp_nan
-												feat(doc): update wifi sections for H2

											
										
										
											2023-08-30 23:31:07 -04:00
 								   本部分的 Wi-Fi API 示例代码存放在 ESP-IDF 示例项目的 :example:`wifi` 目录下。
-												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
-												doc: esp32c2 wifi programming guide doc.

											
										
										
											2022-07-07 02:13:11 -04:00
+								.. only:: SOC_WIFI_MESH_SUPPORT
 								      ESP-WIFI-MESH 的示例代码存放在 ESP-IDF 示例项目的 :example:`mesh` 目录下。
-												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
 								以太网
 								========
 								.. 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
-												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
 								本部分的以太网 API 示例代码存放在 ESP-IDF 示例项目的 :example:`ethernet` 目录下。
-												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
-												docs: Updated CN translation for index files in api-guides and api-reference

											
										
										
											2021-12-30 05:50:55 -05:00
+								Thread 是一种基于 IPv6 的物联网网状网络技术。
-												docs: update format issues for EN and CN files under api-reference/network  folder and api-reference folder

											
										
										
											2023-07-21 06:51:21 -04:00
-												docs: update format issues left in CN docs

											
										
										
											2023-09-13 22:37:29 -04:00
+								本部分的 Thread API 示例代码存放在 ESP-IDF 示例项目的 :example:`openthread` 目录下。
-												docs: add OpenThread docs

											
										
										
											2021-07-22 23:57:40 -04:00
-												docs: Provide Chinese translation for 5 documents in api-reference/network

											
										
										
											2023-08-22 04:34:41 -04:00
+								ESP-NETIF
 								=========
-												docs: Update translations for ESP-IDF unsynchronized files

											
										
										
											2023-10-08 22:25:19 -04:00
-												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
+								.. 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
 								IP 网络层协议
 								================
-												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
 								.. 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
-												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
 								TCP/IP 套接字 API 的示例代码存放在 ESP-IDF 示例项目的 :example:`protocols/sockets` 目录下。
 								应用层协议
 								===========
-												docs: Updated CN translation for index files in api-guides and api-reference

											
										
										
											2021-12-30 05:50:55 -05:00
+								应用层网络协议（IP 网络层协议之上）的相关文档存放在 :doc:`../protocols/index` 目录下。