Skip to content

Commit b1497fb

Browse files
pedrominatelpedrominatel
authored
[Docs] Peripheral list updated to include all supported SoCs (espressif#5851)
1 parent 5e04eb4 commit b1497fb

File tree

2 files changed

+62
-43
lines changed

2 files changed

+62
-43
lines changed

‎docs/source/esp-idf_component.rst

+1-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ For a simplified method, see `lib-builder <lib_builder>`_.
1010
Installation
1111
------------
1212

13-
.. note::
14-
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.
13+
.. 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.
1514

1615
- Download and install `ESP-IDF <https://github.com/espressif/esp-idf>`_.
1716
- Create blank idf project (from one of the examples).

‎docs/source/libraries.rst

+61-41
Original file line numberDiff line numberDiff line change
@@ -7,49 +7,69 @@ Here is where the Libraries API's descriptions are located:
77
Supported Peripherals
88
---------------------
99

10-
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.
10+
Currently, the Arduino ESP32 supports the following peripherals with Arduino APIs.
1111

12-
+-------------+-------------+---------+--------------------+
13-
| Peripheral | Arduino API | ESP-IDF | Comment |
14-
+=============+=============+=========+====================+
15-
| ADC | Yes | Yes | |
16-
+-------------+-------------+---------+--------------------+
17-
| DAC | No | No | |
18-
+-------------+-------------+---------+--------------------+
19-
| GPIO | Yes | Yes | |
20-
+-------------+-------------+---------+--------------------+
21-
| SDIO/SPI | Yes | Yes | |
22-
+-------------+-------------+---------+--------------------+
23-
| I2C | Yes | Yes | |
24-
+-------------+-------------+---------+--------------------+
25-
| I2S | No | Yes | In Development |
26-
+-------------+-------------+---------+--------------------+
27-
| Wi-Fi | Yes | Yes | |
28-
+-------------+-------------+---------+--------------------+
29-
| Bluetooth | Yes | Yes | |
30-
+-------------+-------------+---------+--------------------+
31-
| RMT | Yes | Yes | |
32-
+-------------+-------------+---------+--------------------+
33-
| Touch | Yes | Yes | ESP32 & ESP32-S2 |
34-
+-------------+-------------+---------+--------------------+
35-
| Timer | Yes | Yes | |
36-
+-------------+-------------+---------+--------------------+
37-
| UART | Yes | Yes | |
38-
+-------------+-------------+---------+--------------------+
39-
| Hall Sensor | Yes | Yes | Only for ESP32 |
40-
+-------------+-------------+---------+--------------------+
41-
| LEDC | Yes | Yes | |
42-
+-------------+-------------+---------+--------------------+
43-
| Motor PWM | No | No | |
44-
+-------------+-------------+---------+--------------------+
45-
| TWAI | No | No | |
46-
+-------------+-------------+---------+--------------------+
47-
| Ethernet | Yes | Yes | Only for ESP32 |
48-
+-------------+-------------+---------+--------------------+
49-
| USB | Yes | Yes | Only for ESP32-S2 |
50-
+-------------+-------------+---------+--------------------+
12+
+---------------+---------------+---------------+---------------+-------------------------------+
13+
| Peripheral | ESP32 | ESP32-S2 | ESP32-C3 | Comments |
14+
+===============+===============+===============+===============+===============================+
15+
| ADC | Yes | Yes | Yes | |
16+
+---------------+---------------+---------------+---------------+-------------------------------+
17+
| Bluetooth | Yes | Not Supported | Not Supported | Bluetooth Classic |
18+
+---------------+---------------+---------------+---------------+-------------------------------+
19+
| BLE | Yes | Not Supported | Yes | |
20+
+---------------+---------------+---------------+---------------+-------------------------------+
21+
| DAC | Yes | Yes | Not Supported | |
22+
+---------------+---------------+---------------+---------------+-------------------------------+
23+
| Ethernet | Yes | Not Supported | Not Supported | (*) |
24+
+---------------+---------------+---------------+---------------+-------------------------------+
25+
| GPIO | Yes | Yes | Yes | |
26+
+---------------+---------------+---------------+---------------+-------------------------------+
27+
| Hall Sensor | Yes | Not Supported | Not Supported | |
28+
+---------------+---------------+---------------+---------------+-------------------------------+
29+
| I2C | Yes | Yes | Yes | |
30+
+---------------+---------------+---------------+---------------+-------------------------------+
31+
| I2S | No | No | No | WIP |
32+
+---------------+---------------+---------------+---------------+-------------------------------+
33+
| LEDC | Yes | Yes | Yes | |
34+
+---------------+---------------+---------------+---------------+-------------------------------+
35+
| Motor PWM | No | Not Supported | Not Supported | |
36+
+---------------+---------------+---------------+---------------+-------------------------------+
37+
| Pulse Counter | No | No | No | |
38+
+---------------+---------------+---------------+---------------+-------------------------------+
39+
| RMT | Yes | Yes | Yes | |
40+
+---------------+---------------+---------------+---------------+-------------------------------+
41+
| SDIO | No | No | No | |
42+
+---------------+---------------+---------------+---------------+-------------------------------+
43+
| SPI | Yes | Yes | Yes | |
44+
+---------------+---------------+---------------+---------------+-------------------------------+
45+
| Timer | Yes | Yes | Yes | |
46+
+---------------+---------------+---------------+---------------+-------------------------------+
47+
| Temp. Sensor | Not Supported | Yes | Yes | |
48+
+---------------+---------------+---------------+---------------+-------------------------------+
49+
| Touch | Yes | Yes | Not Supported | |
50+
+---------------+---------------+---------------+---------------+-------------------------------+
51+
| TWAI | No | No | No | |
52+
+---------------+---------------+---------------+---------------+-------------------------------+
53+
| UART | Yes | Yes | Yes | |
54+
+---------------+---------------+---------------+---------------+-------------------------------+
55+
| USB | Not Supported | Yes | Yes | ESP32-C3 only CDC/JTAG |
56+
+---------------+---------------+---------------+---------------+-------------------------------+
57+
| Wi-Fi | Yes | Yes | Yes | |
58+
+---------------+---------------+---------------+---------------+-------------------------------+
5159

52-
Some peripherals are not available for all ESP32 families. To see more details about it, see the corresponding datasheet.
60+
Notes
61+
^^^^^
62+
63+
(*) SPI Ethernet is supported by all ESP32 families and RMII only for ESP32.
64+
65+
.. note:: 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.
66+
67+
Datasheet
68+
^^^^^^^^^
69+
70+
* `ESP32 <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_
71+
* `ESP32-S2 <https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf>`_
72+
* `ESP32-C3 <https://www.espressif.com/sites/default/files/documentation/esp32-c3_datasheet_en.pdf>`_
5373

5474
APIs
5575
----

0 commit comments

Comments
 (0)