STM32F4-Discovery BSP User Manual: stm32f4_discovery_accelerometer.h Source File

STM32F4-Discovery BSP

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