Struct Flex

pub struct Flex<'d> { /* private fields */ }

Flexible pin driver.

This driver allows changing the pin mode between input and output.

Implementations

impl Flex<'_>

pub async fn wait_for(&mut self, event: Event)

Available on crate feature unstable only.

Wait until the pin experiences a particular Event.

The GPIO driver will disable listening for the event once it occurs, or if the Future is dropped.

Note that calling this function will overwrite previous listen operations for this pin.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub async fn wait_for_high(&mut self)

Available on crate feature unstable only.

Wait until the pin is high.

See Self::wait_for for more information.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub async fn wait_for_low(&mut self)

Available on crate feature unstable only.

Wait until the pin is low.

See Self::wait_for for more information.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub async fn wait_for_rising_edge(&mut self)

Available on crate feature unstable only.

Wait for the pin to undergo a transition from low to high.

See Self::wait_for for more information.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub async fn wait_for_falling_edge(&mut self)

Available on crate feature unstable only.

Wait for the pin to undergo a transition from high to low.

See Self::wait_for for more information.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub async fn wait_for_any_edge(&mut self)

Available on crate feature unstable only.

Wait for the pin to undergo any transition, i.e low to high OR high to low.

See Self::wait_for for more information.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

impl<'d> Flex<'d>

pub fn new(pin: impl Peripheral<P = impl Into<AnyPin>> + 'd) -> Self

Available on crate feature unstable only.

Create flexible pin driver for a Pin. No mode change happens.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn peripheral_input(&self) -> InputSignal

Available on crate feature unstable only.

Returns a peripheral input connected to this pin.

The input signal can be passed to peripherals in place of an input pin.

let pin1_gpio = Flex::new(peripherals.GPIO1);
// Can be passed as an input.
let pin1 = pin1_gpio.peripheral_input();

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn is_high(&self) -> bool

Available on crate feature unstable only.

Get whether the pin input level is high.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn is_low(&self) -> bool

Available on crate feature unstable only.

Get whether the pin input level is low.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn level(&self) -> Level

Available on crate feature unstable only.

Get the current pin input level.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn listen(&mut self, event: Event)

Available on crate feature unstable only.

Listen for interrupts.

See Input::listen for more information and an example.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn unlisten(&mut self)

Available on crate feature unstable only.

Stop listening for interrupts.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn is_listening(&self) -> bool

Available on crate feature unstable only.

Check if the pin is listening for interrupts.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn clear_interrupt(&mut self)

Available on crate feature unstable only.

Clear the interrupt status bit for this Pin

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn is_interrupt_set(&self) -> bool

Available on crate feature unstable only.

Checks if the interrupt status bit for this Pin is set

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn wakeup_enable( &mut self, enable: bool, event: WakeEvent, ) -> Result<(), WakeConfigError>

Available on crate feature unstable only.

Enable as a wake-up source.

This will unlisten for interrupts

Error

Configuring pin to wake up from light sleep on an edge trigger is currently not supported, corresponding variant of WakeConfigError will be returned.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn set_as_output(&mut self)

Available on crate feature unstable only.

Set the GPIO to output mode.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn set_high(&mut self)

Available on crate feature unstable only.

Set the output as high.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn set_low(&mut self)

Available on crate feature unstable only.

Set the output as low.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn set_level(&mut self, level: Level)

Available on crate feature unstable only.

Set the output level.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn is_set_high(&self) -> bool

Available on crate feature unstable only.

Is the output pin set as high?

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn is_set_low(&self) -> bool

Available on crate feature unstable only.

Is the output pin set as low?

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn output_level(&self) -> Level

Available on crate feature unstable only.

What level output is set to

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn toggle(&mut self)

Available on crate feature unstable only.

Toggle pin output

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn set_drive_strength(&mut self, strength: DriveStrength)

Available on crate feature unstable only.

Configure the DriveStrength of the pin

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

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

Available on crate feature unstable only.

Set the GPIO to open-drain mode.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

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

Available on crate feature unstable only.

Configure pullup/pulldown resistors.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn enable_input(&mut self, enable_input: bool)

Available on crate feature unstable only.

Enable or disable the GPIO pin input buffer.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn apply_output_config(&mut self, config: &OutputConfig)

Available on crate feature unstable only.

Applies the given output configuration to the pin.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn apply_input_config(&mut self, config: &InputConfig)

Available on crate feature unstable only.

Applies the given input configuration to the pin.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn split(self) -> (InputSignal, OutputSignal)

Available on crate feature unstable only.

Split the pin into an input and output signal.

Peripheral signals allow connecting peripherals together without using external hardware.

let pin1 = Flex::new(peripherals.GPIO1);
let (input, output) = pin1.split();

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn into_peripheral_output(self) -> OutputSignal

Available on crate feature unstable only.

Turns the pin object into a peripheral output.

The output signal can be passed to peripherals in place of an output pin.

let pin1_gpio = Flex::new(peripherals.GPIO1);
// Can be passed as an output.
let pin1 = pin1_gpio.into_peripheral_output();

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

Trait Implementations

impl<'d> Debug for Flex<'d>

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

Formats the value using the given formatter.

impl ErrorType for Flex<'_>

Available on crate feature unstable only.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

type Error = Infallible

Error type

impl<'d> Format for Flex<'d>

where PeripheralRef<'d, AnyPin>: Format,

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

Writes the defmt representation of self to fmt.

impl From<Flex<'static>> for InputConnection

Available on crate feature unstable only.

fn from(pin: Flex<'static>) -> Self

Converts to this type from the input type.

impl From<Flex<'static>> for InputSignal

Available on crate feature unstable only.

fn from(input: Flex<'static>) -> Self

Converts to this type from the input type.

impl From<Flex<'static>> for OutputConnection

Available on crate feature unstable only.

fn from(pin: Flex<'static>) -> Self

Converts to this type from the input type.

impl From<Flex<'static>> for OutputSignal

Available on crate feature unstable only.

fn from(output: Flex<'static>) -> Self

Converts to this type from the input type.

impl InputPin for Flex<'_>

Available on crate feature unstable only.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

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 Flex<'_>

Available on crate feature unstable only.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

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 Peripheral for Flex<'_>

type P = Flex<'_>

Peripheral singleton type

unsafe fn clone_unchecked(&self) -> Self::P

Unsafely clone (duplicate) a peripheral singleton.

fn into_ref<'a>(self) -> PeripheralRef<'a, Self::P>

where Self: 'a,

Convert a value into a PeripheralRef.

fn map_into<U>(self) -> U

where Self::P: Into<U>, U: Peripheral<P = U>,

Map the peripheral using Into.

fn map<U>(self, transform: impl FnOnce(Self::P) -> U) -> U

where U: Peripheral<P = U>,

Map the peripheral using Into.

impl StatefulOutputPin for Flex<'_>

Available on crate feature unstable only.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

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.

impl Wait for Flex<'_>

Available on crate feature unstable only.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

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

Wait until the pin is high. If it is already high, return immediately.

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

Wait until the pin is low. If it is already low, return immediately.

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

Wait for the pin to undergo a transition from low to high.

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

Wait for the pin to undergo a transition from high to low.

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

Wait for the pin to undergo any transition, i.e low to high OR high to low.

impl PeripheralInput for Flex<'static>

Available on crate feature unstable only.

impl PeripheralOutput for Flex<'static>

Available on crate feature unstable only.