Struct stm32f4xx_hal::gpio::Pin

pub struct Pin<MODE, const P: char, const N: u8> { /* fields omitted */ }

Generic pin type

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

Implementations

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

pub fn into_alternate<const A: u8>(self) -> Pin<Alternate<A>, P, N>

Configures the pin to operate alternate mode

pub fn into_alternate_open_drain<const A: u8>(self) -> Pin<AlternateOD<A>, P, N>

Configures the pin to operate in alternate open drain mode

pub fn into_alternate_af0(self) -> Pin<Alternate<0>, P, N>

👎 Deprecated since 0.10.0

Configures the pin to operate in AF0 mode

pub fn into_alternate_af1(self) -> Pin<Alternate<1>, P, N>

👎 Deprecated since 0.10.0

Configures the pin to operate in AF1 mode

pub fn into_alternate_af2(self) -> Pin<Alternate<2>, P, N>

👎 Deprecated since 0.10.0

Configures the pin to operate in AF2 mode

pub fn into_alternate_af3(self) -> Pin<Alternate<3>, P, N>

👎 Deprecated since 0.10.0

Configures the pin to operate in AF3 mode

pub fn into_alternate_af4(self) -> Pin<Alternate<4>, P, N>

👎 Deprecated since 0.10.0

Configures the pin to operate in AF4 mode

pub fn into_alternate_af5(self) -> Pin<Alternate<5>, P, N>

👎 Deprecated since 0.10.0

Configures the pin to operate in AF5 mode

pub fn into_alternate_af6(self) -> Pin<Alternate<6>, P, N>

👎 Deprecated since 0.10.0

Configures the pin to operate in AF6 mode

pub fn into_alternate_af7(self) -> Pin<Alternate<7>, P, N>

👎 Deprecated since 0.10.0

Configures the pin to operate in AF7 mode

pub fn into_alternate_af8(self) -> Pin<Alternate<8>, P, N>

👎 Deprecated since 0.10.0

Configures the pin to operate in AF8 mode

pub fn into_alternate_af9(self) -> Pin<Alternate<9>, P, N>

👎 Deprecated since 0.10.0

Configures the pin to operate in AF9 mode

pub fn into_alternate_af10(self) -> Pin<Alternate<10>, P, N>

👎 Deprecated since 0.10.0

Configures the pin to operate in AF10 mode

pub fn into_alternate_af11(self) -> Pin<Alternate<11>, P, N>

👎 Deprecated since 0.10.0

Configures the pin to operate in AF11 mode

pub fn into_alternate_af12(self) -> Pin<Alternate<12>, P, N>

👎 Deprecated since 0.10.0

Configures the pin to operate in AF12 mode

pub fn into_alternate_af13(self) -> Pin<Alternate<13>, P, N>

👎 Deprecated since 0.10.0

Configures the pin to operate in AF13 mode

pub fn into_alternate_af14(self) -> Pin<Alternate<14>, P, N>

👎 Deprecated since 0.10.0

Configures the pin to operate in AF14 mode

pub fn into_alternate_af15(self) -> Pin<Alternate<15>, P, N>

👎 Deprecated since 0.10.0

Configures the pin to operate in AF15 mode

pub fn into_alternate_af0_open_drain(self) -> Pin<AlternateOD<0>, P, N>

👎 Deprecated since 0.10.0

Configures the pin to operate in AF0 open drain mode

pub fn into_alternate_af1_open_drain(self) -> Pin<AlternateOD<1>, P, N>

👎 Deprecated since 0.10.0

Configures the pin to operate in AF1 open drain mode

pub fn into_alternate_af2_open_drain(self) -> Pin<AlternateOD<2>, P, N>

👎 Deprecated since 0.10.0

Configures the pin to operate in AF2 open drain mode

pub fn into_alternate_af3_open_drain(self) -> Pin<AlternateOD<3>, P, N>

👎 Deprecated since 0.10.0

Configures the pin to operate in AF3 open drain mode

pub fn into_alternate_af4_open_drain(self) -> Pin<AlternateOD<4>, P, N>

👎 Deprecated since 0.10.0

Configures the pin to operate in AF4 open drain mode

pub fn into_alternate_af5_open_drain(self) -> Pin<AlternateOD<5>, P, N>

👎 Deprecated since 0.10.0

Configures the pin to operate in AF5 open drain mode

pub fn into_alternate_af6_open_drain(self) -> Pin<AlternateOD<6>, P, N>

👎 Deprecated since 0.10.0

Configures the pin to operate in AF6 open drain mode

pub fn into_alternate_af7_open_drain(self) -> Pin<AlternateOD<7>, P, N>

👎 Deprecated since 0.10.0

Configures the pin to operate in AF7 open drain mode

pub fn into_alternate_af8_open_drain(self) -> Pin<AlternateOD<8>, P, N>

👎 Deprecated since 0.10.0

Configures the pin to operate in AF8 open drain mode

pub fn into_alternate_af9_open_drain(self) -> Pin<AlternateOD<9>, P, N>

👎 Deprecated since 0.10.0

Configures the pin to operate in AF9 open drain mode

pub fn into_alternate_af10_open_drain(self) -> Pin<AlternateOD<10>, P, N>

👎 Deprecated since 0.10.0

Configures the pin to operate in AF10 open drain mode

pub fn into_alternate_af11_open_drain(self) -> Pin<AlternateOD<11>, P, N>

👎 Deprecated since 0.10.0

Configures the pin to operate in AF11 open drain mode

pub fn into_alternate_af12_open_drain(self) -> Pin<AlternateOD<12>, P, N>

👎 Deprecated since 0.10.0

Configures the pin to operate in AF12 open drain mode

pub fn into_alternate_af13_open_drain(self) -> Pin<AlternateOD<13>, P, N>

Configures the pin to operate in AF13 open drain modev

pub fn into_alternate_af14_open_drain(self) -> Pin<AlternateOD<14>, P, N>

👎 Deprecated since 0.10.0

Configures the pin to operate in AF14 open drain mode

pub fn into_alternate_af15_open_drain(self) -> Pin<AlternateOD<15>, P, N>

👎 Deprecated since 0.10.0

Configures the pin to operate in AF15 open drain mode

pub fn into_floating_input(self) -> Pin<Input<Floating>, P, N>

Configures the pin to operate as a floating input pin

pub fn into_pull_down_input(self) -> Pin<Input<PullDown>, P, N>

Configures the pin to operate as a pulled down input pin

pub fn into_pull_up_input(self) -> Pin<Input<PullUp>, P, N>

Configures the pin to operate as a pulled up input pin

pub fn into_open_drain_output(self) -> Pin<Output<OpenDrain>, P, N>

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

pub fn into_open_drain_output_in_state(
    self,
    initial_state: PinState
) -> Pin<Output<OpenDrain>, P, N>

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) -> Pin<Output<PushPull>, P, N>

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

pub fn into_push_pull_output_in_state(
    self,
    initial_state: PinState
) -> Pin<Output<PushPull>, P, N>

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) -> Pin<Analog, P, N>

Configures the pin to operate as an analog input pin

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

pub fn with_floating_input<R>(
    &mut self,
    f: impl FnOnce(&mut Pin<Input<Floating>, P, N>) -> R
) -> R

Temporarily configures this pin as a floating input.

The closure f is called with the reconfigured pin. After it returns, the pin will be configured back.

pub fn with_pull_down_input<R>(
    &mut self,
    f: impl FnOnce(&mut Pin<Input<PullDown>, P, N>) -> R
) -> R

Temporarily configures this pin as a pulled-down input.

The closure f is called with the reconfigured pin. After it returns, the pin will be configured back.

pub fn with_pull_up_input<R>(
    &mut self,
    f: impl FnOnce(&mut Pin<Input<PullUp>, P, N>) -> R
) -> R

Temporarily configures this pin as a pulled-up input.

The closure f is called with the reconfigured pin. After it returns, the pin will be configured back.

pub fn with_analog<R>(
    &mut self,
    f: impl FnOnce(&mut Pin<Analog, P, N>) -> R
) -> R

Temporarily configures this pin as an analog pin.

The closure f is called with the reconfigured pin. After it returns, the pin will be configured back.

pub fn with_open_drain_output<R>(
    &mut self,
    f: impl FnOnce(&mut Pin<Output<OpenDrain>, P, N>) -> R
) -> R

Temporarily configures this pin as an open drain output.

The closure f is called with the reconfigured pin. After it returns, the pin will be configured back. The value of the pin after conversion is undefined. If you want to control it, use with_open_drain_output_in_state

pub fn with_open_drain_output_in_state<R>(
    &mut self,
    state: PinState,
    f: impl FnOnce(&mut Pin<Output<OpenDrain>, P, N>) -> R
) -> R

Temporarily configures this pin as an open drain output .

The closure f is called with the reconfigured pin. After it returns, the pin will be configured back. 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 with_push_pull_output<R>(
    &mut self,
    f: impl FnOnce(&mut Pin<Output<PushPull>, P, N>) -> R
) -> R

Temporarily configures this pin as a push-pull output.

The closure f is called with the reconfigured pin. After it returns, the pin will be configured back. The value of the pin after conversion is undefined. If you want to control it, use with_push_pull_output_in_state

pub fn with_push_pull_output_in_state<R>(
    &mut self,
    state: PinState,
    f: impl FnOnce(&mut Pin<Output<PushPull>, P, N>) -> R
) -> R

Temporarily configures this pin as a push-pull output.

The closure f is called with the reconfigured pin. After it returns, the pin will be configured back. Note that the new state is set slightly before conversion happens. This can cause a short output glitch if switching between output modes

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

pub fn set_speed(self, speed: Speed) -> Self

Set pin speed

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

pub fn internal_pull_up(&mut self, on: bool)

Enables / disables the internal pull up

impl<const P: char, const N: u8, const A: u8> Pin<Alternate<A>, P, N>

pub fn set_speed(self, speed: Speed) -> Self

Set pin speed

pub fn internal_pull_up(self, on: bool) -> Self

Enables / disables the internal pull up

impl<const P: char, const N: u8, const A: u8> Pin<Alternate<A>, P, N>

pub fn set_open_drain(self) -> Pin<AlternateOD<A>, P, N>

Turns pin alternate configuration pin into open drain

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

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

Erases the pin number 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

pub fn downgrade(self) -> PEPin<MODE, P>

👎 Deprecated since 0.10.0:

Please use erase_number instead

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

Erases the pin number and the 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

pub fn downgrade2(self) -> EPin<MODE>

👎 Deprecated since 0.10.0:

Please use erase instead

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

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> Pin<Output<OpenDrain>, P, N>

pub fn is_high(&self) -> bool

pub fn is_low(&self) -> bool

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

pub fn is_high(&self) -> bool

pub fn is_low(&self) -> bool

Trait Implementations

impl<const P: char, const N: u8, const A: u8> From<Pin<Alternate<A>, P, N>> for Pin<Input<PullDown>, P, N>

fn from(f: Pin<Alternate<A>, P, N>) -> Self

Performs the conversion.

impl<const P: char, const N: u8, const A: u8> From<Pin<Alternate<A>, P, N>> for Pin<Input<PullUp>, P, N>

fn from(f: Pin<Alternate<A>, P, N>) -> Self

Performs the conversion.

impl<const P: char, const N: u8, const A: u8> From<Pin<Alternate<A>, P, N>> for Pin<Input<Floating>, P, N>

fn from(f: Pin<Alternate<A>, P, N>) -> Self

Performs the conversion.

impl<const P: char, const N: u8, const A: u8> From<Pin<Alternate<A>, P, N>> for Pin<Output<OpenDrain>, P, N>

fn from(f: Pin<Alternate<A>, P, N>) -> Self

Performs the conversion.

impl<const P: char, const N: u8, const A: u8> From<Pin<Alternate<A>, P, N>> for Pin<Output<PushPull>, P, N>

fn from(f: Pin<Alternate<A>, P, N>) -> Self

Performs the conversion.

impl<const P: char, const N: u8, const A: u8> From<Pin<Alternate<A>, P, N>> for Pin<Analog, P, N>

fn from(f: Pin<Alternate<A>, P, N>) -> Self

Performs the conversion.

impl<const P: char, const N: u8, const A: u8, const B: u8> From<Pin<Alternate<B>, P, N>> for Pin<AlternateOD<A>, P, N>

fn from(f: Pin<Alternate<B>, P, N>) -> Self

Performs the conversion.

impl<const P: char, const N: u8, const A: u8> From<Pin<AlternateOD<A>, P, N>> for Pin<Input<PullDown>, P, N>

fn from(f: Pin<AlternateOD<A>, P, N>) -> Self

Performs the conversion.

impl<const P: char, const N: u8, const A: u8> From<Pin<AlternateOD<A>, P, N>> for Pin<Input<PullUp>, P, N>

fn from(f: Pin<AlternateOD<A>, P, N>) -> Self

Performs the conversion.

impl<const P: char, const N: u8, const A: u8> From<Pin<AlternateOD<A>, P, N>> for Pin<Input<Floating>, P, N>

fn from(f: Pin<AlternateOD<A>, P, N>) -> Self

Performs the conversion.

impl<const P: char, const N: u8, const A: u8> From<Pin<AlternateOD<A>, P, N>> for Pin<Output<OpenDrain>, P, N>

fn from(f: Pin<AlternateOD<A>, P, N>) -> Self

Performs the conversion.

impl<const P: char, const N: u8, const A: u8> From<Pin<AlternateOD<A>, P, N>> for Pin<Output<PushPull>, P, N>

fn from(f: Pin<AlternateOD<A>, P, N>) -> Self

Performs the conversion.

impl<const P: char, const N: u8, const A: u8> From<Pin<AlternateOD<A>, P, N>> for Pin<Analog, P, N>

fn from(f: Pin<AlternateOD<A>, P, N>) -> Self

Performs the conversion.

impl<const P: char, const N: u8, const A: u8, const B: u8> From<Pin<AlternateOD<B>, P, N>> for Pin<Alternate<A>, P, N>

fn from(f: Pin<AlternateOD<B>, P, N>) -> Self

Performs the conversion.

impl<const P: char, const N: u8, const A: u8> From<Pin<Analog, P, N>> for Pin<Alternate<A>, P, N>

fn from(f: Pin<Analog, P, N>) -> Self

Performs the conversion.

impl<const P: char, const N: u8, const A: u8> From<Pin<Analog, P, N>> for Pin<AlternateOD<A>, P, N>

fn from(f: Pin<Analog, P, N>) -> Self

Performs the conversion.

impl<const P: char, const N: u8> From<Pin<Analog, P, N>> for Pin<Input<PullDown>, P, N>

fn from(f: Pin<Analog, P, N>) -> Self

Performs the conversion.

impl<const P: char, const N: u8> From<Pin<Analog, P, N>> for Pin<Input<PullUp>, P, N>

fn from(f: Pin<Analog, P, N>) -> Self

Performs the conversion.

impl<const P: char, const N: u8> From<Pin<Analog, P, N>> for Pin<Input<Floating>, P, N>

fn from(f: Pin<Analog, P, N>) -> Self

Performs the conversion.

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

fn from(f: Pin<Analog, P, N>) -> Self

Performs the conversion.

impl<const P: char, const N: u8> From<Pin<Analog, P, N>> for Pin<Output<PushPull>, P, N>

fn from(f: Pin<Analog, P, N>) -> Self

Performs the conversion.

impl<const P: char, const N: u8> From<Pin<Input<Floating>, P, N>> for Pin<Input<PullDown>, P, N>

fn from(f: Pin<Input<Floating>, P, N>) -> Self

Performs the conversion.

impl<const P: char, const N: u8> From<Pin<Input<Floating>, P, N>> for Pin<Input<PullUp>, P, N>

fn from(f: Pin<Input<Floating>, P, N>) -> Self

Performs the conversion.

impl<MODE, const P: char, const N: u8, const A: u8> From<Pin<Input<MODE>, P, N>> for Pin<Alternate<A>, P, N>

fn from(f: Pin<Input<MODE>, P, N>) -> Self

Performs the conversion.

impl<MODE, const P: char, const N: u8, const A: u8> From<Pin<Input<MODE>, P, N>> for Pin<AlternateOD<A>, P, N>

fn from(f: Pin<Input<MODE>, P, N>) -> Self

Performs the conversion.

impl<MODE, const P: char, const N: u8> From<Pin<Input<MODE>, P, N>> for Pin<Output<OpenDrain>, P, N>

fn from(f: Pin<Input<MODE>, P, N>) -> Self

Performs the conversion.

impl<MODE, const P: char, const N: u8> From<Pin<Input<MODE>, P, N>> for Pin<Output<PushPull>, P, N>

fn from(f: Pin<Input<MODE>, P, N>) -> Self

Performs the conversion.

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

fn from(f: Pin<Input<MODE>, P, N>) -> Self

Performs the conversion.

impl<const P: char, const N: u8> From<Pin<Input<PullDown>, P, N>> for Pin<Input<PullUp>, P, N>

fn from(f: Pin<Input<PullDown>, P, N>) -> Self

Performs the conversion.

impl<const P: char, const N: u8> From<Pin<Input<PullDown>, P, N>> for Pin<Input<Floating>, P, N>

fn from(f: Pin<Input<PullDown>, P, N>) -> Self

Performs the conversion.

impl<const P: char, const N: u8> From<Pin<Input<PullUp>, P, N>> for Pin<Input<PullDown>, P, N>

fn from(f: Pin<Input<PullUp>, P, N>) -> Self

Performs the conversion.

impl<const P: char, const N: u8> From<Pin<Input<PullUp>, P, N>> for Pin<Input<Floating>, P, N>

fn from(f: Pin<Input<PullUp>, P, N>) -> Self

Performs the conversion.

impl<MODE, const P: char, const N: u8, const A: u8> From<Pin<Output<MODE>, P, N>> for Pin<Alternate<A>, P, N>

fn from(f: Pin<Output<MODE>, P, N>) -> Self

Performs the conversion.

impl<MODE, const P: char, const N: u8, const A: u8> From<Pin<Output<MODE>, P, N>> for Pin<AlternateOD<A>, P, N>

fn from(f: Pin<Output<MODE>, P, N>) -> Self

Performs the conversion.

impl<MODE, const P: char, const N: u8> From<Pin<Output<MODE>, P, N>> for Pin<Input<PullDown>, P, N>

fn from(f: Pin<Output<MODE>, P, N>) -> Self

Performs the conversion.

impl<MODE, const P: char, const N: u8> From<Pin<Output<MODE>, P, N>> for Pin<Input<PullUp>, P, N>

fn from(f: Pin<Output<MODE>, P, N>) -> Self

Performs the conversion.

impl<MODE, const P: char, const N: u8> From<Pin<Output<MODE>, P, N>> for Pin<Input<Floating>, P, N>

fn from(f: Pin<Output<MODE>, P, N>) -> Self

Performs the conversion.

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

fn from(f: Pin<Output<MODE>, P, N>) -> Self

Performs the conversion.

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

fn from(f: Pin<Output<OpenDrain>, P, N>) -> Self

Performs the conversion.

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

fn from(f: Pin<Output<PushPull>, P, N>) -> Self

Performs the conversion.

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

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<MODE, const P: char, const N: u8> InputPin for Pin<Input<MODE>, P, N>

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> IoPin<Pin<Input<Floating>, P, N>, Pin<Output<PushPull>, P, N>> for Pin<Output<PushPull>, P, N>

type Error = Infallible

Error type.

fn into_input_pin(self) -> Result<Pin<Input<Floating>, P, N>, Self::Error>

Tries to convert this pin to input mode.

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

Tries to convert this pin to output mode with the given initial state.

impl<const P: char, const N: u8> IoPin<Pin<Input<Floating>, P, N>, Pin<Output<PushPull>, P, N>> for Pin<Input<Floating>, P, N>

type Error = Infallible

Error type.

fn into_input_pin(self) -> Result<Self, Self::Error>

Tries to convert this pin to input mode.

fn into_output_pin(
    self,
    state: PinState
) -> Result<Pin<Output<PushPull>, P, N>, Self::Error>

Tries to convert this pin to output mode with the given initial state.

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

type Error = Infallible

Error type.

fn into_input_pin(self) -> Result<Self, Self::Error>

Tries to convert this pin to input mode.

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

Tries to convert this pin to output mode with the given initial state.

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

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<MODE, const P: char, const N: u8> PinExt for Pin<MODE, P, N>

type Mode = MODE

fn pin_id(&self) -> u8

Return pin number

fn port_id(&self) -> u8

Return port number

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

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<MODE, const P: char, const N: u8> ToggleableOutputPin for Pin<Output<MODE>, P, N>

type Error = Infallible

Error type

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

Toggle pin output.