Add more docs

This commit is contained in:
chemicstry
2022-10-24 22:48:40 +03:00
parent ac61e0ee9f
commit 52c03cf0a4
3 changed files with 9 additions and 0 deletions

View File

@ -3,6 +3,9 @@ use embassy_time::{Duration, Instant};
use super::{Error, I2c, Instance};
/// An I2C wrapper, which provides `embassy-time` based timeouts for all `embedded-hal` trait methods.
///
/// This is useful for recovering from a shorted bus or a device stuck in a clock stretching state.
/// A regular [I2c] would freeze until condition is removed.
pub struct TimeoutI2c<'d, T: Instance, TXDMA, RXDMA> {
i2c: &'d mut I2c<'d, T, TXDMA, RXDMA>,
timeout: Duration,