openwebrx-clone/README.md

134 lines
7.2 KiB
Markdown
Raw Normal View History

2014-11-29 00:07:10 +00:00
OpenWebRX
2014-11-28 20:55:31 +00:00
=========
[:floppy_disk: Setup guide for Ubuntu](http://blog.sdr.hu/2015/06/30/quick-setup-openwebrx.html) | [:blue_book: Knowledge base on the Wiki](https://github.com/simonyiszk/openwebrx/wiki/) | [:earth_americas: Receivers on SDR.hu](http://sdr.hu/)
2014-11-29 00:07:10 +00:00
OpenWebRX is a multi-user SDR receiver software with a web interface.
![OpenWebRX](http://blog.sdr.hu/images/openwebrx/screenshot.png)
2014-11-29 00:07:10 +00:00
It has the following features:
2019-06-30 13:57:32 +00:00
- [csdr](https://github.com/simonyiszk/csdr) based demodulators (AM/FM/SSB/CW/BPSK31),
2014-11-29 00:10:36 +00:00
- filter passband can be set from GUI,
2019-06-30 13:57:32 +00:00
- 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
- Multiple SDR devices can be used simultaneously
- [digiham](https://github.com/jketterl/digiham) based demodularors (DMR, YSF)
- [dsd](https://github.com/f4exb/dsdcc) based demodulators (D-Star, NXDN)
2019-07-21 16:38:54 +00:00
- [wsjt-x](https://physics.princeton.edu/pulsar/k1jt/wsjtx.html) based demodulators (FT8, FT4, WSPR, JT65, JT9)
2019-09-13 21:14:44 +00:00
**News (2019-09-13 by DD5JFK)**
- New set of APRS-related features
- Decode Packet transmissions using [direwolf](https://github.com/wb2osz/direwolf) (1k2 only for now)
- APRS packets are mostly decoded and shown both in a new panel and on the map
- APRS is also available as a background service
- direwolfs I-gate functionality can be enabled, which allows your receiver to work as a receive-only I-gate for the APRS network in the background
- Demodulation for background services has been optimized to use less total bandwidth, saving CPU
- More metrics have been added; they can be used together with collectd and its curl_json plugin for now, with some limitations.
2019-07-21 16:38:54 +00:00
**News (2019-07-21 by DD5JFK)**
- Latest Features:
2019-07-21 16:40:00 +00:00
- More WSJT-X modes have been added, including the new FT4 mode
2019-07-21 16:38:54 +00:00
- I started adding a bandplan feature, the first thing visible is the "dial" indicator that brings you right to the dial frequency for digital modes
- fixed some bugs in the websocket communication which broke the map
2019-06-30 13:57:32 +00:00
2019-07-13 16:59:06 +00:00
**News (2019-07-13 by DD5JFK)**
- Latest Features:
- FT8 Integration (using wsjt-x demodulators)
- New Map Feature that shows both decoded grid squares from FT8 and Locations decoded from YSF digital voice
- New Feature report that will show what functionality is available
- There's a new Raspbian SD Card image available (see below)
2019-06-30 13:57:32 +00:00
**News (2019-06-30 by DD5JFK)**
- I have done some major rework on the openwebrx core, and I am planning to continue adding more features in the near future. Please check this place for updates.
- My work has not been accepted into the upstream repository, so you will need to chose between my fork and the official version.
- I have enabled the issue tracker on this project, so feel free to file bugs or suggest enhancements there!
- This version sports the following new and amazing features:
- Support of multiple SDR devices simultaneously
- Support for multiple profiles per SDR that allow the user to listen to different frequencies
- Support for digital voice decoding
- Feature detection that will disable functionality when dependencies are not available (if you're missing the digital buttons, this is probably why)
- Raspbian SD Card Images and Docker builds available (see below)
- I am currently working on the feature set for a stable release, but you are more than welcome to test development versions!
> When upgrading OpenWebRX, please make sure that you also upgrade *csdr* and *digiham*!
2019-06-30 13:57:32 +00:00
## OpenWebRX servers on SDR.hu
2014-11-29 00:07:10 +00:00
2019-06-30 13:57:32 +00:00
[SDR.hu](http://sdr.hu) is a site which lists the active, public OpenWebRX servers. Your receiver [can also be part of it](http://sdr.hu/openwebrx), if you want.
2019-06-30 13:57:32 +00:00
![sdr.hu](http://blog.sdr.hu/images/openwebrx/screenshot-sdrhu.png)
2015-09-30 14:06:30 +00:00
2019-06-30 13:57:32 +00:00
## Setup
2019-06-30 13:57:32 +00:00
### Raspberry Pi SD Card Images
2019-07-13 16:59:06 +00:00
Probably the quickest way to get started is to download the [latest Raspberry Pi SD Card Image](https://s3.eu-central-1.amazonaws.com/de.dd5jfk.openwebrx/2019-07-13-OpenWebRX-full.zip). It contains all the depencencies out of the box, and should work on all Raspberries up to the 3B+.
2016-01-23 23:03:08 +00:00
2019-06-30 13:57:32 +00:00
This is based off the Raspbian Lite distribution, so [their installation instructions](https://www.raspberrypi.org/documentation/installation/installing-images/) apply.
2016-02-14 17:23:34 +00:00
2019-06-30 13:57:32 +00:00
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!)
2019-06-30 13:57:32 +00:00
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 http://openwebrx:8073/ on most networks. This may vary depending on your specific setup.
2015-09-30 14:06:30 +00:00
2019-06-30 13:57:32 +00:00
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](https://hub.docker.com/r/jketterl/openwebrx). You can find a short introduction there.
### Manual Installation
2014-11-29 00:07:10 +00:00
2019-06-30 13:57:32 +00:00
OpenWebRX currently requires Linux and python 3 to run.
2014-11-29 00:07:10 +00:00
First you will need to install the dependencies:
2014-11-29 00:07:47 +00:00
2019-06-30 13:57:32 +00:00
- [csdr](https://github.com/simonyiszk/csdr)
- [rtl-sdr](http://sdr.osmocom.org/trac/wiki/rtl-sdr)
Optional Dependencies if you want to be able to listen do digital voice:
- [digiham](https://github.com/jketterl/digiham)
- [dsd](https://github.com/f4exb/dsdcc)
2014-11-29 00:07:10 +00:00
2019-07-21 16:38:54 +00:00
Optional Dependency if you want to decode WSJT-X modes:
- [wsjt-x](https://physics.princeton.edu/pulsar/k1jt/wsjtx.html)
2014-11-29 00:07:10 +00:00
After cloning this repository and connecting an RTL-SDR dongle to your computer, you can run the server:
./openwebrx.py
2019-07-21 16:38:54 +00:00
2014-11-29 00:07:10 +00:00
You can now open the GUI at <a href="http://localhost:8073">http://localhost:8073</a>.
2014-11-29 00:12:17 +00:00
Please note that the server is also listening on the following ports (on localhost only):
2014-11-29 00:07:47 +00:00
2019-06-30 13:57:32 +00:00
- ports 4950 to 4960 for the multi-user I/Q servers.
2014-11-29 00:07:10 +00:00
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:
2014-11-29 00:13:38 +00:00
*Andras Retzler, HA7ILM &lt;randras@sdr.hu&gt;*
2014-11-29 00:13:15 +00:00
2014-11-29 00:07:10 +00:00
## Usage tips
2014-11-29 13:09:03 +00:00
You can zoom the waterfall display by the mouse wheel. You can also drag the waterfall to pan across it.
2014-11-29 13:05:39 +00:00
2014-11-29 00:07:47 +00:00
The filter envelope can be dragged at its ends and moved around to set the passband.
2014-11-29 00:07:10 +00:00
2014-11-29 13:09:03 +00:00
However, if you hold down the shift key, you can drag the center line (BFO) or the whole passband (PBS).
2014-11-29 00:07:47 +00:00
2015-10-11 16:50:12 +00:00
## Setup tips
2014-11-29 12:56:56 +00:00
2015-10-11 16:52:45 +00:00
If you have any problems installing OpenWebRX, you should check out the <a href="https://github.com/simonyiszk/openwebrx/wiki">Wiki</a> about it, which has a page on the <a href="https://github.com/simonyiszk/openwebrx/wiki/Common-problems-and-their-solutions">common problems and their solutions</a>.
2014-11-29 12:56:56 +00:00
2015-10-11 16:51:37 +00:00
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.
2014-11-30 17:00:53 +00:00
2015-11-29 16:55:45 +00:00
## Licensing
2015-11-29 16:59:12 +00:00
OpenWebRX is available under Affero GPL v3 license (<a href="https://tldrlegal.com/license/gnu-affero-general-public-license-v3-(agpl-3.0)">summary</a>).
2015-11-29 16:55:45 +00:00
OpenWebRX is also available under a commercial license on request. Please contact me at the address *&lt;randras@sdr.hu&gt;* for licensing options.