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

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

.. toctree::
   :maxdepth: 1

   General Notes <general-notes>
   Build System <build-system>
   Build System (CMake) <build-system-cmake>
   Error Handling <error-handling>
   Fatal Errors <fatal-errors>
   Deep Sleep Wake Stubs <deep-sleep-stub>
   ESP32 Core Dump <core_dump>
   Flash Encryption <../security/flash-encryption>
   FreeRTOS SMP Changes <freertos-smp>
   Thread Local Storage <thread-local-storage>
   High Level Interrupts <hlinterrupts>
   JTAG Debugging <jtag-debugging/index>
   Bootloader <bootloader>
   Partition Tables <partition-tables>
   Secure Boot <../security/secure-boot>
   ULP Coprocessor <ulp>
   ULP Coprocessor (CMake) <ulp-cmake>
   Unit Testing <unit-tests>
   Unit Testing (CMake) <unit-tests-cmake>
   Application Level Tracing <app_trace>
   Console Component <console>
   ROM debug console <romconsole>
   RF Calibration <RF_calibration>
   WiFi Driver <wifi>
   ESP-MESH <mesh>
   ESP-BLE-MESH <esp-ble-mesh/ble-mesh-index>
   BluFi <blufi>
   External SPI-connected RAM <external-ram>
   Linker Script Generation <linker-script-generation>
Getting started guides 2017-03-27 00:01:52 +02:00			`API Guides`
			`**********`
Included missing links between English and Chinese documentation, where translation into Chinese is available 2019-01-27 19:01:34 +01:00			:link_to_translation:`zh_CN:[中文]`
Getting started guides 2017-03-27 00:01:52 +02:00
			`.. toctree::`
			`:maxdepth: 1`

			`General Notes <general-notes>`
			`Build System <build-system>`
docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline. 2018-08-08 09:58:00 +02:00			`Build System (CMake) <build-system-cmake>`
docs: add pages about error handling 2018-06-11 14:49:35 +02:00			`Error Handling <error-handling>`
			`Fatal Errors <fatal-errors>`
JTAG Debugging - revamping of Debugging documentation 2017-06-11 21:12:30 +02:00			`Deep Sleep Wake Stubs <deep-sleep-stub>`
Getting started guides 2017-03-27 00:01:52 +02:00			`ESP32 Core Dump <core_dump>`
			`Flash Encryption <../security/flash-encryption>`
docs: Added documentation for FreeRTOS SMP changes Added documentation about the ESP-IDF changes to FreeRTOS. The documentation covers changes to the following FreeRTOS aspects. - Task Creation - Affects on scheduling (Task skipping, scheduler suspension, tick synchronicity) - Critical sections and disabling interrupts - Thread Local Storage Pointers and deletion callbacks - Configuring ESP-IDF FreeRTOS 2017-09-08 13:50:15 +02:00			`FreeRTOS SMP Changes <freertos-smp>`
freertos: Adds C11 TLS support 2018-02-04 23:06:45 +01:00			`Thread Local Storage <thread-local-storage>`
Break out high-level interrupts so a component can override them 2017-04-18 11:14:32 +02:00			`High Level Interrupts <hlinterrupts>`
JTAG Debugging - revamping of Debugging documentation 2017-06-11 21:12:30 +02:00			`JTAG Debugging <jtag-debugging/index>`
bootloader: Refactoring Need to make the bootloader modular so that users can redefine its functional part. - refactoring and moving functions to the bootloader_support component - Changed function to `void` bootloader_utility_load_image(...); TW19596 2018-04-16 17:35:41 +02:00			`Bootloader <bootloader>`
JTAG Debugging - revamping of Debugging documentation 2017-06-11 21:12:30 +02:00			`Partition Tables <partition-tables>`
Getting started guides 2017-03-27 00:01:52 +02:00			`Secure Boot <../security/secure-boot>`
			`ULP Coprocessor <ulp>`
cmake: add ulp components build support 2018-09-13 08:54:59 +02:00			`ULP Coprocessor (CMake) <ulp-cmake>`
Getting started guides 2017-03-27 00:01:52 +02:00			`Unit Testing <unit-tests>`
cmake: Add support for test build 2018-08-27 04:48:16 +02:00			`Unit Testing (CMake) <unit-tests-cmake>`
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 04:07:37 +01:00			`Application Level Tracing <app_trace>`
add console component and example 2017-08-15 10:11:19 +02:00			`Console Component <console>`
Some documentation for the undocumented ROM console. 2017-06-29 13:01:50 +02:00			`ROM debug console <romconsole>`
doc: add documentation for RF calibration Add an API to erase phy namespace of NVS 2018-11-29 09:07:28 +01:00			`RF Calibration <RF_calibration>`
docs: add wifi.rst Add more documents about WiFi API/Event Mechanism/State Machine etc 2017-05-03 13:21:08 +02:00			`WiFi Driver <wifi>`
docs/rewrite_mesh_docs The following commit rewrites the ESP-MESH docs. This commit includes new diagrams and a structure approach to the mesh docs. Some mesh api references have also been modified. 2018-06-26 14:48:47 +02:00			`ESP-MESH <mesh>`
ble_mesh: Add ESP BLE Mesh implementation 1. BLE Mesh Core * Provisioning: Node Role * PB-ADV and PB-GATT * Authentication OOB * Provisioning: Provisioner Role * PB-ADV and PB-GATT * Authentication OOB * Networking * Relay * Segmentation and Reassembly * Key Refresh * IV Update * Proxy Support * Multiple Client Models Run Simultaneously * Support multiple client models send packets to different nodes simultaneously * No blocking between client model and server * NVS Storage * Store BLE Mesh node related information in flash * Store BLE Mesh Provisioner related information in flash 2. BLE Mesh Models * Foundation Models * Configuration Server Model * Configuration Client Model * Health Server Model * Health Client Model * Generic * Generic OnOff Server * Generic OnOff Client * Generic Level Server * Generic Level Client * Generic Default Transition Time Server * Generic Default Transition Time Client * Generic Power OnOff Server * Generic Power OnOff Setup Server * Generic Power OnOff Client * Generic Power Level Server * Generic Power Level Setup Server * Generic Power Level Client * Generic Battery Server * Generic Battery Client * Generic Location Server * Generic Location Setup Server * Generic Location Client * Generic Admin Property Server * Generic Manufacturer Property Server * Generic User Property Server * Generic Client Property Server * Generic Property Client * Sensor Server Model * Sensor Server * Sensor Setup Server * Sensor Client * Time and Scenes * Time Server * Time Setup Server * Time Client * Scene Server * Scene Setup Server * Scene Client * Scheduler Server * Scheduler Setup Server * Scheduler Client * Lighting * Light Lightness Server * Light Lightness Setup Server * Light Lightness Client * Light CTL Server * Light CTL Setup Server * Light CTL Client * Light CTL Temperature Server * Light HSL Server * Light HSL Setup Server * Light HSL Client * Light HSL Hue Server * Light HSL Saturation Server * Light xyL Server * Light xyL Setup Server * Light xyL Client * Light LC Server * Light LC Setup Server * Light LC Client 3. BLE Mesh Applications * BLE Mesh Node * OnOff Client Example * OnOff Server Example * BLE Mesh Provisioner * Example * Fast Provisioning * Vendor Fast Prov Server Model * Vendor Fast Prov Client Model * Examples * Wi-Fi & BLE Mesh Coexistence * Example * BLE Mesh Console Commands * Examples 2019-11-01 09:08:47 +01:00			`ESP-BLE-MESH <esp-ble-mesh/ble-mesh-index>`
Update index.rst 2018-06-04 08:24:10 +02:00			`BluFi <blufi>`
Add logic to make external RAM usable with malloc() 2017-09-22 10:02:39 +02:00			`External SPI-connected RAM <external-ram>`
doc: add documentation for RF calibration Add an API to erase phy namespace of NVS 2018-11-29 09:07:28 +01:00			`Linker Script Generation <linker-script-generation>`