ThinkingSkins - MossSolar Facade  Version 1.0
 All Classes Files Functions Variables Pages
Adafruit_TSL2561_U.h
1 /**************************************************************************/
35 /**************************************************************************/
36 #ifndef _TSL2561_H_
37 #define _TSL2561_H_
38 
39 #if ARDUINO >= 100
40  #include <Arduino.h>
41 #else
42  #include <WProgram.h>
43 #endif
44 #include <Adafruit_Sensor.h>
45 #include <Wire.h>
46 
47 #define TSL2561_VISIBLE 2 // channel 0 - channel 1
48 #define TSL2561_INFRARED 1 // channel 1
49 #define TSL2561_FULLSPECTRUM 0 // channel 0
50 
51 // I2C address options
52 #define TSL2561_ADDR_LOW (0x29)
53 #define TSL2561_ADDR_FLOAT (0x39) // Default address (pin left floating)
54 #define TSL2561_ADDR_HIGH (0x49)
55 
56 // Lux calculations differ slightly for CS package
57 //#define TSL2561_PACKAGE_CS
58 #define TSL2561_PACKAGE_T_FN_CL
59 
60 #define TSL2561_COMMAND_BIT (0x80) // Must be 1
61 #define TSL2561_CLEAR_BIT (0x40) // Clears any pending interrupt (write 1 to clear)
62 #define TSL2561_WORD_BIT (0x20) // 1 = read/write word (rather than byte)
63 #define TSL2561_BLOCK_BIT (0x10) // 1 = using block read/write
64 
65 #define TSL2561_CONTROL_POWERON (0x03)
66 #define TSL2561_CONTROL_POWEROFF (0x00)
67 
68 #define TSL2561_LUX_LUXSCALE (14) // Scale by 2^14
69 #define TSL2561_LUX_RATIOSCALE (9) // Scale ratio by 2^9
70 #define TSL2561_LUX_CHSCALE (10) // Scale channel values by 2^10
71 #define TSL2561_LUX_CHSCALE_TINT0 (0x7517) // 322/11 * 2^TSL2561_LUX_CHSCALE
72 #define TSL2561_LUX_CHSCALE_TINT1 (0x0FE7) // 322/81 * 2^TSL2561_LUX_CHSCALE
73 
74 // T, FN and CL package values
75 #define TSL2561_LUX_K1T (0x0040) // 0.125 * 2^RATIO_SCALE
76 #define TSL2561_LUX_B1T (0x01f2) // 0.0304 * 2^LUX_SCALE
77 #define TSL2561_LUX_M1T (0x01be) // 0.0272 * 2^LUX_SCALE
78 #define TSL2561_LUX_K2T (0x0080) // 0.250 * 2^RATIO_SCALE
79 #define TSL2561_LUX_B2T (0x0214) // 0.0325 * 2^LUX_SCALE
80 #define TSL2561_LUX_M2T (0x02d1) // 0.0440 * 2^LUX_SCALE
81 #define TSL2561_LUX_K3T (0x00c0) // 0.375 * 2^RATIO_SCALE
82 #define TSL2561_LUX_B3T (0x023f) // 0.0351 * 2^LUX_SCALE
83 #define TSL2561_LUX_M3T (0x037b) // 0.0544 * 2^LUX_SCALE
84 #define TSL2561_LUX_K4T (0x0100) // 0.50 * 2^RATIO_SCALE
85 #define TSL2561_LUX_B4T (0x0270) // 0.0381 * 2^LUX_SCALE
86 #define TSL2561_LUX_M4T (0x03fe) // 0.0624 * 2^LUX_SCALE
87 #define TSL2561_LUX_K5T (0x0138) // 0.61 * 2^RATIO_SCALE
88 #define TSL2561_LUX_B5T (0x016f) // 0.0224 * 2^LUX_SCALE
89 #define TSL2561_LUX_M5T (0x01fc) // 0.0310 * 2^LUX_SCALE
90 #define TSL2561_LUX_K6T (0x019a) // 0.80 * 2^RATIO_SCALE
91 #define TSL2561_LUX_B6T (0x00d2) // 0.0128 * 2^LUX_SCALE
92 #define TSL2561_LUX_M6T (0x00fb) // 0.0153 * 2^LUX_SCALE
93 #define TSL2561_LUX_K7T (0x029a) // 1.3 * 2^RATIO_SCALE
94 #define TSL2561_LUX_B7T (0x0018) // 0.00146 * 2^LUX_SCALE
95 #define TSL2561_LUX_M7T (0x0012) // 0.00112 * 2^LUX_SCALE
96 #define TSL2561_LUX_K8T (0x029a) // 1.3 * 2^RATIO_SCALE
97 #define TSL2561_LUX_B8T (0x0000) // 0.000 * 2^LUX_SCALE
98 #define TSL2561_LUX_M8T (0x0000) // 0.000 * 2^LUX_SCALE
99 
100 // CS package values
101 #define TSL2561_LUX_K1C (0x0043) // 0.130 * 2^RATIO_SCALE
102 #define TSL2561_LUX_B1C (0x0204) // 0.0315 * 2^LUX_SCALE
103 #define TSL2561_LUX_M1C (0x01ad) // 0.0262 * 2^LUX_SCALE
104 #define TSL2561_LUX_K2C (0x0085) // 0.260 * 2^RATIO_SCALE
105 #define TSL2561_LUX_B2C (0x0228) // 0.0337 * 2^LUX_SCALE
106 #define TSL2561_LUX_M2C (0x02c1) // 0.0430 * 2^LUX_SCALE
107 #define TSL2561_LUX_K3C (0x00c8) // 0.390 * 2^RATIO_SCALE
108 #define TSL2561_LUX_B3C (0x0253) // 0.0363 * 2^LUX_SCALE
109 #define TSL2561_LUX_M3C (0x0363) // 0.0529 * 2^LUX_SCALE
110 #define TSL2561_LUX_K4C (0x010a) // 0.520 * 2^RATIO_SCALE
111 #define TSL2561_LUX_B4C (0x0282) // 0.0392 * 2^LUX_SCALE
112 #define TSL2561_LUX_M4C (0x03df) // 0.0605 * 2^LUX_SCALE
113 #define TSL2561_LUX_K5C (0x014d) // 0.65 * 2^RATIO_SCALE
114 #define TSL2561_LUX_B5C (0x0177) // 0.0229 * 2^LUX_SCALE
115 #define TSL2561_LUX_M5C (0x01dd) // 0.0291 * 2^LUX_SCALE
116 #define TSL2561_LUX_K6C (0x019a) // 0.80 * 2^RATIO_SCALE
117 #define TSL2561_LUX_B6C (0x0101) // 0.0157 * 2^LUX_SCALE
118 #define TSL2561_LUX_M6C (0x0127) // 0.0180 * 2^LUX_SCALE
119 #define TSL2561_LUX_K7C (0x029a) // 1.3 * 2^RATIO_SCALE
120 #define TSL2561_LUX_B7C (0x0037) // 0.00338 * 2^LUX_SCALE
121 #define TSL2561_LUX_M7C (0x002b) // 0.00260 * 2^LUX_SCALE
122 #define TSL2561_LUX_K8C (0x029a) // 1.3 * 2^RATIO_SCALE
123 #define TSL2561_LUX_B8C (0x0000) // 0.000 * 2^LUX_SCALE
124 #define TSL2561_LUX_M8C (0x0000) // 0.000 * 2^LUX_SCALE
125 
126 // Auto-gain thresholds
127 #define TSL2561_AGC_THI_13MS (4850) // Max value at Ti 13ms = 5047
128 #define TSL2561_AGC_TLO_13MS (100)
129 #define TSL2561_AGC_THI_101MS (36000) // Max value at Ti 101ms = 37177
130 #define TSL2561_AGC_TLO_101MS (200)
131 #define TSL2561_AGC_THI_402MS (63000) // Max value at Ti 402ms = 65535
132 #define TSL2561_AGC_TLO_402MS (500)
133 
134 // Clipping thresholds
135 #define TSL2561_CLIPPING_13MS (4900)
136 #define TSL2561_CLIPPING_101MS (37000)
137 #define TSL2561_CLIPPING_402MS (65000)
138 
139 enum
140 {
141  TSL2561_REGISTER_CONTROL = 0x00,
142  TSL2561_REGISTER_TIMING = 0x01,
143  TSL2561_REGISTER_THRESHHOLDL_LOW = 0x02,
144  TSL2561_REGISTER_THRESHHOLDL_HIGH = 0x03,
145  TSL2561_REGISTER_THRESHHOLDH_LOW = 0x04,
146  TSL2561_REGISTER_THRESHHOLDH_HIGH = 0x05,
147  TSL2561_REGISTER_INTERRUPT = 0x06,
148  TSL2561_REGISTER_CRC = 0x08,
149  TSL2561_REGISTER_ID = 0x0A,
150  TSL2561_REGISTER_CHAN0_LOW = 0x0C,
151  TSL2561_REGISTER_CHAN0_HIGH = 0x0D,
152  TSL2561_REGISTER_CHAN1_LOW = 0x0E,
153  TSL2561_REGISTER_CHAN1_HIGH = 0x0F
154 };
155 
156 typedef enum
157 {
158  TSL2561_INTEGRATIONTIME_13MS = 0x00, // 13.7ms
159  TSL2561_INTEGRATIONTIME_101MS = 0x01, // 101ms
160  TSL2561_INTEGRATIONTIME_402MS = 0x02 // 402ms
161 }
162 tsl2561IntegrationTime_t;
163 
164 typedef enum
165 {
166  TSL2561_GAIN_1X = 0x00, // No gain
167  TSL2561_GAIN_16X = 0x10, // 16x gain
168 }
169 tsl2561Gain_t;
170 
172  public:
173  Adafruit_TSL2561_Unified(uint8_t addr, int32_t sensorID = -1);
174  boolean begin(void);
175 
176  /* TSL2561 Functions */
177  void enableAutoRange(bool enable);
178  void setIntegrationTime(tsl2561IntegrationTime_t time);
179  void setGain(tsl2561Gain_t gain);
180  void getLuminosity (uint16_t *broadband, uint16_t *ir);
181  uint32_t calculateLux(uint16_t broadband, uint16_t ir);
182 
183  /* Unified Sensor API Functions */
184  void getEvent(sensors_event_t*);
185  void getSensor(sensor_t*);
186 
187  private:
188  int8_t _addr;
189  boolean _tsl2561Initialised;
190  boolean _tsl2561AutoGain;
191  tsl2561IntegrationTime_t _tsl2561IntegrationTime;
192  tsl2561Gain_t _tsl2561Gain;
193  int32_t _tsl2561SensorID;
194 
195  void enable (void);
196  void disable (void);
197  void write8 (uint8_t reg, uint32_t value);
198  uint8_t read8 (uint8_t reg);
199  uint16_t read16 (uint8_t reg);
200  void getData (uint16_t *broadband, uint16_t *ir);
201 };
202 #endif
uint32_t calculateLux(uint16_t broadband, uint16_t ir)
Definition: Adafruit_TSL2561_U.cpp:363
Definition: Adafruit_Sensor.h:139
void enableAutoRange(bool enable)
Enables or disables the auto-gain settings when reading data from the sensor.
Definition: Adafruit_TSL2561_U.cpp:220
Definition: Adafruit_Sensor.h:127
void setGain(tsl2561Gain_t gain)
Definition: Adafruit_TSL2561_U.cpp:252
void getLuminosity(uint16_t *broadband, uint16_t *ir)
Gets the broadband (mixed lighting) and IR only values from the TSL2561, adjusting gain if auto-gain ...
Definition: Adafruit_TSL2561_U.cpp:275
void getSensor(sensor_t *)
Gets the sensor_t data.
Definition: Adafruit_TSL2561_U.cpp:499
Adafruit_TSL2561_Unified(uint8_t addr, int32_t sensorID=-1)
Definition: Adafruit_TSL2561_U.cpp:172
Definition: Adafruit_Sensor.h:100
boolean begin(void)
Definition: Adafruit_TSL2561_U.cpp:192
void getEvent(sensors_event_t *)
Gets the most recent sensor event.
Definition: Adafruit_TSL2561_U.cpp:477
void setIntegrationTime(tsl2561IntegrationTime_t time)
Definition: Adafruit_TSL2561_U.cpp:230
Definition: Adafruit_TSL2561_U.h:171