https://github.com/tbouron/mmm-sonos

MagicMirror module that displays playing tracks on your Sonos network
https://github.com/tbouron/mmm-sonos

magic-mirror-modules magicmirror magicmirror2 sonos

Last synced: 3 months ago
JSON representation

MagicMirror module that displays playing tracks on your Sonos network

• Host: GitHub
• URL: https://github.com/tbouron/mmm-sonos
• Owner: tbouron
• License: apache-2.0
• Created: 2019-12-23T18:07:02.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-08-22T10:18:17.000Z (5 months ago)
• Last Synced: 2024-10-04T18:11:33.569Z (3 months ago)
• Topics: magic-mirror-modules, magicmirror, magicmirror2, sonos
• Language: JavaScript
• Homepage:
• Size: 95.7 KB
• Stars: 16
• Watchers: 4
• Forks: 11
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MagicMirror Module: Sonos

`MMM-Sonos` is a module for [MagicMirror](https://github.com/MichMich/MagicMirror) that allows you to display playing tracks on your Sonos network.

It support the display of different rooms and track information.

![Screenshot of the Sonos module](./screenshot.png)

## Usage

### Setup

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

```sh

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:

```javascript

/* 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 ` +`, 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 |

| listenWithPolling | When the default events won't work with the sonos, it is possible to poll the data | `false` | No |

| pollingTimeout | Polling timeout in millisecond, only workd when `listenWithPolling` is set to `true` | 5000 | No |