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

21
ChaseLEDs_8cpp_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: ChaseLEDs.cpp 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>
@@ -116,7 +117,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#include &lt;WProgram.h&gt;</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00071"></a><span class="lineno"><a class="code" href="classChaseLEDs.html#ab6bb3da371d3730a6552e93a9b2eab78"> 71</a></span>&#160;<a class="code" href="classChaseLEDs.html#ab6bb3da371d3730a6552e93a9b2eab78" title="Initializes the LED chaser.">ChaseLEDs::ChaseLEDs</a>(<span class="keyword">const</span> uint8_t *pins, <span class="keywordtype">int</span> num, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> advanceTime)</div>
<div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="classChaseLEDs.html#ab6bb3da371d3730a6552e93a9b2eab78"> 71</a></span>&#160;<a class="code" href="classChaseLEDs.html#ab6bb3da371d3730a6552e93a9b2eab78">ChaseLEDs::ChaseLEDs</a>(<span class="keyword">const</span> uint8_t *pins, <span class="keywordtype">int</span> num, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> advanceTime)</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; : _pins(pins)</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; , _numPins(num)</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; , _currentIndex(-1)</div>
@@ -129,35 +130,39 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; }</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;}</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;</div>
<div class="line"><a name="l00087"></a><span class="lineno"><a class="code" href="classChaseLEDs.html#a8745fa6b9f33b6c6274a563dd4dea786"> 87</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classChaseLEDs.html#a8745fa6b9f33b6c6274a563dd4dea786">ChaseLEDs::loop</a>()</div>
<div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="classChaseLEDs.html#a8745fa6b9f33b6c6274a563dd4dea786"> 87</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classChaseLEDs.html#a8745fa6b9f33b6c6274a563dd4dea786">ChaseLEDs::loop</a>()</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;{</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="keywordflow">if</span> (_currentIndex &gt;= 0) {</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="keywordflow">if</span> ((millis() - _lastChange) &gt;= _advanceTime) {</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="comment">// Advance to the next LED in sequence.</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; _currentIndex = (_currentIndex + 1) % _numPins;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; _lastChange += _advanceTime;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <a class="code" href="classChaseLEDs.html#aa0f4e0bd07dd65ee5574e894a612486b" title="Advances to the next LED in sequence, turning off prevPin, and turning on nextPin.">advance</a>(<a class="code" href="classChaseLEDs.html#a27c460fcb341c2dc2fcf9341616eb525" title="Returns the pin that is n steps back in the sequence.">previousPin</a>(1), _pins[_currentIndex]);</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <a class="code" href="classChaseLEDs.html#aa0f4e0bd07dd65ee5574e894a612486b">advance</a>(<a class="code" href="classChaseLEDs.html#a27c460fcb341c2dc2fcf9341616eb525">previousPin</a>(1), _pins[_currentIndex]);</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; }</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="comment">// First time - light the first LED.</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; _currentIndex = 0;</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; _lastChange = millis();</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <a class="code" href="classChaseLEDs.html#aa0f4e0bd07dd65ee5574e894a612486b" title="Advances to the next LED in sequence, turning off prevPin, and turning on nextPin.">advance</a>(<a class="code" href="classChaseLEDs.html#a27c460fcb341c2dc2fcf9341616eb525" title="Returns the pin that is n steps back in the sequence.">previousPin</a>(1), _pins[_currentIndex]);</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <a class="code" href="classChaseLEDs.html#aa0f4e0bd07dd65ee5574e894a612486b">advance</a>(<a class="code" href="classChaseLEDs.html#a27c460fcb341c2dc2fcf9341616eb525">previousPin</a>(1), _pins[_currentIndex]);</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; }</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;}</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;</div>
<div class="line"><a name="l00136"></a><span class="lineno"><a class="code" href="classChaseLEDs.html#aa0f4e0bd07dd65ee5574e894a612486b"> 136</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classChaseLEDs.html#aa0f4e0bd07dd65ee5574e894a612486b" title="Advances to the next LED in sequence, turning off prevPin, and turning on nextPin.">ChaseLEDs::advance</a>(uint8_t prevPin, uint8_t nextPin)</div>
<div class="line"><a name="l00136"></a><span class="lineno"><a class="line" href="classChaseLEDs.html#aa0f4e0bd07dd65ee5574e894a612486b"> 136</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classChaseLEDs.html#aa0f4e0bd07dd65ee5574e894a612486b">ChaseLEDs::advance</a>(uint8_t prevPin, uint8_t nextPin)</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;{</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; digitalWrite(prevPin, LOW);</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; digitalWrite(nextPin, HIGH);</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;}</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;</div>
<div class="ttc" id="classChaseLEDs_html_aa0f4e0bd07dd65ee5574e894a612486b"><div class="ttname"><a href="classChaseLEDs.html#aa0f4e0bd07dd65ee5574e894a612486b">ChaseLEDs::advance</a></div><div class="ttdeci">virtual void advance(uint8_t prevPin, uint8_t nextPin)</div><div class="ttdoc">Advances to the next LED in sequence, turning off prevPin, and turning on nextPin. </div><div class="ttdef"><b>Definition:</b> <a href="ChaseLEDs_8cpp_source.html#l00136">ChaseLEDs.cpp:136</a></div></div>
<div class="ttc" id="classChaseLEDs_html_a27c460fcb341c2dc2fcf9341616eb525"><div class="ttname"><a href="classChaseLEDs.html#a27c460fcb341c2dc2fcf9341616eb525">ChaseLEDs::previousPin</a></div><div class="ttdeci">uint8_t previousPin(int n) const </div><div class="ttdoc">Returns the pin that is n steps back in the sequence. </div><div class="ttdef"><b>Definition:</b> <a href="ChaseLEDs_8h_source.html#l00040">ChaseLEDs.h:40</a></div></div>
<div class="ttc" id="classChaseLEDs_html_a8745fa6b9f33b6c6274a563dd4dea786"><div class="ttname"><a href="classChaseLEDs.html#a8745fa6b9f33b6c6274a563dd4dea786">ChaseLEDs::loop</a></div><div class="ttdeci">void loop()</div><div class="ttdef"><b>Definition:</b> <a href="ChaseLEDs_8cpp_source.html#l00087">ChaseLEDs.cpp:87</a></div></div>
<div class="ttc" id="classChaseLEDs_html_ab6bb3da371d3730a6552e93a9b2eab78"><div class="ttname"><a href="classChaseLEDs.html#ab6bb3da371d3730a6552e93a9b2eab78">ChaseLEDs::ChaseLEDs</a></div><div class="ttdeci">ChaseLEDs(const uint8_t *pins, int num, unsigned long advanceTime)</div><div class="ttdoc">Initializes the LED chaser. </div><div class="ttdef"><b>Definition:</b> <a href="ChaseLEDs_8cpp_source.html#l00071">ChaseLEDs.cpp:71</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>