docs(esp32p4): Add missing information and improve organization (#11081)
* docs(esp32p4): Add missing information and improve organization * docs(datasheets): Add missing datasheets * docs(readme): Reorder title * docs(typos): Fix typos
This commit is contained in:
parent
2a3de9c415
commit
f7c1efccaa
7 changed files with 97 additions and 72 deletions
11
README.md
11
README.md
|
|
@ -1,4 +1,4 @@
|
||||||
# Arduino core for the ESP32, ESP32-P4, ESP32-S2, ESP32-S3, ESP32-C3, ESP32-C6 and ESP32-H2
|
# Arduino core for the ESP32, ESP32-C3, ESP32-C6, ESP32-H2, ESP32-P4, ESP32-S2 and ESP32-S3.
|
||||||
|
|
||||||
[](https://github.com/espressif/arduino-esp32/actions/workflows/push.yml?query=branch%3Amaster+event%3Apush)
|
[](https://github.com/espressif/arduino-esp32/actions/workflows/push.yml?query=branch%3Amaster+event%3Apush)
|
||||||
[)](https://github.com/espressif/arduino-esp32/actions/workflows/push.yml?query=branch%3Amaster+event%3Aschedule)
|
[)](https://github.com/espressif/arduino-esp32/actions/workflows/push.yml?query=branch%3Amaster+event%3Aschedule)
|
||||||
|
|
@ -67,16 +67,17 @@ Here are the ESP32 series supported by the Arduino-ESP32 project:
|
||||||
| **SoC** | **Stable** | **Development** | **Datasheet** |
|
| **SoC** | **Stable** | **Development** | **Datasheet** |
|
||||||
|----------|:----------:|:---------------:|:-------------------------------------------------------------------------------------------------:|
|
|----------|:----------:|:---------------:|:-------------------------------------------------------------------------------------------------:|
|
||||||
| ESP32 | Yes | Yes | [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf) |
|
| ESP32 | Yes | Yes | [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf) |
|
||||||
| ESP32-S2 | Yes | Yes | [ESP32-S2](https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf) |
|
|
||||||
| ESP32-C3 | Yes | Yes | [ESP32-C3](https://www.espressif.com/sites/default/files/documentation/esp32-c3_datasheet_en.pdf) |
|
| ESP32-C3 | Yes | Yes | [ESP32-C3](https://www.espressif.com/sites/default/files/documentation/esp32-c3_datasheet_en.pdf) |
|
||||||
| ESP32-S3 | Yes | Yes | [ESP32-S3](https://www.espressif.com/sites/default/files/documentation/esp32-s3_datasheet_en.pdf) |
|
|
||||||
| ESP32-C6 | Yes | Yes | [ESP32-C6](https://www.espressif.com/sites/default/files/documentation/esp32-c6_datasheet_en.pdf) |
|
| ESP32-C6 | Yes | Yes | [ESP32-C6](https://www.espressif.com/sites/default/files/documentation/esp32-c6_datasheet_en.pdf) |
|
||||||
| ESP32-H2 | Yes | Yes | [ESP32-H2](https://www.espressif.com/sites/default/files/documentation/esp32-h2_datasheet_en.pdf) |
|
| ESP32-H2 | Yes | Yes | [ESP32-H2](https://www.espressif.com/sites/default/files/documentation/esp32-h2_datasheet_en.pdf) |
|
||||||
| ESP32-P4 | Yes | Yes | [ESP32-P4](https://www.espressif.com/sites/default/files/documentation/esp32-p4_datasheet_en.pdf) |
|
| ESP32-P4 | Yes | Yes | [ESP32-P4](https://www.espressif.com/sites/default/files/documentation/esp32-p4_datasheet_en.pdf) |
|
||||||
|
| ESP32-S2 | Yes | Yes | [ESP32-S2](https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf) |
|
||||||
|
| ESP32-S3 | Yes | Yes | [ESP32-S3](https://www.espressif.com/sites/default/files/documentation/esp32-s3_datasheet_en.pdf) |
|
||||||
|
|
||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
> ESP32-C2 is also supported by Arduino-ESP32 but requires rebuilding the static libraries. This is not trivial and requires a good understanding of the ESP-IDF
|
> ESP32-C2 is also supported by Arduino-ESP32 but requires using Arduino as an ESP-IDF component or rebuilding the static libraries.
|
||||||
> build system. For more information, see the [Lib Builder documentation](https://docs.espressif.com/projects/arduino-esp32/en/latest/lib_builder.html).
|
> For more information, see the [Arduino as an ESP-IDF component documentation](https://docs.espressif.com/projects/arduino-esp32/en/latest/esp-idf_component.html) or the
|
||||||
|
> [Lib Builder documentation](https://docs.espressif.com/projects/arduino-esp32/en/latest/lib_builder.html), respectively.
|
||||||
|
|
||||||
For more details visit the [supported chips](https://docs.espressif.com/projects/arduino-esp32/en/latest/getting_started.html#supported-soc-s) documentation page.
|
For more details visit the [supported chips](https://docs.espressif.com/projects/arduino-esp32/en/latest/getting_started.html#supported-soc-s) documentation page.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -18,16 +18,18 @@ The ESP32 is divided by family:
|
||||||
|
|
||||||
* ESP32
|
* ESP32
|
||||||
* Wi-Fi, BT and BLE 4
|
* Wi-Fi, BT and BLE 4
|
||||||
* ESP32-S2
|
|
||||||
* Wi-Fi only
|
|
||||||
* ESP32-S3
|
|
||||||
* Wi-Fi and BLE 5
|
|
||||||
* ESP32-C3
|
* ESP32-C3
|
||||||
* Wi-Fi and BLE 5
|
* Wi-Fi and BLE 5
|
||||||
* ESP32-C6
|
* ESP32-C6
|
||||||
* Wi-Fi, BLE 5 and IEEE 802.15.4
|
* Wi-Fi, BLE 5 and IEEE 802.15.4
|
||||||
* ESP32-H2
|
* ESP32-H2
|
||||||
* BLE 5 and IEEE 802.15.4
|
* BLE 5 and IEEE 802.15.4
|
||||||
|
* ESP32-P4
|
||||||
|
* 400 MHz Dual Core RISC-V CPU, 40 MHz ULP Co-processor, single-precision FPU and AI extensions.
|
||||||
|
* ESP32-S2
|
||||||
|
* Wi-Fi only
|
||||||
|
* ESP32-S3
|
||||||
|
* Wi-Fi and BLE 5
|
||||||
|
|
||||||
For each family, we have SoC variants with some differentiation. The differences are more about the embedded flash and its size and the number of the cores (dual or single).
|
For each family, we have SoC variants with some differentiation. The differences are more about the embedded flash and its size and the number of the cores (dual or single).
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,16 +2,20 @@ Datasheet
|
||||||
---------
|
---------
|
||||||
|
|
||||||
* `ESP32`_ (Datasheet)
|
* `ESP32`_ (Datasheet)
|
||||||
* `ESP32-S2`_ (Datasheet)
|
* `ESP32-C2`_ (Datasheet)
|
||||||
* `ESP32-C3`_ (Datasheet)
|
* `ESP32-C3`_ (Datasheet)
|
||||||
* `ESP32-S3`_ (Datasheet)
|
|
||||||
* `ESP32-C6`_ (Datasheet)
|
* `ESP32-C6`_ (Datasheet)
|
||||||
* `ESP32-H2`_ (Datasheet)
|
* `ESP32-H2`_ (Datasheet)
|
||||||
|
* `ESP32-P4`_ (Datasheet)
|
||||||
|
* `ESP32-S2`_ (Datasheet)
|
||||||
|
* `ESP32-S3`_ (Datasheet)
|
||||||
|
|
||||||
.. _Espressif Product Selector: https://products.espressif.com/
|
.. _Espressif Product Selector: https://products.espressif.com/
|
||||||
.. _ESP32: https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf
|
.. _ESP32: https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf
|
||||||
.. _ESP32-S2: https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf
|
.. _ESP32-C2: https://www.espressif.com/sites/default/files/documentation/esp8684_datasheet_en.pdf
|
||||||
.. _ESP32-C3: https://www.espressif.com/sites/default/files/documentation/esp32-c3_datasheet_en.pdf
|
.. _ESP32-C3: https://www.espressif.com/sites/default/files/documentation/esp32-c3_datasheet_en.pdf
|
||||||
.. _ESP32-S3: https://www.espressif.com/sites/default/files/documentation/esp32-s3_datasheet_en.pdf
|
|
||||||
.. _ESP32-C6: https://www.espressif.com/sites/default/files/documentation/esp32-c6_datasheet_en.pdf
|
.. _ESP32-C6: https://www.espressif.com/sites/default/files/documentation/esp32-c6_datasheet_en.pdf
|
||||||
.. _ESP32-H2: https://www.espressif.com/sites/default/files/documentation/esp32-h2_datasheet_en.pdf
|
.. _ESP32-H2: https://www.espressif.com/sites/default/files/documentation/esp32-h2_datasheet_en.pdf
|
||||||
|
.. _ESP32-P4: https://www.espressif.com/sites/default/files/documentation/esp32-p4_datasheet_en.pdf
|
||||||
|
.. _ESP32-S2: https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf
|
||||||
|
.. _ESP32-S3: https://www.espressif.com/sites/default/files/documentation/esp32-s3_datasheet_en.pdf
|
||||||
|
|
|
||||||
|
|
@ -38,17 +38,18 @@ Here are the ESP32 series supported by the Arduino-ESP32 project:
|
||||||
SoC Stable Development Datasheet
|
SoC Stable Development Datasheet
|
||||||
========== ====== =========== =================================
|
========== ====== =========== =================================
|
||||||
ESP32 Yes Yes `ESP32`_
|
ESP32 Yes Yes `ESP32`_
|
||||||
ESP32-S2 Yes Yes `ESP32-S2`_
|
|
||||||
ESP32-C3 Yes Yes `ESP32-C3`_
|
ESP32-C3 Yes Yes `ESP32-C3`_
|
||||||
ESP32-S3 Yes Yes `ESP32-S3`_
|
|
||||||
ESP32-C6 Yes Yes `ESP32-C6`_
|
ESP32-C6 Yes Yes `ESP32-C6`_
|
||||||
ESP32-H2 Yes Yes `ESP32-H2`_
|
ESP32-H2 Yes Yes `ESP32-H2`_
|
||||||
|
ESP32-P4 Yes Yes `ESP32-P4`_
|
||||||
|
ESP32-S2 Yes Yes `ESP32-S2`_
|
||||||
|
ESP32-S3 Yes Yes `ESP32-S3`_
|
||||||
========== ====== =========== =================================
|
========== ====== =========== =================================
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
ESP32-C2 is also supported by Arduino-ESP32 but requires rebuilding the static libraries.
|
ESP32-C2 is also supported by Arduino-ESP32 but requires using Arduino as an ESP-IDF component or rebuilding the static libraries.
|
||||||
This is not trivial and requires a good understanding of the ESP-IDF build system.
|
For more information, see the `Arduino as an ESP-IDF component documentation <esp-idf_component.html>`_ or the
|
||||||
For more information, see the `Lib Builder documentation <lib_builder.html>`_.
|
`Lib Builder documentation <lib_builder.html>`_, respectively.
|
||||||
|
|
||||||
See `Boards <boards/boards.html>`_ for more details about ESP32 development boards.
|
See `Boards <boards/boards.html>`_ for more details about ESP32 development boards.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -151,13 +151,13 @@ Set the build target(chip). ex. 'esp32s3'
|
||||||
This build command will build for the ESP32-S3 target. You can specify other targets.
|
This build command will build for the ESP32-S3 target. You can specify other targets.
|
||||||
|
|
||||||
* esp32
|
* esp32
|
||||||
* esp32s2
|
|
||||||
* esp32s3
|
|
||||||
* esp32c2
|
* esp32c2
|
||||||
* esp32c3
|
* esp32c3
|
||||||
* esp32c6
|
* esp32c6
|
||||||
* esp32h2
|
* esp32h2
|
||||||
* esp32p4
|
* esp32p4
|
||||||
|
* esp32s2
|
||||||
|
* esp32s3
|
||||||
|
|
||||||
Set Build Type
|
Set Build Type
|
||||||
^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^
|
||||||
|
|
|
||||||
|
|
@ -9,60 +9,68 @@ Supported Peripherals
|
||||||
|
|
||||||
Currently, the Arduino ESP32 supports the following peripherals with Arduino APIs.
|
Currently, the Arduino ESP32 supports the following peripherals with Arduino APIs.
|
||||||
|
|
||||||
+---------------+-------+-------+-------+-------+-------+-------+-------+
|
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
|
||||||
| Peripheral | ESP32 | S2 | C3 | S3 | C6 | H2 | Notes |
|
| Peripheral | ESP32 | C3 | C6 | H2 | P4 | S2 | S3 | Notes |
|
||||||
+===============+=======+=======+=======+=======+=======+=======+=======+
|
+===============+=======+=======+=======+=======+=======+=======+=======+=======+
|
||||||
| ADC | Yes | Yes | Yes | Yes | Yes | Yes | |
|
| ADC | Yes | Yes | Yes | Yes | Yes | Yes | Yes | (1) |
|
||||||
+---------------+-------+-------+-------+-------+-------+-------+-------+
|
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
|
||||||
| BT Classic | Yes | N/A | N/A | N/A | N/A | N/A | |
|
| BT Classic | Yes | N/A | N/A | N/A | N/A | N/A | N/A | |
|
||||||
+---------------+-------+-------+-------+-------+-------+-------+-------+
|
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
|
||||||
| BLE | Yes | N/A | Yes | Yes | Yes | Yes | |
|
| BLE | Yes | Yes | Yes | Yes | No | N/A | Yes | |
|
||||||
+---------------+-------+-------+-------+-------+-------+-------+-------+
|
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
|
||||||
| DAC | Yes | Yes | N/A | N/A | N/A | N/A | |
|
| DAC | Yes | N/A | N/A | N/A | Yes | Yes | N/A | |
|
||||||
+---------------+-------+-------+-------+-------+-------+-------+-------+
|
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
|
||||||
| Ethernet | Yes | N/A | N/A | N/A | N/A | N/A | (*) |
|
| Ethernet | Yes | N/A | N/A | N/A | Yes | N/A | N/A | (2) |
|
||||||
+---------------+-------+-------+-------+-------+-------+-------+-------+
|
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
|
||||||
| GPIO | Yes | Yes | Yes | Yes | Yes | Yes | |
|
| GPIO | Yes | Yes | Yes | Yes | Yes | Yes | Yes | |
|
||||||
+---------------+-------+-------+-------+-------+-------+-------+-------+
|
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
|
||||||
| Hall Sensor | N/A | N/A | N/A | N/A | N/A | N/A | |
|
| Hall Sensor | N/A | N/A | N/A | N/A | N/A | N/A | N/A | |
|
||||||
+---------------+-------+-------+-------+-------+-------+-------+-------+
|
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
|
||||||
| I2C | Yes | Yes | Yes | Yes | Yes | Yes | |
|
| I2C | Yes | Yes | Yes | Yes | Yes | Yes | Yes | |
|
||||||
+---------------+-------+-------+-------+-------+-------+-------+-------+
|
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
|
||||||
| I2S | Yes | Yes | Yes | Yes | Yes | Yes | |
|
| I2S | Yes | Yes | Yes | Yes | Yes | Yes | Yes | |
|
||||||
+---------------+-------+-------+-------+-------+-------+-------+-------+
|
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
|
||||||
| LEDC | Yes | Yes | Yes | Yes | Yes | Yes | |
|
| LEDC | Yes | Yes | Yes | Yes | Yes | Yes | Yes | |
|
||||||
+---------------+-------+-------+-------+-------+-------+-------+-------+
|
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
|
||||||
| Motor PWM | No | N/A | N/A | N/A | N/A | N/A | |
|
| MIPI | N/A | N/A | N/A | N/A | No | N/A | N/A | |
|
||||||
+---------------+-------+-------+-------+-------+-------+-------+-------+
|
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
|
||||||
| Pulse Counter | No | No | No | No | No | No | |
|
| Motor PWM | No | N/A | N/A | N/A | N/A | N/A | N/A | |
|
||||||
+---------------+-------+-------+-------+-------+-------+-------+-------+
|
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
|
||||||
| RMT | Yes | Yes | Yes | Yes | Yes | Yes | |
|
| MSPI | N/A | N/A | N/A | N/A | No | N/A | N/A | |
|
||||||
+---------------+-------+-------+-------+-------+-------+-------+-------+
|
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
|
||||||
| SDIO | No | No | No | No | No | No | |
|
| Pulse Counter | No | No | No | No | No | No | No | |
|
||||||
+---------------+-------+-------+-------+-------+-------+-------+-------+
|
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
|
||||||
| SDMMC | Yes | N/A | N/A | Yes | N/A | N/A | |
|
| RMT | Yes | Yes | Yes | Yes | Yes | Yes | Yes | |
|
||||||
+---------------+-------+-------+-------+-------+-------+-------+-------+
|
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
|
||||||
| Timer | Yes | Yes | Yes | Yes | Yes | Yes | |
|
| SDIO | No | No | No | No | No | No | No | |
|
||||||
+---------------+-------+-------+-------+-------+-------+-------+-------+
|
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
|
||||||
| Temp. Sensor | N/A | Yes | Yes | Yes | Yes | Yes | |
|
| SDMMC | Yes | N/A | N/A | N/A | N/A | N/A | Yes | |
|
||||||
+---------------+-------+-------+-------+-------+-------+-------+-------+
|
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
|
||||||
| Touch | Yes | Yes | N/A | Yes | N/A | N/A | |
|
| Timer | Yes | Yes | Yes | Yes | Yes | Yes | Yes | |
|
||||||
+---------------+-------+-------+-------+-------+-------+-------+-------+
|
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
|
||||||
| TWAI | No | No | No | No | No | No | |
|
| Temp. Sensor | N/A | Yes | Yes | Yes | Yes | Yes | Yes | |
|
||||||
+---------------+-------+-------+-------+-------+-------+-------+-------+
|
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
|
||||||
| UART | Yes | Yes | Yes | Yes | Yes | Yes | |
|
| Touch | Yes | N/A | N/A | N/A | Yes | Yes | Yes | |
|
||||||
+---------------+-------+-------+-------+-------+-------+-------+-------+
|
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
|
||||||
| USB | N/A | Yes | Yes | Yes | Yes | Yes | (**) |
|
| TWAI | No | No | No | No | No | No | No | |
|
||||||
+---------------+-------+-------+-------+-------+-------+-------+-------+
|
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
|
||||||
| Wi-Fi | Yes | Yes | Yes | Yes | Yes | N/A | |
|
| UART | Yes | Yes | Yes | Yes | Yes | Yes | Yes | |
|
||||||
+---------------+-------+-------+-------+-------+-------+-------+-------+
|
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
|
||||||
|
| USB | N/A | Yes | Yes | Yes | Yes | Yes | Yes | (3) |
|
||||||
|
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
|
||||||
|
| Wi-Fi | Yes | Yes | Yes | N/A | Yes | Yes | Yes | (4) |
|
||||||
|
+---------------+-------+-------+-------+-------+-------+-------+-------+-------+
|
||||||
|
|
||||||
Notes
|
Notes
|
||||||
^^^^^
|
^^^^^
|
||||||
|
|
||||||
(*) SPI Ethernet is supported by all ESP32 families and RMII only for ESP32.
|
(1) ESP32-P4 calibration schemes not supported yet in IDF and ADC Continuous also lacks IDF support.
|
||||||
|
|
||||||
(**) ESP32-C3, C6, H2 only support USB CDC/JTAG
|
(2) SPI Ethernet is supported by all ESP32 families and RMII only for ESP32 and ESP32-P4.
|
||||||
|
|
||||||
|
(3) ESP32-C3, C6, H2 only support USB CDC/JTAG
|
||||||
|
|
||||||
|
(4) ESP32-P4 only supports Wi-Fi through another SoC by using ``esp_hosted``.
|
||||||
|
|
||||||
.. 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.
|
.. 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.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -25,15 +25,24 @@
|
||||||
{
|
{
|
||||||
"name": "ESP32 Dev Board"
|
"name": "ESP32 Dev Board"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"name": "ESP32-C3 Dev Board"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "ESP32-C6 Dev Board"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "ESP32-H2 Dev Board"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "ESP32-P4 Dev Board"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"name": "ESP32-S2 Dev Board"
|
"name": "ESP32-S2 Dev Board"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "ESP32-S3 Dev Board"
|
"name": "ESP32-S3 Dev Board"
|
||||||
},
|
},
|
||||||
{
|
|
||||||
"name": "ESP32-C3 Dev Board"
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
"name": "Arduino Nano ESP32"
|
"name": "Arduino Nano ESP32"
|
||||||
}
|
}
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue