Updated Docs
This commit is contained in:
@@ -91,14 +91,14 @@ $(document).ready(function(){initNavTree('index.html',''); initResizable(); });
|
||||
<li><a class="el" href="software.html">Software</a></li>
|
||||
</ul>
|
||||
<hr />
|
||||
<h1><a class="anchor" id="autotoc_md14"></a>
|
||||
<h1><a class="anchor" id="autotoc_md15"></a>
|
||||
About</h1>
|
||||
<p>What this project is about (TODO)</p>
|
||||
<h1><a class="anchor" id="autotoc_md15"></a>
|
||||
<h1><a class="anchor" id="autotoc_md16"></a>
|
||||
Documentation</h1>
|
||||
<p>For Documentation, we will use "doxygen" to easily create documentation pages for the project. This will be accessible in a variety of means, but primarily through HTML pages accessible through a browser, covering all aspects of the project.</p>
|
||||
<p>More information here: <a class="el" href="documentation_guide.html">Documentation Guide</a></p>
|
||||
<h2><a class="anchor" id="autotoc_md16"></a>
|
||||
<h2><a class="anchor" id="autotoc_md17"></a>
|
||||
Tips from Dr. Bazuin</h2>
|
||||
<ul>
|
||||
<li>Make sub-circuits/sub-designs for schematics to keep things organized and modular/copy-able</li>
|
||||
@@ -116,12 +116,20 @@ Tips from Dr. Bazuin</h2>
|
||||
<li>Need to make sure we have a BOM</li>
|
||||
<li>Free samples for parts from manufacturers</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" id="autotoc_md17"></a>
|
||||
<h2><a class="anchor" id="autotoc_md18"></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_md19"></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 +137,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 Tue Feb 2 2021 00:44:35 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
Reference in New Issue
Block a user