no_std Hardware Abstraction Layers for ESP32 microcontrollers
Go to file
Alex Vinyals d4ec063cec
esp-wifi(initialize): no longer requires maximum CPU clock (#1688)
This patch replaces a CPU clock check that enforced running the MCU
at maximum clock speed during WiFi radio initialization. The previous
was incompatible for low power settings.

Now, the check ensures the CPU runs with at *at least* 80MHz, which
is the minimum required clock speed for proper WiFi radio functionality.

For `esp32s3` MCUs, the call to `ets_update_cpu_frequency_rom` has been
moved to the `esp-hal` clocks module. This call is now only made when
configuring CPU to a non-default setting.
2024-06-25 07:42:11 +00:00
.cargo Add the xtask package, implement automation for building examples (#1157) 2024-02-12 15:38:19 +00:00
.github Fix: allow defmt-espflash + auto configuration @ esp-println (#1687) 2024-06-24 13:26:08 +00:00
esp-alloc esp-hal: Add runnable doctests to peripheral drivers (#1663) 2024-06-11 10:18:09 +00:00
esp-backtrace Prepare esp-backtrace@0.12.1 release (#1696) 2024-06-19 14:42:49 +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 esp-wifi(initialize): no longer requires maximum CPU clock (#1688) 2024-06-25 07:42:11 +00:00
esp-hal-embassy esp-hal-wifi: make executors optional (again) (#1683) 2024-06-17 10:23:31 +00:00
esp-hal-procmacros esp-hal: Add runnable doctests to peripheral drivers (#1663) 2024-06-11 10:18:09 +00:00
esp-hal-smartled New package releases (#1654) 2024-06-04 16:11:42 +00:00
esp-ieee802154 New package releases (#1654) 2024-06-04 16:11:42 +00:00
esp-lp-hal Add remaining GPIO pins for ESP32-S2/S3 ULP (#1695) 2024-06-19 15:17:48 +00:00
esp-metadata New package releases (#1654) 2024-06-04 16:11:42 +00:00
esp-println Fix: allow defmt-espflash + auto configuration @ esp-println (#1687) 2024-06-24 13:26:08 +00:00
esp-riscv-rt next release cycle 2024-04-18 16:51:30 +00:00
esp-storage Housekeeping (#1647) 2024-05-31 13:58:54 +00:00
esp-wifi esp-wifi(initialize): no longer requires maximum CPU clock (#1688) 2024-06-25 07:42:11 +00:00
examples Patch up LCD_CAM example (#1701) 2024-06-20 13:27:50 +00:00
extras Add IEEE802.15.4 Wireshark Extcap (#1636) 2024-05-29 14:04:44 +00:00
hil-test Additional move base dma api (#1672) 2024-06-19 13:17:22 +00:00
resources Update xtask to support generating documentation for multiple packages (#1653) 2024-06-04 15:27:41 +00:00
xtask esp-hal: Add runnable doctests to peripheral drivers (#1663) 2024-06-11 10:18:09 +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 Add API-GUIDELINES.md (#1543) 2024-05-21 16:36:36 +00:00
Cargo.toml Extract embassy support into esp-hal-embassy package (#1595) 2024-06-03 11:27:20 +00:00
CONTRIBUTING.md Add API-GUIDELINES.md (#1543) 2024-05-21 16:36:36 +00: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.