You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: ports/espressif/README.rst
+77-7Lines changed: 77 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,7 @@ Support Status:
11
11
12
12
ESP32-C3, "beta"
13
13
ESP32-S2, "stable"
14
+
ESP32-S3, "beta"
14
15
15
16
How this port is organized:
16
17
---------------------------------------
@@ -31,9 +32,11 @@ Connecting to the ESP32-C3
31
32
32
33
**USB Connetion:**
33
34
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.
35
36
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:
37
40
38
41
.. csv-table::
39
42
:header: GPIO, USB
@@ -47,7 +50,9 @@ Connect these pins using a `USB adapter <https://www.adafruit.com/product/4090>`
47
50
48
51
**UART Connection:**
49
52
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.
51
56
52
57
.. csv-table::
53
58
:header: GPIO, UART
@@ -66,7 +71,46 @@ Connecting to the ESP32-S2
66
71
67
72
**USB Connetion:**
68
73
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:
70
114
71
115
.. csv-table::
72
116
:header: GPIO, USB
@@ -78,16 +122,42 @@ Depending on the board you have the USB port may or may not be connected to nati
78
122
79
123
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.
80
124
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
+
81
143
Building and flashing
82
144
---------------------------------------
83
145
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:
85
151
86
152
.. code-block::
87
153
88
154
./esp-idf/install.sh
89
155
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:
91
161
92
162
.. code-block::
93
163
@@ -106,7 +176,7 @@ Building boards is typically done through ``make BOARD=board_id``. The default p
106
176
Debugging
107
177
---------------------------------------
108
178
109
-
TODO: Add documentation for ESP32-C3 JTAG feature.
179
+
TODO: Add documentation for ESP32-C3/S3 JTAG feature.
110
180
111
181
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.
0 commit comments