SerialBufferRK
Public Member Functions
SerialBuffer< SIZE > Class Template Reference

Buffered serial class. More...

#include <SerialBufferRK.h>

Inheritance diagram for SerialBuffer< SIZE >:
SerialBufferBase Stream Print

Public Member Functions

 SerialBuffer (USARTSerial &port)
 Constructs a SerialBuffer object. More...
 
- Public Member Functions inherited from SerialBufferBase
 SerialBufferBase (uint8_t *buf, size_t bufSize, USARTSerial &port)
 Constructs a SerialBufferBase object. You normally will use SerialBuffer instead. More...
 
virtual int available ()
 Returns the number of bytes available to read from the serial port. More...
 
virtual int availableForWrite ()
 Returns the number of bytes available to write into the TX FIFO. More...
 
virtual int read ()
 Read a single byte from the serial port. More...
 
virtual int peek ()
 Read a single byte from the serial port, but do not remove it so it can be read again. More...
 
void readClear ()
 Clear the read buffer.
 
virtual void flush ()
 Block until all serial data is sent. More...
 
virtual size_t write (uint8_t c)
 Write a single byte to the serial port. More...
 
- Public Member Functions inherited from Stream
void setTimeout (system_tick_t timeout)
 Sets the read timeout (default: 1000 milliseconds) More...
 
bool find (char *target)
 Reads data from the stream until the target string is found. More...
 
bool find (char *target, size_t length)
 Reads data from the stream until the target string is found. More...
 
bool findUntil (char *target, char *terminator)
 Reads data from the stream until the target string is found or the terminator string is found. More...
 
bool findUntil (char *target, size_t targetLen, char *terminate, size_t termLen)
 Reads data from the stream until the target string is found or the terminator string is found. More...
 
long parseInt ()
 returns the first valid (long) integer value from the current position More...
 
float parseFloat ()
 returns the first valid float value from the current position More...
 
size_t readBytes (char *buffer, size_t length)
 Read chars from stream into buffer. More...
 
size_t readBytesUntil (char terminator, char *buffer, size_t length)
 Read chars from stream into buffer until the character terminator is found. More...
 
String readString ()
 Reads the remainder of the file into a string.
 
String readStringUntil (char terminator)
 Reads the remainder of the file into a string or until terminator is found. More...
 
- Public Member Functions inherited from Print
int getWriteError ()
 Return the last error code. 0 means no error.
 
void clearWriteError ()
 Clear the last error code to 0.
 
size_t write (const char *str)
 Write a null-terminated c-string the stream or file. More...
 
virtual size_t write (const uint8_t *buffer, size_t size)
 Write a bytes specified by a buffer and length to the stream or file. More...
 
size_t print (const char[])
 Print a null-terminated array of char variables (a c-string) to the stream or file.
 
size_t print (char)
 Print a single character to the stream or file.
 
size_t print (unsigned char value, int base=DEC)
 Print an unsigned char (byte value, 8 bits) in the specified base to the stream or file. More...
 
size_t print (int value, int base=DEC)
 Print an int (32 bit integer) the specified base to the stream or file. More...
 
size_t print (unsigned int value, int base=DEC)
 Print an unsigned int (32 bit unsigned integer) the specified base to the stream or file. More...
 
size_t print (long value, int base=DEC)
 Print a long (32 bit integer) the specified base to the stream or file. More...
 
size_t print (unsigned long value, int base=DEC)
 Print a unsigned long (32 bit unsigned integer) the specified base to the stream or file. More...
 
size_t print (double value, int dec=2)
 Print a double floating point value to the stream or file. More...
 
size_t print (const Printable &)
 Print an object derived from Printable to the stream or file.
 
size_t println (const char[])
 Print a null-terminated array of char variables (a c-string) plus a CRLF end-of-line terminator to the stream or file.
 
size_t println (char value)
 Print a single character plus a CRLF end-of-line terminator to the stream or file.
 
size_t println (unsigned char value, int base=DEC)
 Print an unsigned char (byte value. 8 bits) in the specified base plus a CRLF end-of-line terminator to the stream or file. More...
 
size_t println (int value, int base=DEC)
 Print an int (32 bit integer) the specified base to plus a CRLF end-of-line terminator the stream or file. More...
 
size_t println (unsigned int value, int base=DEC)
 Print an unsigned int (32 bit unsigned integer) the specified base plus a CRLF end-of-line terminator to the stream or file. More...
 
size_t println (long value, int base=DEC)
 Print a long (32 bit signed integer) the specified base plus a CRLF end-of-line terminator to the stream or file. More...
 
size_t println (unsigned long value, int base=DEC)
 Print a unsigned long (32 bit unsigned integer) the specified base plus a CRLF end-of-line terminator to the stream or file. More...
 
size_t println (double value, int dec=2)
 Print a double floating point value plus a CRLF end-of-line terminator to the stream or file. More...
 
size_t println (const Printable &)
 Print an object derived from Printable plus a CRLF end-of-line terminator to the stream or file.
 
size_t println (void)
 Print a CRLF end-of-line terminator to the stream or file.
 
template<typename... Args>
size_t printf (const char *format, Args... args)
 Print using printf-style formatting to the stream or file. More...
 
template<typename... Args>
size_t printlnf (const char *format, Args... args)
 Print using printf-style formatting plus a CRLF end-of-line terminator to the stream or file. More...
 

Detailed Description

template<size_t SIZE>
class SerialBuffer< SIZE >

Buffered serial class.

Parameters
SIZEthe size of the buffer in bytes
portThe port to attach to. Must be a USARTSerial (Serial1, Serial2, Serial4, ...)

The buffered serial class creates a thread to read from the serial port, eliminating problems with dropping data

Constructor & Destructor Documentation

◆ SerialBuffer()

template<size_t SIZE>
SerialBuffer< SIZE >::SerialBuffer ( USARTSerial &  port)
inline

Constructs a SerialBuffer object.

Parameters
portThe real serial port to get the data to buffer from.

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