Serial.h File Reference

Hardware serial (Uart class) and the SerialN / SerialLPN instances. More...

#include <inttypes.h>
#include "api/Common.h"
#include "HardwareSerial.h"
#include "Stream.h"
#include "uart.h"

Classes
class	Uart
	STM32 hardware UART. More...

Macros
#define	SERIAL_TX_BUFFER_SIZE   64
	Size in bytes of the transmit ring buffer.
#define	SERIAL_RX_BUFFER_SIZE   64
	Size in bytes of the receive ring buffer.

Typedefs
typedef uint8_t	tx_buffer_index_t
	Index type of the transmit buffer, 8 bits when the buffer is at most 256 bytes.
typedef uint8_t	rx_buffer_index_t
	Index type of the receive buffer, 8 bits when the buffer is at most 256 bytes.

Enumerations
enum	HalfDuplexMode_t { HALF_DUPLEX_DISABLED , HALF_DUPLEX_ENABLED }
	Half-duplex mode selection of the Uart(void *, HalfDuplexMode_t) constructor. More...

Detailed Description

Hardware serial (Uart class) and the SerialN / SerialLPN instances.

Macro Definition Documentation

SERIAL_RX_BUFFER_SIZE

#define SERIAL_RX_BUFFER_SIZE   64

Size in bytes of the receive ring buffer.

Can be defined before including this file.

SERIAL_TX_BUFFER_SIZE

#define SERIAL_TX_BUFFER_SIZE   64

Size in bytes of the transmit ring buffer.

Can be defined before including this file.

Enumeration Type Documentation

HalfDuplexMode_t

enum HalfDuplexMode_t

Half-duplex mode selection of the Uart(void *, HalfDuplexMode_t) constructor.

Enumerator
HALF_DUPLEX_DISABLED	Full-duplex, RX and TX pins are used.
HALF_DUPLEX_ENABLED	Half-duplex, only the TX pin is used.