mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2025-04-28 17:10:03 +02:00
121 lines
6.8 KiB
HTML
121 lines
6.8 KiB
HTML
<!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"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.5"/>
|
|
<title>My Project: Introduction</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">My Project
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.5 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li class="current"><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.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)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Pages</a></div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Introduction </div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><p>This program is intended to control the SLS detectors via command line interface. This is the only way to access all possible functionality of the detectors, however it is often recommendable to avoid changing the most advanced settings, rather leaving the task to configuration files, as when using the GUI or the API provided.</p>
|
|
<p>The command line interface consists in four main functions:</p>
|
|
<ul>
|
|
<li><b>sls_detector_acquire</b> to acquire data from the detector</li>
|
|
<li><b>sls_detector_put</b> to set detector parameters</li>
|
|
<li><b>sls_detector_get</b> to retrieve detector parameters</li>
|
|
<li><b>sls_detector_help</b> to get help concerning the text commands Additionally the program slsReceiver should be started on the machine expected to receive the data from the detector.</li>
|
|
</ul>
|
|
<p>If you need control a single detector, the use of the command line interface does not need any additional arguments.</p>
|
|
<p>For commands addressing a single controller of your detector, the command cmd should be called with the index i of the controller:</p>
|
|
<p><b>sls_detector_clnt i:cmd</b></p>
|
|
<p>where <b>sls_detector_clnt</b> is the text client (put, get, acquire, help).</p>
|
|
<p>In case more than one detector is configured on the control PC, the command cmd should be called with their respective index j:</p>
|
|
<p><b>sls_detector_clnt j-cmd</b></p>
|
|
<p>where <b>sls_detector_clnt</b> is the text client (put, get, acquire, help).</p>
|
|
<p>To address a specific controller i of detector j use:</p>
|
|
<p><b>sls_detector_clnt j-i:cmd</b></p>
|
|
<p>To use different shared memory segements for different detectors on the same client pc, one can use environment variable <b>SLSDETNAME</b> set to any string to different strings to make the shared memory segments unique. One can then use the same multi detector id for both detectors as they have a different shared memory names.</p>
|
|
<p>For additional questions concerning the indexing of the detector, please refer to the SLS Detectors FAQ documentation.</p>
|
|
<p>The commands are sudivided into different pages depending on their functionalities:</p>
|
|
<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>
|
|
<li><a class="el" href="actions.html">Actions</a>: commands to define scripts to be executed during the acquisition flow</li>
|
|
<li><a class="el" href="network.html">Network</a>: commands to setup the network between client, detector and receiver</li>
|
|
<li><a class="el" href="receiver.html">Receiver</a>: commands to configure the receiver</li>
|
|
<li><a class="el" href="ctb.html">Chiptest board</a>: commands specific for the new chiptest board as pattern generator</li>
|
|
<li><a class="el" href="test.html">Developer</a>: commands to be used only for software debugging. Avoid using them! </li>
|
|
</ul>
|
|
</div></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.5
|
|
</small></address>
|
|
</body>
|
|
</html>
|