mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2025-04-29 01:20:02 +02:00
216 lines
9.4 KiB
HTML
216 lines
9.4 KiB
HTML
<!-- 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>Configuration 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="config">Configuration commands </a></h1><p>Commands to configure the detector. these commands are often left to the configuration file.</p>
|
|
<ul>
|
|
<li><b>datastream</b> enables/disables the 0MQ data stream (0MQ threads created) from receiver to client.</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>free</b> Free shared memory on the control PC</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>add</b> Adds a detector at the end of the multi-detector structure. <code>put</code> argument is the hostname or IP adress. Returns the chained list of detector hostnames.</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>remove i</b> Removes controller <code>i</code> from the multi-detector structure. Can be used for partial readout of the detector.</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>type</b> Sets/gets detector type (string).</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>hostname</b> <code>put</code> 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.</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>id[:i]</b> Returns the id of the detector structure. i is the detector position in a multi detector system. If used a <code>put</code>, 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.</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>master i</b> <code>put</code> sets the position of the master of the acquisition (-1 if none). Returns the position of the master of the detector structure (-1 if none).</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>sync</b> Sets/gets the synchronization mode of the detectors in the multi-detector structure. Can be: <code>none</code>, <code>gating</code>, <code>trigger</code>, <code>complementary</code>. Mainly used by MYTHEN/GOTTHARD.</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>online [i]</b> sets the detector in online (1) or offline (0) mode</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>checkonline</b> returns the hostnames of all detectors without connecting to them</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>activate</b> Activates/Deactivates the detector. Deactivated detector does not send data. Used for EIGER only.</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>lock [i]</b> Locks/Unlocks the detector to communicate with this client. 1 locks, 0 unlocks.</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>nmod [i]</b> sets/gets the number of modules of the detector. Used for MYTHEN only.</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>maxmod </b> Gets the maximum number of modules of the detector. Used for MYTHEN only. Cannot put!</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>dr [i]</b> sets/gets the dynamic range of detector. Mythen [4,8,16,24]. Eiger [4,8,16,32]. Others cannot put!</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>roi [i] [xmin] [xmax] [ymin] [ymax] </b> sets region of interest of the detector, where i is number of rois;i=0 to clear rois. Used for GOTTHARD only.</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>detsizechan [xmax] [ymax]</b> 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.</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>roimask [i]</b> ??</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>flippeddatax [i]</b> enables/disables data being flipped across x axis. 1 enables, 0 disables. Used for EIGER only. 1 for bottom half-module, 0 for top-half module.</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>flags [flag]</b> sets/gets the readout flags to mode. Options: none, storeinram, tot, continous, parallel, nonparallel, safe, digital, analog_digital, unknown. Used for MYTHEN and EIGER only.</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>extsig:[i] [flag]</b> sets/gets the mode of the external signal i. Options: <code>off</code>, <code>gate_in_active_high</code>, <code>gate_in_active_low</code>, <code>trigger_in_rising_edge</code>, <code>trigger_in_falling_edge</code>, <code>ro_trigger_in_rising_edge</code>, <code>ro_trigger_in_falling_edge</code>, <code>gate_out_active_high</code>, <code>gate_out_active_low</code>, <code>trigger_out_rising_edge</code>, <code>trigger_out_falling_edge</code>, <code>ro_trigger_out_rising_edge</code>, <code>ro_trigger_out_falling_edge</code>. <br/>
|
|
Used in MYTHEN, GOTTHARD, PROPIX only.</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>programfpga [file]</b> programs the FPGA with file f (with .pof extension). Used for JUNGFRAU, MOENCH only. Only put!</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>resetfpga [f]</b> resets FPGA, where f can be any value. Used for JUNGFRAU only. Only put!</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>powerchip [i]</b> Powers on/off the chip. 1 powers on, 0 powers off. Can also get the power status. Used for JUNGFRAU only.</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>led [i]</b> sets/gets the led status. 1 on, 0 off. Used for MOENCH only ??</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>moduleversion:[i]</b> Gets the firmware version of module i. Used for MYTHEN only. Only get!</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>detectornumber</b> Gets the serial number or MAC of detector. Only get!</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>modulenumber:[i]</b> Gets the serial number of module i. Used for MYTHEN only. Only get!</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>detectorversion</b> Gets the firmware version of detector. Only get!</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>softwareversion</b> Gets the software version of detector server. Only get!</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>thisversion</b> Gets the software version of this client software. Only get!</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>receiverversion</b> Gets the software version of receiver. Only get!</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>timing [mode]</b> sets/gets synchronization mode of the detector. Mode: auto, trigger, ro_trigger, gating, triggered_gating</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>exptime [i]</b> sets/gets exposure time in s</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>subexptime [i]</b> sets/gets sub exposure time in s. Used in EIGER only in 32 bit mode.</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>period [i]</b> sets/gets frame period in s.</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>delay [i]</b> sets/gets delay in s. Used in MYTHEN, GOTTHARD only</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>gates [i]</b> sets/gets number of gates. Used in MYTHEN, GOTTHARD, EIGER only</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>gates [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.</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>cycles [i]</b> sets/gets number of triggers. Timing mode should be set appropriately.</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</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>measurements [i]</b> sets/gets number of measurements.</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>samples [i]</b> sets/gets number of samples expected from the jctb. Used in CHIP TEST BOARD only.</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>exptimel [i]</b> gets exposure time left. Used in MYTHEN, GOTTHARD only.</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>periodl [i]</b> gets frame period left. Used in MYTHEN, GOTTHARD only.</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>delayl [i]</b> gets delay left. Used in MYTHEN, GOTTHARD only.</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>gatesl [i]</b> gets number of gates left. Used in MYTHEN, GOTTHARD only.</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>framesl [i]</b> gets number of frames left. Used in MYTHEN, GOTTHARD only.</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>cyclesl [i]</b> gets number of cylces left. Used in MYTHEN, GOTTHARD only.</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>probesl [i]</b> gets number of probes left. Used in MYTHEN, GOTTHARD only. </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 15 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>
|