Safe Rust wrappers for the drivers in the ESP IDF SDK

Highlights

• Implements the traits of embedded-hal V0.2 as well as those of V1.0 - both blocking and async
• Supports almost all ESP IDF drivers: GPIO, SPI, I2C, TIMER, PWM, I2S, UART, etc.
• Blocking and async mode for each driver (async support in progress)
• Re-exports esp-idf-sys as espidfhal::sys

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

(For baremetal Rust ESP projects please check esp-hal.)

Community Effort

Please note that all esp-idf-* crates are a community effort, in that Espressif puts little to no paid developer time in these. So while ESP-IDF itself is very popular and well tested, the esp-idf-* crates:

• Might be a bit lagging behind the latest stable ESP-IDF version
• Are (currently) missing HIL tests
• Need more documentation

For a HAL which is officially supported by Espressif (as in - with paid developer time), please look at esp-hal. Keep in mind that esp-hal is nostd-only, does not use ESP-IDF and requires async programming.

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. the ledcsimple 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 ledc_simple --monitor

| MCU | "--target" | | --- | ------ | | esp32c2 | riscv32imc-esp-espidf | | esp32c3| riscv32imc-esp-espidf | | esp32c6| riscv32imac-esp-espidf | | esp32h2 | riscv32imac-esp-espidf | | esp32p4 | riscv32imafc-esp-espidf | | esp32 | xtensa-esp32-espidf | | esp32s2 | xtensa-esp32s2-espidf | | esp32s3 | xtensa-esp32s3-espidf |

In order to run the examples on other chips you will most likely need to adapt at least the used pins.

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:

• The Rust on ESP Book
• The ESP Embedded Training
• The esp-idf-template project
• The embedded-hal project
• The esp-idf-svc project
• The embedded-svc project
• The esp-idf-sys project
• The Rust for Xtensa toolchain
• The Rust-with-STD demo project

Hardware Notes

Each chip has a number of GPIO pins which are generally used by the SPI0 and SPI1 peripherals in order to connect external PSRAM and/or SPI Flash memory. The datasheets explicitly state that these are not recommended for use, however this crate includes them anyways for completeness.

Please refer to the table below to determine the pins which are not recommended for use for your chip.

| Chip | GPIOs | | ------------ | :----------------: | | ESP32 | 6 - 11, 16 - 17 | | ESP32-C2 | 12 - 17 | | ESP32-C3 | 12 - 17 | | ESP32-C6 | 24 - 30 | | ESP32-H2 | 15 - 21 | | ESP32-S2 | 26 - 32 | | ESP32-S3 | 26 - 32, 33 - 37\* |

\* When using Octal Flash and/or Octal PSRAM