openwebrx-clone/README.md

OpenWebRX
=========

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

![OpenWebRX](/screenshot.jpg?raw=true)

It has the following features:

- <a href="https://github.com/simonyiszk/csdr">libcsdr</a> based demodulators (AM/FM/SSB),
- filter passband can be set from GUI,
- waterfall display can be shifted back in time,
- it extensively uses HTML5 features like WebSocket, Web Audio API, and &lt;canvas&gt;.
- 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

OpenWebRX currently requires a Linux machine to run. 

First you will need to install the dependencies:

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

Please note that the server is also listening on the following ports (on localhost only):

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

Actually, if you do something cool with OpenWebRX (or just have a problem), please drop me a mail:  
*Andras Retzler, HA7ILM &lt;randras@sdr.hu&gt;*

I would like to maintain a list of online amateur radio receivers on <a href="http://openwebrx.org/">openwebrx.org</a>.

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

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

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

## Todo

Currently, clients use up a lot of bandwidth. This will be improved later.
initial commit 2014-11-29 00:07:10 +00:00			`OpenWebRX`
Initial commit 2014-11-28 20:55:31 +00:00			`=========`

initial commit 2014-11-29 00:07:10 +00:00			`OpenWebRX is a multi-user SDR receiver software with a web interface.`

			`![OpenWebRX](/screenshot.jpg?raw=true)`

			`It has the following features:`

			`- <a href="https://github.com/simonyiszk/csdr">libcsdr</a> based demodulators (AM/FM/SSB),`
readme fixes 2014-11-29 00:10:36 +00:00			`- filter passband can be set from GUI,`
initial commit 2014-11-29 00:07:10 +00:00			`- waterfall display can be shifted back in time,`
readme fixes 2014-11-29 00:10:36 +00:00			`- it extensively uses HTML5 features like WebSocket, Web Audio API, and <canvas>.`
initial commit 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`

			`OpenWebRX currently requires a Linux machine to run.`

			`First you will need to install the dependencies:`
initial commit 2014-11-29 00:07:47 +00:00
initial commit 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>.`

readme fixes 2014-11-29 00:12:17 +00:00			`Please note that the server is also listening on the following ports (on localhost only):`
initial commit 2014-11-29 00:07:47 +00:00
initial commit 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`.

readme fixes 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:`
readme fixes 2014-11-29 00:13:38 +00:00			`Andras Retzler, HA7ILM <randras@sdr.hu>`
readme fixes 2014-11-29 00:13:15 +00:00
readme fix 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>.`
initial commit 2014-11-29 00:07:10 +00:00
			`## Usage tips`

readme fixes 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.`
readme tips fix 2014-11-29 13:05:39 +00:00
initial commit 2014-11-29 00:07:47 +00:00			`The filter envelope can be dragged at its ends and moved around to set the passband.`
initial commit 2014-11-29 00:07:10 +00:00
readme fixes 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).`
initial commit 2014-11-29 00:07:47 +00:00
added ddc_transition_bw() 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.

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

initial commit 2014-11-29 00:07:47 +00:00			`## Todo`

			`Currently, clients use up a lot of bandwidth. This will be improved later.`