Hosted::Serial Class Reference

#include <Serial.h>

Inheritance diagram for Hosted::Serial:

Collaboration diagram for Hosted::Serial:

Public Member Functions
	Serial (const String &ttyDevice)
	~Serial ()
bool	setDtr (bool on)
bool	setRts (bool on)
bool	begin (uint32_t baud=9600)
	Initialise the serial port. More...
size_t	write (uint8_t c) override
	Writes a single character to output stream. More...
int	available () override
int	read () override
size_t	readBytes (char *buffer, size_t length) override
	Read chars from stream into buffer. More...
size_t	write (const uint8_t *buffer, size_t size)
	Writes characters from a buffer to output stream. More...
int	peek () override
void	flush () override
Public Member Functions inherited from Stream
	Stream ()
void	setTimeout (unsigned long timeout)
	Set maximum milliseconds to wait for stream data, default is 1 second. More...
bool	find (const char *target)
	Read data from the stream until the target string is found. More...
bool	find (const char *target, size_t length)
	Read data from the stream until the target string of given length is found. More...
bool	findUntil (const char *target, const char *terminator)
	As find() but search ends if the terminator string is found. More...
bool	findUntil (const char *target, size_t targetLen, const char *terminate, size_t termLen)
	As findUntil(const char*, const char*) but search ends if the terminate string is found. More...
long	parseInt ()
	Returns the first valid (long) integer value from the current position. More...
float	parseFloat ()
	float version of parseInt More...
size_t	readBytes (uint8_t *buffer, size_t length)
size_t	readBytesUntil (char terminator, char *buffer, size_t length)
	As readBytes() with terminator character. More...
virtual String	readString (size_t maxLen)
	Like readBytes but place content into a String More...
String	readStringUntil (char terminator)
virtual int	indexOf (char c)
Public Member Functions inherited from Print
virtual	~Print ()
int	getWriteError ()
	Gets last error. More...
void	clearWriteError ()
	Clears the last write error. More...
size_t	write (const char *str)
	Writes a c-string to output stream. More...
size_t	write (const char *buffer, size_t size)
	Writes characters from a buffer to output stream. More...
size_t	print (char c)
	Prints a single character to output stream. More...
size_t	print (const char str[])
	Prints a c-string to output stream. More...
size_t	print (double num, int digits=2)
	Print a floating-point number to output stream. More...
template<typename T >
std::enable_if< has_printTo< T >::value, size_t >::type	print (const T &obj)
	Prints a Printable object to output stream. More...
size_t	print (const String &s)
	Prints a String to output stream. More...
template<typename E >
std::enable_if< std::is_enum< E >::value &&!std::is_convertible< E, int >::value, size_t >::type	print (E value)
	enums can be printed as strings provided they have a toString(E) implementation. More...
size_t	println ()
	Prints a newline to output stream. More...
template<typename... Args>
size_t	println (const Args &... args)
	Print value plus newline to output stream. More...
size_t	printf (const char *fmt,...)
	Prints a formatted c-string to output stream. More...
size_t	print (unsigned long num, uint8_t base=DEC)
template<typename... Args>
size_t	print (unsigned long num, Args... args)
template<typename... Args>
size_t	print (const unsigned long long &num, Args... args)
size_t	print (long num, uint8_t base=DEC)
template<typename... Args>
size_t	print (long num, Args... args)
template<typename... Args>
size_t	print (const long long &num, Args... args)
template<typename... Args>
size_t	print (unsigned int num, Args... args)
template<typename... Args>
size_t	print (unsigned char num, Args... args)
template<typename... Args>
size_t	print (int num, Args... args)

Additional Inherited Members
Protected Member Functions inherited from Stream
int	timedRead ()
int	timedPeek ()
int	peekNextDigit ()
	returns the next numeric digit in the stream or -1 if timeout More...
long	parseInt (char skipChar)
	Like regular parseInt() but the given skipChar is ignored. More...
float	parseFloat (char skipChar)
	Like parseInt(skipChar) for float. More...
Protected Member Functions inherited from Print
void	setWriteError (int err=1)
Protected Attributes inherited from Stream
uint16_t	receiveTimeout = 1000
	number of milliseconds to wait for the next char before aborting timed read More...

Constructor & Destructor Documentation

Serial()

Hosted::Serial::Serial ( const String &  ttyDevice )

inline

~Serial()

Hosted::Serial::~Serial ( )

inline

Member Function Documentation

available()

int Hosted::Serial::available ( )

inlineoverridevirtual

Implements Stream.

begin()

bool Hosted::Serial::begin ( uint32_t  baud = 9600 )

inline

Initialise the serial port.

Parameters

baud	BAUD rate of the serial port (Default: 9600)

flush()

void Hosted::Serial::flush ( )

inlineoverridevirtual

Implements Stream.

peek()

int Hosted::Serial::peek ( )

inlineoverridevirtual

Implements Stream.

read()

int Hosted::Serial::read ( )

inlineoverridevirtual

Implements Stream.

readBytes()

size_t Hosted::Serial::readBytes ( char *  buffer, size_t  length  )

inlineoverridevirtual

Read chars from stream into buffer.

Terminates if length characters have been read or timeout (see setTimeout). Returns the number of characters placed in the buffer (0 means no valid data found).

Note

Inherited classes may provide more efficient implementations without timeout.

Reimplemented from Stream.

setDtr()

bool Hosted::Serial::setDtr ( bool  on )

inline

setRts()

bool Hosted::Serial::setRts ( bool  on )

inline

write() [1/2]

size_t Hosted::Serial::write ( const uint8_t *  buffer, size_t  size  )

inlinevirtual

Writes characters from a buffer to output stream.

Parameters

buffer	Pointer to character buffer
size	Quantity of characters to write

Return values

size_t

Quantity of characters written to stream

Reimplemented from Print.

write() [2/2]

size_t Hosted::Serial::write ( uint8_t  c )

inlineoverridevirtual

Writes a single character to output stream.

Parameters

c	Character to write to output stream

Return values

size_t

Quantity of characters written to output stream

Implements Print.

---

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

• Components/Hosted/include/Hosted/Serial.h