Wire_Library

Wire Library. More...

Functions
void	TwoWire::begin (int sda, int scl)
void	TwoWire::pins (int sda, int scl) __attribute__((deprecated))
void	TwoWire::begin ()
void	TwoWire::begin (uint8_t)
void	TwoWire::begin (int)
void	TwoWire::setClock (uint32_t)
void	TwoWire::setClockStretchLimit (uint32_t)
void	TwoWire::beginTransmission (uint8_t)
void	TwoWire::beginTransmission (int)
uint8_t	TwoWire::endTransmission (void)
uint8_t	TwoWire::endTransmission (uint8_t)
size_t	TwoWire::requestFrom (uint8_t address, size_t size, bool sendStop)
uint8_t	TwoWire::status ()
uint8_t	TwoWire::requestFrom (uint8_t, uint8_t)
uint8_t	TwoWire::requestFrom (uint8_t, uint8_t, uint8_t)
uint8_t	TwoWire::requestFrom (int, int)
uint8_t	TwoWire::requestFrom (int, int, int)
virtual size_t	TwoWire::write (uint8_t)
	This pure virtual function is used to define the operation that writes binary data. More...
virtual size_t	TwoWire::write (const uint8_t *, size_t)
	This function is used to write buffer to the interface defined by the object. More...
virtual int	TwoWire::available (void)
	available() gets the number of bytes available in the stream. This is only for bytes that have already arrived. More...
virtual int	TwoWire::read (void)
	read() reads characters from an incoming stream to the buffer. More...
virtual int	TwoWire::peek (void)
	Read a byte from the file without advancing to the next one. That is, successive calls to peek() will return the same value, as will the next call to read(). More...
virtual void	TwoWire::flush (void)
void	TwoWire::onReceive (void(*)(int))
void	TwoWire::onRequest (void(*)(void))
size_t	TwoWire::write (unsigned long n)
size_t	TwoWire::write (long n)
size_t	TwoWire::write (unsigned int n)
size_t	TwoWire::write (int n)

Detailed Description

Wire Library.

Function Documentation

available()

int TwoWire::available ( void  )

virtual

available() gets the number of bytes available in the stream. This is only for bytes that have already arrived.

This function is part of the Stream class, and is called by any class that inherits from it (Wire, Serial, etc). See the Stream class main page for more information.

Parameters

[in]

None

Returns

stream : an instance of a class that inherits from Stream

Note

Implements Stream.

peek()

int TwoWire::peek ( void  )

virtual

Read a byte from the file without advancing to the next one. That is, successive calls to peek() will return the same value, as will the next call to read().

This function is part of the Stream class, and is called by any class that inherits from it (Wire, Serial, etc). See the Stream class main page for more information.

Parameters

[in]

None

Returns

None

Note

Implements Stream.

read()

int TwoWire::read ( void  )

virtual

read() reads characters from an incoming stream to the buffer.

This function is part of the Stream class, and is called by any class that inherits from it (Wire, Serial, etc). See the Stream class main page for more information.

Parameters

[in]

None

Returns

the first byte of incoming data available (or -1 if no data is available)

Note

Implements Stream.

write() [1/2]

size_t TwoWire::write ( uint8_t  )

virtual

This pure virtual function is used to define the operation that writes binary data.

Parameters

[in]

val

a value to send as a single byte

Returns

The length of write successfully (1 byte).

Note

Implements Print.

write() [2/2]

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

virtual

This function is used to write buffer to the interface defined by the object.

Parameters

[in]	buffer	Specify the buffer.
[in]	size	Specify the size.

Returns

The length of write successfully.

Note

Parameters

[in]	buffer	Specify the buffer.
[in]	size	Specify the size.

Returns

The length of write successfully (1 byte).

Note

Reimplemented from Print.