Merge pull request #2438 from embassy-rs/eeh-docs

embassy-embedded-hal: add README.
This commit is contained in:
Dario Nieuwenhuis 2024-01-11 20:10:17 +00:00 committed by GitHub
commit 0d62e9c96c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 2 deletions

View File

@ -0,0 +1,12 @@
# embassy-embedded-hal
Collection of utilities to use `embedded-hal` and `embedded-storage` traits with Embassy.
- 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.
- Async utilities
- Adapters to convert from blocking to (fake) async.
- Adapters to insert yields on trait operations.
- Flash utilities
- Split a flash memory into smaller partitions.
- Concatenate flash memories together.
- Simulated in-memory flash.

View File

@ -1,8 +1,7 @@
#![cfg_attr(not(feature = "std"), no_std)] #![cfg_attr(not(feature = "std"), no_std)]
#![allow(async_fn_in_trait)] #![allow(async_fn_in_trait)]
#![warn(missing_docs)] #![warn(missing_docs)]
#![doc = include_str!("../README.md")]
//! Utilities to use `embedded-hal` traits with Embassy.
pub mod adapter; pub mod adapter;
pub mod flash; pub mod flash;