diff --git a/.gitignore b/.gitignore index 8e5e9ca..f0e0c66 100644 --- a/.gitignore +++ b/.gitignore @@ -44,3 +44,13 @@ tests/__pycache__/ # FreeCAD ignores *.FCStd1 + +# TeX(maker) ignores +*.aux +*.lof +*.log +*.lot +*.synctex.gz +*.gz +*.toc + diff --git a/Documentation/IAQ_Wired_Sensor_Datasheet.tex b/Documentation/IAQ_Wired_Sensor_Datasheet.tex new file mode 100644 index 0000000..3d001ff --- /dev/null +++ b/Documentation/IAQ_Wired_Sensor_Datasheet.tex @@ -0,0 +1,171 @@ +\documentclass[a4paper,12pt,twoside]{article} +\usepackage[utf8]{inputenc} +\usepackage[english]{babel} +\usepackage{fancyhdr} +\usepackage{graphics} +\usepackage{graphicx} +\usepackage{multicol} +\usepackage{capt-of} +\usepackage[table]{xcolor} + +% ONLY FOR TEMPLATE +\usepackage{blindtext} + +\pagestyle{fancy} +\fancyhf{} +\fancyhead[LE,LO]{\includegraphics{./fig/VelesLabsLogo.png}} +\fancyhead[RE,RO]{PRODUCT NAME\\DATASHEET v. 1.0} +\fancyfoot[LE,LO]{\leftmark} +\fancyfoot[RE,RO]{\thepage} + +\renewcommand{\headrulewidth}{2pt} +\renewcommand{\footrulewidth}{2pt} +\setlength{\headheight}{35pt} + +\begin{document} +%TODO: TITLEPAGE + + +\begin{multicols*}{2} +\includegraphics[width=0.45\textwidth]{./fig/iaq_wired_sensor.png} +\section*{Features} +\begin{itemize} +\setlength\itemsep{0cm} +\item 260 to 1260 hPa absolute pressure range +\item Current consumption down to 3 A +\item High overpressure capability: 20x full-scale +\item Embedded temperature compensation +\item 24-bit pressure data output +\item 16-bit temperature data output +\item ODR from 1 Hz to 75 Hz +\item SPI and I²C interfaces +\item Embedded FIFO +\item Interrupt functions: Data Ready, FIFO flags, pressure thresholds +\item Supply voltage: 1.7 to 3.6 V +\item High shock survivability: 22,000 g +\item Small and thin package +\item ECOPACK lead-free compliant +\end{itemize} +\section*{Description} +\blindtext +\blindtext +\end{multicols*} +\pagebreak + +\tableofcontents +\listoffigures +\listoftables + +\pagebreak + +\section{Specifications} +\subsection{Electrical Specifications} +\begin{table}[h] +\scriptsize +\begin{tabular}{|p{5cm}|p{2cm}|p{1cm}|p{1cm}|p{1cm}|p{1cm}|} +\hline +\rowcolor{lightgray}\textbf{Parameter} & \textbf{Symbol} & \textbf{Min.} & \textbf{Typ.} & \textbf{Max.} & \textbf{Unit} \\ \hline +Input voltage & $V_{DD}$ & 5 & 12 & 24 & V \\ \hline +Average supply current & $I_{DD}$ & & 50 & & mA \\ \hline +RS485 Single-Ended Output High & $V_{OH}$ & 2.2 & & & V \\ \hline +RS485 Single-Ended Output Low & $V_{OL}$ & & & 0.8 & V \\ \hline +RS485 Differential Output & $V_{OD}$ & 2.0 & & & V \\ \hline +RS485 Receiver Differential Threshold Voltage & $V_{TH}$ & -200 & -105 & -10 & mV \\ \hline +\end{tabular} +\normalsize +\caption{Electrical Specifications} +\label{tab:specifications_electrical} +\end{table} +\vfill +\subsection{Sensing Specifications} +\begin{table}[h] +\scriptsize +\begin{tabular}{|p{5cm}|p{3cm}|p{4.25cm}|} +\hline +\rowcolor{lightgray}\textbf{Parameter} & \textbf{Conditions} & \textbf{Value} \\ \hline +CO$_2$ measurement range & \multicolumn{1}{c|}{-} & 0 $\div$ 40000 ppm \\ \hline +CO$_2$ measurement accuracy & 400 ppm – 2000 ppm & ($\pm$50 ppm + 5\% of reading) \\ \hline +CO$_2$ measurement repeatability & Typical & $\pm$10 ppm \\ \hline +T measurement range & \multicolumn{1}{c|}{-} & –40 $\div$ +125 $^{\circ}$C \\ \hline +T measurement accuracy & Typical & $\pm$0.2 $^{\circ}$C \\ \hline +T measurement repeatability & Typical & $\pm$0.2 $^{\circ}$C \\ \hline +RH measurement range & \multicolumn{1}{c|}{-} & 0 $\div$ 100 \%RH \\ \hline +RH measurement accuracy & Typical & $\pm$1.8 \%RH \\ \hline +RH measurement repeatability & \multicolumn{1}{c|}{-} & $\pm$0.08 \%RH \\ \hline +\end{tabular} +\normalsize +\caption{Sensing Specifications} +\label{tab:specifications_sensing} +\end{table} +\vfill + +\subsection{Interface Specifications} +\begin{table}[h] +\scriptsize +\begin{tabular}{|p{3.75cm}|p{9cm}|} +\hline +\rowcolor{lightgray}\textbf{Parameter} & \textbf{Value} \\ \hline +Used Protocol & MODBUS RTU \\ \hline +Default Baudrate & 19200 Baud \\ \hline +Usable Baudrates & 4800, 9600, 14400, 19200, 28800, 38400, 57600, 76800, 119200 Baud \\ \hline +Data Bytes & 8 \\ \hline +Parity & Even \\ \hline +Stop Bits & 1 \\ \hline +\end{tabular} +\normalsize +\caption{Sensing Specifications} +\label{tab:specifications_interface} +\end{table} +\vfill +\pagebreak + +\subsection{Connectors Pinout} +\subsubsection{Main Connector Pinout} +\begin{figure}[h] +\begin{minipage}[c]{0.5\linewidth} + \centering + \includegraphics[width=0.5\textwidth]{./fig/connector_pins.png} + \caption{Main Connector Pinout} + \label{fig:connector_pinout} +\end{minipage} +\begin{minipage}[c]{0.5\linewidth} + \centering + \scriptsize + \begin{tabular}{|p{0.75cm}|p{1.25cm}|p{3cm}|} + + \hline +\rowcolor{lightgray}\textbf{Pin} & \textbf{Name} & \textbf{Description} \\ \hline + 1 & VDD & Supply Voltage \\ \hline + 2 & A & RS485 A+ \\ \hline + 3 & B & RS485 B- \\ \hline + 4 & GND & Ground \\ \hline + \end{tabular} + \captionof{table}{Main Connector Pinout} + \label{tab:connector_pinout} +\end{minipage} +\end{figure} + +\subsubsection{Programming Connector Pinout} +\begin{table}[h] +\scriptsize + \centering + \begin{tabular}{|p{0.75cm}|p{1.55cm}|p{3cm}|} + \hline +\rowcolor{lightgray} \textbf{Pin} & \textbf{Name} & \textbf{Description} \\ \hline + 1 & 3V3 & 3.3V Sensing \\ \hline + 2 & GND & Ground \\ \hline + 3 & SWDIO & SWD Data \\ \hline + 4 & SWCLK & SWD Clock \\ \hline + 4 & NRST & MCU Reset \\ \hline + \end{tabular} + \caption{Programming Connector Pinout} + \label{tab:swd_connector_pinout} +\end{table} + +\section{Communication Specification} +\subsection{Physical Layer - RS485} +\subsection{Link Layer - MODBUS RTU} +\subsubsection{Registers Description} + +\section{Mechanical Dimesions} +\end{document} \ No newline at end of file diff --git a/Documentation/Front_View_LED_GREEN.png b/Documentation/fig/Front_View_LED_GREEN.png similarity index 100% rename from Documentation/Front_View_LED_GREEN.png rename to Documentation/fig/Front_View_LED_GREEN.png diff --git a/Documentation/Front_View_LED_GREENYELLOW.png b/Documentation/fig/Front_View_LED_GREENYELLOW.png similarity index 100% rename from Documentation/Front_View_LED_GREENYELLOW.png rename to Documentation/fig/Front_View_LED_GREENYELLOW.png diff --git a/Documentation/Front_View_LED_ORANGE.png b/Documentation/fig/Front_View_LED_ORANGE.png similarity index 100% rename from Documentation/Front_View_LED_ORANGE.png rename to Documentation/fig/Front_View_LED_ORANGE.png diff --git a/Documentation/Front_View_LED_PURPLE.png b/Documentation/fig/Front_View_LED_PURPLE.png similarity index 100% rename from Documentation/Front_View_LED_PURPLE.png rename to Documentation/fig/Front_View_LED_PURPLE.png diff --git a/Documentation/Front_View_LED_RED.png b/Documentation/fig/Front_View_LED_RED.png similarity index 100% rename from Documentation/Front_View_LED_RED.png rename to Documentation/fig/Front_View_LED_RED.png diff --git a/Documentation/Front_View_LED_YELLOW.png b/Documentation/fig/Front_View_LED_YELLOW.png similarity index 100% rename from Documentation/Front_View_LED_YELLOW.png rename to Documentation/fig/Front_View_LED_YELLOW.png diff --git a/Documentation/Front_View_WHITE.png b/Documentation/fig/Front_View_WHITE.png similarity index 100% rename from Documentation/Front_View_WHITE.png rename to Documentation/fig/Front_View_WHITE.png diff --git a/Documentation/Front_view_cartoonish.png b/Documentation/fig/Front_view_cartoonish.png similarity index 100% rename from Documentation/Front_view_cartoonish.png rename to Documentation/fig/Front_view_cartoonish.png diff --git a/Documentation/fig/VelesLabsLogo.png b/Documentation/fig/VelesLabsLogo.png new file mode 100644 index 0000000..049b196 Binary files /dev/null and b/Documentation/fig/VelesLabsLogo.png differ diff --git a/Documentation/connector_pins.png b/Documentation/fig/connector_pins.png similarity index 90% rename from Documentation/connector_pins.png rename to Documentation/fig/connector_pins.png index cddb023..0ba2ac1 100644 Binary files a/Documentation/connector_pins.png and b/Documentation/fig/connector_pins.png differ diff --git a/Documentation/fig/iaq_wired_sensor.png b/Documentation/fig/iaq_wired_sensor.png new file mode 100644 index 0000000..0ff57e1 Binary files /dev/null and b/Documentation/fig/iaq_wired_sensor.png differ