Struct Uart

pub struct Uart<'d, M: Mode> { /* private fields */ }

Bidirectional UART Driver, which acts as a combination of UartTx and UartRx.

Notes on embedded_io::Read

embedded_io::Read requires guarantees that the base UartRx cannot provide.

See UartRx for more details, and see BufferedUart and [RingBufferedUartRx] as alternatives that do provide the necessary guarantees for embedded_io::Read.

Implementations

impl<'d> Uart<'d, Blocking>

pub fn new_blocking<T: Instance>( peri: Peri<'d, T>, rx: Peri<'d, impl RxPin<T>>, tx: Peri<'d, impl TxPin<T>>, config: Config, ) -> Result<Self, ConfigError>

Create a new blocking bidirectional UART.

pub fn new_blocking_with_rtscts<T: Instance>( peri: Peri<'d, T>, rx: Peri<'d, impl RxPin<T>>, tx: Peri<'d, impl TxPin<T>>, rts: Peri<'d, impl RtsPin<T>>, cts: Peri<'d, impl CtsPin<T>>, config: Config, ) -> Result<Self, ConfigError>

Create a new bidirectional UART with request-to-send and clear-to-send pins

impl<'d, M: Mode> Uart<'d, M>

pub fn blocking_write(&mut self, buffer: &[u8]) -> Result<(), Error>

Perform a blocking write

pub fn blocking_flush(&mut self) -> Result<(), Error>

Block until transmission complete

pub fn busy(&self) -> bool

Check if UART is busy.

pub fn blocking_read(&mut self, buffer: &mut [u8]) -> Result<(), Error>

Perform a blocking read into buffer

pub fn split(self) -> (UartTx<'d, M>, UartRx<'d, M>)

Split the Uart into a transmitter and receiver, which is particularly useful when having two tasks correlating to transmitting and receiving.

pub fn split_ref(&mut self) -> (&mut UartTx<'d, M>, &mut UartRx<'d, M>)

Split the Uart into a transmitter and receiver by mutable reference, which is particularly useful when having two tasks correlating to transmitting and receiving.

pub fn set_config(&mut self, config: &Config) -> Result<(), ConfigError>

Reconfigure the driver

pub fn send_break(&self)

Send break character

pub fn set_baudrate(&self, baudrate: u32) -> Result<(), ConfigError>

Set baudrate

Trait Implementations

impl<'d, M: Mode> SetConfig for Uart<'d, M>

type Config = Config

The configuration type used by this driver.

type ConfigError = ConfigError

The error type that can occur if set_config fails.

fn set_config(&mut self, config: &Self::Config) -> Result<(), Self::ConfigError>

Set the configuration of the driver.