alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-09-20 00:36:01 -04:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

docs: Updated CN translation for index files in api-guides and api-reference

Browse Source
This commit is contained in:
Shang Zhou 2021-12-30 18:50:55 +08:00
parent 46d5f92533
commit 33a00cf197
17 changed files with 295 additions and 234 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
docs/en/api-guides/index.rst
View File

@ -3,44 +3,44 @@ API Guides
:link_to_translation:`zh_CN:[中文]` :link_to_translation:`zh_CN:[中文]`
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
Application Level Tracing <app_trace> app_trace
Application Startup Flow <startup> startup
:SOC_BT_SUPPORTED: BluFi <blufi> :SOC_BT_SUPPORTED: blufi
Bootloader <bootloader> bootloader
Build System <build-system> build-system
Deep Sleep Wake Stubs <deep-sleep-stub> core_dump
:SOC_USB_OTG_SUPPORTED: Device Firmware Upgrade through USB <dfu> deep-sleep-stub
Error Handling <error-handling> :SOC_USB_OTG_SUPPORTED: dfu
:SOC_BT_SUPPORTED: ESP-BLE-MESH <esp-ble-mesh/ble-mesh-index> error-handling
ESP-WIFI-MESH <esp-wifi-mesh> :SOC_BT_SUPPORTED: esp-ble-mesh/ble-mesh-index
Core Dump <core_dump> freertos-smp
Event Handling <event-handling> esp-wifi-mesh
:SOC_SPIRAM_SUPPORTED: External SPI-connected RAM <external-ram> event-handling
Fatal Errors <fatal-errors> fatal-errors
Flash Encryption <../security/flash-encryption> ../security/flash-encryption
:esp32s3: Flash and External SPI RAM Configuration <flash_psram_config> :esp32s3: flash_psram_config
FreeRTOS SMP Changes <freertos-smp> hardware-abstraction
Hardware Abstraction <hardware-abstraction> :CONFIG_IDF_TARGET_ARCH_XTENSA: hlinterrupts
:CONFIG_IDF_TARGET_ARCH_XTENSA: High Level Interrupts <hlinterrupts> jtag-debugging/index
JTAG Debugging <jtag-debugging/index> linker-script-generation
Linker Script Generation <linker-script-generation> lwip
Memory Types <memory-types> memory-types
lwIP TCP/IP Stack <lwip> openthread
OpenThread <openthread> partition-tables
Partition Tables <partition-tables> performance/index
Performance <performance/index> :not esp32c2: RF_calibration
:not esp32c2: RF Calibration <RF_calibration> :esp32: ../security/secure-boot-v1
:esp32: Secure Boot <../security/secure-boot-v1> ../security/secure-boot-v2
Secure Boot V2 <../security/secure-boot-v2> :SOC_SPIRAM_SUPPORTED: external-ram
Thread Local Storage <thread-local-storage> thread-local-storage
Tools <tools/index> tools/index
:SOC_ULP_SUPPORTED: ULP Coprocessor <ulp> :SOC_ULP_SUPPORTED: ulp
:SOC_RISCV_COPROC_SUPPORTED: ULP-RISC-V Coprocessor <ulp-risc-v> :SOC_RISCV_COPROC_SUPPORTED: ulp-risc-v
Unit Testing (Target) <unit-tests> unit-tests
Unit Testing (Linux Host) <linux-host-testing> linux-host-testing
:SOC_USB_OTG_SUPPORTED: USB OTG Console <usb-otg-console> :SOC_USB_OTG_SUPPORTED: usb-otg-console
:SOC_USB_SERIAL_JTAG_SUPPORTED: USB Serial/JTAG Controller Console <usb-serial-jtag-console> :SOC_USB_SERIAL_JTAG_SUPPORTED: usb-serial-jtag-console
:SOC_WIFI_SUPPORTED: Wi-Fi Driver <wifi> :SOC_WIFI_SUPPORTED: wifi
:SOC_WIFI_SUPPORTED: Wi-Fi Security <wifi-security> :SOC_WIFI_SUPPORTED: wifi-security

17
docs/en/api-reference/bluetooth/index.rst
View File

@ -6,13 +6,13 @@ Bluetooth API
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
Bluetooth Controller && VHCI <controller_vhci> bt_common
Bluetooth Common <bt_common> bt_le
Bluetooth LE <bt_le> :SOC_CLASSIC_BT_SUPPORTED: classic_bt
:SOC_CLASSIC_BT_SUPPORTED: Bluetooth Classic <classic_bt> controller_vhci
NimBLE <nimble/index> esp-ble-mesh
ESP-BLE-MESH <esp-ble-mesh> nimble/index
ESP-IDF currently supports two host stacks. The Bluedroid based stack (default) supports classic Bluetooth as well as BLE. On the other hand, Apache NimBLE based stack is BLE only. For users to make a choice: ESP-IDF currently supports two host stacks. The Bluedroid based stack (default) supports classic Bluetooth as well as BLE. On the other hand, Apache NimBLE based stack is BLE only. For users to make a choice:
* For usecases involving classic Bluetooth as well as BLE, Bluedroid should be used. * For usecases involving classic Bluetooth as well as BLE, Bluedroid should be used.
@ -22,8 +22,7 @@ ESP-IDF currently supports two host stacks. The Bluedroid based stack (default)
For the overview of the ESP32 Bluetooth stack architecture, follow the 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_en.pdf>`_
* `ESP32 Bluetooth Architecture (PDF) [中文] <http://espressif.com/sites/default/files/documentation/esp32_bluetooth_architecture_cn.pdf>`_
Code examples for this API section are provided in the :example:`bluetooth/bluedroid` directory of ESP-IDF examples. Code examples for this API section are provided in the :example:`bluetooth/bluedroid` directory of ESP-IDF examples.

22
docs/en/api-reference/index.rst
View File

@ -4,15 +4,15 @@ API Reference
:link_to_translation:`zh_CN:[中文]` :link_to_translation:`zh_CN:[中文]`
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:SOC_BT_SUPPORTED: Bluetooth <bluetooth/index> api-conventions
Networking <network/index> protocols/index
Peripherals <peripherals/index> :SOC_BT_SUPPORTED: bluetooth/index
Protocols <protocols/index> error-codes
Provisioning <provisioning/index> network/index
Storage <storage/index> peripherals/index
System <system/index> kconfig
API Conventions <api-conventions> provisioning/index
Configuration Options <kconfig> storage/index
Error Codes Reference <error-codes> system/index

23
docs/en/api-reference/network/index.rst
View File

@ -9,11 +9,11 @@ Wi-Fi
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
Wi-Fi <esp_wifi> esp_now
SmartConfig <esp_smartconfig> esp-wifi-mesh
ESP-NOW <esp_now> esp_smartconfig
ESP-WIFI-MESH <esp-wifi-mesh> esp_wifi
EasyConnect <esp_dpp> esp_dpp
Code examples for the Wi-Fi API are provided in the :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.
@ -26,7 +26,7 @@ Ethernet
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
Ethernet <esp_eth> esp_eth
Code examples for the Ethernet API are provided in the :example:`ethernet` directory of ESP-IDF examples. Code examples for the Ethernet API are provided in the :example:`ethernet` directory of ESP-IDF examples.
@ -36,7 +36,7 @@ Thread
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
Thread <esp_openthread> esp_openthread
Thread is an IPv6-based mesh networking technology for IoT. 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. Code examples for the Thread API are provided in the :example:`openthread` directory of ESP-IDF examples.
@ -47,7 +47,7 @@ ESP-NETIF
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
ESP-NETIF <esp_netif.rst> esp_netif
IP Network Layer IP Network Layer
================ ================
@ -55,13 +55,12 @@ IP Network Layer
.. toctree:: .. toctree::
:hidden: :hidden:
TCP/IP Adapter Migration Guide <tcpip_adapter_migration.rst> tcpip_adapter_migration
ESP-NETIF Custom I/O Driver <esp_netif_driver.rst> esp_netif_driver
Code examples for TCP/IP socket APIs are provided in the :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.
The TCP/IP Adapter (legacy network interface library) has been deprecated, please consult the :doc:`/api-reference/network/tcpip_adapter_migration` 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.
to update existing IDF applications.
Application Layer  Application Layer 
================= =================

30
docs/en/api-reference/protocols/index.rst
View File

@ -5,21 +5,21 @@ Application Protocols
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
ASIO <asio> asio
ESP-MQTT <mqtt> modbus
ESP-TLS <esp_tls> mqtt
OpenSSL APIs <openssl_apis> esp_tls
HTTP Client <esp_http_client> esp_http_client
HTTP Server <esp_http_server> esp_local_ctrl
HTTPS Server <esp_https_server> esp_serial_slave_link
ICMP Echo <icmp_echo> esp_websocket_client
Local Control <esp_local_ctrl> esp_crt_bundle
mDNS <mdns> esp_http_server
Modbus <modbus> esp_https_server
Websocket Client <esp_websocket_client> icmp_echo
ESP Serial Slave Link <esp_serial_slave_link> mdns
Certificate Bundle <esp_crt_bundle> openssl_apis
Code examples for this API section are provided in the :example:`protocols` directory of ESP-IDF examples. Code examples for this API section are provided in the :example:`protocols` directory of ESP-IDF examples.

14
docs/en/api-reference/provisioning/index.rst
View File

@ -6,22 +6,22 @@ Provisioning API
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
Protocol Communication <protocomm> protocomm
Unified Provisioning <provisioning> provisioning
Wi-Fi Provisioning <wifi_provisioning> wifi_provisioning
Code examples for above API are provided in the :example:`provisioning` directory of ESP-IDF examples. Code examples for above API are provided in the :example:`provisioning` directory of ESP-IDF examples.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
SmartConfig <../network/esp_smartconfig> ../network/esp_smartconfig
Code example for above API is provided in :example:`wifi/smart_config` Code example for above API is provided in :example:`wifi/smart_config`.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
EasyConnect <../network/esp_dpp> ../network/esp_dpp
Code example for above API is provided in :example:`wifi/wifi_easy_connect/dpp-enrollee` Code example for above API is provided in :example:`wifi/wifi_easy_connect/dpp-enrollee`.

18
docs/en/api-reference/storage/index.rst
View File

@ -6,15 +6,15 @@ Storage API
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
FAT Filesystem <fatfs> fatfs
Mass Manufacturing Utility <mass_mfg.rst> mass_mfg.rst
Non-Volatile Storage <nvs_flash> nvs_flash
NVS Partition Generation Utility <nvs_partition_gen.rst> nvs_partition_gen.rst
SD/SDIO/MMC Driver <sdmmc> sdmmc
SPI Flash and Partition APIs <spi_flash> spi_flash
SPIFFS Filesystem <spiffs> spiffs
Virtual Filesystem <vfs> vfs
Wear Levelling API <wear-levelling> wear-levelling

60
docs/en/api-reference/system/index.rst
View File

@ -1,37 +1,39 @@
System API System API
********** **********
:link_to_translation:`zh_CN:[中文]`
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
App image format <app_image_format> app_image_format
Application Level Tracing <app_trace> app_trace
:SOC_ASYNC_MEMCPY_SUPPORTED: Async Memory Copy <async_memcpy> esp_function_with_shared_stack
Console Component <console> console
eFuse Manager <efuse> efuse
Error Codes and Helper Functions <esp_err> esp_err
ESP HTTPS OTA <esp_https_ota> esp_https_ota
POSIX Threads Support <pthread> esp_event
Event Loop Library <esp_event> freertos
FreeRTOS <freertos> freertos_additions
FreeRTOS Supplemental Features <freertos_additions> mem_alloc
Heap Memory Allocation <mem_alloc> heap_debug
Heap Memory Debugging <heap_debug> esp_timer
High Resolution Timer <esp_timer> internal-unstable
:esp32: Himem (large external SPI RAM) API <himem> :not CONFIG_FREERTOS_UNICORE: ipc
:not CONFIG_FREERTOS_UNICORE: Inter-Processor Call <ipc> intr_alloc
Call function with external stack <esp_function_with_shared_stack> log
Interrupt Allocation <intr_alloc> system
Logging <log> ota
Miscellaneous System APIs <system> :CONFIG_IDF_TARGET_ARCH_XTENSA: perfmon
Over The Air Updates (OTA) <ota> power_management
:CONFIG_IDF_TARGET_ARCH_XTENSA: Performance Monitor <perfmon> pthread
Power Management <power_management> random
Random Number Generation <random> sleep_modes
Sleep Modes <sleep_modes> system_time
Watchdogs <wdts> :SOC_ASYNC_MEMCPY_SUPPORTED: async_memcpy
System Time <system_time> :esp32: himem
Internal and Unstable API <internal-unstable> wdts
Code examples for this API section are provided in the :example:`system` directory of ESP-IDF examples. Code examples for this API section are provided in the :example:`system` directory of ESP-IDF examples.

2
docs/zh_CN/api-guides/build-system.rst
View File

@ -1,4 +1,4 @@
构建系统（CMake 版） 构建系统
******************** ********************
:link_to_translation:`en:[English]` :link_to_translation:`en:[English]`

78
docs/zh_CN/api-guides/index.rst
View File

@ -5,42 +5,42 @@ API 指南
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
应用层跟踪 <app_trace> app_trace
Application Startup Flow <startup> startup
:SOC_BT_SUPPORTED: BluFi <blufi> :SOC_BT_SUPPORTED: blufi
引导加载程序 <bootloader> bootloader
构建系统 <build-system> build-system
深度睡眠唤醒存根 <deep-sleep-stub> core_dump
:SOC_USB_OTG_SUPPORTED: 通过 USB 升级设备固件 <dfu> deep-sleep-stub
错误处理 <error-handling> :SOC_USB_OTG_SUPPORTED: dfu
:SOC_BT_SUPPORTED: ESP-BLE-MESH <esp-ble-mesh/ble-mesh-index> error-handling
ESP-WIFI-MESH <esp-wifi-mesh> :SOC_BT_SUPPORTED: esp-ble-mesh/ble-mesh-index
核心转储 <core_dump> freertos-smp
事件处理 <event-handling> esp-wifi-mesh
:SOC_SPIRAM_SUPPORTED: 片外 SPI RAM <external-ram> event-handling
严重错误 <fatal-errors> fatal-errors
Flash 加密 <../security/flash-encryption> ../security/flash-encryption
:esp32s3: Flash and External SPI RAM Configuration <flash_psram_config> :esp32s3: flash_psram_config
FreeRTOS SMP 变化 <freertos-smp> hardware-abstraction
硬件抽象层 <hardware-abstraction> :CONFIG_IDF_TARGET_ARCH_XTENSA: hlinterrupts
:CONFIG_IDF_TARGET_ARCH_XTENSA: 高层中断 <hlinterrupts> jtag-debugging/index
JTAG 调试 <jtag-debugging/index> linker-script-generation
链接脚本生成机制 <linker-script-generation> lwip
lwIP TCP/IP 协议栈 <lwip> memory-types
OpenThread <openthread> openthread
Memory Types <memory-types> partition-tables
分区表 <partition-tables> performance/index
Performance <performance/index> :not esp32c2: RF_calibration
:not esp32c2: 射频校准 <RF_calibration> :esp32: ../security/secure-boot-v1
:esp32: 安全启动 <../security/secure-boot-v1> ../security/secure-boot-v2
安全启动 V2 <../security/secure-boot-v2> :SOC_SPIRAM_SUPPORTED: external-ram
线程本地存储 <thread-local-storage> thread-local-storage
工具 <tools/index> tools/index
:SOC_ULP_SUPPORTED: ULP 协处理器 <ulp> :SOC_ULP_SUPPORTED: ulp
:SOC_RISCV_COPROC_SUPPORTED: ULP-RISC-V 协处理器 <ulp-risc-v> :SOC_RISCV_COPROC_SUPPORTED: ulp-risc-v
单元测试 (Target) <unit-tests> unit-tests
单元测试 (Linux Host) <linux-host-testing> linux-host-testing
:SOC_USB_OTG_SUPPORTED: USB 控制台 <usb-otg-console> :SOC_USB_OTG_SUPPORTED: usb-otg-console
:SOC_USB_SERIAL_JTAG_SUPPORTED: USB Serial/JTAG Controller Console <usb-serial-jtag-console> :SOC_USB_SERIAL_JTAG_SUPPORTED: usb-serial-jtag-console
:SOC_WIFI_SUPPORTED: Wi-Fi 驱动 <wifi> :SOC_WIFI_SUPPORTED: wifi
:SOC_WIFI_SUPPORTED: Wi-Fi Security <wifi-security> :SOC_WIFI_SUPPORTED: wifi-security

23
docs/zh_CN/api-reference/bluetooth/index.rst
View File

@ -6,20 +6,25 @@
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
Bluetooth Controller && VHCI <controller_vhci> bt_common
Bluetooth Common <bt_common> bt_le
Bluetooth LE <bt_le> :SOC_CLASSIC_BT_SUPPORTED: classic_bt
:SOC_CLASSIC_BT_SUPPORTED: Bluetooth Classic <classic_bt> controller_vhci
NimBLE <nimble/index> esp-ble-mesh
ESP-BLE-MESH <esp-ble-mesh> nimble/index
ESP-IDF 目前支持两个主机堆栈。基于 Bluedroid 的堆栈（默认）支持传统蓝牙和 BLE，而基于 Apache NimBLE 的堆栈仅支持 BLE。用户可参考如下信息进行选择：
* 对于同时涉及传统蓝牙和 BLE 的用例，应该选用 Bluedroid。
* 对于仅涉及 BLE 的用例，建议选用 NimBLE。在代码占用和运行时，NimBLE 对内存的要求较低，因此适用于此类场景。
.. only:: esp32 .. only:: esp32
请点击下方链接，查看 ESP32 蓝牙架构： 请点击下方链接，查看 ESP32 蓝牙架构：
`ESP32 蓝牙架构 (PDF) <http://espressif.com/sites/default/files/documentation/esp32_bluetooth_architecture_cn.pdf>`_ * `ESP32 蓝牙架构 (PDF) <http://espressif.com/sites/default/files/documentation/esp32_bluetooth_architecture_cn.pdf>`_
蓝牙 API 的示例代码存放于 ESP-IDF :example:`bluetooth/bluedroid` 示例目录下，请查看。 蓝牙 API 的示例代码存放于 ESP-IDF 示例项目的 :example:`bluetooth/bluedroid` 目录下。
下面的示例给出了详细介绍： 下面的示例给出了详细介绍：

20
docs/zh_CN/api-reference/index.rst
View File

@ -6,13 +6,13 @@ API 参考
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:SOC_BT_SUPPORTED: 蓝牙 <bluetooth/index> api-conventions
连网 <network/index> protocols/index
外设 <peripherals/index> :SOC_BT_SUPPORTED: bluetooth/index
协议 <protocols/index> error-codes
配网 <provisioning/index> network/index
存储 <storage/index> peripherals/index
System <system/index> kconfig
API Conventions <api-conventions> provisioning/index
Configuration Options <kconfig> storage/index
Error Codes Reference <error-codes> system/index

30
docs/zh_CN/api-reference/network/index.rst
View File

@ -4,16 +4,16 @@
:link_to_translation:`en:[English]` :link_to_translation:`en:[English]`
Wi-Fi Wi-Fi
======= =====
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
Wi-Fi <esp_wifi> esp_now
Smart Config <esp_smartconfig> esp-wifi-mesh
ESP-NOW <esp_now> esp_smartconfig
ESP-WIFI-MESH <esp-wifi-mesh> esp_wifi
EasyConnect <esp_dpp> esp_dpp
本部分的 Wi-Fi API 示例代码存放在 ESP-IDF 示例项目的 :example:`wifi` 目录下。 本部分的 Wi-Fi API 示例代码存放在 ESP-IDF 示例项目的 :example:`wifi` 目录下。
@ -26,7 +26,7 @@ ESP-WIFI-MESH 的示例代码存放在 ESP-IDF 示例项目的 :example:`mesh`
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
Ethernet <esp_eth> esp_eth
本部分的以太网 API 示例代码存放在 ESP-IDF 示例项目的 :example:`ethernet` 目录下。 本部分的以太网 API 示例代码存放在 ESP-IDF 示例项目的 :example:`ethernet` 目录下。
@ -36,29 +36,33 @@ Thread
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
Thread <esp_openthread> esp_openthread
Thread 是一种基于 IPv6 的物联网网状网络技术。
本部分的Thread API 示例代码存放在 ESP-IDF 示例项目的 :example:`openthread` 目录下。 本部分的Thread API 示例代码存放在 ESP-IDF 示例项目的 :example:`openthread` 目录下。
IP 网络层协议 IP 网络层协议
================ ================
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
ESP-NETIF <esp_netif.rst> esp_netif
IP 网络层协议
================
.. toctree:: .. toctree::
:hidden: :hidden:
TCP/IP Adapter Migration Guide <tcpip_adapter_migration.rst> tcpip_adapter_migration
ESP-NETIF Custom I/O Driver <esp_netif_driver.rst> esp_netif_driver
TCP/IP 套接字 API 的示例代码存放在 ESP-IDF 示例项目的 :example:`protocols/sockets` 目录下。 TCP/IP 套接字 API 的示例代码存放在 ESP-IDF 示例项目的 :example:`protocols/sockets` 目录下。
目前已不再使用 TCP/IP 适配器（旧式网络接口库），请参考 :doc:`/api-reference/network/tcpip_adapter_migration` 来更新现有的 IDF 应用程序。
应用层协议  应用层协议 
=========== ===========
应用层网络协议（IP 网络层协议之上）的相关文档存放在 :doc:`../protocols/index`。 应用层网络协议（IP 网络层协议之上）的相关文档存放在 :doc:`../protocols/index` 目录下。

32
docs/zh_CN/api-reference/protocols/index.rst
View File

@ -5,25 +5,25 @@
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
mDNS <mdns> asio
ESP-TLS <esp_tls> modbus
OpenSSL APIs <openssl_apis> mqtt
HTTP Client <esp_http_client> esp_tls
Websocket Client <esp_websocket_client> esp_http_client
HTTP 服务器 <esp_http_server> esp_local_ctrl
HTTPS Server <esp_https_server> esp_serial_slave_link
ICMP Echo <icmp_echo> esp_websocket_client
ASIO <asio> esp_crt_bundle
ESP-MQTT <mqtt> esp_http_server
Modbus slave <modbus> esp_https_server
Local Control <esp_local_ctrl> icmp_echo
ESP Serial Slave Link <esp_serial_slave_link> mdns
Certificate Bundle <esp_crt_bundle> openssl_apis
此 API 部分的示例代码在 ESP-IDF 示例工程的 :example:`protocols` 目录下提供。 此 API 部分的示例代码存放在 ESP-IDF 示例项目的 :example:`protocols` 目录下。
IP 网络层协议 IP 网络层协议
============= =============
IP 网络层协议（应用层协议之下）的文档位于 :doc:`../network/index` 。 IP 网络层协议（应用层协议之下）的文档存放在 :doc:`../network/index` 目录下。

20
docs/zh_CN/api-reference/provisioning/index.rst
View File

@ -6,8 +6,22 @@
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
Unified Provisioning <provisioning> protocomm
Protocol Communication <protocomm> provisioning
Wi-Fi Provisioning <wifi_provisioning> wifi_provisioning
本部分的 API 示例代码存放在 ESP-IDF 示例项目的 :example:`provisioning` 目录下。 本部分的 API 示例代码存放在 ESP-IDF 示例项目的 :example:`provisioning` 目录下。
.. toctree::
:maxdepth: 1
../network/esp_smartconfig
本部分的 API 示例代码存放在 :example:`wifi/smart_config` 目录下。
.. toctree::
:maxdepth: 1
../network/esp_dpp
本部分的 API 示例代码存放在 :example:`wifi/wifi_easy_connect/dpp-enrollee` 目录下。

20
docs/zh_CN/api-reference/storage/index.rst
View File

@ -6,16 +6,16 @@
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
FAT 文件系统 <fatfs> fatfs
量产程序 <mass_mfg.rst> mass_mfg.rst
非易失性存储库 <nvs_flash> nvs_flash
NVS 分区生成程序 <nvs_partition_gen.rst> nvs_partition_gen.rst
SD/SDIO/MMC 驱动程序 <sdmmc> sdmmc
SPI Flash API <spi_flash> spi_flash
SPIFFS 文件系统 <spiffs> spiffs
虚拟文件系统组件 <vfs> vfs
磨损均衡 API <wear-levelling> wear-levelling
此部分 API 代码示例详见 ESP-IDF 项下 :example:`storage` 目录。 此部分 API 代码示例存放在 ESP-IDF 示例项目的 :example:`storage` 目录下。

40
docs/zh_CN/api-reference/system/index.rst
View File

@ -1 +1,39 @@
.. include:: ../../../en/api-reference/system/index.rst System API
**********
:link_to_translation:`en:[English]`
.. toctree::
:maxdepth: 1
app_image_format
app_trace
esp_function_with_shared_stack
console
efuse
esp_err
esp_https_ota
esp_event
freertos
freertos_additions
mem_alloc
heap_debug
esp_timer
internal-unstable
:not CONFIG_FREERTOS_UNICORE: ipc
intr_alloc
log
system
ota
:CONFIG_IDF_TARGET_ARCH_XTENSA: perfmon
power_management
pthread
random
sleep_modes
system_time
:SOC_ASYNC_MEMCPY_SUPPORTED: async_memcpy
:esp32: himem
wdts
此部分 API 代码示例存放在 ESP-IDF 示例项目的 :example:`system` 目录下。