mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
Update docs
This commit is contained in:
Rhys Weatherley
@@ -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.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>
|
||||
@@ -114,19 +115,19 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"></span></div>
|
||||
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <inttypes.h></span></div>
|
||||
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div>
|
||||
<div class="line"><a name="l00028"></a><span class="lineno"><a class="code" href="classChaseLEDs.html"> 28</a></span> <span class="keyword">class </span><a class="code" href="classChaseLEDs.html" title="Chase LED's on output pins in a defined sequence.">ChaseLEDs</a></div>
|
||||
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="classChaseLEDs.html"> 28</a></span> <span class="keyword">class </span><a class="code" href="classChaseLEDs.html">ChaseLEDs</a></div>
|
||||
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> {</div>
|
||||
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">public</span>:</div>
|
||||
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <a class="code" href="classChaseLEDs.html#ab6bb3da371d3730a6552e93a9b2eab78" title="Initializes the LED chaser.">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> <a class="code" href="classChaseLEDs.html#aed060c51bb63dd8065be89f895989700" title="Returns the number of milliseconds that each LED will be lit in the chase sequence.">advanceTime</a>);</div>
|
||||
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <a class="code" href="classChaseLEDs.html#ab6bb3da371d3730a6552e93a9b2eab78">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> <a class="code" href="classChaseLEDs.html#aed060c51bb63dd8065be89f895989700">advanceTime</a>);</div>
|
||||
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
|
||||
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordtype">void</span> <a class="code" href="classChaseLEDs.html#a8745fa6b9f33b6c6274a563dd4dea786">loop</a>();</div>
|
||||
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
|
||||
<div class="line"><a name="l00035"></a><span class="lineno"><a class="code" href="classChaseLEDs.html#aed060c51bb63dd8065be89f895989700"> 35</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classChaseLEDs.html#aed060c51bb63dd8065be89f895989700" title="Returns the number of milliseconds that each LED will be lit in the chase sequence.">advanceTime</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _advanceTime; }</div>
|
||||
<div class="line"><a name="l00036"></a><span class="lineno"><a class="code" href="classChaseLEDs.html#af560270f72302c19fb7f95002089c9d7"> 36</a></span>  <span class="keywordtype">void</span> <a class="code" href="classChaseLEDs.html#af560270f72302c19fb7f95002089c9d7" title="Sets the number of milliseconds to advance between LED's to advanceTime.">setAdvanceTime</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> advanceTime) { _advanceTime = <a class="code" href="classChaseLEDs.html#aed060c51bb63dd8065be89f895989700" title="Returns the number of milliseconds that each LED will be lit in the chase sequence.">advanceTime</a>; }</div>
|
||||
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classChaseLEDs.html#aed060c51bb63dd8065be89f895989700"> 35</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classChaseLEDs.html#aed060c51bb63dd8065be89f895989700">advanceTime</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _advanceTime; }</div>
|
||||
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classChaseLEDs.html#af560270f72302c19fb7f95002089c9d7"> 36</a></span>  <span class="keywordtype">void</span> <a class="code" href="classChaseLEDs.html#af560270f72302c19fb7f95002089c9d7">setAdvanceTime</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> advanceTime) { _advanceTime = <a class="code" href="classChaseLEDs.html#aed060c51bb63dd8065be89f895989700">advanceTime</a>; }</div>
|
||||
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div>
|
||||
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">protected</span>:</div>
|
||||
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">virtual</span> <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.">advance</a>(uint8_t prevPin, uint8_t nextPin);</div>
|
||||
<div class="line"><a name="l00040"></a><span class="lineno"><a class="code" href="classChaseLEDs.html#a27c460fcb341c2dc2fcf9341616eb525"> 40</a></span>  uint8_t <a class="code" href="classChaseLEDs.html#a27c460fcb341c2dc2fcf9341616eb525" title="Returns the pin that is n steps back in the sequence.">previousPin</a>(<span class="keywordtype">int</span> n)<span class="keyword"> const</span></div>
|
||||
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classChaseLEDs.html#aa0f4e0bd07dd65ee5574e894a612486b">advance</a>(uint8_t prevPin, uint8_t nextPin);</div>
|
||||
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classChaseLEDs.html#a27c460fcb341c2dc2fcf9341616eb525"> 40</a></span>  uint8_t <a class="code" href="classChaseLEDs.html#a27c460fcb341c2dc2fcf9341616eb525">previousPin</a>(<span class="keywordtype">int</span> n)<span class="keyword"> const</span></div>
|
||||
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword"> </span>{ <span class="keywordflow">return</span> _pins[(_currentIndex + _numPins - n) % _numPins]; }</div>
|
||||
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div>
|
||||
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">private</span>:</div>
|
||||
@@ -138,12 +139,19 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> };</div>
|
||||
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div>
|
||||
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor">#endif</span></div>
|
||||
<div class="ttc" id="classChaseLEDs_html_aed060c51bb63dd8065be89f895989700"><div class="ttname"><a href="classChaseLEDs.html#aed060c51bb63dd8065be89f895989700">ChaseLEDs::advanceTime</a></div><div class="ttdeci">unsigned long advanceTime() const </div><div class="ttdoc">Returns the number of milliseconds that each LED will be lit in the chase sequence. </div><div class="ttdef"><b>Definition:</b> <a href="ChaseLEDs_8h_source.html#l00035">ChaseLEDs.h:35</a></div></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"><div class="ttname"><a href="classChaseLEDs.html">ChaseLEDs</a></div><div class="ttdoc">Chase LED's on output pins in a defined sequence. </div><div class="ttdef"><b>Definition:</b> <a href="ChaseLEDs_8h_source.html#l00028">ChaseLEDs.h:28</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 class="ttc" id="classChaseLEDs_html_af560270f72302c19fb7f95002089c9d7"><div class="ttname"><a href="classChaseLEDs.html#af560270f72302c19fb7f95002089c9d7">ChaseLEDs::setAdvanceTime</a></div><div class="ttdeci">void setAdvanceTime(unsigned long advanceTime)</div><div class="ttdoc">Sets the number of milliseconds to advance between LED's to advanceTime. </div><div class="ttdef"><b>Definition:</b> <a href="ChaseLEDs_8h_source.html#l00036">ChaseLEDs.h:36</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  <a href="http://www.doxygen.org/index.html">
|
||||
Generated on Thu Mar 12 2015 19:02:05 for ArduinoLibs by  <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>
|
||||
|
||||
Reference in New Issue
Block a user