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

31
BlinkLED_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: BlinkLED.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="l00064"></a><span class="lineno"><a class="code" href="classBlinkLED.html#afc33958651e7ce6dceb428ea654c2c2f"> 64</a></span>&#160;<a class="code" href="classBlinkLED.html#afc33958651e7ce6dceb428ea654c2c2f" title="Initialize a blinking LED on the specified pin.">BlinkLED::BlinkLED</a>(uint8_t pin, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> onTime, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> offTime, <span class="keywordtype">bool</span> initialState)</div>
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="classBlinkLED.html#afc33958651e7ce6dceb428ea654c2c2f"> 64</a></span>&#160;<a class="code" href="classBlinkLED.html#afc33958651e7ce6dceb428ea654c2c2f">BlinkLED::BlinkLED</a>(uint8_t pin, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> onTime, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> offTime, <span class="keywordtype">bool</span> initialState)</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; : _pin(pin)</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; , _state(initialState)</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; , _paused(false)</div>
@@ -128,7 +129,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; _lastChange = millis();</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;}</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;</div>
<div class="line"><a name="l00079"></a><span class="lineno"><a class="code" href="classBlinkLED.html#aeeaf42b94c5392935f00f0f12a58c75e"> 79</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classBlinkLED.html#aeeaf42b94c5392935f00f0f12a58c75e">BlinkLED::loop</a>()</div>
<div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="classBlinkLED.html#aeeaf42b94c5392935f00f0f12a58c75e"> 79</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classBlinkLED.html#aeeaf42b94c5392935f00f0f12a58c75e">BlinkLED::loop</a>()</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;{</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keywordflow">if</span> (_paused)</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keywordflow">return</span>;</div>
@@ -148,22 +149,22 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; }</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;}</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;</div>
<div class="line"><a name="l00122"></a><span class="lineno"><a class="code" href="classBlinkLED.html#a47f95624881063aa91c0066ed2c92258"> 122</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classBlinkLED.html#a47f95624881063aa91c0066ed2c92258" title="Sets the onTime and offTime (in milliseconds).">BlinkLED::setBlinkRate</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> onTime, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> offTime)</div>
<div class="line"><a name="l00122"></a><span class="lineno"><a class="line" href="classBlinkLED.html#a47f95624881063aa91c0066ed2c92258"> 122</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classBlinkLED.html#a47f95624881063aa91c0066ed2c92258">BlinkLED::setBlinkRate</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> onTime, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> offTime)</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;{</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; _onTime = <a class="code" href="classBlinkLED.html#a8475f78f41d1a2d5d719bec8cbbb3ebb" title="Returns the number of milliseconds the LED will be on.">onTime</a>;</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; _offTime = <a class="code" href="classBlinkLED.html#a74c640edf1a9f6e8bea1e139462908bc" title="Returns the number of milliseconds the LED will be off.">offTime</a>;</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; _onTime = <a class="code" href="classBlinkLED.html#a8475f78f41d1a2d5d719bec8cbbb3ebb">onTime</a>;</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; _offTime = <a class="code" href="classBlinkLED.html#a74c640edf1a9f6e8bea1e139462908bc">offTime</a>;</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;}</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;</div>
<div class="line"><a name="l00145"></a><span class="lineno"><a class="code" href="classBlinkLED.html#af904a345e56d49948a042ac439d0b9d4"> 145</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classBlinkLED.html#af904a345e56d49948a042ac439d0b9d4" title="Sets the current state of the LED, where true is on, false is off.">BlinkLED::setState</a>(<span class="keywordtype">bool</span> state)</div>
<div class="line"><a name="l00145"></a><span class="lineno"><a class="line" href="classBlinkLED.html#af904a345e56d49948a042ac439d0b9d4"> 145</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classBlinkLED.html#af904a345e56d49948a042ac439d0b9d4">BlinkLED::setState</a>(<span class="keywordtype">bool</span> state)</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160;{</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; <span class="keywordflow">if</span> (_state != state) {</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; digitalWrite(_pin, state ? HIGH : LOW);</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; _state = <a class="code" href="classBlinkLED.html#ab89b5b3435998ea6699d4bf94866e233" title="Returns the current state of the LED; true is on, false is off.">state</a>;</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; _state = <a class="code" href="classBlinkLED.html#ab89b5b3435998ea6699d4bf94866e233">state</a>;</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; _lastChange = millis();</div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; }</div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160;}</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160;</div>
<div class="line"><a name="l00170"></a><span class="lineno"><a class="code" href="classBlinkLED.html#a380241e4dfd20e8a558487227f2f4252"> 170</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classBlinkLED.html#a380241e4dfd20e8a558487227f2f4252" title="Resumes the LED blink cycle after a pause().">BlinkLED::resume</a>()</div>
<div class="line"><a name="l00170"></a><span class="lineno"><a class="line" href="classBlinkLED.html#a380241e4dfd20e8a558487227f2f4252"> 170</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classBlinkLED.html#a380241e4dfd20e8a558487227f2f4252">BlinkLED::resume</a>()</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160;{</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160; <span class="keywordflow">if</span> (_paused) {</div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160; _paused = <span class="keyword">false</span>;</div>
@@ -184,12 +185,20 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160; }</div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160;}</div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160;</div>
<div class="ttc" id="classBlinkLED_html_a380241e4dfd20e8a558487227f2f4252"><div class="ttname"><a href="classBlinkLED.html#a380241e4dfd20e8a558487227f2f4252">BlinkLED::resume</a></div><div class="ttdeci">void resume()</div><div class="ttdoc">Resumes the LED blink cycle after a pause(). </div><div class="ttdef"><b>Definition:</b> <a href="BlinkLED_8cpp_source.html#l00170">BlinkLED.cpp:170</a></div></div>
<div class="ttc" id="classBlinkLED_html_aeeaf42b94c5392935f00f0f12a58c75e"><div class="ttname"><a href="classBlinkLED.html#aeeaf42b94c5392935f00f0f12a58c75e">BlinkLED::loop</a></div><div class="ttdeci">void loop()</div><div class="ttdef"><b>Definition:</b> <a href="BlinkLED_8cpp_source.html#l00079">BlinkLED.cpp:79</a></div></div>
<div class="ttc" id="classBlinkLED_html_a74c640edf1a9f6e8bea1e139462908bc"><div class="ttname"><a href="classBlinkLED.html#a74c640edf1a9f6e8bea1e139462908bc">BlinkLED::offTime</a></div><div class="ttdeci">unsigned long offTime() const </div><div class="ttdoc">Returns the number of milliseconds the LED will be off. </div><div class="ttdef"><b>Definition:</b> <a href="BlinkLED_8h_source.html#l00036">BlinkLED.h:36</a></div></div>
<div class="ttc" id="classBlinkLED_html_af904a345e56d49948a042ac439d0b9d4"><div class="ttname"><a href="classBlinkLED.html#af904a345e56d49948a042ac439d0b9d4">BlinkLED::setState</a></div><div class="ttdeci">void setState(bool state)</div><div class="ttdoc">Sets the current state of the LED, where true is on, false is off. </div><div class="ttdef"><b>Definition:</b> <a href="BlinkLED_8cpp_source.html#l00145">BlinkLED.cpp:145</a></div></div>
<div class="ttc" id="classBlinkLED_html_a47f95624881063aa91c0066ed2c92258"><div class="ttname"><a href="classBlinkLED.html#a47f95624881063aa91c0066ed2c92258">BlinkLED::setBlinkRate</a></div><div class="ttdeci">void setBlinkRate(unsigned long onTime, unsigned long offTime)</div><div class="ttdoc">Sets the onTime and offTime (in milliseconds). </div><div class="ttdef"><b>Definition:</b> <a href="BlinkLED_8cpp_source.html#l00122">BlinkLED.cpp:122</a></div></div>
<div class="ttc" id="classBlinkLED_html_ab89b5b3435998ea6699d4bf94866e233"><div class="ttname"><a href="classBlinkLED.html#ab89b5b3435998ea6699d4bf94866e233">BlinkLED::state</a></div><div class="ttdeci">bool state() const </div><div class="ttdoc">Returns the current state of the LED; true is on, false is off. </div><div class="ttdef"><b>Definition:</b> <a href="BlinkLED_8h_source.html#l00039">BlinkLED.h:39</a></div></div>
<div class="ttc" id="classBlinkLED_html_a8475f78f41d1a2d5d719bec8cbbb3ebb"><div class="ttname"><a href="classBlinkLED.html#a8475f78f41d1a2d5d719bec8cbbb3ebb">BlinkLED::onTime</a></div><div class="ttdeci">unsigned long onTime() const </div><div class="ttdoc">Returns the number of milliseconds the LED will be on. </div><div class="ttdef"><b>Definition:</b> <a href="BlinkLED_8h_source.html#l00035">BlinkLED.h:35</a></div></div>
<div class="ttc" id="classBlinkLED_html_afc33958651e7ce6dceb428ea654c2c2f"><div class="ttname"><a href="classBlinkLED.html#afc33958651e7ce6dceb428ea654c2c2f">BlinkLED::BlinkLED</a></div><div class="ttdeci">BlinkLED(uint8_t pin, unsigned long onTime, unsigned long offTime, bool initialState=false)</div><div class="ttdoc">Initialize a blinking LED on the specified pin. </div><div class="ttdef"><b>Definition:</b> <a href="BlinkLED_8cpp_source.html#l00064">BlinkLED.cpp:64</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>