PioUartRx

pio_uart

Struct PioUartRx 

Source 
pub struct PioUartRx<PinID: PinId, PIO: PIOExt, SM: StateMachineIndex, State> { /* private fields */ }
Expand description

Represents the Rx part of a UART interface using the RP2040’s PIO hardware.

§Type Parameters

  • PinID: The PinId for the RX pin.
  • SM: The state machine to use.
  • State: The state of the UART interface, either pio::Stopped or pio::Running.

Implementations§

Source§

impl<PinID: PinId, PIO: PIOExt, SM: StateMachineIndex> PioUartRx<PinID, PIO, SM, Stopped>

Source

pub fn new( rx_pin: Pin<PinID, PIO::PinFunction, PullUp>, rx_sm: UninitStateMachine<(PIO, SM)>, rx_program: &mut RxProgram<PIO>, baud: HertzU32, system_freq: HertzU32, ) -> Self

Create a new PioUartRx instance. Requires the RxProgram to be already installed (see install_rx_program).

§Arguments
  • rx_pin: The RX pin configured with FunctionPioX and PullUp. Use pin.gpioX.reconfigure().
  • sm: A PIO state machine instance.
  • rx_program: The installed Rx program.
  • baud: Desired baud rate.
  • system_freq: System frequency.
Source

pub fn enable(self) -> PioUartRx<PinID, PIO, SM, Running>

Enables the UART, transitioning it to the Running state.

§Returns

An instance of PioUartRx in the Running state.

Source

pub fn free( self, ) -> (UninitStateMachine<(PIO, SM)>, Pin<PinID, PIO::PinFunction, PullUp>)

Frees the underlying resources, returning the SM instance and the pin.

§Returns

A tuple containing the used SM and the RX pin.

Source§

impl<PinID: PinId, PIO: PIOExt, SM: StateMachineIndex> PioUartRx<PinID, PIO, SM, Running>

Source

pub fn read_raw(&mut self, buf: &mut [u8]) -> Result<usize, ()>

Reads raw data into a buffer.

§Arguments
  • buf: A mutable slice of u8 to store the read data.
§Returns

Ok(usize): Number of bytes read. Err(()): If an error occurs.

Source

pub fn stop(self) -> PioUartRx<PinID, PIO, SM, Stopped>

Stops the UART, transitioning it back to the Stopped state.

§Returns

An instance of PioUartRx in the Stopped state.

Trait Implementations§

Source§

impl<PinID: PinId, PIO: PIOExt, SM: StateMachineIndex> ErrorType for PioUartRx<PinID, PIO, SM, Running>

Source§

type Error = PioSerialError

Error type of all the IO operations on this type.
Source§

impl<PinID: PinId, PIO: PIOExt, SM: StateMachineIndex> Read for PioUartRx<PinID, PIO, SM, Running>

Source§

fn read(&mut self, buf: &mut [u8]) -> Result<usize, Self::Error>

Read some bytes from this source into the specified buffer, returning how many bytes were read. Read more
Source§

fn read_exact( &mut self, buf: &mut [u8], ) -> Result<(), ReadExactError<Self::Error>>

Read the exact number of bytes required to fill buf. Read more

Auto Trait Implementations§

§

impl<PinID, PIO, SM, State> Freeze for PioUartRx<PinID, PIO, SM, State>
where PinID: Freeze, <PIO as PIOExt>::PinFunction: Freeze,

§

impl<PinID, PIO, SM, State> !RefUnwindSafe for PioUartRx<PinID, PIO, SM, State>

§

impl<PinID, PIO, SM, State> Send for PioUartRx<PinID, PIO, SM, State>
where PinID: Send, <PIO as PIOExt>::PinFunction: Send,

§

impl<PinID, PIO, SM, State> !Sync for PioUartRx<PinID, PIO, SM, State>

§

impl<PinID, PIO, SM, State> Unpin for PioUartRx<PinID, PIO, SM, State>
where PinID: Unpin, <PIO as PIOExt>::PinFunction: Unpin, State: Unpin, PIO: Unpin, SM: Unpin,

§

impl<PinID, PIO, SM, State> !UnwindSafe for PioUartRx<PinID, PIO, SM, State>

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<Choices> CoproductSubsetter<CNil, HNil> for Choices

Source§

type Remainder = Choices

Source§

fn subset( self, ) -> Result<CNil, <Choices as CoproductSubsetter<CNil, HNil>>::Remainder>

Extract a subset of the possible types in a coproduct (or get the remaining possibilities) 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U, I> LiftInto<U, I> for T
where U: LiftFrom<T, I>,

Source§

fn lift_into(self) -> U

Performs the indexed conversion.
Source§

impl<Source> Sculptor<HNil, HNil> for Source

Source§

type Remainder = Source

Source§

fn sculpt(self) -> (HNil, <Source as Sculptor<HNil, HNil>>::Remainder)

Consumes the current HList and returns an HList with the requested shape. Read more
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.