Skip to content

Commit 13aa203

Browse files
committed
List creates in embedded-hal rustdocs.
1 parent b268c27 commit 13aa203

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

embedded-hal/src/lib.rs

+15
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,21 @@
77
//! **NOTE** If you want to use an alpha release of the 1.0.0 version, use an exact version
88
//! specifier in your `Cargo.toml` like: `embedded-hal = "=1.0.0-alpha.2"`.
99
//!
10+
//! # Companion crates
11+
//!
12+
//! The main `embedded-hal` crate contains only blocking traits, where the operation is done
13+
//! synchronously before returning. Check out the following crates, which contain versions
14+
//! of the traits for other execution models:
15+
//!
16+
//! - [`embedded-hal-async`](https://docs.rs/embedded-hal-async): async/await-based.
17+
//! - [`embedded-hal-nb`](https://docs.rs/embedded-hal-nb): polling-based, using the `nb` crate.
18+
//!
19+
//! The [`embedded-hal-bus`](https://docs.rs/embedded-hal-bus) crate provides utilities for sharing
20+
//! SPI and I2C buses.
21+
//!
22+
//! Additionally, more domain-specific traits are available in separate crates:
23+
//! - [`embedded-can`](https://docs.rs/embedded-can): Controller Area Network (CAN)
24+
//!
1025
//! # Design goals
1126
//!
1227
//! The HAL

0 commit comments

Comments
 (0)