scvoice¶
Real time voice alert.
Description¶
This tool runs an external script whenever an event has been created or updated. It can also run a script in case an amplitude of a particular type or a preliminary origin (heads-up message) has been sent. The common purpose for this tool is to play a sound or to convert a message to speech using external tools like festival or espeak. There are three possible trigger mechanisms for calling scripts:
Event creation/update
Amplitude creation
Origin creation (with status = preliminary)
Although this tool was designed to alert the user acoustically it can also be used to send e-mails, sms or to do any other kind of alert. scvoice can only run one script per call type at a time! A template (scalert) Python script with more options has been added to SeisComP to be used as source for custom notifications.
Examples¶
Event script¶
The following script is used as event script. It requires festival which should be available in almost any Linux distribution.
Important
When saving the scripts given below do not forget to set the executable bit otherwise scvoice cannot call the scripts. In Linux just run:
chmod +x /path/to/file
Save an executable script file, e.g., under, e.g.
~/.seiscomp/event.sh
:#!/bin/sh if [ "$2" = "1" ]; then echo " $1" | sed 's/,/, ,/g' | festival --tts; else echo "Event updated, $1" | sed 's/,/, ,/g' | festival --tts; fi
Add the file to the configuration of
scripts.event
in the fileSEISCOMP_ROOT/etc/scvoice.cfg
or~/.seiscomp/scvoice.cfg
:scripts.event = /home/sysop/.seiscomp/event.sh
Amplitude script¶
Save an executable script file, e.g., under
~/.seiscomp/amplitude.sh
#!/bin/sh # Play a wav file with a particular volume # derived from the amplitude itself. playwave ~/.seiscomp/beep.wav -v $3
Add the file to the configuration of
scripts.amplitude
in the fileSEISCOMP_ROOT/etc/scvoice.cfg
or~/.seiscomp/scvoice.cfg
:scripts.amplitude = /home/sysop/.seiscomp/amplitude.sh
Alert script¶
Create a sound file
siren.wav
for accoustic alerts.Save an executable script file under, e.g.,
~/.seiscomp/alert.sh
:#!/bin/sh playwave /home/sysop/.seiscomp/siren.wav
Add the script filename to the configuration of
scripts.alert
in the fileSEISCOMP_ROOT/etc/scvoice.cfg
or~/.seiscomp/scvoice.cfg
.scripts.alert = /home/sysop/.seiscomp/alert.sh
Configuration¶
etc/defaults/global.cfg
etc/defaults/scvoice.cfg
etc/global.cfg
etc/scvoice.cfg
~/.seiscomp/global.cfg
~/.seiscomp/scvoice.cfg
scvoice inherits global options.
-
firstNew
¶ Type: boolean
Treats an event as new event when it is seen the first time. Default is
false
.
-
agencyIDs
¶ Type: list:string
Defines a white list of agencyIDs to alert an event. The agencyID is extracted from the preferred origin of the event. If this list is empty, all agencies are allowed.
-
poi.message
¶ Type: string
The default message string for the event-script is “earthquake, [HOURS] hours [MINS] minutes ago, [DESC], magnitude [MAG], depth [DEP] kilometers” 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: “@region@, @dist@ kilometers from @poi@ away”.
-
poi.maxDist
¶ Type: double
Unit: deg
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. Default is
20
.
-
poi.minPopulation
¶ Type: double
Minimum population for a city to become a point of interest. Default is
50000
.
-
scripts.amplitude
¶ Type: string
Specify the script to be called if an amplitude arrives, network-, stationcode and amplitude are passed as parameters $1, $2 and $3.
-
scripts.alert
¶ Type: string
Specify the script to be called if a preliminary origin arrives, latitude and longitude are passed as parameters $1 and $2.
-
scripts.event
¶ Type: string
Specify 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 parameter $1, $2, $3, $4 and $5.
Command-line¶
Generic¶
-
-h
,
--help
¶
show help message.
-
-V
,
--version
¶
show version information
-
--config-file
arg
¶ Use alternative configuration file. When this option is used the loading of all stages is disabled. Only the given configuration file is parsed and used. To use another name for the configuration create a symbolic link of the application or copy it, eg scautopick -> scautopick2.
-
--plugins
arg
¶ Load given plugins.
-
-D
,
--daemon
¶
Run as daemon. This means the application will fork itself and doesn’t need to be started with &.
-
--auto-shutdown
arg
¶ Enable/disable self-shutdown because a master module shutdown. This only works when messaging is enabled and the master module sends a shutdown message (enabled with –start-stop-msg for the master module).
-
--shutdown-master-module
arg
¶ Sets the name of the master-module used for auto-shutdown. This is the application name of the module actually started. If symlinks are used then it is the name of the symlinked application.
-
--shutdown-master-username
arg
¶ Sets the name of the master-username of the messaging used for auto-shutdown. If “shutdown-master-module” is given as well this parameter is ignored.
Verbosity¶
-
--verbosity
arg
¶ Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info, 4:debug
-
-v
,
--v
¶
Increase verbosity level (may be repeated, eg. -vv)
-
-q
,
--quiet
¶
Quiet mode: no logging output
-
--component
arg
¶ Limits the logging to a certain component. This option can be given more than once.
-
-s
,
--syslog
¶
Use syslog logging back end. The output usually goes to /var/lib/messages.
-
-l
,
--lockfile
arg
¶ Path to lock file.
-
--console
arg
¶ Send log output to stdout.
-
--debug
¶
Debug mode: –verbosity=4 –console=1
-
--log-file
arg
¶ Use alternative log file.
Messaging¶
-
-u
,
--user
arg
¶ Overrides configuration parameter
connection.username
.
-
-H
,
--host
arg
¶ Overrides configuration parameter
connection.server
.
-
-t
,
--timeout
arg
¶ Overrides configuration parameter
connection.timeout
.
-
-g
,
--primary-group
arg
¶ Overrides configuration parameter
connection.primaryGroup
.
-
-S
,
--subscribe-group
arg
¶ A group to subscribe to. This option can be given more than once.
-
--content-type
arg
¶ Overrides configuration parameter
connection.contentType
.
-
--start-stop-msg
arg
¶ Sets sending of a start- and a stop message.
Database¶
-
--db-driver-list
¶
List all supported database drivers.
-
-d
,
--database
arg
¶ The database connection string, format: service://user:pwd@host/database. “service” is the name of the database driver which can be queried with “–db-driver-list”.
-
--config-module
arg
¶ The configmodule to use.
-
--inventory-db
arg
¶ Load the inventory from the given database or file, format: [service://]location
-
--db-disable
¶
Do not use the database at all
Alert¶
-
--amp-type
arg
¶ Specify the amplitude type to listen to.
-
--amp-script
arg
¶ Overrides configuration parameter
scripts.amplitude
.
-
--alert-script
arg
¶ Overrides configuration parameter
scripts.alert
.
-
--event-script
arg
¶ Overrides configuration parameter
scripts.event
.
Cities¶
-
--max-dist
arg
¶ Overrides configuration parameter
poi.maxDist
.
-
--min-population
arg
¶ Overrides configuration parameter
poi.minPopulation
.