TwoWire Class Reference

#include <Wire.h>

Public Member Functions
	TwoWire ()
void	begin ()
void	begin (uint8_t)
void	begin (int)
void	beginTransmission (uint8_t)
void	beginTransmission (int)
void	endTransmission (void)
void	requestFrom (uint8_t, uint8_t)
void	requestFrom (int, int)
void	send (uint8_t)
void	send (uint8_t *, uint8_t)
void	send (int)
void	send (char *)
uint8_t	available (void)
uint8_t	receive (void)
void	onReceive (void(*)(int))
void	onRequest (void(*)(void))
void	close ()
Static Private Member Functions
static void	onRequestService (void)
static void	onReceiveService (uint8_t *, int)
Static Private Attributes
static uint8_t *	rxBuffer = 0
static uint8_t	rxBufferIndex = 0
static uint8_t	rxBufferLength = 0
static uint8_t	txAddress = 0
static uint8_t *	txBuffer = 0
static uint8_t	txBufferIndex = 0
static uint8_t	txBufferLength = 0
static uint8_t	transmitting = 0
static void(*	user_onRequest )(void)
static void(*	user_onReceive )(int)

---

Detailed Description

Definition at line 28 of file Wire.h.

---

Constructor & Destructor Documentation

TwoWire::TwoWire

(

)

Definition at line 52 of file Wire.cpp.

{
}

---

Member Function Documentation

void TwoWire::onRequestService

(

void

)

[static, private]

Definition at line 239 of file Wire.cpp.

References txBufferIndex, txBufferLength, and user_onRequest.

Referenced by begin().

{
  // don't bother if user hasn't registered a callback
  if(!user_onRequest){
    return;
  }
  // reset tx buffer iterator vars
  // !!! this will kill any pending pre-master sendTo() activity
  txBufferIndex = 0;
  txBufferLength = 0;
  // alert user program
  user_onRequest();
}

Here is the caller graph for this function:

void TwoWire::onReceiveService	(	uint8_t *	inBytes,
		int	numBytes
	)			[static, private]

Definition at line 214 of file Wire.cpp.

References rxBuffer, rxBufferIndex, rxBufferLength, and user_onReceive.

Referenced by begin().

{
  // don't bother if user hasn't registered a callback
  if(!user_onReceive){
    return;
  }
  // don't bother if rx buffer is in use by a master requestFrom() op
  // i know this drops data, but it allows for slight stupidity
  // meaning, they may not have read all the master requestFrom() data yet
  if(rxBufferIndex < rxBufferLength){
    return;
  }
  // copy twi rx buffer into local read buffer
  // this enables new reads to happen in parallel
  for(uint8_t i = 0; i < numBytes; ++i){
    rxBuffer[i] = inBytes[i];    
  }
  // set rx iterator vars
  rxBufferIndex = 0;
  rxBufferLength = numBytes;
  // alert user program
  user_onReceive(numBytes);
}

Here is the caller graph for this function:

void TwoWire::begin

(

void

)

Definition at line 58 of file Wire.cpp.

References BUFFER_LENGTH, rxBuffer, rxBufferIndex, rxBufferLength, twi_init(), txBuffer, txBufferIndex, and txBufferLength.

Referenced by begin(), WaspRTC::begin(), WaspACC::begin(), WaspSensorPrototyping::readADC(), WaspSensorAgr::readDendrometer(), WaspSensorAgr::readPT1000(), WaspSensorAgr::readRadiation(), WaspSensorGas::setAmplifier(), WaspSensorPrototyping::setAmplifierGain(), WaspSensorAgr::setDigipot(), WaspSensorEvent::setDigipot0(), WaspSensorEvent::setDigipot1(), WaspSensorPrototyping::setLoadResistor(), WaspPWR::setLowBatteryThreshold(), and WaspSensorGas::setResistor().

{
  // init buffer for reads
  rxBuffer = (uint8_t*) calloc(BUFFER_LENGTH, sizeof(uint8_t));
  rxBufferIndex = 0;
  rxBufferLength = 0;

  // init buffer for writes
  txBuffer = (uint8_t*) calloc(BUFFER_LENGTH, sizeof(uint8_t));
  txBufferIndex = 0;
  txBufferLength = 0;

  twi_init();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void TwoWire::begin

(

uint8_t

address

)

Definition at line 73 of file Wire.cpp.

References begin(), onReceiveService(), onRequestService(), twi_attachSlaveRxEvent(), twi_attachSlaveTxEvent(), and twi_setAddress().

{
  twi_setAddress(address);
  twi_attachSlaveTxEvent(onRequestService);
  twi_attachSlaveRxEvent(onReceiveService);
  begin();
}

Here is the call graph for this function:

void TwoWire::begin

(

int

address

)

Definition at line 81 of file Wire.cpp.

References begin().

{
  begin((uint8_t)address);
}

Here is the call graph for this function:

void TwoWire::beginTransmission

(

uint8_t

address

)

Definition at line 104 of file Wire.cpp.

References transmitting, txAddress, txBufferIndex, and txBufferLength.

Referenced by beginTransmission(), WaspSensorAgr::readDendrometer(), WaspSensorAgr::readPT1000(), WaspACC::readRegister(), WaspRTC::readRTC(), WaspRTC::readRTCregister(), WaspSensorGas::setAmplifier(), WaspSensorPrototyping::setAmplifierGain(), WaspSensorAgr::setDigipot(), WaspSensorEvent::setDigipot0(), WaspSensorEvent::setDigipot1(), WaspSensorPrototyping::setLoadResistor(), WaspPWR::setLowBatteryThreshold(), WaspSensorGas::setResistor(), WaspACC::writeRegister(), WaspRTC::writeRTC(), WaspRTC::writeRTCalarm1(), WaspRTC::writeRTCalarm2(), and WaspRTC::writeRTCregister().

{
  // indicate that we are transmitting
  transmitting = 1;
  // set address of targeted slave
  txAddress = address;
  // reset tx buffer iterator vars
  txBufferIndex = 0;
  txBufferLength = 0;
}

Here is the caller graph for this function:

void TwoWire::beginTransmission

(

int

address

)

Definition at line 115 of file Wire.cpp.

References beginTransmission().

{
  beginTransmission((uint8_t)address);
}

Here is the call graph for this function:

void TwoWire::endTransmission

(

void

)

Definition at line 120 of file Wire.cpp.

References transmitting, twi_writeTo(), txAddress, txBuffer, txBufferIndex, and txBufferLength.

Referenced by WaspSensorAgr::readDendrometer(), WaspSensorAgr::readPT1000(), WaspACC::readRegister(), WaspRTC::readRTC(), WaspRTC::readRTCregister(), WaspSensorGas::setAmplifier(), WaspSensorPrototyping::setAmplifierGain(), WaspSensorAgr::setDigipot(), WaspSensorEvent::setDigipot0(), WaspSensorEvent::setDigipot1(), WaspSensorPrototyping::setLoadResistor(), WaspPWR::setLowBatteryThreshold(), WaspSensorGas::setResistor(), WaspACC::writeRegister(), WaspRTC::writeRTC(), WaspRTC::writeRTCalarm1(), WaspRTC::writeRTCalarm2(), and WaspRTC::writeRTCregister().

{
  // transmit buffer (blocking)
  twi_writeTo(txAddress, txBuffer, txBufferLength, 1);
  // reset tx buffer iterator vars
  txBufferIndex = 0;
  txBufferLength = 0;
  // indicate that we are done transmitting
  transmitting = 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void TwoWire::requestFrom	(	uint8_t	address,
		uint8_t	quantity
	)

Definition at line 86 of file Wire.cpp.

References BUFFER_LENGTH, rxBuffer, rxBufferIndex, rxBufferLength, and twi_readFrom().

Referenced by WaspSensorPrototyping::readADC(), WaspSensorAgr::readDendrometer(), WaspSensorAgr::readPT1000(), WaspSensorAgr::readRadiation(), WaspACC::readRegister(), WaspRTC::readRTC(), WaspRTC::readRTCregister(), and requestFrom().

{
  // clamp to buffer length
  if(quantity > BUFFER_LENGTH){
    quantity = BUFFER_LENGTH;
  }
  // perform blocking read into buffer
  twi_readFrom(address, rxBuffer, quantity);
  // set rx buffer iterator vars
  rxBufferIndex = 0;
  rxBufferLength = quantity;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void TwoWire::requestFrom	(	int	address,
		int	quantity
	)

Definition at line 99 of file Wire.cpp.

References requestFrom().

{
  requestFrom((uint8_t)address, (uint8_t)quantity);
}

Here is the call graph for this function:

void TwoWire::send

(

uint8_t

data

)

Definition at line 134 of file Wire.cpp.

References BUFFER_LENGTH, transmitting, twi_transmit(), txBuffer, txBufferIndex, and txBufferLength.

Referenced by WaspSensorAgr::readDendrometer(), WaspSensorAgr::readPT1000(), WaspACC::readRegister(), WaspRTC::readRTC(), WaspRTC::readRTCregister(), send(), WaspSensorGas::setAmplifier(), WaspSensorPrototyping::setAmplifierGain(), WaspSensorAgr::setDigipot(), WaspSensorEvent::setDigipot0(), WaspSensorEvent::setDigipot1(), WaspSensorPrototyping::setLoadResistor(), WaspPWR::setLowBatteryThreshold(), WaspSensorGas::setResistor(), WaspACC::writeRegister(), WaspRTC::writeRTC(), WaspRTC::writeRTCalarm1(), WaspRTC::writeRTCalarm2(), and WaspRTC::writeRTCregister().

{
  if(transmitting){
  // in master transmitter mode
    // don't bother if buffer is full
    if(txBufferLength >= BUFFER_LENGTH){
      return;
    }
    // put byte in tx buffer
    txBuffer[txBufferIndex] = data;
    ++txBufferIndex;
    // update amount in buffer   
    txBufferLength = txBufferIndex;
  }else{
  // in slave send mode
    // reply to master
    twi_transmit(&data, 1);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void TwoWire::send	(	uint8_t *	data,
		uint8_t	quantity
	)

Definition at line 157 of file Wire.cpp.

References send(), transmitting, and twi_transmit().

{
  if(transmitting){
  // in master transmitter mode
    for(uint8_t i = 0; i < quantity; ++i){
      send(data[i]);
    }
  }else{
  // in slave send mode
    // reply to master
    twi_transmit(data, quantity);
  }
}

Here is the call graph for this function:

void TwoWire::send

(

int

data

)

Definition at line 182 of file Wire.cpp.

References send().

{
  send((uint8_t)data);
}

Here is the call graph for this function:

void TwoWire::send

(

char *

data

)

Definition at line 174 of file Wire.cpp.

References send().

{
  send((uint8_t*)data, strlen(data));
}

Here is the call graph for this function:

uint8_t TwoWire::available

(

void

)

Definition at line 190 of file Wire.cpp.

References rxBufferIndex, and rxBufferLength.

Referenced by WaspSensorPrototyping::readADC(), WaspSensorAgr::readDendrometer(), WaspSensorAgr::readPT1000(), WaspSensorAgr::readRadiation(), WaspACC::readRegister(), WaspRTC::readRTC(), and WaspRTC::readRTCregister().

{
  return rxBufferLength - rxBufferIndex;
}

Here is the caller graph for this function:

uint8_t TwoWire::receive

(

void

)

Definition at line 198 of file Wire.cpp.

References rxBuffer, rxBufferIndex, and rxBufferLength.

Referenced by WaspSensorPrototyping::readADC(), WaspSensorAgr::readDendrometer(), WaspSensorAgr::readPT1000(), WaspSensorAgr::readRadiation(), WaspACC::readRegister(), WaspRTC::readRTC(), and WaspRTC::readRTCregister().

{
  // default to returning null char
  // for people using with char strings
  uint8_t value = '\0';
  
  // get each successive byte on each call
  if(rxBufferIndex < rxBufferLength){
    value = rxBuffer[rxBufferIndex];
    ++rxBufferIndex;
  }

  return value;
}

Here is the caller graph for this function:

void TwoWire::onReceive

(

void(*)(int)

function

)

Definition at line 254 of file Wire.cpp.

References user_onReceive.

{
  user_onReceive = function;
}

void TwoWire::onRequest

(

void(*)(void)

function

)

Definition at line 260 of file Wire.cpp.

References user_onRequest.

{
  user_onRequest = function;
}

void TwoWire::close

(

void

)

Definition at line 265 of file Wire.cpp.

References rxBuffer, twi_close(), and txBuffer.

Referenced by WaspPWR::closeI2C().

{
        free(rxBuffer);
        free(txBuffer);
        twi_close();
}

Here is the call graph for this function:

Here is the caller graph for this function:

---

Field Documentation

uint8_t * TwoWire::rxBuffer = 0 [static, private]

Definition at line 31 of file Wire.h.

Referenced by begin(), close(), onReceiveService(), receive(), and requestFrom().

uint8_t TwoWire::rxBufferIndex = 0 [static, private]

Definition at line 32 of file Wire.h.

Referenced by available(), begin(), onReceiveService(), receive(), and requestFrom().

uint8_t TwoWire::rxBufferLength = 0 [static, private]

Definition at line 33 of file Wire.h.

Referenced by available(), begin(), onReceiveService(), receive(), and requestFrom().

uint8_t TwoWire::txAddress = 0 [static, private]

Definition at line 35 of file Wire.h.

Referenced by beginTransmission(), and endTransmission().

uint8_t * TwoWire::txBuffer = 0 [static, private]

Definition at line 36 of file Wire.h.

Referenced by begin(), close(), endTransmission(), and send().

uint8_t TwoWire::txBufferIndex = 0 [static, private]

Definition at line 37 of file Wire.h.

Referenced by begin(), beginTransmission(), endTransmission(), onRequestService(), and send().

uint8_t TwoWire::txBufferLength = 0 [static, private]

Definition at line 38 of file Wire.h.

Referenced by begin(), beginTransmission(), endTransmission(), onRequestService(), and send().

uint8_t TwoWire::transmitting = 0 [static, private]

Definition at line 40 of file Wire.h.

Referenced by beginTransmission(), endTransmission(), and send().

void(* TwoWire::user_onRequest)(void)

(

void

)

[static, private]

Referenced by onRequest(), and onRequestService().

void(* TwoWire::user_onReceive)(int)

(

int

)

[static, private]

Referenced by onReceive(), and onReceiveService().

---

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

• Wire.h
• Wire.cpp