Documentation mostly working as desired. Good enough for now. Added some topics.
This commit is contained in:
2
Documentation/latex/_9_hardware_8markdown.tex
Normal file
2
Documentation/latex/_9_hardware_8markdown.tex
Normal file
@@ -0,0 +1,2 @@
|
||||
\hypertarget{_9_hardware_8markdown}{}\doxysection{Hardware/!\+Hardware.markdown File Reference}
|
||||
\label{_9_hardware_8markdown}\index{Hardware/"!Hardware.markdown@{Hardware/"!Hardware.markdown}}
|
||||
2
Documentation/latex/_9_software_8markdown.tex
Normal file
2
Documentation/latex/_9_software_8markdown.tex
Normal file
@@ -0,0 +1,2 @@
|
||||
\hypertarget{_9_software_8markdown}{}\doxysection{Software/!\+Software.markdown File Reference}
|
||||
\label{_9_software_8markdown}\index{Software/"!Software.markdown@{Software/"!Software.markdown}}
|
||||
@@ -0,0 +1,2 @@
|
||||
\hypertarget{_device_01_specifications_test3_8markdown}{}\doxysection{Hardware/\+Device Specifications\+Test3.\+markdown File Reference}
|
||||
\label{_device_01_specifications_test3_8markdown}\index{Hardware/Device SpecificationsTest3.markdown@{Hardware/Device SpecificationsTest3.markdown}}
|
||||
@@ -0,0 +1,2 @@
|
||||
\hypertarget{_documentation_01_guide_8markdown}{}\doxysection{Meta/\+Documentation Guide.\+markdown File Reference}
|
||||
\label{_documentation_01_guide_8markdown}\index{Meta/Documentation Guide.markdown@{Meta/Documentation Guide.markdown}}
|
||||
@@ -0,0 +1,2 @@
|
||||
\hypertarget{dir_7795a02a4813dcd036f04e5f7854f185}{}\doxysection{Meta Directory Reference}
|
||||
\label{dir_7795a02a4813dcd036f04e5f7854f185}\index{Meta Directory Reference@{Meta Directory Reference}}
|
||||
19
Documentation/latex/documentation_guide.tex
Normal file
19
Documentation/latex/documentation_guide.tex
Normal file
@@ -0,0 +1,19 @@
|
||||
\hypertarget{documentation_guide_autotoc_md17}{}\doxysection{Doxygen}\label{documentation_guide_autotoc_md17}
|
||||
The program called \char`\"{}doxygen\char`\"{} (\href{https://github.com/doxygen/doxygen}{\texttt{ Git\+Hub Page}} and \href{https://www.doxygen.nl/}{\texttt{ Website}}) is what we\textquotesingle{}re using to document our project and try to make things a bit simpler/easier not only for us, but also future projects or people looking at what we\textquotesingle{}ve done.
|
||||
|
||||
It simply uses a small configuration file at the root of the project {\ttfamily /\+Doxyfile} to store some settings, and the rest is through mainly Markdown files ({\ttfamily .md} or {\ttfamily .markdown}) and source code files.
|
||||
|
||||
It is setup (as of writing this) that someone can simply open the {\ttfamily /\+Doxyfile} in the GUI Wizard, click on the \char`\"{}\+Run\char`\"{} tab, then \char`\"{}\+Run doxygen\char`\"{}, and everything will be updated... that\textquotesingle{}s it.\hypertarget{documentation_guide_autotoc_md18}{}\doxysection{Updating Documentation}\label{documentation_guide_autotoc_md18}
|
||||
You need to have installed the program from either the Git\+Hub page or website, then simply open the {\ttfamily /\+Doxyfile} within the GUI frontend or \char`\"{}\+Wizard\char`\"{}.\hypertarget{documentation_guide_autotoc_md19}{}\doxysection{Important Notes}\label{documentation_guide_autotoc_md19}
|
||||
|
||||
\begin{DoxyItemize}
|
||||
\item Make sure that the {\ttfamily /\+Doxyfile} stays where it\textquotesingle{}s at! It should be kept at the root directory (just to keep things simple)
|
||||
\item Make sure you use RELATIVE paths when changing configurations, or else when someone else tries running the {\ttfamily /\+Doxyfile}, they\textquotesingle{}ll have to re-\/do all of them in order for it to start functioning again.
|
||||
\end{DoxyItemize}\hypertarget{documentation_guide_autotoc_md20}{}\doxysubsection{For Consistency}\label{documentation_guide_autotoc_md20}
|
||||
|
||||
\begin{DoxyItemize}
|
||||
\item Please make sure the internal names of files are using \char`\"{}camel\+Case\char`\"{}
|
||||
\begin{DoxyItemize}
|
||||
\item Example\+: for \char`\"{}@page documentation\+Guide Documentation Guide\char`\"{} \char`\"{}documentation\+Guide\char`\"{} is the name used internally by doxygen. \char`\"{}\+Documentation Guide\char`\"{} is what shows up on the output documentation.
|
||||
\end{DoxyItemize}
|
||||
\end{DoxyItemize}
|
||||
1
Documentation/latex/documentation_guide1.tex
Normal file
1
Documentation/latex/documentation_guide1.tex
Normal file
@@ -0,0 +1 @@
|
||||
\hypertarget{documentation_guide1_autotoc_md17}{}\doxysection{Test}\label{documentation_guide1_autotoc_md17}
|
||||
109
Documentation/latex/hardware.tex
Normal file
109
Documentation/latex/hardware.tex
Normal file
@@ -0,0 +1,109 @@
|
||||
{\bfseries{Subpages}}
|
||||
|
||||
|
||||
\begin{DoxyItemize}
|
||||
\item \mbox{\hyperlink{deviceSpecifications}{Device Specifications}}
|
||||
\item \mbox{\hyperlink{layoutPlanning}{Layout Planning}}
|
||||
\end{DoxyItemize}
|
||||
|
||||
\DoxyHorRuler{0}
|
||||
\hypertarget{deviceSpecifications}{}\doxysection{Device Specifications}\label{deviceSpecifications}
|
||||
\hypertarget{device_specifications_autotoc_md1}{}\doxysubsubsection{Microcontroller\+: Texas Instruments MSP430\+F5438\+AIPZR}\label{device_specifications_autotoc_md1}
|
||||
|
||||
\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{device_specifications_autotoc_md2}{}\doxysubsubsection{Real-\/\+Time Clock/\+Calendar\+: Microchip Technology \+MCP7940\+MT-\/\+I/\+SN}\label{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{device_specifications_autotoc_md3}{}\doxysubsubsection{Bluetooth/\+Wi-\/\+Fi\+: Espressif Systems ESP32-\/\+WROVER-\/\+IE (8\+MB)}\label{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{device_specifications_autotoc_md4}{}\doxysubsubsection{GPS Receiver\+: Maxim Integrated \+MAX2771\+ETI+T}\label{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{device_specifications_autotoc_md5}{}\doxysubsubsection{CANbus Controller\+: Microchip Technology MCP2515\+T-\/\+I/\+SO}\label{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{device_specifications_autotoc_md6}{}\doxysubsubsection{CAN Bus Transceiver\+: \+Microchip Technology MCP2542\+FD-\/\+H/\+SN}\label{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{device_specifications_autotoc_md7}{}\doxysubsubsection{SD Card (\+Generic)}\label{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{device_specifications_autotoc_md8}{}\doxysubsubsection{USB to UART Bridge\+: FTDI \+FT260\+Q-\/T}\label{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{device_specifications_autotoc_md9}{}\doxysubsubsection{RS-\/232 Transceiver\+: Texas Instruments GD75232\+PWR}\label{device_specifications_autotoc_md9}
|
||||
\hypertarget{device_specifications_autotoc_md10}{}\doxysubsubsection{Inertial Measurement Unit\+: TDK Inven\+Sense ICM-\/20600}\label{device_specifications_autotoc_md10}
|
||||
|
||||
\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}\hypertarget{layoutPlanning}{}\doxysection{Layout Planning}\label{layoutPlanning}
|
||||
\hypertarget{layout_planning_autotoc_md11}{}\doxysubsubsection{Microcontroller}\label{layout_planning_autotoc_md11}
|
||||
@@ -1,7 +1,17 @@
|
||||
\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}
|
||||
{\bfseries{Subpages}}
|
||||
|
||||
|
||||
\begin{DoxyItemize}
|
||||
\item \mbox{\hyperlink{hardware}{Hardware}}
|
||||
\item \mbox{\hyperlink{software}{Software}}
|
||||
\end{DoxyItemize}
|
||||
|
||||
\DoxyHorRuler{0}
|
||||
\hypertarget{index_autotoc_md13}{}\doxysection{About}\label{index_autotoc_md13}
|
||||
What this project is about (TODO)\hypertarget{index_autotoc_md14}{}\doxysection{Documentation}\label{index_autotoc_md14}
|
||||
For Documentation, we will use \char`\"{}doxygen\char`\"{} to easily create documentation pages for the project. This will be accessible in a variety of means, but primarily through HTML pages accessible through a browser, covering all aspects of the project.
|
||||
|
||||
More information here\+: \mbox{\hyperlink{documentation_guide}{Documentation Guide}}\hypertarget{index_autotoc_md15}{}\doxysubsection{Tips from Dr. Bazuin}\label{index_autotoc_md15}
|
||||
|
||||
\begin{DoxyItemize}
|
||||
\item Make sub-\/circuits/sub-\/designs for schematics to keep things organized and modular/copy-\/able
|
||||
@@ -22,5 +32,6 @@ For Documentation, we will use \char`\"{}doxygen\char`\"{} to easily create docu
|
||||
|
||||
\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 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
|
||||
\end{DoxyItemize}
|
||||
1
Documentation/latex/layout_planning.tex
Normal file
1
Documentation/latex/layout_planning.tex
Normal file
@@ -0,0 +1 @@
|
||||
\hypertarget{layout_planning_autotoc_md10}{}\doxysubsection{Microcontroller}\label{layout_planning_autotoc_md10}
|
||||
@@ -1,4 +1,5 @@
|
||||
\hypertarget{md__hardware__device__specifications_autotoc_md1}{}\doxysection{Microcontroller\+: Texas Instruments MSP430\+F5438\+AIPZR}\label{md__hardware__device__specifications_autotoc_md1}
|
||||
device\+Specifications Device Specifications\+Test1 \hypertarget{md__hardware__device__specifications_autotoc_md0}{}\doxysection{Device Specifications\+Test2}\label{md__hardware__device__specifications_autotoc_md0}
|
||||
\hypertarget{md__hardware__device__specifications_autotoc_md1}{}\doxysubsection{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
|
||||
@@ -22,7 +23,7 @@
|
||||
\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}
|
||||
\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_autotoc_md2}{}\doxysubsection{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
|
||||
@@ -33,7 +34,7 @@
|
||||
\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}
|
||||
\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_autotoc_md3}{}\doxysubsection{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
|
||||
@@ -43,7 +44,7 @@
|
||||
\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}
|
||||
\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_autotoc_md4}{}\doxysubsection{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
|
||||
@@ -51,7 +52,7 @@
|
||||
\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}
|
||||
\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_autotoc_md5}{}\doxysubsection{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
|
||||
@@ -62,12 +63,12 @@
|
||||
\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}
|
||||
\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_autotoc_md6}{}\doxysubsection{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}
|
||||
\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_autotoc_md7}{}\doxysubsection{SD Card (\+Generic)}\label{md__hardware__device__specifications_autotoc_md7}
|
||||
|
||||
\begin{DoxyItemize}
|
||||
\item 2.\+7 V to 3.\+6 V Supply Voltage
|
||||
@@ -75,12 +76,12 @@
|
||||
\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}
|
||||
\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_autotoc_md8}{}\doxysubsection{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}
|
||||
\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_autotoc_md9}{}\doxysubsection{RS-\/232 Transceiver\+: Texas Instruments GD75232\+PWR}\label{md__hardware__device__specifications_autotoc_md9}
|
||||
\hypertarget{md__hardware__device__specifications_autotoc_md10}{}\doxysubsection{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
|
||||
|
||||
@@ -0,0 +1,99 @@
|
||||
device\+Specifications Device Specifications\+Test1 \hypertarget{md__hardware__device__specifications_test3_autotoc_md0}{}\doxysection{Device Specifications\+Test2}\label{md__hardware__device__specifications_test3_autotoc_md0}
|
||||
\hypertarget{md__hardware__device__specifications_test3_autotoc_md1}{}\doxysubsection{Microcontroller\+: Texas Instruments MSP430\+F5438\+AIPZR}\label{md__hardware__device__specifications_test3_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_test3_autotoc_md2}{}\doxysubsection{Real-\/\+Time Clock/\+Calendar\+: Microchip Technology \+MCP7940\+MT-\/\+I/\+SN}\label{md__hardware__device__specifications_test3_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_test3_autotoc_md3}{}\doxysubsection{Bluetooth/\+Wi-\/\+Fi\+: Espressif Systems ESP32-\/\+WROVER-\/\+IE (8\+MB)}\label{md__hardware__device__specifications_test3_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_test3_autotoc_md4}{}\doxysubsection{GPS Receiver\+: Maxim Integrated \+MAX2771\+ETI+T}\label{md__hardware__device__specifications_test3_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_test3_autotoc_md5}{}\doxysubsection{CANbus Controller\+: Microchip Technology MCP2515\+T-\/\+I/\+SO}\label{md__hardware__device__specifications_test3_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_test3_autotoc_md6}{}\doxysubsection{CAN Bus Transceiver\+: \+Microchip Technology MCP2542\+FD-\/\+H/\+SN}\label{md__hardware__device__specifications_test3_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_test3_autotoc_md7}{}\doxysubsection{SD Card (\+Generic)}\label{md__hardware__device__specifications_test3_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_test3_autotoc_md8}{}\doxysubsection{USB to UART Bridge\+: FTDI \+FT260\+Q-\/T}\label{md__hardware__device__specifications_test3_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_test3_autotoc_md9}{}\doxysubsection{RS-\/232 Transceiver\+: Texas Instruments GD75232\+PWR}\label{md__hardware__device__specifications_test3_autotoc_md9}
|
||||
\hypertarget{md__hardware__device__specifications_test3_autotoc_md10}{}\doxysubsection{Inertial Measurement Unit\+: TDK Inven\+Sense ICM-\/20600}\label{md__hardware__device__specifications_test3_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 +1 @@
|
||||
\hypertarget{md__hardware__layout__planning_autotoc_md12}{}\doxysection{Microcontroller}\label{md__hardware__layout__planning_autotoc_md12}
|
||||
\hypertarget{md__hardware__layout__planning_autotoc_md11}{}\doxysection{Microcontroller}\label{md__hardware__layout__planning_autotoc_md11}
|
||||
|
||||
@@ -158,7 +158,7 @@
|
||||
\begin{titlepage}
|
||||
\vspace*{7cm}
|
||||
\begin{center}%
|
||||
{\Large Sunseeker Telemetry and Lighting System }\\
|
||||
{\Large 2020-\/2021 Sunseeker Telemetry and Lighting System }\\
|
||||
\vspace*{1cm}
|
||||
{\large Generated by Doxygen 1.9.1}\\
|
||||
\end{center}
|
||||
@@ -171,22 +171,29 @@
|
||||
\hypersetup{pageanchor=true}
|
||||
|
||||
%--- Begin generated contents ---
|
||||
\chapter{ECE4810-\/\+Fall2020-\/\+Sunseeker\+Telemetry}
|
||||
\chapter{Main Page}
|
||||
\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{Hardware}
|
||||
\label{hardware}
|
||||
\Hypertarget{hardware}
|
||||
\input{hardware}
|
||||
\chapter{Software}
|
||||
\label{software}
|
||||
\Hypertarget{software}
|
||||
\input{software}
|
||||
\chapter{Documentation Guide}
|
||||
\label{documentation_guide}
|
||||
\Hypertarget{documentation_guide}
|
||||
\input{documentation_guide}
|
||||
\chapter{File Index}
|
||||
\input{files}
|
||||
\chapter{File Documentation}
|
||||
\input{_9_hardware_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_software_8markdown}
|
||||
\input{main_8c}
|
||||
%--- End generated contents ---
|
||||
|
||||
|
||||
0
Documentation/latex/software.tex
Normal file
0
Documentation/latex/software.tex
Normal file
Reference in New Issue
Block a user