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

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

.. toctree::
   :maxdepth: 1

   FreeRTOS <freertos>
   FreeRTOS Additions <freertos_additions>
   Heap Memory Allocation <mem_alloc>
   Heap Memory Debugging <heap_debug>
   Interrupt Allocation <intr_alloc>
   Watchdogs <wdts>
   Inter-Processor Call <ipc>
   High Resolution Timer <esp_timer>
   Logging <log>
   Application Level Tracing <app_trace>
   Power Management <power_management>
   Sleep Modes <sleep_modes>
   Base MAC address <base_mac_address>
   Over The Air Updates (OTA) <ota>
   ESP pthread <esp_pthread>


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 22:08:35 +00:00			`System API`
			`**********`

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

docs: add FreeRTOS API docs - Use `code` tags instead of a mix of `<pre></pre>` and `@verbatim .. @endverbatim` - Remove manually added function prototypes from comment blocks - Remove of grouping (`\defgroup`) — some extra work is needed to make groups compatible with the way we auto-generate API reference from Doxygen XML files. It's pretty easy to add the grouping directives back if/when we implement support for Doxygen groups in the later stages of documentation build process. - Hide private APIs under `@cond .. @endcond` - Convert some comments into Doxygen-compatible ones - Fix various documentation issues: missing documentation for some parameters, mismatch between parameter names in comment block and in function prototype. - Add doxygen comments for functions which didn't have them (thread local storage). - Add [out] param tags where necessary - Redefine `xTaskCreate` and `xTaskCreateStatic` as inline functions instead of macros. 2017-12-01 04:50:45 +00:00			`FreeRTOS <freertos>`
freeRTOS/Re-factor ring buffers This fixes multiple bugs with ring buffers and re-factors the code. The public API has not changed, however the underlying implementation have various private functions have been changed. The following behavioral changes have been made - Size of ring buffers for No-Split/Allow-Split buffers will not be rounded up to the nearest 32-bit aligned size. This was done to simplify the implementation - Item size for No-Split/Allow-Split buffers will also be rounded up to the nearest 32-bit aligned size. The following bugs have been fixed - In copyItemToRingbufAllowSplit(), when copying an item where the aligned size is smaller than the remaining length, the function does not consider the case where the true size of the item is less than 4 bytes. - The copy functions will automatically wrap around the write pointers when the remaining length of the buffer is not large enough to fit a header, but does not consider if wrapping around will cause an overlap with the read pointer. This will make a full buffer be mistaken for an empty buffer closes #1711 - xRingbufferSend() can get stuck in a infinite loop when the size of the free memory is larger than the needed_size, but too small to fit in the ring buffer due to alignment and extra overhead of wrapping around. closes #1846 - Fixed documentation with ring buffer queue set API - Adding and removing from queue set does not consider the case where the read/write semaphores actually hold a value. The following functions have been deprecated - xRingbufferIsNextItemWrapped() due to lack of thread safety - xRingbufferAddToQueueSetWrite() and xRingbufferRemoveFromQueueSetWrite() as adding the queue sets only work under receive operations. The following functions have been added - xRingbufferReceiveSplit() and xRingbufferReceiveSplitFromISR() as a thread safe way to receive from allow-split buffers - vRingbufferGetInfo() Documentation for ring buffers has also been added. 2018-04-18 17:20:34 +00:00			`FreeRTOS Additions <freertos_additions>`
doc: Add docs for heap trace & poisoning 2017-07-18 23:07:17 +00:00			`Heap Memory Allocation <mem_alloc>`
			`Heap Memory Debugging <heap_debug>`
Moved api documentation to new folders / categories 2017-01-16 22:08:35 +00:00			`Interrupt Allocation <intr_alloc>`
			`Watchdogs <wdts>`
docs/ipc documentation This commit updates doxygen comments in the IPC header files and adds an rst docs page. 2017-11-22 07:16:29 +00:00			`Inter-Processor Call <ipc>`
esp_timer: add documentation, expose profiling option in Kconfig 2017-11-24 10:51:37 +00:00			`High Resolution Timer <esp_timer>`
Moved api documentation to new folders / categories 2017-01-16 22:08:35 +00:00			`Logging <log>`
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-22 03:07:37 +00:00			`Application Level Tracing <app_trace>`
docs: add FreeRTOS API docs - Use `code` tags instead of a mix of `<pre></pre>` and `@verbatim .. @endverbatim` - Remove manually added function prototypes from comment blocks - Remove of grouping (`\defgroup`) — some extra work is needed to make groups compatible with the way we auto-generate API reference from Doxygen XML files. It's pretty easy to add the grouping directives back if/when we implement support for Doxygen groups in the later stages of documentation build process. - Hide private APIs under `@cond .. @endcond` - Convert some comments into Doxygen-compatible ones - Fix various documentation issues: missing documentation for some parameters, mismatch between parameter names in comment block and in function prototype. - Add doxygen comments for functions which didn't have them (thread local storage). - Add [out] param tags where necessary - Redefine `xTaskCreate` and `xTaskCreateStatic` as inline functions instead of macros. 2017-12-01 04:50:45 +00:00			`Power Management <power_management>`
			`Sleep Modes <sleep_modes>`
			`Base MAC address <base_mac_address>`
			`Over The Air Updates (OTA) <ota>`
pthread: Allow configuration of priority and stacksize The expected usage is: esp_pthread_set_cfg(cfg); pthread_create() If the inherit flag is set, then all subsequent threads forked by this thread will also inherit this configuration. This avoids having to change/prefix this for each and every pthread_create() call. 2018-02-25 09:26:04 +00:00			`ESP pthread <esp_pthread>`
Moved api documentation to new folders / categories 2017-01-16 22:08:35 +00:00
Added links from api category TOC to example category folders Typo fix in bluetooth README.md 2017-01-18 20:04:11 +00: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 08:16:06 +00:00			Example code for this API section is provided in :example:`system` directory of ESP-IDF examples.