275 lines
9.3 KiB
XML
275 lines
9.3 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<seiscomp>
|
|
<module name="sproc2caps" category="Acquisition">
|
|
<description>
|
|
Recordstream data acquisition plugin that applies filter and/or a
|
|
mathematical expression to one or more data streams forming new streams
|
|
</description>
|
|
<command-line>
|
|
<group name="Generic">
|
|
<optionReference>generic#help</optionReference>
|
|
<optionReference>generic#version</optionReference>
|
|
<optionReference>generic#daemon</optionReference>
|
|
</group>
|
|
<group name="Verbosity">
|
|
<optionReference>verbosity#verbosity</optionReference>
|
|
<optionReference>verbosity#v</optionReference>
|
|
<optionReference>verbosity#quiet</optionReference>
|
|
<optionReference>verbosity#syslog</optionReference>
|
|
<optionReference>verbosity#lockfile</optionReference>
|
|
<optionReference>verbosity#console</optionReference>
|
|
<optionReference>verbosity#debug</optionReference>
|
|
<optionReference>verbosity#log-file</optionReference>
|
|
</group>
|
|
<group name="Records">
|
|
<optionReference>records#record-driver-list</optionReference>
|
|
<optionReference>records#record-url</optionReference>
|
|
<optionReference>records#record-file</optionReference>
|
|
<optionReference>records#record-type</optionReference>
|
|
</group>
|
|
<group name="Output">
|
|
<option flag="O" long-flag="output" argument="arg" publicID="Output#host" param-ref="output.address">
|
|
<description>
|
|
This is the CAPS server which shall receive the data.
|
|
</description>
|
|
</option>
|
|
<option long-flag="agent" argument="arg">
|
|
<description>
|
|
Sets the agent string. Allows the server to identify the
|
|
application that sends data.
|
|
</description>
|
|
</option>
|
|
<option flag="b" long-flag="buffer-size" argument="arg">
|
|
<description>
|
|
Size (bytes) of the journal buffer. If the value ist
|
|
exceeded, a synchronization of the journal is forced.
|
|
</description>
|
|
</option>
|
|
<option long-flag="backfilling" argument="arg" default="0">
|
|
<description>
|
|
Buffer size in seconds for backfilling gaps.
|
|
</description>
|
|
</option>
|
|
<option long-flag="mseed" argument="">
|
|
<description>
|
|
Enable on-the-fly miniSEED encoding. If the encoder does not
|
|
support the input type of a packet, it will be forwarded.
|
|
Re-encoding of miniSEED packets is not supported.
|
|
</description>
|
|
</option>
|
|
<option long-flag="encoding" argument="arg">
|
|
<description>
|
|
miniSEED encoding to use: Uncompressed, Steim1 or Steim2.
|
|
</description>
|
|
</option>
|
|
<option long-flag="rec-len" argument="arg">
|
|
<description>miniSEED record length expressed as a power of
|
|
2. A 512 byte record would be 9.
|
|
</description>
|
|
</option>
|
|
<option long-flag="max-future-endtime" argument="arg">
|
|
<description>
|
|
Maximum allowed relative end time for packets. If the packet
|
|
end time is greater than the current time plus this value,
|
|
the packet will be discarded. By default this value is set
|
|
to 120 seconds.
|
|
</description>
|
|
</option>
|
|
<option long-flag="dump-packets" argument="">
|
|
<description>
|
|
Dump packets to stdout.
|
|
</description>
|
|
</option>
|
|
</group>
|
|
<group name="Journal">
|
|
<option flag="j" long-flag="journal" argument="arg">
|
|
<description>
|
|
File to store stream states. Use an empty string to log to
|
|
stdout.
|
|
</description>
|
|
</option>
|
|
<option flag="" long-flag="flush" argument="arg">
|
|
<description>
|
|
Flush stream states to disk every n seconds.
|
|
</description>
|
|
</option>
|
|
<option long-flag="wait-for-ack arg" argument="arg">
|
|
<description>
|
|
Wait when a sync has been forced, up to n seconds.
|
|
</description>
|
|
</option>
|
|
<option flag="w" long-flag="wait-for-last-ack" argument="arg">
|
|
<description>
|
|
Wait on shutdown to receive acknownledgement messages, up to
|
|
the given number of seconds.
|
|
</description>
|
|
</option>
|
|
</group>
|
|
<group name="Status">
|
|
<option flag="" long-flag="status-log" argument="">
|
|
<description>
|
|
Log information status information, e.g., max bytes buffered.
|
|
</description>
|
|
</option>
|
|
<option flag="" long-flag="status-flush" argument="arg">
|
|
<description>
|
|
Flush status every n seconds to disk.
|
|
</description>
|
|
</option>
|
|
<option long-flag="stop" argument="">
|
|
<description>
|
|
Stop processing when data acquisition is finished. The
|
|
'finished' signal depends on data source.
|
|
</description>
|
|
</option>
|
|
</group>
|
|
<group name="Streams">
|
|
<option flag="" long-flag="begin" argument="arg">
|
|
<description>
|
|
Start time of data time window.
|
|
</description>
|
|
</option>
|
|
<option flag="" long-flag="end" argument="arg">
|
|
<description>
|
|
End time of data time window.
|
|
</description>
|
|
</option>
|
|
<option flag="" long-flag="map" argument="arg">
|
|
<description>
|
|
Stream map file.
|
|
</description>
|
|
</option>
|
|
<option flag="" long-flag="expr" argument="arg">
|
|
<description>
|
|
Mathematical expression to be applied.
|
|
</description>
|
|
</option>
|
|
</group>
|
|
<group name="Test">
|
|
<option flag="" long-flag="gain-in" argument="arg">
|
|
<description>
|
|
Gain that is applied to the input values.
|
|
</description>
|
|
</option>
|
|
<option flag="" long-flag="gain-out" argument="arg">
|
|
<description>
|
|
Gain that is applied to the output values.
|
|
</description>
|
|
</option>
|
|
</group>
|
|
</command-line>
|
|
<configuration>
|
|
<group name ="journal">
|
|
<parameter name="file" type="string" default="@ROOTDIR@/var/run/sproc2caps/journal">
|
|
<description>
|
|
File to store stream states
|
|
</description>
|
|
</parameter>
|
|
<parameter name="flush" type="uint" default="10" unit="s">
|
|
<description>
|
|
Flush stream states to disk every n seconds
|
|
</description>
|
|
</parameter>
|
|
<parameter name="waitForAck" type="uint" default="60" unit="s">
|
|
<description>
|
|
Wait when a sync has been forced, up to n seconds
|
|
</description>
|
|
</parameter>
|
|
<parameter name="waitForLastAck" type="uint" default="5" unit="s">
|
|
<description>
|
|
Wait on shutdown to receive acknownledgement messages, up to n seconds
|
|
</description>
|
|
</parameter>
|
|
</group>
|
|
<group name="streams">
|
|
<description>Configure operations applied to input streams and the stream mapping.</description>
|
|
<parameter name="begin" type="string" default="">
|
|
<description>
|
|
Start time of data time window, default 'GMT'
|
|
</description>
|
|
</parameter>
|
|
<parameter name="end" type="string" default="">
|
|
<description>
|
|
End time of data time window
|
|
</description>
|
|
</parameter>
|
|
<parameter name="filter" type="string" default="self">
|
|
<description>
|
|
Sets the input filter
|
|
</description>
|
|
</parameter>
|
|
<parameter name="expr" type="string" default="x1 + x2">
|
|
<description>
|
|
Sets the mathematical expression
|
|
</description>
|
|
</parameter>
|
|
<parameter name="map" type="string" default="@DATADIR@/sproc2caps/streams.map">
|
|
<description>
|
|
Absolute path to the stream map file. Each line
|
|
holds n input streams and one output stream.
|
|
Example:
|
|
|
|
CX.PB11..BHZ CX.PB11..BHZ
|
|
|
|
CX.PB11..BHZ CX.PB07..BHZ CX.PB11..BBZ
|
|
</description>
|
|
</parameter>
|
|
</group>
|
|
<group name="output">
|
|
<description>Configure the data output.</description>
|
|
<parameter name="address" type="string" default="localhost:18003">
|
|
<description>
|
|
Data output URL [[caps|capss]://][user:pass@]host[:port]. This parameter
|
|
superseds the host and port parameter of previous versions and takes precedence.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="host" type="string" default="localhost">
|
|
<description>
|
|
Data output host. Deprecated: Use output.address instead.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="port" type="int" default="18003">
|
|
<description>
|
|
Data output port. Deprecated: Use output.address instead.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="bufferSize" type="uint" default="1048576" unit="B">
|
|
<description>Size (bytes) of the packet buffer</description>
|
|
</parameter>
|
|
<parameter name="backfillingBufferSize" type="uint" default="180" unit="s">
|
|
<description>
|
|
Length of backfilling buffer. Whenever a gap 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.
|
|
</description>
|
|
</parameter>
|
|
<group name="mseed">
|
|
<parameter name="enable" type="boolean" default="true">
|
|
<description>Enable on-the-fly MiniSeed
|
|
encoding. If the encoder does not support the input
|
|
type of a packet it will be forwarded. Re encoding of
|
|
MiniSEED packets is not supported.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="encoding" type="string" default="Steim2">
|
|
<description>MiniSEED encoding to use. (Uncompressed, Steim1 or Steim2)</description>
|
|
</parameter>
|
|
</group>
|
|
</group>
|
|
<group name="statusLog">
|
|
<parameter name="enable" type="boolean" default="false">
|
|
<description>
|
|
Log information status information e.g.
|
|
max bytes buffered
|
|
</description>
|
|
</parameter>
|
|
<parameter name="flush" type="uint" default="10" unit="s">
|
|
<description>
|
|
Flush status every n seconds to disk
|
|
</description>
|
|
</parameter>
|
|
</group>
|
|
</configuration>
|
|
</module>
|
|
</seiscomp>
|