325 lines
15 KiB
HTML
325 lines
15 KiB
HTML
<!doctype html>
|
|
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
|
|
<title>gdi2caps — 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="ngl2caps" href="ngl2caps.html" />
|
|
<link rel="prev" title="data2caps" href="data2caps.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="ngl2caps.html" title="ngl2caps"
|
|
accesskey="N">
|
|
next
|
|
</a>
|
|
</li>
|
|
<li class="right">
|
|
<a href="data2caps.html" title="data2caps"
|
|
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="gdi2caps">
|
|
<span id="id1"></span><h1>gdi2caps<a class="headerlink" href="#gdi2caps" title="Permalink to this heading">¶</a></h1>
|
|
<p><strong>CAPS import module for Guralp GDI server.</strong></p>
|
|
<section id="description">
|
|
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading">¶</a></h2>
|
|
<p>The Güralp Data Interconnect plugin(GDI) requests data from one or multiple GDI
|
|
servers and sends it to a CAPS server. The communication between a GDI server
|
|
and the plugin itself is based on the GDI client library whereas outgoing
|
|
packets are send through the CAPS client library. Depending on the configuration
|
|
outgoing packets are converted on-the-fly into MSEED by the CAPS client library.
|
|
The plugin supports the following GDI sample formats:</p>
|
|
<ul class="simple">
|
|
<li><p>INT32</p></li>
|
|
<li><p>INT16</p></li>
|
|
<li><p>IEEE32FLOAT</p></li>
|
|
<li><p>TEXT</p></li>
|
|
</ul>
|
|
</section>
|
|
<section id="backfilling">
|
|
<h2>Backfilling<a class="headerlink" href="#backfilling" title="Permalink to this heading">¶</a></h2>
|
|
<p>By default backfilling of unordered packets is enabled and the buffer size is
|
|
set to 180 seconds. With backfilling enabled The CAPS client library ensures
|
|
that all packets within this time window are send in order to the remote CAPS
|
|
server. The buffer size can be changed in the plugin configuration. A value of
|
|
zero disables the backfilling.</p>
|
|
</section>
|
|
<section id="connection-handling">
|
|
<h2>Connection handling<a class="headerlink" href="#connection-handling" title="Permalink to this heading">¶</a></h2>
|
|
<section id="caps-connection">
|
|
<h3>CAPS Connection<a class="headerlink" href="#caps-connection" title="Permalink to this heading">¶</a></h3>
|
|
<p>All packets forwarded to the CAPS client library are stored in a local packet
|
|
buffer and are removed when they have been acknowledged by the remote CAPS
|
|
server. If a packet could not be send the plugin closes the connection and
|
|
tries to reconnect in a certain interval. If the packet buffer is exceeded the
|
|
packet is droped and the client library returns with an error.</p>
|
|
</section>
|
|
<section id="gdi-connection">
|
|
<h3>GDI Connection<a class="headerlink" href="#gdi-connection" title="Permalink to this heading">¶</a></h3>
|
|
<p>For each configured GDI connection the plugin opens a connection to the remote
|
|
GDI server. The plugin requests real time data only, the retrievel of “historic”
|
|
data is not supported yet. Every second the plugin checks the connection state.
|
|
If the state is GDI_State_Out_Of_Sync it closes the connection and tries to
|
|
reconnect in a certain interval.</p>
|
|
</section>
|
|
</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>gdi2caps 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">@DATADIR@/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/gdi2caps.cfg</span></code></div>
|
|
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/gdi2caps.cfg</span></code></div>
|
|
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/gdi2caps.cfg</span></code></div>
|
|
</div>
|
|
<dl class="std confval">
|
|
<dt class="sig sig-object std" id="confval-mapping">
|
|
<span class="sig-name descname"><span class="pre">mapping</span></span><a class="headerlink" href="#confval-mapping" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Type: <em>strings</em></p>
|
|
<p>List of station name mappings separated by comma. Each list
|
|
entry has the format [name]:[alias]</p>
|
|
</dd></dl>
|
|
|
|
<dl class="std confval">
|
|
<dt class="sig sig-object std" id="confval-mseed">
|
|
<span class="sig-name descname"><span class="pre">mseed</span></span><a class="headerlink" href="#confval-mseed" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
|
|
<p>Type: <em>boolean</em></p>
|
|
<p>Enable MSEED encoding.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="std confval">
|
|
<dt class="sig sig-object std" id="confval-selectors">
|
|
<span class="sig-name descname"><span class="pre">selectors</span></span><a class="headerlink" href="#confval-selectors" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Type: <em>list:string</em></p>
|
|
<p>Format: [loc.cha, …]. Wildcards are supported.</p>
|
|
</dd></dl>
|
|
|
|
<span class="target" id="caps"></span><dl class="std confval">
|
|
<dt class="sig sig-object std" id="confval-caps.address">
|
|
<span class="sig-name descname"><span class="pre">caps.address</span></span><a class="headerlink" href="#confval-caps.address" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Type: <em>string</em></p>
|
|
<p>CAPS server address. Format is [address[:port]].</p>
|
|
</dd></dl>
|
|
|
|
<dl class="std confval">
|
|
<dt class="sig sig-object std" id="confval-caps.backFillingBufferSize">
|
|
<span class="sig-name descname"><span class="pre">caps.backFillingBufferSize</span></span><a class="headerlink" href="#confval-caps.backFillingBufferSize" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">180</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>
|
|
|
|
<div class="admonition note" id="profiles-name">
|
|
<span id="profiles"></span><p class="admonition-title">Note</p>
|
|
<p><strong>profiles.$name.*</strong>
|
|
$name is a placeholder for the name to be used.</p>
|
|
</div>
|
|
<dl class="std confval">
|
|
<dt class="sig sig-object std" id="confval-profiles.-name.source">
|
|
<span class="sig-name descname"><span class="pre">profiles.$name.source</span></span><a class="headerlink" href="#confval-profiles.-name.source" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Type: <em>string</em></p>
|
|
<p>GDI server address in format [host]:[port]. If port
|
|
is omitted, 1565 is assumed.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="std confval">
|
|
<dt class="sig sig-object std" id="confval-profiles.-name.identifier">
|
|
<span class="sig-name descname"><span class="pre">profiles.$name.identifier</span></span><a class="headerlink" href="#confval-profiles.-name.identifier" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Type: <em>string</em></p>
|
|
<p>GDI connection identifying name. If two connections
|
|
using the same name the first connection will be
|
|
closed from the server.
|
|
If omitted, the hostname is used.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="std confval">
|
|
<dt class="sig sig-object std" id="confval-profiles.-name.mapping">
|
|
<span class="sig-name descname"><span class="pre">profiles.$name.mapping</span></span><a class="headerlink" href="#confval-profiles.-name.mapping" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Type: <em>strings</em></p>
|
|
<p>List of station name mappings separated by comma. Each
|
|
entry has the format [name]:[alias]</p>
|
|
</dd></dl>
|
|
|
|
<dl class="std confval">
|
|
<dt class="sig sig-object std" id="confval-profiles.-name.selectors">
|
|
<span class="sig-name descname"><span class="pre">profiles.$name.selectors</span></span><a class="headerlink" href="#confval-profiles.-name.selectors" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Type: <em>list:string</em></p>
|
|
<p>List of selectors separated by comma. Each entry
|
|
has the format [loc.cha]. Wildcards are supported.</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-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>GDI server address in format [host]:[port]. If port
|
|
is omitted, 1565 is assumed.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="std confval">
|
|
<dt class="sig sig-object std" id="confval-identifier">
|
|
<span class="sig-name descname"><span class="pre">identifier</span></span><a class="headerlink" href="#confval-identifier" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Type: <em>string</em></p>
|
|
<p>GDI connection identifying name. If two connections
|
|
using the same name the first connection will be
|
|
closed from the server.
|
|
If omitted, the hostname is used.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="std confval">
|
|
<dt class="sig sig-object std" id="confval-0">
|
|
<span class="sig-name descname"><span class="pre">mapping</span></span><a class="headerlink" href="#confval-0" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Type: <em>strings</em></p>
|
|
<p>List of station name mappings separated by comma. Each list
|
|
entry has the format [name]:[alias]</p>
|
|
</dd></dl>
|
|
|
|
<dl class="std confval">
|
|
<dt class="sig sig-object std" id="confval-1">
|
|
<span class="sig-name descname"><span class="pre">selectors</span></span><a class="headerlink" href="#confval-1" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Type: <em>list:string</em></p>
|
|
<p>List of selectors separated by comma. Each entry
|
|
has the format [loc.cha]. Wildcards are supported.</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="#">gdi2caps</a><ul>
|
|
<li><a class="reference internal" href="#description">Description</a></li>
|
|
<li><a class="reference internal" href="#backfilling">Backfilling</a></li>
|
|
<li><a class="reference internal" href="#connection-handling">Connection handling</a><ul>
|
|
<li><a class="reference internal" href="#caps-connection">CAPS Connection</a></li>
|
|
<li><a class="reference internal" href="#gdi-connection">GDI Connection</a></li>
|
|
</ul>
|
|
</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>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
<div>
|
|
<h4>Previous topic</h4>
|
|
<p class="topless"><a href="data2caps.html"
|
|
title="previous chapter">data2caps</a></p>
|
|
</div>
|
|
<div>
|
|
<h4>Next topic</h4>
|
|
<p class="topless"><a href="ngl2caps.html"
|
|
title="next chapter">ngl2caps</a></p>
|
|
</div>
|
|
<div role="note" aria-label="source link">
|
|
<h3>This Page</h3>
|
|
<ul class="this-page-menu">
|
|
<li><a href="../_sources/apps/gdi2caps.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">
|
|
© Copyright <a href="https://www.gempa.de">2013, gempa GmbH.</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html> |