Add-on:Sonos

Sonos

http://mirrors.xbmc.org/addons/frodo/script.sonos/icon.png Author: robwebset Type: Program Repo: License: GPL v2.0 Source: Source code Summary: Sonos Controller

Add-ons

Sonos

Need help with this add-on? See here.

Supports simple Sonos Controls and notifications from XBMC. Look at the wiki for more details.

Introduction

The XBMC Sonos addon allows you to control your Sonos system from XBMC. It is implemented (for those who like to know) as a script, plugin and service. In addition to controlling your Sonos system it also allows you to be notified (via a popup) whenever a new track starts and link the audio volume control of XBMC to the audio volume of the Sonos system. There is also a full "Artist View" controller that will display images and descriptions of the artists currently playing on the Sonos System.

The Sonos addon currently only supports a single speaker (or single group) - this is partly because I only have one speaker available to test any features.

Installation

The Sonos addon does not require any other programs installed. It will communicate directly with your Sonos speaker to perform operations.

The following settings are available:

Speaker

Search For Sonos Speakers... Attempt to auto detect any Sonos speakers on the network IP Address The IP Address of your speaker Zone Name (Optional) The Zone Name which the Speaker belongs to (This will be auto populated if a search is done) - Automatically Update IP Address On Startup This will result in the Sonos Addon searching for Speakers in the given Zone, and setting their IP address automatically (Useful if the IP addresses of your speakers change and you want XBMC to auto-detect them each time the system starts) Debugging Enable Debug logging Enables Sonos debug logging into the XBMC log file Use Test Data Useful for testing if a Sonos speaker is not available (Also allows custom skinners that do not have a Sonos system to develop skins)

Controller

Display Artist Information Displays images and artist information while items are playing when the controller is selected (using ArtistSlideshow) - Layout A selection of various layouts of the screen when the Artist Information is shown Controller Refresh Interval (Seconds) Sets how often the controller screen should refresh and check for changes of track being played Avoid Duplicate Key Presses (Seconds) When using a remote control and holding down a button (such as volume) it will send many requests to increase the volume - this setting allows you to ensure only one press is detected every X seconds. (This prevents flooding the Sonos system with requests). Volume Change Increments When the volume increase/decrease button, how much to change the volume by (default is 3%)

Automation

Link XBMC Volume With Sonos Speaker (Requires Restart) Whenever you change the XBMC volume, the Sonos volume will be set to the same percentage value (Note: Changes in the Sonos Volume are not reflected in XBMC - this is one way only) - Switch Sonos To Line-In On XBMC Startup When XBMC starts, it will send a message to the Sonos speaker to switch it to line-in - Switch Sonos To Line-In On Media Start When XBMC start stats playing any form of media, it will send a message to the Sonos speaker to switch it to line-in Automatically Pause Sonos When XBMC Plays Media (Restart Required) If you start playing any form of media in XBMC, then a pause command will be sent to the Sonos system to ensure it stops playing - Automatically Resume Sonos (Seconds) [0 = Off] If The Sonos Addon paused the Sonos system because of XBMC playing media, how many seconds to wait before resuming Sonos playback

Plugin

Batch Size The number of records to retrieve from Sonos in one chunk, looping to get all the records in this batch size. (Default = 100) Maximum Entries In Displayed Lists Limits the number of entries that are retrieved from the Sonos system when generating lists (e.g. The Queue). (Default = 1000) Use Skin Icons Instead Of Sonos Icons Allows the change of the plugin section to use the default icons suplied by skin instead of the Sonos icons

Notifications

Enable Notifications (Restart Required) Enables or disables the popup notification of track change Display Notification For (Seconds) How long to display the track information on the screen Notification Check Frequency (Seconds) The frequency in which the service check which track is playing on the Sonos speaker Do Not Display Notification If Video Is Playing Prevents the popup notification displaying while a video file is playing Do Not Display Notification If Controller Is Showing In most cases this would be "true" (default) so that the popup does not display the notification while the controller is showing. However when using certain Artist Slideshow supported controller sceens, there is no display of the current artist name or track, this allos the notification to show while these screens are being used. Use Default XBMC Notification Dialog Uses the default XBMC popup dialog instead of the custom Sonos one

Features

Notifications

Upon startup of XBMC, the Sonos addon will launch a service to monitor your Sonos speaker. It will then provide a popup each time the track being played on the Sonos speaker changes. This can be disabled via the settings menu if not required.

Main Script/Controller

The controller enables you to control your Sonos speaker. It suports commands like:

• Play
• Pause
• Stop
• Previous
• Next
• Mute
• Change Volume
• Seek to position in track

In addition to this, the controller will display the currently playing track information and the Album Art. Additional artist information can be retrieved from the web and displayed if selected in the settings.

Plugin

The plugin allows users to view and select tracks that are available on the Sonos system. It has a root menu that contains

• Music Library - The list of locally stored tracks on your server
• Radio Stations - The radio stations saved in "My Radio Stations"
• Queue - The currently queued tracks to play on the Sonos system

It suports commands like:

• Play now
• Add to queue
• Replace queue
• Clear queue

To enable this feature just run the addon program in the normal way or add it to your XBMC Home Page and launch it from there.

Debugging

If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:

• XBMC logging from the main setting menu
• Sonos debug from the Sonos addon settings menu

Please do not paste the log into the forum thread, just link to it.