Struct mimxrt500_hal::gpio::pin::Pin

pub struct Pin<I, M>where
    I: PinId,
    M: PinMode,{ /* private fields */ }

A type-level GPIO pin, parameterized by PinId and PinMode types.

This is the main interesting type for pin configuration and GPIO functionality. Use .into() to switch a pin into a different mode and therefore obtain a new Pin with different parameters.

Implementations

impl<I, M> Pin<I, M>where I: PinId, M: PinMode,

pub fn set_output(&self, high: bool)

Sets the output value for the pin.

This method is always available, but will have no immediate effect if the pin is not in output mode. Use set_output before converting to an output to specify the initial value once output mode is enabled.

pub fn toggle_output(&self)

Toggles the output state for the pin.

This method is always available, but will have no immediate effect if the pin is not in output mode.

pub fn into_push_pull_output(self) -> Pin<I, OutputPushPull>

Reconfigures the pin into a push-pull output and returns the new pin.

pub fn into_input(self) -> Pin<I, InputFloating>

Reconfigures the pin into a floating input and returns the new pin.

pub fn into_input_pullup(self) -> Pin<I, InputPullUp>

Reconfigures the pin into an input with pull-up and returns the new pin.

pub fn into_input_pulldown(self) -> Pin<I, InputPullDown>

Reconfigures the pin into an input with pull-down and returns the new pin.

pub const fn into_value_based(self) -> DynPin

Reinterprets the pin as a value-based DynPin, which tracks the pin ID and mode as runtime data rather than as type parameters.

Trait Implementations

impl<Id: PinId, M: PinMode> ErrorType for Pin<Id, M>

type Error = Infallible

Error type

impl<Id: PinId, IC: InputConfig, const OOD: bool, const OFD: bool, const OSS: bool> From<Pin<Id, Input<IC>>> for Pin<Id, Output<OOD, OFD, OSS>>

fn from(value: Pin<Id, Input<IC>>) -> Self

Converts to this type from the input type.

impl<Id: PinId, const OOD: bool, const OFD: bool, const OSS: bool, IC: InputConfig> From<Pin<Id, Output<OOD, OFD, OSS>>> for Pin<Id, Input<IC>>

fn from(value: Pin<Id, Output<OOD, OFD, OSS>>) -> Self

Converts to this type from the input type.

impl<Id: PinId, F: AltFunc, ST: SignalType> From<Pin<Id, Unknown>> for Pin<Id, Alternate<F, ST>>

fn from(value: Pin<Id, Unknown>) -> Self

Converts to this type from the input type.

impl<Id: PinId, C: InputConfig> From<Pin<Id, Unknown>> for Pin<Id, Input<C>>

fn from(value: Pin<Id, Unknown>) -> Self

Converts to this type from the input type.

impl<Id: PinId, const OD: bool, const FD: bool, const SS: bool> From<Pin<Id, Unknown>> for Pin<Id, Output<OD, FD, SS>>

fn from(value: Pin<Id, Unknown>) -> Self

Converts to this type from the input type.

impl<Id: PinId, C: InputConfig> InputPin for Pin<Id, Input<C>>

Pins in input mode implement ehal::InputPin.

This implementation does not take into account the possibility that the port might be configured to invert its input. If that flag is set then the two methods will return opposite values.

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<Id: PinId, const OD: bool, const FD: bool, const SS: bool> OutputPin for Pin<Id, Output<OD, FD, SS>>

Pins in output mode implement ehal::OutputPin.

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<Id: PinId, const OD: bool, const FD: bool, const SS: bool> ToggleableOutputPin for Pin<Id, Output<OD, FD, SS>>

Pins in output mode implement ehal::ToggleableOutputPin.

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

Toggle pin output.