Mustapha hamdi / Light_Sensor_Nucleo

INSAT Mini Project

Dependencies:   ST_INTERFACES X_NUCLEO_COMMON

Fork of X_NUCLEO_6180XA1 by ST

Components/VL6180X/vl6180x_class.h@1:1de1ea2994d9, 2015-09-09 (annotated)

Committer:
gallonm
Date:
Wed Sep 09 16:00:39 2015 +0000
Revision:
1:1de1ea2994d9
Child:
3:454541a079f4
Added some files

Who changed what in which revision?

UserRevisionLine numberNew contents of line
gallonm 1:1de1ea2994d9 1 /**
gallonm 1:1de1ea2994d9 2 ******************************************************************************
gallonm 1:1de1ea2994d9 3 * @file vl6180x_class.h
gallonm 1:1de1ea2994d9 4 * @author AST / EST
gallonm 1:1de1ea2994d9 5 * @version V0.0.1
gallonm 1:1de1ea2994d9 6 * @date 14-April-2015
gallonm 1:1de1ea2994d9 7 * @brief Header file for component VL6180X
gallonm 1:1de1ea2994d9 8 ******************************************************************************
gallonm 1:1de1ea2994d9 9 * @attention
gallonm 1:1de1ea2994d9 10 *
gallonm 1:1de1ea2994d9 11 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
gallonm 1:1de1ea2994d9 12 *
gallonm 1:1de1ea2994d9 13 * Redistribution and use in source and binary forms, with or without modification,
gallonm 1:1de1ea2994d9 14 * are permitted provided that the following conditions are met:
gallonm 1:1de1ea2994d9 15 * 1. Redistributions of source code must retain the above copyright notice,
gallonm 1:1de1ea2994d9 16 * this list of conditions and the following disclaimer.
gallonm 1:1de1ea2994d9 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
gallonm 1:1de1ea2994d9 18 * this list of conditions and the following disclaimer in the documentation
gallonm 1:1de1ea2994d9 19 * and/or other materials provided with the distribution.
gallonm 1:1de1ea2994d9 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
gallonm 1:1de1ea2994d9 21 * may be used to endorse or promote products derived from this software
gallonm 1:1de1ea2994d9 22 * without specific prior written permission.
gallonm 1:1de1ea2994d9 23 *
gallonm 1:1de1ea2994d9 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
gallonm 1:1de1ea2994d9 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
gallonm 1:1de1ea2994d9 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
gallonm 1:1de1ea2994d9 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
gallonm 1:1de1ea2994d9 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
gallonm 1:1de1ea2994d9 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
gallonm 1:1de1ea2994d9 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
gallonm 1:1de1ea2994d9 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
gallonm 1:1de1ea2994d9 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
gallonm 1:1de1ea2994d9 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
gallonm 1:1de1ea2994d9 34 *
gallonm 1:1de1ea2994d9 35 ******************************************************************************
gallonm 1:1de1ea2994d9 36 */
gallonm 1:1de1ea2994d9 37
gallonm 1:1de1ea2994d9 38 #ifndef __VL6180X_CLASS_H
gallonm 1:1de1ea2994d9 39 #define __VL6180X_CLASS_H
gallonm 1:1de1ea2994d9 40
gallonm 1:1de1ea2994d9 41 /* Includes ------------------------------------------------------------------*/
gallonm 1:1de1ea2994d9 42 #include "RangeSensor.h"
gallonm 1:1de1ea2994d9 43 #include "LightSensor.h"
gallonm 1:1de1ea2994d9 44 #include "vl6180x_api.h"
gallonm 1:1de1ea2994d9 45 #include "vl6180x_cfg.h"
gallonm 1:1de1ea2994d9 46 #include "vl6180x_def.h"
gallonm 1:1de1ea2994d9 47 #include "vl6180x_i2c.h"
gallonm 1:1de1ea2994d9 48 #include "vl6180x_types.h"
gallonm 1:1de1ea2994d9 49 #include "vl6180x_platform.h"
gallonm 1:1de1ea2994d9 50 #include "vl6180x_appcfg.h"
gallonm 1:1de1ea2994d9 51
gallonm 1:1de1ea2994d9 52 /* Classes -------------------------------------------------------------------*/
gallonm 1:1de1ea2994d9 53 /** Class representing a VL6180X sensor component
gallonm 1:1de1ea2994d9 54 */
gallonm 1:1de1ea2994d9 55 class VL6180X : public RangeSensor, public LightSensor {
gallonm 1:1de1ea2994d9 56 public:
gallonm 1:1de1ea2994d9 57 /** Constructor
gallonm 1:1de1ea2994d9 58 * @param[in] i2c device I2C to be used for communication
gallonm 1:1de1ea2994d9 59 */
gallonm 1:1de1ea2994d9 60 VL6180X(DevI2C &i2c) : RangeSensor(), LightSensor(), dev_i2c(i2c) {}
gallonm 1:1de1ea2994d9 61
gallonm 1:1de1ea2994d9 62 /** Destructor
gallonm 1:1de1ea2994d9 63 */
gallonm 1:1de1ea2994d9 64 virtual ~VL6180X() {}
gallonm 1:1de1ea2994d9 65
gallonm 1:1de1ea2994d9 66 /*** Interface Methods ***/
gallonm 1:1de1ea2994d9 67 virtual int Init(void *init_struct) {
gallonm 1:1de1ea2994d9 68 return VL6180X_Init();
gallonm 1:1de1ea2994d9 69 }
gallonm 1:1de1ea2994d9 70
gallonm 1:1de1ea2994d9 71 virtual int ReadID(uint8_t *ht_id) {
gallonm 1:1de1ea2994d9 72 return VL6180X_ReadID(ht_id);
gallonm 1:1de1ea2994d9 73 }
gallonm 1:1de1ea2994d9 74
gallonm 1:1de1ea2994d9 75 /**
gallonm 1:1de1ea2994d9 76 * @brief Reset sensor
gallonm 1:1de1ea2994d9 77 * @return 0 in case of success, an error code otherwise
gallonm 1:1de1ea2994d9 78 */
gallonm 1:1de1ea2994d9 79 virtual int Reset(void) {
gallonm 1:1de1ea2994d9 80 return VL6180X_RebootCmd();
gallonm 1:1de1ea2994d9 81 }
gallonm 1:1de1ea2994d9 82
gallonm 1:1de1ea2994d9 83 virtual int GetRange(float *pfData) {
gallonm 1:1de1ea2994d9 84 return VL6180X_GetRange(pfData);
gallonm 1:1de1ea2994d9 85 }
gallonm 1:1de1ea2994d9 86
gallonm 1:1de1ea2994d9 87 virtual int GetLight(float *pfData) {
gallonm 1:1de1ea2994d9 88 return VL6180X_GetLight(pfData);
gallonm 1:1de1ea2994d9 89 }
gallonm 1:1de1ea2994d9 90
gallonm 1:1de1ea2994d9 91 protected:
gallonm 1:1de1ea2994d9 92 /*** Methods ***/
gallonm 1:1de1ea2994d9 93 RANGE_LIGHT_StatusTypeDef VL6180X_Init(RANGE_LIGHT_InitTypeDef *VL6180X_Init);
gallonm 1:1de1ea2994d9 94 RANGE_LIGHT_StatusTypeDef VL6180X_ReadID(uint8_t *ht_id);
gallonm 1:1de1ea2994d9 95 RANGE_LIGHT_StatusTypeDef VL6180X_SetID(uint8_t *ht_id);
gallonm 1:1de1ea2994d9 96 RANGE_LIGHT_StatusTypeDef VL6180X_RebootCmd(void);
gallonm 1:1de1ea2994d9 97 RANGE_LIGHT_StatusTypeDef VL6180X_GetRange(float* pfData);
gallonm 1:1de1ea2994d9 98 RANGE_LIGHT_StatusTypeDef VL6180X_GetLight(float* pfData);
gallonm 1:1de1ea2994d9 99
gallonm 1:1de1ea2994d9 100 /**
gallonm 1:1de1ea2994d9 101 * @brief Configures VL6180X interrupt lines for NUCLEO boards
gallonm 1:1de1ea2994d9 102 */
gallonm 1:1de1ea2994d9 103 void VL6180X_IO_ITConfig(void)
gallonm 1:1de1ea2994d9 104 {
gallonm 1:1de1ea2994d9 105 /* To be implemented */
gallonm 1:1de1ea2994d9 106 }
gallonm 1:1de1ea2994d9 107
gallonm 1:1de1ea2994d9 108 /**
gallonm 1:1de1ea2994d9 109 * @brief Configures VL6180X I2C interface
gallonm 1:1de1ea2994d9 110 * @return RANGE_LIGHT_OK in case of success, an error code otherwise
gallonm 1:1de1ea2994d9 111 */
gallonm 1:1de1ea2994d9 112 RANGE_LIGHT_StatusTypeDef VL6180X_IO_Init(void)
gallonm 1:1de1ea2994d9 113 {
gallonm 1:1de1ea2994d9 114 return RANGE_LIGHT_OK; /* done in constructor */
gallonm 1:1de1ea2994d9 115 }
gallonm 1:1de1ea2994d9 116
gallonm 1:1de1ea2994d9 117
gallonm 1:1de1ea2994d9 118 /*** Instance Variables ***/
gallonm 1:1de1ea2994d9 119 /* IO Device */
gallonm 1:1de1ea2994d9 120 DevI2C &dev_i2c;
gallonm 1:1de1ea2994d9 121
gallonm 1:1de1ea2994d9 122
gallonm 1:1de1ea2994d9 123 };
gallonm 1:1de1ea2994d9 124
gallonm 1:1de1ea2994d9 125 #endif // __VL6180X_CLASS_H