Merge remote-tracking branch 'upstream/master'

Conflicts:
	src/InputFileReader.cpp

1 files changed, 52 insertions, 4 deletions

diff --git a/doc/example.ini b/doc/example.ini
index e1ce252..ee9d567 100644
--- a/doc/example.ini
+++ b/doc/example.ini
@@ -8,6 +8,29 @@
 telnet=1
 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.
+;
+; 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 "".
+; The following commands are supported:
+; REQ: ["ping"]
+; REP: ["ok"]
+;
+; REQ: ["get"][module name][parameter]
+; REP: [value] _OR_ ["fail"][error description]
+;
+; REQ: ["set"][module name][parameter][value]
+; REP: ["ok"] _OR_ ["fail"][error description]
+zmqctrl=1
+zmqctrlendpoint=tcp://127.0.0.1:9400
+
 [log]
 ; Write to a logfile or to syslog.
 ; Setting filename to stderr is very useful during tests and development
@@ -26,6 +49,9 @@ loop=0
 ; 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
 
 [modulator]
 ; Gain mode: 0=FIX, 1=MAX, 2=VAR
@@ -59,7 +85,7 @@ gainmode=2
 ; and wide-band noise will be generated.
 ;
 ; Be aware that there is a dependency with resampling.
-digital_gain=1.0
+digital_gain=0.8
 
 ; Output sample rate. Values other than 2048000 enable
 ; resampling.
@@ -86,15 +112,26 @@ enabled=0
 filtertapsfile=simple_taps.txt
 
 [output]
-; choose output: possible values: uhd, file
+; choose output: possible values: uhd, file, zmq
 output=uhd
 
 [fileoutput]
-; The file output writes I/Q float values (i.e. complex float)
+; Two output formats are supported: In the default mode,
+; the file output writes I/Q float values (i.e. complex float)
 ; to the file. The I and Q samples can take values up to
 ; 100000 in absolute magnitude with gainmode FIX.
 ; With gainmode VAR, they should never exceed 50000.
 ; With gainmode MAX, thet are limited to 32767.
+;format=complexf
+;
+; When the format is set to s8, the output writes I/Q 8-bit
+; signed integers, where the magnitude is multiplied by 128/50000
+; effectively mapping the gainmode VAR range of -50000 -- 50000
+; to -128 -- 128. For other gainmodes, use the digital_gain setting
+; to make sure you don't create clipping.
+;format=s8
+
+; The output file:
 filename=/dev/stdout
 
 [uhdoutput]
@@ -116,7 +153,7 @@ txgain=2.0
 
 ; For the B200
 ; More information and measurements available on:
-; http://opendigitalradio.org/index.php/USRP_B200_Measurements
+; http://wiki.opendigitalradio.org/index.php/USRP_B200_Measurements
 ;
 ; Settings:
 ;device=
@@ -156,6 +193,17 @@ pps_source=none
 ; possible values: ignore, crash
 behaviour_refclk_lock_lost=ignore
 
+; section defining ZeroMQ output properties
+[zmqoutput]
+
+; on which port to listen for connections
+; please see the Transports section in man zmq
+; for more informat io the syntax
+listen=tcp://*:54001
+
+; what ZMQ socket type to use. Valid values: PUB, REP
+; Please see man zmq_socket for documentation
+socket_type=pub
 
 ; Used for SFN with the UHD output
 [delaymanagement]