Struct esp32_hal::serial::Serial

pub struct Serial<UART: Instance, TX: OutputPin, RX: InputPin, CTS: InputPin = Gpio19<Input<Floating>>, RTS: OutputPin = Gpio22<Output<PushPull>>> { /* fields omitted */ }

Serial abstraction

Implementations

impl<UART: Instance, TX: OutputPin, RX: InputPin, CTS: InputPin, RTS: OutputPin> Serial<UART, TX, RX, CTS, RTS>

pub fn new(
    uart: UART,
    pins: Pins<TX, RX, CTS, RTS>,
    config: Config,
    clock_control: ClockControlConfig
) -> Result<Self, Error>

Create a new serial driver

pub fn change_stop_bits(&mut self, stop_bits: StopBits) -> &mut Self

Change the number of stop bits

pub fn change_data_bits(&mut self, data_bits: DataBits) -> &mut Self

Change the number of data bits

pub fn change_parity(&mut self, parity: Parity) -> &mut Self

Change the type of parity checking

pub fn change_baudrate<T: Into<Hertz> + Copy>(
    &mut self,
    baudrate: T
) -> Result<&mut Self, Error>

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 change_baudrate_force_clock<T: Into<Hertz> + Copy>(
    &mut self,
    baudrate: T,
    use_apb_frequency: bool
) -> Result<&mut Self, Error>

Change the baudrate choosing the reference or APB clock manually

pub fn is_clock_apb(&self) -> bool

Returns if the reference or APB clock is used

pub fn baudrate(&self) -> Hertz

Returns the current baudrate

pub fn listen(&mut self, _event: Event)

Starts listening for an interrupt event

pub fn unlisten(&mut self, _event: Event)

Stop listening for an interrupt event

pub fn is_rx_idle(&self) -> bool

Return true if the receiver is idle

pub fn is_tx_idle(&self) -> bool

Return true if the transmitter is idle

pub fn split(self) -> (Tx<UART>, Rx<UART>)

Split the serial driver in separate TX and RX drivers

pub fn release(self) -> (UART, Pins<TX, RX, CTS, RTS>)

Release the UART and GPIO resources

pub fn reset_rx_fifo(&mut self)

pub fn reset_tx_fifo(&self)

Trait Implementations

impl<UART: Instance, TX: OutputPin, RX: InputPin, CTS: InputPin, RTS: OutputPin> Read<u8> for Serial<UART, TX, RX, CTS, RTS>

type Error = Infallible

Read error

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

Reads a single word from the serial interface

impl<UART: Instance, TX: OutputPin, RX: InputPin, CTS: InputPin, RTS: OutputPin> Write<u8> for Serial<UART, TX, RX, CTS, RTS>

type Error = Infallible

Write error

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

Ensures that none of the previously written words are still buffered

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

Writes a single word to the serial interface

impl<UART: Instance, TX: OutputPin, RX: InputPin, CTS: InputPin, RTS: OutputPin> Write for Serial<UART, TX, RX, CTS, RTS>

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

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.