Struct InputPin

pub struct InputPin(/* private fields */);

Provides embedded_hal::digital traits for a gpiocdev::Request containing a single input pin.

Holding the InputPin grants exclusive access to the pin.

Do NOT drop the InputPin until you are completely done with it. Dropping and re-requesting the line is far more expensive than getting the value.

Implementations

impl InputPin

pub fn new<P>(chip: P, offset: u32) -> Result<Self, Error>

where P: AsRef<Path>,

Creates a new input pin for the given offset on the given chip.

use embedded_hal::digital::InputPin;

let mut pin = gpiocdev_embedded_hal::InputPin::new("/dev/gpiochip0", 4)?;
if pin.is_high()? {
    println!("Input is high.");
}

pub fn into_output_pin(self, state: PinState) -> Result<OutputPin, Error>

Set this pin to output mode.

pub fn from_found_line(fl: FoundLine) -> Result<Self, Error>

Create an InputPin from a gpiocdev::FoundLine.

Examples

use embedded_hal::digital::InputPin;

let sensor0 = gpiocdev::find_named_line("SENSOR0").unwrap();
let mut pin = gpiocdev_embedded_hal::InputPin::from_found_line(sensor0)?;
if pin.is_low()? {
    println!("Input is low.");
}

pub fn from_name(name: &str) -> Result<Self, Error>

Create an InputPin given a line name.

Examples

use embedded_hal::digital::InputPin;

let mut gpio22 = gpiocdev_embedded_hal::InputPin::from_name("GPIO22")?;
if gpio22.is_low()? {
    println!("Input is low.");
}

Trait Implementations

impl Debug for InputPin

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl ErrorType for InputPin

type Error = Error

Errors returned by InputPin.

impl From<InputPin> for InputPin

fn from(pin: InputPin) -> Self

Convert a synchronous InputPin into a tokio InputPin.

impl From<InputPin> for InputPin

fn from(pin: InputPin) -> Self

Convert a tokio InputPin into a synchronous InputPin.

impl From<InputPin> for InputPin

fn from(pin: InputPin) -> Self

Convert a synchronous InputPin into an async_io InputPin.

impl From<InputPin> for InputPin

fn from(pin: InputPin) -> Self

Convert an async_io InputPin into a synchronous InputPin.

impl From<InputPin> for Request

fn from(pin: InputPin) -> Self

Convert the InputPin into the contained Request.

impl InputPin for InputPin

fn is_high(&mut self) -> Result<bool, Self::Error>

Is the input pin high?

fn is_low(&mut self) -> Result<bool, Self::Error>

Is the input pin low?

impl TryFrom<Request> for InputPin

fn try_from(req: Request) -> Result<Self, Self::Error>

Convert any single input line gpiocdev::Request into a InputPin.

This allows for advanced configurations such as setting bias or using the active_low flag to flip the line polarity. InputPin::new<P>() should be used for less complex configurations.

type Error = Error

The type returned in the event of a conversion error.