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

API Guides
**********
:link_to_translation:`zh_CN:[中文]`

.. toctree::
    :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 esp8684: 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>
Getting started guides 2017-03-26 18:01:52 -04:00			`API Guides`
			`**********`
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:`zh_CN:[中文]`
Getting started guides 2017-03-26 18:01:52 -04:00
			`.. toctree::`
docs: Alphbetically sort toctree This commit sorts the entries of variuos toctrees alphabetically. Indentation was also fixed. The order of some toctrees were not modified if the existing order had some form of suggested reading order. 2019-08-13 04:01:50 -04:00			`:maxdepth: 1`
Getting started guides 2017-03-26 18:01:52 -04:00
docs: Alphbetically sort toctree This commit sorts the entries of variuos toctrees alphabetically. Indentation was also fixed. The order of some toctrees were not modified if the existing order had some form of suggested reading order. 2019-08-13 04:01:50 -04:00			`Application Level Tracing <app_trace>`
docs: split the 'general notes' page into two 2021-02-22 17:45:41 -05:00			`Application Startup Flow <startup>`
doc: add generation of tags from sdkconfig and x_caps.h headers Also updates the way we handle exclude_patterns to use the new tags Closes IDF-1484 2020-04-30 04:55:12 -04:00			`:SOC_BT_SUPPORTED: BluFi <blufi>`
docs: Alphbetically sort toctree This commit sorts the entries of variuos toctrees alphabetically. Indentation was also fixed. The order of some toctrees were not modified if the existing order had some form of suggested reading order. 2019-08-13 04:01:50 -04:00			`Bootloader <bootloader>`
			`Build System <build-system>`
			`Deep Sleep Wake Stubs <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: Device Firmware Upgrade through USB <dfu>`
docs: Alphbetically sort toctree This commit sorts the entries of variuos toctrees alphabetically. Indentation was also fixed. The order of some toctrees were not modified if the existing order had some form of suggested reading order. 2019-08-13 04:01:50 -04:00			`Error Handling <error-handling>`
doc: add generation of tags from sdkconfig and x_caps.h headers Also updates the way we handle exclude_patterns to use the new tags Closes IDF-1484 2020-04-30 04:55:12 -04: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>`
doc: removed reference to idf_target in core dump title 2019-12-12 22:22:44 -05:00			`Core Dump <core_dump>`
docs: Alphbetically sort toctree This commit sorts the entries of variuos toctrees alphabetically. Indentation was also fixed. The order of some toctrees were not modified if the existing order had some form of suggested reading order. 2019-08-13 04:01:50 -04:00			`Event Handling <event-handling>`
Docs: Add C3 support to build_docs 2020-10-28 21:57:09 -04:00			`:SOC_SPIRAM_SUPPORTED: External SPI-connected RAM <external-ram>`
docs: Alphbetically sort toctree This commit sorts the entries of variuos toctrees alphabetically. Indentation was also fixed. The order of some toctrees were not modified if the existing order had some form of suggested reading order. 2019-08-13 04:01:50 -04:00			`Fatal Errors <fatal-errors>`
			`Flash Encryption <../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>`
docs: Alphbetically sort toctree This commit sorts the entries of variuos toctrees alphabetically. Indentation was also fixed. The order of some toctrees were not modified if the existing order had some form of suggested reading order. 2019-08-13 04:01:50 -04:00			`FreeRTOS SMP Changes <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 <hardware-abstraction>`
Docs: Add C3 support to build_docs 2020-10-28 21:57:09 -04:00			`:CONFIG_IDF_TARGET_ARCH_XTENSA: High Level Interrupts <hlinterrupts>`
docs: Alphbetically sort toctree This commit sorts the entries of variuos toctrees alphabetically. Indentation was also fixed. The order of some toctrees were not modified if the existing order had some form of suggested reading order. 2019-08-13 04:01:50 -04:00			`JTAG Debugging <jtag-debugging/index>`
			`Linker Script Generation <linker-script-generation>`
docs: split the 'general notes' page into two 2021-02-22 17:45:41 -05:00			`Memory Types <memory-types>`
lwip: Add lwIP API Guide Try to provide a full overview of lwIP features as implemented in esp-lwip and ESP-IDF 2019-10-16 19:47:52 -04:00			`lwIP TCP/IP Stack <lwip>`
docs: add OpenThread docs 2021-07-22 23:57:40 -04:00			`OpenThread <openthread>`
docs: Alphbetically sort toctree This commit sorts the entries of variuos toctrees alphabetically. Indentation was also fixed. The order of some toctrees were not modified if the existing order had some form of suggested reading order. 2019-08-13 04:01:50 -04:00			`Partition Tables <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 <RF_calibration>`
feat/secure_boot_v2: Adding docs for secure boot v2 ESP32-ECO3 2020-02-24 14:54:16 -05:00			`:esp32: Secure Boot <../security/secure-boot-v1>`
docs: Adds secure_boot_v2 for ESP32-C3 ECO3 2021-04-06 09:58:01 -04:00			`Secure Boot V2 <../security/secure-boot-v2>`
docs: Alphbetically sort toctree This commit sorts the entries of variuos toctrees alphabetically. Indentation was also fixed. The order of some toctrees were not modified if the existing order had some form of suggested reading order. 2019-08-13 04:01:50 -04:00			`Thread Local Storage <thread-local-storage>`
			`Tools <tools/index>`
Docs: Add C3 support to build_docs 2020-10-28 21:57:09 -04:00			`:SOC_ULP_SUPPORTED: ULP Coprocessor <ulp>`
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			`:SOC_RISCV_COPROC_SUPPORTED: ULP-RISC-V Coprocessor <ulp-risc-v>`
doc: linux host test documentation 2020-12-24 04:34:03 -05:00			`Unit Testing (Target) <unit-tests>`
			`Unit Testing (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 OTG Console <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 Driver <wifi>`
			`:SOC_WIFI_SUPPORTED: Wi-Fi Security <wifi-security>`