Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added description of table-decode feature to readme #25

Merged
merged 1 commit into from
Apr 14, 2024
+13 −2
Merged

added description of table-decode feature to readme #25

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions README.md
View file
Open in desktop
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.
Loading