openwebrx-clone/README.md

OpenWebRX
=========

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

![OpenWebRX](/screenshot.png?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 supports RTL-SDR and HackRF; other SDR hardware may be easily added.

**News:**
- 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`.)
- OpenWebRX now uses <a href="https://github.com/simonyiszk/csdr#sdrjs">sdr.js</a> (*libcsdr* compiled to JavaScript) for some client-side DSP tasks. 
- Receivers can now be listed on <a href="http://sdr.hu/">sdr.hu</a>.
- License for OpenWebRX is now Affero GPL v3. 

## Setup

OpenWebRX currently requires Linux and python 2.7 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;*

## 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 <a href="https://github.com/simonyiszk/openwebrx/wiki">Wiki</a> about it, where there is a page on the <a href="https://github.com/simonyiszk/openwebrx/wiki/Common-problems-and-their-solutions">common problems and their solutions</a>.

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

If you want to run OpenWebRX on a remote server instead of localhost, do not forget to set *server_hostname* in `config_webrx.py`.
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.`

screenshot fix, tnx hg2ecz 2014-11-29 17:47:50 +00:00			`![OpenWebRX](/screenshot.png?raw=true)`
initial commit 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),`
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),`
Experimental HackRF support (updated README.md) 2015-10-11 00:09:49 +00:00			`- currently supports RTL-SDR and HackRF; other SDR hardware may be easily added.`
initial commit 2014-11-29 00:07:10 +00:00
many fixes and new features like IMA ADPCM compression 2015-08-17 18:32:58 +00:00			`News:`
			`- 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`.)
fixed named anchor in readme 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.`
fix comments & readme 2015-08-18 15:22:49 +00:00			`- Receivers can now be listed on <a href="http://sdr.hu/">sdr.hu</a>.`
many fixes and new features like IMA ADPCM compression 2015-08-17 18:32:58 +00:00			`- License for OpenWebRX is now Affero GPL v3.`

initial commit 2014-11-29 00:07:10 +00:00			`## Setup`

insert shebang, fix readme 2014-11-29 17:50:25 +00:00			`OpenWebRX currently requires Linux and python 2.7 to run.`
initial commit 2014-11-29 00:07:10 +00:00
			`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
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
Update README.md 2015-10-11 16:50:12 +00:00			`## Setup tips`
added ddc_transition_bw() 2014-11-29 12:56:56 +00:00
Update README.md 2015-10-11 16:50:12 +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, where there is a page on the <a href="https://github.com/simonyiszk/openwebrx/wiki/Common-problems-and-their-solutions">common problems and their solutions</a>.`
added ddc_transition_bw() 2014-11-29 12:56:56 +00:00
Update README.md 2015-10-11 16:50:12 +00:00			`Sometimes the actual error message is not at the end of the terminal output, you may have to go back in it to find it.`
readme fix 2014-11-30 17:00:53 +00:00
Update README.md 2015-10-11 16:50:12 +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`.