joachim/openwebrx-clone
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Open source, multi-user SDR receiver software with a web interface
948 Commits 12 Branches 17 Tags 36 MiB
Python 64.4%
JavaScript 24.7%
CSS 4.5%
HTML 3.5%
Shell 2.9%
1258180805
Go to file
Jakob Ketterl 1258180805 update the readme
2020-01-29 20:05:06 +01:00
csdr avoid using preexec_fn in the other places, too 2020-01-17 21:18:02 +01:00
debian update digiham dependency 2020-01-09 19:33:17 +01:00
docker update dependencies in docker 2020-01-25 23:52:20 +01:00
htdocs include digital demods in hash 2020-01-25 23:47:32 +01:00
owrx Fix PlutoSDR support 2020-01-22 21:55:22 +01:00
systemd add systemd; add dependencies 2019-12-08 17:35:37 +01:00
.dockerignore use explicit revisions so i can use the docker build cache 2019-12-30 00:11:27 +01:00
.gitignore switch file loading to pkg_resources 2019-12-08 20:27:58 +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 rtlsdr via soapy to the docker builds; clean up 2020-01-17 12:58:26 +01:00
CHANGELOG.md update changelog, closes #47 2020-01-29 19:58:36 +01:00
config_webrx.py update legal information 2020-01-09 22:24:39 +01:00
LICENSE.txt Create LICENSE.txt 2015-11-29 18:00:35 +01:00
openwebrx.py restructure project for packaging 2019-12-08 17:15:48 +01:00
push.sh add rtlsdr via soapy to the docker builds; clean up 2020-01-17 12:58:26 +01:00
README.md update the readme 2020-01-29 20:05:06 +01:00
sdrhu.py restructure project for packaging 2019-12-08 17:15:48 +01:00
setup.py update legal information 2020-01-09 22:24:39 +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 Raspberries up to the 3B+.

This is based off the Raspbian Lite distribution, so their installation instructions apply.

Please note: I have not updated this to include the Raspberry Pi 4 yet. (It seems to be impossible to build Rasbpian Buster images on x86 hardware right now. Stay tuned!)

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).

Setup tips

If you have any problems installing OpenWebRX, you should check out the Wiki about it, which has a page on the common problems and their solutions.

Sometimes the actual error message is not at the end of the terminal output, you may have to look at the whole output to find it.

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.