Skip to content

Commit 9e28643

Browse files
committed
add esp32s3 documentation in readme
1 parent dddc282 commit 9e28643

File tree

2 files changed

+79
-9
lines changed

2 files changed

+79
-9
lines changed

README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ Supported Support status
213213
================ ============================================================
214214
atmel-samd ``SAMD21`` stable | ``SAMD51`` stable
215215
cxd56 stable
216-
espressif ``ESP32-C3`` beta | ``ESP32-S2`` stable
216+
espressif ``ESP32-C3`` beta | ``ESP32-S2`` stable | ``ESP32-S3`` beta
217217
litex alpha
218218
mimxrt10xx alpha
219219
nrf stable
@@ -229,7 +229,7 @@ unix alpha
229229
Boards
230230
~~~~~~
231231

232-
- Each ``port`` has a ``boards`` directory containing variations of boards
232+
- Each ``port`` has a ``boards`` directory containing boards
233233
which belong to a specific microcontroller line.
234234
- A list of native modules supported by a particular board can be found
235235
`here <https://circuitpython.readthedocs.io/en/latest/shared-bindings/support_matrix.html>`__.

ports/espressif/README.rst

Lines changed: 77 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Support Status:
1111

1212
ESP32-C3, "beta"
1313
ESP32-S2, "stable"
14+
ESP32-S3, "beta"
1415

1516
How this port is organized:
1617
---------------------------------------
@@ -31,9 +32,11 @@ Connecting to the ESP32-C3
3132

3233
**USB Connetion:**
3334

34-
On ESP32-C3 REV3 chips, a USB Serial/JTAG Controller is available. Note: The USB connection cannot be used for a ``CIRCUITPY`` drive.
35+
On ESP32-C3 REV3 chips, a USB Serial/JTAG Controller is available. Note: This USB connection cannot be used for a ``CIRCUITPY`` drive.
3536

36-
Depending on the board you have the USB port may or may not be connected to native USB, if it isn't connected to native USB then following connections need to be made to get serial console, REPL interface, flashing CircuitPython and JTAG debugging.
37+
Depending on the board you have, the USB port may or may not be connected to native USB.
38+
39+
Following connections need to be made if native USB isn't available on USB port:
3740

3841
.. csv-table::
3942
:header: GPIO, USB
@@ -47,7 +50,9 @@ Connect these pins using a `USB adapter <https://www.adafruit.com/product/4090>`
4750

4851
**UART Connection:**
4952

50-
A `USB to UART convertor <https://www.adafruit.com/product/3309>`_ can be used for connecting to ESP32-C3 to get serial console, REPL interface and flashing CircuitPython. Following connections need to be made in this case.
53+
A `USB to UART convertor <https://www.adafruit.com/product/3309>`_ can be used for connecting to ESP32-C3 to get serial console, REPL interface and flashing CircuitPython.
54+
55+
Following connections need to be made in this case.
5156

5257
.. csv-table::
5358
:header: GPIO, UART
@@ -66,7 +71,46 @@ Connecting to the ESP32-S2
6671

6772
**USB Connetion:**
6873

69-
Depending on the board you have the USB port may or may not be connected to native USB, if it isn't connected to native USB then following connections need to be made to get CircuitPython working.
74+
Depending on the board you have, the USB port may or may not be connected to native USB.
75+
76+
Following connections need to be made if native USB isn't available on USB port:
77+
78+
.. csv-table::
79+
:header: GPIO, USB
80+
81+
20, "D+ (green)"
82+
19, "D- (white)"
83+
GND, "GND (black)"
84+
5V, "5V (red)"
85+
86+
Connect these pins using a `USB adapter <https://www.adafruit.com/product/4090>`_ or `breakout cable <https://www.adafruit.com/product/4448>`_ to access the CircuitPython drive.
87+
88+
**UART Connection:**
89+
90+
A `USB to UART convertor <https://www.adafruit.com/product/3309>`_ can be used for connecting to ESP32-S2 to get serial console and flashing CircuitPython.
91+
92+
Following connections need to be made in this case:
93+
94+
.. csv-table::
95+
:header: GPIO, UART
96+
97+
43, "RX"
98+
44, "TX"
99+
GND, "GND"
100+
5V, "5V"
101+
102+
**BLE Connection:**
103+
104+
This feature isn't available on ESP32-S2.
105+
106+
Connecting to the ESP32-S3
107+
---------------------------------------
108+
109+
**USB Connetion:**
110+
111+
Depending on the board you have, the USB port may or may not be connected to native USB.
112+
113+
Following connections need to be made if native USB isn't available on USB port:
70114

71115
.. csv-table::
72116
:header: GPIO, USB
@@ -78,16 +122,42 @@ Depending on the board you have the USB port may or may not be connected to nati
78122

79123
Connect these pins using a `USB adapter <https://www.adafruit.com/product/4090>`_ or `breakout cable <https://www.adafruit.com/product/4448>`_ to access the CircuitPython drive.
80124

125+
**UART Connection:**
126+
127+
A `USB to UART convertor <https://www.adafruit.com/product/3309>`_ can be used for connecting to ESP32-S3 to get serial console and flashing CircuitPython.
128+
129+
Following connections need to be made in this case:
130+
131+
.. csv-table::
132+
:header: GPIO, UART
133+
134+
43, "RX"
135+
44, "TX"
136+
GND, "GND"
137+
5V, "5V"
138+
139+
**BLE Connection:**
140+
141+
This feature is not yet available and currently under development.
142+
81143
Building and flashing
82144
---------------------------------------
83145

84-
Before building or flashing the, you must `install the esp-idf <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/index.html>`_. This must be re-done every time the esp-idf is updated, but not every time you build. Run ``cd ports/espressif`` from ``circuitpython/`` to move to the espressif port root, and run:
146+
Before building or flashing the, you must `install the esp-idf <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/index.html>`_.
147+
148+
Note: This must be re-done every time the esp-idf is updated, but not every time you build.
149+
150+
Run ``cd ports/espressif`` from ``circuitpython/`` to move to the espressif port root, and run:
85151

86152
.. code-block::
87153
88154
./esp-idf/install.sh
89155
90-
After this initial installation, you must add the esp-idf tools to your path. You must also do this **any time you open a new bash environment for building or flashing**:
156+
After this initial installation, you must add the esp-idf tools to your path.
157+
158+
Note: This must be re-done every time you open a new bash environment for building or flashing.
159+
160+
Run ``cd ports/espressif`` from ``circuitpython/`` to move to the espressif port root, and run:
91161

92162
.. code-block::
93163
@@ -106,7 +176,7 @@ Building boards is typically done through ``make BOARD=board_id``. The default p
106176
Debugging
107177
---------------------------------------
108178

109-
TODO: Add documentation for ESP32-C3 JTAG feature.
179+
TODO: Add documentation for ESP32-C3/S3 JTAG feature.
110180

111181
The ESP32-S2 supports JTAG debugging over OpenOCD using a JLink or other probe hardware. The official tutorials can be found on the Espressif website `here <https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/api-guides/jtag-debugging/index.html>`_, but they are mostly for the ESP32-S2 Kaluga, which has built-in debugging.
112182

0 commit comments

Comments
 (0)