index.rst 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. ESP-IDF Programming Guide
  2. =========================
  3. 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.
  4. Contents:
  5. .. toctree::
  6. :caption: Setup Toolchain
  7. :maxdepth: 1
  8. Windows <windows-setup>
  9. Linux <linux-setup>
  10. Mac OS <macos-setup>
  11. .. Connect - TBA
  12. .. toctree::
  13. :caption: Build and Flash
  14. :maxdepth: 1
  15. Make <make-project>
  16. Eclipse IDE <eclipse-setup>
  17. .. toctree::
  18. :caption: What Else?
  19. :maxdepth: 1
  20. General Notes <general-notes>
  21. Build System <build-system>
  22. Debugging <openocd>
  23. ESP32 Core Dump <core_dump>
  24. Partition Tables <partition-tables>
  25. Flash Encryption <security/flash-encryption>
  26. Secure Boot <security/secure-boot>
  27. Deep Sleep Wake Stubs <deep-sleep-stub>
  28. ULP Coprocessor <ulp>
  29. Unit Testing <unit-tests>
  30. .. toctree::
  31. :caption: API Reference
  32. :maxdepth: 2
  33. Wi-Fi <api/wifi/index>
  34. Bluetooth <api/bluetooth/index>
  35. Ethernet <api/ethernet/index>
  36. Peripherals <api/peripherals/index>
  37. System <api/system/index>
  38. Storage <api/storage/index>
  39. Protocols <api/protocols/index>
  40. .. toctree::
  41. :caption: Hardware Reference
  42. Technical Reference Manual (PDF) <http://espressif.com/sites/default/files/documentation/esp32_technical_reference_manual_en.pdf>
  43. Pin List and Functions (PDF) <http://espressif.com/sites/default/files/documentation/esp32_chip_pin_list_en.pdf>
  44. Chip Pinout (PDF) <http://espressif.com/sites/default/files/documentation/esp32_pinout_v1_0.pdf>
  45. Silicon Errata (PDF) <http://espressif.com/sites/default/files/documentation/eco_and_workarounds_for_bugs_in_esp32_en.pdf>
  46. Modules and Boards <modules-and-boards>
  47. .. toctree::
  48. :caption: Contribute
  49. :maxdepth: 1
  50. Contributions Guide <contributing>
  51. Style Guide <style-guide>
  52. Documenting Code <documenting-code>
  53. API Template <api/template>
  54. Contributor Agreement <contributor-agreement>
  55. .. toctree::
  56. :caption: Legal
  57. :maxdepth: 1
  58. COPYRIGHT
  59. Indices
  60. =======
  61. * :ref:`genindex`