Diff: X_NUCLEO_IKS01A2/Components/LSM303AGRSensor/LSM303AGR_ACC_Sensor.h

Revision:

1:0db1dabf7b69

Parent:

0:489965565a0d

Child:

2:39ad2a393143

--- a/X_NUCLEO_IKS01A2/Components/LSM303AGRSensor/LSM303AGR_ACC_Sensor.h	Fri Aug 12 13:42:49 2016 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,149 +0,0 @@
-/**
- ******************************************************************************
- * @file    LSM303AGR_ACC_Sensor.h
- * @author  AST
- * @version V1.0.0
- * @date    5 August 2016
- * @brief   Abstract Class of an LSM303AGR accelerometer sensor.
- ******************************************************************************
- * @attention
- *
- * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
- *
- * Redistribution and use in source and binary forms, with or without modification,
- * are permitted provided that the following conditions are met:
- *   1. Redistributions of source code must retain the above copyright notice,
- *      this list of conditions and the following disclaimer.
- *   2. Redistributions in binary form must reproduce the above copyright notice,
- *      this list of conditions and the following disclaimer in the documentation
- *      and/or other materials provided with the distribution.
- *   3. Neither the name of STMicroelectronics nor the names of its contributors
- *      may be used to endorse or promote products derived from this software
- *      without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- ******************************************************************************
- */
-
-
-/* Prevent recursive inclusion -----------------------------------------------*/
-
-#ifndef __LSM303AGR_ACC_Sensor_H__
-#define __LSM303AGR_ACC_Sensor_H__
-
-
-/* Includes ------------------------------------------------------------------*/
-
-#include "DevI2C.h"
-#include "LSM303AGR_ACC_driver.h"
-
-/* Defines -------------------------------------------------------------------*/
-#define LSM303AGR_ACC_SENSITIVITY_FOR_FS_2G_NORMAL_MODE               3.900f  /**< Sensitivity value for 2 g full scale and normal mode [mg/LSB] */
-#define LSM303AGR_ACC_SENSITIVITY_FOR_FS_2G_HIGH_RESOLUTION_MODE      0.980f  /**< Sensitivity value for 2 g full scale and high resolution mode [mg/LSB] */
-#define LSM303AGR_ACC_SENSITIVITY_FOR_FS_2G_LOW_POWER_MODE           15.630f  /**< Sensitivity value for 2 g full scale and low power mode [mg/LSB] */
-#define LSM303AGR_ACC_SENSITIVITY_FOR_FS_4G_NORMAL_MODE               7.820f  /**< Sensitivity value for 4 g full scale and normal mode [mg/LSB] */
-#define LSM303AGR_ACC_SENSITIVITY_FOR_FS_4G_HIGH_RESOLUTION_MODE      1.950f  /**< Sensitivity value for 4 g full scale and high resolution mode [mg/LSB] */
-#define LSM303AGR_ACC_SENSITIVITY_FOR_FS_4G_LOW_POWER_MODE           31.260f  /**< Sensitivity value for 4 g full scale and low power mode [mg/LSB] */
-#define LSM303AGR_ACC_SENSITIVITY_FOR_FS_8G_NORMAL_MODE              15.630f  /**< Sensitivity value for 8 g full scale and normal mode [mg/LSB] */
-#define LSM303AGR_ACC_SENSITIVITY_FOR_FS_8G_HIGH_RESOLUTION_MODE      3.900f  /**< Sensitivity value for 8 g full scale and high resolution mode [mg/LSB] */
-#define LSM303AGR_ACC_SENSITIVITY_FOR_FS_8G_LOW_POWER_MODE           62.520f  /**< Sensitivity value for 8 g full scale and low power mode [mg/LSB] */
-#define LSM303AGR_ACC_SENSITIVITY_FOR_FS_16G_NORMAL_MODE             46.900f  /**< Sensitivity value for 16 g full scale and normal mode [mg/LSB] */
-#define LSM303AGR_ACC_SENSITIVITY_FOR_FS_16G_HIGH_RESOLUTION_MODE    11.720f  /**< Sensitivity value for 16 g full scale and high resolution mode [mg/LSB] */
-#define LSM303AGR_ACC_SENSITIVITY_FOR_FS_16G_LOW_POWER_MODE         187.580f  /**< Sensitivity value for 16 g full scale and low power mode [mg/LSB] */
-
-
-/* Typedefs ------------------------------------------------------------------*/
-typedef enum
-{
-  LSM303AGR_ACC_STATUS_OK = 0,
-  LSM303AGR_ACC_STATUS_ERROR,
-  LSM303AGR_ACC_STATUS_TIMEOUT,
-  LSM303AGR_ACC_STATUS_NOT_IMPLEMENTED
-} LSM303AGR_ACC_StatusTypeDef;
-
-
-/* Class Declaration ---------------------------------------------------------*/
-
-/**
- * Abstract class of an LSM303AGR Inertial Measurement Unit (IMU) 6 axes
- * sensor.
- */
-class LSM303AGR_ACC_Sensor
-{
-  public:
-    LSM303AGR_ACC_Sensor                       (DevI2C &i2c);
-    LSM303AGR_ACC_Sensor                       (DevI2C &i2c, uint8_t address);
-    LSM303AGR_ACC_StatusTypeDef Enable         (void);
-    LSM303AGR_ACC_StatusTypeDef Disable        (void);
-    LSM303AGR_ACC_StatusTypeDef ReadID         (uint8_t *p_id);
-    LSM303AGR_ACC_StatusTypeDef GetAxes        (int32_t *pData);
-    LSM303AGR_ACC_StatusTypeDef GetSensitivity (float *pfData);
-    LSM303AGR_ACC_StatusTypeDef GetAxesRaw     (int16_t *pData);
-    LSM303AGR_ACC_StatusTypeDef GetODR         (float *odr);
-    LSM303AGR_ACC_StatusTypeDef SetODR         (float odr);
-    LSM303AGR_ACC_StatusTypeDef GetFS          (float *fullScale);
-    LSM303AGR_ACC_StatusTypeDef SetFS          (float fullScale);
-    LSM303AGR_ACC_StatusTypeDef ReadReg        (uint8_t reg, uint8_t *data);
-    LSM303AGR_ACC_StatusTypeDef WriteReg       (uint8_t reg, uint8_t data);
-    
-    /**
-     * @brief Utility function to read data.
-     * @param  pBuffer: pointer to data to be read.
-     * @param  RegisterAddr: specifies internal address register to be read.
-     * @param  NumByteToRead: number of bytes to be read.
-     * @retval 0 if ok, an error code otherwise.
-     */
-    uint8_t IO_Read(uint8_t* pBuffer, uint8_t RegisterAddr, uint16_t NumByteToRead)
-    {
-        return (uint8_t) dev_i2c.i2c_read(pBuffer, address, RegisterAddr, NumByteToRead);
-    }
-    
-    /**
-     * @brief Utility function to write data.
-     * @param  pBuffer: pointer to data to be written.
-     * @param  RegisterAddr: specifies internal address register to be written.
-     * @param  NumByteToWrite: number of bytes to write.
-     * @retval 0 if ok, an error code otherwise.
-     */
-    uint8_t IO_Write(uint8_t* pBuffer, uint8_t RegisterAddr, uint16_t NumByteToWrite)
-    {
-        return (uint8_t) dev_i2c.i2c_write(pBuffer, address, RegisterAddr, NumByteToWrite);
-    }
-
-  private:
-    LSM303AGR_ACC_StatusTypeDef SetODR_When_Enabled(float odr);
-    LSM303AGR_ACC_StatusTypeDef SetODR_When_Disabled(float odr);
-    LSM303AGR_ACC_StatusTypeDef GetSensitivity_Normal_Mode( float *sensitivity );
-    LSM303AGR_ACC_StatusTypeDef GetSensitivity_LP_Mode( float *sensitivity );
-    LSM303AGR_ACC_StatusTypeDef GetSensitivity_HR_Mode( float *sensitivity );
-
-    /* Helper classes. */
-    DevI2C &dev_i2c;
-    
-    /* Configuration */
-    uint8_t address;
-    
-    uint8_t isEnabled;
-    float Last_ODR;
-};
-
-#ifdef __cplusplus
- extern "C" {
-#endif
-uint8_t LSM303AGR_ACC_IO_Write( void *handle, uint8_t WriteAddr, uint8_t *pBuffer, uint16_t nBytesToWrite );
-uint8_t LSM303AGR_ACC_IO_Read( void *handle, uint8_t ReadAddr, uint8_t *pBuffer, uint16_t nBytesToRead );
-#ifdef __cplusplus
-  }
-#endif
-
-#endif