HardwareSerial Class Reference

Inheritance diagram for HardwareSerial:

Public Member Functions
	HardwareSerial (uint32_t _rx, uint32_t _tx, uint32_t _rts=NUM_DIGITAL_PINS, uint32_t _cts=NUM_DIGITAL_PINS)
	HardwareSerial (PinName _rx, PinName _tx, PinName _rts=NC, PinName _cts=NC)
	HardwareSerial (void *peripheral, HalfDuplexMode_t halfDuplex=HALF_DUPLEX_DISABLED)
	HardwareSerial (uint32_t _rxtx)
	HardwareSerial (PinName _rxtx)
void	begin (unsigned long baud)
void	begin (unsigned long, uint8_t)
void	end ()
virtual int	available (void)
virtual int	peek (void)
virtual int	read (void)
int	availableForWrite (void)
virtual void	flush ()
void	flush (uint32_t timeout)
virtual size_t	write (uint8_t)
size_t	write (unsigned long n)
size_t	write (long n)
size_t	write (unsigned int n)
size_t	write (int n)
size_t	write (const uint8_t *buffer, size_t size)
	operator bool ()
void	setRx (uint32_t _rx)
void	setTx (uint32_t _tx)
void	setRx (PinName _rx)
void	setTx (PinName _tx)
void	setRts (uint32_t _rts)
void	setCts (uint32_t _cts)
void	setRtsCts (uint32_t _rts, uint32_t _cts)
void	setRts (PinName _rts)
void	setCts (PinName _cts)
void	setRtsCts (PinName _rts, PinName _cts)
void	setHalfDuplex (void)
bool	isHalfDuplex (void) const
void	enableHalfDuplexRx (void)
size_t	write (const char *str)
size_t	write (const char *buffer, size_t size)
Public Member Functions inherited from Stream
void	setTimeout (unsigned long timeout)
unsigned long	getTimeout (void)
bool	find (const char *target)
bool	find (const uint8_t *target)
bool	find (const char *target, size_t length)
bool	find (const uint8_t *target, size_t length)
bool	find (char target)
bool	findUntil (const char *target, const char *terminator)
bool	findUntil (const uint8_t *target, const char *terminator)
bool	findUntil (const char *target, size_t targetLen, const char *terminate, size_t termLen)
bool	findUntil (const uint8_t *target, size_t targetLen, const char *terminate, size_t termLen)
long	parseInt (LookaheadMode lookahead=SKIP_ALL, char ignore=NO_IGNORE_CHAR)
float	parseFloat (LookaheadMode lookahead=SKIP_ALL, char ignore=NO_IGNORE_CHAR)
virtual size_t	readBytes (char *buffer, size_t length)
size_t	readBytes (uint8_t *buffer, size_t length)
virtual size_t	readBytesUntil (char terminator, char *buffer, size_t length)
size_t	readBytesUntil (char terminator, uint8_t *buffer, size_t length)
String	readString ()
String	readStringUntil (char terminator)
Public Member Functions inherited from Print
int	getWriteError ()
void	clearWriteError ()
size_t	write (const char *str)
size_t	write (const char *buffer, size_t size)
size_t	print (const __FlashStringHelper *)
size_t	print (const String &)
size_t	print (const char[])
size_t	print (char)
size_t	print (unsigned char, int=DEC)
size_t	print (int, int=DEC)
size_t	print (unsigned int, int=DEC)
size_t	print (long, int=DEC)
size_t	print (unsigned long, int=DEC)
size_t	print (long long, int=DEC)
size_t	print (unsigned long long, int=DEC)
size_t	print (float, int=2)
size_t	print (double, int=2)
size_t	print (const Printable &)
size_t	println (const __FlashStringHelper *)
size_t	println (const String &s)
size_t	println (const char[])
size_t	println (char)
size_t	println (unsigned char, int=DEC)
size_t	println (int, int=DEC)
size_t	println (unsigned int, int=DEC)
size_t	println (long, int=DEC)
size_t	println (unsigned long, int=DEC)
size_t	println (long long, int=DEC)
size_t	println (unsigned long long, int=DEC)
size_t	println (float, int=2)
size_t	println (double, int=2)
size_t	println (const Printable &)
size_t	println (void)
int	printf (const char *format,...)
int	printf (const __FlashStringHelper *format,...)
int	vprintf (const __FlashStringHelper *format, va_list ap)
int	vprintf (const char *format, va_list ap)

Static Public Member Functions
static void	_rx_complete_irq (serial_t *obj)
static int	_tx_complete_irq (serial_t *obj)

Protected Attributes
bool	_written
unsigned char	_rx_buffer [SERIAL_RX_BUFFER_SIZE]
unsigned char	_tx_buffer [SERIAL_TX_BUFFER_SIZE]
serial_t	_serial
Protected Attributes inherited from Stream
unsigned long	_timeout
unsigned long	_startMillis

Additional Inherited Members
Protected Member Functions inherited from Stream
int	timedRead ()
int	timedPeek ()
int	peekNextDigit (LookaheadMode lookahead, bool detectDecimal)
long	parseInt (char ignore)
float	parseFloat (char ignore)
int	findMulti (struct MultiTarget *targets, int tCount)
Protected Member Functions inherited from Print
void	setWriteError (int err=1)

Member Function Documentation

available()

virtual int HardwareSerial::available ( void )

virtual

Implements Stream.

availableForWrite()

int HardwareSerial::availableForWrite ( void )

virtual

Reimplemented from Print.

flush()

virtual void HardwareSerial::flush ( )

virtual

Reimplemented from Print.

peek()

virtual int HardwareSerial::peek ( void )

virtual

Implements Stream.

read()

virtual int HardwareSerial::read ( void )

virtual

Implements Stream.

write() [1/2]

size_t HardwareSerial::write ( const uint8_t * buffer, size_t size )

virtual

Reimplemented from Print.

write() [2/2]

virtual size_t HardwareSerial::write ( uint8_t )

virtual

Implements Print.

---

The documentation for this class was generated from the following file:

• /Users/yhchoi/Documents/CSWCSS/4-6-subj/REC/training/lib_packs/JM9_XRCU_Board/stm32/cores/arduino/HardwareSerial.h