Struct stm32_hal2::serial::Serial

pub struct Serial<USART> { /* fields omitted */ }

Serial abstraction

Implementations

impl Serial<USART1>

pub fn new_usart1<C: ClockCfg>(
    usart: USART1,
    config: Config,
    clocks: &C,
    rcc: &mut RCC
) -> Self

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

Frees the USART peripheral

impl Serial<USART2>

pub fn new_usart2<C: ClockCfg>(
    usart: USART2,
    config: Config,
    clocks: &C,
    rcc: &mut RCC
) -> Self

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

Frees the USART peripheral

Trait Implementations

impl Read<u8> for Serial<USART1>

type Error = Error

Read error

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

Reads a single word from the serial interface

impl Read<u8> for Serial<USART2>

type Error = Error

Read error

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

Reads a single word from the serial interface

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

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

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

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

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

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

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

impl Write<u8> for Serial<USART1>

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 Write<u8> for Serial<USART2>

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