Added main README.markdown to included files list in doxygen

This commit is contained in:
William Miceli
2021-01-26 12:59:48 -05:00
parent 7966cf0e14
commit d9b4e5cfe2
65 changed files with 2517 additions and 7 deletions

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>Sunseeker Telemetry and Lighting System: Main Page</title>
<title>Sunseeker Telemetry and Lighting System: ECE4810-Fall2020-SunseekerTelemetry</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>
@@ -80,11 +80,40 @@ $(document).ready(function(){initNavTree('index.html',''); initResizable(); });
</iframe>
</div>
<div class="header">
<div class="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">Sunseeker Telemetry and Lighting System Documentation</div> </div>
<div class="title">ECE4810-Fall2020-SunseekerTelemetry </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p><a class="anchor" id="md_README"></a></p>
<h1><a class="anchor" id="autotoc_md14"></a>
Documentation</h1>
<p>For Documentation, we will use "doxygen" to easily create documentation pages for the project. This will be accessible in a variety of means, but primarily through HTML pages accessible through a browser, covering all aspects of the project.</p>
<h2><a class="anchor" id="autotoc_md15"></a>
Tips from Dr. Bazuin</h2>
<ul>
<li>Make sub-circuits/sub-designs for schematics to keep things organized and modular/copy-able</li>
<li>We can sit-in on Sunseeker meetings</li>
<li>Need higher voltage for Lights from the supplied voltage of CANbus</li>
<li>Connecting crystal oscillators to MCU</li>
<li>A-213/A-216? has some power conversion example boards</li>
<li>Will Beringer(?) has schematics of DC-DC converters</li>
<li>MCU - Test pins need to be connected for JTAG interface</li>
<li>MCU - Have switch to short !RST pin on MCU with capacitors to allow the MCU to reset</li>
<li>MCU - Oth port LED toggle</li>
<li>MCU - Setup clock system with using SLAU208Q, page 161</li>
<li>MCU - UART on SLAU208Q, page 939</li>
<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>
</ul>
<h2><a class="anchor" id="autotoc_md16"></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>
</ul>
</div></div><!-- PageDoc -->
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->