Class SerialClass

ClassList > SerialClass

Inherits the following classes: HardwareSerial

Public Functions

Type	Name
	SerialClass (uint32_t port, pin_size_t rx=PIN_INVALID, pin_size_t tx=PIN_INVALID)
int	available ()
void	begin (unsigned long baudrate, uint16_t config, pin_size_t rx, pin_size_t tx)
void	begin (unsigned long baudrate, uint16_t config)
void	begin (unsigned long baudrate)
void	configure (unsigned long baudrate, uint16_t config)
void	configure (unsigned long baudrate)
void	end ()
void	flush ()
	operator bool ()
int	peek ()
int	read ()
bool	setPins (pin_size_t rx, pin_size_t tx)
size_t	write (uint8_t c)

Public Functions Documentation

function SerialClass

inline SerialClass::SerialClass (
    uint32_t port,
    pin_size_t rx=PIN_INVALID,
    pin_size_t tx=PIN_INVALID
) 

function available

int SerialClass::available () 

function begin [1/3]

void SerialClass::begin (
    unsigned long baudrate,
    uint16_t config,
    pin_size_t rx,
    pin_size_t tx
) 

function begin [2/3]

inline void SerialClass::begin (
    unsigned long baudrate,
    uint16_t config
) 

function begin [3/3]

inline void SerialClass::begin (
    unsigned long baudrate
) 

function configure [1/2]

void SerialClass::configure (
    unsigned long baudrate,
    uint16_t config
) 

function configure [2/2]

inline void SerialClass::configure (
    unsigned long baudrate
) 

function end

void SerialClass::end () 

function flush

void SerialClass::flush () 

function operator bool

inline SerialClass::operator bool () 

function peek

int SerialClass::peek () 

function read

int SerialClass::read () 

function setPins

bool SerialClass::setPins (
    pin_size_t rx,
    pin_size_t tx
) 

function write

size_t SerialClass::write (
    uint8_t c
) 

---

The documentation for this class was generated from the following file cores/common/arduino/libraries/api/Serial/Serial.h