embassy-nxp

Crates

git

Versions

mimxrt1011

Flavors

Struct Flex

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

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§

Source§

impl<'d> Flex<'d>

Source

pub fn new(pin: Peri<'d, impl Pin>) -> 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.

Source

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

Set the pin’s pull.

Source

pub fn set_slewrate(&mut self, rate: SlewRate)

Source

pub fn set_schmitt(&mut self, enable: bool)

Set the pin’s Schmitt trigger.

Source

pub fn set_as_input(&mut self)

Put the pin into input mode.

The pull setting is left unchanged.

Source

pub fn set_as_output(&mut self)

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.

Source

pub fn set_as_input_output(&mut self)

Put the pin into input + open-drain output mode.

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.

The internal weak pull-up and pull-down resistors will be disabled.

Source

pub fn set_as_disconnected(&mut self)

Set the pin as “disconnected”, ie doing nothing and consuming the lowest amount of power possible.

This is currently the same as [Self::set_as_analog()] but is semantically different really. Drivers should set_as_disconnected() pins when dropped.

Note that this also disables the pull-up and pull-down resistors.

Source

pub fn is_high(&self) -> bool

Get whether the pin input level is high.

Source

pub fn is_low(&self) -> bool

Get whether the pin input level is low.

Source

pub fn get_level(&self) -> Level

Returns current pin level

Source

pub fn set_high(&mut self)

Set the output as high.

Source

pub fn set_low(&mut self)

Set the output as low.

Source

pub fn toggle(&mut self)

Toggle pin output

Source

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

Set the output level.

Source

pub fn get_output_level(&self) -> Level

Get the current pin output level.

Source

pub fn is_set_high(&self) -> bool

Is the output level high?

If the Flex is set as an input, then this is equivalent to Flex::is_high.

Source

pub fn is_set_low(&self) -> bool

Is the output level low?

If the Flex is set as an input, then this is equivalent to Flex::is_low.

Source

pub async fn wait_for_high(&mut self)

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

Source

pub async fn wait_for_low(&mut self)

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

Source

pub async fn wait_for_rising_edge(&mut self)

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

Source

pub async fn wait_for_falling_edge(&mut self)

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

Source

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§

Source§

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

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<'d> Freeze for Flex<'d>

§

impl<'d> RefUnwindSafe for Flex<'d>

§

impl<'d> Send for Flex<'d>

§

impl<'d> Sync for Flex<'d>

§

impl<'d> Unpin for Flex<'d>

§

impl<'d> !UnwindSafe for Flex<'d>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.