Skip to content

Commit ec876a5

Browse files
garywilldpgeorge
authored andcommitted
esp32/README: Make some minor improvements to the README.
Changes: - To add user to Linux dialout group, usermod is the universal Linux way. adduser is Debian-based way. - When installing IDF, we don't have to install all toolchains for all chips. - List currently supported chip models. - Other minor typo and gramma corrections. Signed-off-by: garywill <[email protected]>
1 parent c143eb5 commit ec876a5

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

ports/esp32/README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ This is a port of MicroPython to the Espressif ESP32 series of
55
microcontrollers. It uses the ESP-IDF framework and MicroPython runs as
66
a task under FreeRTOS.
77

8+
Currently supports ESP32, ESP32-C3, ESP32-C6, ESP32-S2 and ESP32-S3
9+
(ESP8266 is supported by a separate MicroPython port).
10+
811
Supported features include:
912
- REPL (Python prompt) over UART0.
1013
- 16k stack for the MicroPython task and approximately 100k Python heap.
@@ -67,12 +70,16 @@ After you've cloned and checked out the IDF to the correct version, run the
6770

6871
```bash
6972
$ cd esp-idf
70-
$ ./install.sh # (or install.bat on Windows)
73+
$ ./install.sh esp32 # (or install.bat on Windows)
7174
$ source export.sh # (or export.bat on Windows)
7275
```
7376

74-
The `install.sh` step only needs to be done once. You will need to source
75-
`export.sh` for every new session.
77+
The `install.sh` step only needs to be done once. Change `esp32` if you are
78+
targeting other chip. Use comma-separated list like `esp32,esp32s2` to
79+
install for multiple chips. Or omit the chip to install for all Espressif
80+
chips (which is slower).
81+
82+
You will need to source `export.sh` for every new session.
7683

7784
Building the firmware
7885
---------------------
@@ -85,7 +92,7 @@ this repository):
8592
$ make -C mpy-cross
8693
```
8794

88-
Then to build MicroPython for the ESP32 run:
95+
Then to build MicroPython for ESP32 run:
8996

9097
```bash
9198
$ cd ports/esp32
@@ -106,7 +113,7 @@ rebooting or logging out and in again. (Note: on some distributions this may
106113
be the `uucp` group, run `ls -la /dev/ttyUSB0` to check.)
107114

108115
```bash
109-
$ sudo adduser <username> dialout
116+
$ sudo usermod -aG dialout <username>
110117
```
111118

112119
If you are installing MicroPython to your module for the first time, or
@@ -141,7 +148,7 @@ $ idf.py -D MICROPY_BOARD=ESP32_GENERIC build
141148
$ idf.py flash
142149
```
143150

144-
Some boards also support "variants", which are allow for small variations of
151+
Some boards also support "variants", which allow for small variations of
145152
an otherwise similar board. For example different flash sizes or features. For
146153
example to build the `OTA` variant of `ESP32_GENERIC`.
147154

@@ -173,7 +180,7 @@ or
173180
$ miniterm.py /dev/ttyUSB0 115200
174181
```
175182

176-
You can also use `idf.py monitor`.
183+
You can also use `idf.py monitor` or `mpremote`.
177184

178185
Configuring the WiFi and using the board
179186
----------------------------------------

0 commit comments

Comments
 (0)