Skip to content

[Docs] Added supported peripherals list on libraries section #5829

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
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 52 additions & 1 deletion docs/source/libraries.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,60 @@ Libraries

Here is where the Libraries API's descriptions are located.

Supported Peripherals
---------------------

Currently, the Arduino ESP32 supports the following peripherals with Arduino style. Some other peripherals are not supported yet, but it's supported using ESP-IDF style.

+-------------+-------------+---------+--------------------+
| Peripheral | Arduino API | ESP-IDF | Comment |
+=============+=============+=========+====================+
| ADC | Yes | Yes | |
+-------------+-------------+---------+--------------------+
| DAC | No | No | |
+-------------+-------------+---------+--------------------+
| GPIO | Yes | Yes | |
+-------------+-------------+---------+--------------------+
| SDIO/SPI | Yes | Yes | |
+-------------+-------------+---------+--------------------+
| I2C | Yes | Yes | |
+-------------+-------------+---------+--------------------+
| I2S | No | Yes | In Development |
+-------------+-------------+---------+--------------------+
| Wi-Fi | Yes | Yes | |
+-------------+-------------+---------+--------------------+
| Bluetooth | Yes | Yes | |
+-------------+-------------+---------+--------------------+
| RMT | Yes | Yes | |
+-------------+-------------+---------+--------------------+
| Touch | Yes | Yes | ESP32 & ESP32-S2 |
+-------------+-------------+---------+--------------------+
| Timer | Yes | Yes | |
+-------------+-------------+---------+--------------------+
| UART | Yes | Yes | |
+-------------+-------------+---------+--------------------+
| Hall Sensor | Yes | Yes | Only for ESP32 |
+-------------+-------------+---------+--------------------+
| LEDC | Yes | Yes | |
+-------------+-------------+---------+--------------------+
| Motor PWM | No | No | |
+-------------+-------------+---------+--------------------+
| TWAI | No | No | |
+-------------+-------------+---------+--------------------+
| Ethernet | Yes | Yes | Only for ESP32 |
+-------------+-------------+---------+--------------------+
| USB | Yes | Yes | Only for ESP32-S2 |
+-------------+-------------+---------+--------------------+

Some peripherals are not available for all ESP32 families. To see more details about it, see the corresponding datasheet.

APIs
----

The Arduino ESP32 offers some unique APIs, described in this section:

.. toctree::
:maxdepth: 1
:caption: API's:

Bluetooth <api/bluetooth>
Deep Sleep <api/deepsleep>
Expand Down