Struct stm32f1xx_hal::gpio::Pin

pub struct Pin<const P: char, const N: u8, MODE = Input<Floating>> { /* private fields */ }

Generic pin type

• P is port name: A for GPIOA, B for GPIOB, etc.
• N is pin number: from 0 to 15.
• MODE is one of the pin modes (see Modes section).

Implementations

impl<const N: u8, MODE> Pin<'A', N, MODE>where
    MODE: Active,

pub fn erase(self) -> ErasedPin<MODE>

Erases the pin number and port from the type

This is useful when you want to collect the pins into an array where you need all the elements to have the same type

impl<const N: u8, MODE> Pin<'B', N, MODE>where
    MODE: Active,

pub fn erase(self) -> ErasedPin<MODE>

Erases the pin number and port from the type

This is useful when you want to collect the pins into an array where you need all the elements to have the same type

impl<const N: u8, MODE> Pin<'C', N, MODE>where
    MODE: Active,

pub fn erase(self) -> ErasedPin<MODE>

Erases the pin number and port from the type

This is useful when you want to collect the pins into an array where you need all the elements to have the same type

impl<const N: u8, MODE> Pin<'D', N, MODE>where
    MODE: Active,

pub fn erase(self) -> ErasedPin<MODE>

Erases the pin number and port from the type

This is useful when you want to collect the pins into an array where you need all the elements to have the same type

impl<const N: u8, MODE> Pin<'E', N, MODE>where
    MODE: Active,

pub fn erase(self) -> ErasedPin<MODE>

Erases the pin number and port from the type

This is useful when you want to collect the pins into an array where you need all the elements to have the same type

impl<const N: u8, MODE> Pin<'F', N, MODE>where
    MODE: Active,

pub fn erase(self) -> ErasedPin<MODE>

Erases the pin number and port from the type

This is useful when you want to collect the pins into an array where you need all the elements to have the same type

impl<const N: u8, MODE> Pin<'G', N, MODE>where
    MODE: Active,

pub fn erase(self) -> ErasedPin<MODE>

Erases the pin number and port from the type

This is useful when you want to collect the pins into an array where you need all the elements to have the same type

impl<const P: char, const N: u8, MODE> Pin<P, N, MODE>where
    MODE: Active,

pub fn erase_number(self) -> PartiallyErasedPin<P, MODE>

Erases the pin number from the type

impl<const P: char, const N: u8, MODE> Pin<P, N, Output<MODE>>

pub fn set_high(&mut self)

pub fn set_low(&mut self)

pub fn get_state(&self) -> PinState

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

pub fn is_set_high(&self) -> bool

pub fn is_set_low(&self) -> bool

pub fn toggle(&mut self)

impl<const P: char, const N: u8, MODE> Pin<P, N, Input<MODE>>

pub fn is_high(&self) -> bool

pub fn is_low(&self) -> bool

impl<const P: char, const N: u8> Pin<P, N, Output<OpenDrain>>

pub fn is_high(&self) -> bool

pub fn is_low(&self) -> bool

impl<const P: char, const N: u8, MODE> Pin<P, N, MODE>where
    MODE: Active,
    Self: HL,

pub fn into_alternate_push_pull(
    self,
    cr: &mut <Self as HL>::Cr
) -> Pin<P, N, Alternate<PushPull>>

Configures the pin to operate as an alternate function push-pull output pin.

pub fn into_alternate_open_drain(
    self,
    cr: &mut <Self as HL>::Cr
) -> Pin<P, N, Alternate<OpenDrain>>

Configures the pin to operate as an alternate function open-drain output pin.

pub fn into_floating_input(
    self,
    cr: &mut <Self as HL>::Cr
) -> Pin<P, N, Input<Floating>>

Configures the pin to operate as a floating input pin

pub fn into_pull_down_input(
    self,
    cr: &mut <Self as HL>::Cr
) -> Pin<P, N, Input<PullDown>>

Configures the pin to operate as a pulled down input pin

pub fn into_pull_up_input(
    self,
    cr: &mut <Self as HL>::Cr
) -> Pin<P, N, Input<PullUp>>

Configures the pin to operate as a pulled up input pin

pub fn into_open_drain_output(
    self,
    cr: &mut <Self as HL>::Cr
) -> Pin<P, N, Output<OpenDrain>>

Configures the pin to operate as an open-drain output pin. Initial state will be low.

pub fn into_open_drain_output_with_state(
    self,
    cr: &mut <Self as HL>::Cr,
    initial_state: PinState
) -> Pin<P, N, Output<OpenDrain>>

Configures the pin to operate as an open-drain output pin. initial_state specifies whether the pin should be initially high or low.

pub fn into_push_pull_output(
    self,
    cr: &mut <Self as HL>::Cr
) -> Pin<P, N, Output<PushPull>>

Configures the pin to operate as an push-pull output pin. Initial state will be low.

pub fn into_push_pull_output_with_state(
    self,
    cr: &mut <Self as HL>::Cr,
    initial_state: PinState
) -> Pin<P, N, Output<PushPull>>

Configures the pin to operate as an push-pull output pin. initial_state specifies whether the pin should be initially high or low.

pub fn into_analog(self, cr: &mut <Self as HL>::Cr) -> Pin<P, N, Analog>

Configures the pin to operate as an analog input pin

pub fn into_dynamic(self, cr: &mut <Self as HL>::Cr) -> Pin<P, N, Dynamic>

Configures the pin as a pin that can change between input and output without changing the type. It starts out as a floating input

impl<const P: char, const N: u8, MODE> Pin<P, N, MODE>where
    MODE: Active + PinMode,
    Self: HL,

pub fn as_push_pull_output(
    &mut self,
    cr: &mut <Self as HL>::Cr,
    f: impl FnMut(&mut Pin<P, N, Output<PushPull>>)
)

Temporarily change the mode of the pin.

The value of the pin after conversion is undefined. If you want to control it, use $stateful_fn_name

pub fn as_push_pull_output_with_state(
    &mut self,
    cr: &mut <Self as HL>::Cr,
    state: PinState,
    f: impl FnMut(&mut Pin<P, N, Output<PushPull>>)
)

Temporarily change the mode of the pin.

Note that the new state is set slightly before conversion happens. This can cause a short output glitch if switching between output modes

pub fn as_open_drain_output(
    &mut self,
    cr: &mut <Self as HL>::Cr,
    f: impl FnMut(&mut Pin<P, N, Output<OpenDrain>>)
)

Temporarily change the mode of the pin.

The value of the pin after conversion is undefined. If you want to control it, use $stateful_fn_name

pub fn as_open_drain_output_with_state(
    &mut self,
    cr: &mut <Self as HL>::Cr,
    state: PinState,
    f: impl FnMut(&mut Pin<P, N, Output<OpenDrain>>)
)

Temporarily change the mode of the pin.

Note that the new state is set slightly before conversion happens. This can cause a short output glitch if switching between output modes

pub fn as_floating_input(
    &mut self,
    cr: &mut <Self as HL>::Cr,
    f: impl FnMut(&mut Pin<P, N, Input<Floating>>)
)

Temporarily change the mode of the pin.

pub fn as_pull_up_input(
    &mut self,
    cr: &mut <Self as HL>::Cr,
    f: impl FnMut(&mut Pin<P, N, Input<PullUp>>)
)

Temporarily change the mode of the pin.

pub fn as_pull_down_input(
    &mut self,
    cr: &mut <Self as HL>::Cr,
    f: impl FnMut(&mut Pin<P, N, Input<PullDown>>)
)

Temporarily change the mode of the pin.

impl<const P: char, const N: u8> Pin<P, N, Dynamic>where
    Self: HL,

pub fn make_pull_up_input(&mut self, cr: &mut <Self as HL>::Cr)

pub fn make_pull_down_input(&mut self, cr: &mut <Self as HL>::Cr)

pub fn make_floating_input(&mut self, cr: &mut <Self as HL>::Cr)

pub fn make_push_pull_output(&mut self, cr: &mut <Self as HL>::Cr)

pub fn make_open_drain_output(&mut self, cr: &mut <Self as HL>::Cr)

Trait Implementations

impl<const P: char, MODE> HL for Pin<P, 0, MODE>

type Cr = Cr<P, false>

Configuration register associated to pin

impl<const P: char, MODE> HL for Pin<P, 1, MODE>

type Cr = Cr<P, false>

Configuration register associated to pin

impl<const P: char, MODE> HL for Pin<P, 10, MODE>

type Cr = Cr<P, true>

Configuration register associated to pin

impl<const P: char, MODE> HL for Pin<P, 11, MODE>

type Cr = Cr<P, true>

Configuration register associated to pin

impl<const P: char, MODE> HL for Pin<P, 12, MODE>

type Cr = Cr<P, true>

Configuration register associated to pin

impl<const P: char, MODE> HL for Pin<P, 13, MODE>

type Cr = Cr<P, true>

Configuration register associated to pin

impl<const P: char, MODE> HL for Pin<P, 14, MODE>

type Cr = Cr<P, true>

Configuration register associated to pin

impl<const P: char, MODE> HL for Pin<P, 15, MODE>

type Cr = Cr<P, true>

Configuration register associated to pin

impl<const P: char, MODE> HL for Pin<P, 2, MODE>

type Cr = Cr<P, false>

Configuration register associated to pin

impl<const P: char, MODE> HL for Pin<P, 3, MODE>

type Cr = Cr<P, false>

Configuration register associated to pin

impl<const P: char, MODE> HL for Pin<P, 4, MODE>

type Cr = Cr<P, false>

Configuration register associated to pin

impl<const P: char, MODE> HL for Pin<P, 5, MODE>

type Cr = Cr<P, false>

Configuration register associated to pin

impl<const P: char, MODE> HL for Pin<P, 6, MODE>

type Cr = Cr<P, false>

Configuration register associated to pin

impl<const P: char, MODE> HL for Pin<P, 7, MODE>

type Cr = Cr<P, false>

Configuration register associated to pin

impl<const P: char, MODE> HL for Pin<P, 8, MODE>

type Cr = Cr<P, true>

Configuration register associated to pin

impl<const P: char, MODE> HL for Pin<P, 9, MODE>

type Cr = Cr<P, true>

Configuration register associated to pin

impl<const P: char, const N: u8> InputPin for Pin<P, N, Dynamic>

type Error = PinModeError

Error type

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

Is the input pin high?

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

Is the input pin low?

impl<const P: char, const N: u8, MODE> InputPin for Pin<P, N, Input<MODE>>

type Error = Infallible

Error type

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

Is the input pin high?

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

Is the input pin low?

impl<const P: char, const N: u8> InputPin for Pin<P, N, Output<OpenDrain>>

type Error = Infallible

Error type

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

Is the input pin high?

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

Is the input pin low?

impl<const P: char, const N: u8> OutputPin for Pin<P, N, Dynamic>

type Error = PinModeError

Error type

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

Drives the pin high

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

Drives the pin low

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

Drives the pin high or low depending on the provided value

impl<const P: char, const N: u8, MODE> OutputPin for Pin<P, N, Output<MODE>>

type Error = Infallible

Error type

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

Drives the pin high

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

Drives the pin low

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

Drives the pin high or low depending on the provided value

impl<const P: char, const N: u8> OutputSpeed for Pin<P, N, Alternate<PushPull>>where
    Self: HL,

fn set_speed(&mut self, cr: &mut <Self as HL>::Cr, speed: IOPinSpeed)

impl<const P: char, const N: u8, MODE> OutputSpeed for Pin<P, N, Output<MODE>>where
    Self: HL,

fn set_speed(&mut self, cr: &mut <Self as HL>::Cr, speed: IOPinSpeed)

impl<const P: char, const N: u8, MODE> PinExt for Pin<P, N, MODE>

type Mode = MODE

fn pin_id(&self) -> u8

Return pin number

fn port_id(&self) -> u8

Return port number

impl<const P: char, const N: u8, MODE> StatefulOutputPin for Pin<P, N, Output<MODE>>

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

Is the pin in drive high mode?

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

Is the pin in drive low mode?

impl<const P: char, const N: u8, MODE> ToggleableOutputPin for Pin<P, N, Output<MODE>>

type Error = Infallible

Error type

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

Toggle pin output.