Struct Pin

pub struct Pin {
    pub port: Port,
    pub pin: u8,
}

Represents a single GPIO pin. Allows configuration, and reading/setting state.

Fields

port: Port

The GPIO Port letter. Eg A, B, C.

pin: u8

The pin number: 1 - 15.

Implementations

impl Pin

pub fn new(port: Port, pin: u8, mode: PinMode) -> Self

Create a new pin, with a specific mode. Enables the RCC peripheral clock to the port, if not already enabled. Example: let pa1 = Pin::new(Port::A, 1, PinMode::Output); Leaves settings other than mode and alternate function (if applicable) at their hardware defaults.

pub fn mode(&mut self, value: PinMode)

Set pin mode. Eg, Output, Input, Analog, or Alt. Sets the MODER register.

pub fn output_type(&mut self, value: OutputType)

Set output type. Sets the OTYPER register.

pub fn output_speed(&mut self, value: OutputSpeed)

Set output speed to Low, Medium, or High. Sets the OSPEEDR register.

pub fn pull(&mut self, value: Pull)

Set internal pull resistor: Pull up, pull down, or floating. Sets the PUPDR register.

pub fn cfg_lock(&mut self, value: CfgLock)

Lock or unlock a port configuration. Sets the LCKR register.

pub fn get_state(&mut self) -> PinState

Read the input data register. Eg determine if the pin is high or low. See also is_high() and is_low(). Reads from the IDR register.

pub fn set_state(&mut self, value: PinState)

Set a pin state (ie set high or low output voltage level). See also set_high() and set_low(). Sets the BSRR register. Atomic.

pub fn enable_interrupt(&mut self, edge: Edge)

Configure this pin as an interrupt source. Set the edge as Rising or Falling.

pub fn is_high(&self) -> bool

Check if the pin’s input voltage is high. Reads from the IDR register.

pub fn is_low(&self) -> bool

Check if the pin’s input voltage is low. Reads from the IDR register.

pub fn set_high(&mut self)

Set the pin’s output voltage to high. Sets the BSRR register. Atomic.

pub fn set_low(&mut self)

Set the pin’s output voltage to low. Sets the BSRR register. Atomic.

pub fn toggle(&mut self)

Toggle output voltage between low and high. Sets the BSRR register. Atomic.

Trait Implementations

impl Clone for Pin

fn clone(&self) -> Pin

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ErrorType for Pin

type Error = Infallible

Error type

impl InputPin for Pin

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 OutputPin for Pin

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 StatefulOutputPin for Pin

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.