vl6180x_params_t Struct Reference

VL6180X device configuration. More...

Detailed Description

VL6180X device configuration.

Definition at line 548 of file vl6180x.h.

#include <vl6180x.h>

Data Fields
uint8_t	period
	Measurement period in continuous mode in steps of 10 ms (default 20 = 200 ms). More...

Hardware configuration
unsigned	i2c_dev
	I2C device, default I2C_DEV(0)
uint8_t	i2c_addr
	I2C slave address.
gpio_t	shutdown_pin
	Shutdown pin, LOW active.
gpio_t	int_pin
	Interrupt pin, LOW active.
vl6180x_int_config_t	int_cfg
	Interrupt mode configuration.
vl6180x_int_thresh_t	int_thresh
	Interrupt threshold configuration.

Range measurement configuration
uint8_t	rng_max_time
	Maximum convergence time in ms [1...63] given to the sensor to perform a range measurement (default 50 = 50 ms)

ALS measurement configuration
uint16_t	als_int_time
	ALS integration time in ms [1...512] (default 100 = 100 ms, recommended)
uint16_t	als_lux_res
	ALS lux resolution multiplied by factor 1000 (default 0.32 lux/count is the factory calibrated lux resolution without cover glas)
vl6180x_als_gain_t	als_gain
	ALS analogue gain for light channel (default VL6180X_ALS_GAIN_1_0)

Field Documentation

period

uint8_t vl6180x_params_t::period

Measurement period in continuous mode in steps of 10 ms (default 20 = 200 ms).

The measurement period also controls the measurement mode used after sensor initialization. If the configured measurement period is 0, the single-shot mode is enabled for both the range and ALS measurements. The functions vl6180x_rng_start_single and vl6180x_als_start_single must then be used to start a single measurement. Otherwise, the continuous mode is activated for both measurements, which are started immediately after sensor initialization with the configured measurement period. This also applies to the initialization after a power-down and power-up cycle.

Note

When ALS and range measurements are used in continuous mode, the so-called interleaved mode is used automatically, where an ALS measurement is immediately followed by a range measurement and repeated with the defined period.

Definition at line 587 of file vl6180x.h.

---

The documentation for this struct was generated from the following file:

• drivers/include/vl6180x.h