Skip to content
This repository was archived by the owner on Sep 13, 2025. It is now read-only.

Commit 7ae2c25

Browse files
DavarcoDavarco
committed
Added intro documentation
1 parent df5a51f commit 7ae2c25

File tree

366 files changed

+15032
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

366 files changed

+15032
-0
lines changed

‎doc/html/annotated.html‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.13"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>Mako: Data Structures</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr style="height: 56px;">
23+
<td id="projectalign" style="padding-left: 0.5em;">
24+
<div id="projectname">Mako
25+
</div>
26+
</td>
27+
</tr>
28+
</tbody>
29+
</table>
30+
</div>
31+
<!-- end header part -->
32+
<!-- Generated by Doxygen 1.8.13 -->
33+
<script type="text/javascript">
34+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
35+
</script>
36+
<script type="text/javascript" src="menudata.js"></script>
37+
<script type="text/javascript" src="menu.js"></script>
38+
<script type="text/javascript">
39+
$(function() {
40+
initMenu('',true,false,'search.php','Search');
41+
$(document).ready(function() { init_search(); });
42+
});
43+
</script>
44+
<div id="main-nav"></div>
45+
</div><!-- top -->
46+
<!-- window showing the filter options -->
47+
<div id="MSearchSelectWindow"
48+
onmouseover="return searchBox.OnSearchSelectShow()"
49+
onmouseout="return searchBox.OnSearchSelectHide()"
50+
onkeydown="return searchBox.OnSearchSelectKey(event)">
51+
</div>
52+
53+
<!-- iframe showing the search results (closed by default) -->
54+
<div id="MSearchResultsWindow">
55+
<iframe src="javascript:void(0)" frameborder="0"
56+
name="MSearchResults" id="MSearchResults">
57+
</iframe>
58+
</div>
59+
60+
<div class="header">
61+
<div class="headertitle">
62+
<div class="title">Data Structures</div> </div>
63+
</div><!--header-->
64+
<div class="contents">
65+
<div class="textblock">Here are the data structures with brief descriptions:</div><div class="directory">
66+
<table class="directory">
67+
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structCamera.html" target="_self">Camera</a></td><td class="desc"></td></tr>
68+
<tr id="row_1_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classModel.html" target="_self">Model</a></td><td class="desc"></td></tr>
69+
<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structObservation.html" target="_self">Observation</a></td><td class="desc"></td></tr>
70+
<tr id="row_3_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structState.html" target="_self">State</a></td><td class="desc"></td></tr>
71+
<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classTensor.html" target="_self">Tensor</a></td><td class="desc"></td></tr>
72+
<tr id="row_5_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classVisionService.html" target="_self">VisionService</a></td><td class="desc"></td></tr>
73+
</table>
74+
</div><!-- directory -->
75+
</div><!-- contents -->
76+
<!-- start footer part -->
77+
<hr class="footer"/><address class="footer"><small>
78+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
79+
<img class="footer" src="doxygen.png" alt="doxygen"/>
80+
</a> 1.8.13
81+
</small></address>
82+
</body>
83+
</html>

‎doc/html/atmega_8hpp.html‎

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.13"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>Mako: src/sub_control/include/control/atmega.hpp File Reference</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr style="height: 56px;">
23+
<td id="projectalign" style="padding-left: 0.5em;">
24+
<div id="projectname">Mako
25+
</div>
26+
</td>
27+
</tr>
28+
</tbody>
29+
</table>
30+
</div>
31+
<!-- end header part -->
32+
<!-- Generated by Doxygen 1.8.13 -->
33+
<script type="text/javascript">
34+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
35+
</script>
36+
<script type="text/javascript" src="menudata.js"></script>
37+
<script type="text/javascript" src="menu.js"></script>
38+
<script type="text/javascript">
39+
$(function() {
40+
initMenu('',true,false,'search.php','Search');
41+
$(document).ready(function() { init_search(); });
42+
});
43+
</script>
44+
<div id="main-nav"></div>
45+
<!-- window showing the filter options -->
46+
<div id="MSearchSelectWindow"
47+
onmouseover="return searchBox.OnSearchSelectShow()"
48+
onmouseout="return searchBox.OnSearchSelectHide()"
49+
onkeydown="return searchBox.OnSearchSelectKey(event)">
50+
</div>
51+
52+
<!-- iframe showing the search results (closed by default) -->
53+
<div id="MSearchResultsWindow">
54+
<iframe src="javascript:void(0)" frameborder="0"
55+
name="MSearchResults" id="MSearchResults">
56+
</iframe>
57+
</div>
58+
59+
<div id="nav-path" class="navpath">
60+
<ul>
61+
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_2a69d65e88f1b99dc5b1053747bce5af.html">sub_control</a></li><li class="navelem"><a class="el" href="dir_3dad69e7ad7d7f4b72bfc771e75c6827.html">include</a></li><li class="navelem"><a class="el" href="dir_5389f37eee4bc08cf3a07638257f392d.html">control</a></li> </ul>
62+
</div>
63+
</div><!-- top -->
64+
<div class="header">
65+
<div class="summary">
66+
<a href="#define-members">Macros</a> &#124;
67+
<a href="#func-members">Functions</a> &#124;
68+
<a href="#var-members">Variables</a> </div>
69+
<div class="headertitle">
70+
<div class="title">atmega.hpp File Reference</div> </div>
71+
</div><!--header-->
72+
<div class="contents">
73+
74+
<p>Function definitions for interfacing with the code on the atmega.
75+
<a href="#details">More...</a></p>
76+
<div class="textblock"><code>#include &lt;string&gt;</code><br />
77+
<code>#include &quot;<a class="el" href="state_8hpp_source.html">control/state.hpp</a>&quot;</code><br />
78+
</div><div class="textblock"><div class="dynheader">
79+
Include dependency graph for atmega.hpp:</div>
80+
<div class="dyncontent">
81+
<div class="center"><img src="atmega_8hpp__incl.png" border="0" usemap="#src_2sub__control_2include_2control_2atmega_8hpp" alt=""/></div>
82+
<map name="src_2sub__control_2include_2control_2atmega_8hpp" id="src_2sub__control_2include_2control_2atmega_8hpp">
83+
<area shape="rect" id="node3" href="state_8hpp.html" title="State struct and constant definitions. " alt="" coords="73,95,192,121"/>
84+
</map>
85+
</div>
86+
</div>
87+
<p><a href="atmega_8hpp_source.html">Go to the source code of this file.</a></p>
88+
<table class="memberdecls">
89+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
90+
Macros</h2></td></tr>
91+
<tr class="memitem:a614217d263be1fb1a5f76e2ff7be19a2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="atmega_8hpp.html#a614217d263be1fb1a5f76e2ff7be19a2">PORT</a>&#160;&#160;&#160;&quot;/dev/ttyACM0&quot;</td></tr>
92+
<tr class="separator:a614217d263be1fb1a5f76e2ff7be19a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
93+
</table><table class="memberdecls">
94+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
95+
Functions</h2></td></tr>
96+
<tr class="memitem:a8f6680c5d33d6233c25529ff98406679"><td class="memItemLeft" align="right" valign="top"><a id="a8f6680c5d33d6233c25529ff98406679"></a>
97+
void&#160;</td><td class="memItemRight" valign="bottom"><b>atmega::write</b> (std::string)</td></tr>
98+
<tr class="separator:a8f6680c5d33d6233c25529ff98406679"><td class="memSeparator" colspan="2">&#160;</td></tr>
99+
<tr class="memitem:a6306408ade4f56d184a373eba5b51922"><td class="memItemLeft" align="right" valign="top"><a id="a6306408ade4f56d184a373eba5b51922"></a>
100+
void&#160;</td><td class="memItemRight" valign="bottom"><b>atmega::write</b> (const <a class="el" href="structState.html">State</a> &amp;)</td></tr>
101+
<tr class="separator:a6306408ade4f56d184a373eba5b51922"><td class="memSeparator" colspan="2">&#160;</td></tr>
102+
<tr class="memitem:aeba9f31fdbd75c7d289c05ff6ee286c9"><td class="memItemLeft" align="right" valign="top"><a id="aeba9f31fdbd75c7d289c05ff6ee286c9"></a>
103+
void&#160;</td><td class="memItemRight" valign="bottom"><b>atmega::relative</b> (const <a class="el" href="structState.html">State</a> &amp;)</td></tr>
104+
<tr class="separator:aeba9f31fdbd75c7d289c05ff6ee286c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
105+
<tr class="memitem:a22abb5bf33a5d76d0c31d30185c023bd"><td class="memItemLeft" align="right" valign="top"><a id="a22abb5bf33a5d76d0c31d30185c023bd"></a>
106+
bool&#160;</td><td class="memItemRight" valign="bottom"><b>atmega::alive</b> ()</td></tr>
107+
<tr class="separator:a22abb5bf33a5d76d0c31d30185c023bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
108+
<tr class="memitem:a0cb20880482ecd989647672f6ca2a830"><td class="memItemLeft" align="right" valign="top"><a id="a0cb20880482ecd989647672f6ca2a830"></a>
109+
<a class="el" href="structState.html">State</a>&#160;</td><td class="memItemRight" valign="bottom"><b>atmega::state</b> ()</td></tr>
110+
<tr class="separator:a0cb20880482ecd989647672f6ca2a830"><td class="memSeparator" colspan="2">&#160;</td></tr>
111+
</table><table class="memberdecls">
112+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
113+
Variables</h2></td></tr>
114+
<tr class="memitem:a5e34b501678d80ab91465e65389c9749"><td class="memItemLeft" align="right" valign="top"><a id="a5e34b501678d80ab91465e65389c9749"></a>
115+
FILE *&#160;</td><td class="memItemRight" valign="bottom"><b>atmega::in</b> = fopen(<a class="el" href="atmega_8hpp.html#a614217d263be1fb1a5f76e2ff7be19a2">PORT</a>, &quot;r+&quot;)</td></tr>
116+
<tr class="separator:a5e34b501678d80ab91465e65389c9749"><td class="memSeparator" colspan="2">&#160;</td></tr>
117+
<tr class="memitem:ae69d979ccfad9a05f9ae8e6c1370585e"><td class="memItemLeft" align="right" valign="top"><a id="ae69d979ccfad9a05f9ae8e6c1370585e"></a>
118+
FILE *&#160;</td><td class="memItemRight" valign="bottom"><b>atmega::out</b> = fopen(<a class="el" href="atmega_8hpp.html#a614217d263be1fb1a5f76e2ff7be19a2">PORT</a>, &quot;w+&quot;)</td></tr>
119+
<tr class="separator:ae69d979ccfad9a05f9ae8e6c1370585e"><td class="memSeparator" colspan="2">&#160;</td></tr>
120+
<tr class="memitem:afa2561d0008822ad2f9a906ab9c7e445"><td class="memItemLeft" align="right" valign="top"><a id="afa2561d0008822ad2f9a906ab9c7e445"></a>
121+
<a class="el" href="structState.html">State</a>&#160;</td><td class="memItemRight" valign="bottom"><b>atmega::sim_state</b></td></tr>
122+
<tr class="separator:afa2561d0008822ad2f9a906ab9c7e445"><td class="memSeparator" colspan="2">&#160;</td></tr>
123+
</table>
124+
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
125+
<div class="textblock"><p>Function definitions for interfacing with the code on the atmega. </p>
126+
<dl class="section author"><dt>Author</dt><dd>David Zhang </dd></dl>
127+
</div><h2 class="groupheader">Macro Definition Documentation</h2>
128+
<a id="a614217d263be1fb1a5f76e2ff7be19a2"></a>
129+
<h2 class="memtitle"><span class="permalink"><a href="#a614217d263be1fb1a5f76e2ff7be19a2">&#9670;&nbsp;</a></span>PORT</h2>
130+
131+
<div class="memitem">
132+
<div class="memproto">
133+
<table class="memname">
134+
<tr>
135+
<td class="memname">#define PORT&#160;&#160;&#160;&quot;/dev/ttyACM0&quot;</td>
136+
</tr>
137+
</table>
138+
</div><div class="memdoc">
139+
<p>Port where atmega is connected. </p>
140+
141+
</div>
142+
</div>
143+
</div><!-- contents -->
144+
<!-- start footer part -->
145+
<hr class="footer"/><address class="footer"><small>
146+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
147+
<img class="footer" src="doxygen.png" alt="doxygen"/>
148+
</a> 1.8.13
149+
</small></address>
150+
</body>
151+
</html>

‎doc/html/atmega_8hpp__incl.map‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<map id="src/sub_control/include/control/atmega.hpp" name="src/sub_control/include/control/atmega.hpp">
2+
<area shape="rect" id="node3" href="$state_8hpp.html" title="State struct and constant definitions. " alt="" coords="73,95,192,121"/>
3+
</map>

‎doc/html/atmega_8hpp__incl.md5‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
4eb5d54b3c13ce875eb105b587f4a5c1

‎doc/html/atmega_8hpp__incl.png‎

8.97 KB
Loading

0 commit comments

Comments
 (0)