accelerometer.h

Go to the documentation of this file.

/*************************************************************************//**
 * \file heivs/accelerometer.h
 * \brief ARMEBS4 accelerometer access functions
 * \author Pascal Sartoretti (sap at hevs dot ch)
 *
 * \defgroup accelerometer Accelerometer
 * @{
 *
 * \brief Measures the acceleration force that is applied to the board
 *
 * \ingroup onboard
 *
 * The acceleration force applied to the device is measured on all three
 * (x, y, z) physical axes and includes the force of gravity.
 *
 * \image html accelerometer.jpg
 * \image latex accelerometer.eps
 *
 * This kind of device is typically used to :
 * - Simulate a spirit level
 * - Rotate the screen according to the orientation of the device
 * - Detect free fall (in hard drives)
 *
 ****************************************************************************/

#include <stdint.h>
#include "heivs/error.h"

/*************************************************************************//**
 * \brief Accelerometer data
 ****************************************************************************/
struct accelerometer_data_t
{
    int8_t x;       ///< x axis acceleration value (31 to -32)
    int8_t y;       ///< y axis acceleration value (31 to -32)
    int8_t z;       ///< z axis acceleration value (31 to -32)
};

#ifdef __cplusplus
    extern "C" {
#endif
/*************************************************************************//**
 * \brief Initialize the accelerometer
 * \return #NO_ERROR for no problem
 *
 * Accelerometer is initialized for fast acquisition
 ****************************************************************************/
status_e Accel_Init(void);

/*************************************************************************//**
 * \brief Read data from accelerometer
 * \param data Pointer to structure of data
 * \return #NO_ERROR for no problem
 ****************************************************************************/
status_e Accel_Read(struct accelerometer_data_t *data);

/*************************************************************************//**
 * \brief Write special config to accelrometer
 * \param reg Register address to write in
 * \param data Data byte to write in this register
 * \return #NO_ERROR for no problem
 ****************************************************************************/
status_e Accel_WriteCfg(uint8_t reg, uint8_t data);

#ifdef __cplusplus
    }
#endif

/**
 * @}
 */