Adafruit_VL6180X.h File Reference

#include "Arduino.h"
#include <Adafruit_I2CDevice.h>

Go to the source code of this file.

Classes
class	Adafruit_VL6180X
	! Class for managing connection and state to a VL6180X sensor More...

Macros
#define	VL6180X_DEFAULT_I2C_ADDR   0x29
	The fixed I2C addres.
#define	VL6180X_REG_IDENTIFICATION_MODEL_ID   0x000
	! Device model identification number
#define	VL6180X_REG_SYSTEM_INTERRUPT_CONFIG   0x014
	! Interrupt configuration
#define	VL6180X_REG_SYSTEM_INTERRUPT_CLEAR   0x015
	! Interrupt clear bits
#define	VL6180X_REG_SYSTEM_FRESH_OUT_OF_RESET   0x016
	! Fresh out of reset bit
#define	VL6180X_REG_SYSRANGE_START   0x018
	! Trigger Ranging
#define	VL6180X_REG_SYSRANGE_PART_TO_PART_RANGE_OFFSET   0x024
	! Part to part range offset
#define	VL6180X_REG_SYSALS_START   0x038
	! Trigger Lux Reading
#define	VL6180X_REG_SYSALS_ANALOGUE_GAIN   0x03F
	! Lux reading gain
#define	VL6180X_REG_SYSALS_INTEGRATION_PERIOD_HI   0x040
	! Integration period for ALS mode, high byte
#define	VL6180X_REG_SYSALS_INTEGRATION_PERIOD_LO   0x041
	! Integration period for ALS mode, low byte
#define	VL6180X_REG_RESULT_RANGE_STATUS   0x04d
	! Specific error codes
#define	VL6180X_REG_RESULT_INTERRUPT_STATUS_GPIO   0x04f
	! Interrupt status
#define	VL6180X_REG_RESULT_ALS_VAL   0x050
	! Light reading value
#define	VL6180X_REG_RESULT_RANGE_VAL   0x062
	! Ranging reading value
#define	VL6180X_REG_SLAVE_DEVICE_ADDRESS   0x212
	! I2C Slave Device Address
#define	VL6180X_ALS_GAIN_1   0x06
	1x gain
#define	VL6180X_ALS_GAIN_1_25   0x05
	1.25x gain
#define	VL6180X_ALS_GAIN_1_67   0x04
	1.67x gain
#define	VL6180X_ALS_GAIN_2_5   0x03
	2.5x gain
#define	VL6180X_ALS_GAIN_5   0x02
	5x gain
#define	VL6180X_ALS_GAIN_10   0x01
	10x gain
#define	VL6180X_ALS_GAIN_20   0x00
	20x gain
#define	VL6180X_ALS_GAIN_40   0x07
	40x gain
#define	VL6180X_ERROR_NONE   0
	Success!
#define	VL6180X_ERROR_SYSERR_1   1
	System error.
#define	VL6180X_ERROR_SYSERR_5   5
	Sysem error.
#define	VL6180X_ERROR_ECEFAIL   6
	Early convergence estimate fail.
#define	VL6180X_ERROR_NOCONVERGE   7
	No target detected.
#define	VL6180X_ERROR_RANGEIGNORE   8
	Ignore threshold check failed.
#define	VL6180X_ERROR_SNR   11
	Ambient conditions too high.
#define	VL6180X_ERROR_RAWUFLOW   12
	Raw range algo underflow.
#define	VL6180X_ERROR_RAWOFLOW   13
	Raw range algo overflow.
#define	VL6180X_ERROR_RANGEUFLOW   14
	Raw range algo underflow.
#define	VL6180X_ERROR_RANGEOFLOW   15
	Raw range algo overflow.

Detailed Description

This is the documentation for Adafruit's VL6180X driver for the Arduino platform. It is designed specifically to work with the Adafruit VL6180X breakout: http://www.adafruit.com/products/3316

These sensors use I2C to communicate, 2 pins (SCL+SDA) are required to interface with the breakout.

Adafruit invests time and resources providing this open source code, please support Adafruit and open-source hardware by purchasing products from Adafruit!

Written by ladyada for Adafruit Industries.

BSD license, all text here must be included in any redistribution.