x_nucleo_iks01a1_magneto.h

00001 /**
00002  ******************************************************************************
00003  * @file    x_nucleo_iks01a1_magneto.h
00004  * @author  MEMS Application Team
00005  * @version V1.0.0
00006  * @date    30-July-2014
00007  * @brief   This file contains definitions for the x_nucleo_iks01a1_magneto.c 
00008  ******************************************************************************
00009  * @attention
00010  *
00011  * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
00012  *
00013  * Redistribution and use in source and binary forms, with or without modification,
00014  * are permitted provided that the following conditions are met:
00015  *   1. Redistributions of source code must retain the above copyright notice,
00016  *      this list of conditions and the following disclaimer.
00017  *   2. Redistributions in binary form must reproduce the above copyright notice,
00018  *      this list of conditions and the following disclaimer in the documentation
00019  *      and/or other materials provided with the distribution.
00020  *   3. Neither the name of STMicroelectronics nor the names of its contributors
00021  *      may be used to endorse or promote products derived from this software
00022  *      without specific prior written permission.
00023  *
00024  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00025  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00026  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00027  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00028  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00029  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00030  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00031  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00032  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00033  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00034  *
00035  ******************************************************************************
00036  */
00037 
00038 /* Define to prevent recursive inclusion -------------------------------------*/
00039 #ifndef __X_NUCLEO_IKS01A1_MAGNETO_H
00040 #define __X_NUCLEO_IKS01A1_MAGNETO_H
00041 
00042 #ifdef __cplusplus
00043 extern "C" {
00044 #endif
00045 
00046 /* Includes ------------------------------------------------------------------*/
00047 #include "x_nucleo_iks01a1.h"
00048 /* Include nine axes sensor component driver */
00049 #include "lis3mdl.h"
00050 
00051 /** @addtogroup BSP
00052  * @{
00053  */
00054 
00055 /** @addtogroup X_NUCLEO_IKS01A1
00056  * @{
00057  */
00058 
00059 /** @addtogroup X_NUCLEO_IKS01A1_MAGNETO
00060  * @{
00061  */
00062 
00063 /** @defgroup X_NUCLEO_IKS01A1_MAGNETO_Exported_Constants
00064  * @{
00065  */
00066 
00067 /**
00068  * @}
00069  */
00070 
00071 /** @defgroup X_NUCLEO_IKS01A1_MAGNETO_Exported_Macros
00072  * @{
00073  */
00074 
00075 /**
00076  * @}
00077  */
00078 
00079 /** @defgroup X_NUCLEO_IKS01A1_MAGNETO_Exported_Functions
00080  * @{
00081  */
00082 /* Sensor Configuration Functions */
00083 MAGNETO_StatusTypeDef BSP_MAGNETO_Init(void);
00084 uint8_t BSP_MAGNETO_isInitialized(void);
00085 uint8_t BSP_MAGNETO_Read_M_ID(void);
00086 MAGNETO_StatusTypeDef BSP_MAGNETO_Check_M_ID(void);
00087 void BSP_MAGNETO_M_GetAxesRaw(AxesRaw_TypeDef *pData);
00088 
00089 /**
00090  * @}
00091  */
00092 
00093 /**
00094  * @}
00095  */
00096 
00097 /**
00098  * @}
00099  */
00100 
00101 /**
00102  * @}
00103  */
00104 
00105 #ifdef __cplusplus
00106 }
00107 #endif
00108 
00109 #endif /* __X_NUCLEO_IKS01A1_MAGNETO_H */
00110 
00111 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
00112