#include <Wire.h>

Inheritance diagram for TwoWire:
[legend]
Collaboration diagram for TwoWire:
[legend]

Public Member Functions

 TwoWire ()
 
void begin (int sda, int scl)
 
void pins (int sda, int scl)
 
void begin ()
 
void begin (uint8_t)
 
void begin (int)
 
void setClock (uint32_t)
 
void setClockStretchLimit (uint32_t)
 
void beginTransmission (uint8_t)
 
void beginTransmission (int)
 
uint8_t endTransmission ()
 
uint8_t endTransmission (uint8_t)
 
size_t requestFrom (uint8_t address, size_t size, bool sendStop)
 
uint8_t status ()
 
uint8_t requestFrom (uint8_t, uint8_t)
 
uint8_t requestFrom (uint8_t, uint8_t, uint8_t)
 
uint8_t requestFrom (int, int)
 
uint8_t requestFrom (int, int, int)
 
size_t write (uint8_t) override
 Writes a single character to output stream. More...
 
size_t write (const uint8_t *, size_t) override
 Writes characters from a buffer to output stream. More...
 
int available () override
 
int read () override
 
int peek () override
 
void flush () override
 
void onReceive (void(*)(int))
 
void onRequest (void(*)())
 
size_t write (unsigned long n)
 
size_t write (long n)
 
size_t write (unsigned int n)
 
size_t write (int n)
 
void setTimeout (unsigned long timeout)
 
bool find (char *target)
 
bool find (char *target, size_t length)
 
bool findUntil (char *target, char *terminator)
 
bool findUntil (char *target, size_t targetLen, char *terminate, size_t termLen)
 
long parseInt ()
 
float parseFloat ()
 
size_t readBytes (char *buffer, size_t length)
 
size_t readBytesUntil (char terminator, char *buffer, size_t length)
 
String readString ()
 
String readStringUntil (char terminator)
 
virtual int indexOf (char c)
 
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...
 
size_t print (const Printable &p)
 Prints a Printable object to output stream. More...
 
size_t print (const String &s)
 Prints a String to output stream. More...
 
size_t println ()
 Prints a newline to output stream. More...
 
size_t println (const char str[])
 Prints a c-string to output stream, appending newline. More...
 
size_t println (char c)
 Prints a single character to output stream, appending newline. More...
 
size_t println (double num, int digits=2)
 Print a floating-point number to output stream, appending newline. More...
 
size_t println (const Printable &p)
 Prints a Printable object to output stream, appending newline. More...
 
size_t println (const String &s)
 Prints a String to output stream, appending newline. More...
 
size_t printf (const char *fmt,...) __attribute__((format(printf
 Prints a formatted c-string to output stream. More...
 
Print an integral number to output stream
Parameters
numNumber to print
baseThe base for output (Default: Decimal (base 10))
Return values
size_tQuantity of characters written to stream
size_t print (unsigned long num, int base=DEC)
 
size_t print (const unsigned long long &num, int base=DEC)
 
size_t print (long, int base=DEC)
 
size_t print (const long long &, int base=DEC)
 
size_t print (unsigned int num, int base=DEC)
 
size_t print (unsigned char num, int base=DEC)
 
size_t print (int num, int base=DEC)
 
Print an integral number to output stream, appending newline
Parameters
numNumber to print
baseThe base for output (Default: Decimal (base 10))
Return values
size_tQuantity of characters written to stream
size_t println (unsigned char num, int base=DEC)
 
size_t println (unsigned int num, int base=DEC)
 
size_t println (unsigned long num, int base=DEC)
 
size_t println (const unsigned long long &num, int base=DEC)
 
size_t println (int num, int base=DEC)
 
size_t println (long num, int base=DEC)
 
size_t println (const long long &num, int base=DEC)
 

Protected Member Functions

int timedRead ()
 
int timedPeek ()
 
int peekNextDigit ()
 
long parseInt (char skipChar)
 
float parseFloat (char skipChar)
 
void setWriteError (int err=1)
 

Protected Attributes

unsigned long receiveTimeout = 1000
 
unsigned long startMillis = 0
 

Constructor & Destructor Documentation

◆ TwoWire()

TwoWire::TwoWire ( )

Member Function Documentation

◆ available()

int TwoWire::available ( )
overridevirtual

Implements Stream.

◆ begin() [1/4]

void TwoWire::begin ( int  sda,
int  scl 
)

◆ begin() [2/4]

void TwoWire::begin ( )

◆ begin() [3/4]

void TwoWire::begin ( uint8_t  )

◆ begin() [4/4]

void TwoWire::begin ( int  )

◆ beginTransmission() [1/2]

void TwoWire::beginTransmission ( uint8_t  )

◆ beginTransmission() [2/2]

void TwoWire::beginTransmission ( int  )

◆ clearWriteError()

void Print::clearWriteError ( )
inlineinherited

Clears the last write error.

◆ endTransmission() [1/2]

uint8_t TwoWire::endTransmission ( )

◆ endTransmission() [2/2]

uint8_t TwoWire::endTransmission ( uint8_t  )

◆ find() [1/2]

bool Stream::find ( char *  target)
inherited

◆ find() [2/2]

bool Stream::find ( char *  target,
size_t  length 
)
inherited

◆ findUntil() [1/2]

bool Stream::findUntil ( char *  target,
char *  terminator 
)
inherited

◆ findUntil() [2/2]

bool Stream::findUntil ( char *  target,
size_t  targetLen,
char *  terminate,
size_t  termLen 
)
inherited

◆ flush()

void TwoWire::flush ( )
overridevirtual

Implements Stream.

◆ getWriteError()

int Print::getWriteError ( )
inlineinherited

Gets last error.

Return values
intError number of last write error

◆ indexOf()

virtual int Stream::indexOf ( char  c)
inlinevirtualinherited

Reimplemented in HardwareSerial.

◆ onReceive()

void TwoWire::onReceive ( void(*)(int )

◆ onRequest()

void TwoWire::onRequest ( void(*)()  )

◆ parseFloat() [1/2]

float Stream::parseFloat ( )
inherited

◆ parseFloat() [2/2]

float Stream::parseFloat ( char  skipChar)
protectedinherited

◆ parseInt() [1/2]

long Stream::parseInt ( )
inherited

◆ parseInt() [2/2]

long Stream::parseInt ( char  skipChar)
protectedinherited

◆ peek()

int TwoWire::peek ( )
overridevirtual

Implements Stream.

◆ peekNextDigit()

int Stream::peekNextDigit ( )
protectedinherited

◆ pins()

void TwoWire::pins ( int  sda,
int  scl 
)

◆ print() [1/12]

size_t Print::print ( char  c)
inlineinherited

Prints a single character to output stream.

Parameters
cCharacter to print
Return values
size_tQuantity of characters written to stream

◆ print() [2/12]

size_t Print::print ( const char  str[])
inlineinherited

Prints a c-string to output stream.

Parameters
strc-string to print
Return values
size_tQuantity of characters written to output stream

◆ print() [3/12]

size_t Print::print ( unsigned long  num,
int  base = DEC 
)
inlineinherited

◆ print() [4/12]

size_t Print::print ( const unsigned long long &  num,
int  base = DEC 
)
inlineinherited

◆ print() [5/12]

size_t Print::print ( long  ,
int  base = DEC 
)
inherited

◆ print() [6/12]

size_t Print::print ( const long long &  ,
int  base = DEC 
)
inherited

◆ print() [7/12]

size_t Print::print ( unsigned int  num,
int  base = DEC 
)
inlineinherited

◆ print() [8/12]

size_t Print::print ( unsigned char  num,
int  base = DEC 
)
inlineinherited

◆ print() [9/12]

size_t Print::print ( int  num,
int  base = DEC 
)
inlineinherited

◆ print() [10/12]

size_t Print::print ( double  num,
int  digits = 2 
)
inlineinherited

Print a floating-point number to output stream.

Parameters
numNumber to print
digitsThe decimal places to print (Default: 2, e.g. 21.35)
Return values
size_tQuantity of characters written to stream

◆ print() [11/12]

size_t Print::print ( const Printable p)
inlineinherited

Prints a Printable object to output stream.

Parameters
pObject to print
Return values
size_tQuantity of characters written to stream

◆ print() [12/12]

size_t Print::print ( const String s)
inlineinherited

Prints a String to output stream.

Parameters
sString to print
Return values
size_tQuantity of characters written to stream

◆ printf()

size_t Print::printf ( const char *  fmt,
  ... 
)
inherited

Prints a formatted c-string to output stream.

Parameters
fmtPointer to formated c-string to print
...Parameters for placeholders within formated string
Return values
size_tQuantity of characters written to stream
Note
Use standard printf placeholders, e.g. d for integer, s for c-string, etc.

◆ println() [1/13]

size_t Print::println ( )
inlineinherited

Prints a newline to output stream.

Return values
size_tQuantity of characters written to stream

◆ println() [2/13]

size_t Print::println ( const char  str[])
inlineinherited

Prints a c-string to output stream, appending newline.

Parameters
strc-string to print
Return values
size_tQuantity of characters written to stream

◆ println() [3/13]

size_t Print::println ( char  c)
inlineinherited

Prints a single character to output stream, appending newline.

Parameters
cCharacter to print
Return values
size_tQuantity of characters written to stream

◆ println() [4/13]

size_t Print::println ( unsigned char  num,
int  base = DEC 
)
inlineinherited

◆ println() [5/13]

size_t Print::println ( unsigned int  num,
int  base = DEC 
)
inlineinherited

◆ println() [6/13]

size_t Print::println ( unsigned long  num,
int  base = DEC 
)
inlineinherited

◆ println() [7/13]

size_t Print::println ( const unsigned long long &  num,
int  base = DEC 
)
inlineinherited

◆ println() [8/13]

size_t Print::println ( int  num,
int  base = DEC 
)
inlineinherited

◆ println() [9/13]

size_t Print::println ( long  num,
int  base = DEC 
)
inlineinherited

◆ println() [10/13]

size_t Print::println ( const long long &  num,
int  base = DEC 
)
inlineinherited

◆ println() [11/13]

size_t Print::println ( double  num,
int  digits = 2 
)
inlineinherited

Print a floating-point number to output stream, appending newline.

Parameters
numNumber to print
digitsThe decimal places to print (Default: 2, e.g. 21.35)
Return values
size_tQuantity of characters written to stream

◆ println() [12/13]

size_t Print::println ( const Printable p)
inlineinherited

Prints a Printable object to output stream, appending newline.

Parameters
pObject to print
Return values
size_tQuantity of characters written to stream

◆ println() [13/13]

size_t Print::println ( const String s)
inlineinherited

Prints a String to output stream, appending newline.

Parameters
sString to print
Return values
size_tQuantity of characters written to stream

◆ read()

int TwoWire::read ( )
overridevirtual

Implements Stream.

◆ readBytes()

size_t Stream::readBytes ( char *  buffer,
size_t  length 
)
inherited

◆ readBytesUntil()

size_t Stream::readBytesUntil ( char  terminator,
char *  buffer,
size_t  length 
)
inherited

◆ readString()

String Stream::readString ( )
inherited

◆ readStringUntil()

String Stream::readStringUntil ( char  terminator)
inherited

◆ requestFrom() [1/5]

size_t TwoWire::requestFrom ( uint8_t  address,
size_t  size,
bool  sendStop 
)

◆ requestFrom() [2/5]

uint8_t TwoWire::requestFrom ( uint8_t  ,
uint8_t   
)

◆ requestFrom() [3/5]

uint8_t TwoWire::requestFrom ( uint8_t  ,
uint8_t  ,
uint8_t   
)

◆ requestFrom() [4/5]

uint8_t TwoWire::requestFrom ( int  ,
int   
)

◆ requestFrom() [5/5]

uint8_t TwoWire::requestFrom ( int  ,
int  ,
int   
)

◆ setClock()

void TwoWire::setClock ( uint32_t  )

◆ setClockStretchLimit()

void TwoWire::setClockStretchLimit ( uint32_t  )

◆ setTimeout()

void Stream::setTimeout ( unsigned long  timeout)
inherited

◆ setWriteError()

void Print::setWriteError ( int  err = 1)
inlineprotectedinherited

◆ status()

uint8_t TwoWire::status ( )

◆ timedPeek()

int Stream::timedPeek ( )
protectedinherited

◆ timedRead()

int Stream::timedRead ( )
protectedinherited

◆ write() [1/8]

size_t TwoWire::write ( uint8_t  )
overridevirtual

Writes a single character to output stream.

Parameters
uint8_tCharacter to write to output stream
Return values
size_tQuantity of characters written to output stream

Implements Print.

◆ write() [2/8]

size_t TwoWire::write ( const uint8_t *  buffer,
size_t  size 
)
overridevirtual

Writes characters from a buffer to output stream.

Parameters
bufferPointer to character buffer
sizeQuantity of characters to write
Return values
size_tQuantity of characters written to stream

Reimplemented from Print.

◆ write() [3/8]

size_t TwoWire::write ( unsigned long  n)
inline

◆ write() [4/8]

size_t Print::write ( const char *  str)
inlineinherited

Writes a c-string to output stream.

Parameters
strPointer to c-string
Return values
size_tQuantity of characters written to stream

◆ write() [5/8]

size_t TwoWire::write ( long  n)
inline

◆ write() [6/8]

size_t TwoWire::write ( unsigned int  n)
inline

◆ write() [7/8]

size_t TwoWire::write ( int  n)
inline

◆ write() [8/8]

size_t Print::write ( const char *  buffer,
size_t  size 
)
inlineinherited

Writes characters from a buffer to output stream.

Parameters
bufferPointer to character buffer
sizeQuantity of characters to write
Return values
size_tQuantity of characters written to stream

Member Data Documentation

◆ receiveTimeout

unsigned long Stream::receiveTimeout = 1000
protectedinherited

◆ startMillis

unsigned long Stream::startMillis = 0
protectedinherited

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