Hardware Abstraction Layer crates for the ESP32, ESP32-C2/C3/C6, ESP32-H2, ESP32-P4, and ESP32-S2/S3 from Espressif. Additionally provides support for programming the low-power RISC-V cores found on the ESP32-C6 and ESP32-S2/S3.

These HALs are no_std; if you are looking for std support, please use esp-idf-hal 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.

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 on docs.rs for the relevant chip.

• The Rust Programming Language
• The Embedded Rust Book
• The Embedonomicon
• The Rust on ESP Book
• Embedded Rust (no_std) on Espressif

Crate	Documentation	Technical Reference Manual	Target	MSRV
esp32-hal		ESP32	xtensa-esp32-none-elf
esp32c2-hal		ESP32-C2	riscv32imc-unknown-none-elf
esp32c3-hal		ESP32-C3	riscv32imc-unknown-none-elf
esp32c6-hal		ESP32-C6	riscv32imac-unknown-none-elf
esp32h2-hal		ESP32-H2	riscv32imac-unknown-none-elf
esp32p4-hal		ESP32-P4	riscv32imafc-unknown-none-elf
esp32s2-hal		ESP32-S2	xtensa-esp32s2-none-elf
esp32s3-hal		ESP32-S3	xtensa-esp32s3-none-elf

There are a number of other crates within the esp-rs organization which can be used in conjunction with esp-hal:

We provide a simple pre-commit hook to verify the formatting of each package prior to committing changes. We strongly encourage use of this git hook.

The hook can be enabled by copying it in to the .git/hooks/ directory:

cp pre-commit .git/hooks/pre-commit

When using this hook, you can choose to ignore its failure on a per-commit basis by committing with the --no-verify flag; however, you will need to be sure that all packages are formatted when submitting a pull request.

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.

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.