HardwareSerial.h File Reference

This file contains class with methods to handle UART, USART and LPUART periphery. More...

#include "wirish.h"
#include <inttypes.h>
#include "Stream.h"

Include dependency graph for HardwareSerial.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	HardwareSerial
	This class is for handling UART periphery. More...

Macros
#define	YIELD
#define	HS_RX_BUF_SIZE   128
	Rx buffer size. More...
#define	IS_LPUART_INSTANCE(instance)   (true)

Typedefs
typedef UART_InitTypeDef	SerialConfig
	HAL library configuration structure. More...
typedef UART_AdvFeatureInitTypeDef	AdvSerialConfig
	HAL library advanced configuration structure. More...

Enumerations
enum	SerialMode { SERIAL_FULL = UART_MODE_TX_RX, SERIAL_RX_ONLY = UART_MODE_RX, SERIAL_TX_ONLY = UART_MODE_TX }
	Enumeration of 3 UART direction modes. More...

Functions
void	HS_UART_AbortReceive_IT (UART_HandleTypeDef *huart)
	Copied from HAL UART library. More...

Detailed Description

This file contains class with methods to handle UART, USART and LPUART periphery.

Credits

Author

Patrik Cepko and Matej Fitoš

Date

Nov 27, 2021

See also

HardwareSerial

Stream

Print

SerialMode

SerialConfig

SSerialConfig

AdvSerialConfig

Credits

Author

Patrik Cepko and Matej Fitoš

Date

Jan 29, 2021

See also

HardwareSerial

Stream

Print

SerialMode

SerialConfig

SSerialConfig

AdvSerialConfig

Macro Definition Documentation

YIELD

#define YIELD

HS_RX_BUF_SIZE

#define HS_RX_BUF_SIZE   128

Rx buffer size.

IS_LPUART_INSTANCE

#define IS_LPUART_INSTANCE

(

instance

)

(true)

Typedef Documentation

SerialConfig

typedef UART_InitTypeDef SerialConfig

HAL library configuration structure.

AdvSerialConfig

typedef UART_AdvFeatureInitTypeDef AdvSerialConfig

HAL library advanced configuration structure.

Note

Advanced serial configuration are not available on STM32F1xx MCUs.

Enumeration Type Documentation

SerialMode

enum SerialMode

Enumeration of 3 UART direction modes.

See also

HardwareSerial

Enumerator
SERIAL_FULL	Transmitting and receiving mode
SERIAL_RX_ONLY	Only receiving mode
SERIAL_TX_ONLY	Only transmitting mode

Function Documentation

HS_UART_AbortReceive_IT()

void HS_UART_AbortReceive_IT

(

UART_HandleTypeDef *

huart

)

Copied from HAL UART library.