Fabio Brembilla / X_NUCLEO_6180XA1

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   X_NUCLEO_COMMON

Fork of X_NUCLEO_6180XA1 by ST

Components/VL6180X/vl6180x_class.h@21:5fb360508b6e, 2015-10-28 (annotated)

Committer:
gallonm
Date:
Wed Oct 28 13:23:49 2015 +0000
Revision:
21:5fb360508b6e
Parent:
20:dd8390d615bf
Child:
23:dfb5ccc7b780
Updated VL6180x_class.h

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 10:4954b09b72d8 44 #include "DevI2C.h"
gallonm 10:4954b09b72d8 45 #include "vl6180x_api.h"
gallonm 10:4954b09b72d8 46 #include "vl6180x_cfg.h"
gallonm 10:4954b09b72d8 47 #include "vl6180x_def.h"
gallonm 10:4954b09b72d8 48 #include "vl6180x_types.h"
gallonm 1:1de1ea2994d9 49 #include "vl6180x_platform.h"
licio.mapelli@st.com 8:f943a1fca15f 50 //#include "vl6180x_appcfg.h"
gallonm 18:c98aa73dc4a5 51 #include "stmpe1600_class.h"
gallonm 1:1de1ea2994d9 52
gallonm 14:0effa0bbf192 53 /* data struct containing range measure, light measure and type of error provided to the user
gallonm 14:0effa0bbf192 54 in case of invalid data range_mm=0xFFFFFFFF and lux=0xFFFFFFFF */
gallonm 12:71d589e6fd2c 55 typedef struct MeasureData
gallonm 12:71d589e6fd2c 56 {
gallonm 16:0d4776564733 57 uint32_t range_mm;
gallonm 16:0d4776564733 58 uint32_t lux;
gallonm 16:0d4776564733 59 uint32_t range_error;
gallonm 16:0d4776564733 60 uint32_t als_error;
gallonm 16:0d4776564733 61 uint32_t int_error;
gallonm 12:71d589e6fd2c 62 }MeasureData_t;
gallonm 12:71d589e6fd2c 63
gallonm 12:71d589e6fd2c 64 /* sensor operating modes */
gallonm 12:71d589e6fd2c 65 typedef enum
gallonm 12:71d589e6fd2c 66 {
gallonm 16:0d4776564733 67 range_single_shot_polling=1,
gallonm 16:0d4776564733 68 als_single_shot_polling,
gallonm 16:0d4776564733 69 range_continuous_polling,
gallonm 16:0d4776564733 70 als_continuous_polling,
gallonm 16:0d4776564733 71 range_continuous_interrupt,
gallonm 16:0d4776564733 72 als_continuous_interrupt,
gallonm 16:0d4776564733 73 interleaved_mode_interrupt,
gallonm 16:0d4776564733 74 range_continuous_polling_low_threshold,
gallonm 16:0d4776564733 75 range_continuous_polling_high_threshold,
gallonm 16:0d4776564733 76 range_continuous_polling_out_of_window,
gallonm 16:0d4776564733 77 als_continuous_polling_low_threshold,
gallonm 16:0d4776564733 78 als_continuous_polling_high_threshold,
gallonm 16:0d4776564733 79 als_continuous_polling_out_of_window,
gallonm 16:0d4776564733 80 range_continuous_interrupt_low_threshold,
gallonm 16:0d4776564733 81 range_continuous_interrrupt_high_threshold,
gallonm 16:0d4776564733 82 range_continuous_interrupt_out_of_window,
gallonm 16:0d4776564733 83 als_continuous_interrupt_low_threshold,
gallonm 16:0d4776564733 84 als_continuous_interrupt_high_threshold,
gallonm 16:0d4776564733 85 als_continuous_interrupt_out_of_window,
gallonm 16:0d4776564733 86 range_continuous_als_single_shot,
gallonm 16:0d4776564733 87 range_single_shot_als_continuous,
gallonm 12:71d589e6fd2c 88 }OperatingMode;
gallonm 12:71d589e6fd2c 89
gallonm 4:a5abf7757947 90 /** default device address */
gallonm 4:a5abf7757947 91 #define DEFAULT_DEVICE_ADDRESS 0x29
gallonm 4:a5abf7757947 92
gallonm 1:1de1ea2994d9 93 /* Classes -------------------------------------------------------------------*/
gallonm 1:1de1ea2994d9 94 /** Class representing a VL6180X sensor component
gallonm 1:1de1ea2994d9 95 */
gallonm 7:2dc81120c917 96 class VL6180X : public RangeSensor, public LightSensor
gallonm 7:2dc81120c917 97 {
gallonm 1:1de1ea2994d9 98 public:
gallonm 1:1de1ea2994d9 99 /** Constructor
gallonm 1:1de1ea2994d9 100 * @param[in] i2c device I2C to be used for communication
gallonm 7:2dc81120c917 101 * @param[in] digital out pin/STMPE1600DigiOut pin to be used for GPIO expander communication
gallonm 12:71d589e6fd2c 102 * @param[in] gpio1 pin
gallonm 12:71d589e6fd2c 103 * @param[in] device address, 0x29 by default
gallonm 1:1de1ea2994d9 104 */
gallonm 16:0d4776564733 105 VL6180X(DevI2C &i2c, DigitalOut &pin, PinName pin_gpio1, uint8_t DevAddr=DEFAULT_DEVICE_ADDRESS) : RangeSensor(), LightSensor(), dev_i2c(i2c), gpio0(&pin), interrupt_measure(pin_gpio1)
gallonm 16:0d4776564733 106 {
gallonm 16:0d4776564733 107 MyDevice.I2cAddr=DevAddr;
gallonm 16:0d4776564733 108 MyDevice.Present=0;
gallonm 16:0d4776564733 109 MyDevice.Ready=0;
gallonm 16:0d4776564733 110 Device=&MyDevice;;
gallonm 16:0d4776564733 111 expgpio0=NULL;
gallonm 16:0d4776564733 112 }
gallonm 10:4954b09b72d8 113
gallonm 16:0d4776564733 114 VL6180X(DevI2C &i2c, STMPE1600DigiOut &pin, PinName pin_gpio1, uint8_t DevAddr=DEFAULT_DEVICE_ADDRESS) : RangeSensor(), LightSensor(), dev_i2c(i2c), expgpio0(&pin), interrupt_measure(pin_gpio1)
gallonm 16:0d4776564733 115 {
gallonm 16:0d4776564733 116 MyDevice.I2cAddr=DevAddr;
gallonm 16:0d4776564733 117 MyDevice.Present=0;
gallonm 16:0d4776564733 118 MyDevice.Ready=0;
gallonm 16:0d4776564733 119 Device=&MyDevice;
gallonm 16:0d4776564733 120 gpio0=NULL;
gallonm 16:0d4776564733 121 }
gallonm 4:a5abf7757947 122
gallonm 7:2dc81120c917 123 /** Destructor
gallonm 7:2dc81120c917 124 */
gallonm 12:71d589e6fd2c 125 //~VL6180X(){}
gallonm 14:0effa0bbf192 126
gallonm 14:0effa0bbf192 127 /* turns on the sensor */
gallonm 16:0d4776564733 128 void VL6180x_On(void)
gallonm 16:0d4776564733 129 {
gallonm 16:0d4776564733 130 if(gpio0)
gallonm 16:0d4776564733 131 *gpio0=1;
gallonm 16:0d4776564733 132 else if(expgpio0)
gallonm 16:0d4776564733 133 *expgpio0=1;
gallonm 16:0d4776564733 134 }
gallonm 7:2dc81120c917 135
gallonm 16:0d4776564733 136 /* turns off the sensor */
gallonm 14:0effa0bbf192 137 void VL6180x_Off(void)
gallonm 16:0d4776564733 138 {
gallonm 16:0d4776564733 139 if(gpio0)
gallonm 16:0d4776564733 140 *gpio0=0;
gallonm 16:0d4776564733 141 else if(expgpio0)
gallonm 16:0d4776564733 142 *expgpio0=0;
gallonm 16:0d4776564733 143 }
gallonm 10:4954b09b72d8 144
gallonm 16:0d4776564733 145 int InitSensor(uint8_t NewAddr);
gallonm 16:0d4776564733 146 int StartMeasurement(OperatingMode operating_mode, void (*fptr)(void), MeasureData_t *Data, uint16_t low, uint16_t high);
gallonm 16:0d4776564733 147 int GetMeasurement(OperatingMode operating_mode, MeasureData_t *Data);
gallonm 16:0d4776564733 148 int StopMeasurement(OperatingMode operating_mode);
gallonm 12:71d589e6fd2c 149
gallonm 16:0d4776564733 150 /* handling functions of the interrupt_measure */
gallonm 12:71d589e6fd2c 151
gallonm 16:0d4776564733 152 /** Attach a function to call when an interrupt is detected, i.e. measurement is ready
gallonm 16:0d4776564733 153 *
gallonm 16:0d4776564733 154 * @param[in] fptr A pointer to a void function, or 0 to set as none
gallonm 16:0d4776564733 155 */
gallonm 16:0d4776564733 156 void AttachInterruptMeasureDetectionIRQ(void (*fptr)(void))
gallonm 16:0d4776564733 157 {
gallonm 16:0d4776564733 158 interrupt_measure.rise(fptr);
gallonm 16:0d4776564733 159 }
gallonm 12:71d589e6fd2c 160
gallonm 16:0d4776564733 161 /** Enable interrupt measure IRQ
gallonm 16:0d4776564733 162 */
gallonm 16:0d4776564733 163 void EnableInterruptMeasureDetectionIRQ(void)
gallonm 16:0d4776564733 164 {
gallonm 16:0d4776564733 165 interrupt_measure.enable_irq();
gallonm 16:0d4776564733 166 }
gallonm 12:71d589e6fd2c 167
gallonm 16:0d4776564733 168 /** Disable interrupt measure IRQ
gallonm 16:0d4776564733 169 */
gallonm 16:0d4776564733 170 void DisableInterruptMeasureDetectionIRQ(void)
gallonm 16:0d4776564733 171 {
gallonm 16:0d4776564733 172 interrupt_measure.disable_irq();
gallonm 16:0d4776564733 173 }
gallonm 12:71d589e6fd2c 174
gallonm 16:0d4776564733 175 int HandleIRQ(OperatingMode operating_mode, MeasureData_t *Data);
gallonm 12:71d589e6fd2c 176
gallonm 16:0d4776564733 177 unsigned Present()
gallonm 16:0d4776564733 178 {
gallonm 16:0d4776564733 179 return Device->Present;
gallonm 16:0d4776564733 180 }
gallonm 15:454710d17358 181
gallonm 16:0d4776564733 182 /* Wrapper functions */
gallonm 16:0d4776564733 183 int WaitDeviceBooted()
gallonm 16:0d4776564733 184 {
gallonm 16:0d4776564733 185 return VL6180x_WaitDeviceBooted(Device);
gallonm 16:0d4776564733 186 }
gallonm 12:71d589e6fd2c 187
gallonm 16:0d4776564733 188 int Init()
gallonm 12:71d589e6fd2c 189 {
gallonm 12:71d589e6fd2c 190 return VL6180x_InitData(Device);
gallonm 12:71d589e6fd2c 191 }
gallonm 12:71d589e6fd2c 192
gallonm 16:0d4776564733 193 int SetupGPIO1(uint8_t InitFunction, int ActiveHigh)
gallonm 16:0d4776564733 194 {
gallonm 16:0d4776564733 195 return VL6180x_SetupGPIO1(Device, InitFunction, ActiveHigh);
gallonm 16:0d4776564733 196 }
gallonm 10:4954b09b72d8 197
gallonm 16:0d4776564733 198 int Prepare()
gallonm 16:0d4776564733 199 {
gallonm 16:0d4776564733 200 return VL6180x_Prepare(Device);
gallonm 16:0d4776564733 201 }
gallonm 10:4954b09b72d8 202
gallonm 16:0d4776564733 203 int RangeStartContinuousMode()
gallonm 16:0d4776564733 204 {
gallonm 16:0d4776564733 205 return VL6180x_RangeStartContinuousMode(Device);
gallonm 16:0d4776564733 206 }
gallonm 12:71d589e6fd2c 207
gallonm 16:0d4776564733 208 int RangeStartSingleShot()
gallonm 16:0d4776564733 209 {
gallonm 16:0d4776564733 210 return VL6180x_RangeStartSingleShot(Device);
gallonm 16:0d4776564733 211 }
gallonm 12:71d589e6fd2c 212
gallonm 16:0d4776564733 213 int RangeSetMaxConvergenceTime(uint8_t MaxConTime_msec)
gallonm 16:0d4776564733 214 {
gallonm 16:0d4776564733 215 return VL6180x_RangeSetMaxConvergenceTime(Device, MaxConTime_msec);
gallonm 16:0d4776564733 216 }
gallonm 12:71d589e6fd2c 217
gallonm 16:0d4776564733 218 int RangePollMeasurement(VL6180x_RangeData_t *pRangeData)
gallonm 16:0d4776564733 219 {
gallonm 16:0d4776564733 220 return VL6180x_RangePollMeasurement(Device, pRangeData);
gallonm 16:0d4776564733 221 }
gallonm 12:71d589e6fd2c 222
gallonm 16:0d4776564733 223 int RangeGetMeasurementIfReady(VL6180x_RangeData_t *pRangeData)
gallonm 16:0d4776564733 224 {
gallonm 16:0d4776564733 225 return VL6180x_RangeGetMeasurementIfReady(Device, pRangeData);
gallonm 16:0d4776564733 226 }
gallonm 12:71d589e6fd2c 227
gallonm 16:0d4776564733 228 int RangeGetMeasurement(VL6180x_RangeData_t *pRangeData)
gallonm 16:0d4776564733 229 {
gallonm 16:0d4776564733 230 return VL6180x_RangeGetMeasurement(Device, pRangeData);
gallonm 16:0d4776564733 231 }
gallonm 12:71d589e6fd2c 232
gallonm 16:0d4776564733 233 int GetRange(int32_t *piData)
gallonm 16:0d4776564733 234 {
gallonm 16:0d4776564733 235 return VL6180x_RangeGetResult(Device, piData);
gallonm 16:0d4776564733 236 }
gallonm 12:71d589e6fd2c 237
gallonm 16:0d4776564733 238 int RangeConfigInterrupt(uint8_t ConfigGpioInt)
gallonm 16:0d4776564733 239 {
gallonm 16:0d4776564733 240 return VL6180x_RangeConfigInterrupt(Device, ConfigGpioInt);
gallonm 16:0d4776564733 241 }
gallonm 12:71d589e6fd2c 242
gallonm 16:0d4776564733 243 int RangeGetInterruptStatus(uint8_t *pIntStatus)
gallonm 16:0d4776564733 244 {
gallonm 16:0d4776564733 245 return VL6180x_RangeGetInterruptStatus(Device, pIntStatus);
gallonm 16:0d4776564733 246 }
gallonm 12:71d589e6fd2c 247
gallonm 16:0d4776564733 248 int AlsPollMeasurement(VL6180x_AlsData_t *pAlsData)
gallonm 16:0d4776564733 249 {
gallonm 16:0d4776564733 250 return VL6180x_AlsPollMeasurement(Device, pAlsData);
gallonm 16:0d4776564733 251 }
gallonm 12:71d589e6fd2c 252
gallonm 16:0d4776564733 253 int AlsGetMeasurement(VL6180x_AlsData_t *pAlsData)
gallonm 16:0d4776564733 254 {
gallonm 16:0d4776564733 255 return VL6180x_AlsGetMeasurement(Device, pAlsData);
gallonm 16:0d4776564733 256 }
gallonm 12:71d589e6fd2c 257
gallonm 16:0d4776564733 258 int AlsConfigInterrupt(uint8_t ConfigGpioInt)
gallonm 16:0d4776564733 259 {
gallonm 16:0d4776564733 260 return VL6180x_AlsConfigInterrupt(Device, ConfigGpioInt);
gallonm 16:0d4776564733 261 }
gallonm 12:71d589e6fd2c 262
gallonm 16:0d4776564733 263 int AlsSetIntegrationPeriod(uint16_t period_ms)
gallonm 16:0d4776564733 264 {
gallonm 12:71d589e6fd2c 265 return VL6180x_AlsSetIntegrationPeriod(Device, period_ms);
gallonm 16:0d4776564733 266 }
gallonm 12:71d589e6fd2c 267
gallonm 16:0d4776564733 268 int AlsSetInterMeasurementPeriod(uint16_t intermeasurement_period_ms)
gallonm 16:0d4776564733 269 {
gallonm 12:71d589e6fd2c 270 return VL6180x_AlsSetInterMeasurementPeriod(Device, intermeasurement_period_ms);
gallonm 12:71d589e6fd2c 271 }
gallonm 12:71d589e6fd2c 272
gallonm 12:71d589e6fd2c 273 int AlsSetAnalogueGain(uint8_t gain)
gallonm 16:0d4776564733 274 {
gallonm 16:0d4776564733 275 return VL6180x_AlsSetAnalogueGain(Device, gain);
gallonm 16:0d4776564733 276 }
gallonm 12:71d589e6fd2c 277
gallonm 16:0d4776564733 278 int AlsSetThresholds(uint8_t low, uint8_t high)
gallonm 16:0d4776564733 279 {
gallonm 16:0d4776564733 280 return VL6180x_AlsSetThresholds(Device, low, high);
gallonm 16:0d4776564733 281 }
gallonm 12:71d589e6fd2c 282
gallonm 12:71d589e6fd2c 283 int AlsGetInterruptStatus(uint8_t *pIntStatus)
gallonm 12:71d589e6fd2c 284 {
gallonm 12:71d589e6fd2c 285 return VL6180x_AlsGetInterruptStatus(Device, pIntStatus);
gallonm 12:71d589e6fd2c 286 }
gallonm 12:71d589e6fd2c 287
gallonm 12:71d589e6fd2c 288 int StaticInit()
gallonm 16:0d4776564733 289 {
gallonm 16:0d4776564733 290 return VL6180x_StaticInit(Device);
gallonm 16:0d4776564733 291 }
gallonm 12:71d589e6fd2c 292
gallonm 16:0d4776564733 293 int RangeWaitDeviceReady(int MaxLoop )
gallonm 16:0d4776564733 294 {
gallonm 16:0d4776564733 295 return VL6180x_RangeWaitDeviceReady(Device, MaxLoop);
gallonm 16:0d4776564733 296 }
gallonm 12:71d589e6fd2c 297
gallonm 16:0d4776564733 298 int RangeSetInterMeasPeriod(uint32_t InterMeasTime_msec)
gallonm 16:0d4776564733 299 {
gallonm 16:0d4776564733 300 return VL6180x_RangeSetInterMeasPeriod(Device, InterMeasTime_msec);
gallonm 16:0d4776564733 301 }
gallonm 12:71d589e6fd2c 302
gallonm 16:0d4776564733 303 int UpscaleSetScaling(uint8_t scaling)
gallonm 16:0d4776564733 304 {
gallonm 16:0d4776564733 305 return VL6180x_UpscaleSetScaling(Device, scaling);
gallonm 16:0d4776564733 306 }
gallonm 12:71d589e6fd2c 307
gallonm 16:0d4776564733 308 int UpscaleGetScaling()
gallonm 16:0d4776564733 309 {
gallonm 16:0d4776564733 310 return VL6180x_UpscaleGetScaling(Device);
gallonm 16:0d4776564733 311 }
gallonm 12:71d589e6fd2c 312
gallonm 16:0d4776564733 313 uint16_t GetUpperLimit()
gallonm 16:0d4776564733 314 {
gallonm 16:0d4776564733 315 return VL6180x_GetUpperLimit(Device);
gallonm 16:0d4776564733 316 }
gallonm 12:71d589e6fd2c 317
gallonm 16:0d4776564733 318 int RangeSetThresholds(uint16_t low, uint16_t high, int SafeHold)
gallonm 16:0d4776564733 319 {
gallonm 16:0d4776564733 320 return VL6180x_RangeSetThresholds(Device, low, high, SafeHold);
gallonm 16:0d4776564733 321 }
gallonm 12:71d589e6fd2c 322
gallonm 16:0d4776564733 323 int RangeGetThresholds(uint16_t *low, uint16_t *high)
gallonm 16:0d4776564733 324 {
gallonm 16:0d4776564733 325 return VL6180x_RangeGetThresholds(Device, low, high);
gallonm 16:0d4776564733 326 }
gallonm 12:71d589e6fd2c 327
gallonm 16:0d4776564733 328 int RangeSetRawThresholds(uint8_t low, uint8_t high)
gallonm 16:0d4776564733 329 {
gallonm 16:0d4776564733 330 return VL6180x_RangeSetRawThresholds(Device, low, high);
gallonm 16:0d4776564733 331 }
gallonm 12:71d589e6fd2c 332
gallonm 16:0d4776564733 333 int RangeSetEceFactor(uint16_t FactorM, uint16_t FactorD)
gallonm 16:0d4776564733 334 {
gallonm 16:0d4776564733 335 return VL6180x_RangeSetEceFactor(Device, FactorM, FactorD);
gallonm 16:0d4776564733 336 }
gallonm 12:71d589e6fd2c 337
gallonm 16:0d4776564733 338 int RangeSetEceState(int enable)
gallonm 16:0d4776564733 339 {
gallonm 16:0d4776564733 340 return VL6180x_RangeSetEceState(Device, enable);
gallonm 16:0d4776564733 341 }
gallonm 12:71d589e6fd2c 342
gallonm 16:0d4776564733 343 int FilterSetState(int state)
gallonm 16:0d4776564733 344 {
gallonm 16:0d4776564733 345 return VL6180x_FilterSetState(Device, state);
gallonm 16:0d4776564733 346 }
gallonm 12:71d589e6fd2c 347
gallonm 16:0d4776564733 348 int FilterGetState()
gallonm 16:0d4776564733 349 {
gallonm 16:0d4776564733 350 return VL6180x_FilterGetState(Device);
gallonm 16:0d4776564733 351 }
gallonm 12:71d589e6fd2c 352
gallonm 16:0d4776564733 353 int DMaxSetState(int state)
gallonm 16:0d4776564733 354 {
gallonm 16:0d4776564733 355 return VL6180x_DMaxSetState(Device, state);
gallonm 16:0d4776564733 356 }
gallonm 12:71d589e6fd2c 357
gallonm 16:0d4776564733 358 int DMaxGetState()
gallonm 16:0d4776564733 359 {
gallonm 16:0d4776564733 360 return VL6180x_DMaxGetState(Device);
gallonm 16:0d4776564733 361 }
gallonm 12:71d589e6fd2c 362
gallonm 16:0d4776564733 363 int RangeSetSystemMode(uint8_t mode)
gallonm 16:0d4776564733 364 {
gallonm 16:0d4776564733 365 return VL6180x_RangeSetSystemMode(Device, mode);
gallonm 16:0d4776564733 366 }
gallonm 12:71d589e6fd2c 367
gallonm 16:0d4776564733 368 int8_t GetOffsetCalibrationData()
gallonm 16:0d4776564733 369 {
gallonm 16:0d4776564733 370 return VL6180x_GetOffsetCalibrationData(Device);
gallonm 16:0d4776564733 371 }
gallonm 12:71d589e6fd2c 372
gallonm 16:0d4776564733 373 void SetOffsetCalibrationData(int8_t offset)
gallonm 16:0d4776564733 374 {
gallonm 16:0d4776564733 375 return VL6180x_SetOffsetCalibrationData(Device, offset);
gallonm 16:0d4776564733 376 }
gallonm 12:71d589e6fd2c 377
gallonm 16:0d4776564733 378 int SetXTalkCompensationRate(FixPoint97_t Rate)
gallonm 16:0d4776564733 379 {
gallonm 16:0d4776564733 380 return VL6180x_SetXTalkCompensationRate(Device, Rate);
gallonm 16:0d4776564733 381 }
gallonm 12:71d589e6fd2c 382
gallonm 16:0d4776564733 383 int AlsWaitDeviceReady(int MaxLoop)
gallonm 16:0d4776564733 384 {
gallonm 16:0d4776564733 385 return VL6180x_AlsWaitDeviceReady(Device, MaxLoop);
gallonm 16:0d4776564733 386 }
gallonm 12:71d589e6fd2c 387
gallonm 16:0d4776564733 388 int AlsSetSystemMode(uint8_t mode)
gallonm 16:0d4776564733 389 {
gallonm 16:0d4776564733 390 return VL6180x_AlsSetSystemMode(Device, mode);
gallonm 16:0d4776564733 391 }
gallonm 12:71d589e6fd2c 392
gallonm 16:0d4776564733 393 int SetGroupParamHold(int Hold)
gallonm 16:0d4776564733 394 {
gallonm 16:0d4776564733 395 return VL6180x_SetGroupParamHold(Device, Hold);
gallonm 16:0d4776564733 396 }
gallonm 12:71d589e6fd2c 397
gallonm 16:0d4776564733 398 int SetI2CAddress(int NewAddr)
gallonm 16:0d4776564733 399 {
gallonm 16:0d4776564733 400 int status;
gallonm 10:4954b09b72d8 401
gallonm 16:0d4776564733 402 status=VL6180x_SetI2CAddress(Device, NewAddr);
gallonm 16:0d4776564733 403 if(!status)
gallonm 16:0d4776564733 404 Device->I2cAddr=NewAddr;
gallonm 16:0d4776564733 405 return status;
gallonm 16:0d4776564733 406 }
gallonm 10:4954b09b72d8 407
gallonm 16:0d4776564733 408 int SetupGPIOx(int pin, uint8_t IntFunction, int ActiveHigh)
gallonm 16:0d4776564733 409 {
gallonm 16:0d4776564733 410 return VL6180x_SetupGPIOx(Device, pin, IntFunction, ActiveHigh);
gallonm 16:0d4776564733 411 }
gallonm 10:4954b09b72d8 412
gallonm 16:0d4776564733 413 int SetGPIOxPolarity(int pin, int active_high)
gallonm 16:0d4776564733 414 {
gallonm 16:0d4776564733 415 return VL6180x_SetGPIOxPolarity(Device, pin, active_high);
gallonm 16:0d4776564733 416 }
gallonm 12:71d589e6fd2c 417
gallonm 16:0d4776564733 418 int SetGPIOxFunctionality(int pin, uint8_t functionality)
gallonm 16:0d4776564733 419 {
gallonm 16:0d4776564733 420 return VL6180x_SetGPIOxFunctionality(Device, pin, functionality);
gallonm 16:0d4776564733 421 }
gallonm 12:71d589e6fd2c 422
gallonm 16:0d4776564733 423 int DisableGPIOxOut(int pin)
gallonm 16:0d4776564733 424 {
gallonm 16:0d4776564733 425 return VL6180x_DisableGPIOxOut(Device, pin);
gallonm 16:0d4776564733 426 }
gallonm 10:4954b09b72d8 427
gallonm 16:0d4776564733 428 int GetInterruptStatus(uint8_t *status)
gallonm 16:0d4776564733 429 {
gallonm 16:0d4776564733 430 return VL6180x_GetInterruptStatus(Device, status);
gallonm 16:0d4776564733 431 }
gallonm 12:71d589e6fd2c 432
gallonm 16:0d4776564733 433 int ClearInterrupt(uint8_t IntClear)
gallonm 16:0d4776564733 434 {
gallonm 16:0d4776564733 435 return VL6180x_ClearInterrupt(Device, IntClear );
gallonm 16:0d4776564733 436 }
gallonm 12:71d589e6fd2c 437
gallonm 16:0d4776564733 438 int GetLight(uint32_t *piData)
gallonm 16:0d4776564733 439 {
gallonm 16:0d4776564733 440 return VL6180x_AlsGetLux(Device, piData);
gallonm 16:0d4776564733 441 }
gallonm 12:71d589e6fd2c 442
gallonm 16:0d4776564733 443 int AlsStartContinuousMode()
gallonm 16:0d4776564733 444 {
gallonm 16:0d4776564733 445 return VL6180x_AlsSetSystemMode(Device, MODE_START_STOP|MODE_CONTINUOUS);
gallonm 16:0d4776564733 446 }
gallonm 12:71d589e6fd2c 447
gallonm 16:0d4776564733 448 private:
gallonm 16:0d4776564733 449 /* api.h functions */
gallonm 16:0d4776564733 450 int VL6180x_WaitDeviceBooted(VL6180xDev_t dev);
gallonm 16:0d4776564733 451 int VL6180x_InitData(VL6180xDev_t dev );
gallonm 16:0d4776564733 452 int VL6180x_SetupGPIO1(VL6180xDev_t dev, uint8_t IntFunction, int ActiveHigh);
gallonm 16:0d4776564733 453 int VL6180x_Prepare(VL6180xDev_t dev);
gallonm 16:0d4776564733 454 int VL6180x_RangeStartContinuousMode(VL6180xDev_t dev);
gallonm 16:0d4776564733 455 int VL6180x_RangeStartSingleShot(VL6180xDev_t dev);
gallonm 16:0d4776564733 456 int VL6180x_RangeSetMaxConvergenceTime(VL6180xDev_t dev, uint8_t MaxConTime_msec);
gallonm 16:0d4776564733 457 int VL6180x_RangePollMeasurement(VL6180xDev_t dev, VL6180x_RangeData_t *pRangeData);
gallonm 16:0d4776564733 458 int VL6180x_RangeGetMeasurementIfReady(VL6180xDev_t dev, VL6180x_RangeData_t *pRangeData);
gallonm 16:0d4776564733 459 int VL6180x_RangeGetMeasurement(VL6180xDev_t dev, VL6180x_RangeData_t *pRangeData);
gallonm 16:0d4776564733 460 int VL6180x_RangeGetResult(VL6180xDev_t dev, int32_t *pRange_mm);
gallonm 16:0d4776564733 461 int VL6180x_RangeConfigInterrupt(VL6180xDev_t dev, uint8_t ConfigGpioInt);
gallonm 16:0d4776564733 462 int VL6180x_RangeGetInterruptStatus(VL6180xDev_t dev, uint8_t *pIntStatus);
gallonm 16:0d4776564733 463 int VL6180x_AlsPollMeasurement(VL6180xDev_t dev, VL6180x_AlsData_t *pAlsData);
gallonm 16:0d4776564733 464 int VL6180x_AlsGetMeasurement(VL6180xDev_t dev, VL6180x_AlsData_t *pAlsData);
gallonm 16:0d4776564733 465 int VL6180x_AlsConfigInterrupt(VL6180xDev_t dev, uint8_t ConfigGpioInt);
gallonm 16:0d4776564733 466 int VL6180x_AlsSetIntegrationPeriod(VL6180xDev_t dev, uint16_t period_ms);
gallonm 16:0d4776564733 467 int VL6180x_AlsSetInterMeasurementPeriod(VL6180xDev_t dev, uint16_t intermeasurement_period_ms);
gallonm 16:0d4776564733 468 int VL6180x_AlsSetAnalogueGain(VL6180xDev_t dev, uint8_t gain);
gallonm 16:0d4776564733 469 int VL6180x_AlsSetThresholds(VL6180xDev_t dev, uint8_t low, uint8_t high);
gallonm 16:0d4776564733 470 int VL6180x_AlsGetInterruptStatus(VL6180xDev_t dev, uint8_t *pIntStatus);
gallonm 16:0d4776564733 471 int VL6180x_StaticInit(VL6180xDev_t dev);
gallonm 16:0d4776564733 472 int VL6180x_RangeWaitDeviceReady(VL6180xDev_t dev, int MaxLoop );
gallonm 16:0d4776564733 473 int VL6180x_RangeSetInterMeasPeriod(VL6180xDev_t dev, uint32_t InterMeasTime_msec);
gallonm 16:0d4776564733 474 int VL6180x_UpscaleSetScaling(VL6180xDev_t dev, uint8_t scaling);
gallonm 16:0d4776564733 475 int VL6180x_UpscaleGetScaling(VL6180xDev_t dev);
gallonm 16:0d4776564733 476 uint16_t VL6180x_GetUpperLimit(VL6180xDev_t dev);
gallonm 16:0d4776564733 477 int VL6180x_RangeSetThresholds(VL6180xDev_t dev, uint16_t low, uint16_t high, int SafeHold);
gallonm 16:0d4776564733 478 int VL6180x_RangeGetThresholds(VL6180xDev_t dev, uint16_t *low, uint16_t *high);
gallonm 16:0d4776564733 479 int VL6180x_RangeSetRawThresholds(VL6180xDev_t dev, uint8_t low, uint8_t high);
gallonm 16:0d4776564733 480 int VL6180x_RangeSetEceFactor(VL6180xDev_t dev, uint16_t FactorM, uint16_t FactorD);
gallonm 16:0d4776564733 481 int VL6180x_RangeSetEceState(VL6180xDev_t dev, int enable );
gallonm 16:0d4776564733 482 int VL6180x_FilterSetState(VL6180xDev_t dev, int state);
gallonm 16:0d4776564733 483 int VL6180x_FilterGetState(VL6180xDev_t dev);
gallonm 16:0d4776564733 484 int VL6180x_DMaxSetState(VL6180xDev_t dev, int state);
gallonm 16:0d4776564733 485 int VL6180x_DMaxGetState(VL6180xDev_t dev);
gallonm 16:0d4776564733 486 int VL6180x_RangeSetSystemMode(VL6180xDev_t dev, uint8_t mode);
gallonm 16:0d4776564733 487 int8_t VL6180x_GetOffsetCalibrationData(VL6180xDev_t dev);
gallonm 16:0d4776564733 488 void VL6180x_SetOffsetCalibrationData(VL6180xDev_t dev, int8_t offset);
gallonm 16:0d4776564733 489 int VL6180x_SetXTalkCompensationRate(VL6180xDev_t dev, FixPoint97_t Rate);
gallonm 16:0d4776564733 490 int VL6180x_AlsWaitDeviceReady(VL6180xDev_t dev, int MaxLoop );
gallonm 16:0d4776564733 491 int VL6180x_AlsSetSystemMode(VL6180xDev_t dev, uint8_t mode);
gallonm 16:0d4776564733 492 int VL6180x_SetGroupParamHold(VL6180xDev_t dev, int Hold);
gallonm 16:0d4776564733 493 int VL6180x_SetI2CAddress(VL6180xDev_t dev, uint8_t NewAddr);
gallonm 16:0d4776564733 494 int VL6180x_SetupGPIOx(VL6180xDev_t dev, int pin, uint8_t IntFunction, int ActiveHigh);
gallonm 16:0d4776564733 495 int VL6180x_SetGPIOxPolarity(VL6180xDev_t dev, int pin, int active_high);
gallonm 16:0d4776564733 496 int VL6180x_SetGPIOxFunctionality(VL6180xDev_t dev, int pin, uint8_t functionality);
gallonm 16:0d4776564733 497 int VL6180x_DisableGPIOxOut(VL6180xDev_t dev, int pin);
gallonm 16:0d4776564733 498 int VL6180x_GetInterruptStatus(VL6180xDev_t dev, uint8_t *status);
gallonm 16:0d4776564733 499 int VL6180x_ClearInterrupt(VL6180xDev_t dev, uint8_t IntClear );
gallonm 12:71d589e6fd2c 500
gallonm 16:0d4776564733 501 /* Other functions defined in api.c */
gallonm 16:0d4776564733 502 int VL6180x_RangeStaticInit(VL6180xDev_t dev);
gallonm 16:0d4776564733 503 int VL6180x_UpscaleRegInit(VL6180xDev_t dev);
gallonm 16:0d4776564733 504 int VL6180x_UpscaleStaticInit(VL6180xDev_t dev);
gallonm 16:0d4776564733 505 int VL6180x_AlsGetLux(VL6180xDev_t dev, lux_t *pLux);
gallonm 16:0d4776564733 506 int _UpscaleInitPatch0(VL6180xDev_t dev);
gallonm 16:0d4776564733 507 int VL6180x_RangeGetDeviceReady(VL6180xDev_t dev, int * Ready);
gallonm 16:0d4776564733 508 int VL6180x_RangeSetEarlyConvergenceEestimateThreshold(VL6180xDev_t dev);
gallonm 16:0d4776564733 509 int32_t _GetAveTotalTime(VL6180xDev_t dev);
gallonm 16:0d4776564733 510 int32_t _filter_Start(VL6180xDev_t dev, uint16_t m_trueRange_mm, uint16_t m_rawRange_mm, uint32_t m_rtnSignalRate, uint32_t m_rtnAmbientRate, uint16_t errorCode);
gallonm 16:0d4776564733 511 int _filter_GetResult(VL6180xDev_t dev, VL6180x_RangeData_t *pRangeData);
gallonm 16:0d4776564733 512 int _GetRateResult(VL6180xDev_t dev, VL6180x_RangeData_t *pRangeData);
gallonm 16:0d4776564733 513 int _DMax_InitData(VL6180xDev_t dev);
gallonm 7:2dc81120c917 514
gallonm 10:4954b09b72d8 515 /* Read function of the ID device */
gallonm 10:4954b09b72d8 516 int ReadID();
gallonm 4:a5abf7757947 517
gallonm 4:a5abf7757947 518 /* Write and read functions from I2C */
gallonm 4:a5abf7757947 519 int VL6180x_WrByte(VL6180xDev_t dev, uint16_t index, uint8_t data);
gallonm 4:a5abf7757947 520 int VL6180x_WrWord(VL6180xDev_t dev, uint16_t index, uint16_t data);
gallonm 4:a5abf7757947 521 int VL6180x_WrDWord(VL6180xDev_t dev, uint16_t index, uint32_t data);
gallonm 4:a5abf7757947 522 int VL6180x_RdByte(VL6180xDev_t dev, uint16_t index, uint8_t *data);
gallonm 4:a5abf7757947 523 int VL6180x_RdWord(VL6180xDev_t dev, uint16_t index, uint16_t *data);
gallonm 4:a5abf7757947 524 int VL6180x_RdDWord(VL6180xDev_t dev, uint16_t index, uint32_t *data);
gallonm 16:0d4776564733 525 int VL6180x_UpdateByte(VL6180xDev_t dev, uint16_t index, uint8_t AndData, uint8_t OrData);
gallonm 4:a5abf7757947 526 int VL6180x_I2CWrite(uint8_t DeviceAddr, uint16_t RegisterAddr, uint8_t *pBuffer, uint16_t NumByteToWrite);
gallonm 4:a5abf7757947 527 int VL6180x_I2CRead(uint8_t DeviceAddr, uint16_t RegisterAddr, uint8_t *pBuffer, uint16_t NumByteToRead);
gallonm 14:0effa0bbf192 528
gallonm 14:0effa0bbf192 529
gallonm 16:0d4776564733 530 int IsPresent()
gallonm 16:0d4776564733 531 {
gallonm 16:0d4776564733 532 int status;
gallonm 14:0effa0bbf192 533
gallonm 16:0d4776564733 534 status=ReadID();
gallonm 14:0effa0bbf192 535 if(status)
gallonm 20:dd8390d615bf 536 printf("Failed to read ID device. Device not present!\n\r");
gallonm 16:0d4776564733 537 return status;
gallonm 16:0d4776564733 538 }
gallonm 16:0d4776564733 539 int StopRangeMeasurement(OperatingMode operating_mode);
gallonm 16:0d4776564733 540 int StopAlsMeasurement(OperatingMode operating_mode);
gallonm 16:0d4776564733 541 int GetRangeMeas(OperatingMode operating_mode, MeasureData_t *Data);
gallonm 16:0d4776564733 542 int GetAlsMeas(OperatingMode operating_mode, MeasureData_t *Data);
gallonm 16:0d4776564733 543 int GetRangeAlsMeas(MeasureData_t *Data);
gallonm 16:0d4776564733 544 int RangeSetLowThreshold(uint16_t threshold);
gallonm 16:0d4776564733 545 int RangeSetHighThreshold(uint16_t threshold);
gallonm 16:0d4776564733 546 int AlsSetLowThreshold(uint16_t threshold);
gallonm 16:0d4776564733 547 int AlsSetHighThreshold(uint16_t threshold);
gallonm 16:0d4776564733 548 int GetRangeError(MeasureData_t *Data, VL6180x_RangeData_t RangeData);
gallonm 16:0d4776564733 549 int GetAlsError(MeasureData_t *Data, VL6180x_AlsData_t AlsData);
gallonm 16:0d4776564733 550 int RangeMeasPollSingleShot(MeasureData_t *Data);
gallonm 16:0d4776564733 551 int AlsMeasPollSingleShot(MeasureData_t *Data);
gallonm 16:0d4776564733 552 int RangeMeasPollContinuousMode();
gallonm 16:0d4776564733 553 int AlsMeasPollContinuousMode();
gallonm 16:0d4776564733 554 int AlsGetMeasurementIfReady(VL6180xDev_t dev, VL6180x_AlsData_t *pAlsData);
gallonm 16:0d4776564733 555 int RangeMeasIntContinuousMode(void (*fptr)(void));
gallonm 16:0d4776564733 556 int AlsMeasIntContinuousMode(void (*fptr)(void));
gallonm 16:0d4776564733 557 int InterleavedMode(void (*fptr)(void));
gallonm 16:0d4776564733 558 int StartInterleavedMode();
gallonm 16:0d4776564733 559 int VL6180x_AlsGetThresholds(VL6180xDev_t dev, uint16_t *low, uint16_t *high);
licio.mapelli@st.com 9:9cbc1736f148 560
gallonm 10:4954b09b72d8 561
gallonm 1:1de1ea2994d9 562 /* IO Device */
gallonm 7:2dc81120c917 563 DevI2C &dev_i2c;
gallonm 10:4954b09b72d8 564 /* Digital out pin */
gallonm 7:2dc81120c917 565 DigitalOut *gpio0;
gallonm 10:4954b09b72d8 566 /* GPIO expander */
gallonm 10:4954b09b72d8 567 STMPE1600DigiOut *expgpio0;
gallonm 12:71d589e6fd2c 568 /* Measure detection IRQ */
gallonm 12:71d589e6fd2c 569 InterruptIn interrupt_measure;
gallonm 10:4954b09b72d8 570 /* Device data */
gallonm 10:4954b09b72d8 571 MyVL6180Dev_t MyDevice;
gallonm 10:4954b09b72d8 572 VL6180xDev_t Device;
gallonm 1:1de1ea2994d9 573 };
gallonm 1:1de1ea2994d9 574
gallonm 4:a5abf7757947 575 #endif // __VL6180X_CLASS_H