8e0a2012dc
* docs: Update GPIO docs * docs: Update other GPIO modules docs * docs: Update AES mod documentation * docs: Update Analog and ADC mod documentation * docs: Update DAC mod documentation * docs: Update lib docs * docs: Update clock mod documentation * docs: Update dma mod documentation * docs: Update interrupt mod documentation * docs: Update lcd_cam mod documentation * docs: Update ledc mod documentation * docs: Update mcpwm mod documentation * docs: Update pcnt mod documentation * docs: Update rom mod documentation * docs: Update rsa mod documentation * docs: Update rtc_cntl mod documentation * docs: Update spi mod documentation * docs: Update timer mod documentation * docs: Update twai mod documentation * docs: Format headers * style: Fix fmt * refactor: Change visibility instead of hidding docs * style: Fix header * Fix typo Co-authored-by: Juraj Sadel <jurajsadel@gmail.com> * Fix typo Co-authored-by: Juraj Sadel <jurajsadel@gmail.com> * Fix typo Co-authored-by: Juraj Sadel <jurajsadel@gmail.com> * Fix typo Co-authored-by: Juraj Sadel <jurajsadel@gmail.com> * Fix typo Co-authored-by: Juraj Sadel <jurajsadel@gmail.com> * docs: Add tracking issue * docs: Remove architecture and simplify sentence * fix: Update visibilities remove hidden docs * Fix type Co-authored-by: Jesse Braham <jessebraham@users.noreply.github.com> * docs: Improve wording Co-authored-by: Jesse Braham <jessebraham@users.noreply.github.com> --------- Co-authored-by: Juraj Sadel <jurajsadel@gmail.com> Co-authored-by: Jesse Braham <jessebraham@users.noreply.github.com>
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, ESP32-C3, 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.
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.
If you consider contributing, please make sure you have read and understood our contributing guide and API guidelines.