esp-idf-sys
| Crates.io | esp-idf-sys |
| lib.rs | esp-idf-sys |
| version | |
| source | src |
| created_at | 2019-08-02 11:44:58.315343 |
| updated_at | 2025-01-10 16:10:01.157384 |
| description | Bindings for ESP-IDF (Espressif's IoT Development Framework) |
| homepage | |
| repository | https://github.com/esp-rs/esp-idf-sys |
| max_upload_size | |
| id | 153738 |
| Cargo.toml error: | TOML parse error at line 25, column 1 | 25 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include` |
| size | 0 |
espressif (github:esp-rs:espressif)
documentation
README
Raw Rust bindings for the ESP IDF SDK
Highlights
- Build is
cargodriven and automatically downloads & configures everything by default; no need to download the ESP IDF SDK manually, or set up a C toolchain - Supports both native ESP IDF build (default), as well as a PlatformIO build
- Option to use in a mixed Rust/C project. Check the documentation in the esp-idf-template crate
You might want to also check out the type safe Rust wrappers built on top of these raw bindings:
Note
esp-idf-sys's build script will download the esp-idf, its gcc toolchain, and build it. To show progress and build information about this process run cargo with the-vv(very verbose) flag, so that build script output is also displayed. This is especially useful since the initial build will take a while.
Build Prerequisites
Follow the Prerequisites section in the esp-idf-template crate.
Customizing how the ESP IDF SDK is built
Read the documentation here.
Examples
The examples could be built and flashed conveniently with cargo-espflash. To run e.g. std_basics 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 std_basics --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 |
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 esp-idf-svc project
- The esp-idf-hal project
- The embedded-svc project
- The embedded-hal project
- The Rust for Xtensa toolchain
- The Rust-with-STD demo project