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

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

.. toctree::
    :maxdepth: 1

    Application Level Tracing <app_trace>
    :SOC_BT_SUPPORTED: BluFi <blufi>
    Bootloader <bootloader>
    Build System <build-system>
    :esp32: Build System (Legacy GNU Make) <build-system-legacy>
    Deep Sleep Wake Stubs <deep-sleep-stub>
    :esp32s2: Device Firmware Upgrade through USB <dfu>
    Error Handling <error-handling>
    :SOC_BT_SUPPORTED: ESP-BLE-MESH <esp-ble-mesh/ble-mesh-index>
    ESP-MESH (Wi-Fi) <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>
    FreeRTOS SMP Changes <freertos-smp>
    General Notes <general-notes>
    Hardware Abstraction <hardware-abstraction>
    :CONFIG_IDF_TARGET_ARCH_XTENSA: High Level Interrupts <hlinterrupts>
    JTAG Debugging <jtag-debugging/index>
    Linker Script Generation <linker-script-generation>
    lwIP TCP/IP Stack <lwip>
    Partition Tables <partition-tables>
    :esp32: RF Calibration <RF_calibration>
    ROM debug console <romconsole>
    :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>
    :esp32: ULP Coprocessor (Legacy GNU Make) <ulp-legacy>
    :esp32s2: ULP-RISC-V Coprocessor <ulp-risc-v>
    Unit Testing <unit-tests>
    :esp32: Unit Testing (Legacy GNU Make) <unit-tests-legacy>
    :esp32s2: USB Console <usb-console>
    WiFi Driver <wifi>
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>`
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>`
docs: Add 'toctree filter' directive & filter out ESP32-only pages from S2 docs 2019-11-22 00:58:04 -05:00			`:esp32: Build System (Legacy GNU Make) <build-system-legacy>`
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			`Deep Sleep Wake Stubs <deep-sleep-stub>`
Add build system support for programming ESP32-S2 using DFU utils 2020-04-06 10:41:44 -04:00			`:esp32s2: 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>`
Provide BLE Mesh documentation 2019-10-30 05:01:18 -04:00			`ESP-MESH (Wi-Fi) <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>`
			`FreeRTOS SMP Changes <freertos-smp>`
			`General Notes <general-notes>`
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>`
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: 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>`
docs: Temporarily mark RF calibration chapter as ESP32 only Can be re-enabled once ESP32-S2 calibration support is added 2020-01-31 01:16:03 -05:00			`:esp32: RF Calibration <RF_calibration>`
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			`ROM debug console <romconsole>`
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: Secure boot v2 support for ESP32-S2 2020-04-03 09:25:30 -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: Add 'toctree filter' directive & filter out ESP32-only pages from S2 docs 2019-11-22 00:58:04 -05:00			`:esp32: ULP Coprocessor (Legacy GNU Make) <ulp-legacy>`
ulp: added support to building code for riscv ULP coprocessor 2020-04-17 15:34:56 -04:00			`:esp32s2: ULP-RISC-V Coprocessor <ulp-risc-v>`
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			`Unit Testing <unit-tests>`
docs: Add 'toctree filter' directive & filter out ESP32-only pages from S2 docs 2019-11-22 00:58:04 -05:00			`:esp32: Unit Testing (Legacy GNU Make) <unit-tests-legacy>`
docs: add section about USB CDC console 2020-05-05 12:39:22 -04:00			`:esp32s2: USB Console <usb-console>`
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			`WiFi Driver <wifi>`