esp-idf/docs/index.rst

ESP32 Programming Guide
=======================

.. caution::

   Until ESP-IDF release 1.0, this documentation is a draft. It is incomplete and may have mistakes. Please mind your step!

Documentation adressed to developers of applications for `ESP32 <https://espressif.com/en/products/hardware/esp32/overview>`_ by `Espressif <https://espressif.com/>`_ using `esp-idf <https://github.com/espressif/esp-idf>`_.


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

   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`
Initial list of Wi-Fi API 2016-10-24 14:44:57 -04:00			`ESP32 Programming Guide`
			`=======================`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 16:14:24 -04:00
Changed title of docs 2016-10-29 17:35:12 -04:00			`.. caution::`

docs: fix typos, build docs with gitlab CI 2016-11-01 08:08:29 -04:00			`Until ESP-IDF release 1.0, this documentation is a draft. It is incomplete and may have mistakes. Please mind your step!`
Guide on documenting code 2016-10-30 14:38:44 -04:00
doc: Index clean up 2016-11-16 14:17:44 -05:00			Documentation adressed to developers of applications for `ESP32 <https://espressif.com/en/products/hardware/esp32/overview>`_ by `Espressif <https://espressif.com/>`_ using `esp-idf <https://github.com/espressif/esp-idf>`_.


Initial list of Wi-Fi API 2016-10-24 14:44:57 -04:00			`Contents:`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 16:14:24 -04:00
Initial list of Wi-Fi API 2016-10-24 14:44:57 -04:00			`.. toctree::`
			`:caption: Setup Toolchain`
			`:maxdepth: 1`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 16:14:24 -04:00
Initial list of Wi-Fi API 2016-10-24 14:44:57 -04:00			`Windows <windows-setup>`
			`Linux <linux-setup>`
			`Mac OS <macos-setup>`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 16:14:24 -04:00
Initial list of Wi-Fi API 2016-10-24 14:44:57 -04:00			`.. Connect - TBA`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 16:14:24 -04:00
Initial list of Wi-Fi API 2016-10-24 14:44:57 -04:00			`.. toctree::`
			`:caption: Build and Flash`
			`:maxdepth: 1`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 16:14:24 -04:00
Make section 2016-10-25 15:28:21 -04:00			`Make <make-project>`
Initial list of Wi-Fi API 2016-10-24 14:44:57 -04:00			`Eclipse IDE <eclipse-setup>`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 16:14:24 -04:00
			`.. toctree::`
API template - reflected template in other DRAFT API dcouments - DRAFT of Bluetooth API - link fixes in CONTRIBUTING.rst 2016-10-26 15:08:36 -04:00			`:caption: What Else?`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 16:14:24 -04:00			`:maxdepth: 1`
Initial list of Wi-Fi API 2016-10-24 14:44:57 -04:00
docs: add description of ESP-IDF application startup flow and memory layout 2016-11-14 02:40:54 -05:00			`General Notes <general-notes>`
Initial list of Wi-Fi API 2016-10-24 14:44:57 -04:00			`partition-tables`
			`build_system`
Make section 2016-10-25 15:28:21 -04:00			`openocd`
docs: fix some warnings 2016-12-16 01:27:22 -05:00			`Flash encryption <security/flash-encryption>`
Secure boot: Documentation tweaks 2016-11-10 23:40:29 -05:00			`Secure Boot <security/secure-boot>`
initial support for generation of ULP coprocessor code 2016-11-29 09:10:31 -05:00			`ULP coprocessor <api/ulp.rst>`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 16:14:24 -04:00
deep-sleep-stub added + TOC outline TOC outline to show overal planned structure 2016-11-05 12:13:44 -04: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 14:17:44 -05: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 12:13:44 -04:00			`1.4. Lower Power Coprocessor - TBA`
Add documentation 2016-11-16 23:09:08 -05:00			`1.5. Watchdogs <api/wdts>`
Fix small things noticed in MR, add documentation 2016-12-13 04:01:10 -05:00			`1.6. Memory allocation <api/mem_alloc>`
			`1.7. ...`
Add documentation 2016-11-16 23:09:08 -05:00			`2. Memory - TBA`
deep-sleep-stub added + TOC outline TOC outline to show overal planned structure 2016-11-05 12:13:44 -04: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 14:17:44 -05:00			`6.4. UART`
deep-sleep-stub added + TOC outline TOC outline to show overal planned structure 2016-11-05 12:13:44 -04:00			`6.5. I2C - TBA`
			`6.6. I2S - TBA`
Add SPI Master driver, example, test and docs 2017-01-06 01:20:32 -05:00			`6.7. SPI - <api/spi_master>`
deep-sleep-stub added + TOC outline TOC outline to show overal planned structure 2016-11-05 12:13:44 -04: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 14:17:44 -05: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 12:13:44 -04:00			`9.3. Http sever - TBA`
			`10. Applications - TBA`
			`..`
			`API Dcoumentation Teamplate`
			`..`

Initial list of Wi-Fi API 2016-10-24 14:44:57 -04:00			`.. toctree::`
			`:caption: API Reference`
			`:maxdepth: 1`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 16:14:24 -04:00
Initial list of Wi-Fi API 2016-10-24 14:44:57 -04: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-11 21:00:24 -05: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 15:08:36 -04:00			`Bluetooth <api/bt>`
Add documentation 2016-11-16 23:09:08 -05:00			`Watchdogs <api/wdts>`
feature/fota_ops_api: add ota core api implement 2016-11-28 00:53:03 -05:00			`OTA <api/ota>`
update docs/index.rst 2016-11-23 08:22:19 -05: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 10:41:04 -05:00			`I2C <api/i2c>`
update docs/index.rst 2016-11-23 08:25:06 -05: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 03:28:16 -05:00			`Sigma-delta Modulation <api/sigmadelta>`
docs: add sdmmc and fatfs docs 2017-01-08 15:09:09 -05:00			`SD/MMC <api/sdmmc>`
docs: fix broken links, formatting, add SPI flash and partition APIs 2016-11-16 08:33:04 -05:00			`SPI Flash and Partition APIs <api/spi_flash>`
Add SPI Master driver, example, test and docs 2017-01-06 01:20:32 -05:00			`SPI Master API <api/spi_master>`
API samples - Logging library - Virtual file system component 2016-10-29 17:00:30 -04:00			`Logging <api/log>`
deep-sleep-stub added + TOC outline TOC outline to show overal planned structure 2016-11-05 12:13:44 -04:00			`Non-Volatile Storage <api/nvs_flash>`
			`Virtual Filesystem <api/vfs>`
docs: add sdmmc and fatfs docs 2017-01-08 15:09:09 -05:00			`FAT Filesystem <api/fatfs>`
ethernet: add first version of ethernet driver 2016-11-08 04:45:17 -05: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 04:33:51 -05:00			`Interrupt Allocation <api/intr_alloc>`
Fix small things noticed in MR, add documentation 2016-12-13 04:01:10 -05:00			`Memory Allocation <api/mem_alloc>`
deep sleep: add documentation 2016-12-16 01:26:52 -05:00			`Deep Sleep <api/deep_sleep>`
deep-sleep-stub added + TOC outline TOC outline to show overal planned structure 2016-11-05 12:13:44 -04:00			`deep-sleep-stub`

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

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

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

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

			`COPYRIGHT`

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