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
+61-11Lines changed: 61 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,16 @@
1
-
Circuitpython on ESP32-S2
1
+
CircuitPython on Espressif SoCs
2
2
=======================================
3
3
4
-
This port adds the ESP32-S2 line of modules from Espressif to Circuitpython. ESP32-S2 modules are low power, single-core Wi-Fi microcontroller SoCs designed for IoT applications.
4
+
This port adds the Espressif line of SoCs to CircuitPython.
5
+
6
+
Support Status:
7
+
---------------------------------------
8
+
9
+
.. csv-table::
10
+
:header: SoC, Status
11
+
12
+
ESP32-C3, "beta"
13
+
ESP32-S2, "stable"
5
14
6
15
How this port is organized:
7
16
---------------------------------------
@@ -10,32 +19,69 @@ How this port is organized:
10
19
- **boards/** contains the configuration files for each development board and breakout available on the port.
11
20
- **common-hal/** contains the port-specific module implementations, used by shared-module and shared-bindings.
12
21
- **esp-idf/** contains the Espressif IoT development framework installation, including all the drivers for the port.
13
-
- **modules/** contains information specific to certain ESP32-S2 hardware modules, such as the pins used for flash and RAM on the WROVER and WROOM.
22
+
- **modules/** contains information specific to certain Espressif SoC based hardware modules, such as the pins used for flash and RAM on the WROVER and WROOM.
14
23
- **peripherals/** contains peripheral setup files and peripheral mapping information, sorted by family and sub-variant. Most files in this directory can be generated with the python scripts in **tools/**.
15
24
- **supervisor/** contains port-specific implementations of internal flash, serial and USB, as well as the **port.c** file, which initializes the port at startup.
16
25
- **tools/** includes useful python scripts for debugging and other purposes.
17
26
18
27
At the root level, refer to **mpconfigboard.h** and **mpconfigport.mk** for port specific settings and a list of enabled circuitpython modules.
19
28
29
+
Connecting to the ESP32-C3
30
+
---------------------------------------
31
+
32
+
**USB Connetion:**
33
+
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
+
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
+
38
+
.. csv-table::
39
+
:header: GPIO, USB
40
+
41
+
19, "D+ (green)"
42
+
18, "D- (white)"
43
+
GND, "GND (black)"
44
+
5V, "5V (red)"
45
+
46
+
Connect these pins using a `USB adapter <https://www.adafruit.com/product/4090>`_ or `breakout cable <https://www.adafruit.com/product/4448>`_.
47
+
48
+
**UART Connection:**
49
+
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.
51
+
52
+
.. csv-table::
53
+
:header: GPIO, UART
54
+
55
+
21, "RX"
56
+
20, "TX"
57
+
GND, "GND"
58
+
5V, "5V"
59
+
60
+
**BLE Connection:**
61
+
62
+
This feature is not yet available and currently under development.
63
+
20
64
Connecting to the ESP32-S2
21
65
---------------------------------------
22
66
23
-
The USB port built into ESP32-S2 boards such as the Saola is not the native USB of the board, but a debugging and programming interface. The actual ESP32-S2 native USB which exposes the Circuitpython drive and CDC connection is located on IO pins 19 and 20:
67
+
**USB Connetion:**
68
+
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.
24
70
25
71
.. csv-table::
26
72
:header: GPIO, USB
27
73
28
74
20, "D+ (green)"
29
75
19, "D- (white)"
30
76
GND, "GND (black)"
31
-
5V, "+5V (red)"
77
+
5V, "5V (red)"
32
78
33
-
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.
79
+
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.
34
80
35
81
Building and flashing
36
82
---------------------------------------
37
83
38
-
Before building or flashing the ESP32-S2, you must `install the esp-idf <https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/get-started/index.html>`_. This must be re-done every time the esp-idf is updated, but not every time you build. Run ``cd ports/esp32s2`` from ``circuitpython/`` to move to the esp32s2 port root, and run:
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:
39
85
40
86
.. code-block::
41
87
@@ -47,24 +93,28 @@ After this initial installation, you must add the esp-idf tools to your path. Yo
47
93
48
94
. esp-idf/export.sh
49
95
50
-
When Circuitpython updates the ESP-IDF to a new release, you may need to run this installation process again. The exact commands used may also vary based on your bash environment.
96
+
When CircuitPython updates the ESP-IDF to a new release, you may need to run this installation process again. The exact commands used may also vary based on your bash environment.
51
97
52
-
Building boards such as the Saola is typically done through ``make flash``. The default port is ``tty.SLAB_USBtoUART``, which will only work on certain Mac setups. On most machines, both Mac and Linux, you will need to set the port yourself by running ``ls /dev/tty.usb*`` and selecting the one that only appears when your development board is plugged in. An example make command with the port setting is as follows:
98
+
Building boards is typically done through ``make BOARD=board_id``. The default port is ``tty.SLAB_USBtoUART``, which will only work on certain Mac setups. On most machines, both Mac and Linux, you will need to set the port yourself by running ``ls /dev/tty.usb*`` and selecting the one that only appears when your development board is plugged in. An example make command with the port setting is as follows:
53
99
54
100
.. code-block::
55
101
56
-
make BOARD=espressif_saola_1_wrover flash PORT=/dev/tty.usbserial-1421120
102
+
make BOARD=board_id PORT=/dev/tty.usbserial-1421120 flash
103
+
104
+
``board_id`` is the unique board identifier in CircuitPython. It is the same as the name of board in ``boards`` directory.
57
105
58
106
Debugging
59
107
---------------------------------------
60
108
109
+
TODO: Add documentation for ESP32-C3 JTAG feature.
110
+
61
111
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.
62
112
63
113
OpenOCD is automatically installed and added to your bash environment during the esp-idf installation and setup process. You can double check that it is installed by using ``openocd --version``, as per the tutorial. Attach the JTAG probe pins according to the `instructions for JTAG debugging <https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/api-guides/jtag-debugging/configure-other-jtag.html>`_ on boards that do not contain an integrated debugger.
64
114
65
115
Once the debugger is connected physically, you must run OpenOCD with attached configuration files specifying the **interface** (your debugger probe) and either a **target** or a **board** (targets are for SoCs only, and can be used when a full board configuration file doesn't exist). You can find the path location of these files by checking the ``OPENOCD_SCRIPTS`` environmental variable by running ``echo $OPENOCD_SCRIPTS`` in bash. Interfaces will be in the ``interface/`` directory, and targets and boards in the ``target/`` and ``board/`` directories, respectively.
66
116
67
-
**Note:** Unfortunately, there are no board files for the esp32-s2 other than the Kaluga, and the included ``target/esp32s2.cfg`` target file will not work by default on the Jlink for boards like the Saola 1, as the default speed is incorrect. In addition, these files are covered under the GPL and cannot be included in Circuitpython. Thus, you must make a copy of the esp32s2.cfg file yourself and add the following line manually, under ``transport select jtag`` at the start of the file:
117
+
**Note:** Unfortunately, there are no board files for the esp32-s2 other than the Kaluga, and the included ``target/esp32s2.cfg`` target file will not work by default on the Jlink for boards like the Saola 1, as the default speed is incorrect. In addition, these files are covered under the GPL and cannot be included in CircuitPython. Thus, you must make a copy of the esp32s2.cfg file yourself and add the following line manually, under ``transport select jtag`` at the start of the file:
0 commit comments