SDR (Software Defined Radio) » gr-osmosdr

[[PageOutline]]

= OsmoSDR Gnuradio Source =

Primarily gr-osmosdr supports the OsmoSDR hardware, but it also offers a wrapper functionality for [http://tetra.osmocom.org/trac/wiki/Funcube_Dongle FunCube Dongle], [http://files.ettus.com/uhd_docs/manual/html/build.html Ettus UHD] and [http://sdr.osmocom.org/trac/wiki/rtl-sdr rtl-sdr] radios. By using gr-osmosdr source you can take advantage of a common software api in your application(s) independent of the underlying radio hardware.

== Build process ==

'''The gnuradio source requires a recent gnuradio (>= v3.5.3) to be installed.'''

Please note: prior pulling a new version from git and compiling it, please do a "make uninstall" first to properly remove the previous version.

Building with cmake:

{{{

git clone git://git.osmocom.org/gr-osmosdr

cd gr-osmosdr/

mkdir build

cd build/

cmake ../ -Wno-dev

make

sudo make install

sudo ldconfig

}}}

NOTE: The source block will appear under 'OsmoSDR' category in GRC menu.

To build the API documentation:

{{{

cd build/

cmake ../ -Wno-dev -DENABLE_DOXYGEN=1

make -C docs

}}}

== Automated installation ==

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.

== Device specification ==

You can specify the source or sink device using a comma separated string of argument=value pairs.

=== Local file ===

||file=<path-to-file-name>||||

||freq=<frequency>|| in Hz||

||rate=<sampling-rate>|| in samples/s||

||repeat=true|false|| Default is false||

||throttle=true|false||Throttle flow of samples, default is false||

=== OsmoSDR (source) ===

||osmosdr=<device-index>|| ||

||mcr=<rate>||Master clock rate. FIXME: Setting the MCR is not supported||

||nchan=<channel-number>||FIXME: Values of nchan != 1 are not supported||

||buffers=<number-of-buffers>|| Default is 32||

=== OsmoSDR (sink) ===

FIXME: OsmoSDR sink is not yet implemented.

=== rtl-sdr ===

||rtl=<device-index>|| ||

||rtl_xtal=<frequency>|| Frequency in Hz of the crystal oscillator used for the RTL chip||

||tunner_xtal=<frequency>|| Frequency in Hz of the crystal oscillator used for the tunner chip||

||buffers=<number-of-buffers>|| Default is 32||

NOTE: if you don't specify rtl_xtal/tunner_xtal, the underlying driver will use 28.0MHz

=== rtl-sdr TCP server ===

||rtl_tcp=<hostname>:<port>|| hostname defaults to "localhost", port to "1234"||

||psize=<payload-size>|| Default is 16384 bytes||

=== UHD ===

||uhd|| Use this argument without value ||

||nchan=<channel-index>|| ||

||subdev=<subdev-spec>|| See below||

Additional argument/value pairs will be passed to the underlying driver, for more information see

http://files.ettus.com/uhd_docs/manual/html/general.html#specifying-the-subdevice-to-use and 

http://files.ettus.com/uhd_docs/manual/html/identification.html#common-device-identifiers

=== FCD ===

||Argument||Notes||

||fcd=<device-index>|| ||

== Known Apps ==

The following 3rd party applications are successfully using gr-osmosdr:

||'''Name'''||'''Type'''||'''Author'''||'''URL'''||

||gr-pocsag||GRC Flowgraph||Marcus Leech||[https://www.cgran.org/browser/projects/gr-pocsag/trunk]||

||multimode RX||GRC Flowgraph||Marcus Leech||[https://www.cgran.org/browser/projects/multimode/trunk]||

||simple_fm_rvc||GRC Flowgraph||Marcus Leech||[https://www.cgran.org/browser/projects/simple_fm_rcv/trunk]||

||Wireless Temp. Sensor RX||Gnuradio App||Kevin Mehall||[https://github.com/kevinmehall/rtlsdr-433m-sensor]||

||gqrx (fork)||SDR GUI||Alexandru Csete||[https://github.com/mathisschmieder/gqrx]||

||tetra_demod_fft||SDR GUI||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] ||

||gqrx (original)||SDR GUI||Alexandru Csete||[https://github.com/csete/gqrx/tree/osmosdr]||

||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] ||

||airprobe '''(NEW)'''||GSM sniffer||osmocom team et al||[http://git.gnumonks.org/cgi-bin/gitweb.cgi?p=airprobe.git]||

||gr-smartnet (WIP) '''(NEW)'''||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]||

||gr-air-modes '''(NEW)'''||ADS-B RX||Nick Foster||[https://www.cgran.org/wiki/gr-air-modes] call with --rtlsdr option||