Struct stm32l4xx_hal::serial::Serial

pub struct Serial<USART, PINS> { /* private fields */ }

Serial abstraction

Implementations

impl<PINS> Serial<USART1, PINS>

pub fn usart1(
    usart: USART1,
    pins: PINS,
    config: impl Into<Config>,
    clocks: Clocks,
    apb: &mut <USART1 as RccBus>::Bus
) -> Self where
    PINS: Pins<USART1>, 

Configures the serial interface and creates the interface struct.

Config is a config struct that configures baud rate, stop bits and parity.

Clocks passes information about the current frequencies of the clocks. The existence of the struct ensures that the clock settings are fixed.

The serial struct takes ownership over the USARTX device registers and the specified PINS

MAPR and APBX are register handles which are passed for configuration. (MAPR is used to map the USART to the corresponding pins. APBX is used to reset the USART.)

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

Starts listening for an interrupt event

pub fn check_for_error() -> Result<(), Error>

Check for, and return, any errors

See Rx::check_for_error.

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

Stops listening for an interrupt event

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

Splits the Serial abstraction into a transmitter and a receiver half

pub fn release(self) -> (USART1, PINS)

Frees the USART peripheral

impl<PINS> Serial<USART2, PINS>

pub fn usart2(
    usart: USART2,
    pins: PINS,
    config: impl Into<Config>,
    clocks: Clocks,
    apb: &mut <USART2 as RccBus>::Bus
) -> Self where
    PINS: Pins<USART2>, 

Configures the serial interface and creates the interface struct.

Config is a config struct that configures baud rate, stop bits and parity.

Clocks passes information about the current frequencies of the clocks. The existence of the struct ensures that the clock settings are fixed.

The serial struct takes ownership over the USARTX device registers and the specified PINS

MAPR and APBX are register handles which are passed for configuration. (MAPR is used to map the USART to the corresponding pins. APBX is used to reset the USART.)

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

Starts listening for an interrupt event

pub fn check_for_error() -> Result<(), Error>

Check for, and return, any errors

See Rx::check_for_error.

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

Stops listening for an interrupt event

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

Splits the Serial abstraction into a transmitter and a receiver half

pub fn release(self) -> (USART2, PINS)

Frees the USART peripheral

Trait Implementations

impl<PINS> Read<u8> for Serial<USART1, PINS>

type Error = Error

Read error

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

Reads a single word from the serial interface

impl<PINS> Read<u8> for Serial<USART2, PINS>

type Error = Error

Read error

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

Reads a single word from the serial interface

impl<USART, PINS> Write for Serial<USART, PINS> where
    Serial<USART, PINS>: Write<u8>, 

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.

impl<PINS> Write<u8> for Serial<USART1, PINS>

type Error = Error

Write error

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

Ensures that none of the previously written words are still buffered

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

Writes a single word to the serial interface

impl<PINS> Write<u8> for Serial<USART2, PINS>

type Error = Error

Write error

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

Ensures that none of the previously written words are still buffered

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

Writes a single word to the serial interface