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

update client command doc

Browse Source
This commit is contained in:
Dhanya Maliakal
2017-08-16 19:06:17 +02:00
parent 24d6d2c24a
commit 45681f86ce
9 changed files with 560 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -2,6 +2,7 @@ Commands to configure the detector. these commands are often left to the configu
\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
@ -65,12 +66,8 @@ 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}
\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_detsize}{}\subsection{Detector Data Size}\label{config_detsize}
commands to configure detector data size
\begin{DoxyItemize}
@ -108,6 +105,11 @@ commands to configure detector status
\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 flags \mbox{[}flag\mbox{]}} 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.
\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 16:12:47 2017 by Doxygen }]{}
Generated on Wed Aug 16 19:04:48 2017 by Doxygen }]{}
\lfoot[]{\fancyplain{}{\bfseries\scriptsize%
Generated on Wed Aug 16 16:12:47 2017 by Doxygen }}
Generated on Wed Aug 16 19:04:48 2017 by Doxygen }}
\cfoot{}
%---------- Internal commands used in this style file ----------------

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

@ -32,13 +32,14 @@ For additional questions concerning the indexing of the detector, please refer t
The commands are sudivided into different pages depending on their functionalities:
\begin{DoxyItemize}
\item \hyperlink{acquisition}{Acquition commands} Acquisition: commands to start/stop the acquisition and retrieve data
\item \hyperlink{config}{Configuration commands} Configuration: commands to configure the detector
\item \hyperlink{acquisition}{Acquisition}: commands to start/stop the acquisition and retrieve data
\item \hyperlink{config}{Configuration}: commands to configure the detector
\item \hyperlink{data}{Data postprocessing}: commands to process the data -\/ mainly for MYTHEN except for rate corrections.
\item \hyperlink{settings}{Settings}: commands to define detector settings/threshold.
\item \hyperlink{output}{Output}: commands to define output file destination and format
\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{receiver}{Receiver}: commands to configure the receiver
\item \hyperlink{ctb}{Chiptest board}: commands specific for the new chiptest board as pattern generator
\item \hyperlink{test}{Developer}: commands to be used only for software debugging. Avoid using them!
\end{DoxyItemize}

6
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 16:12:47 2017}\\
{\small Wed Aug 16 19:04:48 2017}\\
\end{center}
\end{titlepage}
\pagenumbering{roman}
@ -85,6 +85,10 @@
\label{receiver}
\hypertarget{receiver}{}
\input{receiver}
\section{Chiptest board}
\label{ctb}
\hypertarget{ctb}{}
\input{ctb}
\section{Advanced Usage}
\label{advanced}
\hypertarget{advanced}{}

332
manual/slsDetectorClientDocs/latex/settings.tex
View File

@ -53,5 +53,335 @@ Commands to setup the settings of the detector
\begin{DoxyItemize}
\item {\bfseries pedestal \mbox{[}i\mbox{]}} starts acquisition for i frames, calculates pedestal and writes back to fpga. Used in GOTTHARD only. Only put!
\item {\bfseries pedestal \mbox{[}i\mbox{]}} starts acquisition for i frames, calculates pedestal and writes back to fpga. Used in GOTTHARD only. Only put!
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vthreshold \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets detector threshold voltage for single photon counters. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vcalibration \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets the voltage of the calibration pulses. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vtrimbit \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets the voltage to set the width of the trimbits. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vpreamp \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets the voltage to define the preamplifier feedback resistance. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vhaper1 \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets the voltage to define the feedback resistance of the first shaper. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vshaper2 \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets the voltage to define the feedback resistance of the second shaper. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vhighvoltage \mbox{[}i\mbox{]}} Sets/gets the high voltage to the sensor in V (int).
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vapower \mbox{[}i\mbox{]}} Sets/gets the analog power supply for the old chiptest board in DAC units (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vddpower \mbox{[}i\mbox{]}} Sets/gets the digital power supply for the old chiptest board in DAC units (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vshpower \mbox{[}i\mbox{]}} Sets/gets the comparator power supply for the old chiptest board in DAC units (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries viopower \mbox{[}i\mbox{]}} Sets/gets the power supply of the FPGA I/Os for the old chiptest board in DAC units (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vrefds \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets vrefds. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vcascn\_\-pb \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets vcascn\_\-pb. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vcasc\_\-pb \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets vcasc\_\-pb. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vout\_\-cm \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets vout\_\-cm. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vcasc\_\-out \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets vcasc\_\-out. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vin\_\-com \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets vin\_\-com. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vref\_\-comp \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets vref\_\-comp. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries ib\_\-test\_\-c \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets ib\_\-test\_\-c. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries dac\mbox{[}0..7\mbox{]} \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets dac\mbox{[}0..7\mbox{]} for MOENCH02. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vsvp \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets vsvp. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vsvn \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets vsvn. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vtr \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets vtr. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vrf \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets vrf. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vrs \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets vrs. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vtgstv \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets vtgstv. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vcmp\_\-ll \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets vcmp\_\-ll. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vcmp\_\-lr \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets vcmp\_\-lr. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vcal\_\-l \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets vcal\_\-l. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vcomp\_\-rl \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets vcomp\_\-rl. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vcomp\_\-rr \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets vcomp\_\-rr. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries rxb\_\-rb \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets rxb\_\-rb. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries rxb\_\-lb \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets rxb\_\-lb. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vcp \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets vcp. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vcn \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets vcn. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vis \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets vis. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries iodelay \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets iodelay. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries dac:j \mbox{[}i\mbox{]} \mbox{[}mv\mbox{]}} Sets/gets value for DAC number j for the new chiptestboard. Normally in DAC units unless {\ttfamily mv} is specified at the end of the command line (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries adcvpp \mbox{[}i\mbox{]} } Sets/gets the Vpp of the ADC 0 -\/$>$ 1V ; 1 -\/$>$ 1.14V ; 2 -\/$>$ 1.33V ; 3 -\/$>$ 1.6V ; 4 -\/$>$ 2V (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries v\_\-a \mbox{[}i\mbox{]} mv} Sets/gets value for Va on the new chiptest board. Must be in mV (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries v\_\-b \mbox{[}i\mbox{]} mv} Sets/gets value for Vb on the new chiptest board. Must be in mV (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries v\_\-c \mbox{[}i\mbox{]} mv} Sets/gets value for Vc on the new chiptest board. Must be in mV (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries v\_\-d \mbox{[}i\mbox{]} mv} Sets/gets value for Vd on the new chiptest board. Must be in mV (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries v\_\-io \mbox{[}i\mbox{]} mv} Sets/gets value for Vio on the new chiptest board. Must be in mV (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries v\_\-chip \mbox{[}i\mbox{]} mv} Sets/gets value for Vchip on the new chiptest board. Must be in mV (int). Normally don't use it!
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries v\_\-limit \mbox{[}i\mbox{]} mv} Sets/gets a soft limit for the power supplies and the DACs on the new chiptest board. Must be in mV (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries temp\_\-adc} Gets the ADC temperature (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries temp\_\-fpga} Gets the FPGA temperature (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries temp\_\-fpgaext} Gets the external FPGA temperature (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries temp\_\-10ge} Gets the 10Gbe temperature (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries temp\_\-dcdc} Gets the temperature of the DC/DC converter(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries temp\_\-sodl} Gets the temperature of the left so-\/dimm memory (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries temp\_\-sodr} Gets the temperature of the right so-\/dimm memory (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries adc:j} Gets the values of the slow ADC number j for the new chiptest board (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries temp\_\-fpgal} Gets the temperature of the left frontend FPGA (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries temp\_\-fpgar} Gets the temperature of the right frontend FPGA (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries i\_\-a} Gets the current of the power supply a on the new chiptest board (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries i\_\-b} Gets the current of the power supply b on the new chiptest board (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries i\_\-c} Gets the current of the power supply c on the new chiptest board (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries i\_\-d} Gets the current of the power supply d on the new chiptest board (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries i\_\-io} Gets the current of the power supply io on the new chiptest board (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vm\_\-a} Gets the measured voltage of the power supply a on the new chiptest board (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vm\_\-b} Gets the measured voltage of the power supply b on the new chiptest board (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vm\_\-c} Gets the measured voltage of the power supply c on the new chiptest board (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vm\_\-d} Gets the measured voltage of the power supply d on the new chiptest board (int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries vm\_\-io} Gets the measured voltage of the power supply io on the new chiptest board (int)
\end{DoxyItemize}