mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
166 lines
20 KiB
HTML
166 lines
20 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: BlinkLED.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">BlinkLED.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 BlinkLED_h</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"></span><span class="preprocessor">#define BlinkLED_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="classBlinkLED.html"> 28</a></span> <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> {</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="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> </div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <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> </div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classBlinkLED.html#a8475f78f41d1a2d5d719bec8cbbb3ebb"> 35</a></span>  <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>  <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>  <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> </div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classBlinkLED.html#ab89b5b3435998ea6699d4bf94866e233"> 39</a></span>  <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>  <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> </div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classBlinkLED.html#a2760a0223cd6a0598b961f681ffb5c0a"> 42</a></span>  <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>  <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>  <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> </div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  uint8_t _pin;</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordtype">bool</span> _state;</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordtype">bool</span> _paused;</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> _onTime;</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> _offTime;</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> _lastChange;</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> };</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <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 Sat Aug 27 2016 14:32:20 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>
|