Struct Button

pub struct Button { /* private fields */ }

Represents a simple push button or switch. Connect one side of the button to a ground pin, and the other to any GPIO pin. The GPIO pin will be pulled high by default. Alternatively, connect one side of the button to the 3V3 pin, and the other to any GPIO pin, and then create a Button instance with Button::new_with_pulldown

Implementations

impl Button

pub fn new(pin: u8) -> Button

Returns a Button with the pin number given and the pin pulled high with an internal resistor by default

• pin - The GPIO pin which the device is attached to

Examples found in repository

examples/button.rs (line 7)

fn main() {
    // Create a button which is attached to Pin 17
    let mut button = Button::new(17);
    button.wait_for_press(None);
    println!("button pressed");
}

pub fn new_with_pulldown(pin: u8) -> Button

Returns a Button with the pin number given and the pin pulled down with an internal resistor by default

• pin - The GPIO pin which the device is attached to

pub fn is_active(&self) -> bool

Returns True if the device is currently active and False otherwise.

pub fn close(self)

Shut down the device and release all associated resources.

pub fn pin(&self) -> u8

The Pin that the device is connected to.

pub fn value(&self) -> bool

Returns True if the device is currently active and False otherwise.

pub fn wait_for_release(&mut self, timeout: Option<f32>)

• timeout - Number of seconds to wait before proceeding. If this is None, then wait indefinitely until the device is inactive.

pub fn wait_for_press(&mut self, timeout: Option<f32>)

Pause the program until the device is activated, or the timeout is reached.

• timeout - Number of seconds to wait before proceeding. If this is None, then wait indefinitely until the device is active.

Examples found in repository

examples/button.rs (line 8)

fn main() {
    // Create a button which is attached to Pin 17
    let mut button = Button::new(17);
    button.wait_for_press(None);
    println!("button pressed");
}