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 The RemoteTrx application can handle more than one transceiver at a
14 time. You may for example want to handle both a 2m and a 70cm receiver
15 on a site. One sound card is sufficient for doing this since the left
16 channel can be used for one receiver and the right channel can be used
17 for the other receiver. The GLOBAL/TRXS configuration variable is used
18 to tell the RemoteTrx application which transceivers to set up. Each
19 transceiver have an uplink that is used to interface to the main
20 SvxLink server. The most common type is the net uplink which link to
21 the main SvxLink server over the Internet using TCP/IP. It is also
22 possible to have an uplink via RF but the functionality is then lim‐
23 ited.
24 The term "uplink" might be a bit confusing for some people. In this
26 case it does not refer to any specific direction in which the data or
27 audio is flowing. It's just the name for the link up to the main
28 SvxLink server.
29 RemoteTrx look for configuration files in a number of places. First it
31 tries to find a user specific configuration file. It will look for a
32 user specific configuration file in two places:
33 $HOME/.svxlink/remotetrx.conf. If no user specific configuration file
34 can be found, remotetrx will look for the system wide configuration
35 file /etc/svxlink/remotetrx.conf. The --config command line option may
36 also be used to specify an arbitrary configuration file.
37
39 The configuration file is in the famous INI-file format. A generic
40 example of how such a file might look like is shown below.
41 [SECTION1]
43 VALUE1=1
44 VALUE2="TWO "
45 VAULE3="Multi "
46 "line"
47 [SECTION2]
49 VALUE1=2
50 This is a simple format that contain name=value pairs that belong to a
52 section. In written text, a specific configuration variable can be
53 referred to as SECTION1/VALUE2 meaning "configuration variable VALUE2
54 in section SECTION1".
55 The same variable name can exist in two different sections. For example
57 VALUE1 in section SECTION1 have the value 1 and VALUE1 in section SEC‐
58 TION2 have the value 2. Values containing spaces at the beginning or
59 end of the line must be surrounded by citation characters (see SEC‐
60 TION1/VALUE2). Likewise with a multi line value (see SECTION1/VALUE3).
61
63 Here is the description of all configuration variables that remotetrx
64 understands. The configuration variables are described section for sec‐
65 tion.
66 GLOBAL
68 The GLOBAL section contains application global configuration data.
69 TRXS This configuration variable specify a comma separated list of
71 transceiver configuration sections.
72 CFG_DIR
74 Specify the path to a directory that contain additional configu‐
75 ration files. If a relative path is specified, the path will be
76 relative to the directory where the main configuration file is
77 at. All files in the specified directory will be read as addi‐
78 tional configuration. Filenames starting with a dot are ignored.
79 TIMESTAMP_FORMAT
81 This variable specifies the format of the timestamp that is
82 written in front of each row in the log file. The format string
83 is in the same format as specified in the strftime(3) manual
84 page. The default is "%c" which is described as: "the preferred
85 date and time representation for the current locale". The envi‐
86 ronment variables LC_TIME, LC_ALL and LANG will affect how this
87 time format will look. For example, setting LC_TIME="sv_SE.UTF8"
88 will give you swedish timestamp representation. Other examples
89 of format specifiers are:
90 · %d - The day of the month as a decimal number (range 01 to
92 31)
93 · %b - The abbreviated month name according to the current
95 locale
96 · %Y - The year as a decimal number including the century
98 · %H - The hour as a decimal number using a 24-hour clock
100 (range 00 to 23)
101 · %M - The minute as a decimal number (range 00 to 59)
103 · %S - The second as a decimal number (range 00 to 61)
105 So, TIMESTAMP_FORMAT="%d %b %Y %H:%M:%S" would give a timestamp
107 looking something like: "29 Nov 2005 22:31:59".
108 CARD_SAMPLE_RATE
110 This configuration variable determines the sampling rate used
111 for audio input/output. SvxLink always work with a sampling rate
112 of 16kHz internally but there still are som benefits from using
113 a higher sampling rate. On some sound cards the filters look
114 pretty bad at 16kHz and the amplitude response will not be uni‐
115 form which among other things can cause problems for the soft‐
116 ware DTMF decoder.
117 Some sound cards also sound very bad at 16kHz due to insuffi‐
119 cient anti-alias filtering or resampling effects. These, often
120 cheeper, sound cards sound OK at 48kHz.
121 The downside of choosing a higher sampling rate is that it puts
123 a little bit more load on the CPU so if you have a very slow
124 machine (<300MHz), it might not have the computational power to
125 handle it.
126 Supported sampling rates are: 16000 and 48000.
128 CARD_CHANNELS
130 Use this configuration variable to specify how many channels to
131 use when opening a sound card. For normal sound cards the only
132 practical values to use are 1 for mono and 2 for stereo. The
133 latter is the default.
134 When using the sound card in stereo mode it is possible to use
136 the left and right channels independenly to drive two trans‐
137 ceivers. When using the sound card in mono mode, both left and
138 right channels transmit/receive the same audio.
139 Network uplink transceiver section
141 The network uplink transceiver section is used to specify the configu‐
142 ration for a network link to the main SvxLink server. In the default
143 configuration file there is a network uplink transceiver section called
144 NetUpLinkTrx.
145 TYPE Always "Net" for a network uplink transceiver configuration sec‐
147 tion.
148 RX Point out the receiver configuration section to use. Set to NONE
150 if no RX is used. A receiver is configured in the exact same way
151 as in the SvxLink server. Have a look at svxlink.conf(5) for
152 more information on how to configure a receiver.
153 TX Point out the transmitter configuration section to use. Set to
155 NONE if no TX is used. A transmitter is configured in the exact
156 same way as in the SvxLink server. Have a look at
157 svxlink.conf(5) for more information on how to configure a
158 transmitter.
159 LISTEN_PORT
161 The TCP port to listen on. Make sure to choose a unique port for
162 each network uplink transceiver configuration. The default is
163 5210.
164 AUTH_KEY
166 This is the authentication key (password) to use to athenticate
167 incoming connections. The same key have to be specified in the
168 client configuration. If no key is specified, all logins will
169 be unauthenticated. A good authentication key should be 20 char‐
170 acters long. The key will never be transmitted over the net‐
171 work. A HMAC-SHA1 challenge-response procedure will be used for
172 authentication.
173 MUTE_TX_ON_RX
175 If set to a value >= 0, will stop the transmitter from transmit‐
176 ting when the squelch is open. The value represents a delay, in
177 milliseconds, after the squelch has closed, that the transmitter
178 will be muted. For example, if set to 1000, the transmitter will
179 be muted one second after the squelch has closed. The default
180 is not to mute the transmitter when the squelch is open.
181 RF uplink transceiver section
183 The RF uplink transceiver configuration section is used to specify the
184 configuration for an RF link to the main SvxLink server. In the default
185 configuration file there is an RF uplink transceiver section called
186 RfUpLinkTrx. The section name could be anything. It should match what
187 is specified in the TRXS configuration variable in the GLOBAL section.
188 The use of Rf uplinks is very EXPERIMENTAL and still have some flaws.
190 Among other things, detected tones (like CTCSS or 1750 tone burst) are
191 not relayed and all relayed DTMF tones are always 100ms long no matter
192 how long the received digit was. Signal level measurements are not
193 relayed either.
194 Any way, it's used to link remote receivers coming in on the Internet
196 to a site that do not have access to Internet.
197 TYPE Always "RF" for an RF uplink transceiver configuration section.
199 RX Point out the receiver configuration section to use. Set to NONE
201 if no RX is used. A receiver is configured in the exact same way
202 as in the SvxLink server. Have a look at svxlink.conf(5) for
203 more information on how to configure a receiver.
204 TX Point out the transmitter configuration section to use. Set to
206 NONE if no TX is used. A transmitter is configured in the exact
207 same way as in the SvxLink server. Have a look at
208 svxlink.conf(5) for more information on how to configure a
209 transmitter.
210 UPLINK_TX
212 Point out the uplink transmitter configuration section to use.
213 The configuration for an uplink transmitter looks exactly the
214 same as for any other transmitter. In the default configuration
215 file there is an uplink transmitter configuration section called
216 UplinkTx. If there is no uplink transmitter, specify NONE.
217 UPLINK_RX
219 Point out the uplink receiver configuration section to use. The
220 configuration for an uplink receiver looks exactly the same as
221 for any other receiver. In the default configuration file there
222 is an uplink receiver configuration section called UplinkRx. If
223 there is no uplink receiver, specify NONE.
224 MUTE_UPLINK_RX_ON_TX
226 Specify if the link receiver should be muted or not when the
227 link transmitter is transmitting. Set it to 0 if a full duplex
228 link is desired. Default is 1.
229 LOOP_RX_TO_TX
231 Set to 1 to loop incoming RX audio (not link RX) directly to the
232 TX (not link TX). You figure out when to use it. Default is 0.
233 FALLBACK_REPEATER
235 This function is useful if running RemoteTrx as both RX and TX
236 for a repeater. If the connection to the SvxLink base station
237 is lost due to network errors, the RemoteTrx provides a very
238 basic repeater function (SQLELCH controlled) until the the con‐
239 nection has been established again. Set to 1 to enable this
240 function or set to 0 to disable it. Default is 0.
241
243 /etc/svxlink/remotetrx.conf (or deprecated /etc/remotetrx.conf)
244 The system wide configuration file.
245 ~/.svxlink/remotetrx.conf
247 Per user configuration file.
248 /etc/svxlink/remotetrx.d/*
250 Additional configuration files.
251
253 Tobias Blomberg (SM0SVX) <sm0svx at users dot sourceforge dot net>
254
256 svxlink(1), svxlink.conf(1), remotetrx(1), siglevdetcal(1)
257Linux MAY 2011 REMOTETRX.CONF(5)