~vcs-imports/gr-osmosdr/master

« back to all changes in this revision

Viewing changes to README.md

  • Committer: Harald Welte
  • Date: 2023-11-07 20:21:24 UTC
  • Revision ID: git-v1:2fedabec385a91af71468b179f0050f74e17f51e
convert README to markdow; expand/update it slightly

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
gr-osmosdr - generic gnuradio SDR I/O block
 
2
===========================================
 
3
 
 
4
While originally being developed for the
 
5
[OsmoSDR](https://osmocom.org/projects/osmosdr/wiki) hardware, this
 
6
block has become a generic SDR I/O block for a variety of SDR
 
7
hardware, including:
 
8
 
 
9
 * FUNcube Dongle / Pro+ through [gr-funcube](https://github.com/dl1ksv/gr-funcube)
 
10
 * RTL2832U based DVB-T dongles through [librtlsdr](https://osmocom.org/projects/rtl-sdr/wiki)
 
11
 * RTL-TCP spectrum server (see librtlsdr project)
 
12
 * MSi2500 based DVB-T dongles through [libmirisdr](https://gitea.osmocom.org/sdr/libmirisdr)
 
13
 * SDRplay RSP through SDRplay API library
 
14
 * gnuradio .cfile input through libgnuradio-blocks
 
15
 * RFSPACE SDR-IQ, SDR-IP, NetSDR (incl. X2 option), Cloud-IQ, and CloudSDR
 
16
 * AirSpy Wideband Receiver through [libairspy](https://github.com/airspy/airspyone_host)
 
17
 * CCCamp 2015 rad1o Badge through [libhackrf](https://github.com/greatscottgadgets/hackrf)
 
18
 * Great Scott Gadgets HackRF through [libhackrf](https://github.com/greatscottgadgets/hackrf)
 
19
 * Nuand LLC bladeRF through [libbladeRF library](https://www.nuand.com/libbladeRF-doc/)
 
20
 * Ettus USRP Devices through [Ettus UHD library](https://github.com/EttusResearch/uhd)
 
21
 * Fairwaves UmTRX through [Fairwaves' module for UHD](https://github.com/fairwaves/UHD-Fairwaves)
 
22
 * Fairwaves XTRX through [libxtrx](https://github.com/myriadrf/libxtrx)
 
23
 * Red Pitaya SDR transceiver <http://bazaar.redpitaya.com>
 
24
 * FreeSRP through [libfreesrp](https://github.com/myriadrf/libfreesrp)
 
25
 
 
26
By using the gr-osmosdr block you can take advantage of a common software API in
 
27
your application(s) independent of the underlying radio hardware.
 
28
 
 
29
Homepage + Documentation
 
30
------------------------
 
31
 
 
32
For installation and usage guidelines please read the documentation available
 
33
at <https://osmocom.org/projects/gr-osmosdr/wiki>
 
34
 
 
35
For the impatient :) a short excerpt:
 
36
 
 
37
The Gnu Radio block requires a recent gnuradio (>= v3.7) to be installed.
 
38
 
 
39
Before building the block you have to make sure that all the dependencies
 
40
(see list of supported devices above) you are intend to work with are
 
41
properly installed. The build system of gr-osmosdr will recognize them and
 
42
enable specific source/sink components thereafter.
 
43
 
 
44
Please note: prior pulling a new version from git and compiling it,
 
45
please do a "make uninstall" first to properly remove the previous version.
 
46
 
 
47
Building with cmake:
 
48
 
 
49
git clone https://gitea.osmocom.org/sdr/gr-osmosdr
 
50
cd gr-osmosdr/
 
51
mkdir build
 
52
cd build/
 
53
cmake ../
 
54
make
 
55
sudo make install
 
56
sudo ldconfig
 
57
 
 
58
NOTE: The osmocom blocks will appear under 'Sources' and 'Sinks' categories
 
59
in GRC menu.
 
60
 
 
61
Mailing List
 
62
------------
 
63
 
 
64
Discussions related to libosmocore are happening on the
 
65
osmocom-sdr@lists.osmocom.org mailing list, please see
 
66
<https://lists.osmocom.org/mailman/listinfo/osmocom-sdr> for subscription
 
67
options and the list archive.
 
68
 
 
69
Please observe the [Osmocom Mailing List
 
70
Rules](https://osmocom.org/projects/cellular-infrastructure/wiki/Mailing_List_Rules)
 
71
when posting.
 
72
 
 
73
 
 
74
Issue tracker
 
75
-------------
 
76
 
 
77
We are using the Osmocom redmine at <https://osmocom.org/projects/gr-osmosdr/issues>
 
78
 
 
79
Contributing
 
80
------------
 
81
 
 
82
We maintain our source code in a self-hosted instance of gitea at
 
83
<https://gitea.osmocom.org/sdr/gr-osmosdr>. You can send pull requests there, or send
 
84
patches the old-fashioned way (git send-email) to the above-mentioned mailing list.