mirror of
https://github.com/0xFEEDC0DE64/arduino-esp32.git
synced 2025-07-01 04:50:58 +02: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
This commit is contained in:
@ -1,47 +0,0 @@
|
|||||||
Make your question, not a Statement, inclusive. Include all pertinent information:
|
|
||||||
|
|
||||||
What you are trying to do
|
|
||||||
Describe your system (Hardware, computer, O/S, core version, environment)
|
|
||||||
Describe what is failing
|
|
||||||
Show the shortest possible code that will duplicate the error
|
|
||||||
Show the EXACT error message (it doesn't work is not enough)
|
|
||||||
Then if someone is interested and knowledgeable you might get a answer. All of this work on your part shows us that you have worked to solve YOUR problem. The more complete your issue posting is, the more likely someone will volunteer their time to help you.
|
|
||||||
|
|
||||||
If you have a Guru Meditation Error or Backtrace, ***please decode it***:
|
|
||||||
[ExceptionDecoder](https://github.com/me-no-dev/EspExceptionDecoder)
|
|
||||||
|
|
||||||
----------------------------- Remove above -----------------------------
|
|
||||||
|
|
||||||
|
|
||||||
### Hardware:
|
|
||||||
|||||||
|
|
||||||
|:---|---|---|---|---|---|
|
|
||||||
|<B>Board</B>|ESP32 Dev Module|node32|ttgo_lora|ESP32-S2-Saola|Custom w/ ESP32-S2-WROVER 16MB|
|
|
||||||
|<B>Version/Date</B>|1.0.4|2.0.0|0badbeef|11/jul/2017|today's master|
|
|
||||||
|<B>IDE name</B>|Arduino IDE|Atom + Platform.io|IDF component|VSCode|
|
|
||||||
|<B>Flash Frequency</B>|40Mhz|80Mhz|
|
|
||||||
|<B>PSRAM enabled</B>|yes|no|
|
|
||||||
|<B>Upload Speed</B>|115200|
|
|
||||||
|<B>Computer OS</B>|Windows 10|Mac OSX|Ubuntu|
|
|
||||||
|
|
||||||
### Description:
|
|
||||||
Describe your problem here
|
|
||||||
|
|
||||||
|
|
||||||
### Sketch: (leave the backquotes for [code formatting](https://help.github.com/articles/creating-and-highlighting-code-blocks/))
|
|
||||||
```cpp
|
|
||||||
|
|
||||||
//Change the code below by your sketch
|
|
||||||
#include <Arduino.h>
|
|
||||||
|
|
||||||
void setup() {
|
|
||||||
}
|
|
||||||
|
|
||||||
void loop() {
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Debug Messages:
|
|
||||||
```
|
|
||||||
Enable Core debug level: Debug on tools menu of Arduino IDE, then put the serial output here
|
|
||||||
```
|
|
@ -98,18 +98,13 @@ Generic Vendor
|
|||||||
.. note::
|
.. note::
|
||||||
Create one file per board or one file with multiple boards. Do not add board information/description on this file.
|
Create one file per board or one file with multiple boards. Do not add board information/description on this file.
|
||||||
|
|
||||||
|
.. include:: ../common/datasheet.inc
|
||||||
|
|
||||||
Resources
|
Resources
|
||||||
---------
|
---------
|
||||||
|
|
||||||
* `ESP32 Datasheet`_ (Datasheet)
|
|
||||||
* `ESP32-S2 Datasheet`_ (Datasheet)
|
|
||||||
* `ESP32-C3 Datasheet`_ (Datasheet)
|
|
||||||
|
|
||||||
.. _Espressif Systems: https://www.espressif.com
|
.. _Espressif Systems: https://www.espressif.com
|
||||||
.. _Espressif Product Selector: https://products.espressif.com/
|
.. _Espressif Product Selector: https://products.espressif.com/
|
||||||
.. _ESP32 Datasheet: https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf
|
|
||||||
.. _ESP32-S2 Datasheet: https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf
|
|
||||||
.. _ESP32-C3 Datasheet: https://www.espressif.com/sites/default/files/documentation/esp32-c3_datasheet_en.pdf
|
|
||||||
|
|
||||||
.. |board_lolin_d32| raw:: html
|
.. |board_lolin_d32| raw:: html
|
||||||
|
|
||||||
|
@ -26,9 +26,4 @@ Pin Layout
|
|||||||
|
|
||||||
Add here the pin layout image (not required).
|
Add here the pin layout image (not required).
|
||||||
|
|
||||||
Resources
|
.. include:: ../common/datasheet.inc
|
||||||
---------
|
|
||||||
|
|
||||||
* `ESP32`_ (Datasheet)
|
|
||||||
|
|
||||||
.. _ESP32: https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf
|
|
||||||
|
13
docs/source/common/datasheet.inc
Normal file
13
docs/source/common/datasheet.inc
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
Datasheet
|
||||||
|
---------
|
||||||
|
|
||||||
|
* `ESP32`_ (Datasheet)
|
||||||
|
* `ESP32-S2`_ (Datasheet)
|
||||||
|
* `ESP32-C3`_ (Datasheet)
|
||||||
|
* `ESP32-S3`_ (Datasheet)
|
||||||
|
|
||||||
|
.. _Espressif Product Selector: https://products.espressif.com/
|
||||||
|
.. _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
|
||||||
|
.. _ESP32-S3: https://www.espressif.com/sites/default/files/documentation/esp32-s3_datasheet_en.pdf
|
@ -18,11 +18,11 @@ import sys
|
|||||||
# -- Project information -----------------------------------------------------
|
# -- Project information -----------------------------------------------------
|
||||||
|
|
||||||
project = 'Arduino-ESP32'
|
project = 'Arduino-ESP32'
|
||||||
copyright = '2021, Espressif'
|
copyright = '2022, Espressif'
|
||||||
author = 'Espressif'
|
author = 'Espressif'
|
||||||
|
|
||||||
# The full version, including alpha/beta/rc tags
|
# The full version, including alpha/beta/rc tags
|
||||||
release = '2.0.0'
|
release = '2.0.2'
|
||||||
|
|
||||||
# -- General configuration ---------------------------------------------------
|
# -- General configuration ---------------------------------------------------
|
||||||
|
|
||||||
|
@ -34,10 +34,10 @@ Here are the ESP32 series supported by the Arduino-ESP32 project:
|
|||||||
======== ====== =========== ===================================
|
======== ====== =========== ===================================
|
||||||
SoC Stable Development Datasheet
|
SoC Stable Development Datasheet
|
||||||
======== ====== =========== ===================================
|
======== ====== =========== ===================================
|
||||||
ESP32 Yes Yes `ESP32 Datasheet`_
|
ESP32 Yes Yes `ESP32`_
|
||||||
ESP32-S2 Yes Yes `ESP32-S2 Datasheet`_
|
ESP32-S2 Yes Yes `ESP32-S2`_
|
||||||
ESP32-C3 Yes Yes `ESP32-C3 Datasheet`_
|
ESP32-C3 Yes Yes `ESP32-C3`_
|
||||||
ESP32-S3 No No `ESP32-S3 Datasheet`_
|
ESP32-S3 No Yes `ESP32-S3`_
|
||||||
======== ====== =========== ===================================
|
======== ====== =========== ===================================
|
||||||
|
|
||||||
See `Boards <boards/boards.html>`_ for more details about ESP32 development boards.
|
See `Boards <boards/boards.html>`_ for more details about ESP32 development boards.
|
||||||
@ -91,7 +91,9 @@ Before opening a new issue, please read this:
|
|||||||
Be sure to search for a similar reported issue. This avoids duplicating or creating noise in the GitHub Issues reporting.
|
Be sure to search for a similar reported issue. This avoids duplicating or creating noise in the GitHub Issues reporting.
|
||||||
We also have the troubleshooting guide to save your time on the most common issues reported by users.
|
We also have the troubleshooting guide to save your time on the most common issues reported by users.
|
||||||
|
|
||||||
For more details, see the `Issue Template <https://github.com/espressif/arduino-esp32/blob/master/docs/ISSUE_TEMPLATE.md>`_.
|
For more details about creating new Issue, see the `Issue Template <https://github.com/espressif/arduino-esp32/blob/master/.github/ISSUE_TEMPLATE/Issue-report.yml>`_.
|
||||||
|
|
||||||
|
If you have any new idea, see the `Feature request Template <https://github.com/espressif/arduino-esp32/blob/master/.github/ISSUE_TEMPLATE/Feature-request.yml>`_.
|
||||||
|
|
||||||
First Steps
|
First Steps
|
||||||
-----------
|
-----------
|
||||||
@ -114,15 +116,14 @@ in the examples menu or inside each library folder.
|
|||||||
|
|
||||||
https://github.com/espressif/arduino-esp32/tree/master/libraries
|
https://github.com/espressif/arduino-esp32/tree/master/libraries
|
||||||
|
|
||||||
|
|
||||||
|
.. include:: common/datasheet.inc
|
||||||
|
|
||||||
Resources
|
Resources
|
||||||
---------
|
---------
|
||||||
|
|
||||||
.. _Espressif Systems: https://www.espressif.com
|
.. _Espressif Systems: https://www.espressif.com
|
||||||
.. _Espressif Product Selector: https://products.espressif.com/
|
.. _Espressif Product Selector: https://products.espressif.com/
|
||||||
.. _ESP32 Datasheet: https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf
|
|
||||||
.. _ESP32-S2 Datasheet: https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf
|
|
||||||
.. _ESP32-C3 Datasheet: https://www.espressif.com/sites/default/files/documentation/esp32-c3_datasheet_en.pdf
|
|
||||||
.. _ESP32-S3 Datasheet: https://www.espressif.com/sites/default/files/documentation/esp32-s3_datasheet_en.pdf
|
|
||||||
.. _Arduino.cc: https://www.arduino.cc/en/Main/Software
|
.. _Arduino.cc: https://www.arduino.cc/en/Main/Software
|
||||||
.. _Arduino Reference: https://www.arduino.cc/reference/en/
|
.. _Arduino Reference: https://www.arduino.cc/reference/en/
|
||||||
.. _ESP32 Forum: https://esp32.com
|
.. _ESP32 Forum: https://esp32.com
|
||||||
|
@ -8,7 +8,7 @@ Here you will find all the relevant information about the project.
|
|||||||
This is a work in progress documentation and we will appreciate your help! We are looking for contributors!
|
This is a work in progress documentation and we will appreciate your help! We are looking for contributors!
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 1
|
||||||
:caption: Contents:
|
:caption: Contents:
|
||||||
|
|
||||||
Getting Started <getting_started>
|
Getting Started <getting_started>
|
||||||
|
@ -64,12 +64,7 @@ Notes
|
|||||||
|
|
||||||
.. 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.
|
||||||
|
|
||||||
Datasheet
|
.. include:: common/datasheet.inc
|
||||||
^^^^^^^^^
|
|
||||||
|
|
||||||
* `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>`_
|
|
||||||
|
|
||||||
APIs
|
APIs
|
||||||
----
|
----
|
||||||
@ -78,13 +73,6 @@ The Arduino ESP32 offers some unique APIs, described in this section:
|
|||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
:glob:
|
||||||
|
|
||||||
Bluetooth <api/bluetooth>
|
api/*
|
||||||
Deep Sleep <api/deepsleep>
|
|
||||||
ESPNOW <api/espnow>
|
|
||||||
GPIO <api/gpio>
|
|
||||||
I2C <api/i2c>
|
|
||||||
RainMaker <api/rainmaker>
|
|
||||||
Reset Reason <api/reset_reason>
|
|
||||||
USB <api/usb.rst>
|
|
||||||
Wi-Fi <api/wifi>
|
|
||||||
|
@ -62,7 +62,7 @@ JTAG Dedicated GPIOs
|
|||||||
SD/SDIO/MMC HostController Dedicated GPIOs
|
SD/SDIO/MMC HostController Dedicated GPIOs
|
||||||
Motor PWM Any GPIO
|
Motor PWM Any GPIO
|
||||||
SDIO/SPI SlaveController Dedicated GPIOs
|
SDIO/SPI SlaveController Dedicated GPIOs
|
||||||
UART Any GPIO
|
UART Any GPIO[1]
|
||||||
I2C Any GPIO
|
I2C Any GPIO
|
||||||
I2S Any GPIO
|
I2S Any GPIO
|
||||||
LED PWM Any GPIO
|
LED PWM Any GPIO
|
||||||
@ -72,8 +72,11 @@ Parallel QSPI Dedicated GPIOs
|
|||||||
EMAC Dedicated GPIOs
|
EMAC Dedicated GPIOs
|
||||||
Pulse Counter Any GPIO
|
Pulse Counter Any GPIO
|
||||||
TWAI Any GPIO
|
TWAI Any GPIO
|
||||||
|
USB Dedicated GPIOs
|
||||||
============================== ===================================
|
============================== ===================================
|
||||||
|
|
||||||
|
[1] except for the download/programming mode decided by the bootloader.
|
||||||
|
|
||||||
This table is present on each datasheet provided by Espressif.
|
This table is present on each datasheet provided by Espressif.
|
||||||
|
|
||||||
Usage Examples
|
Usage Examples
|
||||||
@ -106,16 +109,11 @@ To change the pins, we must call the ``Wire.setPins(int sda, int scl);`` functio
|
|||||||
|
|
||||||
A similar approach also applies for the other peripherals.
|
A similar approach also applies for the other peripherals.
|
||||||
|
|
||||||
|
.. include:: ../common/datasheet.inc
|
||||||
|
|
||||||
Resources
|
Resources
|
||||||
---------
|
---------
|
||||||
|
|
||||||
* `ESP32`_ (Datasheet)
|
|
||||||
* `ESP32-S2`_ (Datasheet)
|
|
||||||
* `ESP32-C3`_ (Datasheet)
|
|
||||||
|
|
||||||
.. _Espressif Systems: https://www.espressif.com
|
.. _Espressif Systems: https://www.espressif.com
|
||||||
.. _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-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
|
|
||||||
.. _IO MUX GPIO: https://www.espressif.com/sites/default/files/documentation/esp32_technical_reference_manual_en.pdf#iomuxgpio
|
.. _IO MUX GPIO: https://www.espressif.com/sites/default/files/documentation/esp32_technical_reference_manual_en.pdf#iomuxgpio
|
||||||
|
Reference in New Issue
Block a user