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

Doxygen Update

Browse Source
This commit is contained in:
William Miceli
2021-01-30 17:37:32 -05:00
parent bbe1a7f11a
commit a60a8a50cf
58 changed files with 558 additions and 148 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Documentation/html/_9_hardware_8markdown.html
View File

@@ -91,7 +91,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 Fri Jan 29 2021 19:12:56 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 Sat Jan 30 2021 17:37:13 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>

98
Documentation/html/_9_references_8markdown.html Normal file
View File

@@ -0,0 +1,98 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>2020-2021 Sunseeker Telemetry and Lighting System: References/!References.markdown 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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">2020-2021 Sunseeker Telemetry and Lighting System
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih: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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_9_references_8markdown.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="headertitle">
<div class="title">References/!References.markdown File Reference</div> </div>
</div><!--header-->
<div class="contents">
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="_9_references_8markdown.html">!References.markdown</a></li>
<li class="footer">Generated on Sat Jan 30 2021 17:37:13 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>
</html>

2
Documentation/html/_9_software_8markdown.html
View File

@@ -91,7 +91,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 Fri Jan 29 2021 19:12:56 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 Sat Jan 30 2021 17:37:13 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>

2
Documentation/html/_device_01_specifications_8markdown.html
View File

@@ -91,7 +91,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 Fri Jan 29 2021 19:12:56 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 Sat Jan 30 2021 17:37:13 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>

2
Documentation/html/_documentation_01_guide_8markdown.html
View File

@@ -91,7 +91,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 Fri Jan 29 2021 19:12:56 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 Sat Jan 30 2021 17:37:13 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>

2
Documentation/html/_layout_01_planning_8markdown.html
View File

@@ -91,7 +91,7 @@ $(document).ready(function(){initNavTree('_layout_01_planning_8markdown.html',''
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="_layout_01_planning_8markdown.html">Layout Planning.markdown</a></li>
<li class="footer">Generated on Fri Jan 29 2021 19:12:56 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 Sat Jan 30 2021 17:37:13 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>

2
Documentation/html/_r_e_a_d_m_e_8markdown.html
View File

@@ -91,7 +91,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 Fri Jan 29 2021 19:12:56 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 Sat Jan 30 2021 17:37:13 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>

22
Documentation/html/device_specifications.html
View File

@@ -85,7 +85,7 @@ $(document).ready(function(){initNavTree('device_specifications.html',''); initR
<div class="title">Device Specifications </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><h2><a class="anchor" id="autotoc_md1"></a>
<div class="textblock"><h2><a class="anchor" id="autotoc_md2"></a>
Microcontroller: Texas Instruments MSP430F5438AIPZR</h2>
<ul>
<li>1.8 V to 3.6 V Supply Voltage</li>
@@ -110,7 +110,7 @@ Microcontroller: Texas Instruments MSP430F5438AIPZR</h2>
</ul>
</li>
</ul>
<h2><a class="anchor" id="autotoc_md2"></a>
<h2><a class="anchor" id="autotoc_md3"></a>
Real-Time Clock/Calendar: Microchip Technology ‎MCP7940MT-I/SN</h2>
<ul>
<li>1.8 V to 5.5 V Supply Voltage</li>
@@ -122,7 +122,7 @@ Real-Time Clock/Calendar: Microchip Technology ‎MCP7940MT-I/SN</h2>
</ul>
</li>
</ul>
<h2><a class="anchor" id="autotoc_md3"></a>
<h2><a class="anchor" id="autotoc_md4"></a>
Bluetooth/Wi-Fi: Espressif Systems ESP32-WROVER-IE (8MB)</h2>
<ul>
<li>3.0 V to 3.6 V Supply Voltage</li>
@@ -133,7 +133,7 @@ Bluetooth/Wi-Fi: Espressif Systems ESP32-WROVER-IE (8MB)</h2>
</ul>
</li>
</ul>
<h2><a class="anchor" id="autotoc_md4"></a>
<h2><a class="anchor" id="autotoc_md5"></a>
GPS Receiver: Maxim Integrated ‎MAX2771ETI+T</h2>
<ul>
<li>2.7 V to 3.3 V Supply Voltage</li>
@@ -142,7 +142,7 @@ GPS Receiver: Maxim Integrated ‎MAX2771ETI+T</h2>
</ul>
</li>
</ul>
<h2><a class="anchor" id="autotoc_md5"></a>
<h2><a class="anchor" id="autotoc_md6"></a>
CANbus Controller: Microchip Technology MCP2515T-I/SO</h2>
<ul>
<li>2.7 V to 5.5 V Supply Voltage</li>
@@ -154,13 +154,13 @@ CANbus Controller: Microchip Technology MCP2515T-I/SO</h2>
</ul>
</li>
</ul>
<h2><a class="anchor" id="autotoc_md6"></a>
<h2><a class="anchor" id="autotoc_md7"></a>
CAN Bus Transceiver: ‎Microchip Technology MCP2542FD-H/SN</h2>
<ul>
<li>4.5 V to 5.5 V Supply Voltage</li>
<li>Used directly with CANbus Controller</li>
</ul>
<h2><a class="anchor" id="autotoc_md7"></a>
<h2><a class="anchor" id="autotoc_md8"></a>
SD Card (Generic)</h2>
<ul>
<li>2.7 V to 3.6 V Supply Voltage</li>
@@ -169,14 +169,14 @@ SD Card (Generic)</h2>
</ul>
</li>
</ul>
<h2><a class="anchor" id="autotoc_md8"></a>
<h2><a class="anchor" id="autotoc_md9"></a>
USB to UART Bridge: FTDI ‎‎FT260Q-T</h2>
<ul>
<li>We will use a "Bus-Powered Configuration", requiring the host device to supply power, that way we don't have to.</li>
</ul>
<h2><a class="anchor" id="autotoc_md9"></a>
RS-232 Transceiver: Texas Instruments GD75232PWR</h2>
<h2><a class="anchor" id="autotoc_md10"></a>
RS-232 Transceiver: Texas Instruments GD75232PWR</h2>
<h2><a class="anchor" id="autotoc_md11"></a>
Inertial Measurement Unit: TDK InvenSense ICM-20600</h2>
<ul>
<li>1.71 V to 3.45 V Supply Voltage</li>
@@ -199,7 +199,7 @@ Inertial Measurement Unit: TDK InvenSense ICM-20600</h2>
<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 Fri Jan 29 2021 19:12:56 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 Sat Jan 30 2021 17:37:13 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>

98
Documentation/html/dir_465c8a410b787ccece2cc89dfe6b85b1.html Normal file
View File

@@ -0,0 +1,98 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>2020-2021 Sunseeker Telemetry and Lighting System: References Directory 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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">2020-2021 Sunseeker Telemetry and Lighting System
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih: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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('dir_465c8a410b787ccece2cc89dfe6b85b1.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="headertitle">
<div class="title">References Directory Reference</div> </div>
</div><!--header-->
<div class="contents">
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_465c8a410b787ccece2cc89dfe6b85b1.html">References</a></li>
<li class="footer">Generated on Sat Jan 30 2021 17:37:13 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>
</html>

2
Documentation/html/dir_4e9c05acfa2c3671b8618fcb95d57d96.html
View File

@@ -97,7 +97,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 Fri Jan 29 2021 19:12:56 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 Sat Jan 30 2021 17:37:13 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>

2
Documentation/html/dir_6cc751a9e685a986d41d35de353de328.html
View File

@@ -91,7 +91,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 Fri Jan 29 2021 19:12:56 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 Sat Jan 30 2021 17:37:13 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>

22
Documentation/html/dir_6cc751a9e685a986d41d35de353de328.js
View File

@@ -1,14 +1,14 @@
var dir_6cc751a9e685a986d41d35de353de328 =
[
[ "Microcontroller: Texas Instruments MSP430F5438AIPZR", "device_specifications.html#autotoc_md1", null ],
[ "Real-Time Clock/Calendar: Microchip Technology ‎MCP7940MT-I/SN", "device_specifications.html#autotoc_md2", null ],
[ "Bluetooth/Wi-Fi: Espressif Systems ESP32-WROVER-IE (8MB)", "device_specifications.html#autotoc_md3", null ],
[ "GPS Receiver: Maxim Integrated ‎MAX2771ETI+T", "device_specifications.html#autotoc_md4", null ],
[ "CANbus Controller: Microchip Technology MCP2515T-I/SO", "device_specifications.html#autotoc_md5", null ],
[ "CAN Bus Transceiver: ‎Microchip Technology MCP2542FD-H/SN", "device_specifications.html#autotoc_md6", null ],
[ "SD Card (Generic)", "device_specifications.html#autotoc_md7", null ],
[ "USB to UART Bridge: FTDI ‎‎FT260Q-T", "device_specifications.html#autotoc_md8", null ],
[ "RS-232 Transceiver: Texas Instruments GD75232PWR", "device_specifications.html#autotoc_md9", null ],
[ "Inertial Measurement Unit: TDK InvenSense ICM-20600", "device_specifications.html#autotoc_md10", null ],
[ "Microcontroller", "layout_planning.html#autotoc_md11", null ]
[ "Microcontroller: Texas Instruments MSP430F5438AIPZR", "device_specifications.html#autotoc_md2", null ],
[ "Real-Time Clock/Calendar: Microchip Technology ‎MCP7940MT-I/SN", "device_specifications.html#autotoc_md3", null ],
[ "Bluetooth/Wi-Fi: Espressif Systems ESP32-WROVER-IE (8MB)", "device_specifications.html#autotoc_md4", null ],
[ "GPS Receiver: Maxim Integrated ‎MAX2771ETI+T", "device_specifications.html#autotoc_md5", null ],
[ "CANbus Controller: Microchip Technology MCP2515T-I/SO", "device_specifications.html#autotoc_md6", null ],
[ "CAN Bus Transceiver: ‎Microchip Technology MCP2542FD-H/SN", "device_specifications.html#autotoc_md7", null ],
[ "SD Card (Generic)", "device_specifications.html#autotoc_md8", null ],
[ "USB to UART Bridge: FTDI ‎‎FT260Q-T", "device_specifications.html#autotoc_md9", null ],
[ "RS-232 Transceiver: Texas Instruments GD75232PWR", "device_specifications.html#autotoc_md10", null ],
[ "Inertial Measurement Unit: TDK InvenSense ICM-20600", "device_specifications.html#autotoc_md11", null ],
[ "Microcontroller", "layout_planning.html#autotoc_md12", null ]
];

2
Documentation/html/dir_70428d3c5958c16802133545478a5cfb.html
View File

@@ -97,7 +97,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 Fri Jan 29 2021 19:12:56 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 Sat Jan 30 2021 17:37:13 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>

2
Documentation/html/dir_7795a02a4813dcd036f04e5f7854f185.html
View File

@@ -91,7 +91,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 Fri Jan 29 2021 19:12:56 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 Sat Jan 30 2021 17:37:13 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>

2
Documentation/html/dir_ef94255a62432ae865475b379d8bd501.html
View File

@@ -97,7 +97,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 Fri Jan 29 2021 19:12:56 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 Sat Jan 30 2021 17:37:13 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>

15
Documentation/html/documentation_guide.html
View File

@@ -85,25 +85,26 @@ $(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_md17"></a>
<div class="textblock"><h1><a class="anchor" id="autotoc_md18"></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_md18"></a>
<h1><a class="anchor" id="autotoc_md19"></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_md19"></a>
<h1><a class="anchor" id="autotoc_md20"></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_md20"></a>
<h2><a class="anchor" id="autotoc_md21"></a>
For Consistency</h2>
<ul>
<li>Please make sure the internal names of files are using "camelCase"<ul>
<li>Example: for "@page documentationGuide Documentation Guide" "documentationGuide" is the name used internally by doxygen. "Documentation Guide" is what shows up on the output documentation. </li>
<li>Please make sure the internal names ("tags") of files are using "camelCase"<ul>
<li>Example: for "@page documentationGuide Documentation Guide" "documentationGuide" is the name/tag used internally by doxygen. "Documentation Guide" is what shows up on the output documentation. </li>
</ul>
</li>
</ul>
@@ -113,7 +114,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 Fri Jan 29 2021 19:12:56 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 Sat Jan 30 2021 17:37:13 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/files.html
View File

@@ -89,10 +89,11 @@ $(document).ready(function(){initNavTree('files.html',''); initResizable(); });
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span><span onclick="javascript:toggleLevel(4);">4</span>]</div><table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="iconfclosed"></span><a class="el" href="dir_6cc751a9e685a986d41d35de353de328.html" target="_self">Hardware</a></td><td class="desc"></td></tr>
<tr id="row_1_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="iconfclosed"></span><a class="el" href="dir_7795a02a4813dcd036f04e5f7854f185.html" target="_self">Meta</a></td><td class="desc"></td></tr>
<tr id="row_2_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_2_" class="arrow" onclick="toggleFolder('2_')">&#9660;</span><span id="img_2_" class="iconfopen" onclick="toggleFolder('2_')">&#160;</span><a class="el" href="dir_4e9c05acfa2c3671b8618fcb95d57d96.html" target="_self">Software</a></td><td class="desc"></td></tr>
<tr id="row_2_0_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_2_0_" class="arrow" onclick="toggleFolder('2_0_')">&#9660;</span><span id="img_2_0_" class="iconfopen" onclick="toggleFolder('2_0_')">&#160;</span><a class="el" href="dir_70428d3c5958c16802133545478a5cfb.html" target="_self">Code Composer Studio Workspace</a></td><td class="desc"></td></tr>
<tr id="row_2_0_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span id="arr_2_0_0_" class="arrow" onclick="toggleFolder('2_0_0_')">&#9660;</span><span id="img_2_0_0_" class="iconfopen" onclick="toggleFolder('2_0_0_')">&#160;</span><a class="el" href="dir_ef94255a62432ae865475b379d8bd501.html" target="_self">SunseekerTelemetryAndLightingSystem</a></td><td class="desc"></td></tr>
<tr id="row_2_0_0_0_"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><a href="main_8c_source.html"><span class="icondoc"></span></a><a class="el" href="main_8c.html" target="_self">main.c</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><span class="iconfclosed"></span><a class="el" href="dir_465c8a410b787ccece2cc89dfe6b85b1.html" target="_self">References</a></td><td class="desc"></td></tr>
<tr id="row_3_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_3_" class="arrow" onclick="toggleFolder('3_')">&#9660;</span><span id="img_3_" class="iconfopen" onclick="toggleFolder('3_')">&#160;</span><a class="el" href="dir_4e9c05acfa2c3671b8618fcb95d57d96.html" target="_self">Software</a></td><td class="desc"></td></tr>
<tr id="row_3_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_3_0_" class="arrow" onclick="toggleFolder('3_0_')">&#9660;</span><span id="img_3_0_" class="iconfopen" onclick="toggleFolder('3_0_')">&#160;</span><a class="el" href="dir_70428d3c5958c16802133545478a5cfb.html" target="_self">Code Composer Studio Workspace</a></td><td class="desc"></td></tr>
<tr id="row_3_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span id="arr_3_0_0_" class="arrow" onclick="toggleFolder('3_0_0_')">&#9660;</span><span id="img_3_0_0_" class="iconfopen" onclick="toggleFolder('3_0_0_')">&#160;</span><a class="el" href="dir_ef94255a62432ae865475b379d8bd501.html" target="_self">SunseekerTelemetryAndLightingSystem</a></td><td class="desc"></td></tr>
<tr id="row_3_0_0_0_" class="even"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><a href="main_8c_source.html"><span class="icondoc"></span></a><a class="el" href="main_8c.html" target="_self">main.c</a></td><td class="desc"></td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
@@ -100,7 +101,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 Fri Jan 29 2021 19:12:56 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 Sat Jan 30 2021 17:37:13 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>

1
Documentation/html/files_dup.js
View File

@@ -2,5 +2,6 @@ var files_dup =
[
[ "Hardware", "dir_6cc751a9e685a986d41d35de353de328.html", "dir_6cc751a9e685a986d41d35de353de328" ],
[ "Meta", "dir_7795a02a4813dcd036f04e5f7854f185.html", null ],
[ "References", "dir_465c8a410b787ccece2cc89dfe6b85b1.html", null ],
[ "Software", "dir_4e9c05acfa2c3671b8618fcb95d57d96.html", "dir_4e9c05acfa2c3671b8618fcb95d57d96" ]
];

2
Documentation/html/globals.html
View File

@@ -91,7 +91,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 Fri Jan 29 2021 19:12:56 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 Sat Jan 30 2021 17:37:13 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>

2
Documentation/html/globals_func.html
View File

@@ -91,7 +91,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 Fri Jan 29 2021 19:12:56 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 Sat Jan 30 2021 17:37:13 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>

18
Documentation/html/hardware.html
View File

@@ -91,14 +91,28 @@ $(document).ready(function(){initNavTree('hardware.html',''); initResizable(); }
<li><a class="el" href="layout_planning.html">Layout Planning</a></li>
</ul>
<hr />
</div></div><!-- contents -->
<h1><a class="anchor" id="autotoc_md1"></a>
Design Reminders</h1>
<ul>
<li>From "Texas Instruments - SLAS655G...", Page 22:<ul>
<li>To improve EMI on the XT1 oscillator, the following guidelines should be observed:<ul>
<li>Keep the trace between the device and the crystal as short as possible.</li>
<li>Design a good ground plane around the oscillator pins.</li>
<li>Prevent crosstalk from other clock or data lines into oscillator pins XIN and XOUT.</li>
<li>Avoid running PCB traces underneath or adjacent to the XIN and XOUT pins. </li>
</ul>
</li>
</ul>
</li>
</ul>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
<!-- 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 Fri Jan 29 2021 19:12:56 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 Sat Jan 30 2021 17:37:13 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>

1
Documentation/html/hardware.js
View File

@@ -1,5 +1,6 @@
var hardware =
[
[ "Design Reminders", "hardware.html#autotoc_md1", null ],
[ "Device Specifications", "device_specifications.html", null ],
[ "Layout Planning", "layout_planning.html", null ]
];

10
Documentation/html/index.html
View File

@@ -91,14 +91,14 @@ $(document).ready(function(){initNavTree('index.html',''); initResizable(); });
<li><a class="el" href="software.html">Software</a></li>
</ul>
<hr />
<h1><a class="anchor" id="autotoc_md13"></a>
<h1><a class="anchor" id="autotoc_md14"></a>
About</h1>
<p>What this project is about (TODO)</p>
<h1><a class="anchor" id="autotoc_md14"></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_md15"></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>
@@ -116,7 +116,7 @@ Tips from Dr. Bazuin</h2>
<li>Need to make sure we have a BOM</li>
<li>Free samples for parts from manufacturers</li>
</ul>
<h2><a class="anchor" id="autotoc_md16"></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>
@@ -129,7 +129,7 @@ Tips from Dr. Gomez</h2>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Fri Jan 29 2021 19:12:56 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 Sat Jan 30 2021 17:37:13 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>

4
Documentation/html/layout_planning.html
View File

@@ -85,7 +85,7 @@ $(document).ready(function(){initNavTree('layout_planning.html',''); initResizab
<div class="title">Layout Planning </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><h2><a class="anchor" id="autotoc_md11"></a>
<div class="textblock"><h2><a class="anchor" id="autotoc_md12"></a>
Microcontroller</h2>
</div></div><!-- contents -->
</div><!-- PageDoc -->
@@ -94,7 +94,7 @@ Microcontroller</h2>
<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 Fri Jan 29 2021 19:12:56 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 Sat Jan 30 2021 17:37:13 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>

2
Documentation/html/main_8c.html
View File

@@ -124,7 +124,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 Fri Jan 29 2021 19:12:56 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 Sat Jan 30 2021 17:37:13 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>

2
Documentation/html/main_8c_source.html
View File

@@ -101,7 +101,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 Fri Jan 29 2021 19:12:56 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 Sat Jan 30 2021 17:37:13 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>

19
Documentation/html/navtreedata.js
View File

@@ -25,20 +25,23 @@
var NAVTREE =
[
[ "2020-2021 Sunseeker Telemetry and Lighting System", "index.html", [
[ "About", "index.html#autotoc_md13", null ],
[ "Documentation", "index.html#autotoc_md14", [
[ "Tips from Dr. Bazuin", "index.html#autotoc_md15", null ],
[ "Tips from Dr. Gomez", "index.html#autotoc_md16", null ]
[ "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 ]
] ],
[ "Hardware", "hardware.html", "hardware" ],
[ "Software", "software.html", null ],
[ "Documentation Guide", "documentation_guide.html", [
[ "Doxygen", "documentation_guide.html#autotoc_md17", null ],
[ "Updating Documentation", "documentation_guide.html#autotoc_md18", null ],
[ "Important Notes", "documentation_guide.html#autotoc_md19", [
[ "For Consistency", "documentation_guide.html#autotoc_md20", null ]
[ "Doxygen", "documentation_guide.html#autotoc_md18", null ],
[ "Updating Documentation", "documentation_guide.html#autotoc_md19", null ],
[ "Important Notes", "documentation_guide.html#autotoc_md20", [
[ "For Consistency", "documentation_guide.html#autotoc_md21", null ]
] ]
] ],
[ "References", "references.html", [
[ "Universal Clock System (UCS)", "references.html#autotoc_md23", null ]
] ],
[ "Files", "files.html", [
[ "File List", "files.html", "files_dup" ],
[ "Globals", "globals.html", [

68
Documentation/html/navtreeindex0.js
View File

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

3
Documentation/html/pages.html
View File

@@ -88,6 +88,7 @@ $(document).ready(function(){initNavTree('pages.html',''); initResizable(); });
<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>
<tr id="row_1_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="references.html" target="_self">References</a></td><td class="desc"></td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
@@ -95,7 +96,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 Fri Jan 29 2021 19:12:56 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 Sat Jan 30 2021 17:37:13 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>

108
Documentation/html/references.html Normal file
View File

@@ -0,0 +1,108 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>2020-2021 Sunseeker Telemetry and Lighting System: References</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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">2020-2021 Sunseeker Telemetry and Lighting System
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih: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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('references.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">References </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p><b>Subpages</b> </p>
<ul>
<li>microcontroller Microcontroller</li>
</ul>
<hr />
<h1><a class="anchor" id="autotoc_md23"></a>
Universal Clock System (UCS)</h1>
<ul>
<li><a href="https://www.youtube.com/watch?v=b4PEmSDZml4">High-level Introductory Video</a> </li>
</ul>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Sat Jan 30 2021 17:37:13 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>
</html>

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

@@ -1,5 +1,6 @@
var searchData=
[
['_21hardware_2emarkdown_0',['!Hardware.markdown',['../_9_hardware_8markdown.html',1,'']]],
['_21software_2emarkdown_1',['!Software.markdown',['../_9_software_8markdown.html',1,'']]]
['_21references_2emarkdown_1',['!References.markdown',['../_9_references_8markdown.html',1,'']]],
['_21software_2emarkdown_2',['!Software.markdown',['../_9_software_8markdown.html',1,'']]]
];

8
Documentation/html/search/all_1.js
View File

@@ -1,7 +1,7 @@
var searchData=
[
['device_20specifications_2',['Device Specifications',['../device_specifications.html',1,'hardware']]],
['device_20specifications_2emarkdown_3',['Device Specifications.markdown',['../_device_01_specifications_8markdown.html',1,'']]],
['documentation_20guide_4',['Documentation Guide',['../documentation_guide.html',1,'']]],
['documentation_20guide_2emarkdown_5',['Documentation Guide.markdown',['../_documentation_01_guide_8markdown.html',1,'']]]
['device_20specifications_3',['Device Specifications',['../device_specifications.html',1,'hardware']]],
['device_20specifications_2emarkdown_4',['Device Specifications.markdown',['../_device_01_specifications_8markdown.html',1,'']]],
['documentation_20guide_5',['Documentation Guide',['../documentation_guide.html',1,'']]],
['documentation_20guide_2emarkdown_6',['Documentation Guide.markdown',['../_documentation_01_guide_8markdown.html',1,'']]]
];

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

@@ -1,4 +1,4 @@
var searchData=
[
['hardware_6',['Hardware',['../hardware.html',1,'index']]]
['hardware_7',['Hardware',['../hardware.html',1,'index']]]
];

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

@@ -1,5 +1,5 @@
var searchData=
[
['layout_20planning_7',['Layout Planning',['../layout_planning.html',1,'hardware']]],
['layout_20planning_2emarkdown_8',['Layout Planning.markdown',['../_layout_01_planning_8markdown.html',1,'']]]
['layout_20planning_8',['Layout Planning',['../layout_planning.html',1,'hardware']]],
['layout_20planning_2emarkdown_9',['Layout Planning.markdown',['../_layout_01_planning_8markdown.html',1,'']]]
];

4
Documentation/html/search/all_4.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,'']]]
];

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

@@ -1,4 +1,5 @@
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,'']]],
['references_13',['References',['../references.html',1,'']]]
];

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

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

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

@@ -1,5 +1,6 @@
var searchData=
[
['_21hardware_2emarkdown_13',['!Hardware.markdown',['../_9_hardware_8markdown.html',1,'']]],
['_21software_2emarkdown_14',['!Software.markdown',['../_9_software_8markdown.html',1,'']]]
['_21hardware_2emarkdown_15',['!Hardware.markdown',['../_9_hardware_8markdown.html',1,'']]],
['_21references_2emarkdown_16',['!References.markdown',['../_9_references_8markdown.html',1,'']]],
['_21software_2emarkdown_17',['!Software.markdown',['../_9_software_8markdown.html',1,'']]]
];

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

@@ -1,5 +1,5 @@
var searchData=
[
['device_20specifications_2emarkdown_15',['Device Specifications.markdown',['../_device_01_specifications_8markdown.html',1,'']]],
['documentation_20guide_2emarkdown_16',['Documentation Guide.markdown',['../_documentation_01_guide_8markdown.html',1,'']]]
['device_20specifications_2emarkdown_18',['Device Specifications.markdown',['../_device_01_specifications_8markdown.html',1,'']]],
['documentation_20guide_2emarkdown_19',['Documentation Guide.markdown',['../_documentation_01_guide_8markdown.html',1,'']]]
];

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

@@ -1,4 +1,4 @@
var searchData=
[
['layout_20planning_2emarkdown_17',['Layout Planning.markdown',['../_layout_01_planning_8markdown.html',1,'']]]
['layout_20planning_2emarkdown_20',['Layout Planning.markdown',['../_layout_01_planning_8markdown.html',1,'']]]
];

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

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

2
Documentation/html/search/files_4.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_22',['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_23',['main',['../main_8c.html#a840291bc02cba5474a4cb46a9b9566fe',1,'main.c']]]
];

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

@@ -1,5 +1,5 @@
var searchData=
[
['device_20specifications_21',['Device Specifications',['../device_specifications.html',1,'hardware']]],
['documentation_20guide_22',['Documentation Guide',['../documentation_guide.html',1,'']]]
['device_20specifications_24',['Device Specifications',['../device_specifications.html',1,'hardware']]],
['documentation_20guide_25',['Documentation Guide',['../documentation_guide.html',1,'']]]
];

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

@@ -1,4 +1,4 @@
var searchData=
[
['hardware_23',['Hardware',['../hardware.html',1,'index']]]
['hardware_26',['Hardware',['../hardware.html',1,'index']]]
];

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

@@ -1,4 +1,4 @@
var searchData=
[
['layout_20planning_24',['Layout Planning',['../layout_planning.html',1,'hardware']]]
['layout_20planning_27',['Layout Planning',['../layout_planning.html',1,'hardware']]]
];

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

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

37
Documentation/html/search/pages_4.html Normal file
View File

@@ -0,0 +1,37 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><title></title>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<link rel="stylesheet" type="text/css" href="search.css"/>
<script type="text/javascript" src="pages_4.js"></script>
<script type="text/javascript" src="search.js"></script>
</head>
<body class="SRPage">
<div id="SRIndex">
<div class="SRStatus" id="Loading">Loading...</div>
<div id="SRResults"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
createResults();
/* @license-end */
</script>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
document.getElementById("Loading").style.display="none";
document.getElementById("NoMatches").style.display="none";
var searchResults = new SearchResults("searchResults");
searchResults.Search();
window.addEventListener("message", function(event) {
if (event.data == "take_focus") {
var elem = searchResults.NavNext(0);
if (elem) elem.focus();
}
});
/* @license-end */
</script>
</div>
</body>
</html>

4
Documentation/html/search/pages_4.js Normal file
View File

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

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

@@ -3,7 +3,7 @@ var indexSectionsWithContent =
0: "!dhlmrs",
1: "!dlmr",
2: "m",
3: "dhls"
3: "dhlrs"
};
var indexSectionNames =

2
Documentation/html/software.html
View File

@@ -92,7 +92,7 @@ $(document).ready(function(){initNavTree('software.html',''); initResizable(); }
<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 Fri Jan 29 2021 19:12:56 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 Sat Jan 30 2021 17:37:13 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>

2
Documentation/latex/_9_references_8markdown.tex Normal file
View File

@@ -0,0 +1,2 @@
\hypertarget{_9_references_8markdown}{}\doxysection{References/!\+References.markdown File Reference}
\label{_9_references_8markdown}\index{References/"!References.markdown@{References/"!References.markdown}}

2
Documentation/latex/dir_465c8a410b787ccece2cc89dfe6b85b1.tex Normal file
View File

@@ -0,0 +1,2 @@
\hypertarget{dir_465c8a410b787ccece2cc89dfe6b85b1}{}\doxysection{References Directory Reference}
\label{dir_465c8a410b787ccece2cc89dfe6b85b1}\index{References Directory Reference@{References Directory Reference}}

13
Documentation/latex/documentation_guide.tex
View File

@@ -1,19 +1,20 @@
\hypertarget{documentation_guide_autotoc_md17}{}\doxysection{Doxygen}\label{documentation_guide_autotoc_md17}
\hypertarget{documentation_guide_autotoc_md18}{}\doxysection{Doxygen}\label{documentation_guide_autotoc_md18}
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_md18}{}\doxysection{Updating Documentation}\label{documentation_guide_autotoc_md18}
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_md19}{}\doxysection{Important Notes}\label{documentation_guide_autotoc_md19}
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_md19}{}\doxysection{Updating Documentation}\label{documentation_guide_autotoc_md19}
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_md20}{}\doxysection{Important Notes}\label{documentation_guide_autotoc_md20}
\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.
\end{DoxyItemize}\hypertarget{documentation_guide_autotoc_md20}{}\doxysubsection{For Consistency}\label{documentation_guide_autotoc_md20}
\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_md21}{}\doxysubsection{For Consistency}\label{documentation_guide_autotoc_md21}
\begin{DoxyItemize}
\item Please make sure the internal names of files are using \char`\"{}camel\+Case\char`\"{}
\item Please make sure the internal names (\char`\"{}tags\char`\"{}) of files are using \char`\"{}camel\+Case\char`\"{}
\begin{DoxyItemize}
\item Example\+: for \char`\"{}@page documentation\+Guide Documentation Guide\char`\"{} \char`\"{}documentation\+Guide\char`\"{} is the name used internally by doxygen. \char`\"{}\+Documentation Guide\char`\"{} is what shows up on the output documentation.
\item Example\+: for \char`\"{}@page documentation\+Guide Documentation Guide\char`\"{} \char`\"{}documentation\+Guide\char`\"{} is the name/tag used internally by doxygen. \char`\"{}\+Documentation Guide\char`\"{} is what shows up on the output documentation.
\end{DoxyItemize}
\end{DoxyItemize}

37
Documentation/latex/hardware.tex
View File

@@ -7,8 +7,21 @@
\end{DoxyItemize}
\DoxyHorRuler{0}
\hypertarget{deviceSpecifications}{}\doxysection{Device Specifications}\label{deviceSpecifications}
\hypertarget{device_specifications_autotoc_md1}{}\doxysubsubsection{Microcontroller\+: Texas Instruments MSP430\+F5438\+AIPZR}\label{device_specifications_autotoc_md1}
\hypertarget{hardware_autotoc_md1}{}\doxysection{Design Reminders}\label{hardware_autotoc_md1}
\begin{DoxyItemize}
\item From \char`\"{}\+Texas Instruments -\/ SLAS655\+G...\char`\"{}, Page 22\+:
\begin{DoxyItemize}
\item To improve EMI on the XT1 oscillator, the following guidelines should be observed\+:
\begin{DoxyItemize}
\item Keep the trace between the device and the crystal as short as possible.
\item Design a good ground plane around the oscillator pins.
\item Prevent crosstalk from other clock or data lines into oscillator pins XIN and XOUT.
\item Avoid running PCB traces underneath or adjacent to the XIN and XOUT pins.
\end{DoxyItemize}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{deviceSpecifications}{}\doxysection{Device Specifications}\label{deviceSpecifications}
\hypertarget{device_specifications_autotoc_md2}{}\doxysubsubsection{Microcontroller\+: Texas Instruments MSP430\+F5438\+AIPZR}\label{device_specifications_autotoc_md2}
\begin{DoxyItemize}
\item 1.\+8 V to 3.\+6 V Supply Voltage
@@ -32,7 +45,7 @@
\item 14 external channels
\end{DoxyItemize}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md2}{}\doxysubsubsection{Real-\/\+Time Clock/\+Calendar\+: Microchip Technology ‎\+MCP7940\+MT-\/\+I/\+SN}\label{device_specifications_autotoc_md2}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md3}{}\doxysubsubsection{Real-\/\+Time Clock/\+Calendar\+: Microchip Technology ‎\+MCP7940\+MT-\/\+I/\+SN}\label{device_specifications_autotoc_md3}
\begin{DoxyItemize}
\item 1.\+8 V to 5.\+5 V Supply Voltage
@@ -43,7 +56,7 @@
\item Clock rate up to 400 k\+Hz
\end{DoxyItemize}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md3}{}\doxysubsubsection{Bluetooth/\+Wi-\/\+Fi\+: Espressif Systems ESP32-\/\+WROVER-\/\+IE (8\+MB)}\label{device_specifications_autotoc_md3}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md4}{}\doxysubsubsection{Bluetooth/\+Wi-\/\+Fi\+: Espressif Systems ESP32-\/\+WROVER-\/\+IE (8\+MB)}\label{device_specifications_autotoc_md4}
\begin{DoxyItemize}
\item 3.\+0 V to 3.\+6 V Supply Voltage
@@ -53,7 +66,7 @@
\item SPI
\item UART
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md4}{}\doxysubsubsection{GPS Receiver\+: Maxim Integrated ‎\+MAX2771\+ETI+T}\label{device_specifications_autotoc_md4}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md5}{}\doxysubsubsection{GPS Receiver\+: Maxim Integrated ‎\+MAX2771\+ETI+T}\label{device_specifications_autotoc_md5}
\begin{DoxyItemize}
\item 2.\+7 V to 3.\+3 V Supply Voltage
@@ -61,7 +74,7 @@
\begin{DoxyItemize}
\item SPI
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md5}{}\doxysubsubsection{CANbus Controller\+: Microchip Technology MCP2515\+T-\/\+I/\+SO}\label{device_specifications_autotoc_md5}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md6}{}\doxysubsubsection{CANbus Controller\+: Microchip Technology MCP2515\+T-\/\+I/\+SO}\label{device_specifications_autotoc_md6}
\begin{DoxyItemize}
\item 2.\+7 V to 5.\+5 V Supply Voltage
@@ -72,12 +85,12 @@
\item 10 MHz
\end{DoxyItemize}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md6}{}\doxysubsubsection{CAN Bus Transceiver\+: ‎\+Microchip Technology MCP2542\+FD-\/\+H/\+SN}\label{device_specifications_autotoc_md6}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md7}{}\doxysubsubsection{CAN Bus Transceiver\+: ‎\+Microchip Technology MCP2542\+FD-\/\+H/\+SN}\label{device_specifications_autotoc_md7}
\begin{DoxyItemize}
\item 4.\+5 V to 5.\+5 V Supply Voltage
\item Used directly with CANbus Controller
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md7}{}\doxysubsubsection{SD Card (\+Generic)}\label{device_specifications_autotoc_md7}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md8}{}\doxysubsubsection{SD Card (\+Generic)}\label{device_specifications_autotoc_md8}
\begin{DoxyItemize}
\item 2.\+7 V to 3.\+6 V Supply Voltage
@@ -85,12 +98,12 @@
\begin{DoxyItemize}
\item SPI
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md8}{}\doxysubsubsection{USB to UART Bridge\+: FTDI ‎‎\+FT260\+Q-\/T}\label{device_specifications_autotoc_md8}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md9}{}\doxysubsubsection{USB to UART Bridge\+: FTDI ‎‎\+FT260\+Q-\/T}\label{device_specifications_autotoc_md9}
\begin{DoxyItemize}
\item We will use a \char`\"{}\+Bus-\/\+Powered Configuration\char`\"{}, requiring the host device to supply power, that way we don\textquotesingle{}t have to.
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md9}{}\doxysubsubsection{RS-\/232 Transceiver\+: Texas Instruments GD75232\+PWR}\label{device_specifications_autotoc_md9}
\hypertarget{device_specifications_autotoc_md10}{}\doxysubsubsection{Inertial Measurement Unit\+: TDK Inven\+Sense ICM-\/20600}\label{device_specifications_autotoc_md10}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md10}{}\doxysubsubsection{RS-\/232 Transceiver\+: Texas Instruments GD75232\+PWR}\label{device_specifications_autotoc_md10}
\hypertarget{device_specifications_autotoc_md11}{}\doxysubsubsection{Inertial Measurement Unit\+: TDK Inven\+Sense ICM-\/20600}\label{device_specifications_autotoc_md11}
\begin{DoxyItemize}
\item 1.\+71 V to 3.\+45 V Supply Voltage
@@ -106,4 +119,4 @@
\end{DoxyItemize}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{layoutPlanning}{}\doxysection{Layout Planning}\label{layoutPlanning}
\hypertarget{layout_planning_autotoc_md11}{}\doxysubsubsection{Microcontroller}\label{layout_planning_autotoc_md11}
\hypertarget{layout_planning_autotoc_md12}{}\doxysubsubsection{Microcontroller}\label{layout_planning_autotoc_md12}

8
Documentation/latex/index.tex
View File

@@ -7,11 +7,11 @@
\end{DoxyItemize}
\DoxyHorRuler{0}
\hypertarget{index_autotoc_md13}{}\doxysection{About}\label{index_autotoc_md13}
What this project is about (TODO)\hypertarget{index_autotoc_md14}{}\doxysection{Documentation}\label{index_autotoc_md14}
\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_md15}{}\doxysubsection{Tips from Dr. Bazuin}\label{index_autotoc_md15}
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,7 +28,7 @@ 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_md16}{}\doxysubsection{Tips from Dr. Gomez}\label{index_autotoc_md16}
\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

13
Documentation/latex/references.tex Normal file
View File

@@ -0,0 +1,13 @@
{\bfseries{Subpages}}
\begin{DoxyItemize}
\item microcontroller Microcontroller
\end{DoxyItemize}
\DoxyHorRuler{0}
\hypertarget{references_autotoc_md23}{}\doxysection{Universal Clock System (\+UCS)}\label{references_autotoc_md23}
\begin{DoxyItemize}
\item \href{https://www.youtube.com/watch?v=b4PEmSDZml4}{\texttt{ High-\/level Introductory Video}}
\end{DoxyItemize}

5
Documentation/latex/refman.tex
View File

@@ -185,6 +185,10 @@
\label{documentation_guide}
\Hypertarget{documentation_guide}
\input{documentation_guide}
\chapter{References}
\label{references}
\Hypertarget{references}
\input{references}
\chapter{File Index}
\input{files}
\chapter{File Documentation}
@@ -193,6 +197,7 @@
\input{_layout_01_planning_8markdown}
\input{_documentation_01_guide_8markdown}
\input{_r_e_a_d_m_e_8markdown}
\input{_9_references_8markdown}
\input{_9_software_8markdown}
\input{main_8c}
%--- End generated contents ---