Struct Knob 

pub struct Knob<I2C> { /* private fields */ }

Driver for the Modulino Knob module (rotary encoder).

Example

use modulino::Knob;

let mut knob = Knob::new(i2c)?;

// Set a range for the encoder value
knob.set_range(-100, 100);

loop {
    knob.update()?;
     
    if knob.pressed() {
        println!("Button pressed!");
    }
     
    println!("Value: {}", knob.value());
}

Implementations

impl<I2C, E> Knob<I2C>

where I2C: I2c<Error = E>,

pub fn new(i2c: I2C) -> Result<Self, E>

Create a new Knob instance with the default address.

pub fn new_with_address(i2c: I2C, address: u8) -> Result<Self, E>

Create a new Knob instance with a custom address.

pub fn address(&self) -> u8

Get the I2C address.

pub fn update(&mut self) -> Result<bool, E>

Update the encoder state.

This should be called periodically to read the latest values. Returns true if the state has changed.

pub fn value(&self) -> i16

Get the current encoder value.

pub fn set_value(&mut self, value: i16) -> Result<(), E>

Set the encoder value.

pub fn reset(&mut self) -> Result<(), E>

Reset the encoder value to 0.

pub fn pressed(&self) -> bool

Check if the button is currently pressed.

pub fn set_range(&mut self, min: i16, max: i16)

Set the value range for the encoder.

The encoder value will be constrained to this range. Pass None to remove the range constraint.

pub fn clear_range(&mut self)

Clear the range constraint.

pub fn range(&self) -> Option<(i16, i16)>

Get the current range, if set.

pub fn rotation_delta(&self, previous_value: i16) -> i16

Get the rotation direction since the last update.

Returns:

• Positive value for clockwise rotation
• Negative value for counter-clockwise rotation
• 0 for no rotation

pub fn release(self) -> I2C

Release the I2C bus.