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

43
Charlieplex_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: Charlieplex.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,25 +115,25 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor"></span></div>
<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;</div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="code" href="classCharlieplex.html"> 28</a></span>&#160;<span class="keyword">class </span><a class="code" href="classCharlieplex.html" title="Manage an array of LED&#39;s in a charlieplexed arrangement.">Charlieplex</a></div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="classCharlieplex.html"> 28</a></span>&#160;<span class="keyword">class </span><a class="code" href="classCharlieplex.html">Charlieplex</a></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;{</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</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</a>(<span class="keyword">const</span> uint8_t *pins, uint8_t numPins);</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <a class="code" href="classCharlieplex.html#a4dbe37ccba8ba18139f4e710afdcd103" title="Destroys this charlieplexed array.">~Charlieplex</a>();</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <a class="code" href="classCharlieplex.html#abfb0d0456bcbadbf60c21f615adacdbd">Charlieplex</a>(<span class="keyword">const</span> uint8_t *pins, uint8_t numPins);</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <a class="code" href="classCharlieplex.html#a4dbe37ccba8ba18139f4e710afdcd103">~Charlieplex</a>();</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="classCharlieplex.html#a5008aa4143d381ce34a3aed1a3843e4e"> 34</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="classCharlieplex.html#a5008aa4143d381ce34a3aed1a3843e4e" title="Returns the number of LED&#39;s in this charlieplexed array based on the number of pins.">count</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _count; }</div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classCharlieplex.html#a5008aa4143d381ce34a3aed1a3843e4e"> 34</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="classCharlieplex.html#a5008aa4143d381ce34a3aed1a3843e4e">count</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _count; }</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"><a class="code" href="classCharlieplex.html#a90fd09f24b62424b0b7b8bcdb0140b9d"> 36</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classCharlieplex.html#a90fd09f24b62424b0b7b8bcdb0140b9d" title="Returns the value of the LED at index in the charplexed array; true if lit; false if not lit...">led</a>(<span class="keywordtype">int</span> index)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _values[index] != 0; }</div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="code" href="classCharlieplex.html#ab103c9687a0890faf72e4da79e3de0a5"> 37</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classCharlieplex.html#ab103c9687a0890faf72e4da79e3de0a5" title="Sets the value of the LED at index in the charliplexed array.">setLed</a>(<span class="keywordtype">int</span> index, <span class="keywordtype">bool</span> value) { _values[index] = (value ? 255 : 0); }</div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classCharlieplex.html#a90fd09f24b62424b0b7b8bcdb0140b9d"> 36</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classCharlieplex.html#a90fd09f24b62424b0b7b8bcdb0140b9d">led</a>(<span class="keywordtype">int</span> index)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _values[index] != 0; }</div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classCharlieplex.html#ab103c9687a0890faf72e4da79e3de0a5"> 37</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classCharlieplex.html#ab103c9687a0890faf72e4da79e3de0a5">setLed</a>(<span class="keywordtype">int</span> index, <span class="keywordtype">bool</span> value) { _values[index] = (value ? 255 : 0); }</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="classCharlieplex.html#a89312f2fd1d27c4e56346ed9cccfb9f6"> 39</a></span>&#160; uint8_t <a class="code" href="classCharlieplex.html#a89312f2fd1d27c4e56346ed9cccfb9f6" title="Returns the PWM value of the LED at index in the charplexed array; between 0 and 255.">pwmLed</a>(<span class="keywordtype">int</span> index)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _values[index]; }</div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="code" href="classCharlieplex.html#a605a302e13005a1aa3d68d0e22bc474b"> 40</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classCharlieplex.html#a605a302e13005a1aa3d68d0e22bc474b" title="Sets the PWM value of the LED at index in the charliplexed array; between 0 and 255.">setPwmLed</a>(<span class="keywordtype">int</span> index, uint8_t value) { _values[index] = value; }</div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classCharlieplex.html#a89312f2fd1d27c4e56346ed9cccfb9f6"> 39</a></span>&#160; uint8_t <a class="code" href="classCharlieplex.html#a89312f2fd1d27c4e56346ed9cccfb9f6">pwmLed</a>(<span class="keywordtype">int</span> index)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _values[index]; }</div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classCharlieplex.html#a605a302e13005a1aa3d68d0e22bc474b"> 40</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classCharlieplex.html#a605a302e13005a1aa3d68d0e22bc474b">setPwmLed</a>(<span class="keywordtype">int</span> index, uint8_t value) { _values[index] = value; }</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"><a class="code" href="classCharlieplex.html#abb429659a7b1ee4c7306ea659050cb30"> 42</a></span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classCharlieplex.html#abb429659a7b1ee4c7306ea659050cb30" title="Returns the number of microseconds that each LED should be held on for before moving onto the next in...">holdTime</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _holdTime; }</div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="code" href="classCharlieplex.html#a8502f4c752faba37023ced587695f6a4"> 43</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classCharlieplex.html#a8502f4c752faba37023ced587695f6a4" title="Sets the number of microseconds that each LED should be held on for before moving onto the next in lo...">setHoldTime</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> us) { _holdTime = us; }</div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classCharlieplex.html#abb429659a7b1ee4c7306ea659050cb30"> 42</a></span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classCharlieplex.html#abb429659a7b1ee4c7306ea659050cb30">holdTime</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _holdTime; }</div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classCharlieplex.html#a8502f4c752faba37023ced587695f6a4"> 43</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classCharlieplex.html#a8502f4c752faba37023ced587695f6a4">setHoldTime</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> us) { _holdTime = us; }</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</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.">loop</a>();</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</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.">refresh</a>();</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classCharlieplex.html#a8313edeacd8387c428b8299d52584d6a">loop</a>();</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classCharlieplex.html#a3c961bfff866e400dad371f0376f096b">refresh</a>();</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordtype">int</span> _count;</div>
@@ -146,12 +147,24 @@ 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="classCharlieplex_html_a605a302e13005a1aa3d68d0e22bc474b"><div class="ttname"><a href="classCharlieplex.html#a605a302e13005a1aa3d68d0e22bc474b">Charlieplex::setPwmLed</a></div><div class="ttdeci">void setPwmLed(int index, uint8_t value)</div><div class="ttdoc">Sets the PWM value of the LED at index in the charliplexed array; between 0 and 255. </div><div class="ttdef"><b>Definition:</b> <a href="Charlieplex_8h_source.html#l00040">Charlieplex.h:40</a></div></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_a8502f4c752faba37023ced587695f6a4"><div class="ttname"><a href="classCharlieplex.html#a8502f4c752faba37023ced587695f6a4">Charlieplex::setHoldTime</a></div><div class="ttdeci">void setHoldTime(unsigned long us)</div><div class="ttdoc">Sets the number of microseconds that each LED should be held on for before moving onto the next in lo...</div><div class="ttdef"><b>Definition:</b> <a href="Charlieplex_8h_source.html#l00043">Charlieplex.h:43</a></div></div>
<div class="ttc" id="classCharlieplex_html"><div class="ttname"><a href="classCharlieplex.html">Charlieplex</a></div><div class="ttdoc">Manage an array of LED&#39;s in a charlieplexed arrangement. </div><div class="ttdef"><b>Definition:</b> <a href="Charlieplex_8h_source.html#l00028">Charlieplex.h:28</a></div></div>
<div class="ttc" id="classCharlieplex_html_ab103c9687a0890faf72e4da79e3de0a5"><div class="ttname"><a href="classCharlieplex.html#ab103c9687a0890faf72e4da79e3de0a5">Charlieplex::setLed</a></div><div class="ttdeci">void setLed(int index, bool value)</div><div class="ttdoc">Sets the value of the LED at index in the charliplexed array. </div><div class="ttdef"><b>Definition:</b> <a href="Charlieplex_8h_source.html#l00037">Charlieplex.h:37</a></div></div>
<div class="ttc" id="classCharlieplex_html_a90fd09f24b62424b0b7b8bcdb0140b9d"><div class="ttname"><a href="classCharlieplex.html#a90fd09f24b62424b0b7b8bcdb0140b9d">Charlieplex::led</a></div><div class="ttdeci">bool led(int index) const </div><div class="ttdoc">Returns the value of the LED at index in the charplexed array; true if lit; false if not lit...</div><div class="ttdef"><b>Definition:</b> <a href="Charlieplex_8h_source.html#l00036">Charlieplex.h:36</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_a5008aa4143d381ce34a3aed1a3843e4e"><div class="ttname"><a href="classCharlieplex.html#a5008aa4143d381ce34a3aed1a3843e4e">Charlieplex::count</a></div><div class="ttdeci">int count() const </div><div class="ttdoc">Returns the number of LED&#39;s in this charlieplexed array based on the number of pins. </div><div class="ttdef"><b>Definition:</b> <a href="Charlieplex_8h_source.html#l00034">Charlieplex.h:34</a></div></div>
<div class="ttc" id="classCharlieplex_html_abb429659a7b1ee4c7306ea659050cb30"><div class="ttname"><a href="classCharlieplex.html#abb429659a7b1ee4c7306ea659050cb30">Charlieplex::holdTime</a></div><div class="ttdeci">unsigned long holdTime() const </div><div class="ttdoc">Returns the number of microseconds that each LED should be held on for before moving onto the next in...</div><div class="ttdef"><b>Definition:</b> <a href="Charlieplex_8h_source.html#l00042">Charlieplex.h:42</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 class="ttc" id="classCharlieplex_html_a89312f2fd1d27c4e56346ed9cccfb9f6"><div class="ttname"><a href="classCharlieplex.html#a89312f2fd1d27c4e56346ed9cccfb9f6">Charlieplex::pwmLed</a></div><div class="ttdeci">uint8_t pwmLed(int index) const </div><div class="ttdoc">Returns the PWM value of the LED at index in the charplexed array; between 0 and 255. </div><div class="ttdef"><b>Definition:</b> <a href="Charlieplex_8h_source.html#l00039">Charlieplex.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>