Doxygen Update

This commit is contained in:
William Miceli
2021-01-30 17:37:32 -05:00
parent bbe1a7f11a
commit a60a8a50cf
58 changed files with 558 additions and 148 deletions

View File

@@ -7,8 +7,21 @@
\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}
\hypertarget{hardware_autotoc_md1}{}\doxysection{Design Reminders}\label{hardware_autotoc_md1}
\begin{DoxyItemize}
\item From \char`\"{}\+Texas Instruments -\/ SLAS655\+G...\char`\"{}, Page 22\+:
\begin{DoxyItemize}
\item To improve EMI on the XT1 oscillator, the following guidelines should be observed\+:
\begin{DoxyItemize}
\item Keep the trace between the device and the crystal as short as possible.
\item Design a good ground plane around the oscillator pins.
\item Prevent crosstalk from other clock or data lines into oscillator pins XIN and XOUT.
\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}
\begin{DoxyItemize}
\item 1.\+8 V to 3.\+6 V Supply Voltage
@@ -32,7 +45,7 @@
\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}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md3}{}\doxysubsubsection{Real-\/\+Time Clock/\+Calendar\+: Microchip Technology \+MCP7940\+MT-\/\+I/\+SN}\label{device_specifications_autotoc_md3}
\begin{DoxyItemize}
\item 1.\+8 V to 5.\+5 V Supply Voltage
@@ -43,7 +56,7 @@
\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}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md4}{}\doxysubsubsection{Bluetooth/\+Wi-\/\+Fi\+: Espressif Systems ESP32-\/\+WROVER-\/\+IE (8\+MB)}\label{device_specifications_autotoc_md4}
\begin{DoxyItemize}
\item 3.\+0 V to 3.\+6 V Supply Voltage
@@ -53,7 +66,7 @@
\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}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md5}{}\doxysubsubsection{GPS Receiver\+: Maxim Integrated \+MAX2771\+ETI+T}\label{device_specifications_autotoc_md5}
\begin{DoxyItemize}
\item 2.\+7 V to 3.\+3 V Supply Voltage
@@ -61,7 +74,7 @@
\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}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md6}{}\doxysubsubsection{CANbus Controller\+: Microchip Technology MCP2515\+T-\/\+I/\+SO}\label{device_specifications_autotoc_md6}
\begin{DoxyItemize}
\item 2.\+7 V to 5.\+5 V Supply Voltage
@@ -72,12 +85,12 @@
\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}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md7}{}\doxysubsubsection{CAN Bus Transceiver\+: \+Microchip Technology MCP2542\+FD-\/\+H/\+SN}\label{device_specifications_autotoc_md7}
\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}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md8}{}\doxysubsubsection{SD Card (\+Generic)}\label{device_specifications_autotoc_md8}
\begin{DoxyItemize}
\item 2.\+7 V to 3.\+6 V Supply Voltage
@@ -85,12 +98,12 @@
\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}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md9}{}\doxysubsubsection{USB to UART Bridge\+: FTDI \+FT260\+Q-\/T}\label{device_specifications_autotoc_md9}
\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}
\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}
\begin{DoxyItemize}
\item 1.\+71 V to 3.\+45 V Supply Voltage
@@ -106,4 +119,4 @@
\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}
\hypertarget{layout_planning_autotoc_md12}{}\doxysubsubsection{Microcontroller}\label{layout_planning_autotoc_md12}