Diff: Components/lis3mdl/lis3mdl_class.h

Revision:

5:8bab0f419849

Child:

6:8d2abd695c52

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Components/lis3mdl/lis3mdl_class.h	Wed Apr 15 12:10:42 2015 +0200
@@ -0,0 +1,145 @@
+/**
+ ******************************************************************************
+ * @file    lis3mdl_class.h
+ * @author  AST / EST
+ * @version V0.0.1
+ * @date    14-April-2015
+ * @brief   Header file for component LIS3MDL
+ ******************************************************************************
+ * @attention
+ *
+ * <h2><center>&copy; 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 __LIS3MDL_CLASS_H
+#define __LIS3MDL_CLASS_H
+
+/* Includes ------------------------------------------------------------------*/
+#include "mbed.h"
+#include "DevI2C.h"
+#include "../Common/Magneto.h"
+#include "lis3mdl.h"
+
+/* Classes -------------------------------------------------------------------*/
+/** Class representing a LIS3MDL sensor component
+ */
+class LIS3MDL : public Magneto {
+ public:
+	/** Constructor
+	 * @param i2c device I2C to be used for communication
+	 */
+        LIS3MDL(DevI2C &i2c) : Magneto(), dev_i2c(i2c) {
+	}
+	
+	/*** Interface Methods ***/
+	virtual MAGNETO_StatusTypeDef Init(MAGNETO_InitTypeDef *init_struct) {
+		return LIS3MDL_Init(init_struct);
+	}
+
+	virtual MAGNETO_StatusTypeDef Read_M_ID(uint8_t *m_id) {
+		return LIS3MDL_Read_M_ID(m_id);
+	}
+
+	virtual MAGNETO_StatusTypeDef Get_M_Axes(int32_t *pData) {
+		return LIS3MDL_M_GetAxes(pData);
+	}
+
+ protected:
+	/*** Methods ***/
+	MAGNETO_StatusTypeDef LIS3MDL_Init(MAGNETO_InitTypeDef *LIS3MDL_Init);
+	MAGNETO_StatusTypeDef LIS3MDL_Read_M_ID(uint8_t *m_id);
+	MAGNETO_StatusTypeDef LIS3MDL_M_GetAxes(int32_t *pData);
+	MAGNETO_StatusTypeDef LIS3MDL_M_GetAxesRaw(int16_t *pData);
+
+	/**
+	 * @brief  Configures LIS3MDL interrupt lines for NUCLEO boards
+	 * @param  None
+	 * @retval None
+	 */
+	void LIS3MDL_IO_ITConfig(void)
+	{
+		/* To be implemented */
+	}
+
+	/**
+	 * @brief  Configures LIS3MDL I2C interface
+	 * @param  None
+	 * @retval MAGNETO_OK in case of success, an error code otherwise
+	 */
+	MAGNETO_StatusTypeDef LIS3MDL_IO_Init(void)
+	{
+		return MAGNETO_OK; /* done in constructor */
+	}
+
+	/**
+	 * @brief utility function to read data from STC3115
+	 * @param  pBuffer: pointer to data to be read.
+	 * @param  RegisterAddr: specifies internal address register to read from.
+	 * @param  NumByteToRead: number of bytes to be read.
+	 * @retval MAGNETO_OK if ok, MAGNETO_ERROR if an I2C error has occured
+	 */
+	MAGNETO_StatusTypeDef LIS3MDL_IO_Read(uint8_t* pBuffer, 
+					      uint8_t RegisterAddr, uint16_t NumByteToRead)
+	{
+		int ret = dev_i2c.i2c_read(pBuffer,
+					   LIS3MDL_M_MEMS_ADDRESS,
+					   RegisterAddr,
+					   NumByteToRead);
+		if(ret != 0) {
+			return MAGNETO_ERROR;
+		}
+		return MAGNETO_OK;
+	}
+	
+	/**
+	 * @brief utility function to write data to STC3115
+	 * @param  pBuffer: pointer to buffer to be filled.
+	 * @param  RegisterAddr: specifies internal address register to read from.
+	 * @param  NumByteToWrite: number of bytes to write.
+	 * @retval 0 if ok, -1 if an I2C error has occured
+	 */
+	MAGNETO_StatusTypeDef LIS3MDL_IO_Write(uint8_t* pBuffer, 
+					       uint8_t RegisterAddr, uint16_t NumByteToWrite)
+	{
+		int ret = dev_i2c.i2c_write(pBuffer,
+					    LIS3MDL_M_MEMS_ADDRESS,
+					    RegisterAddr,
+					    NumByteToWrite);
+		if(ret != 0) {
+			return MAGNETO_ERROR;
+		}
+		return MAGNETO_OK;
+	}
+	
+	/*** Instance Variables ***/
+	/* IO Device */
+	DevI2C &dev_i2c;
+
+	/* TODO */
+};
+
+#endif // __LIS3MDL_CLASS_H