Kenji Arai / 6180XA1_simple

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.

Dependents:   Check_VL6180XA1_ToF

Fork of X_NUCLEO_6180XA1 by ST

Components/VL6180X/vl6180x_class.h@35:407b0b127eb8, 2015-11-18 (annotated)

Committer:
mapellil
Date:
Wed Nov 18 16:35:04 2015 +0000
Revision:
35:407b0b127eb8
Parent:
32:ef97c377d27b
Child:
38:18abb7f7dcb2
Removed vl6180x_api.h, added doxy comments to API

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
mapellil 30:75bf50276881 6 * @date 9-November-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"
mapellil 35:407b0b127eb8 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"
gallonm 18:c98aa73dc4a5 50 #include "stmpe1600_class.h"
gallonm 1:1de1ea2994d9 51
mapellil 35:407b0b127eb8 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 26:db0cdc5ecc0a 81 range_continuous_interrupt_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:
mapellil 30:75bf50276881 99 /** Constructor 1
mapellil 30:75bf50276881 100 * @param[in] &i2c device I2C to be used for communication
mapellil 30:75bf50276881 101 * @param[in] &pin Mbed DigitalOut pin to be used as component GPIO_0 CE
mapellil 30:75bf50276881 102 * @param[in] pin_gpio1 pin Mbed InterruptIn PinName to be used as component GPIO_1 INT
mapellil 30:75bf50276881 103 * @param[in] DevAddr device address, 0x29 by default
gallonm 1:1de1ea2994d9 104 */
mapellil 32:ef97c377d27b 105 VL6180X(DevI2C &i2c, DigitalOut &pin, PinName pin_gpio1, uint8_t DevAddr=DEFAULT_DEVICE_ADDRESS) : RangeSensor(), LightSensor(), dev_i2c(i2c), gpio0(&pin), gpio1Int(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 }
mapellil 30:75bf50276881 113 /** Constructor 2
mapellil 30:75bf50276881 114 * @param[in] i2c device I2C to be used for communication
mapellil 30:75bf50276881 115 * @param[in] &pin Gpio Expander STMPE1600DigiOut pin to be used as component GPIO_0 CE
mapellil 30:75bf50276881 116 * @param[in] pin_gpio1 pin Mbed InterruptIn PinName to be used as component GPIO_1 INT
mapellil 30:75bf50276881 117 * @param[in] device address, 0x29 by default
mapellil 30:75bf50276881 118 */
mapellil 32:ef97c377d27b 119 VL6180X(DevI2C &i2c, STMPE1600DigiOut &pin, PinName pin_gpio1, uint8_t DevAddr=DEFAULT_DEVICE_ADDRESS) : RangeSensor(), LightSensor(), dev_i2c(i2c), expgpio0(&pin), gpio1Int(pin_gpio1)
gallonm 16:0d4776564733 120 {
gallonm 16:0d4776564733 121 MyDevice.I2cAddr=DevAddr;
gallonm 16:0d4776564733 122 MyDevice.Present=0;
gallonm 16:0d4776564733 123 MyDevice.Ready=0;
gallonm 16:0d4776564733 124 Device=&MyDevice;
gallonm 16:0d4776564733 125 gpio0=NULL;
gallonm 16:0d4776564733 126 }
gallonm 4:a5abf7757947 127
gallonm 7:2dc81120c917 128 /** Destructor
gallonm 7:2dc81120c917 129 */
mapellil 31:f99c53a51917 130 virtual ~VL6180X(){}
gallonm 28:7c9031e96c22 131 /* warning: VL6180X class inherits from GenericSensor, RangeSensor and LightSensor, that haven`t a destructor.
gallonm 23:dfb5ccc7b780 132 The warning should request to introduce a virtual destructor to make sure to delete the object */
mapellil 31:f99c53a51917 133
mapellil 31:f99c53a51917 134 /*** Interface Methods ***/
mapellil 32:ef97c377d27b 135 /*** High level API ***/
mapellil 31:f99c53a51917 136 /**
mapellil 31:f99c53a51917 137 * @brief PowerOn the sensor
mapellil 31:f99c53a51917 138 * @return void
mapellil 31:f99c53a51917 139 */
gallonm 14:0effa0bbf192 140 /* turns on the sensor */
gallonm 16:0d4776564733 141 void VL6180x_On(void)
gallonm 16:0d4776564733 142 {
gallonm 16:0d4776564733 143 if(gpio0)
gallonm 16:0d4776564733 144 *gpio0=1;
gallonm 16:0d4776564733 145 else if(expgpio0)
gallonm 16:0d4776564733 146 *expgpio0=1;
gallonm 16:0d4776564733 147 }
mapellil 31:f99c53a51917 148
mapellil 31:f99c53a51917 149 /**
mapellil 31:f99c53a51917 150 * @brief PowerOff the sensor
mapellil 31:f99c53a51917 151 * @return void
mapellil 31:f99c53a51917 152 */
gallonm 16:0d4776564733 153 /* turns off the sensor */
gallonm 14:0effa0bbf192 154 void VL6180x_Off(void)
gallonm 16:0d4776564733 155 {
gallonm 16:0d4776564733 156 if(gpio0)
gallonm 16:0d4776564733 157 *gpio0=0;
gallonm 16:0d4776564733 158 else if(expgpio0)
gallonm 16:0d4776564733 159 *expgpio0=0;
gallonm 16:0d4776564733 160 }
mapellil 31:f99c53a51917 161
mapellil 31:f99c53a51917 162 /**
mapellil 31:f99c53a51917 163 * @brief Initialize the sensor with default values
mapellil 31:f99c53a51917 164 * @return 0 on Success
mapellil 31:f99c53a51917 165 */
gallonm 16:0d4776564733 166 int InitSensor(uint8_t NewAddr);
mapellil 31:f99c53a51917 167
mapellil 31:f99c53a51917 168 /**
mapellil 31:f99c53a51917 169 * @brief Start the measure indicated by operating mode
mapellil 31:f99c53a51917 170 * @param[in] operating_mode specifies requested measure
mapellil 32:ef97c377d27b 171 * @param[in] fptr specifies call back function must be !NULL in case of interrupt measure
mapellil 32:ef97c377d27b 172 * @param[in] low specifies measure low threashold in Lux or in mm according to measure
mapellil 32:ef97c377d27b 173 * @param[in] high specifies measure high threashold in Lux or in mm according to measure
mapellil 31:f99c53a51917 174 * @return 0 on Success
mapellil 31:f99c53a51917 175 */
gallonm 24:025afc3fe30f 176 int StartMeasurement(OperatingMode operating_mode, void (*fptr)(void), uint16_t low, uint16_t high);
gallonm 12:71d589e6fd2c 177
mapellil 31:f99c53a51917 178 /**
mapellil 31:f99c53a51917 179 * @brief Get results for the measure indicated by operating mode
mapellil 31:f99c53a51917 180 * @param[in] operating_mode specifies requested measure results
mapellil 31:f99c53a51917 181 * @param[out] Data pointer to the MeasureData_t structure to read data in to
mapellil 31:f99c53a51917 182 * @return 0 on Success
mapellil 31:f99c53a51917 183 */
mapellil 31:f99c53a51917 184 int GetMeasurement(OperatingMode operating_mode, MeasureData_t *Data);
mapellil 31:f99c53a51917 185
mapellil 31:f99c53a51917 186 /**
mapellil 31:f99c53a51917 187 * @brief Stop the currently running measure indicate by operating_mode
mapellil 31:f99c53a51917 188 * @param[in] operating_mode specifies requested measure to stop
mapellil 31:f99c53a51917 189 * @return 0 on Success
mapellil 31:f99c53a51917 190 */
mapellil 31:f99c53a51917 191 int StopMeasurement(OperatingMode operating_mode);
mapellil 31:f99c53a51917 192
mapellil 32:ef97c377d27b 193 /**
mapellil 32:ef97c377d27b 194 * @brief Interrupt handling func to be called by user after an INT is occourred
mapellil 32:ef97c377d27b 195 * @param[in] opeating_mode indicating the in progress measure
mapellil 32:ef97c377d27b 196 * @param[out] Data pointer to the MeasureData_t structure to read data in to
mapellil 31:f99c53a51917 197 * @return 0 on Success
mapellil 32:ef97c377d27b 198 */
mapellil 32:ef97c377d27b 199 int HandleIRQ(OperatingMode operating_mode, MeasureData_t *Data);
gallonm 12:71d589e6fd2c 200
mapellil 31:f99c53a51917 201 /**
mapellil 31:f99c53a51917 202 * @brief Enable interrupt measure IRQ
mapellil 31:f99c53a51917 203 * @return 0 on Success
mapellil 31:f99c53a51917 204 */
gallonm 16:0d4776564733 205 void EnableInterruptMeasureDetectionIRQ(void)
gallonm 16:0d4776564733 206 {
mapellil 32:ef97c377d27b 207 gpio1Int.enable_irq();
gallonm 16:0d4776564733 208 }
gallonm 12:71d589e6fd2c 209
mapellil 31:f99c53a51917 210 /**
mapellil 31:f99c53a51917 211 * @brief Disable interrupt measure IRQ
mapellil 31:f99c53a51917 212 * @return 0 on Success
mapellil 31:f99c53a51917 213 */
gallonm 16:0d4776564733 214 void DisableInterruptMeasureDetectionIRQ(void)
gallonm 16:0d4776564733 215 {
mapellil 32:ef97c377d27b 216 gpio1Int.disable_irq();
mapellil 32:ef97c377d27b 217 }
mapellil 32:ef97c377d27b 218 /*** End High level API ***/
mapellil 32:ef97c377d27b 219
mapellil 32:ef97c377d27b 220 /**
mapellil 32:ef97c377d27b 221 * @brief Attach a function to call when an interrupt is detected, i.e. measurement is ready
mapellil 32:ef97c377d27b 222 * @param[in] fptr pointer to call back function to be called whenever an interrupt occours
mapellil 32:ef97c377d27b 223 * @return 0 on Success
mapellil 32:ef97c377d27b 224 */
mapellil 32:ef97c377d27b 225 void AttachInterruptMeasureDetectionIRQ(void (*fptr)(void))
mapellil 32:ef97c377d27b 226 {
mapellil 32:ef97c377d27b 227 gpio1Int.rise(fptr);
gallonm 16:0d4776564733 228 }
mapellil 31:f99c53a51917 229
mapellil 31:f99c53a51917 230 /**
mapellil 31:f99c53a51917 231 * @brief Check the sensor presence
mapellil 31:f99c53a51917 232 * @return 1 when device is present
mapellil 31:f99c53a51917 233 */
gallonm 16:0d4776564733 234 unsigned Present()
gallonm 16:0d4776564733 235 {
gallonm 16:0d4776564733 236 return Device->Present;
gallonm 16:0d4776564733 237 }
gallonm 15:454710d17358 238
mapellil 32:ef97c377d27b 239 /** Wrapper functions */
mapellil 35:407b0b127eb8 240 /** @defgroup api_init Init functions
mapellil 35:407b0b127eb8 241 * @brief API init functions
mapellil 35:407b0b127eb8 242 * @ingroup api_hl
mapellil 35:407b0b127eb8 243 * @{
mapellil 35:407b0b127eb8 244 */
mapellil 35:407b0b127eb8 245 /**
mapellil 35:407b0b127eb8 246 * @brief Wait for device booted after chip enable (hardware standby)
mapellil 35:407b0b127eb8 247 * @par Function Description
mapellil 35:407b0b127eb8 248 * After Chip enable Application you can also simply wait at least 1ms to ensure device is ready
mapellil 35:407b0b127eb8 249 * @warning After device chip enable (gpio0) de-asserted user must wait gpio1 to get asserted (hardware standby).
mapellil 35:407b0b127eb8 250 * or wait at least 400usec prior to do any low level access or api call .
mapellil 35:407b0b127eb8 251 *
mapellil 35:407b0b127eb8 252 * This function implements polling for standby but you must ensure 400usec from chip enable passed\n
mapellil 35:407b0b127eb8 253 * @warning if device get prepared @a VL6180x_Prepare() re-using these function can hold indefinitely\n
mapellil 35:407b0b127eb8 254 *
mapellil 35:407b0b127eb8 255 * @param void
mapellil 35:407b0b127eb8 256 * @return 0 on success
mapellil 35:407b0b127eb8 257 */
gallonm 16:0d4776564733 258 int WaitDeviceBooted()
gallonm 16:0d4776564733 259 {
gallonm 16:0d4776564733 260 return VL6180x_WaitDeviceBooted(Device);
gallonm 16:0d4776564733 261 }
mapellil 35:407b0b127eb8 262
mapellil 35:407b0b127eb8 263 /**
mapellil 35:407b0b127eb8 264 *
mapellil 35:407b0b127eb8 265 * @brief One time device initialization
mapellil 35:407b0b127eb8 266 *
mapellil 35:407b0b127eb8 267 * To be called once and only once after device is brought out of reset (Chip enable) and booted see @a VL6180x_WaitDeviceBooted()
mapellil 35:407b0b127eb8 268 *
mapellil 35:407b0b127eb8 269 * @par Function Description
mapellil 35:407b0b127eb8 270 * When not used after a fresh device "power up" or reset, it may return @a #CALIBRATION_WARNING
mapellil 35:407b0b127eb8 271 * meaning wrong calibration data may have been fetched from device that can result in ranging offset error\n
mapellil 35:407b0b127eb8 272 * If application cannot execute device reset or need to run VL6180x_InitData multiple time
mapellil 35:407b0b127eb8 273 * then it must ensure proper offset calibration saving and restore on its own
mapellil 35:407b0b127eb8 274 * by using @a VL6180x_GetOffsetCalibrationData() on first power up and then @a VL6180x_SetOffsetCalibrationData() all all subsequent init
mapellil 35:407b0b127eb8 275 *
mapellil 35:407b0b127eb8 276 * @param void
mapellil 35:407b0b127eb8 277 * @return 0 on success, @a #CALIBRATION_WARNING if failed
mapellil 35:407b0b127eb8 278 */
gallonm 16:0d4776564733 279 int Init()
gallonm 12:71d589e6fd2c 280 {
gallonm 12:71d589e6fd2c 281 return VL6180x_InitData(Device);
gallonm 12:71d589e6fd2c 282 }
mapellil 35:407b0b127eb8 283
mapellil 35:407b0b127eb8 284 /**
mapellil 35:407b0b127eb8 285 * @brief Configure GPIO1 function and set polarity.
mapellil 35:407b0b127eb8 286 * @par Function Description
mapellil 35:407b0b127eb8 287 * To be used prior to arm single shot measure or start continuous mode.
mapellil 35:407b0b127eb8 288 *
mapellil 35:407b0b127eb8 289 * The function uses @a VL6180x_SetupGPIOx() for setting gpio 1.
mapellil 35:407b0b127eb8 290 * @warning changing polarity can generate a spurious interrupt on pins.
mapellil 35:407b0b127eb8 291 * It sets an interrupt flags condition that must be cleared to avoid polling hangs. \n
mapellil 35:407b0b127eb8 292 * It is safe to run VL6180x_ClearAllInterrupt() just after.
mapellil 35:407b0b127eb8 293 *
mapellil 35:407b0b127eb8 294 * @param IntFunction The interrupt functionality to use one of :\n
mapellil 35:407b0b127eb8 295 * @a #GPIOx_SELECT_OFF \n
mapellil 35:407b0b127eb8 296 * @a #GPIOx_SELECT_GPIO_INTERRUPT_OUTPUT
mapellil 35:407b0b127eb8 297 * @param ActiveHigh The interrupt line polarity see ::IntrPol_e
mapellil 35:407b0b127eb8 298 * use @a #INTR_POL_LOW (falling edge) or @a #INTR_POL_HIGH (rising edge)
mapellil 35:407b0b127eb8 299 * @return 0 on success
mapellil 35:407b0b127eb8 300 */
gallonm 16:0d4776564733 301 int SetupGPIO1(uint8_t InitFunction, int ActiveHigh)
gallonm 16:0d4776564733 302 {
gallonm 16:0d4776564733 303 return VL6180x_SetupGPIO1(Device, InitFunction, ActiveHigh);
gallonm 16:0d4776564733 304 }
mapellil 35:407b0b127eb8 305
mapellil 35:407b0b127eb8 306 /**
mapellil 35:407b0b127eb8 307 * @brief Prepare device for operation
mapellil 35:407b0b127eb8 308 * @par Function Description
mapellil 35:407b0b127eb8 309 * Does static initialization and reprogram common default settings \n
mapellil 35:407b0b127eb8 310 * Device is prepared for new measure, ready single shot ranging or ALS typical polling operation\n
mapellil 35:407b0b127eb8 311 * After prepare user can : \n
mapellil 35:407b0b127eb8 312 * @li Call other API function to set other settings\n
mapellil 35:407b0b127eb8 313 * @li Configure the interrupt pins, etc... \n
mapellil 35:407b0b127eb8 314 * @li Then start ranging or ALS operations in single shot or continuous mode
mapellil 35:407b0b127eb8 315 *
mapellil 35:407b0b127eb8 316 * @param void
mapellil 35:407b0b127eb8 317 * @return 0 on success
mapellil 35:407b0b127eb8 318 */
gallonm 16:0d4776564733 319 int Prepare()
gallonm 16:0d4776564733 320 {
gallonm 16:0d4776564733 321 return VL6180x_Prepare(Device);
gallonm 16:0d4776564733 322 }
mapellil 35:407b0b127eb8 323
mapellil 35:407b0b127eb8 324 /**
mapellil 35:407b0b127eb8 325 * @brief Start continuous ranging mode
mapellil 35:407b0b127eb8 326 *
mapellil 35:407b0b127eb8 327 * @details End user should ensure device is in idle state and not already running
mapellil 35:407b0b127eb8 328 * @return 0 on success
mapellil 35:407b0b127eb8 329 */
gallonm 16:0d4776564733 330 int RangeStartContinuousMode()
gallonm 16:0d4776564733 331 {
gallonm 16:0d4776564733 332 return VL6180x_RangeStartContinuousMode(Device);
gallonm 16:0d4776564733 333 }
mapellil 35:407b0b127eb8 334
mapellil 35:407b0b127eb8 335 /**
mapellil 35:407b0b127eb8 336 * @brief Start single shot ranging measure
mapellil 35:407b0b127eb8 337 *
mapellil 35:407b0b127eb8 338 * @details End user should ensure device is in idle state and not already running
mapellil 35:407b0b127eb8 339 * @return 0 on success
mapellil 35:407b0b127eb8 340 */
gallonm 16:0d4776564733 341 int RangeStartSingleShot()
gallonm 16:0d4776564733 342 {
gallonm 16:0d4776564733 343 return VL6180x_RangeStartSingleShot(Device);
gallonm 16:0d4776564733 344 }
mapellil 35:407b0b127eb8 345
mapellil 35:407b0b127eb8 346 /**
mapellil 35:407b0b127eb8 347 * @brief Set maximum convergence time
mapellil 35:407b0b127eb8 348 *
mapellil 35:407b0b127eb8 349 * @par Function Description
mapellil 35:407b0b127eb8 350 * Setting a low convergence time can impact maximal detectable distance.
mapellil 35:407b0b127eb8 351 * Refer to VL6180x Datasheet Table 7 : Typical range convergence time.
mapellil 35:407b0b127eb8 352 * A typical value for up to x3 scaling is 50 ms
mapellil 35:407b0b127eb8 353 *
mapellil 35:407b0b127eb8 354 * @param MaxConTime_msec
mapellil 35:407b0b127eb8 355 * @return 0 on success. <0 on error. >0 for calibration warning status
mapellil 35:407b0b127eb8 356 */
gallonm 16:0d4776564733 357 int RangeSetMaxConvergenceTime(uint8_t MaxConTime_msec)
gallonm 16:0d4776564733 358 {
gallonm 16:0d4776564733 359 return VL6180x_RangeSetMaxConvergenceTime(Device, MaxConTime_msec);
gallonm 16:0d4776564733 360 }
mapellil 35:407b0b127eb8 361
mapellil 35:407b0b127eb8 362 /**
mapellil 35:407b0b127eb8 363 * @brief Single shot Range measurement in polling mode.
mapellil 35:407b0b127eb8 364 *
mapellil 35:407b0b127eb8 365 * @par Function Description
mapellil 35:407b0b127eb8 366 * Kick off a new single shot range then wait for ready to retrieve it by polling interrupt status \n
mapellil 35:407b0b127eb8 367 * Ranging must be prepared by a first call to @a VL6180x_Prepare() and it is safer to clear very first poll call \n
mapellil 35:407b0b127eb8 368 * This function reference VL6180x_PollDelay(dev) porting macro/call on each polling loop,
mapellil 35:407b0b127eb8 369 * but PollDelay(dev) may never be called if measure in ready on first poll loop \n
mapellil 35:407b0b127eb8 370 * Should not be use in continuous mode operation as it will stop it and cause stop/start misbehaviour \n
mapellil 35:407b0b127eb8 371 * \n This function clears Range Interrupt status , but not error one. For that uses @a VL6180x_ClearErrorInterrupt() \n
mapellil 35:407b0b127eb8 372 * This range error is not related VL6180x_RangeData_t::errorStatus that refer measure status \n
mapellil 35:407b0b127eb8 373 *
mapellil 35:407b0b127eb8 374 * @param pRangeData Will be populated with the result ranging data @a VL6180x_RangeData_t
mapellil 35:407b0b127eb8 375 * @return 0 on success , @a #RANGE_ERROR if device reports an error case in it status (not cleared) use
mapellil 35:407b0b127eb8 376 *
mapellil 35:407b0b127eb8 377 * \sa ::VL6180x_RangeData_t
mapellil 35:407b0b127eb8 378 */
gallonm 16:0d4776564733 379 int RangePollMeasurement(VL6180x_RangeData_t *pRangeData)
gallonm 16:0d4776564733 380 {
gallonm 16:0d4776564733 381 return VL6180x_RangePollMeasurement(Device, pRangeData);
gallonm 16:0d4776564733 382 }
mapellil 35:407b0b127eb8 383
mapellil 35:407b0b127eb8 384 /**
mapellil 35:407b0b127eb8 385 * @brief Check for measure readiness and get it if ready
mapellil 35:407b0b127eb8 386 *
mapellil 35:407b0b127eb8 387 * @par Function Description
mapellil 35:407b0b127eb8 388 * Using this function is an alternative to @a VL6180x_RangePollMeasurement() to avoid polling operation. This is suitable for applications
mapellil 35:407b0b127eb8 389 * where host CPU is triggered on a interrupt (not from VL6180X) to perform ranging operation. In this scenario, we assume that the very first ranging
mapellil 35:407b0b127eb8 390 * operation is triggered by a call to @a VL6180x_RangeStartSingleShot(). Then, host CPU regularly calls @a VL6180x_RangeGetMeasurementIfReady() to
mapellil 35:407b0b127eb8 391 * get a distance measure if ready. In case the distance is not ready, host may get it at the next call.\n
mapellil 35:407b0b127eb8 392 *
mapellil 35:407b0b127eb8 393 * @warning
mapellil 35:407b0b127eb8 394 * This function does not re-start a new measurement : this is up to the host CPU to do it.\n
mapellil 35:407b0b127eb8 395 * This function clears Range Interrupt for measure ready , but not error interrupts. For that, uses @a VL6180x_ClearErrorInterrupt() \n
mapellil 35:407b0b127eb8 396 *
mapellil 35:407b0b127eb8 397 * @param pRangeData Will be populated with the result ranging data if available
mapellil 35:407b0b127eb8 398 * @return 0 when measure is ready pRange data is updated (untouched when not ready), >0 for warning and @a #NOT_READY if measurement not yet ready, <0 for error @a #RANGE_ERROR if device report an error,
mapellil 35:407b0b127eb8 399 */
gallonm 16:0d4776564733 400 int RangeGetMeasurementIfReady(VL6180x_RangeData_t *pRangeData)
gallonm 16:0d4776564733 401 {
gallonm 16:0d4776564733 402 return VL6180x_RangeGetMeasurementIfReady(Device, pRangeData);
gallonm 16:0d4776564733 403 }
mapellil 35:407b0b127eb8 404
mapellil 35:407b0b127eb8 405 /**
mapellil 35:407b0b127eb8 406 * @brief Retrieve range measurements set from device
mapellil 35:407b0b127eb8 407 *
mapellil 35:407b0b127eb8 408 * @par Function Description
mapellil 35:407b0b127eb8 409 * The measurement is made of range_mm status and error code @a VL6180x_RangeData_t \n
mapellil 35:407b0b127eb8 410 * Based on configuration selected extra measures are included.
mapellil 35:407b0b127eb8 411 *
mapellil 35:407b0b127eb8 412 * @warning should not be used in continuous if wrap around filter is active \n
mapellil 35:407b0b127eb8 413 * Does not perform any wait nor check for result availability or validity.
mapellil 35:407b0b127eb8 414 *\sa VL6180x_RangeGetResult for "range only" measurement
mapellil 35:407b0b127eb8 415 *
mapellil 35:407b0b127eb8 416 * @param pRangeData Pointer to the data structure to fill up
mapellil 35:407b0b127eb8 417 * @return 0 on success
mapellil 35:407b0b127eb8 418 */
gallonm 16:0d4776564733 419 int RangeGetMeasurement(VL6180x_RangeData_t *pRangeData)
gallonm 16:0d4776564733 420 {
gallonm 16:0d4776564733 421 return VL6180x_RangeGetMeasurement(Device, pRangeData);
gallonm 16:0d4776564733 422 }
mapellil 35:407b0b127eb8 423
mapellil 35:407b0b127eb8 424 /**
mapellil 35:407b0b127eb8 425 * @brief Get ranging result and only that
mapellil 35:407b0b127eb8 426 *
mapellil 35:407b0b127eb8 427 * @par Function Description
mapellil 35:407b0b127eb8 428 * Unlike @a VL6180x_RangeGetMeasurement() this function only retrieves the range in millimeter \n
mapellil 35:407b0b127eb8 429 * It does any required up-scale translation\n
mapellil 35:407b0b127eb8 430 * It can be called after success status polling or in interrupt mode \n
mapellil 35:407b0b127eb8 431 * @warning these function is not doing wrap around filtering \n
mapellil 35:407b0b127eb8 432 * This function doesn't perform any data ready check!
mapellil 35:407b0b127eb8 433 *
mapellil 35:407b0b127eb8 434 * @param pRange_mm Pointer to range distance
mapellil 35:407b0b127eb8 435 * @return 0 on success
mapellil 35:407b0b127eb8 436 */
gallonm 16:0d4776564733 437 int GetRange(int32_t *piData)
gallonm 16:0d4776564733 438 {
gallonm 16:0d4776564733 439 return VL6180x_RangeGetResult(Device, piData);
gallonm 16:0d4776564733 440 }
gallonm 12:71d589e6fd2c 441
mapellil 35:407b0b127eb8 442 /**
mapellil 35:407b0b127eb8 443 * @brief Configure ranging interrupt reported to application
mapellil 35:407b0b127eb8 444 *
mapellil 35:407b0b127eb8 445 * @param ConfigGpioInt Select ranging report\n select one (and only one) of:\n
mapellil 35:407b0b127eb8 446 * @a #CONFIG_GPIO_INTERRUPT_DISABLED \n
mapellil 35:407b0b127eb8 447 * @a #CONFIG_GPIO_INTERRUPT_LEVEL_LOW \n
mapellil 35:407b0b127eb8 448 * @a #CONFIG_GPIO_INTERRUPT_LEVEL_HIGH \n
mapellil 35:407b0b127eb8 449 * @a #CONFIG_GPIO_INTERRUPT_OUT_OF_WINDOW \n
mapellil 35:407b0b127eb8 450 * @a #CONFIG_GPIO_INTERRUPT_NEW_SAMPLE_READY
mapellil 35:407b0b127eb8 451 * @return 0 on success
mapellil 35:407b0b127eb8 452 */
gallonm 16:0d4776564733 453 int RangeConfigInterrupt(uint8_t ConfigGpioInt)
gallonm 16:0d4776564733 454 {
gallonm 16:0d4776564733 455 return VL6180x_RangeConfigInterrupt(Device, ConfigGpioInt);
gallonm 16:0d4776564733 456 }
mapellil 35:407b0b127eb8 457
mapellil 35:407b0b127eb8 458 /**
mapellil 35:407b0b127eb8 459 * @brief Return ranging error interrupt status
mapellil 35:407b0b127eb8 460 *
mapellil 35:407b0b127eb8 461 * @par Function Description
mapellil 35:407b0b127eb8 462 * Appropriate Interrupt report must have been selected first by @a VL6180x_RangeConfigInterrupt() or @a VL6180x_Prepare() \n
mapellil 35:407b0b127eb8 463 *
mapellil 35:407b0b127eb8 464 * Can be used in polling loop to wait for a given ranging event or in interrupt to read the trigger \n
mapellil 35:407b0b127eb8 465 * Events triggers are : \n
mapellil 35:407b0b127eb8 466 * @a #RES_INT_STAT_GPIO_LOW_LEVEL_THRESHOLD \n
mapellil 35:407b0b127eb8 467 * @a #RES_INT_STAT_GPIO_HIGH_LEVEL_THRESHOLD \n
mapellil 35:407b0b127eb8 468 * @a #RES_INT_STAT_GPIO_OUT_OF_WINDOW \n (RES_INT_STAT_GPIO_LOW_LEVEL_THRESHOLD|RES_INT_STAT_GPIO_HIGH_LEVEL_THRESHOLD)
mapellil 35:407b0b127eb8 469 * @a #RES_INT_STAT_GPIO_NEW_SAMPLE_READY \n
mapellil 35:407b0b127eb8 470 *
mapellil 35:407b0b127eb8 471 * @sa IntrStatus_t
mapellil 35:407b0b127eb8 472 * @param pIntStatus Pointer to status variable to update
mapellil 35:407b0b127eb8 473 * @return 0 on success
mapellil 35:407b0b127eb8 474 */
gallonm 16:0d4776564733 475 int RangeGetInterruptStatus(uint8_t *pIntStatus)
gallonm 16:0d4776564733 476 {
gallonm 16:0d4776564733 477 return VL6180x_RangeGetInterruptStatus(Device, pIntStatus);
gallonm 16:0d4776564733 478 }
mapellil 35:407b0b127eb8 479
mapellil 35:407b0b127eb8 480 /**
mapellil 35:407b0b127eb8 481 * @brief Run a single ALS measurement in single shot polling mode
mapellil 35:407b0b127eb8 482 *
mapellil 35:407b0b127eb8 483 * @par Function Description
mapellil 35:407b0b127eb8 484 * Kick off a new single shot ALS then wait new measurement ready to retrieve it ( polling system interrupt status register for als) \n
mapellil 35:407b0b127eb8 485 * ALS must be prepared by a first call to @a VL6180x_Prepare() \n
mapellil 35:407b0b127eb8 486 * \n Should not be used in continuous or interrupt mode it will break it and create hazard in start/stop \n
mapellil 35:407b0b127eb8 487 *
mapellil 35:407b0b127eb8 488 * @param dev The device
mapellil 35:407b0b127eb8 489 * @param pAlsData Als data structure to fill up @a VL6180x_AlsData_t
mapellil 35:407b0b127eb8 490 * @return 0 on success
mapellil 35:407b0b127eb8 491 */
gallonm 16:0d4776564733 492 int AlsPollMeasurement(VL6180x_AlsData_t *pAlsData)
gallonm 16:0d4776564733 493 {
gallonm 16:0d4776564733 494 return VL6180x_AlsPollMeasurement(Device, pAlsData);
gallonm 16:0d4776564733 495 }
mapellil 35:407b0b127eb8 496
mapellil 35:407b0b127eb8 497 /**
mapellil 35:407b0b127eb8 498 * @brief Get actual ALS measurement
mapellil 35:407b0b127eb8 499 *
mapellil 35:407b0b127eb8 500 * @par Function Description
mapellil 35:407b0b127eb8 501 * Can be called after success status polling or in interrupt mode to retrieve ALS measurement from device \n
mapellil 35:407b0b127eb8 502 * This function doesn't perform any data ready check !
mapellil 35:407b0b127eb8 503 *
mapellil 35:407b0b127eb8 504 * @param pAlsData Pointer to measurement struct @a VL6180x_AlsData_t
mapellil 35:407b0b127eb8 505 * @return 0 on success
mapellil 35:407b0b127eb8 506 */
gallonm 16:0d4776564733 507 int AlsGetMeasurement(VL6180x_AlsData_t *pAlsData)
gallonm 16:0d4776564733 508 {
gallonm 16:0d4776564733 509 return VL6180x_AlsGetMeasurement(Device, pAlsData);
gallonm 16:0d4776564733 510 }
mapellil 35:407b0b127eb8 511
mapellil 35:407b0b127eb8 512 /**
mapellil 35:407b0b127eb8 513 * @brief Configure ALS interrupts provide to application
mapellil 35:407b0b127eb8 514 *
mapellil 35:407b0b127eb8 515 * @param ConfigGpioInt Select one (and only one) of : \n
mapellil 35:407b0b127eb8 516 * @a #CONFIG_GPIO_INTERRUPT_DISABLED \n
mapellil 35:407b0b127eb8 517 * @a #CONFIG_GPIO_INTERRUPT_LEVEL_LOW \n
mapellil 35:407b0b127eb8 518 * @a #CONFIG_GPIO_INTERRUPT_LEVEL_HIGH \n
mapellil 35:407b0b127eb8 519 * @a #CONFIG_GPIO_INTERRUPT_OUT_OF_WINDOW \n
mapellil 35:407b0b127eb8 520 * @a #CONFIG_GPIO_INTERRUPT_NEW_SAMPLE_READY
mapellil 35:407b0b127eb8 521 * @return 0 on success may return #INVALID_PARAMS for invalid mode
mapellil 35:407b0b127eb8 522 */
gallonm 16:0d4776564733 523 int AlsConfigInterrupt(uint8_t ConfigGpioInt)
gallonm 16:0d4776564733 524 {
gallonm 16:0d4776564733 525 return VL6180x_AlsConfigInterrupt(Device, ConfigGpioInt);
gallonm 16:0d4776564733 526 }
mapellil 35:407b0b127eb8 527
mapellil 35:407b0b127eb8 528 /**
mapellil 35:407b0b127eb8 529 * @brief Set ALS integration period
mapellil 35:407b0b127eb8 530 *
mapellil 35:407b0b127eb8 531 * @param period_ms Integration period in msec. Value in between 50 to 100 msec is recommended\n
mapellil 35:407b0b127eb8 532 * @return 0 on success
mapellil 35:407b0b127eb8 533 */
gallonm 16:0d4776564733 534 int AlsSetIntegrationPeriod(uint16_t period_ms)
gallonm 16:0d4776564733 535 {
gallonm 12:71d589e6fd2c 536 return VL6180x_AlsSetIntegrationPeriod(Device, period_ms);
gallonm 16:0d4776564733 537 }
mapellil 35:407b0b127eb8 538
mapellil 35:407b0b127eb8 539 /**
mapellil 35:407b0b127eb8 540 * @brief Set ALS "inter-measurement period"
mapellil 35:407b0b127eb8 541 *
mapellil 35:407b0b127eb8 542 * @par Function Description
mapellil 35:407b0b127eb8 543 * The so call data-sheet "inter measurement period" is actually an extra inter-measurement delay
mapellil 35:407b0b127eb8 544 *
mapellil 35:407b0b127eb8 545 * @param intermeasurement_period_ms Inter measurement time in milli second\n
mapellil 35:407b0b127eb8 546 * @warning applied value is clipped to 2550 ms\n
mapellil 35:407b0b127eb8 547 * @return 0 on success if value is
mapellil 35:407b0b127eb8 548 */
gallonm 16:0d4776564733 549 int AlsSetInterMeasurementPeriod(uint16_t intermeasurement_period_ms)
gallonm 16:0d4776564733 550 {
gallonm 12:71d589e6fd2c 551 return VL6180x_AlsSetInterMeasurementPeriod(Device, intermeasurement_period_ms);
gallonm 12:71d589e6fd2c 552 }
gallonm 12:71d589e6fd2c 553
mapellil 35:407b0b127eb8 554 /**
mapellil 35:407b0b127eb8 555 * @brief Set ALS analog gain code
mapellil 35:407b0b127eb8 556 *
mapellil 35:407b0b127eb8 557 * @par Function Description
mapellil 35:407b0b127eb8 558 * ALS gain code value programmed in @a SYSALS_ANALOGUE_GAIN .
mapellil 35:407b0b127eb8 559 * @param gain Gain code see datasheet or AlsGainLookUp for real value. Value is clipped to 7.
mapellil 35:407b0b127eb8 560 * @return 0 on success
mapellil 35:407b0b127eb8 561 */
gallonm 12:71d589e6fd2c 562 int AlsSetAnalogueGain(uint8_t gain)
gallonm 16:0d4776564733 563 {
gallonm 16:0d4776564733 564 return VL6180x_AlsSetAnalogueGain(Device, gain);
gallonm 16:0d4776564733 565 }
mapellil 35:407b0b127eb8 566
mapellil 35:407b0b127eb8 567 /**
mapellil 35:407b0b127eb8 568 * @brief Set thresholds for ALS continuous mode
mapellil 35:407b0b127eb8 569 * @warning Threshold are raw device value not lux!
mapellil 35:407b0b127eb8 570 *
mapellil 35:407b0b127eb8 571 * @par Function Description
mapellil 35:407b0b127eb8 572 * Basically value programmed in @a SYSALS_THRESH_LOW and @a SYSALS_THRESH_HIGH registers
mapellil 35:407b0b127eb8 573 * @param low ALS low raw threshold for @a SYSALS_THRESH_LOW
mapellil 35:407b0b127eb8 574 * @param high ALS high raw threshold for @a SYSALS_THRESH_HIGH
mapellil 35:407b0b127eb8 575 * @return 0 on success
mapellil 35:407b0b127eb8 576 */
gallonm 28:7c9031e96c22 577 int AlsSetThresholds(uint16_t lux_threshold_low, uint16_t lux_threshold_high);
gallonm 12:71d589e6fd2c 578
mapellil 35:407b0b127eb8 579 /**
mapellil 35:407b0b127eb8 580 * Read ALS interrupt status
mapellil 35:407b0b127eb8 581 * @param pIntStatus Pointer to status
mapellil 35:407b0b127eb8 582 * @return 0 on success
mapellil 35:407b0b127eb8 583 */
gallonm 12:71d589e6fd2c 584 int AlsGetInterruptStatus(uint8_t *pIntStatus)
gallonm 28:7c9031e96c22 585 {
gallonm 12:71d589e6fd2c 586 return VL6180x_AlsGetInterruptStatus(Device, pIntStatus);
gallonm 12:71d589e6fd2c 587 }
gallonm 12:71d589e6fd2c 588
mapellil 35:407b0b127eb8 589 /**
mapellil 35:407b0b127eb8 590 * @brief Low level ranging and ALS register static settings (you should call @a VL6180x_Prepare() function instead)
mapellil 35:407b0b127eb8 591 *
mapellil 35:407b0b127eb8 592 * @return 0 on success
mapellil 35:407b0b127eb8 593 */
gallonm 12:71d589e6fd2c 594 int StaticInit()
gallonm 16:0d4776564733 595 {
gallonm 16:0d4776564733 596 return VL6180x_StaticInit(Device);
gallonm 16:0d4776564733 597 }
mapellil 35:407b0b127eb8 598
mapellil 35:407b0b127eb8 599 /**
mapellil 35:407b0b127eb8 600 * @brief Wait for device to be ready (before a new ranging command can be issued by application)
mapellil 35:407b0b127eb8 601 * @param MaxLoop Max Number of i2c polling loop see @a #msec_2_i2cloop
mapellil 35:407b0b127eb8 602 * @return 0 on success. <0 when fail \n
mapellil 35:407b0b127eb8 603 * @ref VL6180x_ErrCode_t::TIME_OUT for time out \n
mapellil 35:407b0b127eb8 604 * @ref VL6180x_ErrCode_t::INVALID_PARAMS if MaxLop<1
mapellil 35:407b0b127eb8 605 */
gallonm 16:0d4776564733 606 int RangeWaitDeviceReady(int MaxLoop )
gallonm 16:0d4776564733 607 {
gallonm 16:0d4776564733 608 return VL6180x_RangeWaitDeviceReady(Device, MaxLoop);
gallonm 16:0d4776564733 609 }
mapellil 35:407b0b127eb8 610
mapellil 35:407b0b127eb8 611 /**
mapellil 35:407b0b127eb8 612 * @brief Program Inter measurement period (used only in continuous mode)
mapellil 35:407b0b127eb8 613 *
mapellil 35:407b0b127eb8 614 * @par Function Description
mapellil 35:407b0b127eb8 615 * When trying to set too long time, it returns #INVALID_PARAMS
mapellil 35:407b0b127eb8 616 *
mapellil 35:407b0b127eb8 617 * @param InterMeasTime_msec Requires inter-measurement time in msec
mapellil 35:407b0b127eb8 618 * @return 0 on success
mapellil 35:407b0b127eb8 619 */
gallonm 16:0d4776564733 620 int RangeSetInterMeasPeriod(uint32_t InterMeasTime_msec)
gallonm 16:0d4776564733 621 {
gallonm 16:0d4776564733 622 return VL6180x_RangeSetInterMeasPeriod(Device, InterMeasTime_msec);
gallonm 16:0d4776564733 623 }
mapellil 35:407b0b127eb8 624
mapellil 35:407b0b127eb8 625 /**
mapellil 35:407b0b127eb8 626 * @brief Set device ranging scaling factor
mapellil 35:407b0b127eb8 627 *
mapellil 35:407b0b127eb8 628 * @par Function Description
mapellil 35:407b0b127eb8 629 * The ranging scaling factor is applied on the raw distance measured by the device to increase operating ranging at the price of the precision.
mapellil 35:407b0b127eb8 630 * Changing the scaling factor when device is not in f/w standby state (free running) is not safe.
mapellil 35:407b0b127eb8 631 * It can be source of spurious interrupt, wrongly scaled range etc ...
mapellil 35:407b0b127eb8 632 * @warning __This function doesns't update high/low threshold and other programmed settings linked to scaling factor__.
mapellil 35:407b0b127eb8 633 * To ensure proper operation, threshold and scaling changes should be done following this procedure: \n
mapellil 35:407b0b127eb8 634 * @li Set Group hold : @a VL6180x_SetGroupParamHold() \n
mapellil 35:407b0b127eb8 635 * @li Get Threshold @a VL6180x_RangeGetThresholds() \n
mapellil 35:407b0b127eb8 636 * @li Change scaling : @a VL6180x_UpscaleSetScaling() \n
mapellil 35:407b0b127eb8 637 * @li Set Threshold : @a VL6180x_RangeSetThresholds() \n
mapellil 35:407b0b127eb8 638 * @li Unset Group Hold : @a VL6180x_SetGroupParamHold()
mapellil 35:407b0b127eb8 639 *
mapellil 35:407b0b127eb8 640 * @param scaling Scaling factor to apply (1,2 or 3)
mapellil 35:407b0b127eb8 641 * @return 0 on success when up-scale support is not configured it fail for any
mapellil 35:407b0b127eb8 642 * scaling than the one statically configured.
mapellil 35:407b0b127eb8 643 */
gallonm 16:0d4776564733 644 int UpscaleSetScaling(uint8_t scaling)
gallonm 16:0d4776564733 645 {
gallonm 16:0d4776564733 646 return VL6180x_UpscaleSetScaling(Device, scaling);
gallonm 16:0d4776564733 647 }
mapellil 35:407b0b127eb8 648
mapellil 35:407b0b127eb8 649 /**
mapellil 35:407b0b127eb8 650 * @brief Get current ranging scaling factor
mapellil 35:407b0b127eb8 651 *
mapellil 35:407b0b127eb8 652 * @return The current scaling factor
mapellil 35:407b0b127eb8 653 */
gallonm 16:0d4776564733 654 int UpscaleGetScaling()
gallonm 16:0d4776564733 655 {
gallonm 16:0d4776564733 656 return VL6180x_UpscaleGetScaling(Device);
gallonm 16:0d4776564733 657 }
mapellil 35:407b0b127eb8 658
mapellil 35:407b0b127eb8 659 /**
mapellil 35:407b0b127eb8 660 * @brief Get the maximal distance for actual scaling
mapellil 35:407b0b127eb8 661 * @par Function Description
mapellil 35:407b0b127eb8 662 * Do not use prior to @a VL6180x_Prepare() or at least @a VL6180x_InitData()
mapellil 35:407b0b127eb8 663 *
mapellil 35:407b0b127eb8 664 * Any range value more than the value returned by this function is to be considered as "no target detected"
mapellil 35:407b0b127eb8 665 * or "no target in detectable range" \n
mapellil 35:407b0b127eb8 666 * @warning The maximal distance depends on the scaling
mapellil 35:407b0b127eb8 667 *
mapellil 35:407b0b127eb8 668 * @return The maximal range limit for actual mode and scaling
mapellil 35:407b0b127eb8 669 */
gallonm 16:0d4776564733 670 uint16_t GetUpperLimit()
gallonm 16:0d4776564733 671 {
gallonm 16:0d4776564733 672 return VL6180x_GetUpperLimit(Device);
gallonm 16:0d4776564733 673 }
mapellil 35:407b0b127eb8 674
mapellil 35:407b0b127eb8 675 /**
mapellil 35:407b0b127eb8 676 * @brief Apply low and high ranging thresholds that are considered only in continuous mode
mapellil 35:407b0b127eb8 677 *
mapellil 35:407b0b127eb8 678 * @par Function Description
mapellil 35:407b0b127eb8 679 * This function programs low and high ranging thresholds that are considered in continuous mode :
mapellil 35:407b0b127eb8 680 * interrupt will be raised only when an object is detected at a distance inside this [low:high] range.
mapellil 35:407b0b127eb8 681 * The function takes care of applying current scaling factor if any.\n
mapellil 35:407b0b127eb8 682 * To be safe, in continuous operation, thresholds must be changed under "group parameter hold" cover.
mapellil 35:407b0b127eb8 683 * Group hold can be activated/deactivated directly in the function or externally (then set 0)
mapellil 35:407b0b127eb8 684 * using /a VL6180x_SetGroupParamHold() function.
mapellil 35:407b0b127eb8 685 *
mapellil 35:407b0b127eb8 686 * @param low Low threshold in mm
mapellil 35:407b0b127eb8 687 * @param high High threshold in mm
mapellil 35:407b0b127eb8 688 * @param SafeHold Use of group parameters hold to surround threshold programming.
mapellil 35:407b0b127eb8 689 * @return 0 On success
mapellil 35:407b0b127eb8 690 */
gallonm 16:0d4776564733 691 int RangeSetThresholds(uint16_t low, uint16_t high, int SafeHold)
gallonm 16:0d4776564733 692 {
gallonm 16:0d4776564733 693 return VL6180x_RangeSetThresholds(Device, low, high, SafeHold);
gallonm 16:0d4776564733 694 }
gallonm 12:71d589e6fd2c 695
mapellil 35:407b0b127eb8 696 /**
mapellil 35:407b0b127eb8 697 * @brief Get scaled high and low threshold from device
mapellil 35:407b0b127eb8 698 *
mapellil 35:407b0b127eb8 699 * @par Function Description
mapellil 35:407b0b127eb8 700 * Due to scaling factor, the returned value may be different from what has been programmed first (precision lost).
mapellil 35:407b0b127eb8 701 * For instance VL6180x_RangeSetThresholds(dev,11,22) with scale 3
mapellil 35:407b0b127eb8 702 * will read back 9 ((11/3)x3) and 21 ((22/3)x3).
mapellil 35:407b0b127eb8 703 *
mapellil 35:407b0b127eb8 704 * @param low scaled low Threshold ptr can be NULL if not needed
mapellil 35:407b0b127eb8 705 * @param high scaled High Threshold ptr can be NULL if not needed
mapellil 35:407b0b127eb8 706 * @return 0 on success, return value is undefined if both low and high are NULL
mapellil 35:407b0b127eb8 707 * @warning return value is undefined if both low and high are NULL
mapellil 35:407b0b127eb8 708 */
gallonm 16:0d4776564733 709 int RangeGetThresholds(uint16_t *low, uint16_t *high)
gallonm 16:0d4776564733 710 {
gallonm 16:0d4776564733 711 return VL6180x_RangeGetThresholds(Device, low, high);
gallonm 16:0d4776564733 712 }
mapellil 35:407b0b127eb8 713
mapellil 35:407b0b127eb8 714 /**
mapellil 35:407b0b127eb8 715 * @brief Set ranging raw thresholds (scaling not considered so not recommended to use it)
mapellil 35:407b0b127eb8 716 *
mapellil 35:407b0b127eb8 717 * @param low raw low threshold set to raw register
mapellil 35:407b0b127eb8 718 * @param high raw high threshold set to raw register
mapellil 35:407b0b127eb8 719 * @return 0 on success
mapellil 35:407b0b127eb8 720 */
gallonm 16:0d4776564733 721 int RangeSetRawThresholds(uint8_t low, uint8_t high)
gallonm 16:0d4776564733 722 {
gallonm 16:0d4776564733 723 return VL6180x_RangeSetRawThresholds(Device, low, high);
gallonm 16:0d4776564733 724 }
mapellil 35:407b0b127eb8 725
mapellil 35:407b0b127eb8 726 /**
mapellil 35:407b0b127eb8 727 * @brief Set Early Convergence Estimate ratio
mapellil 35:407b0b127eb8 728 * @par Function Description
mapellil 35:407b0b127eb8 729 * For more information on ECE check datasheet
mapellil 35:407b0b127eb8 730 * @warning May return a calibration warning in some use cases
mapellil 35:407b0b127eb8 731 *
mapellil 35:407b0b127eb8 732 * @param FactorM ECE factor M in M/D
mapellil 35:407b0b127eb8 733 * @param FactorD ECE factor D in M/D
mapellil 35:407b0b127eb8 734 * @return 0 on success. <0 on error. >0 on warning
mapellil 35:407b0b127eb8 735 */
gallonm 16:0d4776564733 736 int RangeSetEceFactor(uint16_t FactorM, uint16_t FactorD)
gallonm 16:0d4776564733 737 {
gallonm 16:0d4776564733 738 return VL6180x_RangeSetEceFactor(Device, FactorM, FactorD);
gallonm 16:0d4776564733 739 }
mapellil 35:407b0b127eb8 740
mapellil 35:407b0b127eb8 741 /**
mapellil 35:407b0b127eb8 742 * @brief Set Early Convergence Estimate state (See #SYSRANGE_RANGE_CHECK_ENABLES register)
mapellil 35:407b0b127eb8 743 * @param enable State to be set 0=disabled, otherwise enabled
mapellil 35:407b0b127eb8 744 * @return 0 on success
mapellil 35:407b0b127eb8 745 */
gallonm 16:0d4776564733 746 int RangeSetEceState(int enable)
gallonm 16:0d4776564733 747 {
gallonm 16:0d4776564733 748 return VL6180x_RangeSetEceState(Device, enable);
gallonm 16:0d4776564733 749 }
mapellil 35:407b0b127eb8 750
mapellil 35:407b0b127eb8 751 /**
mapellil 35:407b0b127eb8 752 * @brief Set activation state of the wrap around filter
mapellil 35:407b0b127eb8 753 * @param state New activation state (0=off, otherwise on)
mapellil 35:407b0b127eb8 754 * @return 0 on success
mapellil 35:407b0b127eb8 755 */
gallonm 16:0d4776564733 756 int FilterSetState(int state)
gallonm 16:0d4776564733 757 {
gallonm 16:0d4776564733 758 return VL6180x_FilterSetState(Device, state);
gallonm 16:0d4776564733 759 }
mapellil 35:407b0b127eb8 760
mapellil 35:407b0b127eb8 761 /**
mapellil 35:407b0b127eb8 762 * Get activation state of the wrap around filter
mapellil 35:407b0b127eb8 763 * @return Filter enabled or not, when filter is not supported it always returns 0S
mapellil 35:407b0b127eb8 764 */
gallonm 16:0d4776564733 765 int FilterGetState()
gallonm 16:0d4776564733 766 {
gallonm 16:0d4776564733 767 return VL6180x_FilterGetState(Device);
gallonm 16:0d4776564733 768 }
mapellil 35:407b0b127eb8 769
mapellil 35:407b0b127eb8 770 /**
mapellil 35:407b0b127eb8 771 * @brief Set activation state of DMax computation
mapellil 35:407b0b127eb8 772 * @param state New activation state (0=off, otherwise on)
mapellil 35:407b0b127eb8 773 * @return 0 on success
mapellil 35:407b0b127eb8 774 */
gallonm 16:0d4776564733 775 int DMaxSetState(int state)
gallonm 16:0d4776564733 776 {
gallonm 16:0d4776564733 777 return VL6180x_DMaxSetState(Device, state);
gallonm 16:0d4776564733 778 }
mapellil 35:407b0b127eb8 779
mapellil 35:407b0b127eb8 780 /**
mapellil 35:407b0b127eb8 781 * Get activation state of DMax computation
mapellil 35:407b0b127eb8 782 * @return Filter enabled or not, when filter is not supported it always returns 0S
mapellil 35:407b0b127eb8 783 */
gallonm 16:0d4776564733 784 int DMaxGetState()
gallonm 16:0d4776564733 785 {
gallonm 16:0d4776564733 786 return VL6180x_DMaxGetState(Device);
gallonm 16:0d4776564733 787 }
mapellil 35:407b0b127eb8 788
mapellil 35:407b0b127eb8 789 /**
mapellil 35:407b0b127eb8 790 * @brief Set ranging mode and start/stop measure (use high level functions instead : @a VL6180x_RangeStartSingleShot() or @a VL6180x_RangeStartContinuousMode())
mapellil 35:407b0b127eb8 791 *
mapellil 35:407b0b127eb8 792 * @par Function Description
mapellil 35:407b0b127eb8 793 * When used outside scope of known polling single shot stopped state, \n
mapellil 35:407b0b127eb8 794 * user must ensure the device state is "idle" before to issue a new command.
mapellil 35:407b0b127eb8 795 *
mapellil 35:407b0b127eb8 796 * @param mode A combination of working mode (#MODE_SINGLESHOT or #MODE_CONTINUOUS) and start/stop condition (#MODE_START_STOP) \n
mapellil 35:407b0b127eb8 797 * @return 0 on success
mapellil 35:407b0b127eb8 798 */
gallonm 16:0d4776564733 799 int RangeSetSystemMode(uint8_t mode)
gallonm 16:0d4776564733 800 {
gallonm 16:0d4776564733 801 return VL6180x_RangeSetSystemMode(Device, mode);
gallonm 16:0d4776564733 802 }
mapellil 35:407b0b127eb8 803
mapellil 35:407b0b127eb8 804 /** @} */
mapellil 35:407b0b127eb8 805
mapellil 35:407b0b127eb8 806 /** @defgroup api_ll_range_calibration Ranging calibration functions
mapellil 35:407b0b127eb8 807 * @brief Ranging calibration functions
mapellil 35:407b0b127eb8 808 * @ingroup api_ll
mapellil 35:407b0b127eb8 809 * @{
mapellil 35:407b0b127eb8 810 */
mapellil 35:407b0b127eb8 811 /**
mapellil 35:407b0b127eb8 812 * @brief Get part to part calibration offset
mapellil 35:407b0b127eb8 813 *
mapellil 35:407b0b127eb8 814 * @par Function Description
mapellil 35:407b0b127eb8 815 * Should only be used after a successful call to @a VL6180x_InitData to backup device nvm value
mapellil 35:407b0b127eb8 816 *
mapellil 35:407b0b127eb8 817 * @return part to part calibration offset from device
mapellil 35:407b0b127eb8 818 */
gallonm 16:0d4776564733 819 int8_t GetOffsetCalibrationData()
gallonm 16:0d4776564733 820 {
gallonm 16:0d4776564733 821 return VL6180x_GetOffsetCalibrationData(Device);
gallonm 16:0d4776564733 822 }
mapellil 35:407b0b127eb8 823
mapellil 35:407b0b127eb8 824 /**
mapellil 35:407b0b127eb8 825 * Set or over-write part to part calibration offset
mapellil 35:407b0b127eb8 826 * \sa VL6180x_InitData(), VL6180x_GetOffsetCalibrationData()
mapellil 35:407b0b127eb8 827 * @param offset Offset
mapellil 35:407b0b127eb8 828 */
gallonm 16:0d4776564733 829 void SetOffsetCalibrationData(int8_t offset)
gallonm 16:0d4776564733 830 {
gallonm 16:0d4776564733 831 return VL6180x_SetOffsetCalibrationData(Device, offset);
gallonm 16:0d4776564733 832 }
mapellil 35:407b0b127eb8 833
mapellil 35:407b0b127eb8 834 /**
mapellil 35:407b0b127eb8 835 * @brief Set Cross talk compensation rate
mapellil 35:407b0b127eb8 836 *
mapellil 35:407b0b127eb8 837 * @par Function Description
mapellil 35:407b0b127eb8 838 * It programs register @a #SYSRANGE_CROSSTALK_COMPENSATION_RATE
mapellil 35:407b0b127eb8 839 *
mapellil 35:407b0b127eb8 840 * @param Rate Compensation rate (9.7 fix point) see datasheet for details
mapellil 35:407b0b127eb8 841 * @return 0 on success
mapellil 35:407b0b127eb8 842 */
gallonm 16:0d4776564733 843 int SetXTalkCompensationRate(FixPoint97_t Rate)
gallonm 16:0d4776564733 844 {
gallonm 16:0d4776564733 845 return VL6180x_SetXTalkCompensationRate(Device, Rate);
gallonm 16:0d4776564733 846 }
mapellil 35:407b0b127eb8 847 /** @} */
mapellil 35:407b0b127eb8 848
mapellil 35:407b0b127eb8 849 /** @defgroup api_ll_als ALS functions
mapellil 35:407b0b127eb8 850 * @brief ALS functions
mapellil 35:407b0b127eb8 851 * @ingroup api_ll
mapellil 35:407b0b127eb8 852 * @{
mapellil 35:407b0b127eb8 853 */
mapellil 35:407b0b127eb8 854
mapellil 35:407b0b127eb8 855 /**
mapellil 35:407b0b127eb8 856 * @brief Wait for device to be ready for new als operation or max pollign loop (time out)
mapellil 35:407b0b127eb8 857 * @param MaxLoop Max Number of i2c polling loop see @a #msec_2_i2cloop
mapellil 35:407b0b127eb8 858 * @return 0 on success. <0 when @a VL6180x_ErrCode_t::TIME_OUT if timed out
mapellil 35:407b0b127eb8 859 */
gallonm 16:0d4776564733 860 int AlsWaitDeviceReady(int MaxLoop)
gallonm 16:0d4776564733 861 {
gallonm 16:0d4776564733 862 return VL6180x_AlsWaitDeviceReady(Device, MaxLoop);
gallonm 16:0d4776564733 863 }
gallonm 12:71d589e6fd2c 864
mapellil 35:407b0b127eb8 865 /**
mapellil 35:407b0b127eb8 866 * @brief Set ALS system mode and start/stop measure
mapellil 35:407b0b127eb8 867 *
mapellil 35:407b0b127eb8 868 * @warning When used outside after single shot polling, \n
mapellil 35:407b0b127eb8 869 * User must ensure the device state is ready before issuing a new command (using @a VL6180x_AlsWaitDeviceReady()). \n
mapellil 35:407b0b127eb8 870 * Non respect of this, can cause loss of interrupt or device hanging.
mapellil 35:407b0b127eb8 871 *
mapellil 35:407b0b127eb8 872 * @param mode A combination of working mode (#MODE_SINGLESHOT or #MODE_CONTINUOUS) and start condition (#MODE_START_STOP) \n
mapellil 35:407b0b127eb8 873 * @return 0 on success
mapellil 35:407b0b127eb8 874 */
gallonm 16:0d4776564733 875 int AlsSetSystemMode(uint8_t mode)
gallonm 16:0d4776564733 876 {
gallonm 16:0d4776564733 877 return VL6180x_AlsSetSystemMode(Device, mode);
gallonm 16:0d4776564733 878 }
gallonm 12:71d589e6fd2c 879
mapellil 35:407b0b127eb8 880 /** @defgroup api_ll_misc Misc functions
mapellil 35:407b0b127eb8 881 * @brief Misc functions
mapellil 35:407b0b127eb8 882 * @ingroup api_ll
mapellil 35:407b0b127eb8 883 * @{
mapellil 35:407b0b127eb8 884 */
mapellil 35:407b0b127eb8 885
mapellil 35:407b0b127eb8 886 /**
mapellil 35:407b0b127eb8 887 * Set Group parameter Hold state
mapellil 35:407b0b127eb8 888 *
mapellil 35:407b0b127eb8 889 * @par Function Description
mapellil 35:407b0b127eb8 890 * Group parameter holds @a #SYSTEM_GROUPED_PARAMETER_HOLD enable safe update (non atomic across multiple measure) by host
mapellil 35:407b0b127eb8 891 * \n The critical register group is composed of: \n
mapellil 35:407b0b127eb8 892 * #SYSTEM_INTERRUPT_CONFIG_GPIO \n
mapellil 35:407b0b127eb8 893 * #SYSRANGE_THRESH_HIGH \n
mapellil 35:407b0b127eb8 894 * #SYSRANGE_THRESH_LOW \n
mapellil 35:407b0b127eb8 895 * #SYSALS_INTEGRATION_PERIOD \n
mapellil 35:407b0b127eb8 896 * #SYSALS_ANALOGUE_GAIN \n
mapellil 35:407b0b127eb8 897 * #SYSALS_THRESH_HIGH \n
mapellil 35:407b0b127eb8 898 * #SYSALS_THRESH_LOW
mapellil 35:407b0b127eb8 899 *
mapellil 35:407b0b127eb8 900 *
mapellil 35:407b0b127eb8 901 * @param Hold Group parameter Hold state to be set (on/off)
mapellil 35:407b0b127eb8 902 * @return 0 on success
mapellil 35:407b0b127eb8 903 */
gallonm 16:0d4776564733 904 int SetGroupParamHold(int Hold)
gallonm 16:0d4776564733 905 {
gallonm 16:0d4776564733 906 return VL6180x_SetGroupParamHold(Device, Hold);
gallonm 16:0d4776564733 907 }
mapellil 35:407b0b127eb8 908
mapellil 35:407b0b127eb8 909 /**
mapellil 35:407b0b127eb8 910 * @brief Set new device i2c address
mapellil 35:407b0b127eb8 911 *
mapellil 35:407b0b127eb8 912 * After completion the device will answer to the new address programmed.
mapellil 35:407b0b127eb8 913 *
mapellil 35:407b0b127eb8 914 * @sa AN4478: Using multiple VL6180X's in a single design
mapellil 35:407b0b127eb8 915 * @param NewAddr The new i2c address (7bit)
mapellil 35:407b0b127eb8 916 * @return 0 on success
mapellil 35:407b0b127eb8 917 */
gallonm 16:0d4776564733 918 int SetI2CAddress(int NewAddr)
gallonm 16:0d4776564733 919 {
gallonm 16:0d4776564733 920 int status;
gallonm 10:4954b09b72d8 921
gallonm 16:0d4776564733 922 status=VL6180x_SetI2CAddress(Device, NewAddr);
gallonm 16:0d4776564733 923 if(!status)
gallonm 16:0d4776564733 924 Device->I2cAddr=NewAddr;
gallonm 16:0d4776564733 925 return status;
gallonm 16:0d4776564733 926 }
mapellil 35:407b0b127eb8 927
mapellil 35:407b0b127eb8 928 /**
mapellil 35:407b0b127eb8 929 * @brief Fully configure gpio 0/1 pin : polarity and functionality
mapellil 35:407b0b127eb8 930 *
mapellil 35:407b0b127eb8 931 * @param pin gpio pin 0 or 1
mapellil 35:407b0b127eb8 932 * @param IntFunction Pin functionality : either #GPIOx_SELECT_OFF or #GPIOx_SELECT_GPIO_INTERRUPT_OUTPUT (refer to #SYSTEM_MODE_GPIO1 register definition)
mapellil 35:407b0b127eb8 933 * @param ActiveHigh Set active high polarity, or active low see @a ::IntrPol_e
mapellil 35:407b0b127eb8 934 * @return 0 on success
mapellil 35:407b0b127eb8 935 */
gallonm 16:0d4776564733 936 int SetupGPIOx(int pin, uint8_t IntFunction, int ActiveHigh)
gallonm 16:0d4776564733 937 {
gallonm 16:0d4776564733 938 return VL6180x_SetupGPIOx(Device, pin, IntFunction, ActiveHigh);
gallonm 16:0d4776564733 939 }
mapellil 35:407b0b127eb8 940
mapellil 35:407b0b127eb8 941 /**
mapellil 35:407b0b127eb8 942 * @brief Set interrupt pin polarity for the given GPIO
mapellil 35:407b0b127eb8 943 *
mapellil 35:407b0b127eb8 944 * @param pin Pin 0 or 1
mapellil 35:407b0b127eb8 945 * @param active_high select active high or low polarity using @ref IntrPol_e
mapellil 35:407b0b127eb8 946 * @return 0 on success
mapellil 35:407b0b127eb8 947 */
gallonm 16:0d4776564733 948 int SetGPIOxPolarity(int pin, int active_high)
gallonm 16:0d4776564733 949 {
gallonm 16:0d4776564733 950 return VL6180x_SetGPIOxPolarity(Device, pin, active_high);
gallonm 16:0d4776564733 951 }
mapellil 35:407b0b127eb8 952
mapellil 35:407b0b127eb8 953 /**
mapellil 35:407b0b127eb8 954 * Select interrupt functionality for the given GPIO
mapellil 35:407b0b127eb8 955 *
mapellil 35:407b0b127eb8 956 * @par Function Description
mapellil 35:407b0b127eb8 957 * Functionality refer to @a SYSTEM_MODE_GPIO0
mapellil 35:407b0b127eb8 958 *
mapellil 35:407b0b127eb8 959 * @param pin Pin to configure 0 or 1 (gpio0 or gpio1)\nNote that gpio0 is chip enable at power up !
mapellil 35:407b0b127eb8 960 * @param functionality Pin functionality : either #GPIOx_SELECT_OFF or #GPIOx_SELECT_GPIO_INTERRUPT_OUTPUT (refer to #SYSTEM_MODE_GPIO1 register definition)
mapellil 35:407b0b127eb8 961 * @return 0 on success
mapellil 35:407b0b127eb8 962 */
gallonm 16:0d4776564733 963 int SetGPIOxFunctionality(int pin, uint8_t functionality)
gallonm 16:0d4776564733 964 {
gallonm 16:0d4776564733 965 return VL6180x_SetGPIOxFunctionality(Device, pin, functionality);
gallonm 16:0d4776564733 966 }
mapellil 35:407b0b127eb8 967
mapellil 35:407b0b127eb8 968 /**
mapellil 35:407b0b127eb8 969 * #brief Disable and turn to Hi-Z gpio output pin
mapellil 35:407b0b127eb8 970 *
mapellil 35:407b0b127eb8 971 * @param pin The pin number to disable 0 or 1
mapellil 35:407b0b127eb8 972 * @return 0 on success
mapellil 35:407b0b127eb8 973 */
gallonm 16:0d4776564733 974 int DisableGPIOxOut(int pin)
gallonm 16:0d4776564733 975 {
gallonm 16:0d4776564733 976 return VL6180x_DisableGPIOxOut(Device, pin);
gallonm 16:0d4776564733 977 }
mapellil 35:407b0b127eb8 978
mapellil 35:407b0b127eb8 979 /** @} */
mapellil 35:407b0b127eb8 980
mapellil 35:407b0b127eb8 981 /** @defgroup api_ll_intr Interrupts management functions
mapellil 35:407b0b127eb8 982 * @brief Interrupts management functions
mapellil 35:407b0b127eb8 983 * @ingroup api_ll
mapellil 35:407b0b127eb8 984 * @{
mapellil 35:407b0b127eb8 985 */
mapellil 35:407b0b127eb8 986
mapellil 35:407b0b127eb8 987 /**
mapellil 35:407b0b127eb8 988 * @brief Get all interrupts cause
mapellil 35:407b0b127eb8 989 *
mapellil 35:407b0b127eb8 990 * @param status Ptr to interrupt status. You can use @a IntrStatus_t::val
mapellil 35:407b0b127eb8 991 * @return 0 on success
mapellil 35:407b0b127eb8 992 */
gallonm 16:0d4776564733 993 int GetInterruptStatus(uint8_t *status)
gallonm 16:0d4776564733 994 {
gallonm 16:0d4776564733 995 return VL6180x_GetInterruptStatus(Device, status);
gallonm 16:0d4776564733 996 }
mapellil 35:407b0b127eb8 997
mapellil 35:407b0b127eb8 998 /**
mapellil 35:407b0b127eb8 999 * @brief Clear given system interrupt condition
mapellil 35:407b0b127eb8 1000 *
mapellil 35:407b0b127eb8 1001 * @par Function Description
mapellil 35:407b0b127eb8 1002 * Clear given interrupt cause by writing into register #SYSTEM_INTERRUPT_CLEAR register.
mapellil 35:407b0b127eb8 1003 * @param dev The device
mapellil 35:407b0b127eb8 1004 * @param IntClear Which interrupt source to clear. Use any combinations of #INTERRUPT_CLEAR_RANGING , #INTERRUPT_CLEAR_ALS , #INTERRUPT_CLEAR_ERROR.
mapellil 35:407b0b127eb8 1005 * @return 0 On success
mapellil 35:407b0b127eb8 1006 */
gallonm 16:0d4776564733 1007 int ClearInterrupt(uint8_t IntClear)
gallonm 16:0d4776564733 1008 {
gallonm 16:0d4776564733 1009 return VL6180x_ClearInterrupt(Device, IntClear );
gallonm 16:0d4776564733 1010 }
mapellil 35:407b0b127eb8 1011
mapellil 35:407b0b127eb8 1012 /**
mapellil 35:407b0b127eb8 1013 * @brief Clear error interrupt
mapellil 35:407b0b127eb8 1014 *
mapellil 35:407b0b127eb8 1015 * @param dev The device
mapellil 35:407b0b127eb8 1016 * @return 0 On success
mapellil 35:407b0b127eb8 1017 */
mapellil 35:407b0b127eb8 1018 #define VL6180x_ClearErrorInterrupt(dev) VL6180x_ClearInterrupt(dev, INTERRUPT_CLEAR_ERROR)
mapellil 35:407b0b127eb8 1019
mapellil 35:407b0b127eb8 1020 /**
mapellil 35:407b0b127eb8 1021 * @brief Clear All interrupt causes (als+range+error)
mapellil 35:407b0b127eb8 1022 *
mapellil 35:407b0b127eb8 1023 * @param dev The device
mapellil 35:407b0b127eb8 1024 * @return 0 On success
mapellil 35:407b0b127eb8 1025 */
mapellil 35:407b0b127eb8 1026 #define VL6180x_ClearAllInterrupt(dev) VL6180x_ClearInterrupt(dev, INTERRUPT_CLEAR_ERROR|INTERRUPT_CLEAR_RANGING|INTERRUPT_CLEAR_ALS)
mapellil 35:407b0b127eb8 1027
mapellil 35:407b0b127eb8 1028 /** @} */
mapellil 35:407b0b127eb8 1029
mapellil 35:407b0b127eb8 1030 /**
mapellil 35:407b0b127eb8 1031 * @brief Get the ALS (light in Lux) level
mapellil 35:407b0b127eb8 1032 *
mapellil 35:407b0b127eb8 1033 * @par Function Description
mapellil 35:407b0b127eb8 1034 * Get the ALS (light in Lux) level
mapellil 35:407b0b127eb8 1035 * @param *piData The pointer to variable to write in the measure in Lux
mapellil 35:407b0b127eb8 1036 * @return 0 On success
mapellil 35:407b0b127eb8 1037 */
gallonm 16:0d4776564733 1038 int GetLight(uint32_t *piData)
gallonm 16:0d4776564733 1039 {
gallonm 16:0d4776564733 1040 return VL6180x_AlsGetLux(Device, piData);
gallonm 16:0d4776564733 1041 }
mapellil 35:407b0b127eb8 1042
mapellil 35:407b0b127eb8 1043 /**
mapellil 35:407b0b127eb8 1044 * @brief Start the ALS (light) measure in continous mode
mapellil 35:407b0b127eb8 1045 *
mapellil 35:407b0b127eb8 1046 * @par Function Description
mapellil 35:407b0b127eb8 1047 * Start the ALS (light) measure in continous mode
mapellil 35:407b0b127eb8 1048 * @return 0 On success
mapellil 35:407b0b127eb8 1049 */
gallonm 16:0d4776564733 1050 int AlsStartContinuousMode()
gallonm 16:0d4776564733 1051 {
gallonm 16:0d4776564733 1052 return VL6180x_AlsSetSystemMode(Device, MODE_START_STOP|MODE_CONTINUOUS);
gallonm 16:0d4776564733 1053 }
mapellil 35:407b0b127eb8 1054
mapellil 35:407b0b127eb8 1055 /**
mapellil 35:407b0b127eb8 1056 * @brief Start the ALS (light) measure in single shot mode
mapellil 35:407b0b127eb8 1057 *
mapellil 35:407b0b127eb8 1058 * @par Function Description
mapellil 35:407b0b127eb8 1059 * Start the ALS (light) measure in single shot mode
mapellil 35:407b0b127eb8 1060 * @return 0 On success
mapellil 35:407b0b127eb8 1061 */
gallonm 24:025afc3fe30f 1062 int AlsStartSingleShot()
gallonm 24:025afc3fe30f 1063 {
gallonm 24:025afc3fe30f 1064 return VL6180x_AlsSetSystemMode(Device, MODE_START_STOP|MODE_SINGLESHOT);
gallonm 24:025afc3fe30f 1065 }
gallonm 12:71d589e6fd2c 1066
gallonm 16:0d4776564733 1067 private:
gallonm 16:0d4776564733 1068 /* api.h functions */
gallonm 16:0d4776564733 1069 int VL6180x_WaitDeviceBooted(VL6180xDev_t dev);
gallonm 16:0d4776564733 1070 int VL6180x_InitData(VL6180xDev_t dev );
gallonm 16:0d4776564733 1071 int VL6180x_SetupGPIO1(VL6180xDev_t dev, uint8_t IntFunction, int ActiveHigh);
gallonm 16:0d4776564733 1072 int VL6180x_Prepare(VL6180xDev_t dev);
gallonm 16:0d4776564733 1073 int VL6180x_RangeStartContinuousMode(VL6180xDev_t dev);
gallonm 16:0d4776564733 1074 int VL6180x_RangeStartSingleShot(VL6180xDev_t dev);
gallonm 16:0d4776564733 1075 int VL6180x_RangeSetMaxConvergenceTime(VL6180xDev_t dev, uint8_t MaxConTime_msec);
gallonm 16:0d4776564733 1076 int VL6180x_RangePollMeasurement(VL6180xDev_t dev, VL6180x_RangeData_t *pRangeData);
gallonm 16:0d4776564733 1077 int VL6180x_RangeGetMeasurementIfReady(VL6180xDev_t dev, VL6180x_RangeData_t *pRangeData);
gallonm 16:0d4776564733 1078 int VL6180x_RangeGetMeasurement(VL6180xDev_t dev, VL6180x_RangeData_t *pRangeData);
gallonm 16:0d4776564733 1079 int VL6180x_RangeGetResult(VL6180xDev_t dev, int32_t *pRange_mm);
gallonm 16:0d4776564733 1080 int VL6180x_RangeConfigInterrupt(VL6180xDev_t dev, uint8_t ConfigGpioInt);
gallonm 16:0d4776564733 1081 int VL6180x_RangeGetInterruptStatus(VL6180xDev_t dev, uint8_t *pIntStatus);
gallonm 16:0d4776564733 1082 int VL6180x_AlsPollMeasurement(VL6180xDev_t dev, VL6180x_AlsData_t *pAlsData);
gallonm 16:0d4776564733 1083 int VL6180x_AlsGetMeasurement(VL6180xDev_t dev, VL6180x_AlsData_t *pAlsData);
gallonm 16:0d4776564733 1084 int VL6180x_AlsConfigInterrupt(VL6180xDev_t dev, uint8_t ConfigGpioInt);
gallonm 16:0d4776564733 1085 int VL6180x_AlsSetIntegrationPeriod(VL6180xDev_t dev, uint16_t period_ms);
gallonm 16:0d4776564733 1086 int VL6180x_AlsSetInterMeasurementPeriod(VL6180xDev_t dev, uint16_t intermeasurement_period_ms);
gallonm 16:0d4776564733 1087 int VL6180x_AlsSetAnalogueGain(VL6180xDev_t dev, uint8_t gain);
gallonm 28:7c9031e96c22 1088 int VL6180x_AlsSetThresholds(VL6180xDev_t dev, uint16_t low, uint16_t high);
gallonm 16:0d4776564733 1089 int VL6180x_AlsGetInterruptStatus(VL6180xDev_t dev, uint8_t *pIntStatus);
gallonm 16:0d4776564733 1090 int VL6180x_StaticInit(VL6180xDev_t dev);
gallonm 16:0d4776564733 1091 int VL6180x_RangeWaitDeviceReady(VL6180xDev_t dev, int MaxLoop );
gallonm 16:0d4776564733 1092 int VL6180x_RangeSetInterMeasPeriod(VL6180xDev_t dev, uint32_t InterMeasTime_msec);
gallonm 16:0d4776564733 1093 int VL6180x_UpscaleSetScaling(VL6180xDev_t dev, uint8_t scaling);
gallonm 16:0d4776564733 1094 int VL6180x_UpscaleGetScaling(VL6180xDev_t dev);
gallonm 16:0d4776564733 1095 uint16_t VL6180x_GetUpperLimit(VL6180xDev_t dev);
gallonm 16:0d4776564733 1096 int VL6180x_RangeSetThresholds(VL6180xDev_t dev, uint16_t low, uint16_t high, int SafeHold);
gallonm 16:0d4776564733 1097 int VL6180x_RangeGetThresholds(VL6180xDev_t dev, uint16_t *low, uint16_t *high);
gallonm 16:0d4776564733 1098 int VL6180x_RangeSetRawThresholds(VL6180xDev_t dev, uint8_t low, uint8_t high);
gallonm 16:0d4776564733 1099 int VL6180x_RangeSetEceFactor(VL6180xDev_t dev, uint16_t FactorM, uint16_t FactorD);
gallonm 16:0d4776564733 1100 int VL6180x_RangeSetEceState(VL6180xDev_t dev, int enable );
gallonm 16:0d4776564733 1101 int VL6180x_FilterSetState(VL6180xDev_t dev, int state);
gallonm 16:0d4776564733 1102 int VL6180x_FilterGetState(VL6180xDev_t dev);
gallonm 16:0d4776564733 1103 int VL6180x_DMaxSetState(VL6180xDev_t dev, int state);
gallonm 16:0d4776564733 1104 int VL6180x_DMaxGetState(VL6180xDev_t dev);
gallonm 16:0d4776564733 1105 int VL6180x_RangeSetSystemMode(VL6180xDev_t dev, uint8_t mode);
gallonm 16:0d4776564733 1106 int8_t VL6180x_GetOffsetCalibrationData(VL6180xDev_t dev);
gallonm 16:0d4776564733 1107 void VL6180x_SetOffsetCalibrationData(VL6180xDev_t dev, int8_t offset);
gallonm 16:0d4776564733 1108 int VL6180x_SetXTalkCompensationRate(VL6180xDev_t dev, FixPoint97_t Rate);
gallonm 16:0d4776564733 1109 int VL6180x_AlsWaitDeviceReady(VL6180xDev_t dev, int MaxLoop );
gallonm 16:0d4776564733 1110 int VL6180x_AlsSetSystemMode(VL6180xDev_t dev, uint8_t mode);
gallonm 16:0d4776564733 1111 int VL6180x_SetGroupParamHold(VL6180xDev_t dev, int Hold);
gallonm 16:0d4776564733 1112 int VL6180x_SetI2CAddress(VL6180xDev_t dev, uint8_t NewAddr);
gallonm 16:0d4776564733 1113 int VL6180x_SetupGPIOx(VL6180xDev_t dev, int pin, uint8_t IntFunction, int ActiveHigh);
gallonm 16:0d4776564733 1114 int VL6180x_SetGPIOxPolarity(VL6180xDev_t dev, int pin, int active_high);
gallonm 16:0d4776564733 1115 int VL6180x_SetGPIOxFunctionality(VL6180xDev_t dev, int pin, uint8_t functionality);
gallonm 16:0d4776564733 1116 int VL6180x_DisableGPIOxOut(VL6180xDev_t dev, int pin);
gallonm 16:0d4776564733 1117 int VL6180x_GetInterruptStatus(VL6180xDev_t dev, uint8_t *status);
gallonm 16:0d4776564733 1118 int VL6180x_ClearInterrupt(VL6180xDev_t dev, uint8_t IntClear );
gallonm 12:71d589e6fd2c 1119
gallonm 16:0d4776564733 1120 /* Other functions defined in api.c */
gallonm 16:0d4776564733 1121 int VL6180x_RangeStaticInit(VL6180xDev_t dev);
gallonm 16:0d4776564733 1122 int VL6180x_UpscaleRegInit(VL6180xDev_t dev);
gallonm 16:0d4776564733 1123 int VL6180x_UpscaleStaticInit(VL6180xDev_t dev);
gallonm 16:0d4776564733 1124 int VL6180x_AlsGetLux(VL6180xDev_t dev, lux_t *pLux);
gallonm 16:0d4776564733 1125 int _UpscaleInitPatch0(VL6180xDev_t dev);
gallonm 16:0d4776564733 1126 int VL6180x_RangeGetDeviceReady(VL6180xDev_t dev, int * Ready);
gallonm 16:0d4776564733 1127 int VL6180x_RangeSetEarlyConvergenceEestimateThreshold(VL6180xDev_t dev);
gallonm 16:0d4776564733 1128 int32_t _GetAveTotalTime(VL6180xDev_t dev);
gallonm 16:0d4776564733 1129 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 1130 int _filter_GetResult(VL6180xDev_t dev, VL6180x_RangeData_t *pRangeData);
gallonm 16:0d4776564733 1131 int _GetRateResult(VL6180xDev_t dev, VL6180x_RangeData_t *pRangeData);
gallonm 16:0d4776564733 1132 int _DMax_InitData(VL6180xDev_t dev);
gallonm 7:2dc81120c917 1133
gallonm 10:4954b09b72d8 1134 /* Read function of the ID device */
gallonm 10:4954b09b72d8 1135 int ReadID();
gallonm 4:a5abf7757947 1136
gallonm 4:a5abf7757947 1137 /* Write and read functions from I2C */
gallonm 4:a5abf7757947 1138 int VL6180x_WrByte(VL6180xDev_t dev, uint16_t index, uint8_t data);
gallonm 4:a5abf7757947 1139 int VL6180x_WrWord(VL6180xDev_t dev, uint16_t index, uint16_t data);
gallonm 4:a5abf7757947 1140 int VL6180x_WrDWord(VL6180xDev_t dev, uint16_t index, uint32_t data);
gallonm 4:a5abf7757947 1141 int VL6180x_RdByte(VL6180xDev_t dev, uint16_t index, uint8_t *data);
gallonm 4:a5abf7757947 1142 int VL6180x_RdWord(VL6180xDev_t dev, uint16_t index, uint16_t *data);
gallonm 4:a5abf7757947 1143 int VL6180x_RdDWord(VL6180xDev_t dev, uint16_t index, uint32_t *data);
gallonm 16:0d4776564733 1144 int VL6180x_UpdateByte(VL6180xDev_t dev, uint16_t index, uint8_t AndData, uint8_t OrData);
gallonm 4:a5abf7757947 1145 int VL6180x_I2CWrite(uint8_t DeviceAddr, uint16_t RegisterAddr, uint8_t *pBuffer, uint16_t NumByteToWrite);
gallonm 4:a5abf7757947 1146 int VL6180x_I2CRead(uint8_t DeviceAddr, uint16_t RegisterAddr, uint8_t *pBuffer, uint16_t NumByteToRead);
gallonm 14:0effa0bbf192 1147
gallonm 14:0effa0bbf192 1148
gallonm 16:0d4776564733 1149 int IsPresent()
gallonm 16:0d4776564733 1150 {
gallonm 16:0d4776564733 1151 int status;
gallonm 14:0effa0bbf192 1152
gallonm 16:0d4776564733 1153 status=ReadID();
gallonm 14:0effa0bbf192 1154 if(status)
gallonm 27:22c6f69967d9 1155 VL6180x_ErrLog("Failed to read ID device. Device not present!\n\r");
gallonm 16:0d4776564733 1156 return status;
gallonm 16:0d4776564733 1157 }
gallonm 16:0d4776564733 1158 int StopRangeMeasurement(OperatingMode operating_mode);
gallonm 16:0d4776564733 1159 int StopAlsMeasurement(OperatingMode operating_mode);
gallonm 16:0d4776564733 1160 int GetRangeMeas(OperatingMode operating_mode, MeasureData_t *Data);
gallonm 16:0d4776564733 1161 int GetAlsMeas(OperatingMode operating_mode, MeasureData_t *Data);
gallonm 16:0d4776564733 1162 int GetRangeAlsMeas(MeasureData_t *Data);
gallonm 16:0d4776564733 1163 int RangeSetLowThreshold(uint16_t threshold);
gallonm 16:0d4776564733 1164 int RangeSetHighThreshold(uint16_t threshold);
gallonm 16:0d4776564733 1165 int AlsSetLowThreshold(uint16_t threshold);
gallonm 16:0d4776564733 1166 int AlsSetHighThreshold(uint16_t threshold);
gallonm 16:0d4776564733 1167 int GetRangeError(MeasureData_t *Data, VL6180x_RangeData_t RangeData);
gallonm 16:0d4776564733 1168 int GetAlsError(MeasureData_t *Data, VL6180x_AlsData_t AlsData);
gallonm 24:025afc3fe30f 1169 int RangeMeasPollSingleShot();
gallonm 24:025afc3fe30f 1170 int AlsMeasPollSingleShot();
gallonm 16:0d4776564733 1171 int RangeMeasPollContinuousMode();
gallonm 16:0d4776564733 1172 int AlsMeasPollContinuousMode();
gallonm 16:0d4776564733 1173 int AlsGetMeasurementIfReady(VL6180xDev_t dev, VL6180x_AlsData_t *pAlsData);
gallonm 16:0d4776564733 1174 int RangeMeasIntContinuousMode(void (*fptr)(void));
gallonm 16:0d4776564733 1175 int AlsMeasIntContinuousMode(void (*fptr)(void));
gallonm 16:0d4776564733 1176 int InterleavedMode(void (*fptr)(void));
gallonm 16:0d4776564733 1177 int StartInterleavedMode();
gallonm 26:db0cdc5ecc0a 1178 int AlsGetThresholds(VL6180xDev_t dev, lux_t *low, lux_t *high);
licio.mapelli@st.com 9:9cbc1736f148 1179
gallonm 10:4954b09b72d8 1180
gallonm 1:1de1ea2994d9 1181 /* IO Device */
gallonm 7:2dc81120c917 1182 DevI2C &dev_i2c;
gallonm 10:4954b09b72d8 1183 /* Digital out pin */
gallonm 7:2dc81120c917 1184 DigitalOut *gpio0;
gallonm 10:4954b09b72d8 1185 /* GPIO expander */
gallonm 10:4954b09b72d8 1186 STMPE1600DigiOut *expgpio0;
gallonm 12:71d589e6fd2c 1187 /* Measure detection IRQ */
mapellil 32:ef97c377d27b 1188 InterruptIn gpio1Int;
gallonm 10:4954b09b72d8 1189 /* Device data */
gallonm 10:4954b09b72d8 1190 MyVL6180Dev_t MyDevice;
gallonm 10:4954b09b72d8 1191 VL6180xDev_t Device;
gallonm 1:1de1ea2994d9 1192 };
gallonm 1:1de1ea2994d9 1193
gallonm 4:a5abf7757947 1194 #endif // __VL6180X_CLASS_H