alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-03-15 04:57:30 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

tsl2561.h: adding doxygen tags

Browse Source 
Signed-off-by: John Van Drasek <john.r.van.drasek@intel.com>
This commit is contained in:
John Van Drasek 2015-03-20 16:37:38 -07:00
parent 7bb661d31b
commit 55c8ec0395
1 changed files with 22 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
src/tsl2561/tsl2561.h
View File

@ -91,22 +91,35 @@ namespace upm {
#define LUX_B8C (0x0000) // 0.000 * 2^LUX_SCALE
#define LUX_M8C (0x0000) // 0.000 * 2^LUX_SCALE
/**
/**
* @brief TSL2561 Digital Light Sensor library
*
* The LIGHT-TO-DIGITAL CONVERTER [TAOS-TSL2561]
* (http://www.adafruit.com/datasheets/TSL2561.pdf)
* The TSL2560 and TSL2561 are light-to-digital converters that transform
* light intensity to a digital signal output capable of direct I2C (TSL2561)
*
* @defgroup tsl2561 libupm-tsl2561
* @ingroup seeed i2c light
*/
/**
* @brief C++ API for TSL2561 chip (Digital Light Sensor library)
* @library tsl2561
* @sensor tsl2561
* @comname Light sensor
* @type light
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_Digital_Light_Sensor
* @con i2c
*
* The LIGHT-TO-DIGITAL CONVERTER [TAOS-TSL2561]
* (http://www.adafruit.com/datasheets/TSL2561.pdf)
* The TSL2560 and TSL2561 are light-to-digital converters that transform light
* intensity to a digital signal output capable of direct I2C (TSL2561).
* @brief TSL2561 Digital Light Sensor library
*
* The LIGHT-TO-DIGITAL CONVERTER [TAOS-TSL2561]
* (http://www.adafruit.com/datasheets/TSL2561.pdf)
* The TSL2560 and TSL2561 are light-to-digital converters that transform
* light intensity to a digital signal output capable of direct I2C (TSL2561)
*
* @ingroup tsl2561
* @snippet tsl2561.cxx Interesting
* @image html grovetsl2561.jpeg
* @snippet tsl2561.cxx Interesting
*/
class TSL2561{
public: