openwebrx-clone/README.md

53 lines
2.0 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.
2020-03-07 19:53:17 +00:00
![OpenWebRX](https://www.openwebrx.de/gfx/openwebrx-screenshot.png)
2014-11-29 00:07:10 +00:00
It has the following features:
2020-01-29 19:05:06 +00:00
- [csdr](https://github.com/jketterl/csdr) based demodulators (AM/FM/SSB/CW/BPSK31/BPSK63)
- 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
2020-01-29 19:05:06 +00:00
- currently supports RTL-SDR, HackRF, SDRplay, AirSpy, LimeSDR, PlutoSDR
2019-06-30 13:57:32 +00:00
- Multiple SDR devices can be used simultaneously
2020-01-29 19:05:06 +00:00
- [digiham](https://github.com/jketterl/digiham) based demodularors (DMR, YSF, Pocsag)
2019-06-30 13:57:32 +00:00
- [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-06-30 13:57:32 +00:00
## Setup
The following methods of setting up a receiver are currently available:
- Raspberry Pi SD card images
- Debian repository
- Docker images
- Manual installation
2016-01-23 23:03:08 +00:00
2020-03-05 21:03:19 +00:00
Please checkout the [setup guide on the wiki](https://github.com/jketterl/openwebrx/wiki/Setup-Guide) for more details
on the respective methods.
## Community
If you have trouble setting up or configuring your receiver, you have some great idea you want to see implemented, or
you just generally want to have some OpenWebRX-related chat, come visit us over on
[our groups.io group](https://groups.io/g/openwebrx).
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-11-29 16:55:45 +00:00
## Licensing
2020-01-29 19:11:26 +00:00
OpenWebRX is available under Affero GPL v3 license
2020-03-07 20:23:08 +00:00
([summary](https://tldrlegal.com/license/gnu-affero-general-public-license-v3-(agpl-3.0))).
2015-11-29 16:55:45 +00:00
2020-01-29 19:11:26 +00:00
OpenWebRX is also available under a commercial license on request. Please contact me at the address
*<randras@sdr.hu>* for licensing options.