Struct rotary_encoder_embedded::RotaryEncoder

pub struct RotaryEncoder<MODE, DT, CLK> { /* private fields */ }

Rotary Encoder

Implementations

impl<DT, CLK> RotaryEncoder<AngularVelocityMode, DT, CLK>

where DT: InputPin, CLK: InputPin,

pub fn set_velocity_inc_factor(&mut self, inc_factor: f32)

Set the velocity_inc_factor. How quickly the velocity increases to 1.0.

pub fn set_velocity_dec_factor(&mut self, dec_factor: f32)

Set the velocity_dec_factor. How quickly the velocity decreases or cools-down

pub fn set_velocity_action_ms(&mut self, action_ms: u64)

Set the velocity_action_ms. The window of duration (milliseconds) that the velocity will increase

pub fn decay_velocity(&mut self)

This function should be called periodically, either via a timer or the main loop. This function will reduce the angular velocity over time, the amount is configurable via the constructor

pub fn update(&mut self, current_time_millis: u64) -> Direction

Update the state machine of the RotaryEncoder. This should be called ideally from an interrupt vector when either the DT or CLK pins state changes. This function will update the RotaryEncoder’s Direction and current Angular Velocity.

• current_time - Current timestamp in ms (strictly monotonously increasing)

pub fn velocity(&self) -> Velocity

Returns the current angular velocity of the RotaryEncoder The Angular Velocity is a value between 0.0 and 1.0 This is useful for incrementing/decrementing a value in an exponential fashion

impl<DT, CLK, MODE> RotaryEncoder<MODE, DT, CLK>

where DT: InputPin, CLK: InputPin,

pub fn into_angular_velocity_mode( self ) -> RotaryEncoder<AngularVelocityMode, DT, CLK>

Configure RotaryEncoder to use the AngularVelocityMode API

impl<DT, CLK> RotaryEncoder<StandardMode, DT, CLK>

where DT: InputPin, CLK: InputPin,

pub fn update(&mut self) -> Direction

Updates the RotaryEncoder, updating the direction property

impl<LOGIC, DT, CLK> RotaryEncoder<LOGIC, DT, CLK>

where DT: InputPin, CLK: InputPin,

pub fn into_standard_mode(self) -> RotaryEncoder<StandardMode, DT, CLK>

Configure RotaryEncoder to use the standard API

impl<MODE, DT, CLK> RotaryEncoder<MODE, DT, CLK>

where DT: InputPin, CLK: InputPin,

Common

pub fn pins_mut(&mut self) -> (&mut DT, &mut CLK)

Borrow a mutable reference to the underlying InputPins. This is useful for clearing hardware interrupts.

pub fn release(self) -> (DT, CLK)

Release the underying resources such as the InputPins back to the initiator

pub fn mode(&mut self) -> &mut MODE

Borrow the underlying mode

impl<DT, CLK> RotaryEncoder<InitalizeMode, DT, CLK>

where DT: InputPin, CLK: InputPin,

pub fn new(pin_dt: DT, pin_clk: CLK) -> Self

Initiates a new RotaryEncoder in InitalizeMode, taking two InputPins InputPin.