Luminosity sensor by Texas Advanced Optoelectronic Solutions Inc.. Device combines one broadband photodiode (visible plus infrared) and one infrared-responding photodiode. Sets Gain x1 and 402mS as default.
Dependents: MusicBoxForFathersDay FTHR_SensorHub Affich_Lum_Moist Projetv0 ... more
TSL2561.h@3:d60d8198d76d, 2018-02-20 (annotated)
- Committer:
- kenjiArai
- Date:
- Tue Feb 20 10:49:43 2018 +0000
- Revision:
- 3:d60d8198d76d
- Parent:
- 2:17591031447b
- Child:
- 5:5b1b625fda6f
bug fix -> read_ID() & who_am_i() function
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
kenjiArai | 0:eec7bcd27c52 | 1 | /* |
kenjiArai | 0:eec7bcd27c52 | 2 | * mbed library program |
kenjiArai | 0:eec7bcd27c52 | 3 | * Luminosity sensor -- LIGHT-TO-DIGITAL CONVERTER (light intensity to a digital signal output) |
kenjiArai | 0:eec7bcd27c52 | 4 | * TSL2561 by Texas Advanced Optoelectronic Solutions Inc. |
kenjiArai | 0:eec7bcd27c52 | 5 | * |
kenjiArai | 3:d60d8198d76d | 6 | * Copyright (c) 2015,'17,'18 Kenji Arai / JH1PJL |
kenjiArai | 0:eec7bcd27c52 | 7 | * http://www.page.sannet.ne.jp/kenjia/index.html |
kenjiArai | 0:eec7bcd27c52 | 8 | * http://mbed.org/users/kenjiArai/ |
kenjiArai | 2:17591031447b | 9 | * Created: Feburary 21st, 2015 |
kenjiArai | 2:17591031447b | 10 | * Revised: August 23rd, 2017 |
kenjiArai | 3:d60d8198d76d | 11 | * Revised: Feburary 20th, 2018 bug fix -> read_ID() & who_am_i() |
kenjiArai | 3:d60d8198d76d | 12 | * Thanks PARK JAICHANG |
kenjiArai | 0:eec7bcd27c52 | 13 | */ |
kenjiArai | 0:eec7bcd27c52 | 14 | /* |
kenjiArai | 0:eec7bcd27c52 | 15 | *---------------- REFERENCE ---------------------------------------------------------------------- |
kenjiArai | 0:eec7bcd27c52 | 16 | * https://docs.google.com/viewer?url=http%3A%2F%2Fwww.adafruit.com%2Fdatasheets%2FTSL256x.pdf |
kenjiArai | 0:eec7bcd27c52 | 17 | * https://learn.adafruit.com/tsl2561?view=all |
kenjiArai | 0:eec7bcd27c52 | 18 | * http://www.adafruit.com/products/439 |
kenjiArai | 0:eec7bcd27c52 | 19 | * http://akizukidenshi.com/catalog/g/gM-08219/ |
kenjiArai | 0:eec7bcd27c52 | 20 | */ |
kenjiArai | 0:eec7bcd27c52 | 21 | |
kenjiArai | 0:eec7bcd27c52 | 22 | #ifndef TSL2561_H |
kenjiArai | 0:eec7bcd27c52 | 23 | #define TSL2561_H |
kenjiArai | 0:eec7bcd27c52 | 24 | |
kenjiArai | 0:eec7bcd27c52 | 25 | #include "mbed.h" |
kenjiArai | 0:eec7bcd27c52 | 26 | |
kenjiArai | 0:eec7bcd27c52 | 27 | // Luminosity sensor, TSL2561 |
kenjiArai | 0:eec7bcd27c52 | 28 | // Address b7=0,b6=1,b5=1,b4=1,b3=0,b2=0,b1=1, b0=R/W |
kenjiArai | 0:eec7bcd27c52 | 29 | #define TSL2561_ADDRESS_GND (0x29 << 1) |
kenjiArai | 0:eec7bcd27c52 | 30 | #define TSL2561_ADDRESS_FLOAT (0x39 << 1) |
kenjiArai | 0:eec7bcd27c52 | 31 | #define TSL2561_ADDRESS_VDD (0x49 << 1) |
kenjiArai | 0:eec7bcd27c52 | 32 | |
kenjiArai | 0:eec7bcd27c52 | 33 | ////////////// Registers ////////////////////////////////// |
kenjiArai | 0:eec7bcd27c52 | 34 | // Register definition |
kenjiArai | 0:eec7bcd27c52 | 35 | #define TSL2561_CONTROL 0x00 |
kenjiArai | 0:eec7bcd27c52 | 36 | #define TSL2561_TIMING 0x01 |
kenjiArai | 0:eec7bcd27c52 | 37 | #define TSL2561_THRESHLOWLOW 0x02 |
kenjiArai | 0:eec7bcd27c52 | 38 | #define TSL2561_THRESHHIGHLOW 0x04 |
kenjiArai | 0:eec7bcd27c52 | 39 | #define TSL2561_INTERRUPT 0x06 |
kenjiArai | 0:eec7bcd27c52 | 40 | #define TSL2561_CRC 0x08 |
kenjiArai | 0:eec7bcd27c52 | 41 | #define TSL2561_ID 0x0A |
kenjiArai | 0:eec7bcd27c52 | 42 | #define TSL2561_DATA0LOW 0x0C |
kenjiArai | 0:eec7bcd27c52 | 43 | #define TSL2561_DATA0HIGH 0x0D |
kenjiArai | 0:eec7bcd27c52 | 44 | #define TSL2561_DATA1LOW 0x0E |
kenjiArai | 0:eec7bcd27c52 | 45 | #define TSL2561_DATA1HIGH 0x0F |
kenjiArai | 0:eec7bcd27c52 | 46 | |
kenjiArai | 1:25a700e9b8ec | 47 | ////////////// TIMING PARAMETER /////////////////////////// |
kenjiArai | 1:25a700e9b8ec | 48 | #define TIMING_GAIN_1 (0UL << 4) |
kenjiArai | 1:25a700e9b8ec | 49 | #define TIMING_GAIN_16 (1UL << 4) |
kenjiArai | 1:25a700e9b8ec | 50 | #define TIMING_TIME_13R7 (0x0) |
kenjiArai | 1:25a700e9b8ec | 51 | #define TIMING_TIME_101 (0x1) |
kenjiArai | 1:25a700e9b8ec | 52 | #define TIMING_TIME_402 (0x2) |
kenjiArai | 1:25a700e9b8ec | 53 | #define TIMING_TIME_MANU (0x3) |
kenjiArai | 1:25a700e9b8ec | 54 | #define TIMING_DEFAULT (TIMING_GAIN_1 + TIMING_TIME_402) |
kenjiArai | 1:25a700e9b8ec | 55 | |
kenjiArai | 0:eec7bcd27c52 | 56 | ////////////// ID ///////////////////////////////////////// |
kenjiArai | 3:d60d8198d76d | 57 | #define I_AM_TSL2561CS 0x01 |
kenjiArai | 3:d60d8198d76d | 58 | #define I_AM_TSL2561T_FN_CL 0x05 |
kenjiArai | 0:eec7bcd27c52 | 59 | |
kenjiArai | 0:eec7bcd27c52 | 60 | ////////////// COMMAND //////////////////////////////////// |
kenjiArai | 0:eec7bcd27c52 | 61 | #define CMD_CMDMODE (1UL << 7) |
kenjiArai | 0:eec7bcd27c52 | 62 | #define CMD_CLEAR (1UL << 6) |
kenjiArai | 0:eec7bcd27c52 | 63 | #define CMD_WORD (1UL << 5) |
kenjiArai | 0:eec7bcd27c52 | 64 | #define CMD_BLOCK (1UL << 4) |
kenjiArai | 0:eec7bcd27c52 | 65 | #define CMD_SINGLE (CMD_CMDMODE) |
kenjiArai | 0:eec7bcd27c52 | 66 | #define CMD_MULTI (CMD_CMDMODE + CMD_WORD) |
kenjiArai | 0:eec7bcd27c52 | 67 | |
kenjiArai | 0:eec7bcd27c52 | 68 | /** Interface for Luminosity sensor, TSL2561 |
kenjiArai | 0:eec7bcd27c52 | 69 | * @code |
kenjiArai | 0:eec7bcd27c52 | 70 | * #include "mbed.h" |
kenjiArai | 0:eec7bcd27c52 | 71 | * #include "TSL2561.h" |
kenjiArai | 0:eec7bcd27c52 | 72 | * |
kenjiArai | 0:eec7bcd27c52 | 73 | * // I2C Communication |
kenjiArai | 0:eec7bcd27c52 | 74 | * TSL2561 lum(dp5,dp27); // TSL2561 SDA, SCL |
kenjiArai | 0:eec7bcd27c52 | 75 | * // If you connected I2C line not only this device but also other devices, |
kenjiArai | 0:eec7bcd27c52 | 76 | * // you need to declare following method. |
kenjiArai | 1:25a700e9b8ec | 77 | * I2C i2c(dp5,dp27); // SDA, SCL |
kenjiArai | 0:eec7bcd27c52 | 78 | * TSL2561 lum(i2c); // TSL2561 SDA, SCL (Data available every 400mSec) |
kenjiArai | 0:eec7bcd27c52 | 79 | * |
kenjiArai | 0:eec7bcd27c52 | 80 | * int main() {; |
kenjiArai | 0:eec7bcd27c52 | 81 | * while(true){ |
kenjiArai | 0:eec7bcd27c52 | 82 | * printf("Illuminance: %+7.2f [Lux]\r\n", lum.lux()); |
kenjiArai | 0:eec7bcd27c52 | 83 | * wait(1.0); |
kenjiArai | 0:eec7bcd27c52 | 84 | * } |
kenjiArai | 0:eec7bcd27c52 | 85 | * } |
kenjiArai | 0:eec7bcd27c52 | 86 | * @endcode |
kenjiArai | 0:eec7bcd27c52 | 87 | */ |
kenjiArai | 0:eec7bcd27c52 | 88 | |
kenjiArai | 0:eec7bcd27c52 | 89 | class TSL2561 |
kenjiArai | 0:eec7bcd27c52 | 90 | { |
kenjiArai | 0:eec7bcd27c52 | 91 | public: |
kenjiArai | 0:eec7bcd27c52 | 92 | /** Configure data pin |
kenjiArai | 0:eec7bcd27c52 | 93 | * @param data SDA and SCL pins |
kenjiArai | 0:eec7bcd27c52 | 94 | */ |
kenjiArai | 0:eec7bcd27c52 | 95 | TSL2561(PinName p_sda, PinName p_scl); |
kenjiArai | 0:eec7bcd27c52 | 96 | TSL2561(PinName p_sda, PinName p_scl, uint8_t addr); |
kenjiArai | 0:eec7bcd27c52 | 97 | |
kenjiArai | 0:eec7bcd27c52 | 98 | /** Configure data pin (with other devices on I2C line) |
kenjiArai | 0:eec7bcd27c52 | 99 | * @param I2C previous definition |
kenjiArai | 0:eec7bcd27c52 | 100 | */ |
kenjiArai | 0:eec7bcd27c52 | 101 | TSL2561(I2C& p_i2c); |
kenjiArai | 0:eec7bcd27c52 | 102 | TSL2561(I2C& p_i2c, uint8_t addr); |
kenjiArai | 0:eec7bcd27c52 | 103 | |
kenjiArai | 0:eec7bcd27c52 | 104 | /** Get approximates the human eye response |
kenjiArai | 0:eec7bcd27c52 | 105 | * in the commonly used Illuminance unit of Lux |
kenjiArai | 0:eec7bcd27c52 | 106 | * @param none |
kenjiArai | 0:eec7bcd27c52 | 107 | * @return Lux |
kenjiArai | 0:eec7bcd27c52 | 108 | */ |
kenjiArai | 0:eec7bcd27c52 | 109 | float lux(void); |
kenjiArai | 0:eec7bcd27c52 | 110 | |
kenjiArai | 1:25a700e9b8ec | 111 | /** Set timing register |
kenjiArai | 1:25a700e9b8ec | 112 | * @param timing parameter |
kenjiArai | 1:25a700e9b8ec | 113 | * @return timing read data |
kenjiArai | 0:eec7bcd27c52 | 114 | */ |
kenjiArai | 1:25a700e9b8ec | 115 | uint8_t set_timing_reg(uint8_t parameter); |
kenjiArai | 1:25a700e9b8ec | 116 | |
kenjiArai | 1:25a700e9b8ec | 117 | /** Read timing register |
kenjiArai | 1:25a700e9b8ec | 118 | * @param timing parameter |
kenjiArai | 1:25a700e9b8ec | 119 | * @return timing read data |
kenjiArai | 1:25a700e9b8ec | 120 | */ |
kenjiArai | 1:25a700e9b8ec | 121 | uint8_t read_timing_reg(void); |
kenjiArai | 0:eec7bcd27c52 | 122 | |
kenjiArai | 0:eec7bcd27c52 | 123 | /** Set I2C clock frequency |
kenjiArai | 0:eec7bcd27c52 | 124 | * @param freq. |
kenjiArai | 0:eec7bcd27c52 | 125 | * @return none |
kenjiArai | 0:eec7bcd27c52 | 126 | */ |
kenjiArai | 0:eec7bcd27c52 | 127 | void frequency(int hz); |
kenjiArai | 0:eec7bcd27c52 | 128 | |
kenjiArai | 0:eec7bcd27c52 | 129 | /** check Device ID number |
kenjiArai | 0:eec7bcd27c52 | 130 | * @param none |
kenjiArai | 0:eec7bcd27c52 | 131 | * @return TSL2561 = 1, others 0 |
kenjiArai | 0:eec7bcd27c52 | 132 | */ |
kenjiArai | 0:eec7bcd27c52 | 133 | uint8_t who_am_i(void); |
kenjiArai | 0:eec7bcd27c52 | 134 | |
kenjiArai | 0:eec7bcd27c52 | 135 | /** Read ID and Revision Number |
kenjiArai | 0:eec7bcd27c52 | 136 | * @param none |
kenjiArai | 0:eec7bcd27c52 | 137 | * @return ID + REVNO |
kenjiArai | 0:eec7bcd27c52 | 138 | */ |
kenjiArai | 3:d60d8198d76d | 139 | uint8_t read_ID(void); |
kenjiArai | 0:eec7bcd27c52 | 140 | |
kenjiArai | 0:eec7bcd27c52 | 141 | /** Power Up/Down |
kenjiArai | 0:eec7bcd27c52 | 142 | * @param none |
kenjiArai | 0:eec7bcd27c52 | 143 | * @return none |
kenjiArai | 0:eec7bcd27c52 | 144 | */ |
kenjiArai | 0:eec7bcd27c52 | 145 | void power_up(void); |
kenjiArai | 0:eec7bcd27c52 | 146 | void power_down(void); |
kenjiArai | 0:eec7bcd27c52 | 147 | |
kenjiArai | 0:eec7bcd27c52 | 148 | protected: |
kenjiArai | 2:17591031447b | 149 | I2C *_i2c_p; |
kenjiArai | 2:17591031447b | 150 | I2C &_i2c; |
kenjiArai | 0:eec7bcd27c52 | 151 | |
kenjiArai | 0:eec7bcd27c52 | 152 | void init(void); |
kenjiArai | 0:eec7bcd27c52 | 153 | |
kenjiArai | 0:eec7bcd27c52 | 154 | private: |
kenjiArai | 0:eec7bcd27c52 | 155 | uint8_t TSL2561_addr; |
kenjiArai | 0:eec7bcd27c52 | 156 | uint8_t dt[4]; |
kenjiArai | 1:25a700e9b8ec | 157 | uint32_t ch0; |
kenjiArai | 1:25a700e9b8ec | 158 | uint32_t ch1; |
kenjiArai | 1:25a700e9b8ec | 159 | int8_t gain; |
kenjiArai | 1:25a700e9b8ec | 160 | uint8_t id_number; |
kenjiArai | 1:25a700e9b8ec | 161 | double integ_time; |
kenjiArai | 0:eec7bcd27c52 | 162 | }; |
kenjiArai | 0:eec7bcd27c52 | 163 | |
kenjiArai | 0:eec7bcd27c52 | 164 | #endif // TSL2561_H |