tRacket-sensor

<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>tRacket Sensor: noisemeter-device/blinker.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 id="projectrow">
  <td id="projectalign">
   <div id="projectname">tRacket Sensor<span id="projectnumber">&#160;0.2.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_640a2e73a782d0e2711002117fcf2017.html">noisemeter-device</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">blinker.h</div></div>
</div><!--header-->
<div class="contents">
<a href="blinker_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment">/* noisemeter-device - Firmware for CivicTechTO&#39;s Noisemeter Device</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Copyright (C) 2024  Clyne Sullivan</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> *</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * This program is free software: you can redistribute it and/or modify</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * it under the terms of the GNU General Public License as published by</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> * the Free Software Foundation, either version 3 of the License, or</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> * (at your option) any later version.</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * This program is distributed in the hope that it will be useful,</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * GNU General Public License for more details.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> *</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * You should have received a copy of the GNU General Public License</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"> * along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment"> */</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="preprocessor">#ifndef BLINKER_H</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="preprocessor">#define BLINKER_H</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &quot;<a class="code" href="board_8h.html">board.h</a>&quot;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#include &lt;Ticker.h&gt;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span> </div>
<div class="foldopen" id="foldopen00029" data-start="{" data-end="};">
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="classBlinker.html">   29</a></span><span class="keyword">class </span><a class="code hl_class" href="classBlinker.html">Blinker</a> : <span class="keyword">public</span> Ticker</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span>{</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="keyword">public</span>:</div>
<div class="foldopen" id="foldopen00036" data-start="{" data-end="}">
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="classBlinker.html#a8b59cdda787453b77f20791edc7c9ec5">   36</a></span>  <a class="code hl_function" href="classBlinker.html#a8b59cdda787453b77f20791edc7c9ec5">Blinker</a>(<span class="keywordtype">unsigned</span> ms):</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span>    Ticker()</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span>  {</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span>    attach_ms(ms, <a class="code hl_function" href="classBlinker.html#af75759cb22e5a665ec8dd8d52c640e18">callback</a>, &amp;<a class="code hl_variable" href="classBlinker.html#a968e8707f98056473fb3f9c3fea3d7b2">state</a>);</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span>  }</div>
</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span> </div>
<div class="foldopen" id="foldopen00045" data-start="{" data-end="}">
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="classBlinker.html#a2fe7feaac0ac3ca4cf40239849058c5b">   45</a></span>  <a class="code hl_function" href="classBlinker.html#a2fe7feaac0ac3ca4cf40239849058c5b">~Blinker</a>() {</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span>    <span class="comment">// turn off the LED</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span>    digitalWrite(PIN_LED1, HIGH);</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span>  }</div>
</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="classBlinker.html#a968e8707f98056473fb3f9c3fea3d7b2">   52</a></span>  <span class="keywordtype">int</span> <a class="code hl_variable" href="classBlinker.html#a968e8707f98056473fb3f9c3fea3d7b2">state</a> = HIGH;</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span> </div>
<div class="foldopen" id="foldopen00058" data-start="{" data-end="}">
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"><a class="line" href="classBlinker.html#af75759cb22e5a665ec8dd8d52c640e18">   58</a></span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classBlinker.html#af75759cb22e5a665ec8dd8d52c640e18">callback</a>(<span class="keywordtype">int</span> *st) {</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span>    digitalWrite(PIN_LED1, *st);</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span>    *st ^= HIGH;</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span>  }</div>
</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span>};</div>
</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="preprocessor">#endif </span><span class="comment">// BLINKER_H</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span> </div>
<div class="ttc" id="aboard_8h_html"><div class="ttname"><a href="board_8h.html">board.h</a></div><div class="ttdoc">Pre-defined hardware configurations.</div></div>
<div class="ttc" id="aclassBlinker_html"><div class="ttname"><a href="classBlinker.html">Blinker</a></div><div class="ttdoc">Automates the blinking of the board's LED indicator.</div><div class="ttdef"><b>Definition</b> <a href="blinker_8h_source.html#l00029">blinker.h:30</a></div></div>
<div class="ttc" id="aclassBlinker_html_a2fe7feaac0ac3ca4cf40239849058c5b"><div class="ttname"><a href="classBlinker.html#a2fe7feaac0ac3ca4cf40239849058c5b">Blinker::~Blinker</a></div><div class="ttdeci">~Blinker()</div><div class="ttdoc">Detaches the LED toggle routine.</div><div class="ttdef"><b>Definition</b> <a href="blinker_8h_source.html#l00045">blinker.h:45</a></div></div>
<div class="ttc" id="aclassBlinker_html_a8b59cdda787453b77f20791edc7c9ec5"><div class="ttname"><a href="classBlinker.html#a8b59cdda787453b77f20791edc7c9ec5">Blinker::Blinker</a></div><div class="ttdeci">Blinker(unsigned ms)</div><div class="ttdoc">Starts a timer to toggle the LED.</div><div class="ttdef"><b>Definition</b> <a href="blinker_8h_source.html#l00036">blinker.h:36</a></div></div>
<div class="ttc" id="aclassBlinker_html_a968e8707f98056473fb3f9c3fea3d7b2"><div class="ttname"><a href="classBlinker.html#a968e8707f98056473fb3f9c3fea3d7b2">Blinker::state</a></div><div class="ttdeci">int state</div><div class="ttdoc">State of the LED.</div><div class="ttdef"><b>Definition</b> <a href="blinker_8h_source.html#l00052">blinker.h:52</a></div></div>
<div class="ttc" id="aclassBlinker_html_af75759cb22e5a665ec8dd8d52c640e18"><div class="ttname"><a href="classBlinker.html#af75759cb22e5a665ec8dd8d52c640e18">Blinker::callback</a></div><div class="ttdeci">static void callback(int *st)</div><div class="ttdoc">Ticker callback to toggle the LED every time interval.</div><div class="ttdef"><b>Definition</b> <a href="blinker_8h_source.html#l00058">blinker.h:58</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>