Skip to content

Commit a002f19

Browse files
committed
API docs changes according to the PR review
1 parent 7ccd405 commit a002f19

File tree

7 files changed

+72
-5
lines changed

7 files changed

+72
-5
lines changed

docs/source/api/deepsleep.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
11
##########
22
Deep Sleep
33
##########
4+
5+
About
6+
-----
7+
8+
.. note:: This is a work in progress project and this section is still missing.
9+
10+
Examples
11+
--------
12+
13+
To get started with Hall sensor, you can try:
14+
15+
ExternalWakeUp
16+
**************
17+
18+
.. literalinclude:: ../../../libraries/ESP32/examples/DeepSleep/ExternalWakeUp/ExternalWakeUp.ino
19+
:language: arduino
20+
21+
Timer Wake Up
22+
*************
23+
24+
.. literalinclude:: ../../../libraries/ESP32/examples/DeepSleep/TimerWakeUp/TimerWakeUp.ino
25+
:language: arduino

docs/source/api/espnow.rst

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,20 @@ ESP-NOW
55
ESP-NOW is a fast, connectionless communication technology featuring a short packet transmission.
66
ESP-NOW is ideal for smart lights, remote control devices, sensors and other applications.
77

8-
Example
9-
-------
8+
Examples
9+
--------
10+
11+
ESP-NOW Master
12+
**************
13+
14+
.. literalinclude:: ../../../libraries/ESP32/examples/ESPNow/Basic/Master/Master.ino
15+
:language: arduino
16+
17+
ESP-NOW Slave
18+
*************
19+
20+
.. literalinclude:: ../../../libraries/ESP32/examples/ESPNow/Basic/Slave/Slave.ino
21+
:language: arduino
1022

1123
Resources
1224
---------

docs/source/api/hall_sensor.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,10 @@ About
1010
Example
1111
-------
1212

13+
To get started with Hall sensor, you can try:
14+
15+
Hall Sensor
16+
***********
17+
1318
.. literalinclude:: ../../../libraries/ESP32/examples/HallSensor/HallSensor.ino
1419
:language: arduino

docs/source/api/reset_reason.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
11
############
22
Reset Reason
33
############
4+
5+
About
6+
-----
7+
8+
.. note:: This is a work in progress project and this section is still missing.
9+
10+
Example
11+
-------
12+
13+
To get started with Reset Reason, you can try:
14+
15+
Reset Reason
16+
************
17+
18+
.. literalinclude:: ../../../libraries/ESP32/examples/ResetReason/ResetReason.ino
19+
:language: arduino

docs/source/api/rmt.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,13 @@ About
77

88
.. note:: This is a work in progress project and this section is still missing.
99

10+
Remote Control Transceiver (RMT) peripheral was designed to act as an infrared transceiver.
11+
1012
Example
1113
-------
1214

15+
To get started with RMT, you can try:
16+
1317
RMT Write Neo Pixel
1418
*******************
1519

docs/source/api/sdmmc.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ About
1010
Example
1111
-------
1212

13+
To get started with SD_MMC, you can try:
14+
1315
SDMMC Test
1416
**********
1517

docs/source/api/spi.rst

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,13 @@ Arduino API Reference
1414

1515
`SPI Description <https://docs.arduino.cc/learn/communication/spi>`_
1616

17-
Examples
18-
--------
17+
Example
18+
-------
1919

20-
Complete list of `SPI examples <https://github.com/espressif/arduino-esp32/tree/master/libraries/SPI/examples>`_.
20+
To get started with SPI, you can try:
21+
22+
SPI Multiple Buses
23+
******************
24+
25+
.. literalinclude:: ../../../libraries/SPI/examples/SPI_Multiple_Buses/SPI_Multiple_Buses.ino
26+
:language: arduino

0 commit comments

Comments
 (0)