Skip to content

Commit 6e3ea9e

Browse files
pedrominatelpedrominatel
committed
Added boards information
1 parent e041e17 commit 6e3ea9e

File tree

5 files changed

+237
-11
lines changed

5 files changed

+237
-11
lines changed

‎docs/source/boards/ESP32-C3-DevKitM-1.rst

Lines changed: 57 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,36 @@
1+
******************
12
ESP32-C3-DevKitM-1
2-
==================
3+
******************
4+
5+
The ESP32-C3-DevKitM-1 development board is one of the Espressif official boards. This board is based on the `ESP32-C3-MINI-1`_ module, with the `ESP32-C3`_ as the core.
6+
7+
Specifications
8+
--------------
9+
10+
- Small­sized 2.4 GHz Wi­Fi (802.11 b/g/n) and Bluetooth® 5 module
11+
- Built around ESP32­C3 series of SoCs, RISC­V single­core microprocessor
12+
- 4 MB flash in chip package
13+
- 15 available GPIOs (module)
14+
- Peripherals
15+
- 22 × programmable GPIOs
16+
- Digital interfaces:
17+
- 3 × SPI
18+
- 2 × UART
19+
- 1 × I2C
20+
- 1 × I2S
21+
- Remote control peripheral, with 2 transmit channels and 2 receive channels
22+
- LED PWM controller, with up to 6 channels
23+
- Full-speed USB Serial/JTAG controller
24+
- General DMA controller (GDMA), with 3 transmit channels and 3 receive channels
25+
- 1 × TWAI® controller (compatible with ISO 11898-1)
26+
- Analog interfaces:
27+
- 2 × 12-bit SAR ADCs, up to 6 channels
28+
- 1 × temperature sensor
29+
- Timers:
30+
- 2 × 54-bit general-purpose timers
31+
- 3 × watchdog timers
32+
- 1 × 52-bit system timer
33+
- On­board PCB antenna or external antenna connector
334

435
Header Block
536
------------
@@ -58,3 +89,28 @@ Pin Layout
5889
:align: center
5990
:alt: ESP32-C3-DevKitM-1 (click to enlarge)
6091
:figclass: align-center
92+
93+
Straping Pins
94+
-------------
95+
96+
Some of the GPIO's has important feature during the booting process. Here is the list of the strapping pins on the `ESP32-C3`_.
97+
98+
==== ========= ===================================================================== ================ =================
99+
GPIO Default Function Pull-up Pull-down
100+
==== ========= ===================================================================== ================ =================
101+
IO2 N/A Booting Mode See `ESP32-C3`_ See `ESP32-C3`_
102+
IO9 Pull-up Booting Mode SPI Boot Download Boot
103+
IO8 N/A Booting Mode Don't Care Download Boot
104+
IO8 Pull-up Enabling/Disabling Log Print See `ESP32-C3`_ See `ESP32-C3`_
105+
==== ========= ===================================================================== ================ =================
106+
107+
For more detailed information, see the `ESP32-C3`_ datasheet.
108+
109+
Resources
110+
---------
111+
112+
* `ESP32-C3`_ (Datasheet)
113+
* `ESP32-C3-MINI-1`_ (Datasheet)
114+
115+
.. _ESP32-C3: https://www.espressif.com/sites/default/files/documentation/esp32-c3_datasheet_en.pdf
116+
.. _ESP32-C3-MINI-1: https://www.espressif.com/sites/default/files/documentation/esp32-c3-mini-1_datasheet_en.pdf

‎docs/source/boards/ESP32-DevKitC-1.rst

Lines changed: 83 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,34 @@
1+
***************
12
ESP32-DevKitC-1
2-
===============
3+
***************
4+
5+
The `ESP32-DevKitC-1`_ development board is one of the Espressif official boards. This board is based on the `ESP32-WROVER-E`_ module, with the `ESP32`_ as the core.
6+
7+
Specifications
8+
--------------
9+
10+
- Wi-Fi 802.11 b/g/n (802.11n up to 150 Mbps)
11+
- Bluetooth v4.2 BR/EDR and BLE specification
12+
- Built around ESP32 series of SoCs
13+
- Integrated 4 MB SPI flash
14+
- Integrated 8 MB PSRAM
15+
- Peripherals
16+
- SD card
17+
- UART
18+
- SPI
19+
- SDIO
20+
- I2C
21+
- LED PWM
22+
- Motor PWM
23+
- I2S
24+
- IR
25+
- Pulse Counter
26+
- GPIO
27+
- Capacitive Touch Sensor
28+
- ADC
29+
- DAC
30+
- Two-Wire Automotive Interface (TWAI®, compatible with ISO11898-1)
31+
- On­board PCB antenna or external antenna connector
332

433
Header Block
534
------------
@@ -68,3 +97,56 @@ Pin Layout
6897
:align: center
6998
:alt: ESP32-DevKitC-1 (click to enlarge)
7099
:figclass: align-center
100+
101+
Straping Pins
102+
-------------
103+
104+
Some of the GPIO's has important feature during the booting process. Here is the list of the strapping pins on the `ESP32`_.
105+
106+
==== ========= ===================================================================== ============ ==============
107+
GPIO Default Function Pull-up Pull-down
108+
==== ========= ===================================================================== ============ ==============
109+
IO12 Pull-down Voltage of Internal LDO (VDD_SDIO) 1V8 3V3
110+
IO0 Pull-up Booting Mode SPI Boot Download Boot
111+
IO2 Pull-down Booting Mode Don't Care Download Boot
112+
IO15 Pull-up Enabling/Disabling Log Print During Booting and Timing of SDIO Slave U0TXD Active U0TXD Silent
113+
IO5 Pull-up Timing of SDIO Slave See `ESP32`_ See `ESP32`_
114+
==== ========= ===================================================================== ============ ==============
115+
116+
Restricted Usage GPIOS
117+
----------------------
118+
119+
Some of the GPIO's are used for the external flash and PSRAM. These GPIO's cannot be used:
120+
121+
==== ===================
122+
GPIO Shared Function
123+
==== ===================
124+
IO6 External SPI Flash
125+
IO7 External SPI Flash
126+
IO8 External SPI Flash
127+
IO9 External SPI Flash
128+
IO10 External SPI Flash
129+
IO11 External SPI Flash
130+
==== ===================
131+
132+
Other GPIO's are `INPUT ONLY` and cannot be used as output pin:
133+
134+
==== =========================
135+
GPIO Function
136+
==== =========================
137+
IO36 GPIO36, ADC1_CH0, S_VP
138+
IO39 GPIO39, ADC1_CH3, S_VN
139+
IO34 GPIO34, ADC1_CH6, VDET_1
140+
IO35 GPIO35, ADC1_CH7, VDET_2
141+
==== =========================
142+
143+
Resources
144+
---------
145+
146+
* `ESP32`_ (Datasheet)
147+
* `ESP32-WROVER-E`_ (Datasheet)
148+
* `ESP32-DevKitC`_ (Schematic)
149+
150+
.. _ESP32: https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf
151+
.. _ESP32-WROVER-E: https://www.espressif.com/sites/default/files/documentation/esp32-wrover-e_esp32-wrover-ie_datasheet_en.pdf
152+
.. _ESP32-DevKitC: https://dl.espressif.com/dl/schematics/esp32_devkitc_v4-sch.pdf

‎docs/source/boards/ESP32-S2-Saola-1.rst

Lines changed: 76 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,34 @@
1+
****************
12
ESP32-S2-Saola-1
2-
================
3+
****************
4+
5+
The `ESP32-S2-Saola-1`_ development board is one of the Espressif official boards. This board is based on the `ESP32-S2-WROVER`_ module, with the `ESP32-S2`_ as the core.
6+
7+
Specifications
8+
--------------
9+
10+
- Wi-Fi 802.11 b/g/n (802.11n up to 150 Mbps)
11+
- Built around ESP32-S2 series of SoCs Xtensa® single-core
12+
- Integrated 4 MB SPI flash
13+
- Integrated 2 MB PSRAM
14+
- Peripherals
15+
- 43 × programmable GPIOs
16+
- 2 × 13-bit SAR ADCs, up to 20 channels
17+
- 2 × 8-bit DAC
18+
- 14 × touch sensing IOs
19+
- 4 × SPI
20+
- 1 × I2S
21+
- 2 × I2C
22+
- 2 × UART
23+
- RMT (TX/RX)
24+
- LED PWM controller, up to 8 channels
25+
- 1 × full-speed USB OTG
26+
- 1 × temperature sensor
27+
- 1 × DVP 8/16 camera interface, implemented using the hardware resources of I2S
28+
- 1 × LCD interface (8-bit serial RGB/8080/6800), implemented using the hardware resources of SPI2
29+
- 1 × LCD interface (8/16/24-bit parallel), implemented using the hardware resources of I2S
30+
- 1 × TWAI® controller (compatible with ISO 11898-1)
31+
- On­board PCB antenna or external antenna connector
332

433
Header Block
534
------------
@@ -72,3 +101,49 @@ Pin Layout
72101
:align: center
73102
:alt: ESP32-S2-Saola-1 (click to enlarge)
74103
:figclass: align-center
104+
105+
Straping Pins
106+
-------------
107+
108+
Some of the GPIO's has important feature during the booting process. Here is the list of the strapping pins on the `ESP32-S2`_.
109+
110+
==== ========= ===================================================================== ============ ==============
111+
GPIO Default Function Pull-up Pull-down
112+
==== ========= ===================================================================== ============ ==============
113+
IO45 Pull-down Voltage of Internal LDO (VDD_SDIO) 1V8 3V3
114+
IO0 Pull-up Booting Mode SPI Boot Download Boot
115+
IO46 Pull-down Booting Mode Don't Care Download Boot
116+
IO46 Pull-up Enabling/Disabling Log Print During Booting and Timing of SDIO Slave U0TXD Active U0TXD Silent
117+
==== ========= ===================================================================== ============ ==============
118+
119+
For more detailed information, see the `ESP32-S2`_ datasheet.
120+
121+
Restricted Usage GPIOS
122+
----------------------
123+
124+
Some of the GPIO's are used for the external flash and PSRAM. These GPIO's cannot be used:
125+
126+
==== ===================
127+
GPIO Shared Function
128+
==== ===================
129+
IO26 Connected to PSRAM
130+
==== ===================
131+
132+
Other GPIO's are `INPUT ONLY` and cannot be used as output pin:
133+
134+
==== ===========================
135+
GPIO Function
136+
==== ===========================
137+
IO46 GPIO46
138+
==== ===========================
139+
140+
Resources
141+
---------
142+
143+
* `ESP32-S2`_ (Datasheet)
144+
* `ESP32-S2-WROVER`_ (Datasheet)
145+
* `ESP32-S2-Saola-1`_ (Schematics)
146+
147+
.. _ESP32-S2: https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf
148+
.. _ESP32-S2-WROVER: https://www.espressif.com/sites/default/files/documentation/esp32-s2-wrover_esp32-s2-wrover-i_datasheet_en.pdf
149+
.. _ESP32-S2-Saola-1: https://dl.espressif.com/dl/schematics/ESP32-S2-SAOLA-1_V1.1_schematics.pdf

‎docs/source/getting_started.rst

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,31 @@
1+
***************
12
Getting Started
2-
===============
3+
***************
34

45
About Arduino ESP32
56
-------------------
67

78
How to Contribute
89
-----------------
910

11+
Supported SoC's
12+
---------------
13+
14+
======== ====== =========== ===================================
15+
No. Stable Development Datasheet
16+
======== ====== =========== ===================================
17+
ESP32 Yes Yes `ESP32 Datasheet`_
18+
ESP32-S2 No Yes `ESP32-S2 Datasheet`_
19+
ESP32-C3 No Yes `ESP32-C3 Datasheet`_
20+
ESP32-S3 No No Not Available Yet
21+
======== ====== =========== ===================================
22+
1023
Supported Operational Systems
1124
-----------------------------
1225

1326
Currently, the supported OS are: Windows, Linux and macOS.
1427

28+
.. _ESP32 Datasheet: https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf
29+
.. _ESP32-S2 Datasheet: https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf
30+
.. _ESP32-C3 Datasheet: https://www.espressif.com/sites/default/files/documentation/esp32-c3_datasheet_en.pdf
31+
.. _Arduino.cc: https://www.arduino.cc/en/Main/Software

‎docs/source/installing.rst

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,12 @@ Installing using Boards Manager
1616

1717
https://github.com/raw/espressif/arduino-esp32/gh-pages/package_esp32_dev_index.json
1818

19-
2019
Starting with 1.6.4, Arduino allows installation of third-party platform
2120
packages using Boards Manager. We have packages available for Windows,
2221
macOS, and Linux (x86, amd64, armhf and arm64).
2322

23+
.. note::
24+
Currently, the support for new chips (ESP32-S2 and ESP32-C3) are in the development release. Consider installing the development release if you need to test the new supported SoC in beta.
2425

2526
- Install the current upstream Arduino IDE at the 1.8 level or later. The current version is at the `arduino.cc`_ website.
2627

@@ -33,8 +34,6 @@ macOS, and Linux (x86, amd64, armhf and arm64).
3334
Windows
3435
-------
3536

36-
37-
3837
Linux
3938
-----
4039

@@ -122,9 +121,8 @@ openSUSE
122121
123122
- Restart Arduino IDE.
124123

125-
126124
macOS
127-
=====
125+
-----
128126

129127
- Install the latest Arduino IDE from `arduino.cc`_.
130128

@@ -169,7 +167,5 @@ PlatformIO
169167

170168
- `Project Examples <https://docs.platformio.org/en/latest/platforms/espressif32.html?utm_source=github&utm_medium=arduino-esp32#examples>`_
171169

172-
References
173-
==========
174170

175171
.. _Arduino.cc: https://www.arduino.cc/en/Main/Software

0 commit comments

Comments
 (0)