stm32l475e_iot01_magneto.h

00001 /**
00002   ******************************************************************************
00003   * @file    stm32l475e_iot01_magneto.h
00004   * @author  MCD Application Team
00005   * @brief   This file provides a set of functions needed to manage the magnetometer sensor
00006   ******************************************************************************
00007   * @attention
00008   *
00009   * <h2><center>&copy; Copyright (c) 2017 STMicroelectronics International N.V.
00010   * All rights reserved.</center></h2>
00011   *
00012   * Redistribution and use in source and binary forms, with or without
00013   * modification, are permitted, provided that the following conditions are met:
00014   *
00015   * 1. Redistribution 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 other
00021   *    contributors to this software may be used to endorse or promote products
00022   *    derived from this software without specific written permission.
00023   * 4. This software, including modifications and/or derivative works of this
00024   *    software, must execute solely and exclusively on microcontroller or
00025   *    microprocessor devices manufactured by or for STMicroelectronics.
00026   * 5. Redistribution and use of this software other than as permitted under
00027   *    this license is void and will automatically terminate your rights under
00028   *    this license.
00029   *
00030   * THIS SOFTWARE IS PROVIDED BY STMICROELECTRONICS AND CONTRIBUTORS "AS IS"
00031   * AND ANY EXPRESS, IMPLIED OR STATUTORY WARRANTIES, INCLUDING, BUT NOT
00032   * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
00033   * PARTICULAR PURPOSE AND NON-INFRINGEMENT OF THIRD PARTY INTELLECTUAL PROPERTY
00034   * RIGHTS ARE DISCLAIMED TO THE FULLEST EXTENT PERMITTED BY LAW. IN NO EVENT
00035   * SHALL STMICROELECTRONICS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00036   * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00037   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
00038   * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00039   * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00040   * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
00041   * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00042   *
00043   ******************************************************************************
00044   */
00045 
00046 /* Define to prevent recursive inclusion -------------------------------------*/
00047 #ifndef __STM32L475E_IOT01_MAGNETO_H
00048 #define __STM32L475E_IOT01_MAGNETO_H
00049 
00050 #ifdef __cplusplus
00051  extern "C" {
00052 #endif
00053 
00054 /* Includes ------------------------------------------------------------------*/
00055 #include "stm32l475e_iot01.h"   
00056 /* Include Magnetometer component driver */
00057 #include "../Components/lis3mdl/lis3mdl.h"  
00058    
00059 /** @addtogroup BSP
00060   * @{
00061   */
00062 
00063 /** @addtogroup STM32L475E_IOT01
00064   * @{
00065   */
00066       
00067 /** @addtogroup STM32L475E_IOT01_MAGNETO
00068   * @{
00069   */ 
00070 
00071 /** @defgroup STM32L475_IOT01_MAGNETO_Exported_Types MAGNETO Exported Types
00072   * @{
00073   */   
00074 /* Exported types ------------------------------------------------------------*/
00075 typedef enum 
00076 {
00077   MAGNETO_OK = 0,
00078   MAGNETO_ERROR = 1,
00079   MAGNETO_TIMEOUT = 2
00080 } 
00081 MAGNETO_StatusTypeDef;
00082 /**
00083   * @}
00084   */
00085 
00086 /** @defgroup STM32L475E_IOT01_MAGNETO_Exported_Functions MAGNETO Exported Functions
00087   * @{
00088   */ 
00089 MAGNETO_StatusTypeDef BSP_MAGNETO_Init(void);
00090 void BSP_MAGNETO_DeInit(void);
00091 void BSP_MAGNETO_LowPower(uint16_t status); /* 0 Means Disable Low Power Mode, otherwise Low Power Mode is enabled */
00092 void BSP_MAGNETO_GetXYZ(int16_t *pDataXYZ);
00093 /**
00094   * @}
00095   */
00096 
00097 /**
00098   * @}
00099   */
00100 
00101 /**
00102   * @}
00103   */
00104 
00105 /**
00106   * @}
00107   */
00108 
00109 #ifdef __cplusplus
00110 }
00111 #endif
00112 
00113 #endif /* __STM32L475E_IOT01_MAGNETO_H */
00114 
00115 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/