<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>VizBlocks: src/Button.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">VizBlocks
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Button.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="_button_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef BUTTON_h</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define BUTTON_h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include <Arduino.h></span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>  </div>
<div class="line"><a name="l00006"></a><span class="lineno"><a class="line" href="class_button.html"> 6</a></span> <span class="keyword">class </span><a class="code" href="class_button.html">Button</a></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> {</div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>  </div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  <span class="keywordtype">int</span> _pin;</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  <span class="keywordtype">int</span> _id;</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  </div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  <span class="keywordtype">bool</span> _state;</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  </div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  <span class="keyword">volatile</span> <span class="keywordtype">bool</span> _inputFlag = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <span class="keywordtype">bool</span> _changeFlag = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <span class="keywordtype">bool</span> _pressedFlag = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <span class="keywordtype">bool</span> _holdFlag = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> _previousTimer;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="keywordtype">int</span> _clickInterval = 1000;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="keywordtype">int</span> _holdInterval = 1000;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keywordtype">int</span> _repeatInterval = 1000;</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>  void (*_cb)(<a class="code" href="class_button.html">Button</a>*, uint8_t, bool); <span class="comment">// Callback function</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordtype">bool</span> _read();</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">void</span> _setClickInterval(<span class="keywordtype">int</span> x);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordtype">void</span> _setHoldInterval(<span class="keywordtype">int</span> x);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordtype">void</span> _setRepeatInterval(<span class="keywordtype">int</span> x);</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="comment">// Public members:</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="class_button.html#aeff212895aef4677c616d34494220e14"> 54</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t <a class="code" href="class_button.html#aeff212895aef4677c616d34494220e14">kEventPressed</a> = 0; <span class="comment">// Button was pressed</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="class_button.html#a0c1101a90c59dd34cb05a6cdf94edaff"> 55</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t <a class="code" href="class_button.html#a0c1101a90c59dd34cb05a6cdf94edaff">kEventReleased</a> = 1; <span class="comment">// Button was released</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="class_button.html#a41963b0ccc28009de8a46c52cad5b9b4"> 56</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t <a class="code" href="class_button.html#a41963b0ccc28009de8a46c52cad5b9b4">kEventClicked</a> = 2; <span class="comment">// Button was clicked (pressed and released within _clickInterval)</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="class_button.html#a919fb4da7e37b23eaeb08b6194b2338c"> 57</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t <a class="code" href="class_button.html#a919fb4da7e37b23eaeb08b6194b2338c">kEventHeld</a> = 3; <span class="comment">// Button was held down for longer than _holdInterval</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="class_button.html#a0815fb27da6cee2d24f53f26155d0031"> 58</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t <a class="code" href="class_button.html#a0815fb27da6cee2d24f53f26155d0031">kEventTick</a> = 4; <span class="comment">// Event released every _repeatInterval when button held</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="comment">// Public functions:</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  </div>
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="class_button.html#ac61739f093022155c9c7c1d281feffdb"> 62</a></span>  <a class="code" href="class_button.html#ac61739f093022155c9c7c1d281feffdb">Button</a>(<span class="keywordtype">int</span> pin, <span class="keywordtype">int</span> <span class="keywordtype">id</span> = 99);</div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="class_button.html#a8fc0f6d87068ccd44e07b1d764eddf3f"> 66</a></span>  <span class="keywordtype">void</span> <a class="code" href="class_button.html#a8fc0f6d87068ccd44e07b1d764eddf3f">initInterrupts</a>(<span class="keywordtype">void</span> (*<span class="keyword">function</span>)());</div>
<div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="class_button.html#a94e66e570b29f34aeb0680b7c657265d"> 70</a></span>  <span class="keywordtype">void</span> <a class="code" href="class_button.html#a94e66e570b29f34aeb0680b7c657265d">setEventHandler</a>(<span class="keywordtype">void</span> (*<span class="keyword">function</span>)(<a class="code" href="class_button.html">Button</a>*, uint8_t, <span class="keywordtype">bool</span>));</div>
<div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="class_button.html#a946d9bb84880931ccf3494d84f0ac73a"> 74</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_button.html#a946d9bb84880931ccf3494d84f0ac73a">getState</a>();</div>
<div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="class_button.html#a0b024eb643308f2cfa8d13cd93c6b1ca"> 78</a></span>  <span class="keywordtype">int</span> <a class="code" href="class_button.html#a0b024eb643308f2cfa8d13cd93c6b1ca">getId</a>();</div>
<div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="class_button.html#accfe0a939a17dd9426a4c61323c32e7f"> 82</a></span>  <span class="keywordtype">int</span> <a class="code" href="class_button.html#accfe0a939a17dd9426a4c61323c32e7f">getClickInterval</a>();</div>
<div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="class_button.html#a9782adb68590b975c4c7473b1c2716d4"> 86</a></span>  <span class="keywordtype">int</span> <a class="code" href="class_button.html#a9782adb68590b975c4c7473b1c2716d4">getHoldInterval</a>();</div>
<div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="class_button.html#aff7b7fc611d3f412c91aea2082a9b48d"> 90</a></span>  <span class="keywordtype">int</span> <a class="code" href="class_button.html#aff7b7fc611d3f412c91aea2082a9b48d">getRepeatInterval</a>();</div>
<div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="class_button.html#a4bd4f650e382a7a5501a12dfb7a6b714"> 94</a></span>  <span class="keywordtype">void</span> <a class="code" href="class_button.html#a4bd4f650e382a7a5501a12dfb7a6b714">check</a>();</div>
<div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="class_button.html#aa5151d4e678a588275cfe773337435af"> 98</a></span>  <span class="keywordtype">void</span> ICACHE_RAM_ATTR <a class="code" href="class_button.html#aa5151d4e678a588275cfe773337435af">tick</a>();</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  </div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> };</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  </div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclass_button_html_a919fb4da7e37b23eaeb08b6194b2338c"><div class="ttname"><a href="class_button.html#a919fb4da7e37b23eaeb08b6194b2338c">Button::kEventHeld</a></div><div class="ttdeci">static const uint8_t kEventHeld</div><div class="ttdef"><b>Definition:</b> Button.h:57</div></div>
<div class="ttc" id="aclass_button_html_aff7b7fc611d3f412c91aea2082a9b48d"><div class="ttname"><a href="class_button.html#aff7b7fc611d3f412c91aea2082a9b48d">Button::getRepeatInterval</a></div><div class="ttdeci">int getRepeatInterval()</div><div class="ttdoc">What does this do?</div></div>
<div class="ttc" id="aclass_button_html_ac61739f093022155c9c7c1d281feffdb"><div class="ttname"><a href="class_button.html#ac61739f093022155c9c7c1d281feffdb">Button::Button</a></div><div class="ttdeci">Button(int pin, int id=99)</div></div>
<div class="ttc" id="aclass_button_html_a41963b0ccc28009de8a46c52cad5b9b4"><div class="ttname"><a href="class_button.html#a41963b0ccc28009de8a46c52cad5b9b4">Button::kEventClicked</a></div><div class="ttdeci">static const uint8_t kEventClicked</div><div class="ttdef"><b>Definition:</b> Button.h:56</div></div>
<div class="ttc" id="aclass_button_html_a4bd4f650e382a7a5501a12dfb7a6b714"><div class="ttname"><a href="class_button.html#a4bd4f650e382a7a5501a12dfb7a6b714">Button::check</a></div><div class="ttdeci">void check()</div><div class="ttdoc">What does this do?</div></div>
<div class="ttc" id="aclass_button_html_accfe0a939a17dd9426a4c61323c32e7f"><div class="ttname"><a href="class_button.html#accfe0a939a17dd9426a4c61323c32e7f">Button::getClickInterval</a></div><div class="ttdeci">int getClickInterval()</div><div class="ttdoc">What does this do?</div></div>
<div class="ttc" id="aclass_button_html_a94e66e570b29f34aeb0680b7c657265d"><div class="ttname"><a href="class_button.html#a94e66e570b29f34aeb0680b7c657265d">Button::setEventHandler</a></div><div class="ttdeci">void setEventHandler(void(*function)(Button *, uint8_t, bool))</div><div class="ttdoc">What does this do?</div></div>
<div class="ttc" id="aclass_button_html_aa5151d4e678a588275cfe773337435af"><div class="ttname"><a href="class_button.html#aa5151d4e678a588275cfe773337435af">Button::tick</a></div><div class="ttdeci">void ICACHE_RAM_ATTR tick()</div><div class="ttdoc">What does this do?</div></div>
<div class="ttc" id="aclass_button_html"><div class="ttname"><a href="class_button.html">Button</a></div><div class="ttdef"><b>Definition:</b> Button.h:7</div></div>
<div class="ttc" id="aclass_button_html_aeff212895aef4677c616d34494220e14"><div class="ttname"><a href="class_button.html#aeff212895aef4677c616d34494220e14">Button::kEventPressed</a></div><div class="ttdeci">static const uint8_t kEventPressed</div><div class="ttdef"><b>Definition:</b> Button.h:54</div></div>
<div class="ttc" id="aclass_button_html_a946d9bb84880931ccf3494d84f0ac73a"><div class="ttname"><a href="class_button.html#a946d9bb84880931ccf3494d84f0ac73a">Button::getState</a></div><div class="ttdeci">bool getState()</div><div class="ttdoc">What does this do?</div></div>
<div class="ttc" id="aclass_button_html_a9782adb68590b975c4c7473b1c2716d4"><div class="ttname"><a href="class_button.html#a9782adb68590b975c4c7473b1c2716d4">Button::getHoldInterval</a></div><div class="ttdeci">int getHoldInterval()</div><div class="ttdoc">What does this do?</div></div>
<div class="ttc" id="aclass_button_html_a0c1101a90c59dd34cb05a6cdf94edaff"><div class="ttname"><a href="class_button.html#a0c1101a90c59dd34cb05a6cdf94edaff">Button::kEventReleased</a></div><div class="ttdeci">static const uint8_t kEventReleased</div><div class="ttdef"><b>Definition:</b> Button.h:55</div></div>
<div class="ttc" id="aclass_button_html_a0b024eb643308f2cfa8d13cd93c6b1ca"><div class="ttname"><a href="class_button.html#a0b024eb643308f2cfa8d13cd93c6b1ca">Button::getId</a></div><div class="ttdeci">int getId()</div><div class="ttdoc">What does this do?</div></div>
<div class="ttc" id="aclass_button_html_a0815fb27da6cee2d24f53f26155d0031"><div class="ttname"><a href="class_button.html#a0815fb27da6cee2d24f53f26155d0031">Button::kEventTick</a></div><div class="ttdeci">static const uint8_t kEventTick</div><div class="ttdef"><b>Definition:</b> Button.h:58</div></div>
<div class="ttc" id="aclass_button_html_a8fc0f6d87068ccd44e07b1d764eddf3f"><div class="ttname"><a href="class_button.html#a8fc0f6d87068ccd44e07b1d764eddf3f">Button::initInterrupts</a></div><div class="ttdeci">void initInterrupts(void(*function)())</div><div class="ttdoc">What does this do?</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.18
</small></address>
</body>
</html>