Fixing up GUI windows to better scale with gtgui sinks.

[debian/gnuradio] / gr-radar-mono / README

diff --git a/gr-radar-mono/README b/gr-radar-mono/README
index 0ecf4e381ee0a506bf60db468f425c30ba75635d..577c8e095fe7ce1e4e922aeaba99f5dca334fb37 100644 (file)
--- a/gr-radar-mono/README
+++ b/gr-radar-mono/README
@@ -1,28 +1,32 @@
 This GNU Radio component implements a monostatic radar transmitter
 and receiver.  It uses a custom FPGA build to generate a linear 
-FM chirp waveform directly in the USRP. Echo returns are (will be) 
-recorded to a file for offline analysis.
+FM chirp waveform directly in the USRP. Echo returns are recorded 
+to a file for offline analysis.
 
 The LFM chirp can be up to 32 MHz in width, whose center frequency
 is set by which transmit daughter board is installed.  This gives
 a range resolution of approximately 5 meters.
 
-Only boards in slot A are supported.
-
 The script to run is placed in $prefix/bin:
 
 Usage: usrp_radar_mono.py [options]
 
 Options:
   -h, --help            show this help message and exit
+  -T TX_SUBDEV_SPEC, --tx-subdev-spec=TX_SUBDEV_SPEC
+                        use transmitter board side A or B (default is first
+                        found)
+  -R RX_SUBDEV_SPEC, --rx-subdev-spec=RX_SUBDEV_SPEC
+                        use receiver board side A or B (default is first
+                        found)
+  -g GAIN, --gain=GAIN  set gain in dB (default is midpoint)
   -f FREQ, --frequency=FREQ
                         set transmitter center frequency to FREQ in Hz,
                         default is 0.0
   -w FREQ, --chirp-width=FREQ
-                        set LFM chirp bandwidth in Hz, default is 32000000.0
+                        set LFM chirp bandwidth in Hz, default is 32M
   -a AMPLITUDE, --amplitude=AMPLITUDE
-                        set waveform amplitude in % full scale, default is
-                        100,
+                        set waveform amplitude in % full scale, default is 15,
   --ton=TON             set pulse on period in seconds, default is 5e-06,
   --tsw=TSW             set transmitter switching period in seconds, default
                         is 4.0625e-07,
@@ -31,6 +35,8 @@ Options:
                         10000.0,
   -v, --verbose         enable verbose output, default is disabled
   -D, --debug           enable debugging output, default is disabled
+  -F FILENAME, --filename=FILENAME
+                        log received echos to file
 
 The transmitter creates an LFM chirp, evenly centered on the supplied frequency.
 The four timing parameters are:
@@ -50,15 +56,12 @@ prf     Pulse repetition frequency in Hz.  This establishes to overall pulse
         repetition period, which results in idle time between when the receiver
         is turned off and the next transmitted chirp begins.
 
-Currently, only the transmitter is written. Also, there is not yet any sanity
-checks on the supplied parameters to the script.
-
-The receiver, when completed, will record the radar returns, preserving phase,
-into a file with metadata about each chirp.
+The transmitter is completed.  The receive path is logging echo data to a supplied
+file; however, no meta-data is logged.
 
 This is experimental code.
 
 Johnathan Corgan
 Corgan Enterprises LLC
 jcorgan@corganenterprises.com
-7/18/2007
+9/17/2007