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

38
BlinkLED_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: BlinkLED.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,23 +115,23 @@ 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="classBlinkLED.html"> 28</a></span>&#160;<span class="keyword">class </span><a class="code" href="classBlinkLED.html" title="Blink a LED on a digital output pin.">BlinkLED</a></div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="classBlinkLED.html"> 28</a></span>&#160;<span class="keyword">class </span><a class="code" href="classBlinkLED.html">BlinkLED</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="classBlinkLED.html#afc33958651e7ce6dceb428ea654c2c2f" title="Initialize a blinking LED on the specified pin.">BlinkLED</a>(uint8_t pin, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classBlinkLED.html#a8475f78f41d1a2d5d719bec8cbbb3ebb" title="Returns the number of milliseconds the LED will be on.">onTime</a>, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classBlinkLED.html#a74c640edf1a9f6e8bea1e139462908bc" title="Returns the number of milliseconds the LED will be off.">offTime</a>, <span class="keywordtype">bool</span> initialState = <span class="keyword">false</span>);</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <a class="code" href="classBlinkLED.html#afc33958651e7ce6dceb428ea654c2c2f">BlinkLED</a>(uint8_t pin, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classBlinkLED.html#a8475f78f41d1a2d5d719bec8cbbb3ebb">onTime</a>, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classBlinkLED.html#a74c640edf1a9f6e8bea1e139462908bc">offTime</a>, <span class="keywordtype">bool</span> initialState = <span class="keyword">false</span>);</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classBlinkLED.html#aeeaf42b94c5392935f00f0f12a58c75e">loop</a>();</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;</div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="code" href="classBlinkLED.html#a8475f78f41d1a2d5d719bec8cbbb3ebb"> 35</a></span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classBlinkLED.html#a8475f78f41d1a2d5d719bec8cbbb3ebb" title="Returns the number of milliseconds the LED will be on.">onTime</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _onTime; }</div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="code" href="classBlinkLED.html#a74c640edf1a9f6e8bea1e139462908bc"> 36</a></span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classBlinkLED.html#a74c640edf1a9f6e8bea1e139462908bc" title="Returns the number of milliseconds the LED will be off.">offTime</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _offTime; }</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classBlinkLED.html#a47f95624881063aa91c0066ed2c92258" title="Sets the onTime and offTime (in milliseconds).">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="l00035"></a><span class="lineno"><a class="line" href="classBlinkLED.html#a8475f78f41d1a2d5d719bec8cbbb3ebb"> 35</a></span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classBlinkLED.html#a8475f78f41d1a2d5d719bec8cbbb3ebb">onTime</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _onTime; }</div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classBlinkLED.html#a74c640edf1a9f6e8bea1e139462908bc"> 36</a></span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classBlinkLED.html#a74c640edf1a9f6e8bea1e139462908bc">offTime</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _offTime; }</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classBlinkLED.html#a47f95624881063aa91c0066ed2c92258">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="l00038"></a><span class="lineno"> 38</span>&#160;</div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="code" href="classBlinkLED.html#ab89b5b3435998ea6699d4bf94866e233"> 39</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classBlinkLED.html#ab89b5b3435998ea6699d4bf94866e233" title="Returns the current state of the LED; true is on, false is off.">state</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _state; }</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</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.">setState</a>(<span class="keywordtype">bool</span> <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="l00039"></a><span class="lineno"><a class="line" href="classBlinkLED.html#ab89b5b3435998ea6699d4bf94866e233"> 39</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classBlinkLED.html#ab89b5b3435998ea6699d4bf94866e233">state</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _state; }</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classBlinkLED.html#af904a345e56d49948a042ac439d0b9d4">setState</a>(<span class="keywordtype">bool</span> <a class="code" href="classBlinkLED.html#ab89b5b3435998ea6699d4bf94866e233">state</a>);</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="classBlinkLED.html#a2760a0223cd6a0598b961f681ffb5c0a"> 42</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classBlinkLED.html#a2760a0223cd6a0598b961f681ffb5c0a" title="Pauses the LED blink cycle in its current state().">pause</a>() { _paused = <span class="keyword">true</span>; }</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classBlinkLED.html#a380241e4dfd20e8a558487227f2f4252" title="Resumes the LED blink cycle after a pause().">resume</a>();</div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="code" href="classBlinkLED.html#aa0ee318b886b84fb71d5831fa456ecc8"> 44</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classBlinkLED.html#aa0ee318b886b84fb71d5831fa456ecc8" title="Returns true if the LED blink cycle is paused; false otherwise.">isPaused</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _paused; }</div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classBlinkLED.html#a2760a0223cd6a0598b961f681ffb5c0a"> 42</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classBlinkLED.html#a2760a0223cd6a0598b961f681ffb5c0a">pause</a>() { _paused = <span class="keyword">true</span>; }</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classBlinkLED.html#a380241e4dfd20e8a558487227f2f4252">resume</a>();</div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classBlinkLED.html#aa0ee318b886b84fb71d5831fa456ecc8"> 44</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classBlinkLED.html#aa0ee318b886b84fb71d5831fa456ecc8">isPaused</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _paused; }</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; uint8_t _pin;</div>
@@ -142,12 +143,23 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;};</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="preprocessor">#endif</span></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_a2760a0223cd6a0598b961f681ffb5c0a"><div class="ttname"><a href="classBlinkLED.html#a2760a0223cd6a0598b961f681ffb5c0a">BlinkLED::pause</a></div><div class="ttdeci">void pause()</div><div class="ttdoc">Pauses the LED blink cycle in its current state(). </div><div class="ttdef"><b>Definition:</b> <a href="BlinkLED_8h_source.html#l00042">BlinkLED.h:42</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"><div class="ttname"><a href="classBlinkLED.html">BlinkLED</a></div><div class="ttdoc">Blink a LED on a digital output pin. </div><div class="ttdef"><b>Definition:</b> <a href="BlinkLED_8h_source.html#l00028">BlinkLED.h:28</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 class="ttc" id="classBlinkLED_html_aa0ee318b886b84fb71d5831fa456ecc8"><div class="ttname"><a href="classBlinkLED.html#aa0ee318b886b84fb71d5831fa456ecc8">BlinkLED::isPaused</a></div><div class="ttdeci">bool isPaused() const </div><div class="ttdoc">Returns true if the LED blink cycle is paused; false otherwise. </div><div class="ttdef"><b>Definition:</b> <a href="BlinkLED_8h_source.html#l00044">BlinkLED.h:44</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>