1241 lines
62 KiB
HTML
1241 lines
62 KiB
HTML
<!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 TCS3430 Arduino Library: Adafruit_TCS3430 Class Reference</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 TCS3430 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="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="class_adafruit___t_c_s3430-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Adafruit_TCS3430 Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Class that stores state and functions for interacting with TCS3430 Color and ALS Sensor.
|
|
<a href="class_adafruit___t_c_s3430.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_adafruit___t_c_s3430_8h_source.html">Adafruit_TCS3430.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:accd5cb4768599550fed8aa47c12ce9fc"><td class="memItemLeft" align="right" valign="top"><a id="accd5cb4768599550fed8aa47c12ce9fc"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#accd5cb4768599550fed8aa47c12ce9fc">Adafruit_TCS3430</a> ()</td></tr>
|
|
<tr class="memdesc:accd5cb4768599550fed8aa47c12ce9fc"><td class="mdescLeft"> </td><td class="mdescRight">Instantiates a new TCS3430 class. <br /></td></tr>
|
|
<tr class="separator:accd5cb4768599550fed8aa47c12ce9fc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4b2018b50a207a8c48f4d50a32abc406"><td class="memItemLeft" align="right" valign="top"><a id="a4b2018b50a207a8c48f4d50a32abc406"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#a4b2018b50a207a8c48f4d50a32abc406">~Adafruit_TCS3430</a> ()</td></tr>
|
|
<tr class="memdesc:a4b2018b50a207a8c48f4d50a32abc406"><td class="mdescLeft"> </td><td class="mdescRight">Cleans up the TCS3430. <br /></td></tr>
|
|
<tr class="separator:a4b2018b50a207a8c48f4d50a32abc406"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a988ac3940a49017d82defb3263a66e33"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#a988ac3940a49017d82defb3263a66e33">begin</a> (uint8_t addr=<a class="el" href="_adafruit___t_c_s3430_8h.html#a030e27c89e0f8e29d5dfbfc5983dc211">TCS3430_DEFAULT_ADDR</a>, TwoWire *theWire=&Wire)</td></tr>
|
|
<tr class="memdesc:a988ac3940a49017d82defb3263a66e33"><td class="mdescLeft"> </td><td class="mdescRight">Sets up the hardware and initializes I2C. <a href="#a988ac3940a49017d82defb3263a66e33">More...</a><br /></td></tr>
|
|
<tr class="separator:a988ac3940a49017d82defb3263a66e33"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a68ea001ca483f19c46ec82f550fa11b1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#a68ea001ca483f19c46ec82f550fa11b1">setIntegrationCycles</a> (uint8_t cycles)</td></tr>
|
|
<tr class="memdesc:a68ea001ca483f19c46ec82f550fa11b1"><td class="mdescLeft"> </td><td class="mdescRight">Set integration cycles. <a href="#a68ea001ca483f19c46ec82f550fa11b1">More...</a><br /></td></tr>
|
|
<tr class="separator:a68ea001ca483f19c46ec82f550fa11b1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a73a4bee8fce603e9fe38d6bc3a36f797"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#a73a4bee8fce603e9fe38d6bc3a36f797">getIntegrationCycles</a> ()</td></tr>
|
|
<tr class="memdesc:a73a4bee8fce603e9fe38d6bc3a36f797"><td class="mdescLeft"> </td><td class="mdescRight">Get integration cycles. <a href="#a73a4bee8fce603e9fe38d6bc3a36f797">More...</a><br /></td></tr>
|
|
<tr class="separator:a73a4bee8fce603e9fe38d6bc3a36f797"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a95e66bb80240e94d1645e3f198a4a972"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#a95e66bb80240e94d1645e3f198a4a972">setIntegrationTime</a> (float ms)</td></tr>
|
|
<tr class="memdesc:a95e66bb80240e94d1645e3f198a4a972"><td class="mdescLeft"> </td><td class="mdescRight">Set integration time in milliseconds. <a href="#a95e66bb80240e94d1645e3f198a4a972">More...</a><br /></td></tr>
|
|
<tr class="separator:a95e66bb80240e94d1645e3f198a4a972"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9b92b774672205743fe9bec2e35ee313"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#a9b92b774672205743fe9bec2e35ee313">getIntegrationTime</a> ()</td></tr>
|
|
<tr class="memdesc:a9b92b774672205743fe9bec2e35ee313"><td class="mdescLeft"> </td><td class="mdescRight">Get integration time in milliseconds. <a href="#a9b92b774672205743fe9bec2e35ee313">More...</a><br /></td></tr>
|
|
<tr class="separator:a9b92b774672205743fe9bec2e35ee313"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aad057b8d27c83ed2335bf0fb6bcc4b84"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#aad057b8d27c83ed2335bf0fb6bcc4b84">setWaitCycles</a> (uint8_t cycles)</td></tr>
|
|
<tr class="memdesc:aad057b8d27c83ed2335bf0fb6bcc4b84"><td class="mdescLeft"> </td><td class="mdescRight">Set wait cycles. <a href="#aad057b8d27c83ed2335bf0fb6bcc4b84">More...</a><br /></td></tr>
|
|
<tr class="separator:aad057b8d27c83ed2335bf0fb6bcc4b84"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3a5e4aabb8dec5765ee57827a8b14725"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#a3a5e4aabb8dec5765ee57827a8b14725">getWaitCycles</a> ()</td></tr>
|
|
<tr class="memdesc:a3a5e4aabb8dec5765ee57827a8b14725"><td class="mdescLeft"> </td><td class="mdescRight">Get wait cycles. <a href="#a3a5e4aabb8dec5765ee57827a8b14725">More...</a><br /></td></tr>
|
|
<tr class="separator:a3a5e4aabb8dec5765ee57827a8b14725"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0b0973578cc4205ca7e3922e61568734"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#a0b0973578cc4205ca7e3922e61568734">setWaitTime</a> (float ms)</td></tr>
|
|
<tr class="memdesc:a0b0973578cc4205ca7e3922e61568734"><td class="mdescLeft"> </td><td class="mdescRight">Set wait time in milliseconds. <a href="#a0b0973578cc4205ca7e3922e61568734">More...</a><br /></td></tr>
|
|
<tr class="separator:a0b0973578cc4205ca7e3922e61568734"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0e962eb30ea627ae788e4d4f4271bf9f"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#a0e962eb30ea627ae788e4d4f4271bf9f">getWaitTime</a> ()</td></tr>
|
|
<tr class="memdesc:a0e962eb30ea627ae788e4d4f4271bf9f"><td class="mdescLeft"> </td><td class="mdescRight">Get wait time in milliseconds. <a href="#a0e962eb30ea627ae788e4d4f4271bf9f">More...</a><br /></td></tr>
|
|
<tr class="separator:a0e962eb30ea627ae788e4d4f4271bf9f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:addde0b77340ac92d50993e35f7069f93"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#addde0b77340ac92d50993e35f7069f93">setALSThresholdLow</a> (uint16_t threshold)</td></tr>
|
|
<tr class="memdesc:addde0b77340ac92d50993e35f7069f93"><td class="mdescLeft"> </td><td class="mdescRight">Set ALS low threshold. <a href="#addde0b77340ac92d50993e35f7069f93">More...</a><br /></td></tr>
|
|
<tr class="separator:addde0b77340ac92d50993e35f7069f93"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1b4db96200e1ab898497291908f38475"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#a1b4db96200e1ab898497291908f38475">getALSThresholdLow</a> ()</td></tr>
|
|
<tr class="memdesc:a1b4db96200e1ab898497291908f38475"><td class="mdescLeft"> </td><td class="mdescRight">Get ALS low threshold. <a href="#a1b4db96200e1ab898497291908f38475">More...</a><br /></td></tr>
|
|
<tr class="separator:a1b4db96200e1ab898497291908f38475"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a481369d6b2ea22dd69cf12605c97f54d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#a481369d6b2ea22dd69cf12605c97f54d">setALSThresholdHigh</a> (uint16_t threshold)</td></tr>
|
|
<tr class="memdesc:a481369d6b2ea22dd69cf12605c97f54d"><td class="mdescLeft"> </td><td class="mdescRight">Set ALS high threshold. <a href="#a481369d6b2ea22dd69cf12605c97f54d">More...</a><br /></td></tr>
|
|
<tr class="separator:a481369d6b2ea22dd69cf12605c97f54d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9f2992673a12a1267f301904c3a2f888"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#a9f2992673a12a1267f301904c3a2f888">getALSThresholdHigh</a> ()</td></tr>
|
|
<tr class="memdesc:a9f2992673a12a1267f301904c3a2f888"><td class="mdescLeft"> </td><td class="mdescRight">Get ALS high threshold. <a href="#a9f2992673a12a1267f301904c3a2f888">More...</a><br /></td></tr>
|
|
<tr class="separator:a9f2992673a12a1267f301904c3a2f888"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4a7203532914b3cbe928f447d3a0fa5f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#a4a7203532914b3cbe928f447d3a0fa5f">setInterruptPersistence</a> (<a class="el" href="_adafruit___t_c_s3430_8h.html#ad8df91653f2174fa69c789ed69b45a18">tcs3430_pers_t</a> persistence)</td></tr>
|
|
<tr class="memdesc:a4a7203532914b3cbe928f447d3a0fa5f"><td class="mdescLeft"> </td><td class="mdescRight">Set interrupt persistence. <a href="#a4a7203532914b3cbe928f447d3a0fa5f">More...</a><br /></td></tr>
|
|
<tr class="separator:a4a7203532914b3cbe928f447d3a0fa5f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a527dd3ac526f81dfd84bb92682825031"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_adafruit___t_c_s3430_8h.html#ad8df91653f2174fa69c789ed69b45a18">tcs3430_pers_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#a527dd3ac526f81dfd84bb92682825031">getInterruptPersistence</a> ()</td></tr>
|
|
<tr class="memdesc:a527dd3ac526f81dfd84bb92682825031"><td class="mdescLeft"> </td><td class="mdescRight">Get interrupt persistence. <a href="#a527dd3ac526f81dfd84bb92682825031">More...</a><br /></td></tr>
|
|
<tr class="separator:a527dd3ac526f81dfd84bb92682825031"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af71072111c357646ee719a414b3d7da1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#af71072111c357646ee719a414b3d7da1">setWaitLong</a> (bool enable)</td></tr>
|
|
<tr class="memdesc:af71072111c357646ee719a414b3d7da1"><td class="mdescLeft"> </td><td class="mdescRight">Sets wait long mode. <a href="#af71072111c357646ee719a414b3d7da1">More...</a><br /></td></tr>
|
|
<tr class="separator:af71072111c357646ee719a414b3d7da1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa652f377172c739d64b81b317fe21c4f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#aa652f377172c739d64b81b317fe21c4f">getWaitLong</a> ()</td></tr>
|
|
<tr class="memdesc:aa652f377172c739d64b81b317fe21c4f"><td class="mdescLeft"> </td><td class="mdescRight">Gets wait long mode status. <a href="#aa652f377172c739d64b81b317fe21c4f">More...</a><br /></td></tr>
|
|
<tr class="separator:aa652f377172c739d64b81b317fe21c4f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af27b6ec71250d75fe70708fad6c39fa8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#af27b6ec71250d75fe70708fad6c39fa8">setALSMUX_IR2</a> (bool enable)</td></tr>
|
|
<tr class="memdesc:af27b6ec71250d75fe70708fad6c39fa8"><td class="mdescLeft"> </td><td class="mdescRight">Set ALS MUX to IR2 or X channel. <a href="#af27b6ec71250d75fe70708fad6c39fa8">More...</a><br /></td></tr>
|
|
<tr class="separator:af27b6ec71250d75fe70708fad6c39fa8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a79254e24b0ac9c171aeaa4cfebe7fb90"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#a79254e24b0ac9c171aeaa4cfebe7fb90">getALSMUX_IR2</a> ()</td></tr>
|
|
<tr class="memdesc:a79254e24b0ac9c171aeaa4cfebe7fb90"><td class="mdescLeft"> </td><td class="mdescRight">Get ALS MUX setting. <a href="#a79254e24b0ac9c171aeaa4cfebe7fb90">More...</a><br /></td></tr>
|
|
<tr class="separator:a79254e24b0ac9c171aeaa4cfebe7fb90"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab9df2b938e4f4e51b97ec1ed05c1d43a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#ab9df2b938e4f4e51b97ec1ed05c1d43a">setALSGain</a> (<a class="el" href="_adafruit___t_c_s3430_8h.html#ad5e9a7aaabd9abe3efdb6520282dff17">tcs3430_gain_t</a> gain)</td></tr>
|
|
<tr class="memdesc:ab9df2b938e4f4e51b97ec1ed05c1d43a"><td class="mdescLeft"> </td><td class="mdescRight">Set ALS gain. <a href="#ab9df2b938e4f4e51b97ec1ed05c1d43a">More...</a><br /></td></tr>
|
|
<tr class="separator:ab9df2b938e4f4e51b97ec1ed05c1d43a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af158076cdb710a748a0adc8cd07294be"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_adafruit___t_c_s3430_8h.html#ad5e9a7aaabd9abe3efdb6520282dff17">tcs3430_gain_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#af158076cdb710a748a0adc8cd07294be">getALSGain</a> ()</td></tr>
|
|
<tr class="memdesc:af158076cdb710a748a0adc8cd07294be"><td class="mdescLeft"> </td><td class="mdescRight">Get ALS gain. <a href="#af158076cdb710a748a0adc8cd07294be">More...</a><br /></td></tr>
|
|
<tr class="separator:af158076cdb710a748a0adc8cd07294be"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac05a34edbc1b4c15c3dcea2868b2da6e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#ac05a34edbc1b4c15c3dcea2868b2da6e">isALSSaturated</a> ()</td></tr>
|
|
<tr class="memdesc:ac05a34edbc1b4c15c3dcea2868b2da6e"><td class="mdescLeft"> </td><td class="mdescRight">Check if ALS is saturated. <a href="#ac05a34edbc1b4c15c3dcea2868b2da6e">More...</a><br /></td></tr>
|
|
<tr class="separator:ac05a34edbc1b4c15c3dcea2868b2da6e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab8e2530f4f2d458965952dae69f4dd84"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#ab8e2530f4f2d458965952dae69f4dd84">clearALSSaturated</a> ()</td></tr>
|
|
<tr class="memdesc:ab8e2530f4f2d458965952dae69f4dd84"><td class="mdescLeft"> </td><td class="mdescRight">Clear ALS saturation flag. <a href="#ab8e2530f4f2d458965952dae69f4dd84">More...</a><br /></td></tr>
|
|
<tr class="separator:ab8e2530f4f2d458965952dae69f4dd84"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a63d8731ba1d619f8dd8464fa11b1a9c7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#a63d8731ba1d619f8dd8464fa11b1a9c7">isALSInterrupt</a> ()</td></tr>
|
|
<tr class="memdesc:a63d8731ba1d619f8dd8464fa11b1a9c7"><td class="mdescLeft"> </td><td class="mdescRight">Check if ALS interrupt is active. <a href="#a63d8731ba1d619f8dd8464fa11b1a9c7">More...</a><br /></td></tr>
|
|
<tr class="separator:a63d8731ba1d619f8dd8464fa11b1a9c7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7ef2b3b2a80c96d02057909b54adc62e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#a7ef2b3b2a80c96d02057909b54adc62e">clearALSInterrupt</a> ()</td></tr>
|
|
<tr class="memdesc:a7ef2b3b2a80c96d02057909b54adc62e"><td class="mdescLeft"> </td><td class="mdescRight">Clear ALS interrupt flag. <a href="#a7ef2b3b2a80c96d02057909b54adc62e">More...</a><br /></td></tr>
|
|
<tr class="separator:a7ef2b3b2a80c96d02057909b54adc62e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a68093d84fe1c319d8b7bfeb3930bc0e0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#a68093d84fe1c319d8b7bfeb3930bc0e0">getData</a> (uint16_t *x, uint16_t *y, uint16_t *z)</td></tr>
|
|
<tr class="memdesc:a68093d84fe1c319d8b7bfeb3930bc0e0"><td class="mdescLeft"> </td><td class="mdescRight">Get sensor data for X, Y, Z channels. <a href="#a68093d84fe1c319d8b7bfeb3930bc0e0">More...</a><br /></td></tr>
|
|
<tr class="separator:a68093d84fe1c319d8b7bfeb3930bc0e0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5a3597dcdbe2bad06ae67c2cc7fed89b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#a5a3597dcdbe2bad06ae67c2cc7fed89b">setInterruptClearOnRead</a> (bool enable)</td></tr>
|
|
<tr class="memdesc:a5a3597dcdbe2bad06ae67c2cc7fed89b"><td class="mdescLeft"> </td><td class="mdescRight">Set interrupt clear on read mode. <a href="#a5a3597dcdbe2bad06ae67c2cc7fed89b">More...</a><br /></td></tr>
|
|
<tr class="separator:a5a3597dcdbe2bad06ae67c2cc7fed89b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0cdb6083bc5546bff95980f8922357e1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#a0cdb6083bc5546bff95980f8922357e1">getInterruptClearOnRead</a> ()</td></tr>
|
|
<tr class="memdesc:a0cdb6083bc5546bff95980f8922357e1"><td class="mdescLeft"> </td><td class="mdescRight">Get interrupt clear on read mode. <a href="#a0cdb6083bc5546bff95980f8922357e1">More...</a><br /></td></tr>
|
|
<tr class="separator:a0cdb6083bc5546bff95980f8922357e1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a530061c6214c64087a893edbb160ce77"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#a530061c6214c64087a893edbb160ce77">setSleepAfterInterrupt</a> (bool enable)</td></tr>
|
|
<tr class="memdesc:a530061c6214c64087a893edbb160ce77"><td class="mdescLeft"> </td><td class="mdescRight">Set sleep after interrupt mode. <a href="#a530061c6214c64087a893edbb160ce77">More...</a><br /></td></tr>
|
|
<tr class="separator:a530061c6214c64087a893edbb160ce77"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaadd975d7bda21231a05e5dc6c8b8396"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#aaadd975d7bda21231a05e5dc6c8b8396">getSleepAfterInterrupt</a> ()</td></tr>
|
|
<tr class="memdesc:aaadd975d7bda21231a05e5dc6c8b8396"><td class="mdescLeft"> </td><td class="mdescRight">Get sleep after interrupt mode. <a href="#aaadd975d7bda21231a05e5dc6c8b8396">More...</a><br /></td></tr>
|
|
<tr class="separator:aaadd975d7bda21231a05e5dc6c8b8396"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad13d0c9277faac2ccad61ef2065a9c6c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#ad13d0c9277faac2ccad61ef2065a9c6c">setAutoZeroMode</a> (bool enable)</td></tr>
|
|
<tr class="memdesc:ad13d0c9277faac2ccad61ef2065a9c6c"><td class="mdescLeft"> </td><td class="mdescRight">Set auto-zero mode. <a href="#ad13d0c9277faac2ccad61ef2065a9c6c">More...</a><br /></td></tr>
|
|
<tr class="separator:ad13d0c9277faac2ccad61ef2065a9c6c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a78f0c13baa31309f16f0c42451de3957"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#a78f0c13baa31309f16f0c42451de3957">getAutoZeroMode</a> ()</td></tr>
|
|
<tr class="memdesc:a78f0c13baa31309f16f0c42451de3957"><td class="mdescLeft"> </td><td class="mdescRight">Get auto-zero mode. <a href="#a78f0c13baa31309f16f0c42451de3957">More...</a><br /></td></tr>
|
|
<tr class="separator:a78f0c13baa31309f16f0c42451de3957"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1d5a7f50764be35652a34a35d45afa50"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#a1d5a7f50764be35652a34a35d45afa50">setRunAutoZeroEveryN</a> (uint8_t n)</td></tr>
|
|
<tr class="memdesc:a1d5a7f50764be35652a34a35d45afa50"><td class="mdescLeft"> </td><td class="mdescRight">Set auto-zero interval. <a href="#a1d5a7f50764be35652a34a35d45afa50">More...</a><br /></td></tr>
|
|
<tr class="separator:a1d5a7f50764be35652a34a35d45afa50"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a68e657bb29d51dd08648e6a4638f65c0"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#a68e657bb29d51dd08648e6a4638f65c0">getRunAutoZeroEveryN</a> ()</td></tr>
|
|
<tr class="memdesc:a68e657bb29d51dd08648e6a4638f65c0"><td class="mdescLeft"> </td><td class="mdescRight">Get auto-zero interval. <a href="#a68e657bb29d51dd08648e6a4638f65c0">More...</a><br /></td></tr>
|
|
<tr class="separator:a68e657bb29d51dd08648e6a4638f65c0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adf59731a9d253fb83cc7c144ccb282d7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#adf59731a9d253fb83cc7c144ccb282d7">enableSaturationInt</a> (bool enable)</td></tr>
|
|
<tr class="memdesc:adf59731a9d253fb83cc7c144ccb282d7"><td class="mdescLeft"> </td><td class="mdescRight">Enable/disable saturation interrupt. <a href="#adf59731a9d253fb83cc7c144ccb282d7">More...</a><br /></td></tr>
|
|
<tr class="separator:adf59731a9d253fb83cc7c144ccb282d7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a44480304cc25f3310cb4541889fb0cb5"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#a44480304cc25f3310cb4541889fb0cb5">enableALSInt</a> (bool enable)</td></tr>
|
|
<tr class="memdesc:a44480304cc25f3310cb4541889fb0cb5"><td class="mdescLeft"> </td><td class="mdescRight">Enable/disable ALS interrupt. <a href="#a44480304cc25f3310cb4541889fb0cb5">More...</a><br /></td></tr>
|
|
<tr class="separator:a44480304cc25f3310cb4541889fb0cb5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0e2809afee8867578a310cdd95493e1d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#a0e2809afee8867578a310cdd95493e1d">waitEnable</a> (bool enable)</td></tr>
|
|
<tr class="memdesc:a0e2809afee8867578a310cdd95493e1d"><td class="mdescLeft"> </td><td class="mdescRight">Enable/disable wait functionality. <a href="#a0e2809afee8867578a310cdd95493e1d">More...</a><br /></td></tr>
|
|
<tr class="separator:a0e2809afee8867578a310cdd95493e1d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af15e31743438960a52f73c30867a3f8f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#af15e31743438960a52f73c30867a3f8f">isWaitEnabled</a> ()</td></tr>
|
|
<tr class="memdesc:af15e31743438960a52f73c30867a3f8f"><td class="mdescLeft"> </td><td class="mdescRight">Check if wait is enabled. <a href="#af15e31743438960a52f73c30867a3f8f">More...</a><br /></td></tr>
|
|
<tr class="separator:af15e31743438960a52f73c30867a3f8f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac739b28f71bd67f5a70ba3fe5df7f86c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#ac739b28f71bd67f5a70ba3fe5df7f86c">ALSEnable</a> (bool enable)</td></tr>
|
|
<tr class="memdesc:ac739b28f71bd67f5a70ba3fe5df7f86c"><td class="mdescLeft"> </td><td class="mdescRight">Enable/disable ALS functionality. <a href="#ac739b28f71bd67f5a70ba3fe5df7f86c">More...</a><br /></td></tr>
|
|
<tr class="separator:ac739b28f71bd67f5a70ba3fe5df7f86c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:affbd992402729176d53a3ea3ba24fc8c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#affbd992402729176d53a3ea3ba24fc8c">isALSEnabled</a> ()</td></tr>
|
|
<tr class="memdesc:affbd992402729176d53a3ea3ba24fc8c"><td class="mdescLeft"> </td><td class="mdescRight">Check if ALS is enabled. <a href="#affbd992402729176d53a3ea3ba24fc8c">More...</a><br /></td></tr>
|
|
<tr class="separator:affbd992402729176d53a3ea3ba24fc8c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a966022bf170f449b5734af992700b88b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#a966022bf170f449b5734af992700b88b">powerOn</a> (bool enable)</td></tr>
|
|
<tr class="memdesc:a966022bf170f449b5734af992700b88b"><td class="mdescLeft"> </td><td class="mdescRight">Power on/off the sensor. <a href="#a966022bf170f449b5734af992700b88b">More...</a><br /></td></tr>
|
|
<tr class="separator:a966022bf170f449b5734af992700b88b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aabd466a47e674373b7ce7dd87cf9a341"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___t_c_s3430.html#aabd466a47e674373b7ce7dd87cf9a341">isPoweredOn</a> ()</td></tr>
|
|
<tr class="memdesc:aabd466a47e674373b7ce7dd87cf9a341"><td class="mdescLeft"> </td><td class="mdescRight">Check if sensor is powered on. <a href="#aabd466a47e674373b7ce7dd87cf9a341">More...</a><br /></td></tr>
|
|
<tr class="separator:aabd466a47e674373b7ce7dd87cf9a341"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Class that stores state and functions for interacting with TCS3430 Color and ALS Sensor. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a988ac3940a49017d82defb3263a66e33"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a988ac3940a49017d82defb3263a66e33">◆ </a></span>begin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_TCS3430::begin </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>addr</em> = <code><a class="el" href="_adafruit___t_c_s3430_8h.html#a030e27c89e0f8e29d5dfbfc5983dc211">TCS3430_DEFAULT_ADDR</a></code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">TwoWire * </td>
|
|
<td class="paramname"><em>theWire</em> = <code>&Wire</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets up the hardware and initializes I2C. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">addr</td><td>The I2C address to be used. </td></tr>
|
|
<tr><td class="paramname">theWire</td><td>The Wire object to be used for I2C connections. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if initialization was successful, otherwise false. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a68ea001ca483f19c46ec82f550fa11b1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a68ea001ca483f19c46ec82f550fa11b1">◆ </a></span>setIntegrationCycles()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_TCS3430::setIntegrationCycles </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>cycles</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set integration cycles. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">cycles</td><td>Number of integration cycles (1-256) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true on success </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a73a4bee8fce603e9fe38d6bc3a36f797"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a73a4bee8fce603e9fe38d6bc3a36f797">◆ </a></span>getIntegrationCycles()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t Adafruit_TCS3430::getIntegrationCycles </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get integration cycles. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Current integration cycles </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a95e66bb80240e94d1645e3f198a4a972"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a95e66bb80240e94d1645e3f198a4a972">◆ </a></span>setIntegrationTime()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_TCS3430::setIntegrationTime </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>ms</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set integration time in milliseconds. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ms</td><td>Integration time in ms </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true on success </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9b92b774672205743fe9bec2e35ee313"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9b92b774672205743fe9bec2e35ee313">◆ </a></span>getIntegrationTime()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float Adafruit_TCS3430::getIntegrationTime </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get integration time in milliseconds. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Integration time in ms </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aad057b8d27c83ed2335bf0fb6bcc4b84"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aad057b8d27c83ed2335bf0fb6bcc4b84">◆ </a></span>setWaitCycles()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_TCS3430::setWaitCycles </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>cycles</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set wait cycles. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">cycles</td><td>Number of wait cycles </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true on success </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3a5e4aabb8dec5765ee57827a8b14725"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3a5e4aabb8dec5765ee57827a8b14725">◆ </a></span>getWaitCycles()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t Adafruit_TCS3430::getWaitCycles </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get wait cycles. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Current wait cycles </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0b0973578cc4205ca7e3922e61568734"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0b0973578cc4205ca7e3922e61568734">◆ </a></span>setWaitTime()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_TCS3430::setWaitTime </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>ms</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set wait time in milliseconds. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ms</td><td>Wait time in ms </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true on success </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0e962eb30ea627ae788e4d4f4271bf9f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0e962eb30ea627ae788e4d4f4271bf9f">◆ </a></span>getWaitTime()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float Adafruit_TCS3430::getWaitTime </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get wait time in milliseconds. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Wait time in ms </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="addde0b77340ac92d50993e35f7069f93"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#addde0b77340ac92d50993e35f7069f93">◆ </a></span>setALSThresholdLow()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_TCS3430::setALSThresholdLow </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>threshold</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set ALS low threshold. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">threshold</td><td>Low threshold value </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true on success </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1b4db96200e1ab898497291908f38475"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1b4db96200e1ab898497291908f38475">◆ </a></span>getALSThresholdLow()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t Adafruit_TCS3430::getALSThresholdLow </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get ALS low threshold. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Current low threshold value </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a481369d6b2ea22dd69cf12605c97f54d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a481369d6b2ea22dd69cf12605c97f54d">◆ </a></span>setALSThresholdHigh()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_TCS3430::setALSThresholdHigh </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>threshold</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set ALS high threshold. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">threshold</td><td>High threshold value </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true on success </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9f2992673a12a1267f301904c3a2f888"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9f2992673a12a1267f301904c3a2f888">◆ </a></span>getALSThresholdHigh()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t Adafruit_TCS3430::getALSThresholdHigh </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get ALS high threshold. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Current high threshold value </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4a7203532914b3cbe928f447d3a0fa5f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4a7203532914b3cbe928f447d3a0fa5f">◆ </a></span>setInterruptPersistence()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_TCS3430::setInterruptPersistence </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_adafruit___t_c_s3430_8h.html#ad8df91653f2174fa69c789ed69b45a18">tcs3430_pers_t</a> </td>
|
|
<td class="paramname"><em>persistence</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set interrupt persistence. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">persistence</td><td>Persistence setting </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true on success </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a527dd3ac526f81dfd84bb92682825031"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a527dd3ac526f81dfd84bb92682825031">◆ </a></span>getInterruptPersistence()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_adafruit___t_c_s3430_8h.html#ad8df91653f2174fa69c789ed69b45a18">tcs3430_pers_t</a> Adafruit_TCS3430::getInterruptPersistence </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get interrupt persistence. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Current persistence setting </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af71072111c357646ee719a414b3d7da1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af71072111c357646ee719a414b3d7da1">◆ </a></span>setWaitLong()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_TCS3430::setWaitLong </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enable</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets wait long mode. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">enable</td><td>true to enable 12x wait time multiplier </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true on success </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa652f377172c739d64b81b317fe21c4f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa652f377172c739d64b81b317fe21c4f">◆ </a></span>getWaitLong()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_TCS3430::getWaitLong </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets wait long mode status. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if 12x wait time multiplier is enabled </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af27b6ec71250d75fe70708fad6c39fa8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af27b6ec71250d75fe70708fad6c39fa8">◆ </a></span>setALSMUX_IR2()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_TCS3430::setALSMUX_IR2 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enable</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set ALS MUX to IR2 or X channel. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">enable</td><td>true for IR2, false for X channel </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true on success </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a79254e24b0ac9c171aeaa4cfebe7fb90"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a79254e24b0ac9c171aeaa4cfebe7fb90">◆ </a></span>getALSMUX_IR2()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_TCS3430::getALSMUX_IR2 </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get ALS MUX setting. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if IR2 channel, false if X channel </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab9df2b938e4f4e51b97ec1ed05c1d43a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab9df2b938e4f4e51b97ec1ed05c1d43a">◆ </a></span>setALSGain()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_TCS3430::setALSGain </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_adafruit___t_c_s3430_8h.html#ad5e9a7aaabd9abe3efdb6520282dff17">tcs3430_gain_t</a> </td>
|
|
<td class="paramname"><em>gain</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set ALS gain. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">gain</td><td>Gain setting </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true on success </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af158076cdb710a748a0adc8cd07294be"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af158076cdb710a748a0adc8cd07294be">◆ </a></span>getALSGain()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_adafruit___t_c_s3430_8h.html#ad5e9a7aaabd9abe3efdb6520282dff17">tcs3430_gain_t</a> Adafruit_TCS3430::getALSGain </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get ALS gain. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Current gain setting </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac05a34edbc1b4c15c3dcea2868b2da6e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac05a34edbc1b4c15c3dcea2868b2da6e">◆ </a></span>isALSSaturated()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_TCS3430::isALSSaturated </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check if ALS is saturated. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if saturated </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab8e2530f4f2d458965952dae69f4dd84"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab8e2530f4f2d458965952dae69f4dd84">◆ </a></span>clearALSSaturated()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_TCS3430::clearALSSaturated </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clear ALS saturation flag. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>true on success </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a63d8731ba1d619f8dd8464fa11b1a9c7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a63d8731ba1d619f8dd8464fa11b1a9c7">◆ </a></span>isALSInterrupt()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_TCS3430::isALSInterrupt </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check if ALS interrupt is active. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if interrupt is active </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7ef2b3b2a80c96d02057909b54adc62e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7ef2b3b2a80c96d02057909b54adc62e">◆ </a></span>clearALSInterrupt()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_TCS3430::clearALSInterrupt </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clear ALS interrupt flag. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>true on success </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a68093d84fe1c319d8b7bfeb3930bc0e0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a68093d84fe1c319d8b7bfeb3930bc0e0">◆ </a></span>getData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Adafruit_TCS3430::getData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint16_t * </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t * </td>
|
|
<td class="paramname"><em>y</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t * </td>
|
|
<td class="paramname"><em>z</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get sensor data for X, Y, Z channels. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">x</td><td>Pointer to store X channel data </td></tr>
|
|
<tr><td class="paramname">y</td><td>Pointer to store Y channel data </td></tr>
|
|
<tr><td class="paramname">z</td><td>Pointer to store Z channel data </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5a3597dcdbe2bad06ae67c2cc7fed89b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5a3597dcdbe2bad06ae67c2cc7fed89b">◆ </a></span>setInterruptClearOnRead()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_TCS3430::setInterruptClearOnRead </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enable</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set interrupt clear on read mode. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">enable</td><td>true to enable clear on read </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true on success </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0cdb6083bc5546bff95980f8922357e1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0cdb6083bc5546bff95980f8922357e1">◆ </a></span>getInterruptClearOnRead()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_TCS3430::getInterruptClearOnRead </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get interrupt clear on read mode. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if clear on read is enabled </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a530061c6214c64087a893edbb160ce77"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a530061c6214c64087a893edbb160ce77">◆ </a></span>setSleepAfterInterrupt()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_TCS3430::setSleepAfterInterrupt </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enable</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set sleep after interrupt mode. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">enable</td><td>true to enable sleep after interrupt </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true on success </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaadd975d7bda21231a05e5dc6c8b8396"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaadd975d7bda21231a05e5dc6c8b8396">◆ </a></span>getSleepAfterInterrupt()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_TCS3430::getSleepAfterInterrupt </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get sleep after interrupt mode. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if sleep after interrupt is enabled </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad13d0c9277faac2ccad61ef2065a9c6c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad13d0c9277faac2ccad61ef2065a9c6c">◆ </a></span>setAutoZeroMode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_TCS3430::setAutoZeroMode </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enable</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set auto-zero mode. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">enable</td><td>true to enable auto-zero </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true on success </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a78f0c13baa31309f16f0c42451de3957"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a78f0c13baa31309f16f0c42451de3957">◆ </a></span>getAutoZeroMode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_TCS3430::getAutoZeroMode </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get auto-zero mode. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if auto-zero is enabled </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1d5a7f50764be35652a34a35d45afa50"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1d5a7f50764be35652a34a35d45afa50">◆ </a></span>setRunAutoZeroEveryN()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_TCS3430::setRunAutoZeroEveryN </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>n</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set auto-zero interval. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">n</td><td>Run auto-zero every N measurements </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true on success </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a68e657bb29d51dd08648e6a4638f65c0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a68e657bb29d51dd08648e6a4638f65c0">◆ </a></span>getRunAutoZeroEveryN()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t Adafruit_TCS3430::getRunAutoZeroEveryN </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get auto-zero interval. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Auto-zero interval (every N measurements) </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adf59731a9d253fb83cc7c144ccb282d7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adf59731a9d253fb83cc7c144ccb282d7">◆ </a></span>enableSaturationInt()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_TCS3430::enableSaturationInt </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enable</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enable/disable saturation interrupt. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">enable</td><td>true to enable saturation interrupt </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true on success </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a44480304cc25f3310cb4541889fb0cb5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a44480304cc25f3310cb4541889fb0cb5">◆ </a></span>enableALSInt()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_TCS3430::enableALSInt </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enable</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enable/disable ALS interrupt. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">enable</td><td>true to enable ALS interrupt </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true on success </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0e2809afee8867578a310cdd95493e1d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0e2809afee8867578a310cdd95493e1d">◆ </a></span>waitEnable()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_TCS3430::waitEnable </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enable</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enable/disable wait functionality. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">enable</td><td>true to enable wait </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true on success </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af15e31743438960a52f73c30867a3f8f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af15e31743438960a52f73c30867a3f8f">◆ </a></span>isWaitEnabled()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_TCS3430::isWaitEnabled </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check if wait is enabled. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if wait is enabled </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac739b28f71bd67f5a70ba3fe5df7f86c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac739b28f71bd67f5a70ba3fe5df7f86c">◆ </a></span>ALSEnable()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_TCS3430::ALSEnable </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enable</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enable/disable ALS functionality. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">enable</td><td>true to enable ALS </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true on success </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="affbd992402729176d53a3ea3ba24fc8c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#affbd992402729176d53a3ea3ba24fc8c">◆ </a></span>isALSEnabled()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_TCS3430::isALSEnabled </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check if ALS is enabled. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if ALS is enabled </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a966022bf170f449b5734af992700b88b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a966022bf170f449b5734af992700b88b">◆ </a></span>powerOn()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_TCS3430::powerOn </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enable</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Power on/off the sensor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">enable</td><td>true to power on </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true on success </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aabd466a47e674373b7ce7dd87cf9a341"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aabd466a47e674373b7ce7dd87cf9a341">◆ </a></span>isPoweredOn()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_TCS3430::isPoweredOn </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check if sensor is powered on. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if powered on </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="_adafruit___t_c_s3430_8h_source.html">Adafruit_TCS3430.h</a></li>
|
|
<li><a class="el" href="_adafruit___t_c_s3430_8cpp.html">Adafruit_TCS3430.cpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|