VCNL4010.h

Go to the documentation of this file.

// clang-format off
// clang-format on
#include "Arduino.h"  // Arduino data type definitions
#include <Wire.h>     // Standard I2C "Wire" library
#ifndef VCNL4010_h    // Guard code definition

#define VCNL4010_h  // Define the name inside guard code
#ifndef _BV
#define _BV(bit) (1 << (bit))  
#endif
/********************************************
** Declare all constants used in the class **
********************************************/
#ifndef I2C_MODES  // I2C related constants

#define I2C_MODES                                 // Guard code to prevent multiple declarations
const uint32_t I2C_STANDARD_MODE{100000};         
const uint32_t I2C_FAST_MODE{400000};             
const uint32_t I2C_FAST_MODE_PLUS_MODE{1000000};  
const uint32_t I2C_HIGH_SPEED_MODE{3400000};      
#endif
const uint8_t VCNL4010_I2C_ADDRESS{0x13};       
const uint8_t VCNL4010_PRODUCT_VERSION{0x21};   
const uint8_t VCNL4010_I2C_MS_DELAY{200};       
const uint8_t REGISTER_CMD{0x80};               
const uint8_t REGISTER_PRODUCT{0x81};           
const uint8_t REGISTER_PROXIMITY_RATE{0x82};    
const uint8_t REGISTER_LED_CURRENT{0x83};       
const uint8_t REGISTER_AMBIENT_PARAM{0x84};     
const uint8_t REGISTER_AMBIENT_LIGHT{0x85};     
const uint8_t REGISTER_PROXIMITY{0x87};         
const uint8_t REGISTER_INTERRUPT{0x89};         
const uint8_t REGISTER_LOW_THRESH_MSB{0x8A};    
const uint8_t REGISTER_LOW_THRESH_LSB{0x8B};    
const uint8_t REGISTER_HIGH_THRESH_MSB{0x8C};   
const uint8_t REGISTER_HIGH_THRESH_LSB{0x8D};   
const uint8_t REGISTER_INTERRUPT_STATUS{0x8E};  
const uint8_t REGISTER_PROXIMITY_TIMING{0x8F};  
const uint8_t BIT_ALS_DATA_RDY{6};              
const uint8_t BIT_PROX_DATA_RDY{5};             
const uint8_t BIT_ALS_OD{4};                    
const uint8_t BIT_PROX_OD{3};                   
const uint8_t BIT_ALS_EN{2};                    
const uint8_t BIT_PROX_EN{1};                   
const uint8_t BIT_SELFTIMED_EN{0};              

class VCNL4010 {
 public:
  VCNL4010();
  ~VCNL4010();
  bool     begin(void);                                     // Overloaded just device address
  bool     begin(const uint8_t deviceAddress);              // Overloaded just device address
  bool     begin(const uint32_t &i2CSpeed);                 // Overloaded just speed
  bool     begin(const uint8_t   deviceAddress,             // Start I2C communications
                 const uint32_t &i2CSpeed);                 // specifying both parameters
  void     setProximityHz(const uint8_t Hz = 2);            // Set proximity Hz sampling rate
  void     setLEDmA(const uint8_t mA = 20) const;           // Set milliamperes used by IR LED
  void     setProximityFreq(const uint8_t value = 0);       // Set Frequency value from list
  uint16_t getAmbientLight() const;                         // Retrieve ambient light reading
  uint16_t getProximity() const;                            // Retrieve proximity reading
  uint8_t  getInterrupt() const;                            // Retrieve Interrupt bits
  void     clearInterrupt(const uint8_t intVal = 0) const;  // Clear Interrupt bits
  uint8_t  readByte(const uint8_t addr) const;              // Read a single byte from device
  uint16_t readWord(const uint8_t addr) const;              // Read two bytes from device
  void     writeByte(const uint8_t addr, const uint8_t data) const;  // Write a byte to device
  void     setAmbientLight(const uint8_t sample = 2,
                           const uint8_t avg    = 32) const;           // Set samples and avg
  void     setAmbientContinuous(const bool ContinuousMode = true);  // Cont. Ambient sampling on/off
  void     setProximityContinuous(const bool ContinuousMode = true);  // Cont. Prox sampling on/off
  void     setInterrupt(const uint8_t count = 1, const bool ProxReady = false,
                        const bool ALSReady = false, const bool ProxThreshold = false,
                        const bool ALSThreshold = false, const uint16_t lowThreshold = 0,
                        const uint16_t highThreshold = UINT16_MAX) const;

 private:
  bool    _ContinuousAmbient   = false;                 // If mode turned on for Ambient readings
  bool    _ContinuousProximity = false;                 // If mode turned on for Proximity readings
  uint8_t _I2Caddress          = VCNL4010_I2C_ADDRESS;  // Default to standard I2C address
};                                                      // of VCNL4010 class definition
#endif