adafruit/Adafruit_TSL2561
1
0
Fork 1
mirror of https://github.com/adafruit/Adafruit_TSL2561.git synced 2025-08-03 19:04:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

Deploy code docs to GitHub Pages Travis build: 21

Browse Source 
Commit: 4f670c0cff
This commit is contained in:
Travis CI
2019-02-15 22:20:49 +00:00
parent 927ea685f0
commit 7727db6bdb
5 changed files with 2 additions and 175 deletions
Download Patch File Download Diff File Expand all files Collapse all files

92
html/md__r_e_a_d_m_e.html
View File

@@ -1,92 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Adafruit TSL2561 Arduino Library: Adafruit TSL2561 Light Sensor Driver [![Build Status](https://travis-ci.org/adafruit/Adafruit_TSL2561.svg?branch=master)](https://travis-ci.org/adafruit/Adafruit_TSL2561)</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Adafruit TSL2561 Arduino Library
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Adafruit TSL2561 Light Sensor Driver [![Build Status](<a href="https://travis-ci.org/adafruit/Adafruit_TSL2561.svg?branch=master">https://travis-ci.org/adafruit/Adafruit_TSL2561.svg?branch=master</a>)](<a href="https://travis-ci.org/adafruit/Adafruit_TSL2561">https://travis-ci.org/adafruit/Adafruit_TSL2561</a>) </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>This driver is for the Adafruit TSL2561 Breakout, and is based on Adafruit's Unified Sensor Library (Adafruit_Sensor).</p>
<div class="image">
<img src="https://cdn-shop.adafruit.com/970x728/439-00.jpg" height="300"/>
</div>
<p>The driver supports manual or 'auto' gain. Adjusting the gain allows you to make the sensor more or less 'sensitive' to light (depending on if you are indoors or outdoors, for example): </p><div class="fragment"><div class="line">tsl.setGain(TSL2561_GAIN_1X); /* No gain ... use in bright light to avoid sensor saturation */</div><div class="line">tsl.setGain(TSL2561_GAIN_16X); /* 16x gain ... use in low light to boost sensitivity */</div><div class="line">tsl.enableAutoGain(true); /* Auto-gain ... switches automatically between 1x and 16x */</div></div><!-- fragment --><p>The driver also supports as automatic clipping detection, and will return '65536' lux when the sensor is saturated and data is unreliable. tsl.getEvent will return false in case of saturation and true in case of valid light data.</p>
<h2>About the TSL2561</h2>
<p>The TSL2561 is a 16-bit digital (I2C) light sensor, with adjustable gain and 'integration time'.</p>
<p>Adjusting the 'integration time' essentially increases the resolution of the device, since the analog converter inside the chip has time to take more samples. The integration time can be set as follows: </p><div class="fragment"><div class="line">tsl.setIntegrationTime(TSL2561_INTEGRATIONTIME_13MS); /* fast but low resolution */</div><div class="line">tsl.setIntegrationTime(TSL2561_INTEGRATIONTIME_101MS); /* medium resolution and speed */</div><div class="line">tsl.setIntegrationTime(TSL2561_INTEGRATIONTIME_402MS); /* 16-bit data but slowest conversions */</div></div><!-- fragment --><p>One of the big advantages of the TSL2561 is that it is capable of measuring both broadband (visible plus infrared) and infrared light thanks to two distinct sensing units on the device. This is important in certain lighting environments to be able to read the light level reliably.</p>
<p>More information on the TSL2561 can be found in the datasheet: <a href="http://www.adafruit.com/datasheets/TSL2561.pdf">http://www.adafruit.com/datasheets/TSL2561.pdf</a></p>
<h2>What is the Adafruit Unified Sensor Library?</h2>
<p>The Adafruit Unified Sensor Library (Adafruit_Sensor) provides a common interface and data type for any supported sensor. It defines some basic information about the sensor (sensor limits, etc.), and returns standard SI units of a specific type and scale for each supported sensor type.</p>
<p>It provides a simple abstraction layer between your application and the actual sensor HW, allowing you to drop in any comparable sensor with only one or two lines of code to change in your project (essentially the constructor since the functions to read sensor data and get information about the sensor are defined in the base Adafruit_Sensor class).</p>
<p>This is imporant useful for two reasons:</p>
<p>1.) You can use the data right away because it's already converted to SI units that you understand and can compare, rather than meaningless values like 0..1023.</p>
<p>2.) Because SI units are standardised in the sensor library, you can also do quick sanity checks working with new sensors, or drop in any comparable sensor if you need better sensitivity or if a lower cost unit becomes available, etc.</p>
<p>Light sensors will always report units in lux, gyroscopes will always report units in rad/s, etc. ... freeing you up to focus on the data, rather than digging through the datasheet to understand what the sensor's raw numbers really mean.</p>
<h2>About this Driver</h2>
<p>Adafruit invests time and resources providing this open source code. Please support Adafruit and open-source hardware by purchasing products from Adafruit!</p>
<p>Written by Kevin (KTOWN) Townsend for Adafruit Industries. </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>

1
html/menudata.js
View File

@@ -1,6 +1,5 @@
var menudata={children:[
{text:"Main Page",url:"index.html"},
{text:"Related Pages",url:"pages.html"},
{text:"Classes",url:"annotated.html",children:[
{text:"Class List",url:"annotated.html"},
{text:"Class Index",url:"classes.html"},

78
html/pages.html
View File

@@ -1,78 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Adafruit TSL2561 Arduino Library: Related Pages</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Adafruit TSL2561 Arduino Library
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">Related Pages</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock">Here is a list of all related documentation pages:</div><div class="directory">
<table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="md__r_e_a_d_m_e.html" target="_self">Adafruit TSL2561 Light Sensor Driver [![Build Status](https://travis-ci.org/adafruit/Adafruit_TSL2561.svg?branch=master)](https://travis-ci.org/adafruit/Adafruit_TSL2561)</a></td><td class="desc"></td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>

3
html/search/all_0.js
View File

@@ -3,6 +3,5 @@ var searchData=
['adafruit_5ftsl2561_5fu_2ecpp',['Adafruit_TSL2561_U.cpp',['../_adafruit___t_s_l2561___u_8cpp.html',1,'']]],
['adafruit_5ftsl2561_5fu_2eh',['Adafruit_TSL2561_U.h',['../_adafruit___t_s_l2561___u_8h.html',1,'']]],
['adafruit_5ftsl2561_5funified',['Adafruit_TSL2561_Unified',['../class_adafruit___t_s_l2561___unified.html',1,'Adafruit_TSL2561_Unified'],['../class_adafruit___t_s_l2561___unified.html#abd81c1ca2c46e4d8b9c3f4460a65aa3f',1,'Adafruit_TSL2561_Unified::Adafruit_TSL2561_Unified()']]],
['adafruit_20tsl2561_20light_2flux_20sensor_20driver',['Adafruit TSL2561 Light/Lux sensor driver',['../index.html',1,'']]],
['adafruit_20tsl2561_20light_20sensor_20driver_20_20_5b_21_5bbuild_20status_5d_28https_3a_2f_2ftravis_2dci_2eorg_2fadafruit_2fadafruit_5ftsl2561_2esvg_3fbranch_3dmaster_29_5d_28https_3a_2f_2ftravis_2dci_2eorg_2fadafruit_2fadafruit_5ftsl2561_29',['Adafruit TSL2561 Light Sensor Driver [![Build Status](https://travis-ci.org/adafruit/Adafruit_TSL2561.svg?branch=master)](https://travis-ci.org/adafruit/Adafruit_TSL2561)',['../md__r_e_a_d_m_e.html',1,'']]]
['adafruit_20tsl2561_20light_2flux_20sensor_20driver',['Adafruit TSL2561 Light/Lux sensor driver',['../index.html',1,'']]]
];

3
html/search/pages_0.js
View File

@@ -1,5 +1,4 @@
var searchData=
[
['adafruit_20tsl2561_20light_2flux_20sensor_20driver',['Adafruit TSL2561 Light/Lux sensor driver',['../index.html',1,'']]],
['adafruit_20tsl2561_20light_20sensor_20driver_20_20_5b_21_5bbuild_20status_5d_28https_3a_2f_2ftravis_2dci_2eorg_2fadafruit_2fadafruit_5ftsl2561_2esvg_3fbranch_3dmaster_29_5d_28https_3a_2f_2ftravis_2dci_2eorg_2fadafruit_2fadafruit_5ftsl2561_29',['Adafruit TSL2561 Light Sensor Driver [![Build Status](https://travis-ci.org/adafruit/Adafruit_TSL2561.svg?branch=master)](https://travis-ci.org/adafruit/Adafruit_TSL2561)',['../md__r_e_a_d_m_e.html',1,'']]]
['adafruit_20tsl2561_20light_2flux_20sensor_20driver',['Adafruit TSL2561 Light/Lux sensor driver',['../index.html',1,'']]]
];