mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2025-06-23 18:17:59 +02:00
command line doc. done
This commit is contained in:
Dhanya Maliakal
@ -40,49 +40,49 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
|
||||
<h1><a class="anchor" id="actions">Actions </a></h1><p>Commands to define scripts to be executed during the acquisition flow</p>
|
||||
<ul>
|
||||
<li><b>positions [n [p0..pn-1]]</b> sets/gets number of angular position and positions to be acquired.</li>
|
||||
<li><b>positions [n [p0..pn-1]]</b> sets/gets number of angular position and positions to be acquired.. <code>Returns</code> <code></code>(int int..) n [p0..pn-1]</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>startscript [s]</b> sets/gets the script to be executed at the beginning of the acquisition. <code>none</code> unsets.</li>
|
||||
<li><b>startscript [s]</b> sets/gets the script to be executed at the beginning of the acquisition. <code>none</code> unsets. <code>Returns</code> <code></code>(string)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>startscriptpar [s]</b> sets/gets a string to be passed as a parameter to the startscript</li>
|
||||
<li><b>startscriptpar [s]</b> sets/gets a string to be passed as a parameter to the startscript. <code>Returns</code> <code></code>(string)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>stopscript [s]</b> sets/gets the script to be executed at the end of the acquisition. <code>none</code> unsets.</li>
|
||||
<li><b>stopscript [s]</b> sets/gets the script to be executed at the end of the acquisition. <code>none</code> unsets. <code>Returns</code> <code></code>(string)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>stopscriptpar [s]</b> sets/gets a string to be passed as a parameter to the stopscript</li>
|
||||
<li><b>stopscriptpar [s]</b> sets/gets a string to be passed as a parameter to the stopscript. <code>Returns</code> <code></code>(string)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>scriptbefore [s]</b> sets/gets the script to be executed before starting the detector every time in the acquisition. <code>none</code> unsets.</li>
|
||||
<li><b>scriptbefore [s]</b> sets/gets the script to be executed before starting the detector every time in the acquisition. <code>none</code> unsets. <code>Returns</code> <code></code>(string)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>scriptbeforepar [s]</b> sets/gets a string to be passed as a parameter to the scriptbefore</li>
|
||||
<li><b>scriptbeforepar [s]</b> sets/gets a string to be passed as a parameter to the scriptbefore. <code>Returns</code> <code></code>(string)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>scriptafter [s]</b> sets/gets the script to be executed after the detector has finished every time in the acquisition. <code>none</code> unsets.</li>
|
||||
<li><b>scriptafter [s]</b> sets/gets the script to be executed after the detector has finished every time in the acquisition. <code>none</code> unsets. <code>Returns</code> <code></code>(string)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>scriptafterpar [s]</b> sets/gets a string to be passed as a parameter to the scriptafter</li>
|
||||
<li><b>scriptafterpar [s]</b> sets/gets a string to be passed as a parameter to the scriptafter. <code>Returns</code> <code></code>(string)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>headerafter [s]</b> sets/gets the script to be executed for logging the detector parameters. <code>none</code> unsets.</li>
|
||||
<li><b>headerafter [s]</b> sets/gets the script to be executed for logging the detector parameters. <code>none</code> unsets. <code>Returns</code> <code></code>(string)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>headerbefore [s]</b> sets/gets the script to be executed for logging the detector parameters. <code>none</code> unsets.</li>
|
||||
<li><b>headerbefore [s]</b> sets/gets the script to be executed for logging the detector parameters. <code>none</code> unsets. <code>Returns</code> <code></code>(string)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>headerbeforepar [s]</b> sets/gets a string to be passed as a parameter to the headerbefore script</li>
|
||||
<li><b>headerbeforepar [s]</b> sets/gets a string to be passed as a parameter to the headerbefore script. <code>Returns</code> <code></code>(string)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>headerafterpar [s]</b> sets/gets a string to be passed as a parameter to the headerafter script</li>
|
||||
<li><b>headerafterpar [s]</b> sets/gets a string to be passed as a parameter to the headerafter script. <code>Returns</code> <code></code>(string)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>enacallog [i]</b> enables/disables logging of the parameters necessary for the energy calibration. 1 sets, 0 unsets.</li>
|
||||
<li><b>enacallog [i]</b> enables/disables logging of the parameters necessary for the energy calibration. 1 sets, 0 unsets. <code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>angcallog [i]</b> enables/disables logging of the parameters necessary for the angular calibration. 1 sets, 0 unsets.</li>
|
||||
<li><b>angcallog [i]</b> enables/disables logging of the parameters necessary for the angular calibration. 1 sets, 0 unsets. <code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>scan0script [s]</b> sets/gets the script to be executed for the scan 0 level. <code>none</code> unsets.</li>
|
||||
|
||||
@ -44,11 +44,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
<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>
|
||||
@ -131,9 +128,6 @@ Flags</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. <code>Returns</code> <code></code>(string)</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! <code>Returns</code> <code></code>("successful", "unsuccessful")</li>
|
||||
</ul>
|
||||
@ -182,18 +176,6 @@ Versions</a></h2>
|
||||
<ul>
|
||||
<li><b>receiverversion</b> Gets the software version of receiver. Only get! <code>Returns</code> <code></code>(long int) in hexadecimal</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 <code>Returns</code> <code></code>(string)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>exptime [i]</b> sets/gets exposure time in s. <code>Returns</code> <code></code>(double with 9 decimal digits)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>subexptime [i]</b> sets/gets sub exposure time in s. Used in EIGER only in 32 bit mode. <code>Returns</code> <code></code>(double with 9 decimal digits)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>period [i]</b> sets/gets frame period in s. <code>Returns</code> <code></code>(double with 9 decimal digits)</li>
|
||||
</ul>
|
||||
@ -201,56 +183,8 @@ Timers</a></h2>
|
||||
<li><b>delay [i]</b> sets/gets delay in s. Used in MYTHEN, GOTTHARD only. <code>Returns</code> <code></code>(double with 9 decimal digits)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>gates [i]</b> sets/gets number of gates. Used in MYTHEN, GOTTHARD only. <code>Returns</code> <code></code>(long long int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>frames [i]</b> sets/gets number of frames. If <code>timing</code> is not <code>auto</code>, then it is the number of frames per cycle/trigger. <code>Returns</code> <code></code>(long long int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>cycles [i]</b> sets/gets number of triggers. Timing mode should be set appropriately. <code>Returns</code> <code></code>(long long int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>probes [i]</b> 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. <code>Returns</code> <code></code>(long long int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>measurements [i]</b> sets/gets number of measurements. <code>Returns</code> <code></code>(long long int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>samples [i]</b> sets/gets number of samples expected from the jctb. Used in CHIP TEST BOARD only. <code>Returns</code> <code></code>(long long int)</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! <code>Returns</code> <code></code>(double with 9 decimal digits)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>periodl</b> gets frame period left. Used in MYTHEN, GOTTHARD only. Only get! <code>Returns</code> <code></code>(double with 9 decimal digits)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>delayl</b> gets delay left. Used in MYTHEN, GOTTHARD only. Only get! <code>Returns</code> <code></code>(double with 9 decimal digits)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>gatesl</b> gets number of gates left. Used in MYTHEN, GOTTHARD only. Only get! <code>Returns</code> <code></code>(double with 9 decimal digits)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>framesl</b> gets number of frames left. Used in MYTHEN, GOTTHARD only. Only get! <code>Returns</code> <code></code>(double with 9 decimal digits)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>cyclesl</b> gets number of cylces left. Used in MYTHEN, GOTTHARD only. Only get! <code>Returns</code> <code></code>(double with 9 decimal digits)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>probesl</b> gets number of probes left. Used in MYTHEN, GOTTHARD only. Only get! <code>Returns</code> <code></code>(double with 9 decimal digits)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>now</b> ??? Only get!</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>timestamp</b> ??? Only get!</li>
|
||||
</ul>
|
||||
<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>
|
||||
@ -258,40 +192,40 @@ Speed</a></h2>
|
||||
<li><b>clkdivider [i]</b> sets/gets the readout clock divider. EIGER, JUNGFRAU [0(fast speed), 1(half speed), 2(quarter speed)]. MYTHEN[???]. <code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>clkdivider [i]</b> sets/gets length of set/reset signals (in clock cycles). Used in MYTHEN only. <code>Returns</code> <code></code>(int)</li>
|
||||
<li><b>setlength [i]</b> sets/gets length of set/reset signals (in clock cycles). Used in MYTHEN only. <code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>clkdivider [i]</b> sets/gets waitstates of the bus interface (in clock cycles). Used in MYTHEN only. <code>Returns</code> <code></code>(int)</li>
|
||||
<li><b>waitstates [i]</b> sets/gets waitstates of the bus interface (in clock cycles). Used in MYTHEN only. <code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>clkdivider [i]</b> sets/gets clock divider in tot mode. Used in MYTHEN only. <code>Returns</code> <code></code>(int)</li>
|
||||
<li><b>totdivider [i]</b> sets/gets clock divider in tot mode. Used in MYTHEN only. <code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>clkdivider [i]</b> sets/gets duty cycle of the tot clock. Used in MYTHEN only. <code>Returns</code> <code></code>(int)</li>
|
||||
<li><b>totdutycycle [i]</b> sets/gets duty cycle of the tot clock. Used in MYTHEN only. <code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>phasestep [i]</b> ???. <code>Returns</code> <code></code>(int)</li>
|
||||
<li><b>phasestep [i]</b> Only put for gotthard. Moves the phase of the ADC clock.<code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>oversampling [i]</b> ???. <code>Returns</code> <code></code>(int)</li>
|
||||
<li><b>oversampling [i]</b> Sets/gets the number of adcsamples per clock. For the new chiptestboard.<code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>adcclk [i]</b> ???. <code>Returns</code> <code></code>(int)</li>
|
||||
<li><b>adcclk [i]</b> sets/gets the ADC clock frequency in MHz. For the new chiptestboard!<code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>adcphase [i]</b> ??? Used in MYTHEN, JUNGFRAU only. <code>Returns</code> <code></code>(int)</li>
|
||||
<li><b>adcphase [i]</b> Sets/gets the ADC clock frequency in MHz. For the new chiptestboard!<code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>adcpipeline [i]</b> ??? <code>Returns</code> <code></code>(int)</li>
|
||||
<li><b>adcpipeline [i]</b> Sets/gets the pipeline of the ADC. For the new chiptestbaord!<code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>dbitclk [i]</b> ??? <code>Returns</code> <code></code>(int)</li>
|
||||
<li><b>dbitclk [i]</b> Sets/gets the clock frequency of the latching of the digital bits in MHz. For the new chiptestboard!<code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>dbitphase [i]</b> ??? <code>Returns</code> <code></code>(int)</li>
|
||||
<li><b>dbitphase [i]</b> Sets/gets the phase of the clock for latching of the digital bits. For the new chiptestboard!?<code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>dbitpipeline [i]</b> ??? <code>Returns</code> <code></code>(int)</li>
|
||||
<li><b>dbitpipeline [i]</b> Sets/gets the pipeline of the latching of the digital bits. For the new chiptestbaord!<code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" id="configsettings">
|
||||
Detector Parameters</a></h2>
|
||||
|
||||
@ -58,6 +58,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
<ul>
|
||||
<li><a class="el" href="acquisition.html">Acquisition</a>: commands to start/stop the acquisition and retrieve data</li>
|
||||
<li><a class="el" href="config.html">Configuration</a>: commands to configure the detector</li>
|
||||
<li><a class="el" href="timing.html">Timing</a>: commands to configure the detector timing</li>
|
||||
<li><a class="el" href="data.html">Data postprocessing</a>: commands to process the data - mainly for MYTHEN except for rate corrections.</li>
|
||||
<li><a class="el" href="settings.html">Settings</a>: commands to define detector settings/threshold.</li>
|
||||
<li><a class="el" href="output.html">Output</a>: commands to define output file destination and format</li>
|
||||
|
||||
@ -40,58 +40,58 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
|
||||
<h1><a class="anchor" id="network">Network </a></h1><p>Commands to setup the network between client, detector and receiver</p>
|
||||
<ul>
|
||||
<li><b>rx_hostname [s]</b> sets/gets the receiver hostname or IP address, configures detector mac with all network parameters and updates receiver with acquisition parameters. Normally used for single detectors (Can be multi-detector). <code>none</code> disables. If used, use as last network command in configuring detector MAC.</li>
|
||||
<li><b>rx_hostname [s]</b> sets/gets the receiver hostname or IP address, configures detector mac with all network parameters and updates receiver with acquisition parameters. Normally used for single detectors (Can be multi-detector). <code>none</code> disables. If used, use as last network command in configuring detector MAC. <code>Returns</code> <code></code>(string)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>rx_udpip [ip]</b> sets/gets the ip address of the receiver UDP interface where the data from the detector will be streamed to. Normally used for single detectors (Can be multi-detector). Used if different from eth0.</li>
|
||||
<li><b>rx_udpip [ip]</b> sets/gets the ip address of the receiver UDP interface where the data from the detector will be streamed to. Normally used for single detectors (Can be multi-detector). Used if different from eth0. <code>Returns</code> <code></code>(string)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>rx_udpmac [mac]</b> sets/gets the mac address of the receiver UDP interface where the data from the detector will be streamed to. Normally used for single detectors (Can be multi-detector).</li>
|
||||
<li><b>rx_udpmac [mac]</b> sets/gets the mac address of the receiver UDP interface where the data from the detector will be streamed to. Normally used for single detectors (Can be multi-detector). <code>Returns</code> <code></code>(string)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>rx_udpport [port]</b> sets/gets the port of the receiver UDP interface where the data from the detector will be streamed to. Use single-detector command.</li>
|
||||
<li><b>rx_udpport [port]</b> sets/gets the port of the receiver UDP interface where the data from the detector will be streamed to. Use single-detector command. <code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>rx_udpport2 [port]</b> sets/gets the second port of the receiver UDP interface where the data from the second half of the detector will be streamed to. Use single-detector command. Used for EIGER only.</li>
|
||||
<li><b>rx_udpport2 [port]</b> sets/gets the second port of the receiver UDP interface where the data from the second half of the detector will be streamed to. Use single-detector command. Used for EIGER only. <code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>detectormac [mac]</b> sets/gets the mac address of the detector UDP interface from where the detector will stream data. Use single-detector command. Normally unused.</li>
|
||||
<li><b>detectormac [mac]</b> sets/gets the mac address of the detector UDP interface from where the detector will stream data. Use single-detector command. Normally unused. <code>Returns</code> <code></code>(string)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>detectorip [ip]</b> sets/gets the ip address of the detector UDP interface from where the detector will stream data. Use single-detector command. Keep in same subnet as rx_udpip (if rx_udpip specified).</li>
|
||||
<li><b>detectorip [ip]</b> sets/gets the ip address of the detector UDP interface from where the detector will stream data. Use single-detector command. Keep in same subnet as rx_udpip (if rx_udpip specified). <code>Returns</code> <code></code>(string)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>txndelay_left [delay]</b> sets/gets the transmission delay of first packet in an image being streamed out from the detector's left UDP port. Use single-detector command. Used for EIGER only.</li>
|
||||
<li><b>txndelay_left [delay]</b> sets/gets the transmission delay of first packet in an image being streamed out from the detector's left UDP port. Use single-detector command. Used for EIGER only. <code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>txndelay_right [delay]</b> sets/gets the transmission delay of first packet in an image being streamed out from the detector's right UDP port. Use single-detector command. Used for EIGER only.</li>
|
||||
<li><b>txndelay_right [delay]</b> sets/gets the transmission delay of first packet in an image being streamed out from the detector's right UDP port. Use single-detector command. Used for EIGER only. <code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>txndelay_frame [delay]</b> sets/gets the transmission frame period of entire frame being streamed out from the detector for both ports. Use single-detector command. Used for EIGER only.</li>
|
||||
<li><b>txndelay_frame [delay]</b> sets/gets the transmission frame period of entire frame being streamed out from the detector for both ports. Use single-detector command. Used for EIGER only. <code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>flowcontrol_10g [delay]</b> Enables/disables 10 GbE flow control. 1 enables, 0 disables. Used for EIGER only.</li>
|
||||
<li><b>flowcontrol_10g [delay]</b> Enables/disables 10 GbE flow control. 1 enables, 0 disables. Used for EIGER only. <code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>zmqport [port]</b> sets/gets the 0MQ (TCP) port of the receiver from where data is streamed to the client. Use single-detector command to set individually or multi-detector command to calculate based on <code>port</code> for the rest.</li>
|
||||
<li><b>zmqport [port]</b> sets/gets the 0MQ (TCP) port of the receiver from where data is streamed to the client. Use single-detector command to set individually or multi-detector command to calculate based on <code>port</code> for the rest. <code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>configuremac [i]</b> configures the MAC of the detector with these parameters: detectorip, detectormac, rx_udpip, rx_udpmac, rx_udpport, rx_udpport2 (if applicable). Only put!</li>
|
||||
<li><b>configuremac [i]</b> configures the MAC of the detector with these parameters: detectorip, detectormac, rx_udpip, rx_udpmac, rx_udpport, rx_udpport2 (if applicable). This command is already included in <code>rx_hsotname</code>. Only put!. <code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>rx_tcpport [port]</b> sets/gets the port of the client-receiver TCP interface. Use single-detector command. Is different for each detector if same <code>rx_hostname</code> used. Must be first command to communicate with receiver.</li>
|
||||
<li><b>rx_tcpport [port]</b> sets/gets the port of the client-receiver TCP interface. Use single-detector command. Is different for each detector if same <code>rx_hostname</code> used. Must be first command to communicate with receiver. <code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>port [port]</b> sets/gets the port of the client-detector control server TCP interface. Use single-detector command. Default value is 1952 for all detectors. Normally not changed.</li>
|
||||
<li><b>port [port]</b> sets/gets the port of the client-detector control server TCP interface. Use single-detector command. Default value is 1952 for all detectors. Normally not changed. <code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<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>
|
||||
<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. <code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>lock [i]</b> Locks/Unlocks the detector to communicate with this client. 1 locks, 0 unlocks.</li>
|
||||
<li><b>lock [i]</b> Locks/Unlocks the detector to communicate with this client. 1 locks, 0 unlocks. <code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>lastclient </b> Gets the last client communicating with the detector. Cannot put! </li>
|
||||
<li><b>lastclient </b> Gets the last client communicating with the detector. Cannot put!. <code>Returns</code> <code></code>(string) </li>
|
||||
</ul>
|
||||
</div>
|
||||
<!--- window showing the filter options -->
|
||||
|
||||
@ -40,25 +40,25 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
|
||||
<h1><a class="anchor" id="output">Output settings </a></h1><p>Commands to setup the file destination and format</p>
|
||||
<ul>
|
||||
<li><b>outdir [dir]</b> Sets/gets the file output directory (string)</li>
|
||||
<li><b>outdir [dir]</b> Sets/gets the file output directory. <code>Returns</code> <code></code>(string)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>fname [fn]</b> Sets/gets the root of the output file name (string)</li>
|
||||
<li><b>fname [fn]</b> Sets/gets the root of the output file name <code>Returns</code> <code></code>(string)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>index [i]</b> Sets/gets the current file index (int)</li>
|
||||
<li><b>index [i]</b> Sets/gets the current file index. <code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>enablefwrite [i]</b> Enables/disables file writing. 1 enables, 0 disables.</li>
|
||||
<li><b>enablefwrite [i]</b> Enables/disables file writing. 1 enables, 0 disables. <code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>overwrite [i]</b> enables(1) /disables(0) file overwriting</li>
|
||||
<li><b>overwrite [i]</b> enables(1) /disables(0) file overwriting. <code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>currentfname</b> gets the filename for the data without index and extension</li>
|
||||
<li><b>currentfname</b> gets the filename for the data without index and extension. MYTHEN only. <code>Returns</code> <code></code>(string)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>fileformat</b> sets/gets the file format for data in receiver. Options: [ascii, binary, hdf5]. Ascii is not implemented in Receiver. </li>
|
||||
<li><b>fileformat</b> sets/gets the file format for data in receiver. Options: [ascii, binary, hdf5]. Ascii is not implemented in Receiver. <code>Returns</code> <code></code>(string) </li>
|
||||
</ul>
|
||||
</div>
|
||||
<!--- window showing the filter options -->
|
||||
|
||||
@ -43,6 +43,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</li>
|
||||
<li><a class="el" href="config.html">Configuration commands</a>
|
||||
</li>
|
||||
<li><a class="el" href="timing.html">Timing commands</a>
|
||||
</li>
|
||||
<li><a class="el" href="data.html">Data processing commands</a>
|
||||
</li>
|
||||
<li><a class="el" href="settings.html">Detector settings commands</a>
|
||||
|
||||
@ -40,34 +40,34 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
|
||||
<h1><a class="anchor" id="receiver">Receiver commands </a></h1><p>Commands to configure the receiver. Not used in MYTHEN.</p>
|
||||
<ul>
|
||||
<li><b>receiver [s]</b> starts/stops the receiver to listen to detector packets. Gets status of receiver. Options: [start, stop].</li>
|
||||
<li><b>receiver [s]</b> starts/stops the receiver to listen to detector packets. Options: [ <code>start</code>, <code>stop</code>]. <code>Returns</code> <code></code>(string) status of receiver[ <code>idle</code>, <code>running</code>].</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>r_online [i]</b> sets/gets the receiver in online/offline mode. 1 is online, 0 is offline. Get is from shared memory.</li>
|
||||
<li><b>r_online [i]</b> sets/gets the receiver in online/offline mode. 1 is online, 0 is offline. Get is from shared memory. <code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>r_checkonline</b> Checks the receiver if it is online/offline mode. Prints either 'All receiver online', '[List of all receiver hostname in offline mode] :Not all receiver online'. Only get!</li>
|
||||
<li><b>r_checkonline</b> Checks the receiver if it is online/offline mode. Only get! <code>Returns</code> (string) "All online" or "[list of offline hostnames] : Not online".</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>framescaught</b> gets the number of frames caught by receiver. Average of all for multi-detector command. Only get!</li>
|
||||
<li><b>framescaught</b> gets the number of frames caught by receiver. Average of all for multi-detector command. Only get! <code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>resetframescaught [i]</b> resets the number of frames caught to 0. i can be any number. Use this if using status start, instead of acquire (this command is included). Only put!</li>
|
||||
<li><b>resetframescaught [i]</b> resets the number of frames caught to 0. i can be any number. Use this if using status start, instead of acquire (this command is included). Only put! <code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>frameindex [i]</b> gets the current frame index of receiver. Average of all for multi-detector command. Only get!</li>
|
||||
<li><b>frameindex [i]</b> gets the current frame index of receiver. Average of all for multi-detector command. Only get! <code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>r_lock [i]</b> locks/unlocks the receiver to communicate with only this client. 1 locks, 0 unlocks.</li>
|
||||
<li><b>r_lock [i]</b> locks/unlocks the receiver to communicate with only this client. 1 locks, 0 unlocks. <code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>r_lastclient</b> gets the last client communicating with the receiver. Only get!</li>
|
||||
<li><b>r_lastclient</b> gets the last client communicating with the receiver. Only get! <code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>r_readfreq [i]</b> sets/gets the stream frequency of data from receiver to client. i > 0 is the nth frame being streamed. 0 sets frequency to a default timer (200ms).</li>
|
||||
<li><b>r_readfreq [i]</b> sets/gets the stream frequency of data from receiver to client. i > 0 is the nth frame being streamed. 0 sets frequency to a default timer (200ms). <code>Returns</code> <code></code>(int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>rx_fifodepth [i]</b> sets/gets receiver fifo (between Listener and Writer Threads) depth to i number of frames. Can improve listener packet loss, not if limited by writing. </li>
|
||||
<li><b>rx_fifodepth [i]</b> sets/gets receiver fifo (between Listener and Writer Threads) depth to i number of frames. Can improve listener packet loss (loss due to packet processing time in Listener threads), not if limited by writing. <code>Returns</code> <code></code>(int) </li>
|
||||
</ul>
|
||||
</div>
|
||||
<!--- window showing the filter options -->
|
||||
|
||||
116
manual/slsDetectorClientDocs/html/timing.html
Normal file
116
manual/slsDetectorClientDocs/html/timing.html
Normal file
@ -0,0 +1,116 @@
|
||||
<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<title>Timing commands</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javaScript" src="search/search.js"></script>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
|
||||
</head>
|
||||
<body onload='searchBox.OnSelectItem(0);'>
|
||||
<!-- Generated by Doxygen 1.6.1 -->
|
||||
<script type="text/javascript"><!--
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
--></script>
|
||||
<div class="navigation" id="top">
|
||||
<div class="tabs">
|
||||
<ul>
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li class="current"><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<img id="MSearchSelect" src="search/search.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="contents">
|
||||
|
||||
|
||||
<h1><a class="anchor" id="timing">Timing commands </a></h1><p>Commands to setup the timing</p>
|
||||
<ul>
|
||||
<li><b>timing [mode]</b> sets/gets synchronization mode of the detector. Mode: auto, trigger, ro_trigger, gating, triggered_gating (string)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>exptime [i]</b> sets/gets exposure time in s. <code>Returns</code> <code></code>(double with 9 decimal digits)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>subexptime [i]</b> sets/gets sub exposure time in s. Used in EIGER only in 32 bit mode. <code>Returns</code> <code></code>(double with 9 decimal digits)</li>
|
||||
</ul>
|
||||
<p>/*!</p>
|
||||
<ul>
|
||||
<li><b>gates [i]</b> sets/gets number of gates. Used in MYTHEN, GOTTHARD only. <code>Returns</code> <code></code>(long long int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>frames [i]</b> sets/gets number of frames. If <code>timing</code> is not <code>auto</code>, then it is the number of frames per cycle/trigger. <code>Returns</code> <code></code>(long long int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>cycles [i]</b> sets/gets number of triggers. Timing mode should be set appropriately. <code>Returns</code> <code></code>(long long int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>probes [i]</b> 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. <code>Returns</code> <code></code>(long long int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>measurements [i]</b> sets/gets number of measurements. <code>Returns</code> <code></code>(long long int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>samples [i]</b> sets/gets number of samples expected from the jctb. Used in CHIP TEST BOARD only. <code>Returns</code> <code></code>(long long int)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>exptimel</b> gets exposure time left. Used in MYTHEN, GOTTHARD only. Only get! <code>Returns</code> <code></code>(double with 9 decimal digits)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>periodl</b> gets frame period left. Used in MYTHEN, GOTTHARD only. Only get! <code>Returns</code> <code></code>(double with 9 decimal digits)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>delayl</b> gets delay left. Used in MYTHEN, GOTTHARD only. Only get! <code>Returns</code> <code></code>(double with 9 decimal digits)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>gatesl</b> gets number of gates left. Used in MYTHEN, GOTTHARD only. Only get! <code>Returns</code> <code></code>(double with 9 decimal digits)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>cyclesl</b> gets number of cylces left. Used in MYTHEN, GOTTHARD only. Only get! <code>Returns</code> <code></code>(double with 9 decimal digits)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>probesl</b> gets number of probes left. Used in MYTHEN, GOTTHARD only. Only get! <code>Returns</code> <code></code>(double with 9 decimal digits)</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>now</b> Actual time of the detector. Only get!</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>timestamp</b> Last frame timestamp for MYTHEN. Only get!</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>nframes</b> ??? Only get! </li>
|
||||
</ul>
|
||||
</div>
|
||||
<!--- window showing the filter options -->
|
||||
<div id="MSearchSelectWindow"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||
</div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
<iframe src="" frameborder="0"
|
||||
name="MSearchResults" id="MSearchResults">
|
||||
</iframe>
|
||||
</div>
|
||||
|
||||
<hr size="1"/><address style="text-align: right;"><small>Generated on 17 Aug 2017 by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user