Updated Doxygen

This commit is contained in:
William Miceli
2021-02-16 21:28:01 -05:00
parent 5148ac3166
commit 80e2fdcd2f
530 changed files with 52222 additions and 186 deletions

View File

@@ -22,10 +22,21 @@
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{designChoices}{}\doxysection{Design Choices}\label{designChoices}
\hypertarget{design_choices_autotoc_md2}{}\doxysubsection{JTAG Interface}\label{design_choices_autotoc_md2}
When connecting the MCU to the programmer via the JTAG interface, it is possible for a local power supply connected to the MCU to be used or for power from the debugging/programming adapter to be used. Since having power supplied to the MCU from the debugging/programming adapter can be useful for use outside of the Sunseeker vehicle, we chose to use that.\hypertarget{design_choices_autotoc_md3}{}\doxysubsection{Microcontroller Peripheral Connections}\label{design_choices_autotoc_md3}
Universal Serial Communication Interfaces (USCIs)\+:
When connecting the MCU to the programmer via the JTAG interface, it is possible for a local power supply connected to the MCU to be used or for power from the debugging/programming adapter to be used. Since having power supplied to the MCU from the debugging/programming adapter can be useful for use outside of the Sunseeker vehicle, we chose to use that.\hypertarget{design_choices_autotoc_md3}{}\doxysubsection{Microcontroller Connections}\label{design_choices_autotoc_md3}
The board is going to be organized to the best of our abilities to be organized as such\+:
\begin{DoxyItemize}
\item Left Side\+:
\begin{DoxyItemize}
\item Peripherals for communicating with/controlling the Sunseeker vehicle
\end{DoxyItemize}
\item Right Side\+:
\begin{DoxyItemize}
\item Peripherals for communicating with users
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{design_choices_autotoc_md4}{}\doxysubparagraph{Universal Serial Communication Interfaces (\+USCIs)\+:}\label{design_choices_autotoc_md4}
\begin{DoxyItemize}
\item A -\/ Supporting up to four total of UART and/or SPI
\begin{DoxyItemize}
@@ -37,11 +48,11 @@ Universal Serial Communication Interfaces (USCIs)\+:
\item A1\+:
\item A2 \mbox{[}UART\mbox{]}\+:
\begin{DoxyItemize}
\item RS-\/232 Transceiver (STMicroelectronics ST232\+CDR)
\item USB to UART Bridge (Future Technology Devices International FT230\+XS-\/R)
\end{DoxyItemize}
\item A3 \mbox{[}UART\mbox{]}\+:
\begin{DoxyItemize}
\item USB to UART Bridge (Future Technology Devices International FT230\+XS-\/R)
\item RS-\/232 Transceiver (STMicroelectronics ST232\+CDR)
\end{DoxyItemize}
\end{DoxyItemize}
\item B -\/ Supporting up to four total of I2C and/or SPI
@@ -49,22 +60,23 @@ Universal Serial Communication Interfaces (USCIs)\+:
\item B0 \mbox{[}SPI\mbox{]}\+:
\begin{DoxyItemize}
\item SD Card
\item GPS Receiver (Maxim Integrated \+MAX2771\+ETI+T)
\item GPS Receiver (U-\/\+Blox NEO-\/\+M8\+Q-\/01A)
\end{DoxyItemize}
\item B1 \mbox{[}SPI\mbox{]}\+:
\item B1 \mbox{[}I2C\mbox{]}\+:
\begin{DoxyItemize}
\item Inertial Measurement Unit (TDK Inven\+Sense ICM-\/20948)
\item Real-\/\+Time Clock/\+Calendar (Microchip Technology \+MCP7940\+MT-\/\+I/\+SN)
\end{DoxyItemize}
\item B2\+:
\item B3 \mbox{[}SPI\mbox{]}\+:
\begin{DoxyItemize}
\item Bluetooth/\+Wi-\/\+Fi (Espressif Systems ESP32-\/\+WROVER-\/\+IE (8MB))
\end{DoxyItemize}
\item B2 \mbox{[}I2C\mbox{]}\+:
\begin{DoxyItemize}
\item Inertial Measurement Unit (TDK Inven\+Sense ICM-\/20600)
\item Real-\/\+Time Clock/\+Calendar (Microchip Technology \+MCP7940\+MT-\/\+I/\+SN)
\end{DoxyItemize}
\end{DoxyItemize}
\end{DoxyItemize}
The thinking behind this so far, is to try and balance the load between the modules with SPI protocol being used in more high data-\/rate peripherals and I2C used with lower or less-\/used peripherals. \hypertarget{deviceSpecifications}{}\doxysection{Device Specifications}\label{deviceSpecifications}
\hypertarget{device_specifications_autotoc_md4}{}\doxysubsubsection{Microcontroller\+: Texas Instruments MSP430\+F5438\+AIPZR}\label{device_specifications_autotoc_md4}
In addition to trying to keep the MCU and PCB organized with the left-\/side being to do with the Sunseeker vehicle and the right side to be peripherals interacting with users, we tried to also load-\/balance the USCI modules, as well as have the SPI protocol be used in more high data-\/rate peripherals and I2C used with lower or less-\/used peripherals. In Texas Instruments SLAS655G Document \mbox{[}Page 7\mbox{]} has a pin diagram showing the physical location of where each pin is physically located. \hypertarget{deviceSpecifications}{}\doxysection{Device Specifications}\label{deviceSpecifications}
\hypertarget{device_specifications_autotoc_md5}{}\doxysubsubsection{Microcontroller\+: Texas Instruments MSP430\+F5438\+AIPZR}\label{device_specifications_autotoc_md5}
\begin{DoxyItemize}
\item 1.\+8 V to 3.\+6 V Supply Voltage
@@ -88,7 +100,7 @@ The thinking behind this so far, is to try and balance the load between the modu
\item 14 external channels
\end{DoxyItemize}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md5}{}\doxysubsubsection{Real-\/\+Time Clock/\+Calendar\+: Microchip Technology \+MCP7940\+MT-\/\+I/\+SN}\label{device_specifications_autotoc_md5}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md6}{}\doxysubsubsection{Real-\/\+Time Clock/\+Calendar\+: Microchip Technology \+MCP7940\+MT-\/\+I/\+SN}\label{device_specifications_autotoc_md6}
\begin{DoxyItemize}
\item 1.\+8 V to 5.\+5 V Supply Voltage
@@ -100,7 +112,7 @@ The thinking behind this so far, is to try and balance the load between the modu
\item Clock rate up to 400 k\+Hz
\end{DoxyItemize}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md6}{}\doxysubsubsection{Bluetooth/\+Wi-\/\+Fi\+: Espressif Systems ESP32-\/\+WROVER-\/\+IE (8\+MB)}\label{device_specifications_autotoc_md6}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md7}{}\doxysubsubsection{Bluetooth/\+Wi-\/\+Fi\+: Espressif Systems ESP32-\/\+WROVER-\/\+IE (8\+MB)}\label{device_specifications_autotoc_md7}
\begin{DoxyItemize}
\item 3.\+0 V to 3.\+6 V Supply Voltage
@@ -125,19 +137,25 @@ The thinking behind this so far, is to try and balance the load between the modu
\item Up to 5 Mbps
\end{DoxyItemize}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md7}{}\doxysubsubsection{GPS Receiver\+: Maxim Integrated \+MAX2771\+ETI+T}\label{device_specifications_autotoc_md7}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md8}{}\doxysubsubsection{GPS Receiver\+: U-\/\+Blox NEO-\/\+M8\+Q-\/01A}\label{device_specifications_autotoc_md8}
\begin{DoxyItemize}
\item 2.\+7 V to 3.\+3 V Supply Voltage
\item 2.\+7 V to 3.\+6 V
\item Notable Peripherals\+:
\begin{DoxyItemize}
\item SPI
\begin{DoxyItemize}
\item Slave only
\item Need to calculate frequency
\item Slave Only
\item 5.\+5 MHz
\end{DoxyItemize}
\item UART
\item I2C (Also called Display Data Channel (DDC))
\begin{DoxyItemize}
\item Slave Only
\item 400 k\+Hz
\end{DoxyItemize}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md8}{}\doxysubsubsection{CANbus Controller\+: Microchip Technology MCP2515\+T-\/\+I/\+SO}\label{device_specifications_autotoc_md8}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md9}{}\doxysubsubsection{CANbus Controller\+: Microchip Technology MCP2515\+T-\/\+I/\+SO}\label{device_specifications_autotoc_md9}
\begin{DoxyItemize}
\item 2.\+7 V to 5.\+5 V Supply Voltage
@@ -149,12 +167,12 @@ The thinking behind this so far, is to try and balance the load between the modu
\item 10 MHz
\end{DoxyItemize}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md9}{}\doxysubsubsection{CANbus Transceiver\+: \+Microchip Technology MCP2542\+FD-\/\+H/\+SN}\label{device_specifications_autotoc_md9}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md10}{}\doxysubsubsection{CANbus Transceiver\+: \+Microchip Technology MCP2542\+FD-\/\+H/\+SN}\label{device_specifications_autotoc_md10}
\begin{DoxyItemize}
\item 4.\+5 V to 5.\+5 V Supply Voltage
\item Used directly with CANbus Controller
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md10}{}\doxysubsubsection{SD Card (\+Generic)}\label{device_specifications_autotoc_md10}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md11}{}\doxysubsubsection{SD Card (\+Generic)}\label{device_specifications_autotoc_md11}
\begin{DoxyItemize}
\item 2.\+7 V to 3.\+6 V Supply Voltage
@@ -162,7 +180,7 @@ The thinking behind this so far, is to try and balance the load between the modu
\begin{DoxyItemize}
\item SPI
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md11}{}\doxysubsubsection{USB to UART Bridge\+: Future Technology Devices International FT230\+XS-\/R}\label{device_specifications_autotoc_md11}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md12}{}\doxysubsubsection{USB to UART Bridge\+: Future Technology Devices International FT230\+XS-\/R}\label{device_specifications_autotoc_md12}
\begin{DoxyItemize}
\item 3 V to 5 V Supply Voltage
@@ -170,15 +188,16 @@ The thinking behind this so far, is to try and balance the load between the modu
\begin{DoxyItemize}
\item UART
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md12}{}\doxysubsubsection{RS-\/232 Transceiver\+: STMicroelectronics ST232\+CDR}\label{device_specifications_autotoc_md12}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md13}{}\doxysubsubsection{RS-\/232 Transceiver\+: STMicroelectronics ST232\+CDR}\label{device_specifications_autotoc_md13}
\begin{DoxyItemize}
\item 4.\+5 V to 5.\+5 V Supply Voltage
\item Will use UART from the MCU
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md13}{}\doxysubsubsection{Inertial Measurement Unit\+: TDK Inven\+Sense ICM-\/20600}\label{device_specifications_autotoc_md13}
\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md14}{}\doxysubsubsection{Inertial Measurement Unit\+: TDK Inven\+Sense ICM-\/20948}\label{device_specifications_autotoc_md14}
\begin{DoxyItemize}
\item 1.\+71 V to 3.\+45 V Supply Voltage
\item 1.\+71 V to 3.\+6 V Supply Voltage
\item VDDIO Voltage input also needed from 1.\+71 V to 1.\+95 V
\item Notable Peripherals\+:
\begin{DoxyItemize}
\item I2C
@@ -189,7 +208,7 @@ The thinking behind this so far, is to try and balance the load between the modu
\item SPI
\begin{DoxyItemize}
\item Slave only
\item 10 MHz
\item 7 MHz
\end{DoxyItemize}
\end{DoxyItemize}
\end{DoxyItemize}