Skip to content

trulyjoel/yellowShoes

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

81 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

yellowShoes

nrsc5 (HD FM) radio player - web based, mobile friendly

Description

If you have an SDR Dongle that can receive NRSC-5 digital radio stations, you can use yellowShoes as the playback and control UI (User-interface). Navigate to your yellowShoes instance from a decent web browser, and you're good to go!

Requirements

  • You must have nrsc5 compiled and installed. The nrsc5 binary must be in your PATH.
  • Optional Requirement: If you want mp3 playback (or have IOS devices), you will need lame encoder binary in your PATH. See IOS Playback section.

Album Art

Album art has been enabled as an experimental feature. Album Art tiles works on mobile device lock screens and desktop browsers.

Enabling this option will make your backend initiate network traffic to search and find cover/album art images. The results we find may be inaccurate or even inappropriate.

Builds that support Album Art are kept here.

Enabling Album Art

You must launch yellowShoes with -enableAlbumArt to enable album art.

$ ./yellowShoes -enableAlbumArt

Then navigate to Settings -> Cover Art and enable.

Setup

  • Setup nrsc5

  • Download the yellowShoes binary suitable for your Operating System and Platform from bin folder of the Album_Art branch.

  • Launch the binary you downloaded:

$ ./yellowShoes -enableAlbumArt 
yellowShoes Ver 4.0a Copyright (C) Evuraan <[email protected]>
This program comes with ABSOLUTELY NO WARRANTY.
Using temp dir: /tmp, port: 8113

Windows

PS C:\temp\yellowShoes\bin> .\yellowShoes-win-amd64.exe
  • Launch a browser and navigate to http:https://<Your_Address>:Port/main to launch the UI. Example: http:https://192.168.1.134:8113/main

Usage

Default port is 8113. If you wish to specify an alternate port or temp directory, use the appropriate input arguments:

$ ./yellowShoes -h
yellowShoes Ver 4.0a Copyright (C) Evuraan <[email protected]>
This program comes with ABSOLUTELY NO WARRANTY.
Usage of ./yellowShoes:
  -enableAlbumArt
    	enable album art
  -port string
    	port to use (default "8113")
  -tempFolder string
    	temp folder with write access to use (default "/tmp")
  -v	print version information and exit

Settings

Optional: rtl_tcp

If you have rtl_tcp running in your network, yellowShoes can connect to it - navigate to the settings section to set it up.

yellowShoes and Docker

You can run yellowShoes inside a Docker container. See the Docker section.

Routing/Proxying

Below example is how I pegged yellowShoes behind Apache:

<Location /hdFm/>
ProxyPass  http:https://192.168.1.14:8113/
ProxyPassReverse http:https://192.168.1.14:8113/
Order deny,allow
Allow from all
Options -Indexes
</Location>

This would allow proto:https://myapp.dev/hdFm/main externally.

Screenshots

References

Thanks:

Packages

No packages published

Languages

  • HTML 55.5%
  • Go 42.5%
  • Shell 1.1%
  • Dockerfile 0.9%