Adafruit_TSL2591.h

Go to the documentation of this file.

/**************************************************************************/
/**************************************************************************/

#ifndef _TSL2591_H_
#define _TSL2591_H_

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

#define TSL2591_VISIBLE (2)      
#define TSL2591_INFRARED (1)     
#define TSL2591_FULLSPECTRUM (0) 

#define TSL2591_ADDR (0x29) 

#define TSL2591_COMMAND_BIT                                                    \
  (0xA0) 

#define TSL2591_CLEAR_INT (0xE7)
#define TSL2591_TEST_INT (0xE4)

#define TSL2591_WORD_BIT (0x20)  
#define TSL2591_BLOCK_BIT (0x10) 

#define TSL2591_ENABLE_POWEROFF (0x00) 
#define TSL2591_ENABLE_POWERON (0x01)  
#define TSL2591_ENABLE_AEN                                                     \
  (0x02) 
#define TSL2591_ENABLE_AIEN                                                    \
  (0x10) 
#define TSL2591_ENABLE_NPIEN                                                   \
  (0x80) 

#define TSL2591_LUX_DF (408.0F)   
#define TSL2591_LUX_COEFB (1.64F) 
#define TSL2591_LUX_COEFC (0.59F) 
#define TSL2591_LUX_COEFD (0.86F) 

enum {
  TSL2591_REGISTER_ENABLE = 0x00,          // Enable register
  TSL2591_REGISTER_CONTROL = 0x01,         // Control register
  TSL2591_REGISTER_THRESHOLD_AILTL = 0x04, // ALS low threshold lower byte
  TSL2591_REGISTER_THRESHOLD_AILTH = 0x05, // ALS low threshold upper byte
  TSL2591_REGISTER_THRESHOLD_AIHTL = 0x06, // ALS high threshold lower byte
  TSL2591_REGISTER_THRESHOLD_AIHTH = 0x07, // ALS high threshold upper byte
  TSL2591_REGISTER_THRESHOLD_NPAILTL =
      0x08, // No Persist ALS low threshold lower byte
  TSL2591_REGISTER_THRESHOLD_NPAILTH =
      0x09, // No Persist ALS low threshold higher byte
  TSL2591_REGISTER_THRESHOLD_NPAIHTL =
      0x0A, // No Persist ALS high threshold lower byte
  TSL2591_REGISTER_THRESHOLD_NPAIHTH =
      0x0B, // No Persist ALS high threshold higher byte
  TSL2591_REGISTER_PERSIST_FILTER = 0x0C, // Interrupt persistence filter
  TSL2591_REGISTER_PACKAGE_PID = 0x11,    // Package Identification
  TSL2591_REGISTER_DEVICE_ID = 0x12,      // Device Identification
  TSL2591_REGISTER_DEVICE_STATUS = 0x13,  // Internal Status
  TSL2591_REGISTER_CHAN0_LOW = 0x14,      // Channel 0 data, low byte
  TSL2591_REGISTER_CHAN0_HIGH = 0x15,     // Channel 0 data, high byte
  TSL2591_REGISTER_CHAN1_LOW = 0x16,      // Channel 1 data, low byte
  TSL2591_REGISTER_CHAN1_HIGH = 0x17,     // Channel 1 data, high byte
};

typedef enum {
  TSL2591_INTEGRATIONTIME_100MS = 0x00, // 100 millis
  TSL2591_INTEGRATIONTIME_200MS = 0x01, // 200 millis
  TSL2591_INTEGRATIONTIME_300MS = 0x02, // 300 millis
  TSL2591_INTEGRATIONTIME_400MS = 0x03, // 400 millis
  TSL2591_INTEGRATIONTIME_500MS = 0x04, // 500 millis
  TSL2591_INTEGRATIONTIME_600MS = 0x05, // 600 millis
} tsl2591IntegrationTime_t;

typedef enum {
  //  bit 7:4: 0
  TSL2591_PERSIST_EVERY = 0x00, // Every ALS cycle generates an interrupt
  TSL2591_PERSIST_ANY = 0x01,   // Any value outside of threshold range
  TSL2591_PERSIST_2 = 0x02,     // 2 consecutive values out of range
  TSL2591_PERSIST_3 = 0x03,     // 3 consecutive values out of range
  TSL2591_PERSIST_5 = 0x04,     // 5 consecutive values out of range
  TSL2591_PERSIST_10 = 0x05,    // 10 consecutive values out of range
  TSL2591_PERSIST_15 = 0x06,    // 15 consecutive values out of range
  TSL2591_PERSIST_20 = 0x07,    // 20 consecutive values out of range
  TSL2591_PERSIST_25 = 0x08,    // 25 consecutive values out of range
  TSL2591_PERSIST_30 = 0x09,    // 30 consecutive values out of range
  TSL2591_PERSIST_35 = 0x0A,    // 35 consecutive values out of range
  TSL2591_PERSIST_40 = 0x0B,    // 40 consecutive values out of range
  TSL2591_PERSIST_45 = 0x0C,    // 45 consecutive values out of range
  TSL2591_PERSIST_50 = 0x0D,    // 50 consecutive values out of range
  TSL2591_PERSIST_55 = 0x0E,    // 55 consecutive values out of range
  TSL2591_PERSIST_60 = 0x0F,    // 60 consecutive values out of range
} tsl2591Persist_t;

typedef enum {
  TSL2591_GAIN_LOW = 0x00,  
  TSL2591_GAIN_MED = 0x10,  
  TSL2591_GAIN_HIGH = 0x20, 
  TSL2591_GAIN_MAX = 0x30,  
} tsl2591Gain_t;

/**************************************************************************/
/**************************************************************************/
class Adafruit_TSL2591 : public Adafruit_Sensor {
public:
  Adafruit_TSL2591(int32_t sensorID = -1);
  ~Adafruit_TSL2591();

  boolean begin(TwoWire *theWire, uint8_t addr = TSL2591_ADDR);
  boolean begin(uint8_t addr = TSL2591_ADDR);
  void enable(void);
  void disable(void);

  float calculateLux(uint16_t ch0, uint16_t ch1);
  void setGain(tsl2591Gain_t gain);
  void setTiming(tsl2591IntegrationTime_t integration);
  uint16_t getLuminosity(uint8_t channel);
  uint32_t getFullLuminosity();

  tsl2591IntegrationTime_t getTiming();
  tsl2591Gain_t getGain();

  // Interrupt
  void clearInterrupt(void);
  void registerInterrupt(uint16_t lowerThreshold, uint16_t upperThreshold,
                         tsl2591Persist_t persist);
  uint8_t getStatus();

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

private:
  Adafruit_I2CDevice *i2c_dev = NULL; 

  void write8(uint8_t r);
  void write8(uint8_t r, uint8_t v);
  uint16_t read16(uint8_t reg);
  uint8_t read8(uint8_t reg);

  tsl2591IntegrationTime_t _integration;
  tsl2591Gain_t _gain;
  int32_t _sensorID;
  uint8_t _addr;

  boolean _initialized;
};
#endif