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

Revert ""

Browse Source 
This reverts commit 75142d8376, reversing
changes made to b51d00d063.
This commit is contained in:
William Miceli
2021-02-08 14:24:50 -05:00
parent 75142d8376
commit 3ba4462b54
79 changed files with 5211 additions and 1383 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 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>
<li class="footer">Generated on Sat Feb 6 2021 19:02:29 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 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>
<li class="footer">Generated on Sat Feb 6 2021 19:02:29 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 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>
<li class="footer">Generated on Sat Feb 6 2021 19:02:29 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 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>
<li class="footer">Generated on Sat Feb 6 2021 19:02:29 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 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>
<li class="footer">Generated on Sat Feb 6 2021 19:02:29 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

104
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>
@@ -85,7 +92,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_md2"></a>
<div class="textblock"><h2><a class="anchor" id="autotoc_md4"></a>
Microcontroller: Texas Instruments MSP430F5438AIPZR</h2>
<ul>
<li>1.8 V to 3.6 V Supply Voltage</li>
@@ -110,57 +117,78 @@ Microcontroller: Texas Instruments MSP430F5438AIPZR</h2>
</ul>
</li>
</ul>
<h2><a class="anchor" id="autotoc_md3"></a>
<h2><a class="anchor" id="autotoc_md5"></a>
Real-Time Clock/Calendar: Microchip Technology ‎MCP7940MT-I/SN</h2>
<ul>
<li>1.8 V to 5.5 V Supply Voltage</li>
<li>Notable Peripherals:<ul>
<li>I2C<ul>
<li>Slave only</li>
<li>Clock rate up to 400 kHz</li>
</ul>
</li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="autotoc_md4"></a>
<h2><a class="anchor" id="autotoc_md6"></a>
Bluetooth/Wi-Fi: Espressif Systems ESP32-WROVER-IE (8MB)</h2>
<ul>
<li>3.0 V to 3.6 V Supply Voltage</li>
<li>Notable Peripherals:<ul>
<li>I2C</li>
<li>SPI</li>
<li>UART</li>
<li>I2C (2)<ul>
<li>Master or Slave</li>
<li>100 kbit/s or 400 kbit/s</li>
<li>7-bit/10-bit addressing mode</li>
</ul>
</li>
</ul>
<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>
<li>Notable Peripherals:<ul>
<li>SPI</li>
</ul>
</li>
</ul>
<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>
<li>Notable Peripherals:<ul>
<li>SPI<ul>
<li>10 MHz</li>
<li>SPI, HSPI and VSPI</li>
<li>Master or Slave</li>
<li>1-line full-duplex and 1/2/4-line half-duplex</li>
<li>Up to 80 MHz</li>
<li>Up to 64-byte FIFO</li>
</ul>
</li>
<li>UART (3)<ul>
<li>Up to 5 Mbps</li>
</ul>
</li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="autotoc_md7"></a>
CAN Bus Transceiver: ‎Microchip Technology MCP2542FD-H/SN</h2>
GPS Receiver: Maxim Integrated ‎MAX2771ETI+T</h2>
<ul>
<li>2.7 V to 3.3 V Supply Voltage</li>
<li>Notable Peripherals:<ul>
<li>SPI<ul>
<li>Slave only</li>
<li>Need to calculate frequency</li>
</ul>
</li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="autotoc_md8"></a>
CANbus Controller: Microchip Technology MCP2515T-I/SO</h2>
<ul>
<li>2.7 V to 5.5 V Supply Voltage</li>
<li>Notable Peripherals:<ul>
<li>SPI<ul>
<li>Slave (Assuming only option)</li>
<li>10 MHz</li>
</ul>
</li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="autotoc_md9"></a>
CANbus 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_md8"></a>
<h2><a class="anchor" id="autotoc_md10"></a>
SD Card (Generic)</h2>
<ul>
<li>2.7 V to 3.6 V Supply Voltage</li>
@@ -169,23 +197,33 @@ SD Card (Generic)</h2>
</ul>
</li>
</ul>
<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_md10"></a>
RS-232 Transceiver: Texas Instruments GD75232PWR</h2>
<h2><a class="anchor" id="autotoc_md11"></a>
USB to UART Bridge: Future Technology Devices International FT230XS-R</h2>
<ul>
<li>3 V to 5 V Supply Voltage</li>
<li>Notable Peripherals:<ul>
<li>UART</li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="autotoc_md12"></a>
RS-232 Transceiver: STMicroelectronics ST232CDR</h2>
<ul>
<li>4.5 V to 5.5 V Supply Voltage</li>
<li>Will use UART from the MCU</li>
</ul>
<h2><a class="anchor" id="autotoc_md13"></a>
Inertial Measurement Unit: TDK InvenSense ICM-20600</h2>
<ul>
<li>1.71 V to 3.45 V Supply Voltage</li>
<li>Notable Peripherals:<ul>
<li>I2C<ul>
<li>Slave only</li>
<li>400 kHz</li>
</ul>
</li>
<li>SPI<ul>
<li>Slave only</li>
<li>10 MHz </li>
</ul>
</li>
@@ -198,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 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>
<li class="navelem"><a class="el" href="hardware.html">Hardware</a></li>
<li class="footer">Generated on Sat Feb 6 2021 19:02:29 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 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>
<li class="footer">Generated on Sat Feb 6 2021 19:02:29 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 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>
<li class="footer">Generated on Sat Feb 6 2021 19:02:29 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>

21
Documentation/html/dir_6cc751a9e685a986d41d35de353de328.js
View File

@@ -1,14 +1,13 @@
var dir_6cc751a9e685a986d41d35de353de328 =
[
[ "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 ]
[ "Microcontroller: Texas Instruments MSP430F5438AIPZR", "device_specifications.html#autotoc_md4", null ],
[ "Real-Time Clock/Calendar: Microchip Technology ‎MCP7940MT-I/SN", "device_specifications.html#autotoc_md5", null ],
[ "Bluetooth/Wi-Fi: Espressif Systems ESP32-WROVER-IE (8MB)", "device_specifications.html#autotoc_md6", null ],
[ "GPS Receiver: Maxim Integrated ‎MAX2771ETI+T", "device_specifications.html#autotoc_md7", null ],
[ "CANbus Controller: Microchip Technology MCP2515T-I/SO", "device_specifications.html#autotoc_md8", null ],
[ "CANbus Transceiver: ‎Microchip Technology MCP2542FD-H/SN", "device_specifications.html#autotoc_md9", null ],
[ "SD Card (Generic)", "device_specifications.html#autotoc_md10", null ],
[ "USB to UART Bridge: Future Technology Devices International FT230XS-R", "device_specifications.html#autotoc_md11", null ],
[ "RS-232 Transceiver: STMicroelectronics ST232CDR", "device_specifications.html#autotoc_md12", null ],
[ "Inertial Measurement Unit: TDK InvenSense ICM-20600", "device_specifications.html#autotoc_md13", null ]
];

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 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>
<li class="footer">Generated on Sat Feb 6 2021 19:02:29 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 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>
<li class="footer">Generated on Sat Feb 6 2021 19:02:29 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 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>
<li class="footer">Generated on Sat Feb 6 2021 19:02:29 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

26
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,36 +92,43 @@ $(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_md18"></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_md19"></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_md20"></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_md21"></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>
<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>
<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>
<h2><a class="anchor" id="autotoc_md23"></a>
Adding Images</h2>
<p>Use this pattern/format: </p><div class="fragment"><div class="line">@image html &quot;Documentation Guide.assets/Funny-Cat-Hidden.jpg&quot;</div>
<div class="line">@cond EXCLUDED</div>
<div class="line">![img](Documentation Guide.assets/Funny-Cat-Hidden.jpg)</div>
<div class="line">@endcond</div>
</div><!-- fragment --><p>Which will output a single image that is both easily viewable in Doxygen, as well as Markdown viewers/editors. </p>
</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>
<li class="footer">Generated on Sat Feb 6 2021 19:02:29 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

18
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>
@@ -89,11 +96,10 @@ $(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: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>
<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>
</table>
</div><!-- directory -->
</div><!-- contents -->
@@ -101,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 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>
<li class="footer">Generated on Sat Feb 6 2021 19:02:30 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,6 +2,5 @@ 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" ]
];

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 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>
<li class="footer">Generated on Sat Feb 6 2021 19:02:30 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 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>
<li class="footer">Generated on Sat Feb 6 2021 19:02:30 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>

12
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>
@@ -87,8 +94,8 @@ $(document).ready(function(){initNavTree('hardware.html',''); initResizable(); }
<div class="contents">
<div class="textblock"><p><b>Subpages</b> </p>
<ul>
<li><a class="el" href="design_choices.html">Design Choices</a></li>
<li><a class="el" href="device_specifications.html">Device Specifications</a></li>
<li><a class="el" href="layout_planning.html">Layout Planning</a></li>
</ul>
<hr />
<h1><a class="anchor" id="autotoc_md1"></a>
@@ -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 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>
<li class="footer">Generated on Sat Feb 6 2021 19:02:29 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>

7
Documentation/html/hardware.js
View File

@@ -1,6 +1,9 @@
var hardware =
[
[ "Design Reminders", "hardware.html#autotoc_md1", null ],
[ "Device Specifications", "device_specifications.html", null ],
[ "Layout Planning", "layout_planning.html", null ]
[ "Design Choices", "design_choices.html", [
[ "JTAG Interface", "design_choices.html#autotoc_md2", null ],
[ "Microcontroller Peripheral Connections", "design_choices.html#autotoc_md3", null ]
] ],
[ "Device Specifications", "device_specifications.html", null ]
];

33
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,16 +89,10 @@ $(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_md14"></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_md15"></a>
@@ -115,13 +116,23 @@ 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_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>
<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_md18"></a>
TODO List</h1>
<ul>
<li>[ ] Make battery circuitry for Real-Time Clock/Calendar for when the vehicle is off.</li>
<li>[ ] Ensure the footprint for CANbus Transceiver is present, since it's not available in Altium by default, and the import from Ultra Librarian seemed to only successfully add the schematic and 3D Model, but wasn't sure about footprint.</li>
<li>[ ] The CANbus Controller required a resonator/oscillator and capacitor pair to be picked, but non-optimized values were given and so we need to test which resonator/oscillator and capacitor pair works best.</li>
<li>[ ] Need to look through Sunseeker documentation to learn how they have their CANbus setup, ensuring we have our controller and transceiver setup correctly. </li>
</ul>
</div></div><!-- PageDoc -->
</div><!-- contents -->
@@ -129,7 +140,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 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>
<li class="footer">Generated on Sat Feb 6 2021 19:02:29 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.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 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>
<li class="footer">Generated on Sat Feb 6 2021 19:02:29 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 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>
<li class="footer">Generated on Sat Feb 6 2021 19:02:29 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+ */
}

25
Documentation/html/navtreedata.js
View File

@@ -25,23 +25,24 @@
var NAVTREE =
[
[ "2020-2021 Sunseeker Telemetry and Lighting System", "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 ]
[ "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 ]
] ],
[ "Hardware", "hardware.html", "hardware" ],
[ "Software", "software.html", null ],
[ "Documentation Guide", "documentation_guide.html", [
[ "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 ]
[ "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 ],
[ "Adding Images", "documentation_guide.html#autotoc_md23", 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", [
@@ -54,7 +55,7 @@ var NAVTREE =
var NAVTREEINDEX =
[
"device_specifications.html"
"design_choices.html"
];
var SYNCONMSG = 'click to disable panel synchronisation';

79
Documentation/html/navtreeindex0.js
View File

@@ -1,44 +1,45 @@
var NAVTREEINDEX0 =
{
"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_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],
"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],
"device_specifications.html#autotoc_md13":[9],
"device_specifications.html#autotoc_md4":[0],
"device_specifications.html#autotoc_md5":[1],
"device_specifications.html#autotoc_md6":[2],
"device_specifications.html#autotoc_md7":[3],
"device_specifications.html#autotoc_md8":[4],
"device_specifications.html#autotoc_md9":[5],
"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],
"documentation_guide.html#autotoc_md23":[3,2,1],
"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_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],
"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":[],
"references.html":[5],
"references.html#autotoc_md23":[5,0],
"software.html":[3]
"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

18
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,9 +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>
<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>
<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 -->
@@ -96,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 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>
<li class="footer">Generated on Sat Feb 6 2021 19:02:30 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_0.js
View File

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

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

@@ -1,7 +1,9 @@
var searchData=
[
['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,'']]]
['design_20choices_2',['Design Choices',['../design_choices.html',1,'hardware']]],
['design_20choices_2emarkdown_3',['Design Choices.markdown',['../_design_01_choices_8markdown.html',1,'']]],
['device_20specifications_4',['Device Specifications',['../device_specifications.html',1,'hardware']]],
['device_20specifications_2emarkdown_5',['Device Specifications.markdown',['../_device_01_specifications_8markdown.html',1,'']]],
['documentation_20guide_6',['Documentation Guide',['../documentation_guide.html',1,'']]],
['documentation_20guide_2emarkdown_7',['Documentation Guide.markdown',['../_documentation_01_guide_8markdown.html',1,'']]]
];

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

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

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

@@ -1,5 +1,4 @@
var searchData=
[
['main_10',['main',['../main_8c.html#a840291bc02cba5474a4cb46a9b9566fe',1,'main.c']]],
['main_2ec_11',['main.c',['../main_8c.html',1,'']]]
['readme_2emarkdown_12',['README.markdown',['../_r_e_a_d_m_e_8markdown.html',1,'']]]
];

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

@@ -1,5 +1,4 @@
var searchData=
[
['readme_2emarkdown_12',['README.markdown',['../_r_e_a_d_m_e_8markdown.html',1,'']]],
['references_13',['References',['../references.html',1,'']]]
['software_13',['Software',['../software.html',1,'']]]
];

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

@@ -1,6 +1,5 @@
var searchData=
[
['_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,'']]]
['_21hardware_2emarkdown_14',['!Hardware.markdown',['../_9_hardware_8markdown.html',1,'']]],
['_21software_2emarkdown_15',['!Software.markdown',['../_9_software_8markdown.html',1,'']]]
];

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

@@ -1,5 +1,6 @@
var searchData=
[
['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,'']]]
['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=
[
['layout_20planning_2emarkdown_20',['Layout Planning.markdown',['../_layout_01_planning_8markdown.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=
[
['main_2ec_21',['main.c',['../main_8c.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_23',['main',['../main_8c.html#a840291bc02cba5474a4cb46a9b9566fe',1,'main.c']]]
['main_21',['main',['../main_8c.html#a840291bc02cba5474a4cb46a9b9566fe',1,'main.c']]]
];

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

@@ -1,5 +1,6 @@
var searchData=
[
['device_20specifications_24',['Device Specifications',['../device_specifications.html',1,'hardware']]],
['documentation_20guide_25',['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_26',['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=
[
['layout_20planning_27',['Layout Planning',['../layout_planning.html',1,'hardware']]]
['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 {

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

@@ -1,9 +1,9 @@
var indexSectionsWithContent =
{
0: "!dhlmrs",
1: "!dlmr",
0: "!dhmrs",
1: "!dmr",
2: "m",
3: "dhlrs"
3: "dhs"
};
var indexSectionNames =

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 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>
<li class="footer">Generated on Sat Feb 6 2021 19:02:29 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

23
Documentation/latex/documentation_guide.tex
View File

@@ -1,20 +1,31 @@
\hypertarget{documentation_guide_autotoc_md18}{}\doxysection{Doxygen}\label{documentation_guide_autotoc_md18}
\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_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}
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_md21}{}\doxysubsection{For Consistency}\label{documentation_guide_autotoc_md21}
\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`\"{}
\begin{DoxyItemize}
\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.
\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}
\end{DoxyItemize}\hypertarget{documentation_guide_autotoc_md23}{}\doxysubsection{Adding Images}\label{documentation_guide_autotoc_md23}
Use this pattern/format\+:
\begin{DoxyCode}{0}
\DoxyCodeLine{@image html "{}Documentation Guide.assets/Funny-\/Cat-\/Hidden.jpg"{}}
\DoxyCodeLine{@cond EXCLUDED}
\DoxyCodeLine{![img](Documentation Guide.assets/Funny-\/Cat-\/Hidden.jpg)}
\DoxyCodeLine{@endcond}
\end{DoxyCode}
Which will output a single image that is both easily viewable in Doxygen, as well as Markdown viewers/editors.

109
Documentation/latex/hardware.tex
View File

@@ -2,8 +2,8 @@
\begin{DoxyItemize}
\item \mbox{\hyperlink{designChoices}{Design Choices}}
\item \mbox{\hyperlink{deviceSpecifications}{Device Specifications}}
\item \mbox{\hyperlink{layoutPlanning}{Layout Planning}}
\end{DoxyItemize}
\DoxyHorRuler{0}
@@ -20,8 +20,51 @@
\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}
\end{DoxyItemize}\hypertarget{designChoices}{}\doxysection{Design Choices}\label{designChoices}
\hypertarget{design_choices_autotoc_md2}{}\doxysubsection{JTAG Interface}\label{design_choices_autotoc_md2}
When connecting the MCU to the programmer via the JTAG interface, it is possible for a local power supply connected to the MCU to be used or for power from the debugging/programming adapter to be used. Since having power supplied to the MCU from the debugging/programming adapter can be useful for use outside of the Sunseeker vehicle, we chose to use that.\hypertarget{design_choices_autotoc_md3}{}\doxysubsection{Microcontroller Peripheral Connections}\label{design_choices_autotoc_md3}
Universal Serial Communication Interfaces (USCIs)\+:
\begin{DoxyItemize}
\item A -\/ Supporting up to four total of UART and/or SPI
\begin{DoxyItemize}
\item A0 \mbox{[}SPI\mbox{]}\+:
\begin{DoxyItemize}
\item CANbus Controller 0 (Microchip Technology MCP2515\+T-\/\+I/\+SO)
\item CANbus Controller 1 (Microchip Technology MCP2515\+T-\/\+I/\+SO)
\end{DoxyItemize}
\item A1\+:
\item A2 \mbox{[}UART\mbox{]}\+:
\begin{DoxyItemize}
\item RS-\/232 Transceiver (STMicroelectronics ST232\+CDR)
\end{DoxyItemize}
\item A3 \mbox{[}UART\mbox{]}\+:
\begin{DoxyItemize}
\item USB to UART Bridge (Future Technology Devices International FT230\+XS-\/R)
\end{DoxyItemize}
\end{DoxyItemize}
\item B -\/ Supporting up to four total of I2C and/or SPI
\begin{DoxyItemize}
\item B0 \mbox{[}SPI\mbox{]}\+:
\begin{DoxyItemize}
\item SD Card
\item GPS Receiver (Maxim Integrated ‎\+MAX2771\+ETI+T)
\end{DoxyItemize}
\item B1 \mbox{[}SPI\mbox{]}\+:
\begin{DoxyItemize}
\item Bluetooth/\+Wi-\/\+Fi (Espressif Systems ESP32-\/\+WROVER-\/\+IE (8MB))
\end{DoxyItemize}
\item B2 \mbox{[}I2C\mbox{]}\+:
\begin{DoxyItemize}
\item Inertial Measurement Unit (TDK Inven\+Sense ICM-\/20600)
\item Real-\/\+Time Clock/\+Calendar (Microchip Technology ‎\+MCP7940\+MT-\/\+I/\+SN)
\end{DoxyItemize}
\end{DoxyItemize}
\end{DoxyItemize}
The thinking behind this so far, is to try and balance the load between the modules with SPI protocol being used in more high data-\/rate peripherals and I2C used with lower or less-\/used peripherals. \hypertarget{deviceSpecifications}{}\doxysection{Device Specifications}\label{deviceSpecifications}
\hypertarget{device_specifications_autotoc_md4}{}\doxysubsubsection{Microcontroller\+: Texas Instruments MSP430\+F5438\+AIPZR}\label{device_specifications_autotoc_md4}
\begin{DoxyItemize}
\item 1.\+8 V to 3.\+6 V Supply Voltage
@@ -45,7 +88,7 @@
\item 14 external channels
\end{DoxyItemize}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md3}{}\doxysubsubsection{Real-\/\+Time Clock/\+Calendar\+: Microchip Technology ‎\+MCP7940\+MT-\/\+I/\+SN}\label{device_specifications_autotoc_md3}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md5}{}\doxysubsubsection{Real-\/\+Time Clock/\+Calendar\+: Microchip Technology ‎\+MCP7940\+MT-\/\+I/\+SN}\label{device_specifications_autotoc_md5}
\begin{DoxyItemize}
\item 1.\+8 V to 5.\+5 V Supply Voltage
@@ -53,28 +96,48 @@
\begin{DoxyItemize}
\item I2C
\begin{DoxyItemize}
\item Slave only
\item Clock rate up to 400 k\+Hz
\end{DoxyItemize}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md4}{}\doxysubsubsection{Bluetooth/\+Wi-\/\+Fi\+: Espressif Systems ESP32-\/\+WROVER-\/\+IE (8\+MB)}\label{device_specifications_autotoc_md4}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md6}{}\doxysubsubsection{Bluetooth/\+Wi-\/\+Fi\+: Espressif Systems ESP32-\/\+WROVER-\/\+IE (8\+MB)}\label{device_specifications_autotoc_md6}
\begin{DoxyItemize}
\item 3.\+0 V to 3.\+6 V Supply Voltage
\item Notable Peripherals\+:
\begin{DoxyItemize}
\item I2C
\item SPI
\item UART
\item I2C (2)
\begin{DoxyItemize}
\item Master or Slave
\item 100 kbit/s or 400 kbit/s
\item 7-\/bit/10-\/bit addressing mode
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md5}{}\doxysubsubsection{GPS Receiver\+: Maxim Integrated ‎\+MAX2771\+ETI+T}\label{device_specifications_autotoc_md5}
\item SPI
\begin{DoxyItemize}
\item SPI, HSPI and VSPI
\item Master or Slave
\item 1-\/line full-\/duplex and 1/2/4-\/line half-\/duplex
\item Up to 80 MHz
\item Up to 64-\/byte FIFO
\end{DoxyItemize}
\item UART (3)
\begin{DoxyItemize}
\item Up to 5 Mbps
\end{DoxyItemize}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md7}{}\doxysubsubsection{GPS Receiver\+: Maxim Integrated ‎\+MAX2771\+ETI+T}\label{device_specifications_autotoc_md7}
\begin{DoxyItemize}
\item 2.\+7 V to 3.\+3 V Supply Voltage
\item Notable Peripherals\+:
\begin{DoxyItemize}
\item SPI
\begin{DoxyItemize}
\item Slave only
\item Need to calculate frequency
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md6}{}\doxysubsubsection{CANbus Controller\+: Microchip Technology MCP2515\+T-\/\+I/\+SO}\label{device_specifications_autotoc_md6}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md8}{}\doxysubsubsection{CANbus Controller\+: Microchip Technology MCP2515\+T-\/\+I/\+SO}\label{device_specifications_autotoc_md8}
\begin{DoxyItemize}
\item 2.\+7 V to 5.\+5 V Supply Voltage
@@ -82,15 +145,16 @@
\begin{DoxyItemize}
\item SPI
\begin{DoxyItemize}
\item Slave (Assuming only option)
\item 10 MHz
\end{DoxyItemize}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md7}{}\doxysubsubsection{CAN Bus Transceiver\+: ‎\+Microchip Technology MCP2542\+FD-\/\+H/\+SN}\label{device_specifications_autotoc_md7}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md9}{}\doxysubsubsection{CANbus Transceiver\+: ‎\+Microchip Technology MCP2542\+FD-\/\+H/\+SN}\label{device_specifications_autotoc_md9}
\begin{DoxyItemize}
\item 4.\+5 V to 5.\+5 V Supply Voltage
\item Used directly with CANbus Controller
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md8}{}\doxysubsubsection{SD Card (\+Generic)}\label{device_specifications_autotoc_md8}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md10}{}\doxysubsubsection{SD Card (\+Generic)}\label{device_specifications_autotoc_md10}
\begin{DoxyItemize}
\item 2.\+7 V to 3.\+6 V Supply Voltage
@@ -98,12 +162,20 @@
\begin{DoxyItemize}
\item SPI
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md9}{}\doxysubsubsection{USB to UART Bridge\+: FTDI ‎‎\+FT260\+Q-\/T}\label{device_specifications_autotoc_md9}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md11}{}\doxysubsubsection{USB to UART Bridge\+: Future Technology Devices International FT230\+XS-\/R}\label{device_specifications_autotoc_md11}
\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_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}
\item 3 V to 5 V Supply Voltage
\item Notable Peripherals\+:
\begin{DoxyItemize}
\item UART
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md12}{}\doxysubsubsection{RS-\/232 Transceiver\+: STMicroelectronics ST232\+CDR}\label{device_specifications_autotoc_md12}
\begin{DoxyItemize}
\item 4.\+5 V to 5.\+5 V Supply Voltage
\item Will use UART from the MCU
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md13}{}\doxysubsubsection{Inertial Measurement Unit\+: TDK Inven\+Sense ICM-\/20600}\label{device_specifications_autotoc_md13}
\begin{DoxyItemize}
\item 1.\+71 V to 3.\+45 V Supply Voltage
@@ -111,12 +183,13 @@
\begin{DoxyItemize}
\item I2C
\begin{DoxyItemize}
\item Slave only
\item 400 k\+Hz
\end{DoxyItemize}
\item SPI
\begin{DoxyItemize}
\item Slave only
\item 10 MHz
\end{DoxyItemize}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{layoutPlanning}{}\doxysection{Layout Planning}\label{layoutPlanning}
\hypertarget{layout_planning_autotoc_md12}{}\doxysubsubsection{Microcontroller}\label{layout_planning_autotoc_md12}
\end{DoxyItemize}

20
Documentation/latex/index.tex
View File

@@ -1,12 +1,3 @@
{\bfseries{Subpages}}
\begin{DoxyItemize}
\item \mbox{\hyperlink{hardware}{Hardware}}
\item \mbox{\hyperlink{software}{Software}}
\end{DoxyItemize}
\DoxyHorRuler{0}
\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.
@@ -28,10 +19,19 @@ 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
\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
\item He said that he is available himself for anything power-\/related to help out with if needed
\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.
\item \mbox{[} \mbox{]} Ensure the footprint for CANbus Transceiver is present, since it\textquotesingle{}s not available in Altium by default, and the import from Ultra Librarian seemed to only successfully add the schematic and 3D Model, but wasn\textquotesingle{}t sure about footprint.
\item \mbox{[} \mbox{]} The CANbus Controller required a resonator/oscillator and capacitor pair to be picked, but non-\/optimized values were given and so we need to test which resonator/oscillator and capacitor pair works best.
\item \mbox{[} \mbox{]} Need to look through Sunseeker documentation to learn how they have their CANbus setup, ensuring we have our controller and transceiver setup correctly.
\end{DoxyItemize}

9
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}
@@ -185,19 +185,14 @@
\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}
\input{_9_hardware_8markdown}
\input{_design_01_choices_8markdown}
\input{_device_01_specifications_8markdown}
\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 ---

2667
Doxyfile.doxygen Normal file
View File

File diff suppressed because it is too large Load Diff

3
Hardware/!Hardware.markdown
View File

@@ -4,7 +4,6 @@
- @subpage designChoices
- @subpage deviceSpecifications
- @subpage layoutPlanning
---
@@ -17,4 +16,4 @@
- Keep the trace between the device and the crystal as short as possible.
- Design a good ground plane around the oscillator pins.
- Prevent crosstalk from other clock or data lines into oscillator pins XIN and XOUT.
- Avoid running PCB traces underneath or adjacent to the XIN and XOUT pins.
- Avoid running PCB traces underneath or adjacent to the XIN and XOUT pins.

2858
Hardware/AltiumProject/2020-2021 Telemetry and Lighting Board/2020-2021 Telemetry and Lighting Board.PrjPcb
View File

File diff suppressed because it is too large Load Diff

BIN
Hardware/AltiumProject/2020-2021 Telemetry and Lighting Board/Light.SchDoc
View File

Binary file not shown.

2
Hardware/AltiumProject/2020-2021 Telemetry and Lighting Board/MCU_JTAG.Harness
View File

@@ -1 +1 @@
MCU_JTAG=MCU_JTAG_TDO,MCU_JTAG_TDI,MCU_JTAG_TMS,MCU_JTAG_TCK,MCU_JTAG_R\S\T\,MCU_JTAG_TEST,MCU_JTAG_VCCTOOL
MCU_JTAG=TDO,TDI,TMS,TCK,R\S\T\,TEST,VCCTOOL

BIN
Hardware/AltiumProject/2020-2021 Telemetry and Lighting Board/MCU_JTAG.SchDoc
View File

Binary file not shown.

BIN
Hardware/AltiumProject/2020-2021 Telemetry and Lighting Board/Main.SchDoc
View File

Binary file not shown.

6
Hardware/AltiumProject/2020-2021 Telemetry and Lighting Board/__Previews/MCU_JTAG.SchDocPreview
View File

File diff suppressed because one or more lines are too long

10
Hardware/AltiumProject/2020-2021 Telemetry and Lighting Board/__Previews/Main.SchDocPreview
View File

File diff suppressed because one or more lines are too long

18
Hardware/AltiumProject/2020-2021 Telemetry and Lighting Board/__Previews/Sheet1.SchDocPreview
View File

File diff suppressed because one or more lines are too long

39
Hardware/Design Choices.markdown
View File

@@ -4,3 +4,42 @@
When connecting the MCU to the programmer via the JTAG interface, it is possible for a local power supply connected to the MCU to be used or for power from the debugging/programming adapter to be used. Since having power supplied to the MCU from the debugging/programming adapter can be useful for use outside of the Sunseeker vehicle, we chose to use that.
# Microcontroller Connections
The board is going to be organized to the best of our abilities to be organized as such:
- Left Side:
- Peripherals for communicating with/controlling the Sunseeker vehicle
- Right Side:
- Peripherals for communicating with users
#### Universal Serial Communication Interfaces (USCIs):
- A - Supporting up to four total of UART and/or SPI
- A0 [SPI]:
- CANbus Controller 0 (Microchip Technology MCP2515T-I/SO)
- CANbus Controller 1 (Microchip Technology MCP2515T-I/SO)
- A1:
- A2 [UART]:
- USB to UART Bridge (Future Technology Devices International FT230XS-R)
- A3 [UART]:
- RS-232 Transceiver (STMicroelectronics ST232CDR)
- B - Supporting up to four total of I2C and/or SPI
- B0 [SPI]:
- SD Card
- GPS Receiver (Maxim Integrated ‎MAX2771ETI+T)
- B1 [I2C]:
- Inertial Measurement Unit (TDK InvenSense ICM-20600)
- Real-Time Clock/Calendar (Microchip Technology ‎MCP7940MT-I/SN)
- B2:
- B3 [SPI]:
- Bluetooth/Wi-Fi (Espressif Systems ESP32-WROVER-IE (8MB))
In addition to trying to keep the MCU and PCB organized with the left-side being to do with the Sunseeker vehicle and the right side to be peripherals interacting with users, we tried to also load-balance the USCI modules, as well as have the SPI protocol be used in more high data-rate peripherals and I2C used with lower or less-used peripherals. In Texas Instruments SLAS655G Document [Page 7] has a pin diagram showing the physical location of where each pin is physically located.

15
Hardware/Device Specifications.markdown
View File

@@ -66,7 +66,7 @@
## CAN Bus Transceiver: ‎Microchip Technology MCP2542FD-H/SN
## CANbus Transceiver: ‎Microchip Technology MCP2542FD-H/SN
- 4.5 V to 5.5 V Supply Voltage
- Used directly with CANbus Controller
@@ -81,15 +81,18 @@
## USB to UART Bridge: FTDI ‎‎FT260Q-T
## USB to UART Bridge: Future Technology Devices International FT230XS-R
- We will use a "Bus-Powered Configuration", requiring the host device to supply power, that way we don't have to.
- 3 V to 5 V Supply Voltage
- Notable Peripherals:
- UART
## RS-232 Transceiver: Texas Instruments GD75232PWR
## RS-232 Transceiver: STMicroelectronics ST232CDR
- 4.5 V to 5.5 V Supply Voltage
- Will use UART from the MCU
@@ -98,7 +101,9 @@
- 1.71 V to 3.45 V Supply Voltage
- Notable Peripherals:
- I2C
- Slave only
- 400 kHz
- SPI
- Slave only
- 10 MHz

15
Meta/Documentation Guide.markdown
View File

@@ -33,3 +33,18 @@ You need to have installed the program from either the GitHub page or website, t
"documentationGuide" is the name/tag used internally by doxygen.
"Documentation Guide" is what shows up on the output documentation.
## Adding Images
Use this pattern/format:
@code
@image html "Documentation Guide.assets/Funny-Cat-Hidden.jpg"
@cond EXCLUDED
![img](Documentation Guide.assets/Funny-Cat-Hidden.jpg)
@endcond
@endcode
Which will output a single image that is both easily viewable in Doxygen, as well as Markdown viewers/editors.
@cond EXCLUDED
**Note: if you are reading this in a Markdown/text editor, do not include the '@code' and '@endcode' lines! Those are just to present it nicely for those reading in Doxygen pages. Please also switch to view the source code view if not already, that way you can see the code for the Markdown image.**
@endcond

28
README.markdown
View File

@@ -1,14 +1,4 @@
@mainpage
@b Subpages
- @subpage hardware
- @subpage software
---
@mainpage Home
# About
@@ -40,6 +30,8 @@ More information here: @ref documentationGuide "Documentation Guide"
- Document things as we go
- Need to make sure we have a BOM
- Free samples for parts from manufacturers
- Make peripherals like output on one side and inputs on the other
- Use SPI Chip Select as a separate command (Use 3-pin SPI and then just use GPIO for Chip Select)
@@ -50,3 +42,17 @@ More information here: @ref documentationGuide "Documentation Guide"
- He said that he is available himself for anything power-related to help out with if needed
# TODO List
- [ ] Make battery circuitry for Real-Time Clock/Calendar for when the vehicle is off.
- [ ] Ensure the footprint for CANbus Transceiver is present, since it's not available in Altium by default, and the import from Ultra Librarian seemed to only successfully add the schematic and 3D Model, but wasn't sure about footprint.
- [ ] The CANbus Controller required a resonator/oscillator and capacitor pair to be picked, but non-optimized values were given and so we need to test which resonator/oscillator and capacitor pair works best.
- [ ] Need to look through Sunseeker documentation to learn how they have their CANbus setup, ensuring we have our controller and transceiver setup correctly.

36
Resources/!Resources.markdown Normal file
View File

@@ -0,0 +1,36 @@
@page resources Resources
@b Subpages
- @subpage microcontroller Microcontroller
---
# Altium Designer
## Learning Resources
- [Official YouTube Series](https://www.youtube.com/watch?v=HZIjYeVJXeU&list=PL3aaAq2OJU5H_V1wJfcxn9RtUf2hs2FU6)
## Importing Schematics/Footprints/3D Models
- [Instructional YouTube Video](https://www.youtube.com/watch?v=6h-Z_NJibI8)
## Tips
- Altium seems to crash upon saving, most likely due to file names/paths being too long, and it not knowing how to handle it, then crashing.
- Whitespace characters seem to be safe to use in your file paths.
# Texas Instruments MSP430 Universal Clock System (UCS)
- [High-level Introductory Video](https://www.youtube.com/watch?v=b4PEmSDZml4)