Better example.ini defaults

1 files changed, 39 insertions, 48 deletions

diff --git a/doc/example.ini b/doc/example.ini
index e0a1fc8..cf56720 100644
--- a/doc/example.ini
+++ b/doc/example.ini
@@ -10,15 +10,15 @@ telnetport=2121
 
 ; Enable zmq remote control.
 ; The zmq remote control is intended for machine-to-machine
-; integration and requires that ODR-DabMod is built with zmq support.
-; The zmq remote control may run in parallel with Telnet.
+; integration. It may run in parallel with Telnet.
 ;
 ; Protocol:
 ; ODR-DabMod binds a zmq rep socket so clients must connect
 ; using either req or dealer socket.
 ; [] denotes message part as zmq multi-part message are used for delimitation.
 ; All message parts are utf-8 encoded strings and match the Telnet command set.
-; Explicit codes are denoted with "".
+; Messages to be sent as literal strings are denoted with "" below.
+;
 ; The following commands are supported:
 ; REQ: ["ping"]
 ; REP: ["ok"]
@@ -34,7 +34,7 @@ telnetport=2121
 ;
 ; REQ: ["set"][module name][parameter][value]
 ; REP: ["ok"] _OR_ ["fail"][error description]
-zmqctrl=0
+zmqctrl=1
 zmqctrlendpoint=tcp://127.0.0.1:9400
 
 [log]
@@ -53,6 +53,17 @@ source=/dev/stdin
 ; When the end of file is reached, it is possible to rewind it
 loop=0
 
+; ETI-over-TCP example:
+;transport=tcp
+;source=localhost:9200
+
+; When recieving data using ZeroMQ, the source is the URI to be used
+;transport=zeromq
+;source=tcp://localhost:8080
+; The option max_frames_queued defines the maximum number of ETI frames
+; that can be in the input queue
+;max_frames_queued=100
+
 ; EDI input.
 ; Listen for EDI data on a given UDP port
 ;transport=edi
@@ -63,16 +74,6 @@ loop=0
 ; No support yet for multicast, should work with and without PFT
 ; This EDI implementation does not support EDI Packet Resend
 
-; When recieving data using ZeroMQ, the source is the URI to be used
-;transport=zeromq
-;source=tcp://localhost:8080
-; The option max_frames_queued defines the maximum number of ETI frames
-; that can be in the input queue
-;max_frames_queued=100
-
-; ETI-over-TCP example:
-;transport=tcp
-;source=localhost:9200
 
 [modulator]
 ;   Mode 'fix' uses a fixed factor and is really not recommended. It is more
@@ -99,7 +100,7 @@ gainmode=var
 
 ; Transmission mode
 ; If not defined, take the mode from ETI
-;mode=2
+;mode=1
 
 ; The digital gain is a value that is multiplied to each sample. It is used
 ; to tune the chain to make sure that no non-linearities appear up to the
@@ -116,11 +117,11 @@ digital_gain=0.8
 ; is enabled or not !
 rate=2048000
 
-; CIC equaliser for USRP1 and USRP2
+; (DEPRECATED) CIC equaliser for USRP1 and USRP2
 ; Set to 0 to disable CicEqualiser
 ; when set to 400000000, an additional USRP2 check is enabled.
 ; See DabModulator.cpp line 186
-dac_clk_rate=0
+;dac_clk_rate=0
 
 ; The USRP1 does not have flexible clocking, you will need
 ;rate=3200000
@@ -149,19 +150,9 @@ enabled=1
 ;filtertapsfile=simple_taps.txt
 
 [poly]
-;Predistortion using memoryless polynom
-enabled=1
+;Predistortion using memoryless polynom, see dpd/ folder for more info
+enabled=0
 polycoeffile=polyCoefs
-;eg:
-;echo "8
-;0.1
-;0
-;0
-;0
-;0
-;0
-;0
-;0" > polyCoefs
 
 [output]
 ; choose output: possible values: uhd, file, zmq, soapysdr
@@ -191,7 +182,7 @@ output=uhd
 ;format=s8
 
 ; The output file:
-filename=/dev/stdout
+filename=ofdm.iq
 
 [uhdoutput]
 ; The UHD output can be directly used with the Ettus USRP devices
@@ -201,30 +192,30 @@ filename=/dev/stdout
 ;   master_clock_rate = 4 * sample_rate
 ; or even a higher factor.
 ;
-; Settings for a USRP B100:
+; Settings for the B200:
 device=
-; you can put additional UHD device settings here
 master_clock_rate=32768000
-type=b100
-txgain=2.0
-; Try first with small gain values
-; Also set rate to 2048000
-
-; For the B200
-; More information and measurements available on:
-; http://wiki.opendigitalradio.org/index.php/USRP_B200_Measurements
-;
-; Settings:
-;device=
-;master_clock_rate=32768000
-;type=b200
-;txgain=40
+type=b200
+txgain=40
 ; The B200 needs larger gains (up to 89dB) but,
 ; "Gain settings are application specific, but it is recommended that users
 ; consider using at least half of the available gain to get reasonable dynamic
 ; range."
 ;    From the B200 User Manual
 ;    http://files.ettus.com/uhd_docs/manual/html/usrp_b200.html
+;
+; More information and measurements available on:
+; http://wiki.opendigitalradio.org/index.php/USRP_B200_Measurements
+
+
+; Settings for a USRP B100:
+;device=
+; you can put additional UHD device settings here
+;master_clock_rate=32768000
+;type=b100
+;txgain=2.0
+; Try first with small gain values
+; Also set rate to 2048000
 
 
 ; For the USRP1
@@ -233,7 +224,7 @@ txgain=2.0
 ; the usrp1 can have two daughterboards, the subdevice parameter allows you
 ; to choose which one to use
 ;subdevice=A:0
-; The USRP1 doesn't support master_clock_rate, you need to enable resamping
+; The USRP1 doesn't support master_clock_rate, you need to enable resampling
 
 
 ; You must specify either frequency or channel, but not both.
@@ -275,7 +266,7 @@ max_gps_holdover_time=600
 ; Enable the TCP server to communicate TX and RX feedback for
 ; digital predistortion.
 ; Set to 0 to disable
-dpd_port=50055
+;dpd_port=50055
 
 ; section defining ZeroMQ output properties
 [zmqoutput]