Struct embassy_nrf::uarte::Uarte

pub struct Uarte<'d, T: Instance> { /* private fields */ }

UARTE driver.

Implementations

impl<'d, T: Instance> Uarte<'d, T>

pub fn new(
uarte: impl Peripheral<P = T> + 'd,
_irq: impl Binding<T::Interrupt, InterruptHandler<T>> + 'd,
rxd: impl Peripheral<P = impl GpioPin> + 'd,
txd: impl Peripheral<P = impl GpioPin> + 'd,
config: Config
) -> Self

Create a new UARTE without hardware flow control

pub fn new_with_rtscts(
uarte: impl Peripheral<P = T> + 'd,
_irq: impl Binding<T::Interrupt, InterruptHandler<T>> + 'd,
rxd: impl Peripheral<P = impl GpioPin> + 'd,
txd: impl Peripheral<P = impl GpioPin> + 'd,
cts: impl Peripheral<P = impl GpioPin> + 'd,
rts: impl Peripheral<P = impl GpioPin> + 'd,
config: Config
) -> Self

Create a new UARTE with hardware flow control (RTS/CTS)

pub fn split(self) -> (UarteTx<'d, T>, UarteRx<'d, T>)

Split the Uarte into the transmitter and receiver parts.

This is useful to concurrently transmit and receive from independent tasks.

pub fn split_with_idle<U: TimerInstance>(
self,
timer: impl Peripheral<P = U> + 'd,
ppi_ch1: impl Peripheral<P = impl ConfigurableChannel + 'd> + 'd,
ppi_ch2: impl Peripheral<P = impl ConfigurableChannel + 'd> + 'd
) -> (UarteTx<'d, T>, UarteRxWithIdle<'d, T, U>)

Split the Uarte into the transmitter and receiver with idle support parts.

This is useful to concurrently transmit and receive from independent tasks.

pub fn event_endtx(&self) -> Event

Return the endtx event for use with PPI

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

Read bytes until the buffer is filled.

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

Write all bytes in the buffer.

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

Same as write but will fail instead of copying data into RAM. Consult the module level documentation to learn more.

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

Read bytes until the buffer is filled.

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

Write all bytes in the buffer.

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

Same as blocking_write but will fail instead of copying data into RAM. Consult the module level documentation to learn more.

Trait Implementations

impl<'d, T: Instance> ErrorType for Uarte<'d, T>

type Error = Error

Error type

impl<'d, T: Instance> Write<u8> for Uarte<'d, T>

type Error = Error

The type of error that can occur when writing

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

Writes a slice, blocking until everything has been written

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

Block until the serial interface has sent all buffered words

impl<'d, T: Instance> Write<u8> for Uarte<'d, T>

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

Writes a slice, blocking until everything has been written

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

Block until the serial interface has sent all buffered words