feedc0de/arduino-esp32
1
0
Fork 0
forked from espressif/arduino-esp32
Code Pull Requests Activity
Files
master
arduino-esp32/docs/source/libraries.rst

79 lines
5.2 KiB
ReStructuredText
Raw Permalink Normal View History

Docs: Initial documentation structure using Sphinx (#5355) This PR is the initial documentation structure including the basic information about the project and Sphinx configuration. ####CONTENTS: - Getting Started - Installing - Boards - Libraries - Library Builder - Tutorials - ESP-IDF as Component - OTA Web Update - makeEspArduino - Troubleshooting - Contributing This PR also changes the README.md.
2021-07-19 11:37:26 +01:00
#########
Libraries
#########
[Docs] Added I2C driver docs (#5770) * Added I2C driver docs docs: Changes on the images and added more details about the I2C slave * docs: Added slaveWrite description and added docs build folder to the gitignore file
2021-11-04 12:32:05 +00:00
Here is where the Libraries API's descriptions are located:
Docs: Initial documentation structure using Sphinx (#5355) This PR is the initial documentation structure including the basic information about the project and Sphinx configuration. ####CONTENTS: - Getting Started - Installing - Boards - Libraries - Library Builder - Tutorials - ESP-IDF as Component - OTA Web Update - makeEspArduino - Troubleshooting - Contributing This PR also changes the README.md.
2021-07-19 11:37:26 +01:00
docs: Added supported peripherals list on libraries section (#5829)
2021-11-04 12:29:42 +00:00
Supported Peripherals
---------------------
[Docs] Peripheral list updated to include all supported SoCs (#5851)
2021-11-08 10:36:06 +00:00
Currently, the Arduino ESP32 supports the following peripherals with Arduino APIs.
docs: Added supported peripherals list on libraries section (#5829)
2021-11-04 12:29:42 +00:00
[Docs] Peripheral list updated to include all supported SoCs (#5851)
2021-11-08 10:36:06 +00:00
+---------------+---------------+---------------+---------------+-------------------------------+
| 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 | |
+---------------+---------------+---------------+---------------+-------------------------------+
Esp32 s3 support (#6341) Co-authored-by: Jason2866 <24528715+Jason2866@users.noreply.github.com> Co-authored-by: Unexpected Maker <seon@unexpectedmaker.com> Co-authored-by: Rodrigo Garcia <rodrigo.garcia@espressif.com> Co-authored-by: Tomáš Pilný <34927466+PilnyTomas@users.noreply.github.com> Co-authored-by: Pedro Minatel <pedro.minatel@espressif.com> Co-authored-by: Ivan Grokhotkov <ivan@espressif.com> Co-authored-by: Jan Procházka <90197375+P-R-O-C-H-Y@users.noreply.github.com> Co-authored-by: Limor "Ladyada" Fried <limor@ladyada.net>
2022-03-28 12:09:41 +03:00
| I2S | Yes | No | No | WIP |
[Docs] Peripheral list updated to include all supported SoCs (#5851)
2021-11-08 10:36:06 +00:00
+---------------+---------------+---------------+---------------+-------------------------------+
| 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 | |
+---------------+---------------+---------------+---------------+-------------------------------+
docs: Added supported peripherals list on libraries section (#5829)
2021-11-04 12:29:42 +00:00
[Docs] Peripheral list updated to include all supported SoCs (#5851)
2021-11-08 10:36:06 +00:00
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 <https://products.espressif.com>`_ page.
Docs cleanup and version updated to 2.0.2 (#6213) * Docs cleanup and version updated to 2.0.2 * Removed issue template information * Removed issue template file * Added referecnces for the issue and feature request form
2022-02-01 09:24:06 +00:00
.. include:: common/datasheet.inc
docs: Added supported peripherals list on libraries section (#5829)
2021-11-04 12:29:42 +00:00
APIs
----
The Arduino ESP32 offers some unique APIs, described in this section:
Docs: Initial documentation structure using Sphinx (#5355) This PR is the initial documentation structure including the basic information about the project and Sphinx configuration. ####CONTENTS: - Getting Started - Installing - Boards - Libraries - Library Builder - Tutorials - ESP-IDF as Component - OTA Web Update - makeEspArduino - Troubleshooting - Contributing This PR also changes the README.md.
2021-07-19 11:37:26 +01:00
.. toctree::
:maxdepth: 1
Docs cleanup and version updated to 2.0.2 (#6213) * Docs cleanup and version updated to 2.0.2 * Removed issue template information * Removed issue template file * Added referecnces for the issue and feature request form
2022-02-01 09:24:06 +00:00
:glob:
Esp32 s3 support (#6341) Co-authored-by: Jason2866 <24528715+Jason2866@users.noreply.github.com> Co-authored-by: Unexpected Maker <seon@unexpectedmaker.com> Co-authored-by: Rodrigo Garcia <rodrigo.garcia@espressif.com> Co-authored-by: Tomáš Pilný <34927466+PilnyTomas@users.noreply.github.com> Co-authored-by: Pedro Minatel <pedro.minatel@espressif.com> Co-authored-by: Ivan Grokhotkov <ivan@espressif.com> Co-authored-by: Jan Procházka <90197375+P-R-O-C-H-Y@users.noreply.github.com> Co-authored-by: Limor "Ladyada" Fried <limor@ladyada.net>
2022-03-28 12:09:41 +03:00
Docs cleanup and version updated to 2.0.2 (#6213) * Docs cleanup and version updated to 2.0.2 * Removed issue template information * Removed issue template file * Added referecnces for the issue and feature request form
2022-02-01 09:24:06 +00:00
api/*
Copy Permalink