- id[:i] Returns the id of the detector structure. i is the detector position in a multi detector system. If used a
put
, configures the id of the detector structure. i is the detector position in a multi detector system and l is the id of the detector to be added.
@@ -86,161 +86,161 @@ Data Structure
Status
commands to configure detector status
-- online [i] sets the detector in online (1) or offline (0) mode
+- online [i] sets the detector in online (1) or offline (0) mode.
Returns
(int)
-- checkonline returns the hostnames of all detectors without connecting to them
+- checkonline returns the hostnames of all detectors without connecting to them.
Returns
(string) "All online" or "[list of offline hostnames] : Not online".
-- activate Activates/Deactivates the detector. Deactivated detector does not send data. Used for EIGER only.
+- activate Activates/Deactivates the detector. Deactivated detector does not send data. Used for EIGER only.
Returns
(int)
commands to configure detector data size
-- nmod [i] sets/gets the number of modules of the detector. Used for MYTHEN only.
+- nmod [i] sets/gets the number of modules of the detector. Used for MYTHEN only.
Returns
(int)
-- maxmod Gets the maximum number of modules of the detector. Used for MYTHEN only. Cannot put!
+- maxmod Gets the maximum number of modules of the detector. Used for MYTHEN only. Cannot put!
Returns
(int)
-- dr [i] sets/gets the dynamic range of detector. Mythen [4,8,16,24]. Eiger [4,8,16,32]. Others cannot put!
+- dr [i] sets/gets the dynamic range of detector. Mythen [4,8,16,24]. Eiger [4,8,16,32]. Others cannot put!
Returns
(int)
-- roi [i] [xmin] [xmax] [ymin] [ymax] sets region of interest of the detector, where i is number of rois;i=0 to clear rois. Used for GOTTHARD only.
+- roi [i] [xmin] [xmax] [ymin] [ymax] sets region of interest of the detector, where i is number of rois;i=0 to clear rois. Used for GOTTHARD only.
Returns
(int)
-- detsizechan [xmax] [ymax] sets the maximum number of channels in each dimension for complete detector set; -1 is no limit. Use for multi-detector system as first command in config file.
+- detsizechan [xmax] [ymax] sets the maximum number of channels in each dimension for complete detector set; -1 is no limit. Use for multi-detector system as first command in config file.
Returns
("int int")
-- roimask [i] ??
+- roimask [i] ??
Returns
(int) in hexadecimal
-- flippeddatax [i] 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.
+- flippeddatax [i] 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.
Returns
(int)
-- tengiga [i] enables/disables 10GbE in system (detector & receiver). 1 enabled 10GbE, 0 enables 1GbE. Used in EIGER only.
+- tengiga [i] enables/disables 10GbE in system (detector & receiver). 1 enabled 10GbE, 0 enables 1GbE. Used in EIGER only.
Returns
(int)
commands to configure detector flags
-- flags [flag] 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.
+- flags [flag] 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.
Returns
(string). put takes one string and returns
concatenation of all active flags separated by spaces.
- extsig:[i] [flag] sets/gets the mode of the external signal i. Options:
off
, gate_in_active_high
, gate_in_active_low
, trigger_in_rising_edge
, trigger_in_falling_edge
, ro_trigger_in_rising_edge
, ro_trigger_in_falling_edge
, gate_out_active_high
, gate_out_active_low
, trigger_out_rising_edge
, trigger_out_falling_edge
, ro_trigger_out_rising_edge
, ro_trigger_out_falling_edge
.
- Used in MYTHEN, GOTTHARD, PROPIX only.
+ Used in MYTHEN, GOTTHARD, PROPIX only. Returns
(string)
commands to configure FPGA of the detector
-- programfpga [file] programs the FPGA with file f (with .pof extension). Used for JUNGFRAU, MOENCH only. Only put!
+- programfpga [file] programs the FPGA with file f (with .pof extension). Used for JUNGFRAU, MOENCH only. Only put!
Returns
("successful", "unsuccessful")
-- resetfpga [f] resets FPGA, where f can be any value. Used for JUNGFRAU only. Only put!
+- resetfpga [f] resets FPGA, where f can be any value. Used for JUNGFRAU only. Only put!
Returns
("successful", "unsuccessful")
commands to configure chip of the detector
-- powerchip [i] Powers on/off the chip. 1 powers on, 0 powers off. Can also get the power status. Used for JUNGFRAU only.
+- powerchip [i] Powers on/off the chip. 1 powers on, 0 powers off. Can also get the power status. Used for JUNGFRAU only.
Returns
(int)
-- led [i] sets/gets the led status. 1 on, 0 off. Used for MOENCH only ??
+- led [i] sets/gets the led status. 1 on, 0 off. Used for MOENCH only ??
Returns
(int)
-- pulse [n] [x] [y] pulses pixel at coordinates (x,y) n number of times. Used in EIGER only. Only put!
+- pulse [n] [x] [y] pulses pixel at coordinates (x,y) n number of times. Used in EIGER only. Only put!
Returns
("successful", "unsuccessful")
-- pulsenmove [n] [x] [y] 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!
+- pulsenmove [n] [x] [y] 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!
Returns
("successful", "unsuccessful")
-- pulsechip [n]pulses chip n number of times, while n=-1 will reset it to normal mode. Used in EIGER only. Only put!
+- pulsechip [n]pulses chip n number of times, while n=-1 will reset it to normal mode. Used in EIGER only. Only put!
Returns
("successful", "unsuccessful")
Commands to check versions of each subsystem
-- moduleversion:[i] Gets the firmware version of module i. Used for MYTHEN only. Only get!
+- moduleversion:[i] Gets the firmware version of module i. Used for MYTHEN only. Only get!
Returns
(long int) in hexadecimal or "undefined module number"
-- detectornumber Gets the serial number or MAC of detector. Only get!
+- detectornumber Gets the serial number or MAC of detector. Only get!
Returns
(long int) in hexadecimal
-- modulenumber:[i] Gets the serial number of module i. Used for MYTHEN only. Only get!
+- modulenumber:[i] Gets the serial number of module i. Used for MYTHEN only. Only get!
Returns
(long int) in hexadecimal or "undefined module number"
-- detectorversion Gets the firmware version of detector. Only get!
+- detectorversion Gets the firmware version of detector. Only get!
Returns
(long int) in hexadecimal
-- softwareversion Gets the software version of detector server. Only get!
+- softwareversion Gets the software version of detector server. Only get!
Returns
(long int) in hexadecimal
-- thisversion Gets the software version of this client software. Only get!
+- thisversion Gets the software version of this client software. Only get!
Returns
(long int) in hexadecimal
-- receiverversion Gets the software version of receiver. Only get!
+- receiverversion Gets the software version of receiver. Only get!
Returns
(long int) in hexadecimal
commands to configure the timers of the detector
-- timing [mode] sets/gets synchronization mode of the detector. Mode: auto, trigger, ro_trigger, gating, triggered_gating
+- timing [mode] sets/gets synchronization mode of the detector. Mode: auto, trigger, ro_trigger, gating, triggered_gating
Returns
(string)
-- exptime [i] sets/gets exposure time in s
+- exptime [i] sets/gets exposure time in s.
Returns
(double with 9 decimal digits)
-- subexptime [i] sets/gets sub exposure time in s. Used in EIGER only in 32 bit mode.
+- subexptime [i] sets/gets sub exposure time in s. Used in EIGER only in 32 bit mode.
Returns
(double with 9 decimal digits)
-- period [i] sets/gets frame period in s.
+- period [i] sets/gets frame period in s.
Returns
(double with 9 decimal digits)
-- delay [i] sets/gets delay in s. Used in MYTHEN, GOTTHARD only
+- delay [i] sets/gets delay in s. Used in MYTHEN, GOTTHARD only.
Returns
(double with 9 decimal digits)
-- gates [i] sets/gets number of gates. Used in MYTHEN, GOTTHARD, EIGER only
+- gates [i] sets/gets number of gates. Used in MYTHEN, GOTTHARD only.
Returns
(long long int)
-- gates [i] sets/gets number of frames. If
timing
is not auto
, then it is the number of frames per cycle/trigger.
+- frames [i] sets/gets number of frames. If
timing
is not auto
, then it is the number of frames per cycle/trigger. Returns
(long long int)
-- cycles [i] sets/gets number of triggers. Timing mode should be set appropriately.
+- cycles [i] sets/gets number of triggers. Timing mode should be set appropriately.
Returns
(long long int)
-- probes [i] sets/gets number of probes to accumulate. When setting, max 3! cycles should be set to 1, frames to the number of pump-probe events. Used in MYTHEN only
+- probes [i] sets/gets number of probes to accumulate. When setting, max 3! cycles should be set to 1, frames to the number of pump-probe events. Used in MYTHEN only.
Returns
(long long int)
-- measurements [i] sets/gets number of measurements.
+- measurements [i] sets/gets number of measurements.
Returns
(long long int)
-- samples [i] sets/gets number of samples expected from the jctb. Used in CHIP TEST BOARD only.
+- samples [i] sets/gets number of samples expected from the jctb. Used in CHIP TEST BOARD only.
Returns
(long long int)
commands to configure the read only timers of the detector
-- exptimel gets exposure time left. Used in MYTHEN, GOTTHARD only. Only get!
+- exptimel gets exposure time left. Used in MYTHEN, GOTTHARD only. Only get!
Returns
(double with 9 decimal digits)
-- periodl gets frame period left. Used in MYTHEN, GOTTHARD only. Only get!
+- periodl gets frame period left. Used in MYTHEN, GOTTHARD only. Only get!
Returns
(double with 9 decimal digits)
-- delayl gets delay left. Used in MYTHEN, GOTTHARD only. Only get!
+- delayl gets delay left. Used in MYTHEN, GOTTHARD only. Only get!
Returns
(double with 9 decimal digits)
-- gatesl gets number of gates left. Used in MYTHEN, GOTTHARD only. Only get!
+- gatesl gets number of gates left. Used in MYTHEN, GOTTHARD only. Only get!
Returns
(double with 9 decimal digits)
-- framesl gets number of frames left. Used in MYTHEN, GOTTHARD only. Only get!
+- framesl gets number of frames left. Used in MYTHEN, GOTTHARD only. Only get!
Returns
(double with 9 decimal digits)
-- cyclesl gets number of cylces left. Used in MYTHEN, GOTTHARD only. Only get!
+- cyclesl gets number of cylces left. Used in MYTHEN, GOTTHARD only. Only get!
Returns
(double with 9 decimal digits)
-- probesl gets number of probes left. Used in MYTHEN, GOTTHARD only. Only get!
+- probesl gets number of probes left. Used in MYTHEN, GOTTHARD only. Only get!
Returns
(double with 9 decimal digits)
- now ??? Only get!
@@ -255,58 +255,58 @@ RO Timers
Speed
commands to configure speed of detector
-- clkdivider [i] sets/gets the readout clock divider. EIGER, JUNGFRAU [0(fast speed), 1(half speed), 2(quarter speed)]. MYTHEN[???]
+- clkdivider [i] sets/gets the readout clock divider. EIGER, JUNGFRAU [0(fast speed), 1(half speed), 2(quarter speed)]. MYTHEN[???].
Returns
(int)
-- clkdivider [i] sets/gets length of set/reset signals (in clock cycles). Used in MYTHEN only
+- clkdivider [i] sets/gets length of set/reset signals (in clock cycles). Used in MYTHEN only.
Returns
(int)
-- clkdivider [i] sets/gets waitstates of the bus interface (in clock cycles). Used in MYTHEN only
+- clkdivider [i] sets/gets waitstates of the bus interface (in clock cycles). Used in MYTHEN only.
Returns
(int)
-- clkdivider [i] sets/gets clock divider in tot mode. Used in MYTHEN only
+- clkdivider [i] sets/gets clock divider in tot mode. Used in MYTHEN only.
Returns
(int)
-- clkdivider [i] sets/gets duty cycle of the tot clock. Used in MYTHEN only
+- clkdivider [i] sets/gets duty cycle of the tot clock. Used in MYTHEN only.
Returns
(int)
-- phasestep [i] ???
+- phasestep [i] ???.
Returns
(int)
-- oversampling [i] ???
+- oversampling [i] ???.
Returns
(int)
-- adcclk [i] ???
+- adcclk [i] ???.
Returns
(int)
-- adcphase [i] ??? Used in MYTHEN, JUNGFRAU only.
+- adcphase [i] ??? Used in MYTHEN, JUNGFRAU only.
Returns
(int)
-- adcpipeline [i] ???
+- adcpipeline [i] ???
Returns
(int)
-- dbitclk [i] ???
+- dbitclk [i] ???
Returns
(int)
-- dbitphase [i] ???
+- dbitphase [i] ???
Returns
(int)
-- dbitpipeline [i] ???
+- dbitpipeline [i] ???
Returns
(int)
commands to configure/retrieve configuration of detector
-- config [fname] sets/saves detector/receiver to configuration contained in fname. Same as executing sls_detector_put for every line. Normally a one time operation.
+- config [fname] sets/saves detector/receiver to configuration contained in fname. Same as executing sls_detector_put for every line. Normally a one time operation.
Returns
(string) fname
-- rx_printconfig prints the receiver configuration. Only get!
+- rx_printconfig prints the receiver configuration. Only get!
Returns
(string)
-- parameters [fname] sets/saves detector parameters contained in fname. Normally once per different measurement.
+- parameters [fname] sets/saves detector parameters contained in fname. Normally once per different measurement.
Returns
(string) fname
-- setup [fname] sets/saves detector complete setup contained in fname (extensions automatically generated), including trimfiles, ff coefficients etc.
+- setup [fname] sets/saves detector complete setup contained in fname (extensions automatically generated), including trimfiles, ff coefficients etc.
Returns
(string) fname
diff --git a/manual/slsDetectorClientDocs/latex/acquisition.tex b/manual/slsDetectorClientDocs/latex/acquisition.tex
index 29603ddd1..afc5b0bf6 100644
--- a/manual/slsDetectorClientDocs/latex/acquisition.tex
+++ b/manual/slsDetectorClientDocs/latex/acquisition.tex
@@ -2,7 +2,17 @@ Commands to control the acquisition
\begin{DoxyItemize}
-\item {\bfseries acquire} blocking acquisition (like calling sls\_\-detector\_\-acquire). Starts receiver and detector, writes and processes the data, stops detector. Only get!
+\item {\bfseries acquire} blocking acquisition (like calling sls\_\-detector\_\-acquire). Starts receiver and detector, writes and processes the data, stops detector. Only get! {\ttfamily Returns} (string){\ttfamily \char`\"{}acquire unsuccessful\char`\"{}} if fails, else \char`\"{}\char`\"{} for MYTHEN, {\ttfamily \char`\"{}Acquired (int)\char`\"{}} for others, where int is number of frames caught.
+\end{DoxyItemize}
+
+
+\begin{DoxyItemize}
+\item {\bfseries busy} returns {\ttfamily 1} if the acquisition is active, {\ttfamily 0} otherwise. Works when the acquisition is started in blocking mode. Only get! {\ttfamily Returns} {\ttfamily }(int)
+\end{DoxyItemize}
+
+
+\begin{DoxyItemize}
+\item {\bfseries status \mbox{[}s\mbox{]} } starts or stops acquisition in detector in non blocking mode. {\ttfamily s:} \mbox{[}{\ttfamily start}, {\ttfamily stop}\mbox{]}. {\ttfamily Returns} the detector status: \mbox{[}{\ttfamily running}, {\ttfamily error}, {\ttfamily transmitting}, {\ttfamily finished}, {\ttfamily waiting}, {\ttfamily idle}\mbox{]}. {\ttfamily Returns} {\ttfamily }(string)
\end{DoxyItemize}
@@ -16,16 +26,6 @@ Commands to control the acquisition
\end{DoxyItemize}
-\begin{DoxyItemize}
-\item {\bfseries status} {\ttfamily returns} the detector status (string)-\/ can be: {\ttfamily running}, {\ttfamily error}, {\ttfamily transmitting}, {\ttfamily finished}, {\ttfamily waiting} or {\ttfamily idle}; {\ttfamily put} can be {\ttfamily start} or {\ttfamily stop}
-\end{DoxyItemize}
-
-
-\begin{DoxyItemize}
-\item {\bfseries busy} returns {\ttfamily 1} if the acquisition is active, {\ttfamily 0} otherwise. Works when the acquisition is started in non-\/blocking mode. Only get!
-\end{DoxyItemize}
-
-
\begin{DoxyItemize}
\item {\bfseries readctr } Reads the counters from the detector memory (analog detector returning values translated into number of photons -\/ only GOTTHARD). Cannot put.
\end{DoxyItemize}
diff --git a/manual/slsDetectorClientDocs/latex/config.tex b/manual/slsDetectorClientDocs/latex/config.tex
index ac130ad48..6bf0328b7 100644
--- a/manual/slsDetectorClientDocs/latex/config.tex
+++ b/manual/slsDetectorClientDocs/latex/config.tex
@@ -16,7 +16,7 @@ commands to configure detector data structure
\begin{DoxyItemize}
-\item {\bfseries datastream} enables/disables the 0MQ data stream (0MQ threads created) from receiver to client.
+\item {\bfseries datastream }enables/disables the 0MQ data stream (0MQ threads created) from receiver to client. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
@@ -36,12 +36,12 @@ commands to configure detector data structure
\begin{DoxyItemize}
-\item {\bfseries type} Sets/gets detector type (string).
+\item {\bfseries type} Sets/gets detector type. {\ttfamily Returns} {\ttfamily }(string). Normally not used. Using hostname is enough.
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries hostname} {\ttfamily put} adds the hostname (ot IP adress) at the end of the multi-\/detector structure. If used for a single controlled (i:) replaces the current hostname. Returns the list of the hostnames of the multi-\/detector structure.
+\item {\bfseries hostname} {\ttfamily put} adds the hostname (ot IP adress) at the end of the multi-\/detector structure. If used for a single controlled (i:) replaces the current hostname. Returns the list of the hostnames of the multi-\/detector structure. {\ttfamily Returns} {\ttfamily }(string)
\end{DoxyItemize}
@@ -62,235 +62,235 @@ commands to configure detector status
\begin{DoxyItemize}
-\item {\bfseries online \mbox{[}i\mbox{]}} sets the detector in online (1) or offline (0) mode
+\item {\bfseries online \mbox{[}i\mbox{]}} sets the detector in online (1) or offline (0) mode. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries checkonline} returns the hostnames of all detectors without connecting to them
+\item {\bfseries checkonline} returns the hostnames of all detectors without connecting to them. {\ttfamily Returns} (string) \char`\"{}All online\char`\"{} or \char`\"{}\mbox{[}list of offline hostnames\mbox{]} : Not online\char`\"{}.
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries activate} Activates/Deactivates the detector. Deactivated detector does not send data. Used for EIGER only.
+\item {\bfseries activate} Activates/Deactivates the detector. Deactivated detector does not send data. Used for EIGER only. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}\hypertarget{config_configsize}{}\subsection{Data Size}\label{config_configsize}
commands to configure detector data size
\begin{DoxyItemize}
-\item {\bfseries nmod \mbox{[}i\mbox{]}} sets/gets the number of modules of the detector. Used for MYTHEN only.
+\item {\bfseries nmod \mbox{[}i\mbox{]}} sets/gets the number of modules of the detector. Used for MYTHEN only. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries maxmod } Gets the maximum number of modules of the detector. Used for MYTHEN only. Cannot put!
+\item {\bfseries maxmod } Gets the maximum number of modules of the detector. Used for MYTHEN only. Cannot put! {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries dr \mbox{[}i\mbox{]}} sets/gets the dynamic range of detector. Mythen \mbox{[}4,8,16,24\mbox{]}. Eiger \mbox{[}4,8,16,32\mbox{]}. Others cannot put!
+\item {\bfseries dr \mbox{[}i\mbox{]}} sets/gets the dynamic range of detector. Mythen \mbox{[}4,8,16,24\mbox{]}. Eiger \mbox{[}4,8,16,32\mbox{]}. Others cannot put! {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries roi \mbox{[}i\mbox{]} \mbox{[}xmin\mbox{]} \mbox{[}xmax\mbox{]} \mbox{[}ymin\mbox{]} \mbox{[}ymax\mbox{]} } sets region of interest of the detector, where i is number of rois;i=0 to clear rois. Used for GOTTHARD only.
+\item {\bfseries roi \mbox{[}i\mbox{]} \mbox{[}xmin\mbox{]} \mbox{[}xmax\mbox{]} \mbox{[}ymin\mbox{]} \mbox{[}ymax\mbox{]} } sets region of interest of the detector, where i is number of rois;i=0 to clear rois. Used for GOTTHARD only. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries detsizechan \mbox{[}xmax\mbox{]} \mbox{[}ymax\mbox{]}} sets the maximum number of channels in each dimension for complete detector set; -\/1 is no limit. Use for multi-\/detector system as first command in config file.
+\item {\bfseries detsizechan \mbox{[}xmax\mbox{]} \mbox{[}ymax\mbox{]}} sets the maximum number of channels in each dimension for complete detector set; -\/1 is no limit. Use for multi-\/detector system as first command in config file. {\ttfamily Returns} {\ttfamily }(\char`\"{}int int\char`\"{})
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries roimask \mbox{[}i\mbox{]}} ??
+\item {\bfseries roimask \mbox{[}i\mbox{]}} ?? {\ttfamily Returns} {\ttfamily }(int) in hexadecimal
\end{DoxyItemize}
\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.
+\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. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\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.
+\item {\bfseries tengiga \mbox{[}i\mbox{]}} enables/disables 10GbE in system (detector \& receiver). 1 enabled 10GbE, 0 enables 1GbE. Used in EIGER only. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}\hypertarget{config_configflags}{}\subsection{Flags}\label{config_configflags}
commands to configure detector flags
\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.
+\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. {\ttfamily Returns} {\ttfamily }(string). put takes one string and {\ttfamily returns} concatenation of all active flags separated by spaces.
\end{DoxyItemize}
\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.
+ Used in MYTHEN, GOTTHARD, PROPIX only. {\ttfamily Returns} {\ttfamily }(string)
\end{DoxyItemize}\hypertarget{config_configfpga}{}\subsection{FPGA}\label{config_configfpga}
commands to configure FPGA of the detector
\begin{DoxyItemize}
-\item {\bfseries programfpga \mbox{[}file\mbox{]}} programs the FPGA with file f (with .pof extension). Used for JUNGFRAU, MOENCH only. Only put!
+\item {\bfseries programfpga \mbox{[}file\mbox{]}} programs the FPGA with file f (with .pof extension). Used for JUNGFRAU, MOENCH only. Only put! {\ttfamily Returns} {\ttfamily }(\char`\"{}successful\char`\"{}, \char`\"{}unsuccessful\char`\"{})
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries resetfpga \mbox{[}f\mbox{]}} resets FPGA, where f can be any value. Used for JUNGFRAU only. Only put!
+\item {\bfseries resetfpga \mbox{[}f\mbox{]}} resets FPGA, where f can be any value. Used for JUNGFRAU only. Only put! {\ttfamily Returns} {\ttfamily }(\char`\"{}successful\char`\"{}, \char`\"{}unsuccessful\char`\"{})
\end{DoxyItemize}\hypertarget{config_configchip}{}\subsection{Chip}\label{config_configchip}
commands to configure chip of the detector
\begin{DoxyItemize}
-\item {\bfseries powerchip \mbox{[}i\mbox{]}} Powers on/off the chip. 1 powers on, 0 powers off. Can also get the power status. Used for JUNGFRAU only.
+\item {\bfseries powerchip \mbox{[}i\mbox{]}} Powers on/off the chip. 1 powers on, 0 powers off. Can also get the power status. Used for JUNGFRAU only. {\ttfamily Returns} {\ttfamily }(int)
\end{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 ?? {\ttfamily Returns} {\ttfamily }(int)
\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!
+\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! {\ttfamily Returns} {\ttfamily }(\char`\"{}successful\char`\"{}, \char`\"{}unsuccessful\char`\"{})
\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!
+\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! {\ttfamily Returns} {\ttfamily }(\char`\"{}successful\char`\"{}, \char`\"{}unsuccessful\char`\"{})
\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 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! {\ttfamily Returns} {\ttfamily }(\char`\"{}successful\char`\"{}, \char`\"{}unsuccessful\char`\"{})
\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!
+\item {\bfseries moduleversion:\mbox{[}i\mbox{]}} Gets the firmware version of module i. Used for MYTHEN only. Only get! {\ttfamily Returns} {\ttfamily }(long int) in hexadecimal or \char`\"{}undefined module number\char`\"{}
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries detectornumber} Gets the serial number or MAC of detector. Only get!
+\item {\bfseries detectornumber} Gets the serial number or MAC of detector. Only get! {\ttfamily Returns} {\ttfamily }(long int) in hexadecimal
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries modulenumber:\mbox{[}i\mbox{]}} Gets the serial number of module i. Used for MYTHEN only. Only get!
+\item {\bfseries modulenumber:\mbox{[}i\mbox{]}} Gets the serial number of module i. Used for MYTHEN only. Only get! {\ttfamily Returns} {\ttfamily }(long int) in hexadecimal or \char`\"{}undefined module number\char`\"{}
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries detectorversion} Gets the firmware version of detector. Only get!
+\item {\bfseries detectorversion} Gets the firmware version of detector. Only get! {\ttfamily Returns} {\ttfamily }(long int) in hexadecimal
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries softwareversion} Gets the software version of detector server. Only get!
+\item {\bfseries softwareversion} Gets the software version of detector server. Only get! {\ttfamily Returns} {\ttfamily }(long int) in hexadecimal
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries thisversion} Gets the software version of this client software. Only get!
+\item {\bfseries thisversion} Gets the software version of this client software. Only get! {\ttfamily Returns} {\ttfamily }(long int) in hexadecimal
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries receiverversion} Gets the software version of receiver. Only get!
+\item {\bfseries receiverversion} Gets the software version of receiver. Only get! {\ttfamily Returns} {\ttfamily }(long int) in hexadecimal
\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
+\item {\bfseries timing \mbox{[}mode\mbox{]}} sets/gets synchronization mode of the detector. Mode: auto, trigger, ro\_\-trigger, gating, triggered\_\-gating {\ttfamily Returns} {\ttfamily }(string)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries exptime \mbox{[}i\mbox{]}} sets/gets exposure time in s
+\item {\bfseries exptime \mbox{[}i\mbox{]}} sets/gets exposure time in s. {\ttfamily Returns} {\ttfamily }(double with 9 decimal digits)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries subexptime \mbox{[}i\mbox{]}} sets/gets sub exposure time in s. Used in EIGER only in 32 bit mode.
+\item {\bfseries subexptime \mbox{[}i\mbox{]}} sets/gets sub exposure time in s. Used in EIGER only in 32 bit mode. {\ttfamily Returns} {\ttfamily }(double with 9 decimal digits)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries period \mbox{[}i\mbox{]}} sets/gets frame period in s.
+\item {\bfseries period \mbox{[}i\mbox{]}} sets/gets frame period in s. {\ttfamily Returns} {\ttfamily }(double with 9 decimal digits)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries delay \mbox{[}i\mbox{]}} sets/gets delay in s. Used in MYTHEN, GOTTHARD only
+\item {\bfseries delay \mbox{[}i\mbox{]}} sets/gets delay in s. Used in MYTHEN, GOTTHARD only. {\ttfamily Returns} {\ttfamily }(double with 9 decimal digits)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries gates \mbox{[}i\mbox{]}} sets/gets number of gates. Used in MYTHEN, GOTTHARD, EIGER only
+\item {\bfseries gates \mbox{[}i\mbox{]}} sets/gets number of gates. Used in MYTHEN, GOTTHARD only. {\ttfamily Returns} {\ttfamily }(long long int)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries gates \mbox{[}i\mbox{]}} sets/gets number of frames. If {\ttfamily timing} is not {\ttfamily auto}, then it is the number of frames per cycle/trigger.
+\item {\bfseries frames \mbox{[}i\mbox{]}} sets/gets number of frames. If {\ttfamily timing} is not {\ttfamily auto}, then it is the number of frames per cycle/trigger. {\ttfamily Returns} {\ttfamily }(long long int)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries cycles \mbox{[}i\mbox{]}} sets/gets number of triggers. Timing mode should be set appropriately.
+\item {\bfseries cycles \mbox{[}i\mbox{]}} sets/gets number of triggers. Timing mode should be set appropriately. {\ttfamily Returns} {\ttfamily }(long long int)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries probes \mbox{[}i\mbox{]}} sets/gets number of probes to accumulate. When setting, max 3! cycles should be set to 1, frames to the number of pump-\/probe events. Used in MYTHEN only
+\item {\bfseries probes \mbox{[}i\mbox{]}} sets/gets number of probes to accumulate. When setting, max 3! cycles should be set to 1, frames to the number of pump-\/probe events. Used in MYTHEN only. {\ttfamily Returns} {\ttfamily }(long long int)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries measurements \mbox{[}i\mbox{]}} sets/gets number of measurements.
+\item {\bfseries measurements \mbox{[}i\mbox{]}} sets/gets number of measurements. {\ttfamily Returns} {\ttfamily }(long long int)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries samples \mbox{[}i\mbox{]}} sets/gets number of samples expected from the jctb. Used in CHIP TEST BOARD only.
+\item {\bfseries samples \mbox{[}i\mbox{]}} sets/gets number of samples expected from the jctb. Used in CHIP TEST BOARD only. {\ttfamily Returns} {\ttfamily }(long long int)
\end{DoxyItemize}\hypertarget{config_configrotimers}{}\subsection{RO Timers}\label{config_configrotimers}
commands to configure the read only timers of the detector
\begin{DoxyItemize}
-\item {\bfseries exptimel} gets exposure time left. Used in MYTHEN, GOTTHARD only. Only get!
+\item {\bfseries exptimel} gets exposure time left. Used in MYTHEN, GOTTHARD only. Only get! {\ttfamily Returns} {\ttfamily }(double with 9 decimal digits)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries periodl} gets frame period left. Used in MYTHEN, GOTTHARD only. Only get!
+\item {\bfseries periodl} gets frame period left. Used in MYTHEN, GOTTHARD only. Only get! {\ttfamily Returns} {\ttfamily }(double with 9 decimal digits)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries delayl} gets delay left. Used in MYTHEN, GOTTHARD only. Only get!
+\item {\bfseries delayl} gets delay left. Used in MYTHEN, GOTTHARD only. Only get! {\ttfamily Returns} {\ttfamily }(double with 9 decimal digits)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries gatesl} gets number of gates left. Used in MYTHEN, GOTTHARD only. Only get!
+\item {\bfseries gatesl} gets number of gates left. Used in MYTHEN, GOTTHARD only. Only get! {\ttfamily Returns} {\ttfamily }(double with 9 decimal digits)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries framesl} gets number of frames left. Used in MYTHEN, GOTTHARD only. Only get!
+\item {\bfseries framesl} gets number of frames left. Used in MYTHEN, GOTTHARD only. Only get! {\ttfamily Returns} {\ttfamily }(double with 9 decimal digits)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries cyclesl} gets number of cylces left. Used in MYTHEN, GOTTHARD only. Only get!
+\item {\bfseries cyclesl} gets number of cylces left. Used in MYTHEN, GOTTHARD only. Only get! {\ttfamily Returns} {\ttfamily }(double with 9 decimal digits)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries probesl} gets number of probes left. Used in MYTHEN, GOTTHARD only. Only get!
+\item {\bfseries probesl} gets number of probes left. Used in MYTHEN, GOTTHARD only. Only get! {\ttfamily Returns} {\ttfamily }(double with 9 decimal digits)
\end{DoxyItemize}
@@ -311,86 +311,86 @@ commands to configure speed of detector
\begin{DoxyItemize}
-\item {\bfseries clkdivider \mbox{[}i\mbox{]}} sets/gets the readout clock divider. EIGER, JUNGFRAU \mbox{[}0(fast speed), 1(half speed), 2(quarter speed)\mbox{]}. MYTHEN\mbox{[}???\mbox{]}
+\item {\bfseries clkdivider \mbox{[}i\mbox{]}} sets/gets the readout clock divider. EIGER, JUNGFRAU \mbox{[}0(fast speed), 1(half speed), 2(quarter speed)\mbox{]}. MYTHEN\mbox{[}???\mbox{]}. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries clkdivider \mbox{[}i\mbox{]}} sets/gets length of set/reset signals (in clock cycles). Used in MYTHEN only
+\item {\bfseries clkdivider \mbox{[}i\mbox{]}} sets/gets length of set/reset signals (in clock cycles). Used in MYTHEN only. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries clkdivider \mbox{[}i\mbox{]}} sets/gets waitstates of the bus interface (in clock cycles). Used in MYTHEN only
+\item {\bfseries clkdivider \mbox{[}i\mbox{]}} sets/gets waitstates of the bus interface (in clock cycles). Used in MYTHEN only. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries clkdivider \mbox{[}i\mbox{]}} sets/gets clock divider in tot mode. Used in MYTHEN only
+\item {\bfseries clkdivider \mbox{[}i\mbox{]}} sets/gets clock divider in tot mode. Used in MYTHEN only. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries clkdivider \mbox{[}i\mbox{]}} sets/gets duty cycle of the tot clock. Used in MYTHEN only
+\item {\bfseries clkdivider \mbox{[}i\mbox{]}} sets/gets duty cycle of the tot clock. Used in MYTHEN only. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries phasestep \mbox{[}i\mbox{]}} ???
+\item {\bfseries phasestep \mbox{[}i\mbox{]}} ???. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries oversampling \mbox{[}i\mbox{]}} ???
+\item {\bfseries oversampling \mbox{[}i\mbox{]}} ???. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries adcclk \mbox{[}i\mbox{]}} ???
+\item {\bfseries adcclk \mbox{[}i\mbox{]}} ???. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries adcphase \mbox{[}i\mbox{]}} ??? Used in MYTHEN, JUNGFRAU only.
+\item {\bfseries adcphase \mbox{[}i\mbox{]}} ??? Used in MYTHEN, JUNGFRAU only. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries adcpipeline \mbox{[}i\mbox{]}} ???
+\item {\bfseries adcpipeline \mbox{[}i\mbox{]}} ??? {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries dbitclk \mbox{[}i\mbox{]}} ???
+\item {\bfseries dbitclk \mbox{[}i\mbox{]}} ??? {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries dbitphase \mbox{[}i\mbox{]}} ???
+\item {\bfseries dbitphase \mbox{[}i\mbox{]}} ??? {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries dbitpipeline \mbox{[}i\mbox{]}} ???
+\item {\bfseries dbitpipeline \mbox{[}i\mbox{]}} ??? {\ttfamily Returns} {\ttfamily }(int)
\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.
+\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. {\ttfamily Returns} {\ttfamily }(string) fname
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries rx\_\-printconfig} prints the receiver configuration. Only get!
+\item {\bfseries rx\_\-printconfig} prints the receiver configuration. Only get! {\ttfamily Returns} {\ttfamily }(string)
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries parameters \mbox{[}fname\mbox{]}} sets/saves detector parameters contained in fname. Normally once per different measurement.
+\item {\bfseries parameters \mbox{[}fname\mbox{]}} sets/saves detector parameters contained in fname. Normally once per different measurement. {\ttfamily Returns} {\ttfamily }(string) fname
\end{DoxyItemize}
\begin{DoxyItemize}
-\item {\bfseries setup \mbox{[}fname\mbox{]}} sets/saves detector complete setup contained in fname (extensions automatically generated), including trimfiles, ff coefficients etc.
+\item {\bfseries setup \mbox{[}fname\mbox{]}} sets/saves detector complete setup contained in fname (extensions automatically generated), including trimfiles, ff coefficients etc. {\ttfamily Returns} {\ttfamily }(string) fname
\end{DoxyItemize}
\ No newline at end of file
diff --git a/manual/slsDetectorClientDocs/latex/doxygen.sty b/manual/slsDetectorClientDocs/latex/doxygen.sty
index 2ba1c1b0f..3547f240e 100644
--- a/manual/slsDetectorClientDocs/latex/doxygen.sty
+++ b/manual/slsDetectorClientDocs/latex/doxygen.sty
@@ -24,9 +24,9 @@
\fancyplain{}{\bfseries\thepage}%
}
\rfoot[\fancyplain{}{\bfseries\scriptsize%
- Generated on Thu Aug 17 14:31:37 2017 by Doxygen }]{}
+ Generated on Thu Aug 17 16:24:24 2017 by Doxygen }]{}
\lfoot[]{\fancyplain{}{\bfseries\scriptsize%
- Generated on Thu Aug 17 14:31:37 2017 by Doxygen }}
+ Generated on Thu Aug 17 16:24:24 2017 by Doxygen }}
\cfoot{}
%---------- Internal commands used in this style file ----------------
diff --git a/manual/slsDetectorClientDocs/latex/refman.tex b/manual/slsDetectorClientDocs/latex/refman.tex
index ada982757..84d42b631 100644
--- a/manual/slsDetectorClientDocs/latex/refman.tex
+++ b/manual/slsDetectorClientDocs/latex/refman.tex
@@ -40,7 +40,7 @@
\vspace*{1cm}
{\large Generated by Doxygen 1.6.1}\\
\vspace*{0.5cm}
-{\small Thu Aug 17 14:31:37 2017}\\
+{\small Thu Aug 17 16:24:24 2017}\\
\end{center}
\end{titlepage}
\pagenumbering{roman}