USB::CDC::UsbSerial Class Referenceabstract

Base class for both device and host serial port modes. More...

#include <UsbSerial.h>

Inheritance diagram for USB::CDC::UsbSerial:
Collaboration diagram for USB::CDC::UsbSerial:

Public Types

using DataReceived = StreamDataReceivedDelegate
 
using TransmitComplete = Delegate< void(UsbSerial &device)>
 

Public Member Functions

 UsbSerial ()
 
virtual size_t setRxBufferSize (size_t size)=0
 Sets receiving buffer size. More...
 
virtual size_t setTxBufferSize (size_t size)=0
 Sets transmit buffer size. More...
 
void setTxWait (bool wait)
 Governs write behaviour when UART transmit buffers are full. More...
 
uint16_t readMemoryBlock (char *buf, int max_len) override
 Read a block of memory. More...
 
bool seek (int len) override
 Move read cursor. More...
 
virtual void clear (SerialMode mode=SERIAL_FULL)=0
 Clear the serial port transmit/receive buffers. More...
 
void systemDebugOutput (bool enabled)
 Configure serial port for system debug output and redirect output from debugf. More...
 
bool onDataReceived (DataReceived callback)
 
bool onTransmitComplete (TransmitComplete callback)
 
unsigned getStatus ()
 Get status error flags and clear them. More...
 
void handleEvent (Event event)
 
- Public Member Functions inherited from ReadWriteStream
size_t write (uint8_t charToWrite) override
 From Stream class: We don't write using this stream. More...
 
virtual size_t write (const uint8_t *buffer, size_t size)=0
 Write chars to stream. More...
 
virtual size_t copyFrom (IDataSourceStream *source, size_t size=SIZE_MAX)
 Copy data from a source stream. More...
 
virtual size_t write (uint8_t c)=0
 Writes a single character to output stream. More...
 
size_t write (const char *str)
 Writes a c-string to output stream. More...
 
virtual size_t write (const uint8_t *buffer, size_t size)
 Writes characters from a buffer to output stream. More...
 
size_t write (const char *buffer, size_t size)
 Writes characters from a buffer to output stream. More...
 
- Public Member Functions inherited from IDataSourceStream
virtual StreamType getStreamType () const
 Get the stream type. More...
 
virtual bool isValid () const
 Determine if the stream object contains valid data. More...
 
size_t readBytes (char *buffer, size_t length) override
 Read chars from stream into buffer. More...
 
int read () override
 Read one character and moves the stream pointer. More...
 
int peek () override
 Read a character without advancing the stream pointer. More...
 
virtual int seekFrom (int offset, SeekOrigin origin)
 Change position in stream. More...
 
virtual bool isFinished ()=0
 Check if all data has been read. More...
 
virtual int available ()
 Return the total length of the stream. More...
 
void flush () override
 
virtual String id () const
 Returns unique id of the resource. More...
 
virtual String getName () const
 Returns name of the resource. More...
 
virtual MimeType getMimeType () const
 Get MIME type for stream content. More...
 
String readString (size_t maxLen) override
 Overrides Stream method for more efficient reading. More...
 
virtual bool moveString (String &s)
 Memory-based streams may be able to move content into a String. More...
 
virtual size_t readBytes (char *buffer, size_t length)
 Read chars from stream into buffer. More...
 
size_t readBytes (uint8_t *buffer, size_t length)
 
- 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...
 
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)
 

Protected Attributes

uart_options_t options {_BV(UART_OPT_TXWAIT)}
 
SimpleTimer flushTimer
 
- Protected Attributes inherited from Stream
uint16_t receiveTimeout = 1000
 number of milliseconds to wait for the next char before aborting timed read More...
 

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)
 

Detailed Description

Base class for both device and host serial port modes.

Todo:
We could inherit from HardwareSerial here, or preferably provide an abstract base class for all serial devices.

Member Typedef Documentation

◆ DataReceived

◆ TransmitComplete

Constructor & Destructor Documentation

◆ UsbSerial()

USB::CDC::UsbSerial::UsbSerial ( )

Member Function Documentation

◆ clear()

virtual void USB::CDC::UsbSerial::clear ( SerialMode  mode = SERIAL_FULL)
pure virtual

Clear the serial port transmit/receive buffers.

Parameters
modeWhether to flush TX, RX or both (the default)
Note
All un-read buffered data is removed and any error condition cleared

Implemented in USB::VENDOR::Device, USB::CDC::Device, and USB::CDC::HostDevice.

◆ getStatus()

unsigned USB::CDC::UsbSerial::getStatus ( )

Get status error flags and clear them.

Return values
unsignedStatus flags, combination of SerialStatus bits
See also
SerialStatus

◆ handleEvent()

void USB::CDC::UsbSerial::handleEvent ( Event  event)

◆ onDataReceived()

bool USB::CDC::UsbSerial::onDataReceived ( DataReceived  callback)
inline

◆ onTransmitComplete()

bool USB::CDC::UsbSerial::onTransmitComplete ( TransmitComplete  callback)
inline

◆ readMemoryBlock()

uint16_t USB::CDC::UsbSerial::readMemoryBlock ( char *  data,
int  bufSize 
)
inlineoverridevirtual

Read a block of memory.

Parameters
dataPointer to the data to be read
bufSizeQuantity of chars to read
Return values
uint16_tQuantity of chars read
Todo:
Should IDataSourceStream::readMemoryBlock return same data type as its bufSize param?

Implements IDataSourceStream.

◆ seek()

bool USB::CDC::UsbSerial::seek ( int  len)
inlineoverridevirtual

Move read cursor.

Parameters
lenRelative cursor adjustment
Return values
boolTrue on success.

Reimplemented from IDataSourceStream.

◆ setRxBufferSize()

virtual size_t USB::CDC::UsbSerial::setRxBufferSize ( size_t  size)
pure virtual

Sets receiving buffer size.

Parameters
sizerequested size
Return values
size_tactual size

Implemented in USB::VENDOR::Device, USB::CDC::Device, and USB::CDC::HostDevice.

◆ setTxBufferSize()

virtual size_t USB::CDC::UsbSerial::setTxBufferSize ( size_t  size)
pure virtual

Sets transmit buffer size.

Parameters
sizerequested size
Return values
size_tactual size

Implemented in USB::VENDOR::Device, USB::CDC::Device, and USB::CDC::HostDevice.

◆ setTxWait()

void USB::CDC::UsbSerial::setTxWait ( bool  wait)
inline

Governs write behaviour when UART transmit buffers are full.

Parameters
waitIf false, writes will return short count; applications can use the txComplete callback to send more data. If true, writes will wait for more buffer space so that all requested data is written

◆ systemDebugOutput()

void USB::CDC::UsbSerial::systemDebugOutput ( bool  enabled)

Configure serial port for system debug output and redirect output from debugf.

Parameters
enabledTrue to enable this port for system debug output
Note
If enabled, port will issue system debug messages

Member Data Documentation

◆ flushTimer

SimpleTimer USB::CDC::UsbSerial::flushTimer
protected

◆ options

uart_options_t USB::CDC::UsbSerial::options {_BV(UART_OPT_TXWAIT)}
protected

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