diff --git a/Adafruit_TSL2561_U.cpp b/Adafruit_TSL2561_U.cpp
index 38124c5..daf275a 100644
--- a/Adafruit_TSL2561_U.cpp
+++ b/Adafruit_TSL2561_U.cpp
@@ -1,168 +1,45 @@
-/**************************************************************************/
/*!
- @file Adafruit_TSL2561.cpp
- @author K.Townsend (Adafruit Industries)
- @license BSD (see license.txt)
-
- Driver for the TSL2561 digital luminosity (light) sensors.
-
- Pick one up at http://www.adafruit.com/products/439
-
- Adafruit invests time and resources providing this open source code,
- please support Adafruit and open-source hardware by purchasing
- products from Adafruit!
-
- @section HISTORY
-
- v2.0 - Rewrote driver for Adafruit_Sensor and Auto-Gain support, and
- added lux clipping check (returns 0 lux on sensor saturation)
- v1.0 - First release (previously TSL2561)
+ * @file Adafruit_TSL2561_U.cpp
+ *
+ * @mainpage Adafruit TSL2561 Light/Lux sensor driver
+ *
+ * @section intro_sec Introduction
+ *
+ * This is the documentation for Adafruit's TSL2561 driver for the
+ * Arduino platform. It is designed specifically to work with the
+ * Adafruit TSL2561 breakout: http://www.adafruit.com/products/439
+ *
+ * These sensors use I2C to communicate, 2 pins (SCL+SDA) are required
+ * to interface with the breakout.
+ *
+ * Adafruit invests time and resources providing this open source code,
+ * please support Adafruit and open-source hardware by purchasing
+ * products from Adafruit!
+ *
+ * @section dependencies Dependencies
+ *
+ * This library depends on
+ * Adafruit_Sensor being present on your system. Please make sure you have
+ * installed the latest version before using this library.
+ *
+ * @section author Author
+ *
+ * Written by Kevin "KTOWN" Townsend for Adafruit Industries.
+ *
+ * @section license License
+ *
+ * BSD license, all text here must be included in any redistribution.
+ *
+ * @section HISTORY
+ *
+ * v2.0 - Rewrote driver for Adafruit_Sensor and Auto-Gain support, and
+ * added lux clipping check (returns 0 lux on sensor saturation)
+ * v1.0 - First release (previously TSL2561)
*/
/**************************************************************************/
-#if defined(__AVR__)
-#include
-#include
-#elif !defined(TEENSYDUINO)
-#include "pgmspace.h"
-#endif
-#include
#include "Adafruit_TSL2561_U.h"
-#define TSL2561_DELAY_INTTIME_13MS (15)
-#define TSL2561_DELAY_INTTIME_101MS (120)
-#define TSL2561_DELAY_INTTIME_402MS (450)
-
-/*========================================================================*/
-/* PRIVATE FUNCTIONS */
-/*========================================================================*/
-
-/**************************************************************************/
-/*!
- @brief Writes a register and an 8 bit value over I2C
-*/
-/**************************************************************************/
-void Adafruit_TSL2561_Unified::write8 (uint8_t reg, uint32_t value)
-{
- wire -> beginTransmission(_addr);
- #if ARDUINO >= 100
- wire -> write(reg);
- wire -> write(value & 0xFF);
- #else
- wire -> send(reg);
- wire -> send(value & 0xFF);
- #endif
- wire -> endTransmission();
-}
-
-/**************************************************************************/
-/*!
- @brief Reads an 8 bit value over I2C
-*/
-/**************************************************************************/
-uint8_t Adafruit_TSL2561_Unified::read8(uint8_t reg)
-{
- wire -> beginTransmission(_addr);
- #if ARDUINO >= 100
- wire -> write(reg);
- #else
- wire -> send(reg);
- #endif
- wire -> endTransmission();
-
- wire -> requestFrom(_addr, 1);
- #if ARDUINO >= 100
- return wire -> read();
- #else
- return wire -> receive();
- #endif
-}
-
-/**************************************************************************/
-/*!
- @brief Reads a 16 bit values over I2C
-*/
-/**************************************************************************/
-uint16_t Adafruit_TSL2561_Unified::read16(uint8_t reg)
-{
- uint16_t x; uint16_t t;
-
- wire -> beginTransmission(_addr);
- #if ARDUINO >= 100
- wire -> write(reg);
- #else
- wire -> send(reg);
- #endif
- wire -> endTransmission();
-
- wire -> requestFrom(_addr, 2);
- #if ARDUINO >= 100
- t = wire -> read();
- x = wire -> read();
- #else
- t = wire -> receive();
- x = wire -> receive();
- #endif
- x <<= 8;
- x |= t;
- return x;
-}
-
-/**************************************************************************/
-/*!
- Enables the device
-*/
-/**************************************************************************/
-void Adafruit_TSL2561_Unified::enable(void)
-{
- /* Enable the device by setting the control bit to 0x03 */
- write8(TSL2561_COMMAND_BIT | TSL2561_REGISTER_CONTROL, TSL2561_CONTROL_POWERON);
-}
-
-/**************************************************************************/
-/*!
- Disables the device (putting it in lower power sleep mode)
-*/
-/**************************************************************************/
-void Adafruit_TSL2561_Unified::disable(void)
-{
- /* Turn the device off to save power */
- write8(TSL2561_COMMAND_BIT | TSL2561_REGISTER_CONTROL, TSL2561_CONTROL_POWEROFF);
-}
-
-/**************************************************************************/
-/*!
- Private function to read luminosity on both channels
-*/
-/**************************************************************************/
-void Adafruit_TSL2561_Unified::getData (uint16_t *broadband, uint16_t *ir)
-{
- /* Enable the device by setting the control bit to 0x03 */
- enable();
-
- /* Wait x ms for ADC to complete */
- switch (_tsl2561IntegrationTime)
- {
- case TSL2561_INTEGRATIONTIME_13MS:
- delay(TSL2561_DELAY_INTTIME_13MS); // KTOWN: Was 14ms
- break;
- case TSL2561_INTEGRATIONTIME_101MS:
- delay(TSL2561_DELAY_INTTIME_101MS); // KTOWN: Was 102ms
- break;
- default:
- delay(TSL2561_DELAY_INTTIME_402MS); // KTOWN: Was 403ms
- break;
- }
-
- /* Reads a two byte value from channel 0 (visible + infrared) */
- *broadband = read16(TSL2561_COMMAND_BIT | TSL2561_WORD_BIT | TSL2561_REGISTER_CHAN0_LOW);
-
- /* Reads a two byte value from channel 1 (infrared) */
- *ir = read16(TSL2561_COMMAND_BIT | TSL2561_WORD_BIT | TSL2561_REGISTER_CHAN1_LOW);
-
- /* Turn the device off to save power */
- disable();
-}
/*========================================================================*/
/* CONSTRUCTORS */
@@ -170,7 +47,10 @@ void Adafruit_TSL2561_Unified::getData (uint16_t *broadband, uint16_t *ir)
/**************************************************************************/
/*!
- Constructor
+ @brief Constructor
+ @param addr The I2C address this chip can be found on, 0x29, 0x39 or 0x49
+ @param sensorID An optional ID that will be placed in sensor events to help
+ keep track if you have many sensors in use
*/
/**************************************************************************/
Adafruit_TSL2561_Unified::Adafruit_TSL2561_Unified(uint8_t addr, int32_t sensorID)
@@ -189,24 +69,41 @@ Adafruit_TSL2561_Unified::Adafruit_TSL2561_Unified(uint8_t addr, int32_t sensorI
/**************************************************************************/
/*!
- Initializes I2C and configures the sensor (call this function before
- doing anything else)
+ @brief Initializes I2C and configures the sensor with default Wire I2C
+ (call this function before doing anything else)
+ @returns True if sensor is found and initialized, false otherwise.
*/
/**************************************************************************/
boolean Adafruit_TSL2561_Unified::begin()
{
wire = &Wire;
- wire -> begin();
+ _i2c->begin();
return init();
}
+/**************************************************************************/
+/*!
+ @brief Initializes I2C and configures the sensor with provided I2C device
+ (call this function before doing anything else)
+ @param theWire A pointer to any I2C interface (e.g. &Wire1)
+ @returns True if sensor is found and initialized, false otherwise.
+*/
+/**************************************************************************/
boolean Adafruit_TSL2561_Unified::begin(TwoWire *theWire)
{
wire = theWire;
- wire -> begin();
+ _i2c-> begin();
return init();
}
+/**************************************************************************/
+/*!
+ @brief Initializes I2C connection and settings.
+ Attempts to determine if the sensor is contactable, then sets up a default
+ integration time and gain. Then powers down the chip.
+ @returns True if sensor is found and initialized, false otherwise.
+*/
+/**************************************************************************/
boolean Adafruit_TSL2561_Unified::init()
{
/* Make sure we're actually connected */
@@ -231,6 +128,7 @@ boolean Adafruit_TSL2561_Unified::init()
/*!
@brief Enables or disables the auto-gain settings when reading
data from the sensor
+ @param enable Set to true to enable, False to disable
*/
/**************************************************************************/
void Adafruit_TSL2561_Unified::enableAutoRange(bool enable)
@@ -240,7 +138,10 @@ void Adafruit_TSL2561_Unified::enableAutoRange(bool enable)
/**************************************************************************/
/*!
- Sets the integration time for the TSL2561
+ @brief Sets the integration time for the TSL2561. Higher time means
+ more light captured (better for low light conditions) but will
+ take longer to run readings.
+ @param time The amount of time we'd like to add up values
*/
/**************************************************************************/
void Adafruit_TSL2561_Unified::setIntegrationTime(tsl2561IntegrationTime_t time)
@@ -262,7 +163,8 @@ void Adafruit_TSL2561_Unified::setIntegrationTime(tsl2561IntegrationTime_t time)
/**************************************************************************/
/*!
- Adjusts the gain on the TSL2561 (adjusts the sensitivity to light)
+ @brief Adjusts the gain on the TSL2561 (adjusts the sensitivity to light)
+ @param gain The value we'd like to set the gain to
*/
/**************************************************************************/
void Adafruit_TSL2561_Unified::setGain(tsl2561Gain_t gain)
@@ -286,6 +188,10 @@ void Adafruit_TSL2561_Unified::setGain(tsl2561Gain_t gain)
/*!
@brief Gets the broadband (mixed lighting) and IR only values from
the TSL2561, adjusting gain if auto-gain is enabled
+ @param broadband Pointer to a uint16_t we will fill with a sensor
+ reading from the IR+visible light diode.
+ @param ir Pointer to a uint16_t we will fill with a sensor the
+ IR-only light diode.
*/
/**************************************************************************/
void Adafruit_TSL2561_Unified::getLuminosity (uint16_t *broadband, uint16_t *ir)
@@ -370,10 +276,79 @@ void Adafruit_TSL2561_Unified::getLuminosity (uint16_t *broadband, uint16_t *ir)
} while (!valid);
}
+
+
/**************************************************************************/
/*!
- Converts the raw sensor values to the standard SI lux equivalent.
- Returns 0 if the sensor is saturated and the values are unreliable.
+ Enables the device
+*/
+/**************************************************************************/
+void Adafruit_TSL2561_Unified::enable(void)
+{
+ /* Enable the device by setting the control bit to 0x03 */
+ write8(TSL2561_COMMAND_BIT | TSL2561_REGISTER_CONTROL, TSL2561_CONTROL_POWERON);
+}
+
+/**************************************************************************/
+/*!
+ Disables the device (putting it in lower power sleep mode)
+*/
+/**************************************************************************/
+void Adafruit_TSL2561_Unified::disable(void)
+{
+ /* Turn the device off to save power */
+ write8(TSL2561_COMMAND_BIT | TSL2561_REGISTER_CONTROL, TSL2561_CONTROL_POWEROFF);
+}
+
+/**************************************************************************/
+/*!
+ Private function to read luminosity on both channels
+*/
+/**************************************************************************/
+void Adafruit_TSL2561_Unified::getData (uint16_t *broadband, uint16_t *ir)
+{
+ /* Enable the device by setting the control bit to 0x03 */
+ enable();
+
+ /* Wait x ms for ADC to complete */
+ switch (_tsl2561IntegrationTime)
+ {
+ case TSL2561_INTEGRATIONTIME_13MS:
+ delay(TSL2561_DELAY_INTTIME_13MS); // KTOWN: Was 14ms
+ break;
+ case TSL2561_INTEGRATIONTIME_101MS:
+ delay(TSL2561_DELAY_INTTIME_101MS); // KTOWN: Was 102ms
+ break;
+ default:
+ delay(TSL2561_DELAY_INTTIME_402MS); // KTOWN: Was 403ms
+ break;
+ }
+
+ /* Reads a two byte value from channel 0 (visible + infrared) */
+ *broadband = read16(TSL2561_COMMAND_BIT | TSL2561_WORD_BIT | TSL2561_REGISTER_CHAN0_LOW);
+
+ /* Reads a two byte value from channel 1 (infrared) */
+ *ir = read16(TSL2561_COMMAND_BIT | TSL2561_WORD_BIT | TSL2561_REGISTER_CHAN1_LOW);
+
+ /* Turn the device off to save power */
+ disable();
+}
+
+
+/**************************************************************************/
+/*!
+ @brief Converts the raw sensor values to the standard SI lux equivalent.
+ @param broadband The 16-bit sensor reading from the IR+visible light diode.
+ @param ir The 16-bit sensor reading from the IR-only light diode.
+ @returns The integer Lux value we calcuated.
+ Returns 0 if the sensor is saturated and the values are
+ unreliable, or 65536 if the sensor is saturated.
+*/
+/**************************************************************************/
+/**************************************************************************/
+/*!
+
+ Returns
*/
/**************************************************************************/
uint32_t Adafruit_TSL2561_Unified::calculateLux(uint16_t broadband, uint16_t ir)
@@ -488,8 +463,10 @@ uint32_t Adafruit_TSL2561_Unified::calculateLux(uint16_t broadband, uint16_t ir)
/**************************************************************************/
/*!
@brief Gets the most recent sensor event
- returns true if sensor reading is between 0 and 65535 lux
- returns false if sensor is saturated
+ @param event Pointer to a sensor_event_t type that will be filled
+ with the lux value, timestamp, data type and sensor ID.
+ @returns True if sensor reading is between 0 and 65535 lux,
+ false if sensor is saturated
*/
/**************************************************************************/
bool Adafruit_TSL2561_Unified::getEvent(sensors_event_t *event)
@@ -517,6 +494,8 @@ bool Adafruit_TSL2561_Unified::getEvent(sensors_event_t *event)
/**************************************************************************/
/*!
@brief Gets the sensor_t data
+ @param sensor A pointer to a sensor_t structure that we will fill with
+ details about the TSL2561 and its capabilities
*/
/**************************************************************************/
void Adafruit_TSL2561_Unified::getSensor(sensor_t *sensor)
@@ -535,3 +514,64 @@ void Adafruit_TSL2561_Unified::getSensor(sensor_t *sensor)
sensor->min_value = 1.0;
sensor->resolution = 1.0;
}
+
+
+
+/*========================================================================*/
+/* PRIVATE FUNCTIONS */
+/*========================================================================*/
+
+/**************************************************************************/
+/*!
+ @brief Writes a register and an 8 bit value over I2C
+ @param reg I2C register to write the value to
+ @param value The 8-bit value we're writing to the register
+*/
+/**************************************************************************/
+void Adafruit_TSL2561_Unified::write8 (uint8_t reg, uint8_t value)
+{
+ _i2c->beginTransmission(_addr);
+ _i2c->write(reg);
+ _i2c->write(value);
+ _i2c->endTransmission();
+}
+
+/**************************************************************************/
+/*!
+ @brief Reads an 8 bit value over I2C
+ @param reg I2C register to read from
+ @returns 8-bit value containing single byte data read
+*/
+/**************************************************************************/
+uint8_t Adafruit_TSL2561_Unified::read8(uint8_t reg)
+{
+ _i2c->beginTransmission(_addr);
+ _i2c->write(reg);
+ _i2c->endTransmission();
+
+ _i2c->requestFrom(_addr, 1);
+ return _i2c-> read();
+}
+
+/**************************************************************************/
+/*!
+ @brief Reads a 16 bit values over I2C
+ @param reg I2C register to read from
+ @returns 16-bit value containing 2-byte data read
+*/
+/**************************************************************************/
+uint16_t Adafruit_TSL2561_Unified::read16(uint8_t reg)
+{
+ uint16_t x, t;
+
+ _i2c->beginTransmission(_addr);
+ _i2c->write(reg);
+ _i2c->endTransmission();
+
+ _i2c->requestFrom(_addr, 2);
+ t = _i2c->read();
+ x = _i2c->read();
+ x <<= 8;
+ x |= t;
+ return x;
+}
diff --git a/Adafruit_TSL2561_U.h b/Adafruit_TSL2561_U.h
index b9a416f..1f93d15 100644
--- a/Adafruit_TSL2561_U.h
+++ b/Adafruit_TSL2561_U.h
@@ -1,166 +1,146 @@
-/**************************************************************************/
-/*!
- @file Adafruit_TSL2561.h
- @author K. Townsend (Adafruit Industries)
+/*!
+ * @file Adafruit_TSL2561_U.h
+ *
+ * This is part of Adafruit's FXOS8700 driver for the Arduino platform. It is
+ * designed specifically to work with the Adafruit FXOS8700 breakout:
+ * https://www.adafruit.com/products/3463
+ *
+ * These sensors use I2C to communicate, 2 pins (SCL+SDA) are required
+ * to interface with the breakout.
+ *
+ * Adafruit invests time and resources providing this open source code,
+ * please support Adafruit and open-source hardware by purchasing
+ * products from Adafruit!
+ *
+ * Written by Kevin "KTOWN" Townsend for Adafruit Industries.
+ *
+ * BSD license, all text here must be included in any redistribution.
+ *
+ */
- @section LICENSE
+#ifndef ADAFRUIT_TSL2561_H_
+#define ADAFRUIT_TSL2561_H_
- Software License Agreement (BSD License)
-
- Copyright (c) 2013, Adafruit Industries
- All rights reserved.
-
- Redistribution and use in source and binary forms, with or without
- modification, are permitted provided that the following conditions are met:
- 1. Redistributions of source code must retain the above copyright
- notice, this list of conditions and the following disclaimer.
- 2. Redistributions in binary form must reproduce the above copyright
- notice, this list of conditions and the following disclaimer in the
- documentation and/or other materials provided with the distribution.
- 3. Neither the name of the copyright holders nor the
- names of its contributors may be used to endorse or promote products
- derived from this software without specific prior written permission.
-
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
- EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
- WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
- DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
- (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-*/
-/**************************************************************************/
-#ifndef _TSL2561_H_
-#define _TSL2561_H_
-
-#if ARDUINO >= 100
- #include
-#else
- #include
-#endif
+#include
#include
-#include "HardwareSerial.h"
+#include
-#ifdef __AVR_ATtiny85__
- #include "TinyWireM.h"
- #define Wire TinyWireM
-#else
- #include
-#endif
-
-
-#define TSL2561_VISIBLE 2 // channel 0 - channel 1
-#define TSL2561_INFRARED 1 // channel 1
-#define TSL2561_FULLSPECTRUM 0 // channel 0
+#define TSL2561_VISIBLE 2 ///< channel 0 - channel 1
+#define TSL2561_INFRARED 1 ///< channel 1
+#define TSL2561_FULLSPECTRUM 0 ///< channel 0
// I2C address options
-#define TSL2561_ADDR_LOW (0x29)
-#define TSL2561_ADDR_FLOAT (0x39) // Default address (pin left floating)
-#define TSL2561_ADDR_HIGH (0x49)
+#define TSL2561_ADDR_LOW (0x29) ///< Default address (pin pulled low)
+#define TSL2561_ADDR_FLOAT (0x39) ///< Default address (pin left floating)
+#define TSL2561_ADDR_HIGH (0x49) ///< Default address (pin pulled high)
// Lux calculations differ slightly for CS package
-//#define TSL2561_PACKAGE_CS
-#define TSL2561_PACKAGE_T_FN_CL
+//#define TSL2561_PACKAGE_CS ///< Chip scale package
+#define TSL2561_PACKAGE_T_FN_CL ///< Dual Flat No-Lead package
-#define TSL2561_COMMAND_BIT (0x80) // Must be 1
-#define TSL2561_CLEAR_BIT (0x40) // Clears any pending interrupt (write 1 to clear)
-#define TSL2561_WORD_BIT (0x20) // 1 = read/write word (rather than byte)
-#define TSL2561_BLOCK_BIT (0x10) // 1 = using block read/write
+#define TSL2561_COMMAND_BIT (0x80) ///< Must be 1
+#define TSL2561_CLEAR_BIT (0x40) ///< Clears any pending interrupt (write 1 to clear)
+#define TSL2561_WORD_BIT (0x20) ///< 1 = read/write word (rather than byte)
+#define TSL2561_BLOCK_BIT (0x10) ///< 1 = using block read/write
-#define TSL2561_CONTROL_POWERON (0x03)
-#define TSL2561_CONTROL_POWEROFF (0x00)
+#define TSL2561_CONTROL_POWERON (0x03) ///< Control register setting to turn on
+#define TSL2561_CONTROL_POWEROFF (0x00)) ///< Control register setting to turn off
-#define TSL2561_LUX_LUXSCALE (14) // Scale by 2^14
-#define TSL2561_LUX_RATIOSCALE (9) // Scale ratio by 2^9
-#define TSL2561_LUX_CHSCALE (10) // Scale channel values by 2^10
-#define TSL2561_LUX_CHSCALE_TINT0 (0x7517) // 322/11 * 2^TSL2561_LUX_CHSCALE
-#define TSL2561_LUX_CHSCALE_TINT1 (0x0FE7) // 322/81 * 2^TSL2561_LUX_CHSCALE
+#define TSL2561_LUX_LUXSCALE (14) ///< Scale by 2^14
+#define TSL2561_LUX_RATIOSCALE (9) ///< Scale ratio by 2^9
+#define TSL2561_LUX_CHSCALE (10) ///< Scale channel values by 2^10
+#define TSL2561_LUX_CHSCALE_TINT0 (0x7517) ///< 322/11 * 2^TSL2561_LUX_CHSCALE
+#define TSL2561_LUX_CHSCALE_TINT1 (0x0FE7) ///< 322/81 * 2^TSL2561_LUX_CHSCALE
// T, FN and CL package values
-#define TSL2561_LUX_K1T (0x0040) // 0.125 * 2^RATIO_SCALE
-#define TSL2561_LUX_B1T (0x01f2) // 0.0304 * 2^LUX_SCALE
-#define TSL2561_LUX_M1T (0x01be) // 0.0272 * 2^LUX_SCALE
-#define TSL2561_LUX_K2T (0x0080) // 0.250 * 2^RATIO_SCALE
-#define TSL2561_LUX_B2T (0x0214) // 0.0325 * 2^LUX_SCALE
-#define TSL2561_LUX_M2T (0x02d1) // 0.0440 * 2^LUX_SCALE
-#define TSL2561_LUX_K3T (0x00c0) // 0.375 * 2^RATIO_SCALE
-#define TSL2561_LUX_B3T (0x023f) // 0.0351 * 2^LUX_SCALE
-#define TSL2561_LUX_M3T (0x037b) // 0.0544 * 2^LUX_SCALE
-#define TSL2561_LUX_K4T (0x0100) // 0.50 * 2^RATIO_SCALE
-#define TSL2561_LUX_B4T (0x0270) // 0.0381 * 2^LUX_SCALE
-#define TSL2561_LUX_M4T (0x03fe) // 0.0624 * 2^LUX_SCALE
-#define TSL2561_LUX_K5T (0x0138) // 0.61 * 2^RATIO_SCALE
-#define TSL2561_LUX_B5T (0x016f) // 0.0224 * 2^LUX_SCALE
-#define TSL2561_LUX_M5T (0x01fc) // 0.0310 * 2^LUX_SCALE
-#define TSL2561_LUX_K6T (0x019a) // 0.80 * 2^RATIO_SCALE
-#define TSL2561_LUX_B6T (0x00d2) // 0.0128 * 2^LUX_SCALE
-#define TSL2561_LUX_M6T (0x00fb) // 0.0153 * 2^LUX_SCALE
-#define TSL2561_LUX_K7T (0x029a) // 1.3 * 2^RATIO_SCALE
-#define TSL2561_LUX_B7T (0x0018) // 0.00146 * 2^LUX_SCALE
-#define TSL2561_LUX_M7T (0x0012) // 0.00112 * 2^LUX_SCALE
-#define TSL2561_LUX_K8T (0x029a) // 1.3 * 2^RATIO_SCALE
-#define TSL2561_LUX_B8T (0x0000) // 0.000 * 2^LUX_SCALE
-#define TSL2561_LUX_M8T (0x0000) // 0.000 * 2^LUX_SCALE
+#define TSL2561_LUX_K1T (0x0040) ///< 0.125 * 2^RATIO_SCALE
+#define TSL2561_LUX_B1T (0x01f2) ///< 0.0304 * 2^LUX_SCALE
+#define TSL2561_LUX_M1T (0x01be) ///< 0.0272 * 2^LUX_SCALE
+#define TSL2561_LUX_K2T (0x0080) ///< 0.250 * 2^RATIO_SCALE
+#define TSL2561_LUX_B2T (0x0214) ///< 0.0325 * 2^LUX_SCALE
+#define TSL2561_LUX_M2T (0x02d1) ///< 0.0440 * 2^LUX_SCALE
+#define TSL2561_LUX_K3T (0x00c0) ///< 0.375 * 2^RATIO_SCALE
+#define TSL2561_LUX_B3T (0x023f) ///< 0.0351 * 2^LUX_SCALE
+#define TSL2561_LUX_M3T (0x037b) ///< 0.0544 * 2^LUX_SCALE
+#define TSL2561_LUX_K4T (0x0100) ///< 0.50 * 2^RATIO_SCALE
+#define TSL2561_LUX_B4T (0x0270) ///< 0.0381 * 2^LUX_SCALE
+#define TSL2561_LUX_M4T (0x03fe) ///< 0.0624 * 2^LUX_SCALE
+#define TSL2561_LUX_K5T (0x0138) ///< 0.61 * 2^RATIO_SCALE
+#define TSL2561_LUX_B5T (0x016f) ///< 0.0224 * 2^LUX_SCALE
+#define TSL2561_LUX_M5T (0x01fc) ///< 0.0310 * 2^LUX_SCALE
+#define TSL2561_LUX_K6T (0x019a) ///< 0.80 * 2^RATIO_SCALE
+#define TSL2561_LUX_B6T (0x00d2) ///< 0.0128 * 2^LUX_SCALE
+#define TSL2561_LUX_M6T (0x00fb) ///< 0.0153 * 2^LUX_SCALE
+#define TSL2561_LUX_K7T (0x029a) ///< 1.3 * 2^RATIO_SCALE
+#define TSL2561_LUX_B7T (0x0018) ///< 0.00146 * 2^LUX_SCALE
+#define TSL2561_LUX_M7T (0x0012) ///< 0.00112 * 2^LUX_SCALE
+#define TSL2561_LUX_K8T (0x029a) ///< 1.3 * 2^RATIO_SCALE
+#define TSL2561_LUX_B8T (0x0000) ///< 0.000 * 2^LUX_SCALE
+#define TSL2561_LUX_M8T (0x0000) ///< 0.000 * 2^LUX_SCALE
// CS package values
-#define TSL2561_LUX_K1C (0x0043) // 0.130 * 2^RATIO_SCALE
-#define TSL2561_LUX_B1C (0x0204) // 0.0315 * 2^LUX_SCALE
-#define TSL2561_LUX_M1C (0x01ad) // 0.0262 * 2^LUX_SCALE
-#define TSL2561_LUX_K2C (0x0085) // 0.260 * 2^RATIO_SCALE
-#define TSL2561_LUX_B2C (0x0228) // 0.0337 * 2^LUX_SCALE
-#define TSL2561_LUX_M2C (0x02c1) // 0.0430 * 2^LUX_SCALE
-#define TSL2561_LUX_K3C (0x00c8) // 0.390 * 2^RATIO_SCALE
-#define TSL2561_LUX_B3C (0x0253) // 0.0363 * 2^LUX_SCALE
-#define TSL2561_LUX_M3C (0x0363) // 0.0529 * 2^LUX_SCALE
-#define TSL2561_LUX_K4C (0x010a) // 0.520 * 2^RATIO_SCALE
-#define TSL2561_LUX_B4C (0x0282) // 0.0392 * 2^LUX_SCALE
-#define TSL2561_LUX_M4C (0x03df) // 0.0605 * 2^LUX_SCALE
-#define TSL2561_LUX_K5C (0x014d) // 0.65 * 2^RATIO_SCALE
-#define TSL2561_LUX_B5C (0x0177) // 0.0229 * 2^LUX_SCALE
-#define TSL2561_LUX_M5C (0x01dd) // 0.0291 * 2^LUX_SCALE
-#define TSL2561_LUX_K6C (0x019a) // 0.80 * 2^RATIO_SCALE
-#define TSL2561_LUX_B6C (0x0101) // 0.0157 * 2^LUX_SCALE
-#define TSL2561_LUX_M6C (0x0127) // 0.0180 * 2^LUX_SCALE
-#define TSL2561_LUX_K7C (0x029a) // 1.3 * 2^RATIO_SCALE
-#define TSL2561_LUX_B7C (0x0037) // 0.00338 * 2^LUX_SCALE
-#define TSL2561_LUX_M7C (0x002b) // 0.00260 * 2^LUX_SCALE
-#define TSL2561_LUX_K8C (0x029a) // 1.3 * 2^RATIO_SCALE
-#define TSL2561_LUX_B8C (0x0000) // 0.000 * 2^LUX_SCALE
-#define TSL2561_LUX_M8C (0x0000) // 0.000 * 2^LUX_SCALE
+#define TSL2561_LUX_K1C (0x0043) ///< 0.130 * 2^RATIO_SCALE
+#define TSL2561_LUX_B1C (0x0204) ///< 0.0315 * 2^LUX_SCALE
+#define TSL2561_LUX_M1C (0x01ad) ///< 0.0262 * 2^LUX_SCALE
+#define TSL2561_LUX_K2C (0x0085) ///< 0.260 * 2^RATIO_SCALE
+#define TSL2561_LUX_B2C (0x0228) ///< 0.0337 * 2^LUX_SCALE
+#define TSL2561_LUX_M2C (0x02c1) ///< 0.0430 * 2^LUX_SCALE
+#define TSL2561_LUX_K3C (0x00c8) ///< 0.390 * 2^RATIO_SCALE
+#define TSL2561_LUX_B3C (0x0253) ///< 0.0363 * 2^LUX_SCALE
+#define TSL2561_LUX_M3C (0x0363) ///< 0.0529 * 2^LUX_SCALE
+#define TSL2561_LUX_K4C (0x010a) ///< 0.520 * 2^RATIO_SCALE
+#define TSL2561_LUX_B4C (0x0282) ///< 0.0392 * 2^LUX_SCALE
+#define TSL2561_LUX_M4C (0x03df) ///< 0.0605 * 2^LUX_SCALE
+#define TSL2561_LUX_K5C (0x014d) ///< 0.65 * 2^RATIO_SCALE
+#define TSL2561_LUX_B5C (0x0177) ///< 0.0229 * 2^LUX_SCALE
+#define TSL2561_LUX_M5C (0x01dd) ///< 0.0291 * 2^LUX_SCALE
+#define TSL2561_LUX_K6C (0x019a) ///< 0.80 * 2^RATIO_SCALE
+#define TSL2561_LUX_B6C (0x0101) ///< 0.0157 * 2^LUX_SCALE
+#define TSL2561_LUX_M6C (0x0127) ///< 0.0180 * 2^LUX_SCALE
+#define TSL2561_LUX_K7C (0x029a) ///< 1.3 * 2^RATIO_SCALE
+#define TSL2561_LUX_B7C (0x0037) ///< 0.00338 * 2^LUX_SCALE
+#define TSL2561_LUX_M7C (0x002b) ///< 0.00260 * 2^LUX_SCALE
+#define TSL2561_LUX_K8C (0x029a) ///< 1.3 * 2^RATIO_SCALE
+#define TSL2561_LUX_B8C (0x0000) ///< 0.000 * 2^LUX_SCALE
+#define TSL2561_LUX_M8C (0x0000) ///< 0.000 * 2^LUX_SCALE
// Auto-gain thresholds
-#define TSL2561_AGC_THI_13MS (4850) // Max value at Ti 13ms = 5047
-#define TSL2561_AGC_TLO_13MS (100)
-#define TSL2561_AGC_THI_101MS (36000) // Max value at Ti 101ms = 37177
-#define TSL2561_AGC_TLO_101MS (200)
-#define TSL2561_AGC_THI_402MS (63000) // Max value at Ti 402ms = 65535
-#define TSL2561_AGC_TLO_402MS (500)
+#define TSL2561_AGC_THI_13MS (4850) ///< Max value at Ti 13ms = 5047
+#define TSL2561_AGC_TLO_13MS (100) ///< Min value at Ti 13ms = 100
+#define TSL2561_AGC_THI_101MS (36000) ///< Max value at Ti 101ms = 37177
+#define TSL2561_AGC_TLO_101MS (200) ///< Min value at Ti 101ms = 200
+#define TSL2561_AGC_THI_402MS (63000) ///< Max value at Ti 402ms = 65535
+#define TSL2561_AGC_TLO_402MS (500) ///< Min value at Ti 402ms = 500
// Clipping thresholds
-#define TSL2561_CLIPPING_13MS (4900)
-#define TSL2561_CLIPPING_101MS (37000)
-#define TSL2561_CLIPPING_402MS (65000)
+#define TSL2561_CLIPPING_13MS (4900) ///< # Counts that trigger a change in gain/integration
+#define TSL2561_CLIPPING_101MS (37000) ///< # Counts that trigger a change in gain/integration
+#define TSL2561_CLIPPING_402MS (65000) ///< # Counts that trigger a change in gain/integration
+// Delay for integration times
+#define TSL2561_DELAY_INTTIME_13MS (15) ///< Wait 15ms for 13ms integration
+#define TSL2561_DELAY_INTTIME_101MS (120) ///< Wait 120ms for 101ms integration
+#define TSL2561_DELAY_INTTIME_402MS (450) ///< Wait 450ms for 402ms integration
+
+/** TSL2561 I2C Registers */
enum
{
- TSL2561_REGISTER_CONTROL = 0x00,
- TSL2561_REGISTER_TIMING = 0x01,
- TSL2561_REGISTER_THRESHHOLDL_LOW = 0x02,
- TSL2561_REGISTER_THRESHHOLDL_HIGH = 0x03,
- TSL2561_REGISTER_THRESHHOLDH_LOW = 0x04,
- TSL2561_REGISTER_THRESHHOLDH_HIGH = 0x05,
- TSL2561_REGISTER_INTERRUPT = 0x06,
- TSL2561_REGISTER_CRC = 0x08,
- TSL2561_REGISTER_ID = 0x0A,
- TSL2561_REGISTER_CHAN0_LOW = 0x0C,
- TSL2561_REGISTER_CHAN0_HIGH = 0x0D,
- TSL2561_REGISTER_CHAN1_LOW = 0x0E,
- TSL2561_REGISTER_CHAN1_HIGH = 0x0F
+ 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
};
+/** Three options for how long to integrate readings for */
typedef enum
{
TSL2561_INTEGRATIONTIME_13MS = 0x00, // 13.7ms
@@ -169,6 +149,7 @@ typedef enum
}
tsl2561IntegrationTime_t;
+/** TSL2561 offers 2 gain settings */
typedef enum
{
TSL2561_GAIN_1X = 0x00, // No gain
@@ -176,6 +157,13 @@ typedef enum
}
tsl2561Gain_t;
+
+
+/**************************************************************************/
+/*!
+ @brief Class that stores state and functions for interacting with TSL2561 Light Sensor
+*/
+/**************************************************************************/
class Adafruit_TSL2561_Unified : public Adafruit_Sensor {
public:
Adafruit_TSL2561_Unified(uint8_t addr, int32_t sensorID = -1);
@@ -195,7 +183,7 @@ class Adafruit_TSL2561_Unified : public Adafruit_Sensor {
void getSensor(sensor_t*);
private:
- TwoWire *wire;
+ TwoWire *_i2c;
int8_t _addr;
boolean _tsl2561Initialised;
@@ -211,4 +199,5 @@ class Adafruit_TSL2561_Unified : public Adafruit_Sensor {
uint16_t read16 (uint8_t reg);
void getData (uint16_t *broadband, uint16_t *ir);
};
-#endif
+
+#endif // ADAFRUIT_TSL2561_H
diff --git a/README.md b/README.md
index ab700cb..84412bc 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-#Adafruit TSL2561 Light Sensor Driver #
+# Adafruit TSL2561 Light Sensor Driver #
This driver is for the Adafruit TSL2561 Breakout, and is based on Adafruit's Unified Sensor Library (Adafruit_Sensor).