forked from adafruit/Adafruit_TSL2561
219 lines
9.3 KiB
C++
219 lines
9.3 KiB
C++
/*!
|
|
* @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.
|
|
*
|
|
*/
|
|
|
|
#ifndef ADAFRUIT_TSL2561_H_
|
|
#define ADAFRUIT_TSL2561_H_
|
|
|
|
#include <Adafruit_Sensor.h>
|
|
#include <Arduino.h>
|
|
#include <Wire.h>
|
|
#include <chrono>
|
|
|
|
using namespace std::chrono_literals;
|
|
|
|
#define TSL2561_VISIBLE 2 ///< channel 0 - channel 1
|
|
#define TSL2561_INFRARED 1 ///< channel 1
|
|
#define TSL2561_FULLSPECTRUM 0 ///< channel 0
|
|
|
|
// I2C address options
|
|
constexpr const uint8_t TSL2561_ADDR_LOW = 0x29; ///< Default address (pin pulled low)
|
|
constexpr const uint8_t TSL2561_ADDR_FLOAT = 0x39; ///< Default address (pin left floating)
|
|
constexpr const uint8_t TSL2561_ADDR_HIGH = 0x49; ///< Default address (pin pulled high)
|
|
|
|
// Lux calculations differ slightly for CS package
|
|
//#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_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
|
|
|
|
// 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
|
|
|
|
// 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
|
|
|
|
// Auto-gain thresholds
|
|
#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) ///< # 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
|
|
constexpr const auto TSL2561_DELAY_INTTIME_13MS = 15ms; ///< Wait 15ms for 13ms integration
|
|
constexpr const auto TSL2561_DELAY_INTTIME_101MS = 120ms; ///< Wait 120ms for 101ms integration
|
|
constexpr const auto TSL2561_DELAY_INTTIME_402MS = 450ms; ///< Wait 450ms for 402ms integration
|
|
|
|
/** TSL2561 I2C Registers */
|
|
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
|
|
};
|
|
|
|
/** Three options for how long to integrate readings for */
|
|
enum tsl2561IntegrationTime_t {
|
|
TSL2561_INTEGRATIONTIME_13MS = 0x00, // 13.7ms
|
|
TSL2561_INTEGRATIONTIME_101MS = 0x01, // 101ms
|
|
TSL2561_INTEGRATIONTIME_402MS = 0x02 // 402ms
|
|
};
|
|
|
|
/** TSL2561 offers 2 gain settings */
|
|
enum tsl2561Gain_t {
|
|
TSL2561_GAIN_1X = 0x00, // No gain
|
|
TSL2561_GAIN_16X = 0x10, // 16x gain
|
|
};
|
|
|
|
/**************************************************************************/
|
|
/*!
|
|
@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) :
|
|
_addr{addr},
|
|
_tsl2561SensorID{sensorID}
|
|
{}
|
|
|
|
bool begin(bool skipWireBegin = false);
|
|
bool begin(TwoWire *theWire, bool skipWireBegin = false);
|
|
bool init();
|
|
|
|
/* TSL2561 Functions */
|
|
void enableAutoRange(bool enable);
|
|
bool setIntegrationTime(tsl2561IntegrationTime_t time);
|
|
private:
|
|
bool setIntegrationTimePriv(tsl2561IntegrationTime_t time);
|
|
public:
|
|
bool setGain(tsl2561Gain_t gain);
|
|
private:
|
|
bool setGainPriv(tsl2561Gain_t gain);
|
|
public:
|
|
|
|
struct Luminosity { uint16_t broadband; uint16_t ir; };
|
|
std::optional<Luminosity> getLuminosity();
|
|
std::optional<uint32_t> calculateLux(Luminosity luminosity);
|
|
|
|
/* Unified Sensor API Functions */
|
|
std::optional<sensors_event_t> getEvent() override;
|
|
sensor_t getSensor() override;
|
|
|
|
private:
|
|
TwoWire *_i2c{};
|
|
|
|
uint8_t _addr;
|
|
bool _tsl2561Initialised{};
|
|
bool _tsl2561AutoGain{};
|
|
tsl2561IntegrationTime_t _tsl2561IntegrationTime{TSL2561_INTEGRATIONTIME_13MS};
|
|
tsl2561Gain_t _tsl2561Gain{TSL2561_GAIN_1X};
|
|
int32_t _tsl2561SensorID;
|
|
|
|
bool enable(void);
|
|
bool disable(void);
|
|
bool write8(uint8_t reg, uint8_t value);
|
|
std::optional<uint8_t> read8(uint8_t reg);
|
|
std::optional<uint16_t> read16(uint8_t reg);
|
|
std::optional<Luminosity> getData();
|
|
};
|
|
|
|
#endif // ADAFRUIT_TSL2561_H
|