Skip to content

Commit

Permalink
docs: update docs for InterruptPinLatching
Browse files Browse the repository at this point in the history
KXCJ9 interrupt should be cleared using clear_interrupts()
regardless of latch configuration.

Signed-off-by: Sergey Matyukevich <geomatsi@gmail.com>
  • Loading branch information
geomatsi authored and eldruin committed Jul 2, 2019
1 parent 27c771b commit 66cc5f0
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions src/types.rs
Original file line number Diff line number Diff line change
Expand Up @@ -218,8 +218,9 @@ pub enum InterruptPinPolarity {
/// Physical interrupt pin latching behavior
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum InterruptPinLatching {
/// Interrupt pin will transmit a single pulse with a period
/// of `0.03ms - 0.05ms` when triggered.
/// Interrupt pin will transmit a single pulse with a period of `0.03ms - 0.05ms`
/// when triggered, but only once. No further pulses will be transmitted until
/// cleared with `clear_interrupts()`.
NonLatching,
/// Interrupt pin stays active until cleared with `clear_interrupts()`. (default)
Latching,
Expand Down

0 comments on commit 66cc5f0

Please sign in to comment.