724 lines
46 KiB
HTML
724 lines
46 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||
|
|
<meta name="generator" content="Doxygen 1.8.13"/>
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||
|
|
<title>AceButton: ace_button::AceButton 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">AceButton
|
||
|
|
 <span id="projectnumber">1.3.3</span>
|
||
|
|
</div>
|
||
|
|
<div id="projectbrief">An adjustable, compact, event-driven button library for Arduino.</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 id="nav-path" class="navpath">
|
||
|
|
<ul>
|
||
|
|
<li class="navelem"><b>ace_button</b></li><li class="navelem"><a class="el" href="classace__button_1_1AceButton.html">AceButton</a></li> </ul>
|
||
|
|
</div>
|
||
|
|
</div><!-- top -->
|
||
|
|
<div class="header">
|
||
|
|
<div class="summary">
|
||
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
||
|
|
<a href="#pub-static-attribs">Static Public Attributes</a> |
|
||
|
|
<a href="classace__button_1_1AceButton-members.html">List of all members</a> </div>
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">ace_button::AceButton Class Reference</div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p>An Adjustable Compact Event-driven (ACE) Button library that debounces and dispatches button events to a user-defined event handler.
|
||
|
|
<a href="classace__button_1_1AceButton.html#details">More...</a></p>
|
||
|
|
|
||
|
|
<p><code>#include <<a class="el" href="ace__button_2AceButton_8h_source.html">AceButton.h</a>></code></p>
|
||
|
|
<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:a3c480636223edc899a79c821c32c6982"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1AceButton.html#a3c480636223edc899a79c821c32c6982">AceButton</a> (uint8_t pin=0, uint8_t defaultReleasedState=HIGH, uint8_t id=0)</td></tr>
|
||
|
|
<tr class="memdesc:a3c480636223edc899a79c821c32c6982"><td class="mdescLeft"> </td><td class="mdescRight">Constructor defines parameters of the button that changes from button to button. <a href="#a3c480636223edc899a79c821c32c6982">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a3c480636223edc899a79c821c32c6982"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ab2ec2d3b98e2e2228f85271385e07521"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1AceButton.html#ab2ec2d3b98e2e2228f85271385e07521">AceButton</a> (<a class="el" href="classace__button_1_1ButtonConfig.html">ButtonConfig</a> *buttonConfig)</td></tr>
|
||
|
|
<tr class="memdesc:ab2ec2d3b98e2e2228f85271385e07521"><td class="mdescLeft"> </td><td class="mdescRight">Constructor that accepts a <a class="el" href="classace__button_1_1ButtonConfig.html" title="Class that defines the timing parameters and event handler of an AceButton or a group of AceButton in...">ButtonConfig</a> as a dependency. <a href="#ab2ec2d3b98e2e2228f85271385e07521">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ab2ec2d3b98e2e2228f85271385e07521"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a18c47304c694c6f084a343a7c83bef34"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1AceButton.html#a18c47304c694c6f084a343a7c83bef34">init</a> (uint8_t pin=0, uint8_t defaultReleasedState=HIGH, uint8_t id=0)</td></tr>
|
||
|
|
<tr class="memdesc:a18c47304c694c6f084a343a7c83bef34"><td class="mdescLeft"> </td><td class="mdescRight">Reset the button to the initial constructed state. <a href="#a18c47304c694c6f084a343a7c83bef34">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a18c47304c694c6f084a343a7c83bef34"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a5e4ea4aca852a5e0b1d426bccb131cfb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classace__button_1_1ButtonConfig.html">ButtonConfig</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1AceButton.html#a5e4ea4aca852a5e0b1d426bccb131cfb">getButtonConfig</a> () ACE_BUTTON_INLINE</td></tr>
|
||
|
|
<tr class="memdesc:a5e4ea4aca852a5e0b1d426bccb131cfb"><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="classace__button_1_1ButtonConfig.html" title="Class that defines the timing parameters and event handler of an AceButton or a group of AceButton in...">ButtonConfig</a> associated with this Button. <a href="#a5e4ea4aca852a5e0b1d426bccb131cfb">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a5e4ea4aca852a5e0b1d426bccb131cfb"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:abc9d705d1ca4341cf6f9434962b5b5e7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1AceButton.html#abc9d705d1ca4341cf6f9434962b5b5e7">setButtonConfig</a> (<a class="el" href="classace__button_1_1ButtonConfig.html">ButtonConfig</a> *buttonConfig) ACE_BUTTON_INLINE</td></tr>
|
||
|
|
<tr class="memdesc:abc9d705d1ca4341cf6f9434962b5b5e7"><td class="mdescLeft"> </td><td class="mdescRight">Set the <a class="el" href="classace__button_1_1ButtonConfig.html" title="Class that defines the timing parameters and event handler of an AceButton or a group of AceButton in...">ButtonConfig</a> associated with this Button. <a href="#abc9d705d1ca4341cf6f9434962b5b5e7">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:abc9d705d1ca4341cf6f9434962b5b5e7"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a42edbfeb4091c867d976a4d24622f19c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1AceButton.html#a42edbfeb4091c867d976a4d24622f19c">setEventHandler</a> (<a class="el" href="classace__button_1_1ButtonConfig.html#a6d9db3c7b221b474c3cfd8fca5f4ba1e">ButtonConfig::EventHandler</a> eventHandler) ACE_BUTTON_INLINE</td></tr>
|
||
|
|
<tr class="memdesc:a42edbfeb4091c867d976a4d24622f19c"><td class="mdescLeft"> </td><td class="mdescRight">Convenience method to set the event handler. <a href="#a42edbfeb4091c867d976a4d24622f19c">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a42edbfeb4091c867d976a4d24622f19c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ac6b12ca62c7c055325bfebd036579ed6"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1AceButton.html#ac6b12ca62c7c055325bfebd036579ed6">getPin</a> () ACE_BUTTON_INLINE</td></tr>
|
||
|
|
<tr class="memdesc:ac6b12ca62c7c055325bfebd036579ed6"><td class="mdescLeft"> </td><td class="mdescRight">Get the button's pin number. <a href="#ac6b12ca62c7c055325bfebd036579ed6">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ac6b12ca62c7c055325bfebd036579ed6"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a4a693b836e3fed29d4e7203a5a97910b"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1AceButton.html#a4a693b836e3fed29d4e7203a5a97910b">getId</a> () ACE_BUTTON_INLINE</td></tr>
|
||
|
|
<tr class="memdesc:a4a693b836e3fed29d4e7203a5a97910b"><td class="mdescLeft"> </td><td class="mdescRight">Get the custom identifier of the button. <a href="#a4a693b836e3fed29d4e7203a5a97910b">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a4a693b836e3fed29d4e7203a5a97910b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:afa8013bb98f5fbd79654aebca613ba71"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1AceButton.html#afa8013bb98f5fbd79654aebca613ba71">getDefaultReleasedState</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:afa8013bb98f5fbd79654aebca613ba71"><td class="mdescLeft"> </td><td class="mdescRight">Get the initial released state of the button, HIGH or LOW. <a href="#afa8013bb98f5fbd79654aebca613ba71">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:afa8013bb98f5fbd79654aebca613ba71"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a3c49e9edf8cbb5e3800c5f4506d0beca"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1AceButton.html#a3c49e9edf8cbb5e3800c5f4506d0beca">getLastButtonState</a> () ACE_BUTTON_INLINE</td></tr>
|
||
|
|
<tr class="memdesc:a3c49e9edf8cbb5e3800c5f4506d0beca"><td class="mdescLeft"> </td><td class="mdescRight">Return the button state that was last valid. <a href="#a3c49e9edf8cbb5e3800c5f4506d0beca">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a3c49e9edf8cbb5e3800c5f4506d0beca"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:af710048a654fa5d5e45405661282a7b1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1AceButton.html#af710048a654fa5d5e45405661282a7b1">check</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:af710048a654fa5d5e45405661282a7b1"><td class="mdescLeft"> </td><td class="mdescRight">Check state of button and trigger event processing. <a href="#af710048a654fa5d5e45405661282a7b1">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:af710048a654fa5d5e45405661282a7b1"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aa3cbb3fb16076cfe9255e0f70cc6aa72"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1AceButton.html#aa3cbb3fb16076cfe9255e0f70cc6aa72">isReleased</a> (uint8_t buttonState) ACE_BUTTON_INLINE</td></tr>
|
||
|
|
<tr class="memdesc:aa3cbb3fb16076cfe9255e0f70cc6aa72"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the given buttonState represents a 'Released' state for the button. <a href="#aa3cbb3fb16076cfe9255e0f70cc6aa72">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:aa3cbb3fb16076cfe9255e0f70cc6aa72"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:af80a2bd19d929bff5dcce54a3db6fb0a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1AceButton.html#af80a2bd19d929bff5dcce54a3db6fb0a">isPressedRaw</a> () ACE_BUTTON_INLINE</td></tr>
|
||
|
|
<tr class="memdesc:af80a2bd19d929bff5dcce54a3db6fb0a"><td class="mdescLeft"> </td><td class="mdescRight">Read the button state directly using <a class="el" href="classace__button_1_1ButtonConfig.html" title="Class that defines the timing parameters and event handler of an AceButton or a group of AceButton in...">ButtonConfig</a> and return true if the button is in the Pressed state. <a href="#af80a2bd19d929bff5dcce54a3db6fb0a">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:af80a2bd19d929bff5dcce54a3db6fb0a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
|
||
|
|
Static Public Attributes</h2></td></tr>
|
||
|
|
<tr class="memitem:ae723d826fe219a8415764b9fed5d8976"><td class="memItemLeft" align="right" valign="top">static const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1AceButton.html#ae723d826fe219a8415764b9fed5d8976">kEventPressed</a> = 0</td></tr>
|
||
|
|
<tr class="memdesc:ae723d826fe219a8415764b9fed5d8976"><td class="mdescLeft"> </td><td class="mdescRight">Button was pressed. <a href="#ae723d826fe219a8415764b9fed5d8976">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ae723d826fe219a8415764b9fed5d8976"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ada5bd7c31950e2acdb8a9464e795c13c"><td class="memItemLeft" align="right" valign="top">static const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1AceButton.html#ada5bd7c31950e2acdb8a9464e795c13c">kEventReleased</a> = 1</td></tr>
|
||
|
|
<tr class="memdesc:ada5bd7c31950e2acdb8a9464e795c13c"><td class="mdescLeft"> </td><td class="mdescRight">Button was released. <a href="#ada5bd7c31950e2acdb8a9464e795c13c">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ada5bd7c31950e2acdb8a9464e795c13c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a21797e5e069da3f7bba42b40ab3a7305"><td class="memItemLeft" align="right" valign="top"><a id="a21797e5e069da3f7bba42b40ab3a7305"></a>
|
||
|
|
static const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1AceButton.html#a21797e5e069da3f7bba42b40ab3a7305">kEventClicked</a> = 2</td></tr>
|
||
|
|
<tr class="memdesc:a21797e5e069da3f7bba42b40ab3a7305"><td class="mdescLeft"> </td><td class="mdescRight">Button was clicked (Pressed and Released within <a class="el" href="classace__button_1_1ButtonConfig.html#a19db203ce87dc2cafb2cab6ba124387a" title="Milliseconds to wait for a possible click. ">ButtonConfig::getClickDelay()</a>). <br /></td></tr>
|
||
|
|
<tr class="separator:a21797e5e069da3f7bba42b40ab3a7305"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a0c63f30106e4688425ba37d8f7a9546b"><td class="memItemLeft" align="right" valign="top">static const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1AceButton.html#a0c63f30106e4688425ba37d8f7a9546b">kEventDoubleClicked</a> = 3</td></tr>
|
||
|
|
<tr class="memdesc:a0c63f30106e4688425ba37d8f7a9546b"><td class="mdescLeft"> </td><td class="mdescRight">Button was double-clicked. <a href="#a0c63f30106e4688425ba37d8f7a9546b">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a0c63f30106e4688425ba37d8f7a9546b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a769599d288f64dc0e55a69184596d804"><td class="memItemLeft" align="right" valign="top"><a id="a769599d288f64dc0e55a69184596d804"></a>
|
||
|
|
static const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1AceButton.html#a769599d288f64dc0e55a69184596d804">kEventLongPressed</a> = 4</td></tr>
|
||
|
|
<tr class="memdesc:a769599d288f64dc0e55a69184596d804"><td class="mdescLeft"> </td><td class="mdescRight">Button was held down for longer than <a class="el" href="classace__button_1_1ButtonConfig.html#a46d4213a827a94bf82ba99a9c2e59531" title="Milliseconds for a long press event. ">ButtonConfig::getLongPressDelay()</a>). <br /></td></tr>
|
||
|
|
<tr class="separator:a769599d288f64dc0e55a69184596d804"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a9c4195cb128da40677ea223eb81743c9"><td class="memItemLeft" align="right" valign="top">static const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1AceButton.html#a9c4195cb128da40677ea223eb81743c9">kEventRepeatPressed</a> = 5</td></tr>
|
||
|
|
<tr class="memdesc:a9c4195cb128da40677ea223eb81743c9"><td class="mdescLeft"> </td><td class="mdescRight">Button was held down and auto generated multiple presses. <a href="#a9c4195cb128da40677ea223eb81743c9">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a9c4195cb128da40677ea223eb81743c9"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:afe8e8e22146f510afa487e6ec98b6253"><td class="memItemLeft" align="right" valign="top">static const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1AceButton.html#afe8e8e22146f510afa487e6ec98b6253">kButtonStateUnknown</a> = 2</td></tr>
|
||
|
|
<tr class="memdesc:afe8e8e22146f510afa487e6ec98b6253"><td class="mdescLeft"> </td><td class="mdescRight">Button state is unknown. <a href="#afe8e8e22146f510afa487e6ec98b6253">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:afe8e8e22146f510afa487e6ec98b6253"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<div class="textblock"><p>An Adjustable Compact Event-driven (ACE) Button library that debounces and dispatches button events to a user-defined event handler. </p>
|
||
|
|
<p>Supported events types are:</p>
|
||
|
|
<ul>
|
||
|
|
<li>kEventPressed</li>
|
||
|
|
<li>kEventReleased</li>
|
||
|
|
<li>kEventClicked</li>
|
||
|
|
<li>kEventDoubleClicked</li>
|
||
|
|
<li>kEventLongPressed</li>
|
||
|
|
<li>kEventRepeatPressed</li>
|
||
|
|
</ul>
|
||
|
|
<p>The <a class="el" href="classace__button_1_1AceButton.html#af710048a654fa5d5e45405661282a7b1" title="Check state of button and trigger event processing. ">check()</a> method should be called from the loop() at least 2-3 times during the debouncing time period. For 20 ms delay, the <a class="el" href="classace__button_1_1AceButton.html#af710048a654fa5d5e45405661282a7b1" title="Check state of button and trigger event processing. ">check()</a> method should be called at a minimum of every 5 ms. The execution time of <a class="el" href="classace__button_1_1AceButton.html#af710048a654fa5d5e45405661282a7b1" title="Check state of button and trigger event processing. ">check()</a> on a 16 MHz Arduino ATmega328P MCU seems to about about 12-14 microseconds. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2AceButton_8h_source.html#l00050">50</a> of file <a class="el" href="ace__button_2AceButton_8h_source.html">AceButton.h</a>.</p>
|
||
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||
|
|
<a id="a3c480636223edc899a79c821c32c6982"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3c480636223edc899a79c821c32c6982">◆ </a></span>AceButton() <span class="overload">[1/2]</span></h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">ace_button::AceButton::AceButton </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">uint8_t </td>
|
||
|
|
<td class="paramname"><em>pin</em> = <code>0</code>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">uint8_t </td>
|
||
|
|
<td class="paramname"><em>defaultReleasedState</em> = <code>HIGH</code>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">uint8_t </td>
|
||
|
|
<td class="paramname"><em>id</em> = <code>0</code> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Constructor defines parameters of the button that changes from button to button. </p>
|
||
|
|
<p>These parameters don't change during the runtime of the program. Another way to initialize the object is to create an instance using an empty constructor, then use the <a class="el" href="classace__button_1_1AceButton.html#a18c47304c694c6f084a343a7c83bef34" title="Reset the button to the initial constructed state. ">init()</a> method to initialize the object with these parameters.</p>
|
||
|
|
<p>Using the constructor often reads better for simple situations where only a single button is used, and it doesn't need to be configured significantly. Using the <a class="el" href="classace__button_1_1AceButton.html#a18c47304c694c6f084a343a7c83bef34" title="Reset the button to the initial constructed state. ">init()</a> method can make the code be more readable when multiple buttons are used, and they need to be significantly customized. The <a class="el" href="classace__button_1_1AceButton.html#a18c47304c694c6f084a343a7c83bef34" title="Reset the button to the initial constructed state. ">init()</a> method allows the button configuration code to appear in close proximity to the pinMode() methods which sets up the hardware pins.</p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">pin</td><td>The pin number of the button. Default 0. Normally the pin number should be given at construction time. However, the pin number the pin number can be omitted so that the pin number can be assigned at setup() time using the setPin() method.</td></tr>
|
||
|
|
<tr><td class="paramname">defaultReleasedState</td><td>The pin state when the button is in the initial released position. Default HIGH. When using a pullup resistor (either external or internal) and the button is connected to ground, this should be set to HIGH. When using an external pulldown resistor and the button is connected to Vcc (5V or 3.3V), this should be set to LOW. The defaultReleasedState can be assigned using the constructor or the <a class="el" href="classace__button_1_1AceButton.html#a18c47304c694c6f084a343a7c83bef34" title="Reset the button to the initial constructed state. ">init()</a> method.</td></tr>
|
||
|
|
<tr><td class="paramname">id</td><td>This is an optional user-defined identifier for the button. For example, this could be an index into an array of data that is associated with the button. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="AceButton_8cpp_source.html#l00039">39</a> of file <a class="el" href="AceButton_8cpp_source.html">AceButton.cpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="ab2ec2d3b98e2e2228f85271385e07521"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab2ec2d3b98e2e2228f85271385e07521">◆ </a></span>AceButton() <span class="overload">[2/2]</span></h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">ace_button::AceButton::AceButton </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="classace__button_1_1ButtonConfig.html">ButtonConfig</a> * </td>
|
||
|
|
<td class="paramname"><em>buttonConfig</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Constructor that accepts a <a class="el" href="classace__button_1_1ButtonConfig.html" title="Class that defines the timing parameters and event handler of an AceButton or a group of AceButton in...">ButtonConfig</a> as a dependency. </p>
|
||
|
|
<p>Dependency injection using this constructor is now recommended over using the <a class="el" href="classace__button_1_1AceButton.html#abc9d705d1ca4341cf6f9434962b5b5e7" title="Set the ButtonConfig associated with this Button. ">setButtonConfig()</a> method because it makes the dependency more clear. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="AceButton_8cpp_source.html#l00044">44</a> of file <a class="el" href="AceButton_8cpp_source.html">AceButton.cpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
||
|
|
<a id="af710048a654fa5d5e45405661282a7b1"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af710048a654fa5d5e45405661282a7b1">◆ </a></span>check()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void ace_button::AceButton::check </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Check state of button and trigger event processing. </p>
|
||
|
|
<p>This method should be called from the loop() method in Arduino every 4-5 times during the getDebounceDelay() time (default 20 ms), so about every 5 ms. If this is called less often than that, the debouncing algorithm may not work correctly, which may cause other event detection algorithms to fail. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="AceButton_8cpp_source.html#l00073">73</a> of file <a class="el" href="AceButton_8cpp_source.html">AceButton.cpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a5e4ea4aca852a5e0b1d426bccb131cfb"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5e4ea4aca852a5e0b1d426bccb131cfb">◆ </a></span>getButtonConfig()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="classace__button_1_1ButtonConfig.html">ButtonConfig</a>* ace_button::AceButton::getButtonConfig </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>Get the <a class="el" href="classace__button_1_1ButtonConfig.html" title="Class that defines the timing parameters and event handler of an AceButton or a group of AceButton in...">ButtonConfig</a> associated with this Button. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2AceButton_8h_source.html#l00143">143</a> of file <a class="el" href="ace__button_2AceButton_8h_source.html">AceButton.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="afa8013bb98f5fbd79654aebca613ba71"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afa8013bb98f5fbd79654aebca613ba71">◆ </a></span>getDefaultReleasedState()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">uint8_t ace_button::AceButton::getDefaultReleasedState </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Get the initial released state of the button, HIGH or LOW. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="AceButton_8cpp_source.html#l00067">67</a> of file <a class="el" href="AceButton_8cpp_source.html">AceButton.cpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a4a693b836e3fed29d4e7203a5a97910b"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4a693b836e3fed29d4e7203a5a97910b">◆ </a></span>getId()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">uint8_t ace_button::AceButton::getId </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>Get the custom identifier of the button. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2AceButton_8h_source.html#l00174">174</a> of file <a class="el" href="ace__button_2AceButton_8h_source.html">AceButton.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a3c49e9edf8cbb5e3800c5f4506d0beca"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3c49e9edf8cbb5e3800c5f4506d0beca">◆ </a></span>getLastButtonState()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">uint8_t ace_button::AceButton::getLastButtonState </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>Return the button state that was last valid. </p>
|
||
|
|
<p>This is a tri-state function. It may return HIGH, LOW or kButtonStateUnknown to indicate that the last state is not known. This method is <b>not</b> for public consumption, it is exposed only for testing purposes. Consider it to be a private method. Use the buttonState parameter provided to the EventHandler.</p>
|
||
|
|
<p>In a more general multi-threaded environment (which the Arduino is not, fortunately or unfortunately), the <a class="el" href="classace__button_1_1AceButton.html#a3c49e9edf8cbb5e3800c5f4506d0beca" title="Return the button state that was last valid. ">getLastButtonState()</a> may have changed from the value of buttonState provided to the event handler. In other words, there is a race-condition. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2AceButton_8h_source.html#l00192">192</a> of file <a class="el" href="ace__button_2AceButton_8h_source.html">AceButton.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="ac6b12ca62c7c055325bfebd036579ed6"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac6b12ca62c7c055325bfebd036579ed6">◆ </a></span>getPin()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">uint8_t ace_button::AceButton::getPin </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>Get the button's pin number. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2AceButton_8h_source.html#l00171">171</a> of file <a class="el" href="ace__button_2AceButton_8h_source.html">AceButton.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a18c47304c694c6f084a343a7c83bef34"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a18c47304c694c6f084a343a7c83bef34">◆ </a></span>init()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void ace_button::AceButton::init </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">uint8_t </td>
|
||
|
|
<td class="paramname"><em>pin</em> = <code>0</code>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">uint8_t </td>
|
||
|
|
<td class="paramname"><em>defaultReleasedState</em> = <code>HIGH</code>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">uint8_t </td>
|
||
|
|
<td class="paramname"><em>id</em> = <code>0</code> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Reset the button to the initial constructed state. </p>
|
||
|
|
<p>In particular, <a class="el" href="classace__button_1_1AceButton.html#a3c49e9edf8cbb5e3800c5f4506d0beca" title="Return the button state that was last valid. ">getLastButtonState()</a> returns kButtonStateUnknown. The parameters are identical as the parameters in the <a class="el" href="classace__button_1_1AceButton.html#a3c480636223edc899a79c821c32c6982" title="Constructor defines parameters of the button that changes from button to button. ">AceButton()</a> constructor. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="AceButton_8cpp_source.html#l00049">49</a> of file <a class="el" href="AceButton_8cpp_source.html">AceButton.cpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="af80a2bd19d929bff5dcce54a3db6fb0a"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af80a2bd19d929bff5dcce54a3db6fb0a">◆ </a></span>isPressedRaw()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool ace_button::AceButton::isPressedRaw </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>Read the button state directly using <a class="el" href="classace__button_1_1ButtonConfig.html" title="Class that defines the timing parameters and event handler of an AceButton or a group of AceButton in...">ButtonConfig</a> and return true if the button is in the Pressed state. </p>
|
||
|
|
<p>This method is intended to be used in the global setup() to determine if the button was pressed while the device was booted. This method does not use the <a class="el" href="classace__button_1_1AceButton.html#af710048a654fa5d5e45405661282a7b1" title="Check state of button and trigger event processing. ">check()</a> method, does not perform any debouncing, and does not dispatch events to the EventHandler. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2AceButton_8h_source.html#l00231">231</a> of file <a class="el" href="ace__button_2AceButton_8h_source.html">AceButton.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="aa3cbb3fb16076cfe9255e0f70cc6aa72"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa3cbb3fb16076cfe9255e0f70cc6aa72">◆ </a></span>isReleased()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool ace_button::AceButton::isReleased </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">uint8_t </td>
|
||
|
|
<td class="paramname"><em>buttonState</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>Returns true if the given buttonState represents a 'Released' state for the button. </p>
|
||
|
|
<p>Returns false if the buttonState is 'Pressed' or kButtonStateUnknown.</p>
|
||
|
|
<p>The HIGH or LOW logical value of buttonState represents different a button position depending on whether the button is wired with a pull-up or a pull-down resistor. This method translates the logical level to the physical position which allows the client code to be independent of the physical wiring.</p>
|
||
|
|
<p>Normally, the eventType given to the EventHandler should be sufficient because the value of the eventType already encodes this information. This method is provided just in case. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2AceButton_8h_source.html#l00220">220</a> of file <a class="el" href="ace__button_2AceButton_8h_source.html">AceButton.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="abc9d705d1ca4341cf6f9434962b5b5e7"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abc9d705d1ca4341cf6f9434962b5b5e7">◆ </a></span>setButtonConfig()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void ace_button::AceButton::setButtonConfig </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="classace__button_1_1ButtonConfig.html">ButtonConfig</a> * </td>
|
||
|
|
<td class="paramname"><em>buttonConfig</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 <a class="el" href="classace__button_1_1ButtonConfig.html" title="Class that defines the timing parameters and event handler of an AceButton or a group of AceButton in...">ButtonConfig</a> associated with this Button. </p>
|
||
|
|
<p>It is recommended that the <a class="el" href="classace__button_1_1AceButton.html#ab2ec2d3b98e2e2228f85271385e07521" title="Constructor that accepts a ButtonConfig as a dependency. ">AceButton(ButtonConfig*)</a> constructor is used instead to make the dependency to <a class="el" href="classace__button_1_1ButtonConfig.html" title="Class that defines the timing parameters and event handler of an AceButton or a group of AceButton in...">ButtonConfig</a> more explicit. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2AceButton_8h_source.html#l00152">152</a> of file <a class="el" href="ace__button_2AceButton_8h_source.html">AceButton.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a42edbfeb4091c867d976a4d24622f19c"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a42edbfeb4091c867d976a4d24622f19c">◆ </a></span>setEventHandler()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void ace_button::AceButton::setEventHandler </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="classace__button_1_1ButtonConfig.html#a6d9db3c7b221b474c3cfd8fca5f4ba1e">ButtonConfig::EventHandler</a> </td>
|
||
|
|
<td class="paramname"><em>eventHandler</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>Convenience method to set the event handler. </p>
|
||
|
|
<p>Event handlers are stored in the <a class="el" href="classace__button_1_1ButtonConfig.html" title="Class that defines the timing parameters and event handler of an AceButton or a group of AceButton in...">ButtonConfig</a> object, not in the <a class="el" href="classace__button_1_1AceButton.html" title="An Adjustable Compact Event-driven (ACE) Button library that debounces and dispatches button events t...">AceButton</a> object, to save memory. (Multiple buttons are likely to share the same event handler.) So this method is just a pass-through to <a class="el" href="classace__button_1_1ButtonConfig.html#a5d228f08e9943fd4ab90caab39ef80be" title="Install the event handler. ">ButtonConfig::setEventHandler()</a>. If you are using multiple <a class="el" href="classace__button_1_1ButtonConfig.html" title="Class that defines the timing parameters and event handler of an AceButton or a group of AceButton in...">ButtonConfig</a> objects, you should call the <a class="el" href="classace__button_1_1ButtonConfig.html#a5d228f08e9943fd4ab90caab39ef80be" title="Install the event handler. ">ButtonConfig::setEventHandler()</a> method on those objects directly, instead of using this method. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2AceButton_8h_source.html#l00165">165</a> of file <a class="el" href="ace__button_2AceButton_8h_source.html">AceButton.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
||
|
|
<a id="afe8e8e22146f510afa487e6ec98b6253"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afe8e8e22146f510afa487e6ec98b6253">◆ </a></span>kButtonStateUnknown</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">const uint8_t ace_button::AceButton::kButtonStateUnknown = 2</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Button state is unknown. </p>
|
||
|
|
<p>This is a third state (different from LOW or HIGH) used when the class is first initialized upon reboot. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2AceButton_8h_source.html#l00090">90</a> of file <a class="el" href="ace__button_2AceButton_8h_source.html">AceButton.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a0c63f30106e4688425ba37d8f7a9546b"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0c63f30106e4688425ba37d8f7a9546b">◆ </a></span>kEventDoubleClicked</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">const uint8_t ace_button::AceButton::kEventDoubleClicked = 3</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Button was double-clicked. </p>
|
||
|
|
<p>(Two clicks within <a class="el" href="classace__button_1_1ButtonConfig.html#a5ba500367e03c36f39225a5858e110e6" title="Milliseconds between the first and second click to register as a double-click. ">ButtonConfig::getDoubleClickDelay()</a>). </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2AceButton_8h_source.html#l00070">70</a> of file <a class="el" href="ace__button_2AceButton_8h_source.html">AceButton.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="ae723d826fe219a8415764b9fed5d8976"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae723d826fe219a8415764b9fed5d8976">◆ </a></span>kEventPressed</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">const uint8_t ace_button::AceButton::kEventPressed = 0</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Button was pressed. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2AceButton_8h_source.html#l00055">55</a> of file <a class="el" href="ace__button_2AceButton_8h_source.html">AceButton.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="ada5bd7c31950e2acdb8a9464e795c13c"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ada5bd7c31950e2acdb8a9464e795c13c">◆ </a></span>kEventReleased</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">const uint8_t ace_button::AceButton::kEventReleased = 1</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Button was released. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2AceButton_8h_source.html#l00058">58</a> of file <a class="el" href="ace__button_2AceButton_8h_source.html">AceButton.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a9c4195cb128da40677ea223eb81743c9"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9c4195cb128da40677ea223eb81743c9">◆ </a></span>kEventRepeatPressed</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">const uint8_t ace_button::AceButton::kEventRepeatPressed = 5</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Button was held down and auto generated multiple presses. </p>
|
||
|
|
<p>The first event is triggered after <a class="el" href="classace__button_1_1ButtonConfig.html#ad85c75d2a2dd200552a181fb154d5fd2" title="Milliseconds that a button needs to be Pressed down before the start of the sequence of RepeatPressed...">ButtonConfig::getRepeatPressDelay()</a>, then the event fires repeatedly every <a class="el" href="classace__button_1_1ButtonConfig.html#aec4a97a1a1306b9ff12f1cdf44515c43" title="Milliseconds between two successive RepeatPressed events. ">ButtonConfig::getRepeatPressInterval()</a> until the button is released. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2AceButton_8h_source.html#l00084">84</a> of file <a class="el" href="ace__button_2AceButton_8h_source.html">AceButton.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
||
|
|
<li>/home/brian/dev/AceButton/src/ace_button/<a class="el" href="ace__button_2AceButton_8h_source.html">AceButton.h</a></li>
|
||
|
|
<li>/home/brian/dev/AceButton/src/ace_button/<a class="el" href="AceButton_8cpp_source.html">AceButton.cpp</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>
|