mirror of
https://github.com/espressif/esp-idf
synced 2025-03-09 17:19:09 -04:00
docs: Updated CN translation for index files in api-guides and api-reference
This commit is contained in:
Shang Zhou
parent
46d5f92533
commit
33a00cf197
@ -3,44 +3,44 @@ API Guides
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:maxdepth: 1
|
||||
|
||||
Application Level Tracing <app_trace>
|
||||
Application Startup Flow <startup>
|
||||
:SOC_BT_SUPPORTED: BluFi <blufi>
|
||||
Bootloader <bootloader>
|
||||
Build System <build-system>
|
||||
Deep Sleep Wake Stubs <deep-sleep-stub>
|
||||
:SOC_USB_OTG_SUPPORTED: Device Firmware Upgrade through USB <dfu>
|
||||
Error Handling <error-handling>
|
||||
:SOC_BT_SUPPORTED: ESP-BLE-MESH <esp-ble-mesh/ble-mesh-index>
|
||||
ESP-WIFI-MESH <esp-wifi-mesh>
|
||||
Core Dump <core_dump>
|
||||
Event Handling <event-handling>
|
||||
:SOC_SPIRAM_SUPPORTED: External SPI-connected RAM <external-ram>
|
||||
Fatal Errors <fatal-errors>
|
||||
Flash Encryption <../security/flash-encryption>
|
||||
:esp32s3: Flash and External SPI RAM Configuration <flash_psram_config>
|
||||
FreeRTOS SMP Changes <freertos-smp>
|
||||
Hardware Abstraction <hardware-abstraction>
|
||||
:CONFIG_IDF_TARGET_ARCH_XTENSA: High Level Interrupts <hlinterrupts>
|
||||
JTAG Debugging <jtag-debugging/index>
|
||||
Linker Script Generation <linker-script-generation>
|
||||
Memory Types <memory-types>
|
||||
lwIP TCP/IP Stack <lwip>
|
||||
OpenThread <openthread>
|
||||
Partition Tables <partition-tables>
|
||||
Performance <performance/index>
|
||||
:not esp32c2: RF Calibration <RF_calibration>
|
||||
:esp32: Secure Boot <../security/secure-boot-v1>
|
||||
Secure Boot V2 <../security/secure-boot-v2>
|
||||
Thread Local Storage <thread-local-storage>
|
||||
Tools <tools/index>
|
||||
:SOC_ULP_SUPPORTED: ULP Coprocessor <ulp>
|
||||
:SOC_RISCV_COPROC_SUPPORTED: ULP-RISC-V Coprocessor <ulp-risc-v>
|
||||
Unit Testing (Target) <unit-tests>
|
||||
Unit Testing (Linux Host) <linux-host-testing>
|
||||
:SOC_USB_OTG_SUPPORTED: USB OTG Console <usb-otg-console>
|
||||
:SOC_USB_SERIAL_JTAG_SUPPORTED: USB Serial/JTAG Controller Console <usb-serial-jtag-console>
|
||||
:SOC_WIFI_SUPPORTED: Wi-Fi Driver <wifi>
|
||||
:SOC_WIFI_SUPPORTED: Wi-Fi Security <wifi-security>
|
||||
app_trace
|
||||
startup
|
||||
:SOC_BT_SUPPORTED: blufi
|
||||
bootloader
|
||||
build-system
|
||||
core_dump
|
||||
deep-sleep-stub
|
||||
:SOC_USB_OTG_SUPPORTED: dfu
|
||||
error-handling
|
||||
:SOC_BT_SUPPORTED: esp-ble-mesh/ble-mesh-index
|
||||
freertos-smp
|
||||
esp-wifi-mesh
|
||||
event-handling
|
||||
fatal-errors
|
||||
../security/flash-encryption
|
||||
:esp32s3: flash_psram_config
|
||||
hardware-abstraction
|
||||
:CONFIG_IDF_TARGET_ARCH_XTENSA: hlinterrupts
|
||||
jtag-debugging/index
|
||||
linker-script-generation
|
||||
lwip
|
||||
memory-types
|
||||
openthread
|
||||
partition-tables
|
||||
performance/index
|
||||
:not esp32c2: RF_calibration
|
||||
:esp32: ../security/secure-boot-v1
|
||||
../security/secure-boot-v2
|
||||
:SOC_SPIRAM_SUPPORTED: external-ram
|
||||
thread-local-storage
|
||||
tools/index
|
||||
:SOC_ULP_SUPPORTED: ulp
|
||||
:SOC_RISCV_COPROC_SUPPORTED: ulp-risc-v
|
||||
unit-tests
|
||||
linux-host-testing
|
||||
:SOC_USB_OTG_SUPPORTED: usb-otg-console
|
||||
:SOC_USB_SERIAL_JTAG_SUPPORTED: usb-serial-jtag-console
|
||||
:SOC_WIFI_SUPPORTED: wifi
|
||||
:SOC_WIFI_SUPPORTED: wifi-security
|
||||
@ -6,13 +6,13 @@ Bluetooth API
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
Bluetooth Controller && VHCI <controller_vhci>
|
||||
Bluetooth Common <bt_common>
|
||||
Bluetooth LE <bt_le>
|
||||
:SOC_CLASSIC_BT_SUPPORTED: Bluetooth Classic <classic_bt>
|
||||
NimBLE <nimble/index>
|
||||
ESP-BLE-MESH <esp-ble-mesh>
|
||||
|
||||
bt_common
|
||||
bt_le
|
||||
:SOC_CLASSIC_BT_SUPPORTED: classic_bt
|
||||
controller_vhci
|
||||
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:
|
||||
|
||||
* 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:
|
||||
|
||||
* `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_cn.pdf>`_
|
||||
* `ESP32 Bluetooth Architecture (PDF) <http://espressif.com/sites/default/files/documentation/esp32_bluetooth_architecture_en.pdf>`_
|
||||
|
||||
Code examples for this API section are provided in the :example:`bluetooth/bluedroid` directory of ESP-IDF examples.
|
||||
|
||||
|
||||
@ -4,15 +4,15 @@ API Reference
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:maxdepth: 2
|
||||
|
||||
:SOC_BT_SUPPORTED: Bluetooth <bluetooth/index>
|
||||
Networking <network/index>
|
||||
Peripherals <peripherals/index>
|
||||
Protocols <protocols/index>
|
||||
Provisioning <provisioning/index>
|
||||
Storage <storage/index>
|
||||
System <system/index>
|
||||
API Conventions <api-conventions>
|
||||
Configuration Options <kconfig>
|
||||
Error Codes Reference <error-codes>
|
||||
api-conventions
|
||||
protocols/index
|
||||
:SOC_BT_SUPPORTED: bluetooth/index
|
||||
error-codes
|
||||
network/index
|
||||
peripherals/index
|
||||
kconfig
|
||||
provisioning/index
|
||||
storage/index
|
||||
system/index
|
||||
@ -9,11 +9,11 @@ Wi-Fi
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Wi-Fi <esp_wifi>
|
||||
SmartConfig <esp_smartconfig>
|
||||
ESP-NOW <esp_now>
|
||||
ESP-WIFI-MESH <esp-wifi-mesh>
|
||||
EasyConnect <esp_dpp>
|
||||
esp_now
|
||||
esp-wifi-mesh
|
||||
esp_smartconfig
|
||||
esp_wifi
|
||||
esp_dpp
|
||||
|
||||
Code examples for the Wi-Fi API are provided in the :example:`wifi` directory of ESP-IDF examples.
|
||||
|
||||
@ -26,7 +26,7 @@ Ethernet
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Ethernet <esp_eth>
|
||||
esp_eth
|
||||
|
||||
Code examples for the Ethernet API are provided in the :example:`ethernet` directory of ESP-IDF examples.
|
||||
|
||||
@ -36,7 +36,7 @@ Thread
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Thread <esp_openthread>
|
||||
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.
|
||||
@ -47,7 +47,7 @@ ESP-NETIF
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
ESP-NETIF <esp_netif.rst>
|
||||
esp_netif
|
||||
|
||||
IP Network Layer
|
||||
================
|
||||
@ -55,13 +55,12 @@ IP Network Layer
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
TCP/IP Adapter Migration Guide <tcpip_adapter_migration.rst>
|
||||
ESP-NETIF Custom I/O Driver <esp_netif_driver.rst>
|
||||
tcpip_adapter_migration
|
||||
esp_netif_driver
|
||||
|
||||
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.
|
||||
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
|
||||
=================
|
||||
|
||||
@ -5,21 +5,21 @@ Application Protocols
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
ASIO <asio>
|
||||
ESP-MQTT <mqtt>
|
||||
ESP-TLS <esp_tls>
|
||||
OpenSSL APIs <openssl_apis>
|
||||
HTTP Client <esp_http_client>
|
||||
HTTP Server <esp_http_server>
|
||||
HTTPS Server <esp_https_server>
|
||||
ICMP Echo <icmp_echo>
|
||||
Local Control <esp_local_ctrl>
|
||||
mDNS <mdns>
|
||||
Modbus <modbus>
|
||||
Websocket Client <esp_websocket_client>
|
||||
ESP Serial Slave Link <esp_serial_slave_link>
|
||||
Certificate Bundle <esp_crt_bundle>
|
||||
|
||||
asio
|
||||
modbus
|
||||
mqtt
|
||||
esp_tls
|
||||
esp_http_client
|
||||
esp_local_ctrl
|
||||
esp_serial_slave_link
|
||||
esp_websocket_client
|
||||
esp_crt_bundle
|
||||
esp_http_server
|
||||
esp_https_server
|
||||
icmp_echo
|
||||
mdns
|
||||
openssl_apis
|
||||
|
||||
Code examples for this API section are provided in the :example:`protocols` directory of ESP-IDF examples.
|
||||
|
||||
|
||||
|
||||
@ -6,22 +6,22 @@ Provisioning API
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Protocol Communication <protocomm>
|
||||
Unified Provisioning <provisioning>
|
||||
Wi-Fi Provisioning <wifi_provisioning>
|
||||
protocomm
|
||||
provisioning
|
||||
wifi_provisioning
|
||||
|
||||
Code examples for above API are provided in the :example:`provisioning` directory of ESP-IDF examples.
|
||||
|
||||
.. toctree::
|
||||
: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::
|
||||
: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`.
|
||||
|
||||
@ -6,15 +6,15 @@ Storage API
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
FAT Filesystem <fatfs>
|
||||
Mass Manufacturing Utility <mass_mfg.rst>
|
||||
Non-Volatile Storage <nvs_flash>
|
||||
NVS Partition Generation Utility <nvs_partition_gen.rst>
|
||||
SD/SDIO/MMC Driver <sdmmc>
|
||||
SPI Flash and Partition APIs <spi_flash>
|
||||
SPIFFS Filesystem <spiffs>
|
||||
Virtual Filesystem <vfs>
|
||||
Wear Levelling API <wear-levelling>
|
||||
fatfs
|
||||
mass_mfg.rst
|
||||
nvs_flash
|
||||
nvs_partition_gen.rst
|
||||
sdmmc
|
||||
spi_flash
|
||||
spiffs
|
||||
vfs
|
||||
wear-levelling
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,37 +1,39 @@
|
||||
System API
|
||||
**********
|
||||
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
App image format <app_image_format>
|
||||
Application Level Tracing <app_trace>
|
||||
:SOC_ASYNC_MEMCPY_SUPPORTED: Async Memory Copy <async_memcpy>
|
||||
Console Component <console>
|
||||
eFuse Manager <efuse>
|
||||
Error Codes and Helper Functions <esp_err>
|
||||
ESP HTTPS OTA <esp_https_ota>
|
||||
POSIX Threads Support <pthread>
|
||||
Event Loop Library <esp_event>
|
||||
FreeRTOS <freertos>
|
||||
FreeRTOS Supplemental Features <freertos_additions>
|
||||
Heap Memory Allocation <mem_alloc>
|
||||
Heap Memory Debugging <heap_debug>
|
||||
High Resolution Timer <esp_timer>
|
||||
:esp32: Himem (large external SPI RAM) API <himem>
|
||||
:not CONFIG_FREERTOS_UNICORE: Inter-Processor Call <ipc>
|
||||
Call function with external stack <esp_function_with_shared_stack>
|
||||
Interrupt Allocation <intr_alloc>
|
||||
Logging <log>
|
||||
Miscellaneous System APIs <system>
|
||||
Over The Air Updates (OTA) <ota>
|
||||
:CONFIG_IDF_TARGET_ARCH_XTENSA: Performance Monitor <perfmon>
|
||||
Power Management <power_management>
|
||||
Random Number Generation <random>
|
||||
Sleep Modes <sleep_modes>
|
||||
Watchdogs <wdts>
|
||||
System Time <system_time>
|
||||
Internal and Unstable API <internal-unstable>
|
||||
|
||||
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
|
||||
|
||||
|
||||
Code examples for this API section are provided in the :example:`system` directory of ESP-IDF examples.
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
构建系统（CMake 版）
|
||||
构建系统
|
||||
********************
|
||||
|
||||
:link_to_translation:`en:[English]`
|
||||
|
||||
@ -5,42 +5,42 @@ API 指南
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
应用层跟踪 <app_trace>
|
||||
Application Startup Flow <startup>
|
||||
:SOC_BT_SUPPORTED: BluFi <blufi>
|
||||
引导加载程序 <bootloader>
|
||||
构建系统 <build-system>
|
||||
深度睡眠唤醒存根 <deep-sleep-stub>
|
||||
:SOC_USB_OTG_SUPPORTED: 通过 USB 升级设备固件 <dfu>
|
||||
错误处理 <error-handling>
|
||||
:SOC_BT_SUPPORTED: ESP-BLE-MESH <esp-ble-mesh/ble-mesh-index>
|
||||
ESP-WIFI-MESH <esp-wifi-mesh>
|
||||
核心转储 <core_dump>
|
||||
事件处理 <event-handling>
|
||||
:SOC_SPIRAM_SUPPORTED: 片外 SPI RAM <external-ram>
|
||||
严重错误 <fatal-errors>
|
||||
Flash 加密 <../security/flash-encryption>
|
||||
:esp32s3: Flash and External SPI RAM Configuration <flash_psram_config>
|
||||
FreeRTOS SMP 变化 <freertos-smp>
|
||||
硬件抽象层 <hardware-abstraction>
|
||||
:CONFIG_IDF_TARGET_ARCH_XTENSA: 高层中断 <hlinterrupts>
|
||||
JTAG 调试 <jtag-debugging/index>
|
||||
链接脚本生成机制 <linker-script-generation>
|
||||
lwIP TCP/IP 协议栈 <lwip>
|
||||
OpenThread <openthread>
|
||||
Memory Types <memory-types>
|
||||
分区表 <partition-tables>
|
||||
Performance <performance/index>
|
||||
:not esp32c2: 射频校准 <RF_calibration>
|
||||
:esp32: 安全启动 <../security/secure-boot-v1>
|
||||
安全启动 V2 <../security/secure-boot-v2>
|
||||
线程本地存储 <thread-local-storage>
|
||||
工具 <tools/index>
|
||||
:SOC_ULP_SUPPORTED: ULP 协处理器 <ulp>
|
||||
:SOC_RISCV_COPROC_SUPPORTED: ULP-RISC-V 协处理器 <ulp-risc-v>
|
||||
单元测试 (Target) <unit-tests>
|
||||
单元测试 (Linux Host) <linux-host-testing>
|
||||
:SOC_USB_OTG_SUPPORTED: USB 控制台 <usb-otg-console>
|
||||
:SOC_USB_SERIAL_JTAG_SUPPORTED: USB Serial/JTAG Controller Console <usb-serial-jtag-console>
|
||||
:SOC_WIFI_SUPPORTED: Wi-Fi 驱动 <wifi>
|
||||
:SOC_WIFI_SUPPORTED: Wi-Fi Security <wifi-security>
|
||||
app_trace
|
||||
startup
|
||||
:SOC_BT_SUPPORTED: blufi
|
||||
bootloader
|
||||
build-system
|
||||
core_dump
|
||||
deep-sleep-stub
|
||||
:SOC_USB_OTG_SUPPORTED: dfu
|
||||
error-handling
|
||||
:SOC_BT_SUPPORTED: esp-ble-mesh/ble-mesh-index
|
||||
freertos-smp
|
||||
esp-wifi-mesh
|
||||
event-handling
|
||||
fatal-errors
|
||||
../security/flash-encryption
|
||||
:esp32s3: flash_psram_config
|
||||
hardware-abstraction
|
||||
:CONFIG_IDF_TARGET_ARCH_XTENSA: hlinterrupts
|
||||
jtag-debugging/index
|
||||
linker-script-generation
|
||||
lwip
|
||||
memory-types
|
||||
openthread
|
||||
partition-tables
|
||||
performance/index
|
||||
:not esp32c2: RF_calibration
|
||||
:esp32: ../security/secure-boot-v1
|
||||
../security/secure-boot-v2
|
||||
:SOC_SPIRAM_SUPPORTED: external-ram
|
||||
thread-local-storage
|
||||
tools/index
|
||||
:SOC_ULP_SUPPORTED: ulp
|
||||
:SOC_RISCV_COPROC_SUPPORTED: ulp-risc-v
|
||||
unit-tests
|
||||
linux-host-testing
|
||||
:SOC_USB_OTG_SUPPORTED: usb-otg-console
|
||||
:SOC_USB_SERIAL_JTAG_SUPPORTED: usb-serial-jtag-console
|
||||
:SOC_WIFI_SUPPORTED: wifi
|
||||
:SOC_WIFI_SUPPORTED: wifi-security
|
||||
@ -6,20 +6,25 @@
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
Bluetooth Controller && VHCI <controller_vhci>
|
||||
Bluetooth Common <bt_common>
|
||||
Bluetooth LE <bt_le>
|
||||
:SOC_CLASSIC_BT_SUPPORTED: Bluetooth Classic <classic_bt>
|
||||
NimBLE <nimble/index>
|
||||
ESP-BLE-MESH <esp-ble-mesh>
|
||||
bt_common
|
||||
bt_le
|
||||
:SOC_CLASSIC_BT_SUPPORTED: classic_bt
|
||||
controller_vhci
|
||||
esp-ble-mesh
|
||||
nimble/index
|
||||
|
||||
ESP-IDF 目前支持两个主机堆栈。基于 Bluedroid 的堆栈（默认）支持传统蓝牙和 BLE，而基于 Apache NimBLE 的堆栈仅支持 BLE。用户可参考如下信息进行选择：
|
||||
|
||||
* 对于同时涉及传统蓝牙和 BLE 的用例，应该选用 Bluedroid。
|
||||
* 对于仅涉及 BLE 的用例，建议选用 NimBLE。在代码占用和运行时，NimBLE 对内存的要求较低，因此适用于此类场景。
|
||||
|
||||
.. 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` 目录下。
|
||||
|
||||
下面的示例给出了详细介绍：
|
||||
|
||||
|
||||
@ -6,13 +6,13 @@ API 参考
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
:SOC_BT_SUPPORTED: 蓝牙 <bluetooth/index>
|
||||
连网 <network/index>
|
||||
外设 <peripherals/index>
|
||||
协议 <protocols/index>
|
||||
配网 <provisioning/index>
|
||||
存储 <storage/index>
|
||||
System <system/index>
|
||||
API Conventions <api-conventions>
|
||||
Configuration Options <kconfig>
|
||||
Error Codes Reference <error-codes>
|
||||
api-conventions
|
||||
protocols/index
|
||||
:SOC_BT_SUPPORTED: bluetooth/index
|
||||
error-codes
|
||||
network/index
|
||||
peripherals/index
|
||||
kconfig
|
||||
provisioning/index
|
||||
storage/index
|
||||
system/index
|
||||
@ -4,16 +4,16 @@
|
||||
:link_to_translation:`en:[English]`
|
||||
|
||||
Wi-Fi
|
||||
=======
|
||||
=====
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Wi-Fi <esp_wifi>
|
||||
Smart Config <esp_smartconfig>
|
||||
ESP-NOW <esp_now>
|
||||
ESP-WIFI-MESH <esp-wifi-mesh>
|
||||
EasyConnect <esp_dpp>
|
||||
esp_now
|
||||
esp-wifi-mesh
|
||||
esp_smartconfig
|
||||
esp_wifi
|
||||
esp_dpp
|
||||
|
||||
本部分的 Wi-Fi API 示例代码存放在 ESP-IDF 示例项目的 :example:`wifi` 目录下。
|
||||
|
||||
@ -26,7 +26,7 @@ ESP-WIFI-MESH 的示例代码存放在 ESP-IDF 示例项目的 :example:`mesh`
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Ethernet <esp_eth>
|
||||
esp_eth
|
||||
|
||||
本部分的以太网 API 示例代码存放在 ESP-IDF 示例项目的 :example:`ethernet` 目录下。
|
||||
|
||||
@ -36,29 +36,33 @@ Thread
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Thread <esp_openthread>
|
||||
esp_openthread
|
||||
|
||||
Thread 是一种基于 IPv6 的物联网网状网络技术。
|
||||
本部分的Thread API 示例代码存放在 ESP-IDF 示例项目的 :example:`openthread` 目录下。
|
||||
|
||||
|
||||
IP 网络层协议
|
||||
================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
ESP-NETIF <esp_netif.rst>
|
||||
esp_netif
|
||||
|
||||
IP 网络层协议
|
||||
================
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
TCP/IP Adapter Migration Guide <tcpip_adapter_migration.rst>
|
||||
ESP-NETIF Custom I/O Driver <esp_netif_driver.rst>
|
||||
tcpip_adapter_migration
|
||||
esp_netif_driver
|
||||
|
||||
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` 目录下。
|
||||
|
||||
@ -5,25 +5,25 @@
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
mDNS <mdns>
|
||||
ESP-TLS <esp_tls>
|
||||
OpenSSL APIs <openssl_apis>
|
||||
HTTP Client <esp_http_client>
|
||||
Websocket Client <esp_websocket_client>
|
||||
HTTP 服务器 <esp_http_server>
|
||||
HTTPS Server <esp_https_server>
|
||||
ICMP Echo <icmp_echo>
|
||||
ASIO <asio>
|
||||
ESP-MQTT <mqtt>
|
||||
Modbus slave <modbus>
|
||||
Local Control <esp_local_ctrl>
|
||||
ESP Serial Slave Link <esp_serial_slave_link>
|
||||
Certificate Bundle <esp_crt_bundle>
|
||||
asio
|
||||
modbus
|
||||
mqtt
|
||||
esp_tls
|
||||
esp_http_client
|
||||
esp_local_ctrl
|
||||
esp_serial_slave_link
|
||||
esp_websocket_client
|
||||
esp_crt_bundle
|
||||
esp_http_server
|
||||
esp_https_server
|
||||
icmp_echo
|
||||
mdns
|
||||
openssl_apis
|
||||
|
||||
此 API 部分的示例代码在 ESP-IDF 示例工程的 :example:`protocols` 目录下提供。
|
||||
此 API 部分的示例代码存放在 ESP-IDF 示例项目的 :example:`protocols` 目录下。
|
||||
|
||||
|
||||
IP 网络层协议
|
||||
=============
|
||||
|
||||
IP 网络层协议（应用层协议之下）的文档位于 :doc:`../network/index` 。
|
||||
IP 网络层协议（应用层协议之下）的文档存放在 :doc:`../network/index` 目录下。
|
||||
|
||||
@ -6,8 +6,22 @@
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Unified Provisioning <provisioning>
|
||||
Protocol Communication <protocomm>
|
||||
Wi-Fi Provisioning <wifi_provisioning>
|
||||
protocomm
|
||||
provisioning
|
||||
wifi_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` 目录下。
|
||||
|
||||
@ -6,16 +6,16 @@
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
FAT 文件系统 <fatfs>
|
||||
量产程序 <mass_mfg.rst>
|
||||
非易失性存储库 <nvs_flash>
|
||||
NVS 分区生成程序 <nvs_partition_gen.rst>
|
||||
SD/SDIO/MMC 驱动程序 <sdmmc>
|
||||
SPI Flash API <spi_flash>
|
||||
SPIFFS 文件系统 <spiffs>
|
||||
虚拟文件系统组件 <vfs>
|
||||
磨损均衡 API <wear-levelling>
|
||||
fatfs
|
||||
mass_mfg.rst
|
||||
nvs_flash
|
||||
nvs_partition_gen.rst
|
||||
sdmmc
|
||||
spi_flash
|
||||
spiffs
|
||||
vfs
|
||||
wear-levelling
|
||||
|
||||
|
||||
|
||||
此部分 API 代码示例详见 ESP-IDF 项下 :example:`storage` 目录。
|
||||
此部分 API 代码示例存放在 ESP-IDF 示例项目的 :example:`storage` 目录下。
|
||||
|
||||
@ -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` 目录下。
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user