-
Notifications
You must be signed in to change notification settings - Fork 7.6k
Added missing API references #7553
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
VojtechBartoska
merged 3 commits into
espressif:master
from
pedrominatel:add_arduino_api_references
Dec 14, 2022
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 <https://github.com/espressif/arduino-esp32/tree/master/libraries/BLE/examples>`_. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 <https://github.com/espressif/arduino-esp32/tree/master/libraries/BluetoothSerial/examples>`_. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 <https://github.com/espressif/arduino-esp32/tree/master/libraries/Ethernet/examples>`_. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
############# | ||
Pulse Counter | ||
############# | ||
|
||
About | ||
----- | ||
|
||
.. note:: This peripheral is not supported yet by the Arduino API's. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
------- | ||
|
||
pedrominatel marked this conversation as resolved.
Show resolved
Hide resolved
|
||
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 <https://github.com/espressif/arduino-esp32/tree/master/libraries/ESP32/examples/RMT>`_. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
#### | ||
SDIO | ||
#### | ||
|
||
About | ||
----- | ||
|
||
.. note:: This peripheral is not supported yet by the Arduino API's. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
------- | ||
|
||
pedrominatel marked this conversation as resolved.
Show resolved
Hide resolved
|
||
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 <https://github.com/espressif/arduino-esp32/tree/master/libraries/SD_MMC/examples>`_. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 <https://www.arduino.cc/reference/en/language/functions/communication/spi/>`_ | ||
|
||
`SPI Description <https://docs.arduino.cc/learn/communication/spi>`_ | ||
|
||
Example | ||
------- | ||
|
||
pedrominatel marked this conversation as resolved.
Show resolved
Hide resolved
|
||
To get started with SPI, you can try: | ||
|
||
SPI Multiple Buses | ||
****************** | ||
|
||
.. literalinclude:: ../../../libraries/SPI/examples/SPI_Multiple_Buses/SPI_Multiple_Buses.ino | ||
:language: arduino |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.