Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/CFenner/MMM-Sonos
A module for the MagicMirror to display informations about the currently playing songs on your Sonos system.
https://github.com/CFenner/MMM-Sonos
magic-mirror-modules magicmirror sonos sonos-api
Last synced: 3 months ago
JSON representation
A module for the MagicMirror to display informations about the currently playing songs on your Sonos system.
- Host: GitHub
- URL: https://github.com/CFenner/MMM-Sonos
- Owner: CFenner
- License: mit
- Created: 2016-03-25T21:21:31.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-07-30T09:43:39.000Z (4 months ago)
- Last Synced: 2024-07-30T12:57:07.768Z (4 months ago)
- Topics: magic-mirror-modules, magicmirror, sonos, sonos-api
- Language: JavaScript
- Homepage:
- Size: 213 KB
- Stars: 44
- Watchers: 7
- Forks: 22
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-mmm - **MMM-Sonos**
README
[![code climate](https://codeclimate.com/github/CFenner/MMM-Sonos/badges/gpa.svg)](https://codeclimate.com/github/CFenner/MMM-Sonos)
[![API](https://img.shields.io/badge/api-Sonos-orange.svg)](https://github.com/jishi/node-sonos-http-api)
[![All Contributors](https://img.shields.io/github/all-contributors/CFenner/MMM-Sonos/main)](#contributors-)
[![License](https://img.shields.io/github/license/mashape/apistatus.svg)](https://choosealicense.com/licenses/mit/)# MagicMirror-Sonos-Module
This is an adaption of the [MagicMirror-SonosModule](https://github.com/Vaggan/MagicMirror-SonosModule) by [Vaggan](https://github.com/Vaggan). It was modified to fit the new module system and got some enhancements in visualisation an configuration.
![Sonos Module](https://github.com/CFenner/MagicMirror-Sonos-Module/blob/master/.github/preview.png)
## Usage
Prerequisites:
- requires MagicMirror v2.0.0
- install and [run](https://github.com/MichMich/MagicMirror/wiki/Auto-Starting-MagicMirror) [node-sonos-http-api](https://github.com/jishi/node-sonos-http-api)### Installation
Navigate into your MagicMirror's modules folder:
```shell
cd ~/MagicMirror/modules
```Clone this repository:
```shell
git clone https://github.com/CFenner/MMM-Sonos
```Navigate to the new MMM-Sonos folder and install the node dependencies.
```shell
cd MMM-Sonos/ && npm install --production
```Configure the module in your config.js file.
### Configuration
To run the module properly, you need to add the following data to your config.js file.
```js
{
module: 'MMM-Sonos',
position: 'top_right', // you may choose any location
config: {}
}
```You also can set some options to hide different parts of the module.
| Option | Description | Default |
|---|---|---|
|`showStoppedRoom`|Trigger the visualization of stopped rooms.|`true`|
|`showAlbumArt`|Trigger the visualization of the album art.|`true`|
|`albumArtLocation`|Specifies on which side of the text the album art is rendered. Possible values: `left`, `right`.|`right`|
|`showRoomName`|Trigger the visualization of the room name.|`true`|### Known Issues
The module may not be able to access the data of the sonos API due to a Cross-Origin Resource Sharing (CORS) issue. This could be solved by adding the following lines to the `sonos-http-api.js` just before `res.write(new Buffer(jsonResponse));` in the sonos api. Remember to restart the service after the change.
```js
res.setHeader("Access-Control-Allow-Origin", "http://localhost");
res.setHeader("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept");
```### How to Install Sonos-API
To install the Sonos-API just clone the [repository](https://github.com/jishi/node-sonos-http-api) to your PI.
```shell
git clone https://github.com/jishi/node-sonos-http-api.git
```Navigate to the new node-sonos-http-api folder and install the node dependencies.
```shell
cd node-sonos-http-api && npm install --production
```Now you can run the service with:
```shell
npm start
```I really recommend to use PM2 like it is described on the MagicMirror [Wiki page](https://github.com/MichMich/MagicMirror/wiki/Auto-Starting-MagicMirror).
```shell
cd ~/Sonos
npm start
```## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Christopher Edling
🤔 💻 🔬
Magnus
💻
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!