README.md

MagicMirror Module: Sonos

MMM-Sonos is a module for MagicMirror that allows you to display playing tracks on your Sonos network. It support the display of different rooms and track information.

Usage

Setup

Clone this module into your MagicMirror's modules directory and install dependencies:

cd modules
git clone https://github.com/tbouron/MMM-Sonos
cd MMM-Sonos
npm i

then add the module to your MagicMirror's configuration. Here is an example:

/* MagicMirror/config/config.js */
{
    /* ...your other config here */

    modules: [

        /* ...your other modules here */

        {
            module: 'MMM-Sonos',
            header: 'Now playing',
            position: 'top_left',
            config: {
                animationSpeed: Number,
                showFullGroupName: Boolean,
                showArtist: Boolean,
                showAlbum: Boolean,
                showMetadata: Boolean
            }
        }
    ]
}

Configuration options

Configuration key	Description	Default	Required
animationSpeed	Animation speed to display/hide the module when tracks change. This value is in milliseconds	1000	No
showFullGroupName	Whether or not to display all devices in the group. If false, the group name will be <coordinator-name> +<number-other-devices>, e.g. Kitchen +2.	false	No
showArtist	Whether or not to display the artist name	true	No
showAlbum	Whether or not to display the album name	true	No
showMetadata	Whether or not to display the track metadata, i.e. room where it's played, length, volume	true	No