mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
171 lines
21 KiB
HTML
171 lines
21 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<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>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">ArduinoLibs
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.6 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_bc0718b08fb2015b8e59c47b2805f60c.html">libraries</a></li><li class="navelem"><a class="el" href="dir_1586d320a3b1e622174530fde769cda9.html">BlinkLED</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Charlieplex.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (C) 2012 Southern Storm Software, Pty Ltd.</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * copy of this software and associated documentation files (the "Software"),</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * to deal in the Software without restriction, including without limitation</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * the rights to use, copy, modify, merge, publish, distribute, sublicense,</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * and/or sell copies of the Software, and to permit persons to whom the</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * Software is furnished to do so, subject to the following conditions:</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * The above copyright notice and this permission notice shall be included</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * in all copies or substantial portions of the Software.</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * DEALINGS IN THE SOFTWARE.</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#ifndef Charlieplex_h</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"></span><span class="preprocessor">#define Charlieplex_h</span></div>
|
|
<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="line" href="classCharlieplex.html"> 28</a></span> <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> {</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="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>  <a class="code" href="classCharlieplex.html#a4dbe37ccba8ba18139f4e710afdcd103">~Charlieplex</a>();</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classCharlieplex.html#a5008aa4143d381ce34a3aed1a3843e4e"> 34</a></span>  <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> </div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classCharlieplex.html#a90fd09f24b62424b0b7b8bcdb0140b9d"> 36</a></span>  <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>  <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> </div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classCharlieplex.html#a89312f2fd1d27c4e56346ed9cccfb9f6"> 39</a></span>  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>  <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> </div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classCharlieplex.html#abb429659a7b1ee4c7306ea659050cb30"> 42</a></span>  <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>  <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> </div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <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>  <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> </div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordtype">int</span> _count;</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  uint8_t *_pins1;</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  uint8_t *_pins2;</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  uint8_t *_values;</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> _holdTime;</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> _lastTime;</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">int</span> _currentIndex;</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  uint8_t _pwmPhase;</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> };</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <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'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'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 Mon Apr 2 2018 18:36:52 for ArduinoLibs by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.6
|
|
</small></address>
|
|
</body>
|
|
</html>
|