USBSerial Class Reference

#include <USBSerial.h>

Inheritance diagram for USBSerial:

Collaboration diagram for USBSerial:

Public Member Functions
void	begin (uint32_t)
virtual int	available (void)
virtual int	availableForWrite (void)
virtual int	peek (void)
virtual int	read (void)
virtual size_t	readBytes (char *buffer, size_t length)
virtual size_t	readBytesUntil (char terminator, char *buffer, size_t length)
virtual void	flush (void)
virtual size_t	write (uint8_t)
virtual size_t	write (const uint8_t *buffer, size_t size)
	operator bool (void)
Public Member Functions inherited from Stream
	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)
size_t	readBytes (uint8_t *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
	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 (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 (double, int=2)
size_t	println (const Printable &)
size_t	println (void)
void	println (int64_t, uint8_t=DEC)
void	print (int64_t, uint8_t=DEC)
void	println (uint64_t, uint8_t=DEC)
void	print (uint64_t, uint8_t=DEC)

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)
Protected Attributes inherited from Stream
unsigned long	_timeout
unsigned long	_startMillis

Member Function Documentation

begin()

void USBSerial::begin

(

uint32_t

baud_count

)

                                         {
    // uart config is ignored in USB-CDC
}

available()

int USBSerial::available ( void  )

virtual

Implements Stream.

                             {
    return ibufc;
}

availableForWrite()

int USBSerial::availableForWrite ( void  )

virtual

                                     {
    return (USBSERIAL_OBUF_SIZE - obufc);
}

peek()

int USBSerial::peek ( void  )

virtual

Implements Stream.

                        {
    int ch = -1;
    if (ibufc)
        ch = ibuff[ibufr];
    return ch;
}

read()

int USBSerial::read ( void  )

virtual

Implements Stream.

                        {
    int ch = -1;
    if (ibufc) {
        ch = ibuff[ibufr++];
        ibufc--;
        if (ibufr >= USBSERIAL_IBUF_SIZE)
            ibufr = 0;
    }
    return ch;
}

readBytes()

size_t USBSerial::readBytes ( char *  buffer, size_t  length  )

virtual

Reimplemented from Stream.

                                                       {
    char ch;
    size_t readed = 0;
    while (ibufc && length) {
        ch = ibuff[ibufr++];
        buffer[readed++] = ch;
        ibufc--;
        length--;
        if (ibufr >= USBSERIAL_IBUF_SIZE)
            ibufr = 0;
    }
    return readed;
}

readBytesUntil()

size_t USBSerial::readBytesUntil ( char  terminator, char *  buffer, size_t  length  )

virtual

Reimplemented from Stream.

                                                                             {
    char ch;
    size_t readed = 0;
    while (ibufc && length) {
        ch = ibuff[ibufr++];
        buffer[readed++] = ch;
        ibufc--;
        length--;
        if (ibufr >= USBSERIAL_IBUF_SIZE)
            ibufr = 0;
        if (ch == terminator)
            break;
    }
    return readed;
}

flush()

void USBSerial::flush ( void  )

virtual

Implements Stream.

                          {
    if (obufc)
        usb_cdc_tx_buffer();
}

Here is the call graph for this function:

write() [1/2]

size_t USBSerial::write ( uint8_t  ch )

virtual

Implements Print.

                                  {
    if (obufc >= USBSERIAL_OBUF_SIZE)
        return 0; // buffer overflow
    obuff[obufc++] = ch;
    if (ch == '\n') // eoln
        usb_cdc_tx_buffer();
    return 1;
}

Here is the call graph for this function:

Here is the caller graph for this function:

write() [2/2]

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

virtual

Reimplemented from Print.

                                                          {
    size_t written = 0;
    while (size--) {
        if (write(*buffer) != 1)
            break;
        written++;
        buffer++;
    }
    return written;
}

Here is the call graph for this function:

operator bool()

USBSerial::operator bool

(

void

)

                             {
    return true;
}