Home

Awesome

Safe Rust wrappers for the services in the ESP IDF SDK

CI crates.io Documentation Matrix Wokwi

Highlights

You might want to also check out the ESP IDF Drivers wrappers, and the raw bindings to ESP IDF in the esp-idf-sys crate!

Build Prerequisites

Follow the Prerequisites section in the esp-idf-template crate.

Examples

The examples could be built and flashed conveniently with cargo-espflash. To run e.g. wifi on an e.g. ESP32-C3: (Swap the Rust target and example name with the target corresponding for your ESP32 MCU and with the example you would like to build)

with cargo-espflash:

$ MCU=esp32c3 cargo espflash flash --target riscv32imc-esp-espidf --example wifi --monitor
MCU"--target"
esp32c2riscv32imc-esp-espidf
esp32c3riscv32imc-esp-espidf
esp32c6riscv32imac-esp-espidf
esp32h2riscv32imac-esp-espidf
esp32p4riscv32imafc-esp-espidf
esp32xtensa-esp32-espidf
esp32s2xtensa-esp32s2-espidf
esp32s3xtensa-esp32s3-espidf

Setting up a "Hello, world!" binary crate with ESP IDF

Use the esp-idf-template project. Everything would be arranged and built for you automatically - no need to manually clone the ESP IDF repository.

More information

For more information, check out: