Skip to content

Commit

Permalink
added description of table-decode feature to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
BartMassey committed Apr 14, 2024
1 parent 6a21b2f commit c9de10f
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,19 @@

A simple, platform agnostic rotary encoder library.

An alternate decoder algorithm that is more tolerant of
noise is enabled by the Cargo feature `table-encoder`. It
follows the discussion of noisy decoding
[here](https://www.best-microcontroller-projects.com/rotary-encoder.html).


You can call `update` from an ISR. You may get many spurious
interrupts from switch bounce, though the algorithm handles
them appropriately. When polling `update`, a poll time of
about 1 ms seems to work well.

## Examples

```rust
#![no_std]
#![no_main]
Expand Down Expand Up @@ -53,5 +66,3 @@ fn main() -> ! {
}
}
```

Alternatively, you can call `update` from an ISR.

0 comments on commit c9de10f

Please sign in to comment.