Skip to content

Commit 7ccd405

Browse files
committed
Added missing API references
1 parent 3968aa9 commit 7ccd405

File tree

10 files changed

+173
-3
lines changed

10 files changed

+173
-3
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ boards.sloeber.txt
3131
# Ignore docs build (Sphinx)
3232
docs/build
3333
docs/source/_build
34+
__pycache__/
35+
_build/
3436

3537
# Test log files
3638
*.log

docs/source/api/ble.rst

Lines changed: 27 additions & 0 deletions
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.
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

Lines changed: 27 additions & 3 deletions
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.
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/ethernet.rst

Lines changed: 27 additions & 0 deletions
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.
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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
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.
9+
10+
Example
11+
-------
12+
13+
.. literalinclude:: ../../../libraries/ESP32/examples/HallSensor/HallSensor.ino
14+
:language: arduino

docs/source/api/pulse_counter.rst

Lines changed: 8 additions & 0 deletions
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/rmt.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
###
2+
RMT
3+
###
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+
RMT Write Neo Pixel
14+
*******************
15+
16+
.. literalinclude:: ../../../libraries/ESP32/examples/RMT/RMTWriteNeoPixel/RMTWriteNeoPixel.ino
17+
:language: arduino
18+
19+
20+
Complete list of `RMT examples <https://github.com/espressif/arduino-esp32/tree/master/libraries/ESP32/examples/RMT>`_.

docs/source/api/sdio.rst

Lines changed: 8 additions & 0 deletions
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

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
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.
9+
10+
Example
11+
-------
12+
13+
SDMMC Test
14+
**********
15+
16+
.. literalinclude:: ../../../libraries/SD_MMC/examples/SDMMC_Test/SDMMC_Test.ino
17+
:language: arduino
18+
19+
20+
Complete list of `SD MMC examples <https://github.com/espressif/arduino-esp32/tree/master/libraries/SD_MMC/examples>`_.

docs/source/api/spi.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
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+
Examples
18+
--------
19+
20+
Complete list of `SPI examples <https://github.com/espressif/arduino-esp32/tree/master/libraries/SPI/examples>`_.

0 commit comments

Comments
 (0)