diff options
| -rw-r--r-- | embassy-embedded-hal/README.md | 12 | ||||
| -rw-r--r-- | embassy-embedded-hal/src/lib.rs | 3 |
2 files changed, 13 insertions, 2 deletions
diff --git a/embassy-embedded-hal/README.md b/embassy-embedded-hal/README.md new file mode 100644 index 000000000..69581c788 --- /dev/null +++ b/embassy-embedded-hal/README.md | |||
| @@ -0,0 +1,12 @@ | |||
| 1 | # embassy-embedded-hal | ||
| 2 | |||
| 3 | Collection of utilities to use `embedded-hal` and `embedded-storage` traits with Embassy. | ||
| 4 | |||
| 5 | - Shared SPI and I2C buses, both blocking and async, with a `SetConfig` trait allowing changing bus configuration (e.g. frequency) between devices on the same bus. | ||
| 6 | - Async utilities | ||
| 7 | - Adapters to convert from blocking to (fake) async. | ||
| 8 | - Adapters to insert yields on trait operations. | ||
| 9 | - Flash utilities | ||
| 10 | - Split a flash memory into smaller partitions. | ||
| 11 | - Concatenate flash memories together. | ||
| 12 | - Simulated in-memory flash. | ||
diff --git a/embassy-embedded-hal/src/lib.rs b/embassy-embedded-hal/src/lib.rs index ee974324b..99a2d93c7 100644 --- a/embassy-embedded-hal/src/lib.rs +++ b/embassy-embedded-hal/src/lib.rs | |||
| @@ -1,8 +1,7 @@ | |||
| 1 | #![cfg_attr(not(feature = "std"), no_std)] | 1 | #![cfg_attr(not(feature = "std"), no_std)] |
| 2 | #![allow(async_fn_in_trait)] | 2 | #![allow(async_fn_in_trait)] |
| 3 | #![warn(missing_docs)] | 3 | #![warn(missing_docs)] |
| 4 | 4 | #![doc = include_str!("../README.md")] | |
| 5 | //! Utilities to use `embedded-hal` traits with Embassy. | ||
| 6 | 5 | ||
| 7 | pub mod adapter; | 6 | pub mod adapter; |
| 8 | pub mod flash; | 7 | pub mod flash; |