Struct esp32c3_hal::Serial

pub struct Serial<T> { /* private fields */ }

UART driver

Implementations

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

pub fn new_with_config<P>(
    uart: T,
    config: Option<Config>,
    pins: Option<P>,
    clocks: &Clocks
) -> Serial<T>where
    P: UartPins,

Create a new UART instance with defaults

pub fn new(uart: T) -> Serial<T>

Create a new UART instance with defaults

pub fn free(self) -> T

Return the raw interface to the underlying UART instance

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

Writes bytes

pub fn set_at_cmd(&mut self, config: AtCmdConfig)

Configures the AT-CMD detection settings.

pub fn set_rx_fifo_full_threshold(&mut self, threshold: u16)

Configures the RX-FIFO threshold

pub fn listen_at_cmd(&mut self)

Listen for AT-CMD interrupts

pub fn unlisten_at_cmd(&mut self)

Stop listening for AT-CMD interrupts

pub fn listen_tx_done(&mut self)

Listen for TX-DONE interrupts

pub fn unlisten_tx_done(&mut self)

Stop listening for TX-DONE interrupts

pub fn listen_rx_fifo_full(&mut self)

Listen for RX-FIFO-FULL interrupts

pub fn unlisten_rx_fifo_full(&mut self)

Stop listening for RX-FIFO-FULL interrupts

pub fn at_cmd_interrupt_set(&self) -> bool

Checks if AT-CMD interrupt is set

pub fn tx_done_interrupt_set(&self) -> bool

Checks if TX-DONE interrupt is set

pub fn rx_fifo_full_interrupt_set(&self) -> bool

Checks if RX-FIFO-FULL interrupt is set

pub fn reset_at_cmd_interrupt(&self)

Reset AT-CMD interrupt

pub fn reset_tx_done_interrupt(&self)

Reset TX-DONE interrupt

pub fn reset_rx_fifo_full_interrupt(&self)

Reset RX-FIFO-FULL interrupt

pub fn change_stop_bits(&mut self, stop_bits: StopBits) -> &mut Serial<T>

Change the number of stop bits

Trait Implementations

impl<T> Read<u8> for Serial<T>where
    T: Instance,

type Error = Error

Read error

fn read(&mut self) -> Result<u8, Error<<Serial<T> as Read<u8>>::Error>>

Reads a single word from the serial interface

impl<T> Write<u8> for Serial<T>where
    T: Instance,

type Error = Error

Write error

fn write(
    &mut self,
    word: u8
) -> Result<(), Error<<Serial<T> as Write<u8>>::Error>>

Writes a single word to the serial interface

fn flush(&mut self) -> Result<(), Error<<Serial<T> as Write<u8>>::Error>>

Ensures that none of the previously written words are still buffered

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

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.