Skip to content

[Docs] Peripheral list updated to include all supported SoCs #5851

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.

Sign up for GitHub

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 7 commits into from
Nov 8, 2021
Merged

[Docs] Peripheral list updated to include all supported SoCs #5851

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
00cc8cf
docs: Changes on the peripherals table now by ESP32 family
pedrominatel Nov 4, 2021
4ac68dd
docs: Peripheral list updated
pedrominatel Nov 5, 2021
0bd4036
docs: Fix on ESP-IDF as component
pedrominatel Nov 5, 2021
01dcc96
docs: Added product selector link
pedrominatel Nov 5, 2021
13ba0f2
docs: Temp sensor removed from ESP32 support
pedrominatel Nov 5, 2021
20b2932
docs: Peripheral Table updated according to the review
pedrominatel Nov 8, 2021
6d9a2fe
docs: Added Ethernet notes for RMII and SPI support
pedrominatel Nov 8, 2021
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
3 changes: 1 addition & 2 deletions docs/source/esp-idf_component.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ For a simplified method, see `lib-builder <lib_builder>`_.
Installation
------------

.. note::
Latest Arduino Core ESP32 version is now compatible with [ESP-IDF v4.4](https://github.com/espressif/esp-idf/tree/release/v4.4). Please consider this compability when using Arduino as component in ESP-IDF.
.. note:: Latest Arduino Core ESP32 version is now compatible with [ESP-IDF v4.4](https://github.com/espressif/esp-idf/tree/release/v4.4). Please consider this compability when using Arduino as component in ESP-IDF.

- Download and install `ESP-IDF <https://github.com/espressif/esp-idf>`_.
- Create blank idf project (from one of the examples).
Expand Down
86 changes: 45 additions & 41 deletions docs/source/libraries.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,49 +7,53 @@ 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.
Currently, the Arduino ESP32 supports the following peripherals with Arduino APIs.

+-------------+-------------+---------+--------------------+
| 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 |
+-------------+-------------+---------+--------------------+
+---------------+---------------+---------------+---------------+--------------------+
| Peripheral | ESP32 | ESP32-S2 | ESP32-C3 | Comments |
+===============+===============+===============+===============+====================+
| ADC | Yes | Yes | Yes | |
+---------------+---------------+---------------+---------------+--------------------+
| Bluetooth | Yes | Not Supported | Yes | |
+---------------+---------------+---------------+---------------+--------------------+
| DAC | No | No | No | Planned |
+---------------+---------------+---------------+---------------+--------------------+
| Ethernet | Yes | Not Supported | Not Supported | |
+---------------+---------------+---------------+---------------+--------------------+
| GPIO | Yes | Yes | Yes | |
+---------------+---------------+---------------+---------------+--------------------+
| Hall Sensor | Yes | Not Supported | Not Supported | |
+---------------+---------------+---------------+---------------+--------------------+
| I2C | Yes | Yes | Yes | |
+---------------+---------------+---------------+---------------+--------------------+
| I2S | No | No | No | WIP |
+---------------+---------------+---------------+---------------+--------------------+
| LEDC | Yes | Yes | Yes | |
+---------------+---------------+---------------+---------------+--------------------+
| Motor PWM | No | Not Supported | Not Supported | |
+---------------+---------------+---------------+---------------+--------------------+
| Pulse Counter | Yes | Yes | Yes | |
+---------------+---------------+---------------+---------------+--------------------+
| RMT | Yes | Yes | Yes | |
+---------------+---------------+---------------+---------------+--------------------+
| SDIO/SPI | Yes | Yes | Yes | |
+---------------+---------------+---------------+---------------+--------------------+
| Timer | Yes | Yes | Yes | |
+---------------+---------------+---------------+---------------+--------------------+
| Temp. Sensor | Not Supported | Yes | Yes | |
+---------------+---------------+---------------+---------------+--------------------+
| Touch | Yes | Yes | Not Supported | |
+---------------+---------------+---------------+---------------+--------------------+
| TWAI | No | No | No | |
+---------------+---------------+---------------+---------------+--------------------+
| UART | Yes | Yes | Yes | |
+---------------+---------------+---------------+---------------+--------------------+
| USB | Not Supported | Yes | Yes | ESP32-C3 only CDC |
+---------------+---------------+---------------+---------------+--------------------+
| Wi-Fi | Yes | Yes | Yes | |
+---------------+---------------+---------------+---------------+--------------------+

Some peripherals are not available for all ESP32 families. To see more details about it, see the corresponding datasheet.
Some peripherals are not available for all ESP32 families. To see more details about it, see the corresponding SoC at `Product Selector <https://products.espressif.com>`_ page.

APIs
----
Expand Down