Skip to content

Latest commit

 

History

History
65 lines (45 loc) · 3.31 KB

README.md

File metadata and controls

65 lines (45 loc) · 3.31 KB
Raw

MagicMirror² Module MMM-FSAPI

A module for your MagicMirror² that shows what is playing on your Frontier Silicon powered radio. Examples of such devices are in the following list: https://github.com/cweiske/frontier-silicon-firmwares

Based on the source it will show some media information. For Spotify album art, song name, artist and album name are shown. For DAB and FM the image will be retrieved using the RadioDNS service and the song information from the device itself (witch is sometimes garbage for FM).

Example Spotify Example DAB

Installation

1. Execute the following commands to install the module:

cd ~/MagicMirror/modules # navigate to module folder
git clone https://github.com/MarcLandis/MMM-FSAPI # clone this repository
cd MMM-FSAPI
npm install # install dependencies

2. Then, add the following into the modules section of your config/config.js file:

{
    module: 'MMM-MMM-FSAPI',
    position: 'top_right',
    config: {
        // See 'Configuration options' for more information.
    }
},

Update

Execute the following commands to install the module:

cd ~/MagicMirror/modules/MMM-FSAPI
git pull
npm install

Configuration options

The following properties can be configured:

Option Description
ip The IP address of the device.
pin The PIN for the API. It defaults to 1234.

Default value: "1234"
updateInterval The interval in seconds the API is fetched. Minimum is 2.

Default value: 10
alwaysShowAlbumArt Show a generic album art image if non could be retrieved from the API.

Possible values: true or false
Default value: false
isoCountryCode Fallback to this country code for retrieving the RadioDNS data.

Possible values: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
showPI Show the "Programme Identification Code" as 4-digit hexadecimal number.

Possible values: true or false
Default value: false

Fallback station images

As many FM and DAB stations in Germany won't return information via RadioDNS anymore it is now possible to manually add station images under ~/MagicMirror/modules/MMM-FSAPI/images/stations/

The name of the image is the Programme Identification Code as 4-digit hexadecimal number. It must be a PNG.

Example: 1023.png for StarFM in Germany

To get the code you can use the config option "showPI".