gr-osmosdr/README

While primarily being developed for the OsmoSDR hardware, this block
as well supports:

 * FUNcube Dongle through libgnuradio-fcd
 * FUNcube Dongle Pro+ through gr-fcdproplus
 * sysmocom OsmoSDR Devices through libosmosdr
 * RTL2832U based DVB-T dongles through librtlsdr
 * RTL-TCP spectrum server (see librtlsdr project)
 * MSi2500 based DVB-T dongles through libmirisdr
 * gnuradio .cfile input through libgnuradio-blocks
 * RFSPACE SDR-IQ, SDR-IP, NetSDR (incl. X2 option)
 * AirSpy Wideband Receiver through libairspy
 * Great Scott Gadgets HackRF through libhackrf
 * Nuand LLC bladeRF through libbladeRF library
 * Ettus USRP Devices through Ettus UHD library
 * Fairwaves UmTRX through Fairwaves' fork of UHD

By using the OsmoSDR block you can take advantage of a common software api in
your application(s) independent of the underlying radio hardware.

For installation and usage guidelines please read the documentation available
at http://sdr.osmocom.org/trac/wiki/GrOsmoSDR

A short excerpt from the wiki:

The Gnu Radio block requires a recent gnuradio (>= v3.7) to be installed.

Before building the block you have to make sure that all 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.

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 ../
make
sudo make install
sudo ldconfig

NOTE: The osmocom blocks will appear under 'Sources' and 'Sinks' categories
in GRC menu.
update README 2013-06-04 22:15:28 +00:00			`While primarily being developed for the OsmoSDR hardware, this block`
			`as well supports:`
initial commit 2012-04-06 13:29:14 +00:00
fcd: add support for FUNcube Dongle Pro+ The gnuradio block https://github.com/dl1ksv/gr-fcdproplus must be installed before building gr-osmosdr. Available named gains: Dongle Classic: LNA: -5 to 30 dB, in 2.5 dB steps MIX: 4 or 12 dB Dongle Pro+: LNA: 0 or 1, meaning off/on only. no information about real values. MIX: 0 or 1, meaning off/on only. no information about real values. BB: 0 to 59 dB, in 1 dB steps This patch also introduces optional "device" and "type" arguments which allow to override the values automatically picked by gr-osmosdr: osmocom_fft -a "fcd,device=hw:2,type=2" The "device" argument overrides the audio device used by the underlying driver to access the dongle's IQ sample stream. The "type" argument selects the dongle type, 1 for Classic, 2 for Pro+. Thanks to Alexey Bazhin for the initial patch and Volker Schroer for testing. 2013-07-13 12:13:41 +00:00			`* FUNcube Dongle through libgnuradio-fcd`
			`* FUNcube Dongle Pro+ through gr-fcdproplus`
make OSMOCOM lowercase 2013-06-08 15:38:18 +00:00			`* sysmocom OsmoSDR Devices through libosmosdr`
update README 2013-05-25 23:07:24 +00:00			`* RTL2832U based DVB-T dongles through librtlsdr`
			`* RTL-TCP spectrum server (see librtlsdr project)`
			`* MSi2500 based DVB-T dongles through libmirisdr`
convert to gnuradio 3.7 interface 2013-05-29 20:34:40 +00:00			`* gnuradio .cfile input through libgnuradio-blocks`
rfspace: add support for RFSPACE SDR-IQ and SDR-IP Usage example: osmocom_fft -a sdr-iq=/dev/ttyUSB0 osmocom_fft -a sdr-ip=host[:port] osmocom_fft -a netsdr=host[:port][,nchan=2] The following named gain stages are available: SDR-IQ: ATT: -20 to +10 dB, in 10dB steps SDR-IP: ATT: -30 to 0 dB, in 10dB steps The ftdi_sio driver is being used for SDR-IQ. It creates a character device of the form: crw-rw---- 1 root dialout 188, 0 Dec 19 22:14 /dev/ttyUSB0 To be able to open the device without root permissions add yourself to the "dialout" group or do a "chmod 666 /dev/ttyUSB0" after pluggin in. 2013-12-18 22:55:10 +00:00			`* RFSPACE SDR-IQ, SDR-IP, NetSDR (incl. X2 option)`
airspy: add support for AirSpy wideband receiver Requires https://github.com/airspy/host Usage example: osmocom_fft -a airspy The following named gain stages are available: LNA: 0 to 15, step 1 MIX: 0 to 15, step 1 IF: 0 to 15, step 1 At the moment the gains are not in dB but gain indices internal to R820t tuner. 2014-01-04 20:15:44 +00:00			`* AirSpy Wideband Receiver through libairspy`
grc: move around documentation 2013-08-04 20:28:55 +00:00			`* Great Scott Gadgets HackRF through libhackrf`
			`* Nuand LLC bladeRF through libbladeRF library`
netsdr: add support for RFSPACE NetSDR receiver - implements broadcast UDP based device discovery - prints device information (serial/versions) on startup - reads available frequency range(s) from the device - integrity checks of IQ stream using sequence numbers - automatic bandpass or a wideband lowpass selectable The following named gain stages are available: ATT: -30 to 0 dB, in 10dB steps Known limitations: - setting the sample rate is possible only before the flowgraph has been started 2013-10-19 15:17:19 +00:00			`* Ettus USRP Devices through Ettus UHD library`
add UmTRX to the list of supported devices requires Fairwaves' port of the Ettus UHD library: https://github.com/fairwaves/UHD-Fairwaves 2013-12-10 15:56:14 +00:00			`* Fairwaves UmTRX through Fairwaves' fork of UHD`
update README 2013-05-25 23:07:24 +00:00
update README 2013-06-04 22:15:28 +00:00			`By using the OsmoSDR block you can take advantage of a common software api in`
			`your application(s) independent of the underlying radio hardware.`
update README 2013-05-25 23:07:24 +00:00
update README 2013-06-04 22:15:28 +00:00			`For installation and usage guidelines please read the documentation available`
			`at http://sdr.osmocom.org/trac/wiki/GrOsmoSDR`
update README 2013-05-25 23:07:24 +00:00
grc: move around documentation 2013-08-04 20:28:55 +00:00			`A short excerpt from the wiki:`
update README 2013-05-25 23:07:24 +00:00
update README 2013-06-04 22:15:28 +00:00			`The Gnu Radio block requires a recent gnuradio (>= v3.7) to be installed.`
update README 2013-05-25 23:07:24 +00:00
grc: move around documentation 2013-08-04 20:28:55 +00:00			`Before building the block you have to make sure that all dependencies`
update README 2013-06-04 22:15:28 +00:00			`(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.`
update README 2013-05-25 23:07:24 +00:00
update README 2013-06-04 22:15:28 +00:00			`Please note: prior pulling a new version from git and compiling it,`
			`please do a "make uninstall" first to properly remove the previous version.`
update README 2013-05-25 23:07:24 +00:00
			`Building with cmake:`

			`git clone git://git.osmocom.org/gr-osmosdr`
			`cd gr-osmosdr/`
			`mkdir build`
			`cd build/`
			`cmake ../`
			`make`
			`sudo make install`
			`sudo ldconfig`

make OSMOCOM lowercase 2013-06-08 15:38:18 +00:00			`NOTE: The osmocom blocks will appear under 'Sources' and 'Sinks' categories`
update README 2013-06-04 22:15:28 +00:00			`in GRC menu.`