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

Merge branch '3.0-rc' into developer

Browse Source
This commit is contained in:
Dhanya Maliakal 2017-08-17 13:56:09 +02:00
commit b9cd0054a9
18 changed files with 189 additions and 132 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
RELEASE.txt
View File

@ -85,6 +85,10 @@ Reiterating, both 2.3 and 3.0 supports the following features:
file write (so we dont write) and register the callbacks (so the user gets
the data).
4. Multiple Receivers have to be started as different processes, instead of threads
due to static variables being used. Please refer example code provided in the
slsDetectorsPackage/users folder (mainReceiver.cpp).
New Features
@ -166,7 +170,10 @@ Resolved Issues
4. (Eiger/Jungfrau) Bug Fix: Client crashing should not crash the server as SIGPIPE
signal is caught.
5. (Eiger) Buf Fix: Front End Temperature read out conversion fixed.
5. (Eiger) Bug Fix: Front End Temperature read out conversion fixed.
6. (Eiger) Bug Fix: sls_detector_get trimval(get all trimbits) would return only the first pixel
value. Now it returns -1 if all the pixels are different.
Receiver

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

@ -78,7 +78,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</iframe>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 16 Aug 2017 by&nbsp;
<hr size="1"/><address style="text-align: right;"><small>Generated on 17 Aug 2017 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>

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

@ -129,7 +129,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</iframe>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 16 Aug 2017 by&nbsp;
<hr size="1"/><address style="text-align: right;"><small>Generated on 17 Aug 2017 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>

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

@ -54,7 +54,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</iframe>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 16 Aug 2017 by&nbsp;
<hr size="1"/><address style="text-align: right;"><small>Generated on 17 Aug 2017 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>

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

@ -40,14 +40,21 @@ 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>
<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#detsize">Detector Data Size</a>: commands to configure detector data size</li>
<li><a class="el" href="config.html#versions">Versions</a>: commands to check version of each subsytem</li>
<li><a class="el" href="config.html#configstructure">Data Structure</a>: commands to configure detector data structure</li>
<li><a class="el" href="config.html#configstatus">Status</a>: commands to configure detector status</li>
<li><a class="el" href="config.html#configsize">Data Size</a>: commands to configure detector data size</li>
<li><a class="el" href="config.html#configflags">Flags</a>: commands to configure detector flags</li>
<li><a class="el" href="config.html#configfpga">FPGA</a>: commands to configure FPGA of the detector</li>
<li><a class="el" href="config.html#configchip">Chip</a>: commands to configure chip of the detector</li>
<li><a class="el" href="config.html#configversions">Versions</a>: commands to check version of each subsytem</li>
<li><a class="el" href="config.html#configtimers">Timers</a>: commands to configure the timers of the detector</li>
<li><a class="el" href="config.html#configrotimers">RO Timers</a>: commands to configure the read only timers of the detector</li>
<li><a class="el" href="config.html#configspeed">Speed</a>: commands to configure speed of detector</li>
<li><a class="el" href="config.html#configsettings">Detector Parameters</a>: commands to configure/retrieve configuration of detector</li>
</ul>
<h2><a class="anchor" id="detstructure">
Detector Structure</a></h2>
<p>commands to configure detector structure</p>
<h2><a class="anchor" id="configstructure">
Data Structure</a></h2>
<p>commands to configure detector data structure</p>
<ul>
<li><b>datastream</b> enables/disables the 0MQ data stream (0MQ threads created) from receiver to client.</li>
</ul>
@ -75,8 +82,8 @@ Detector Structure</a></h2>
<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>
</ul>
<h2><a class="anchor" id="detstatus">
Detector Status</a></h2>
<h2><a class="anchor" id="configstatus">
Status</a></h2>
<p>commands to configure detector status</p>
<ul>
<li><b>online [i]</b> sets the detector in online (1) or offline (0) mode</li>
@ -87,8 +94,8 @@ Detector Status</a></h2>
<ul>
<li><b>activate</b> Activates/Deactivates the detector. Deactivated detector does not send data. Used for EIGER only.</li>
</ul>
<h2><a class="anchor" id="detsize">
Detector Data Size</a></h2>
<h2><a class="anchor" id="configsize">
Data Size</a></h2>
<p>commands to configure detector data size</p>
<ul>
<li><b>nmod [i]</b> sets/gets the number of modules of the detector. Used for MYTHEN only.</li>
@ -111,9 +118,9 @@ Detector Data Size</a></h2>
<ul>
<li><b>flippeddatax [i]</b> enables/disables data being flipped across x axis. 1 enables, 0 disables. Used for EIGER only. 1 for bottom half-module, 0 for top-half module.</li>
</ul>
<ul>
<li><b>lock [i]</b> Locks/Unlocks the detector to communicate with this client. 1 locks, 0 unlocks.</li>
</ul>
<h2><a class="anchor" id="configflags">
Flags</a></h2>
<p>commands to configure detector flags</p>
<ul>
<li><b>flags [flag]</b> sets/gets the readout flags to mode. Options: none, storeinram, tot, continous, parallel, nonparallel, safe, digital, analog_digital, unknown. Used for MYTHEN and EIGER only.</li>
</ul>
@ -121,22 +128,61 @@ Detector Data Size</a></h2>
<li><b>extsig:[i] [flag]</b> sets/gets the mode of the external signal i. Options: <code>off</code>, <code>gate_in_active_high</code>, <code>gate_in_active_low</code>, <code>trigger_in_rising_edge</code>, <code>trigger_in_falling_edge</code>, <code>ro_trigger_in_rising_edge</code>, <code>ro_trigger_in_falling_edge</code>, <code>gate_out_active_high</code>, <code>gate_out_active_low</code>, <code>trigger_out_rising_edge</code>, <code>trigger_out_falling_edge</code>, <code>ro_trigger_out_rising_edge</code>, <code>ro_trigger_out_falling_edge</code>. <br/>
Used in MYTHEN, GOTTHARD, PROPIX only.</li>
</ul>
<h2><a class="anchor" id="configfpga">
FPGA</a></h2>
<p>commands to configure FPGA of the detector</p>
<ul>
<li><b>programfpga [file]</b> programs the FPGA with file f (with .pof extension). Used for JUNGFRAU, MOENCH only. Only put!</li>
</ul>
<ul>
<li><b>resetfpga [f]</b> resets FPGA, where f can be any value. Used for JUNGFRAU only. Only put!</li>
</ul>
<h2><a class="anchor" id="configchip">
Chip</a></h2>
<p>commands to configure chip of the detector</p>
<ul>
<li><b>powerchip [i]</b> Powers on/off the chip. 1 powers on, 0 powers off. Can also get the power status. Used for JUNGFRAU only.</li>
</ul>
<ul>
<li><b>led [i]</b> sets/gets the led status. 1 on, 0 off. Used for MOENCH only ??</li>
</ul>
<h2><a class="anchor" id="versions">
<ul>
<li><b>pulse [n] [x] [y]</b> pulses pixel at coordinates (x,y) n number of times. Used in EIGER only. Only put!</li>
</ul>
<ul>
<li><b>pulsenmove [n] [x] [y]</b> pulses pixel n number of times and moves relatively by x value (x axis) and y value(y axis). Used in EIGER only. Only put!</li>
</ul>
<ul>
<li><b>pulsechip [n]</b>pulses chip n number of times, while n=-1 will reset it to normal mode. Used in EIGER only. Only put!</li>
</ul>
<h2><a class="anchor" id="configversions">
Versions</a></h2>
<p>Commands to check versions of each subsystem</p>
<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>
<h2><a class="anchor" id="configtimers">
Timers</a></h2>
<p>commands to configure the timers of the detector</p>
<ul>
<li><b>timing [mode]</b> sets/gets synchronization mode of the detector. Mode: auto, trigger, ro_trigger, gating, triggered_gating</li>
</ul>
<ul>
@ -169,6 +215,9 @@ Versions</a></h2>
<ul>
<li><b>samples [i]</b> sets/gets number of samples expected from the jctb. Used in CHIP TEST BOARD only.</li>
</ul>
<h2><a class="anchor" id="configrotimers">
RO Timers</a></h2>
<p>commands to configure the read only timers of the detector</p>
<ul>
<li><b>exptimel</b> gets exposure time left. Used in MYTHEN, GOTTHARD only. Only get!</li>
</ul>
@ -199,6 +248,9 @@ Versions</a></h2>
<ul>
<li><b>nframes</b> ??? Only get!</li>
</ul>
<h2><a class="anchor" id="configspeed">
Speed</a></h2>
<p>commands to configure speed of detector</p>
<ul>
<li><b>clkdivider [i]</b> sets/gets the readout clock divider. EIGER, JUNGFRAU [0(fast speed), 1(half speed), 2(quarter speed)]. MYTHEN[???]</li>
</ul>
@ -236,6 +288,12 @@ Versions</a></h2>
<li><b>dbitphase [i]</b> ???</li>
</ul>
<ul>
<li><b>dbitpipeline [i]</b> ???</li>
</ul>
<h2><a class="anchor" id="configsettings">
Detector Parameters</a></h2>
<p>commands to configure/retrieve configuration of detector</p>
<ul>
<li><b>config [fname]</b> sets/saves detector/receiver to configuration contained in fname. Same as executing sls_detector_put for every line. Normally a one time operation.</li>
</ul>
<ul>
@ -248,16 +306,7 @@ Versions</a></h2>
<li><b>setup [fname]</b> sets/saves detector complete setup contained in fname (extensions automatically generated), including trimfiles, ff coefficients etc.</li>
</ul>
<ul>
<li><b>tengiga [i]</b> enables/disables 10GbE in system (detector &amp; receiver). 1 enabled 10GbE, 0 enables 1GbE. Used in EIGER only.</li>
</ul>
<ul>
<li><b>pulse [n] [x] [y]</b> pulses pixel at coordinates (x,y) n number of times. Used in EIGER only. Only put!</li>
</ul>
<ul>
<li><b>pulsenmove [n] [x] [y]</b> pulses pixel n number of times and moves relatively by x value (x axis) and y value(y axis). Used in EIGER only. Only put!</li>
</ul>
<ul>
<li><b>pulsechip [n]</b>pulses chip n number of times, while n=-1 will reset it to normal mode. Used in EIGER only. Only put! </li>
<li><b>tengiga [i]</b> enables/disables 10GbE in system (detector &amp; receiver). 1 enabled 10GbE, 0 enables 1GbE. Used in EIGER only. </li>
</ul>
</div>
<!--- window showing the filter options -->
@ -274,7 +323,7 @@ Versions</a></h2>
</iframe>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 16 Aug 2017 by&nbsp;
<hr size="1"/><address style="text-align: right;"><small>Generated on 17 Aug 2017 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>

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

@ -99,7 +99,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</iframe>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 16 Aug 2017 by&nbsp;
<hr size="1"/><address style="text-align: right;"><small>Generated on 17 Aug 2017 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>

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

@ -82,7 +82,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</iframe>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 16 Aug 2017 by&nbsp;
<hr size="1"/><address style="text-align: right;"><small>Generated on 17 Aug 2017 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>

5
manual/slsDetectorClientDocs/html/network.html
View File

@ -88,6 +88,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li><b>stopport [port]</b> sets/gets the port of the client-detector stop server TCP interface. Use single-detector command. Default value is 1953 for all detectors. Normally not changed.</li>
</ul>
<ul>
<li><b>lock [i]</b> Locks/Unlocks the detector to communicate with this client. 1 locks, 0 unlocks.</li>
</ul>
<ul>
<li><b>lastclient </b> Gets the last client communicating with the detector. Cannot put! </li>
</ul>
</div>
@ -105,7 +108,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</iframe>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 16 Aug 2017 by&nbsp;
<hr size="1"/><address style="text-align: right;"><small>Generated on 17 Aug 2017 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>

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

@ -75,7 +75,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</iframe>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 16 Aug 2017 by&nbsp;
<hr size="1"/><address style="text-align: right;"><small>Generated on 17 Aug 2017 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>

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

@ -75,7 +75,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</iframe>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 16 Aug 2017 by&nbsp;
<hr size="1"/><address style="text-align: right;"><small>Generated on 17 Aug 2017 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>

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

@ -84,7 +84,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</iframe>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 16 Aug 2017 by&nbsp;
<hr size="1"/><address style="text-align: right;"><small>Generated on 17 Aug 2017 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>

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

@ -286,7 +286,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</iframe>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 16 Aug 2017 by&nbsp;
<hr size="1"/><address style="text-align: right;"><small>Generated on 17 Aug 2017 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>

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

@ -55,27 +55,6 @@ 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>
</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>
</ul>
<ul>
@ -117,7 +96,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</iframe>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 16 Aug 2017 by&nbsp;
<hr size="1"/><address style="text-align: right;"><small>Generated on 17 Aug 2017 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>

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

@ -1,11 +1,18 @@
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_detsize}{Detector Data Size}: commands to configure detector data size
\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
\item \hyperlink{config_configstructure}{Data Structure}: commands to configure detector data structure
\item \hyperlink{config_configstatus}{Status}: commands to configure detector status
\item \hyperlink{config_configsize}{Data Size}: commands to configure detector data size
\item \hyperlink{config_configflags}{Flags}: commands to configure detector flags
\item \hyperlink{config_configfpga}{FPGA}: commands to configure FPGA of the detector
\item \hyperlink{config_configchip}{Chip}: commands to configure chip of the detector
\item \hyperlink{config_configversions}{Versions}: commands to check version of each subsytem
\item \hyperlink{config_configtimers}{Timers}: commands to configure the timers of the detector
\item \hyperlink{config_configrotimers}{RO Timers}: commands to configure the read only timers of the detector
\item \hyperlink{config_configspeed}{Speed}: commands to configure speed of detector
\item \hyperlink{config_configsettings}{Detector Parameters}: commands to configure/retrieve configuration of detector
\end{DoxyItemize}\hypertarget{config_configstructure}{}\subsection{Data Structure}\label{config_configstructure}
commands to configure detector data structure
\begin{DoxyItemize}
@ -50,7 +57,7 @@ commands to configure detector structure
\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.
\end{DoxyItemize}\hypertarget{config_detstatus}{}\subsection{Detector Status}\label{config_detstatus}
\end{DoxyItemize}\hypertarget{config_configstatus}{}\subsection{Status}\label{config_configstatus}
commands to configure detector status
@ -66,7 +73,7 @@ commands to configure detector status
\begin{DoxyItemize}
\item {\bfseries activate} Activates/Deactivates the detector. Deactivated detector does not send data. Used for EIGER only.
\end{DoxyItemize}\hypertarget{config_detsize}{}\subsection{Detector Data Size}\label{config_detsize}
\end{DoxyItemize}\hypertarget{config_configsize}{}\subsection{Data Size}\label{config_configsize}
commands to configure detector data size
@ -102,12 +109,8 @@ commands to configure detector data size
\begin{DoxyItemize}
\item {\bfseries flippeddatax \mbox{[}i\mbox{]}} enables/disables data being flipped across x axis. 1 enables, 0 disables. Used for EIGER only. 1 for bottom half-\/module, 0 for top-\/half module.
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries lock \mbox{[}i\mbox{]}} Locks/Unlocks the detector to communicate with this client. 1 locks, 0 unlocks.
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{config_configflags}{}\subsection{Flags}\label{config_configflags}
commands to configure detector flags
\begin{DoxyItemize}
@ -118,7 +121,8 @@ commands to configure detector data size
\begin{DoxyItemize}
\item {\bfseries extsig:\mbox{[}i\mbox{]} \mbox{[}flag\mbox{]}} sets/gets the mode of the external signal i. Options: {\ttfamily off}, {\ttfamily gate\_\-in\_\-active\_\-high}, {\ttfamily gate\_\-in\_\-active\_\-low}, {\ttfamily trigger\_\-in\_\-rising\_\-edge}, {\ttfamily trigger\_\-in\_\-falling\_\-edge}, {\ttfamily ro\_\-trigger\_\-in\_\-rising\_\-edge}, {\ttfamily ro\_\-trigger\_\-in\_\-falling\_\-edge}, {\ttfamily gate\_\-out\_\-active\_\-high}, {\ttfamily gate\_\-out\_\-active\_\-low}, {\ttfamily trigger\_\-out\_\-rising\_\-edge}, {\ttfamily trigger\_\-out\_\-falling\_\-edge}, {\ttfamily ro\_\-trigger\_\-out\_\-rising\_\-edge}, {\ttfamily ro\_\-trigger\_\-out\_\-falling\_\-edge}. \par
Used in MYTHEN, GOTTHARD, PROPIX only.
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{config_configfpga}{}\subsection{FPGA}\label{config_configfpga}
commands to configure FPGA of the detector
\begin{DoxyItemize}
@ -128,7 +132,8 @@ commands to configure detector data size
\begin{DoxyItemize}
\item {\bfseries resetfpga \mbox{[}f\mbox{]}} resets FPGA, where f can be any value. Used for JUNGFRAU only. Only put!
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{config_configchip}{}\subsection{Chip}\label{config_configchip}
commands to configure chip of the detector
\begin{DoxyItemize}
@ -138,10 +143,61 @@ commands to configure detector data size
\begin{DoxyItemize}
\item {\bfseries led \mbox{[}i\mbox{]}} sets/gets the led status. 1 on, 0 off. Used for MOENCH only ??
\end{DoxyItemize}\hypertarget{config_versions}{}\subsection{Versions}\label{config_versions}
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries pulse \mbox{[}n\mbox{]} \mbox{[}x\mbox{]} \mbox{[}y\mbox{]}} pulses pixel at coordinates (x,y) n number of times. Used in EIGER only. Only put!
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries pulsenmove \mbox{[}n\mbox{]} \mbox{[}x\mbox{]} \mbox{[}y\mbox{]}} pulses pixel n number of times and moves relatively by x value (x axis) and y value(y axis). Used in EIGER only. Only put!
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries pulsechip \mbox{[}n\mbox{]}}pulses chip n number of times, while n=-\/1 will reset it to normal mode. Used in EIGER only. Only put!
\end{DoxyItemize}\hypertarget{config_configversions}{}\subsection{Versions}\label{config_configversions}
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}\hypertarget{config_configtimers}{}\subsection{Timers}\label{config_configtimers}
commands to configure the timers of the detector
\begin{DoxyItemize}
\item {\bfseries timing \mbox{[}mode\mbox{]}} sets/gets synchronization mode of the detector. Mode: auto, trigger, ro\_\-trigger, gating, triggered\_\-gating
\end{DoxyItemize}
@ -194,7 +250,8 @@ Commands to check versions of each subsystem
\begin{DoxyItemize}
\item {\bfseries samples \mbox{[}i\mbox{]}} sets/gets number of samples expected from the jctb. Used in CHIP TEST BOARD only.
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{config_configrotimers}{}\subsection{RO Timers}\label{config_configrotimers}
commands to configure the read only timers of the detector
\begin{DoxyItemize}
@ -244,7 +301,8 @@ Commands to check versions of each subsystem
\begin{DoxyItemize}
\item {\bfseries nframes} ??? Only get!
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{config_configspeed}{}\subsection{Speed}\label{config_configspeed}
commands to configure speed of detector
\begin{DoxyItemize}
@ -307,6 +365,12 @@ Commands to check versions of each subsystem
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries dbitpipeline \mbox{[}i\mbox{]}} ???
\end{DoxyItemize}\hypertarget{config_configsettings}{}\subsection{Detector Parameters}\label{config_configsettings}
commands to configure/retrieve configuration of detector
\begin{DoxyItemize}
\item {\bfseries config \mbox{[}fname\mbox{]}} sets/saves detector/receiver to configuration contained in fname. Same as executing sls\_\-detector\_\-put for every line. Normally a one time operation.
\end{DoxyItemize}
@ -328,20 +392,5 @@ Commands to check versions of each subsystem
\begin{DoxyItemize}
\item {\bfseries tengiga \mbox{[}i\mbox{]}} enables/disables 10GbE in system (detector \& receiver). 1 enabled 10GbE, 0 enables 1GbE. Used in EIGER only.
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries pulse \mbox{[}n\mbox{]} \mbox{[}x\mbox{]} \mbox{[}y\mbox{]}} pulses pixel at coordinates (x,y) n number of times. Used in EIGER only. Only put!
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries pulsenmove \mbox{[}n\mbox{]} \mbox{[}x\mbox{]} \mbox{[}y\mbox{]}} pulses pixel n number of times and moves relatively by x value (x axis) and y value(y axis). Used in EIGER only. Only put!
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries pulsechip \mbox{[}n\mbox{]}}pulses chip n number of times, while n=-\/1 will reset it to normal mode. Used in EIGER only. Only put!
\item {\bfseries tengiga \mbox{[}i\mbox{]}} enables/disables 10GbE in system (detector \& receiver). 1 enabled 10GbE, 0 enables 1GbE. Used in EIGER only.
\end{DoxyItemize}

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

@ -24,9 +24,9 @@
\fancyplain{}{\bfseries\thepage}%
}
\rfoot[\fancyplain{}{\bfseries\scriptsize%
Generated on Wed Aug 16 19:04:48 2017 by Doxygen }]{}
Generated on Thu Aug 17 13:55:05 2017 by Doxygen }]{}
\lfoot[]{\fancyplain{}{\bfseries\scriptsize%
Generated on Wed Aug 16 19:04:48 2017 by Doxygen }}
Generated on Thu Aug 17 13:55:05 2017 by Doxygen }}
\cfoot{}
%---------- Internal commands used in this style file ----------------

5
manual/slsDetectorClientDocs/latex/network.tex
View File

@ -79,6 +79,11 @@ Commands to setup the network between client, detector and receiver
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries lock \mbox{[}i\mbox{]}} Locks/Unlocks the detector to communicate with this client. 1 locks, 0 unlocks.
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries lastclient } Gets the last client communicating with the detector. Cannot put!
\end{DoxyItemize}

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

@ -40,7 +40,7 @@
\vspace*{1cm}
{\large Generated by Doxygen 1.6.1}\\
\vspace*{0.5cm}
{\small Wed Aug 16 19:04:48 2017}\\
{\small Thu Aug 17 13:55:05 2017}\\
\end{center}
\end{titlepage}
\pagenumbering{roman}

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

@ -24,41 +24,6 @@ Commands to be used only for software debugging. Avoid using them!
\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}
\item {\bfseries digitest \mbox{[}i\mbox{]}} will perform test which will plot the unique channel identifier, instead of data. Only get!
\end{DoxyItemize}