OVMS3-idf/docs/index.rst

ESP-IDF Programming Guide
=========================

This is the documentation for Espressif IoT Developement Framework (`esp-idf <https://github.com/espressif/esp-idf>`_). ESP-IDF is the official development framework for the `ESP32 <https://espressif.com/en/products/hardware/esp32/overview>`_ chip.


Contents:

.. toctree::
   :caption: Setup Toolchain
   :maxdepth: 1

   Windows <windows-setup>
   Linux <linux-setup>
   Mac OS <macos-setup>

.. Connect - TBA

.. toctree::
   :caption: Build and Flash
   :maxdepth: 1

   Make <make-project>
   Eclipse IDE <eclipse-setup>

.. toctree::
   :caption: What Else?
   :maxdepth: 1
   
   General Notes <general-notes>
   partition-tables
   build_system
   openocd
   core_dump
   Flash encryption <security/flash-encryption>
   Secure Boot <security/secure-boot>
   ULP coprocessor <api/ulp.rst>

.. API Reference
   ..
   Table of Contents Outline
   ..
   1. System - TBA
     1.1. Fundamentals of multiprocessor programming with FreeRTOS - TBA
     1.2. Application startup flow - TBA
     1.3. Flash encryption and secure boot: how they work and APIs
     1.4. Lower Power Coprocessor - TBA
     1.5. Watchdogs <api/wdts>
     1.6. Memory allocation <api/mem_alloc>
     1.7. ...
   2. Memory - TBA
     2.1. Memory layout of the application (IRAM/IROM, limitations of each) - TBA
     2.2. Flash layout and partitions - TBA
     2.3. Flash access APIs - TBA
     2.4. Partition APIs - TBA
     2.5. OTA mechanism (app partitions, OTA partition) and APIs - TBA
     2.6. ... 
   3. Wi-Fi
   4. Bluetooth
     4.1. BT Classic - TBA
     4.2. BLE
   5. Ethernet - TBA
   6. Interfaces
     6.1. GPIO
     6.2. ADC - TBA
     6.3. DAC - TBA
     6.4. UART
     6.5. I2C - TBA
     6.6. I2S - TBA
     6.7. SPI - <api/spi_master>
     6.8. CAN - TBA
     6.9. SD Controller - TBA
     6.10. Infrared - TBA
     6.11. Pulse Counter - TBA
     6.12. PWM - TBA
     6.13. LED PWM
     6.14. ...
   7. Sensors - TBA
     7.1. Hall Sensor - TBA
     7.2. Temperature Sensor - TBA
     7.3. Touch Sensor - TBA
   8. Protocols - TBA
   9. Components
     9.1. Logging
     9.2  Non-Volatile Storage
     9.3  Virtual Filesystem
     9.3. Http sever - TBA
   10. Applications - TBA
   ..
   API Dcoumentation Teamplate
   ..

.. toctree::
   :caption: API Reference
   :maxdepth: 1

   Wi-Fi <api/esp_wifi>
   Smart Config <api/esp_smartconfig>
   Bluetooth <api/bt>
   Watchdogs <api/wdts>
   OTA <api/ota>
   GPIO <api/gpio>
   UART <api/uart>
   LED Control <api/ledc>
   Remote Control <api/rmt>
   Timer <api/timer>
   I2C <api/i2c>
   Pulse Counter <api/pcnt>
   Sigma-delta Modulation <api/sigmadelta>
   SD/MMC <api/sdmmc>
   SPI Flash and Partition APIs <api/spi_flash>
   SPI Master API <api/spi_master>
   Logging <api/log>
   Non-Volatile Storage <api/nvs_flash>
   Virtual Filesystem <api/vfs>
   FAT Filesystem <api/fatfs>
   Ethernet <api/esp_eth>
   Interrupt Allocation <api/intr_alloc>
   Memory Allocation <api/mem_alloc>
   Deep Sleep <api/deep_sleep>
   deep-sleep-stub

   mDNS <api/mdns>
   Template <api/template>

.. toctree::
   :caption: Technical Reference

   Technical Reference <http://espressif.com/sites/default/files/documentation/esp32_technical_reference_manual_en.pdf>

.. Resources - TBA
   
.. toctree::
   :caption: Contribute
   :maxdepth: 1

   contributing
   Style Guide <style-guide>
   documenting-code
   contributor-agreement

.. toctree::
   :caption: Legal
   :maxdepth: 1

   COPYRIGHT

 
Indices
-------

* :ref:`genindex`
* :ref:`search`
docs: update index, improve structure of the readme 2017-01-15 17:48:47 +00:00			`ESP-IDF Programming Guide`
			`=========================`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 20:14:24 +00:00
docs: update index, improve structure of the readme 2017-01-15 17:48:47 +00:00			This is the documentation for Espressif IoT Developement Framework (`esp-idf <https://github.com/espressif/esp-idf>`_). ESP-IDF is the official development framework for the `ESP32 <https://espressif.com/en/products/hardware/esp32/overview>`_ chip.
doc: Index clean up 2016-11-16 19:17:44 +00:00

Initial list of Wi-Fi API 2016-10-24 18:44:57 +00:00			`Contents:`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 20:14:24 +00:00
Initial list of Wi-Fi API 2016-10-24 18:44:57 +00:00			`.. toctree::`
			`:caption: Setup Toolchain`
			`:maxdepth: 1`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 20:14:24 +00:00
Initial list of Wi-Fi API 2016-10-24 18:44:57 +00:00			`Windows <windows-setup>`
			`Linux <linux-setup>`
			`Mac OS <macos-setup>`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 20:14:24 +00:00
Initial list of Wi-Fi API 2016-10-24 18:44:57 +00:00			`.. Connect - TBA`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 20:14:24 +00:00
Initial list of Wi-Fi API 2016-10-24 18:44:57 +00:00			`.. toctree::`
			`:caption: Build and Flash`
			`:maxdepth: 1`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 20:14:24 +00:00
Make section 2016-10-25 19:28:21 +00:00			`Make <make-project>`
Initial list of Wi-Fi API 2016-10-24 18:44:57 +00:00			`Eclipse IDE <eclipse-setup>`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 20:14:24 +00:00
			`.. toctree::`
API template - reflected template in other DRAFT API dcouments - DRAFT of Bluetooth API - link fixes in CONTRIBUTING.rst 2016-10-26 19:08:36 +00:00			`:caption: What Else?`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 20:14:24 +00:00			`:maxdepth: 1`
Initial list of Wi-Fi API 2016-10-24 18:44:57 +00:00
docs: add description of ESP-IDF application startup flow and memory layout 2016-11-14 07:40:54 +00:00			`General Notes <general-notes>`
Initial list of Wi-Fi API 2016-10-24 18:44:57 +00:00			`partition-tables`
			`build_system`
Make section 2016-10-25 19:28:21 +00:00			`openocd`
esp32: Fixes issues discussed during code review of MR!341 The following issues mentioned during MR!341 review were fixed: 1) Core dump test application description 2) Usage of CONFIG_ESP32_ENABLE_COREDUMP_TO_FLASH and CONFIG_ESP32_ENABLE_COREDUMP_TO_UART 3) FLASH_GUARD_START macro usage is fixed in flash API 4) Core dump module logging facility 5) cache util functions doc updated 6) interactive delay before print core dump to uart 7) core dump partion support in build system 2017-01-10 11:48:47 +00:00			`core_dump`
docs: fix some warnings 2016-12-16 06:27:22 +00:00			`Flash encryption <security/flash-encryption>`
Secure boot: Documentation tweaks 2016-11-11 04:40:29 +00:00			`Secure Boot <security/secure-boot>`
initial support for generation of ULP coprocessor code 2016-11-29 14:10:31 +00:00			`ULP coprocessor <api/ulp.rst>`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 20:14:24 +00:00
deep-sleep-stub added + TOC outline TOC outline to show overal planned structure 2016-11-05 16:13:44 +00:00			`.. API Reference`
			`..`
			`Table of Contents Outline`
			`..`
			`1. System - TBA`
			`1.1. Fundamentals of multiprocessor programming with FreeRTOS - TBA`
			`1.2. Application startup flow - TBA`
doc: Index clean up 2016-11-16 19:17:44 +00:00			`1.3. Flash encryption and secure boot: how they work and APIs`
deep-sleep-stub added + TOC outline TOC outline to show overal planned structure 2016-11-05 16:13:44 +00:00			`1.4. Lower Power Coprocessor - TBA`
Add documentation 2016-11-17 04:09:08 +00:00			`1.5. Watchdogs <api/wdts>`
Fix small things noticed in MR, add documentation 2016-12-13 09:01:10 +00:00			`1.6. Memory allocation <api/mem_alloc>`
			`1.7. ...`
Add documentation 2016-11-17 04:09:08 +00:00			`2. Memory - TBA`
deep-sleep-stub added + TOC outline TOC outline to show overal planned structure 2016-11-05 16:13:44 +00:00			`2.1. Memory layout of the application (IRAM/IROM, limitations of each) - TBA`
			`2.2. Flash layout and partitions - TBA`
			`2.3. Flash access APIs - TBA`
			`2.4. Partition APIs - TBA`
			`2.5. OTA mechanism (app partitions, OTA partition) and APIs - TBA`
			`2.6. ...`
			`3. Wi-Fi`
			`4. Bluetooth`
			`4.1. BT Classic - TBA`
			`4.2. BLE`
			`5. Ethernet - TBA`
			`6. Interfaces`
			`6.1. GPIO`
			`6.2. ADC - TBA`
			`6.3. DAC - TBA`
doc: Index clean up 2016-11-16 19:17:44 +00:00			`6.4. UART`
deep-sleep-stub added + TOC outline TOC outline to show overal planned structure 2016-11-05 16:13:44 +00:00			`6.5. I2C - TBA`
			`6.6. I2S - TBA`
Add SPI Master driver, example, test and docs 2017-01-06 06:20:32 +00:00			`6.7. SPI - <api/spi_master>`
deep-sleep-stub added + TOC outline TOC outline to show overal planned structure 2016-11-05 16:13:44 +00:00			`6.8. CAN - TBA`
			`6.9. SD Controller - TBA`
			`6.10. Infrared - TBA`
			`6.11. Pulse Counter - TBA`
			`6.12. PWM - TBA`
			`6.13. LED PWM`
			`6.14. ...`
			`7. Sensors - TBA`
			`7.1. Hall Sensor - TBA`
			`7.2. Temperature Sensor - TBA`
			`7.3. Touch Sensor - TBA`
			`8. Protocols - TBA`
			`9. Components`
doc: Index clean up 2016-11-16 19:17:44 +00:00			`9.1. Logging`
			`9.2 Non-Volatile Storage`
			`9.3 Virtual Filesystem`
deep-sleep-stub added + TOC outline TOC outline to show overal planned structure 2016-11-05 16:13:44 +00:00			`9.3. Http sever - TBA`
			`10. Applications - TBA`
			`..`
			`API Dcoumentation Teamplate`
			`..`

Initial list of Wi-Fi API 2016-10-24 18:44:57 +00:00			`.. toctree::`
			`:caption: API Reference`
			`:maxdepth: 1`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 20:14:24 +00:00
Initial list of Wi-Fi API 2016-10-24 18:44:57 +00:00			`Wi-Fi <api/esp_wifi>`
esp32: refactor to sniffer 1. TW8657, WIFI send the whole packet to smartconfig; 2. modify API annotation of smartconfig and sniffer; 3. export smartconfig APIs to programming guide; 2016-12-12 02:00:24 +00:00			`Smart Config <api/esp_smartconfig>`
API template - reflected template in other DRAFT API dcouments - DRAFT of Bluetooth API - link fixes in CONTRIBUTING.rst 2016-10-26 19:08:36 +00:00			`Bluetooth <api/bt>`
Add documentation 2016-11-17 04:09:08 +00:00			`Watchdogs <api/wdts>`
feature/fota_ops_api: add ota core api implement 2016-11-28 05:53:03 +00:00			`OTA <api/ota>`
update docs/index.rst 2016-11-23 13:22:19 +00:00			`GPIO <api/gpio>`
			`UART <api/uart>`
			`LED Control <api/ledc>`
			`Remote Control <api/rmt>`
			`Timer <api/timer>`
1. modify i2c_set_pin function 2. update example comments and other minor changes 3. rename API: i2c_cmd_link_create/i2c_cmd_link_delete (+4 squashed commits) Squashed commits: [2e0ac3e] 1. coding style: add one space after condition key words. 2. modify i2c.h, use gpio_num_t instead of int, improve comments of return values 3. add i2c index in index.rst 4. add readme for i2c example [4991d92] update i2c.doc [88b672e] driver: i2c 1. add mux and spin lock to run in a thread-safe way. 2. modify example code [4eb15fe] driver: i2c code 1. add i2c master code 2. add i2c slave code 3. add i2c example code 4. add DRAM_ATTR for I2C array 2016-12-16 15:41:04 +00:00			`I2C <api/i2c>`
update docs/index.rst 2016-11-23 13:25:06 +00:00			`Pulse Counter <api/pcnt>`
driver: sigma-delta 1. add sigma-delta code and example. 2. add gpio output signal in io matrix. Squashed commits: [a25e7d4] minor changes for doc [6a03a1e] minor changes on comments and doc. [97dd9e4] Add doc. update index.rst change example index 2016-11-23 08:28:16 +00:00			`Sigma-delta Modulation <api/sigmadelta>`
docs: add sdmmc and fatfs docs 2017-01-08 20:09:09 +00:00			`SD/MMC <api/sdmmc>`
docs: fix broken links, formatting, add SPI flash and partition APIs 2016-11-16 13:33:04 +00:00			`SPI Flash and Partition APIs <api/spi_flash>`
Add SPI Master driver, example, test and docs 2017-01-06 06:20:32 +00:00			`SPI Master API <api/spi_master>`
API samples - Logging library - Virtual file system component 2016-10-29 21:00:30 +00:00			`Logging <api/log>`
deep-sleep-stub added + TOC outline TOC outline to show overal planned structure 2016-11-05 16:13:44 +00:00			`Non-Volatile Storage <api/nvs_flash>`
			`Virtual Filesystem <api/vfs>`
docs: add sdmmc and fatfs docs 2017-01-08 20:09:09 +00:00			`FAT Filesystem <api/fatfs>`
ethernet: add first version of ethernet driver 2016-11-08 09:45:17 +00:00			`Ethernet <api/esp_eth>`
Add interrupt allocation scheme / interrupt sharing. Also modifies drivers and examples. Also allows interrupts to be marked specifically as having a handler that's all in IRAM. 2016-11-25 09:33:51 +00:00			`Interrupt Allocation <api/intr_alloc>`
Fix small things noticed in MR, add documentation 2016-12-13 09:01:10 +00:00			`Memory Allocation <api/mem_alloc>`
deep sleep: add documentation 2016-12-16 06:26:52 +00:00			`Deep Sleep <api/deep_sleep>`
deep-sleep-stub added + TOC outline TOC outline to show overal planned structure 2016-11-05 16:13:44 +00:00			`deep-sleep-stub`

Initial mDNS component and example 2017-01-04 16:54:07 +00:00			`mDNS <api/mdns>`
API template - reflected template in other DRAFT API dcouments - DRAFT of Bluetooth API - link fixes in CONTRIBUTING.rst 2016-10-26 19:08:36 +00:00			`Template <api/template>`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 20:14:24 +00:00
			`.. toctree::`
Make section 2016-10-25 19:28:21 +00:00			`:caption: Technical Reference`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 20:14:24 +00:00
Make section 2016-10-25 19:28:21 +00:00			`Technical Reference <http://espressif.com/sites/default/files/documentation/esp32_technical_reference_manual_en.pdf>`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 20:14:24 +00:00
			`.. Resources - TBA`

			`.. toctree::`
			`:caption: Contribute`
			`:maxdepth: 1`

			`contributing`
New items to documentation TOC - Style Guide - UART API 2016-11-10 21:47:29 +00:00			`Style Guide <style-guide>`
Guide on documenting code 2016-10-30 18:38:44 +00:00			`documenting-code`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 20:14:24 +00:00			`contributor-agreement`

			`.. toctree::`
Initial list of Wi-Fi API 2016-10-24 18:44:57 +00:00			`:caption: Legal`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 20:14:24 +00:00			`:maxdepth: 1`

			`COPYRIGHT`

Make section 2016-10-25 19:28:21 +00:00
			`Indices`
doc: Index clean up 2016-11-16 19:17:44 +00:00			`-------`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 20:14:24 +00:00
			* :ref:`genindex`
			* :ref:`search`
deep-sleep-stub added + TOC outline TOC outline to show overal planned structure 2016-11-05 16:13:44 +00:00