aa0e257ffe
* commit test 1 test commit 2 next device asd * try example, haven't built yet * Add feature flags for legacy RMT examples Remove references to the ds18b20 specific device. Add a feature flag `rmt-legacy` that, when enabled, will build the original rmt modules from v4 of the esp-idf. When disabled, the v5 rmt interface can be used for one wire applications. Implement the Iterator trait for a device search and use the Iterator in the example. * Add more feature guards to examples compile * Add alternative main functions for examples * Use std threading * Add std to thread sleep * use std duration * correct use for legacy rmt component * Remove local bindings and use the esp-idf-sys master * fix a typo * Remove esp-idf component inclusion * Update gitignore * Fix examples * mut-ex out the example compilation * add implementation for temperature readings * Conditional compile * esp4.4 compile * Changes to cargo and config * Remove OWDevice and simplify API * Remove phantomdata that is not required * adjust lifetimes for single search at a time * Keep RMT peripheral and add channel to onewire Moves the RMT driver into a private `driver` module, which will only be compiled in rmt-legacy mode. Also reduce the number of cfg feature flags in examples by wrapping the implementation in a module. * modularise examples * Fix for CI * update example name to make it pop --------- Co-authored-by: Dane Slattery <dane@polarmonitoring.com> Co-authored-by: DaneSlattery <dane_s@umantec.net>
Safe Rust wrappers for the drivers in the ESP IDF SDK
Highlights
- Implements the traits of embedded-hal
V0.2as well as those ofV1.0- both blocking and async - Supports almost all ESP IDF drivers: GPIO, SPI, I2C, TIMER, PWM, I2S, UART, etc.
- Blocking and
asyncmode for each driver (asyncsupport in progress) - Re-exports
esp-idf-sysasesp_idf_hal::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.)
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 ledc_simple 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-templateproject - The
embedded-halproject - The
esp-idf-svcproject - The
embedded-svcproject - The
esp-idf-sysproject - 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