[−][src]Struct rust_gpiozero::input_devices::Button
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
Methods
impl Button
[src]
pub fn new(pin: u8) -> Button
[src]
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
pub fn new_with_pulldown(pin: u8) -> Button
[src]
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
[src]
Returns True
if the device is currently active and False
otherwise.
pub fn close(self)
[src]
Shut down the device and release all associated resources.
pub fn pin(&self) -> u8
[src]
The Pin
that the device is connected to.
pub fn value(&self) -> bool
[src]
Returns True
if the device is currently active and False
otherwise.
pub fn wait_for_release(&mut self, timeout: Option<f32>)
[src]
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>)
[src]
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.
Auto Trait Implementations
Blanket Implementations
impl<T> From for T
[src]
impl<T, U> Into for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = !
try_from
)The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T> Borrow for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> BorrowMut for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T, U> TryInto for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,