summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorgarywill <garywill@disroot.org>2024-12-22 13:35:21 +0800
committerDamien George <damien@micropython.org>2025-02-28 16:13:55 +1100
commitec876a5e27163299ff60ee70e4ef21073dd67704 (patch)
treecd2c6652b0c8e3f3f658ffac38569269a3147e60
parentc143eb50248b3a3f521775f09f5073675095e48a (diff)
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 <garywill@disroot.org>
-rw-r--r--ports/esp32/README.md21
1 files changed, 14 insertions, 7 deletions
diff --git a/ports/esp32/README.md b/ports/esp32/README.md
index 6ed7eddb8..d9115072a 100644
--- a/ports/esp32/README.md
+++ b/ports/esp32/README.md
@@ -5,6 +5,9 @@ This is a port of MicroPython to the Espressif ESP32 series of
microcontrollers. It uses the ESP-IDF framework and MicroPython runs as
a task under FreeRTOS.
+Currently supports ESP32, ESP32-C3, ESP32-C6, ESP32-S2 and ESP32-S3
+(ESP8266 is supported by a separate MicroPython port).
+
Supported features include:
- REPL (Python prompt) over UART0.
- 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
```bash
$ cd esp-idf
-$ ./install.sh # (or install.bat on Windows)
+$ ./install.sh esp32 # (or install.bat on Windows)
$ source export.sh # (or export.bat on Windows)
```
-The `install.sh` step only needs to be done once. You will need to source
-`export.sh` for every new session.
+The `install.sh` step only needs to be done once. Change `esp32` if you are
+targeting other chip. Use comma-separated list like `esp32,esp32s2` to
+install for multiple chips. Or omit the chip to install for all Espressif
+chips (which is slower).
+
+You will need to source `export.sh` for every new session.
Building the firmware
---------------------
@@ -85,7 +92,7 @@ this repository):
$ make -C mpy-cross
```
-Then to build MicroPython for the ESP32 run:
+Then to build MicroPython for ESP32 run:
```bash
$ cd ports/esp32
@@ -106,7 +113,7 @@ rebooting or logging out and in again. (Note: on some distributions this may
be the `uucp` group, run `ls -la /dev/ttyUSB0` to check.)
```bash
-$ sudo adduser <username> dialout
+$ sudo usermod -aG dialout <username>
```
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
$ idf.py flash
```
-Some boards also support "variants", which are allow for small variations of
+Some boards also support "variants", which allow for small variations of
an otherwise similar board. For example different flash sizes or features. For
example to build the `OTA` variant of `ESP32_GENERIC`.
@@ -173,7 +180,7 @@ or
$ miniterm.py /dev/ttyUSB0 115200
```
-You can also use `idf.py monitor`.
+You can also use `idf.py monitor` or `mpremote`.
Configuring the WiFi and using the board
----------------------------------------