You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

188 lines
7.2 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<seiscomp>
<module name="scalert" category="Utilities">
<description>Real time alert template.</description>
<configuration>
<parameter name="firstNew" type="boolean" default="false">
<description>
Treat an event as new event when it is seen the first time.
</description>
</parameter>
<parameter name="agencyIDs" type="list:string" default="">
<description>
List of agency IDs to consider picks and origins. The agency ID
is extracted from the pick or the preferred origin of the event
and compared with the configured IDs.
unset (=): use agencyID defined in global, default
empty list (=""): all agencies are allowed
</description>
</parameter>
<group name="poi">
<parameter name="message" type="string">
<description>
The default message string for the event-script is
&quot;earthquake, [HOURS] hours [MINS] minutes ago, [DESC],
magnitude [MAG], depth [DEP] kilometers&quot; whereas [DESC]
is the string given in the event.description attribute. This
string can be overwritten using one of the following options.
There are three placeholders that can be used: @region@,
@dist@ and @poi@.
Example: &quot;@region@, @dist@ kilometers from @poi@
away&quot;.
</description>
</parameter>
<parameter name="maxDist" type="double" default="20" unit="deg">
<description>
When using the nearest point of interest (city) as part of
the message string, specify the maximum distance in degrees
from the event. Any point of interest farther away will be
ignored.
</description>
</parameter>
<parameter name="minPopulation" type="double" default="50000">
<description>
Minimum population for a city to become a point of interest.
</description>
</parameter>
</group>
<group name="scripts">
<parameter name="pick" type="string">
<description>
The script to be called when a pick
arrives. Network-, station code, pick publicID are passed
as parameters $1, $2, $3.
</description>
</parameter>
<parameter name="amplitude" type="string">
<description>
The script to be called when an amplitude
arrives. Network-, station code, amplitude and amplitude
public ID are passed as parameters $1, $2, $3, $4.
</description>
</parameter>
<parameter name="alert" type="string">
<description>
The script to be called when a preliminary
origin arrives. Latitude and longitude are passed as
parameters $1 and $2.
</description>
</parameter>
<parameter name="event" type="string">
<description>
The script to be called when an event has been
declared. The message string, a flag (1=new event,
0=update event), the EventID, the arrival count and the
magnitude (optional when set) are passed as parameters
$1, $2, $3, $4 and $5.
</description>
</parameter>
</group>
<group name="constraints">
<description>Constraints for executing scripts</description>
<parameter name="phaseHints" type="list::string" default="P,S">
<description>
Start the pick script only when the phaseHint of the
received pick has one of the value(s).
</description>
</parameter>
<parameter name="phaseStreams" type="list::string" default="">
<description>
Start the pick script only when the stream (NET.STA.LOC.CHA)
of the received pick belongs to the list of stream IDs. If empty,
all picks are accepted, otherwise only the ones whose stream ID
matches one of the entry of this comma separated list. Each entry
must follow the NET.STA.LOC.CHA format, but the special
characters ? * | ( ) are also accepeted.
E.g. "CH.*,GR.STA??.*,*.*.*.HH?,*.*.*.??(Z|1)"
</description>
</parameter>
<parameter name="phaseNumber" type="int" default="1">
<description>
Start the pick script only when a minimum number of phases
'phaseNumber' is received within 'phaseInterval'.
</description>
</parameter>
<parameter name="phaseInterval" type="int" default="1" unit='s'>
<description>
Start the pick script only when a minimum number of phases
'phaseNumber' is received within 'phaseInterval'.
</description>
</parameter>
</group>
</configuration>
<command-line>
<synopsis>
scalert [options]
</synopsis>
<group name="Generic">
<optionReference>generic#help</optionReference>
<optionReference>generic#version</optionReference>
<optionReference>generic#config-file</optionReference>
<optionReference>generic#plugins</optionReference>
<optionReference>generic#daemon</optionReference>
<optionReference>generic#auto-shutdown</optionReference>
<optionReference>generic#shutdown-master-module</optionReference>
<optionReference>generic#shutdown-master-username</optionReference>
<option long-flag="first-new" param-ref="firstNew"/>
</group>
<group name="Verbosity">
<optionReference>verbosity#verbosity</optionReference>
<optionReference>verbosity#v</optionReference>
<optionReference>verbosity#quiet</optionReference>
<optionReference>verbosity#component</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="Messaging">
<optionReference>messaging#user</optionReference>
<optionReference>messaging#host</optionReference>
<optionReference>messaging#timeout</optionReference>
<optionReference>messaging#primary-group</optionReference>
<optionReference>messaging#subscribe-group</optionReference>
<optionReference>messaging#content-type</optionReference>
<optionReference>messaging#start-stop-msg</optionReference>
</group>
<group name="Database">
<optionReference>database#db-driver-list</optionReference>
<optionReference>database#database</optionReference>
<optionReference>database#config-module</optionReference>
<optionReference>database#inventory-db</optionReference>
<optionReference>database#db-disable</optionReference>
</group>
<group name="Alert">
<option long-flag="amp-type" argument="arg" default="snr">
<description>
Specify the amplitude type to listen to.
</description>
</option>
<option long-flag="amp-script" argument="arg" param-ref="scripts.amplitude"/>
<option long-flag="alert-script" argument="arg" param-ref="scripts.alert"/>
<option long-flag="event-script" argument="arg" param-ref="scripts.event"/>
</group>
<group name="Cities">
<option long-flag="max-dist" argument="arg" param-ref="poi.maxDist"/>
<option long-flag="min-population" argument="arg" param-ref="poi.minPopulation"/>
</group>
<group name="Debug">
<option flag="E" long-flag="eventid" argument="arg">
<description>
Specify event ID that is used for testing. After running the
alert scripts scvoice will exit.
</description>
</option>
</group>
</command-line>
</module>
</seiscomp>