Open source, multi-user SDR receiver software with a web interface
Go to file
Jakob Ketterl d1dc14d9e5 don't put debian files in docker builds 2020-02-17 15:03:39 +01:00
csdr re-wire the audio output to "null" - thanks to @dl9rdz 2020-02-17 12:06:13 +01:00
debian create and use custom user on debian install 2020-02-17 15:03:20 +01:00
docker use more cpu cores 2020-02-16 12:19:49 +01:00
htdocs style the input 2020-02-01 22:25:16 +01:00
owrx re-wire the audio output to "null" - thanks to @dl9rdz 2020-02-17 12:06:13 +01:00
systemd create and use custom user on debian install 2020-02-17 15:03:20 +01:00
.dockerignore don't put debian files in docker builds 2020-02-17 15:03:39 +01:00
.gitignore switch file loading to pkg_resources 2019-12-08 20:27:58 +01:00
CHANGELOG.md add soapyremote source 2020-02-09 13:59:37 +01:00
LICENSE.txt Create LICENSE.txt 2015-11-29 18:00:35 +01:00
README.md more readme updates 2020-01-29 20:11:26 +01:00
bands.json add scaffolding for pocsag decoding 2020-01-06 22:08:17 +01:00
bookmarks.json add scaffolding for pocsag decoding 2020-01-06 22:08:17 +01:00
build.sh add soapy remote to docker build, too 2020-02-09 15:23:17 +01:00
config_webrx.py update legal information 2020-01-09 22:24:39 +01:00
openwebrx.py restructure project for packaging 2019-12-08 17:15:48 +01:00
push.sh add soapy remote to docker build, too 2020-02-09 15:23:17 +01:00
sdrhu.py update copyright date 2020-02-16 11:49:20 +01:00
setup.py refactor service / schedule code in preparation for alternate schedulers 2020-01-17 22:46:01 +01:00

README.md

OpenWebRX

OpenWebRX is a multi-user SDR receiver software with a web interface.

OpenWebRX

It has the following features:

  • csdr based demodulators (AM/FM/SSB/CW/BPSK31/BPSK63)
  • filter passband can be set from GUI
  • it extensively uses HTML5 features like WebSocket, Web Audio API, and Canvas
  • it works in Google Chrome, Chromium and Mozilla Firefox
  • currently supports RTL-SDR, HackRF, SDRplay, AirSpy, LimeSDR, PlutoSDR
  • Multiple SDR devices can be used simultaneously
  • digiham based demodularors (DMR, YSF, Pocsag)
  • dsd based demodulators (D-Star, NXDN)
  • wsjt-x based demodulators (FT8, FT4, WSPR, JT65, JT9)

Setup

Raspberry Pi SD Card Images

Probably the quickest way to get started is to download the latest Raspberry Pi SD Card Image. It contains all the depencencies out of the box, and should work on all Raspberry Pis. It is based off the Raspbian Lite distribution, so their installation instructions apply.

You can find the latest images here. You can also checkout the nightly folder, which has the most recent builds, albeit untested.

Once you have booted a Raspberry with the SD Card, it will appear in your network with the hostname "openwebrx", which should make it available as https://openwebrx/ on most networks. This may vary depending on your specific setup.

For Digital voice, the minimum requirement right now seems to be a Rasbperry Pi 3B+. I would like to work on optimizing this for lower specs, but at this point I am not sure how much can be done.

Docker Images

For those familiar with docker, I am providing recent builds and Releases for both x86 and arm processors on the Docker hub. You can find a short introduction there.

Manual Installation

OpenWebRX currently requires Linux and python >= 3.6 to run.

First you will need to install the dependencies:

Optional dependencies if you want to be able to listen do digital voice:

Optional dependency if you want to decode WSJT-X modes:

Detailed installation instructions in the Wiki

After cloning this repository and connecting an RTL-SDR dongle to your computer, you can run the server:

./openwebrx.py

You can now open the GUI at http://localhost:8073.

Now the next step is to customize the parameters of your server in config_webrx.py.

Actually, if you do something cool with OpenWebRX, please drop me a mail:
Jakob Ketterl, DD5JFK <dd5jfk@darc.de>

Usage tips

You can zoom the waterfall display by the mouse wheel. You can also drag the waterfall to pan across it.

The filter envelope can be dragged at its ends and moved around to set the passband.

However, if you hold down the shift key, you can drag the center line (BFO) or the whole passband (PBS).

Licensing

OpenWebRX is available under Affero GPL v3 license (summary.

OpenWebRX is also available under a commercial license on request. Please contact me at the address <randras@sdr.hu> for licensing options.