Skip to content

Commit

Permalink
docs: add supported hardware document
Browse files Browse the repository at this point in the history
resolves #23.
  • Loading branch information
vsergeev committed Jul 17, 2016
1 parent 9889959 commit 4c6de99
Showing 1 changed file with 62 additions and 0 deletions.
62 changes: 62 additions & 0 deletions docs/7.supported-hardware.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Supported Hardware

## Hardware SDR Sources/Sinks

Hardware SDRs source and sink digital I/Q samples through USB, PCI, or other
high speed digital interfaces.

### Sources

* [`RtlSdrSource`](0.reference-manual.md#rtlsdrsource) via [librtlsdr](http://sdr.osmocom.org/trac/wiki/rtl-sdr)
* [`AirspySource`](0.reference-manual.md#airspysource) via [libairspy](https://github.com/airspy/host)
* [`HackRFSource`](0.reference-manual.md#hackrfsource) via [libhackrf](https://github.com/mossmann/hackrf)
* [`SDRplaySource`](0.reference-manual.md#sdrplaysource) via [libmirsdrapi-rsp](http://sdrplay.com/linux.html)

Coming soon:

* `SoapySDRSource` via [SoapySDR](https://github.com/pothosware/SoapySDR)
* [`BladeRFSource`](https://github.com/vsergeev/luaradio/issues/19) via [libbladerf](https://github.com/Nuand/bladeRF)

### Sinks

None to date. All transceivers above planned.

Coming soon:

* `HackRFSink` via [libhackrf](https://github.com/mossmann/hackrf)
* `SoapySDRSink` via [SoapySDR](https://github.com/pothosware/SoapySDR)
* `BladeRFSink` via [libbladerf](https://github.com/Nuand/bladeRF)

## Soundcard SDR Sources/Sinks

Soundcard SDRs source and sink analog I/Q signals through soundcard stereo
line-in and line-out interfaces.

### Sources

Coming soon:

* `PulseAudioSource` via [libpulse](https://freedesktop.org/software/pulseaudio/doxygen/)

### Sinks

* [`PulseAudioSink`](0.reference-manual.md#pulseaudiosink) via [libpulse](https://freedesktop.org/software/pulseaudio/doxygen/)

## File Sources/Sinks

File sources and sinks can also indirectly support SDR hardware by reading or
writing a named pipe, linked to an external utility that interfaces with the
SDR hardware.

### Sources

* [`IQFileSource`](0.reference-manual.md#iqfilesource) for binary I/Q files
* [`RealFileSource`](0.reference-manual.md#realfilesource) for binary real-valued files
* [`WAVFileSource`](0.reference-manual.md#wavfilesource) for WAV files

### Sinks

* [`IQFileSink`](0.reference-manual.md#iqfilesink) for binary I/Q files
* [`RealFileSink`](0.reference-manual.md#realfilesink) for binary real-valued files
* [`WAVFileSink`](0.reference-manual.md#wavfilesink) for WAV files

0 comments on commit 4c6de99

Please sign in to comment.