87 lines
11 KiB
HTML
87 lines
11 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.14"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>satnogs-rotator-firmware: libraries/endstop.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">satnogs-rotator-firmware
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.14 -->
|
|
<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_bc0718b08fb2015b8e59c47b2805f60c.html">libraries</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">endstop.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="endstop_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> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#ifndef ENDSTOP_H_</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#define ENDSTOP_H_</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">/**************************************************************************/</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">/**************************************************************************/</span></div><div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="classendstop.html"> 22</a></span> <span class="keyword">class </span><a class="code" href="classendstop.html">endstop</a> {</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">public</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"><a class="line" href="classendstop.html#accd7d557af506828fffb434809f422f1"> 25</a></span>  <a class="code" href="classendstop.html#accd7d557af506828fffb434809f422f1">endstop</a>(uint8_t pin, <span class="keywordtype">bool</span> default_state) {</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <a class="code" href="classendstop.html#a17475e2676c5922399ea8b2bd6de0111">_pin</a> = pin;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <a class="code" href="classendstop.html#aaf8429fa28d2aa40a42884b469e8f626">_default_state</a> = default_state;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  }</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="comment">/**************************************************************************/</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="comment">/**************************************************************************/</span></div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classendstop.html#a6d24d7ed95ded92431288da42a6aebf9"> 35</a></span>  <span class="keywordtype">void</span> <a class="code" href="classendstop.html#a6d24d7ed95ded92431288da42a6aebf9">init</a>() {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  pinMode(<a class="code" href="classendstop.html#a17475e2676c5922399ea8b2bd6de0111">_pin</a>, INPUT_PULLUP);</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  }</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="comment">/**************************************************************************/</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="comment">/**************************************************************************/</span></div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classendstop.html#a530a60aaf81bd5022e56df71c194dfbc"> 45</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classendstop.html#a530a60aaf81bd5022e56df71c194dfbc">get_state</a>() {</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordflow">if</span> (digitalRead(<a class="code" href="classendstop.html#a17475e2676c5922399ea8b2bd6de0111">_pin</a>) == <a class="code" href="classendstop.html#aaf8429fa28d2aa40a42884b469e8f626">_default_state</a>)</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</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="keyword">private</span>:</div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classendstop.html#a17475e2676c5922399ea8b2bd6de0111"> 53</a></span>  uint8_t <a class="code" href="classendstop.html#a17475e2676c5922399ea8b2bd6de0111">_pin</a>;</div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classendstop.html#aaf8429fa28d2aa40a42884b469e8f626"> 54</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classendstop.html#aaf8429fa28d2aa40a42884b469e8f626">_default_state</a>;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> };</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#endif </span><span class="comment">/* ENDSTOP_H_ */</span><span class="preprocessor"></span></div><div class="ttc" id="classendstop_html_a17475e2676c5922399ea8b2bd6de0111"><div class="ttname"><a href="classendstop.html#a17475e2676c5922399ea8b2bd6de0111">endstop::_pin</a></div><div class="ttdeci">uint8_t _pin</div><div class="ttdef"><b>Definition:</b> <a href="endstop_8h_source.html#l00053">endstop.h:53</a></div></div>
|
|
<div class="ttc" id="classendstop_html_a6d24d7ed95ded92431288da42a6aebf9"><div class="ttname"><a href="classendstop.html#a6d24d7ed95ded92431288da42a6aebf9">endstop::init</a></div><div class="ttdeci">void init()</div><div class="ttdoc">Initialize the Input pin for end-stop. </div><div class="ttdef"><b>Definition:</b> <a href="endstop_8h_source.html#l00035">endstop.h:35</a></div></div>
|
|
<div class="ttc" id="classendstop_html"><div class="ttname"><a href="classendstop.html">endstop</a></div><div class="ttdoc">Class that functions for interacting with end-stop. </div><div class="ttdef"><b>Definition:</b> <a href="endstop_8h_source.html#l00022">endstop.h:22</a></div></div>
|
|
<div class="ttc" id="classendstop_html_accd7d557af506828fffb434809f422f1"><div class="ttname"><a href="classendstop.html#accd7d557af506828fffb434809f422f1">endstop::endstop</a></div><div class="ttdeci">endstop(uint8_t pin, bool default_state)</div><div class="ttdef"><b>Definition:</b> <a href="endstop_8h_source.html#l00025">endstop.h:25</a></div></div>
|
|
<div class="ttc" id="classendstop_html_aaf8429fa28d2aa40a42884b469e8f626"><div class="ttname"><a href="classendstop.html#aaf8429fa28d2aa40a42884b469e8f626">endstop::_default_state</a></div><div class="ttdeci">bool _default_state</div><div class="ttdef"><b>Definition:</b> <a href="endstop_8h_source.html#l00054">endstop.h:54</a></div></div>
|
|
<div class="ttc" id="classendstop_html_a530a60aaf81bd5022e56df71c194dfbc"><div class="ttname"><a href="classendstop.html#a530a60aaf81bd5022e56df71c194dfbc">endstop::get_state</a></div><div class="ttdeci">bool get_state()</div><div class="ttdoc">Get the state of end-stop. </div><div class="ttdef"><b>Definition:</b> <a href="endstop_8h_source.html#l00045">endstop.h:45</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.14
|
|
</small></address>
|
|
</body>
|
|
</html>
|