diff --git a/docs/source/esp-idf_component.rst b/docs/source/esp-idf_component.rst index ba2ff67604d..d6f387375d5 100644 --- a/docs/source/esp-idf_component.rst +++ b/docs/source/esp-idf_component.rst @@ -10,8 +10,7 @@ For a simplified method, see `lib-builder `_. Installation ------------ -.. 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. +.. 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. - Download and install `ESP-IDF `_. - Create blank idf project (from one of the examples). diff --git a/docs/source/libraries.rst b/docs/source/libraries.rst index 52b419c394c..6275e603f2a 100644 --- a/docs/source/libraries.rst +++ b/docs/source/libraries.rst @@ -7,49 +7,69 @@ Here is where the Libraries API's descriptions are located: Supported Peripherals --------------------- -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. +Currently, the Arduino ESP32 supports the following peripherals with Arduino APIs. -+-------------+-------------+---------+--------------------+ -| Peripheral | Arduino API | ESP-IDF | Comment | -+=============+=============+=========+====================+ -| ADC | Yes | Yes | | -+-------------+-------------+---------+--------------------+ -| DAC | No | No | | -+-------------+-------------+---------+--------------------+ -| GPIO | Yes | Yes | | -+-------------+-------------+---------+--------------------+ -| SDIO/SPI | Yes | Yes | | -+-------------+-------------+---------+--------------------+ -| I2C | Yes | Yes | | -+-------------+-------------+---------+--------------------+ -| I2S | No | Yes | In Development | -+-------------+-------------+---------+--------------------+ -| Wi-Fi | Yes | Yes | | -+-------------+-------------+---------+--------------------+ -| Bluetooth | Yes | Yes | | -+-------------+-------------+---------+--------------------+ -| RMT | Yes | Yes | | -+-------------+-------------+---------+--------------------+ -| Touch | Yes | Yes | ESP32 & ESP32-S2 | -+-------------+-------------+---------+--------------------+ -| Timer | Yes | Yes | | -+-------------+-------------+---------+--------------------+ -| UART | Yes | Yes | | -+-------------+-------------+---------+--------------------+ -| Hall Sensor | Yes | Yes | Only for ESP32 | -+-------------+-------------+---------+--------------------+ -| LEDC | Yes | Yes | | -+-------------+-------------+---------+--------------------+ -| Motor PWM | No | No | | -+-------------+-------------+---------+--------------------+ -| TWAI | No | No | | -+-------------+-------------+---------+--------------------+ -| Ethernet | Yes | Yes | Only for ESP32 | -+-------------+-------------+---------+--------------------+ -| USB | Yes | Yes | Only for ESP32-S2 | -+-------------+-------------+---------+--------------------+ ++---------------+---------------+---------------+---------------+-------------------------------+ +| Peripheral | ESP32 | ESP32-S2 | ESP32-C3 | Comments | ++===============+===============+===============+===============+===============================+ +| ADC | Yes | Yes | Yes | | ++---------------+---------------+---------------+---------------+-------------------------------+ +| Bluetooth | Yes | Not Supported | Not Supported | Bluetooth Classic | ++---------------+---------------+---------------+---------------+-------------------------------+ +| BLE | Yes | Not Supported | Yes | | ++---------------+---------------+---------------+---------------+-------------------------------+ +| DAC | Yes | Yes | Not Supported | | ++---------------+---------------+---------------+---------------+-------------------------------+ +| Ethernet | Yes | Not Supported | Not Supported | (*) | ++---------------+---------------+---------------+---------------+-------------------------------+ +| GPIO | Yes | Yes | Yes | | ++---------------+---------------+---------------+---------------+-------------------------------+ +| Hall Sensor | Yes | Not Supported | Not Supported | | ++---------------+---------------+---------------+---------------+-------------------------------+ +| I2C | Yes | Yes | Yes | | ++---------------+---------------+---------------+---------------+-------------------------------+ +| I2S | No | No | No | WIP | ++---------------+---------------+---------------+---------------+-------------------------------+ +| LEDC | Yes | Yes | Yes | | ++---------------+---------------+---------------+---------------+-------------------------------+ +| Motor PWM | No | Not Supported | Not Supported | | ++---------------+---------------+---------------+---------------+-------------------------------+ +| Pulse Counter | No | No | No | | ++---------------+---------------+---------------+---------------+-------------------------------+ +| RMT | Yes | Yes | Yes | | ++---------------+---------------+---------------+---------------+-------------------------------+ +| SDIO | No | No | No | | ++---------------+---------------+---------------+---------------+-------------------------------+ +| SPI | Yes | Yes | Yes | | ++---------------+---------------+---------------+---------------+-------------------------------+ +| Timer | Yes | Yes | Yes | | ++---------------+---------------+---------------+---------------+-------------------------------+ +| Temp. Sensor | Not Supported | Yes | Yes | | ++---------------+---------------+---------------+---------------+-------------------------------+ +| Touch | Yes | Yes | Not Supported | | ++---------------+---------------+---------------+---------------+-------------------------------+ +| TWAI | No | No | No | | ++---------------+---------------+---------------+---------------+-------------------------------+ +| UART | Yes | Yes | Yes | | ++---------------+---------------+---------------+---------------+-------------------------------+ +| USB | Not Supported | Yes | Yes | ESP32-C3 only CDC/JTAG | ++---------------+---------------+---------------+---------------+-------------------------------+ +| Wi-Fi | Yes | Yes | Yes | | ++---------------+---------------+---------------+---------------+-------------------------------+ -Some peripherals are not available for all ESP32 families. To see more details about it, see the corresponding datasheet. +Notes +^^^^^ + +(*) SPI Ethernet is supported by all ESP32 families and RMII only for ESP32. + +.. note:: Some peripherals are not available for all ESP32 families. To see more details about it, see the corresponding SoC at `Product Selector `_ page. + +Datasheet +^^^^^^^^^ + +* `ESP32 `_ +* `ESP32-S2 `_ +* `ESP32-C3 `_ APIs ----