detectors/slsDetectorPackage
25
0
Fork 0
mirror of https://github.com/slsdetectorgroup/slsDetectorPackage.git synced 2025-04-23 06:50:02 +02:00
Code Issues Actions Packages Releases Activity

updated command line doc

Browse Source
This commit is contained in:
Dhanya Maliakal 2017-08-16 11:50:01 +02:00
parent 8bc039c95f
commit 3c59b3b8dd
8 changed files with 85 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
manual/slsDetectorClientDocs/html/config.html
View File

@ -40,6 +40,14 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<h1><a class="anchor" id="config">Configuration commands </a></h1><p>Commands to configure the detector. these commands are often left to the configuration file.</p> <h1><a class="anchor" id="config">Configuration commands </a></h1><p>Commands to configure the detector. these commands are often left to the configuration file.</p>
<ul> <ul>
<li><a class="el" href="config.html#detstructure">Detector Structure</a>: commands to configure detector structure</li>
<li><a class="el" href="config.html#detstatus">Detector Status</a>: commands to configure detector status</li>
<li><a class="el" href="config.html#versions">Versions</a>: commands to check version of each subsytem</li>
</ul>
<h2><a class="anchor" id="detstructure">
Detector Structure</a></h2>
<p>commands to configure detector structure</p>
<ul>
<li><b>datastream</b> enables/disables the 0MQ data stream (0MQ threads created) from receiver to client.</li> <li><b>datastream</b> enables/disables the 0MQ data stream (0MQ threads created) from receiver to client.</li>
</ul> </ul>
<ul> <ul>
@ -66,6 +74,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<ul> <ul>
<li><b>sync</b> Sets/gets the synchronization mode of the detectors in the multi-detector structure. Can be: <code>none</code>, <code>gating</code>, <code>trigger</code>, <code>complementary</code>. Mainly used by MYTHEN/GOTTHARD.</li> <li><b>sync</b> Sets/gets the synchronization mode of the detectors in the multi-detector structure. Can be: <code>none</code>, <code>gating</code>, <code>trigger</code>, <code>complementary</code>. Mainly used by MYTHEN/GOTTHARD.</li>
</ul> </ul>
<h2><a class="anchor" id="detstatus">
Detector Status</a></h2>
<p>commands to configure detector status</p>
<ul> <ul>
<li><b>online [i]</b> sets the detector in online (1) or offline (0) mode</li> <li><b>online [i]</b> sets the detector in online (1) or offline (0) mode</li>
</ul> </ul>
@ -118,27 +129,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<ul> <ul>
<li><b>led [i]</b> sets/gets the led status. 1 on, 0 off. Used for MOENCH only ??</li> <li><b>led [i]</b> sets/gets the led status. 1 on, 0 off. Used for MOENCH only ??</li>
</ul> </ul>
<ul> <h2><a class="anchor" id="versions">
<li><b>moduleversion:[i]</b> Gets the firmware version of module i. Used for MYTHEN only. Only get!</li> Versions</a></h2>
</ul> <p>Commands to check versions of each subsystem</p>
<ul>
<li><b>detectornumber</b> Gets the serial number or MAC of detector. Only get!</li>
</ul>
<ul>
<li><b>modulenumber:[i]</b> Gets the serial number of module i. Used for MYTHEN only. Only get!</li>
</ul>
<ul>
<li><b>detectorversion</b> Gets the firmware version of detector. Only get!</li>
</ul>
<ul>
<li><b>softwareversion</b> Gets the software version of detector server. Only get!</li>
</ul>
<ul>
<li><b>thisversion</b> Gets the software version of this client software. Only get!</li>
</ul>
<ul>
<li><b>receiverversion</b> Gets the software version of receiver. Only get!</li>
</ul>
<ul> <ul>
<li><b>timing [mode]</b> sets/gets synchronization mode of the detector. Mode: auto, trigger, ro_trigger, gating, triggered_gating</li> <li><b>timing [mode]</b> sets/gets synchronization mode of the detector. Mode: auto, trigger, ro_trigger, gating, triggered_gating</li>
</ul> </ul>

2
manual/slsDetectorClientDocs/html/index.html
View File

@ -64,7 +64,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li><a class="el" href="actions.html">Actions</a>: commands to define scripts to be executed during the acquisition flow</li> <li><a class="el" href="actions.html">Actions</a>: commands to define scripts to be executed during the acquisition flow</li>
<li><a class="el" href="network.html">Network</a>: commands to setup the network between client, detector and receiver</li> <li><a class="el" href="network.html">Network</a>: commands to setup the network between client, detector and receiver</li>
<li><a class="el" href="receiver.html">Receiver</a>: commands to configure the receiver</li> <li><a class="el" href="receiver.html">Receiver</a>: commands to configure the receiver</li>
<li><a class="el" href="test.html">Developer</a> Developer: commands to be used only for software debugging. Avoid using them! </li> <li><a class="el" href="test.html">Developer</a>: commands to be used only for software debugging. Avoid using them! </li>
</ul> </ul>
</div> </div>
<!--- window showing the filter options --> <!--- window showing the filter options -->

21
manual/slsDetectorClientDocs/html/test.html
View File

@ -55,6 +55,27 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li><b>flippeddatay [i]</b> enables/disables data being flipped across y axis. 1 enables, 0 disables. Not implemented.</li> <li><b>flippeddatay [i]</b> enables/disables data being flipped across y axis. 1 enables, 0 disables. Not implemented.</li>
</ul> </ul>
<ul> <ul>
<li><b>moduleversion:[i]</b> Gets the firmware version of module i. Used for MYTHEN only. Only get!</li>
</ul>
<ul>
<li><b>detectornumber</b> Gets the serial number or MAC of detector. Only get!</li>
</ul>
<ul>
<li><b>modulenumber:[i]</b> Gets the serial number of module i. Used for MYTHEN only. Only get!</li>
</ul>
<ul>
<li><b>detectorversion</b> Gets the firmware version of detector. Only get!</li>
</ul>
<ul>
<li><b>softwareversion</b> Gets the software version of detector server. Only get!</li>
</ul>
<ul>
<li><b>thisversion</b> Gets the software version of this client software. Only get!</li>
</ul>
<ul>
<li><b>receiverversion</b> Gets the software version of receiver. Only get!</li>
</ul>
<ul>
<li><b>digitest [i]</b> will perform test which will plot the unique channel identifier, instead of data. Only get!</li> <li><b>digitest [i]</b> will perform test which will plot the unique channel identifier, instead of data. Only get!</li>
</ul> </ul>
<ul> <ul>

47
manual/slsDetectorClientDocs/latex/config.tex
View File

@ -1,4 +1,10 @@
Commands to configure the detector. these commands are often left to the configuration file. Commands to configure the detector. these commands are often left to the configuration file.
\begin{DoxyItemize}
\item \hyperlink{config_detstructure}{Detector Structure}: commands to configure detector structure
\item \hyperlink{config_detstatus}{Detector Status}: commands to configure detector status
\item \hyperlink{config_versions}{Versions}: commands to check version of each subsytem
\end{DoxyItemize}\hypertarget{config_detstructure}{}\subsection{Detector Structure}\label{config_detstructure}
commands to configure detector structure
\begin{DoxyItemize} \begin{DoxyItemize}
@ -43,7 +49,8 @@ Commands to configure the detector. these commands are often left to the configu
\begin{DoxyItemize} \begin{DoxyItemize}
\item {\bfseries sync} Sets/gets the synchronization mode of the detectors in the multi-\/detector structure. Can be: {\ttfamily none}, {\ttfamily gating}, {\ttfamily trigger}, {\ttfamily complementary}. Mainly used by MYTHEN/GOTTHARD. \item {\bfseries sync} Sets/gets the synchronization mode of the detectors in the multi-\/detector structure. Can be: {\ttfamily none}, {\ttfamily gating}, {\ttfamily trigger}, {\ttfamily complementary}. Mainly used by MYTHEN/GOTTHARD.
\end{DoxyItemize} \end{DoxyItemize}\hypertarget{config_detstatus}{}\subsection{Detector Status}\label{config_detstatus}
commands to configure detector status
\begin{DoxyItemize} \begin{DoxyItemize}
@ -129,42 +136,8 @@ Commands to configure the detector. these commands are often left to the configu
\begin{DoxyItemize} \begin{DoxyItemize}
\item {\bfseries led \mbox{[}i\mbox{]}} sets/gets the led status. 1 on, 0 off. Used for MOENCH only ?? \item {\bfseries led \mbox{[}i\mbox{]}} sets/gets the led status. 1 on, 0 off. Used for MOENCH only ??
\end{DoxyItemize} \end{DoxyItemize}\hypertarget{config_versions}{}\subsection{Versions}\label{config_versions}
Commands to check versions of each subsystem
\begin{DoxyItemize}
\item {\bfseries moduleversion:\mbox{[}i\mbox{]}} Gets the firmware version of module i. Used for MYTHEN only. Only get!
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries detectornumber} Gets the serial number or MAC of detector. Only get!
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries modulenumber:\mbox{[}i\mbox{]}} Gets the serial number of module i. Used for MYTHEN only. Only get!
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries detectorversion} Gets the firmware version of detector. Only get!
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries softwareversion} Gets the software version of detector server. Only get!
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries thisversion} Gets the software version of this client software. Only get!
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries receiverversion} Gets the software version of receiver. Only get!
\end{DoxyItemize}
\begin{DoxyItemize} \begin{DoxyItemize}

4
manual/slsDetectorClientDocs/latex/doxygen.sty
View File

@ -24,9 +24,9 @@
\fancyplain{}{\bfseries\thepage}% \fancyplain{}{\bfseries\thepage}%
} }
\rfoot[\fancyplain{}{\bfseries\scriptsize% \rfoot[\fancyplain{}{\bfseries\scriptsize%
Generated on Wed Aug 16 11:13:18 2017 by Doxygen }]{} Generated on Wed Aug 16 11:49:38 2017 by Doxygen }]{}
\lfoot[]{\fancyplain{}{\bfseries\scriptsize% \lfoot[]{\fancyplain{}{\bfseries\scriptsize%
Generated on Wed Aug 16 11:13:18 2017 by Doxygen }} Generated on Wed Aug 16 11:49:38 2017 by Doxygen }}
\cfoot{} \cfoot{}
%---------- Internal commands used in this style file ---------------- %---------- Internal commands used in this style file ----------------

2
manual/slsDetectorClientDocs/latex/index.tex
View File

@ -40,5 +40,5 @@ The commands are sudivided into different pages depending on their functionaliti
\item \hyperlink{actions}{Actions}: commands to define scripts to be executed during the acquisition flow \item \hyperlink{actions}{Actions}: commands to define scripts to be executed during the acquisition flow
\item \hyperlink{network}{Network}: commands to setup the network between client, detector and receiver \item \hyperlink{network}{Network}: commands to setup the network between client, detector and receiver
\item \hyperlink{receiver}{Receiver}: commands to configure the receiver \item \hyperlink{receiver}{Receiver}: commands to configure the receiver
\item \hyperlink{test}{Developer} Developer: commands to be used only for software debugging. Avoid using them! \item \hyperlink{test}{Developer}: commands to be used only for software debugging. Avoid using them!
\end{DoxyItemize} \end{DoxyItemize}

2
manual/slsDetectorClientDocs/latex/refman.tex
View File

@ -40,7 +40,7 @@
\vspace*{1cm} \vspace*{1cm}
{\large Generated by Doxygen 1.6.1}\\ {\large Generated by Doxygen 1.6.1}\\
\vspace*{0.5cm} \vspace*{0.5cm}
{\small Wed Aug 16 11:13:18 2017}\\ {\small Wed Aug 16 11:49:38 2017}\\
\end{center} \end{center}
\end{titlepage} \end{titlepage}
\pagenumbering{roman} \pagenumbering{roman}

35
manual/slsDetectorClientDocs/latex/test.tex
View File

@ -24,6 +24,41 @@ Commands to be used only for software debugging. Avoid using them!
\end{DoxyItemize} \end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries moduleversion:\mbox{[}i\mbox{]}} Gets the firmware version of module i. Used for MYTHEN only. Only get!
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries detectornumber} Gets the serial number or MAC of detector. Only get!
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries modulenumber:\mbox{[}i\mbox{]}} Gets the serial number of module i. Used for MYTHEN only. Only get!
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries detectorversion} Gets the firmware version of detector. Only get!
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries softwareversion} Gets the software version of detector server. Only get!
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries thisversion} Gets the software version of this client software. Only get!
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries receiverversion} Gets the software version of receiver. Only get!
\end{DoxyItemize}
\begin{DoxyItemize} \begin{DoxyItemize}
\item {\bfseries digitest \mbox{[}i\mbox{]}} will perform test which will plot the unique channel identifier, instead of data. Only get! \item {\bfseries digitest \mbox{[}i\mbox{]}} will perform test which will plot the unique channel identifier, instead of data. Only get!
\end{DoxyItemize} \end{DoxyItemize}