Skip to content

Commit ffdfd7e

Browse files
pedrominatelpedrominatel
authored
Added missing API references (#7553)
API docs changes according to the PR review Contribution message updated
1 parent 5d614f5 commit ffdfd7e

13 files changed

+244
-5
lines changed

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ boards.sloeber.txt
3232
# Ignore docs build (Sphinx)
3333
docs/build
3434
docs/source/_build
35+
__pycache__/
36+
_build/
3537

3638
# Test log files
3739
*.log

‎docs/source/api/ble.rst

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
###
2+
BLE
3+
###
4+
5+
About
6+
-----
7+
8+
.. note:: This is a work in progress project and this section is still missing. If you want to contribute, please see the `Contributions Guide <../contributing.html>`_.
9+
10+
Examples
11+
--------
12+
13+
To get started with BLE, you can try:
14+
15+
BLE Scan
16+
********
17+
18+
.. literalinclude:: ../../../libraries/BLE/examples/BLE_scan/BLE_scan.ino
19+
:language: arduino
20+
21+
BLE UART
22+
********
23+
24+
.. literalinclude:: ../../../libraries/BLE/examples/BLE_uart/BLE_uart.ino
25+
:language: arduino
26+
27+
Complete list of `BLE examples <https://github.com/espressif/arduino-esp32/tree/master/libraries/BLE/examples>`_.

‎docs/source/api/bluetooth.rst

+27-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,27 @@
1-
#############
2-
Bluetooth API
3-
#############
1+
#########
2+
Bluetooth
3+
#########
4+
5+
About
6+
-----
7+
8+
.. note:: This is a work in progress project and this section is still missing. If you want to contribute, please see the `Contributions Guide <../contributing.html>`_.
9+
10+
Examples
11+
--------
12+
13+
To get started with Bluetooth, you can try:
14+
15+
Serial To Serial BT
16+
*******************
17+
18+
.. literalinclude:: ../../../libraries/BluetoothSerial/examples/SerialToSerialBT/SerialToSerialBT.ino
19+
:language: arduino
20+
21+
BT Classic Device Discovery
22+
***************************
23+
24+
.. literalinclude:: ../../../libraries/BluetoothSerial/examples/bt_classic_device_discovery/bt_classic_device_discovery.ino
25+
:language: arduino
26+
27+
Complete list of `Bluetooth examples <https://github.com/espressif/arduino-esp32/tree/master/libraries/BluetoothSerial/examples>`_.

‎docs/source/api/deepsleep.rst

+22
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. If you want to contribute, please see the `Contributions Guide <../contributing.html>`_.
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

+16-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,22 @@ 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+
.. note:: This is a work in progress project and this section is still missing. If you want to contribute, please see the `Contributions Guide <../contributing.html>`_.
9+
10+
Examples
11+
--------
12+
13+
ESP-NOW Master
14+
**************
15+
16+
.. literalinclude:: ../../../libraries/ESP32/examples/ESPNow/Basic/Master/Master.ino
17+
:language: arduino
18+
19+
ESP-NOW Slave
20+
*************
21+
22+
.. literalinclude:: ../../../libraries/ESP32/examples/ESPNow/Basic/Slave/Slave.ino
23+
:language: arduino
1024

1125
Resources
1226
---------

‎docs/source/api/ethernet.rst

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
########
2+
Ethernet
3+
########
4+
5+
About
6+
-----
7+
8+
.. note:: This is a work in progress project and this section is still missing. If you want to contribute, please see the `Contributions Guide <../contributing.html>`_.
9+
10+
Examples
11+
--------
12+
13+
To get started with Ethernet, you can try:
14+
15+
LAN8720
16+
*******
17+
18+
.. literalinclude:: ../../../libraries/Ethernet/examples/ETH_LAN8720/ETH_LAN8720.ino
19+
:language: arduino
20+
21+
TLK110
22+
******
23+
24+
.. literalinclude:: ../../../libraries/Ethernet/examples/ETH_TLK110/ETH_TLK110.ino
25+
:language: arduino
26+
27+
Complete list of `Ethernet examples <https://github.com/espressif/arduino-esp32/tree/master/libraries/Ethernet/examples>`_.

‎docs/source/api/hall_sensor.rst

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
###########
2+
Hall Sensor
3+
###########
4+
5+
About
6+
-----
7+
8+
.. note:: This is a work in progress project and this section is still missing. If you want to contribute, please see the `Contributions Guide <../contributing.html>`_.
9+
10+
Example
11+
-------
12+
13+
To get started with Hall sensor, you can try:
14+
15+
Hall Sensor
16+
***********
17+
18+
.. literalinclude:: ../../../libraries/ESP32/examples/HallSensor/HallSensor.ino
19+
:language: arduino

‎docs/source/api/pulse_counter.rst

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
#############
2+
Pulse Counter
3+
#############
4+
5+
About
6+
-----
7+
8+
.. note:: This peripheral is not supported yet by the Arduino API's.

‎docs/source/api/reset_reason.rst

+16
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. If you want to contribute, please see the `Contributions Guide <../contributing.html>`_.
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

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
###
2+
RMT
3+
###
4+
5+
About
6+
-----
7+
8+
.. note:: This is a work in progress project and this section is still missing. If you want to contribute, please see the `Contributions Guide <../contributing.html>`_.
9+
10+
Remote Control Transceiver (RMT) peripheral was designed to act as an infrared transceiver.
11+
12+
Example
13+
-------
14+
15+
To get started with RMT, you can try:
16+
17+
RMT Write Neo Pixel
18+
*******************
19+
20+
.. literalinclude:: ../../../libraries/ESP32/examples/RMT/RMTWriteNeoPixel/RMTWriteNeoPixel.ino
21+
:language: arduino
22+
23+
24+
Complete list of `RMT examples <https://github.com/espressif/arduino-esp32/tree/master/libraries/ESP32/examples/RMT>`_.

‎docs/source/api/sdio.rst

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
####
2+
SDIO
3+
####
4+
5+
About
6+
-----
7+
8+
.. note:: This peripheral is not supported yet by the Arduino API's.

‎docs/source/api/sdmmc.rst

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
######
2+
SD MMC
3+
######
4+
5+
About
6+
-----
7+
8+
.. note:: This is a work in progress project and this section is still missing. If you want to contribute, please see the `Contributions Guide <../contributing.html>`_.
9+
10+
Example
11+
-------
12+
13+
To get started with SD_MMC, you can try:
14+
15+
SDMMC Test
16+
**********
17+
18+
.. literalinclude:: ../../../libraries/SD_MMC/examples/SDMMC_Test/SDMMC_Test.ino
19+
:language: arduino
20+
21+
22+
Complete list of `SD MMC examples <https://github.com/espressif/arduino-esp32/tree/master/libraries/SD_MMC/examples>`_.

‎docs/source/api/spi.rst

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
###
2+
SPI
3+
###
4+
5+
About
6+
-----
7+
8+
For some APIs, the reference to be used is the same as the Arduino Core.
9+
10+
Arduino API Reference
11+
---------------------
12+
13+
`SPI Reference <https://www.arduino.cc/reference/en/language/functions/communication/spi/>`_
14+
15+
`SPI Description <https://docs.arduino.cc/learn/communication/spi>`_
16+
17+
Example
18+
-------
19+
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)