arduino::FileStream Class Reference

We use the FileStream class to be able to provide Serail, Serial1 and Serial2 outside of the Arduino environment;. More...

#include <FileStream.h>

Inheritance diagram for arduino::FileStream:

Public Member Functions
	FileStream (const char *outDevice="/dev/stdout", const char *inDevice="/dev/stdin")
virtual int	available ()
virtual void	begin (int speed)
virtual void	flush ()
void	open (const char *outDevice, const char *inDevice)
virtual int	peek ()
virtual void	print (const char *str)
virtual void	print (int str)
virtual void	println (const char *str="")
virtual void	println (int str)
virtual int	read ()
virtual void	write (const char *str, int len)
virtual size_t	write (int32_t value)
virtual void	write (uint8_t *str, int len)
virtual size_t	write (uint8_t value)
Public Member Functions inherited from arduino::Stream
bool	find (char target)
bool	find (const char *target)
bool	find (const char *target, size_t length)
bool	find (const uint8_t *target)
bool	find (const uint8_t *target, size_t length)
bool	findUntil (const char *target, const char *terminator)
bool	findUntil (const char *target, size_t targetLen, const char *terminate, size_t termLen)
bool	findUntil (const uint8_t *target, const char *terminator)
bool	findUntil (const uint8_t *target, size_t targetLen, const char *terminate, size_t termLen)
unsigned long	getTimeout (void)
float	parseFloat (LookaheadMode lookahead=SKIP_ALL, char ignore=NO_IGNORE_CHAR)
long	parseInt (LookaheadMode lookahead=SKIP_ALL, char ignore=NO_IGNORE_CHAR)
size_t	readBytes (char *buffer, size_t length)
size_t	readBytes (uint8_t *buffer, size_t length)
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)
void	setTimeout (unsigned long timeout)
Public Member Functions inherited from arduino::Print
virtual int	availableForWrite ()
void	clearWriteError ()
int	getWriteError ()
size_t	print (char)
size_t	print (const __FlashStringHelper *)
size_t	print (const char[])
size_t	print (const Printable &)
size_t	print (const String &)
size_t	print (double, int=2)
size_t	print (int, int=DEC)
size_t	print (long long, int=DEC)
size_t	print (long, int=DEC)
size_t	print (unsigned char, int=DEC)
size_t	print (unsigned int, int=DEC)
size_t	print (unsigned long long, int=DEC)
size_t	print (unsigned long, int=DEC)
size_t	println (char)
size_t	println (const __FlashStringHelper *)
size_t	println (const char[])
size_t	println (const Printable &)
size_t	println (const String &s)
size_t	println (double, int=2)
size_t	println (int, int=DEC)
size_t	println (long long, int=DEC)
size_t	println (long, int=DEC)
size_t	println (unsigned char, int=DEC)
size_t	println (unsigned int, int=DEC)
size_t	println (unsigned long long, int=DEC)
size_t	println (unsigned long, int=DEC)
size_t	println (void)
size_t	write (const char *buffer, size_t size)
size_t	write (const char *str)
virtual size_t	write (const uint8_t *buffer, size_t size)

Protected Attributes
std::fstream	in
std::fstream	out
Protected Attributes inherited from arduino::Stream
unsigned long	_startMillis
unsigned long	_timeout

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

Detailed Description

We use the FileStream class to be able to provide Serail, Serial1 and Serial2 outside of the Arduino environment;.

Member Function Documentation

available()

virtual int arduino::FileStream::available ( void  )

inlinevirtual

Implements arduino::Stream.

flush()

virtual void arduino::FileStream::flush ( void  )

inlinevirtual

Reimplemented from arduino::Print.

peek()

virtual int arduino::FileStream::peek ( void  )

inlinevirtual

Implements arduino::Stream.

read()

virtual int arduino::FileStream::read ( void  )

inlinevirtual

Implements arduino::Stream.

write()

virtual size_t arduino::FileStream::write ( uint8_t  value )

inlinevirtual

Implements arduino::Print.

---

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

• ArduinoCore-Linux/cores/arduino/FileStream.h