mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
181 lines
13 KiB
HTML
181 lines
13 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"/>
|
|
<title>ArduinoLibs: BlinkLED.cpp Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body onload='searchBox.OnSelectItem(0);'>
|
|
<!-- Generated by Doxygen 1.7.4 -->
|
|
<script type="text/javascript"><!--
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
--></script>
|
|
<div id="top">
|
|
<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>
|
|
<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 id="searchli">
|
|
<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>
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">BlinkLED.cpp</div> </div>
|
|
</div>
|
|
<div class="contents">
|
|
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
|
|
<a name="l00002"></a>00002 <span class="comment"> * Copyright (C) 2012 Southern Storm Software, Pty Ltd.</span>
|
|
<a name="l00003"></a>00003 <span class="comment"> *</span>
|
|
<a name="l00004"></a>00004 <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a</span>
|
|
<a name="l00005"></a>00005 <span class="comment"> * copy of this software and associated documentation files (the "Software"),</span>
|
|
<a name="l00006"></a>00006 <span class="comment"> * to deal in the Software without restriction, including without limitation</span>
|
|
<a name="l00007"></a>00007 <span class="comment"> * the rights to use, copy, modify, merge, publish, distribute, sublicense,</span>
|
|
<a name="l00008"></a>00008 <span class="comment"> * and/or sell copies of the Software, and to permit persons to whom the</span>
|
|
<a name="l00009"></a>00009 <span class="comment"> * Software is furnished to do so, subject to the following conditions:</span>
|
|
<a name="l00010"></a>00010 <span class="comment"> *</span>
|
|
<a name="l00011"></a>00011 <span class="comment"> * The above copyright notice and this permission notice shall be included</span>
|
|
<a name="l00012"></a>00012 <span class="comment"> * in all copies or substantial portions of the Software.</span>
|
|
<a name="l00013"></a>00013 <span class="comment"> *</span>
|
|
<a name="l00014"></a>00014 <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS</span>
|
|
<a name="l00015"></a>00015 <span class="comment"> * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
|
|
<a name="l00016"></a>00016 <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
|
|
<a name="l00017"></a>00017 <span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
|
|
<a name="l00018"></a>00018 <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING</span>
|
|
<a name="l00019"></a>00019 <span class="comment"> * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER</span>
|
|
<a name="l00020"></a>00020 <span class="comment"> * DEALINGS IN THE SOFTWARE.</span>
|
|
<a name="l00021"></a>00021 <span class="comment"> */</span>
|
|
<a name="l00022"></a>00022
|
|
<a name="l00023"></a>00023 <span class="preprocessor">#include "BlinkLED.h"</span>
|
|
<a name="l00024"></a>00024 <span class="preprocessor">#if defined(ARDUINO) && ARDUINO >= 100</span>
|
|
<a name="l00025"></a>00025 <span class="preprocessor"></span><span class="preprocessor">#include <Arduino.h></span>
|
|
<a name="l00026"></a>00026 <span class="preprocessor">#else</span>
|
|
<a name="l00027"></a>00027 <span class="preprocessor"></span><span class="preprocessor">#include <WProgram.h></span>
|
|
<a name="l00028"></a>00028 <span class="preprocessor">#endif</span>
|
|
<a name="l00029"></a>00029 <span class="preprocessor"></span>
|
|
<a name="l00064"></a><a class="code" href="classBlinkLED.html#afc33958651e7ce6dceb428ea654c2c2f">00064</a> <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)
|
|
<a name="l00065"></a>00065 : _pin(pin)
|
|
<a name="l00066"></a>00066 , _state(initialState)
|
|
<a name="l00067"></a>00067 , _paused(false)
|
|
<a name="l00068"></a>00068 , _onTime(onTime)
|
|
<a name="l00069"></a>00069 , _offTime(offTime)
|
|
<a name="l00070"></a>00070 {
|
|
<a name="l00071"></a>00071 pinMode(pin, OUTPUT);
|
|
<a name="l00072"></a>00072 digitalWrite(pin, initialState ? HIGH : LOW);
|
|
<a name="l00073"></a>00073 _lastChange = millis();
|
|
<a name="l00074"></a>00074 }
|
|
<a name="l00075"></a>00075
|
|
<a name="l00079"></a><a class="code" href="classBlinkLED.html#aeeaf42b94c5392935f00f0f12a58c75e">00079</a> <span class="keywordtype">void</span> <a class="code" href="classBlinkLED.html#aeeaf42b94c5392935f00f0f12a58c75e">BlinkLED::loop</a>()
|
|
<a name="l00080"></a>00080 {
|
|
<a name="l00081"></a>00081 <span class="keywordflow">if</span> (_paused)
|
|
<a name="l00082"></a>00082 <span class="keywordflow">return</span>;
|
|
<a name="l00083"></a>00083 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> currentTime = millis();
|
|
<a name="l00084"></a>00084 <span class="keywordflow">if</span> (_state) {
|
|
<a name="l00085"></a>00085 <span class="keywordflow">if</span> ((currentTime - _lastChange) >= _onTime) {
|
|
<a name="l00086"></a>00086 digitalWrite(_pin, LOW);
|
|
<a name="l00087"></a>00087 _lastChange += _onTime;
|
|
<a name="l00088"></a>00088 _state = <span class="keyword">false</span>;
|
|
<a name="l00089"></a>00089 }
|
|
<a name="l00090"></a>00090 } <span class="keywordflow">else</span> {
|
|
<a name="l00091"></a>00091 <span class="keywordflow">if</span> ((currentTime - _lastChange) >= _offTime) {
|
|
<a name="l00092"></a>00092 digitalWrite(_pin, HIGH);
|
|
<a name="l00093"></a>00093 _lastChange += _offTime;
|
|
<a name="l00094"></a>00094 _state = <span class="keyword">true</span>;
|
|
<a name="l00095"></a>00095 }
|
|
<a name="l00096"></a>00096 }
|
|
<a name="l00097"></a>00097 }
|
|
<a name="l00098"></a>00098
|
|
<a name="l00122"></a><a class="code" href="classBlinkLED.html#a47f95624881063aa91c0066ed2c92258">00122</a> <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)
|
|
<a name="l00123"></a>00123 {
|
|
<a name="l00124"></a>00124 _onTime = <a class="code" href="classBlinkLED.html#a8475f78f41d1a2d5d719bec8cbbb3ebb" title="Returns the number of milliseconds the LED will be on.">onTime</a>;
|
|
<a name="l00125"></a>00125 _offTime = <a class="code" href="classBlinkLED.html#a74c640edf1a9f6e8bea1e139462908bc" title="Returns the number of milliseconds the LED will be off.">offTime</a>;
|
|
<a name="l00126"></a>00126 }
|
|
<a name="l00127"></a>00127
|
|
<a name="l00145"></a><a class="code" href="classBlinkLED.html#af904a345e56d49948a042ac439d0b9d4">00145</a> <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)
|
|
<a name="l00146"></a>00146 {
|
|
<a name="l00147"></a>00147 <span class="keywordflow">if</span> (_state != state) {
|
|
<a name="l00148"></a>00148 digitalWrite(_pin, state ? HIGH : LOW);
|
|
<a name="l00149"></a>00149 _state = <a class="code" href="classBlinkLED.html#ab89b5b3435998ea6699d4bf94866e233" title="Returns the current state of the LED; true is on, false is off.">state</a>;
|
|
<a name="l00150"></a>00150 _lastChange = millis();
|
|
<a name="l00151"></a>00151 }
|
|
<a name="l00152"></a>00152 }
|
|
<a name="l00153"></a>00153
|
|
<a name="l00170"></a><a class="code" href="classBlinkLED.html#a380241e4dfd20e8a558487227f2f4252">00170</a> <span class="keywordtype">void</span> <a class="code" href="classBlinkLED.html#a380241e4dfd20e8a558487227f2f4252" title="Resumes the LED blink cycle after a pause().">BlinkLED::resume</a>()
|
|
<a name="l00171"></a>00171 {
|
|
<a name="l00172"></a>00172 <span class="keywordflow">if</span> (_paused) {
|
|
<a name="l00173"></a>00173 _paused = <span class="keyword">false</span>;
|
|
<a name="l00174"></a>00174 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> currentTime = millis();
|
|
<a name="l00175"></a>00175 <span class="keywordflow">if</span> (_state) {
|
|
<a name="l00176"></a>00176 <span class="keywordflow">if</span> ((currentTime - _lastChange) >= _onTime) {
|
|
<a name="l00177"></a>00177 digitalWrite(_pin, LOW);
|
|
<a name="l00178"></a>00178 _lastChange = currentTime;
|
|
<a name="l00179"></a>00179 _state = <span class="keyword">false</span>;
|
|
<a name="l00180"></a>00180 }
|
|
<a name="l00181"></a>00181 } <span class="keywordflow">else</span> {
|
|
<a name="l00182"></a>00182 <span class="keywordflow">if</span> ((currentTime - _lastChange) >= _offTime) {
|
|
<a name="l00183"></a>00183 digitalWrite(_pin, HIGH);
|
|
<a name="l00184"></a>00184 _lastChange = currentTime;
|
|
<a name="l00185"></a>00185 _state = <span class="keyword">true</span>;
|
|
<a name="l00186"></a>00186 }
|
|
<a name="l00187"></a>00187 }
|
|
<a name="l00188"></a>00188 }
|
|
<a name="l00189"></a>00189 }
|
|
<a name="l00190"></a>00190
|
|
</pre></div></div>
|
|
</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>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</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>
|
|
|
|
<hr class="footer"/><address class="footer"><small>Generated on Mon May 28 2012 20:55:50 for ArduinoLibs by 
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
|
|
</body>
|
|
</html>
|