Merged r6015:6026 from jcorgan/radar.
[debian/gnuradio] / gr-radar-mono / README
1 This GNU Radio component implements a monostatic radar transmitter
2 and receiver.  It uses a custom FPGA build to generate a linear 
3 FM chirp waveform directly in the USRP. Echo returns are (will be) 
4 recorded to a file for offline analysis.
5
6 The LFM chirp can be up to 32 MHz in width, whose center frequency
7 is set by which transmit daughter board is installed.  This gives
8 a range resolution of approximately 5 meters.
9
10 Only boards in slot A are supported.
11
12 The script to run is placed in $prefix/bin:
13
14 Usage: usrp_radar_mono.py [options]
15
16 Options:
17   -h, --help            show this help message and exit
18   -f FREQ, --frequency=FREQ
19                         set transmitter center frequency to FREQ in Hz,
20                         default is 0.0
21   -w FREQ, --chirp-width=FREQ
22                         set LFM chirp bandwidth in Hz, default is 32000000.0
23   -a AMPLITUDE, --amplitude=AMPLITUDE
24                         set waveform amplitude in % full scale, default is
25                         100,
26   --ton=TON             set pulse on period in seconds, default is 5e-06,
27   --tsw=TSW             set transmitter switching period in seconds, default
28                         is 4.0625e-07,
29   --tlook=TLOOK         set receiver look time in seconds, default is 5e-06,
30   --prf=PRF             set pulse repetition frequency in Hz, default is
31                         10000.0,
32   -v, --verbose         enable verbose output, default is disabled
33   -D, --debug           enable debugging output, default is disabled
34
35 The transmitter creates an LFM chirp, evenly centered on the supplied frequency.
36 The four timing parameters are:
37
38 ton     Chirp on time in seconds.  
39
40 tsw     Transmitter switching time in seconds.  This the delay after the chirp
41         is transmitted before the receiver is enabled. These two (tsw and ton)
42         parameters determine the minimum range of the radar.
43
44 tlook   The the amount of time in seconds the receiver is enabled to record
45         echo responses ("look" time). This parameter determines the maximum
46         radar range that can be measured, though transmitter power will also
47         limit return strength and practical range.
48
49 prf     Pulse repetition frequency in Hz.  This establishes to overall pulse
50         repetition period, which results in idle time between when the receiver
51         is turned off and the next transmitted chirp begins.
52
53 Currently, only the transmitter is written. Also, there is not yet any sanity
54 checks on the supplied parameters to the script.
55
56 The receiver, when completed, will record the radar returns, preserving phase,
57 into a file with metadata about each chirp.
58
59 This is experimental code.
60
61 Johnathan Corgan
62 Corgan Enterprises LLC
63 jcorgan@corganenterprises.com
64 7/18/2007