spacecruft
/
satnogs-rotator-firmware
1
0
Fork 0
Code Issues Pull Requests Releases Activity
satnogs-rotator-firmware/doxygen_files/html/globals_8h.html

278 lines
19 KiB
HTML
Raw Blame History

<!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/globals.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">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&amp;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&amp;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="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">globals.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;Arduino.h&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for globals.h:</div>
<div class="dyncontent">
<div class="center"><img src="globals_8h__incl.png" border="0" usemap="#libraries_2globals_8h" alt=""/></div>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="globals_8h__dep__incl.png" border="0" usemap="#libraries_2globals_8hdep" alt=""/></div>
<map name="libraries_2globals_8hdep" id="libraries_2globals_8hdep">
<area shape="rect" id="node2" href="easycomm_8h.html" title="libraries/easycomm.h" alt="" coords="144,80,307,107"/>
<area shape="rect" id="node3" href="watchdog_8h.html" title="libraries/watchdog.h" alt="" coords="39,155,193,181"/>
<area shape="rect" id="node4" href="dc__motor__controller_8ino.html" title="dc_motor_controller\l/dc_motor_controller.ino" alt="" coords="5,229,184,271"/>
<area shape="rect" id="node5" href="stepper__motor__controller_8ino.html" title="stepper_motor_controller\l/stepper_motor_controller.ino" alt="" coords="208,229,421,271"/>
</map>
</div>
</div>
<p><a href="globals_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__control.html">_control</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__rotator.html">_rotator</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ae09bc16eee2b545dd6a98d700c3e3501"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="globals_8h.html#ae09bc16eee2b545dd6a98d700c3e3501">_rotator_status</a> { <a class="el" href="globals_8h.html#ae09bc16eee2b545dd6a98d700c3e3501a0e9a37114c0e458d28d52f06ec0f2242">idle</a> = 1,
<a class="el" href="globals_8h.html#ae09bc16eee2b545dd6a98d700c3e3501ab4be0aa0ed7631ee6c4a434c66cd86bf">moving</a> = 2,
<a class="el" href="globals_8h.html#ae09bc16eee2b545dd6a98d700c3e3501ad975d8e65ab97856d5861bd3065e4f67">pointing</a> = 4,
<a class="el" href="globals_8h.html#ae09bc16eee2b545dd6a98d700c3e3501ad606e435413ea0944dd00d49e901e4ed">error</a> = 8
}</td></tr>
<tr class="separator:ae09bc16eee2b545dd6a98d700c3e3501"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a455fc53a09c638322a14f309a295e7f1"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="globals_8h.html#a455fc53a09c638322a14f309a295e7f1">_rotator_error</a> { <br />
&#160;&#160;<a class="el" href="globals_8h.html#a455fc53a09c638322a14f309a295e7f1a1f1efebf2c41e3bef0fef1862bf5f0c4">no_error</a> = 1,
<a class="el" href="globals_8h.html#a455fc53a09c638322a14f309a295e7f1a13da766a5299f2f7015a5922277088b4">sensor_error</a> = 2,
<a class="el" href="globals_8h.html#a455fc53a09c638322a14f309a295e7f1a83cf4d6b86174dccaf2a83810b4f83b6">homing_error</a> = 4,
<a class="el" href="globals_8h.html#a455fc53a09c638322a14f309a295e7f1ab3e9a59dba488d350b0eabd4962a67af">motor_error</a> = 8,
<br />
&#160;&#160;<a class="el" href="globals_8h.html#a455fc53a09c638322a14f309a295e7f1a717423059b8c506b73ed007b6a8c3bca">over_temperature</a> = 12,
<a class="el" href="globals_8h.html#a455fc53a09c638322a14f309a295e7f1a33b2cd89605d2c298f0f1b447eb794fb">wdt_error</a> = 16
<br />
}</td></tr>
<tr class="separator:a455fc53a09c638322a14f309a295e7f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a011a2a3681d95bf0def772367ba6ad33"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="globals_8h.html#a011a2a3681d95bf0def772367ba6ad33">_control_mode</a> { <a class="el" href="globals_8h.html#a011a2a3681d95bf0def772367ba6ad33a186286c1e4467cf7aeb7d01bca2ba162">position</a> = 0,
<a class="el" href="globals_8h.html#a011a2a3681d95bf0def772367ba6ad33a3d18b3fd8daa40d26a07452c9de67a87">speed</a> = 1
}</td></tr>
<tr class="separator:a011a2a3681d95bf0def772367ba6ad33"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a87c5a684fccc0f0ed68486d54ffbda77"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct__control.html">_control</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="globals_8h.html#a87c5a684fccc0f0ed68486d54ffbda77">control_az</a></td></tr>
<tr class="separator:a87c5a684fccc0f0ed68486d54ffbda77"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade92ac8f94e642ce7708250d1235ae85"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct__control.html">_control</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="globals_8h.html#ade92ac8f94e642ce7708250d1235ae85">control_el</a></td></tr>
<tr class="separator:ade92ac8f94e642ce7708250d1235ae85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:addd34cf12b8ad4e4eb65097b7c950dc4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct__rotator.html">_rotator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="globals_8h.html#addd34cf12b8ad4e4eb65097b7c950dc4">rotator</a></td></tr>
<tr class="separator:addd34cf12b8ad4e4eb65097b7c950dc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>It is a file to define all global variables</p>
<p>Licensed under the GPLv3 </p>
<p class="definition">Definition in file <a class="el" href="globals_8h_source.html">globals.h</a>.</p>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a011a2a3681d95bf0def772367ba6ad33"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a011a2a3681d95bf0def772367ba6ad33">&#9670;&nbsp;</a></span>_control_mode</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="globals_8h.html#a011a2a3681d95bf0def772367ba6ad33">_control_mode</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Rotator Control Modes </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a011a2a3681d95bf0def772367ba6ad33a186286c1e4467cf7aeb7d01bca2ba162"></a>position&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a011a2a3681d95bf0def772367ba6ad33a3d18b3fd8daa40d26a07452c9de67a87"></a>speed&#160;</td><td class="fielddoc"></td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="globals_8h_source.html#l00025">25</a> of file <a class="el" href="globals_8h_source.html">globals.h</a>.</p>
</div>
</div>
<a id="a455fc53a09c638322a14f309a295e7f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a455fc53a09c638322a14f309a295e7f1">&#9670;&nbsp;</a></span>_rotator_error</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="globals_8h.html#a455fc53a09c638322a14f309a295e7f1">_rotator_error</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Rotator Errors </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a455fc53a09c638322a14f309a295e7f1a1f1efebf2c41e3bef0fef1862bf5f0c4"></a>no_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a455fc53a09c638322a14f309a295e7f1a13da766a5299f2f7015a5922277088b4"></a>sensor_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a455fc53a09c638322a14f309a295e7f1a83cf4d6b86174dccaf2a83810b4f83b6"></a>homing_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a455fc53a09c638322a14f309a295e7f1ab3e9a59dba488d350b0eabd4962a67af"></a>motor_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a455fc53a09c638322a14f309a295e7f1a717423059b8c506b73ed007b6a8c3bca"></a>over_temperature&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a455fc53a09c638322a14f309a295e7f1a33b2cd89605d2c298f0f1b447eb794fb"></a>wdt_error&#160;</td><td class="fielddoc"></td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="globals_8h_source.html#l00020">20</a> of file <a class="el" href="globals_8h_source.html">globals.h</a>.</p>
</div>
</div>
<a id="ae09bc16eee2b545dd6a98d700c3e3501"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae09bc16eee2b545dd6a98d700c3e3501">&#9670;&nbsp;</a></span>_rotator_status</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="globals_8h.html#ae09bc16eee2b545dd6a98d700c3e3501">_rotator_status</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Rotator status </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ae09bc16eee2b545dd6a98d700c3e3501a0e9a37114c0e458d28d52f06ec0f2242"></a>idle&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ae09bc16eee2b545dd6a98d700c3e3501ab4be0aa0ed7631ee6c4a434c66cd86bf"></a>moving&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ae09bc16eee2b545dd6a98d700c3e3501ad975d8e65ab97856d5861bd3065e4f67"></a>pointing&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ae09bc16eee2b545dd6a98d700c3e3501ad606e435413ea0944dd00d49e901e4ed"></a>error&#160;</td><td class="fielddoc"></td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="globals_8h_source.html#l00016">16</a> of file <a class="el" href="globals_8h_source.html">globals.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a87c5a684fccc0f0ed68486d54ffbda77"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a87c5a684fccc0f0ed68486d54ffbda77">&#9670;&nbsp;</a></span>control_az</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct__control.html">_control</a> control_az</td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= { .input = 0, .input_prv = 0, .speed=0, .setpoint = 0,</div><div class="line"> .setpoint_speed = 0, .load = 0, .u = 0, .p = 8.0,</div><div class="line"> .i = 0.0, .d = 0.5 }</div></div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="globals_8h_source.html#l00051">51</a> of file <a class="el" href="globals_8h_source.html">globals.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="easycomm_8h_source.html#l00048">easycomm::easycomm_proc()</a>, <a class="el" href="stepper__motor__controller_8ino_source.html#l00154">homing()</a>, and <a class="el" href="stepper__motor__controller_8ino_source.html#l00084">loop()</a>.</p>
</div>
</div>
<a id="ade92ac8f94e642ce7708250d1235ae85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade92ac8f94e642ce7708250d1235ae85">&#9670;&nbsp;</a></span>control_el</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct__control.html">_control</a> control_el</td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= { .input = 0, .input_prv = 0, .speed=0, .setpoint = 0,</div><div class="line"> .setpoint_speed = 0, .load = 0, .u = 0, .p = 10.0,</div><div class="line"> .i = 0.0, .d = 0.3 }</div></div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="globals_8h_source.html#l00054">54</a> of file <a class="el" href="globals_8h_source.html">globals.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="easycomm_8h_source.html#l00048">easycomm::easycomm_proc()</a>, <a class="el" href="stepper__motor__controller_8ino_source.html#l00154">homing()</a>, and <a class="el" href="stepper__motor__controller_8ino_source.html#l00084">loop()</a>.</p>
</div>
</div>
<a id="addd34cf12b8ad4e4eb65097b7c950dc4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#addd34cf12b8ad4e4eb65097b7c950dc4">&#9670;&nbsp;</a></span>rotator</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct__rotator.html">_rotator</a> rotator</td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= { .rotator_status = <a class="code" href="globals_8h.html#ae09bc16eee2b545dd6a98d700c3e3501a0e9a37114c0e458d28d52f06ec0f2242">idle</a>, .rotator_error = <a class="code" href="globals_8h.html#a455fc53a09c638322a14f309a295e7f1a1f1efebf2c41e3bef0fef1862bf5f0c4">no_error</a>,</div><div class="line"> .control_mode = <a class="code" href="globals_8h.html#a011a2a3681d95bf0def772367ba6ad33a186286c1e4467cf7aeb7d01bca2ba162">position</a>, .homing_flag = <span class="keyword">false</span>,</div><div class="line"> .inside_temperature = 0, .park_az = 0, .park_el = 0,</div><div class="line"> .fault_az = LOW, .fault_el = LOW , .switch_az = <span class="keyword">false</span>,</div><div class="line"> .switch_el = <span class="keyword">false</span>}</div><div class="ttc" id="globals_8h_html_ae09bc16eee2b545dd6a98d700c3e3501a0e9a37114c0e458d28d52f06ec0f2242"><div class="ttname"><a href="globals_8h.html#ae09bc16eee2b545dd6a98d700c3e3501a0e9a37114c0e458d28d52f06ec0f2242">idle</a></div><div class="ttdef"><b>Definition:</b> <a href="globals_8h_source.html#l00017">globals.h:17</a></div></div>
<div class="ttc" id="globals_8h_html_a011a2a3681d95bf0def772367ba6ad33a186286c1e4467cf7aeb7d01bca2ba162"><div class="ttname"><a href="globals_8h.html#a011a2a3681d95bf0def772367ba6ad33a186286c1e4467cf7aeb7d01bca2ba162">position</a></div><div class="ttdef"><b>Definition:</b> <a href="globals_8h_source.html#l00026">globals.h:26</a></div></div>
<div class="ttc" id="globals_8h_html_a455fc53a09c638322a14f309a295e7f1a1f1efebf2c41e3bef0fef1862bf5f0c4"><div class="ttname"><a href="globals_8h.html#a455fc53a09c638322a14f309a295e7f1a1f1efebf2c41e3bef0fef1862bf5f0c4">no_error</a></div><div class="ttdef"><b>Definition:</b> <a href="globals_8h_source.html#l00021">globals.h:21</a></div></div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="globals_8h_source.html#l00057">57</a> of file <a class="el" href="globals_8h_source.html">globals.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="easycomm_8h_source.html#l00048">easycomm::easycomm_proc()</a>, <a class="el" href="watchdog_8h_source.html#l00056">ISR()</a>, and <a class="el" href="dc__motor__controller_8ino_source.html#l00105">loop()</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink