Struct embassy_nrf::gpio::Flex

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

GPIO flexible pin.

This pin can either be a disconnected, input, or output pin, or both. The level register bit will remain set while not in output mode, so the pin’s level will be ‘remembered’ when it is not in output mode.

Implementations

impl<'d> Flex<'d>

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

Wrap the pin in a Flex.

The pin remains disconnected. The initial output level is unspecified, but can be changed before the pin is put into output mode.

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

Put the pin into input mode.

pub fn set_as_output(&mut self, drive: OutputDrive)

Put the pin into output mode.

The pin level will be whatever was set before (or low by default). If you want it to begin at a specific level, call set_high/set_low on the pin first.

pub fn set_as_input_output(&mut self, pull: Pull, drive: OutputDrive)

Put the pin into input + output mode.

This is commonly used for “open drain” mode. If you set drive = Standard0Disconnect1, the hardware will drive the line low if you set it to low, and will leave it floating if you set it to high, in which case you can read the input to figure out whether another device is driving the line low.

The pin level will be whatever was set before (or low by default). If you want it to begin at a specific level, call set_high/set_low on the pin first.

pub fn set_as_disconnected(&mut self)

Put the pin into disconnected mode.

pub fn is_high(&self) -> bool

Get whether the pin input level is high.

pub fn is_low(&self) -> bool

Get whether the pin input level is low.

pub fn get_level(&self) -> Level

Get the pin input level.

pub fn set_high(&mut self)

Set the output as high.

pub fn set_low(&mut self)

Set the output as low.

pub fn toggle(&mut self)

Toggle the output level.

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

Set the output level.

pub fn is_set_high(&self) -> bool

Get whether the output level is set to high.

pub fn is_set_low(&self) -> bool

Get whether the output level is set to low.

pub fn get_output_level(&self) -> Level

Get the current output level.

impl<'d> Flex<'d>

pub async fn wait_for_high(&mut self)

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

pub async fn wait_for_low(&mut self)

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

pub async fn wait_for_rising_edge(&mut self)

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

pub async fn wait_for_falling_edge(&mut self)

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

pub async fn wait_for_any_edge(&mut self)

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

Trait Implementations

impl<'d> Drop for Flex<'d>

fn drop(&mut self)

Executes the destructor for this type.

impl<'d> ErrorType for Flex<'d>

type Error = Infallible

Error type

impl<'d> InputPin for Flex<'d>

Implement embedded_hal_02::digital::v2::InputPin for Flex;

If the pin is not in input mode the result is unspecified.

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<'d> InputPin for Flex<'d>

Implement [InputPin] for Flex;

If the pin is not in input mode the result is unspecified.

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<'d> OutputPin for Flex<'d>

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<'d> OutputPin for Flex<'d>

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<'d> StatefulOutputPin for Flex<'d>

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<'d> StatefulOutputPin for Flex<'d>

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<'d> ToggleableOutputPin for Flex<'d>

type Error = Infallible

Error type

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

Toggle pin output.

impl<'d> Wait for Flex<'d>

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.