Adafruit_VCNL4040.h

Go to the documentation of this file.

#ifndef _ADAFRUIT_VCNL4040_H
#define _ADAFRUIT_VCNL4040_H

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

#define VCNL4040_I2CADDR_DEFAULT 0x60 

// All addresses are for 16bit registers;
// duplicates are for high or low bytes that aren't used together
#define VCNL4040_ALS_CONFIG                                                    \
  0x00                         
#define VCNL4040_ALS_THDH 0x01 
#define VCNL4040_ALS_THDL 0x02 
#define VCNL4040_PS_CONF1_L                                                    \
  0x03                         
#define VCNL4040_PS_MS_H 0x04  
#define VCNL4040_PS_THDL 0x06  
#define VCNL4040_PS_THDH 0x07  
#define VCNL4040_PS_DATA 0x08  
#define VCNL4040_ALS_DATA 0x09 
#define VCNL4040_WHITE_DATA 0x0A 
#define VCNL4040_INT_FLAG 0x0B   
#define VCNL4040_DEVICE_ID 0x0C  


typedef enum led_current {
  VCNL4040_LED_CURRENT_50MA,
  VCNL4040_LED_CURRENT_75MA,
  VCNL4040_LED_CURRENT_100MA,
  VCNL4040_LED_CURRENT_120MA,
  VCNL4040_LED_CURRENT_140MA,
  VCNL4040_LED_CURRENT_160MA,
  VCNL4040_LED_CURRENT_180MA,
  VCNL4040_LED_CURRENT_200MA,
} VCNL4040_LEDCurrent;

typedef enum led_duty_cycle {
  VCNL4040_LED_DUTY_1_40,
  VCNL4040_LED_DUTY_1_80,
  VCNL4040_LED_DUTY_1_160,
  VCNL4040_LED_DUTY_1_320,
} VCNL4040_LEDDutyCycle;

typedef enum ambient_integration_time {
  VCNL4040_AMBIENT_INTEGRATION_TIME_80MS,
  VCNL4040_AMBIENT_INTEGRATION_TIME_160MS,
  VCNL4040_AMBIENT_INTEGRATION_TIME_320MS,
  VCNL4040_AMBIENT_INTEGRATION_TIME_640MS,
} VCNL4040_AmbientIntegration;

typedef enum proximity_integration_time {
  VCNL4040_PROXIMITY_INTEGRATION_TIME_1T,
  VCNL4040_PROXIMITY_INTEGRATION_TIME_1_5T,
  VCNL4040_PROXIMITY_INTEGRATION_TIME_2T,
  VCNL4040_PROXIMITY_INTEGRATION_TIME_2_5T,
  VCNL4040_PROXIMITY_INTEGRATION_TIME_3T,
  VCNL4040_PROXIMITY_INTEGRATION_TIME_3_5T,
  VCNL4040_PROXIMITY_INTEGRATION_TIME_4T,
  VCNL4040_PROXIMITY_INTEGRATION_TIME_8T,
} VCNL4040_ProximityIntegration;
typedef enum proximity_type {
  VCNL4040_PROXIMITY_INT_DISABLE,
  VCNL4040_PROXIMITY_INT_CLOSE,
  VCNL4040_PROXIMITY_INT_AWAY,
  VCNL4040_PROXIMITY_INT_CLOSE_AWAY,
} VCNL4040_ProximityType;

typedef enum interrupt_type {
  VCNL4040_PROXIMITY_AWAY,
  VCNL4040_PROXIMITY_CLOSE,
  VCNL4040_AMBIENT_HIGH = 4,
  VCNL4040_AMBIENT_LOW,
} VCNL4040_InterruptType;

class Adafruit_VCNL4040 {
public:
  Adafruit_VCNL4040();
  boolean begin(uint8_t i2c_addr = VCNL4040_I2CADDR_DEFAULT,
                TwoWire *wire = &Wire);
  uint16_t getProximity(void);
  uint16_t getAmbientLight(void);
  uint16_t getWhiteLight(void);
  uint16_t getLux(void);

  void enableProximity(bool enable);
  void enableAmbientLight(bool enable);
  void enableWhiteLight(bool enable);

  uint8_t getInterruptStatus(void);
  void enableAmbientLightInterrupts(bool enable);

  uint16_t getAmbientLightHighThreshold(void);
  void setAmbientLightHighThreshold(uint16_t high_threshold);

  uint16_t getAmbientLightLowThreshold(void);
  void setAmbientLightLowThreshold(uint16_t low_threshold);

  void enableProximityInterrupts(VCNL4040_ProximityType interrupt_condition);

  uint16_t getProximityLowThreshold(void);
  void setProximityLowThreshold(uint16_t low_threshold);

  uint16_t getProximityHighThreshold(void);
  void setProximityHighThreshold(uint16_t high_threshold);

  VCNL4040_ProximityIntegration getProximityIntegrationTime(void);
  void
  setProximityIntegrationTime(VCNL4040_ProximityIntegration integration_time);

  VCNL4040_AmbientIntegration getAmbientIntegrationTime(void);
  void setAmbientIntegrationTime(VCNL4040_AmbientIntegration integration_time);

  VCNL4040_LEDCurrent getProximityLEDCurrent(void);
  void setProximityLEDCurrent(VCNL4040_LEDCurrent led_current);

  VCNL4040_LEDDutyCycle getProximityLEDDutyCycle(void);
  void setProximityLEDDutyCycle(VCNL4040_LEDDutyCycle duty_cycle);

  bool getProximityHighResolution(void);
  void setProximityHighResolution(bool high_resolution);

  Adafruit_BusIO_Register
      *PS_CONFIG_12, 
      *ALS_CONFIG,   
      *PS_MS;        

private:
  bool _init(void);

  Adafruit_I2CDevice *i2c_dev;
};

#endif