Skip to content

Latest commit

 

History

History
79 lines (73 loc) · 2.1 KB

README.md

File metadata and controls

79 lines (73 loc) · 2.1 KB

Module: Radarr Activity

This is a module for MagicMirror, intended to show the latest downloaded episodes from Radarr.

Installing the module

Clone this repository in your ~/MagicMirror/modules/ folder ( $ cd ~MagicMirror/modules/ ):

git clone https://github.com/s-cotton/MMM-Radarr-Activity.git

Using the module

To use this module, add it to the modules array in the config/config.js file:

modules: [
{
    module: 'MMM-Radarr-Activity',
    position: 'bottom_left',
    header: 'Recent Radarr Activity',
    config: {
        radarrProtocol: "http",
        radarrHost: "localhost",
        radarrPort: "7878",
        radarrAPIKey: "",
        perPage: 15,
        scrollTimeout: 10000,
        scrollEffect: 'fade',
        updateInterval: 300000,
    }
},
]

Configuration options

The following properties can be configured:

Option Description
radarrProtocol http or https
This value is REQUIRED
radarrHost localhost or FQDN
This value is REQUIRED
radarrPort 7878 is the default, 80 if you are using a FQDN
This value is REQUIRED
radarrAPIKey API Key from Radarr Installation
This value is REQUIRED
perPage Number of Updates to read from Radarr. Default value is 15
scrollTimeout How long to show each update. Default value is 10 seconds (10000)
scrollEffect Scroll Effect between items, possible values are:
"fade", "fadeout", "none", "scrollHorz"
Default value is "scrollHorz"
updateInterval How long between data calls to Radarr. Default value is 15 minutes (300000)