# Eqalarm_ew Configuration File Commands

(last revised 5 December 1996)
Page Index:
1. Example configuration file
2. Functional command listing
3. Alphabetic command listing & description

On startup, eqalarm_ew reads the configuration file named on the command line. Commands in this file set up all parameters used in issuing earthquake notifications. In the control file, lines may begin with a valid eqalarm_ew command (listed below) or with one of 2 special characters:

>     #  marks the line as a comment (example: # This is a comment).

>     @  allows control files to be nested; one control file can be
>        accessed from another with the command "@" followed by
>        a string representing the path name of the next control file
>        (example: @model.d).

Command names must be typed in the control file exactly as shown in this document (upper/lower case matters!).

## 1. EXAMPLE CONFIGURATION FILE

    #
    # eqalarmMgr's configuration file
    #
    MyModuleId      MOD_EQALARM_EW  # module id for this instance of eqalarmMgr
    RingName        HYPO_RING       # transport ring for I/0
    LogSwitch       1               # 0 to turn off logging to disk

    # List the message logos to grab from transport ring
    #               Installation    Module          Message Type
    GetSumFrom      INST_WILDCARD   MOD_WILDCARD      TYPE_H71SUM

    # Read the magnitude threshold
    #
    MagThreshold    1.0

    # The name of the pager group to notify
    PagerGroup      seisstaffew

## 2. FUNCTIONAL COMMAND LISTING

Below are the commands recognized by eqalarm_ew, grouped by the function they influence. All of the commands are required; they must be specified in the control file in order for eqalarm_ew to operate.

             Earthworm system setup:
                    GetSumFrom	   	required
     		MyModuleId	   	required
    		RingName	   	required

    	Earthquake Notification:
    		MagThreshold		required
    		PagerGroup		required

    	Output Control:
    		LogSwitch		required

## 3. ALPHABETIC COMMAND LISTING & DESCRIPTION

In the following section, all configuration file commands are listed in alphabetical order. Listed along with the command (bold-type) are its arguments (in red), the name of the subroutine that processes the command, and the function within the module that the command influences. A detailed description of the command and is also given. Default values and example commands are listed after each command description.

    command arg1				processed by		function

    GetSumFrom inst mod_id 			eqalarm_config		Earthworm setup

> Controls the hypocenter messages input to eqalarm_ew. eqalarm_ew will only process TYPE_H71SUM messages that come from module mod_id at installation inst. inst and mod_id are character strings (valid strings are listed in earthworm.h/earthworm.d) which are related to single-byte numbers that uniquely identify each installation and module. Only one "GetSumFrom" command may be issued; wildcards (INST_WILDCARD and MOD_WILDCARD) will force eqalarm_ew to process all hypocenter messages, regardless of their place of origin.

>     Default:  none
>     Example:  GetSumFrom  INST_WILDCARD  MOD_WILDCARD

    LogSwitch switch			eqalarm_config		output

> Sets the on-off switch for writing a log file to disk. If switch is 0, no log file will be written. If switch is 1, eqalarm_ew will write a daily log file(s) called eqalarm_ewxx.log_yymmdd where xx is eqalarm_ew's module id (set with "MyModuleId" command) and yymmdd is the current UTC date (ex: 960123) on the system clock. The file(s) will be written in the EW_LOG directory (environment variable).

>     Default:  none

    MagThreshold mag			eqalarm_config		EQ notification

> Sets the magnitude threshold for earthquake notification. If the magnitude of an event is greater than or equal to mag, eqalarm_ew will issue a pager message (TYPE_PAGE) describing the event.

>     Default:  none
>     Example:  MagThreshold 3.5

    MyModuleId mod_id			eqalarm_config		Earthworm setup

> Sets the module id for labeling all outgoing messages. mod_id is a character string (valid strings are listed in earthworm.d) that relates (in earthworm.d) to a unique single-byte number.

>     Default:  none
>     Example:  MyModuleId MOD_EQALARM_EW

    PagerGroup group			eqalarm_config		EQ notification

> Controls which pagers will receive event notifications. group is a character string (which may or may not be enclosed in double-quotes) which is registered as a "pager group" with a Pageit computer. group is written to the beginning of each pager message issued. eqalarm_ew places the pager message into shared memory where it can be found by the pagerfeeder module who then sends it to a Pageit computer via the serial port.

>     Default:  none
>     Example:  PagerGroup  beepers

    RingName ring				eqalarm_config		Earthworm setup

> Tells eqalarm_ew which shared memory region to use for input/output. ring is a character string (valid strings are listed in earthworm.d) that relates (in earthworm.d) to a unique number for the key to the shared memory region.

>     Default:  none
>     Example:  RingName HYPO_RING

Module Index | Eqalarm_ew Overview