esp-idf/docs/en/api-reference/system/index.rst

System API
**********

.. 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 Additions <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>


Code examples for this API section are provided in the :example:`system` directory of ESP-IDF examples.
Moved api documentation to new folders / categories 2017-01-16 23:08:35 +01:00			`System API`
			`**********`

			`.. 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 16:01:50 +08:00			`:maxdepth: 1`
Moved api documentation to new folders / categories 2017-01-16 23:08:35 +01: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 16:01:50 +08:00			`App image format <app_image_format>`
			`Application Level Tracing <app_trace>`
docs: updated system api-reference chapters for C3 2021-03-12 15:20:41 +08:00			`:SOC_ASYNC_MEMCPY_SUPPORTED: Async Memory Copy <async_memcpy>`
console: simplify examples 1. simplify console examples 2. add "quit" command 3. support console command overwrite 4. add API reference 2020-02-03 18:01:04 +08:00			`Console Component <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 16:01:50 +08:00			`eFuse Manager <efuse>`
			`Error Codes and Helper Functions <esp_err>`
			`ESP HTTPS OTA <esp_https_ota>`
docs: Rename esp_pthread docs to pthread, expand details of supported APIs - Move the code that was in the document out to an example 2021-04-23 10:00:17 +10:00			`POSIX Threads Support <pthread>`
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 16:01:50 +08:00			`Event Loop Library <esp_event>`
			`FreeRTOS <freertos>`
			`FreeRTOS Additions <freertos_additions>`
			`Heap Memory Allocation <mem_alloc>`
			`Heap Memory Debugging <heap_debug>`
			`High Resolution Timer <esp_timer>`
doc: Update English pages with generic target name 2019-12-09 11:01:09 +08:00			`:esp32: Himem (large external SPI RAM) API <himem>`
docs: updated system api-reference chapters for C3 2021-03-12 15:20:41 +08:00			`:not CONFIG_FREERTOS_UNICORE: Inter-Processor Call <ipc>`
test/shared_stack_printf: improved printf with shared stack function test 2020-03-31 13:58:02 -03:00			`Call function with external stack <esp_function_with_shared_stack>`
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 16:01:50 +08:00			`Interrupt Allocation <intr_alloc>`
			`Logging <log>`
			`Miscellaneous System APIs <system>`
			`Over The Air Updates (OTA) <ota>`
docs: updated system api-reference chapters for C3 2021-03-12 15:20:41 +08:00			`:CONFIG_IDF_TARGET_ARCH_XTENSA: Performance Monitor <perfmon>`
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 16:01:50 +08:00			`Power Management <power_management>`
docs: Add random number generation to the API Reference System section 2021-05-11 11:40:38 +10:00			`Random Number Generation <random>`
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 16:01:50 +08:00			`Sleep Modes <sleep_modes>`
			`Watchdogs <wdts>`
docs: Add System time chapter and for sntp a description about using CONFIG_LWIP_SNTP_UPDATE_DELAY option Closes: https://github.com/espressif/esp-idf/issues/4386 Closes: IDFGH-2237 Closes: IDF-1199 2019-11-25 15:03:38 +08:00			`System Time <system_time>`
docs: Add esp_rom_printf to API Reference 2020-09-02 19:57:39 +08:00			`Internal and Unstable API <internal-unstable>`
Moved api documentation to new folders / categories 2017-01-16 23:08:35 +01:00
Added links from api category TOC to example category folders Typo fix in bluetooth README.md 2017-01-18 21:04:11 +01:00
Review log.rst and index.rst files in api-reference/system 2019-04-11 15:33:38 +08:00			Code examples for this API section are provided in the :example:`system` directory of ESP-IDF examples.