parent
2c5ad1c350
commit
f73c9090ec
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@ -1,97 +1,207 @@ |
||||
# BOUNCE 2 |
||||
|
||||
Debouncing library for Arduino and Wiring by Thomas Ouellet Fredericks with contributions from: Eric Lowry, Jim Schimpf, Tom Harkaway, Joachim Krüger and MrGradgrind. |
||||
Debouncing library for Arduino and Wiring by Thomas Ouellet Fredericks with many contributions from the community : https://github.com/thomasfredericks/Bounce2/graphs/contributors |
||||
|
||||
More about debouncing: http://en.wikipedia.org/wiki/Debounce#Contact_bounce |
||||
Basically, the mechanical part of buttons and switches vibrate slightly when closed or opened causing multiple undesired false states (similar to noise). This library filters out these undesired state changes. More about debouncing: |
||||
* John Errington's Experiments with an Arduino : [Using digital inputs: Switch bounce and solutions to it](http://www.skillbank.co.uk/arduino/switchbounce.htm) |
||||
* Wikipedia article : http://en.wikipedia.org/wiki/Debounce#Contact_bounce |
||||
|
||||
See the bottom of this page for a basic usage example and the "examples" folder for more. |
||||
|
||||
## GITHUB PAGE |
||||
The library is composed of three classes: |
||||
* Debouncer : The code that does the actual debouncing. Only advanced users should play with this class. |
||||
* Bounce : This is the general use library. It links the Debouncer to a hardware pin on your board. |
||||
* Button : A special version of Bounce for buttons that are pressed. |
||||
|
||||
https://github.com/thomasfredericks/Bounce2 |
||||
# INSTALLATION & DOWNLOAD |
||||
|
||||
## DOCUMENTATION |
||||
Install through your software's Library Manager or download the latest version [here](https://github.com/thomasfredericks/Bounce2/archive/master.zip) and put the "Bounce2" folder in your "libraries" folder. |
||||
|
||||
The complete class documentation can be found in the "docs" folder or [online here](http://thomasfredericks.github.io/Bounce2/). |
||||
Please note that the original version of this library (Bounce 1) is included in the "extras" folder of the download but not supported anymore. |
||||
|
||||
# HAVE A QUESTION? |
||||
## BASIC USE |
||||
|
||||
Please post your questions [here](http://forum.arduino.cc/index.php?topic=266132.0). |
||||
### INSTANTIATE |
||||
|
||||
# INSTALLATION & DOWNLOAD |
||||
```cpp |
||||
#include <Bounce2.h> |
||||
Bounce b = Bounce(); // Instantiate a Bounce object |
||||
``` |
||||
|
||||
Install through your software's Library Manager or download the latest version [here](https://github.com/thomasfredericks/Bounce2/archive/master.zip) and put the "Bounce2" folder in your "libraries" folder. |
||||
### SETUP |
||||
|
||||
The original version of Bounce (Bounce 1) is included in the download but not supported anymore. |
||||
```cpp |
||||
b.attach ( <PIN> , <PIN MODE> ); |
||||
b.interval( <INTERVAL IN MS> ); |
||||
``` |
||||
### LOOP |
||||
|
||||
```cpp |
||||
b.update(); |
||||
if ( b.changed() ) { |
||||
// THE STATE OF THE INPUT CHANGED |
||||
int deboucedValue = b.read(); |
||||
// DO SOMETHING WITH THE VALUE |
||||
} |
||||
``` |
||||
|
||||
# DEBOUNCE ALGORITHMS (FOR ADVANCED USERS) |
||||
|
||||
## BOUNCE EXAMPLE |
||||
|
||||
## STABLE INTERVAL |
||||
```cpp |
||||
// This example toggles the debug LED (pin 13) on or off when a button on pin 2 is pressed. |
||||
|
||||
By default, the Bounce library uses a stable interval to process the debouncing. This is simpler to understand and can cancel unwanted noise. |
||||
// Include the Bounce2 library found here : |
||||
// https://github.com/thomasfredericks/Bounce2 |
||||
#include <Bounce2.h> |
||||
|
||||
![](https://raw.github.com/thomasfredericks/Bounce-Arduino-Wiring/master/extras/BouncySwitch_stable.png) |
||||
#define BUTTON_PIN 2 |
||||
#define LED_PIN 13 |
||||
|
||||
## LOCK-OUT INTERVAL |
||||
int ledState = LOW; |
||||
|
||||
By defining "#define BOUNCE_LOCK_OUT" in "Bounce.h" (or in your code before including "Bounce.h") you can activate an alternative debouncing method. This method is a lot more responsive, but does not cancel noise. |
||||
|
||||
``` |
||||
#define BOUNCE_LOCK_OUT |
||||
``` |
||||
Bounce b = Bounce(); // Instantiate a Bounce object |
||||
|
||||
![](https://raw.github.com/thomasfredericks/Bounce-Arduino-Wiring/master/extras/BouncySwitch_lockout.png) |
||||
void setup() { |
||||
|
||||
b.attach(BUTTON_PIN,INPUT_PULLUP); // Attach the debouncer to a pin with INPUT_PULLUP mode |
||||
b.interval(25); // Use a debounce interval of 25 milliseconds |
||||
|
||||
## WITH PROMPT DETECTION |
||||
|
||||
By defining "#define BOUNCE_WITH_PROMPT_DETECTION" in "Bounce.h" (or in your code before including "Bounce.h") you can activate an alternative debouncing method. Button state changes are available immediately so long as the previous state has been stable for the timeout period. Otherwise the state will be updated as soon as the timeout period allows. |
||||
pinMode(LED_PIN,OUTPUT); // Setup the LED |
||||
digitalWrite(LED_PIN,ledState); // Turn off the LED |
||||
|
||||
* Able to report acurate switch time normally with no delay. |
||||
* Use when accurate switch transition timing is important. |
||||
} |
||||
|
||||
``` |
||||
#define BOUNCE_WITH_PROMPT_DETECTION |
||||
void loop() { |
||||
|
||||
b.update(); // Update the Bounce instance |
||||
|
||||
if ( b.fell() ) { // Call code if button transitions from HIGH to LOW |
||||
ledState = !ledState; // Toggle LED state |
||||
digitalWrite(LED_PIN,ledState); // Apply new LED state |
||||
} |
||||
} |
||||
``` |
||||
|
||||
# BASIC EXAMPLE |
||||
## BUTTON EXAMPLE |
||||
|
||||
```cpp |
||||
// This example toggles the debug LED (pin 13) on or off |
||||
// when a button on pin 2 is pressed. |
||||
/* |
||||
DESCRIPTION |
||||
==================== |
||||
This is an example of the Bounce2::Button class. |
||||
When the user presses a physical button, it toggles a LED on or off. |
||||
The Button class matches an electrical state to a physical action. |
||||
Use .setPressedState(LOW or HIGH) to set the detection state for when the button is pressed. |
||||
|
||||
INSTRUCTIONS |
||||
==================== |
||||
Set BUTTON_PIN to the pin attached to the button. |
||||
Set LED_PIN to the pin attached to a LED. |
||||
|
||||
*/ |
||||
|
||||
// Include the Bounce2 library found here : |
||||
// https://github.com/thomasfredericks/Bounce2 |
||||
#include <Bounce2.h> |
||||
|
||||
#define BUTTON_PIN 2 |
||||
#define LED_PIN 13 |
||||
// INSTANTIATE A Button OBJECT |
||||
Bounce2::Button button = Bounce2::Button(); |
||||
|
||||
int ledState = LOW; |
||||
// WE WILL attach() THE BUTTON TO THE FOLLOWING PIN IN setup() |
||||
#define BUTTON_PIN 39 |
||||
|
||||
// DEFINE THE PIN FOR THE LED : |
||||
// 1) SOME BOARDS HAVE A DEFAULT LED (LED_BUILTIN) |
||||
//#define LED_PIN LED_BUILTIN |
||||
// 2) OTHERWISE SET YOUR OWN PIN |
||||
#define LED_PIN 13 |
||||
|
||||
Bounce debouncer = Bounce(); // Instantiate a Bounce object |
||||
// SET A VARIABLE TO STORE THE LED STATE |
||||
bool ledState = LOW; |
||||
|
||||
void setup() { |
||||
|
||||
debouncer.attach(BUTTON_PIN,INPUT_PULLUP); // Attach the debouncer to a pin with INPUT_PULLUP mode |
||||
debouncer.interval(25); // Use a debounce interval of 25 milliseconds |
||||
// BUTTON SETUP |
||||
|
||||
// SELECT ONE OF THE FOLLOWING : |
||||
// 1) IF YOUR BUTTON HAS AN INTERNAL PULL-UP |
||||
// button.attach( BUTTON_PIN , INPUT_PULLUP ); // USE INTERNAL PULL-UP |
||||
// 2) IF YOUR BUTTON USES AN EXTERNAL PULL-UP |
||||
button.attach( BUTTON_PIN, INPUT ); // USE EXTERNAL PULL-UP |
||||
|
||||
pinMode(LED_PIN,OUTPUT); // Setup the LED |
||||
// DEBOUNCE INTERVAL IN MILLISECONDS |
||||
button.interval(5); |
||||
|
||||
// INDICATE THAT THE LOW STATE CORRESPONDS TO PHYSICALLY PRESSING THE BUTTON |
||||
button.setPressedState(LOW); |
||||
|
||||
// LED SETUP |
||||
pinMode(LED_PIN,OUTPUT); |
||||
digitalWrite(LED_PIN,ledState); |
||||
|
||||
} |
||||
|
||||
void loop() { |
||||
// UPDATE THE BUTTON |
||||
// YOU MUST CALL THIS EVERY LOOP |
||||
button.update(); |
||||
|
||||
debouncer.update(); // Update the Bounce instance |
||||
if ( button.pressed() ) { |
||||
|
||||
// TOGGLE THE LED STATE : |
||||
ledState = !ledState; // SET ledState TO THE OPPOSITE OF ledState |
||||
digitalWrite(LED_PIN,ledState); |
||||
|
||||
if ( debouncer.fell() ) { // Call code if button transitions from HIGH to LOW |
||||
ledState = !ledState; // Toggle LED state |
||||
digitalWrite(LED_PIN,ledState); // Apply new LED state |
||||
} |
||||
} |
||||
``` |
||||
|
||||
|
||||
# DOCUMENTATION |
||||
|
||||
The complete class documentation can be found in the "docs" folder or [online here](http://thomasfredericks.github.io/Bounce2/). |
||||
|
||||
## GITHUB PAGE (SOURCE CODE) |
||||
|
||||
https://github.com/thomasfredericks/Bounce2 |
||||
|
||||
# HAVE A QUESTION? |
||||
|
||||
Please post your questions [here](http://forum.arduino.cc/index.php?topic=266132.0). |
||||
|
||||
|
||||
|
||||
# ALTERNATE DEBOUNCE ALGORITHMS FOR ADVANCED USERS AND SPECIFIC CASES |
||||
|
||||
|
||||
## STABLE INTERVAL |
||||
|
||||
By default, the Bounce library uses a stable interval to process the debouncing. This is simpler to understand and can cancel unwanted noise. |
||||
|
||||
![](https://raw.github.com/thomasfredericks/Bounce-Arduino-Wiring/master/extras/BouncySwitch_stable.png) |
||||
|
||||
## LOCK-OUT INTERVAL |
||||
|
||||
By defining "#define BOUNCE_LOCK_OUT" in "Bounce.h" (or in your code before including "Bounce.h") you can activate an alternative debouncing method. This method is a lot more responsive, but does not cancel noise. |
||||
|
||||
``` |
||||
#define BOUNCE_LOCK_OUT |
||||
``` |
||||
|
||||
![](https://raw.github.com/thomasfredericks/Bounce-Arduino-Wiring/master/extras/BouncySwitch_lockout.png) |
||||
|
||||
## WITH PROMPT DETECTION |
||||
|
||||
By defining "#define BOUNCE_WITH_PROMPT_DETECTION" in "Bounce.h" (or in your code before including "Bounce.h") you can activate an alternative debouncing method. Button state changes are available immediately so long as the previous state has been stable for the timeout period. Otherwise the state will be updated as soon as the timeout period allows. |
||||
|
||||
* Able to report acurate switch time normally with no delay. |
||||
* Use when accurate switch transition timing is important. |
||||
|
||||
``` |
||||
#define BOUNCE_WITH_PROMPT_DETECTION |
||||
``` |
||||
|
||||
|
||||
|
@ -0,0 +1,2 @@ |
||||
COMPONENT_SRCDIRS := src
|
||||
COMPONENT_ADD_INCLUDEDIRS := src
|
File diff suppressed because one or more lines are too long
@ -0,0 +1,110 @@ |
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/> |
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/> |
||||
<title>Bounce2: src/Bounce2NameSpace.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/searchdata.js"></script> |
||||
<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;"> |
||||
<div id="projectname">Bounce2 |
||||
</div> |
||||
</td> |
||||
</tr> |
||||
</tbody> |
||||
</table> |
||||
</div> |
||||
<!-- end header part --> |
||||
<!-- Generated by Doxygen 1.8.17 --> |
||||
<script type="text/javascript"> |
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
||||
/* @license-end */ |
||||
</script> |
||||
<script type="text/javascript" src="menudata.js"></script> |
||||
<script type="text/javascript" src="menu.js"></script> |
||||
<script type="text/javascript"> |
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
||||
$(function() { |
||||
initMenu('',true,false,'search.php','Search'); |
||||
$(document).ready(function() { init_search(); }); |
||||
}); |
||||
/* @license-end */</script> |
||||
<div id="main-nav"></div> |
||||
<!-- window showing the filter options --> |
||||
<div id="MSearchSelectWindow" |
||||
onmouseover="return searchBox.OnSearchSelectShow()" |
||||
onmouseout="return searchBox.OnSearchSelectHide()" |
||||
onkeydown="return searchBox.OnSearchSelectKey(event)"> |
||||
</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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul> |
||||
</div> |
||||
</div><!-- top --> |
||||
<div class="header"> |
||||
<div class="headertitle"> |
||||
<div class="title">Bounce2NameSpace.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"> The MIT License (MIT)</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"> Copyright (c) 2013 thomasfredericks</span></div> |
||||
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span> </div> |
||||
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> Permission is hereby granted, free of charge, to any person obtaining a copy of</span></div> |
||||
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> this software and associated documentation files (the "Software"), to deal in</span></div> |
||||
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> the Software without restriction, including without limitation the rights to</span></div> |
||||
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of</span></div> |
||||
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> the Software, and to permit persons to whom the Software is furnished to do so,</span></div> |
||||
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> subject to the following conditions:</span></div> |
||||
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"></span> </div> |
||||
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> The above copyright notice and this permission notice shall be included in all</span></div> |
||||
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> copies or substantial portions of the Software.</span></div> |
||||
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"></span> </div> |
||||
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div> |
||||
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS</span></div> |
||||
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR</span></div> |
||||
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER</span></div> |
||||
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN</span></div> |
||||
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span></div> |
||||
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">*/</span></div> |
||||
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div> |
||||
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">/* * * * * * * * * * * * * * * * * * * * * * * * * * * *</span></div> |
||||
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> Main code by Thomas O Fredericks (tof@t-o-f.info)</span></div> |
||||
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> Previous contributions by Eric Lowry, Jim Schimpf and Tom Harkaway</span></div> |
||||
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * * * * * * * * * * * * * * * * * * * * * * * * * * * * */</span></div> |
||||
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div> |
||||
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">using namespace </span><a class="code" href="namespace_bounce2.html">Bounce2</a>;</div> |
||||
</div><!-- fragment --></div><!-- contents --> |
||||
<div class="ttc" id="anamespace_bounce2_html"><div class="ttname"><a href="namespace_bounce2.html">Bounce2</a></div><div class="ttdoc">The Debouncer:Bounce:Button class. The Button class matches an electrical state to a physical action.</div><div class="ttdef"><b>Definition:</b> Bounce2.h:243</div></div> |
||||
<!-- start footer part --> |
||||
<hr class="footer"/><address class="footer"><small> |
||||
Generated by  <a href="http://www.doxygen.org/index.html"> |
||||
<img class="footer" src="doxygen.png" alt="doxygen"/> |
||||
</a> 1.8.17 |
||||
</small></address> |
||||
</body> |
||||
</html> |
@ -0,0 +1,147 @@ |
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/> |
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/> |
||||
<title>Bounce2: bounce_basic.ino</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/searchdata.js"></script> |
||||
<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;"> |
||||
<div id="projectname">Bounce2 |
||||
</div> |
||||
</td> |
||||
</tr> |
||||
</tbody> |
||||
</table> |
||||
</div> |
||||
<!-- end header part --> |
||||
<!-- Generated by Doxygen 1.8.17 --> |
||||
<script type="text/javascript"> |
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
||||
/* @license-end */ |
||||
</script> |
||||
<script type="text/javascript" src="menudata.js"></script> |
||||
<script type="text/javascript" src="menu.js"></script> |
||||
<script type="text/javascript"> |
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
||||
$(function() { |
||||
initMenu('',true,false,'search.php','Search'); |
||||
$(document).ready(function() { init_search(); }); |
||||
}); |
||||
/* @license-end */</script> |
||||
<div id="main-nav"></div> |
||||
</div><!-- top --> |
||||
<!-- window showing the filter options --> |
||||
<div id="MSearchSelectWindow" |
||||
onmouseover="return searchBox.OnSearchSelectShow()" |
||||
onmouseout="return searchBox.OnSearchSelectHide()" |
||||
onkeydown="return searchBox.OnSearchSelectKey(event)"> |
||||
</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 class="header"> |
||||
<div class="headertitle"> |
||||
<div class="title">bounce_basic.ino</div> </div> |
||||
</div><!--header--> |
||||
<div class="contents"> |
||||
<p>Basic example of the <a class="el" href="class_bounce.html" title="The Debouncer:Bounce class. Links the Deboucing class to a hardware pin.">Bounce</a> class.</p> |
||||
<div class="fragment"><div class="line"> </div> |
||||
<div class="line">/*</div> |
||||
<div class="line"> DESCRIPTION</div> |
||||
<div class="line"> ====================</div> |
||||
<div class="line"> Simple example of the Bounce library that switches a LED when</div> |
||||
<div class="line"> a state change (from HIGH to LOW) is triggered (for example when a button is pressed).</div> |
||||
<div class="line"> </div> |
||||
<div class="line"> Set BOUNCE_PIN to the pin attached to the input (a button for example).</div> |
||||
<div class="line"> Set LED_PIN to the pin attached to a LED.</div> |
||||
<div class="line"> </div> |
||||
<div class="line">*/</div> |
||||
<div class="line"> </div> |
||||
<div class="line">// WE WILL attach() THE Bounce INSTANCE TO THE FOLLOWING PIN IN setup()</div> |
||||
<div class="line">#define BOUNCE_PIN 2</div> |
||||
<div class="line"> </div> |
||||
<div class="line">// DEFINE THE PIN FOR THE LED :</div> |
||||
<div class="line">// 1) SOME BOARDS HAVE A DEFAULT LED (LED_BUILTIN)</div> |
||||
<div class="line">#define LED_PIN LED_BUILTIN</div> |
||||
<div class="line">// 2) OTHERWISE SET YOUR OWN PIN</div> |
||||
<div class="line">// #define LED_PIN 13</div> |
||||
<div class="line"> </div> |
||||
<div class="line">// Include the Bounce2 library found here :</div> |
||||
<div class="line">// https://github.com/thomasfredericks/Bounce2</div> |
||||
<div class="line">#include <Bounce2.h></div> |
||||
<div class="line"> </div> |
||||
<div class="line"> </div> |
||||
<div class="line">// INSTANTIATE A Bounce OBJECT</div> |
||||
<div class="line">Bounce bounce = Bounce();</div> |
||||
<div class="line"> </div> |
||||
<div class="line">// SET A VARIABLE TO STORE THE LED STATE</div> |
||||
<div class="line">int ledState = LOW;</div> |
||||
<div class="line"> </div> |
||||
<div class="line">void setup() {</div> |
||||
<div class="line"> </div> |
||||
<div class="line"> // BOUNCE SETUP</div> |
||||
<div class="line"> </div> |
||||
<div class="line"> // SELECT ONE OF THE FOLLOWING :</div> |
||||
<div class="line"> // 1) IF YOUR INPUT HAS AN INTERNAL PULL-UP</div> |
||||
<div class="line"> // bounce.attach( BOUNCE_PIN , INPUT_PULLUP ); // USE INTERNAL PULL-UP</div> |
||||
<div class="line"> // 2) IF YOUR INPUT USES AN EXTERNAL PULL-UP</div> |
||||
<div class="line"> bounce.attach( BOUNCE_PIN, INPUT ); // USE EXTERNAL PULL-UP</div> |
||||
<div class="line"> </div> |
||||
<div class="line"> // DEBOUNCE INTERVAL IN MILLISECONDS</div> |
||||
<div class="line"> bounce.interval(5); // interval in ms</div> |
||||
<div class="line"> </div> |
||||
<div class="line"> // LED SETUP</div> |
||||
<div class="line"> pinMode(LED_PIN, OUTPUT);</div> |
||||
<div class="line"> digitalWrite(LED_PIN, ledState);</div> |
||||
<div class="line"> </div> |
||||
<div class="line">}</div> |
||||
<div class="line"> </div> |
||||
<div class="line">void loop() {</div> |
||||
<div class="line"> // Update the Bounce instance (YOU MUST DO THIS EVERY LOOP)</div> |
||||
<div class="line"> bounce.update();</div> |
||||
<div class="line"> </div> |
||||
<div class="line"> // <Bounce>.changed() RETURNS true IF THE STATE CHANGED (FROM HIGH TO LOW OR LOW TO HIGH)</div> |
||||
<div class="line"> if ( bounce.changed() ) {</div> |
||||
<div class="line"> // THE STATE OF THE INPUT CHANGED</div> |
||||
<div class="line"> // GET THE STATE</div> |
||||
<div class="line"> int deboucedInput = bounce.read();</div> |
||||
<div class="line"> // IF THE CHANGED VALUE IS LOW</div> |
||||
<div class="line"> if ( deboucedInput == LOW ) {</div> |
||||
<div class="line"> ledState = !ledState; // SET ledState TO THE OPPOSITE OF ledState</div> |
||||
<div class="line"> digitalWrite(LED_PIN,ledState); // WRITE THE NEW ledState</div> |
||||
<div class="line"> }</div> |
||||
<div class="line"> }</div> |
||||
<div class="line"> </div> |
||||
<div class="line"> </div> |
||||
<div class="line"> </div> |
||||
<div class="line">}</div> |
||||
</div><!-- fragment --> </div><!-- contents --> |
||||
<!-- start footer part --> |
||||
<hr class="footer"/><address class="footer"><small> |
||||
Generated by  <a href="http://www.doxygen.org/index.html"> |
||||
<img class="footer" src="doxygen.png" alt="doxygen"/> |
||||
</a> 1.8.17 |
||||
</small></address> |
||||
</body> |
||||
</html> |
@ -0,0 +1,77 @@ |
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/> |
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/> |
||||
<title>Bounce2: button_basic.ino</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/searchdata.js"></script> |
||||
<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;"> |
||||
<div id="projectname">Bounce2 |
||||
</div> |
||||
</td> |
||||
</tr> |
||||
</tbody> |
||||
</table> |
||||
</div> |
||||
<!-- end header part --> |
||||
<!-- Generated by Doxygen 1.8.17 --> |
||||
<script type="text/javascript"> |
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
||||
/* @license-end */ |
||||
</script> |
||||
<script type="text/javascript" src="menudata.js"></script> |
||||
<script type="text/javascript" src="menu.js"></script> |
||||
<script type="text/javascript"> |
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
||||
$(function() { |
||||
initMenu('',true,false,'search.php','Search'); |
||||
$(document).ready(function() { init_search(); }); |
||||
}); |
||||
/* @license-end */</script> |
||||
<div id="main-nav"></div> |
||||
</div><!-- top --> |
||||
<!-- window showing the filter options --> |
||||
<div id="MSearchSelectWindow" |
||||
onmouseover="return searchBox.OnSearchSelectShow()" |
||||
onmouseout="return searchBox.OnSearchSelectHide()" |
||||
onkeydown="return searchBox.OnSearchSelectKey(event)"> |
||||
</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 class="header"> |
||||
<div class="headertitle"> |
||||
<div class="title">button_basic.ino</div> </div> |
||||
</div><!--header--> |
||||
<div class="contents"> |
||||
<p>Basic example of the Button class.</p> |
||||
<div class="fragment"></div><!-- fragment --> </div><!-- contents --> |
||||
<!-- start footer part --> |
||||
<hr class="footer"/><address class="footer"><small> |
||||
Generated by  <a href="http://www.doxygen.org/index.html"> |
||||
<img class="footer" src="doxygen.png" alt="doxygen"/> |
||||
</a> 1.8.17 |
||||
</small></address> |
||||
</body> |
||||
</html> |
After Width: | Height: | Size: 619 B |
@ -0,0 +1,114 @@ |
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/> |
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/> |
||||
<title>Bounce2: Member List</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/searchdata.js"></script> |
||||
<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;"> |
||||
<div id="projectname">Bounce2 |
||||
</div> |
||||
</td> |
||||
</tr> |
||||
</tbody> |
||||
</table> |
||||
</div> |
||||
<!-- end header part --> |
||||
<!-- Generated by Doxygen 1.8.17 --> |
||||
<script type="text/javascript"> |
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
||||
/* @license-end */ |
||||
</script> |
||||
<script type="text/javascript" src="menudata.js"></script> |
||||
<script type="text/javascript" src="menu.js"></script> |
||||
<script type="text/javascript"> |
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
||||
$(function() { |
||||
initMenu('',true,false,'search.php','Search'); |
||||
$(document).ready(function() { init_search(); }); |
||||
}); |
||||
/* @license-end */</script> |
||||
<div id="main-nav"></div> |
||||
<!-- window showing the filter options --> |
||||
<div id="MSearchSelectWindow" |
||||
onmouseover="return searchBox.OnSearchSelectShow()" |
||||
onmouseout="return searchBox.OnSearchSelectHide()" |
||||
onkeydown="return searchBox.OnSearchSelectKey(event)"> |
||||
</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="namespace_bounce2.html">Bounce2</a></li><li class="navelem"><a class="el" href="class_bounce2_1_1_button.html">Button</a></li> </ul> |
||||
</div> |
||||
</div><!-- top --> |
||||
<div class="header"> |
||||
<div class="headertitle"> |
||||
<div class="title">Bounce2::Button Member List</div> </div> |
||||
</div><!--header--> |
||||
<div class="contents"> |
||||
|
||||
<p>This is the complete list of members for <a class="el" href="class_bounce2_1_1_button.html">Bounce2::Button</a>, including all inherited members.</p> |
||||
<table class="directory"> |
||||
<tr class="even"><td class="entry"><a class="el" href="class_bounce.html#aba08e592941465d033e3eba3dde66eaf">attach</a>(int pin, int mode)</td><td class="entry"><a class="el" href="class_bounce.html">Bounce</a></td><td class="entry"></td></tr> |
||||
<tr><td class="entry"><a class="el" href="class_bounce.html#a163477dbcbaf1a3dee6cb3b62eedf09e">attach</a>(int pin)</td><td class="entry"><a class="el" href="class_bounce.html">Bounce</a></td><td class="entry"></td></tr> |
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>begin</b>() (defined in <a class="el" href="class_debouncer.html">Debouncer</a>)</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> |
||||
<tr><td class="entry"><a class="el" href="class_bounce.html#aa62a2e2b5ad0ee6913a95f2f2a0e7606">Bounce</a>()</td><td class="entry"><a class="el" href="class_bounce.html">Bounce</a></td><td class="entry"></td></tr> |
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>Bounce</b>(uint8_t pin, unsigned long interval_millis) (defined in <a class="el" href="class_bounce.html">Bounce</a>)</td><td class="entry"><a class="el" href="class_bounce.html">Bounce</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> |
||||
<tr><td class="entry"><a class="el" href="class_bounce2_1_1_button.html#a18710b645862d2b8f058a73aabbaf7ad">Button</a>()</td><td class="entry"><a class="el" href="class_bounce2_1_1_button.html">Bounce2::Button</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> |
||||
<tr class="even"><td class="entry"><a class="el" href="class_debouncer.html#a47c83f13a03920d21fbfafd8469ec06b">changed</a>()</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> |
||||
<tr><td class="entry"><a class="el" href="class_debouncer.html#a34c46ca04d4178933cc0049436d10fe6">Debouncer</a>()</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"></td></tr> |
||||
<tr class="even"><td class="entry"><a class="el" href="class_debouncer.html#a462994f1f9a20876b2ee239eeee97448">duration</a>()</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"></td></tr> |
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>durationOfPreviousState</b> (defined in <a class="el" href="class_debouncer.html">Debouncer</a>)</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> |
||||
<tr class="even"><td class="entry"><a class="el" href="class_bounce.html#ac756559419bfa1c5060e5e4a4ad6406f">fallingEdge</a>()</td><td class="entry"><a class="el" href="class_bounce.html">Bounce</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> |
||||
<tr><td class="entry"><a class="el" href="class_debouncer.html#a1ef5a04b4ebe97352ff3bb227476035c">fell</a>()</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"></td></tr> |
||||
<tr class="even"><td class="entry"><a class="el" href="class_bounce2_1_1_button.html#ab9e2b89ad499fa4b052370140730b6ba">getPressedState</a>()</td><td class="entry"><a class="el" href="class_bounce2_1_1_button.html">Bounce2::Button</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> |
||||
<tr><td class="entry"><a class="el" href="class_debouncer.html#a930bf3945e698d77b889f6309079857d">interval</a>(uint16_t interval_millis)</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"></td></tr> |
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>interval_millis</b> (defined in <a class="el" href="class_debouncer.html">Debouncer</a>)</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> |
||||
<tr><td class="entry"><a class="el" href="class_bounce2_1_1_button.html#a94c31de8109c89d6ee577ed9b14ea676">isPressed</a>()</td><td class="entry"><a class="el" href="class_bounce2_1_1_button.html">Bounce2::Button</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> |
||||
<tr class="even"><td class="entry"><a class="el" href="class_bounce.html#a1cb79cb0ba2379cd12cc7c098d97053a">pin</a></td><td class="entry"><a class="el" href="class_bounce.html">Bounce</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> |
||||
<tr><td class="entry"><a class="el" href="class_bounce2_1_1_button.html#a3fbacfb9a631e03afcfaa5dc39686bad">pressed</a>()</td><td class="entry"><a class="el" href="class_bounce2_1_1_button.html">Bounce2::Button</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> |
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>previous_millis</b> (defined in <a class="el" href="class_debouncer.html">Debouncer</a>)</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> |
||||
<tr><td class="entry"><a class="el" href="class_debouncer.html#a89ab95e7ac24874bb8cb684dc36a98b9">previousDuration</a>()</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"></td></tr> |
||||
<tr class="even"><td class="entry"><a class="el" href="class_debouncer.html#a2cae68910c19c778507f257842fc41bf">read</a>()</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"></td></tr> |
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>readCurrentState</b>() (defined in <a class="el" href="class_bounce.html">Bounce</a>)</td><td class="entry"><a class="el" href="class_bounce.html">Bounce</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></td></tr> |
||||
<tr class="even"><td class="entry"><a class="el" href="class_bounce2_1_1_button.html#a902d9df3cd993f80f59bcb205ed4be37">released</a>()</td><td class="entry"><a class="el" href="class_bounce2_1_1_button.html">Bounce2::Button</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> |
||||
<tr><td class="entry"><a class="el" href="class_bounce.html#a3417beb80eb6593d768c2e9884c57aa0">risingEdge</a>()</td><td class="entry"><a class="el" href="class_bounce.html">Bounce</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> |
||||
<tr class="even"><td class="entry"><a class="el" href="class_debouncer.html#a9990de6fa7256842c35c246d7dea8dbb">rose</a>()</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"></td></tr> |
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>setPinMode</b>(int pin, int mode) (defined in <a class="el" href="class_bounce.html">Bounce</a>)</td><td class="entry"><a class="el" href="class_bounce.html">Bounce</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></td></tr> |
||||
<tr class="even"><td class="entry"><a class="el" href="class_bounce2_1_1_button.html#a3c88b7938b26bca9dc2c7e72aedc442e">setPressedState</a>(bool state)</td><td class="entry"><a class="el" href="class_bounce2_1_1_button.html">Bounce2::Button</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> |
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>state</b> (defined in <a class="el" href="class_debouncer.html">Debouncer</a>)</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> |
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>stateChangeLastTime</b> (defined in <a class="el" href="class_debouncer.html">Debouncer</a>)</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> |
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>stateForPressed</b> (defined in <a class="el" href="class_bounce2_1_1_button.html">Bounce2::Button</a>)</td><td class="entry"><a class="el" href="class_bounce2_1_1_button.html">Bounce2::Button</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> |
||||
<tr class="even"><td class="entry"><a class="el" href="class_debouncer.html#a72f3e8d483555031d2ac21b0b7702c06">update</a>()</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"></td></tr> |
||||
</table></div><!-- contents --> |
||||
<!-- start footer part --> |
||||
<hr class="footer"/><address class="footer"><small> |
||||
Generated by  <a href="http://www.doxygen.org/index.html"> |
||||
<img class="footer" src="doxygen.png" alt="doxygen"/> |
||||
</a> 1.8.17 |
||||
</small></address> |
||||
</body> |
||||
</html> |
@ -0,0 +1,282 @@ |
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/> |
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/> |
||||
<title>Bounce2: Bounce2::Button Class Reference</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/searchdata.js"></script> |
||||
<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;"> |
||||
<div id="projectname">Bounce2 |
||||
</div> |
||||
</td> |
||||
</tr> |
||||
</tbody> |
||||
</table> |
||||
</div> |
||||
<!-- end header part --> |
||||
<!-- Generated by Doxygen 1.8.17 --> |
||||
<script type="text/javascript"> |
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
||||
/* @license-end */ |
||||
</script> |
||||
<script type="text/javascript" src="menudata.js"></script> |
||||
<script type="text/javascript" src="menu.js"></script> |
||||
<script type="text/javascript"> |
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
||||
$(function() { |
||||
initMenu('',true,false,'search.php','Search'); |
||||
$(document).ready(function() { init_search(); }); |
||||
}); |
||||
/* @license-end */</script> |
||||
<div id="main-nav"></div> |
||||
<!-- window showing the filter options --> |
||||
<div id="MSearchSelectWindow" |
||||
onmouseover="return searchBox.OnSearchSelectShow()" |
||||
onmouseout="return searchBox.OnSearchSelectHide()" |
||||
onkeydown="return searchBox.OnSearchSelectKey(event)"> |
||||
</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="namespace_bounce2.html">Bounce2</a></li><li class="navelem"><a class="el" href="class_bounce2_1_1_button.html">Button</a></li> </ul> |
||||
</div> |
||||
</div><!-- top --> |
||||
<div class="header"> |
||||
<div class="summary"> |
||||
<a href="#pub-methods">Public Member Functions</a> | |
||||
<a href="#pro-attribs">Protected Attributes</a> | |
||||
<a href="class_bounce2_1_1_button-members.html">List of all members</a> </div> |
||||
<div class="headertitle"> |
||||
<div class="title">Bounce2::Button Class Reference</div> </div> |
||||
</div><!--header--> |
||||
<div class="contents"> |
||||
<div class="dynheader"> |
||||
Inheritance diagram for Bounce2::Button:</div> |
||||
<div class="dyncontent"> |
||||
<div class="center"> |
||||
<img src="class_bounce2_1_1_button.png" usemap="#Bounce2::Button_map" alt=""/> |
||||
<map id="Bounce2::Button_map" name="Bounce2::Button_map"> |
||||
<area href="class_bounce.html" title="The Debouncer:Bounce class. Links the Deboucing class to a hardware pin." alt="Bounce" shape="rect" coords="0,56,103,80"/> |
||||
<area href="class_debouncer.html" title="The Debouce class. Just the deboucing code separated from all harware." alt="Debouncer" shape="rect" coords="0,0,103,24"/> |
||||
</map> |
||||
</div></div> |
||||
<table class="memberdecls"> |
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
||||
Public Member Functions</h2></td></tr> |
||||
<tr class="memitem:a18710b645862d2b8f058a73aabbaf7ad"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bounce2_1_1_button.html#a18710b645862d2b8f058a73aabbaf7ad">Button</a> ()</td></tr> |
||||
<tr class="memdesc:a18710b645862d2b8f058a73aabbaf7ad"><td class="mdescLeft"> </td><td class="mdescRight">Create an instance of the <a class="el" href="class_bounce2_1_1_button.html">Button</a> class. By default, the pressed state is matched to a HIGH electrical level. <a href="class_bounce2_1_1_button.html#a18710b645862d2b8f058a73aabbaf7ad">More...</a><br /></td></tr> |
||||
<tr class="separator:a18710b645862d2b8f058a73aabbaf7ad"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a3c88b7938b26bca9dc2c7e72aedc442e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bounce2_1_1_button.html#a3c88b7938b26bca9dc2c7e72aedc442e">setPressedState</a> (bool state)</td></tr> |
||||
<tr class="memdesc:a3c88b7938b26bca9dc2c7e72aedc442e"><td class="mdescLeft"> </td><td class="mdescRight">Set the electrical state (HIGH/LOW) that corresponds to a physical press. By default, the pressed state is matched to a HIGH electrical level. <a href="class_bounce2_1_1_button.html#a3c88b7938b26bca9dc2c7e72aedc442e">More...</a><br /></td></tr> |
||||
<tr class="separator:a3c88b7938b26bca9dc2c7e72aedc442e"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:ab9e2b89ad499fa4b052370140730b6ba"><td class="memItemLeft" align="right" valign="top"><a id="ab9e2b89ad499fa4b052370140730b6ba"></a> |
||||
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bounce2_1_1_button.html#ab9e2b89ad499fa4b052370140730b6ba">getPressedState</a> ()</td></tr> |
||||
<tr class="memdesc:ab9e2b89ad499fa4b052370140730b6ba"><td class="mdescLeft"> </td><td class="mdescRight">Get the electrical state (HIGH/LOW) that corresponds to a physical press. <br /></td></tr> |
||||
<tr class="separator:ab9e2b89ad499fa4b052370140730b6ba"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a94c31de8109c89d6ee577ed9b14ea676"><td class="memItemLeft" align="right" valign="top"><a id="a94c31de8109c89d6ee577ed9b14ea676"></a> |
||||
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bounce2_1_1_button.html#a94c31de8109c89d6ee577ed9b14ea676">isPressed</a> ()</td></tr> |
||||
<tr class="memdesc:a94c31de8109c89d6ee577ed9b14ea676"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the button is currently physically pressed. <br /></td></tr> |
||||
<tr class="separator:a94c31de8109c89d6ee577ed9b14ea676"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a3fbacfb9a631e03afcfaa5dc39686bad"><td class="memItemLeft" align="right" valign="top"><a id="a3fbacfb9a631e03afcfaa5dc39686bad"></a> |
||||
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bounce2_1_1_button.html#a3fbacfb9a631e03afcfaa5dc39686bad">pressed</a> ()</td></tr> |
||||
<tr class="memdesc:a3fbacfb9a631e03afcfaa5dc39686bad"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the button was physically pressed <br /> |
||||
<br /></td></tr> |
||||
<tr class="separator:a3fbacfb9a631e03afcfaa5dc39686bad"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a902d9df3cd993f80f59bcb205ed4be37"><td class="memItemLeft" align="right" valign="top"><a id="a902d9df3cd993f80f59bcb205ed4be37"></a> |
||||
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bounce2_1_1_button.html#a902d9df3cd993f80f59bcb205ed4be37">released</a> ()</td></tr> |
||||
<tr class="memdesc:a902d9df3cd993f80f59bcb205ed4be37"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the button was physically released <br /> |
||||
<br /></td></tr> |
||||
<tr class="separator:a902d9df3cd993f80f59bcb205ed4be37"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="inherit_header pub_methods_class_bounce"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_bounce')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_bounce.html">Bounce</a></td></tr> |
||||
<tr class="memitem:aa62a2e2b5ad0ee6913a95f2f2a0e7606 inherit pub_methods_class_bounce"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bounce.html#aa62a2e2b5ad0ee6913a95f2f2a0e7606">Bounce</a> ()</td></tr> |
||||
<tr class="memdesc:aa62a2e2b5ad0ee6913a95f2f2a0e7606 inherit pub_methods_class_bounce"><td class="mdescLeft"> </td><td class="mdescRight">Create an instance of the <a class="el" href="class_bounce.html" title="The Debouncer:Bounce class. Links the Deboucing class to a hardware pin.">Bounce</a> class. <a href="class_bounce.html#aa62a2e2b5ad0ee6913a95f2f2a0e7606">More...</a><br /></td></tr> |
||||
<tr class="separator:aa62a2e2b5ad0ee6913a95f2f2a0e7606 inherit pub_methods_class_bounce"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:aba08e592941465d033e3eba3dde66eaf inherit pub_methods_class_bounce"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bounce.html#aba08e592941465d033e3eba3dde66eaf">attach</a> (int <a class="el" href="class_bounce.html#a1cb79cb0ba2379cd12cc7c098d97053a">pin</a>, int mode)</td></tr> |
||||
<tr class="memdesc:aba08e592941465d033e3eba3dde66eaf inherit pub_methods_class_bounce"><td class="mdescLeft"> </td><td class="mdescRight">Attach to a pin and sets that pin's mode (INPUT, INPUT_PULLUP or OUTPUT). <a href="class_bounce.html#aba08e592941465d033e3eba3dde66eaf">More...</a><br /></td></tr> |
||||
<tr class="separator:aba08e592941465d033e3eba3dde66eaf inherit pub_methods_class_bounce"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a163477dbcbaf1a3dee6cb3b62eedf09e inherit pub_methods_class_bounce"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bounce.html#a163477dbcbaf1a3dee6cb3b62eedf09e">attach</a> (int <a class="el" href="class_bounce.html#a1cb79cb0ba2379cd12cc7c098d97053a">pin</a>)</td></tr> |
||||
<tr class="separator:a163477dbcbaf1a3dee6cb3b62eedf09e inherit pub_methods_class_bounce"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:ab34517094faf21d4f38b36da2915132b inherit pub_methods_class_bounce"><td class="memItemLeft" align="right" valign="top"><a id="ab34517094faf21d4f38b36da2915132b"></a> |
||||
 </td><td class="memItemRight" valign="bottom"><b>Bounce</b> (uint8_t <a class="el" href="class_bounce.html#a1cb79cb0ba2379cd12cc7c098d97053a">pin</a>, unsigned long interval_millis)</td></tr> |
||||
<tr class="separator:ab34517094faf21d4f38b36da2915132b inherit pub_methods_class_bounce"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a3417beb80eb6593d768c2e9884c57aa0 inherit pub_methods_class_bounce"><td class="memItemLeft" align="right" valign="top"><a id="a3417beb80eb6593d768c2e9884c57aa0"></a> |
||||
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bounce.html#a3417beb80eb6593d768c2e9884c57aa0">risingEdge</a> ()</td></tr> |
||||
<tr class="memdesc:a3417beb80eb6593d768c2e9884c57aa0 inherit pub_methods_class_bounce"><td class="mdescLeft"> </td><td class="mdescRight">Deprecated (i.e. do not use). Included for partial compatibility for programs written with <a class="el" href="class_bounce.html" title="The Debouncer:Bounce class. Links the Deboucing class to a hardware pin.">Bounce</a> version 1. <br /></td></tr> |
||||
<tr class="separator:a3417beb80eb6593d768c2e9884c57aa0 inherit pub_methods_class_bounce"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:ac756559419bfa1c5060e5e4a4ad6406f inherit pub_methods_class_bounce"><td class="memItemLeft" align="right" valign="top"><a id="ac756559419bfa1c5060e5e4a4ad6406f"></a> |
||||
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bounce.html#ac756559419bfa1c5060e5e4a4ad6406f">fallingEdge</a> ()</td></tr> |
||||
<tr class="memdesc:ac756559419bfa1c5060e5e4a4ad6406f inherit pub_methods_class_bounce"><td class="mdescLeft"> </td><td class="mdescRight">Deprecated (i.e. do not use). Included for partial compatibility for programs written with <a class="el" href="class_bounce.html" title="The Debouncer:Bounce class. Links the Deboucing class to a hardware pin.">Bounce</a> version 1. <br /></td></tr> |
||||
<tr class="separator:ac756559419bfa1c5060e5e4a4ad6406f inherit pub_methods_class_bounce"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="inherit_header pub_methods_class_debouncer"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_debouncer')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_debouncer.html">Debouncer</a></td></tr> |
||||
<tr class="memitem:a34c46ca04d4178933cc0049436d10fe6 inherit pub_methods_class_debouncer"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_debouncer.html#a34c46ca04d4178933cc0049436d10fe6">Debouncer</a> ()</td></tr> |
||||
<tr class="memdesc:a34c46ca04d4178933cc0049436d10fe6 inherit pub_methods_class_debouncer"><td class="mdescLeft"> </td><td class="mdescRight">Create an instance of the Debounce class. <a href="class_debouncer.html#a34c46ca04d4178933cc0049436d10fe6">More...</a><br /></td></tr> |
||||
<tr class="separator:a34c46ca04d4178933cc0049436d10fe6 inherit pub_methods_class_debouncer"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a930bf3945e698d77b889f6309079857d inherit pub_methods_class_debouncer"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_debouncer.html#a930bf3945e698d77b889f6309079857d">interval</a> (uint16_t interval_millis)</td></tr> |
||||
<tr class="memdesc:a930bf3945e698d77b889f6309079857d inherit pub_methods_class_debouncer"><td class="mdescLeft"> </td><td class="mdescRight">Sets the debounce interval in milliseconds. <a href="class_debouncer.html#a930bf3945e698d77b889f6309079857d">More...</a><br /></td></tr> |
||||
<tr class="separator:a930bf3945e698d77b889f6309079857d inherit pub_methods_class_debouncer"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a72f3e8d483555031d2ac21b0b7702c06 inherit pub_methods_class_debouncer"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_debouncer.html#a72f3e8d483555031d2ac21b0b7702c06">update</a> ()</td></tr> |
||||
<tr class="memdesc:a72f3e8d483555031d2ac21b0b7702c06 inherit pub_methods_class_debouncer"><td class="mdescLeft"> </td><td class="mdescRight">Updates the pin's state. <a href="class_debouncer.html#a72f3e8d483555031d2ac21b0b7702c06">More...</a><br /></td></tr> |
||||
<tr class="separator:a72f3e8d483555031d2ac21b0b7702c06 inherit pub_methods_class_debouncer"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a2cae68910c19c778507f257842fc41bf inherit pub_methods_class_debouncer"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_debouncer.html#a2cae68910c19c778507f257842fc41bf">read</a> ()</td></tr> |
||||
<tr class="memdesc:a2cae68910c19c778507f257842fc41bf inherit pub_methods_class_debouncer"><td class="mdescLeft"> </td><td class="mdescRight">Returns the pin's state (HIGH or LOW). <a href="class_debouncer.html#a2cae68910c19c778507f257842fc41bf">More...</a><br /></td></tr> |
||||
<tr class="separator:a2cae68910c19c778507f257842fc41bf inherit pub_methods_class_debouncer"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a1ef5a04b4ebe97352ff3bb227476035c inherit pub_methods_class_debouncer"><td class="memItemLeft" align="right" valign="top"><a id="a1ef5a04b4ebe97352ff3bb227476035c"></a> |
||||
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_debouncer.html#a1ef5a04b4ebe97352ff3bb227476035c">fell</a> ()</td></tr> |
||||
<tr class="memdesc:a1ef5a04b4ebe97352ff3bb227476035c inherit pub_methods_class_debouncer"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if pin signal transitions from high to low. <br /></td></tr> |
||||
<tr class="separator:a1ef5a04b4ebe97352ff3bb227476035c inherit pub_methods_class_debouncer"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a9990de6fa7256842c35c246d7dea8dbb inherit pub_methods_class_debouncer"><td class="memItemLeft" align="right" valign="top"><a id="a9990de6fa7256842c35c246d7dea8dbb"></a> |
||||
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_debouncer.html#a9990de6fa7256842c35c246d7dea8dbb">rose</a> ()</td></tr> |
||||
<tr class="memdesc:a9990de6fa7256842c35c246d7dea8dbb inherit pub_methods_class_debouncer"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if pin signal transitions from low to high. <br /></td></tr> |
||||
<tr class="separator:a9990de6fa7256842c35c246d7dea8dbb inherit pub_methods_class_debouncer"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a47c83f13a03920d21fbfafd8469ec06b inherit pub_methods_class_debouncer"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_debouncer.html#a47c83f13a03920d21fbfafd8469ec06b">changed</a> ()</td></tr> |
||||
<tr class="memdesc:a47c83f13a03920d21fbfafd8469ec06b inherit pub_methods_class_debouncer"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the state changed on last update. <a href="class_debouncer.html#a47c83f13a03920d21fbfafd8469ec06b">More...</a><br /></td></tr> |
||||
<tr class="separator:a47c83f13a03920d21fbfafd8469ec06b inherit pub_methods_class_debouncer"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a462994f1f9a20876b2ee239eeee97448 inherit pub_methods_class_debouncer"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="class_debouncer.html#a462994f1f9a20876b2ee239eeee97448">duration</a> ()</td></tr> |
||||
<tr class="memdesc:a462994f1f9a20876b2ee239eeee97448 inherit pub_methods_class_debouncer"><td class="mdescLeft"> </td><td class="mdescRight">Returns the duration in milliseconds of the current state. <a href="class_debouncer.html#a462994f1f9a20876b2ee239eeee97448">More...</a><br /></td></tr> |
||||
<tr class="separator:a462994f1f9a20876b2ee239eeee97448 inherit pub_methods_class_debouncer"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a89ab95e7ac24874bb8cb684dc36a98b9 inherit pub_methods_class_debouncer"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="class_debouncer.html#a89ab95e7ac24874bb8cb684dc36a98b9">previousDuration</a> ()</td></tr> |
||||
<tr class="memdesc:a89ab95e7ac24874bb8cb684dc36a98b9 inherit pub_methods_class_debouncer"><td class="mdescLeft"> </td><td class="mdescRight">Returns the duration in milliseconds of the previous state. <a href="class_debouncer.html#a89ab95e7ac24874bb8cb684dc36a98b9">More...</a><br /></td></tr> |
||||
<tr class="separator:a89ab95e7ac24874bb8cb684dc36a98b9 inherit pub_methods_class_debouncer"><td class="memSeparator" colspan="2"> </td></tr> |
||||
</table><table class="memberdecls"> |
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> |
||||
Protected Attributes</h2></td></tr> |
||||
<tr class="memitem:ad9d3ecd99e3c30bcf4c239f01fce3cc3"><td class="memItemLeft" align="right" valign="top"><a id="ad9d3ecd99e3c30bcf4c239f01fce3cc3"></a> |
||||
bool </td><td class="memItemRight" valign="bottom"><b>stateForPressed</b> = 1</td></tr> |
||||
<tr class="separator:ad9d3ecd99e3c30bcf4c239f01fce3cc3"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="inherit_header pro_attribs_class_bounce"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_bounce')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="class_bounce.html">Bounce</a></td></tr> |
||||
<tr class="memitem:a1cb79cb0ba2379cd12cc7c098d97053a inherit pro_attribs_class_bounce"><td class="memItemLeft" align="right" valign="top"><a id="a1cb79cb0ba2379cd12cc7c098d97053a"></a> |
||||
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bounce.html#a1cb79cb0ba2379cd12cc7c098d97053a">pin</a></td></tr> |
||||
<tr class="memdesc:a1cb79cb0ba2379cd12cc7c098d97053a inherit pro_attribs_class_bounce"><td class="mdescLeft"> </td><td class="mdescRight">Deprecated (i.e. do not use). Included for partial compatibility for programs written with <a class="el" href="class_bounce.html" title="The Debouncer:Bounce class. Links the Deboucing class to a hardware pin.">Bounce</a> version 1. <br /></td></tr> |
||||
<tr class="separator:a1cb79cb0ba2379cd12cc7c098d97053a inherit pro_attribs_class_bounce"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="inherit_header pro_attribs_class_debouncer"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_debouncer')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="class_debouncer.html">Debouncer</a></td></tr> |
||||
<tr class="memitem:afab369aec42a15595ebac695a088cccd inherit pro_attribs_class_debouncer"><td class="memItemLeft" align="right" valign="top"><a id="afab369aec42a15595ebac695a088cccd"></a> |
||||
unsigned long </td><td class="memItemRight" valign="bottom"><b>previous_millis</b></td></tr> |
||||
<tr class="separator:afab369aec42a15595ebac695a088cccd inherit pro_attribs_class_debouncer"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a25f000f08b3291f80154ec620abfe52a inherit pro_attribs_class_debouncer"><td class="memItemLeft" align="right" valign="top"><a id="a25f000f08b3291f80154ec620abfe52a"></a> |
||||
uint16_t </td><td class="memItemRight" valign="bottom"><b>interval_millis</b></td></tr> |
||||
<tr class="separator:a25f000f08b3291f80154ec620abfe52a inherit pro_attribs_class_debouncer"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a50b7f921222452bf7328ad84d09c15af inherit pro_attribs_class_debouncer"><td class="memItemLeft" align="right" valign="top"><a id="a50b7f921222452bf7328ad84d09c15af"></a> |
||||
uint8_t </td><td class="memItemRight" valign="bottom"><b>state</b></td></tr> |
||||
<tr class="separator:a50b7f921222452bf7328ad84d09c15af inherit pro_attribs_class_debouncer"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a1bcf1b5c2a67b6409fea2e8705bcab57 inherit pro_attribs_class_debouncer"><td class="memItemLeft" align="right" valign="top"><a id="a1bcf1b5c2a67b6409fea2e8705bcab57"></a> |
||||
unsigned long </td><td class="memItemRight" valign="bottom"><b>stateChangeLastTime</b></td></tr> |
||||
<tr class="separator:a1bcf1b5c2a67b6409fea2e8705bcab57 inherit pro_attribs_class_debouncer"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:adbe8de6a1cfff329629e9136a4efea6c inherit pro_attribs_class_debouncer"><td class="memItemLeft" align="right" valign="top"><a id="adbe8de6a1cfff329629e9136a4efea6c"></a> |
||||
unsigned long </td><td class="memItemRight" valign="bottom"><b>durationOfPreviousState</b></td></tr> |
||||
<tr class="separator:adbe8de6a1cfff329629e9136a4efea6c inherit pro_attribs_class_debouncer"><td class="memSeparator" colspan="2"> </td></tr> |
||||
</table><table class="memberdecls"> |
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> |
||||
Additional Inherited Members</h2></td></tr> |
||||
<tr class="inherit_header pro_methods_class_bounce"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_bounce')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="class_bounce.html">Bounce</a></td></tr> |
||||
<tr class="memitem:ad6efc6dd65035de20f015cc44be37873 inherit pro_methods_class_bounce"><td class="memItemLeft" align="right" valign="top"><a id="ad6efc6dd65035de20f015cc44be37873"></a> |
||||
virtual bool </td><td class="memItemRight" valign="bottom"><b>readCurrentState</b> ()</td></tr> |
||||
<tr class="separator:ad6efc6dd65035de20f015cc44be37873 inherit pro_methods_class_bounce"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a231a992bf2a1f4521043068e35eb50a6 inherit pro_methods_class_bounce"><td class="memItemLeft" align="right" valign="top"><a id="a231a992bf2a1f4521043068e35eb50a6"></a> |
||||
virtual void </td><td class="memItemRight" valign="bottom"><b>setPinMode</b> (int <a class="el" href="class_bounce.html#a1cb79cb0ba2379cd12cc7c098d97053a">pin</a>, int mode)</td></tr> |
||||
<tr class="separator:a231a992bf2a1f4521043068e35eb50a6 inherit pro_methods_class_bounce"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="inherit_header pro_methods_class_debouncer"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_debouncer')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="class_debouncer.html">Debouncer</a></td></tr> |
||||
<tr class="memitem:a38f85f1c1819a5634d93565e0459117b inherit pro_methods_class_debouncer"><td class="memItemLeft" align="right" valign="top"><a id="a38f85f1c1819a5634d93565e0459117b"></a> |
||||
void </td><td class="memItemRight" valign="bottom"><b>begin</b> ()</td></tr> |
||||
<tr class="separator:a38f85f1c1819a5634d93565e0459117b inherit pro_methods_class_debouncer"><td class="memSeparator" colspan="2"> </td></tr> |
||||
</table> |
||||
<h2 class="groupheader">Constructor & Destructor Documentation</h2> |
||||
<a id="a18710b645862d2b8f058a73aabbaf7ad"></a> |
||||
<h2 class="memtitle"><span class="permalink"><a href="#a18710b645862d2b8f058a73aabbaf7ad">◆ </a></span>Button()</h2> |
||||
|
||||
<div class="memitem"> |
||||
<div class="memproto"> |
||||
<table class="mlabels"> |
||||
<tr> |
||||
<td class="mlabels-left"> |
||||
<table class="memname"> |
||||
<tr> |
||||
<td class="memname">Bounce2::Button::Button </td> |
||||
<td>(</td> |
||||
<td class="paramname"></td><td>)</td> |
||||
<td></td> |
||||
</tr> |
||||
</table> |
||||
</td> |
||||
<td class="mlabels-right"> |
||||
<span class="mlabels"><span class="mlabel">inline</span></span> </td> |
||||
</tr> |
||||
</table> |
||||
</div><div class="memdoc"> |
||||
|
||||
<p>Create an instance of the <a class="el" href="class_bounce2_1_1_button.html">Button</a> class. By default, the pressed state is matched to a HIGH electrical level. </p> |
||||
<div class="fragment"><div class="line"><span class="comment">// Create an instance of the Button class.</span></div> |
||||
<div class="line"><a class="code" href="class_bounce2_1_1_button.html#a18710b645862d2b8f058a73aabbaf7ad">Button</a>() button;</div> |
||||
</div><!-- fragment --> |
||||
</div> |
||||
</div> |
||||
<h2 class="groupheader">Member Function Documentation</h2> |
||||
<a id="a3c88b7938b26bca9dc2c7e72aedc442e"></a> |
||||
<h2 class="memtitle"><span class="permalink"><a href="#a3c88b7938b26bca9dc2c7e72aedc442e">◆ </a></span>setPressedState()</h2> |
||||
|
||||
<div class="memitem"> |
||||
<div class="memproto"> |
||||
<table class="mlabels"> |
||||
<tr> |
||||
<td class="mlabels-left"> |
||||
<table class="memname"> |
||||
<tr> |
||||
<td class="memname">void Bounce2::Button::setPressedState </td> |
||||
<td>(</td> |
||||
<td class="paramtype">bool </td> |
||||
<td class="paramname"><em>state</em></td><td>)</td> |
||||
<td></td> |
||||
</tr> |
||||
</table> |
||||
</td> |
||||
<td class="mlabels-right"> |
||||
<span class="mlabels"><span class="mlabel">inline</span></span> </td> |
||||
</tr> |
||||
</table> |
||||
</div><div class="memdoc"> |
||||
|
||||
<p>Set the electrical state (HIGH/LOW) that corresponds to a physical press. By default, the pressed state is matched to a HIGH electrical level. </p> |
||||
<dl class="params"><dt>Parameters</dt><dd> |
||||
<table class="params"> |
||||
<tr><td class="paramname">state</td><td>The electrical state (HIGH/LOW) that corresponds to a physical press. </td></tr> |
||||
</table> |
||||
</dd> |
||||
</dl> |
||||
|
||||
</div> |
||||
</div> |
||||
<hr/>The documentation for this class was generated from the following file:<ul> |
||||
<li>src/<a class="el" href="_bounce2_8h_source.html">Bounce2.h</a></li> |
||||
</ul> |
||||
</div><!-- contents --> |
||||
<div class="ttc" id="aclass_bounce2_1_1_button_html_a18710b645862d2b8f058a73aabbaf7ad"><div class="ttname"><a href="class_bounce2_1_1_button.html#a18710b645862d2b8f058a73aabbaf7ad">Bounce2::Button::Button</a></div><div class="ttdeci">Button()</div><div class="ttdoc">Create an instance of the Button class. By default, the pressed state is matched to a HIGH electrical...</div><div class="ttdef"><b>Definition:</b> Bounce2.h:260</div></div> |
||||
<!-- start footer part --> |
||||
<hr class="footer"/><address class="footer"><small> |
||||
Generated by  <a href="http://www.doxygen.org/index.html"> |
||||
<img class="footer" src="doxygen.png" alt="doxygen"/> |
||||
</a> 1.8.17 |
||||
</small></address> |
||||
</body> |
||||
</html> |
After Width: | Height: | Size: 614 B |
@ -0,0 +1,105 @@ |
||||
<!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.13"/> |
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/> |
||||
<title>Bounce2: Member List</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/searchdata.js"></script> |
||||
<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;"> |
||||
<div id="projectname">Bounce2 |
||||
</div> |
||||
</td> |
||||
</tr> |
||||
</tbody> |
||||
</table> |
||||
</div> |
||||
<!-- end header part --> |
||||
<!-- Generated by Doxygen 1.8.13 --> |
||||
<script type="text/javascript"> |
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
||||
</script> |
||||
<script type="text/javascript" src="menudata.js"></script> |
||||
<script type="text/javascript" src="menu.js"></script> |
||||
<script type="text/javascript"> |
||||
$(function() { |
||||
initMenu('',true,false,'search.php','Search'); |
||||
$(document).ready(function() { init_search(); }); |
||||
}); |
||||
</script> |
||||
<div id="main-nav"></div> |
||||
<!-- window showing the filter options --> |
||||
<div id="MSearchSelectWindow" |
||||
onmouseover="return searchBox.OnSearchSelectShow()" |
||||
onmouseout="return searchBox.OnSearchSelectHide()" |
||||
onkeydown="return searchBox.OnSearchSelectKey(event)"> |
||||
</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><!-- top --> |
||||
<div class="header"> |
||||
<div class="headertitle"> |
||||
<div class="title">Button Member List</div> </div> |
||||
</div><!--header--> |
||||
<div class="contents"> |
||||
|
||||
<p>This is the complete list of members for <a class="el" href="class_button.html">Button</a>, including all inherited members.</p> |
||||
<table class="directory"> |
||||
<tr class="even"><td class="entry"><a class="el" href="class_bounce.html#aba08e592941465d033e3eba3dde66eaf">attach</a>(int pin, int mode)</td><td class="entry"><a class="el" href="class_bounce.html">Bounce</a></td><td class="entry"></td></tr> |
||||
<tr><td class="entry"><a class="el" href="class_bounce.html#a163477dbcbaf1a3dee6cb3b62eedf09e">attach</a>(int pin)</td><td class="entry"><a class="el" href="class_bounce.html">Bounce</a></td><td class="entry"></td></tr> |
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>begin</b>() (defined in <a class="el" href="class_debouncer.html">Debouncer</a>)</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> |
||||
<tr><td class="entry"><a class="el" href="class_bounce.html#aa62a2e2b5ad0ee6913a95f2f2a0e7606">Bounce</a>()</td><td class="entry"><a class="el" href="class_bounce.html">Bounce</a></td><td class="entry"></td></tr> |
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>Bounce</b>(uint8_t pin, unsigned long interval_millis) (defined in <a class="el" href="class_bounce.html">Bounce</a>)</td><td class="entry"><a class="el" href="class_bounce.html">Bounce</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> |
||||
<tr><td class="entry"><a class="el" href="class_button.html#a3b36df1ae23c58aedb9e15a713159459">Button</a>()</td><td class="entry"><a class="el" href="class_button.html">Button</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> |
||||
<tr class="even"><td class="entry"><a class="el" href="class_debouncer.html#a47c83f13a03920d21fbfafd8469ec06b">changed</a>()</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> |
||||
<tr><td class="entry"><a class="el" href="class_debouncer.html#a34c46ca04d4178933cc0049436d10fe6">Debouncer</a>()</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"></td></tr> |
||||
<tr class="even"><td class="entry"><a class="el" href="class_debouncer.html#a462994f1f9a20876b2ee239eeee97448">duration</a>()</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"></td></tr> |
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>durationOfPreviousState</b> (defined in <a class="el" href="class_debouncer.html">Debouncer</a>)</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> |
||||
<tr class="even"><td class="entry"><a class="el" href="class_bounce.html#ac756559419bfa1c5060e5e4a4ad6406f">fallingEdge</a>()</td><td class="entry"><a class="el" href="class_bounce.html">Bounce</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> |
||||
<tr><td class="entry"><a class="el" href="class_debouncer.html#a1ef5a04b4ebe97352ff3bb227476035c">fell</a>()</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"></td></tr> |
||||
<tr class="even"><td class="entry"><a class="el" href="class_debouncer.html#a930bf3945e698d77b889f6309079857d">interval</a>(uint16_t interval_millis)</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"></td></tr> |
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>interval_millis</b> (defined in <a class="el" href="class_debouncer.html">Debouncer</a>)</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> |
||||
<tr class="even"><td class="entry"><a class="el" href="class_bounce.html#a1cb79cb0ba2379cd12cc7c098d97053a">pin</a></td><td class="entry"><a class="el" href="class_bounce.html">Bounce</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> |
||||
<tr><td class="entry"><a class="el" href="class_button.html#a8e37fb754907685539ea71183204b033">pressed</a>()</td><td class="entry"><a class="el" href="class_button.html">Button</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> |
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>previous_millis</b> (defined in <a class="el" href="class_debouncer.html">Debouncer</a>)</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> |
||||
<tr><td class="entry"><a class="el" href="class_debouncer.html#a89ab95e7ac24874bb8cb684dc36a98b9">previousDuration</a>()</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"></td></tr> |
||||
<tr class="even"><td class="entry"><a class="el" href="class_debouncer.html#a2cae68910c19c778507f257842fc41bf">read</a>()</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"></td></tr> |
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>readCurrentState</b>() (defined in <a class="el" href="class_bounce.html">Bounce</a>)</td><td class="entry"><a class="el" href="class_bounce.html">Bounce</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></td></tr> |
||||
<tr class="even"><td class="entry"><a class="el" href="class_button.html#a0b3d2033eb8a6e93141e0b2d8375e9dd">released</a>()</td><td class="entry"><a class="el" href="class_button.html">Button</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> |
||||
<tr><td class="entry"><a class="el" href="class_bounce.html#a3417beb80eb6593d768c2e9884c57aa0">risingEdge</a>()</td><td class="entry"><a class="el" href="class_bounce.html">Bounce</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> |
||||
<tr class="even"><td class="entry"><a class="el" href="class_debouncer.html#a9990de6fa7256842c35c246d7dea8dbb">rose</a>()</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"></td></tr> |
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>setPinMode</b>(int pin, int mode) (defined in <a class="el" href="class_bounce.html">Bounce</a>)</td><td class="entry"><a class="el" href="class_bounce.html">Bounce</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></td></tr> |
||||
<tr class="even"><td class="entry"><a class="el" href="class_button.html#aa58da793c244339b781349cf9af544d5">setPressedState</a>(bool state)</td><td class="entry"><a class="el" href="class_button.html">Button</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> |
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>state</b> (defined in <a class="el" href="class_debouncer.html">Debouncer</a>)</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> |
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>stateChangeLastTime</b> (defined in <a class="el" href="class_debouncer.html">Debouncer</a>)</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> |
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>stateForPressed</b> (defined in <a class="el" href="class_button.html">Button</a>)</td><td class="entry"><a class="el" href="class_button.html">Button</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> |
||||
<tr class="even"><td class="entry"><a class="el" href="class_debouncer.html#a72f3e8d483555031d2ac21b0b7702c06">update</a>()</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"></td></tr> |
||||
</table></div><!-- contents --> |
||||
<!-- start footer part --> |
||||
<hr class="footer"/><address class="footer"><small> |
||||
Generated by  <a href="http://www.doxygen.org/index.html"> |
||||
<img class="footer" src="doxygen.png" alt="doxygen"/> |
||||
</a> 1.8.13 |
||||
</small></address> |
||||
</body> |
||||
</html> |
@ -0,0 +1,269 @@ |
||||
<!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.13"/> |
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/> |
||||
<title>Bounce2: Button Class Reference</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/searchdata.js"></script> |
||||
<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;"> |
||||
<div id="projectname">Bounce2 |
||||
</div> |
||||
</td> |
||||
</tr> |
||||
</tbody> |
||||
</table> |
||||
</div> |
||||
<!-- end header part --> |
||||
<!-- Generated by Doxygen 1.8.13 --> |
||||
<script type="text/javascript"> |
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
||||
</script> |
||||
<script type="text/javascript" src="menudata.js"></script> |
||||
<script type="text/javascript" src="menu.js"></script> |
||||
<script type="text/javascript"> |
||||
$(function() { |
||||
initMenu('',true,false,'search.php','Search'); |
||||
$(document).ready(function() { init_search(); }); |
||||
}); |
||||
</script> |
||||
<div id="main-nav"></div> |
||||
<!-- window showing the filter options --> |
||||
<div id="MSearchSelectWindow" |
||||
onmouseover="return searchBox.OnSearchSelectShow()" |
||||
onmouseout="return searchBox.OnSearchSelectHide()" |
||||
onkeydown="return searchBox.OnSearchSelectKey(event)"> |
||||
</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><!-- top --> |
||||
<div class="header"> |
||||
<div class="summary"> |
||||
<a href="#pub-methods">Public Member Functions</a> | |
||||
<a href="#pro-attribs">Protected Attributes</a> | |
||||
<a href="class_button-members.html">List of all members</a> </div> |
||||
<div class="headertitle"> |
||||
<div class="title">Button Class Reference</div> </div> |
||||
</div><!--header--> |
||||
<div class="contents"> |
||||
|
||||
<p>The Debouncer:Bounce:<a class="el" href="class_button.html" title="The Debouncer:Bounce:Button class. The Button class matches an electrical state to a physical action...">Button</a> class. The <a class="el" href="class_button.html" title="The Debouncer:Bounce:Button class. The Button class matches an electrical state to a physical action...">Button</a> class matches an electrical state to a physical action. |
||||
<a href="class_button.html#details">More...</a></p> |
||||
|
||||
<p><code>#include <<a class="el" href="_bounce2_8h_source.html">Bounce2.h</a>></code></p> |
||||
<div class="dynheader"> |
||||
Inheritance diagram for Button:</div> |
||||
<div class="dyncontent"> |
||||
<div class="center"> |
||||
<img src="class_button.png" usemap="#Button_map" alt=""/> |
||||
<map id="Button_map" name="Button_map"> |
||||
<area href="class_bounce.html" title="The Debouncer:Bounce class. Links the Deboucing class to a hardware pin. " alt="Bounce" shape="rect" coords="0,56,75,80"/> |
||||
<area href="class_debouncer.html" title="The Debouce class. Just the deboucing code separated from all harware. " alt="Debouncer" shape="rect" coords="0,0,75,24"/> |
||||
</map> |
||||
</div></div> |
||||
<table class="memberdecls"> |
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
||||
Public Member Functions</h2></td></tr> |
||||
<tr class="memitem:a3b36df1ae23c58aedb9e15a713159459"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_button.html#a3b36df1ae23c58aedb9e15a713159459">Button</a> ()</td></tr> |
||||
<tr class="memdesc:a3b36df1ae23c58aedb9e15a713159459"><td class="mdescLeft"> </td><td class="mdescRight">Create an instance of the <a class="el" href="class_button.html" title="The Debouncer:Bounce:Button class. The Button class matches an electrical state to a physical action...">Button</a> class. By default, the pressed state is matched to a HIGH electrical level. <a href="#a3b36df1ae23c58aedb9e15a713159459">More...</a><br /></td></tr> |
||||
<tr class="separator:a3b36df1ae23c58aedb9e15a713159459"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:aa58da793c244339b781349cf9af544d5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_button.html#aa58da793c244339b781349cf9af544d5">setPressedState</a> (bool state)</td></tr> |
||||
<tr class="memdesc:aa58da793c244339b781349cf9af544d5"><td class="mdescLeft"> </td><td class="mdescRight">Set the electrical state (HIGH/LOW) that corresponds to a physical press. By default, the pressed state is matched to a HIGH electrical level. <a href="#aa58da793c244339b781349cf9af544d5">More...</a><br /></td></tr> |
||||
<tr class="separator:aa58da793c244339b781349cf9af544d5"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a8e37fb754907685539ea71183204b033"><td class="memItemLeft" align="right" valign="top"><a id="a8e37fb754907685539ea71183204b033"></a> |
||||
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_button.html#a8e37fb754907685539ea71183204b033">pressed</a> ()</td></tr> |
||||
<tr class="memdesc:a8e37fb754907685539ea71183204b033"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the button was physically pressed. <br /></td></tr> |
||||
<tr class="separator:a8e37fb754907685539ea71183204b033"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a0b3d2033eb8a6e93141e0b2d8375e9dd"><td class="memItemLeft" align="right" valign="top"><a id="a0b3d2033eb8a6e93141e0b2d8375e9dd"></a> |
||||
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_button.html#a0b3d2033eb8a6e93141e0b2d8375e9dd">released</a> ()</td></tr> |
||||
<tr class="memdesc:a0b3d2033eb8a6e93141e0b2d8375e9dd"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the button was physically released. <br /></td></tr> |
||||
<tr class="separator:a0b3d2033eb8a6e93141e0b2d8375e9dd"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="inherit_header pub_methods_class_bounce"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_bounce')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_bounce.html">Bounce</a></td></tr> |
||||
<tr class="memitem:aa62a2e2b5ad0ee6913a95f2f2a0e7606 inherit pub_methods_class_bounce"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bounce.html#aa62a2e2b5ad0ee6913a95f2f2a0e7606">Bounce</a> ()</td></tr> |
||||
<tr class="memdesc:aa62a2e2b5ad0ee6913a95f2f2a0e7606 inherit pub_methods_class_bounce"><td class="mdescLeft"> </td><td class="mdescRight">Create an instance of the <a class="el" href="class_bounce.html" title="The Debouncer:Bounce class. Links the Deboucing class to a hardware pin. ">Bounce</a> class. <a href="class_bounce.html#aa62a2e2b5ad0ee6913a95f2f2a0e7606">More...</a><br /></td></tr> |
||||
<tr class="separator:aa62a2e2b5ad0ee6913a95f2f2a0e7606 inherit pub_methods_class_bounce"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:aba08e592941465d033e3eba3dde66eaf inherit pub_methods_class_bounce"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bounce.html#aba08e592941465d033e3eba3dde66eaf">attach</a> (int <a class="el" href="class_bounce.html#a1cb79cb0ba2379cd12cc7c098d97053a">pin</a>, int mode)</td></tr> |
||||
<tr class="memdesc:aba08e592941465d033e3eba3dde66eaf inherit pub_methods_class_bounce"><td class="mdescLeft"> </td><td class="mdescRight">Attach to a pin and sets that pin's mode (INPUT, INPUT_PULLUP or OUTPUT). <a href="class_bounce.html#aba08e592941465d033e3eba3dde66eaf">More...</a><br /></td></tr> |
||||
<tr class="separator:aba08e592941465d033e3eba3dde66eaf inherit pub_methods_class_bounce"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a163477dbcbaf1a3dee6cb3b62eedf09e inherit pub_methods_class_bounce"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bounce.html#a163477dbcbaf1a3dee6cb3b62eedf09e">attach</a> (int <a class="el" href="class_bounce.html#a1cb79cb0ba2379cd12cc7c098d97053a">pin</a>)</td></tr> |
||||
<tr class="separator:a163477dbcbaf1a3dee6cb3b62eedf09e inherit pub_methods_class_bounce"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:ab34517094faf21d4f38b36da2915132b inherit pub_methods_class_bounce"><td class="memItemLeft" align="right" valign="top"><a id="ab34517094faf21d4f38b36da2915132b"></a> |
||||
 </td><td class="memItemRight" valign="bottom"><b>Bounce</b> (uint8_t <a class="el" href="class_bounce.html#a1cb79cb0ba2379cd12cc7c098d97053a">pin</a>, unsigned long interval_millis)</td></tr> |
||||
<tr class="separator:ab34517094faf21d4f38b36da2915132b inherit pub_methods_class_bounce"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a3417beb80eb6593d768c2e9884c57aa0 inherit pub_methods_class_bounce"><td class="memItemLeft" align="right" valign="top"><a id="a3417beb80eb6593d768c2e9884c57aa0"></a> |
||||
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bounce.html#a3417beb80eb6593d768c2e9884c57aa0">risingEdge</a> ()</td></tr> |
||||
<tr class="memdesc:a3417beb80eb6593d768c2e9884c57aa0 inherit pub_methods_class_bounce"><td class="mdescLeft"> </td><td class="mdescRight">Deprecated (i.e. do not use). Included for partial compatibility for programs written with <a class="el" href="class_bounce.html" title="The Debouncer:Bounce class. Links the Deboucing class to a hardware pin. ">Bounce</a> version 1. <br /></td></tr> |
||||
<tr class="separator:a3417beb80eb6593d768c2e9884c57aa0 inherit pub_methods_class_bounce"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:ac756559419bfa1c5060e5e4a4ad6406f inherit pub_methods_class_bounce"><td class="memItemLeft" align="right" valign="top"><a id="ac756559419bfa1c5060e5e4a4ad6406f"></a> |
||||
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bounce.html#ac756559419bfa1c5060e5e4a4ad6406f">fallingEdge</a> ()</td></tr> |
||||
<tr class="memdesc:ac756559419bfa1c5060e5e4a4ad6406f inherit pub_methods_class_bounce"><td class="mdescLeft"> </td><td class="mdescRight">Deprecated (i.e. do not use). Included for partial compatibility for programs written with <a class="el" href="class_bounce.html" title="The Debouncer:Bounce class. Links the Deboucing class to a hardware pin. ">Bounce</a> version 1. <br /></td></tr> |
||||
<tr class="separator:ac756559419bfa1c5060e5e4a4ad6406f inherit pub_methods_class_bounce"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="inherit_header pub_methods_class_debouncer"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_debouncer')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_debouncer.html">Debouncer</a></td></tr> |
||||
<tr class="memitem:a34c46ca04d4178933cc0049436d10fe6 inherit pub_methods_class_debouncer"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_debouncer.html#a34c46ca04d4178933cc0049436d10fe6">Debouncer</a> ()</td></tr> |
||||
<tr class="memdesc:a34c46ca04d4178933cc0049436d10fe6 inherit pub_methods_class_debouncer"><td class="mdescLeft"> </td><td class="mdescRight">Create an instance of the Debounce class. <a href="class_debouncer.html#a34c46ca04d4178933cc0049436d10fe6">More...</a><br /></td></tr> |
||||
<tr class="separator:a34c46ca04d4178933cc0049436d10fe6 inherit pub_methods_class_debouncer"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a930bf3945e698d77b889f6309079857d inherit pub_methods_class_debouncer"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_debouncer.html#a930bf3945e698d77b889f6309079857d">interval</a> (uint16_t interval_millis)</td></tr> |
||||
<tr class="memdesc:a930bf3945e698d77b889f6309079857d inherit pub_methods_class_debouncer"><td class="mdescLeft"> </td><td class="mdescRight">Sets the debounce interval in milliseconds. <a href="class_debouncer.html#a930bf3945e698d77b889f6309079857d">More...</a><br /></td></tr> |
||||
<tr class="separator:a930bf3945e698d77b889f6309079857d inherit pub_methods_class_debouncer"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a72f3e8d483555031d2ac21b0b7702c06 inherit pub_methods_class_debouncer"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_debouncer.html#a72f3e8d483555031d2ac21b0b7702c06">update</a> ()</td></tr> |
||||
<tr class="memdesc:a72f3e8d483555031d2ac21b0b7702c06 inherit pub_methods_class_debouncer"><td class="mdescLeft"> </td><td class="mdescRight">Updates the pin's state. <a href="class_debouncer.html#a72f3e8d483555031d2ac21b0b7702c06">More...</a><br /></td></tr> |
||||
<tr class="separator:a72f3e8d483555031d2ac21b0b7702c06 inherit pub_methods_class_debouncer"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a2cae68910c19c778507f257842fc41bf inherit pub_methods_class_debouncer"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_debouncer.html#a2cae68910c19c778507f257842fc41bf">read</a> ()</td></tr> |
||||
<tr class="memdesc:a2cae68910c19c778507f257842fc41bf inherit pub_methods_class_debouncer"><td class="mdescLeft"> </td><td class="mdescRight">Returns the pin's state (HIGH or LOW). <a href="class_debouncer.html#a2cae68910c19c778507f257842fc41bf">More...</a><br /></td></tr> |
||||
<tr class="separator:a2cae68910c19c778507f257842fc41bf inherit pub_methods_class_debouncer"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a1ef5a04b4ebe97352ff3bb227476035c inherit pub_methods_class_debouncer"><td class="memItemLeft" align="right" valign="top"><a id="a1ef5a04b4ebe97352ff3bb227476035c"></a> |
||||
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_debouncer.html#a1ef5a04b4ebe97352ff3bb227476035c">fell</a> ()</td></tr> |
||||
<tr class="memdesc:a1ef5a04b4ebe97352ff3bb227476035c inherit pub_methods_class_debouncer"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if pin signal transitions from high to low. <br /></td></tr> |
||||
<tr class="separator:a1ef5a04b4ebe97352ff3bb227476035c inherit pub_methods_class_debouncer"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a9990de6fa7256842c35c246d7dea8dbb inherit pub_methods_class_debouncer"><td class="memItemLeft" align="right" valign="top"><a id="a9990de6fa7256842c35c246d7dea8dbb"></a> |
||||
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_debouncer.html#a9990de6fa7256842c35c246d7dea8dbb">rose</a> ()</td></tr> |
||||
<tr class="memdesc:a9990de6fa7256842c35c246d7dea8dbb inherit pub_methods_class_debouncer"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if pin signal transitions from low to high. <br /></td></tr> |
||||
<tr class="separator:a9990de6fa7256842c35c246d7dea8dbb inherit pub_methods_class_debouncer"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a47c83f13a03920d21fbfafd8469ec06b inherit pub_methods_class_debouncer"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_debouncer.html#a47c83f13a03920d21fbfafd8469ec06b">changed</a> ()</td></tr> |
||||
<tr class="memdesc:a47c83f13a03920d21fbfafd8469ec06b inherit pub_methods_class_debouncer"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the state changed on last update. <a href="class_debouncer.html#a47c83f13a03920d21fbfafd8469ec06b">More...</a><br /></td></tr> |
||||
<tr class="separator:a47c83f13a03920d21fbfafd8469ec06b inherit pub_methods_class_debouncer"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a462994f1f9a20876b2ee239eeee97448 inherit pub_methods_class_debouncer"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="class_debouncer.html#a462994f1f9a20876b2ee239eeee97448">duration</a> ()</td></tr> |
||||
<tr class="memdesc:a462994f1f9a20876b2ee239eeee97448 inherit pub_methods_class_debouncer"><td class="mdescLeft"> </td><td class="mdescRight">Returns the duration in milliseconds of the current state. <a href="class_debouncer.html#a462994f1f9a20876b2ee239eeee97448">More...</a><br /></td></tr> |
||||
<tr class="separator:a462994f1f9a20876b2ee239eeee97448 inherit pub_methods_class_debouncer"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a89ab95e7ac24874bb8cb684dc36a98b9 inherit pub_methods_class_debouncer"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="class_debouncer.html#a89ab95e7ac24874bb8cb684dc36a98b9">previousDuration</a> ()</td></tr> |
||||
<tr class="memdesc:a89ab95e7ac24874bb8cb684dc36a98b9 inherit pub_methods_class_debouncer"><td class="mdescLeft"> </td><td class="mdescRight">Returns the duration in milliseconds of the previous state. <a href="class_debouncer.html#a89ab95e7ac24874bb8cb684dc36a98b9">More...</a><br /></td></tr> |
||||
<tr class="separator:a89ab95e7ac24874bb8cb684dc36a98b9 inherit pub_methods_class_debouncer"><td class="memSeparator" colspan="2"> </td></tr> |
||||
</table><table class="memberdecls"> |
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> |
||||
Protected Attributes</h2></td></tr> |
||||
<tr class="memitem:ac7dd76476b2b7b40950c05925093247d"><td class="memItemLeft" align="right" valign="top"><a id="ac7dd76476b2b7b40950c05925093247d"></a> |
||||
bool </td><td class="memItemRight" valign="bottom"><b>stateForPressed</b> = 1</td></tr> |
||||
<tr class="separator:ac7dd76476b2b7b40950c05925093247d"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="inherit_header pro_attribs_class_bounce"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_bounce')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="class_bounce.html">Bounce</a></td></tr> |
||||
<tr class="memitem:a1cb79cb0ba2379cd12cc7c098d97053a inherit pro_attribs_class_bounce"><td class="memItemLeft" align="right" valign="top"><a id="a1cb79cb0ba2379cd12cc7c098d97053a"></a> |
||||
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bounce.html#a1cb79cb0ba2379cd12cc7c098d97053a">pin</a></td></tr> |
||||
<tr class="memdesc:a1cb79cb0ba2379cd12cc7c098d97053a inherit pro_attribs_class_bounce"><td class="mdescLeft"> </td><td class="mdescRight">Deprecated (i.e. do not use). Included for partial compatibility for programs written with <a class="el" href="class_bounce.html" title="The Debouncer:Bounce class. Links the Deboucing class to a hardware pin. ">Bounce</a> version 1. <br /></td></tr> |
||||
<tr class="separator:a1cb79cb0ba2379cd12cc7c098d97053a inherit pro_attribs_class_bounce"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="inherit_header pro_attribs_class_debouncer"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_debouncer')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="class_debouncer.html">Debouncer</a></td></tr> |
||||
<tr class="memitem:afab369aec42a15595ebac695a088cccd inherit pro_attribs_class_debouncer"><td class="memItemLeft" align="right" valign="top"><a id="afab369aec42a15595ebac695a088cccd"></a> |
||||
unsigned long </td><td class="memItemRight" valign="bottom"><b>previous_millis</b></td></tr> |
||||
<tr class="separator:afab369aec42a15595ebac695a088cccd inherit pro_attribs_class_debouncer"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a25f000f08b3291f80154ec620abfe52a inherit pro_attribs_class_debouncer"><td class="memItemLeft" align="right" valign="top"><a id="a25f000f08b3291f80154ec620abfe52a"></a> |
||||
uint16_t </td><td class="memItemRight" valign="bottom"><b>interval_millis</b></td></tr> |
||||
<tr class="separator:a25f000f08b3291f80154ec620abfe52a inherit pro_attribs_class_debouncer"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a50b7f921222452bf7328ad84d09c15af inherit pro_attribs_class_debouncer"><td class="memItemLeft" align="right" valign="top"><a id="a50b7f921222452bf7328ad84d09c15af"></a> |
||||
uint8_t </td><td class="memItemRight" valign="bottom"><b>state</b></td></tr> |
||||
<tr class="separator:a50b7f921222452bf7328ad84d09c15af inherit pro_attribs_class_debouncer"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a1bcf1b5c2a67b6409fea2e8705bcab57 inherit pro_attribs_class_debouncer"><td class="memItemLeft" align="right" valign="top"><a id="a1bcf1b5c2a67b6409fea2e8705bcab57"></a> |
||||
unsigned long </td><td class="memItemRight" valign="bottom"><b>stateChangeLastTime</b></td></tr> |
||||
<tr class="separator:a1bcf1b5c2a67b6409fea2e8705bcab57 inherit pro_attribs_class_debouncer"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:adbe8de6a1cfff329629e9136a4efea6c inherit pro_attribs_class_debouncer"><td class="memItemLeft" align="right" valign="top"><a id="adbe8de6a1cfff329629e9136a4efea6c"></a> |
||||
unsigned long </td><td class="memItemRight" valign="bottom"><b>durationOfPreviousState</b></td></tr> |
||||
<tr class="separator:adbe8de6a1cfff329629e9136a4efea6c inherit pro_attribs_class_debouncer"><td class="memSeparator" colspan="2"> </td></tr> |
||||
</table><table class="memberdecls"> |
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> |
||||
Additional Inherited Members</h2></td></tr> |
||||
<tr class="inherit_header pro_methods_class_bounce"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_bounce')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="class_bounce.html">Bounce</a></td></tr> |
||||
<tr class="memitem:ad6efc6dd65035de20f015cc44be37873 inherit pro_methods_class_bounce"><td class="memItemLeft" align="right" valign="top"><a id="ad6efc6dd65035de20f015cc44be37873"></a> |
||||
virtual bool </td><td class="memItemRight" valign="bottom"><b>readCurrentState</b> ()</td></tr> |
||||
<tr class="separator:ad6efc6dd65035de20f015cc44be37873 inherit pro_methods_class_bounce"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a231a992bf2a1f4521043068e35eb50a6 inherit pro_methods_class_bounce"><td class="memItemLeft" align="right" valign="top"><a id="a231a992bf2a1f4521043068e35eb50a6"></a> |
||||
virtual void </td><td class="memItemRight" valign="bottom"><b>setPinMode</b> (int <a class="el" href="class_bounce.html#a1cb79cb0ba2379cd12cc7c098d97053a">pin</a>, int mode)</td></tr> |
||||
<tr class="separator:a231a992bf2a1f4521043068e35eb50a6 inherit pro_methods_class_bounce"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="inherit_header pro_methods_class_debouncer"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_debouncer')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="class_debouncer.html">Debouncer</a></td></tr> |
||||
<tr class="memitem:a38f85f1c1819a5634d93565e0459117b inherit pro_methods_class_debouncer"><td class="memItemLeft" align="right" valign="top"><a id="a38f85f1c1819a5634d93565e0459117b"></a> |
||||
void </td><td class="memItemRight" valign="bottom"><b>begin</b> ()</td></tr> |
||||
<tr class="separator:a38f85f1c1819a5634d93565e0459117b inherit pro_methods_class_debouncer"><td class="memSeparator" colspan="2"> </td></tr> |
||||
</table> |
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
||||
<div class="textblock"><p>The Debouncer:Bounce:<a class="el" href="class_button.html" title="The Debouncer:Bounce:Button class. The Button class matches an electrical state to a physical action...">Button</a> class. The <a class="el" href="class_button.html" title="The Debouncer:Bounce:Button class. The Button class matches an electrical state to a physical action...">Button</a> class matches an electrical state to a physical action. </p> |
||||
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
||||
<a id="a3b36df1ae23c58aedb9e15a713159459"></a> |
||||
<h2 class="memtitle"><span class="permalink"><a href="#a3b36df1ae23c58aedb9e15a713159459">◆ </a></span>Button()</h2> |
||||
|
||||
<div class="memitem"> |
||||
<div class="memproto"> |
||||
<table class="mlabels"> |
||||
<tr> |
||||
<td class="mlabels-left"> |
||||
<table class="memname"> |
||||
<tr> |
||||
<td class="memname">Button::Button </td> |
||||
<td>(</td> |
||||
<td class="paramname"></td><td>)</td> |
||||
<td></td> |
||||
</tr> |
||||
</table> |
||||
</td> |
||||
<td class="mlabels-right"> |
||||
<span class="mlabels"><span class="mlabel">inline</span></span> </td> |
||||
</tr> |
||||
</table> |
||||
</div><div class="memdoc"> |
||||
|
||||
<p>Create an instance of the <a class="el" href="class_button.html" title="The Debouncer:Bounce:Button class. The Button class matches an electrical state to a physical action...">Button</a> class. By default, the pressed state is matched to a HIGH electrical level. </p> |
||||
<div class="fragment"><div class="line"><span class="comment">// Create an instance of the Button class.</span></div><div class="line"><a class="code" href="class_button.html#a3b36df1ae23c58aedb9e15a713159459">Button</a>() button;</div></div><!-- fragment --> |
||||
</div> |
||||
</div> |
||||
<h2 class="groupheader">Member Function Documentation</h2> |
||||
<a id="aa58da793c244339b781349cf9af544d5"></a> |
||||
<h2 class="memtitle"><span class="permalink"><a href="#aa58da793c244339b781349cf9af544d5">◆ </a></span>setPressedState()</h2> |
||||
|
||||
<div class="memitem"> |
||||
<div class="memproto"> |
||||
<table class="mlabels"> |
||||
<tr> |
||||
<td class="mlabels-left"> |
||||
<table class="memname"> |
||||
<tr> |
||||
<td class="memname">void Button::setPressedState </td> |
||||
<td>(</td> |
||||
<td class="paramtype">bool </td> |
||||
<td class="paramname"><em>state</em></td><td>)</td> |
||||
<td></td> |
||||
</tr> |
||||
</table> |
||||
</td> |
||||
<td class="mlabels-right"> |
||||
<span class="mlabels"><span class="mlabel">inline</span></span> </td> |
||||
</tr> |
||||
</table> |
||||
</div><div class="memdoc"> |
||||
|
||||
<p>Set the electrical state (HIGH/LOW) that corresponds to a physical press. By default, the pressed state is matched to a HIGH electrical level. </p> |
||||
<dl class="params"><dt>Parameters</dt><dd> |
||||
<table class="params"> |
||||
<tr><td class="paramname">state</td><td>The electrical state (HIGH/LOW) that corresponds to a physical press. </td></tr> |
||||
</table> |
||||
</dd> |
||||
</dl> |
||||
|
||||
</div> |
||||
</div> |
||||
<hr/>The documentation for this class was generated from the following file:<ul> |
||||
<li>src/<a class="el" href="_bounce2_8h_source.html">Bounce2.h</a></li> |
||||
</ul> |
||||
</div><!-- contents --> |
||||
<!-- start footer part --> |
||||
<hr class="footer"/><address class="footer"><small> |
||||
Generated by  <a href="http://www.doxygen.org/index.html"> |
||||
<img class="footer" src="doxygen.png" alt="doxygen"/> |
||||
</a> 1.8.13 |
||||
</small></address> |
||||
</body> |
||||
</html> |
After Width: | Height: | Size: 520 B |
@ -0,0 +1,95 @@ |
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/> |
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/> |
||||
<title>Bounce2: Member List</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/searchdata.js"></script> |
||||
<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;"> |
||||
<div id="projectname">Bounce2 |
||||
</div> |
||||
</td> |
||||
</tr> |
||||
</tbody> |
||||
</table> |
||||
</div> |
||||
<!-- end header part --> |
||||
<!-- Generated by Doxygen 1.8.17 --> |
||||
<script type="text/javascript"> |
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
||||
/* @license-end */ |
||||
</script> |
||||
<script type="text/javascript" src="menudata.js"></script> |
||||
<script type="text/javascript" src="menu.js"></script> |
||||
<script type="text/javascript"> |
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
||||
$(function() { |
||||
initMenu('',true,false,'search.php','Search'); |
||||
$(document).ready(function() { init_search(); }); |
||||
}); |
||||
/* @license-end */</script> |
||||
<div id="main-nav"></div> |
||||
<!-- window showing the filter options --> |
||||
<div id="MSearchSelectWindow" |
||||
onmouseover="return searchBox.OnSearchSelectShow()" |
||||
onmouseout="return searchBox.OnSearchSelectHide()" |
||||
onkeydown="return searchBox.OnSearchSelectKey(event)"> |
||||
</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><!-- top --> |
||||
<div class="header"> |
||||
<div class="headertitle"> |
||||
<div class="title">Debouncer Member List</div> </div> |
||||
</div><!--header--> |
||||
<div class="contents"> |
||||
|
||||
<p>This is the complete list of members for <a class="el" href="class_debouncer.html">Debouncer</a>, including all inherited members.</p> |
||||
<table class="directory"> |
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>begin</b>() (defined in <a class="el" href="class_debouncer.html">Debouncer</a>)</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> |
||||
<tr><td class="entry"><a class="el" href="class_debouncer.html#a47c83f13a03920d21fbfafd8469ec06b">changed</a>()</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> |
||||
<tr class="even"><td class="entry"><a class="el" href="class_debouncer.html#a34c46ca04d4178933cc0049436d10fe6">Debouncer</a>()</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"></td></tr> |
||||
<tr><td class="entry"><a class="el" href="class_debouncer.html#a462994f1f9a20876b2ee239eeee97448">duration</a>()</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"></td></tr> |
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>durationOfPreviousState</b> (defined in <a class="el" href="class_debouncer.html">Debouncer</a>)</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> |
||||
<tr><td class="entry"><a class="el" href="class_debouncer.html#a1ef5a04b4ebe97352ff3bb227476035c">fell</a>()</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"></td></tr> |
||||
<tr class="even"><td class="entry"><a class="el" href="class_debouncer.html#a930bf3945e698d77b889f6309079857d">interval</a>(uint16_t interval_millis)</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"></td></tr> |
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>interval_millis</b> (defined in <a class="el" href="class_debouncer.html">Debouncer</a>)</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> |
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>previous_millis</b> (defined in <a class="el" href="class_debouncer.html">Debouncer</a>)</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> |
||||
<tr><td class="entry"><a class="el" href="class_debouncer.html#a89ab95e7ac24874bb8cb684dc36a98b9">previousDuration</a>()</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"></td></tr> |
||||
<tr class="even"><td class="entry"><a class="el" href="class_debouncer.html#a2cae68910c19c778507f257842fc41bf">read</a>()</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"></td></tr> |
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>readCurrentState</b>()=0 (defined in <a class="el" href="class_debouncer.html">Debouncer</a>)</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></td></tr> |
||||
<tr class="even"><td class="entry"><a class="el" href="class_debouncer.html#a9990de6fa7256842c35c246d7dea8dbb">rose</a>()</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"></td></tr> |
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>state</b> (defined in <a class="el" href="class_debouncer.html">Debouncer</a>)</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> |
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>stateChangeLastTime</b> (defined in <a class="el" href="class_debouncer.html">Debouncer</a>)</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> |
||||
<tr><td class="entry"><a class="el" href="class_debouncer.html#a72f3e8d483555031d2ac21b0b7702c06">update</a>()</td><td class="entry"><a class="el" href="class_debouncer.html">Debouncer</a></td><td class="entry"></td></tr> |
||||
</table></div><!-- contents --> |
||||
<!-- start footer part --> |
||||
<hr class="footer"/><address class="footer"><small> |
||||
Generated by  <a href="http://www.doxygen.org/index.html"> |
||||
<img class="footer" src="doxygen.png" alt="doxygen"/> |
||||
</a> 1.8.17 |
||||
</small></address> |
||||
</body> |
||||
</html> |
@ -0,0 +1,320 @@ |
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/> |
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/> |
||||
<title>Bounce2: Debouncer Class Reference</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/searchdata.js"></script> |
||||
<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;"> |
||||
<div id="projectname">Bounce2 |
||||
</div> |
||||
</td> |
||||
</tr> |
||||
</tbody> |
||||
</table> |
||||
</div> |
||||
<!-- end header part --> |
||||
<!-- Generated by Doxygen 1.8.17 --> |
||||
<script type="text/javascript"> |
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
||||
/* @license-end */ |
||||
</script> |
||||
<script type="text/javascript" src="menudata.js"></script> |
||||
<script type="text/javascript" src="menu.js"></script> |
||||
<script type="text/javascript"> |
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
||||
$(function() { |
||||
initMenu('',true,false,'search.php','Search'); |
||||
$(document).ready(function() { init_search(); }); |
||||
}); |
||||
/* @license-end */</script> |
||||
<div id="main-nav"></div> |
||||
<!-- window showing the filter options --> |
||||
<div id="MSearchSelectWindow" |
||||
onmouseover="return searchBox.OnSearchSelectShow()" |
||||
onmouseout="return searchBox.OnSearchSelectHide()" |
||||
onkeydown="return searchBox.OnSearchSelectKey(event)"> |
||||
</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><!-- top --> |
||||
<div class="header"> |
||||
<div class="summary"> |
||||
<a href="#pub-methods">Public Member Functions</a> | |
||||
<a href="#pro-methods">Protected Member Functions</a> | |
||||
<a href="#pro-attribs">Protected Attributes</a> | |
||||
<a href="class_debouncer-members.html">List of all members</a> </div> |
||||
<div class="headertitle"> |
||||
<div class="title">Debouncer Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
||||
</div><!--header--> |
||||
<div class="contents"> |
||||
|
||||
<p>The Debouce class. Just the deboucing code separated from all harware. |
||||
<a href="class_debouncer.html#details">More...</a></p> |
||||
|
||||
<p><code>#include <<a class="el" href="_bounce2_8h_source.html">Bounce2.h</a>></code></p> |
||||
<div class="dynheader"> |
||||
Inheritance diagram for Debouncer:</div> |
||||
<div class="dyncontent"> |
||||
<div class="center"> |
||||
<img src="class_debouncer.png" usemap="#Debouncer_map" alt=""/> |
||||
<map id="Debouncer_map" name="Debouncer_map"> |
||||
<area href="class_bounce.html" title="The Debouncer:Bounce class. Links the Deboucing class to a hardware pin." alt="Bounce" shape="rect" coords="0,56,103,80"/> |
||||
<area href="class_bounce2_1_1_button.html" alt="Bounce2::Button" shape="rect" coords="0,112,103,136"/> |
||||
</map> |
||||
</div></div> |
||||
<table class="memberdecls"> |
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
||||
Public Member Functions</h2></td></tr> |
||||
<tr class="memitem:a34c46ca04d4178933cc0049436d10fe6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_debouncer.html#a34c46ca04d4178933cc0049436d10fe6">Debouncer</a> ()</td></tr> |
||||
<tr class="memdesc:a34c46ca04d4178933cc0049436d10fe6"><td class="mdescLeft"> </td><td class="mdescRight">Create an instance of the Debounce class. <a href="class_debouncer.html#a34c46ca04d4178933cc0049436d10fe6">More...</a><br /></td></tr> |
||||
<tr class="separator:a34c46ca04d4178933cc0049436d10fe6"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a930bf3945e698d77b889f6309079857d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_debouncer.html#a930bf3945e698d77b889f6309079857d">interval</a> (uint16_t interval_millis)</td></tr> |
||||
<tr class="memdesc:a930bf3945e698d77b889f6309079857d"><td class="mdescLeft"> </td><td class="mdescRight">Sets the debounce interval in milliseconds. <a href="class_debouncer.html#a930bf3945e698d77b889f6309079857d">More...</a><br /></td></tr> |
||||
<tr class="separator:a930bf3945e698d77b889f6309079857d"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a72f3e8d483555031d2ac21b0b7702c06"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_debouncer.html#a72f3e8d483555031d2ac21b0b7702c06">update</a> ()</td></tr> |
||||
<tr class="memdesc:a72f3e8d483555031d2ac21b0b7702c06"><td class="mdescLeft"> </td><td class="mdescRight">Updates the pin's state. <a href="class_debouncer.html#a72f3e8d483555031d2ac21b0b7702c06">More...</a><br /></td></tr> |
||||
<tr class="separator:a72f3e8d483555031d2ac21b0b7702c06"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a2cae68910c19c778507f257842fc41bf"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_debouncer.html#a2cae68910c19c778507f257842fc41bf">read</a> ()</td></tr> |
||||
<tr class="memdesc:a2cae68910c19c778507f257842fc41bf"><td class="mdescLeft"> </td><td class="mdescRight">Returns the pin's state (HIGH or LOW). <a href="class_debouncer.html#a2cae68910c19c778507f257842fc41bf">More...</a><br /></td></tr> |
||||
<tr class="separator:a2cae68910c19c778507f257842fc41bf"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a1ef5a04b4ebe97352ff3bb227476035c"><td class="memItemLeft" align="right" valign="top"><a id="a1ef5a04b4ebe97352ff3bb227476035c"></a> |
||||
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_debouncer.html#a1ef5a04b4ebe97352ff3bb227476035c">fell</a> ()</td></tr> |
||||
<tr class="memdesc:a1ef5a04b4ebe97352ff3bb227476035c"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if pin signal transitions from high to low. <br /></td></tr> |
||||
<tr class="separator:a1ef5a04b4ebe97352ff3bb227476035c"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a9990de6fa7256842c35c246d7dea8dbb"><td class="memItemLeft" align="right" valign="top"><a id="a9990de6fa7256842c35c246d7dea8dbb"></a> |
||||
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_debouncer.html#a9990de6fa7256842c35c246d7dea8dbb">rose</a> ()</td></tr> |
||||
<tr class="memdesc:a9990de6fa7256842c35c246d7dea8dbb"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if pin signal transitions from low to high. <br /></td></tr> |
||||
<tr class="separator:a9990de6fa7256842c35c246d7dea8dbb"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a47c83f13a03920d21fbfafd8469ec06b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_debouncer.html#a47c83f13a03920d21fbfafd8469ec06b">changed</a> ()</td></tr> |
||||
<tr class="memdesc:a47c83f13a03920d21fbfafd8469ec06b"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the state changed on last update. <a href="class_debouncer.html#a47c83f13a03920d21fbfafd8469ec06b">More...</a><br /></td></tr> |
||||
<tr class="separator:a47c83f13a03920d21fbfafd8469ec06b"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a462994f1f9a20876b2ee239eeee97448"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="class_debouncer.html#a462994f1f9a20876b2ee239eeee97448">duration</a> ()</td></tr> |
||||
<tr class="memdesc:a462994f1f9a20876b2ee239eeee97448"><td class="mdescLeft"> </td><td class="mdescRight">Returns the duration in milliseconds of the current state. <a href="class_debouncer.html#a462994f1f9a20876b2ee239eeee97448">More...</a><br /></td></tr> |
||||
<tr class="separator:a462994f1f9a20876b2ee239eeee97448"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a89ab95e7ac24874bb8cb684dc36a98b9"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="class_debouncer.html#a89ab95e7ac24874bb8cb684dc36a98b9">previousDuration</a> ()</td></tr> |
||||
<tr class="memdesc:a89ab95e7ac24874bb8cb684dc36a98b9"><td class="mdescLeft"> </td><td class="mdescRight">Returns the duration in milliseconds of the previous state. <a href="class_debouncer.html#a89ab95e7ac24874bb8cb684dc36a98b9">More...</a><br /></td></tr> |
||||
<tr class="separator:a89ab95e7ac24874bb8cb684dc36a98b9"><td class="memSeparator" colspan="2"> </td></tr> |
||||
</table><table class="memberdecls"> |
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> |
||||
Protected Member Functions</h2></td></tr> |
||||
<tr class="memitem:a38f85f1c1819a5634d93565e0459117b"><td class="memItemLeft" align="right" valign="top"><a id="a38f85f1c1819a5634d93565e0459117b"></a> |
||||
void </td><td class="memItemRight" valign="bottom"><b>begin</b> ()</td></tr> |
||||
<tr class="separator:a38f85f1c1819a5634d93565e0459117b"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a4a377599ec41b901d6a291809c60eb4f"><td class="memItemLeft" align="right" valign="top"><a id="a4a377599ec41b901d6a291809c60eb4f"></a> |
||||
virtual bool </td><td class="memItemRight" valign="bottom"><b>readCurrentState</b> ()=0</td></tr> |
||||
<tr class="separator:a4a377599ec41b901d6a291809c60eb4f"><td class="memSeparator" colspan="2"> </td></tr> |
||||
</table><table class="memberdecls"> |
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> |
||||
Protected Attributes</h2></td></tr> |
||||
<tr class="memitem:afab369aec42a15595ebac695a088cccd"><td class="memItemLeft" align="right" valign="top"><a id="afab369aec42a15595ebac695a088cccd"></a> |
||||
unsigned long </td><td class="memItemRight" valign="bottom"><b>previous_millis</b></td></tr> |
||||
<tr class="separator:afab369aec42a15595ebac695a088cccd"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a25f000f08b3291f80154ec620abfe52a"><td class="memItemLeft" align="right" valign="top"><a id="a25f000f08b3291f80154ec620abfe52a"></a> |
||||
uint16_t </td><td class="memItemRight" valign="bottom"><b>interval_millis</b></td></tr> |
||||
<tr class="separator:a25f000f08b3291f80154ec620abfe52a"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a50b7f921222452bf7328ad84d09c15af"><td class="memItemLeft" align="right" valign="top"><a id="a50b7f921222452bf7328ad84d09c15af"></a> |
||||
uint8_t </td><td class="memItemRight" valign="bottom"><b>state</b></td></tr> |
||||
<tr class="separator:a50b7f921222452bf7328ad84d09c15af"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:a1bcf1b5c2a67b6409fea2e8705bcab57"><td class="memItemLeft" align="right" valign="top"><a id="a1bcf1b5c2a67b6409fea2e8705bcab57"></a> |
||||
unsigned long </td><td class="memItemRight" valign="bottom"><b>stateChangeLastTime</b></td></tr> |
||||
<tr class="separator:a1bcf1b5c2a67b6409fea2e8705bcab57"><td class="memSeparator" colspan="2"> </td></tr> |
||||
<tr class="memitem:adbe8de6a1cfff329629e9136a4efea6c"><td class="memItemLeft" align="right" valign="top"><a id="adbe8de6a1cfff329629e9136a4efea6c"></a> |
||||
unsigned long </td><td class="memItemRight" valign="bottom"><b>durationOfPreviousState</b></td></tr> |
||||
<tr class="separator:adbe8de6a1cfff329629e9136a4efea6c"><td class="memSeparator" colspan="2"> </td></tr> |
||||
</table> |
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
||||
<div class="textblock"><p>The Debouce class. Just the deboucing code separated from all harware. </p> |
||||
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
||||
<a id="a34c46ca04d4178933cc0049436d10fe6"></a> |
||||
<h2 class="memtitle"><span class="permalink"><a href="#a34c46ca04d4178933cc0049436d10fe6">◆ </a></span>Debouncer()</h2> |
||||
|
||||
<div class="memitem"> |
||||
<div class="memproto"> |
||||
<table class="memname"> |
||||
<tr> |
||||
<td class="memname">Debouncer::Debouncer </td> |
||||
<td>(</td> |
||||
<td class="paramname"></td><td>)</td> |
||||
<td></td> |
||||
</tr> |
||||
</table> |
||||
</div><div class="memdoc"> |
||||
|
||||
<p>Create an instance of the Debounce class. </p> |
||||
|
||||
</div> |
||||
</div> |
||||
<h2 class="groupheader">Member Function Documentation</h2> |
||||
<a id="a47c83f13a03920d21fbfafd8469ec06b"></a> |
||||
<h2 class="memtitle"><span class="permalink"><a href="#a47c83f13a03920d21fbfafd8469ec06b">◆ </a></span>changed()</h2> |
||||
|
||||
<div class="memitem"> |
||||
<div class="memproto"> |
||||
<table class="mlabels"> |
||||
<tr> |
||||
<td class="mlabels-left"> |
||||
<table class="memname"> |
||||
<tr> |
||||
<td class="memname">bool Debouncer::changed </td> |
||||
<td>(</td> |
||||
<td class="paramname"></td><td>)</td> |
||||
<td></td> |
||||
</tr> |
||||
</table> |
||||
</td> |
||||
<td class="mlabels-right"> |
||||
<span class="mlabels"><span class="mlabel">inline</span></span> </td> |
||||
</tr> |
||||
</table> |
||||
</div><div class="memdoc"> |
||||
|
||||
<p>Returns true if the state changed on last update. </p> |
||||
<dl class="section return"><dt>Returns</dt><dd>True if the state changed on last update. Otherwise, returns false. </dd></dl> |
||||
|
||||
</div> |
||||
</div> |
||||
<a id="a462994f1f9a20876b2ee239eeee97448"></a> |
||||
<h2 class="memtitle"><span class="permalink"><a href="#a462994f1f9a20876b2ee239eeee97448">◆ </a></span>duration()</h2> |
||||
|
||||
<div class="memitem"> |
||||
<div class="memproto"> |
||||
<table class="memname"> |
||||
<tr> |
||||
<td class="memname">unsigned long Debouncer::duration </td> |
||||
<td>(</td> |
||||
<td class="paramname"></td><td>)</td> |
||||
<td></td> |
||||
</tr> |
||||
</table> |
||||
</div><div class="memdoc"> |
||||
|
||||
<p>Returns the duration in milliseconds of the current state. </p> |
||||
<p>Is reset to 0 once the pin rises ( <a class="el" href="class_debouncer.html#a9990de6fa7256842c35c246d7dea8dbb" title="Returns true if pin signal transitions from low to high.">rose()</a> ) or falls ( <a class="el" href="class_debouncer.html#a1ef5a04b4ebe97352ff3bb227476035c" title="Returns true if pin signal transitions from high to low.">fell()</a> ).</p> |
||||
<dl class="section return"><dt>Returns</dt><dd>The duration in milliseconds (unsigned long) of the current state. </dd></dl> |
||||
|
||||
</div> |
||||
</div> |
||||
<a id="a930bf3945e698d77b889f6309079857d"></a> |
||||
<h2 class="memtitle"><span class="permalink"><a href="#a930bf3945e698d77b889f6309079857d">◆ </a></span>interval()</h2> |
||||
|
||||
<div class="memitem"> |
||||
<div class="memproto"> |
||||
<table class="memname"> |
||||
<tr> |
||||
<td class="memname">void Debouncer::interval </td> |
||||
<td>(</td> |
||||
<td class="paramtype">uint16_t </td> |
||||
<td class="paramname"><em>interval_millis</em></td><td>)</td> |
||||
<td></td> |
||||
</tr> |
||||
</table> |
||||
</div><div class="memdoc"> |
||||
|
||||
<p>Sets the debounce interval in milliseconds. </p> |
||||
<dl class="params"><dt>Parameters</dt><dd> |
||||
<table class="params"> |
||||
<tr><td class="paramname">interval_millis</td><td>The interval time in milliseconds. </td></tr> |
||||
</table> |
||||
</dd> |
||||
</dl> |
||||
|
||||
</div> |
||||
</div> |
||||
<a id="a89ab95e7ac24874bb8cb684dc36a98b9"></a> |
||||
<h2 class="memtitle"><span class="permalink"><a href="#a89ab95e7ac24874bb8cb684dc36a98b9">◆ </a></span>previousDuration()</h2> |
||||
|
||||
<div class="memitem"> |
||||
<div class="memproto"> |
||||
<table class="memname"> |
||||
<tr> |
||||
<td class="memname">unsigned long Debouncer::previousDuration </td> |
||||
<td>(</td> |
||||
<td class="paramname"></td><td>)</td> |
||||
<td></td> |
||||
</tr> |
||||
</table> |
||||
</div><div class="memdoc"> |
||||
|
||||
<p>Returns the duration in milliseconds of the previous state. </p> |
||||
<p>Takes the values of <a class="el" href="class_debouncer.html#a462994f1f9a20876b2ee239eeee97448" title="Returns the duration in milliseconds of the current state.">duration()</a> once the pin changes state.</p> |
||||
<dl class="section return"><dt>Returns</dt><dd>The duration in milliseconds (unsigned long) of the previous state. </dd></dl> |
||||
|
||||
</div> |
||||
</div> |
||||
<a id="a2cae68910c19c778507f257842fc41bf"></a> |
||||
<h2 class="memtitle"><span class="permalink"><a href="#a2cae68910c19c778507f257842fc41bf">◆ </a></span>read()</h2> |
||||
|
||||
<div class="memitem"> |
||||
<div class="memproto"> |
||||
<table class="memname"> |
||||
<tr> |
||||
<td class="memname">bool Debouncer::read </td> |
||||
<td>(</td> |
||||
<td class="paramname"></td><td>)</td> |
||||
<td></td> |
||||
</tr> |
||||
</table> |
||||
</div><div class="memdoc"> |
||||
|
||||
<p>Returns the pin's state (HIGH or LOW). </p> |
||||
<dl class="section return"><dt>Returns</dt><dd>HIGH or LOW. </dd></dl> |
||||
|
||||
</div> |
||||
</div> |
||||
<a id="a72f3e8d483555031d2ac21b0b7702c06"></a> |
||||
<h2 class="memtitle"><span class="permalink"><a href="#a72f3e8d483555031d2ac21b0b7702c06">◆ </a></span>update()</h2> |
||||
|
||||
<div class="memitem"> |
||||
<div class="memproto"> |
||||
<table class="memname"> |
||||
<tr> |
||||
<td class="memname">bool Debouncer::update </td> |
||||
<td>(</td> |
||||
<td class="paramname"></td><td>)</td> |
||||
<td></td> |
||||
</tr> |
||||
</table> |
||||
</div><div class="memdoc"> |
||||
|
||||
<p>Updates the pin's state. </p> |
||||
<p>Because <a class="el" href="class_bounce.html" title="The Debouncer:Bounce class. Links the Deboucing class to a hardware pin.">Bounce</a> does not use interrupts, you have to "update" the object before reading its value and it has to be done as often as possible (that means to include it in your loop()). Only call <a class="el" href="class_debouncer.html#a72f3e8d483555031d2ac21b0b7702c06" title="Updates the pin's state.">update()</a> once per loop().</p> |
||||
<dl class="section return"><dt>Returns</dt><dd>True if the pin changed state. </dd></dl> |
||||
|
||||
</div> |
||||
</div> |
||||
<hr/>The documentation for this class was generated from the following files:<ul> |
||||
<li>src/<a class="el" href="_bounce2_8h_source.html">Bounce2.h</a></li> |
||||
<li>src/Bounce2.cpp</li> |
||||
</ul> |
||||
</div><!-- contents --> |
||||
<!-- start footer part --> |
||||
<hr class="footer"/><address class="footer"><small> |
||||
Generated by  <a href="http://www.doxygen.org/index.html"> |
||||
<img class="footer" src="doxygen.png" alt="doxygen"/> |
||||
</a> 1.8.17 |
||||
</small></address> |
||||
</body> |
||||
</html> |
After Width: | Height: | Size: 626 B |
@ -0,0 +1,77 @@ |
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/> |
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/> |
||||
<title>Bounce2: Class Members - Variables</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/searchdata.js"></script> |
||||
<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;"> |
||||
<div id="projectname">Bounce2 |
||||
</div> |
||||
</td> |
||||
</tr> |
||||
</tbody> |
||||
</table> |
||||
</div> |
||||
<!-- end header part --> |
||||
<!-- Generated by Doxygen 1.8.17 --> |
||||
<script type="text/javascript"> |
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
||||
/* @license-end */ |
||||
</script> |
||||
<script type="text/javascript" src="menudata.js"></script> |
||||
<script type="text/javascript" src="menu.js"></script> |
||||
<script type="text/javascript"> |
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
||||
$(function() { |
||||
initMenu('',true,false,'search.php','Search'); |
||||
$(document).ready(function() { init_search(); }); |
||||
}); |
||||
/* @license-end */</script> |
||||
<div id="main-nav"></div> |
||||
</div><!-- top --> |
||||
<!-- window showing the filter options --> |
||||
<div id="MSearchSelectWindow" |
||||
onmouseover="return searchBox.OnSearchSelectShow()" |
||||
onmouseout="return searchBox.OnSearchSelectHide()" |
||||
onkeydown="return searchBox.OnSearchSelectKey(event)"> |
||||
</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 class="contents"> |
||||
 <ul> |
||||
<li>pin |
||||
: <a class="el" href="class_bounce.html#a1cb79cb0ba2379cd12cc7c098d97053a">Bounce</a> |
||||
</li> |
||||
</ul> |
||||
</div><!-- contents --> |
||||
<!-- start footer part --> |
||||
<hr class="footer"/><address class="footer"><small> |
||||
Generated by  <a href="http://www.doxygen.org/index.html"> |
||||
<img class="footer" src="doxygen.png" alt="doxygen"/> |
||||
</a> 1.8.17 |
||||
</small></address> |
||||
</body> |
||||
</html> |
@ -0,0 +1,83 @@ |
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/> |
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/> |
||||
<title>Bounce2: Class Hierarchy</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/searchdata.js"></script> |
||||
<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;"> |
||||
<div id="projectname">Bounce2 |
||||
</div> |
||||
</td> |
||||
</tr> |
||||
</tbody> |
||||
</table> |
||||
</div> |
||||
<!-- end header part --> |
||||
<!-- Generated by Doxygen 1.8.17 --> |
||||
<script type="text/javascript"> |
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
||||
/* @license-end */ |
||||
</script> |
||||
<script type="text/javascript" src="menudata.js"></script> |
||||
<script type="text/javascript" src="menu.js"></script> |
||||
<script type="text/javascript"> |
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
||||
$(function() { |
||||
initMenu('',true,false,'search.php','Search'); |
||||
$(document).ready(function() { init_search(); }); |
||||
}); |
||||
/* @license-end */</script> |
||||
<div id="main-nav"></div> |
||||
</div><!-- top --> |
||||
<!-- window showing the filter options --> |
||||
<div id="MSearchSelectWindow" |
||||
onmouseover="return searchBox.OnSearchSelectShow()" |
||||
onmouseout="return searchBox.OnSearchSelectHide()" |
||||
onkeydown="return searchBox.OnSearchSelectKey(event)"> |
||||
</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 class="header"> |
||||
<div class="headertitle"> |
||||
<div class="title">Class Hierarchy</div> </div> |
||||
</div><!--header--> |
||||
<div class="contents"> |
||||
<div class="textblock">This inheritance list is sorted roughly, but not completely, alphabetically:</div><div class="directory"> |
||||
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span>]</div><table class="directory"> |
||||
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">▼</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_debouncer.html" target="_self">Debouncer</a></td><td class="desc">The Debouce class. Just the deboucing code separated from all harware </td></tr> |
||||
<tr id="row_0_0_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span id="arr_0_0_" class="arrow" onclick="toggleFolder('0_0_')">▼</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_bounce.html" target="_self">Bounce</a></td><td class="desc">The <a class="el" href="class_debouncer.html" title="The Debouce class. Just the deboucing code separated from all harware.">Debouncer</a>:<a class="el" href="class_bounce.html" title="The Debouncer:Bounce class. Links the Deboucing class to a hardware pin.">Bounce</a> class. Links the Deboucing class to a hardware pin </td></tr> |
||||
<tr id="row_0_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_bounce2_1_1_button.html" target="_self">Bounce2::Button</a></td><td class="desc"></td></tr> |
||||
</table> |
||||
</div><!-- directory --> |
||||
</div><!-- contents --> |
||||
<!-- start footer part --> |
||||
<hr class="footer"/><address class="footer"><small> |
||||
Generated by  <a href="http://www.doxygen.org/index.html"> |
||||
<img class="footer" src="doxygen.png" alt="doxygen"/> |
||||
</a> 1.8.17 |
||||
</small></address> |
||||
</body> |
||||
</html> |
File diff suppressed because one or more lines are too long
@ -1,11 +1,37 @@ |
||||
/* |
||||
@licstart The following is the entire license notice for the |
||||
JavaScript code in this file. |
||||
|
||||
Copyright (C) 1997-2019 by Dimitri van Heesch |
||||
|
||||
This program is free software; you can redistribute it and/or modify |
||||
it under the terms of version 2 of the GNU General Public License as published by |
||||
the Free Software Foundation |
||||
|
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
|
||||
You should have received a copy of the GNU General Public License along |
||||
with this program; if not, write to the Free Software Foundation, Inc., |
||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. |
||||
|
||||
@licend The above is the entire license notice |
||||
for the JavaScript code in this file |
||||
*/ |
||||
var menudata={children:[ |
||||
{text:"Main Page",url:"index.html"}, |
||||
{text:"Namespaces",url:"namespaces.html",children:[ |
||||
{text:"Namespace List",url:"namespaces.html"}]}, |
||||
{text:"Classes",url:"annotated.html",children:[ |
||||
{text:"Class List",url:"annotated.html"}, |
||||
{text:"Class Index",url:"classes.html"}, |
||||
{text:"Class Hierarchy",url:"hierarchy.html"}, |
||||
{text:"Class Members",url:"functions.html",children:[ |
||||
{text:"All",url:"functions.html"}, |
||||
{text:"Functions",url:"functions_func.html"}]}]}, |
||||
{text:"Functions",url:"functions_func.html"}, |
||||
{text:"Variables",url:"functions_vars.html"}]}]}, |
||||
{text:"Files",url:"files.html",children:[ |
||||
{text:"File List",url:"files.html"}]}, |
||||
{text:"Examples",url:"examples.html"}]} |
||||
|
@ -0,0 +1,89 @@ |
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/> |
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/> |
||||
<title>Bounce2: Bounce2 Namespace Reference</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/searchdata.js"></script> |
||||
<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;"> |
||||
<div id="projectname">Bounce2 |
||||
</div> |
||||
</td> |
||||
</tr> |
||||
</tbody> |
||||
</table> |
||||
</div> |
||||
<!-- end header part --> |
||||
<!-- Generated by Doxygen 1.8.17 --> |
||||
<script type="text/javascript"> |
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
||||
/* @license-end */ |
||||
</script> |
||||
<script type="text/javascript" src="menudata.js"></script> |
||||
<script type="text/javascript" src="menu.js"></script> |
||||
<script type="text/javascript"> |
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
||||
$(function() { |
||||
initMenu('',true,false,'search.php','Search'); |
||||
$(document).ready(function() { init_search(); }); |
||||
}); |
||||
/* @license-end */</script> |
||||
<div id="main-nav"></div> |
||||
<!-- window showing the filter options --> |
||||
<div id="MSearchSelectWindow" |
||||
onmouseover="return searchBox.OnSearchSelectShow()" |
||||
onmouseout="return searchBox.OnSearchSelectHide()" |
||||
onkeydown="return searchBox.OnSearchSelectKey(event)"> |
||||
</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><!-- top --> |
||||
<div class="header"> |
||||
<div class="summary"> |
||||
<a href="#nested-classes">Classes</a> </div> |
||||
<div class="headertitle"> |
||||
<div class="title">Bounce2 Namespace Reference</div> </div> |
||||
</div><!--header--> |
||||
<div class="contents"> |
||||
|
||||
<p>The Debouncer:Bounce:<a class="el" href="class_bounce2_1_1_button.html">Button</a> class. The <a class="el" href="class_bounce2_1_1_button.html">Button</a> class matches an electrical state to a physical action. |
||||
<a href="namespace_bounce2.html#details">More...</a></p> |
||||
<table class="memberdecls"> |
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> |
||||
Classes</h2></td></tr> |
||||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bounce2_1_1_button.html">Button</a></td></tr> |
||||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
||||
</table> |
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
||||
<div class="textblock"><p>The Debouncer:Bounce:<a class="el" href="class_bounce2_1_1_button.html">Button</a> class. The <a class="el" href="class_bounce2_1_1_button.html">Button</a> class matches an electrical state to a physical action. </p> |
||||
</div></div><!-- contents --> |
||||
<!-- start footer part --> |
||||
<hr class="footer"/><address class="footer"><small> |
||||
Generated by  <a href="http://www.doxygen.org/index.html"> |
||||
<img class="footer" src="doxygen.png" alt="doxygen"/> |
||||
</a> 1.8.17 |
||||
</small></address> |
||||
</body> |
||||
</html> |
@ -0,0 +1,81 @@ |
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/> |
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/> |
||||
<title>Bounce2: Namespace List</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/searchdata.js"></script> |
||||
<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;"> |
||||
<div id="projectname">Bounce2 |
||||
</div> |
||||
</td> |
||||
</tr> |
||||
</tbody> |
||||
</table> |
||||
</div> |
||||
<!-- end header part --> |
||||
<!-- Generated by Doxygen 1.8.17 --> |
||||
<script type="text/javascript"> |
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
||||
/* @license-end */ |
||||
</script> |
||||
<script type="text/javascript" src="menudata.js"></script> |
||||
<script type="text/javascript" src="menu.js"></script> |
||||
<script type="text/javascript"> |
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
||||
$(function() { |
||||
initMenu('',true,false,'search.php','Search'); |
||||
$(document).ready(function() { init_search(); }); |
||||
}); |
||||
/* @license-end */</script> |
||||
<div id="main-nav"></div> |
||||
</div><!-- top --> |
||||
<!-- window showing the filter options --> |
||||
<div id="MSearchSelectWindow" |
||||
onmouseover="return searchBox.OnSearchSelectShow()" |
||||
onmouseout="return searchBox.OnSearchSelectHide()" |
||||
onkeydown="return searchBox.OnSearchSelectKey(event)"> |
||||
</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 class="header"> |
||||
<div class="headertitle"> |
||||
<div class="title">Namespace List</div> </div> |
||||
</div><!--header--> |
||||
<div class="contents"> |
||||
<div class="textblock">Here is a list of all documented namespaces with brief descriptions:</div><div class="directory"> |
||||
<table class="directory"> |
||||
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespace_bounce2.html" target="_self">Bounce2</a></td><td class="desc">The Debouncer:Bounce:<a class="el" href="class_bounce2_1_1_button.html">Button</a> class. The <a class="el" href="class_bounce2_1_1_button.html">Button</a> class matches an electrical state to a physical action </td></tr> |
||||
</table> |
||||
</div><!-- directory --> |
||||
</div><!-- contents --> |
||||
<!-- start footer part --> |
||||
<hr class="footer"/><address class="footer"><small> |
||||
Generated by  <a href="http://www.doxygen.org/index.html"> |
||||
<img class="footer" src="doxygen.png" alt="doxygen"/> |
||||
</a> 1.8.17 |
||||
</small></address> |
||||
</body> |
||||
</html> |
@ -1,4 +1,4 @@ |
||||
var searchData= |
||||
[ |
||||
['attach',['attach',['../class_bounce.html#aba08e592941465d033e3eba3dde66eaf',1,'Bounce::attach(int pin, int mode)'],['../class_bounce.html#a163477dbcbaf1a3dee6cb3b62eedf09e',1,'Bounce::attach(int pin)']]] |
||||
['attach_0',['attach',['../class_bounce.html#aba08e592941465d033e3eba3dde66eaf',1,'Bounce::attach(int pin, int mode)'],['../class_bounce.html#a163477dbcbaf1a3dee6cb3b62eedf09e',1,'Bounce::attach(int pin)']]] |
||||
]; |
||||
|
@ -1,5 +1,7 @@ |
||||
var searchData= |
||||
[ |
||||
['bounce',['Bounce',['../class_bounce.html',1,'Bounce'],['../class_bounce.html#aa62a2e2b5ad0ee6913a95f2f2a0e7606',1,'Bounce::Bounce()'],['../class_bounce.html#ab34517094faf21d4f38b36da2915132b',1,'Bounce::Bounce(uint8_t pin, unsigned long interval_millis)']]], |
||||
['bounce_202',['BOUNCE 2',['../index.html',1,'']]] |
||||
['bounce_1',['Bounce',['../class_bounce.html',1,'Bounce'],['../class_bounce.html#aa62a2e2b5ad0ee6913a95f2f2a0e7606',1,'Bounce::Bounce()']]], |
||||
['bounce2_2',['Bounce2',['../namespace_bounce2.html',1,'']]], |
||||
['button_3',['Button',['../class_bounce2_1_1_button.html',1,'Bounce2::Button'],['../class_bounce2_1_1_button.html#a18710b645862d2b8f058a73aabbaf7ad',1,'Bounce2::Button::Button()']]], |
||||
['bounce_202_4',['BOUNCE 2',['../index.html',1,'']]] |
||||
]; |
||||
|
@ -1,4 +1,4 @@ |
||||
var searchData= |
||||
[ |
||||
['duration',['duration',['../class_bounce.html#a62412d814d36102ab3d285e801d5d29a',1,'Bounce']]] |
||||
['changed_5',['changed',['../class_debouncer.html#a47c83f13a03920d21fbfafd8469ec06b',1,'Debouncer']]] |
||||
]; |
||||
|
@ -1,5 +1,5 @@ |
||||
var searchData= |
||||
[ |
||||
['fallingedge',['fallingEdge',['../class_bounce.html#ac756559419bfa1c5060e5e4a4ad6406f',1,'Bounce']]], |
||||
['fell',['fell',['../class_bounce.html#abfbb0910f5b1ec4e25315cff26dd6289',1,'Bounce']]] |
||||
['debouncer_6',['Debouncer',['../class_debouncer.html',1,'Debouncer'],['../class_debouncer.html#a34c46ca04d4178933cc0049436d10fe6',1,'Debouncer::Debouncer()']]], |
||||
['duration_7',['duration',['../class_debouncer.html#a462994f1f9a20876b2ee239eeee97448',1,'Debouncer']]] |
||||
]; |
||||
|
@ -1,4 +1,5 @@ |
||||
var searchData= |
||||
[ |
||||
['interval',['interval',['../class_bounce.html#a2c6e68bf749497c597a9437b488b3d7c',1,'Bounce']]] |
||||
['fallingedge_8',['fallingEdge',['../class_bounce.html#ac756559419bfa1c5060e5e4a4ad6406f',1,'Bounce']]], |
||||
['fell_9',['fell',['../class_debouncer.html#a1ef5a04b4ebe97352ff3bb227476035c',1,'Debouncer']]] |
||||
]; |
||||
|
@ -1,6 +1,4 @@ |
||||
var searchData= |
||||
[ |
||||
['read',['read',['../class_bounce.html#ae1936fdf44501992707e6cbaee9bbc76',1,'Bounce']]], |
||||
['risingedge',['risingEdge',['../class_bounce.html#a3417beb80eb6593d768c2e9884c57aa0',1,'Bounce']]], |
||||
['rose',['rose',['../class_bounce.html#a9e4187934576e568cdfa8f94efeff6f2',1,'Bounce']]] |
||||
['getpressedstate_10',['getPressedState',['../class_bounce2_1_1_button.html#ab9e2b89ad499fa4b052370140730b6ba',1,'Bounce2::Button']]] |
||||
]; |
||||
|
@ -1,4 +1,5 @@ |
||||
var searchData= |
||||
[ |
||||
['update',['update',['../class_bounce.html#ab36d7b83bf32e0935a0c2c6a05096441',1,'Bounce']]] |
||||
['interval_11',['interval',['../class_debouncer.html#a930bf3945e698d77b889f6309079857d',1,'Debouncer']]], |
||||
['ispressed_12',['isPressed',['../class_bounce2_1_1_button.html#a94c31de8109c89d6ee577ed9b14ea676',1,'Bounce2::Button']]] |
||||
]; |
||||
|
@ -0,0 +1,30 @@ |
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
||||
<html><head><title></title> |
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
||||
<meta name="generator" content="Doxygen 1.8.17"/> |
||||
<link rel="stylesheet" type="text/css" href="search.css"/> |
||||
<script type="text/javascript" src="all_7.js"></script> |
||||
<script type="text/javascript" src="search.js"></script> |
||||
</head> |
||||
<body class="SRPage"> |
||||
<div id="SRIndex"> |
||||
<div class="SRStatus" id="Loading">Loading...</div> |
||||
<div id="SRResults"></div> |
||||
<script type="text/javascript"><!-- |
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
||||
createResults(); |
||||
/* @license-end */ |
||||
--></script> |
||||
<div class="SRStatus" id="Searching">Searching...</div> |
||||
<div class="SRStatus" id="NoMatches">No Matches</div> |
||||
<script type="text/javascript"><!-- |
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
||||
document.getElementById("Loading").style.display="none"; |
||||
document.getElementById("NoMatches").style.display="none"; |
||||
var searchResults = new SearchResults("searchResults"); |
||||
searchResults.Search(); |
||||
/* @license-end */ |
||||
--></script> |
||||
</div> |
||||
</body> |
||||
</html> |
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue