no_std Hardware Abstraction Layers for ESP32 microcontrollers
Go to file
Sergio Gasquez Arcos 7ea471c1ac
Remove unnecessary delay (#1794)
* fix: Remove unnecesary delay

* docs: Update changelog

* fix: Remove unused variable

* fix: Remove clippy warning from examples
2024-07-15 13:09:47 +00:00
.cargo Add the xtask package, implement automation for building examples (#1157) 2024-02-12 15:38:19 +00:00
.github Housekeeping: fix warnings, rename some examples, etc. (#1786) 2024-07-12 09:35:55 +00:00
esp-alloc Update changelog CI (#1725) 2024-06-28 14:15:01 +00:00
esp-backtrace Remove unnecessary build dependency from esp-backtrace (#1788) 2024-07-12 15:07:37 +00:00
esp-build Add a lint-packages subcommand to xtask, use in CI workflow (#1594) 2024-05-24 20:00:04 +00:00
esp-hal Remove unnecessary delay (#1794) 2024-07-15 13:09:47 +00:00
esp-hal-embassy Housekeeping: fix warnings, rename some examples, etc. (#1786) 2024-07-12 09:35:55 +00:00
esp-hal-procmacros Take 2 on #[ram] soundness (#1677) 2024-07-10 13:30:48 +00:00
esp-hal-smartled Update changelog CI (#1725) 2024-06-28 14:15:01 +00:00
esp-ieee802154 Fix new clippy lints introduced in 1.78 & 1.79 (#1776) 2024-07-09 13:23:19 +00:00
esp-lp-hal Add additional public functions to esp-lp-hal for Delay and UART, deny missing documentation (#1789) 2024-07-12 14:56:34 +00:00
esp-metadata Improve xtensa interrupt latency (#1735) 2024-07-03 15:43:01 +00:00
esp-println Housekeeping: fix warnings, rename some examples, etc. (#1786) 2024-07-12 09:35:55 +00:00
esp-riscv-rt Take 2 on #[ram] soundness (#1677) 2024-07-10 13:30:48 +00:00
esp-storage Update changelog CI (#1725) 2024-06-28 14:15:01 +00:00
esp-wifi Fix clippy warning in esp-wifi, remove Cargo patch and update semihosting dependency (#1778) 2024-07-09 09:50:09 -07:00
examples Remove unnecessary delay (#1794) 2024-07-15 13:09:47 +00:00
extras Add IEEE802.15.4 Wireshark Extcap (#1636) 2024-05-29 14:04:44 +00:00
hil-test support dma chunk sizes other than 4092 (#1758) 2024-07-15 12:00:33 +00:00
resources Update xtask to support generating documentation for multiple packages (#1653) 2024-06-04 15:27:41 +00:00
xtask Improve and use timer abstractions (#1753) 2024-07-09 15:59:38 +00:00
.gitattributes Set merge=union git attribute for CHANGELOG.md 2023-07-12 09:24:09 -07:00
.gitignore Tweak the documentation URL slightly (#1250) 2024-03-07 17:19:07 +00:00
API-GUIDELINES.md Update module documentation - Part 2 (#1777) 2024-07-12 09:48:45 +00:00
Cargo.toml Extract embassy support into esp-hal-embassy package (#1595) 2024-06-03 11:27:20 +00:00
CONTRIBUTING.md Update CONTRIBUTING.md (#1311) 2024-07-09 14:37:44 +02:00
LICENSE-APACHE Initial commit 2021-10-19 15:00:41 -07:00
LICENSE-MIT Initial commit 2021-10-19 15:00:41 -07:00
README.md Top-level README.md updates, change to path dependency for esp-backtrace in hil-test package (#1588) (#1591) 2024-05-24 09:33:18 +00:00
rustfmt.toml Begin adding some doc comments, update rustfmt config 2022-01-10 15:23:01 -08:00

esp-hal

GitHub Actions Workflow Status GitHub Actions Workflow Status MIT/Apache-2.0 licensed Matrix

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

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:

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.