esp-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>
   IDF Monitor <idf-monitor>

.. toctree::
   :caption: What Else?
   :maxdepth: 1

   General Notes <general-notes>
   Build System <build-system>
   Debugging <openocd>
   ESP32 Core Dump <core_dump>
   Partition Tables <partition-tables>
   Flash Encryption <security/flash-encryption>
   Secure Boot <security/secure-boot>
   Deep Sleep Wake Stubs <deep-sleep-stub>
   ULP Coprocessor <ulp>
   Unit Testing <unit-tests>

.. toctree::
   :caption: API Reference
   :maxdepth: 2

   Wi-Fi <api/wifi/index>
   Bluetooth <api/bluetooth/index>
   Ethernet <api/ethernet/index>
   Peripherals <api/peripherals/index>
   System <api/system/index>
   Storage <api/storage/index>
   Protocols <api/protocols/index>

.. toctree::
   :caption: Hardware Reference

   Technical Reference Manual (PDF) <http://espressif.com/sites/default/files/documentation/esp32_technical_reference_manual_en.pdf>
   Pin List and Functions (PDF) <http://espressif.com/sites/default/files/documentation/esp32_chip_pin_list_en.pdf>
   Chip Pinout (PDF) <http://espressif.com/sites/default/files/documentation/esp32_pinout_v1_0.pdf>
   Silicon Errata (PDF) <http://espressif.com/sites/default/files/documentation/eco_and_workarounds_for_bugs_in_esp32_en.pdf>
   Modules and Boards <modules-and-boards>
   
.. toctree::
   :caption: Contribute
   :maxdepth: 1

   Contributions Guide <contributing>
   Style Guide <style-guide>
   Documenting Code <documenting-code>
   API Template <api/template>
   Contributor Agreement <contributor-agreement>

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

   COPYRIGHT

 
Indices
=======

* :ref:`genindex`