embedded-hal

A Hardware Abstraction Layer (HAL) for embedded systems

This project is developed and maintained by the HAL team.

Important

📣 embedded-hal v1.0 is now released! Check out the announcement blog post, the API documentation and the migration guide.

Scope

embedded-hal serves as a foundation for building an ecosystem of platform-agnostic drivers. (driver meaning library crates that let a target platform interface an external device like a digital sensor or a wireless transceiver).

The advantage of this system is that by writing the driver as a generic library on top of embedded-hal driver authors can support any number of target platforms (e.g. Cortex-M microcontrollers, AVR microcontrollers, embedded Linux, etc.).

The advantage for application developers is that by adopting embedded-hal they can unlock all these drivers for their platform.

For functionality that goes beyond what is provided by embedded-hal, users are encouraged to use the target platform directly. Abstractions of common functionality can be proposed to be included into embedded-hal as described in this guide, though.

See more about the design goals in this documentation section.

Crates

The main embedded-hal project is not tied to a specific execution model like blocking or non-blocking.

Crate	crates.io	Docs
embedded-hal			Core traits, blocking version
embedded-hal-async			Core traits, async version
embedded-hal-nb			Core traits, polling version using the nb crate
embedded-hal-bus			Utilities for sharing SPI and I2C buses
embedded-can			Controller Area Network (CAN) traits
embedded-io			I/O traits (read, write, seek, etc.), blocking and nonblocking version.
embedded-io-async			I/O traits, async version
embedded-io-adapters			Adapters between the embedded-io and embedded-io-async traits and other IO traits (std, tokio, futures...)

Documents

• Migrating from v0.2 to v1.0.
• How-to: add a new trait
• MSRV

Implementations and drivers

For a non-exhaustive list of embedded-hal implementations and driver crates check the awesome-embedded-rust list.

You may be able to find even more HAL implementation crates and driver crates by searching for the embedded-hal-impl, embedded-hal-driver and embedded-hal keywords on crates.io.

Minimum Supported Rust Version (MSRV)

This crate is guaranteed to compile on stable Rust 1.60 and up. It might compile with older versions but that may change in any new patch release.

See here for details on how the MSRV may be upgraded.

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.

Code of Conduct

Contribution to this repository is organized under the terms of the Rust Code of Conduct, the maintainers of this repository, the HAL team, promise to intervene to uphold that code of conduct.