Merge pull request #27 from RWU-R2M/devel

Devel

README.md

@@ -1,18 +1,18 @@
 # Documentation
 
-## ToDo List
-- [ ] sufficient evidence: schematics, datasheets, calculations
+## License 📃
 
+```
+ ------------------------------------------------------------------------------
+| Copyright (C)  2024 Leandro Ebner.                                           |
+|                                                                              |
+| Permission is granted to copy, distribute and/or modify this document under  |
+| the terms of the GNU Free Documentation License,                             |
+| Version 1.3 or any later version published by the Free Software Foundation;  |
+| with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.   |
+| A copy of the license can be found here:                                     |
+| https://www.gnu.org/licenses/fdl-1.3.txt                                     |
+ ------------------------------------------------------------------------------
+```
 
 
-## Structure: 
-- Hazardous Material List
-- Power Architecture
-- Energy Storage
-- Emergency Stop
-- Power Distribution
-- Power Conversion
-- Power Consuming Circuits
-- Unused Circuits
-- Circuit Table
-

contents/appendix.tex

@@ -0,0 +1,52 @@
+\section{Appendix}
+\subsection{Definitions}
+
+    \begin{enumerate}
+        \item The word \textit{should} indicates a suggestion which may become a requirement in future competitions.
+        \item A \textit{circuit} is one or more electricity-consuming devices (and the connections between them) which draw current from a single power source through a common \textit{circuit protection} element.
+        \item \textit{Regulators} consume and provide power, with their input and outputs counting as at least one \textit{circuit} each.
+        \item The \textit{current rating} of a component is the manufacturer-published value indicating the maximum acceptable amperage consumed or provided by the device in normal continuous conditions. Transient, burst, or peak current limits are \textbf{not} \textit{current ratings}.
+        \item The \textit{current rating} of \textit{circuit protection} is the amperage above which it is designed to interrupt current flow.
+        \item \textit{Circuit protection} is a fuse or electromechanical circuit-breaker which reliably interrupts excessive current flows through a connected \textit{circuit}. Software-based solutions are \textbf{insufficient}. Motor controllers, power regulators, or other devices with current limiting capabilities are \textbf{not} sufficient for use as \textit{circuit protection}. Self-resetting fuses are also \textbf{insufficient}.
+        \item A \textit{kill switch} is a physical switch mounted on a rover which, when pressed down, causes the interruption of power to \textbf{all} rover systems until the switch is manually reset.
+    \end{enumerate}
+
+    \clearpage %PAGE SPECIFIER
+
+    \subsection{Requirements}
+
+    \begin{enumerate}
+
+    % 1 -------------------------------------------------------------------------------------------------------------------------------------------
+    \item Rovers must not include any flammable, environmentally damaging, or otherwise hazardous liquids or gasses, except:
+    \begin{enumerate}
+        \item Within a permanently sealed component such as a battery; \label{battery}
+        \item Commercially-available lubricants as required by mechanical assemblies, where care is taken to avoid overuse and contamination.
+    \end{enumerate}
+    %   -------------------------------------------------------------------------------------------------------------------------------------------
+
+
+    % 4 -------------------------------------------------------------------------------------------------------------------------------------------
+    \item Each circuit must include separate circuit protection.
+    \begin{enumerate}
+        \item The current rating of the devices powered by the circuit, or 2 Amps for lower-current circuits;
+        \item The safe current-carrying capacity of the smallest connectors or conductors in the circuit.
+        \item The connections between your battery and any distribution board/panel are a circuit, and must be protected as such. Off the shelf battery management systems (BMSs) are allowable here, and are the only exception to the ban on protection systems that rely on software.
+    \end{enumerate}
+    %   -------------------------------------------------------------------------------------------------------------------------------------------
+
+
+    % 7 -------------------------------------------------------------------------------------------------------------------------------------------
+    \item Sufficient documentation must be provided to prove the safety of your rover before you will be allowed to compete.
+    \begin{enumerate}
+        \item The documentation diagram should be updated to reflect ongoing changes during CIRC. \label{req7.5}
+        \item Related low-current devices (less than 2A total) on the same circuit may be grouped into black-box subsystems to reduce the complexity of the diagram.
+        \item Each power source, circuit protection element, circuit, and device/device group in your documentation on the diagram must be identified annotated with a short name and current rating.
+        \item A photograph of the emergency stop button mounted on the rover must be included.
+    \end{enumerate}
+    %   -------------------------------------------------------------------------------------------------------------------------------------------
+
+
+    \end{enumerate}
+
+

contents/connectors.tex

@@ -0,0 +1,134 @@
+\subsection{XT30 Female Connector Datasheet}
+
+\includegraphics[width=\textwidth]{contents/figures/xt30_f.jpg}
+
+The datasheet of the XT-series of connectors can be found \href{https://www.lcsc.com/datasheet/lcsc_datasheet_2304140030_Changzhou-Amass-Elec-XT30U-F_C99102.pdf}{\textbf{\underline{here}}}.
+The table below is only an extract of the most important information, to be used as standalone reference and also in case the URL above fails.
+
+\begin{table}[h] %Float specifier check: passed!
+    \begin{tabular}{rlrl}
+         Item No.:&  XT30U-F &  Contact Resistance:& $0.70m \Omega$\\
+         Color:&  Black \& Yellow&  Max. Voltage:& $500V$\\
+         Contact Material:&  Gold plated brass&  Continous Current:& $15A$\\
+         Isolation Material:&  PA (Nylon)&  Max. Current:& $30A$\\
+         Flammability:&  94V-0&  Mating Cycles:& 1000\\
+         Certifications:&  CE/UL&  Temperature Range:& -20°C - 120°C\\
+    \end{tabular}
+    \caption{XT30 female connector and its electrical and mechanical parameters.}
+    \label{xt30_f_specs}
+\end{table}
+
+\clearpage %PAGE SPECIFIER
+    \label{xt30}
+\subsection{XT30 Male Connector Datasheet}
+
+\includegraphics[width=\textwidth]{contents/figures/xt30_m.jpg}
+
+The datasheet of the XT-series of connectors can be found \href{https://www.lcsc.com/datasheet/lcsc_datasheet_2304140030_Changzhou-Amass-Elec-XT30U-F_C99101.pdf}{\textbf{\underline{here}}}.
+The table below is only an extract of the most important information, to be used as standalone reference and also in case the URL above fails.
+
+\begin{table}[h] %Float specifier check: passed!
+    \begin{tabular}{rlrl}
+         Item No.:&  XT30U-M &  Contact Resistance:& $0.70m \Omega$\\
+         Color:&  Black \& Yellow&  Max. Voltage:& $500V$\\
+         Contact Material:&  Gold plated brass&  Continous Current:& $15A$\\
+         Isolation Material:&  PA (Nylon)&  Max. Current:& $30A$\\
+         Flammability:&  94V-0&  Mating Cycles:& 1000\\
+         Certifications:&  CE/UL&  Temperature Range:& -20°C - 120°C\\
+    \end{tabular}
+    \caption{XT30 male connector and its electrical and mechanical parameters.}
+    \label{xt30_m_specs}
+\end{table}
+
+\clearpage %PAGE SPECIFIER
+
+\subsection{XT60 Female Connector Datasheet}
+
+\includegraphics[width=\textwidth]{contents/figures/xt60_f.jpg}
+
+The datasheet of the XT-series of connectors can be found \href{https://www.lcsc.com/datasheet/lcsc_datasheet_2401031338_Changzhou-Amass-Elec-XT60U-F_C19191801.pdf}{\textbf{\underline{here}}}.
+The table below is only an extract of the most important information, to be used as standalone reference and also in case the URL above fails.
+
+\begin{table}[h] %Float specifier check: passed!
+    \begin{tabular}{rlrl}
+         Item No.:&  XT60U-F &  Contact Resistance:& $0.45m \Omega$\\
+         Color:&  Black \& Yellow&  Max. Voltage:& $500V$\\
+         Contact Material:&  Gold plated brass&  Continous Current:& $30A$\\
+         Isolation Material:&  PA (Nylon)&  Max. Current:& $60A$\\
+         Flammability:&  94V-0&  Mating Cycles:& 1000\\
+         Certifications:&  CE/UL&  Temperature Range:& -20°C - 120°C\\
+    \end{tabular}
+    \caption{XT60 female connector and its electrical and mechanical parameters.}
+    \label{xt60_f_specs}
+\end{table}
+
+\clearpage %PAGE SPECIFIER 
+\label{xt60}
+\subsection{XT60 Male Connector Datasheet}
+
+\includegraphics[width=\textwidth]{contents/figures/xt60_m.jpg}
+
+The datasheet of the XT-series of connectors can be found \href{https://www.lcsc.com/datasheet/lcsc_datasheet_1810251312_Changzhou-Amass-Elec-XT60U-M_C129184.pdf}{\textbf{\underline{here}}}.
+The table below is only an extract of the most important information, to be used as standalone reference and also in case the URL above fails.
+
+\begin{table}[h] %Float specifier check: passed!
+    \begin{tabular}{rlrl}
+         Item No.:&  XT60U-M &  Contact Resistance:& $0.45m \Omega$\\
+         Color:&  Black \& Yellow&  Max. Voltage:& $500V$\\
+         Contact Material:&  Gold plated brass&  Continous Current:& $30A$\\
+         Isolation Material:&  PA (Nylon)&  Max. Current:& $60A$\\
+         Flammability:&  94V-0&  Mating Cycles:& 1000\\
+         Certifications:&  CE/UL&  Temperature Range:& -20°C - 120°C\\
+    \end{tabular}
+    \caption{XT60 male connector and its electrical and mechanical parameters.}
+    \label{xt60_m_specs}
+\end{table}
+
+\clearpage %PAGE SPECIFIER
+
+\subsection{XT90 Female Connector Datasheet}
+
+\includegraphics[width=\textwidth]{contents/figures/xt90_f.jpg}
+
+The datasheet of the XT-series of connectors can be found \href{https://www.lcsc.com/datasheet/lcsc_datasheet_2207061800_Changzhou-Amass-Elec-XT90H-F-G-Y_C3040685.pdf}{\textbf{\underline{here}}}.
+The table below is only an extract of the most important information, to be used as standalone reference and also in case the URL above fails.
+
+\begin{table}[h] %Float specifier check: passed!
+    \begin{tabular}{rlrl}
+         Item No.:&  XT90H-F.G.Y &  Contact Resistance:& $0.30m \Omega$\\
+         Color:&  Black \& Yellow&  Max. Voltage:& $500V$\\
+         Contact Material:&  Gold plated brass&  Continous Current:& $40A$\\
+         Isolation Material:&  PA (Nylon)&  Max. Current:& $90A$\\
+         Flammability:&  94V-0&  Mating Cycles:& 1000\\
+         Certifications:&  CE/UL&  Temperature Range:& -20°C - 120°C\\
+    \end{tabular}
+    \caption{XT90 female connector and its electrical and mechanical parameters.}
+    \label{xt90_f_specs}
+\end{table}
+
+\clearpage %PAGE SPECIFIER
+\label{xt90}
+\subsection{XT90 Male Connector Datasheet}
+
+\includegraphics[width=\textwidth]{contents/figures/xt90_m.jpg}
+
+The datasheet of the XT-series of connectors can be found \href{https://www.lcsc.com/datasheet/lcsc_datasheet_2207062115_Changzhou-Amass-Elec-XT90H-M-G-Y_C3040683.pdf}{\textbf{\underline{here}}}.
+The table below is only an extract of the most important information, to be used as standalone reference and also in case the URL above fails.
+
+\begin{table}[h] %Float specifier check: passed!
+    \begin{tabular}{rlrl}
+         Item No.:&  XT90H-M.G.Y &  Contact Resistance:& $0.30m \Omega$\\
+         Color:&  Black \& Yellow&  Max. Voltage:& $500V$\\
+         Contact Material:&  Gold plated brass&  Continous Current:& $40A$\\
+         Isolation Material:&  PA (Nylon)&  Max. Current:& $90A$\\
+         Flammability:&  94V-0&  Mating Cycles:& 1000\\
+         Certifications:&  CE/UL&  Temperature Range:& -20°C - 120°C\\
+    \end{tabular}
+    \caption{XT90 male connector and its electrical and mechanical parameters.}
+    \label{xt90_m_specs}
+\end{table}
+
+\clearpage %PAGE SPECIFIER
+
+
+