esp-hal
An extremely experimental attempt at writing a HAL which targets the ESP32, ESP32-C3, ESP32-S2, and ESP32-S3.
If you are interested in no_std development for ESP devices, we encourage you to contribute whatever you can to this repository!
IMPORTANT:
These crates should not be used for anything other than experimentation at this point in time, this is merely a proof-of-concept.
The
esp32-halpackage in this repository is NOT the same as the one published on crates.io. The published crate can be found in the esp-rs/esp32-hal repository. Once feature parity has been reached, the hope is for the version in this repository to supersede the old one.The various packages in this repository may or may not build at any given time.
Until the first releases are published, there should be no expectation of API stability.
Please make sure you understand all the points above, and use these packages at your own risk. When the packages in this repository are ready for general use this README will be updated to indicate such.
For additional updates, please follow along in the esp-rs channel on Matrix.
What is working?
| Peripheral | ESP32 | ESP32-C3 | ESP32S2 | ESP32S3 |
|---|---|---|---|---|
| TIMG | ☑ | ☑ | ☑ | ☑ |
| UART | ☑ | ☑ | ☑ | ☑ |
| GPIO | ☑ | ☑ | - | - |
The DelayMs and DelayUs traits from embedded-hal have been implemented
- Uses the
SYSTIMERperipheral for the ESP32-C3, and the built in Xtensa timers for the other chips
What is NOT working?
Everything else.
Peripheral Access Crates
For the time being, the esp-hal-common package is using git dependencies pointing to a monorepo containing the various PACs. This is being done for two reasons:
- While the existing
esp32-halcrate exists, so mustesp32; however, updating theesp32crate to the newer SVD causes breaking changes - To enable rapid patching and prototyping without interfering with the mainline repositories
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.