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

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

.. toctree::
   :maxdepth: 1

   Heap Memory Allocation <mem_alloc>
   Heap Memory Debugging <heap_debug>
   Interrupt Allocation <intr_alloc>
   Watchdogs <wdts>
   Hooks <hooks>
   Over The Air Updates (OTA) <ota>
   Sleep Modes <sleep_modes>
   Power Management <power_management>
   Logging <log>
   Base MAC address <base_mac_address>
   Application Level Tracing <app_trace>


Example code for this API section is provided in :example:`system` directory of ESP-IDF examples.
Moved api documentation to new folders / categories 2017-01-16 17:08:35 -05:00			`System API`
			`**********`

			`.. toctree::`
			`:maxdepth: 1`

doc: Add docs for heap trace & poisoning 2017-07-18 19:07:17 -04:00			`Heap Memory Allocation <mem_alloc>`
			`Heap Memory Debugging <heap_debug>`
Moved api documentation to new folders / categories 2017-01-16 17:08:35 -05:00			`Interrupt Allocation <intr_alloc>`
			`Watchdogs <wdts>`
docs/Added documentation about esp32 hooks This commit adds documentation about the esp32 Idle and Tick Hooks 2017-10-17 06:57:31 -04:00			`Hooks <hooks>`
docs: Improve/clarify partition, OTA & SPI flash docs Related to #313 https://github.com/espressif/esp-idf/issues/313 2017-02-16 20:43:55 -05:00			`Over The Air Updates (OTA) <ota>`
sleep: add light sleep, factor out APIs common for deep/light sleep 2017-04-21 00:32:50 -04:00			`Sleep Modes <sleep_modes>`
docs: add power management API reference 2017-10-09 02:38:41 -04:00			`Power Management <power_management>`
Moved api documentation to new folders / categories 2017-01-16 17:08:35 -05:00			`Logging <log>`
Optimize configuration of base MAC address Application developer can call APIs to configure base MAC address instead of using menuconfig. 2017-05-05 10:24:56 -04:00			`Base MAC address <base_mac_address>`
esp32: SEGGER SystemView Tracing Support Implements support for system level traces compatible with SEGGER SystemView tool on top of ESP32 application tracing module. That kind of traces can help to analyse program's behaviour. SystemView can show timeline of tasks/ISRs execution, context switches, statistics related to the CPUs' load distribution etc. Also this commit adds useful feature to ESP32 application tracing module: - Trace data buffering is implemented to handle temporary peaks of events load 2017-03-21 23:07:37 -04:00			`Application Level Tracing <app_trace>`
Moved api documentation to new folders / categories 2017-01-16 17:08:35 -05:00
Added links from api category TOC to example category folders Typo fix in bluetooth README.md 2017-01-18 15:04:11 -05:00
docs: use custom roles to generate GitHub links This change replaces direct links to GitHub master branch with auto-generated links using docutils custom roles. These auto-generated links point to the tree or blob for the git commit ID (or tag) of the repository. This is needed to ensure that links don’t become broken when files in master branch are moved around or deleted. The following roles are introduced: - :idf:`path` - points to directory inside ESP-IDF - :idf_blob:`path` - points to file inside ESP-IDF - :idf_raw:`path` - points to raw view of the file inside ESP-IDF - :component:`path` - points to directory inside ESP-IDF components dir - :component_blob:`path` - points to file inside ESP-IDF components dir - :component_raw:`path` - points to raw view of the file inside ESP-IDF components dir - :example:`path` - points to directory inside ESP-IDF examples dir - :example_blob:`path` - points to file inside ESP-IDF examples dir - :example_raw:`path` - points to raw view of the file inside ESP-IDF examples dir A check is added to the CI build script, which searches RST files for presence of hard-coded links (identified by tree/master, blob/master, or raw/master part of the URL). This check can be run manually: cd docs && make gh-linkcheck Additionally, Sphinx linkcheck build type is used to create new CI test, which check for broken links. This test has to be triggered explicitly, because including it in normal build process (when the commit is not yet deployed to Github) will not work. It can be triggered in a regular fashion using a combination of cron and Curl, similar to stress tests. 2017-01-19 03:16:06 -05:00			Example code for this API section is provided in :example:`system` directory of ESP-IDF examples.