1
0
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
2015-03-12 19:03:15 +10:00
parent 083448f195
commit c6206e4216
493 changed files with 35310 additions and 3018 deletions

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: Charlieplex.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>
@@ -118,7 +119,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#include &lt;stdlib.h&gt;</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#include &lt;string.h&gt;</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div>
<div class="line"><a name="l00121"></a><span class="lineno"><a class="code" href="classCharlieplex.html#abfb0d0456bcbadbf60c21f615adacdbd"> 121</a></span>&#160;<a class="code" href="classCharlieplex.html#abfb0d0456bcbadbf60c21f615adacdbd" title="Constructs a new charliexplexing array where the output pins are specified by the numPins entries in ...">Charlieplex::Charlieplex</a>(<span class="keyword">const</span> uint8_t *pins, uint8_t numPins)</div>
<div class="line"><a name="l00121"></a><span class="lineno"><a class="line" href="classCharlieplex.html#abfb0d0456bcbadbf60c21f615adacdbd"> 121</a></span>&#160;<a class="code" href="classCharlieplex.html#abfb0d0456bcbadbf60c21f615adacdbd">Charlieplex::Charlieplex</a>(<span class="keyword">const</span> uint8_t *pins, uint8_t numPins)</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; : _count(((int)numPins) * (numPins - 1))</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; , _lastTime(micros())</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; , _currentIndex(-1)</div>
@@ -153,23 +154,23 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; }</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160;}</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160;</div>
<div class="line"><a name="l00159"></a><span class="lineno"><a class="code" href="classCharlieplex.html#a4dbe37ccba8ba18139f4e710afdcd103"> 159</a></span>&#160;<a class="code" href="classCharlieplex.html#a4dbe37ccba8ba18139f4e710afdcd103" title="Destroys this charlieplexed array.">Charlieplex::~Charlieplex</a>()</div>
<div class="line"><a name="l00159"></a><span class="lineno"><a class="line" href="classCharlieplex.html#a4dbe37ccba8ba18139f4e710afdcd103"> 159</a></span>&#160;<a class="code" href="classCharlieplex.html#a4dbe37ccba8ba18139f4e710afdcd103">Charlieplex::~Charlieplex</a>()</div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160;{</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; free(_pins1);</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; free(_pins2);</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; free(_values);</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160;}</div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160;</div>
<div class="line"><a name="l00277"></a><span class="lineno"><a class="code" href="classCharlieplex.html#a8313edeacd8387c428b8299d52584d6a"> 277</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classCharlieplex.html#a8313edeacd8387c428b8299d52584d6a" title="Runs the multiplexing loop, to display the LED states on the charlieplexed array.">Charlieplex::loop</a>()</div>
<div class="line"><a name="l00277"></a><span class="lineno"><a class="line" href="classCharlieplex.html#a8313edeacd8387c428b8299d52584d6a"> 277</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classCharlieplex.html#a8313edeacd8387c428b8299d52584d6a">Charlieplex::loop</a>()</div>
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span>&#160;{</div>
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> us = micros();</div>
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span>&#160; <span class="keywordflow">if</span> ((us - _lastTime) &gt;= _holdTime) {</div>
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span>&#160; _lastTime = us;</div>
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span>&#160; <a class="code" href="classCharlieplex.html#a3c961bfff866e400dad371f0376f096b" title="Refreshes the charlieplexed array by advancing to the next LED that needs to be lit.">refresh</a>();</div>
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span>&#160; <a class="code" href="classCharlieplex.html#a3c961bfff866e400dad371f0376f096b">refresh</a>();</div>
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span>&#160; }</div>
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span>&#160;}</div>
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span>&#160;</div>
<div class="line"><a name="l00296"></a><span class="lineno"><a class="code" href="classCharlieplex.html#a3c961bfff866e400dad371f0376f096b"> 296</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classCharlieplex.html#a3c961bfff866e400dad371f0376f096b" title="Refreshes the charlieplexed array by advancing to the next LED that needs to be lit.">Charlieplex::refresh</a>()</div>
<div class="line"><a name="l00296"></a><span class="lineno"><a class="line" href="classCharlieplex.html#a3c961bfff866e400dad371f0376f096b"> 296</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classCharlieplex.html#a3c961bfff866e400dad371f0376f096b">Charlieplex::refresh</a>()</div>
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span>&#160;{</div>
<div class="line"><a name="l00298"></a><span class="lineno"> 298</span>&#160; <span class="comment">// Find the next LED to be lit.</span></div>
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span>&#160; <span class="keywordtype">int</span> prevIndex = _currentIndex;</div>
@@ -224,12 +225,16 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00348"></a><span class="lineno"> 348</span>&#160; analogWrite(pin1, value);</div>
<div class="line"><a name="l00349"></a><span class="lineno"> 349</span>&#160; }</div>
<div class="line"><a name="l00350"></a><span class="lineno"> 350</span>&#160;}</div>
<div class="ttc" id="classCharlieplex_html_a4dbe37ccba8ba18139f4e710afdcd103"><div class="ttname"><a href="classCharlieplex.html#a4dbe37ccba8ba18139f4e710afdcd103">Charlieplex::~Charlieplex</a></div><div class="ttdeci">~Charlieplex()</div><div class="ttdoc">Destroys this charlieplexed array. </div><div class="ttdef"><b>Definition:</b> <a href="Charlieplex_8cpp_source.html#l00159">Charlieplex.cpp:159</a></div></div>
<div class="ttc" id="classCharlieplex_html_abfb0d0456bcbadbf60c21f615adacdbd"><div class="ttname"><a href="classCharlieplex.html#abfb0d0456bcbadbf60c21f615adacdbd">Charlieplex::Charlieplex</a></div><div class="ttdeci">Charlieplex(const uint8_t *pins, uint8_t numPins)</div><div class="ttdoc">Constructs a new charliexplexing array where the output pins are specified by the numPins entries in ...</div><div class="ttdef"><b>Definition:</b> <a href="Charlieplex_8cpp_source.html#l00121">Charlieplex.cpp:121</a></div></div>
<div class="ttc" id="classCharlieplex_html_a8313edeacd8387c428b8299d52584d6a"><div class="ttname"><a href="classCharlieplex.html#a8313edeacd8387c428b8299d52584d6a">Charlieplex::loop</a></div><div class="ttdeci">void loop()</div><div class="ttdoc">Runs the multiplexing loop, to display the LED states on the charlieplexed array. ...</div><div class="ttdef"><b>Definition:</b> <a href="Charlieplex_8cpp_source.html#l00277">Charlieplex.cpp:277</a></div></div>
<div class="ttc" id="classCharlieplex_html_a3c961bfff866e400dad371f0376f096b"><div class="ttname"><a href="classCharlieplex.html#a3c961bfff866e400dad371f0376f096b">Charlieplex::refresh</a></div><div class="ttdeci">void refresh()</div><div class="ttdoc">Refreshes the charlieplexed array by advancing to the next LED that needs to be lit. </div><div class="ttdef"><b>Definition:</b> <a href="Charlieplex_8cpp_source.html#l00296">Charlieplex.cpp:296</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>