veles_labs/iaq_sensor_wired
2
0
Fork 0
Code Issues 6 Pull Requests Projects Releases Wiki Activity

Updated the registers in the documentation.

Browse Source
This commit is contained in:
David Žaitlík 2022-07-30 20:38:17 +02:00
parent 5df130255a
commit 87ca42af91
2 changed files with 38 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
Documentation/Datasheet/IAQ_Wired_Sensor_Datasheet.pdf
View File

Binary file not shown.

53
Documentation/Datasheet/IAQ_Wired_Sensor_Datasheet.tex
View File

@ -8,6 +8,7 @@
\usepackage{multicol} \usepackage{multicol}
\usepackage{capt-of} \usepackage{capt-of}
\usepackage[table]{xcolor} \usepackage[table]{xcolor}
\usepackage{pdfpages}
\usepackage{hyperref} % for internal section links \usepackage{hyperref} % for internal section links
% ONLY FOR DRAFT % ONLY FOR DRAFT
@ -247,18 +248,22 @@ Input registers contain measured values. They are read-only and 16-bit in size.
$\mathrm{CO_2}$ concentration & 30006 & ppm & \\ \hline $\mathrm{CO_2}$ concentration & 30006 & ppm & \\ \hline
VOC index & 30007 & VOC index & see \hyperref[inputReg:note1]{Note 1} \\ \hline VOC index & 30007 & VOC index & see \hyperref[inputReg:note1]{Note 1} \\ \hline
VOC ticks & 30008 & raw VOC ticks & raw value from VOC sensor \\ \hline VOC ticks & 30008 & raw VOC ticks & raw value from VOC sensor \\ \hline
PMC Mass 1.0 & 30009 & TODO & if connected \\ \hline PMC Mass 1.0 & 30009 & $\mu$g/m$^3$ & if connected \\ \hline
PMC Mass 2.5 & 30010 & TODO & if connected \\ \hline PMC Mass 2.5 & 30010 & $\mu$g/m$^3$ & if connected \\ \hline
PMC Mass 4.0 & 30011 & TODO & if connected \\ \hline PMC Mass 4.0 & 30011 & $\mu$g/m$^3$ & if connected \\ \hline
PMC Mass 10.0 & 30012 & TODO & if connected \\ \hline PMC Mass 10.0 & 30012 & $\mu$g/m$^3$ & if connected \\ \hline
PMC Number 0.5 & 30013 & TODO & if connected \\ \hline PMC Number 0.5 & 30013 & \#/cm$^3$ & if connected \\ \hline
PMC Number 1.0 & 30014 & TODO & if connected \\ \hline PMC Number 1.0 & 30014 & \#/cm$^3$ & if connected \\ \hline
PMC Number 2.5 & 30015 & TODO & if connected \\ \hline PMC Number 2.5 & 30015 & \#/cm$^3$ & if connected \\ \hline
PMC Number 4.0 & 30016 & TODO & if connected\\ \hline PMC Number 4.0 & 30016 & \#/cm$^3$ & if connected\\ \hline
PMC Number 10.0 & 30017 & TODO & if connected \\ \hline PMC Number 10.0 & 30017 & \#/cm$^3$ & if connected \\ \hline
Temperature from $\mathrm{CO_2}$ sensor & 30019 & °C & \\ \hline PMC Typical Particle Size & 30018 & nm & if connected \\ \hline
Temperature from $\mathrm{CO_2}$ sensor & 30020 & °F & \\ \hline Temperature Readout Error & 30019 & - & see \hyperref[inputReg:note2]{Note 2}\\ \hline
RH from $\mathrm{CO_2}$ sensor & 30021 & \% & \\ \hline RH Readout Error & 30020 & - & see \hyperref[inputReg:note2]{Note 2}\\ \hline
$\mathrm{CO_2}$ Readout Error & 30021 & - & see \hyperref[inputReg:note2]{Note 2}\\ \hline
VOC Readout Error & 30022 & - & see \hyperref[inputReg:note2]{Note 2}\\ \hline
PMC Readout Error & 30023 & - & see \hyperref[inputReg:note2]{Note 2}\\ \hline
\end{tabular} \end{tabular}
\caption{Modbus input registers for \sensor{}} \caption{Modbus input registers for \sensor{}}
\label{tab:modbus_input_registers} \label{tab:modbus_input_registers}
@ -268,8 +273,24 @@ Input registers contain measured values. They are read-only and 16-bit in size.
\label{inputReg:note1} \label{inputReg:note1}
The VOC index has a range of 1-500 with 100 being the average. After sensor start-up, the VOC index is 0 until a sufficient amount of data has been measured. The VOC index has a range of 1-500 with 100 being the average. After sensor start-up, the VOC index is 0 until a sufficient amount of data has been measured.
\subsubsection{Holding registers} \paragraph{Note 2}
\label{inputReg:note2}
The error codes are described in table \ref{tab:sensor_errors}.
\begin{table}[h]
\scriptsize
\centering
\begin{tabular}{|p{1cm}|p{6cm}|}
\hline
\rowcolor{lightgray} \textbf{Error Code} & \textbf{Error Description} \\ \hline
0 & OK \\ \hline
-1 & Communication with the sensor failed \\ \hline
-2 & Data CRC Check failed \\ \hline
\end{tabular}
\caption{Error codes of measured values }
\label{tab:sensor_errors}
\end{table}
\subsubsection{Holding registers}
The holding registers can be written to by the master node. Sensor \sensor{} offers the following configuration registers: The holding registers can be written to by the master node. Sensor \sensor{} offers the following configuration registers:
\begin{table}[h] \begin{table}[h]
@ -316,9 +337,11 @@ Modbus baudrate in bits/s. May be one of: 4800, 9600, 14400, 19200, 28800, 38400
\label{holdingReg:note6} \label{holdingReg:note6}
Writing the magic constant 0xABCD to this device will instruct the device to soft-reset. Writing the magic constant 0xABCD to this device will instruct the device to soft-reset.
\vfill \vfill
\pagebreak
\section{Mechanical Dimesions} \section{Mechanical Dimesions}
\includegraphics[scale=0.75]{./fig/IAQ_Sensor_Enclosure-Enclosure_TOP.pdf} %\includepdf[scale=.7]{./fig/IAQ_Sensor_Enclosure-Enclosure_TOP.pdf}
\includegraphics[width=0.95\textwidth]{./fig/IAQ_Sensor_Enclosure-Enclosure_TOP.pdf}
\pagebreak \pagebreak
\section{Schematic} \section{Schematic}
\includegraphics[angle=90,origin=c,scale=0.7]{./../../PCB/Project_Outputs/Schematic/iaq_wired_sensor.pdf} \includegraphics[angle=90,origin=c,width=0.95\textwidth]{./../../PCB/Project_Outputs/Schematic/iaq_wired_sensor.pdf}
\end{document} \end{document}