Skip to content

Commit a5a1cf1

Browse files
committed
docs(esp32): UF2 support, mention Rust
1 parent deb55ba commit a5a1cf1

File tree

2 files changed

+19
-11
lines changed

2 files changed

+19
-11
lines changed

docs/guides/esp32.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,12 @@ You can contribute additional boards by sending a pull request to [wokwi-boards]
2323

2424
## Getting Started
2525

26-
You can use the ESP32 simulator in three ways:
26+
You can use the ESP32 simulator to run different kinds of applications:
2727

28-
1. Build projects using the ESP32 Arduino Core (including ESP-IDF projects)
29-
2. Run MicroPython projects (also CircuitPython on the ESP32-S2)
30-
3. Simulate bin application files you built on your machine (e.g. using ESP-IDF)
28+
1. ESP32 Arduino Core projects (including ESP-IDF projects)
29+
2. MicroPython and CircuitPython projects
30+
3. Rust projects (see https://wokwi.com/rust)
31+
4. Custom application firmware files (e.g. applications built using the ESP-IDF)
3132

3233
### Arduino Core
3334

@@ -43,9 +44,16 @@ Start from the [MicroPython ESP32 Project Template](https://wokwi.com/projects/n
4344

4445
Note: While the simulation is running, press Ctrl+C inside the Serial Terminal to get into the _MicroPython REPL_. Alternatively, you can edit the Blink Example code and remove the while loop. For more information, check out the [MicroPython Guide](./micropython).
4546

46-
### Custom Application (.bin) File
47+
### Custom Application Firmware
4748

48-
Open the [ESP32 custom application project template](https://wokwi.com/projects/305457271083631168), and press "F1" in the code editor. Then choose "Load HEX File and Start Simulation…". Choose any .bin file from your computer and the simulation will start.
49+
Open the [ESP32 custom application project template](https://wokwi.com/projects/305457271083631168), and press "F1" in the code editor. Then choose "Upload Firmware and Start Simulation…". Choose any .bin, .elf or .uf2 file from your computer and the simulation will start.
50+
51+
:::info
52+
When uploading a custom firmware, it's recommended to create a single .bin file that contains the bootloader, partition table, and
53+
application. You can use the [esptool merge_bin command](https://docs.espressif.com/projects/esptool/en/latest/esp32/esptool/basic-commands.html#merge-binaries-for-flashing-merge-bin) to create such file.
54+
55+
For ESP-IDF projects, you can also build a single UF2 file using the command: `idf.py uf2`. The file will be located in `build/uf2.bin`, and can be uploaded to the simulator.
56+
:::
4957

5058
## Simulator Examples
5159

docs/vscode/project-config.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@ Replace "path-to-your-firmware" with the location of the compiled firmware, **re
2323

2424
The extension of the firmware file depends on the board you are using:
2525

26-
| Board | Firmware file extension |
27-
| -------------------------- | ----------------------- |
28-
| Arduino Uno/Mega, ATtiny85 | .hex or .elf |
29-
| Raspberry Pi Pico | .uf2 or .hex |
30-
| ESP32 Family | .bin or .elf |
26+
| Board | Supported firmware types |
27+
| -------------------------- | ------------------------ |
28+
| Arduino Uno/Mega, ATtiny85 | .hex, .elf |
29+
| Raspberry Pi Pico | .hex, .uf2 |
30+
| ESP32 Family | .bin, .uf2, .elf |
3131

3232
You check test your configuration by pressing **F1** and then selecting "**Wokwi: Start Simulator**".
3333

0 commit comments

Comments
 (0)