Skip to content

Commit 193db0f

Browse files
committed
docs(socs): Add missing SoCs and features to documentation
1 parent 9b3364c commit 193db0f

File tree

6 files changed

+78
-56
lines changed

6 files changed

+78
-56
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Arduino core for the ESP32, ESP32-C3, ESP32-C5, ESP32-C6, ESP32-H2, ESP32-P4, ESP32-S2 and ESP32-S3.
1+
# Arduino core for the ESP32 family of SoCs
22

33
[![Build Status](https://img.shields.io/github/actions/workflow/status/espressif/arduino-esp32/push.yml?branch=master&event=push&label=Compilation%20Tests)](https://github.com/espressif/arduino-esp32/actions/workflows/push.yml?query=branch%3Amaster+event%3Apush)
44
[![Verbose Build Status](https://img.shields.io/github/actions/workflow/status/espressif/arduino-esp32/push.yml?branch=master&event=schedule&label=Compilation%20Tests%20(Verbose))](https://github.com/espressif/arduino-esp32/actions/workflows/push.yml?query=branch%3Amaster+event%3Aschedule)

docs/en/boards/boards.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,16 @@ The ESP32 is divided by family:
1818

1919
* ESP32
2020
* Wi-Fi, BT and BLE 4
21+
* ESP32-C2
22+
* Wi-Fi and BLE 5
2123
* ESP32-C3
2224
* Wi-Fi and BLE 5
25+
* ESP32-C5
26+
* Dual-band Wi-Fi 6, BLE 5 and IEEE 802.15.4
2327
* ESP32-C6
24-
* Wi-Fi, BLE 5 and IEEE 802.15.4
28+
* Wi-Fi 6, BLE 5 and IEEE 802.15.4
29+
* ESP32-C61
30+
* Wi-Fi 6, BLE 5
2531
* ESP32-H2
2632
* BLE 5 and IEEE 802.15.4
2733
* ESP32-P4

docs/en/common/datasheet.inc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ Datasheet
44
* `ESP32`_ (Datasheet)
55
* `ESP32-C2`_ (Datasheet)
66
* `ESP32-C3`_ (Datasheet)
7+
* `ESP32-C5`_ (Datasheet)
78
* `ESP32-C6`_ (Datasheet)
9+
* `ESP32-C61`_ (Datasheet)
810
* `ESP32-H2`_ (Datasheet)
911
* `ESP32-P4`_ (Datasheet)
1012
* `ESP32-S2`_ (Datasheet)
@@ -14,7 +16,9 @@ Datasheet
1416
.. _ESP32: https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf
1517
.. _ESP32-C2: https://www.espressif.com/sites/default/files/documentation/esp8684_datasheet_en.pdf
1618
.. _ESP32-C3: https://www.espressif.com/sites/default/files/documentation/esp32-c3_datasheet_en.pdf
19+
.. _ESP32-C5: https://www.espressif.com/sites/default/files/documentation/esp32-c5_datasheet_en.pdf
1720
.. _ESP32-C6: https://www.espressif.com/sites/default/files/documentation/esp32-c6_datasheet_en.pdf
21+
.. _ESP32-C61: https://www.espressif.com/sites/default/files/documentation/esp32-c61_datasheet_en.pdf
1822
.. _ESP32-H2: https://www.espressif.com/sites/default/files/documentation/esp32-h2_datasheet_en.pdf
1923
.. _ESP32-P4: https://www.espressif.com/sites/default/files/documentation/esp32-p4_datasheet_en.pdf
2024
.. _ESP32-S2: https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf

docs/en/getting_started.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ SoC Stable Development Datasheet
3939
========== ====== =========== =================================
4040
ESP32 Yes Yes `ESP32`_
4141
ESP32-C3 Yes Yes `ESP32-C3`_
42+
ESP32-C5 Yes Yes `ESP32-C5`_
4243
ESP32-C6 Yes Yes `ESP32-C6`_
4344
ESP32-H2 Yes Yes `ESP32-H2`_
4445
ESP32-P4 Yes Yes `ESP32-P4`_
@@ -47,7 +48,7 @@ ESP32-S3 Yes Yes `ESP32-S3`_
4748
========== ====== =========== =================================
4849

4950
.. note::
50-
ESP32-C2 is also supported by Arduino-ESP32 but requires using Arduino as an ESP-IDF component or rebuilding the static libraries.
51+
ESP32-C2 and ESP32-C61 are also supported by Arduino-ESP32 but require using Arduino as an ESP-IDF component or rebuilding the static libraries.
5152
For more information, see the `Arduino as an ESP-IDF component documentation <esp-idf_component.html>`_ or the
5253
`Lib Builder documentation <lib_builder.html>`_, respectively.
5354

docs/en/libraries.rst

Lines changed: 61 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -9,57 +9,63 @@ Supported Peripherals
99

1010
Currently, the Arduino ESP32 supports the following peripherals with Arduino APIs.
1111

12-
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
13-
| Peripheral | ESP32 | C3 | C6 | H2 | P4 | S2 | S3 | Notes |
14-
+===============+=======+=======+=======+=======+=======+=======+=======+=======+
15-
| ADC | Yes | Yes | Yes | Yes | Yes | Yes | Yes | (1) |
16-
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
17-
| BT Classic | Yes | N/A | N/A | N/A | N/A | N/A | N/A | |
18-
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
19-
| BLE | Yes | Yes | Yes | Yes | No | N/A | Yes | |
20-
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
21-
| DAC | Yes | N/A | N/A | N/A | Yes | Yes | N/A | |
22-
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
23-
| Ethernet | Yes | N/A | N/A | N/A | Yes | N/A | N/A | (2) |
24-
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
25-
| GPIO | Yes | Yes | Yes | Yes | Yes | Yes | Yes | |
26-
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
27-
| Hall Sensor | N/A | N/A | N/A | N/A | N/A | N/A | N/A | |
28-
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
29-
| I2C | Yes | Yes | Yes | Yes | Yes | Yes | Yes | |
30-
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
31-
| I2S | Yes | Yes | Yes | Yes | Yes | Yes | Yes | |
32-
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
33-
| LEDC | Yes | Yes | Yes | Yes | Yes | Yes | Yes | |
34-
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
35-
| MIPI | N/A | N/A | N/A | N/A | No | N/A | N/A | |
36-
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
37-
| Motor PWM | No | N/A | N/A | N/A | N/A | N/A | N/A | |
38-
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
39-
| MSPI | N/A | N/A | N/A | N/A | No | N/A | N/A | |
40-
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
41-
| Pulse Counter | No | No | No | No | No | No | No | |
42-
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
43-
| RMT | Yes | Yes | Yes | Yes | Yes | Yes | Yes | |
44-
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
45-
| SDIO | No | No | No | No | No | No | No | |
46-
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
47-
| SDMMC | Yes | N/A | N/A | N/A | N/A | N/A | Yes | |
48-
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
49-
| Timer | Yes | Yes | Yes | Yes | Yes | Yes | Yes | |
50-
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
51-
| Temp. Sensor | N/A | Yes | Yes | Yes | Yes | Yes | Yes | |
52-
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
53-
| Touch | Yes | N/A | N/A | N/A | Yes | Yes | Yes | |
54-
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
55-
| TWAI | No | No | No | No | No | No | No | |
56-
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
57-
| UART | Yes | Yes | Yes | Yes | Yes | Yes | Yes | |
58-
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
59-
| USB | N/A | Yes | Yes | Yes | Yes | Yes | Yes | (3) |
60-
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
61-
| Wi-Fi | Yes | Yes | Yes | N/A | Yes | Yes | Yes | (4) |
62-
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
12+
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
13+
| Peripheral | ESP32 | C2 | C3 | C5 | C6 | C61 | H2 | P4 | S2 | S3 | Notes |
14+
+===============+=======+=======+=======+=======+=======+=======+=======+=======+=======+=======+=======+
15+
| ADC | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | (1) |
16+
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
17+
| BT Classic | Yes | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | |
18+
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
19+
| BLE | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | N/A | Yes | (4) |
20+
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
21+
| DAC | Yes | N/A | N/A | N/A | N/A | N/A | N/A | N/A | Yes | N/A | |
22+
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
23+
| Ethernet | Yes | N/A | N/A | N/A | N/A | N/A | N/A | Yes | N/A | N/A | (2) |
24+
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
25+
| GPIO | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | |
26+
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
27+
| Hall Sensor | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | |
28+
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
29+
| I2C | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | |
30+
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
31+
| I2S | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | |
32+
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
33+
| LEDC | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | |
34+
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
35+
| MIPI | N/A | N/A | N/A | N/A | N/A | N/A | N/A | No | N/A | N/A | |
36+
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
37+
| Motor PWM | No | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | |
38+
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
39+
| MSPI | N/A | N/A | N/A | N/A | N/A | N/A | N/A | No | N/A | N/A | |
40+
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
41+
| Pulse Counter | No | No | No | No | No | No | No | No | No | No | |
42+
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
43+
| RMT | Yes | Yes | Yes | Yes | Yes | N/A | Yes | Yes | Yes | Yes | |
44+
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
45+
| SDIO | No | No | No | No | No | No | No | No | No | No | |
46+
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
47+
| SDMMC | Yes | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | Yes | |
48+
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
49+
| PSRAM | Yes | N/A | N/A | Yes | N/A | Yes | N/A | Yes | Yes | Yes | |
50+
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
51+
| Timer | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | |
52+
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
53+
| Temp. Sensor | N/A | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | |
54+
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
55+
| Thread | N/A | N/A | N/A | Yes | Yes | N/A | Yes | N/A | N/A | N/A | |
56+
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
57+
| Touch | Yes | N/A | N/A | N/A | N/A | N/A | N/A | Yes | Yes | Yes | |
58+
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
59+
| TWAI | No | N/A | No | No | No | N/A | No | No | No | No | |
60+
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
61+
| UART | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | |
62+
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
63+
| USB | N/A | N/A | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | (3) |
64+
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
65+
| Wi-Fi | Yes | Yes | Yes | Yes | Yes | Yes | N/A | Yes | Yes | Yes | (4) |
66+
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
67+
| Zigbee | N/A | N/A | N/A | Yes | Yes | N/A | Yes | N/A | N/A | N/A | |
68+
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
6369

6470
Notes
6571
^^^^^
@@ -68,12 +74,14 @@ Notes
6874

6975
(2) SPI Ethernet is supported by all ESP32 families and RMII only for ESP32 and ESP32-P4.
7076

71-
(3) ESP32-C3, C6, H2 only support USB CDC/JTAG
77+
(3) ESP32-C3, C5, C6, C61 and H2 only support USB CDC/JTAG
7278

73-
(4) ESP32-P4 only supports Wi-Fi through another SoC by using ``esp_hosted``.
79+
(4) ESP32-P4 only supports Wi-Fi and BLE through another SoC by using ``esp_hosted``.
7480

7581
.. 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.
7682

83+
.. note:: The ESP32-C2 and ESP32-C61 are only supported using Arduino as an ESP-IDF component or by rebuilding the static libraries.
84+
7785
.. include:: common/datasheet.inc
7886

7987
APIs

package/package_esp32_index.template.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@
2828
{
2929
"name": "ESP32-C3 Dev Board"
3030
},
31+
{
32+
"name": "ESP32-C5 Dev Board"
33+
},
3134
{
3235
"name": "ESP32-C6 Dev Board"
3336
},

0 commit comments

Comments
 (0)