max/embassy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
xoviat 2021-03-14 17:41:59 -05:00
parent 6cebd27cc1
commit a4bee1c1d2
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
embassy-traits/src/qei.rs
View File

@ -6,6 +6,14 @@ use embedded_hal::Direction;
pub trait WaitForRotate { pub trait WaitForRotate {
type RotateFuture<'a>: Future<Output = Direction> + 'a; type RotateFuture<'a>: Future<Output = Direction> + 'a;
/// Wait for a specified number of rotations, in ticks, either up or down.
///
/// Return Direction::Upcounting if the high bound is reached.
/// Return Direction::Downcounting if the low bound is reached.
///
/// Number of ticks is encoder dependent. As an example, if we connect
/// the Bourns PEC11H-4120F-S0020, we have 20 ticks per full rotation.
/// Other encoders may vary.
fn wait_for_rotate<'a>( fn wait_for_rotate<'a>(
self: Pin<&'a mut Self>, self: Pin<&'a mut Self>,
count_down: u16, count_down: u16,