adafruit-mirror/arduino-esp32
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

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

Browse source 
* docs(libraries): Add new SoCs

* docs(): Add C2 and H2 to USB and getting started

* docs(): Fix table format

* docs(extension): Add sphinxemoji support

* docs(): Lower emoji version

* Revert "docs(): Lower emoji version"

This reverts commit 3f3e0adf3c3c585bb439b182c77708fce23bd0b9.

* Revert "docs(extension): Add sphinxemoji support"

This reverts commit e903da689d4531f7fa7327e042206a4cdc3422a8.

* docs(): Shrink peripherals table

* docs(): Shrink table even more

* docs(): Shrink table more and more

* docs(): Shrink table the most I am able to
This commit is contained in:
Jan Procházka 2024-05-29 12:04:46 +02:00 committed by GitHub
parent f772fcadfd
commit 55e340ce47
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 61 additions and 57 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
docs/en/getting_started.rst
View file

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

96
docs/en/libraries.rst
View file

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

2
docs/en/tutorials/cdc_dfu_flash.rst
View file

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