K2HMH
/
nrsc5-dui
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added notes for SDRPlay compilation and operation.

This commit is contained in:
Mark J. Fine 2022-12-08 11:34:57 -05:00
parent b65a8828be
commit ded176ae46
1 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -1,4 +1,4 @@
NRSC5-DUI is a graphical interface for [nrsc5](https://github.com/theori-io/nrsc5). It makes it easy to play your favorite FM HD radio stations using an RTL-SDR dongle. It will also display weather radar and traffic maps found on most iHeart radio stations.
NRSC5-DUI is a graphical interface for [nrsc5](https://github.com/theori-io/nrsc5). It makes it easy to play your favorite FM HD radio stations using an RTL-SDR or SDRPlay dongle. It will also display weather radar and traffic maps found on most iHeart radio stations.
This version is really a fork of a fork of the original nrsc5-gui: The first was developed by [cmnybo](https://github.com/cmnybo/nrsc5-gui) and subsequently modified by [zefie](https://github.com/zefie/nrsc5-gui). It merges the features of the former to the architecture of the latter, while adding several additional control and display features.
@ -16,13 +16,13 @@ The following programs are required to run NRSC5-DUI
* [urllib3](https://pypi.org/project/urllib3)
* [pyOpenSSL](https://pypi.org/project/pyOpenSSL)
* [musicbrainzngs](https://pypi.org/project/musicbrainzngs)
* [nrsc5](https://github.com/theori-io/nrsc5)
* [nrsc5 for RTL_SDR only](https://github.com/theori-io/nrsc5) or [nrsc5 for SDRPlay](https://github.com/fventuri/nrsc5)
It is also assumed you have a fully operational Gtk3 environment installed from [Homebrew](https://brew.sh/), if running on macOS.
# Setup
1. Install the latest version of Python 3.9, PyGObject, Pillow, and other python dependencies.
2. Compile and install nrsc5.
2. Compile and install nrsc5. If using an SDRPlay, you must compile and install the version provided by [fventuri](https://github.com/fventuri/nrsc5).
3. Install nrsc5-dui files in a directory where you have write permissions.
The configuration and resource directories will be created in a new `cfg` and `res` directory under where nrsc5-dui.py resides. Similarly, an `aas` directory will be created for downloaded files and a `map` directory will be created to store weather & traffic maps.
@ -39,7 +39,7 @@ One of the goals of this project was to provide a stand-alone, cross-platform ap
The bottom line is that some have had success installing and running the application and it's dependencies under specific MinGW environments such as WSL2, but may still require the dongle to operate under RTL_TCP and not directly via NRSC5.EXE. Some legacy Windows executables and libraries have been provided in the `bin` directory for those that wish to experiment further. Feel free to use them at your own risk.
# Usage
Please ensure your RTL-SDR dongle is first connected to an available USB port. Then, from the terminal, start nrsc5-dui by entering:
Please ensure your RTL-SDR dongle or SDRPlay is first connected to an available USB port. Then, from the terminal, start nrsc5-dui by entering:
`python3 nrsc5-dui.py`
or something like:
`python3 nrsc5-dui.py /usr/local/bin/`
@ -47,10 +47,19 @@ to include the path to nrsc5 when using scripts (like Apple Script) that seeming
## Settings
You may first change some optional parameters of how nrsc5 works from the Settings tab in nrsc5-dui:
Set the radio you are using to either RTL_SDR or SDRPlay.
Set the gain to Auto, or optionally enter an RF gain in dB that has known to work well for some stations.
Enter a PPM correction value if your RTL-SDR dongle has an offset.
If using an RTL_SDR:
Enter the number of the desired device if you have more than one RTL-SDR dongle.
Enter the IP address that rtl_tcp is listening to and check the Enabled box if you are using a remote RTL-SDR.
Enter the number of the desired device if you have more than one RTL-SDR dongle.
If using an SDRPlay:
Enter the serial number of the SDRPlay.
Enter the antenna port used by the SDRPlay.
Other settings:
Check `Log to file` to enable writing debug information from nrsc5 to nrsc5.log.
Check `Download Album Art` to enable automated downloading of album art from MusicBrainz.
Check `Include Station Art` to display album art that is generated by the station in addition to downloading from MusicBrainz.