Merge branch '3.0-rc' of git.psi.ch:sls_detectors_software/sls_detectors_package into 3.0-rc

manual/manual-client/Eiger_short.tex

@@ -6,6 +6,9 @@
 \usepackage{verbatim}
 \usepackage{xspace}
 \newcommand{\E}{EIGER\xspace}  
+\newcommand{\p}{sls\_detector\_put}
+\newcommand{\g}{sls\_detector\_get}
+
 \begin{document}
 
 \title{\E - short manual}
@@ -137,6 +140,7 @@ returns the client version. The answer can be {\tt{thisversion 111220160718}}.
 /sls_detector_get detectorversion
 \end{verbatim}
 returns the firmware version . The answer can be {\tt{detectorversion 11}}.
+Killing and starting the server on the boards allows you to check the firmware version you have and also if your board is a top/bottom/master/slave.
 
 \section{Setting up the threshold}
 \begin{verbatim}
@@ -333,6 +337,141 @@ sls_detector_put 0-ratecorr -1
 \end{verbatim}
 
 Every time either the rate corrections are activated, $\tau$ is changed or the subframe length is changed, then a new correction table is evaluated. Note that computing the correction table is time consuming. 
+
+\section{Client checks - command line}
+
+Guide on returned strings:
+\begin{enumerate}
+\item \begin{verbatim}
+sls_detector_get free
+\end{verbatim}
+Returns a list of shared mamories cleaned (variable number depending on detector):
+\begin{verbatim}
+Shared memory 273612805 deleted
+Shared memory 276922374 deleted
+Shared memory 270270468 deleted
+free freed
+\end{verbatim}
+Note that occasionally if there is a shared memory of a different size (from an older software version), it will return also a line like this:
+\begin{verbatim}
+*** shmget error (server) ***-1
+\end{verbatim}
+This needs to be cleaned with {\tt{ipcs -m}} and then {\tt{ipcrm -M xxx}}, where xxx are the keys with nattch 0. 
+\item \begin{verbatim}sls_detector_get settings
+settings standard
+\end{verbatim} 
+{\tt{standard}} is only if correct. {\tt{undefined}} or anything else is wrong. 
+
+\item \begin{verbatim}
+sls_detector_get threshold
+threshold xxxx
+\end{verbatim}
+Returns the threshold in eV (xxxx). If it fails to set it, returns the last threshold it was set (which the detector still has). 
+
+\item \begin{verbatim}
+sls_detector_get fname
+fname string
+\end{verbatim}
+
+\item \begin{verbatim}
+sls_detector_get exptime
+exptime number
+\end{verbatim}
+where {\tt{number}} is a string to be interpreted as a float in (s). 
+
+\item \begin{verbatim}
+sls_detector_get period
+period number
+\end{verbatim}
+where {\tt{nuymber}} is a string to be interpreted as a float in (s). 
+
+\item \begin{verbatim}
+sls_detector_get frames
+frames number 
+\end{verbatim}
+where {\tt{number}} is a string to be interpreted as an integer.
+
+\item \begin{verbatim}
+sls_detector_get cycles
+cycles number 
+\end{verbatim}
+where {\tt{number}} is a string to be interpreted as an integer.
+
+\item \begin{verbatim}
+sls_detector_get status
+status string 
+\end{verbatim}
+where {\tt{string}} can be {\tt{idle}} or {\tt{running}}.
+
+\item \begin{verbatim}
+sls_detector_get index
+status number
+\end{verbatim}
+where {\tt{number}} is a string to be interpreted as an integer.
+
+\item \begin{verbatim}
+sls_detector_get dr
+dr number
+\end{verbatim}
+where {\tt{number}} is a string that should be interpreted as an integer (4/8/16/32).
+
+\item \begin{verbatim}
+sls_detector_get clkdivider
+clkdivider number
+\end{verbatim}
+where {\tt{number}} is a string that should be interpreted as an integer (0/1/2/3).
+
+\item \begin{verbatim}
+sls_detector_get flags
+flags string1 string2 
+\end{verbatim}
+where {\tt{string1}} is a string should be always {\tt{continous}} and {\tt{string2}} can be either {\tt{nonparallel}} or {\tt{parallel}}.
+
+\item \begin{verbatim}
+sls_detector_get timing 
+timing string
+\end{verbatim}
+where {\tt{string}} is a string which can be {\tt{auto/trigger/burst\_trigger/gating}}.
+
+\item \begin{verbatim}
+sls_detector_get enablefwrite
+enablefwrite number
+\end{verbatim}
+where {\tt{number}} is a string which should be interpreted as an integer "0" or "1".
+
+\item \begin{verbatim}
+sls_detector_get framescaught
+framescaught number
+\end{verbatim}
+where {\tt{number}} is a string which should be interpreted as an integer of the complete frames got by the receiver.
+
+\item \begin{verbatim}
+sls_detector_get frameindex
+frameindex number
+\end{verbatim}
+where {\tt{number}} is a string which should be interpreted as an integer of the last frame number read from firmware. It comes from the receiver, though and reset after every acquisition series.
+
+\item \begin{verbatim}
+sls_detector_get subexptime
+subexptime number
+\end{verbatim}
+where {\tt{number}} is a string that should be interpreted as a float in s. The default value is 0.002621440. 
+
+\item \begin{verbatim}
+sls_detector_get ratecorr
+ratecorr number
+\end{verbatim}
+where {\tt{number}} is a string that should be interpreted as a float in s.  0.000000 means correction off. Values above zero are the value of $\tau$ in ns.
+
+\item \begin{verbatim}
+sls_detector_get m:vhighvoltage
+m:vhighvoltage number
+\end{verbatim}
+where {\tt{number}} is a string that should be interpreted as an int and for proper Eiger setting is approximately 150~V.  
+
+\end{enumerate}
+
+
 \section{1Gb/s, 10Gb/s links}
 \subsection{Checking the 1Gb/s, 10Gb/s physical links}
 LEDs on the backpanel board at the back of each half module signal:
@@ -472,7 +611,7 @@ The HV can also be set and read through the software:
 ./sls_detector_put vhighvoltage 150
 ./sls_detector_get m:vhighvoltage 
 \end{verbatim}
-Note that the get {\tt{vhighvoltage}} would return the measured HV from the master module only, so one has to really get it for the master \tt{m} module.
+Note that the get {\tt{vhighvoltage}} would return the measured HV from the master module only, so one has to really get it for the master {\tt{m}} module.
 
 \appendix