Skip to main content

Module platform

Module platform 

Source
Expand description

ESP32 platform build, flash, emulation, and package utilities.

The generated harness crate pins its own esp Rust toolchain via rust-toolchain.toml and selects the Xtensa target via .cargo/config.toml, so builds simply run cargo build inside the harness directory with the Xtensa GCC and clang library paths exported.

Structs§

SerialPortSummary
Summary of a host serial port for device listing and board auto-detection.

Functions§

build_esp32
Build the ESP32 firmware ELF for the configured chip.
built_esp32_binary_path
Resolve the built ESP32 firmware ELF path for the given profile.
clean_esp32
Clean Cargo build artifacts and packaged images for the ESP32 harness.
detect_esp_serial_port
Pick the serial port of a connected ESP32 board, if any.
esp_toolchain_envs
Environment variables required to drive the Espressif Rust toolchain for chip.
is_esp32_platform
Check if a platform is supported by the ESP32 backend.
package_esp32
Package the built firmware as a flashable merged image.
qemu_esp32
Run the built firmware ELF under the chip’s QEMU, streaming serial output.
run_esp32
Build, then flash and monitor the firmware on a board, or emulate it.
scan_serial_ports
List host serial ports, marking ports that look like ESP32 boards.