openwebrx-clone/README.md

64 lines
2.5 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.
## 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>
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 8888 for the I/Q source,
- 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 13:28:04 +00:00
I would like to maintain a list of online amateur radio receivers on <a href="http://openwebrx.org/">openwebrx.org</a>.
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
If you want to run OpenWebRX on a remote server instead of localhost, do not forget to set *server_hostname* in `config_webrx.py`, or you may get a WebSocket error.
2014-11-30 17:00:53 +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 lower `fft_size`.
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`.
2014-11-29 12:56:56 +00:00
2014-11-29 00:07:47 +00:00
## Todo
Currently, clients use up a lot of bandwidth. This will be improved later.