esp-idf/docs/zh_CN/api-guides/index.rst

API 指南
**********
:link_to_translation:`en:[English]`

.. 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 esp8684: 射频校准 <RF_calibration>
   :esp32: 安全启动 <../security/secure-boot-v1>
   安全启动 V2 <../security/secure-boot-v2>
   线程本地存储 <thread-local-storage>
   工具 <tools/index>
   :SOC_ULP_SUPPORTED: ULP 协处理器 <ulp>
   :esp32s2: 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>
doc/general_notes:translate from en to zh_CN translate the document [general-notes] into Chinese 2018-07-27 06:11:30 -04:00			`API 指南`
Update index.rst 2018-05-17 04:42:17 -04:00			`**********`
Included missing links between English and Chinese documentation, where translation into Chinese is available 2019-01-27 13:01:34 -05:00			:link_to_translation:`en:[English]`
Update index.rst 2018-05-17 04:42:17 -04:00
			`.. toctree::`
			`:maxdepth: 1`

update CN translation for ulp.rst index.rst bootloader.rst and external-ram.rst under api-guides section 2021-01-08 04:49:09 -05:00			`应用层跟踪 <app_trace>`
docs: split the 'general notes' page into two 2021-02-22 17:45:41 -05:00			`Application Startup Flow <startup>`
update CN translation for ulp.rst index.rst bootloader.rst and external-ram.rst under api-guides section 2021-01-08 04:49:09 -05:00			`:SOC_BT_SUPPORTED: BluFi <blufi>`
			`引导加载程序 <bootloader>`
zh_CN translation of build system (cmake version) 2019-03-05 02:02:48 -05:00			`构建系统 <build-system>`
update CN translation for ulp.rst index.rst bootloader.rst and external-ram.rst under api-guides section 2021-01-08 04:49:09 -05:00			`深度睡眠唤醒存根 <deep-sleep-stub>`
doc: update tinyusb document to support esp32s3 1. Renamed SOC_USB_SUPPORTED to SOC_USB_OTG_SUPPORTED for the reason of another USB related peripheral: USB_JTAG_SERIAL 2. correct related document 2021-06-30 04:04:37 -04:00			`:SOC_USB_OTG_SUPPORTED: 通过 USB 升级设备固件 <dfu>`
doc/error-handling: translated error-handling.rst Translated error-handling.rst from en to zh_CN. 2018-08-31 02:01:43 -04:00			`错误处理 <error-handling>`
update CN translation for ulp.rst index.rst bootloader.rst and external-ram.rst under api-guides section 2021-01-08 04:49:09 -05:00			`:SOC_BT_SUPPORTED: ESP-BLE-MESH <esp-ble-mesh/ble-mesh-index>`
docs: rename ESP-MESH to ESP-WIFI-MESH 2021-07-05 02:06:53 -04:00			`ESP-WIFI-MESH <esp-wifi-mesh>`
docs: initial update of programming guide for C3 Updates "front page" content, get-started, and api-guides with C3 content Enable building and publishing of C3 docs in CI 2021-01-26 21:12:58 -05:00			`核心转储 <core_dump>`
update CN translation for ulp.rst index.rst bootloader.rst and external-ram.rst under api-guides section 2021-01-08 04:49:09 -05:00			`事件处理 <event-handling>`
			`:SOC_SPIRAM_SUPPORTED: 片外 SPI RAM <external-ram>`
zh_CN translation of fatal_error 2019-04-01 00:30:10 -04:00			`严重错误 <fatal-errors>`
update CN translation for ulp.rst index.rst bootloader.rst and external-ram.rst under api-guides section 2021-01-08 04:49:09 -05:00			`Flash 加密 <../security/flash-encryption>`
doc: add flash and psram configuration doc in programming guide 2021-09-16 02:04:45 -04:00			`:esp32s3: Flash and External SPI RAM Configuration <flash_psram_config>`
update CN translation for ulp.rst index.rst bootloader.rst and external-ram.rst under api-guides section 2021-01-08 04:49:09 -05:00			`FreeRTOS SMP 变化 <freertos-smp>`
Add HAL and LL documentation This commit adds docuemntation regarding Hardware Abstraction in ESP-IDF. 2020-05-14 03:33:24 -04:00			`硬件抽象层 <hardware-abstraction>`
update CN translation for ulp.rst index.rst bootloader.rst and external-ram.rst under api-guides section 2021-01-08 04:49:09 -05:00			`:CONFIG_IDF_TARGET_ARCH_XTENSA: 高层中断 <hlinterrupts>`
doc/jtag_debug: translation of jtag debugging translate JTAG Debugging to zh_CN 2018-11-15 09:01:32 -05:00			`JTAG 调试 <jtag-debugging/index>`
docs: initial update of programming guide for C3 Updates "front page" content, get-started, and api-guides with C3 content Enable building and publishing of C3 docs in CI 2021-01-26 21:12:58 -05:00			`链接脚本生成机制 <linker-script-generation>`
update CN translation for ulp.rst index.rst bootloader.rst and external-ram.rst under api-guides section 2021-01-08 04:49:09 -05:00			`lwIP TCP/IP 协议栈 <lwip>`
docs: add OpenThread docs 2021-07-22 23:57:40 -04:00			`OpenThread <openthread>`
docs: split the 'general notes' page into two 2021-02-22 17:45:41 -05:00			`Memory Types <memory-types>`
doc/partition-tables: translation of zh_CN 1. Translated partition-tables.rst into Chinese. 2. Fixed some error in the English version. 2018-10-09 21:43:31 -04:00			`分区表 <partition-tables>`
doc: Add performance guides for execuion speed, binary size, RAM usage Closes https://github.com/espressif/esp-idf/issues/7007 Closes https://github.com/espressif/esp-idf/issues/6715 Closes https://github.com/espressif/esp-idf/issues/3781 Closes https://github.com/espressif/esp-idf/issues/2566 2021-02-19 02:39:26 -05:00			`Performance <performance/index>`
docs: update docs to be able to build with esp8684 2021-11-09 04:11:01 -05:00			`:not esp8684: 射频校准 <RF_calibration>`
update CN translation for ulp.rst index.rst bootloader.rst and external-ram.rst under api-guides section 2021-01-08 04:49:09 -05:00			`:esp32: 安全启动 <../security/secure-boot-v1>`
			`安全启动 V2 <../security/secure-boot-v2>`
			`线程本地存储 <thread-local-storage>`
			`工具 <tools/index>`
Docs: Add C3 support to build_docs 2020-10-28 21:57:09 -04:00			`:SOC_ULP_SUPPORTED: ULP 协处理器 <ulp>`
update CN translation for ulp.rst index.rst bootloader.rst and external-ram.rst under api-guides section 2021-01-08 04:49:09 -05:00			`:esp32s2: ULP-RISC-V 协处理器 <ulp-risc-v>`
doc: linux host test documentation 2020-12-24 04:34:03 -05:00			`单元测试 (Target) <unit-tests>`
			`单元测试 (Linux Host) <linux-host-testing>`
doc: update tinyusb document to support esp32s3 1. Renamed SOC_USB_SUPPORTED to SOC_USB_OTG_SUPPORTED for the reason of another USB related peripheral: USB_JTAG_SERIAL 2. correct related document 2021-06-30 04:04:37 -04:00			`:SOC_USB_OTG_SUPPORTED: USB 控制台 <usb-otg-console>`
* ets_delay_us(1) has too much overhead; change logic * Fix MR comments 2021-04-28 04:38:24 -04:00			`:SOC_USB_SERIAL_JTAG_SUPPORTED: USB Serial/JTAG Controller Console <usb-serial-jtag-console>`
docs: update docs to be able to build with esp8684 2021-11-09 04:11:01 -05:00			`:SOC_WIFI_SUPPORTED: Wi-Fi 驱动 <wifi>`
			`:SOC_WIFI_SUPPORTED: Wi-Fi Security <wifi-security>`