Files
seiscomp-training/share/doc/caps/html/apps/test2caps.html

382 lines
22 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>test2caps &#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="v4l2caps" href="v4l2caps.html" />
<link rel="prev" title="sproc2caps" href="sproc2caps.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="v4l2caps.html" title="v4l2caps"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="sproc2caps.html" title="sproc2caps"
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="test2caps">
<span id="id1"></span><h1>test2caps<a class="headerlink" href="#test2caps" title="Permalink to this heading"></a></h1>
<p><strong>Recordstream data acquisition plugin</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p><strong class="program">test2caps</strong> allows to generate test signals which are send to a CAPS
server. This plugin is useful for testing and developing data acquisition or
processing modules.</p>
</section>
<section id="module-configuration">
<h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/test2caps.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/test2caps.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/test2caps.cfg</span></code></div>
</div>
<p>test2caps inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<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 global
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>
</div>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<section id="general">
<span id="id2"></span><h3>General<a class="headerlink" href="#general" title="Permalink to this heading"></a></h3>
<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 help message</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-config">
<span class="sig-name descname"><span class="pre">--config</span></span><span class="sig-prename descclassname"> <span class="pre">file</span></span><a class="headerlink" href="#cmdoption-config" title="Permalink to this definition"></a></dt>
<dd><p>File to read configuration from</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-0">
<span id="cmdoption-1"></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-0" title="Permalink to this definition"></a></dt>
<dd><p>Print help message</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">arg</span></span><a class="headerlink" href="#cmdoption-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]</p>
</dd></dl>
</section>
<section id="stream">
<span id="id3"></span><h3>Stream<a class="headerlink" href="#stream" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-id">
<span class="sig-name descname"><span class="pre">--id</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-id" title="Permalink to this definition"></a></dt>
<dd><p>Comma separated list of stream IDs [net.sta.loc.cha] to use</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-id-file">
<span class="sig-name descname"><span class="pre">--id-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-id-file" title="Permalink to this definition"></a></dt>
<dd><p>File to read stream IDs from</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-begin">
<span class="sig-name descname"><span class="pre">--begin</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-begin" title="Permalink to this definition"></a></dt>
<dd><p>Start date and time of data stream</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-interval">
<span class="sig-name descname"><span class="pre">--interval</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-interval" title="Permalink to this definition"></a></dt>
<dd><p>Sampling interval to use, format is numerator/denominator</p>
</dd></dl>
</section>
<section id="mode">
<span id="id4"></span><h3>Mode<a class="headerlink" href="#mode" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-read-from">
<span class="sig-name descname"><span class="pre">--read-from</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-read-from" title="Permalink to this definition"></a></dt>
<dd><p>File to read data from</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-random">
<span class="sig-name descname"><span class="pre">--random</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-random" title="Permalink to this definition"></a></dt>
<dd><p>Generate n random samples</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-stream">
<span class="sig-name descname"><span class="pre">--stream</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-stream" title="Permalink to this definition"></a></dt>
<dd><p>Generate continuous sinus data</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-amplitude">
<span class="sig-name descname"><span class="pre">--amplitude</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-amplitude" title="Permalink to this definition"></a></dt>
<dd><p>Amplitude of sinus data</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-period">
<span class="sig-name descname"><span class="pre">--period</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-period" title="Permalink to this definition"></a></dt>
<dd><p>Period of sinus data in seconds</p>
</dd></dl>
</section>
<section id="packets">
<span id="id5"></span><h3>Packets<a class="headerlink" href="#packets" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-data-type">
<span class="sig-name descname"><span class="pre">--data-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-data-type" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-arg-arg">
<span class="sig-name descname"><span class="pre">arg</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-arg-arg" title="Permalink to this definition"></a></dt>
<dd><p>Data type to use. Available are: INT8, INT32, FLOAT, DOUBLE</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-fill">
<span class="sig-name descname"><span class="pre">--fill</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-fill" title="Permalink to this definition"></a></dt>
<dd><p>Number of seconds of data to send before/after start time</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-format">
<span class="sig-name descname"><span class="pre">--format</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-format" title="Permalink to this definition"></a></dt>
<dd><p>Format description 4 characters, e.g. JPEG</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-mseed">
<span class="sig-name descname"><span class="pre">--mseed</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-mseed" title="Permalink to this definition"></a></dt>
<dd><p>Enable Steim2 encoding for RAW packets</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-recsize">
<span class="sig-name descname"><span class="pre">--recsize</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-recsize" title="Permalink to this definition"></a></dt>
<dd><p>Record size in samples in stream mode</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-q">
<span id="cmdoption-quality"></span><span class="sig-name descname"><span class="pre">-q</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">--quality</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-q" title="Permalink to this definition"></a></dt>
<dd><p>Record timing quality</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-type">
<span class="sig-name descname"><span class="pre">--type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-type" title="Permalink to this definition"></a></dt>
<dd><p>Packet type to use, e.g. ANY, RAW</p>
</dd></dl>
</section>
<section id="output">
<span id="id6"></span><h3>Output<a class="headerlink" href="#output" title="Permalink to this heading"></a></h3>
<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">arg</span></span><a class="headerlink" href="#cmdoption-H" title="Permalink to this definition"></a></dt>
<dd><p>Data output host</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-p">
<span id="cmdoption-port"></span><span class="sig-name descname"><span class="pre">-p</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">--port</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-p" title="Permalink to this definition"></a></dt>
<dd><p>Data output port</p>
</dd></dl>
</section>
<section id="verbosity">
<span id="id7"></span><h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-2">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-2" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
</section>
<section id="id8">
<span id="id9"></span><h3>Output<a class="headerlink" href="#id8" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-3">
<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">arg</span></span><a class="headerlink" href="#cmdoption-3" title="Permalink to this definition"></a></dt>
<dd><p>Data output host</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-4">
<span id="cmdoption-5"></span><span class="sig-name descname"><span class="pre">-p</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">--port</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-4" title="Permalink to this definition"></a></dt>
<dd><p>Data output port</p>
</dd></dl>
</section>
<section id="journal">
<span id="id10"></span><h3>Journal<a class="headerlink" href="#journal" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-j">
<span id="cmdoption-journal"></span><span class="sig-name descname"><span class="pre">-j</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">--journal</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-j" title="Permalink to this definition"></a></dt>
<dd><p>File to store stream states. Use an empty string to log to standard out.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-f">
<span id="cmdoption-flush"></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">--flush</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-f" title="Permalink to this definition"></a></dt>
<dd><p>Flush stream states to disk every n seconds</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-waitForAck">
<span class="sig-name descname"><span class="pre">--waitForAck</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-waitForAck" title="Permalink to this definition"></a></dt>
<dd><p>Wait when a sync has been forced, up to n seconds</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-w">
<span id="cmdoption-waitForLastAck"></span><span class="sig-name descname"><span class="pre">-w</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">--waitForLastAck</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-w" title="Permalink to this definition"></a></dt>
<dd><p>Wait on shutdown to receive acknownledgement messages, up to n seconds</p>
</dd></dl>
</section>
</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="#">test2caps</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#general">General</a></li>
<li><a class="reference internal" href="#stream">Stream</a></li>
<li><a class="reference internal" href="#mode">Mode</a></li>
<li><a class="reference internal" href="#packets">Packets</a></li>
<li><a class="reference internal" href="#output">Output</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#id8">Output</a></li>
<li><a class="reference internal" href="#journal">Journal</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="sproc2caps.html"
title="previous chapter">sproc2caps</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="v4l2caps.html"
title="next chapter">v4l2caps</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/test2caps.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>