Struct nrf52811_hal::Uarte

pub struct Uarte<T>(_);

Interface to a UARTE instance.

This is a very basic interface that comes with the following limitations:

• The UARTE instances share the same address space with instances of UART. You need to make sure that conflicting instances are disabled before using Uarte. See product specification:
  • nrf52832: Section 15.2
  • nrf52840: Section 6.1.2

Implementations

impl<T> Uarte<T> where
    T: Instance, 

pub fn new(
    uarte: T,
    pins: Pins,
    parity: PARITY_A,
    baudrate: BAUDRATE_A
) -> Uarte<T>

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

Write via UARTE.

This method uses transmits all bytes in tx_buffer.

The buffer must have a length of at most 255 bytes on the nRF52832 and at most 65535 bytes on the nRF52840.

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

Read via UARTE.

This method fills all bytes in rx_buffer, and blocks until the buffer is full.

The buffer must have a length of at most 255 bytes.

pub fn read_timeout<I>(
    &mut self,
    rx_buffer: &mut [u8],
    timer: &mut Timer<I, OneShot>,
    cycles: u32
) -> Result<(), Error> where
    I: Instance, 

Read via UARTE.

This method fills all bytes in rx_buffer, and blocks until the buffer is full or the timeout expires, whichever comes first.

If the timeout occurs, an Error::Timeout(n) will be returned, where n is the number of bytes read successfully.

This method assumes the interrupt for the given timer is NOT enabled, and in cases where a timeout does NOT occur, the timer will be left running until completion.

The buffer must have a length of at most 255 bytes.

pub fn free(self) -> (T, Pins)

Return the raw interface to the underlying UARTE peripheral.

pub fn split(
    self,
    tx_buf: &'static mut [u8],
    rx_buf: &'static mut [u8; 1]
) -> Result<(UarteTx<T>, UarteRx<T>), Error>

Split into implementations of embedded_hal::serial traits. The size of the tx_buf slice passed to this method will determine the size of the DMA transfers performed. The rx_buf slice is an array of size 1 since the embedded_hal traits only allow reading one byte at a time.

Trait Implementations

impl<T> Write for Uarte<T> where
    T: Instance, 

pub fn write_str(&mut self, s: &str) -> Result<(), Error>

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait.