You can get really good official docs here now https://github.com/adafruit/circuitpython/tree/main/ports/espressif
Below are the old notes (19 Oct 2020)
This is all pre-release stuff so while it worked for me at the time I wrote it, it might be changed.
- Do the first three(3) streps in the Getting Started Guide
- Pip install the pre-release esptool:
pip install -e ~/esp/esp-idf/components/esptool_py/esptool - Check the esptool version. You should see:
➜ esptool.py version
esptool.py v3.0-dev
3.0-dev
NOTE: I have a wrover, so the commands below are for that you use WROOM if you have that boad. NOTE: This is using the Saola's USB port (the one on the board) not the ESP32-S2's native USB.
On Mac: look for the port in ls /dev.tty* 99.9% its the USB one.
on Windows it's a com#
esptool.py --chip esp32s2 --port /dev/tty.usbserial-1420 -b 460800 --before=default_reset --after=hard_reset write_flash --flash_mode dio --flash_freq 40m --flash_size 4MB 0x0000 adafruit-circuitpython-espressif_saola_1_wrover-en_US-5.4.0-beta.1.bin
The output I saw was:
esptool.py v3.0-dev
Serial port /dev/tty.usbserial-1420
Connecting....
Chip is ESP32-S2
Features: WiFi
Crystal is 40MHz
MAC: 7c:df:a1:00:7d:a8
Uploading stub...
Running stub...
Stub running...
Changing baud rate to 460800
Changed.
Configuring flash size...
Compressed 395888 bytes to 222622...
Wrote 395888 bytes (222622 compressed) at 0x00000000 in 5.3 seconds (effective 601.1 kbit/s)...
Hash of data verified.
You know you have the wrong
espytool.pyif it doesn't like your--chip esp32s2cli option.
NOTE: Now we will be using the ESP32-S2 Native USB
esptool.py --chip esp32s2 -p /dev/cu.usbmodem01 --no-stub -b 460800 --before=default_reset --after=hard_reset write_flash --flash_mode qio --flash_freq 40m --flash_size 16MB 0x0000 adafruit-circuitpython-unexpectedmaker_feathers2-en_US-20200815-41be0fd.bin
The output I saw was:
esptool.py v3.0-dev
Serial port /dev/cu.usbmodem01
Connecting...
Chip is ESP32-S2
Features: WiFi
Crystal is 40MHz
MAC: 7c:df:a1:00:8c:1c
Changing baud rate to 460800
Changed.
Enabling default SPI flash mode...
Configuring flash size...
Erasing flash...
Took 1.58s to erase flash block
Wrote 481280 bytes at 0x00000000 in 13.1 seconds (295.0 kbit/s)...
Hash of data verified.
Leaving...
Hard resetting via RTS pin...
Tap the reset button and you should have a CircuitPy drive show up.
The ESP32-S2 has native USB support which enables it to show up as a USB drive on your PC. This is a must-have for CircuitPython. THe USB port on the WROVER is not the native one. To access the native port you to have to connect a USB cable to the pins on the WROVER.
Watch @tannewt wire it up with the Adafruit USB-A Breakout Cable
| NAME | USB | WROVER |
|---|---|---|
| D- | White | 19 |
| D+ | Green | 20 |
| 5VDC | Red | 5V |
| Ground | Black | GND |
I used an Adafruit USB C Breakout Board - Downstream Connection 4094 and put my WROVER on a breadboard.
| Header Pin | WROVER Pin |
|---|---|
| Ground | GND |
| VBUS | 5V |
| CC1 | -- |
| D- | 19 |
| D+ | 20 |
| SBU1 | -- |
| CC2 | -- |
I've seen intermittent issues where the Native USB won't show up in MacOS. So far, it appears as though if I reboot it then works. No pattern yet has been figured out.
I did not use these, let me know if they need to be corrected
| NAME | USB | WROVER |
|---|---|---|
| 5VDC | 1 | 5V |
| D- | 2 | 19 |
| D+ | 3 | 20 |
| Ground | 4 | GND |
| NAME | USB | WROVER |
|---|---|---|
| D- | A7\B7 | 19 |
| D+ | A6\B6 | 20 |
| 5VDC | A9\B4 | 5V |
| Ground | A1\B12 OR B1\A12 | GND |
- Do the first four(4) streps in the (Getting Started Guide)[https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/get-started/index.html].
- If you've already done 1-3, just do 4.
- Follow the (Building CircuitPython setup steps)[https://learn.adafruit.com/building-circuitpython/introduction]
- You do NOT need to install the GCC for Arm (gcc-arm-embedded on MacOS). The IDF handles that (This is Xtensa not ARM).
- Follow the steps right through Build CircuitPython.
- After you build mpy-cross, you are ready to build the ESP32-S2 port of CircuitPython for your board.
- Have a look in
circruitpython/ports/esp32s2/boardsand take note the board names. - From
circruitpython/ports/esp32s2/runmake BOARD=YOUR BOARDfor example:make BOARD=unexpectedmaker_feathers2- If you get errors, first try running
make clean BOARD=YOUR BOARD. - If you still get errors double check all your setup steps (maybe you didn't install something) and if still stuck head over to (AdaFruit Discord)[https://discord.gg/adafruit] and the CircuitPython channel.
- If you get errors, first try running
- If your build completes without errors, you use the same flash commnds outlined above. Your file will be in a build-YOURBOARD folder and the file name is firmware.bin. example:
build-unexpectedmaker_feathers2/firmware.bin
Some of us had problems with rw storage after loading cpy on the saolas. This has fixed in all cases so far:
import storage
storage.erase_filesystem()
Also, the way the Makefile is currently writen, it will only work on a Mac which sucks for the rest of us. @tannewt suggested detecting the port and adding "PORT="
make BOARD=espressif_saola_1_wrover PORT=/dev/on-my-os flash
(both are not bugs since uf2 is coming)