105 lines
53 KiB
HTML
105 lines
53 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: /home/brian/dev/AceButton/src/ace_button/AceButton.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">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"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_ebbe9b537c0e01d975153fa119b09658.html">ace_button</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">AceButton.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">MIT License</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) 2018 Brian T. Park</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</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">of this software and associated documentation files (the "Software"), to deal</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">in the Software without restriction, including without limitation the rights</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">copies of the Software, and to permit persons to whom the Software is</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">furnished to do so, 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,</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">SOFTWARE.</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">*/</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#ifndef ACE_BUTTON_ACE_BUTTON_H</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#define ACE_BUTTON_ACE_BUTTON_H</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <Arduino.h></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "ButtonConfig.h"</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">namespace </span><a class="code" href="namespaceace__button.html">ace_button</a> {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classace__button_1_1AceButton.html"> 50</a></span> <span class="keyword">class </span><a class="code" href="classace__button_1_1AceButton.html">AceButton</a> {</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="comment">// The supported event types.</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classace__button_1_1AceButton.html#ae723d826fe219a8415764b9fed5d8976"> 55</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t <a class="code" href="classace__button_1_1AceButton.html#ae723d826fe219a8415764b9fed5d8976">kEventPressed</a> = 0;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="classace__button_1_1AceButton.html#ada5bd7c31950e2acdb8a9464e795c13c"> 58</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t <a class="code" href="classace__button_1_1AceButton.html#ada5bd7c31950e2acdb8a9464e795c13c">kEventReleased</a> = 1;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="classace__button_1_1AceButton.html#a21797e5e069da3f7bba42b40ab3a7305"> 64</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t <a class="code" href="classace__button_1_1AceButton.html#a21797e5e069da3f7bba42b40ab3a7305">kEventClicked</a> = 2;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classace__button_1_1AceButton.html#a0c63f30106e4688425ba37d8f7a9546b"> 70</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t <a class="code" href="classace__button_1_1AceButton.html#a0c63f30106e4688425ba37d8f7a9546b">kEventDoubleClicked</a> = 3;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="classace__button_1_1AceButton.html#a769599d288f64dc0e55a69184596d804"> 76</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t <a class="code" href="classace__button_1_1AceButton.html#a769599d288f64dc0e55a69184596d804">kEventLongPressed</a> = 4;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="classace__button_1_1AceButton.html#a9c4195cb128da40677ea223eb81743c9"> 84</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t <a class="code" href="classace__button_1_1AceButton.html#a9c4195cb128da40677ea223eb81743c9">kEventRepeatPressed</a> = 5;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="classace__button_1_1AceButton.html#afe8e8e22146f510afa487e6ec98b6253"> 90</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t <a class="code" href="classace__button_1_1AceButton.html#afe8e8e22146f510afa487e6ec98b6253">kButtonStateUnknown</a> = 2;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keyword">explicit</span> <a class="code" href="classace__button_1_1AceButton.html#a3c480636223edc899a79c821c32c6982">AceButton</a>(uint8_t pin = 0, uint8_t defaultReleasedState = HIGH,</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  uint8_t <span class="keywordtype">id</span> = 0);</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> </div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keyword">explicit</span> <a class="code" href="classace__button_1_1AceButton.html#a3c480636223edc899a79c821c32c6982">AceButton</a>(<a class="code" href="classace__button_1_1ButtonConfig.html">ButtonConfig</a>* buttonConfig);</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="keywordtype">void</span> <a class="code" href="classace__button_1_1AceButton.html#a18c47304c694c6f084a343a7c83bef34">init</a>(uint8_t pin = 0, uint8_t defaultReleasedState = HIGH,</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  uint8_t <span class="keywordtype">id</span> = 0);</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div><div class="line"><a name="l00143"></a><span class="lineno"><a class="line" href="classace__button_1_1AceButton.html#a5e4ea4aca852a5e0b1d426bccb131cfb"> 143</a></span>  <a class="code" href="classace__button_1_1ButtonConfig.html">ButtonConfig</a>* <a class="code" href="classace__button_1_1AceButton.html#a5e4ea4aca852a5e0b1d426bccb131cfb">getButtonConfig</a>() ACE_BUTTON_INLINE {</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="keywordflow">return</span> mButtonConfig;</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  }</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div><div class="line"><a name="l00152"></a><span class="lineno"><a class="line" href="classace__button_1_1AceButton.html#abc9d705d1ca4341cf6f9434962b5b5e7"> 152</a></span>  <span class="keywordtype">void</span> <a class="code" href="classace__button_1_1AceButton.html#abc9d705d1ca4341cf6f9434962b5b5e7">setButtonConfig</a>(<a class="code" href="classace__button_1_1ButtonConfig.html">ButtonConfig</a>* buttonConfig) ACE_BUTTON_INLINE {</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  mButtonConfig = buttonConfig;</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  }</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div><div class="line"><a name="l00165"></a><span class="lineno"><a class="line" href="classace__button_1_1AceButton.html#a42edbfeb4091c867d976a4d24622f19c"> 165</a></span>  <span class="keywordtype">void</span> <a class="code" href="classace__button_1_1AceButton.html#a42edbfeb4091c867d976a4d24622f19c">setEventHandler</a>(<a class="code" href="classace__button_1_1ButtonConfig.html#a6d9db3c7b221b474c3cfd8fca5f4ba1e">ButtonConfig::EventHandler</a> eventHandler)</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  ACE_BUTTON_INLINE {</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  mButtonConfig-><a class="code" href="classace__button_1_1ButtonConfig.html#a5d228f08e9943fd4ab90caab39ef80be">setEventHandler</a>(eventHandler);</div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  }</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> </div><div class="line"><a name="l00171"></a><span class="lineno"><a class="line" href="classace__button_1_1AceButton.html#ac6b12ca62c7c055325bfebd036579ed6"> 171</a></span>  uint8_t <a class="code" href="classace__button_1_1AceButton.html#ac6b12ca62c7c055325bfebd036579ed6">getPin</a>() ACE_BUTTON_INLINE { <span class="keywordflow">return</span> mPin; }</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> </div><div class="line"><a name="l00174"></a><span class="lineno"><a class="line" href="classace__button_1_1AceButton.html#a4a693b836e3fed29d4e7203a5a97910b"> 174</a></span>  uint8_t <a class="code" href="classace__button_1_1AceButton.html#a4a693b836e3fed29d4e7203a5a97910b">getId</a>() ACE_BUTTON_INLINE { <span class="keywordflow">return</span> mId; }</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> </div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  uint8_t <a class="code" href="classace__button_1_1AceButton.html#afa8013bb98f5fbd79654aebca613ba71">getDefaultReleasedState</a>();</div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> </div><div class="line"><a name="l00192"></a><span class="lineno"><a class="line" href="classace__button_1_1AceButton.html#a3c49e9edf8cbb5e3800c5f4506d0beca"> 192</a></span>  uint8_t <a class="code" href="classace__button_1_1AceButton.html#a3c49e9edf8cbb5e3800c5f4506d0beca">getLastButtonState</a>() ACE_BUTTON_INLINE {</div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  <span class="keywordflow">return</span> mLastButtonState;</div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  }</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span> </div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  <span class="keywordtype">void</span> <a class="code" href="classace__button_1_1AceButton.html#af710048a654fa5d5e45405661282a7b1">check</a>();</div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> </div><div class="line"><a name="l00220"></a><span class="lineno"><a class="line" href="classace__button_1_1AceButton.html#aa3cbb3fb16076cfe9255e0f70cc6aa72"> 220</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classace__button_1_1AceButton.html#aa3cbb3fb16076cfe9255e0f70cc6aa72">isReleased</a>(uint8_t buttonState) ACE_BUTTON_INLINE {</div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  <span class="keywordflow">return</span> buttonState == <a class="code" href="classace__button_1_1AceButton.html#afa8013bb98f5fbd79654aebca613ba71">getDefaultReleasedState</a>();</div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  }</div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span> </div><div class="line"><a name="l00231"></a><span class="lineno"><a class="line" href="classace__button_1_1AceButton.html#af80a2bd19d929bff5dcce54a3db6fb0a"> 231</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classace__button_1_1AceButton.html#af80a2bd19d929bff5dcce54a3db6fb0a">isPressedRaw</a>() ACE_BUTTON_INLINE {</div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span>  <span class="keywordflow">return</span> !<a class="code" href="classace__button_1_1AceButton.html#aa3cbb3fb16076cfe9255e0f70cc6aa72">isReleased</a>(mButtonConfig-><a class="code" href="classace__button_1_1ButtonConfig.html#a5dab877bf124bfdf5a5eb703ca123027">readButton</a>(mPin));</div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  }</div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span> </div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  <span class="comment">// Some of these private methods may be useful to the calling client but I</span></div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span>  <span class="comment">// don't want to release them to the public because I want to keep the API as</span></div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  <span class="comment">// small as possible for easier long term maintenance. (Once a method is</span></div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  <span class="comment">// released to the public, it must be supported forever to ensure backwards</span></div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  <span class="comment">// compatibility with older client code.)</span></div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span> </div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  <span class="comment">// Disable copy-constructor and assignment operator</span></div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  <a class="code" href="classace__button_1_1AceButton.html#a3c480636223edc899a79c821c32c6982">AceButton</a>(<span class="keyword">const</span> <a class="code" href="classace__button_1_1AceButton.html">AceButton</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span>  <a class="code" href="classace__button_1_1AceButton.html">AceButton</a>& operator=(<span class="keyword">const</span> <a class="code" href="classace__button_1_1AceButton.html">AceButton</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span> </div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span>  <span class="keywordtype">void</span> setPin(uint8_t pin) ACE_BUTTON_INLINE { mPin = pin; }</div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span> </div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span>  <span class="keywordtype">void</span> setDefaultReleasedState(uint8_t state);</div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span> </div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  <span class="keywordtype">void</span> setId(uint8_t <span class="keywordtype">id</span>) ACE_BUTTON_INLINE { mId = id; }</div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span> </div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span>  <span class="comment">// Various bit masks to store a boolean flag in the 'mFlags' field.</span></div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span>  <span class="comment">// We use bit masks to save static RAM. If we had used a 'bool' type, each</span></div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span>  <span class="comment">// of these would consume one byte.</span></div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t kFlagDefaultReleasedState = 0x01;</div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t kFlagDebouncing = 0x02;</div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t kFlagPressed = 0x04;</div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t kFlagClicked = 0x08;</div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t kFlagDoubleClicked = 0x10;</div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t kFlagLongPressed = 0x20;</div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t kFlagRepeatPressed = 0x40;</div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t kFlagClickPostponed = 0x80;</div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span> </div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span>  <span class="comment">// Methods for accessing the button's internal states.</span></div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span>  <span class="comment">// I don't expect these to be useful to the outside world.</span></div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span> </div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span>  <span class="comment">// If this is set, then mLastDebounceTime is valid.</span></div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span>  <span class="keywordtype">bool</span> isDebouncing() ACE_BUTTON_INLINE {</div><div class="line"><a name="l00278"></a><span class="lineno"> 278</span>  <span class="keywordflow">return</span> mFlags & kFlagDebouncing;</div><div class="line"><a name="l00279"></a><span class="lineno"> 279</span>  }</div><div class="line"><a name="l00280"></a><span class="lineno"> 280</span> </div><div class="line"><a name="l00281"></a><span class="lineno"> 281</span>  <span class="keywordtype">void</span> setDebouncing() ACE_BUTTON_INLINE {</div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span>  mFlags |= kFlagDebouncing;</div><div class="line"><a name="l00283"></a><span class="lineno"> 283</span>  }</div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span> </div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span>  <span class="keywordtype">void</span> clearDebouncing() ACE_BUTTON_INLINE {</div><div class="line"><a name="l00286"></a><span class="lineno"> 286</span>  mFlags &= ~kFlagDebouncing;</div><div class="line"><a name="l00287"></a><span class="lineno"> 287</span>  }</div><div class="line"><a name="l00288"></a><span class="lineno"> 288</span> </div><div class="line"><a name="l00289"></a><span class="lineno"> 289</span>  <span class="comment">// If this is set, then mLastPressTime is valid.</span></div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span>  <span class="keywordtype">bool</span> isPressed() ACE_BUTTON_INLINE {</div><div class="line"><a name="l00291"></a><span class="lineno"> 291</span>  <span class="keywordflow">return</span> mFlags & kFlagPressed;</div><div class="line"><a name="l00292"></a><span class="lineno"> 292</span>  }</div><div class="line"><a name="l00293"></a><span class="lineno"> 293</span> </div><div class="line"><a name="l00294"></a><span class="lineno"> 294</span>  <span class="keywordtype">void</span> setPressed() ACE_BUTTON_INLINE {</div><div class="line"><a name="l00295"></a><span class="lineno"> 295</span>  mFlags |= kFlagPressed;</div><div class="line"><a name="l00296"></a><span class="lineno"> 296</span>  }</div><div class="line"><a name="l00297"></a><span class="lineno"> 297</span> </div><div class="line"><a name="l00298"></a><span class="lineno"> 298</span>  <span class="keywordtype">void</span> clearPressed() ACE_BUTTON_INLINE {</div><div class="line"><a name="l00299"></a><span class="lineno"> 299</span>  mFlags &= ~kFlagPressed;</div><div class="line"><a name="l00300"></a><span class="lineno"> 300</span>  }</div><div class="line"><a name="l00301"></a><span class="lineno"> 301</span> </div><div class="line"><a name="l00302"></a><span class="lineno"> 302</span>  <span class="comment">// If this is set, then mLastClickTime is valid.</span></div><div class="line"><a name="l00303"></a><span class="lineno"> 303</span>  <span class="keywordtype">bool</span> isClicked() ACE_BUTTON_INLINE {</div><div class="line"><a name="l00304"></a><span class="lineno"> 304</span>  <span class="keywordflow">return</span> mFlags & kFlagClicked;</div><div class="line"><a name="l00305"></a><span class="lineno"> 305</span>  }</div><div class="line"><a name="l00306"></a><span class="lineno"> 306</span> </div><div class="line"><a name="l00307"></a><span class="lineno"> 307</span>  <span class="keywordtype">void</span> setClicked() ACE_BUTTON_INLINE {</div><div class="line"><a name="l00308"></a><span class="lineno"> 308</span>  mFlags |= kFlagClicked;</div><div class="line"><a name="l00309"></a><span class="lineno"> 309</span>  }</div><div class="line"><a name="l00310"></a><span class="lineno"> 310</span> </div><div class="line"><a name="l00311"></a><span class="lineno"> 311</span>  <span class="keywordtype">void</span> clearClicked() ACE_BUTTON_INLINE {</div><div class="line"><a name="l00312"></a><span class="lineno"> 312</span>  mFlags &= ~kFlagClicked;</div><div class="line"><a name="l00313"></a><span class="lineno"> 313</span>  }</div><div class="line"><a name="l00314"></a><span class="lineno"> 314</span> </div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span>  <span class="comment">// A double click was detected. No need to store the last double-clicked</span></div><div class="line"><a name="l00316"></a><span class="lineno"> 316</span>  <span class="comment">// time because we don't support a triple-click event (yet).</span></div><div class="line"><a name="l00317"></a><span class="lineno"> 317</span>  <span class="keywordtype">bool</span> isDoubleClicked() ACE_BUTTON_INLINE {</div><div class="line"><a name="l00318"></a><span class="lineno"> 318</span>  <span class="keywordflow">return</span> mFlags & kFlagDoubleClicked;</div><div class="line"><a name="l00319"></a><span class="lineno"> 319</span>  }</div><div class="line"><a name="l00320"></a><span class="lineno"> 320</span> </div><div class="line"><a name="l00321"></a><span class="lineno"> 321</span>  <span class="keywordtype">void</span> setDoubleClicked() ACE_BUTTON_INLINE {</div><div class="line"><a name="l00322"></a><span class="lineno"> 322</span>  mFlags |= kFlagDoubleClicked;</div><div class="line"><a name="l00323"></a><span class="lineno"> 323</span>  }</div><div class="line"><a name="l00324"></a><span class="lineno"> 324</span> </div><div class="line"><a name="l00325"></a><span class="lineno"> 325</span>  <span class="keywordtype">void</span> clearDoubleClicked() ACE_BUTTON_INLINE {</div><div class="line"><a name="l00326"></a><span class="lineno"> 326</span>  mFlags &= ~kFlagDoubleClicked;</div><div class="line"><a name="l00327"></a><span class="lineno"> 327</span>  }</div><div class="line"><a name="l00328"></a><span class="lineno"> 328</span> </div><div class="line"><a name="l00329"></a><span class="lineno"> 329</span>  <span class="comment">// If this is set, then mLastPressTime can be treated as the start</span></div><div class="line"><a name="l00330"></a><span class="lineno"> 330</span>  <span class="comment">// of a long press.</span></div><div class="line"><a name="l00331"></a><span class="lineno"> 331</span>  <span class="keywordtype">bool</span> isLongPressed() ACE_BUTTON_INLINE {</div><div class="line"><a name="l00332"></a><span class="lineno"> 332</span>  <span class="keywordflow">return</span> mFlags & kFlagLongPressed;</div><div class="line"><a name="l00333"></a><span class="lineno"> 333</span>  }</div><div class="line"><a name="l00334"></a><span class="lineno"> 334</span> </div><div class="line"><a name="l00335"></a><span class="lineno"> 335</span>  <span class="keywordtype">void</span> setLongPressed() ACE_BUTTON_INLINE {</div><div class="line"><a name="l00336"></a><span class="lineno"> 336</span>  mFlags |= kFlagLongPressed;</div><div class="line"><a name="l00337"></a><span class="lineno"> 337</span>  }</div><div class="line"><a name="l00338"></a><span class="lineno"> 338</span> </div><div class="line"><a name="l00339"></a><span class="lineno"> 339</span>  <span class="keywordtype">void</span> clearLongPressed() ACE_BUTTON_INLINE {</div><div class="line"><a name="l00340"></a><span class="lineno"> 340</span>  mFlags &= ~kFlagLongPressed;</div><div class="line"><a name="l00341"></a><span class="lineno"> 341</span>  }</div><div class="line"><a name="l00342"></a><span class="lineno"> 342</span> </div><div class="line"><a name="l00343"></a><span class="lineno"> 343</span>  <span class="comment">// If this is set, then mLastRepeatPressTime is valid.</span></div><div class="line"><a name="l00344"></a><span class="lineno"> 344</span>  <span class="keywordtype">bool</span> isRepeatPressed() ACE_BUTTON_INLINE {</div><div class="line"><a name="l00345"></a><span class="lineno"> 345</span>  <span class="keywordflow">return</span> mFlags & kFlagRepeatPressed;</div><div class="line"><a name="l00346"></a><span class="lineno"> 346</span>  }</div><div class="line"><a name="l00347"></a><span class="lineno"> 347</span> </div><div class="line"><a name="l00348"></a><span class="lineno"> 348</span>  <span class="keywordtype">void</span> setRepeatPressed() ACE_BUTTON_INLINE {</div><div class="line"><a name="l00349"></a><span class="lineno"> 349</span>  mFlags |= kFlagRepeatPressed;</div><div class="line"><a name="l00350"></a><span class="lineno"> 350</span>  }</div><div class="line"><a name="l00351"></a><span class="lineno"> 351</span> </div><div class="line"><a name="l00352"></a><span class="lineno"> 352</span>  <span class="keywordtype">void</span> clearRepeatPressed() ACE_BUTTON_INLINE {</div><div class="line"><a name="l00353"></a><span class="lineno"> 353</span>  mFlags &= ~kFlagRepeatPressed;</div><div class="line"><a name="l00354"></a><span class="lineno"> 354</span>  }</div><div class="line"><a name="l00355"></a><span class="lineno"> 355</span> </div><div class="line"><a name="l00356"></a><span class="lineno"> 356</span>  <span class="keywordtype">bool</span> isClickPostponed() ACE_BUTTON_INLINE {</div><div class="line"><a name="l00357"></a><span class="lineno"> 357</span>  <span class="keywordflow">return</span> mFlags & kFlagClickPostponed;</div><div class="line"><a name="l00358"></a><span class="lineno"> 358</span>  }</div><div class="line"><a name="l00359"></a><span class="lineno"> 359</span> </div><div class="line"><a name="l00360"></a><span class="lineno"> 360</span>  <span class="keywordtype">void</span> setClickPostponed() ACE_BUTTON_INLINE {</div><div class="line"><a name="l00361"></a><span class="lineno"> 361</span>  mFlags |= kFlagClickPostponed;</div><div class="line"><a name="l00362"></a><span class="lineno"> 362</span>  }</div><div class="line"><a name="l00363"></a><span class="lineno"> 363</span> </div><div class="line"><a name="l00364"></a><span class="lineno"> 364</span>  <span class="keywordtype">void</span> clearClickPostponed() ACE_BUTTON_INLINE {</div><div class="line"><a name="l00365"></a><span class="lineno"> 365</span>  mFlags &= ~kFlagClickPostponed;</div><div class="line"><a name="l00366"></a><span class="lineno"> 366</span>  }</div><div class="line"><a name="l00367"></a><span class="lineno"> 367</span> </div><div class="line"><a name="l00373"></a><span class="lineno"> 373</span>  <span class="keywordtype">bool</span> checkDebounced(uint16_t now, uint8_t buttonState);</div><div class="line"><a name="l00374"></a><span class="lineno"> 374</span> </div><div class="line"><a name="l00381"></a><span class="lineno"> 381</span>  <span class="keywordtype">bool</span> checkInitialized(uint16_t buttonState);</div><div class="line"><a name="l00382"></a><span class="lineno"> 382</span> </div><div class="line"><a name="l00384"></a><span class="lineno"> 384</span>  <span class="keywordtype">void</span> checkEvent(uint16_t now, uint8_t buttonState);</div><div class="line"><a name="l00385"></a><span class="lineno"> 385</span> </div><div class="line"><a name="l00387"></a><span class="lineno"> 387</span>  <span class="keywordtype">void</span> checkLongPress(uint16_t now, uint8_t buttonState);</div><div class="line"><a name="l00388"></a><span class="lineno"> 388</span> </div><div class="line"><a name="l00390"></a><span class="lineno"> 390</span>  <span class="keywordtype">void</span> checkRepeatPress(uint16_t now, uint8_t buttonState);</div><div class="line"><a name="l00391"></a><span class="lineno"> 391</span> </div><div class="line"><a name="l00393"></a><span class="lineno"> 393</span>  <span class="keywordtype">void</span> checkChanged(uint16_t now, uint8_t buttonState);</div><div class="line"><a name="l00394"></a><span class="lineno"> 394</span> </div><div class="line"><a name="l00399"></a><span class="lineno"> 399</span>  <span class="keywordtype">void</span> checkReleased(uint16_t now, uint8_t buttonState);</div><div class="line"><a name="l00400"></a><span class="lineno"> 400</span> </div><div class="line"><a name="l00402"></a><span class="lineno"> 402</span>  <span class="keywordtype">void</span> checkPressed(uint16_t now, uint8_t buttonState);</div><div class="line"><a name="l00403"></a><span class="lineno"> 403</span> </div><div class="line"><a name="l00405"></a><span class="lineno"> 405</span>  <span class="keywordtype">void</span> checkClicked(uint16_t now);</div><div class="line"><a name="l00406"></a><span class="lineno"> 406</span> </div><div class="line"><a name="l00411"></a><span class="lineno"> 411</span>  <span class="keywordtype">void</span> checkDoubleClicked(uint16_t now);</div><div class="line"><a name="l00412"></a><span class="lineno"> 412</span> </div><div class="line"><a name="l00421"></a><span class="lineno"> 421</span>  <span class="keywordtype">void</span> checkOrphanedClick(uint16_t now);</div><div class="line"><a name="l00422"></a><span class="lineno"> 422</span> </div><div class="line"><a name="l00427"></a><span class="lineno"> 427</span>  <span class="keywordtype">void</span> checkPostponedClick(uint16_t now);</div><div class="line"><a name="l00428"></a><span class="lineno"> 428</span> </div><div class="line"><a name="l00475"></a><span class="lineno"> 475</span>  <span class="keywordtype">void</span> handleEvent(uint8_t eventType);</div><div class="line"><a name="l00476"></a><span class="lineno"> 476</span> </div><div class="line"><a name="l00477"></a><span class="lineno"> 477</span>  uint8_t mPin; <span class="comment">// button pin number</span></div><div class="line"><a name="l00478"></a><span class="lineno"> 478</span>  uint8_t mId; <span class="comment">// identifier, e.g. an index into an array</span></div><div class="line"><a name="l00479"></a><span class="lineno"> 479</span> </div><div class="line"><a name="l00480"></a><span class="lineno"> 480</span>  <span class="comment">// Internal states of the button debouncing and event handling.</span></div><div class="line"><a name="l00481"></a><span class="lineno"> 481</span>  <span class="comment">// NOTE: We don't keep track of the lastDoubleClickTime, because we</span></div><div class="line"><a name="l00482"></a><span class="lineno"> 482</span>  <span class="comment">// don't support a TripleClicked event. That may change in the future.</span></div><div class="line"><a name="l00483"></a><span class="lineno"> 483</span>  uint16_t mLastDebounceTime; <span class="comment">// ms</span></div><div class="line"><a name="l00484"></a><span class="lineno"> 484</span>  uint16_t mLastClickTime; <span class="comment">// ms</span></div><div class="line"><a name="l00485"></a><span class="lineno"> 485</span>  uint16_t mLastPressTime; <span class="comment">// ms</span></div><div class="line"><a name="l00486"></a><span class="lineno"> 486</span>  uint16_t mLastRepeatPressTime; <span class="comment">// ms</span></div><div class="line"><a name="l00487"></a><span class="lineno"> 487</span> </div><div class="line"><a name="l00489"></a><span class="lineno"> 489</span>  uint8_t mFlags;</div><div class="line"><a name="l00490"></a><span class="lineno"> 490</span> </div><div class="line"><a name="l00495"></a><span class="lineno"> 495</span>  uint8_t mLastButtonState;</div><div class="line"><a name="l00496"></a><span class="lineno"> 496</span> </div><div class="line"><a name="l00498"></a><span class="lineno"> 498</span>  <a class="code" href="classace__button_1_1ButtonConfig.html">ButtonConfig</a>* mButtonConfig;</div><div class="line"><a name="l00499"></a><span class="lineno"> 499</span> };</div><div class="line"><a name="l00500"></a><span class="lineno"> 500</span> </div><div class="line"><a name="l00501"></a><span class="lineno"> 501</span> }</div><div class="line"><a name="l00502"></a><span class="lineno"> 502</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="classace__button_1_1AceButton_html_a42edbfeb4091c867d976a4d24622f19c"><div class="ttname"><a href="classace__button_1_1AceButton.html#a42edbfeb4091c867d976a4d24622f19c">ace_button::AceButton::setEventHandler</a></div><div class="ttdeci">void setEventHandler(ButtonConfig::EventHandler eventHandler) ACE_BUTTON_INLINE</div><div class="ttdoc">Convenience method to set the event handler. </div><div class="ttdef"><b>Definition:</b> <a href="ace__button_2AceButton_8h_source.html#l00165">AceButton.h:165</a></div></div>
|
|
<div class="ttc" id="classace__button_1_1AceButton_html_abc9d705d1ca4341cf6f9434962b5b5e7"><div class="ttname"><a href="classace__button_1_1AceButton.html#abc9d705d1ca4341cf6f9434962b5b5e7">ace_button::AceButton::setButtonConfig</a></div><div class="ttdeci">void setButtonConfig(ButtonConfig *buttonConfig) ACE_BUTTON_INLINE</div><div class="ttdoc">Set the ButtonConfig associated with this Button. </div><div class="ttdef"><b>Definition:</b> <a href="ace__button_2AceButton_8h_source.html#l00152">AceButton.h:152</a></div></div>
|
|
<div class="ttc" id="classace__button_1_1AceButton_html_afa8013bb98f5fbd79654aebca613ba71"><div class="ttname"><a href="classace__button_1_1AceButton.html#afa8013bb98f5fbd79654aebca613ba71">ace_button::AceButton::getDefaultReleasedState</a></div><div class="ttdeci">uint8_t getDefaultReleasedState()</div><div class="ttdoc">Get the initial released state of the button, HIGH or LOW. </div><div class="ttdef"><b>Definition:</b> <a href="AceButton_8cpp_source.html#l00067">AceButton.cpp:67</a></div></div>
|
|
<div class="ttc" id="classace__button_1_1AceButton_html_aa3cbb3fb16076cfe9255e0f70cc6aa72"><div class="ttname"><a href="classace__button_1_1AceButton.html#aa3cbb3fb16076cfe9255e0f70cc6aa72">ace_button::AceButton::isReleased</a></div><div class="ttdeci">bool isReleased(uint8_t buttonState) ACE_BUTTON_INLINE</div><div class="ttdoc">Returns true if the given buttonState represents a &#39;Released&#39; state for the button. </div><div class="ttdef"><b>Definition:</b> <a href="ace__button_2AceButton_8h_source.html#l00220">AceButton.h:220</a></div></div>
|
|
<div class="ttc" id="classace__button_1_1AceButton_html_af80a2bd19d929bff5dcce54a3db6fb0a"><div class="ttname"><a href="classace__button_1_1AceButton.html#af80a2bd19d929bff5dcce54a3db6fb0a">ace_button::AceButton::isPressedRaw</a></div><div class="ttdeci">bool isPressedRaw() ACE_BUTTON_INLINE</div><div class="ttdoc">Read the button state directly using ButtonConfig and return true if the button is in the Pressed sta...</div><div class="ttdef"><b>Definition:</b> <a href="ace__button_2AceButton_8h_source.html#l00231">AceButton.h:231</a></div></div>
|
|
<div class="ttc" id="classace__button_1_1AceButton_html_a3c49e9edf8cbb5e3800c5f4506d0beca"><div class="ttname"><a href="classace__button_1_1AceButton.html#a3c49e9edf8cbb5e3800c5f4506d0beca">ace_button::AceButton::getLastButtonState</a></div><div class="ttdeci">uint8_t getLastButtonState() ACE_BUTTON_INLINE</div><div class="ttdoc">Return the button state that was last valid. </div><div class="ttdef"><b>Definition:</b> <a href="ace__button_2AceButton_8h_source.html#l00192">AceButton.h:192</a></div></div>
|
|
<div class="ttc" id="classace__button_1_1AceButton_html_a9c4195cb128da40677ea223eb81743c9"><div class="ttname"><a href="classace__button_1_1AceButton.html#a9c4195cb128da40677ea223eb81743c9">ace_button::AceButton::kEventRepeatPressed</a></div><div class="ttdeci">static const uint8_t kEventRepeatPressed</div><div class="ttdoc">Button was held down and auto generated multiple presses. </div><div class="ttdef"><b>Definition:</b> <a href="ace__button_2AceButton_8h_source.html#l00084">AceButton.h:84</a></div></div>
|
|
<div class="ttc" id="classace__button_1_1ButtonConfig_html_a5d228f08e9943fd4ab90caab39ef80be"><div class="ttname"><a href="classace__button_1_1ButtonConfig.html#a5d228f08e9943fd4ab90caab39ef80be">ace_button::ButtonConfig::setEventHandler</a></div><div class="ttdeci">void setEventHandler(EventHandler eventHandler) ACE_BUTTON_INLINE</div><div class="ttdoc">Install the event handler. </div><div class="ttdef"><b>Definition:</b> <a href="ace__button_2ButtonConfig_8h_source.html#l00296">ButtonConfig.h:296</a></div></div>
|
|
<div class="ttc" id="classace__button_1_1AceButton_html_afe8e8e22146f510afa487e6ec98b6253"><div class="ttname"><a href="classace__button_1_1AceButton.html#afe8e8e22146f510afa487e6ec98b6253">ace_button::AceButton::kButtonStateUnknown</a></div><div class="ttdeci">static const uint8_t kButtonStateUnknown</div><div class="ttdoc">Button state is unknown. </div><div class="ttdef"><b>Definition:</b> <a href="ace__button_2AceButton_8h_source.html#l00090">AceButton.h:90</a></div></div>
|
|
<div class="ttc" id="classace__button_1_1ButtonConfig_html_a5dab877bf124bfdf5a5eb703ca123027"><div class="ttname"><a href="classace__button_1_1ButtonConfig.html#a5dab877bf124bfdf5a5eb703ca123027">ace_button::ButtonConfig::readButton</a></div><div class="ttdeci">virtual int readButton(uint8_t pin)</div><div class="ttdoc">Return the HIGH or LOW state of the button. </div><div class="ttdef"><b>Definition:</b> <a href="ace__button_2ButtonConfig_8h_source.html#l00263">ButtonConfig.h:263</a></div></div>
|
|
<div class="ttc" id="classace__button_1_1AceButton_html_a5e4ea4aca852a5e0b1d426bccb131cfb"><div class="ttname"><a href="classace__button_1_1AceButton.html#a5e4ea4aca852a5e0b1d426bccb131cfb">ace_button::AceButton::getButtonConfig</a></div><div class="ttdeci">ButtonConfig * getButtonConfig() ACE_BUTTON_INLINE</div><div class="ttdoc">Get the ButtonConfig associated with this Button. </div><div class="ttdef"><b>Definition:</b> <a href="ace__button_2AceButton_8h_source.html#l00143">AceButton.h:143</a></div></div>
|
|
<div class="ttc" id="classace__button_1_1AceButton_html_a18c47304c694c6f084a343a7c83bef34"><div class="ttname"><a href="classace__button_1_1AceButton.html#a18c47304c694c6f084a343a7c83bef34">ace_button::AceButton::init</a></div><div class="ttdeci">void init(uint8_t pin=0, uint8_t defaultReleasedState=HIGH, uint8_t id=0)</div><div class="ttdoc">Reset the button to the initial constructed state. </div><div class="ttdef"><b>Definition:</b> <a href="AceButton_8cpp_source.html#l00049">AceButton.cpp:49</a></div></div>
|
|
<div class="ttc" id="namespaceace__button_html"><div class="ttname"><a href="namespaceace__button.html">ace_button</a></div><div class="ttdef"><b>Definition:</b> <a href="AceButton_8cpp_source.html#l00028">AceButton.cpp:28</a></div></div>
|
|
<div class="ttc" id="classace__button_1_1ButtonConfig_html"><div class="ttname"><a href="classace__button_1_1ButtonConfig.html">ace_button::ButtonConfig</a></div><div class="ttdoc">Class that defines the timing parameters and event handler of an AceButton or a group of AceButton in...</div><div class="ttdef"><b>Definition:</b> <a href="ace__button_2ButtonConfig_8h_source.html#l00060">ButtonConfig.h:60</a></div></div>
|
|
<div class="ttc" id="classace__button_1_1AceButton_html_a0c63f30106e4688425ba37d8f7a9546b"><div class="ttname"><a href="classace__button_1_1AceButton.html#a0c63f30106e4688425ba37d8f7a9546b">ace_button::AceButton::kEventDoubleClicked</a></div><div class="ttdeci">static const uint8_t kEventDoubleClicked</div><div class="ttdoc">Button was double-clicked. </div><div class="ttdef"><b>Definition:</b> <a href="ace__button_2AceButton_8h_source.html#l00070">AceButton.h:70</a></div></div>
|
|
<div class="ttc" id="classace__button_1_1AceButton_html_a769599d288f64dc0e55a69184596d804"><div class="ttname"><a href="classace__button_1_1AceButton.html#a769599d288f64dc0e55a69184596d804">ace_button::AceButton::kEventLongPressed</a></div><div class="ttdeci">static const uint8_t kEventLongPressed</div><div class="ttdoc">Button was held down for longer than ButtonConfig::getLongPressDelay()). </div><div class="ttdef"><b>Definition:</b> <a href="ace__button_2AceButton_8h_source.html#l00076">AceButton.h:76</a></div></div>
|
|
<div class="ttc" id="classace__button_1_1AceButton_html_a4a693b836e3fed29d4e7203a5a97910b"><div class="ttname"><a href="classace__button_1_1AceButton.html#a4a693b836e3fed29d4e7203a5a97910b">ace_button::AceButton::getId</a></div><div class="ttdeci">uint8_t getId() ACE_BUTTON_INLINE</div><div class="ttdoc">Get the custom identifier of the button. </div><div class="ttdef"><b>Definition:</b> <a href="ace__button_2AceButton_8h_source.html#l00174">AceButton.h:174</a></div></div>
|
|
<div class="ttc" id="classace__button_1_1ButtonConfig_html_a6d9db3c7b221b474c3cfd8fca5f4ba1e"><div class="ttname"><a href="classace__button_1_1ButtonConfig.html#a6d9db3c7b221b474c3cfd8fca5f4ba1e">ace_button::ButtonConfig::EventHandler</a></div><div class="ttdeci">void(* EventHandler)(AceButton *button, uint8_t eventType, uint8_t buttonState)</div><div class="ttdoc">The event handler signature. </div><div class="ttdef"><b>Definition:</b> <a href="ace__button_2ButtonConfig_8h_source.html#l00164">ButtonConfig.h:164</a></div></div>
|
|
<div class="ttc" id="classace__button_1_1AceButton_html_ac6b12ca62c7c055325bfebd036579ed6"><div class="ttname"><a href="classace__button_1_1AceButton.html#ac6b12ca62c7c055325bfebd036579ed6">ace_button::AceButton::getPin</a></div><div class="ttdeci">uint8_t getPin() ACE_BUTTON_INLINE</div><div class="ttdoc">Get the button&#39;s pin number. </div><div class="ttdef"><b>Definition:</b> <a href="ace__button_2AceButton_8h_source.html#l00171">AceButton.h:171</a></div></div>
|
|
<div class="ttc" id="classace__button_1_1AceButton_html_af710048a654fa5d5e45405661282a7b1"><div class="ttname"><a href="classace__button_1_1AceButton.html#af710048a654fa5d5e45405661282a7b1">ace_button::AceButton::check</a></div><div class="ttdeci">void check()</div><div class="ttdoc">Check state of button and trigger event processing. </div><div class="ttdef"><b>Definition:</b> <a href="AceButton_8cpp_source.html#l00073">AceButton.cpp:73</a></div></div>
|
|
<div class="ttc" id="classace__button_1_1AceButton_html"><div class="ttname"><a href="classace__button_1_1AceButton.html">ace_button::AceButton</a></div><div class="ttdoc">An Adjustable Compact Event-driven (ACE) Button library that debounces and dispatches button events t...</div><div class="ttdef"><b>Definition:</b> <a href="ace__button_2AceButton_8h_source.html#l00050">AceButton.h:50</a></div></div>
|
|
<div class="ttc" id="classace__button_1_1AceButton_html_a3c480636223edc899a79c821c32c6982"><div class="ttname"><a href="classace__button_1_1AceButton.html#a3c480636223edc899a79c821c32c6982">ace_button::AceButton::AceButton</a></div><div class="ttdeci">AceButton(uint8_t pin=0, uint8_t defaultReleasedState=HIGH, uint8_t id=0)</div><div class="ttdoc">Constructor defines parameters of the button that changes from button to button. </div><div class="ttdef"><b>Definition:</b> <a href="AceButton_8cpp_source.html#l00039">AceButton.cpp:39</a></div></div>
|
|
<div class="ttc" id="classace__button_1_1AceButton_html_ada5bd7c31950e2acdb8a9464e795c13c"><div class="ttname"><a href="classace__button_1_1AceButton.html#ada5bd7c31950e2acdb8a9464e795c13c">ace_button::AceButton::kEventReleased</a></div><div class="ttdeci">static const uint8_t kEventReleased</div><div class="ttdoc">Button was released. </div><div class="ttdef"><b>Definition:</b> <a href="ace__button_2AceButton_8h_source.html#l00058">AceButton.h:58</a></div></div>
|
|
<div class="ttc" id="classace__button_1_1AceButton_html_ae723d826fe219a8415764b9fed5d8976"><div class="ttname"><a href="classace__button_1_1AceButton.html#ae723d826fe219a8415764b9fed5d8976">ace_button::AceButton::kEventPressed</a></div><div class="ttdeci">static const uint8_t kEventPressed</div><div class="ttdoc">Button was pressed. </div><div class="ttdef"><b>Definition:</b> <a href="ace__button_2AceButton_8h_source.html#l00055">AceButton.h:55</a></div></div>
|
|
<div class="ttc" id="classace__button_1_1AceButton_html_a21797e5e069da3f7bba42b40ab3a7305"><div class="ttname"><a href="classace__button_1_1AceButton.html#a21797e5e069da3f7bba42b40ab3a7305">ace_button::AceButton::kEventClicked</a></div><div class="ttdeci">static const uint8_t kEventClicked</div><div class="ttdoc">Button was clicked (Pressed and Released within ButtonConfig::getClickDelay()). </div><div class="ttdef"><b>Definition:</b> <a href="ace__button_2AceButton_8h_source.html#l00064">AceButton.h:64</a></div></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.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|