upm/src/adxl345/adxl345.h
Mihai Tudor Panu a4e590ae3a adxl345: Grove 3-Axis Accelerometer
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
2015-01-23 17:58:29 -08:00

100 lines
2.8 KiB
C++

/*
* Author: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
* Copyright (c) 2014 Intel Corporation.
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#pragma once
#include <mraa/i2c.h>
#define READ_BUFFER_LENGTH 6
namespace upm {
/**
* @brief Adxl345 accelerometer library
* @defgroup adxl345 libupm-adxl345
*/
/**
* @brief C++ API for Adxl345 (3-axis digital accelerometer)
*
* The Adxl345 is a 3-axis digital accelerometer.
* (http://www.seeedstudio.com/wiki/images/2/2c/ADXL345_datasheet.pdf)
* The sensor has configurable resolutions for measuring ±2g, ±4g, ±8g or ±16g.
* Note that the sensor it is incompatible and will not be detected on the I2C bus
* by the Intel Edison using the Arduino breakout board at 5V (3V3 will work fine).
*
* @ingroup adxl345 i2c
* @snippet adxl345.cxx Interesting
* @image html adxl345.jpeg
*/
class Adxl345 {
public:
/**
* Creates an Adxl345 object
*
* @param bus number of used i2c bus
*/
Adxl345(int bus);
/**
* Adxl345 object destructor
*/
~Adxl345();
/**
* Returns a pointer to a float[3] that contains acceleration (g) forces
*
* @return float* to a float[3]
*/
float* getAcceleration();
/**
* Returns a pointer to an int[3] that contains the raw register values for X, Y and Z
*
* @return int* to an int[3]
*/
int16_t* getRawValues();
/**
* Returns the scale the accelerometer is currently set up to: 2, 4, 8 or 16
*
* @return uint with current scale value
*/
uint8_t getScale();
/**
* Updates the acceleration values from i2c bus
*
* @return 0 for success
*/
mraa_result_t update();
private:
float m_accel[3];
float m_offsets[3];
int16_t m_rawaccel[3];
uint8_t m_buffer[READ_BUFFER_LENGTH];
mraa_i2c_context m_i2c;
};
}