source: trunk/params/k2ew_tcp.d @ 7968

Revision 7968, 8.5 KB checked in by paulf, 4 months ago (diff)

updated common params dir with latest .d .desc from source

  • Property svn:eol-style set to native
  • Property svn:executable set to *
  • Property svn:keywords set to Author Date Id Revision
Line 
1#
2# k2ew configuration file
3#
4# This code receives serial data stream (SDS) packets from the K2 via
5# a TCP/IP port, converts them into Earthworm trace buf messages, and
6# stuffs them into a wave ring.
7#
8
9# Operations Note: added Dec-27-2002: Because the k2ew_tcp program takes a while to
10#       cleanly exit when it receives a SIGTERM signal from startstop, the
11#       KillDelay parameter in startstop.d should be set to a MINIMUM of 15
12#       seconds if k2ew_tcp is being run and wished to be restarted. If you
13#       have KillDelay set to anything less, k2ew_tcp will never get
14#       restarted reliably. (Paul Friberg)
15
16TcpAddr         mss-1           # IP address or domain name of K2 interface
17TcpPort         3001            # TCP port number of K2 interface
18
19ModuleId        MOD_K2EW        # module id for this import
20RingName        WAVE_RING       # transport ring to use for input/output
21
22LogFile         1               # If 0, don't output to logfile; if 1, do
23                                # if 2, log to module log but not stderr/stdout
24
25HeartbeatInt    30              # Heartbeat interval in seconds
26
27Network         NC              # Network name for EW msg headers
28
29ForceBlockMode  0               # should be set to 1 for K2's with modems
30                                # so that the k2ew program can get control at startup
31
32LCFlag 1                        # Indicator for action on missing
33                                # ChannelNames and LocationNames
34                                # 1: use the default location code and
35                                #    k2-configured channel code if none
36                                #    found in k2ew configuration
37                                # 2: Exit with error if any data channel
38                                #    is not assigned in ChannelName and
39                                #    LocationName commands.
40
41# Optional commands:
42
43BasePinno     1001              # Earthworm pin numbers are assigned by
44                                # adding this base number to the stream
45                                # number (0 - 5) of each packet
46                                # default: 0
47
48# StationID SEAB                # If specified, assign a different station
49                                # code to the TRACEBUF packets than what
50                                # is configured into the K2
51
52# ChannelNames  HHE,HHN,HHZ     # If present, assign different channel names
53                                # to the TRACEBUF packets that the names
54                                # configured in the K2. The list can be
55                                # delimited by commas or spaces. See the
56                                # documentation for details about channel
57                                # and serial stream numbering conventions!
58                                # List only STREAMed channels here, which
59                                # may be fewer than the K2 acquires.
60
61# LocationNames 01,01,01        # If present, assign location codes to
62                                # the TRACEBUF packets emitted by k2ew.
63                                # Otherwise, default location code
64                                # will be assigned; currently "--"
65                                # List only STREAMed channels here, which
66                                # may be fewer than the K2 acquires.
67
68
69# HeaderFile "..\k2hdr\k2hdr.SEA" # If specified, k2ew will write the K2 binary
70                                # header to this file.  The file is created at
71                                # program startup and once per day thereafter.
72                                # default: none
73
74# RestartFile   "restart.SEA"   # If you want to attempt a K2 restart, give
75                                # a name for the restart file. It MUST be
76                                # a unique name for this K2 or gross confusion
77                                # will result!
78                                # default: none
79
80MaxRestartAge    60             # Maximum age of the restart file, in seconds
81                                # If the restart file is older than this
82                                # when k2ew restarts, a normal start will
83                                # be used.
84                                # Should be less than WaitTime (below)
85                                # default: 0 (seconds)
86
87CommTimeout   5000              # If unable to communicate with K2 for X
88                                # milliseconds, retry socket or terminate
89                                # default: 5000 (milliseconds)
90
91WaitTime  60                    # Maximum number of seconds to wait for a
92                                # packet to be resent from the k2
93                                # default: 60 (seconds)
94
95# DontQuit                      # Optional command; if present, k2ew will
96                                # not quit on timeouts. K2ew will quit on
97                                # errors in any event.
98
99# MaxBlkResends 4               # Sets the maximum number of times a resend
100                                # request may be sent to the K2 asking for a
101                                # given packet.
102
103# MaxReqPending 6               # Sets the maximum for the total number of
104                                # data blocks upon which resend requests may
105                                # be pending to the K2 at any given time.
106
107# ResumeReqVal 2                # Sets the number of pending "waiting" blocks
108                                # that must be received before new resend
109                                # requests are resumed after reaching the
110                                # 'MaxReqPending' limit.
111
112# WaitResendVal 120             # Sets the maximum time that k2ew will wait
113                                # for packets to be resent from the K2 to N
114                                # seconds.
115
116# RestartComm                   # This command is pertinent only when the
117                                # 'DontQuit' command is present. In this case,
118                                # when 'k2ew' detects a timeout condition (and
119                                # 'RestartComm' is set), the communications link
120                                # to the K2 will be closed and reopened before
121                                # 'k2ew' resumes reading data.
122
123StatusInterval   30             # Interval in minutes between requests for
124                                # K2 status (if 0, then no status requests)
125                                # default: 30 (minutes)
126
127OnBattery                       # Report when K2 loses external power and is
128                                # running on battery power.
129                                # default: do not report
130
131LowBattAlarm 110                # In tenths of volts, threshold for low
132                                # battery alarm (if -1, then no alarm)
133                                # default: -1
134
135MinDiskKB  500  -1              # Low disk alarm threshold in Kilobytes, for
136                                # disk A and disk B (if -1, then no alarm)
137                                # default: -1 -1
138
139ExtStatus                       # Request extended status with normal status
140                                # Comment this out for no extended status
141                                # default: no extended status
142
143LowTempAlarm  150               # Low temperature alarm threshold, in tenths
144                                # degree, C; default: -1000
145
146HighTempAlarm 350               # High temperature alarm threshold, in tenths
147                                # degree, C; default: 1000
148
149GPSLockAlarm  24.0              # If GPS doesn't lock for this many hours,
150                                # report to statmgr.  Optional parameter.
151                                # default: Don't report to statmgr.
152
153#InjectInfo                     # Injects TYPE_K2INFO_PACKET messages into the ring.
154                                # These messages contain binary K2 headers.
155                                # Default is to not inject messages.
156                                # In order to use this feature, you need to add
157                                # message type TYPE_K2INFO_PACKET to file earthworm.d.
158                                # Note that k2ew always injects TYPE_SNW messages
159                                # into the ring, and TYPE_SNW must be defined in
160                                # file earthworm.d.
161
162Debug 0                         # debug level: 0 or commented out for no debug
163                                # logging; 1 - 4 for increasing verbosity
164                                # default: no debug output
Note: See TracBrowser for help on using the repository browser.