NOAA/seiscomp-training
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
77d31c25c1e3df9cc836a8ee0bc3eb02ec198c12
seiscomp-training/share/doc/caps/html/apps/rtpd2caps.html

477 lines
35 KiB
HTML
Raw Blame History

<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>rtpd2caps &#8212; CAPS: Common Acquisition Protocol Server documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/gempa.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/gempa.css?v=c960eebf" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<script type="text/javascript" src="../_static/gempa.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=b3ba4146"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="slink2caps" href="slink2caps.html" />
<link rel="prev" title="rs2caps" href="rs2caps.html" />
</head>
<body>
<div class="header">
<div class="container">
<img class="background" src="../_static/icon.png"/>
<div class="content">
<span class="title">CAPS: Common Acquisition Protocol Server </span>
<span class="version">2025.254#f0c77b29e</span></h1>
</div>
</div>
</div>
<div class="nav">
<div class="container">
<div class="content"><a class="pull-right" id="sidebar-toggle">TOC</a>
<div class="related" role="navigation" aria-label="related navigation">
<ul>
<li class="right">
<a href="../genindex.html" title="General Index"
accesskey="I">
index
</a>
</li>
<li class="right">
<a href="slink2caps.html" title="slink2caps"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="rs2caps.html" title="rs2caps"
accesskey="P">
previous
</a>
</li>
<li class="nav-item nav-item-0">
<a href="../index.html">Home</a>
</li>
<li class="nav-item nav-item-1">
<a href="../base/plugins.html" accesskey="U">Data Acquisition and Manipulation by Plugins</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="rtpd2caps">
<span id="id1"></span><h1>rtpd2caps<a class="headerlink" href="#rtpd2caps" title="Permalink to this heading"></a></h1>
<p><strong>CAPS import module for MRF packets from RTPD server.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>The RTPD plugin for CAPS collects DT and MRF packets through the REN protocol. It
is supposed to have very low latency suitable for real-time data transmission.</p>
<p>The RTPD plugin needs a configuration file which is usually created by its init
script. This configuration files lives under
<code class="file docutils literal notranslate"><span class="pre">$SEISCOMP_ROOT/var/lib/rtpd2caps.cfg</span></code>.
The init script reads the configuration from <code class="file docutils literal notranslate"><span class="pre">$SEISCOMP_ROOT/etc/rtpd2caps.cfg</span></code>
and the bindings from <code class="file docutils literal notranslate"><span class="pre">$SEISCOMP_ROOT/etc/key/rtpd2caps/*</span></code> and prepares the
above final configuration file.</p>
<p>The configuration used by rtpd2caps looks like this:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Number of records to queue if the sink connection is not available</span>
<span class="nv">queue_size</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">20000</span>
<span class="c1"># Define the channel mapping. Each item is a tuple of source id composed</span>
<span class="c1"># of stream and channel and target location and stream code. The target code</span>
<span class="c1"># can be a single channel code (e.g. HNZ) or a combination of location and</span>
<span class="c1"># channel code (e.g. 00.HNZ). In case of DT packets the sampling interval</span>
<span class="c1"># must be specified after the channel code separated by &#39;@&#39;</span>
<span class="c1"># channels = 1.0:HNZ, 1.1:HN1, 1.2:HN2 MRF</span>
<span class="c1"># Starts a particular unit configuration. channel mapping can be overridden</span>
<span class="c1"># in a unit section as well.</span>
unit<span class="w"> </span>200B3
<span class="w"> </span><span class="c1"># Defines the output network code for this unit.</span>
<span class="w"> </span><span class="nv">network</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;RT&quot;</span>
<span class="w"> </span><span class="c1"># Defines the output station code for this unit.</span>
<span class="w"> </span><span class="nv">station</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;TEST1&quot;</span>
<span class="w"> </span><span class="c1"># The RTPD server address.</span>
<span class="w"> </span><span class="nv">address</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">1</span>.2.3.4:2543
<span class="w"> </span><span class="c1"># The CAPS server address.</span>
<span class="w"> </span><span class="nv">sink</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>localhost:18003
<span class="c1"># Another unit.</span>
unit<span class="w"> </span>200B4
<span class="w"> </span><span class="nv">network</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;RT&quot;</span>
<span class="w"> </span><span class="nv">station</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;TEST2&quot;</span>
<span class="w"> </span><span class="nv">address</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">1</span>.2.3.4:2543
<span class="w"> </span><span class="nv">sink</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>localhost
</pre></div>
</div>
<p>A user does not need to create this configuration file manually if using the
plugin integrated into <cite>SeisComP</cite>. The rtpd2caps plugin can be configured as any other
<cite>SeisComP</cite> module, e.g. via <strong class="program">scconfig</strong>.</p>
<p>An example <cite>CAPS</cite> configuration to generate the configuration above can look like this:</p>
<p><code class="file docutils literal notranslate"><span class="pre">$SEISCOMP3_ROOT/etc/rtpd2caps.cfg</span></code></p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># RTP server address in format [host]:[port]. If port is omitted, 2543 is</span>
<span class="c1"># assumed. This is optional and only used if the address in a binding is</span>
<span class="c1"># omitted.</span>
<span class="nv">address</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">1</span>.2.3.4
<span class="c1"># CAPS server address to send data to in format [host]:[port]. If port is</span>
<span class="c1"># omitted, 18003 is assumed. This is optional and only used if the sink in a</span>
<span class="c1"># binding is omitted.</span>
<span class="nv">sink</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>localhost:18003
<span class="c1"># Channel mapping list where each item maps a REFTEK stream/channel id to a</span>
<span class="c1"># SEED channel code with optional location code. Format:</span>
<span class="c1"># {stream}.{channel}:[{loc}.]{cha}, e.g. 1.0:00.HHZ. This is the default used</span>
<span class="c1"># if a station binding does not define it explicitly.</span>
<span class="nv">channels</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">1</span>.0:HNZ,1.1:HN1,1.2:HN2
<span class="c1"># Number of packets that can be queued when a sink is not reachable.</span>
<span class="nv">queueSize</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">20000</span>
</pre></div>
</div>
<p><code class="file docutils literal notranslate"><span class="pre">$SEISCOMP3_ROOT/etc/key/rtpd2caps/station_RT_TEST1</span></code></p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Mandatory REFTEK unit id (hex).</span>
<span class="nv">unit</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>200B3
</pre></div>
</div>
<p><code class="file docutils literal notranslate"><span class="pre">$SEISCOMP3_ROOT/etc/key/rtpd2caps/station_RT_TEST2</span></code></p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Mandatory REFTEK unit id (hex).</span>
<span class="nv">unit</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>200B4
</pre></div>
</div>
</section>
<section id="test-examples">
<h2>Test examples<a class="headerlink" href="#test-examples" title="Permalink to this heading"></a></h2>
<p>To test a server and check what packages are available, rtpd2caps can be ran
in test and verify mode.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>rtpd2caps<span class="w"> </span>-H<span class="w"> </span><span class="m">1</span>.2.3.4<span class="w"> </span>--verify<span class="w"> </span>--test
Requested<span class="w"> </span>attributes:
DAS<span class="w"> </span><span class="s1">&#39;mask&#39;</span><span class="w"> </span><span class="o">(</span>at_dasid<span class="o">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">00000000</span>
Packet<span class="w"> </span>mask<span class="w"> </span><span class="o">(</span>at_pmask<span class="o">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>0x00004000
Stream<span class="w"> </span>mask<span class="w"> </span><span class="o">(</span>at_smask<span class="o">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>0x0000FFFF
Socket<span class="w"> </span>I/O<span class="w"> </span>timeout<span class="w"> </span><span class="o">(</span>at_timeo<span class="o">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">30</span>
TCP/IP<span class="w"> </span>transmit<span class="w"> </span>buffer<span class="w"> </span><span class="o">(</span>at_sndbuf<span class="o">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">0</span>
TCP/IP<span class="w"> </span>receive<span class="w"> </span>buffer<span class="w"> </span><span class="o">(</span>at_rcvbuf<span class="o">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">0</span>
blocking<span class="w"> </span>I/O<span class="w"> </span>flag<span class="w"> </span><span class="o">(</span>at_block<span class="o">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>TRUE
<span class="m">2013</span>:198-08:32:40<span class="w"> </span><span class="nb">local</span><span class="w"> </span><span class="o">[</span><span class="m">2195</span><span class="o">]</span><span class="w"> </span>Parameters:
<span class="m">2013</span>:198-08:32:40<span class="w"> </span><span class="nb">local</span><span class="w"> </span><span class="o">[</span><span class="m">2195</span><span class="o">]</span><span class="w"> </span>*<span class="w"> </span><span class="nv">queue_size</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">10000</span><span class="w"> </span>records
<span class="m">2013</span>:198-08:32:40<span class="w"> </span><span class="nb">local</span><span class="w"> </span><span class="o">[</span><span class="m">2195</span><span class="o">]</span><span class="w"> </span>*<span class="w"> </span><span class="nv">backfilling_buffer_size</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>0s
<span class="m">2013</span>:198-08:32:40<span class="w"> </span><span class="nb">local</span><span class="w"> </span><span class="o">[</span><span class="m">2195</span><span class="o">]</span><span class="w"> </span>Configured<span class="w"> </span><span class="m">1</span><span class="w"> </span>source<span class="o">(</span>s<span class="o">)</span><span class="w"> </span>and<span class="w"> </span><span class="m">0</span><span class="w"> </span>sink<span class="o">(</span>s<span class="o">)</span>
<span class="o">[</span>RTP<span class="w"> </span><span class="m">69</span>.15.146.174:2543<span class="o">]</span>
<span class="w"> </span>XX.YYYY<span class="w"> </span>unit<span class="w"> </span><span class="m">0</span>
<span class="m">2013</span>:198-08:32:40<span class="w"> </span><span class="nb">local</span><span class="w"> </span><span class="o">[</span><span class="m">2195</span><span class="o">]</span><span class="w"> </span>started<span class="w"> </span>reading<span class="w"> </span>from<span class="w"> </span>RTP<span class="w"> </span>server<span class="w"> </span>at<span class="w"> </span><span class="m">1</span>.2.3.4:2543
<span class="m">2013</span>:198-08:32:42<span class="w"> </span><span class="nb">local</span><span class="w"> </span><span class="o">[</span><span class="m">2195</span><span class="o">]</span><span class="w"> </span>Commands<span class="w"> </span>may<span class="w"> </span>not<span class="w"> </span>be<span class="w"> </span>sent
<span class="m">2013</span>:198-08:32:42<span class="w"> </span><span class="nb">local</span><span class="w"> </span><span class="o">[</span><span class="m">2195</span><span class="o">]</span><span class="w"> </span>connected<span class="w"> </span>to<span class="w"> </span><span class="m">1</span>.2.3.4:2543
Actual<span class="w"> </span>parameters:
DAS<span class="w"> </span><span class="s1">&#39;mask&#39;</span><span class="w"> </span><span class="o">(</span>at_dasid<span class="o">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">00000000</span>
Packet<span class="w"> </span>mask<span class="w"> </span><span class="o">(</span>at_pmask<span class="o">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>0x00004000
Stream<span class="w"> </span>mask<span class="w"> </span><span class="o">(</span>at_smask<span class="o">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>0x0000FFFF
Socket<span class="w"> </span>I/O<span class="w"> </span>timeout<span class="w"> </span><span class="o">(</span>at_timeo<span class="o">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">30</span>
TCP/IP<span class="w"> </span>transmit<span class="w"> </span>buffer<span class="w"> </span><span class="o">(</span>at_sndbuf<span class="o">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">0</span>
TCP/IP<span class="w"> </span>receive<span class="w"> </span>buffer<span class="w"> </span><span class="o">(</span>at_rcvbuf<span class="o">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">0</span>
blocking<span class="w"> </span>I/O<span class="w"> </span>flag<span class="w"> </span><span class="o">(</span>at_block<span class="o">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>TRUE
200B3<span class="w"> </span>stream<span class="w"> </span><span class="m">1</span>
<span class="w"> </span>chamap:<span class="w"> </span><span class="m">7</span>
<span class="w"> </span>chacnt:<span class="w"> </span><span class="m">3</span>
<span class="w"> </span>cha<span class="w"> </span>:<span class="w"> </span><span class="m">99</span>
<span class="w"> </span>dtype<span class="w"> </span>:<span class="w"> </span><span class="m">50</span>
<span class="w"> </span><span class="nb">time</span><span class="w"> </span>:<span class="w"> </span><span class="m">2013</span>.198<span class="w"> </span><span class="m">08</span>:33:39.714000
<span class="w"> </span>nsamp<span class="w"> </span>:<span class="w"> </span><span class="m">20</span>
<span class="w"> </span>bytes<span class="w"> </span>:<span class="w"> </span><span class="m">512</span>
<span class="w"> </span>rate<span class="w"> </span>:<span class="w"> </span><span class="m">100</span>
<span class="w"> </span>chans<span class="w"> </span>:<span class="w"> </span><span class="m">0</span>,<span class="w"> </span><span class="m">1</span>,<span class="w"> </span><span class="m">2</span>
200B3<span class="w"> </span>stream<span class="w"> </span><span class="m">1</span>
<span class="w"> </span>chamap:<span class="w"> </span><span class="m">7</span>
<span class="w"> </span>chacnt:<span class="w"> </span><span class="m">3</span>
<span class="w"> </span>cha<span class="w"> </span>:<span class="w"> </span><span class="m">99</span>
<span class="w"> </span>dtype<span class="w"> </span>:<span class="w"> </span><span class="m">50</span>
<span class="w"> </span><span class="nb">time</span><span class="w"> </span>:<span class="w"> </span><span class="m">2013</span>.198<span class="w"> </span><span class="m">08</span>:33:39.914000
<span class="w"> </span>nsamp<span class="w"> </span>:<span class="w"> </span><span class="m">20</span>
<span class="w"> </span>bytes<span class="w"> </span>:<span class="w"> </span><span class="m">512</span>
<span class="w"> </span>rate<span class="w"> </span>:<span class="w"> </span><span class="m">100</span>
<span class="w"> </span>chans<span class="w"> </span>:<span class="w"> </span><span class="m">0</span>,<span class="w"> </span><span class="m">1</span>,<span class="w"> </span><span class="m">2</span>
200B3<span class="w"> </span>stream<span class="w"> </span><span class="m">1</span>
<span class="w"> </span>chamap:<span class="w"> </span><span class="m">7</span>
<span class="w"> </span>chacnt:<span class="w"> </span><span class="m">3</span>
<span class="w"> </span>cha<span class="w"> </span>:<span class="w"> </span><span class="m">99</span>
<span class="w"> </span>dtype<span class="w"> </span>:<span class="w"> </span><span class="m">50</span>
<span class="w"> </span><span class="nb">time</span><span class="w"> </span>:<span class="w"> </span><span class="m">2013</span>.198<span class="w"> </span><span class="m">08</span>:33:40.114000
<span class="w"> </span>nsamp<span class="w"> </span>:<span class="w"> </span><span class="m">20</span>
<span class="w"> </span>bytes<span class="w"> </span>:<span class="w"> </span><span class="m">512</span>
<span class="w"> </span>rate<span class="w"> </span>:<span class="w"> </span><span class="m">100</span>
<span class="w"> </span>chans<span class="w"> </span>:<span class="w"> </span><span class="m">0</span>,<span class="w"> </span><span class="m">1</span>,<span class="w"> </span><span class="m">2</span>
200B3<span class="w"> </span>stream<span class="w"> </span><span class="m">1</span>
<span class="w"> </span>chamap:<span class="w"> </span><span class="m">7</span>
<span class="w"> </span>chacnt:<span class="w"> </span><span class="m">3</span>
<span class="w"> </span>cha<span class="w"> </span>:<span class="w"> </span><span class="m">99</span>
<span class="w"> </span>dtype<span class="w"> </span>:<span class="w"> </span><span class="m">50</span>
<span class="w"> </span><span class="nb">time</span><span class="w"> </span>:<span class="w"> </span><span class="m">2013</span>.198<span class="w"> </span><span class="m">08</span>:33:40.314000
<span class="w"> </span>nsamp<span class="w"> </span>:<span class="w"> </span><span class="m">20</span>
<span class="w"> </span>bytes<span class="w"> </span>:<span class="w"> </span><span class="m">512</span>
<span class="w"> </span>rate<span class="w"> </span>:<span class="w"> </span><span class="m">100</span>
<span class="w"> </span>chans<span class="w"> </span>:<span class="w"> </span><span class="m">0</span>,<span class="w"> </span><span class="m">1</span>,<span class="w"> </span><span class="m">2</span>
...
</pre></div>
</div>
</section>
<section id="module-configuration">
<h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="admonition note">
<p class="admonition-title">Note</p>
<ul>
<li><p>rtpd2caps is a standalone module and does not inherit
<a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p></li>
<li><p>Modules/plugins may require a license file. The default path to license
files is <code class="file docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/licenses/</span></code> which can be overridden by module
configuration of the parameter <code class="xref std std-confval docutils literal notranslate"><span class="pre">gempa.licensePath</span></code>. Example:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>gempa.licensePath = @CONFIGDIR@/licenses
</pre></div>
</div>
</li>
</ul>
</div>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/rtpd2caps.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/rtpd2caps.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/rtpd2caps.cfg</span></code></div>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-address">
<span class="sig-name descname"><span class="pre">address</span></span><a class="headerlink" href="#confval-address" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>RTP server address in format [host]:[port]. If port
is omitted, 2543 is assumed. This is optional and only used
if the address in a binding is omitted.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-sink">
<span class="sig-name descname"><span class="pre">sink</span></span><a class="headerlink" href="#confval-sink" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>CAPS server address to send data to in format [host]:[port].
If port is omitted, 18003 is assumed. This is optional and only used
if the sink in a binding is omitted.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-channels">
<span class="sig-name descname"><span class="pre">channels</span></span><a class="headerlink" href="#confval-channels" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>Channel mapping list where each item maps a REFTEK
stream/channel id to a SEED channel code with optional
location code. Format: {stream}.{channel}:[{loc}.]{cha}, e.g.
1.0:00.HHZ. This is the default used if a station binding does
not define it explicitly.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-queueSize">
<span class="sig-name descname"><span class="pre">queueSize</span></span><a class="headerlink" href="#confval-queueSize" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">10000</span></code></p>
<p>Type: <em>int</em></p>
<p>Number of packets that can be queued when a sink is not reachable.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-backFillingBufferSize">
<span class="sig-name descname"><span class="pre">backFillingBufferSize</span></span><a class="headerlink" href="#confval-backFillingBufferSize" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code></p>
<p>Unit: <em>s</em></p>
<p>Type: <em>int</em></p>
<p>Length of backfilling buffer. Whenever a hole is detected, records
will be held in a buffer and not sent out. Records are flushed from
front to back if the buffer size is exceeded.</p>
</dd></dl>
</section>
<section id="bindings-parameters">
<h2>Bindings Parameters<a class="headerlink" href="#bindings-parameters" title="Permalink to this heading"></a></h2>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-unit">
<span class="sig-name descname"><span class="pre">unit</span></span><a class="headerlink" href="#confval-unit" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Mandatory REFTEK unit id (hex).</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-0">
<span class="sig-name descname"><span class="pre">address</span></span><a class="headerlink" href="#confval-0" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>RTP server address in format [host]:[port]. If port
is omitted, 2543 is assumed.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-1">
<span class="sig-name descname"><span class="pre">sink</span></span><a class="headerlink" href="#confval-1" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>CAPS server address to send data to in format [host]:[port].
If port is omitted, 18003 is assumed.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-2">
<span class="sig-name descname"><span class="pre">channels</span></span><a class="headerlink" href="#confval-2" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>Channel mapping list where each item maps a REFTEK
stream/channel id to a SEED channel code with optional
location code. Format: {stream}.{channel}:[{loc}.]{cha}, e.g.
1.0:00.HHZ.</p>
</dd></dl>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-h">
<span id="cmdoption-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-h" title="Permalink to this definition"></a></dt>
<dd><p>Print program usage and exit.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-H">
<span id="cmdoption-host"></span><span class="sig-name descname"><span class="pre">-H</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--host</span></span><span class="sig-prename descclassname"> <span class="pre">address</span></span><a class="headerlink" href="#cmdoption-H" title="Permalink to this definition"></a></dt>
<dd><p>RTP server to connect to in format [host]:[port]. If port
is omitted, 2543 is assumed.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-S">
<span id="cmdoption-sink"></span><span class="sig-name descname"><span class="pre">-S</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--sink</span></span><span class="sig-prename descclassname"> <span class="pre">address</span></span><a class="headerlink" href="#cmdoption-S" title="Permalink to this definition"></a></dt>
<dd><p>CAPS server to send data to in format [host]:[port]. If port
is omitted, 18003 is assumed.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-n">
<span id="cmdoption-queue-size"></span><span class="sig-name descname"><span class="pre">-n</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--queue-size</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-n" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">10000</span></code></p>
<p>Maximum number of packages queued before
the sink connection becomes blocking.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-b">
<span id="cmdoption-backfilling-buffer-size"></span><span class="sig-name descname"><span class="pre">-b</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--backfilling-buffer-size</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-b" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code></p>
<p>Buffer size in seconds for backfilling holes.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-s">
<span id="cmdoption-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-s" title="Permalink to this definition"></a></dt>
<dd><p>Logs to syslog.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-f">
<span id="cmdoption-config-file"></span><span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">path</span></span><a class="headerlink" href="#cmdoption-f" title="Permalink to this definition"></a></dt>
<dd><p>Path to configuration file to be used.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">path</span></span><a class="headerlink" href="#cmdoption-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Path to log file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">level</span></span><a class="headerlink" href="#cmdoption-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Log verbosity, 4=DEBUG, 3=INFO, 2=WARN, 1=ERR, 0=QUIET.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-debug" title="Permalink to this definition"></a></dt>
<dd><p>Set log level to DEBUG and log everything to stderr.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-verify">
<span class="sig-name descname"><span class="pre">--verify</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-verify" title="Permalink to this definition"></a></dt>
<dd><p>Dump package contents. This option is only useful for testing and debugging.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-test">
<span class="sig-name descname"><span class="pre">--test</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-test" title="Permalink to this definition"></a></dt>
<dd><p>Do not send any data to CAPS.</p>
</dd></dl>
</section>
</section>
<div id="anchors-bottom"></div>
</div>
<div class="sidebar" role="navigation" aria-label="main navigation">
<div id="anchors-top"></div>
<div id="anchors" class="content">
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">rtpd2caps</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#test-examples">Test examples</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#bindings-parameters">Bindings Parameters</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="rs2caps.html"
title="previous chapter">rs2caps</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="slink2caps.html"
title="next chapter">slink2caps</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/rtpd2caps.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<div class="container">
<div class="content">
Release <b></b> version <b>2025.254#f0c77b29e</b>
<div class="copyright">
&copy; Copyright <a href="https://www.gempa.de">2013, gempa GmbH.</a>
</div>
</div>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink