William/Senior-Design-Project_WMU-Sunseeker_Altium-Designer
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fixed navigation for documentation HTML pages

Browse Source
This commit is contained in:
William Miceli
2021-02-03 17:05:10 -05:00
parent 47d317cac7
commit b723b3f7e1
63 changed files with 397 additions and 239 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
Documentation/html/_9_hardware_8markdown.html
View File

@@ -16,6 +16,13 @@
<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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
@@ -91,7 +98,7 @@ $(document).ready(function(){initNavTree('_9_hardware_8markdown.html',''); initR
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="_9_hardware_8markdown.html">!Hardware.markdown</a></li>
<li class="footer">Generated on Tue Feb 2 2021 00:44:35 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>

9
Documentation/html/_9_software_8markdown.html
View File

@@ -16,6 +16,13 @@
<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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
@@ -91,7 +98,7 @@ $(document).ready(function(){initNavTree('_9_software_8markdown.html',''); initR
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="_9_software_8markdown.html">!Software.markdown</a></li>
<li class="footer">Generated on Tue Feb 2 2021 00:44:35 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>

9
Documentation/html/_design_01_choices_8markdown.html
View File

@@ -16,6 +16,13 @@
<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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
@@ -91,7 +98,7 @@ $(document).ready(function(){initNavTree('_design_01_choices_8markdown.html','')
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="_design_01_choices_8markdown.html">Design Choices.markdown</a></li>
<li class="footer">Generated on Tue Feb 2 2021 00:44:35 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>

9
Documentation/html/_device_01_specifications_8markdown.html
View File

@@ -16,6 +16,13 @@
<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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
@@ -91,7 +98,7 @@ $(document).ready(function(){initNavTree('_device_01_specifications_8markdown.ht
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="_device_01_specifications_8markdown.html">Device Specifications.markdown</a></li>
<li class="footer">Generated on Tue Feb 2 2021 00:44:35 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>

9
Documentation/html/_documentation_01_guide_8markdown.html
View File

@@ -16,6 +16,13 @@
<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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
@@ -91,7 +98,7 @@ $(document).ready(function(){initNavTree('_documentation_01_guide_8markdown.html
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="_documentation_01_guide_8markdown.html">Documentation Guide.markdown</a></li>
<li class="footer">Generated on Tue Feb 2 2021 00:44:35 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>

9
Documentation/html/_r_e_a_d_m_e_8markdown.html
View File

@@ -16,6 +16,13 @@
<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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
@@ -91,7 +98,7 @@ $(document).ready(function(){initNavTree('_r_e_a_d_m_e_8markdown.html',''); init
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="_r_e_a_d_m_e_8markdown.html">README.markdown</a></li>
<li class="footer">Generated on Tue Feb 2 2021 00:44:35 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>

BIN
Documentation/html/bc_s.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 666 B

After

Width:  |  Height:  |  Size: 670 B

BIN
Documentation/html/bdwn.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 148 B

After

Width:  |  Height:  |  Size: 147 B

BIN
Documentation/html/closed.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 132 B

After

Width:  |  Height:  |  Size: 131 B

11
Documentation/html/design_choices.html
View File

@@ -16,6 +16,13 @@
<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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
@@ -134,8 +141,8 @@ Microcontroller Peripheral Connections</h1>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="index.html">index</a></li><li class="navelem"><a class="el" href="hardware.html">Hardware</a></li>
<li class="footer">Generated on Tue Feb 2 2021 00:44:35 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
<li class="navelem"><a class="el" href="hardware.html">Hardware</a></li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>

11
Documentation/html/device_specifications.html
View File

@@ -16,6 +16,13 @@
<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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
@@ -229,8 +236,8 @@ Inertial Measurement Unit: TDK InvenSense ICM-20600</h2>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="index.html">index</a></li><li class="navelem"><a class="el" href="hardware.html">Hardware</a></li>
<li class="footer">Generated on Tue Feb 2 2021 00:44:35 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
<li class="navelem"><a class="el" href="hardware.html">Hardware</a></li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>

9
Documentation/html/dir_4e9c05acfa2c3671b8618fcb95d57d96.html
View File

@@ -16,6 +16,13 @@
<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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
@@ -97,7 +104,7 @@ Directories</h2></td></tr>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_4e9c05acfa2c3671b8618fcb95d57d96.html">Software</a></li>
<li class="footer">Generated on Tue Feb 2 2021 00:44:35 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>

9
Documentation/html/dir_6cc751a9e685a986d41d35de353de328.html
View File

@@ -16,6 +16,13 @@
<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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
@@ -91,7 +98,7 @@ $(document).ready(function(){initNavTree('dir_6cc751a9e685a986d41d35de353de328.h
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_6cc751a9e685a986d41d35de353de328.html">Hardware</a></li>
<li class="footer">Generated on Tue Feb 2 2021 00:44:35 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>

9
Documentation/html/dir_70428d3c5958c16802133545478a5cfb.html
View File

@@ -16,6 +16,13 @@
<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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
@@ -97,7 +104,7 @@ Directories</h2></td></tr>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_4e9c05acfa2c3671b8618fcb95d57d96.html">Software</a></li><li class="navelem"><a class="el" href="dir_70428d3c5958c16802133545478a5cfb.html">Code Composer Studio Workspace</a></li>
<li class="footer">Generated on Tue Feb 2 2021 00:44:35 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>

9
Documentation/html/dir_7795a02a4813dcd036f04e5f7854f185.html
View File

@@ -16,6 +16,13 @@
<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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
@@ -91,7 +98,7 @@ $(document).ready(function(){initNavTree('dir_7795a02a4813dcd036f04e5f7854f185.h
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_7795a02a4813dcd036f04e5f7854f185.html">Meta</a></li>
<li class="footer">Generated on Tue Feb 2 2021 00:44:35 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>

9
Documentation/html/dir_ef94255a62432ae865475b379d8bd501.html
View File

@@ -16,6 +16,13 @@
<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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
@@ -97,7 +104,7 @@ Files</h2></td></tr>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_4e9c05acfa2c3671b8618fcb95d57d96.html">Software</a></li><li class="navelem"><a class="el" href="dir_70428d3c5958c16802133545478a5cfb.html">Code Composer Studio Workspace</a></li><li class="navelem"><a class="el" href="dir_ef94255a62432ae865475b379d8bd501.html">SunseekerTelemetryAndLightingSystem</a></li>
<li class="footer">Generated on Tue Feb 2 2021 00:44:35 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>

BIN
Documentation/html/doc.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 736 B

After

Width:  |  Height:  |  Size: 771 B

17
Documentation/html/documentation_guide.html
View File

@@ -16,6 +16,13 @@
<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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
@@ -85,22 +92,22 @@ $(document).ready(function(){initNavTree('documentation_guide.html',''); initRes
<div class="title">Documentation Guide </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><h1><a class="anchor" id="autotoc_md20"></a>
<div class="textblock"><h1><a class="anchor" id="autotoc_md19"></a>
Doxygen</h1>
<p>The program called "doxygen" (<a href="https://github.com/doxygen/doxygen">GitHub Page</a> and <a href="https://www.doxygen.nl/">Website</a>) is what we're using to document our project and try to make things a bit simpler/easier not only for us, but also future projects or people looking at what we've done.</p>
<p>It simply uses a small configuration file at the root of the project <code>/Doxyfile</code> to store some settings, and the rest is through mainly Markdown files (<code>.md</code> or <code>.markdown</code>) and source code files.</p>
<p>It is setup (as of writing this) that someone can simply open the <code>/Doxyfile</code> in the GUI Wizard, click on the "Run" tab, then "Run doxygen", and everything will be updated... that's it.</p>
<h1><a class="anchor" id="autotoc_md21"></a>
<h1><a class="anchor" id="autotoc_md20"></a>
Updating Documentation</h1>
<p>You need to have installed the program from either the GitHub page or website, then simply open the <code>/Doxyfile</code> within the GUI frontend or "Wizard".</p>
<h1><a class="anchor" id="autotoc_md22"></a>
<h1><a class="anchor" id="autotoc_md21"></a>
Important Notes</h1>
<ul>
<li>Make sure that the <code>/Doxyfile</code> stays where it's at! It should be kept at the root directory (just to keep things simple)</li>
<li>Make sure you use RELATIVE paths when changing configurations, or else when someone else tries running the <code>/Doxyfile</code>, they'll have to re-do all of them in order for it to start functioning again.</li>
<li><b>DO NOT</b> put any files into the <code>/Documentation</code> folder manually, as they <b>WILL BE DELETED</b> when doxygen is run.</li>
</ul>
<h2><a class="anchor" id="autotoc_md23"></a>
<h2><a class="anchor" id="autotoc_md22"></a>
For Consistency</h2>
<ul>
<li>Please make sure the internal names ("tags") of files are using "camelCase"<ul>
@@ -114,7 +121,7 @@ For Consistency</h2>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Tue Feb 2 2021 00:44:35 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>

176
Documentation/html/doxygen.css
View File

@@ -22,8 +22,8 @@ h1.groupheader {
}
h2.groupheader {
border-bottom: 1px solid #7FAAE0;
color: #255B9C;
border-bottom: 1px solid #799ED5;
color: #284D83;
font-size: 150%;
font-weight: normal;
margin-top: 1.75em;
@@ -113,7 +113,7 @@ h3.version {
}
div.navtab {
border-right: 1px solid #9DBEE7;
border-right: 1px solid #98B5DF;
padding-right: 15px;
text-align: right;
line-height: 110%;
@@ -177,7 +177,7 @@ dt.alphachar{
}
.classindex dl.odd {
background-color: #F7FAFD;
background-color: #F7F9FC;
}
@media(min-width: 1120px) {
@@ -196,13 +196,13 @@ dt.alphachar{
/* @group Link Styling */
a {
color: #2A66B0;
color: #2E5896;
font-weight: normal;
text-decoration: none;
}
.contents a:visited {
color: #3075C9;
color: #3566AF;
}
a:hover {
@@ -210,7 +210,7 @@ a:hover {
}
.contents a.qindexHL:visited {
color: #FFFFFF;
color: #FFFFFE;
}
a.el {
@@ -221,11 +221,11 @@ a.elRef {
}
a.code, a.code:visited, a.line, a.line:visited {
color: #3075C9;
color: #3566AF;
}
a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited {
color: #3075C9;
color: #3566AF;
}
/* @end */
@@ -254,8 +254,8 @@ ul {
}
pre.fragment {
border: 1px solid #C1D6F0;
background-color: #FBFCFE;
border: 1px solid #BDCFEA;
background-color: #FBFCFD;
padding: 4px 6px;
margin: 4px 8px 4px 2px;
overflow: auto;
@@ -269,8 +269,8 @@ pre.fragment {
div.fragment {
padding: 0 0 1px 0; /*Fixed: last line underline overlap border*/
margin: 4px 8px 4px 2px;
background-color: #FBFCFE;
border: 1px solid #C1D6F0;
background-color: #FBFCFD;
border: 1px solid #BDCFEA;
}
div.line {
@@ -338,7 +338,7 @@ span.lineno a:hover {
div.ah, span.ah {
background-color: black;
font-weight: bold;
color: #FFFFFF;
color: #FFFFFE;
margin-bottom: 3px;
margin-top: 3px;
padding: 0.2em;
@@ -386,9 +386,9 @@ div.contents {
}
td.indexkey {
background-color: #EAF1FA;
background-color: #E9EFF8;
font-weight: bold;
border: 1px solid #C1D6F0;
border: 1px solid #BDCFEA;
margin: 2px 0px 2px 0;
padding: 2px 10px;
white-space: nowrap;
@@ -396,14 +396,14 @@ td.indexkey {
}
td.indexvalue {
background-color: #EAF1FA;
border: 1px solid #C1D6F0;
background-color: #E9EFF8;
border: 1px solid #BDCFEA;
padding: 2px 10px;
margin: 2px 0px;
}
tr.memlist {
background-color: #EDF3FA;
background-color: #ECF1F9;
}
p.formulaDsp {
@@ -486,15 +486,15 @@ span.vhdllogic {
}
blockquote {
background-color: #F6F9FD;
border-left: 2px solid #95B9E5;
background-color: #F6F8FC;
border-left: 2px solid #90AFDD;
margin: 0 24px 0 4px;
padding: 0 12px 0 16px;
}
blockquote.DocNodeRTL {
border-left: 0;
border-right: 2px solid #95B9E5;
border-right: 2px solid #90AFDD;
margin: 0 4px 0 24px;
padding: 0 16px 0 12px;
}
@@ -527,18 +527,18 @@ td.tiny {
.dirtab {
padding: 4px;
border-collapse: collapse;
border: 1px solid #9DBEE7;
border: 1px solid #98B5DF;
}
th.dirtab {
background: #EAF1FA;
background: #E9EFF8;
font-weight: bold;
}
hr {
height: 0px;
border: none;
border-top: 1px solid #367BCE;
border-top: 1px solid #386BB7;
}
hr.footer {
@@ -573,7 +573,7 @@ table.memberdecls {
.mdescLeft, .mdescRight,
.memItemLeft, .memItemRight,
.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
background-color: #F9FBFD;
background-color: #F8FAFD;
border: none;
margin: 4px;
padding: 1px 0 0 8px;
@@ -585,7 +585,7 @@ table.memberdecls {
}
.memSeparator {
border-bottom: 1px solid #DCE8F6;
border-bottom: 1px solid #DAE4F3;
line-height: 1px;
margin: 0px;
padding: 0px;
@@ -600,7 +600,7 @@ table.memberdecls {
}
.memTemplParams {
color: #3075C9;
color: #3566AF;
white-space: nowrap;
font-size: 80%;
}
@@ -613,15 +613,15 @@ table.memberdecls {
.memtitle {
padding: 8px;
border-top: 1px solid #A2C2E8;
border-left: 1px solid #A2C2E8;
border-right: 1px solid #A2C2E8;
border-top: 1px solid #9EB8E1;
border-left: 1px solid #9EB8E1;
border-right: 1px solid #9EB8E1;
border-top-right-radius: 4px;
border-top-left-radius: 4px;
margin-bottom: -1px;
background-image: url('nav_f.png');
background-repeat: repeat-x;
background-color: #E1EBF7;
background-color: #DFE8F5;
line-height: 1.25;
font-weight: 300;
float:left;
@@ -636,14 +636,14 @@ table.memberdecls {
.memtemplate {
font-size: 80%;
color: #3075C9;
color: #3566AF;
font-weight: normal;
margin-left: 9px;
}
.memnav {
background-color: #EAF1FA;
border: 1px solid #9DBEE7;
background-color: #E9EFF8;
border: 1px solid #98B5DF;
text-align: center;
margin: 2px;
margin-right: 15px;
@@ -681,14 +681,14 @@ table.memberdecls {
}
.memproto, dl.reflist dt {
border-top: 1px solid #A2C2E8;
border-left: 1px solid #A2C2E8;
border-right: 1px solid #A2C2E8;
border-top: 1px solid #9EB8E1;
border-left: 1px solid #9EB8E1;
border-right: 1px solid #9EB8E1;
padding: 6px 0px 6px 0px;
color: #1A4170;
color: #1B345A;
font-weight: bold;
text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
background-color: #DDE8F6;
background-color: #DBE5F4;
/* opera specific markup */
box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
border-top-right-radius: 4px;
@@ -707,15 +707,15 @@ table.memberdecls {
}
.memdoc, dl.reflist dd {
border-bottom: 1px solid #A2C2E8;
border-left: 1px solid #A2C2E8;
border-right: 1px solid #A2C2E8;
border-bottom: 1px solid #9EB8E1;
border-left: 1px solid #9EB8E1;
border-right: 1px solid #9EB8E1;
padding: 6px 10px 2px 10px;
background-color: #FBFCFE;
background-color: #FBFCFD;
border-top-width: 0;
background-image:url('nav_g.png');
background-repeat:repeat-x;
background-color: #FFFFFF;
background-color: #FFFFFE;
/* opera specific markup */
border-bottom-left-radius: 4px;
border-bottom-right-radius: 4px;
@@ -798,11 +798,11 @@ span.mlabels {
}
span.mlabel {
background-color: #679BDA;
border-top:1px solid #4584D2;
border-left:1px solid #4584D2;
border-right:1px solid #C1D6F0;
border-bottom:1px solid #C1D6F0;
background-color: #618DCE;
border-top:1px solid #3F74C4;
border-left:1px solid #3F74C4;
border-right:1px solid #BDCFEA;
border-bottom:1px solid #BDCFEA;
text-shadow: none;
color: white;
margin-right: 4px;
@@ -821,8 +821,8 @@ span.mlabel {
div.directory {
margin: 10px 0px;
border-top: 1px solid #95B9E5;
border-bottom: 1px solid #95B9E5;
border-top: 1px solid #90AFDD;
border-bottom: 1px solid #90AFDD;
width: 100%;
}
@@ -860,7 +860,7 @@ div.directory {
.directory tr.even {
padding-left: 6px;
background-color: #F6F9FD;
background-color: #F6F8FC;
}
.directory img {
@@ -878,11 +878,11 @@ div.directory {
cursor: pointer;
padding-left: 2px;
padding-right: 2px;
color: #2A66B0;
color: #2E5896;
}
.arrow {
color: #95B9E5;
color: #90AFDD;
-webkit-user-select: none;
-khtml-user-select: none;
-moz-user-select: none;
@@ -902,7 +902,7 @@ div.directory {
height: 14px;
width: 16px;
display: inline-block;
background-color: #679BDA;
background-color: #618DCE;
color: white;
text-align: center;
border-radius: 4px;
@@ -967,7 +967,7 @@ div.dynheader {
address {
font-style: normal;
color: #1E497E;
color: #203C68;
}
table.doxtable caption {
@@ -981,13 +981,13 @@ table.doxtable {
}
table.doxtable td, table.doxtable th {
border: 1px solid #204E86;
border: 1px solid #22406E;
padding: 3px 7px 2px;
}
table.doxtable th {
background-color: #265EA1;
color: #FFFFFF;
background-color: #2A4F88;
color: #FFFFFE;
font-size: 110%;
padding-bottom: 4px;
padding-top: 5px;
@@ -996,7 +996,7 @@ table.doxtable th {
table.fieldtable {
/*width: 100%;*/
margin-bottom: 10px;
border: 1px solid #A2C2E8;
border: 1px solid #9EB8E1;
border-spacing: 0px;
-moz-border-radius: 4px;
-webkit-border-radius: 4px;
@@ -1012,8 +1012,8 @@ table.fieldtable {
.fieldtable td.fieldtype, .fieldtable td.fieldname {
white-space: nowrap;
border-right: 1px solid #A2C2E8;
border-bottom: 1px solid #A2C2E8;
border-right: 1px solid #9EB8E1;
border-bottom: 1px solid #9EB8E1;
vertical-align: top;
}
@@ -1022,7 +1022,7 @@ table.fieldtable {
}
.fieldtable td.fielddoc {
border-bottom: 1px solid #A2C2E8;
border-bottom: 1px solid #9EB8E1;
/*width: 100%;*/
}
@@ -1041,9 +1041,9 @@ table.fieldtable {
.fieldtable th {
background-image:url('nav_f.png');
background-repeat:repeat-x;
background-color: #E1EBF7;
background-color: #DFE8F5;
font-size: 90%;
color: #1A4170;
color: #1B345A;
padding-bottom: 4px;
padding-top: 5px;
text-align:left;
@@ -1054,7 +1054,7 @@ table.fieldtable {
-webkit-border-top-right-radius: 4px;
border-top-left-radius: 4px;
border-top-right-radius: 4px;
border-bottom: 1px solid #A2C2E8;
border-bottom: 1px solid #9EB8E1;
}
@@ -1076,8 +1076,8 @@ table.fieldtable {
background-position: 0 -5px;
height:30px;
line-height:30px;
color:#81ACE0;
border:solid 1px #BED4EF;
color:#7CA0D6;
border:solid 1px #BBCDEA;
overflow:hidden;
margin:0px;
padding:0px;
@@ -1092,7 +1092,7 @@ table.fieldtable {
background-image:url('bc_s.png');
background-repeat:no-repeat;
background-position:right;
color:#265C9E;
color:#294E85;
}
.navpath li.navelem a
@@ -1101,7 +1101,7 @@ table.fieldtable {
display:block;
text-decoration: none;
outline: none;
color: #1D4679;
color: #1E3963;
font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif;
text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
text-decoration: none;
@@ -1109,7 +1109,7 @@ table.fieldtable {
.navpath li.navelem a:hover
{
color:#5C94D7;
color:#5685CB;
}
.navpath li.footer
@@ -1121,7 +1121,7 @@ table.fieldtable {
background-image:none;
background-repeat:no-repeat;
background-position:right;
color:#265C9E;
color:#294E85;
font-size: 8pt;
}
@@ -1168,9 +1168,9 @@ div.header
{
background-image:url('nav_h.png');
background-repeat:repeat-x;
background-color: #F9FBFD;
background-color: #F8FAFD;
margin: 0px;
border-bottom: 1px solid #C1D6F0;
border-bottom: 1px solid #BDCFEA;
}
div.headertitle
@@ -1365,7 +1365,7 @@ dl.section dd {
padding: 0px;
margin: 0px;
width: 100%;
border-bottom: 1px solid #4584D2;
border-bottom: 1px solid #3F74C4;
}
.image
@@ -1400,7 +1400,7 @@ dl.section dd {
div.zoom
{
border: 1px solid #88B0E2;
border: 1px solid #83A5D8;
}
dl.citelist {
@@ -1408,7 +1408,7 @@ dl.citelist {
}
dl.citelist dt {
color:#245795;
color:#26497D;
float:left;
font-weight:bold;
margin-right:10px;
@@ -1424,8 +1424,8 @@ dl.citelist dd {
div.toc {
padding: 14px 25px;
background-color: #F4F7FC;
border: 1px solid #D6E4F5;
background-color: #F3F6FB;
border: 1px solid #D3DFF1;
border-radius: 7px 7px 7px 7px;
float: right;
height: auto;
@@ -1454,7 +1454,7 @@ div.toc li {
div.toc h3 {
font: bold 12px/1.2 Arial,FreeSans,sans-serif;
color: #3075C9;
color: #3566AF;
border-bottom: 0 none;
margin: 0;
}
@@ -1620,7 +1620,7 @@ tr.heading h2 {
}
#powerTip.n:after, #powerTip.ne:after, #powerTip.nw:after {
border-top-color: #FFFFFF;
border-top-color: #FFFFFE;
border-width: 10px;
margin: 0px -10px;
}
@@ -1648,7 +1648,7 @@ tr.heading h2 {
}
#powerTip.s:after, #powerTip.se:after, #powerTip.sw:after {
border-bottom-color: #FFFFFF;
border-bottom-color: #FFFFFE;
border-width: 10px;
margin: 0px -10px;
}
@@ -1675,7 +1675,7 @@ tr.heading h2 {
left: 100%;
}
#powerTip.e:after {
border-left-color: #FFFFFF;
border-left-color: #FFFFFE;
border-width: 10px;
top: 50%;
margin-top: -10px;
@@ -1691,7 +1691,7 @@ tr.heading h2 {
right: 100%;
}
#powerTip.w:after {
border-right-color: #FFFFFF;
border-right-color: #FFFFFE;
border-width: 10px;
top: 50%;
margin-top: -10px;
@@ -1731,7 +1731,7 @@ table.markdownTable {
}
table.markdownTable td, table.markdownTable th {
border: 1px solid #204E86;
border: 1px solid #22406E;
padding: 3px 7px 2px;
}
@@ -1739,8 +1739,8 @@ table.markdownTable tr {
}
th.markdownTableHeadLeft, th.markdownTableHeadRight, th.markdownTableHeadCenter, th.markdownTableHeadNone {
background-color: #265EA1;
color: #FFFFFF;
background-color: #2A4F88;
color: #FFFFFE;
font-size: 110%;
padding-bottom: 4px;
padding-top: 5px;

10
Documentation/html/doxygen.svg
View File

File diff suppressed because one or more lines are too long
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 15 KiB

9
Documentation/html/files.html
View File

@@ -16,6 +16,13 @@
<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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
@@ -100,7 +107,7 @@ $(document).ready(function(){initNavTree('files.html',''); initResizable(); });
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Tue Feb 2 2021 00:44:35 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>

BIN
Documentation/html/folderclosed.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 574 B

After

Width:  |  Height:  |  Size: 592 B

BIN
Documentation/html/folderopen.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 609 B

After

Width:  |  Height:  |  Size: 604 B

9
Documentation/html/globals.html
View File

@@ -16,6 +16,13 @@
<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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
@@ -91,7 +98,7 @@ $(document).ready(function(){initNavTree('globals.html',''); initResizable(); })
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Tue Feb 2 2021 00:44:35 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>

9
Documentation/html/globals_func.html
View File

@@ -16,6 +16,13 @@
<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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
@@ -91,7 +98,7 @@ $(document).ready(function(){initNavTree('globals_func.html',''); initResizable(
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Tue Feb 2 2021 00:44:35 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>

10
Documentation/html/hardware.html
View File

@@ -16,6 +16,13 @@
<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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
@@ -111,8 +118,7 @@ Design Reminders</h1>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="index.html">index</a></li>
<li class="footer">Generated on Tue Feb 2 2021 00:44:35 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>

31
Documentation/html/index.html
View File

@@ -5,7 +5,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>2020-2021 Sunseeker Telemetry and Lighting System: Main Page</title>
<title>2020-2021 Sunseeker Telemetry and Lighting System: Home</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>
@@ -16,6 +16,13 @@
<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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
@@ -82,23 +89,17 @@ $(document).ready(function(){initNavTree('index.html',''); initResizable(); });
<div class="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">2020-2021 Sunseeker Telemetry and Lighting System Documentation</div> </div>
<div class="title">Home </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p><b>Subpages</b> </p>
<ul>
<li><a class="el" href="hardware.html">Hardware</a></li>
<li><a class="el" href="software.html">Software</a></li>
</ul>
<hr />
<h1><a class="anchor" id="autotoc_md15"></a>
<div class="textblock"><h1><a class="anchor" id="autotoc_md14"></a>
About</h1>
<p>What this project is about (TODO)</p>
<h1><a class="anchor" id="autotoc_md16"></a>
<h1><a class="anchor" id="autotoc_md15"></a>
Documentation</h1>
<p>For Documentation, we will use "doxygen" to easily create documentation pages for the project. This will be accessible in a variety of means, but primarily through HTML pages accessible through a browser, covering all aspects of the project.</p>
<p>More information here: <a class="el" href="documentation_guide.html">Documentation Guide</a></p>
<h2><a class="anchor" id="autotoc_md17"></a>
<h2><a class="anchor" id="autotoc_md16"></a>
Tips from Dr. Bazuin</h2>
<ul>
<li>Make sub-circuits/sub-designs for schematics to keep things organized and modular/copy-able</li>
@@ -115,15 +116,17 @@ Tips from Dr. Bazuin</h2>
<li>Document things as we go</li>
<li>Need to make sure we have a BOM</li>
<li>Free samples for parts from manufacturers</li>
<li>Make peripherals like output on one side and inputs on the other</li>
<li>Use SPI Chip Select as a separate command (Use 3-pin SPI and then just use GPIO for Chip Select)</li>
</ul>
<h2><a class="anchor" id="autotoc_md18"></a>
<h2><a class="anchor" id="autotoc_md17"></a>
Tips from Dr. Gomez</h2>
<ul>
<li>Our requirements/specifications should be made to be more measurable</li>
<li>Need to design to safety standards, which need to be researched online</li>
<li>He said that he is available himself for anything power-related to help out with if needed</li>
</ul>
<h1><a class="anchor" id="autotoc_md19"></a>
<h1><a class="anchor" id="autotoc_md18"></a>
TODO List</h1>
<ul>
<li>[ ] Make battery circuitry for Real-Time Clock/Calendar for when the vehicle is off.</li>
@@ -137,7 +140,7 @@ TODO List</h1>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Tue Feb 2 2021 00:44:35 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>

11
Documentation/html/index.js Normal file
View File

@@ -0,0 +1,11 @@
var index =
[
[ "About", "index.html#autotoc_md15", null ],
[ "Documentation", "index.html#autotoc_md16", [
[ "Tips from Dr. Bazuin", "index.html#autotoc_md17", null ],
[ "Tips from Dr. Gomez", "index.html#autotoc_md18", null ]
] ],
[ "TODO List", "index.html#autotoc_md19", null ],
[ "Hardware", "hardware.html", "hardware" ],
[ "Software", "software.html", null ]
];

9
Documentation/html/main_8c.html
View File

@@ -16,6 +16,13 @@
<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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
@@ -124,7 +131,7 @@ Functions</h2></td></tr>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_4e9c05acfa2c3671b8618fcb95d57d96.html">Software</a></li><li class="navelem"><a class="el" href="dir_70428d3c5958c16802133545478a5cfb.html">Code Composer Studio Workspace</a></li><li class="navelem"><a class="el" href="dir_ef94255a62432ae865475b379d8bd501.html">SunseekerTelemetryAndLightingSystem</a></li><li class="navelem"><a class="el" href="main_8c.html">main.c</a></li>
<li class="footer">Generated on Tue Feb 2 2021 00:44:35 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>

9
Documentation/html/main_8c_source.html
View File

@@ -16,6 +16,13 @@
<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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
@@ -101,7 +108,7 @@ $(document).ready(function(){initNavTree('main_8c_source.html',''); initResizabl
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_4e9c05acfa2c3671b8618fcb95d57d96.html">Software</a></li><li class="navelem"><a class="el" href="dir_70428d3c5958c16802133545478a5cfb.html">Code Composer Studio Workspace</a></li><li class="navelem"><a class="el" href="dir_ef94255a62432ae865475b379d8bd501.html">SunseekerTelemetryAndLightingSystem</a></li><li class="navelem"><a class="el" href="main_8c.html">main.c</a></li>
<li class="footer">Generated on Tue Feb 2 2021 00:44:35 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>

BIN
Documentation/html/nav_f.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 152 B

After

Width:  |  Height:  |  Size: 159 B

BIN
Documentation/html/nav_h.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 99 B

After

Width:  |  Height:  |  Size: 98 B

2
Documentation/html/navtree.css
View File

@@ -119,7 +119,7 @@
#nav-tree {
background-image:url('nav_h.png');
background-repeat:repeat-x;
background-color: #F9FBFD;
background-color: #F8FAFD;
-webkit-overflow-scrolling : touch; /* iOS 5+ */
}

20
Documentation/html/navtreedata.js
View File

@@ -25,19 +25,21 @@
var NAVTREE =
[
[ "2020-2021 Sunseeker Telemetry and Lighting System", "index.html", [
[ "About", "index.html#autotoc_md15", null ],
[ "Documentation", "index.html#autotoc_md16", [
[ "Tips from Dr. Bazuin", "index.html#autotoc_md17", null ],
[ "Tips from Dr. Gomez", "index.html#autotoc_md18", null ]
[ "Home", "index.html", [
[ "About", "index.html#autotoc_md14", null ],
[ "Documentation", "index.html#autotoc_md15", [
[ "Tips from Dr. Bazuin", "index.html#autotoc_md16", null ],
[ "Tips from Dr. Gomez", "index.html#autotoc_md17", null ]
] ],
[ "TODO List", "index.html#autotoc_md18", null ]
] ],
[ "TODO List", "index.html#autotoc_md19", null ],
[ "Hardware", "hardware.html", "hardware" ],
[ "Software", "software.html", null ],
[ "Documentation Guide", "documentation_guide.html", [
[ "Doxygen", "documentation_guide.html#autotoc_md20", null ],
[ "Updating Documentation", "documentation_guide.html#autotoc_md21", null ],
[ "Important Notes", "documentation_guide.html#autotoc_md22", [
[ "For Consistency", "documentation_guide.html#autotoc_md23", null ]
[ "Doxygen", "documentation_guide.html#autotoc_md19", null ],
[ "Updating Documentation", "documentation_guide.html#autotoc_md20", null ],
[ "Important Notes", "documentation_guide.html#autotoc_md21", [
[ "For Consistency", "documentation_guide.html#autotoc_md22", null ]
] ]
] ],
[ "Files", "files.html", [

57
Documentation/html/navtreeindex0.js
View File

@@ -1,9 +1,9 @@
var NAVTREEINDEX0 =
{
"design_choices.html":[3,1],
"design_choices.html#autotoc_md2":[3,1,0],
"design_choices.html#autotoc_md3":[3,1,1],
"device_specifications.html":[3,2],
"design_choices.html":[1,1],
"design_choices.html#autotoc_md2":[1,1,0],
"design_choices.html#autotoc_md3":[1,1,1],
"device_specifications.html":[1,2],
"device_specifications.html#autotoc_md10":[6],
"device_specifications.html#autotoc_md11":[7],
"device_specifications.html#autotoc_md12":[8],
@@ -14,30 +14,31 @@ var NAVTREEINDEX0 =
"device_specifications.html#autotoc_md7":[3],
"device_specifications.html#autotoc_md8":[4],
"device_specifications.html#autotoc_md9":[5],
"dir_4e9c05acfa2c3671b8618fcb95d57d96.html":[6,0,2],
"dir_6cc751a9e685a986d41d35de353de328.html":[6,0,0],
"dir_70428d3c5958c16802133545478a5cfb.html":[6,0,2,0],
"dir_7795a02a4813dcd036f04e5f7854f185.html":[6,0,1],
"dir_ef94255a62432ae865475b379d8bd501.html":[6,0,2,0,0],
"documentation_guide.html":[5],
"documentation_guide.html#autotoc_md20":[5,0],
"documentation_guide.html#autotoc_md21":[5,1],
"documentation_guide.html#autotoc_md22":[5,2],
"documentation_guide.html#autotoc_md23":[5,2,0],
"files.html":[6,0],
"globals.html":[6,1,0],
"globals_func.html":[6,1,1],
"hardware.html":[3],
"hardware.html#autotoc_md1":[3,0],
"dir_4e9c05acfa2c3671b8618fcb95d57d96.html":[4,0,2],
"dir_6cc751a9e685a986d41d35de353de328.html":[4,0,0],
"dir_70428d3c5958c16802133545478a5cfb.html":[4,0,2,0],
"dir_7795a02a4813dcd036f04e5f7854f185.html":[4,0,1],
"dir_ef94255a62432ae865475b379d8bd501.html":[4,0,2,0,0],
"documentation_guide.html":[3],
"documentation_guide.html#autotoc_md19":[3,0],
"documentation_guide.html#autotoc_md20":[3,1],
"documentation_guide.html#autotoc_md21":[3,2],
"documentation_guide.html#autotoc_md22":[3,2,0],
"files.html":[4,0],
"globals.html":[4,1,0],
"globals_func.html":[4,1,1],
"hardware.html":[1],
"hardware.html#autotoc_md1":[1,0],
"index.html":[],
"index.html#autotoc_md15":[0],
"index.html#autotoc_md16":[1],
"index.html#autotoc_md17":[1,0],
"index.html#autotoc_md18":[1,1],
"index.html#autotoc_md19":[2],
"main_8c.html":[6,0,2,0,0,0],
"main_8c.html#a840291bc02cba5474a4cb46a9b9566fe":[6,0,2,0,0,0,0],
"main_8c_source.html":[6,0,2,0,0,0],
"index.html":[0],
"index.html#autotoc_md14":[0,0],
"index.html#autotoc_md15":[0,1],
"index.html#autotoc_md16":[0,1,0],
"index.html#autotoc_md17":[0,1,1],
"index.html#autotoc_md18":[0,2],
"main_8c.html":[4,0,2,0,0,0],
"main_8c.html#a840291bc02cba5474a4cb46a9b9566fe":[4,0,2,0,0,0,0],
"main_8c_source.html":[4,0,2,0,0,0],
"pages.html":[],
"software.html":[4]
"software.html":[2]
};

BIN
Documentation/html/open.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 123 B

After

Width:  |  Height:  |  Size: 121 B

17
Documentation/html/pages.html
View File

@@ -16,6 +16,13 @@
<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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
@@ -86,8 +93,12 @@ $(document).ready(function(){initNavTree('pages.html',''); initResizable(); });
</div><!--header-->
<div class="contents">
<div class="textblock">Here is a list of all related documentation pages:</div><div class="directory">
<table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="documentation_guide.html" target="_self">Documentation Guide</a></td><td class="desc"></td></tr>
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span>]</div><table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><a class="el" href="hardware.html" target="_self">Hardware</a></td><td class="desc"></td></tr>
<tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="design_choices.html" target="_self">Design Choices</a></td><td class="desc"></td></tr>
<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="device_specifications.html" target="_self">Device Specifications</a></td><td class="desc"></td></tr>
<tr id="row_1_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="software.html" target="_self">Software</a></td><td class="desc"></td></tr>
<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="documentation_guide.html" target="_self">Documentation Guide</a></td><td class="desc"></td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
@@ -95,7 +106,7 @@ $(document).ready(function(){initNavTree('pages.html',''); initResizable(); });
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Tue Feb 2 2021 00:44:35 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>

3
Documentation/html/search/all_2.js
View File

@@ -1,4 +1,5 @@
var searchData=
[
['hardware_8',['Hardware',['../hardware.html',1,'index']]]
['hardware_8',['Hardware',['../hardware.html',1,'']]],
['home_9',['Home',['../index.html',1,'']]]
];

4
Documentation/html/search/all_3.js
View File

@@ -1,5 +1,5 @@
var searchData=
[
['main_9',['main',['../main_8c.html#a840291bc02cba5474a4cb46a9b9566fe',1,'main.c']]],
['main_2ec_10',['main.c',['../main_8c.html',1,'']]]
['main_10',['main',['../main_8c.html#a840291bc02cba5474a4cb46a9b9566fe',1,'main.c']]],
['main_2ec_11',['main.c',['../main_8c.html',1,'']]]
];

2
Documentation/html/search/all_4.js
View File

@@ -1,4 +1,4 @@
var searchData=
[
['readme_2emarkdown_11',['README.markdown',['../_r_e_a_d_m_e_8markdown.html',1,'']]]
['readme_2emarkdown_12',['README.markdown',['../_r_e_a_d_m_e_8markdown.html',1,'']]]
];

2
Documentation/html/search/all_5.js
View File

@@ -1,4 +1,4 @@
var searchData=
[
['software_12',['Software',['../software.html',1,'index']]]
['software_13',['Software',['../software.html',1,'']]]
];

4
Documentation/html/search/files_0.js
View File

@@ -1,5 +1,5 @@
var searchData=
[
['_21hardware_2emarkdown_13',['!Hardware.markdown',['../_9_hardware_8markdown.html',1,'']]],
['_21software_2emarkdown_14',['!Software.markdown',['../_9_software_8markdown.html',1,'']]]
['_21hardware_2emarkdown_14',['!Hardware.markdown',['../_9_hardware_8markdown.html',1,'']]],
['_21software_2emarkdown_15',['!Software.markdown',['../_9_software_8markdown.html',1,'']]]
];

6
Documentation/html/search/files_1.js
View File

@@ -1,6 +1,6 @@
var searchData=
[
['design_20choices_2emarkdown_15',['Design Choices.markdown',['../_design_01_choices_8markdown.html',1,'']]],
['device_20specifications_2emarkdown_16',['Device Specifications.markdown',['../_device_01_specifications_8markdown.html',1,'']]],
['documentation_20guide_2emarkdown_17',['Documentation Guide.markdown',['../_documentation_01_guide_8markdown.html',1,'']]]
['design_20choices_2emarkdown_16',['Design Choices.markdown',['../_design_01_choices_8markdown.html',1,'']]],
['device_20specifications_2emarkdown_17',['Device Specifications.markdown',['../_device_01_specifications_8markdown.html',1,'']]],
['documentation_20guide_2emarkdown_18',['Documentation Guide.markdown',['../_documentation_01_guide_8markdown.html',1,'']]]
];

2
Documentation/html/search/files_2.js
View File

@@ -1,4 +1,4 @@
var searchData=
[
['main_2ec_18',['main.c',['../main_8c.html',1,'']]]
['main_2ec_19',['main.c',['../main_8c.html',1,'']]]
];

2
Documentation/html/search/files_3.js
View File

@@ -1,4 +1,4 @@
var searchData=
[
['readme_2emarkdown_19',['README.markdown',['../_r_e_a_d_m_e_8markdown.html',1,'']]]
['readme_2emarkdown_20',['README.markdown',['../_r_e_a_d_m_e_8markdown.html',1,'']]]
];

2
Documentation/html/search/functions_0.js
View File

@@ -1,4 +1,4 @@
var searchData=
[
['main_20',['main',['../main_8c.html#a840291bc02cba5474a4cb46a9b9566fe',1,'main.c']]]
['main_21',['main',['../main_8c.html#a840291bc02cba5474a4cb46a9b9566fe',1,'main.c']]]
];

6
Documentation/html/search/pages_0.js
View File

@@ -1,6 +1,6 @@
var searchData=
[
['design_20choices_21',['Design Choices',['../design_choices.html',1,'hardware']]],
['device_20specifications_22',['Device Specifications',['../device_specifications.html',1,'hardware']]],
['documentation_20guide_23',['Documentation Guide',['../documentation_guide.html',1,'']]]
['design_20choices_22',['Design Choices',['../design_choices.html',1,'hardware']]],
['device_20specifications_23',['Device Specifications',['../device_specifications.html',1,'hardware']]],
['documentation_20guide_24',['Documentation Guide',['../documentation_guide.html',1,'']]]
];

3
Documentation/html/search/pages_1.js
View File

@@ -1,4 +1,5 @@
var searchData=
[
['hardware_24',['Hardware',['../hardware.html',1,'index']]]
['hardware_25',['Hardware',['../hardware.html',1,'']]],
['home_26',['Home',['../index.html',1,'']]]
];

2
Documentation/html/search/pages_2.js
View File

@@ -1,4 +1,4 @@
var searchData=
[
['software_25',['Software',['../software.html',1,'index']]]
['software_27',['Software',['../software.html',1,'']]]
];

14
Documentation/html/search/search.css
View File

@@ -83,8 +83,8 @@
display: none;
position: absolute;
left: 0; top: 0;
border: 1px solid #88B0E2;
background-color: #F9FBFD;
border: 1px solid #83A5D8;
background-color: #F8FAFD;
z-index: 10001;
padding-top: 4px;
padding-bottom: 4px;
@@ -128,7 +128,7 @@ a.SelectItem:active {
a.SelectItem:hover {
color: #FFFFFF;
background-color: #2A66B0;
background-color: #2E5896;
outline-style: none;
text-decoration: none;
cursor: pointer;
@@ -147,7 +147,7 @@ iframe#MSearchResults {
position: absolute;
left: 0; top: 0;
border: 1px solid #000;
background-color: #EDF3FA;
background-color: #ECF1F9;
z-index:10000;
}
@@ -183,7 +183,7 @@ body.SRPage {
.SRSymbol {
font-weight: bold;
color: #2D6EBD;
color: #325FA2;
font-family: Arial, Verdana, sans-serif;
text-decoration: none;
outline: none;
@@ -191,7 +191,7 @@ body.SRPage {
a.SRScope {
display: block;
color: #2D6EBD;
color: #325FA2;
font-family: Arial, Verdana, sans-serif;
text-decoration: none;
outline: none;
@@ -226,7 +226,7 @@ div.searchresults {
/*---------------- External search page results */
.searchresult {
background-color: #EFF4FB;
background-color: #EEF3F9;
}
.pages b {

10
Documentation/html/software.html
View File

@@ -16,6 +16,13 @@
<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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
@@ -91,8 +98,7 @@ $(document).ready(function(){initNavTree('software.html',''); initResizable(); }
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="index.html">index</a></li>
<li class="footer">Generated on Tue Feb 2 2021 00:44:35 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>

BIN
Documentation/html/splitbar.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 315 B

After

Width:  |  Height:  |  Size: 313 B

BIN
Documentation/html/sync_off.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 854 B

After

Width:  |  Height:  |  Size: 847 B

BIN
Documentation/html/sync_on.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 835 B

After

Width:  |  Height:  |  Size: 836 B

BIN
Documentation/html/tab_a.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 140 B

After

Width:  |  Height:  |  Size: 144 B

BIN
Documentation/html/tab_b.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 170 B

After

Width:  |  Height:  |  Size: 174 B

BIN
Documentation/html/tab_h.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 173 B

After

Width:  |  Height:  |  Size: 181 B

BIN
Documentation/html/tab_s.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 191 B

After

Width:  |  Height:  |  Size: 192 B

8
Documentation/latex/documentation_guide.tex
View File

@@ -1,16 +1,16 @@
\hypertarget{documentation_guide_autotoc_md20}{}\doxysection{Doxygen}\label{documentation_guide_autotoc_md20}
\hypertarget{documentation_guide_autotoc_md19}{}\doxysection{Doxygen}\label{documentation_guide_autotoc_md19}
The program called \char`\"{}doxygen\char`\"{} (\href{https://github.com/doxygen/doxygen}{\texttt{ Git\+Hub Page}} and \href{https://www.doxygen.nl/}{\texttt{ Website}}) is what we\textquotesingle{}re using to document our project and try to make things a bit simpler/easier not only for us, but also future projects or people looking at what we\textquotesingle{}ve done.
It simply uses a small configuration file at the root of the project {\ttfamily /\+Doxyfile} to store some settings, and the rest is through mainly Markdown files ({\ttfamily .md} or {\ttfamily .markdown}) and source code files.
It is setup (as of writing this) that someone can simply open the {\ttfamily /\+Doxyfile} in the GUI Wizard, click on the \char`\"{}\+Run\char`\"{} tab, then \char`\"{}\+Run doxygen\char`\"{}, and everything will be updated... that\textquotesingle{}s it.\hypertarget{documentation_guide_autotoc_md21}{}\doxysection{Updating Documentation}\label{documentation_guide_autotoc_md21}
You need to have installed the program from either the Git\+Hub page or website, then simply open the {\ttfamily /\+Doxyfile} within the GUI frontend or \char`\"{}\+Wizard\char`\"{}.\hypertarget{documentation_guide_autotoc_md22}{}\doxysection{Important Notes}\label{documentation_guide_autotoc_md22}
It is setup (as of writing this) that someone can simply open the {\ttfamily /\+Doxyfile} in the GUI Wizard, click on the \char`\"{}\+Run\char`\"{} tab, then \char`\"{}\+Run doxygen\char`\"{}, and everything will be updated... that\textquotesingle{}s it.\hypertarget{documentation_guide_autotoc_md20}{}\doxysection{Updating Documentation}\label{documentation_guide_autotoc_md20}
You need to have installed the program from either the Git\+Hub page or website, then simply open the {\ttfamily /\+Doxyfile} within the GUI frontend or \char`\"{}\+Wizard\char`\"{}.\hypertarget{documentation_guide_autotoc_md21}{}\doxysection{Important Notes}\label{documentation_guide_autotoc_md21}
\begin{DoxyItemize}
\item Make sure that the {\ttfamily /\+Doxyfile} stays where it\textquotesingle{}s at! It should be kept at the root directory (just to keep things simple)
\item Make sure you use RELATIVE paths when changing configurations, or else when someone else tries running the {\ttfamily /\+Doxyfile}, they\textquotesingle{}ll have to re-\/do all of them in order for it to start functioning again.
\item {\bfseries{DO NOT}} put any files into the {\ttfamily /\+Documentation} folder manually, as they {\bfseries{WILL BE DELETED}} when doxygen is run.
\end{DoxyItemize}\hypertarget{documentation_guide_autotoc_md23}{}\doxysubsection{For Consistency}\label{documentation_guide_autotoc_md23}
\end{DoxyItemize}\hypertarget{documentation_guide_autotoc_md22}{}\doxysubsection{For Consistency}\label{documentation_guide_autotoc_md22}
\begin{DoxyItemize}
\item Please make sure the internal names (\char`\"{}tags\char`\"{}) of files are using \char`\"{}camel\+Case\char`\"{}

21
Documentation/latex/index.tex
View File

@@ -1,17 +1,8 @@
{\bfseries{Subpages}}
\begin{DoxyItemize}
\item \mbox{\hyperlink{hardware}{Hardware}}
\item \mbox{\hyperlink{software}{Software}}
\end{DoxyItemize}
\DoxyHorRuler{0}
\hypertarget{index_autotoc_md15}{}\doxysection{About}\label{index_autotoc_md15}
What this project is about (TODO)\hypertarget{index_autotoc_md16}{}\doxysection{Documentation}\label{index_autotoc_md16}
\hypertarget{index_autotoc_md14}{}\doxysection{About}\label{index_autotoc_md14}
What this project is about (TODO)\hypertarget{index_autotoc_md15}{}\doxysection{Documentation}\label{index_autotoc_md15}
For Documentation, we will use \char`\"{}doxygen\char`\"{} to easily create documentation pages for the project. This will be accessible in a variety of means, but primarily through HTML pages accessible through a browser, covering all aspects of the project.
More information here\+: \mbox{\hyperlink{documentation_guide}{Documentation Guide}}\hypertarget{index_autotoc_md17}{}\doxysubsection{Tips from Dr. Bazuin}\label{index_autotoc_md17}
More information here\+: \mbox{\hyperlink{documentation_guide}{Documentation Guide}}\hypertarget{index_autotoc_md16}{}\doxysubsection{Tips from Dr. Bazuin}\label{index_autotoc_md16}
\begin{DoxyItemize}
\item Make sub-\/circuits/sub-\/designs for schematics to keep things organized and modular/copy-\/able
@@ -28,13 +19,15 @@ More information here\+: \mbox{\hyperlink{documentation_guide}{Documentation Gui
\item Document things as we go
\item Need to make sure we have a BOM
\item Free samples for parts from manufacturers
\end{DoxyItemize}\hypertarget{index_autotoc_md18}{}\doxysubsection{Tips from Dr. Gomez}\label{index_autotoc_md18}
\item Make peripherals like output on one side and inputs on the other
\item Use SPI Chip Select as a separate command (Use 3-\/pin SPI and then just use GPIO for Chip Select)
\end{DoxyItemize}\hypertarget{index_autotoc_md17}{}\doxysubsection{Tips from Dr. Gomez}\label{index_autotoc_md17}
\begin{DoxyItemize}
\item Our requirements/specifications should be made to be more measurable
\item Need to design to safety standards, which need to be researched online
\item He said that he is available himself for anything power-\/related to help out with if needed
\end{DoxyItemize}\hypertarget{index_autotoc_md19}{}\doxysection{TODO List}\label{index_autotoc_md19}
\end{DoxyItemize}\hypertarget{index_autotoc_md18}{}\doxysection{TODO List}\label{index_autotoc_md18}
\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Make battery circuitry for Real-\/\+Time Clock/\+Calendar for when the vehicle is off.

2
Documentation/latex/refman.tex
View File

@@ -171,7 +171,7 @@
\hypersetup{pageanchor=true}
%--- Begin generated contents ---
\chapter{Main Page}
\chapter{Home}
\label{index}\hypertarget{index}{}\input{index}
\chapter{Hardware}
\label{hardware}

14
Doxyfile.doxygen
View File

@@ -1097,13 +1097,13 @@ STRIP_CODE_COMMENTS = YES
# entity all documented functions referencing it will be listed.
# The default value is: NO.
REFERENCED_BY_RELATION = NO
REFERENCED_BY_RELATION = YES
# If the REFERENCES_RELATION tag is set to YES then for each documented function
# all documented entities called/used by that function will be listed.
# The default value is: NO.
REFERENCES_RELATION = NO
REFERENCES_RELATION = YES
# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
# to YES then the hyperlinks from functions in REFERENCES_RELATION and
@@ -1308,7 +1308,7 @@ HTML_EXTRA_FILES =
# Minimum value: 0, maximum value: 359, default value: 220.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_HUE = 213
HTML_COLORSTYLE_HUE = 216
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
# in the HTML output. For a value of 0 the output will use grayscales only. A
@@ -1316,7 +1316,7 @@ HTML_COLORSTYLE_HUE = 213
# Minimum value: 0, maximum value: 255, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_SAT = 156
HTML_COLORSTYLE_SAT = 135
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
# luminance component of the colors in the HTML output. Values below 100
@@ -1327,7 +1327,7 @@ HTML_COLORSTYLE_SAT = 156
# Minimum value: 40, maximum value: 240, default value: 80.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_GAMMA = 73
HTML_COLORSTYLE_GAMMA = 82
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
# page will contain the date and time when the page was generated. Setting this
@@ -1355,7 +1355,7 @@ HTML_DYNAMIC_MENUS = YES
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_DYNAMIC_SECTIONS = NO
HTML_DYNAMIC_SECTIONS = YES
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
# shown in the various tree structured indices initially; the user can expand
@@ -1658,7 +1658,7 @@ FORMULA_MACROFILE =
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
USE_MATHJAX = NO
USE_MATHJAX = YES
# When MathJax is enabled you can set the default output format to be used for
# the MathJax output. See the MathJax site (see:

12
README.markdown
View File

@@ -1,14 +1,4 @@
@mainpage
@b Subpages
- @subpage hardware
- @subpage software
---
@mainpage Home
# About