openwebrx-clone/README.md

85 lines
4.3 KiB
Markdown
Raw Normal View History

2014-11-29 00:07:10 +00:00
OpenWebRX
2014-11-28 20:55:31 +00:00
=========
2014-11-29 00:07:10 +00:00
OpenWebRX is a multi-user SDR receiver software with a web interface.
2014-11-29 17:47:50 +00:00
![OpenWebRX](/screenshot.png?raw=true)
2014-11-29 00:07:10 +00:00
It has the following features:
- <a href="https://github.com/simonyiszk/csdr">libcsdr</a> based demodulators (AM/FM/SSB),
2014-11-29 00:10:36 +00:00
- filter passband can be set from GUI,
2014-11-29 00:07:10 +00:00
- waterfall display can be shifted back in time,
2014-11-29 00:10:36 +00:00
- it extensively uses HTML5 features like WebSocket, Web Audio API, and &lt;canvas&gt;.
2014-11-29 00:07:10 +00:00
- it works in Google Chrome, Chromium (above version 37) and Mozilla Firefox (above version 28),
- currently only supports RTL-SDR, but other SDR hardware may be easily added.
2015-09-30 14:06:30 +00:00
**News (2015-08-18)**
- My BSc. thesis written on OpenWebRX is <a href="http://openwebrx.org/bsc-thesis.pdf">available here.</a>
- Several bugs were fixed to improve reliability and stability.
- OpenWebRX now supports compression of audio and waterfall stream, so the required network uplink bandwidth has been decreased from 2 Mbit/s to about 200 kbit/s per client! (Measured with the default settings. It is also dependent on `fft_size`.)
2015-08-17 18:53:48 +00:00
- OpenWebRX now uses <a href="https://github.com/simonyiszk/csdr#sdrjs">sdr.js</a> (*libcsdr* compiled to JavaScript) for some client-side DSP tasks.
2015-08-18 15:22:49 +00:00
- Receivers can now be listed on <a href="http://sdr.hu/">sdr.hu</a>.
- License for OpenWebRX is now Affero GPL v3.
**News (2015-02-14)**
2015-09-30 14:06:30 +00:00
- The DDC in *csdr* has been hand-optimized for ARM NEON, so it runs 3× faster on the Raspberry Pi than before.
2016-01-23 23:03:08 +00:00
- Also we use *ncat* instead of *rtl_mus*, and it is 3× faster.
2015-09-30 14:06:30 +00:00
- OpenWebRX now supports URLs like: http://localhost:8073/#freq=145555000,mod=usb
- UI improvements, thanks to John Seamons and Gnoxter.
2015-09-30 14:06:30 +00:00
> When upgrading OpenWebRX, please make sure that you upgrade *csdr*, and install the new (optional) dependency *ncat*!
2016-01-23 23:03:08 +00:00
2016-02-14 17:23:34 +00:00
## OpenWebRX servers on sdr.hu
[sdr.hu](http://sdr.hu) is a site which lists the active, public OpenWebRX receivers. Your receiver [can also be part of it](http://sdr.hu/openwebrx), if you want.
![sdr.hu](/screenshot-sdrhu.png?raw=true)
2015-09-30 14:06:30 +00:00
2014-11-29 00:07:10 +00:00
## Setup
2014-11-29 17:50:25 +00:00
OpenWebRX currently requires Linux and python 2.7 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
2014-11-29 00:07:10 +00:00
- <a href="https://github.com/simonyiszk/csdr">libcsdr</a>
- <a href="http://sdr.osmocom.org/trac/wiki/rtl-sdr">rtl-sdr</a>
2016-01-23 23:03:08 +00:00
- ncat (On Debian/Ubuntu, it is in the *nmap* package).
> By the way, *nmap* is tool commonly used for auditing network security, and it is not used by OpenWebRX in any way. We need it because the *ncat* command is packaged with it.
>
> *ncat* is a better *netcat* alternative, which is used by OpenWebRX for internally distributing the I/Q data stream. It also solves the problem of having different versions of *netcat* on different Linux distributions, which are not compatible by their command-line arguments.
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:
python openwebrx.py
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
2014-11-29 00:07:10 +00:00
- port 4951 for the multi-user I/Q server.
Now the next step is to customize the parameters of your server in `config_webrx.py`.
2014-11-29 00:13:15 +00:00
Actually, if you do something cool with OpenWebRX (or just have a problem), 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
2014-11-29 12:56:56 +00:00
## Configuration tips
2015-09-30 14:06:30 +00:00
Now we have a %[Wiki](https://github.com/simonyiszk/openwebrx/wiki) with some how-tos. However, some quick tips:
2014-11-29 12:56:56 +00:00
2015-09-30 14:06:30 +00:00
If you want to run OpenWebRX on a remote server instead of localhost, do not forget to set *server_hostname* in `config_webrx.py`.
2014-11-30 17:00:53 +00:00
2015-09-30 14:06:30 +00:00
DSP CPU usage can be fine-tuned in `plugins/dsp/csdr/plugin.py`: you can set transition bandwidths higher (thus degrade filter performance by decreasing the length of the kernel, but also decrease CPU usage), and also set `fft_size` lower.
2014-11-30 17:00:53 +00:00
2014-11-30 18:22:21 +00:00
If you want a chat-box to the top of the page, <a href="https://gist.github.com/ha7ilm/15c4c5e4c80cef9b3144">here is a snippet</a> for you to include in `config_webrx.py`.