345 lines
12 KiB
XML
345 lines
12 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<seiscomp>
|
|
<module name="rs2caps" category="Acquisition">
|
|
<description>Recordstream data acquisition plugin</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#trace</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>
|
|
<option long-flag="test" argument="">
|
|
<description>
|
|
Disable socket communication.
|
|
</description>
|
|
</option>
|
|
<option long-flag="dump" argument="">
|
|
<description>
|
|
Dump all received data to stdout and don't use the input
|
|
port.
|
|
</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="f" 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>
|
|
</group>
|
|
<group name="Streams">
|
|
<option flag="A" long-flag="add-stream" argument="arg">
|
|
<description>
|
|
StreamID [net.sta.loc.cha] to add.
|
|
</description>
|
|
</option>
|
|
<option flag="" long-flag="id-file" argument="arg">
|
|
<description>
|
|
File to read stream IDs from.
|
|
</description>
|
|
</option>
|
|
<option flag="" long-flag="passthrough" argument="">
|
|
<description>
|
|
Do not subscribe to any stream and accept everything a
|
|
record source is passing. This is useful in combination with
|
|
files.
|
|
</description>
|
|
</option>
|
|
<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="days" argument="arg" unit="day">
|
|
<description>
|
|
Begin of data request time window given as days before current time.
|
|
Applied only on streams not found in the journal.
|
|
</description>
|
|
</option>
|
|
<option flag="" long-flag="days-before" argument="arg" unit="day">
|
|
<description>
|
|
End of data request time window given as number of days
|
|
before current time.
|
|
</description>
|
|
</option>
|
|
</group>
|
|
<group name="Polling">
|
|
<option flag="" long-flag="poll" argument="">
|
|
<description>
|
|
For non-streaming inputs polling can be
|
|
used to simulate real-time streaming.
|
|
</description>
|
|
</option>
|
|
<option flag="" long-flag="poll-window" argument="arg">
|
|
<description>
|
|
Time window in seconds to be used with polling.
|
|
</description>
|
|
</option>
|
|
<option flag="" long-flag="poll-interval" argument="arg">
|
|
<description>
|
|
Time interval in seconds used for polling.
|
|
</description>
|
|
</option>
|
|
<option flag="" long-flag="poll-serial" argument="">
|
|
<description>
|
|
Will request each channel seperately rather all channels in
|
|
one request.
|
|
</description>
|
|
</option>
|
|
</group>
|
|
</command-line>
|
|
|
|
<configuration>
|
|
<group name="output">
|
|
<parameter name="address" type="string" default="localhost:18003" publicID="Output#address">
|
|
<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="timeout" type="int" default="60" unit="s">
|
|
<description>
|
|
Timeout when sending a packet. If the timeout expires
|
|
the connection will be closed and re-established.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="maxFutureEndTime" type="int" default="120" unit="s">
|
|
<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>
|
|
</parameter>
|
|
<parameter name="bufferSize" type="uint" default="1048576" unit="bytes">
|
|
<description>
|
|
Size (bytes) of the packet buffer.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="backFillingBufferSize" type="int" default="0" 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="false">
|
|
<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="streams">
|
|
<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="days" type="int" default="-1" unit="day">
|
|
<description>
|
|
Use to set the start time of data time window n days before the current time.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="daysBefore" type="int" default="-1" unit="day">
|
|
<description>
|
|
Use to set the end time of data time window n days before the current time.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="passthrough" type="boolean" default="false">
|
|
<description>
|
|
Do not subscribe to any stream and
|
|
accept everything a record source is
|
|
passing. This is useful in combination
|
|
with files.
|
|
</description>
|
|
</parameter>
|
|
</group>
|
|
<group name="journal">
|
|
<parameter name="file" type="string" default="@ROOTDIR@/var/run/rs2caps/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>
|
|
<parameter name="syncWithBindings" type="boolean" default="false">
|
|
<description>
|
|
Whether to synchronize the journal file with bindings.
|
|
If enabled then each time update-config is called, the
|
|
bound stations will be synchronized with the current
|
|
journal file. Unbound stations will be removed from
|
|
the journal. Synchronizing with bindings will disable
|
|
reading the inventory.
|
|
</description>
|
|
</parameter>
|
|
</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">
|
|
<description>
|
|
Flush status every n seconds to disk
|
|
</description>
|
|
</parameter>
|
|
</group>
|
|
</configuration>
|
|
</module>
|
|
|
|
<binding module="rs2caps">
|
|
<description>
|
|
Configures which streams of a station should be requested.
|
|
</description>
|
|
<configuration>
|
|
<parameter name="selectors" type="list:string">
|
|
<description>
|
|
List of stream selectors in format LOC.CHA.
|
|
If left empty all available streams will be requested.
|
|
</description>
|
|
</parameter>
|
|
</configuration>
|
|
</binding>
|
|
</seiscomp>
|