diff --git a/docs/en/api-reference/bluetooth/index.rst b/docs/en/api-reference/bluetooth/index.rst index c96e0eccf..4e1e2d14b 100644 --- a/docs/en/api-reference/bluetooth/index.rst +++ b/docs/en/api-reference/bluetooth/index.rst @@ -1,6 +1,8 @@ Bluetooth API ************* +:link_to_translation:`zh_CN:[中文]` + .. toctree:: :maxdepth: 2 diff --git a/docs/en/api-reference/network/esp_wifi.rst b/docs/en/api-reference/network/esp_wifi.rst index 1bbbb4bc8..1f0ada9d5 100644 --- a/docs/en/api-reference/network/esp_wifi.rst +++ b/docs/en/api-reference/network/esp_wifi.rst @@ -1,6 +1,8 @@ Wi-Fi ===== +:link_to_translation:`zh_CN:[中文]` + Introduction ------------ diff --git a/docs/en/api-reference/network/index.rst b/docs/en/api-reference/network/index.rst index e313d7e5b..f555a456c 100644 --- a/docs/en/api-reference/network/index.rst +++ b/docs/en/api-reference/network/index.rst @@ -1,6 +1,8 @@ Networking APIs *************** +:link_to_translation:`zh_CN:[中文]` + Wi-Fi ===== diff --git a/docs/en/api-reference/peripherals/index.rst b/docs/en/api-reference/peripherals/index.rst index a649b303a..b9b85c203 100644 --- a/docs/en/api-reference/peripherals/index.rst +++ b/docs/en/api-reference/peripherals/index.rst @@ -1,6 +1,8 @@ Peripherals API *************** +:link_to_translation:`zh_CN:[中文]` + .. toctree:: :maxdepth: 1 diff --git a/docs/en/api-reference/provisioning/index.rst b/docs/en/api-reference/provisioning/index.rst index 33e635ada..0243ec19f 100644 --- a/docs/en/api-reference/provisioning/index.rst +++ b/docs/en/api-reference/provisioning/index.rst @@ -1,6 +1,8 @@ Provisioning API **************** +:link_to_translation:`zh_CN:[中文]` + .. toctree:: :maxdepth: 1 diff --git a/docs/zh_CN/api-reference/bluetooth/index.rst b/docs/zh_CN/api-reference/bluetooth/index.rst index 0379710c3..47e5ddd48 100644 --- a/docs/zh_CN/api-reference/bluetooth/index.rst +++ b/docs/zh_CN/api-reference/bluetooth/index.rst @@ -1 +1,29 @@ -.. include:: ../../../en/api-reference/bluetooth/index.rst \ No newline at end of file +蓝牙 API +************* + +:link_to_translation:`en:[English]` + +.. toctree:: + :maxdepth: 2 + + Bluetooth Controller && VHCI + Bluetooth Common + Bluetooth LE + Bluetooth Classic + + +请点击下方链接,查看 ESP32 蓝牙架构: + +`ESP32 蓝牙架构 (PDF) `_ + +蓝牙 API 的示例代码存放于 ESP-IDF :example:`bluetooth` 示例目录下,请查看。 + +下面的示例给出了详细介绍: + +* :example_file:`GATT 客户端示例 ` +* :example_file:`GATT 服务端服务表格示例 ` +* :example_file:`GATT 服务端示例 ` +* :example_file:`GATT 客户端安全性示例 ` +* :example_file:`GATT 服务端安全性示例 ` +* :example_file:`GATT 客户端多连接示例 ` + diff --git a/docs/zh_CN/api-reference/network/esp_wifi.rst b/docs/zh_CN/api-reference/network/esp_wifi.rst index 860ea1be1..ca828a6fe 100644 --- a/docs/zh_CN/api-reference/network/esp_wifi.rst +++ b/docs/zh_CN/api-reference/network/esp_wifi.rst @@ -1 +1,36 @@ -.. include:: ../../../en/api-reference/network/esp_wifi.rst +Wi-Fi 库 +======== + +:link_to_translation:`en:[English]` + +概述 +----- + +Wi-Fi 库支持配置及监控 ESP32 Wi-Fi 连网功能。 + +支持配置: + +- 基站模式(即 STA 模式或 Wi-Fi 客户端模式),此时 ESP32 连接到接入点 (AP)。 +- AP 模式(即 Soft-AP 模式或接入点模式),此时基站连接到 ESP32。 +- AP-STA 共存模式(ESP32 既是接入点,同时又作为基站连接到另外一个接入点)。 + +- 上述模式的各种安全模式(WPA、WPA2 及 WEP 等)。 +- 扫描接入点(包括主动扫描及被动扫描)。 +- 使用混杂模式监控 IEEE802.11 Wi-Fi 数据包。 + + +应用示例 +---------- + +ESP-IDF 示例项目的 :example:`wifi` 目录下包含以下应用程序: + +* Wi-Fi 示例代码; + +* 另外一个简单的应用程序 `esp-idf-template `_,演示了如何将 ESP32 模组连接到 AP。 + + +API 参考 +------------- + +.. include:: /_build/inc/esp_wifi.inc +.. include:: /_build/inc/esp_wifi_types.inc diff --git a/docs/zh_CN/api-reference/network/index.rst b/docs/zh_CN/api-reference/network/index.rst index 777339ac4..3a7856001 100644 --- a/docs/zh_CN/api-reference/network/index.rst +++ b/docs/zh_CN/api-reference/network/index.rst @@ -1 +1,47 @@ -.. include:: ../../../en/api-reference/network/index.rst \ No newline at end of file +连网 API +*************** + +:link_to_translation:`en:[English]` + +Wi-Fi +======= + +.. toctree:: + :maxdepth: 1 + + Wi-Fi + Smart Config + ESP-NOW + ESP Mesh + +本部分的 Wi-Fi API 示例代码存放在 ESP-IDF 示例项目的 :example:`wifi` 目录下。 + +ESP-MESH 的示例代码存放在 ESP-IDF 示例项目的 :example:`mesh` 目录下。 + + +以太网 +======== + +.. toctree:: + :maxdepth: 1 + + Ethernet + +本部分的以太网 API 示例代码存放在 ESP-IDF 示例项目的 :example:`ethernet` 目录下。 + + +IP 网络层协议 +================ + +.. toctree:: + :maxdepth: 1 + + TCP/IP Adapter + +TCP/IP 套接字 API 的示例代码存放在 ESP-IDF 示例项目的 :example:`protocols/sockets` 目录下。 + + +应用层协议  +=========== + +应用层网络协议(IP 网络层协议之上)的相关文档存放在 :doc:`../protocols/index`。 diff --git a/docs/zh_CN/api-reference/peripherals/index.rst b/docs/zh_CN/api-reference/peripherals/index.rst index 3ac36bb8e..c985d687e 100644 --- a/docs/zh_CN/api-reference/peripherals/index.rst +++ b/docs/zh_CN/api-reference/peripherals/index.rst @@ -1 +1,30 @@ -.. include:: ../../../en/api-reference/peripherals/index.rst \ No newline at end of file +外设 API +*************** + +:link_to_translation:`en:[English]` + +.. toctree:: + :maxdepth: 1 + + ADC + CAN + DAC + GPIO (including RTC low power I/O) + I2C + I2S + LED Control + MCPWM + Pulse Counter + Remote Control + SDMMC Host + SD SPI Host + SDIO Slave + Sigma-delta Modulation + SPI Master + SPI Slave + Timer + Touch Sensor + UART + +本部分的 API 示例代码存放在 ESP-IDF 示例项目的 :example:`peripherals` 目录下。 + diff --git a/docs/zh_CN/api-reference/provisioning/index.rst b/docs/zh_CN/api-reference/provisioning/index.rst index d7931ed5c..3248660a2 100644 --- a/docs/zh_CN/api-reference/provisioning/index.rst +++ b/docs/zh_CN/api-reference/provisioning/index.rst @@ -1 +1,13 @@ -.. include:: ../../../en/api-reference/provisioning/index.rst +配网 API +**************** + +:link_to_translation:`en:[English]` + +.. toctree:: + :maxdepth: 1 + + Unified Provisioning + Protocol Communication + Wi-Fi Provisioning + +本部分的 API 示例代码存放在 ESP-IDF 示例项目的 :example:`provisioning` 目录下。