uv.h

00001 /**
00002   ******************************************************************************
00003   * @file    UV.h
00004   * @author  AST Robotics Team
00005   * @version V0.0.1
00006   * @date    06-March-2014
00007   * @brief   This header file contains the functions prototypes for the uv driver.
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 
00039 /* Define to prevent recursive inclusion -------------------------------------*/
00040 #ifndef __UV_H
00041 #define __UV_H
00042 
00043 #ifdef __cplusplus
00044  extern "C" {
00045 #endif
00046 
00047 /* Includes ------------------------------------------------------------------*/
00048 #include <stdint.h> 
00049 
00050 typedef struct
00051 {
00052   uint8_t Power_Mode;                         /* Power-down/Sleep/Normal Mode */
00053   uint8_t Output_DataRate;                    /* OUT data rate */
00054   //uint8_t Reboot_Mode;                        /* Normal Mode/Reboot memory content */
00055   //uint8_t DifferentialThreshold;              /* Differential Threshold */
00056 }UV_InitTypeDef;
00057 
00058 /** 
00059   * @brief  UV driver structure definition  
00060   */ 
00061 typedef struct
00062 {  
00063   void       (*Init)(UV_InitTypeDef *);
00064   uint8_t    (*ReadID)(void);
00065   void       (*Reset)(void);
00066   void       (*ConfigIT)(uint16_t); 
00067   void       (*EnableIT)(uint8_t);
00068   void       (*DisableIT)(uint8_t);  
00069   uint8_t    (*ITStatus)(uint16_t, uint16_t);   
00070   void       (*ClearIT)(uint16_t, uint16_t); 
00071   void       (*GetIndex)(float *);
00072 }UV_DrvTypeDef;
00073 
00074 
00075 /**
00076   * @}
00077   */ 
00078 
00079 #ifdef __cplusplus
00080 }
00081 #endif
00082 
00083 #endif /* __UV_H */
00084 /**
00085   * @}
00086   */
00087 
00088 /**
00089   * @}
00090   */
00091 
00092 /**
00093   * @}
00094   */ 
00095 
00096 
00097 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ 
00098