Struct stm32f4xx_hal::gpio::Pin

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

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<const P: char, const N: u8, const A: u8> Pin<P, N, Alternate<A, PushPull>>

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

Turns pin alternate configuration pin into open drain

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

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

Configures the pin to operate alternate mode

pub fn into_alternate_open_drain<const A: u8>(
    self
) -> Pin<P, N, Alternate<A, OpenDrain>>where
    Self: IntoAf<A>,

Configures the pin to operate in alternate open drain mode

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

Configures the pin to operate as a input pin

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

Configures the pin to operate as a floating input pin

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

Configures the pin to operate as a pulled down input pin

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

Configures the pin to operate as a pulled up input pin

pub fn into_open_drain_output(self) -> 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_in_state(
    self,
    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) -> 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_in_state(
    self,
    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) -> Pin<P, N, Analog>

Configures the pin to operate as an analog input pin

pub fn into_dynamic(self) -> DynamicPin<P, N>

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

pub fn into_mode<M: PinMode>(self) -> Pin<P, N, M>

Converts pin into specified mode

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

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

Temporarily configures this pin as a 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<P, N, Analog>) -> 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<P, N, Output<OpenDrain>>) -> 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<P, N, Output<OpenDrain>>) -> 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<P, N, Output<PushPull>>) -> 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<P, N, Output<PushPull>>) -> 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<const P: char, const N: u8, MODE> Pin<P, N, MODE>

pub const fn interrupt(&self) -> Interrupt

NVIC interrupt number of interrupt from this pin

Used to unmask / enable the interrupt with cortex_m::peripheral::NVIC::unmask(). This is also useful for all other cortex_m::peripheral::NVIC functions.

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

pub fn set_speed(&mut self, speed: Speed)

Set pin speed

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

Set pin speed

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

pub fn set_internal_resistor(&mut self, resistor: Pull)

Set the internal pull-up and pull-down resistor

pub fn internal_resistor(self, resistor: Pull) -> Self

Set the internal pull-up and pull-down resistor

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

Enables / disables the internal pull up

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

Enables / disables the internal pull down

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

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

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 erase(self) -> ErasedPin<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

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

pub fn set_high(&mut self)

Drives the pin high

pub fn set_low(&mut self)

Drives the pin low

pub fn get_state(&self) -> PinState

Is the pin in drive high or low mode?

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

Drives the pin high or low depending on the provided value

pub fn is_set_high(&self) -> bool

Is the pin in drive high mode?

pub fn is_set_low(&self) -> bool

Is the pin in drive low mode?

pub fn toggle(&mut self)

Toggle pin output

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

pub fn is_high(&self) -> bool

Is the input pin high?

pub fn is_low(&self) -> bool

Is the input pin low?

Trait Implementations

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

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

Formats the value using the given formatter.

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

type Error = Infallible

Error type

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

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl<const P: char, const N: u8, const A: u8, Otype, MODE> From<Pin<P, N, Alternate<A, Otype>>> for Pin<P, N, MODE>where
    Alternate<A, Otype>: PinMode,
    MODE: PinMode + NotAlt,

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

Converts to this type from the input type.

impl<const P: char, const N: u8, const A: u8, const B: u8> From<Pin<P, N, Alternate<B, PushPull>>> for Pin<P, N, Alternate<A, OpenDrain>>where
    Self: IntoAf<A>,

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<const P: char, const N: u8, Otype> From<Pin<P, N, Analog>> for Pin<P, N, Output<Otype>>where
    Output<Otype>: PinMode,

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<const P: char, const N: u8, Otype> From<Pin<P, N, Input>> for Pin<P, N, Output<Otype>>where
    Output<Otype>: PinMode,

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

Converts to this type from the input type.

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

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

Pin-to-erased pin conversion using the From trait.

Note that From is the reciprocal of Into.

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

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

Pin-to-partially erased pin conversion using the From trait.

Note that From is the reciprocal of Into.

impl<const P: char, const N: u8, MODE: PinMode + NotAlt, const A: u8, Otype> From<Pin<P, N, MODE>> for Pin<P, N, Alternate<A, Otype>>where
    Alternate<A, Otype>: PinMode,
    Self: IntoAf<A>,

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<const P: char, const N: u8, Otype> From<Pin<P, N, Output<Otype>>> for Pin<P, N, Analog>where
    Output<Otype>: PinMode,

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

Converts to this type from the input type.

impl<const P: char, const N: u8, Otype> From<Pin<P, N, Output<Otype>>> for Pin<P, N, Input>where
    Output<Otype>: PinMode,

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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, MODE> InputPin for Pin<P, N, MODE>where
    MODE: Readable,

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, Otype> IoPin<Pin<P, N, Input>, Pin<P, N, Output<Otype>>> for Pin<P, N, Input>where
    Output<Otype>: PinMode,

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<P, N, Output<Otype>>, Self::Error>

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

impl<const P: char, const N: u8, Otype> IoPin<Pin<P, N, Input>, Pin<P, N, Output<Otype>>> for Pin<P, N, Input>where
    Output<Otype>: PinMode,

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<P, N, Output<Otype>>, Self::Error>

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

impl<const P: char, const N: u8, Otype> IoPin<Pin<P, N, Input>, Pin<P, N, Output<Otype>>> for Pin<P, N, Output<Otype>>where
    Output<Otype>: PinMode,

type Error = Infallible

Error type.

fn into_input_pin(self) -> Result<Pin<P, N, Input>, 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, Otype> IoPin<Pin<P, N, Input>, Pin<P, N, Output<Otype>>> for Pin<P, N, Output<Otype>>where
    Output<Otype>: PinMode,

type Error = Infallible

Error type.

fn into_input_pin(self) -> Result<Pin<P, N, Input>, 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<P, N, Output<OpenDrain>>, Pin<P, N, Output<OpenDrain>>> for Pin<P, N, Output<OpenDrain>>

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

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<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, MODE> OutputPin for Pin<P, N, Output<MODE>>

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> PinExt for Pin<P, N, MODE>

type Mode = MODE

Current pin mode

fn pin_id(&self) -> u8

Pin number

fn port_id(&self) -> u8

Port number starting from 0

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> 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.

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

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

Toggle pin output.

impl<const P: char, const N: u8> WsPin for Pin<P, N, Ws>

fn is_high(&self) -> bool

fn is_low(&self) -> bool