From 51bb3a5a493250138da1c0d698bffed89773ec20 Mon Sep 17 00:00:00 2001 From: "pedro.minatel" Date: Mon, 5 Dec 2022 17:05:42 +0000 Subject: [PATCH] Added missing API references API docs changes according to the PR review Contribution message updated --- .gitignore | 2 ++ docs/source/api/ble.rst | 27 +++++++++++++++++++++++++++ docs/source/api/bluetooth.rst | 30 +++++++++++++++++++++++++++--- docs/source/api/deepsleep.rst | 22 ++++++++++++++++++++++ docs/source/api/espnow.rst | 18 ++++++++++++++++-- docs/source/api/ethernet.rst | 27 +++++++++++++++++++++++++++ docs/source/api/hall_sensor.rst | 19 +++++++++++++++++++ docs/source/api/pulse_counter.rst | 8 ++++++++ docs/source/api/reset_reason.rst | 16 ++++++++++++++++ docs/source/api/rmt.rst | 24 ++++++++++++++++++++++++ docs/source/api/sdio.rst | 8 ++++++++ docs/source/api/sdmmc.rst | 22 ++++++++++++++++++++++ docs/source/api/spi.rst | 26 ++++++++++++++++++++++++++ 13 files changed, 244 insertions(+), 5 deletions(-) create mode 100644 docs/source/api/ble.rst create mode 100644 docs/source/api/ethernet.rst create mode 100644 docs/source/api/hall_sensor.rst create mode 100644 docs/source/api/pulse_counter.rst create mode 100644 docs/source/api/rmt.rst create mode 100644 docs/source/api/sdio.rst create mode 100644 docs/source/api/sdmmc.rst create mode 100644 docs/source/api/spi.rst diff --git a/.gitignore b/.gitignore index 4021fd8abce..8cccabdc008 100644 --- a/.gitignore +++ b/.gitignore @@ -31,6 +31,8 @@ boards.sloeber.txt # Ignore docs build (Sphinx) docs/build docs/source/_build +__pycache__/ +_build/ # Test log files *.log diff --git a/docs/source/api/ble.rst b/docs/source/api/ble.rst new file mode 100644 index 00000000000..12a8e1280b7 --- /dev/null +++ b/docs/source/api/ble.rst @@ -0,0 +1,27 @@ +### +BLE +### + +About +----- + +.. 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>`_. + +Examples +-------- + +To get started with BLE, you can try: + +BLE Scan +******** + +.. literalinclude:: ../../../libraries/BLE/examples/BLE_scan/BLE_scan.ino + :language: arduino + +BLE UART +******** + +.. literalinclude:: ../../../libraries/BLE/examples/BLE_uart/BLE_uart.ino + :language: arduino + +Complete list of `BLE examples `_. diff --git a/docs/source/api/bluetooth.rst b/docs/source/api/bluetooth.rst index a24aaa4561a..b652d200a51 100644 --- a/docs/source/api/bluetooth.rst +++ b/docs/source/api/bluetooth.rst @@ -1,3 +1,27 @@ -############# -Bluetooth API -############# +######### +Bluetooth +######### + +About +----- + +.. 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>`_. + +Examples +-------- + +To get started with Bluetooth, you can try: + +Serial To Serial BT +******************* + +.. literalinclude:: ../../../libraries/BluetoothSerial/examples/SerialToSerialBT/SerialToSerialBT.ino + :language: arduino + +BT Classic Device Discovery +*************************** + +.. literalinclude:: ../../../libraries/BluetoothSerial/examples/bt_classic_device_discovery/bt_classic_device_discovery.ino + :language: arduino + +Complete list of `Bluetooth examples `_. diff --git a/docs/source/api/deepsleep.rst b/docs/source/api/deepsleep.rst index 933a296e8fa..6c06f8fc628 100644 --- a/docs/source/api/deepsleep.rst +++ b/docs/source/api/deepsleep.rst @@ -1,3 +1,25 @@ ########## Deep Sleep ########## + +About +----- + +.. 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>`_. + +Examples +-------- + +To get started with Hall sensor, you can try: + +ExternalWakeUp +************** + +.. literalinclude:: ../../../libraries/ESP32/examples/DeepSleep/ExternalWakeUp/ExternalWakeUp.ino + :language: arduino + +Timer Wake Up +************* + +.. literalinclude:: ../../../libraries/ESP32/examples/DeepSleep/TimerWakeUp/TimerWakeUp.ino + :language: arduino diff --git a/docs/source/api/espnow.rst b/docs/source/api/espnow.rst index 99c90335ea9..b26d47c3828 100644 --- a/docs/source/api/espnow.rst +++ b/docs/source/api/espnow.rst @@ -5,8 +5,22 @@ ESP-NOW ESP-NOW is a fast, connectionless communication technology featuring a short packet transmission. ESP-NOW is ideal for smart lights, remote control devices, sensors and other applications. -Example -------- +.. 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>`_. + +Examples +-------- + +ESP-NOW Master +************** + +.. literalinclude:: ../../../libraries/ESP32/examples/ESPNow/Basic/Master/Master.ino + :language: arduino + +ESP-NOW Slave +************* + +.. literalinclude:: ../../../libraries/ESP32/examples/ESPNow/Basic/Slave/Slave.ino + :language: arduino Resources --------- diff --git a/docs/source/api/ethernet.rst b/docs/source/api/ethernet.rst new file mode 100644 index 00000000000..9a7bd5687cb --- /dev/null +++ b/docs/source/api/ethernet.rst @@ -0,0 +1,27 @@ +######## +Ethernet +######## + +About +----- + +.. 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>`_. + +Examples +-------- + +To get started with Ethernet, you can try: + +LAN8720 +******* + +.. literalinclude:: ../../../libraries/Ethernet/examples/ETH_LAN8720/ETH_LAN8720.ino + :language: arduino + +TLK110 +****** + +.. literalinclude:: ../../../libraries/Ethernet/examples/ETH_TLK110/ETH_TLK110.ino + :language: arduino + +Complete list of `Ethernet examples `_. diff --git a/docs/source/api/hall_sensor.rst b/docs/source/api/hall_sensor.rst new file mode 100644 index 00000000000..7ab856eb172 --- /dev/null +++ b/docs/source/api/hall_sensor.rst @@ -0,0 +1,19 @@ +########### +Hall Sensor +########### + +About +----- + +.. 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>`_. + +Example +------- + +To get started with Hall sensor, you can try: + +Hall Sensor +*********** + +.. literalinclude:: ../../../libraries/ESP32/examples/HallSensor/HallSensor.ino + :language: arduino diff --git a/docs/source/api/pulse_counter.rst b/docs/source/api/pulse_counter.rst new file mode 100644 index 00000000000..2fedd8ffd96 --- /dev/null +++ b/docs/source/api/pulse_counter.rst @@ -0,0 +1,8 @@ +############# +Pulse Counter +############# + +About +----- + +.. note:: This peripheral is not supported yet by the Arduino API's. diff --git a/docs/source/api/reset_reason.rst b/docs/source/api/reset_reason.rst index ddccffa0372..49bf9397797 100644 --- a/docs/source/api/reset_reason.rst +++ b/docs/source/api/reset_reason.rst @@ -1,3 +1,19 @@ ############ Reset Reason ############ + +About +----- + +.. 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>`_. + +Example +------- + +To get started with Reset Reason, you can try: + +Reset Reason +************ + +.. literalinclude:: ../../../libraries/ESP32/examples/ResetReason/ResetReason.ino + :language: arduino \ No newline at end of file diff --git a/docs/source/api/rmt.rst b/docs/source/api/rmt.rst new file mode 100644 index 00000000000..1622b507050 --- /dev/null +++ b/docs/source/api/rmt.rst @@ -0,0 +1,24 @@ +### +RMT +### + +About +----- + +.. 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>`_. + +Remote Control Transceiver (RMT) peripheral was designed to act as an infrared transceiver. + +Example +------- + +To get started with RMT, you can try: + +RMT Write Neo Pixel +******************* + +.. literalinclude:: ../../../libraries/ESP32/examples/RMT/RMTWriteNeoPixel/RMTWriteNeoPixel.ino + :language: arduino + + +Complete list of `RMT examples `_. diff --git a/docs/source/api/sdio.rst b/docs/source/api/sdio.rst new file mode 100644 index 00000000000..d057e71db3a --- /dev/null +++ b/docs/source/api/sdio.rst @@ -0,0 +1,8 @@ +#### +SDIO +#### + +About +----- + +.. note:: This peripheral is not supported yet by the Arduino API's. diff --git a/docs/source/api/sdmmc.rst b/docs/source/api/sdmmc.rst new file mode 100644 index 00000000000..69b612b4876 --- /dev/null +++ b/docs/source/api/sdmmc.rst @@ -0,0 +1,22 @@ +###### +SD MMC +###### + +About +----- + +.. 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>`_. + +Example +------- + +To get started with SD_MMC, you can try: + +SDMMC Test +********** + +.. literalinclude:: ../../../libraries/SD_MMC/examples/SDMMC_Test/SDMMC_Test.ino + :language: arduino + + +Complete list of `SD MMC examples `_. diff --git a/docs/source/api/spi.rst b/docs/source/api/spi.rst new file mode 100644 index 00000000000..c82b0de5ccb --- /dev/null +++ b/docs/source/api/spi.rst @@ -0,0 +1,26 @@ +### +SPI +### + +About +----- + +For some APIs, the reference to be used is the same as the Arduino Core. + +Arduino API Reference +--------------------- + +`SPI Reference `_ + +`SPI Description `_ + +Example +------- + +To get started with SPI, you can try: + +SPI Multiple Buses +****************** + +.. literalinclude:: ../../../libraries/SPI/examples/SPI_Multiple_Buses/SPI_Multiple_Buses.ino + :language: arduino