| .cargo | ||
| .github | ||
| .vscode | ||
| esp-alloc | ||
| esp-build | ||
| esp-hal | ||
| esp-hal-procmacros | ||
| esp-hal-smartled | ||
| esp-lp-hal | ||
| esp-metadata | ||
| esp-riscv-rt | ||
| examples | ||
| hil-test | ||
| resources | ||
| xtask | ||
| .gitattributes | ||
| .gitignore | ||
| Cargo.toml | ||
| CONTRIBUTING.md | ||
| LICENSE-APACHE | ||
| LICENSE-MIT | ||
| pre-commit | ||
| README.md | ||
| rustfmt.toml | ||
esp-hal
Bare-metal (no_std) hardware abstraction layer for Espressif devices. Currently supports, to varying degrees, the following devices:
- ESP32 Series: ESP32
- ESP32-C Series: ESP32-C2 (aka ESP8684), ESP32-C3 (aka ESP8685), ESP32-C6
- ESP32-H Series: ESP32-H2
- ESP32-S Series: ESP32-S2, ESP32-S3
Additionally provides limited support for programming the low-power RISC-V cores found on the ESP32-C6, ESP32-S2, and ESP32-S3 via the esp-lp-hal package.
These packages are all no_std; if you are looking for std support, please use esp-idf-svc instead.
If you have any questions, comments, or concerns, please open an issue, start a new discussion, or join us on Matrix. For additional information regarding any of the crates in this repository, please refer to the relevant crate's README.
Note
This project is still in the relatively early stages of development, and as such there should be no expectation of API stability. A significant number of peripherals currently have drivers implemented but have varying levels of functionality. For most basic tasks, this should be usable already, however some more advanced or uncommon features may not yet be implemented.
Getting Started
For information relating to the development of Rust applications on ESP devices, please first read The Rust on ESP Book.
For information about the HAL and how to use it in your own projects, please refer to the documentation.
Resources
- The Rust Programming Language
- The Embedded Rust Book
- The Embedonomicon
- The Rust on ESP Book
- Embedded Rust (no_std) on Espressif
Crates
This repository is home to a number of different packages; for more information regarding a particular package, please refer to its README.md and/or documentation.
Ancillary Crates
There are a number of other crates within the esp-rs organization which can be used in conjunction with esp-hal:
| Crate | Description |
|---|---|
| esp-backtrace | Backtrace support for bare-metal applications |
| esp-ieee802154 | Low-level IEEE802.15.4 driver for the ESP32-C6 and ESP32-H2 |
| esp-openthread | A bare-metal Thread implementation using esp-ieee802154 |
| esp-println | Provides print! and println! implementations |
| esp-storage | Implementation of embedded-storage traits to access unencrypted flash memory |
| esp-wifi | no_std Wi-Fi/BLE/ESP-NOW support |
License
Licensed under either of:
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.