taigrr/arduinolibs
1
0
Fork 0
mirror of https://github.com/taigrr/arduinolibs synced 2025-01-18 04:33:12 -08:00
Code Issues Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Rhys Weatherley
2015-03-12 19:03:15 +10:00
parent 083448f195
commit c6206e4216
493 changed files with 35310 additions and 3018 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
IRreceiver_8h_source.html
View File

@@ -3,6 +3,7 @@
<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.6"/>
<title>ArduinoLibs: IRreceiver.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
@@ -29,7 +30,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
@@ -115,18 +116,18 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &lt;inttypes.h&gt;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &quot;RC5.h&quot;</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="code" href="classIRreceiver.html"> 29</a></span>&#160;<span class="keyword">class </span><a class="code" href="classIRreceiver.html" title="Manages the reception of RC-5 commands from an infrared remote control.">IRreceiver</a></div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="classIRreceiver.html"> 29</a></span>&#160;<span class="keyword">class </span><a class="code" href="classIRreceiver.html">IRreceiver</a></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;{</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classIRreceiver.html#a06eccb8b8311eac395e4b20c4e0163e3" title="Constructs a new infrared remote control receiver that is attached to interruptNumber.">IRreceiver</a>(<span class="keywordtype">int</span> interruptNumber = 0);</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classIRreceiver.html#a06eccb8b8311eac395e4b20c4e0163e3">IRreceiver</a>(<span class="keywordtype">int</span> interruptNumber = 0);</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="code" href="classIRreceiver.html#a9c37631cc1291dc47cabcfef2f631cf9"> 34</a></span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classIRreceiver.html#a9c37631cc1291dc47cabcfef2f631cf9" title="Flag that is added to the output of command() when the command is an auto-repeated button press rathe...">AUTO_REPEAT</a> = 128;</div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classIRreceiver.html#a9c37631cc1291dc47cabcfef2f631cf9"> 34</a></span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classIRreceiver.html#a9c37631cc1291dc47cabcfef2f631cf9">AUTO_REPEAT</a> = 128;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordtype">int</span> <a class="code" href="classIRreceiver.html#a4b021592a2b089dc2f1e138a38506fda" title="Returns the next command from the remote control.">command</a>();</div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="code" href="classIRreceiver.html#a19e9334ae97812fa85078507d105478f"> 37</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="classIRreceiver.html#a19e9334ae97812fa85078507d105478f" title="Returns the system number of the previous command(), indicating whether the command was for a TV...">system</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _system; }</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordtype">int</span> <a class="code" href="classIRreceiver.html#a4b021592a2b089dc2f1e138a38506fda">command</a>();</div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classIRreceiver.html#a19e9334ae97812fa85078507d105478f"> 37</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="classIRreceiver.html#a19e9334ae97812fa85078507d105478f">system</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _system; }</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="code" href="classIRreceiver.html#a2c6adc404f71f263ba535ec1ed9cff1a"> 39</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="classIRreceiver.html#a2c6adc404f71f263ba535ec1ed9cff1a" title="Returns the system to filter commands against, or -1 if no filter is set.">systemFilter</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _systemFilter; }</div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="code" href="classIRreceiver.html#a920828f1411fa12d1856cd933066bd08"> 40</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classIRreceiver.html#a920828f1411fa12d1856cd933066bd08" title="Sets the system to filter commands against, or -1 to turn off the system filter.">setSystemFilter</a>(<span class="keywordtype">int</span> <a class="code" href="classIRreceiver.html#a19e9334ae97812fa85078507d105478f" title="Returns the system number of the previous command(), indicating whether the command was for a TV...">system</a>) { _systemFilter = <a class="code" href="classIRreceiver.html#a19e9334ae97812fa85078507d105478f" title="Returns the system number of the previous command(), indicating whether the command was for a TV...">system</a>; }</div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classIRreceiver.html#a2c6adc404f71f263ba535ec1ed9cff1a"> 39</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="classIRreceiver.html#a2c6adc404f71f263ba535ec1ed9cff1a">systemFilter</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _systemFilter; }</div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classIRreceiver.html#a920828f1411fa12d1856cd933066bd08"> 40</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classIRreceiver.html#a920828f1411fa12d1856cd933066bd08">setSystemFilter</a>(<span class="keywordtype">int</span> <a class="code" href="classIRreceiver.html#a19e9334ae97812fa85078507d105478f">system</a>) { _systemFilter = <a class="code" href="classIRreceiver.html#a19e9334ae97812fa85078507d105478f">system</a>; }</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordtype">int</span> _system;</div>
@@ -146,12 +147,19 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;};</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="classIRreceiver_html_a19e9334ae97812fa85078507d105478f"><div class="ttname"><a href="classIRreceiver.html#a19e9334ae97812fa85078507d105478f">IRreceiver::system</a></div><div class="ttdeci">int system() const </div><div class="ttdoc">Returns the system number of the previous command(), indicating whether the command was for a TV...</div><div class="ttdef"><b>Definition:</b> <a href="IRreceiver_8h_source.html#l00037">IRreceiver.h:37</a></div></div>
<div class="ttc" id="classIRreceiver_html_a06eccb8b8311eac395e4b20c4e0163e3"><div class="ttname"><a href="classIRreceiver.html#a06eccb8b8311eac395e4b20c4e0163e3">IRreceiver::IRreceiver</a></div><div class="ttdeci">IRreceiver(int interruptNumber=0)</div><div class="ttdoc">Constructs a new infrared remote control receiver that is attached to interruptNumber. </div><div class="ttdef"><b>Definition:</b> <a href="IRreceiver_8cpp_source.html#l00176">IRreceiver.cpp:176</a></div></div>
<div class="ttc" id="classIRreceiver_html"><div class="ttname"><a href="classIRreceiver.html">IRreceiver</a></div><div class="ttdoc">Manages the reception of RC-5 commands from an infrared remote control. </div><div class="ttdef"><b>Definition:</b> <a href="IRreceiver_8h_source.html#l00029">IRreceiver.h:29</a></div></div>
<div class="ttc" id="classIRreceiver_html_a4b021592a2b089dc2f1e138a38506fda"><div class="ttname"><a href="classIRreceiver.html#a4b021592a2b089dc2f1e138a38506fda">IRreceiver::command</a></div><div class="ttdeci">int command()</div><div class="ttdoc">Returns the next command from the remote control. </div><div class="ttdef"><b>Definition:</b> <a href="IRreceiver_8cpp_source.html#l00220">IRreceiver.cpp:220</a></div></div>
<div class="ttc" id="classIRreceiver_html_a920828f1411fa12d1856cd933066bd08"><div class="ttname"><a href="classIRreceiver.html#a920828f1411fa12d1856cd933066bd08">IRreceiver::setSystemFilter</a></div><div class="ttdeci">void setSystemFilter(int system)</div><div class="ttdoc">Sets the system to filter commands against, or -1 to turn off the system filter. </div><div class="ttdef"><b>Definition:</b> <a href="IRreceiver_8h_source.html#l00040">IRreceiver.h:40</a></div></div>
<div class="ttc" id="classIRreceiver_html_a9c37631cc1291dc47cabcfef2f631cf9"><div class="ttname"><a href="classIRreceiver.html#a9c37631cc1291dc47cabcfef2f631cf9">IRreceiver::AUTO_REPEAT</a></div><div class="ttdeci">static const int AUTO_REPEAT</div><div class="ttdoc">Flag that is added to the output of command() when the command is an auto-repeated button press rathe...</div><div class="ttdef"><b>Definition:</b> <a href="IRreceiver_8h_source.html#l00034">IRreceiver.h:34</a></div></div>
<div class="ttc" id="classIRreceiver_html_a2c6adc404f71f263ba535ec1ed9cff1a"><div class="ttname"><a href="classIRreceiver.html#a2c6adc404f71f263ba535ec1ed9cff1a">IRreceiver::systemFilter</a></div><div class="ttdeci">int systemFilter() const </div><div class="ttdoc">Returns the system to filter commands against, or -1 if no filter is set. </div><div class="ttdef"><b>Definition:</b> <a href="IRreceiver_8h_source.html#l00039">IRreceiver.h:39</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Sep 29 2013 09:30:46 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Mar 12 2015 19:02:05 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</a> 1.8.6
</small></address>
</body>
</html>