sensor.h

00001 /**
00002  ******************************************************************************
00003  * @file    sensor.h
00004  * @author  MEMS Application Team
00005  * @brief   This header file contains the functions prototypes common for all
00006  *          sensor drivers
00007  ******************************************************************************
00008  * @attention
00009  *
00010  * <h2><center>&copy; COPYRIGHT(c) 2018 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 /* Define to prevent recursive inclusion -------------------------------------*/
00038 #ifndef __SENSOR_H
00039 #define __SENSOR_H
00040 
00041 #ifdef __cplusplus
00042 extern "C" {
00043 #endif
00044 
00045 
00046 
00047 /* Includes ------------------------------------------------------------------*/
00048 
00049 #include <string.h>
00050 #include "component.h"
00051 
00052 /** @addtogroup BSP BSP
00053  * @{
00054  */
00055 
00056 /** @addtogroup COMPONENTS COMPONENTS
00057  * @{
00058  */
00059 
00060 /** @addtogroup COMMON COMMON
00061  * @{
00062  */
00063 
00064 /** @addtogroup SENSOR SENSOR
00065  * @{
00066  */
00067 
00068 /** @addtogroup SENSOR_Public_Types SENSOR Public types
00069  * @{
00070  */
00071 
00072 /**
00073  * @brief  Sensor axes raw data structure definition
00074  */
00075 typedef struct
00076 {
00077   int16_t AXIS_X;
00078   int16_t AXIS_Y;
00079   int16_t AXIS_Z;
00080 } SensorAxesRaw_t;
00081 
00082 /**
00083  * @brief  Sensor axes data structure definition
00084  */
00085 typedef struct
00086 {
00087   int32_t AXIS_X;
00088   int32_t AXIS_Y;
00089   int32_t AXIS_Z;
00090 } SensorAxes_t;
00091 
00092 /**
00093  * @brief  Sensor output data rate enumerator definition
00094  */
00095 typedef enum
00096 {
00097   ODR_LOW,
00098   ODR_MID_LOW,
00099   ODR_MID,
00100   ODR_MID_HIGH,
00101   ODR_HIGH
00102 } SensorOdr_t;
00103 
00104 /**
00105  * @brief  Sensor full scale enumerator definition
00106  */
00107 typedef enum
00108 {
00109   FS_LOW,
00110   FS_MID_LOW,
00111   FS_MID,
00112   FS_MID_HIGH,
00113   FS_HIGH
00114 } SensorFs_t;
00115 
00116 /**
00117  * @brief  Sensor interrupt pin enumerator definition
00118  */
00119 typedef enum
00120 {
00121   INT1_PIN,
00122   INT2_PIN
00123 } SensorIntPin_t;
00124 
00125 /**
00126  * @}
00127  */
00128 
00129 /**
00130  * @}
00131  */
00132 
00133 /**
00134  * @}
00135  */
00136 
00137 /**
00138  * @}
00139  */
00140 
00141 /**
00142  * @}
00143  */
00144 
00145 #ifdef __cplusplus
00146 }
00147 #endif
00148 
00149 #endif /* __SENSOR_H */
00150 
00151 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/