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

Added main README.markdown to included files list in doxygen

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -0,0 +1,2 @@
\hypertarget{_device_01_specifications_8markdown}{}\doxysection{Hardware/\+Device Specifications.\+markdown File Reference}
\label{_device_01_specifications_8markdown}\index{Hardware/Device Specifications.markdown@{Hardware/Device Specifications.markdown}}

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

@@ -0,0 +1,2 @@
\hypertarget{_layout_01_planning_8markdown}{}\doxysection{Hardware/\+Layout Planning.\+markdown File Reference}
\label{_layout_01_planning_8markdown}\index{Hardware/Layout Planning.markdown@{Hardware/Layout Planning.markdown}}

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

@@ -0,0 +1,2 @@
\hypertarget{_r_e_a_d_m_e_8markdown}{}\doxysection{README.\+markdown File Reference}
\label{_r_e_a_d_m_e_8markdown}\index{README.markdown@{README.markdown}}

7
Documentation/latex/dir_4e9c05acfa2c3671b8618fcb95d57d96.tex Normal file
View File

@@ -0,0 +1,7 @@
\hypertarget{dir_4e9c05acfa2c3671b8618fcb95d57d96}{}\doxysection{Software Directory Reference}
\label{dir_4e9c05acfa2c3671b8618fcb95d57d96}\index{Software Directory Reference@{Software Directory Reference}}
\doxysubsection*{Directories}
\begin{DoxyCompactItemize}
\item
directory \mbox{\hyperlink{dir_70428d3c5958c16802133545478a5cfb}{Code Composer Studio Workspace}}
\end{DoxyCompactItemize}

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

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

7
Documentation/latex/dir_70428d3c5958c16802133545478a5cfb.tex Normal file
View File

@@ -0,0 +1,7 @@
\hypertarget{dir_70428d3c5958c16802133545478a5cfb}{}\doxysection{Software/\+Code Composer Studio Workspace Directory Reference}
\label{dir_70428d3c5958c16802133545478a5cfb}\index{Software/Code Composer Studio Workspace Directory Reference@{Software/Code Composer Studio Workspace Directory Reference}}
\doxysubsection*{Directories}
\begin{DoxyCompactItemize}
\item
directory \mbox{\hyperlink{dir_ef94255a62432ae865475b379d8bd501}{Sunseeker\+Telemetry\+And\+Lighting\+System}}
\end{DoxyCompactItemize}

7
Documentation/latex/dir_ef94255a62432ae865475b379d8bd501.tex Normal file
View File

@@ -0,0 +1,7 @@
\hypertarget{dir_ef94255a62432ae865475b379d8bd501}{}\doxysection{Software/\+Code Composer Studio Workspace/\+Sunseeker\+Telemetry\+And\+Lighting\+System Directory Reference}
\label{dir_ef94255a62432ae865475b379d8bd501}\index{Software/Code Composer Studio Workspace/SunseekerTelemetryAndLightingSystem Directory Reference@{Software/Code Composer Studio Workspace/SunseekerTelemetryAndLightingSystem Directory Reference}}
\doxysubsection*{Files}
\begin{DoxyCompactItemize}
\item
file \mbox{\hyperlink{main_8c}{main.\+c}}
\end{DoxyCompactItemize}

4
Documentation/latex/files.tex Normal file
View File

@@ -0,0 +1,4 @@
\doxysection{File List}
Here is a list of all files with brief descriptions\+:\begin{DoxyCompactList}
\item\contentsline{section}{Software/\+Code Composer Studio Workspace/\+Sunseeker\+Telemetry\+And\+Lighting\+System/\mbox{\hyperlink{main_8c}{main.\+c}} }{\pageref{main_8c}}{}
\end{DoxyCompactList}

26
Documentation/latex/index.tex Normal file
View File

@@ -0,0 +1,26 @@
\label{index_md_README}%
\Hypertarget{index_md_README}%
\hypertarget{index_autotoc_md14}{}\doxysection{Documentation}\label{index_autotoc_md14}
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.\hypertarget{index_autotoc_md15}{}\doxysubsection{Tips from Dr. Bazuin}\label{index_autotoc_md15}
\begin{DoxyItemize}
\item Make sub-\/circuits/sub-\/designs for schematics to keep things organized and modular/copy-\/able
\item We can sit-\/in on Sunseeker meetings
\item Need higher voltage for Lights from the supplied voltage of CANbus
\item Connecting crystal oscillators to MCU
\item A-\/213/\+A-\/216? has some power conversion example boards
\item Will Beringer(?) has schematics of DC-\/\+DC converters
\item MCU -\/ Test pins need to be connected for JTAG interface
\item MCU -\/ Have switch to short !\+RST pin on MCU with capacitors to allow the MCU to reset
\item MCU -\/ Oth port LED toggle
\item MCU -\/ Setup clock system with using SLAU208Q, page 161
\item MCU -\/ UART on SLAU208Q, page 939
\item Document things as we go
\item Need to make sure we have a BOM
\item Free samples for parts from manufacturers
\end{DoxyItemize}\hypertarget{index_autotoc_md16}{}\doxysubsection{Tips from Dr. Gomez}\label{index_autotoc_md16}
\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
\end{DoxyItemize}

21
Documentation/latex/main_8c.tex Normal file
View File

@@ -0,0 +1,21 @@
\hypertarget{main_8c}{}\doxysection{Software/\+Code Composer Studio Workspace/\+Sunseeker\+Telemetry\+And\+Lighting\+System/main.c File Reference}
\label{main_8c}\index{Software/Code Composer Studio Workspace/SunseekerTelemetryAndLightingSystem/main.c@{Software/Code Composer Studio Workspace/SunseekerTelemetryAndLightingSystem/main.c}}
{\ttfamily \#include $<$msp430.\+h$>$}\newline
\doxysubsection*{Functions}
\begin{DoxyCompactItemize}
\item
int \mbox{\hyperlink{main_8c_a840291bc02cba5474a4cb46a9b9566fe}{main}} (void)
\end{DoxyCompactItemize}
\doxysubsection{Function Documentation}
\mbox{\Hypertarget{main_8c_a840291bc02cba5474a4cb46a9b9566fe}\label{main_8c_a840291bc02cba5474a4cb46a9b9566fe}}
\index{main.c@{main.c}!main@{main}}
\index{main@{main}!main.c@{main.c}}
\doxysubsubsection{\texorpdfstring{main()}{main()}}
{\footnotesize\ttfamily int main (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}
\mbox{\hyperlink{main_8c}{main.\+c}}
Definition at line 7 of file main.\+c.

98
Documentation/latex/md__hardware__device__specifications.tex Normal file
View File

@@ -0,0 +1,98 @@
\hypertarget{md__hardware__device__specifications_autotoc_md1}{}\doxysection{Microcontroller\+: Texas Instruments MSP430\+F5438\+AIPZR}\label{md__hardware__device__specifications_autotoc_md1}
\begin{DoxyItemize}
\item 1.\+8 V to 3.\+6 V Supply Voltage
\item Capabilities\+:
\begin{DoxyItemize}
\item 16-\/bit architecture
\item 25 MHz System Clock
\end{DoxyItemize}
\item Notable Peripherals\+:
\begin{DoxyItemize}
\item Up to 4 of\+:
\begin{DoxyItemize}
\item UART/\+SPI
\end{DoxyItemize}
\item Up to 4 of\+:
\begin{DoxyItemize}
\item I2\+C/\+SPI
\end{DoxyItemize}
\item 12-\/bit ADC
\begin{DoxyItemize}
\item 14 external channels
\end{DoxyItemize}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_autotoc_md2}{}\doxysection{Real-\/\+Time Clock/\+Calendar\+: Microchip Technology ‎\+MCP7940\+MT-\/\+I/\+SN}\label{md__hardware__device__specifications_autotoc_md2}
\begin{DoxyItemize}
\item 1.\+8 V to 5.\+5 V Supply Voltage
\item Notable Peripherals\+:
\begin{DoxyItemize}
\item I2C
\begin{DoxyItemize}
\item Clock rate up to 400 k\+Hz
\end{DoxyItemize}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_autotoc_md3}{}\doxysection{Bluetooth/\+Wi-\/\+Fi\+: Espressif Systems ESP32-\/\+WROVER-\/\+IE (8\+MB)}\label{md__hardware__device__specifications_autotoc_md3}
\begin{DoxyItemize}
\item 3.\+0 V to 3.\+6 V Supply Voltage
\item Notable Peripherals\+:
\begin{DoxyItemize}
\item I2C
\item SPI
\item UART
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_autotoc_md4}{}\doxysection{GPS Receiver\+: Maxim Integrated ‎\+MAX2771\+ETI+T}\label{md__hardware__device__specifications_autotoc_md4}
\begin{DoxyItemize}
\item 2.\+7 V to 3.\+3 V Supply Voltage
\item Notable Peripherals\+:
\begin{DoxyItemize}
\item SPI
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_autotoc_md5}{}\doxysection{CANbus Controller\+: Microchip Technology MCP2515\+T-\/\+I/\+SO}\label{md__hardware__device__specifications_autotoc_md5}
\begin{DoxyItemize}
\item 2.\+7 V to 5.\+5 V Supply Voltage
\item Notable Peripherals\+:
\begin{DoxyItemize}
\item SPI
\begin{DoxyItemize}
\item 10 MHz
\end{DoxyItemize}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_autotoc_md6}{}\doxysection{CAN Bus Transceiver\+: ‎\+Microchip Technology MCP2542\+FD-\/\+H/\+SN}\label{md__hardware__device__specifications_autotoc_md6}
\begin{DoxyItemize}
\item 4.\+5 V to 5.\+5 V Supply Voltage
\item Used directly with CANbus Controller
\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_autotoc_md7}{}\doxysection{SD Card (\+Generic)}\label{md__hardware__device__specifications_autotoc_md7}
\begin{DoxyItemize}
\item 2.\+7 V to 3.\+6 V Supply Voltage
\item Notable Peripherals\+:
\begin{DoxyItemize}
\item SPI
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_autotoc_md8}{}\doxysection{USB to UART Bridge\+: FTDI ‎‎\+FT260\+Q-\/T}\label{md__hardware__device__specifications_autotoc_md8}
\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{md__hardware__device__specifications_autotoc_md9}{}\doxysection{RS-\/232 Transceiver\+: Texas Instruments GD75232\+PWR}\label{md__hardware__device__specifications_autotoc_md9}
\hypertarget{md__hardware__device__specifications_autotoc_md10}{}\doxysection{Inertial Measurement Unit\+: TDK Inven\+Sense ICM-\/20600}\label{md__hardware__device__specifications_autotoc_md10}
\begin{DoxyItemize}
\item 1.\+71 V to 3.\+45 V Supply Voltage
\item Notable Peripherals\+:
\begin{DoxyItemize}
\item I2C
\begin{DoxyItemize}
\item 400 k\+Hz
\end{DoxyItemize}
\item SPI
\begin{DoxyItemize}
\item 10 MHz
\end{DoxyItemize}
\end{DoxyItemize}
\end{DoxyItemize}

1
Documentation/latex/md__hardware__layout__planning.tex Normal file
View File

@@ -0,0 +1 @@
\hypertarget{md__hardware__layout__planning_autotoc_md12}{}\doxysection{Microcontroller}\label{md__hardware__layout__planning_autotoc_md12}

17
Documentation/latex/refman.tex
View File

@@ -171,6 +171,23 @@
\hypersetup{pageanchor=true}
%--- Begin generated contents ---
\chapter{ECE4810-\/\+Fall2020-\/\+Sunseeker\+Telemetry}
\label{index}\hypertarget{index}{}\input{index}
\chapter{Device Specifications}
\label{md__hardware__device__specifications}
\Hypertarget{md__hardware__device__specifications}
\input{md__hardware__device__specifications}
\chapter{Layout Planning}
\label{md__hardware__layout__planning}
\Hypertarget{md__hardware__layout__planning}
\input{md__hardware__layout__planning}
\chapter{File Index}
\input{files}
\chapter{File Documentation}
\input{_device_01_specifications_8markdown}
\input{_layout_01_planning_8markdown}
\input{_r_e_a_d_m_e_8markdown}
\input{main_8c}
%--- End generated contents ---
% Index