nmxptool.d 7.2 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

MaxTolerableLatency  120                 # Max tolerable latency for each channel. (Default 600 sec.)
                                         # In general, DO NOT use with parameter TimeoutRecv.
                                         # It is equivalent to the option -M.

Matteo Quintiliani's avatar
Matteo Quintiliani committed
40
#TimeoutRecv          30                 # Time-out in seconds for flushing queued data of each channel.
Matteo Quintiliani's avatar
Matteo Quintiliani committed
41
42
                                         # (Default 0. No time-out) [10..300].
                                         # Useful for retrieving Data On Demand with minimum delay.
43
                                         # 'tsec' in nmxptool.desc should be greater than 'TimeoutRecv'.
Matteo Quintiliani's avatar
Matteo Quintiliani committed
44
45
46
47
48
49
50
51
52
53
                                         # 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.

                                         # N.B. nmxptool channel definition IS NOT equal to SCNL
                                         # It is NSC, that is NET.STA.CHAN
                                         # NET  is optional and used only for output.
                                         # STA  can be '*', stands for all stations.
                                         # CHAN can contain '?', stands for any character.
Matteo Quintiliani's avatar
Matteo Quintiliani committed
54
                                         # Localtion value is always equal to "--".
Matteo Quintiliani's avatar
Matteo Quintiliani committed
55
56
57
58
59
60
61
62
                                         # Related to the parameters 'ChannelFile' and 'Channel'.
                                         # Network code will be assigned from the first
                                         # pattern that includes station and channel.
                                         # Example: N1.AAA.HH?,N2.*.HH?,MMM.BH?
                                         # Second pattern includes the first. Unless AAA, all
                                         # stations with HH channels will have network to N2.
                                         # Station MMM will have default network defined by 'DefaultNetworkCode'.

63
#MaxDataToRetrieve    3600               # Max amount of data of the past to retrieve from the
Matteo Quintiliani's avatar
Matteo Quintiliani committed
64
65
66
67
68
                                         # 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
69
70
71
72
73
                                         # 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.
Matteo Quintiliani's avatar
Matteo Quintiliani committed
74
                                         # It is extremely harmful when you have many channels.
75

Matteo Quintiliani's avatar
Matteo Quintiliani committed
76

Matteo Quintiliani's avatar
Matteo Quintiliani committed
77
ChannelFile   /home/ew/naqs1a.list.txt   # List of channel patterns, as in 'Channel'. One for each line.
Matteo Quintiliani's avatar
Matteo Quintiliani committed
78
79
80
81
                                         # 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"
                                         # Allow data continuity between program restarts.
Matteo Quintiliani's avatar
Matteo Quintiliani committed
82
                                         # Related to 'MaxDataToRetrieve', it enables request of recent packets.
Matteo Quintiliani's avatar
Matteo Quintiliani committed
83
                                         # It is equivalent to the option -F. Related to 'MaxDataToRetrieve'.
Matteo Quintiliani's avatar
Matteo Quintiliani committed
84

Matteo Quintiliani's avatar
Matteo Quintiliani committed
85
86
#mschan        280/9                     # mSECs/nC
                                         # mSECs are milliseconds to wait before the next request,
Matteo Quintiliani's avatar
Matteo Quintiliani committed
87
                                         # nC is the number of channels to request at a time.
Matteo Quintiliani's avatar
Matteo Quintiliani committed
88
89
90
91
                                         # 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
92
93
                                         # Related to -F and -b. 0/0 for disabling.

Matteo Quintiliani's avatar
Matteo Quintiliani committed
94
    # DO NOT USE parameters 'Channel' and 'ChannelFile' together.
Matteo Quintiliani's avatar
Matteo Quintiliani committed
95
96
    # '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
97
98

# Example of nmxptool channel definition
99
100
101
102
103
104
# Channel              ES.BOB.HH?
# Channel              MN.TIR.HH?
# Channel              MDI.HH?
# Channel              DOI.HH?
# Channel              SALO.HH?
# Channel              MONC.HH?
Matteo Quintiliani's avatar
Matteo Quintiliani committed
105
# Channel              *.BHZ               # Channel selection
106

Matteo Quintiliani's avatar
Matteo Quintiliani committed
107
108
109
# Please, for other details about parameters, refer to the command line "nmxptool -h"