TwoWire Class Reference

#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)
 
- 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...
 
virtual 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)
 As readBytes() with terminator character. More...
 
virtual String readString (size_t maxLen)
 Like readBytes but place content into a String 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...
 
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...
 
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)
 
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)
 

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)
 
- Protected Attributes inherited from Stream
uint16_t receiveTimeout = 1000
 number of milliseconds to wait for the next char before aborting timed read More...
 

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  )

◆ endTransmission() [1/2]

uint8_t TwoWire::endTransmission ( )

◆ endTransmission() [2/2]

uint8_t TwoWire::endTransmission ( uint8_t  )

◆ flush()

void TwoWire::flush ( )
overridevirtual

Implements Stream.

◆ onReceive()

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

◆ onRequest()

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

◆ peek()

int TwoWire::peek ( )
overridevirtual

Implements Stream.

◆ pins()

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

◆ read()

int TwoWire::read ( )
overridevirtual

Implements Stream.

◆ 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  )

◆ status()

uint8_t TwoWire::status ( )

◆ write() [1/6]

size_t TwoWire::write ( uint8_t  c)
overridevirtual

Writes a single character to output stream.

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

Implements Print.

◆ write() [2/6]

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/6]

size_t TwoWire::write ( unsigned long  n)
inline

◆ write() [4/6]

size_t TwoWire::write ( long  n)
inline

◆ write() [5/6]

size_t TwoWire::write ( unsigned int  n)
inline

◆ write() [6/6]

size_t TwoWire::write ( int  n)
inline

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