Version of the IKS01A1 library for this coursework
Dependencies: X_NUCLEO_COMMON
Fork of X_NUCLEO_IKS01A1 by
Components/lsm6ds0/lsm6ds0_class.h
- Committer:
- noutram
- Date:
- 2017-08-01
- Revision:
- 89:c55aa4c1187f
- Parent:
- 57:04563dd74269
File content as of revision 89:c55aa4c1187f:
/** ****************************************************************************** * @file lsm6ds0_class.h * @author AST / EST * @version V0.0.1 * @date 14-April-2015 * @brief Header file for component LSM6DS0 ****************************************************************************** * @attention * * <h2><center>© COPYRIGHT(c) 2015 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. * ****************************************************************************** */ #ifndef __LSM6DS0_CLASS_H #define __LSM6DS0_CLASS_H /* Includes ------------------------------------------------------------------*/ #include "mbed.h" #include "DevI2C.h" #include "lsm6ds0.h" #include "../Interfaces/GyroSensor.h" #include "../Interfaces/MotionSensor.h" /* Classes -------------------------------------------------------------------*/ /** Class representing a LSM6DS0 sensor component */ class LSM6DS0 : public GyroSensor, public MotionSensor { public: /** Constructor * @param[in] i2c device I2C to be used for communication */ LSM6DS0(DevI2C &i2c) : GyroSensor(), MotionSensor(), dev_i2c(i2c) { } /** Destructor */ virtual ~LSM6DS0() {} /*** Interface Methods ***/ virtual int Init(void *init_struct) { return LSM6DS0_Init((IMU_6AXES_InitTypeDef*)init_struct); } virtual int ReadID(uint8_t *xg_id) { return LSM6DS0_Read_XG_ID(xg_id); } virtual int Get_X_Axes(int32_t *pData) { return LSM6DS0_X_GetAxes(pData); } virtual int Get_X_AxesRaw(int16_t *pData) { return LSM6DS0_X_GetAxesRaw(pData); } virtual int Get_G_Axes(int32_t *pData) { return LSM6DS0_G_GetAxes(pData); } virtual int Get_G_AxesRaw(int16_t *pData) { return LSM6DS0_G_GetAxesRaw(pData); } virtual int Get_X_ODR(float *odr) { return LSM6DS0_X_Get_ODR(odr); } virtual int Set_X_ODR(float odr) { return LSM6DS0_X_Set_ODR(odr); } virtual int Get_X_Sensitivity(float *pfData) { return LSM6DS0_X_GetSensitivity(pfData); } virtual int Get_X_FS(float *fullScale) { return LSM6DS0_X_Get_FS(fullScale); } virtual int Set_X_FS(float fullScale) { return LSM6DS0_X_Set_FS(fullScale); } virtual int Get_G_ODR(float *odr) { return LSM6DS0_G_Get_ODR(odr); } virtual int Set_G_ODR(float odr) { return LSM6DS0_G_Set_ODR(odr); } virtual int Get_G_Sensitivity(float *pfData) { return LSM6DS0_G_GetSensitivity(pfData); } virtual int Get_G_FS(float *fullScale) { return LSM6DS0_G_Get_FS(fullScale); } virtual int Set_G_FS(float fullScale) { return LSM6DS0_G_Set_FS(fullScale); } protected: /*** Methods ***/ IMU_6AXES_StatusTypeDef LSM6DS0_Init(IMU_6AXES_InitTypeDef *LSM6DS0_Init); IMU_6AXES_StatusTypeDef LSM6DS0_Read_XG_ID(uint8_t *xg_id); IMU_6AXES_StatusTypeDef LSM6DS0_X_GetAxes(int32_t *pData); IMU_6AXES_StatusTypeDef LSM6DS0_X_GetAxesRaw(int16_t *pData); IMU_6AXES_StatusTypeDef LSM6DS0_G_GetAxes(int32_t *pData); IMU_6AXES_StatusTypeDef LSM6DS0_G_GetAxesRaw(int16_t *pData); IMU_6AXES_StatusTypeDef LSM6DS0_X_Get_ODR( float *odr ); IMU_6AXES_StatusTypeDef LSM6DS0_X_Set_ODR( float odr ); IMU_6AXES_StatusTypeDef LSM6DS0_X_GetSensitivity( float *pfData ); IMU_6AXES_StatusTypeDef LSM6DS0_X_Get_FS( float *fullScale ); IMU_6AXES_StatusTypeDef LSM6DS0_X_Set_FS( float fullScale ); IMU_6AXES_StatusTypeDef LSM6DS0_G_Get_ODR( float *odr ); IMU_6AXES_StatusTypeDef LSM6DS0_G_Set_ODR( float odr ); IMU_6AXES_StatusTypeDef LSM6DS0_G_GetSensitivity( float *pfData ); IMU_6AXES_StatusTypeDef LSM6DS0_G_Get_FS( float *fullScale ); IMU_6AXES_StatusTypeDef LSM6DS0_G_Set_FS( float fullScale ); IMU_6AXES_StatusTypeDef LSM6DS0_X_Set_Axes_Status(uint8_t enableX, uint8_t enableY, uint8_t enableZ); IMU_6AXES_StatusTypeDef LSM6DS0_G_Set_Axes_Status(uint8_t enableX, uint8_t enableY, uint8_t enableZ); /** * @brief Configures LSM6DS0 interrupt lines for NUCLEO boards */ void LSM6DS0_IO_ITConfig(void) { /* To be implemented */ } /** * @brief Configures LSM6DS0 I2C interface * @return IMU_6AXES_OK in case of success, an error code otherwise */ IMU_6AXES_StatusTypeDef LSM6DS0_IO_Init(void) { return IMU_6AXES_OK; /* done in constructor */ } /** * @brief Utility function to read data from LSM6DS0 * @param[out] pBuffer pointer to the byte-array to read data in to * @param[in] RegisterAddr specifies internal address register to read from. * @param[in] NumByteToRead number of bytes to be read. * @retval IMU_6AXES_OK if ok, * @retval IMU_6AXES_ERROR if an I2C error has occured */ IMU_6AXES_StatusTypeDef LSM6DS0_IO_Read(uint8_t* pBuffer, uint8_t RegisterAddr, uint16_t NumByteToRead) { int ret = dev_i2c.i2c_read(pBuffer, LSM6DS0_XG_MEMS_ADDRESS, RegisterAddr, NumByteToRead); if(ret != 0) { return IMU_6AXES_ERROR; } return IMU_6AXES_OK; } /** * @brief Utility function to write data to LSM6DS0 * @param[in] pBuffer pointer to the byte-array data to send * @param[in] RegisterAddr specifies internal address register to read from. * @param[in] NumByteToWrite number of bytes to write. * @retval IMU_6AXES_OK if ok, * @retval IMU_6AXES_ERROR if an I2C error has occured */ IMU_6AXES_StatusTypeDef LSM6DS0_IO_Write(uint8_t* pBuffer, uint8_t RegisterAddr, uint16_t NumByteToWrite) { int ret = dev_i2c.i2c_write(pBuffer, LSM6DS0_XG_MEMS_ADDRESS, RegisterAddr, NumByteToWrite); if(ret != 0) { return IMU_6AXES_ERROR; } return IMU_6AXES_OK; } /*** Instance Variables ***/ /* IO Device */ DevI2C &dev_i2c; }; #endif // __LSM6DS0_CLASS_H