Struct rust_gpiozero::input_devices::DigitalInputDevice [−][src]
pub struct DigitalInputDevice { /* fields omitted */ }
Represents a generic input device with typical on/off behaviour. Adds machinery to fire the active and inactive events for devices that operate in a typical digital manner: straight forward on / off states with (reasonably) clean transitions between the two.
Implementations
impl DigitalInputDevice
[src]
impl DigitalInputDevice
[src]pub fn new(pin: u8) -> DigitalInputDevice
[src]
pub fn new(pin: u8) -> DigitalInputDevice
[src]Returns a DigitalInputDevice with the pin number given with the pin pulled to low by default
is_active
property is adjusted accordingly so that
True
still means active regardless of the :attr:pull_up
setting
Arguments
pin
- The GPIO pin which the device is attached to
Note: BCM pins 2 and 3 are i2c SDA and SCL respectively and include a fixed, 1.8 kohms pull-up to 3.3v
These pins are not suitable for use where no pullup resistor is required Source: https://pinout.xyz/pinout/pin5_gpio3
pub fn new_with_pullup(pin: u8) -> DigitalInputDevice
[src]
pub fn new_with_pullup(pin: u8) -> DigitalInputDevice
[src]Returns a DigitalInputDevice with the pin number given with the pin pulled high with an internal resistor by default
is_active
property is adjusted accordingly so that
True
still means active regardless of the :attr:pull_up
setting
Arguments
pin
- The GPIO pin which the device is attached to
pub fn is_active(&self) -> bool
[src]
pub fn is_active(&self) -> bool
[src]Returns True
if the device is currently active and False
otherwise.
pub fn wait_for_inactive(&mut self, timeout: Option<f32>)
[src]
pub fn wait_for_inactive(&mut self, timeout: Option<f32>)
[src]Pause the program until the device is deactivated, or the timeout is reached.
pub fn wait_for_active(&mut self, timeout: Option<f32>)
[src]
pub fn wait_for_active(&mut self, timeout: Option<f32>)
[src]Pause the program until the device is activated, or the timeout is reached.