Project

General

Profile

GrOsmoSDR » History » Version 29

horiz0n, 02/19/2016 10:50 PM

1 1 horiz0n
[[PageOutline]]
2
3 20 horiz0n
= OSMOCOM Gnuradio Source =
4 1 horiz0n
5 20 horiz0n
While primarily being developed for the OsmoSDR hardware, this block as well supports:
6 1 horiz0n
7 20 horiz0n
 * [http://tetra.osmocom.org/trac/wiki/Funcube_Dongle FunCube Dongle] through libgnuradio-fcd
8
 * [http://sdr.osmocom.org/trac/ OSMOCOM OsmoSDR] Devices through [http://cgit.osmocom.org/osmo-sdr/ libosmosdr]
9
 * [http://greatscottgadgets.com/hackrf/ Great Scott Gadgets HackRF] through [https://github.com/mossmann/hackrf libhackrf]
10 22 horiz0n
 * [https://www.ettus.com/product Ettus USRP] Devices through [http://files.ettus.com/uhd_docs/manual/html/build.html Ettus UHD library]
11 20 horiz0n
 * RTL2832U based DVB-T dongles through [http://sdr.osmocom.org/trac/wiki/rtl-sdr librtlsdr]
12
 * RTL-TCP spectrum server (see librtlsdr project)
13
 * MSi2500 based DVB-T dongles through [http://cgit.osmocom.org/libmirisdr/ libmirisdr]
14
 * gnuradio .cfile input through libgnuradio-core
15
16
By using the OsmoSDR block you can take advantage of a common software api in your application(s) independent of the underlying radio hardware.
17
18 1 horiz0n
== Build process ==
19
20
'''The gnuradio source requires a recent gnuradio (>= v3.6.4.1) to be installed.'''
21 20 horiz0n
22
Before building the source you have to make sure that all the dependencies (see list of supported devices above) you are intend to work with are properly installed. The build system of gr-osmosdr will recognize them and enable specific source/sink components thereafter.
23 1 horiz0n
24
Please note: prior pulling a new version from git and compiling it, please do a "make uninstall" first to properly remove the previous version.
25
26
Building with cmake:
27
{{{
28
git clone git://git.osmocom.org/gr-osmosdr
29
cd gr-osmosdr/
30
mkdir build
31
cd build/
32 14 horiz0n
cmake ../
33 1 horiz0n
make
34
sudo make install
35
sudo ldconfig
36
}}}
37
38 17 horiz0n
NOTE: The OSMOCOM source block will appear under 'Sources' category in GRC menu.
39 1 horiz0n
40 10 horiz0n
To build the API documentation:
41
{{{
42
cd build/
43 14 horiz0n
cmake ../ -DENABLE_DOXYGEN=1
44 10 horiz0n
make -C docs
45
}}}
46
47 1 horiz0n
== Automated installation ==
48
49
Marcus D. Leech has kindly integrated the forementioned build steps into his gnuradio installation script at [http://www.sbrac.org/files/build-gnuradio]. This is the most user-friendly option so far.
50 7 horiz0n
51 11 horiz0n
== Device specification ==
52
You can specify the source or sink device using a comma separated string of argument=value pairs.
53
54 19 horiz0n
The always-up-to-date block documentation is available [http://cgit.osmocom.org/gr-osmosdr/tree/grc/gen_osmosdr_blocks.py#n100 right here].
55
56 18 horiz0n
=== FCD Source ===
57
||Argument||Notes||
58 28 horiz0n
||fcd=<device-index>|| 0-based device identifier||
59 18 horiz0n
60 1 horiz0n
=== OsmoSDR Source ===
61 28 horiz0n
||Argument||Notes||
62
||osmosdr=<device-index>|| 0-based device identifier||
63 1 horiz0n
||buffers=<number-of-buffers>|| Default is 32||
64 28 horiz0n
||buflen=<length-of-buffer>|| Default is 256kB, must be multiple of 512||
65 1 horiz0n
66 11 horiz0n
=== RTL-SDR Source ===
67 28 horiz0n
||Argument||Notes||
68
||rtl=<device-index>|| 0-based device identifier OR serial number||
69
||rtl_xtal=<frequency>|| Frequency (Hz) used for the RTL chip, accepts eng notation||
70
||tuner_xtal=<frequency>|| Frequency (Hz) used for the tuner chip, accepts eng notation||
71 1 horiz0n
||buffers=<number-of-buffers>|| Default is 32||
72 28 horiz0n
||buflen=<length-of-buffer>|| Default is 256kB, must be multiple of 512||
73 29 horiz0n
||direct_samp=0|1|2|| Enable direct sampling mode on the RTL chip. 0: Disable, 1: use I channel, 2: use Q channel||
74
||offset_tune=0|1|| Enable offset tune mode for E4000 tuners||
75 28 horiz0n
76
NOTE: use rtl_eeprom -s to program your own serial number to the device
77 11 horiz0n
NOTE: if you don't specify rtl_xtal/tuner_xtal, the underlying driver will use 28.0MHz
78 1 horiz0n
79
=== RTL-SDR TCP Source ===
80 28 horiz0n
||Argument||Notes||
81 1 horiz0n
||rtl_tcp=<hostname>:<port>|| hostname defaults to "localhost", port to "1234"||
82
||psize=<payload-size>|| Default is 16384 bytes||
83 29 horiz0n
||direct_samp=0|1|2|| Enable direct sampling mode on the RTL chip 0=Off, 1=I-ADC input enabled, 2=Q-ADC input enabled||
84
||offset_tune=0|1|| Enable offset tune mode for E4000 tuners||
85 1 horiz0n
86 28 horiz0n
=== Miri Source ===
87
||Argument||Notes||
88
||miri=<device-index>|| 0-based device identifier||
89
||buffers=<number-of-buffers>|| Default is 32||
90
91
NOTE: if you don't specify rtl_xtal/tuner_xtal, the underlying driver will use 28.0MHz
92
93 1 horiz0n
=== UHD Source / Sink ===
94 28 horiz0n
||Argument||Notes||
95
||uhd|| Use this argument without a value||
96
||nchan=<channel-count>|| For multichannel USRP configurations use the subdev parameter to specify stream mapping||
97
||subdev=<subdev-spec>|| Examples: "A:0", "B:0", "A:0 B:0" when nchan=2. Refer original ettus documentation on this||
98
||lo_offset=<frequency>|| Offset frequency in Hz, must be within daughterboard bandwidth. Accepts eng notation||
99 1 horiz0n
100
Additional argument/value pairs will be passed to the underlying driver, for more information see
101
[http://files.ettus.com/uhd_docs/manual/html/general.html#specifying-the-subdevice-to-use specifying the subdevice] and 
102
[http://files.ettus.com/uhd_docs/manual/html/identification.html#common-device-identifiers common device identifiers] in the Ettus documentation.
103
104
=== HackRF Source / Sink ===
105 28 horiz0n
||Argument||Notes||
106
||hackrf|| Use this argument without a value||
107 24 horiz0n
||buffers=<number-of-buffers>|| Default is 32||
108
109 28 horiz0n
Only the first device found may be used at the moment because of libhackrf limitation.
110
111 24 horiz0n
=== IQ File Source ===
112 28 horiz0n
||Argument||Notes||
113 24 horiz0n
||file=<path-to-file-name>||||
114 28 horiz0n
||freq=<frequency>|| Center frequency in Hz, accepts eng notation||
115
||rate=<sampling-rate>|| Mandatory, in samples/s||
116 7 horiz0n
||repeat=true|false|| Default is true||
117 28 horiz0n
||throttle=true|false|| Throttle flow of samples, default is true||
118 7 horiz0n
119
== Known Apps ==
120
121
The following 3rd party applications are successfully using gr-osmosdr:
122
123
||'''Name'''||'''Type'''||'''Author'''||'''URL'''||
124
||gr-pocsag||GRC Flowgraph||Marcus Leech||[https://www.cgran.org/browser/projects/gr-pocsag/trunk]||
125 15 horiz0n
||multimode RX||GRC Flowgraph||Marcus Leech||[https://www.cgran.org/browser/projects/multimode/trunk]||
126 8 horiz0n
||simple_fm_rvc||GRC Flowgraph||Marcus Leech||[https://www.cgran.org/browser/projects/simple_fm_rcv/trunk]||
127 16 horiz0n
||Wireless Temp. Sensor RX||Gnuradio App||Kevin Mehall||[https://github.com/kevinmehall/rtlsdr-433m-sensor]||
128 1 horiz0n
||gqrx||SDR GUI||Alexandru Csete||[https://github.com/csete/gqrx]||
129
||tetra_demod_fft||Trunking RX||osmocom team||[http://cgit.osmocom.org/cgit/osmo-tetra/tree/src/demod/python/osmosdr-tetra_demod_fft.py osmosdr-tetra_demod_fft.py] and the [http://tetra.osmocom.org/trac/wiki/osmo-tetra#Quickexample HOWTO] ||
130
||airprobe||GSM sniffer||osmocom team et al||[http://git.gnumonks.org/cgi-bin/gitweb.cgi?p=airprobe.git]||
131
||gr-smartnet (WIP)||Trunking RX||Nick Foster||[http://www.reddit.com/r/RTLSDR/comments/us3yo/rtlsdr_smartnet/][[br]][http://www.reddit.com/r/RTLSDR/comments/vbxl0/attention_grsmartnet_users_or_attempted_users/ Notes from the author]||
132
||gr-air-modes||ADS-B RX||Nick Foster||[https://www.cgran.org/wiki/gr-air-modes] call with --rtlsdr option||
133 16 horiz0n
||gr-ais (fork)||AIS RX||Nick Foster[[br]]Antoine Sirinelli[[br]]Christian Gagneraud||[https://github.com/chgans/gr-ais]||
134
||GNSS-SDR ||GPS RX (Realtime!)||Centre Tecnològic de[[br]]Telecomunicacions de Catalunya||[http://www.gnss-sdr.org/documentation/gnss-sdr-operation-realtek-rtl2832u-usb-dongle-dvb-t-receiver Documentation] and [http://www.gnss-sdr.org]||
135 15 horiz0n
||gr-scan ||Scanner||techmeology||[http://www.techmeology.co.uk/gr-scan/]||
136
||pocsag-mrt||Multichannel Realtime[[br]]Decoder||iZsh||[https://github.com/iZsh/pocsag-mrt]||
137
||osmo-gmr-rtl||GMR1 RX||Dimitri Stolnikov||[http://gmr.osmocom.org/trac/wiki/GettingStarted#RTLSDRdongles]||
138
||simple_ra '''(NEW)'''||Radio Astronomy App||Marcus Leech||[https://cgran.org/wiki/simple_ra]||
139
||FS20_decode '''(NEW)'''||FS20 Decoder||Thomas Frisch||[https://github.com/eT0M/rtl_sdr_FS20_decoder]||
140
||OpenLTE '''(NEW)'''||LTE Toolkit||Ben Wojtowicz||[http://sourceforge.net/p/openlte/home/Home/]||
141 28 horiz0n
142
143
== Credits ==
144
145
gr-osmosdr is developed by Dimitri Stolnikov with contributions from Hoernchen and Steve Markgraf.
Add picture from clipboard (Maximum size: 48.8 MB)