Struct OutputPin

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

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

Holding the OutputPin grants exclusive access to the pin.

Do NOT drop the OutputPin until you are completely done with it. While you hold the OutputPin the line is guaranteed to remain as set, but when dropped it may be altered, either by other users or by the kernel itself. Dropping and re-requesting the line is also far more expensive than setting the value.

Implementations

impl OutputPin

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

where P: AsRef<Path>,

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

use embedded_hal::digital::{OutputPin, PinState};

let mut pin = gpiocdev_embedded_hal::OutputPin::new("/dev/gpiochip0", 17, PinState::Low)?;
// later...
pin.set_high()?;

pub fn into_input_pin(self) -> Result<InputPin, Error>

Set this pin to input mode.

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

Create an OutputPin from a gpiocdev::FoundLine.

Examples

use embedded_hal::digital::{OutputPin, PinState};

let led0 = gpiocdev::find_named_line("LED0").unwrap();
let mut pin = gpiocdev_embedded_hal::OutputPin::from_found_line(led0, PinState::High)?;
// ...
pin.set_low()?;

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

Create an OutputPin given a line name.

Examples

use embedded_hal::digital::{OutputPin, PinState};

let mut led0 = gpiocdev_embedded_hal::OutputPin::from_name("LED0", PinState::High)?;
// ...
led0.set_low()?;

Trait Implementations

impl Debug for OutputPin

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

Formats the value using the given formatter.

impl ErrorType for OutputPin

type Error = Error

Errors returned by OutputPin.

impl From<OutputPin> for Request

fn from(pin: OutputPin) -> Self

Convert the OutputPin into the contained Request.

impl InputPin for OutputPin

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

Is the line high?

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

Is the line low?

impl OutputPin for OutputPin

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

Drives the pin low.

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

Drives the pin high.

fn set_state(&mut self, state: PinState) -> Result<(), Error>

Drives the pin high or low depending on the provided value.

impl StatefulOutputPin for OutputPin

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

Is the pin in drive high mode?

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

Is the pin in drive low mode?

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

Toggle pin output.

impl TryFrom<Request> for OutputPin

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

Convert any single output line gpiocdev::Request into an OutputPin.

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

type Error = Error

The type returned in the event of a conversion error.