WaspACC Class Reference

WaspACC Class. More...

#include <WaspACC.h>

Public Member Functions
	WaspACC ()
	class constructor
void	ON ()
	It opens I2C bus and powers the accelerometer.
void	begin ()
	It opens I2C bus.
void	boot ()
	It reboots the accelerometer.
void	close ()
	It closes I2C bus.
uint8_t	getStatus ()
	It gets the accelerometer status.
uint8_t	check ()
	It checks if accelerometer is working properly.
uint8_t	getCTRL1 ()
	It gets the CTRL1 register.
uint8_t	setCTRL1 (uint8_t val)
	It sets the CTRL1 register.
uint8_t	getCTRL2 ()
	It gets the CTRL2 register.
uint8_t	setCTRL2 (uint8_t val)
	It sets the CTRL2 register.
uint8_t	getCTRL3 ()
	It gets the CTRL3 register.
uint8_t	setCTRL3 (uint8_t val)
	It sets the CTRL3 register.
int16_t	readRegister (uint8_t address)
	It reads a register from the accelerometer.
int16_t	writeRegister (uint8_t address, uint8_t val)
	It writes a register to the accelerometer.
uint8_t	getADCmode ()
	It gets the accelerometer's ADC mode.
uint8_t	setADCmode (uint8_t val)
	It sets the accelerometer's ADC mode.
uint8_t	setSamplingRate (uint8_t rate)
	It sets the accelerometer's sampling rate.
int16_t	getX ()
	It gets the acceleration on OX.
int16_t	getY ()
	It gets the acceleration on OY.
int16_t	getZ ()
	It gets the acceleration on OZ.
uint8_t	setFF (void)
	It sets the Free Fall interrupt using the parameters previously defined.
uint8_t	unsetFF (void)
	It unsets the Free Fall interrupt.
uint8_t	setDD (uint8_t directions)
	It sets the Direction Change interrupt using the input parameter.
uint8_t	setDD (void)
	It sets the Direction Change interrupt using the parameters previously defined.
uint8_t	unsetDD (void)
	It unsets the Direction Change interrupt.
uint8_t	getMode ()
	It gets the accelerometer's work mode.
uint8_t	setMode (uint8_t val)
	It sets the accelerometer's work mode.
uint8_t	getAccEvent ()
	It gets the accelerometer's event type.
uint8_t	setAccEvent (uint8_t val)
	It sets the accelerometer's event type.
void	attachInt (void)
	It configures the specific hardware interrupt for the acc.
void	detachInt (void)
	It unsets the specific hardware interrupt for the acc.
void	clearAlarmFlag ()
	It clears the Accelerometer's alarm flag.
Data Fields
volatile uint8_t	flag
	Variable : status flag, used to see if there has been an error while reading/writing or if there has been a hardware interrupt.
uint8_t	flagInt
	Variable : interrupt flag, used to check which interrupt got active.
Private Attributes
uint8_t	accMode
	Variable : Accelerometer Operation Mode.
uint8_t	AccEventMode
	Variable : Accelerometer Event Mode.

---

Detailed Description

WaspACC Class.

WaspACC Class defines all the variables and functions used to manage LIS3LV02DL accelerometer

Definition at line 476 of file WaspACC.h.

---

Constructor & Destructor Documentation

WaspACC::WaspACC

(

)

class constructor

It does nothing

Parameters:

void

Returns:

void

Definition at line 32 of file WaspACC.cpp.

{
    // nothing to do
}

---

Member Function Documentation

void WaspACC::ON

(

void

)

It opens I2C bus and powers the accelerometer.

Parameters:

void

Returns:

void

See also:

boot(), close(), begin()

Definition at line 48 of file WaspACC.cpp.

References ACC_ON, begin(), and setMode().

{
        begin();
        setMode(ACC_ON);
}

Here is the call graph for this function:

void WaspACC::begin

(

void

)

It opens I2C bus.

Parameters:

void

Returns:

void

See also:

boot(), close()

Definition at line 62 of file WaspACC.cpp.

References ACC_ON, accMode, TwoWire::begin(), RTC, RTC_ON, WaspRTC::setMode(), and Wire.

Referenced by ON().

{

        // Sets RTC on to enable I2C
        RTC.setMode(RTC_ON);
        
  accMode = ACC_ON;         // by default the accelerometer will be in continuous mode
                            // this should be changed once Wasp is released, by default
                            // the system should be in standby, and with the communication 
                            // disabled

  Wire.begin(); // join i2c bus (address optional for master)
  
        
  // start the communication by
  // making sure we have the right data in
  // the control registers

  // register 2 takes care rebooting, and turning on/off
  // the free fall filters
  // writeRegister(ctrlReg2, B00000000);
  /*
   *      MSB - fs: full scale selection, 0=2g, 1=6g
   *            bdu: block data update, 0=continuous, 1=when MSB/LSB has been read 
   *            ble: big little endian, 0=little, 1=big
   *            boot: reboot factory defaults
   *            ien: interrupt enable, 0=data ready on RDY , 1=int. request on RDY
   *            drdy: data ready generation, 0 for 0 on RDY, 1 for 1 on RDY
   *            sim: SPI 4/3 wire, 0=4 wires, 1=3 wires
   *      LSB - das: 0=12 bit signed, 1=16 bits unsigned
   */

  // register 1 will decide upon the different acceleration, sample rate,
  // will enable the different axes and will control if the sensor is 
  // in power down mode
  // writeRegister(ctrlReg1, B01000111);
  /*
   *      MSB - pd1, pd0: 00 means power down, 01, 10, 11 are power on
   *            df1, df0: decimation factor, 00=512, 01=128, 10=32, 11=8
   *            sfe: self test enable, 0=normal, 1=active
   *            z enable
   *            y enable
   *      LSB - x enable
   */

  // mostly takes care of filter activations and such
  // writeRegister(ctrlReg3, B00001000);
  // in theory the pin we are trying to write to should be reserved
  // therefore this operation should not be needed
  /*
   *      MSB - eck - External Clock. Default value: 0
   *            hpdd - (0: clock from internal oscillator; 1: clock from external pad)
   *                   High Pass filter enabled for Direction Detection. Default value: 0
   *            hpff - (0: filter bypassed; 1: filter enabled)
   *                   High Pass filter enabled for Free-Fall and Wake-Up. Default value: 0
   *            fds  - (0: filter bypassed; 1: filter enabled)
   *                   Filtered Data Selection. Default value: 0
   *            res  - Reserved. These bit are reserved for future enhancements.
   *                   Best to be left to their default value (10 binary)
   *            res
   *            cfs1, cfs0 - (0: internal filter bypassed; 1: data from internal filter)
   *                   High-pass filter Cut-off Frequency Selection. Default value: 00
   *                   (00: Hpc=512
   *                    01: Hpc=1024
   *                    10: Hpc=2048
   *                    11: Hpc=4096)
   */
}

Here is the call graph for this function:

Here is the caller graph for this function:

void WaspACC::boot

(

void

)

It reboots the accelerometer.

Parameters:

void

Returns:

void

See also:

init(), close()

Definition at line 139 of file WaspACC.cpp.

References B00000000, B00010000, ctrlReg2, delay(), and writeRegister().

{
  // send reboot command
  writeRegister(ctrlReg2, B00010000);

  delay(1);  // make a short pause after rebooting

  writeRegister(ctrlReg2, B00000000);

}

Here is the call graph for this function:

void WaspACC::close

(

void

)

It closes I2C bus.

Parameters:

void

Returns:

void

See also:

init(), boot()

Definition at line 157 of file WaspACC.cpp.

References ACC_HIBERNATE, WaspPWR::closeI2C(), PWR, and setMode().

{
        setMode(ACC_HIBERNATE); 
        PWR.closeI2C();
}

Here is the call graph for this function:

uint8_t WaspACC::getStatus

(

void

)

It gets the accelerometer status.

Parameters:

void

Returns:

a byte containing the accelerometer status as read from the proper register. It won't activate any flags by itself, but activates ACC_COMM_ERROR in case there was an error writing to the register

See also:

check()

Definition at line 174 of file WaspACC.cpp.

References readRegister(), and statusReg.

{
  return (uint8_t) readRegister(statusReg);
}

Here is the call graph for this function:

uint8_t WaspACC::check

(

void

)

It checks if accelerometer is working properly.

Parameters:

void

Returns:

a byte containing the register value. If this value is different from '0x3A', the accelerometer is not working properly

See also:

getStatus()

Definition at line 192 of file WaspACC.cpp.

References readRegister(), and whoAmIReg.

{
  return (uint8_t) readRegister(whoAmIReg);
}

Here is the call graph for this function:

uint8_t WaspACC::getCTRL1

(

void

)

It gets the CTRL1 register.

Parameters:

void

Returns:

a byte containing the register value.

See also:

setCTRL1(uint8_t val)

Definition at line 210 of file WaspACC.cpp.

References ctrlReg1, and readRegister().

{
  return (uint8_t) readRegister(ctrlReg1);
}

Here is the call graph for this function:

uint8_t WaspACC::setCTRL1

(

uint8_t

val

)

It sets the CTRL1 register.

Parameters:

uint8_t

val : value to set the CTRL1 register to

Returns:

'1' if error

See also:

getCTRL1()

Definition at line 224 of file WaspACC.cpp.

References ctrlReg1, and writeRegister().

{
  return (uint8_t) writeRegister(ctrlReg1, val);
}

Here is the call graph for this function:

uint8_t WaspACC::getCTRL2

(

void

)

It gets the CTRL2 register.

Parameters:

void

Returns:

a byte containing the register value.

See also:

setCTRL2(uint8_t val)

Definition at line 239 of file WaspACC.cpp.

References ctrlReg2, and readRegister().

{
  return (uint8_t) readRegister(ctrlReg2);
}

Here is the call graph for this function:

uint8_t WaspACC::setCTRL2

(

uint8_t

val

)

It sets the CTRL2 register.

Parameters:

uint8_t

val : value to set the CTRL2 register to

Returns:

'1' if error

See also:

getCTRL2()

Definition at line 253 of file WaspACC.cpp.

References ctrlReg2, and writeRegister().

{
  return (uint8_t) writeRegister(ctrlReg2, val);
}

Here is the call graph for this function:

uint8_t WaspACC::getCTRL3

(

void

)

It gets the CTRL3 register.

Parameters:

void

Returns:

a byte containing the register value.

See also:

setCTRL3(uint8_t val)

Definition at line 267 of file WaspACC.cpp.

References ctrlReg3, and readRegister().

{
  return (uint8_t) readRegister(ctrlReg3);
}

Here is the call graph for this function:

uint8_t WaspACC::setCTRL3

(

uint8_t

val

)

It sets the CTRL3 register.

Parameters:

uint8_t

val : value to set the CTRL3 register to

Returns:

'1' if error

See also:

getCTRL3()

Definition at line 281 of file WaspACC.cpp.

References ctrlReg3, and writeRegister().

{
  return (uint8_t) writeRegister(ctrlReg3, val);
}

Here is the call graph for this function:

int16_t WaspACC::readRegister

(

uint8_t

address

)

It reads a register from the accelerometer.

Parameters:

uint8_t

address : register address

Returns:

register value or '-1' if error

See also:

writeRegister(uint8_t address, uint8_t val)

Definition at line 656 of file WaspACC.cpp.

References ACC_ERROR_READING, TwoWire::available(), TwoWire::beginTransmission(), TwoWire::endTransmission(), flag, i2cID, TwoWire::receive(), TwoWire::requestFrom(), TwoWire::send(), and Wire.

Referenced by check(), clearAlarmFlag(), getADCmode(), getCTRL1(), getCTRL2(), getCTRL3(), getStatus(), getX(), getY(), getZ(), setADCmode(), setDD(), setSamplingRate(), unsetDD(), unsetFF(), and writeRegister().

{
  // reset the flag
  flag &= ~(ACC_ERROR_READING);

  uint8_t aux = 0;
  Wire.beginTransmission(i2cID);
  Wire.send(regNum);
  Wire.endTransmission();

  Wire.requestFrom(i2cID, 1);
  if(Wire.available())
  {
    aux = Wire.receive();
    return aux;
  }

  // error, activate the reading flag
  flag |= ACC_ERROR_READING;

  return -1;
}

Here is the call graph for this function:

Here is the caller graph for this function:

int16_t WaspACC::writeRegister	(	uint8_t	address,
		uint8_t	val
	)

It writes a register to the accelerometer.

Parameters:

	uint8_t	address : register address
	uint8_t	val : value to write

Returns:

'0' on success, '-1' if error

See also:

readRegister(uint8_t val)

Definition at line 681 of file WaspACC.cpp.

References ACC_ERROR_WRITING, TwoWire::beginTransmission(), TwoWire::endTransmission(), flag, i2cID, readRegister(), TwoWire::send(), and Wire.

Referenced by boot(), clearAlarmFlag(), setADCmode(), setCTRL1(), setCTRL2(), setCTRL3(), setDD(), setFF(), setMode(), setSamplingRate(), unsetDD(), and unsetFF().

{
  // reset the flag
  flag &= ~(ACC_ERROR_WRITING);

  Wire.beginTransmission(i2cID);
  Wire.send(address); 
  Wire.send(val);
  Wire.endTransmission();

  if (readRegister(address) != val)
  {
    // error, activate the reading flag
    flag |= ACC_ERROR_WRITING;

    return -1;
  }

  // exit with no error
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

uint8_t WaspACC::getADCmode

(

void

)

It gets the accelerometer's ADC mode.

Parameters:

void

Returns:

'0' for 12 bits right aligned (MSB represents the sign) and '1' for 16 bits left aligned

See also:

setADCmode(uint8_t val)

Definition at line 295 of file WaspACC.cpp.

References B01, ctrlReg2, and readRegister().

{
  return readRegister(ctrlReg2) && B01;
}

Here is the call graph for this function:

uint8_t WaspACC::setADCmode

(

uint8_t

val

)

It sets the accelerometer's ADC mode.

Parameters:

uint8_t

val : '0' for 12 bits right aligned (MSB represents the sign) and '1' for 16 bits left aligned

Returns:

'0' on success, '-1' if error

See also:

getADCmode()

Definition at line 311 of file WaspACC.cpp.

References B11111110, ctrlReg2, readRegister(), and writeRegister().

{
  uint8_t aux = readRegister(ctrlReg2);
  aux &= B11111110;
  aux |= val;
  return writeRegister(ctrlReg2, aux);
}

Here is the call graph for this function:

uint8_t WaspACC::setSamplingRate

(

uint8_t

rate

)

It sets the accelerometer's sampling rate.

Parameters:

uint8_t

rate : ACC_RATE_40, ACC_RATE_160, ACC_RATE_640, ACC_RATE_2560

Returns:

'0' on success, '-1' if error

Definition at line 329 of file WaspACC.cpp.

References ACC_RATE_160, ACC_RATE_2560, ACC_RATE_40, ACC_RATE_640, B00010000, B00100000, B00110000, B11001111, ctrlReg1, readRegister(), and writeRegister().

{
        uint8_t aux = readRegister(ctrlReg1);
        aux &= B11001111;
        
        switch( rate )
        {
                case ACC_RATE_40        :       aux |= rate;
                                                break;
                case ACC_RATE_160       :       aux |= B00010000;
                                                break;
                case ACC_RATE_640       :       aux |= B00100000;
                                                break;
                case ACC_RATE_2560      :       aux |= B00110000;
                                                break;
        }
        return writeRegister(ctrlReg1, aux);
}

Here is the call graph for this function:

int16_t WaspACC::getX

(

void

)

It gets the acceleration on OX.

Parameters:

void

Returns:

the combined contents of data registers outXhigh and outXlow as an integer according to ADC's configuration

See also:

getY(), getZ()

Definition at line 363 of file WaspACC.cpp.

References outXhigh, outXlow, and readRegister().

{
  int16_t aux = readRegister(outXhigh)*256 + readRegister(outXlow);
  return aux;
}

Here is the call graph for this function:

int16_t WaspACC::getY

(

void

)

It gets the acceleration on OY.

Parameters:

void

Returns:

the combined contents of data registers outYhigh and outYlow as an integer according to ADC's configuration

See also:

getX(), getZ()

Definition at line 379 of file WaspACC.cpp.

References outYhigh, outYlow, and readRegister().

{
  int16_t aux = readRegister(outYhigh)*256 + readRegister(outYlow);
  return aux;
}

Here is the call graph for this function:

int16_t WaspACC::getZ

(

void

)

It gets the acceleration on OZ.

Parameters:

void

Returns:

the combined contents of data registers outZhigh and outZlow as an integer according to ADC's configuration

See also:

getX(), getY()

Definition at line 395 of file WaspACC.cpp.

References outZhigh, outZlow, and readRegister().

{
  int16_t aux = readRegister(outZhigh)*256 + readRegister(outZlow);
  return aux;
}

Here is the call graph for this function:

uint8_t WaspACC::setFF

(

void

)

It sets the Free Fall interrupt using the parameters previously defined.

Parameters:

void

Returns:

'flag' variable

See also:

unsetFF()

Definition at line 466 of file WaspACC.cpp.

References ACC, ACC_FREE_FALL, AccEventMode, attachInt(), ctrlReg1, ctrlReg2, ctrlReg3, FF_WU_CFG, FF_WU_CFG_val, FF_WU_DURATION, FF_WU_DURATION_val, FF_WU_THS_H, FF_WU_THS_H_val, FF_WU_THS_L, FF_WU_THS_L_val, flag, unsetFF(), and writeRegister().

Referenced by WaspPWR::clearInts().

{
  // clear the FF interrupt if active
  unsetFF();
   
  // configure the different registers to 
  // handle acceleration detection on the X, Y, or Z axis
  ACC.writeRegister(ctrlReg1, 0xC7);
  ACC.writeRegister(ctrlReg2, 0x08); 
  ACC.writeRegister(ctrlReg3, 0x08);
  
 // here we have to double-check if we
  // are in 12 or 16bit data modes. The 12
  // bit data mode is giving away the 4LSBs
  // therefore the register needs to be written
  // according to that. 0x3C00 is just below 1g
  // but the acc will give 0x03C0, beware!
  writeRegister(FF_WU_THS_L, FF_WU_THS_L_val);  // threshold L
  writeRegister(FF_WU_THS_H, FF_WU_THS_H_val);  // threshold H
  writeRegister(FF_WU_DURATION, FF_WU_DURATION_val);  // event duration
  // readRegister(HP_FILTER_RESET);   // config the acc. to get current acceleration as initial val
  writeRegister(FF_WU_CFG, FF_WU_CFG_val);  // config accelerometer to wake up 

  // assign the ACC_FREE_FALL mode
  AccEventMode |= ACC_FREE_FALL;

  // attach the hardware interrupt to the pin
  attachInt();

  return flag;
}

Here is the call graph for this function:

Here is the caller graph for this function:

uint8_t WaspACC::unsetFF

(

void

)

It unsets the Free Fall interrupt.

Parameters:

void

Returns:

'flag' variable

See also:

setFF()

Definition at line 501 of file WaspACC.cpp.

References ACC_FREE_FALL, AccEventMode, detachInt(), FF_WU_ACK, FF_WU_CFG, flag, readRegister(), and writeRegister().

Referenced by setFF().

{

  writeRegister(FF_WU_CFG, 0x00);  
  readRegister(FF_WU_ACK);  // clear the interrupt flag

  // detach the event if there are no flags active
  AccEventMode &= ~(ACC_FREE_FALL);
  if (!AccEventMode) detachInt();
  return flag;
}

Here is the call graph for this function:

Here is the caller graph for this function:

uint8_t WaspACC::setDD

(

uint8_t

directions

)

It sets the Direction Change interrupt using the input parameter.

Parameters:

uint8_t

directions : the axis where enable the interruptions

Returns:

'flag' variable

See also:

setDD()

Definition at line 516 of file WaspACC.cpp.

References ACC_DIRECTION, AccEventMode, attachInt(), ctrlReg1, ctrlReg2, ctrlReg3, DD_CFG, DD_THSE_H, DD_THSE_H_val, DD_THSE_L, DD_THSE_L_val, DD_THSI_H, DD_THSI_H_val, DD_THSI_L, DD_THSI_L_val, flag, HP_FILTER_RESET, IEND, LIR, readRegister(), unsetDD(), and writeRegister().

{
  // make sure it gets configured for whatever direction
  // people choose like e.g. XHIE or ZLIE
  directions |= (IEND | LIR);

  // clear the DD interrupt if active
  unsetDD();
   
  // configure the different registers to 
  // handle acceleration detection on the X, Y, or Z axis
  writeRegister(ctrlReg1, 0xC7);
  writeRegister(ctrlReg2, 0x08); 
  writeRegister(ctrlReg3, 0x4B);
  
  // here we have to double-check if we
  // are in 12 or 16bit data modes. The 12
  // bit data mode is giving away the 4LSBs
  // therefore the register needs to be written
  // according to that. 0x3C00 is just below 1g
  // but the acc will give 0x03C0, beware!
  writeRegister(DD_THSI_L, DD_THSI_L_val);  // threshold L internal
  writeRegister(DD_THSI_H, DD_THSI_H_val);  // threshold H internal
  writeRegister(DD_THSE_L, DD_THSE_L_val);  // threshold L external
  writeRegister(DD_THSE_H, DD_THSE_H_val);  // threshold H external
  readRegister(HP_FILTER_RESET);   // config the acc. to get current acceleration as initial val
  writeRegister(DD_CFG, directions);  // config accelerometer to wake up 

  // assign the ACC_FREE_FALL mode
  AccEventMode |= ACC_DIRECTION;

  // attach the hardware interrupt to the pin
  attachInt();

  return flag;
}

Here is the call graph for this function:

uint8_t WaspACC::setDD

(

void

)

[inline]

It sets the Direction Change interrupt using the parameters previously defined.

Parameters:

void

Returns:

'flag' variable

See also:

setDD(uint8_t directions)

Definition at line 707 of file WaspACC.h.

References DD_CFG_val, and flag.

{ setDD(DD_CFG_val); return flag; }

uint8_t WaspACC::unsetDD

(

void

)

It unsets the Direction Change interrupt.

Parameters:

void

Returns:

'flag' variable

See also:

setFF()

Definition at line 556 of file WaspACC.cpp.

References ACC_DIRECTION, AccEventMode, DD_ACK, DD_CFG, detachInt(), flag, readRegister(), and writeRegister().

Referenced by setDD().

{

  writeRegister(DD_CFG, 0x00);
  readRegister(DD_ACK);  // clear the interrupt flag

  // detach the event if there are no flags active
  AccEventMode &= ~(ACC_DIRECTION);
  if (!AccEventMode) detachInt();
  return flag;
}

Here is the call graph for this function:

Here is the caller graph for this function:

uint8_t WaspACC::getMode

(

)

It gets the accelerometer's work mode.

Parameters:

void

Returns:

'accMode' variable

See also:

setMode(uint8_t val)

Definition at line 415 of file WaspACC.cpp.

References accMode.

{
  return accMode;
}

uint8_t WaspACC::setMode

(

uint8_t

val

)

It sets the accelerometer's work mode.

Parameters:

uint8_t

val : the accelerometer's work mode (ACC_ON, ACC_HIBERNATE, ACC_CUSTOM)

Returns:

'0' if no error

See also:

getMode()

Definition at line 433 of file WaspACC.cpp.

References ACC_CUSTOM, ACC_HIBERNATE, ACC_ON, accMode, B00000000, B00000111, B00001000, B01000111, ctrlReg1, ctrlReg2, ctrlReg3, and writeRegister().

Referenced by close(), and ON().

{
  accMode = mode;

  if (mode == ACC_HIBERNATE)
  {
        writeRegister(ctrlReg2,B00000000); // de-activate RDY 
        writeRegister(ctrlReg1,B00000111); // turn power off 
  }

  if (mode == ACC_ON)
  {
        writeRegister(ctrlReg2, B00000000);
        writeRegister(ctrlReg1, B01000111); // turn power ON
        writeRegister(ctrlReg3, B00001000);
  }

  if (mode == ACC_CUSTOM)
  {
        // here the custom mode has to be defined by expert users
  }

  // go out with no error, leaves room to implement an error function
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

uint8_t WaspACC::getAccEvent

(

void

)

It gets the accelerometer's event type.

Parameters:

void

Returns:

'AccEventMode' variable

See also:

setAccEvent(uint8_t val)

Definition at line 575 of file WaspACC.cpp.

References AccEventMode.

{
  return AccEventMode;
}

uint8_t WaspACC::setAccEvent

(

uint8_t

val

)

It sets the accelerometer's event type.

Parameters:

uint8_t

val : accelerometer's event type (ACC_NONE, ACC_FREE_FALL, ACC_DIRECTION, ACC_THRESHOLD)

Returns:

'0' if no error

See also:

getMode()

Definition at line 590 of file WaspACC.cpp.

References ACC_DIRECTION, ACC_FREE_FALL, ACC_NONE, and AccEventMode.

{
  AccEventMode = mode;

  if (mode & ACC_DIRECTION)
  {
  }

  if (mode == ACC_FREE_FALL)
  {
  }

  if (mode == ACC_NONE)
  {
  }

  // go out with no error, leaves room to implement an error function
  return 0;
}

void WaspACC::attachInt

(

void

)

It configures the specific hardware interrupt for the acc.

Parameters:

void

Returns:

void

See also:

detachInt()

Definition at line 619 of file WaspACC.cpp.

References ACC_INT, and enableInterrupts().

Referenced by setDD(), and setFF().

{
        enableInterrupts(ACC_INT);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void WaspACC::detachInt

(

void

)

It unsets the specific hardware interrupt for the acc.

Parameters:

void

Returns:

void

See also:

attachInt()

Definition at line 627 of file WaspACC.cpp.

References ACC_INT, and disableInterrupts().

Referenced by unsetDD(), and unsetFF().

{
  disableInterrupts(ACC_INT);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void WaspACC::clearAlarmFlag

(

void

)

It clears the Accelerometer's alarm flag.

Parameters:

void

Returns:

void

Definition at line 636 of file WaspACC.cpp.

References DD_ACK, DD_CFG, FF_WU_ACK, FF_WU_CFG, readRegister(), and writeRegister().

{
        writeRegister(FF_WU_CFG, 0x00);  
        readRegister(FF_WU_ACK);  // clear the interrupt flag
        
        writeRegister(DD_CFG, 0x00);
        readRegister(DD_ACK);  // clear the interrupt flag
}

Here is the call graph for this function:

---

Field Documentation

uint8_t WaspACC::accMode [private]

Variable : Accelerometer Operation Mode.

Possible values are ACC_ON, ACC_HIBERNATE and ACC_CUSTOM

Definition at line 484 of file WaspACC.h.

Referenced by begin(), getMode(), and setMode().

uint8_t WaspACC::AccEventMode [private]

Variable : Accelerometer Event Mode.

Possible values are ACC_NONE, ACC_FREE_FALL, ACC_DIRECTION, ACC_THRESHOLD

Definition at line 490 of file WaspACC.h.

Referenced by getAccEvent(), setAccEvent(), setDD(), setFF(), unsetDD(), and unsetFF().

volatile uint8_t WaspACC::flag

Variable : status flag, used to see if there has been an error while reading/writing or if there has been a hardware interrupt.

Possible values are ACC_ERROR_READING or ACC_ERROR_WRITING

Definition at line 506 of file WaspACC.h.

Referenced by readRegister(), setDD(), setFF(), unsetDD(), unsetFF(), and writeRegister().

uint8_t WaspACC::flagInt

Variable : interrupt flag, used to check which interrupt got active.

Its structure is: (MSB) 7 6 5 4 3 2 1 0 (LSB) XX XX XX XX XX TH DD FF TH - threshold, DD - direction change, FF - free fall

Definition at line 515 of file WaspACC.h.

---

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

• WaspACC.h
• WaspACC.cpp