Skip to content
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

docs(libraries): Add new SoCs H2 and C6 to missing parts in docs #9709

Merged
merged 13 commits into from
May 29, 2024
Merged

docs(libraries): Add new SoCs H2 and C6 to missing parts in docs #9709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
61bb1cf
docs(libraries): Add new SoCs
P-R-O-C-H-Y May 28, 2024
ba4f8cf
Merge branch 'master' into docs/add-new-chips-to-libraries
P-R-O-C-H-Y May 28, 2024
7faf913
docs(): Add C2 and H2 to USB and getting started
P-R-O-C-H-Y May 28, 2024
6cf4860
Merge branch 'docs/add-new-chips-to-libraries' of https://github.com/…
P-R-O-C-H-Y May 28, 2024
775c929
docs(): Fix table format
P-R-O-C-H-Y May 28, 2024
e903da6
docs(extension): Add sphinxemoji support
P-R-O-C-H-Y May 29, 2024
3f3e0ad
docs(): Lower emoji version
P-R-O-C-H-Y May 29, 2024
b2f1d50
Revert "docs(): Lower emoji version"
P-R-O-C-H-Y May 29, 2024
6c537d6
Revert "docs(extension): Add sphinxemoji support"
P-R-O-C-H-Y May 29, 2024
660c55e
docs(): Shrink peripherals table
P-R-O-C-H-Y May 29, 2024
2e319a4
docs(): Shrink table even more
P-R-O-C-H-Y May 29, 2024
beb2fcf
docs(): Shrink table more and more
P-R-O-C-H-Y May 29, 2024
76d95f5
docs(): Shrink table the most I am able to
P-R-O-C-H-Y May 29, 2024
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
20 changes: 10 additions & 10 deletions docs/en/getting_started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,16 @@ Supported SoC's

Here are the ESP32 series supported by the Arduino-ESP32 project:

======== ====== =========== ===================================
SoC Stable Development Datasheet
======== ====== =========== ===================================
ESP32 Yes Yes `ESP32`_
ESP32-S2 Yes Yes `ESP32-S2`_
ESP32-C3 Yes Yes `ESP32-C3`_
ESP32-S3 Yes Yes `ESP32-S3`_
ESP32-C6 No Yes `ESP32-C6`_
ESP32-H2 No Yes `ESP32-H2`_
======== ====== =========== ===================================
========== ====== =========== =================================
SoC Stable Development Datasheet
========== ====== =========== =================================
ESP32 Yes Yes `ESP32`_
ESP32-S2 Yes Yes `ESP32-S2`_
ESP32-C3 Yes Yes `ESP32-C3`_
ESP32-S3 Yes Yes `ESP32-S3`_
ESP32-C6 Yes Yes `ESP32-C6`_
ESP32-H2 Yes Yes `ESP32-H2`_
========== ====== =========== =================================

.. note::
ESP32-C2 is also supported by Arduino-ESP32 but requires rebuilding the static libraries.
Expand Down
96 changes: 49 additions & 47 deletions docs/en/libraries.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,59 +9,61 @@ Supported Peripherals

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

+---------------+---------------+---------------+---------------+---------------+-----+------------------------+
| Peripheral | ESP32 | ESP32-S2 | ESP32-C3 | ESP32-S3 | | Comments |
+===============+===============+===============+===============+===============+=====+========================+
| ADC | Yes | Yes | Yes | Yes | | |
+---------------+---------------+---------------+---------------+---------------+-----+------------------------+
| Bluetooth | Yes | Not Supported | Not Supported | Not Supported | | Bluetooth Classic |
+---------------+---------------+---------------+---------------+---------------+-----+------------------------+
| BLE | Yes | Not Supported | Yes | Yes | | |
+---------------+---------------+---------------+---------------+---------------+-----+------------------------+
| DAC | Yes | Yes | Not Supported | Not Supported | | |
+---------------+---------------+---------------+---------------+---------------+-----+------------------------+
| Ethernet | Yes | Not Supported | Not Supported | Not Supported | | (*) |
+---------------+---------------+---------------+---------------+---------------+-----+------------------------+
| GPIO | Yes | Yes | Yes | Yes | | |
+---------------+---------------+---------------+---------------+---------------+-----+------------------------+
| Hall Sensor | Not Supported | Not Supported | Not Supported | Not Supported | | |
+---------------+---------------+---------------+---------------+---------------+-----+------------------------+
| I2C | Yes | Yes | Yes | Yes | | |
+---------------+---------------+---------------+---------------+---------------+-----+------------------------+
| I2S | Yes | Yes | Yes | Yes | | |
+---------------+---------------+---------------+---------------+---------------+-----+------------------------+
| LEDC | Yes | Yes | Yes | Yes | | |
+---------------+---------------+---------------+---------------+---------------+-----+------------------------+
| Motor PWM | No | Not Supported | Not Supported | Not Supported | | |
+---------------+---------------+---------------+---------------+---------------+-----+------------------------+
| Pulse Counter | No | No | No | No | | |
+---------------+---------------+---------------+---------------+---------------+-----+------------------------+
| RMT | Yes | Yes | Yes | Yes | | |
+---------------+---------------+---------------+---------------+---------------+-----+------------------------+
| SDIO | No | No | No | No | | |
+---------------+---------------+---------------+---------------+---------------+-----+------------------------+
| SDMMC | Yes | Not Supported | Not Supported | Yes | | |
+---------------+---------------+---------------+---------------+---------------+-----+------------------------+
| Timer | Yes | Yes | Yes | Yes | | |
+---------------+---------------+---------------+---------------+---------------+-----+------------------------+
| Temp. Sensor | Not Supported | Yes | Yes | Yes | | |
+---------------+---------------+---------------+---------------+---------------+-----+------------------------+
| Touch | Yes | Yes | Not Supported | Yes | | |
+---------------+---------------+---------------+---------------+---------------+-----+------------------------+
| TWAI | No | No | No | No | | |
+---------------+---------------+---------------+---------------+---------------+-----+------------------------+
| UART | Yes | Yes | Yes | Yes | | |
+---------------+---------------+---------------+---------------+---------------+-----+------------------------+
| USB | Not Supported | Yes | Yes | Yes | | ESP32-C3 only CDC/JTAG |
+---------------+---------------+---------------+---------------+---------------+-----+------------------------+
| Wi-Fi | Yes | Yes | Yes | Yes | | |
+---------------+---------------+---------------+---------------+---------------+-----+------------------------+
+---------------+-------+-------+-------+-------+-------+-------+-------+
| Peripheral | ESP32 | S2 | C3 | S3 | C6 | H2 | Notes |
+===============+=======+=======+=======+=======+=======+=======+=======+
| ADC | Yes | Yes | Yes | Yes | Yes | Yes | |
+---------------+-------+-------+-------+-------+-------+-------+-------+
| BT Classic | Yes | N/A | N/A | N/A | N/A | N/A | |
+---------------+-------+-------+-------+-------+-------+-------+-------+
| BLE | Yes | N/A | Yes | Yes | Yes | Yes | |
+---------------+-------+-------+-------+-------+-------+-------+-------+
| DAC | Yes | Yes | N/A | N/A | N/A | N/A | |
+---------------+-------+-------+-------+-------+-------+-------+-------+
| Ethernet | Yes | N/A | N/A | N/A | N/A | N/A | (*) |
+---------------+-------+-------+-------+-------+-------+-------+-------+
| GPIO | Yes | Yes | Yes | Yes | Yes | Yes | |
+---------------+-------+-------+-------+-------+-------+-------+-------+
| Hall Sensor | N/A | N/A | N/A | N/A | N/A | N/A | |
+---------------+-------+-------+-------+-------+-------+-------+-------+
| I2C | Yes | Yes | Yes | Yes | Yes | Yes | |
+---------------+-------+-------+-------+-------+-------+-------+-------+
| I2S | Yes | Yes | Yes | Yes | Yes | Yes | |
+---------------+-------+-------+-------+-------+-------+-------+-------+
| LEDC | Yes | Yes | Yes | Yes | Yes | Yes | |
+---------------+-------+-------+-------+-------+-------+-------+-------+
| Motor PWM | No | N/A | N/A | N/A | N/A | N/A | |
+---------------+-------+-------+-------+-------+-------+-------+-------+
| Pulse Counter | No | No | No | No | No | No | |
+---------------+-------+-------+-------+-------+-------+-------+-------+
| RMT | Yes | Yes | Yes | Yes | Yes | Yes | |
+---------------+-------+-------+-------+-------+-------+-------+-------+
| SDIO | No | No | No | No | No | No | |
+---------------+-------+-------+-------+-------+-------+-------+-------+
| SDMMC | Yes | N/A | N/A | Yes | N/A | N/A | |
+---------------+-------+-------+-------+-------+-------+-------+-------+
| Timer | Yes | Yes | Yes | Yes | Yes | Yes | |
+---------------+-------+-------+-------+-------+-------+-------+-------+
| Temp. Sensor | N/A | Yes | Yes | Yes | Yes | Yes | |
+---------------+-------+-------+-------+-------+-------+-------+-------+
| Touch | Yes | Yes | N/A | Yes | N/A | N/A | |
+---------------+-------+-------+-------+-------+-------+-------+-------+
| TWAI | No | No | No | No | No | No | |
+---------------+-------+-------+-------+-------+-------+-------+-------+
| UART | Yes | Yes | Yes | Yes | Yes | Yes | |
+---------------+-------+-------+-------+-------+-------+-------+-------+
| USB | N/A | Yes | Yes | Yes | Yes | Yes | (**) |
+---------------+-------+-------+-------+-------+-------+-------+-------+
| Wi-Fi | Yes | Yes | Yes | Yes | Yes | N/A | |
+---------------+-------+-------+-------+-------+-------+-------+-------+

Notes
^^^^^

(*) SPI Ethernet is supported by all ESP32 families and RMII only for ESP32.

(**) ESP32-C3, C6, H2 only support USB CDC/JTAG

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

.. include:: common/datasheet.inc
Expand Down
2 changes: 2 additions & 0 deletions docs/en/tutorials/cdc_dfu_flash.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ SoC USB Peripheral Support
ESP32-S2 CDC and DFU
ESP32-C3 CDC only
ESP32-S3 CDC and DFU
ESP32-C6 CDC only
ESP32-H2 CDC only
========= =======================

It's important that your board includes the USB connector attached to the embedded USB from the SoC. If your board doesn't have the USB connector, you can attach an external one to the USB pins.
Expand Down
Loading