Struct port_expander::Pin

pub struct Pin<'a, MODE, MUTEX> { /* private fields */ }

Representation of a port-expander pin.

Pin is not constructed directly, this type is created by instanciating a port-expander and then getting access to all its pins using the .split() method.

Implementations

impl<'a, MODE, MUTEX, PD> Pin<'a, MODE, MUTEX>

where PD: PortDriver, MUTEX: PortMutex<Port = PD>,

pub fn pin_mask(&self) -> u32

pub fn access_port_driver<F, R>(&self, f: F) -> R

where F: FnOnce(&mut PD) -> R,

impl<'a, MODE, MUTEX, PD> Pin<'a, MODE, MUTEX>

where PD: PortDriver + PortDriverTotemPole, MUTEX: PortMutex<Port = PD>,

pub fn into_input(self) -> Result<Pin<'a, Input, MUTEX>, PD::Error>

Configure this pin as an input.

The exact electrical details depend on the port-expander device which is used.

pub fn into_output(self) -> Result<Pin<'a, Output, MUTEX>, PD::Error>

Configure this pin as an output with an initial LOW state.

The LOW state is, as long as he port-expander chip allows this, entered without any electrical glitch.

pub fn into_output_high(self) -> Result<Pin<'a, Output, MUTEX>, PD::Error>

Configure this pin as an output with an initial HIGH state.

The HIGH state is, as long as he port-expander chip allows this, entered without any electrical glitch.

impl<'a, MODE, MUTEX, PD> Pin<'a, MODE, MUTEX>

where PD: PortDriver + PortDriverPolarity, MUTEX: PortMutex<Port = PD>,

pub fn into_inverted(self) -> Result<Self, PD::Error>

Turn on hardware polarity inversion for this pin.

pub fn set_inverted(&mut self, inverted: bool) -> Result<(), PD::Error>

Set hardware polarity inversion for this pin.

impl<'a, MODE: HasInput, MUTEX, PD> Pin<'a, MODE, MUTEX>

where PD: PortDriver, MUTEX: PortMutex<Port = PD>,

pub fn is_high(&self) -> Result<bool, PD::Error>

Read the pin’s input state and return true if it is HIGH.

pub fn is_low(&self) -> Result<bool, PD::Error>

Read the pin’s input state and return true if it is LOW.

impl<'a, MODE: HasInput, MUTEX, PD> Pin<'a, MODE, MUTEX>

where PD: PortDriver + PortDriverPullUp, MUTEX: PortMutex<Port = PD>,

pub fn enable_pull_up(&mut self, enable: bool) -> Result<(), PD::Error>

Enable/Disable pull-up resistors for this pin.

If enable is true, the pull-up resistor is enabled, otherwise the pin is configured as floating input.

impl<'a, MODE: HasInput, MUTEX, PD> Pin<'a, MODE, MUTEX>

where PD: PortDriver + PortDriverPullDown, MUTEX: PortMutex<Port = PD>,

pub fn enable_pull_down(&mut self, enable: bool) -> Result<(), PD::Error>

Enable/Disable pull-down resistors for this pin.

If enable is true, the pull-down resistor is enabled, otherwise the pin is configured as floating input.

impl<'a, MODE: HasOutput, MUTEX, PD> Pin<'a, MODE, MUTEX>

where PD: PortDriver, MUTEX: PortMutex<Port = PD>,

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

Set the pin’s output state to HIGH.

Note that this can have different electrical meanings depending on the port-expander chip.

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

Set the pin’s output state to LOW.

Note that this can have different electrical meanings depending on the port-expander chip.

pub fn is_set_high(&self) -> Result<bool, PD::Error>

Return true if the pin’s output state is HIGH.

This method does not read the pin’s electrical state.

pub fn is_set_low(&self) -> Result<bool, PD::Error>

Return true if the pin’s output state is LOW.

This method does not read the pin’s electrical state.

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

Toggle the pin’s output state.

Trait Implementations

impl<'a, MODE, MUTEX, PD> ErrorType for Pin<'a, MODE, MUTEX>

where PD: PortDriver + PortDriverTotemPole, PD::Error: Error, MUTEX: PortMutex<Port = PD>,

type Error = <PD as PortDriver>::Error

Error type

impl<'a, MODE: HasInput, MUTEX, PD> InputPin for Pin<'a, MODE, MUTEX>

where PD: PortDriver + PortDriverTotemPole, <PD as PortDriver>::Error: Error, MUTEX: PortMutex<Port = PD>,

fn is_high(&mut self) -> Result<bool, <PD as PortDriver>::Error>

Is the input pin high?

fn is_low(&mut self) -> Result<bool, <PD as PortDriver>::Error>

Is the input pin low?

impl<'a, MODE: HasOutput, MUTEX, PD> OutputPin for Pin<'a, MODE, MUTEX>

where PD: PortDriver + PortDriverTotemPole, <PD as PortDriver>::Error: Error, MUTEX: PortMutex<Port = PD>,

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<(), Self::Error>

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

impl<'a, MODE: HasOutput, MUTEX, PD> StatefulOutputPin for Pin<'a, MODE, MUTEX>

where PD: PortDriver + PortDriverTotemPole, <PD as PortDriver>::Error: Error, MUTEX: PortMutex<Port = PD>,

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.