Struct esp_idf_svc::hal::uart::UartRxDriver

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

Serial receiver

Implementations

impl<'d> UartRxDriver<'d>

pub fn new<UART>( uart: impl Peripheral<P = UART> + 'd, rx: impl Peripheral<P = impl InputPin> + 'd, cts: Option<impl Peripheral<P = impl InputPin> + 'd>, rts: Option<impl Peripheral<P = impl OutputPin> + 'd>, config: &Config, ) -> Result<UartRxDriver<'d>, EspError>

where UART: Uart,

Create a new serial receiver

pub fn event_queue(&self) -> Option<&Queue<UartEvent>>

Retrieves the event queue for this UART. Returns None if the config specified 0 for queue_size.

pub fn change_stop_bits( &self, stop_bits: StopBits, ) -> Result<&UartRxDriver<'d>, EspError>

Change the number of stop bits

pub fn stop_bits(&self) -> Result<StopBits, EspError>

Returns the current number of stop bits

pub fn change_data_bits( &self, data_bits: DataBits, ) -> Result<&UartRxDriver<'d>, EspError>

Change the number of data bits

pub fn data_bits(&self) -> Result<DataBits, EspError>

Return the current number of data bits

pub fn change_parity( &self, parity: Parity, ) -> Result<&UartRxDriver<'d>, EspError>

Change the type of parity checking

pub fn parity(&self) -> Result<Parity, EspError>

Returns the current type of parity checking

pub fn change_baudrate<T>( &self, baudrate: T, ) -> Result<&UartRxDriver<'d>, EspError>

where T: Into<Hertz> + Copy,

Change the baudrate.

Will automatically select the clock source. When possible the reference clock (1MHz) will be used, because this is constant when the clock source/frequency changes. However if one of the clock frequencies is below 10MHz or if the baudrate is above the reference clock or if the baudrate cannot be set within 1.5% then use the APB clock.

pub fn baudrate(&self) -> Result<Hertz, EspError>

Returns the current baudrate

pub fn read(&self, buf: &mut [u8], delay: u32) -> Result<usize, EspError>

Read multiple bytes into a slice; block until specified timeout

pub fn flush(&self) -> Result<(), EspError>

👎Deprecated since 0.41.3: Use UartRxDriver::clear instead

Clears the receive buffer.

pub fn clear(&self) -> Result<(), EspError>

pub fn port(&self) -> u32

pub fn count(&self) -> Result<usize, EspError>

Get count of remaining bytes in the receive ring buffer

Trait Implementations

impl<'d> Drop for UartRxDriver<'d>

fn drop(&mut self)

Executes the destructor for this type.

impl<'d> ErrorType for UartRxDriver<'d>

type Error = SerialError

Error type

impl<'d> ErrorType for UartRxDriver<'d>

type Error = EspIOError

Error type of all the IO operations on this type.

impl<'d> Read<u8> for UartRxDriver<'d>

type Error = SerialError

Read error

fn read(&mut self) -> Result<u8, Error<<UartRxDriver<'d> as Read<u8>>::Error>>

Reads a single word from the serial interface

impl<'d> Read for UartRxDriver<'d>

fn read(&mut self) -> Result<u8, Error<<UartRxDriver<'d> as ErrorType>::Error>>

Reads a single word from the serial interface

impl<'d> Read for UartRxDriver<'d>

fn read( &mut self, buf: &mut [u8], ) -> Result<usize, <UartRxDriver<'d> as ErrorType>::Error>

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

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

Read the exact number of bytes required to fill buf.