espressif/arduino-esp32
1
0
Fork 1
mirror of https://github.com/0xFEEDC0DE64/arduino-esp32.git synced 2025-06-29 20:10:59 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
ef35baffb0ebc6c2f471767bb6f29ad4537a6a50
arduino-esp32/docs/source/libraries.rst

91 lines
5.6 KiB
ReStructuredText
Raw 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 | |
+---------------+---------------+---------------+---------------+-------------------------------+
| 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 | |
+---------------+---------------+---------------+---------------+-------------------------------+
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.
Datasheet
^^^^^^^^^
* `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-C3 <https://www.espressif.com/sites/default/files/documentation/esp32-c3_datasheet_en.pdf>`_
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
Bluetooth <api/bluetooth>
Deep Sleep <api/deepsleep>
ESPNOW <api/espnow>
GPIO <api/gpio>
[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
I2C <api/i2c>
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
RainMaker <api/rainmaker>
Reset Reason <api/reset_reason>
[Docs] Added USB documentation (#6036) Summary Added USB documentation. Closes: #5784
2021-12-21 10:51:38 +00:00
USB <api/usb.rst>
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
Wi-Fi <api/wifi>
Reference in New Issue Copy Permalink