[installation] Init with inital config for global
This commit is contained in:
272
share/doc/caps/html/base/interfaces.html
Normal file
272
share/doc/caps/html/base/interfaces.html
Normal file
@ -0,0 +1,272 @@
|
||||
<!doctype html>
|
||||
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
|
||||
<title>Server Interfaces — 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="Server and File Testing" href="server-testing.html" />
|
||||
<link rel="prev" title="Execution and Automatic Startup" href="configuration.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="server-testing.html" title="Server and File Testing"
|
||||
accesskey="N">
|
||||
next
|
||||
</a>
|
||||
</li>
|
||||
<li class="right">
|
||||
<a href="configuration.html" title="Execution and Automatic Startup"
|
||||
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="server.html" accesskey="U">CAPS Server Application</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="container">
|
||||
<div class="fitted content" id="anchors-container">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="server-interfaces">
|
||||
<span id="sec-caps-interface"></span><h1>Server Interfaces<a class="headerlink" href="#server-interfaces" title="Permalink to this heading">¶</a></h1>
|
||||
<section id="client-interface-telnet">
|
||||
<span id="sec-caps-client-interface"></span><h2>Client interface / telnet<a class="headerlink" href="#client-interface-telnet" title="Permalink to this heading">¶</a></h2>
|
||||
<p><a class="reference internal" href="glossary.html#term-CAPS"><span class="xref std std-term">CAPS</span></a> provides a line based client interface for requesting data and showing
|
||||
available streams. The <code class="docutils literal notranslate"><span class="pre">telnet</span></code> command may be used to connect to the server:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>telnet<span class="w"> </span>localhost<span class="w"> </span><span class="m">18002</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The following commands are supported by the server:</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">HELLO</span></code> - prints server name and version</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">HELP</span></code> prints descriptive help</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">BYE</span></code> - disconnects from server</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">AUTH</span> <span class="pre"><user></span> <span class="pre"><password></span></code> - performs authentication</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">INFO</span> <span class="pre">STREAMS</span> <span class="pre">[stream</span> <span class="pre">id</span> <span class="pre">filter]</span></code> - lists available streams and time spans,
|
||||
see section ref{sec:ci_info_streams}</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">BEGIN</span> <span class="pre">REQUEST</span></code> - starts a request block, followed by request parameters,
|
||||
see section ref{sec:ci_request}</p>
|
||||
<ul>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">REALTIME</span> <span class="pre">ON|OFF</span></code> - enables/disables real-time mode, if disabled the
|
||||
connection is closed if all archive data was sent</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">STREAM</span> <span class="pre">ADD|REMOVE</span> <span class="pre"><NET.STA.LOC.CHA></span></code> - adds/removes a stream from the
|
||||
request, may be repeated in one request block</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">TIME</span> <span class="pre">[<starttime>]:[endtime]</span></code> - defines start and end time of the
|
||||
request, open boundaries are allowed</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">HELI</span> <span class="pre">ADD|REMOVE</span> <span class="pre"><NET.STA.LOC.CHA></span></code> - similar to STREAM but re-sample
|
||||
the data to 1Hz</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">META{@[version]}</span> <span class="pre">[ON|OFF]</span></code> - request delivery of packet header information only</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">OUTOFORDER</span> <span class="pre">[ON|OFF]</span></code> - delivers data in order of sampling or transmission time</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">SEGMENTS</span> <span class="pre">[ON|OFF]</span></code> - request delivery of times of contiguous segments (API >= 4)</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">GAPS</span> <span class="pre">[ON|OFF]</span></code> - request delivery of times of gaps (API >= 4)</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">TOLERANCE</span> <span class="pre">[value</span> <span class="pre">in</span> <span class="pre">us]</span></code> - Define data segment continuation tolerance in microseconds (API >= 4)</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">RESOLUTION</span> <span class="pre">[value</span> <span class="pre">in</span> <span class="pre">d]</span></code> - Resolution in days of the returned data segments or gaps (API >= 4)</p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">END</span></code> - finalizes a request and starts acquisition</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">PRINT</span> <span class="pre">REQUESTS</span></code> - prints active request of current session</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">ABORT</span></code> - aborts current data transmission</p></li>
|
||||
</ul>
|
||||
<p>Requests to server are separated by a new line. For the response data the server
|
||||
prepends the message length to the data. In this way non ASCII characters or
|
||||
binary content can be returned.</p>
|
||||
<section id="list-available-streams">
|
||||
<span id="sec-ci-info-streams"></span><h3>List available streams<a class="headerlink" href="#list-available-streams" title="Permalink to this heading">¶</a></h3>
|
||||
<p>The following example shows a telnet conversation of a request for available
|
||||
streams. The first line contains the request command. All other lines represent
|
||||
the server response. The response is 124 characters long. The length parameter
|
||||
is interpreted by telnet and converted to its ASCII representation, in this
|
||||
case: <code class="docutils literal notranslate"><span class="pre">|</span></code>.</p>
|
||||
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span><span class="hll"><span class="linenos">1</span>INFO STREAMS VZ.HILO.*
|
||||
</span><span class="linenos">2</span>|STREAMS
|
||||
<span class="linenos">3</span>VZ.HILO.WLS.CAM 2013-07-26T00:00:01 2013-08-02T09:28:17
|
||||
<span class="linenos">4</span>VZ.HILO.WLS.SSH 2008-06-06T00:00:00 2013-08-02T09:04:00
|
||||
<span class="linenos">5</span>END
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="data-requests">
|
||||
<span id="sec-ci-request-data"></span><h3>Data requests<a class="headerlink" href="#data-requests" title="Permalink to this heading">¶</a></h3>
|
||||
<p>Data request are initiated by a request block which defines the stream and the
|
||||
time span to fetch.</p>
|
||||
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span><span class="hll"><span class="linenos"> 1</span>BEGIN REQUEST
|
||||
</span><span class="hll"><span class="linenos"> 2</span>REALTIME OFF
|
||||
</span><span class="hll"><span class="linenos"> 3</span>STREAM ADD VZ.HILO.WLS.SSH
|
||||
</span><span class="hll"><span class="linenos"> 4</span>TIME 2013,08,02,09,00,02:
|
||||
</span><span class="hll"><span class="linenos"> 5</span>END
|
||||
</span><span class="linenos"> 6</span>DSTATUS OK
|
||||
<span class="linenos"> 7</span>SESSION_TABLE VERSION:1
|
||||
<span class="linenos"> 8</span>PACKET_HEADER IDSIZE:2,DATASIZE:4
|
||||
<span class="linenos"> 9</span>FREQUESTS
|
||||
<span class="linenos">10</span>ID:1,SID:VZ.HILO.WLS.SSH,SFREQ:1/60,UOM:mm,FMT:RAW/FLOAT
|
||||
<span class="linenos">11</span>END
|
||||
<span class="linenos">12</span>[unprintable data]
|
||||
<span class="linenos">13</span>'REQUESTS
|
||||
<span class="linenos">14</span>ID:-1,SID:VZ.HILO.WLS.SSH
|
||||
<span class="linenos">15</span>END
|
||||
<span class="linenos">16</span><EFBFBD>EOD
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The listing above shows such a request block in lines 1-5. Line 2 disables the
|
||||
real-time mode which will close the session after all data was read. Line 3 adds
|
||||
the stream to the request set. More streams may be added in successive lines.
|
||||
Line 4 specifies a start time and an open end time.</p>
|
||||
<p>The first response chunk starts at line 6 and ends at line 11. I has a length of
|
||||
68 byte (= ACCII <code class="docutils literal notranslate"><span class="pre">D</span></code>) and contains version information and a session table.
|
||||
The table maps a 2 byte integer id to data stream meta information. In this way
|
||||
following data chunks can be distinguished by only 2 bytes and the header
|
||||
information has to be transmitted only once.</p>
|
||||
<p>Line 12 contains the data chunks. It is omitted here because it contains
|
||||
unprintable characters. A data chunk starts with the 2 id bytes followed by the
|
||||
4 byte chunk size.</p>
|
||||
<p>After all data was transmitted the server reports the end of the stream (line
|
||||
13-15) and the end of the session (line 16).</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="web-interface">
|
||||
<span id="sec-caps-web-interface"></span><h2>Web interface<a class="headerlink" href="#web-interface" title="Permalink to this heading">¶</a></h2>
|
||||
<p><a class="reference internal" href="glossary.html#term-CAPS"><span class="xref std std-term">CAPS</span></a> ships with a read-only web interface for viewing information and
|
||||
downloading data. The Web interface is disabled by default and may be enabled by
|
||||
configuring a valid port number under <a class="reference internal" href="configuration.html#confval-AS.http.port"><code class="xref std std-confval docutils literal notranslate"><span class="pre">AS.http.port</span></code></a>. It provides
|
||||
different tabs:</p>
|
||||
<ul class="simple">
|
||||
<li><p><strong>Channels</strong> (figure <a href="#fig-web-streams">44</a>): View and filter available
|
||||
streams. For the RAW and miniSEED packets it is also possible to view the
|
||||
waveform data by clicking on an entry of the stream table. miniSEED data
|
||||
may be <a class="reference internal" href="data-retrieval.html#sec-caps-web"><span class="std std-ref">downloaded interactively</span></a>.</p></li>
|
||||
<li><p><strong>Server stats</strong> (figure <a href="#fig-web-overview">45</a>): View server traffic
|
||||
statistics. This tab is only accessible if the logged in user is member of the
|
||||
<em>admin</em> group as defined by <a class="reference internal" href="configuration.html#confval-AS.auth.basic.users.passwd"><code class="xref std std-confval docutils literal notranslate"><span class="pre">AS.auth.basic.users.passwd</span></code></a>.</p></li>
|
||||
<li><p><strong>Settings</strong> (figure <a href="#fig-web-settings">46</a>): Set the login
|
||||
credentials and parameters of the other perspectives.</p></li>
|
||||
</ul>
|
||||
<figure class="align-default" id="id1">
|
||||
<span id="fig-web-streams"></span><a class="reference internal image-reference" href="../_images/web_streams.png"><img alt="../_images/web_streams.png" src="../_images/web_streams.png" style="width: 18cm;" /></a>
|
||||
<figcaption>
|
||||
<p><span class="caption-text">Stream perspective of <a class="reference internal" href="glossary.html#term-CAPS"><span class="xref std std-term">CAPS</span></a> Web interface allowing to filter availability
|
||||
streams and to view waveform data for RAW and minSEED records.</span><a class="headerlink" href="#id1" title="Permalink to this image">¶</a></p>
|
||||
</figcaption>
|
||||
</figure>
|
||||
<figure class="align-default" id="id2">
|
||||
<span id="fig-web-overview"></span><a class="reference internal image-reference" href="../_images/web_overview.png"><img alt="../_images/web_overview.png" src="../_images/web_overview.png" style="width: 18cm;" /></a>
|
||||
<figcaption>
|
||||
<p><span class="caption-text">Overview perspective of <a class="reference internal" href="glossary.html#term-CAPS"><span class="xref std std-term">CAPS</span></a> Web interface showing traffic and file
|
||||
statistics.</span><a class="headerlink" href="#id2" title="Permalink to this image">¶</a></p>
|
||||
</figcaption>
|
||||
</figure>
|
||||
<figure class="align-default" id="id3">
|
||||
<span id="fig-web-settings"></span><a class="reference internal image-reference" href="../_images/web_settings.png"><img alt="../_images/web_settings.png" src="../_images/web_settings.png" style="width: 18cm;" /></a>
|
||||
<figcaption>
|
||||
<p><span class="caption-text">Settings perspective of <a class="reference internal" href="glossary.html#term-CAPS"><span class="xref std std-term">CAPS</span></a> Web interface.</span><a class="headerlink" href="#id3" title="Permalink to this image">¶</a></p>
|
||||
</figcaption>
|
||||
</figure>
|
||||
</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="#">Server Interfaces</a><ul>
|
||||
<li><a class="reference internal" href="#client-interface-telnet">Client interface / telnet</a><ul>
|
||||
<li><a class="reference internal" href="#list-available-streams">List available streams</a></li>
|
||||
<li><a class="reference internal" href="#data-requests">Data requests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#web-interface">Web interface</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="configuration.html"
|
||||
title="previous chapter">Execution and Automatic Startup</a></p>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="server-testing.html"
|
||||
title="next chapter">Server and File Testing</a></p>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/base/interfaces.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>
|
||||
Reference in New Issue
Block a user