STM32F3-Discovery BSP User Manual: stm32f3_discovery_accelerometer.h Source File

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