mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2026-01-21 08:51:41 +01:00
304 lines
15 KiB
HTML
304 lines
15 KiB
HTML
|
|
|
|
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" data-content_root="./">
|
|
<head>
|
|
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>slsReceiver/ slsMultiReceiver — slsDetectorPackage 9.0.0 documentation</title>
|
|
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
|
|
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
|
|
<link rel="stylesheet" type="text/css" href="_static/css/extra.css?v=2be88464" />
|
|
|
|
|
|
<script src="_static/jquery.js?v=5d32c60e"></script>
|
|
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
|
<script src="_static/documentation_options.js?v=5929fcd5"></script>
|
|
<script src="_static/doctools.js?v=9bcbadda"></script>
|
|
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
|
<script src="_static/js/theme.js"></script>
|
|
<link rel="index" title="Index" href="genindex.html" />
|
|
<link rel="search" title="Search" href="search.html" />
|
|
<link rel="next" title="File format" href="fileformat.html" />
|
|
<link rel="prev" title="Receivers" href="receivers.html" />
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav">
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search" >
|
|
|
|
|
|
|
|
<a href="index.html" class="icon icon-home">
|
|
slsDetectorPackage 9.0.0
|
|
</a>
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<p class="caption" role="heading"><span class="caption-text">Installation:</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="dependencies.html">Dependencies</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="consuming.html">Consuming slsDetectorPackage</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">C++ API</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="detector.html">Detector</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="result.html">Result</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="receiver_api.html">Receiver</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Python API</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="pygettingstarted.html">Getting Started</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="pydetector.html">Detector</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="pyenums.html">Enums</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="pyexamples.html">Examples</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Command line</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="commandline.html">Command line interface</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="quick_start_guide.html">Quick Start Guide</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Developer</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="container_utils.html">ContainerUtils</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="type_traits.html">TypeTraits</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="ToString.html">ToString</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Firmware</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="firmware.html">Firmware Upgrade</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Detector Server</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="servers.html">Getting Started</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="serverupgrade.html">Upgrade</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="virtualserver.html">Simulators</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="serverdefaults.html">Default Values</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Detector UDP Header</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="udpheader.html">Format</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="udpconfig.html">Config file</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="udpdetspec.html">Detector Specific Fields</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Receiver</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="receivers.html">Receivers</a></li>
|
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">slsReceiver/ slsMultiReceiver</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="#client-commands">Client Commands</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#performance">Performance</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#using-callbacks">Using Callbacks</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Receiver Files</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="fileformat.html">File format</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="slsreceiverheaderformat.html">SLS Receiver Header Format</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="masterfileattributes.html">Master File Attributes</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryfileformat.html">Binary File Format</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="hdf5fileformat.html">HDF5 File Format</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Receiver ZMQ Stream</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="zmqjsonheaderformat.html">ZMQ: Json Header Format</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Troubleshooting</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="index.html">slsDetectorPackage 9.0.0</a>
|
|
</nav>
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="Page navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
|
<li class="breadcrumb-item active">slsReceiver/ slsMultiReceiver</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="_sources/slsreceiver.rst.txt" rel="nofollow"> View page source</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<section id="slsreceiver-slsmultireceiver">
|
|
<h1>slsReceiver/ slsMultiReceiver<a class="headerlink" href="#slsreceiver-slsmultireceiver" title="Link to this heading"></a></h1>
|
|
<div class="line-block">
|
|
<div class="line">One has to start the slsReceiver before loading config file or using any receiver commands (prefix: <strong>rx_</strong> )</div>
|
|
</div>
|
|
<dl>
|
|
<dt>For a Single Module</dt><dd><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># default port 1954</span>
|
|
slsReceiver
|
|
|
|
<span class="c1"># custom port 2012</span>
|
|
slsReceiver<span class="w"> </span>-t2012
|
|
</pre></div>
|
|
</div>
|
|
</dd>
|
|
<dt>For Multiple Modules</dt><dd><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># each receiver (for each module) requires a unique tcp port (if all on same machine)</span>
|
|
|
|
<span class="c1"># using slsReceiver in multiple consoles</span>
|
|
slsReceiver
|
|
slsReceiver<span class="w"> </span>-t1955
|
|
|
|
<span class="c1"># slsMultiReceiver [starting port] [number of receivers]</span>
|
|
slsMultiReceiver<span class="w"> </span><span class="m">2012</span><span class="w"> </span><span class="m">2</span>
|
|
|
|
<span class="c1"># slsMultiReceiver [starting port] [number of receivers] [print each frame header for debugging]</span>
|
|
slsMultiReceiver<span class="w"> </span><span class="m">2012</span><span class="w"> </span><span class="m">2</span><span class="w"> </span><span class="m">1</span>
|
|
</pre></div>
|
|
</div>
|
|
</dd>
|
|
</dl>
|
|
<section id="client-commands">
|
|
<h2>Client Commands<a class="headerlink" href="#client-commands" title="Link to this heading"></a></h2>
|
|
<div class="line-block">
|
|
<div class="line">One can remove <strong>udp_dstmac</strong> from the config file, as the slsReceiver fetches this from the <strong>udp_ip</strong>.</div>
|
|
</div>
|
|
<div class="line-block">
|
|
<div class="line">One can use “auto” for <strong>udp_dstip</strong> if one wants to use default ip of <strong>rx_hostname</strong>.</div>
|
|
</div>
|
|
<div class="line-block">
|
|
<div class="line">The first command to the receiver (<strong>rx_</strong> commands) should be <strong>rx_hostname</strong>. The following are the different ways to establish contact.</div>
|
|
</div>
|
|
<blockquote>
|
|
<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># default receiver tcp port (1954)</span>
|
|
rx_hostname<span class="w"> </span>xxx
|
|
|
|
<span class="c1"># custom receiver port</span>
|
|
rx_hostname<span class="w"> </span>xxx:1957
|
|
|
|
<span class="c1"># custom receiver port</span>
|
|
rx_tcpport<span class="w"> </span><span class="m">1954</span>
|
|
rx_hostname<span class="w"> </span>xxx
|
|
|
|
<span class="c1"># multi modules with custom ports</span>
|
|
rx_hostname<span class="w"> </span>xxx:1955+xxx:1956+
|
|
|
|
|
|
<span class="c1"># multi modules using increasing tcp ports when using multi detector command</span>
|
|
rx_tcpport<span class="w"> </span><span class="m">1955</span>
|
|
rx_hostname<span class="w"> </span>xxx
|
|
|
|
<span class="c1"># or specify multi modules with custom ports on same rxr pc</span>
|
|
<span class="m">0</span>:rx_tcpport<span class="w"> </span><span class="m">1954</span>
|
|
<span class="m">1</span>:rx_tcpport<span class="w"> </span><span class="m">1955</span>
|
|
<span class="m">2</span>:rx_tcpport<span class="w"> </span><span class="m">1956</span>
|
|
rx_hostname<span class="w"> </span>xxx
|
|
|
|
<span class="c1"># multi modules with custom ports on different rxr pc</span>
|
|
<span class="m">0</span>:rx_tcpport<span class="w"> </span><span class="m">1954</span>
|
|
<span class="m">0</span>:rx_hostname<span class="w"> </span>xxx
|
|
<span class="m">1</span>:rx_tcpport<span class="w"> </span><span class="m">1955</span>
|
|
<span class="m">1</span>:rx_hostname<span class="w"> </span>yyy
|
|
</pre></div>
|
|
</div>
|
|
</div></blockquote>
|
|
<div class="line-block">
|
|
<div class="line">Example commands:</div>
|
|
</div>
|
|
<blockquote>
|
|
<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># to get a list of receiver commands (these dont include file commands)</span>
|
|
sls_detector_get<span class="w"> </span>list<span class="w"> </span><span class="p">|</span><span class="w"> </span>grep<span class="w"> </span>rx_
|
|
|
|
<span class="c1"># some file commands are:</span>
|
|
fwrite
|
|
foverwrite
|
|
findex
|
|
fpath
|
|
fname
|
|
fmaster
|
|
fformat
|
|
|
|
<span class="c1"># to get help on a single commands</span>
|
|
sls_detector_get<span class="w"> </span>-h<span class="w"> </span>rx_framescaught
|
|
</pre></div>
|
|
</div>
|
|
</div></blockquote>
|
|
</section>
|
|
<section id="performance">
|
|
<h2>Performance<a class="headerlink" href="#performance" title="Link to this heading"></a></h2>
|
|
<p>Please refer to Receiver PC Tuning options and slsReceiver Tuning under <a class="reference external" href="https://slsdetectorgroup.github.io/devdoc/troubleshooting.html">Troubleshooting</a>.</p>
|
|
</section>
|
|
<section id="using-callbacks">
|
|
<h2>Using Callbacks<a class="headerlink" href="#using-callbacks" title="Link to this heading"></a></h2>
|
|
<dl class="simple">
|
|
<dt>One can get a callback in the receiver for each frame to:</dt><dd><ul class="simple">
|
|
<li><p>manipulate the data that will be written to file, or</p></li>
|
|
<li><p>disable file writing in slsReceiver and take care of the data for each call back</p></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<p>When handling callbacks, the control should be returned as soon as possible, to prevent packet loss from fifo being full.</p>
|
|
<dl>
|
|
<dt><strong>Example</strong></dt><dd><ul>
|
|
<li><p><a class="reference external" href="https://github.com/slsdetectorgroup/api-examples/blob/master/e4-receiver_callbacks.cpp">main cpp file</a></p></li>
|
|
<li><p><a class="reference external" href="https://github.com/slsdetectorgroup/api-examples/blob/master/CMakeLists.txt">cmake file</a>.</p></li>
|
|
<li><p>how to install the slsDetectorPackage with cmake is provided <a class="reference internal" href="installation.html#build-from-source-using-cmake"><span class="std std-ref">here</span></a>.</p></li>
|
|
<li><p>compile the example <strong>e4-rxr</strong> by:</p>
|
|
<blockquote>
|
|
<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>cmake<span class="w"> </span>../path/to/your/source<span class="w"> </span>-DCMAKE_PREFIX_PATH<span class="o">=</span>/path/to/sls/install
|
|
make
|
|
</pre></div>
|
|
</div>
|
|
</div></blockquote>
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
</section>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
<a href="receivers.html" class="btn btn-neutral float-left" title="Receivers" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|
<a href="fileformat.html" class="btn btn-neutral float-right" title="File format" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>© Copyright 2020, PSD Detector Group.</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
<script>
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html> |