Struct Joystick 

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

Driver for the Modulino Joystick module.

The joystick reports X and Y values in the range -128 to 127, where (0, 0) is the center position.

Example

use modulino::Joystick;

let mut joystick = Joystick::new(i2c)?;

loop {
    joystick.update()?;
     
    let x = joystick.x();
    let y = joystick.y();
     
    if joystick.button_pressed() {
        println!("Button pressed at position ({}, {})", x, y);
    }
}

Implementations

impl<I2C, E> Joystick<I2C>

where I2C: I2c<Error = E>,

pub const DEFAULT_DEADZONE: u8 = 10

Default deadzone threshold.

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

Create a new Joystick instance with the default address.

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

Create a new Joystick instance with a custom address.

pub fn address(&self) -> u8

Get the I2C address.

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

Update the joystick state.

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

pub fn x(&self) -> i8

Get the X-axis value (-128 to 127).

pub fn y(&self) -> i8

Get the Y-axis value (-128 to 127).

pub fn position(&self) -> (i8, i8)

Get both axis values as a tuple.

pub fn button_pressed(&self) -> bool

Check if the button is pressed.

pub fn deadzone(&self) -> u8

Get the deadzone threshold.

pub fn set_deadzone(&mut self, deadzone: u8)

Set the deadzone threshold.

Values within this distance from center (0, 0) will be reported as 0.

pub fn is_centered(&self) -> bool

Check if the joystick is in the center position (within deadzone).

pub fn magnitude(&self) -> f32

Get the magnitude of joystick displacement from center.

pub fn angle(&self) -> f32

Get the angle of joystick displacement in radians.

Returns 0 when centered. Angle is measured counter-clockwise from the positive X-axis.

pub fn release(self) -> I2C

Release the I2C bus.