nmxptool.d 8.91 KB
Newer Older
1
#
Matteo Quintiliani's avatar
Matteo Quintiliani committed
2
#                     Configuration File for nmxptool
3
#
4
MyModuleId           MOD_NMXPTOOL
Matteo Quintiliani's avatar
Matteo Quintiliani committed
5 6
RingName             WAVE_RING           # Transport ring to write data to.

7
HeartBeatInterval    10                  # Heartbeat interval, in seconds.
Matteo Quintiliani's avatar
Matteo Quintiliani committed
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
LogFile              1                   # 1 -> Keep log, 0 -> no log file
                                         # 2 -> write to module log but not stderr/stdout

#ForceTraceBuf1      0                   # On systems that support TRACEBUF2
                                         # messages this flag will force the module
                                         # to create TRACEBUF messages instead.
                                         # Most people will never need this.

Verbosity            16                  # Set level of verbosity. Verbosity is a bitmap:
                                         # 1 Channel State, 2 Channel, 4 Raw Stream,
                                         # 8 CRC32, 16 Connection flow,
                                         # 32 Packet Management, 64 Extra, 128 Date,
                                         # 256 Gap, 512 DOD, 1023 All messages.
                                         # It is equivalent to the option -v.

Matteo Quintiliani's avatar
Matteo Quintiliani committed
23
NmxpHost             naqs1a.int.ingv.it  # NaqsServer/DataServer hostname or IP address.
Matteo Quintiliani's avatar
Matteo Quintiliani committed
24 25 26 27 28 29 30
                                         # It is equivalent to the option -H.

NmxpPortPDS          28000               # Port number of NaqsServer (Default 28000)
                                         # It is equivalent to the option -P.

NmxpPortDAP          28002               # Port number of DataServer(Default 28002)
                                         # It is equivalent to the option -D.
31
#UserDAP              mtheo              # DataServer user name. Commented if 'none'.
32
                                         # It is equivalent to the option -u.
33
#PassDAP              mypass             # DataServer password. Commented if 'none'.
34
                                         # It is equivalent to the option -p.
Matteo Quintiliani's avatar
Matteo Quintiliani committed
35

36 37 38 39 40 41 42 43 44
#ShortTermCompletion  60                  # ShortTermCompletion, NOT use 'MaxTolerableLatency'.
                                         #  0 decompressed packets are received in chronological
                                         #    order without waiting for missing packets.
                                         # [1..300] decompressed packets are received in
                                         #    chronological order but waiting for missing packets
                                         #    at most SECs seconds.

MaxTolerableLatency  60                  # Raw Stream, NOT use 'ShortTermCompletion'.
                                         # Max tolerable latency for each channel.
45 46 47 48 49
                                         # (Default 600 sec.) [60..600].
                                         # Enable NaqsServer to send out retransmission requests
                                         # for missed packets. Inside the section NetworkInterface
                                         # of the file Naqs.ini set RetxRequest to Enabled.
                                         # If RetxRequest is not enabled then MaxTolerableLatency is ineffective.
Matteo Quintiliani's avatar
Matteo Quintiliani committed
50 51 52
                                         # In general, DO NOT use with parameter TimeoutRecv.
                                         # It is equivalent to the option -M.

Matteo Quintiliani's avatar
Matteo Quintiliani committed
53
#TimeoutRecv          30                 # Time-out in seconds for flushing queued data of each channel.
54
                                         # It sets mschan to 0/0 ((Default 0. No time-out) [10..300].
Matteo Quintiliani's avatar
Matteo Quintiliani committed
55
                                         # Useful for retrieving Data On Demand with minimum delay.
56
                                         # 'tsec' in nmxptool.desc should be greater than 'TimeoutRecv'.
Matteo Quintiliani's avatar
Matteo Quintiliani committed
57 58 59 60 61
                                         # It is equivalent to the option -T.

DefaultNetworkCode   IV                  # Default network code where in 'ChannelFile' or 'Channel' is not declared.
                                         # It is equivalent to the option -N.

62 63 64
# DefaultLocationCode   01               # Default location code where in 'ChannelFile' or 'Channel' is not declared.
                                         # It is equivalent to the option -n. (Default is NULL location)

Matteo Quintiliani's avatar
Matteo Quintiliani committed
65
                                         # N.B. nmxptool channel definition IS NOT equal to SCNL
66
                                         # It is NSCL, that is NET.STA.CHAN.LOC
Matteo Quintiliani's avatar
Matteo Quintiliani committed
67 68 69
                                         # NET  is optional and used only for output.
                                         # STA  can be '*', stands for all stations.
                                         # CHAN can contain '?', stands for any character.
70
                                         # LOC  is optional and used only for output.
Matteo Quintiliani's avatar
Matteo Quintiliani committed
71
                                         # Related to the parameters 'ChannelFile' and 'Channel'.
72 73 74
                                         # Network and location code will be assigned from the
                                         # first pattern that include station and channel.
                                         # Example: N1.AAA.HH?.01,N2.*.HH?,MMM.BH?.03
Matteo Quintiliani's avatar
Matteo Quintiliani committed
75 76
                                         # Second pattern includes the first. Unless AAA, all
                                         # stations with HH channels will have network to N2.
77
                                         # Stations N2.*.HH? will have default location defined by 'DefaultLocationCode'.
Matteo Quintiliani's avatar
Matteo Quintiliani committed
78 79
                                         # Station MMM will have default network defined by 'DefaultNetworkCode'.

80
#MaxDataToRetrieve    3600               # Max amount of data of the past to retrieve from the
Matteo Quintiliani's avatar
Matteo Quintiliani committed
81 82 83 84 85
                                         # DataServer when program restarts (default 0) [0..86400].
                                         # 0 to disable connection to DataServer.
                                         # It is equivalent to the option -A. Related to 'ChannelFile'.
                                         # If 'MaxDataToRetrieve' is zero and 'ChannelFile' is used,
                                         # only data buffered by NaqsServer will be retrieved.
Matteo Quintiliani's avatar
Matteo Quintiliani committed
86 87 88 89 90
                                         # Rather than using 'MaxDataToRetrieve', it is preferable,
                                         # inside the section Datastream of the file Naqs.ini,
                                         # setting DataBufferLength to a high value.
                                         # 'MaxDataToRetrieve' allows to retrieve much more data of the past
                                         # when the program restarts but it considerably slows down the execution.
91 92 93
                                         # It is extremely harmful when you have many channels,
                                         # in this case you might consider to subdivide the
                                         # channels into different nmxptool instances.
94

Matteo Quintiliani's avatar
Matteo Quintiliani committed
95 96
#mschan        280/9                     # mSECs/nC
                                         # mSECs are milliseconds to wait before the next request,
Matteo Quintiliani's avatar
Matteo Quintiliani committed
97
                                         # nC is the number of channels to request at a time.
Matteo Quintiliani's avatar
Matteo Quintiliani committed
98 99 100 101
                                         # Delaying and requesting few channels at a time make
                                         # data buffering on NaqsServer side more efficient.
                                         # Determined empiric values are default 280/9.
                                         # Condition: TotalNumberOfChannels * (mSECs/nC) < 15 sec. 
Matteo Quintiliani's avatar
Matteo Quintiliani committed
102 103
                                         # Related to -F and -b. 0/0 for disabling.

Matteo Quintiliani's avatar
Matteo Quintiliani committed
104
ChannelFile   /home/ew/nmxptool.list.txt # List of channel patterns, as in 'Channel'. One for each line.
Matteo Quintiliani's avatar
Matteo Quintiliani committed
105 106 107
                                         # This file will not be modified by nmxptool.
                                         # Load/Save time of last sample of each channel in a file
                                         # with the same name, same directory, appending suffix ".nmxpstate"
Matteo Quintiliani's avatar
Matteo Quintiliani committed
108 109
                                         # It enables request of recent packets in order to allow data
                                         # continuity when short disconnections occur or between program restarts.
110
                                         # Related to 'MaxDataToRetrieve', 
Matteo Quintiliani's avatar
Matteo Quintiliani committed
111 112
                                         # It is equivalent to the option -F. Related to 'MaxDataToRetrieve'.

Matteo Quintiliani's avatar
Matteo Quintiliani committed
113
    # DO NOT USE parameters 'Channel' and 'ChannelFile' together.
Matteo Quintiliani's avatar
Matteo Quintiliani committed
114 115
    # 'ChannelFile' is preferable. At restart you can retrieve data of the past
    # from the NaqsServer and optionally from the DataServer, see 'MaxDataToRetrieve'.
Matteo Quintiliani's avatar
Matteo Quintiliani committed
116 117

# Example of nmxptool channel definition
118 119 120
# Channel              ES.BOB.HH?
# Channel              MN.TIR.HH?
# Channel              MDI.HH?
121
# Channel              DOI.HH?.01
122
# Channel              SALO.HH?
123
# Channel              IV.MONC.HH?.03
Matteo Quintiliani's avatar
Matteo Quintiliani committed
124
# Channel              *.BHZ               # Channel selection
125

Matteo Quintiliani's avatar
Matteo Quintiliani committed
126 127 128
# Please, for other details about parameters, refer to the command line "nmxptool -h"