1REMOTETRX.CONF(5) File Formats REMOTETRX.CONF(5)
2
6 remotetrx.conf - Configuration file for the SvxLink remote transceiver
7 server
8
10 remotetrx is the SvxLink remote transceiver server. This man-page
11 describe the configuration file format for it.
12 Remotetrx look for configuration files in a number of places. First it
14 tries to find a user specific configuration file. It will look for a
15 user specific configuration file in two places:
16 $HOME/.svxlink/remotetrx.conf or $HOME/.remotetrxrc. The latter is
17 deprecated. Use the one that will best fit your need. If no user spe‐
18 cific configuration file can be found, remotetrx will look for the sys‐
19 tem wide configuration file /etc/remotetrx.conf. The --config command
20 line option may also be used to specify an arbitrary configuration
21 file.
22
24 The configuration file is in the famous INI-file format. A generic
25 example of how such a file might look like is shown below.
26 [SECTION1]
28 VALUE1=1
29 VALUE2="TWO "
30 VAULE3="Multi "
31 "line"
32 [SECTION2]
34 VALUE1=2
35 This is a simple format that contain name=value pairs that belong to a
37 section. In written text, a specific configuration variable can be
38 referred to as SECTION1/VALUE2 meaning "configuration variable VALUE2
39 in section SECTION1".
40 The same variable name can exist in two different sections. For example
42 VALUE1 in section SECTION1 have the value 1 and VALUE1 in section SEC‐
43 TION2 have the value 2. Values containing spaces at the beginning or
44 end of the line must be surrounded by citation characters (see SEC‐
45 TION1/VALUE2). Likewise with a multi line value (see SECTION1/VALUE3).
46
48 Here is the description of all configuration variables that remotetrx
49 understands. The configuration variables are described section for sec‐
50 tion.
51 GLOBAL
53 The GLOBAL section contains application global configuration data.
54 RX Point out the receiver configuration section to use. Set to NONE
56 if no RX is used. A receiver is configured in the exact same way
57 as in the SvxLink server. Have a look at svxlink.conf(5) for
58 more information on how to configure a receiver.
59 TX Point out the transmitter configuration section to use. Set to
61 NONE if no TX is used. A transmitter is configured in the exact
62 same way as in the SvxLink server. Have a look at
63 svxlink.conf(5) for more information on how to configure a
64 transmitter.
65 UPLINK Point out the uplink configuration section to use. The uplink
67 section specify how this remote receiver should be linked to the
68 main SvxLink server. The term "uplink" might be a bit confusing
69 for some people. In this case it does not refer to any specific
70 direction in which the data or audio is flowing. It's just the
71 name for the link up to the main SvxLink server.
72 Read more about how to configure an uplink in the "Network
74 Uplink Section" or "Trx Uplink Section" chapters below.
75 CFG_DIR
77 Specify the path to a directory that contain additional configu‐
78 ration files. If a relative path is specified, the path will be
79 relative to the directory where the main configuration file is
80 at. All files in the specified directory will be read as addi‐
81 tional configuration. Filenames starting with a dot are ignored.
82 TIMESTAMP_FORMAT
84 This variable specifies the format of the timestamp that is
85 written in front of each row in the log file. The format string
86 is in the same format as specified in the strftime(3) manual
87 page. The default is "%c" which is described as: "the preferred
88 date and time representation for the current locale". The envi‐
89 ronment variables LC_TIME, LC_ALL and LANG will affect how this
90 time format will look. For example, setting LC_TIME="sv_SE.UTF8"
91 will give you swedish timestamp representation. Other examples
92 of format specifiers are:
93 · %d - The day of the month as a decimal number (range 01 to
95 31)
96 · %b - The abbreviated month name according to the current
98 locale
99 · %Y - The year as a decimal number including the century
101 · %H - The hour as a decimal number using a 24-hour clock
103 (range 00 to 23)
104 · %M - The minute as a decimal number (range 00 to 59)
106 · %S - The second as a decimal number (range 00 to 61)
108 So, TIMESTAMP_FORMAT="%d %b %Y %H:%M:%S" would give a timestamp
110 looking something like: "29 Nov 2005 22:31:59".
111 CARD_SAMPLE_RATE
113 This configuration variable determines the sampling rate used
114 for audio input/output. SvxLink always work with a sampling rate
115 of 8kHz internally but there still are som benefits from using a
116 higher sampling rate. On some sound cards the filters look
117 pretty bad at 8kHz and the amplitude response will not be uni‐
118 form which among other things can cause problems for the soft‐
119 ware DTMF decoder.
120 Some sound cards also sound very bad at 8kHz due to insufficient
122 anti-alias filtering or resampling effects. These, often
123 cheeper, sound cards sound OK at 48kHz.
124 The downside of choosing a higher sampling rate is that it puts
126 a little bit more load on the CPU so if you have a very slow
127 machine (<300MHz), it might not have the computational power to
128 handle it.
129 Supported sampling rates are: 8000, 16000 and 48000.
131 Network uplink section
133 The network uplink section is used to specify the configuration for a
134 network link to the main SvxLink server. In the default configuration
135 file there is a network uplink section called NetUpLink.
136 TYPE Always "Net" for a networked uplink.
138 LISTEN_PORT
140 The TCP port to listen on. The default is 5210.
141 AUTH_KEY
143 This is the authentication key (password) to use to athenticate
144 incoming connections. The same key have to be specified in the
145 client configuration. If no key is specified, all logins will
146 be unauthenticated. A good authentication key should be 20 char‐
147 acters long. The key will never be transmitted over the net‐
148 work. A HMAC-SHA1 challenge-response procedure will be used for
149 authentication.
150 Trx uplink section
152 The Trx uplink section is used to specify the configuration for an RF
153 link to the main SvxLink server. In the default configuration file
154 there is a Trx uplink section called TrxUpLink. The section name could
155 be anything. It should match the UPLINK configuration variable in the
156 GLOBAL section.
157 The use of Trx uplinks is very EXPERIMENTAL and still have some flaws.
159 Among other things, detected tones (like CTCSS or 1750 tone burst) are
160 not relayed and all relayed DTMF tones are always 100ms long no matter
161 how long the received digit was. Signal level measurements are not
162 relayed either.
163 Any way, it's used to link remote receivers coming in on the Internet
165 to a site that do not have access to Internet.
166 TYPE Always "Trx" for a Trx uplink.
168 TX Point out the uplink transmitter configuration section to use.
170 The configuration for an uplink transmitter looks exactly the
171 same as for any other transmitter. In the default configuration
172 file there is an uplink transmitter configuration section called
173 UplinkTx.
174 RX Point out the uplink receiver configuration section to use. The
176 configuration for an uplink receiver looks exactly the same as
177 for any other receiver. In the default configuration file there
178 is an uplink receiver configuration section called UplinkRx.
179 MUTE_RX_ON_TX
181 Specify if the link receiver should be muted or not when the
182 link transmitter is transmitting. Set it to 0 if a full duplex
183 link is desired. Default is 1.
184 LOOP_RX_TO_TX
186 Set to 1 to loop incoming RX audio (not link RX) directly to the
187 TX (not link TX). You figure out when to use it. Default is 0.
188
190 /etc/remotetrx.conf
191 The system wide configuration file.
192 ~/.svxlink/remotetrx.conf or ~/.remotetrxrc
194 Per user configuration file.
195 /etc/remotetrx.d/*
197 Additional configuration files.
198
200 Tobias Blomberg (SM0SVX) <sm0svx at users dot sourceforge dot net>
201
203 svxlink(1), svxlink.conf(1), remotetrx(1), siglevdetcal(1)
204Linux APRIL 2008 REMOTETRX.CONF(5)