mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
deep-sleep-stub added + TOC outline
TOC outline to show overal planned structure
This commit is contained in:
parent
adca98348e
commit
7bcd68fb30
@ -5,7 +5,6 @@ ESP32 Programming Guide
|
|||||||
|
|
||||||
Until ESP-IDF release 1.0, this documentation is a draft. It is incomplete and may have mistakes. Please mind your step!
|
Until ESP-IDF release 1.0, this documentation is a draft. It is incomplete and may have mistakes. Please mind your step!
|
||||||
|
|
||||||
|
|
||||||
Contents:
|
Contents:
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
@ -16,8 +15,6 @@ Contents:
|
|||||||
Linux <linux-setup>
|
Linux <linux-setup>
|
||||||
Mac OS <macos-setup>
|
Mac OS <macos-setup>
|
||||||
|
|
||||||
.. Configure - TBA
|
|
||||||
|
|
||||||
.. Connect - TBA
|
.. Connect - TBA
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
@ -35,16 +32,74 @@ Contents:
|
|||||||
build_system
|
build_system
|
||||||
openocd
|
openocd
|
||||||
|
|
||||||
|
.. 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 - TBA
|
||||||
|
1.4. Lower Power Coprocessor - TBA
|
||||||
|
1.5. Watchdogs
|
||||||
|
1.6. ...
|
||||||
|
2. Memeory - 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 - TBA
|
||||||
|
6.5. I2C - TBA
|
||||||
|
6.6. I2S - TBA
|
||||||
|
6.7. SPI - TBA
|
||||||
|
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 <api/log>
|
||||||
|
9.2 Non-Volatile Storage <api/nvs_flash>
|
||||||
|
9.3 Virtual Filesystem <api/vfs>
|
||||||
|
9.3. Http sever - TBA
|
||||||
|
10. Applications - TBA
|
||||||
|
..
|
||||||
|
API Dcoumentation Teamplate
|
||||||
|
..
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:caption: API Reference
|
:caption: API Reference
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
Wi-Fi <api/esp_wifi>
|
Wi-Fi <api/esp_wifi>
|
||||||
Bluetooth <api/bt>
|
Bluetooth <api/bt>
|
||||||
|
|
||||||
GPIO <api/gpio>
|
GPIO <api/gpio>
|
||||||
|
LED Control <api/ledc>
|
||||||
|
|
||||||
Logging <api/log>
|
Logging <api/log>
|
||||||
Non-volatile storage <api/nvs>
|
Non-Volatile Storage <api/nvs_flash>
|
||||||
Virtual filesystem <api/vfs>
|
Virtual Filesystem <api/vfs>
|
||||||
|
deep-sleep-stub
|
||||||
|
|
||||||
Template <api/template>
|
Template <api/template>
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
@ -76,3 +131,4 @@ Indices
|
|||||||
|
|
||||||
* :ref:`genindex`
|
* :ref:`genindex`
|
||||||
* :ref:`search`
|
* :ref:`search`
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user