Adafruit_TSL2561_U.h

Go to the documentation of this file.

#ifndef ADAFRUIT_TSL2561_H_
#define ADAFRUIT_TSL2561_H_

#include <Adafruit_Sensor.h>
#include <Arduino.h>
#include <Wire.h>

#define TSL2561_VISIBLE 2      
#define TSL2561_INFRARED 1     
#define TSL2561_FULLSPECTRUM 0 

// I2C address options
#define TSL2561_ADDR_LOW (0x29)   
#define TSL2561_ADDR_FLOAT (0x39) 
#define TSL2561_ADDR_HIGH (0x49)  

// Lux calculations differ slightly for CS package
//#define TSL2561_PACKAGE_CS                ///< Chip scale package
#define TSL2561_PACKAGE_T_FN_CL 

#define TSL2561_COMMAND_BIT (0x80) 
#define TSL2561_CLEAR_BIT                                                      \
  (0x40) 
#define TSL2561_WORD_BIT (0x20)  
#define TSL2561_BLOCK_BIT (0x10) 

#define TSL2561_CONTROL_POWERON (0x03) 
#define TSL2561_CONTROL_POWEROFF                                               \
  (0x00) 

#define TSL2561_LUX_LUXSCALE (14)          
#define TSL2561_LUX_RATIOSCALE (9)         
#define TSL2561_LUX_CHSCALE (10)           
#define TSL2561_LUX_CHSCALE_TINT0 (0x7517) 
#define TSL2561_LUX_CHSCALE_TINT1 (0x0FE7) 

// T, FN and CL package values
#define TSL2561_LUX_K1T (0x0040) 
#define TSL2561_LUX_B1T (0x01f2) 
#define TSL2561_LUX_M1T (0x01be) 
#define TSL2561_LUX_K2T (0x0080) 
#define TSL2561_LUX_B2T (0x0214) 
#define TSL2561_LUX_M2T (0x02d1) 
#define TSL2561_LUX_K3T (0x00c0) 
#define TSL2561_LUX_B3T (0x023f) 
#define TSL2561_LUX_M3T (0x037b) 
#define TSL2561_LUX_K4T (0x0100) 
#define TSL2561_LUX_B4T (0x0270) 
#define TSL2561_LUX_M4T (0x03fe) 
#define TSL2561_LUX_K5T (0x0138) 
#define TSL2561_LUX_B5T (0x016f) 
#define TSL2561_LUX_M5T (0x01fc) 
#define TSL2561_LUX_K6T (0x019a) 
#define TSL2561_LUX_B6T (0x00d2) 
#define TSL2561_LUX_M6T (0x00fb) 
#define TSL2561_LUX_K7T (0x029a) 
#define TSL2561_LUX_B7T (0x0018) 
#define TSL2561_LUX_M7T (0x0012) 
#define TSL2561_LUX_K8T (0x029a) 
#define TSL2561_LUX_B8T (0x0000) 
#define TSL2561_LUX_M8T (0x0000) 

// CS package values
#define TSL2561_LUX_K1C (0x0043) 
#define TSL2561_LUX_B1C (0x0204) 
#define TSL2561_LUX_M1C (0x01ad) 
#define TSL2561_LUX_K2C (0x0085) 
#define TSL2561_LUX_B2C (0x0228) 
#define TSL2561_LUX_M2C (0x02c1) 
#define TSL2561_LUX_K3C (0x00c8) 
#define TSL2561_LUX_B3C (0x0253) 
#define TSL2561_LUX_M3C (0x0363) 
#define TSL2561_LUX_K4C (0x010a) 
#define TSL2561_LUX_B4C (0x0282) 
#define TSL2561_LUX_M4C (0x03df) 
#define TSL2561_LUX_K5C (0x014d) 
#define TSL2561_LUX_B5C (0x0177) 
#define TSL2561_LUX_M5C (0x01dd) 
#define TSL2561_LUX_K6C (0x019a) 
#define TSL2561_LUX_B6C (0x0101) 
#define TSL2561_LUX_M6C (0x0127) 
#define TSL2561_LUX_K7C (0x029a) 
#define TSL2561_LUX_B7C (0x0037) 
#define TSL2561_LUX_M7C (0x002b) 
#define TSL2561_LUX_K8C (0x029a) 
#define TSL2561_LUX_B8C (0x0000) 
#define TSL2561_LUX_M8C (0x0000) 

// Auto-gain thresholds
#define TSL2561_AGC_THI_13MS (4850)   
#define TSL2561_AGC_TLO_13MS (100)    
#define TSL2561_AGC_THI_101MS (36000) 
#define TSL2561_AGC_TLO_101MS (200)   
#define TSL2561_AGC_THI_402MS (63000) 
#define TSL2561_AGC_TLO_402MS (500)   

// Clipping thresholds
#define TSL2561_CLIPPING_13MS                                                  \
  (4900) 
#define TSL2561_CLIPPING_101MS                                                 \
  (37000) 
#define TSL2561_CLIPPING_402MS                                                 \
  (65000) 

// Delay for integration times
#define TSL2561_DELAY_INTTIME_13MS (15)   
#define TSL2561_DELAY_INTTIME_101MS (120) 
#define TSL2561_DELAY_INTTIME_402MS (450) 


enum {
  TSL2561_REGISTER_CONTROL = 0x00,          // Control/power register
  TSL2561_REGISTER_TIMING = 0x01,           // Set integration time register
  TSL2561_REGISTER_THRESHHOLDL_LOW = 0x02,  // Interrupt low threshold low-byte
  TSL2561_REGISTER_THRESHHOLDL_HIGH = 0x03, // Interrupt low threshold high-byte
  TSL2561_REGISTER_THRESHHOLDH_LOW = 0x04,  // Interrupt high threshold low-byte
  TSL2561_REGISTER_THRESHHOLDH_HIGH =
      0x05,                           // Interrupt high threshold high-byte
  TSL2561_REGISTER_INTERRUPT = 0x06,  // Interrupt settings
  TSL2561_REGISTER_CRC = 0x08,        // Factory use only
  TSL2561_REGISTER_ID = 0x0A,         // TSL2561 identification setting
  TSL2561_REGISTER_CHAN0_LOW = 0x0C,  // Light data channel 0, low byte
  TSL2561_REGISTER_CHAN0_HIGH = 0x0D, // Light data channel 0, high byte
  TSL2561_REGISTER_CHAN1_LOW = 0x0E,  // Light data channel 1, low byte
  TSL2561_REGISTER_CHAN1_HIGH = 0x0F  // Light data channel 1, high byte
};

typedef enum {
  TSL2561_INTEGRATIONTIME_13MS = 0x00,  // 13.7ms
  TSL2561_INTEGRATIONTIME_101MS = 0x01, // 101ms
  TSL2561_INTEGRATIONTIME_402MS = 0x02  // 402ms
} tsl2561IntegrationTime_t;

typedef enum {
  TSL2561_GAIN_1X = 0x00,  // No gain
  TSL2561_GAIN_16X = 0x10, // 16x gain
} tsl2561Gain_t;

/**************************************************************************/
/**************************************************************************/
class Adafruit_TSL2561_Unified : public Adafruit_Sensor {
public:
  Adafruit_TSL2561_Unified(uint8_t addr, int32_t sensorID = -1);
  boolean begin(void);
  boolean begin(TwoWire *theWire);
  boolean init();

  /* TSL2561 Functions */
  void enableAutoRange(bool enable);
  void setIntegrationTime(tsl2561IntegrationTime_t time);
  void setGain(tsl2561Gain_t gain);
  void getLuminosity(uint16_t *broadband, uint16_t *ir);
  uint32_t calculateLux(uint16_t broadband, uint16_t ir);

  /* Unified Sensor API Functions */
  bool getEvent(sensors_event_t *);
  void getSensor(sensor_t *);

private:
  TwoWire *_i2c;

  int8_t _addr;
  boolean _tsl2561Initialised;
  boolean _tsl2561AutoGain;
  tsl2561IntegrationTime_t _tsl2561IntegrationTime;
  tsl2561Gain_t _tsl2561Gain;
  int32_t _tsl2561SensorID;

  void enable(void);
  void disable(void);
  void write8(uint8_t reg, uint8_t value);
  uint8_t read8(uint8_t reg);
  uint16_t read16(uint8_t reg);
  void getData(uint16_t *broadband, uint16_t *ir);
};

#endif // ADAFRUIT_TSL2561_H