Add-on:Sonos: Difference between revisions
m (Addon-Bot Update) |
Rob webset (talk | contribs) (Add Lyric Details) |
||
Line 19: | Line 19: | ||
<br /><br /> | <br /><br /> | ||
== Introduction == | == Introduction == | ||
The | The Kodi Sonos addon allows you to control your Sonos system from Kodi. 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 Kodi 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. | ||
<br /><br /> | <br /><br /> | ||
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. | 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. | ||
Line 39: | Line 39: | ||
::The Zone Name which the Speaker belongs to (This will be auto populated if a search is done) | ::The Zone Name which the Speaker belongs to (This will be auto populated if a search is done) | ||
:'''- Automatically Update IP Address On Startup''' | :'''- 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 | ::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 Kodi to auto-detect them each time the system starts) | ||
:<u>'''''Debugging'''''</u> | :<u>'''''Debugging'''''</u> | ||
:: | :: | ||
:'''Enable Debug logging''' | :'''Enable Debug logging''' | ||
::Enables Sonos debug logging into the | ::Enables Sonos debug logging into the Kodi log file | ||
| [[File:Settings-Speaker.JPG|400px]] | | [[File:Settings-Speaker.JPG|400px]] | ||
|} | |} | ||
Line 52: | Line 52: | ||
| | | | ||
:'''Display Artist Information''' | :'''Display Artist Information''' | ||
::Displays images and artist information while items are playing when the controller is selected (using [[Add-on:Artist Slideshow|ArtistSlideshow]]) | ::Displays images and artist information while items are playing when the controller is selected (using [[Add-on:Artist Slideshow|ArtistSlideshow]] and [[Add-on:CU LRC Lyrics|CU LRC Lyrics]]) | ||
:'''- Layout''' | :'''- Layout''' | ||
::A selection of various layouts of the screen when the Artist Information is shown | ::A selection of various layouts of the screen when the Artist Information is shown | ||
Line 70: | Line 70: | ||
|- valign=top | |- valign=top | ||
| | | | ||
:'''Link | :'''Link Kodi Volume With Sonos Speaker (Requires Restart)''' | ||
::Whenever you change the | ::Whenever you change the Kodi volume, the Sonos volume will be set to the same percentage value (Note: Changes in the Sonos Volume are not reflected in Kodi - this is one way only) | ||
:'''- Switch Sonos To Line-In On | :'''- Switch Sonos To Line-In On Kodi Startup''' | ||
::When | ::When Kodi starts, it will send a message to the Sonos speaker to switch it to line-in | ||
:'''- Switch Sonos To Line-In On Media Start''' | :'''- Switch Sonos To Line-In On Media Start''' | ||
::When | ::When Kodi starts playing any form of media, it will send a message to the Sonos speaker to switch it to line-in | ||
:'''Automatically Pause Sonos When | :'''Automatically Pause Sonos When Kodi Plays Media (Restart Required)''' | ||
::If you start playing any form of media in | ::If you start playing any form of media in Kodi, then a pause command will be sent to the Sonos system to ensure it stops playing | ||
:'''- Automatically Resume Sonos (Seconds) [0 = Off]''' | :'''- Automatically Resume Sonos (Seconds) [0 = Off]''' | ||
::If The Sonos Addon paused the Sonos system because of | ::If The Sonos Addon paused the Sonos system because of Kodi playing media, how many seconds to wait before resuming Sonos playback | ||
| [[File:Settings-Automation.JPG|400px]] | | [[File:Settings-Automation.JPG|400px]] | ||
|} | |} | ||
Line 110: | Line 110: | ||
:'''Do Not Display Notification If Controller Is Showing''' | :'''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. | ::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 | :'''Use Default Kodi Notification Dialog''' | ||
::Uses the default | ::Uses the default Kodi popup dialog instead of the custom Sonos one | ||
<br /> | <br /> | ||
| [[File:Settings-Notifications.JPG|400px]] | | [[File:Settings-Notifications.JPG|400px]] | ||
Line 149: | Line 149: | ||
| Slideshow Only (No Controller) | | Slideshow Only (No Controller) | ||
''Note:'' This screen works well if you also have Notifications enabled (with "Do Not Display Notification If Controller Is Showing" unset) so that you also get notified what the artist and title of each track that starts is. | ''Note:'' This screen works well if you also have Notifications enabled (with "Do Not Display Notification If Controller Is Showing" unset) so that you also get notified what the artist and title of each track that starts is. | ||
|- | |||
| [[File:Sonos-Controller-Artist-4.JPG|400px]] | |||
| Controller, Slideshow, Lyrics | |||
''Note:'' This screen will only show the lyrics when used with Helix (v14) or later (Kodi needs to be restarted after the initial install of the [[Add-on:CU LRC Lyrics|CU LRC Lyrics]] addon) | |||
|} | |} | ||
<br /><br /> | <br /><br /> | ||
Line 159: | Line 163: | ||
| [[File:Notification-Sonos.JPG|300px]] || [[File:Notification-XBMC.JPG|300px]] | | [[File:Notification-Sonos.JPG|300px]] || [[File:Notification-XBMC.JPG|300px]] | ||
|- align=center | |- align=center | ||
| Sonos Notification Format || | | Sonos Notification Format || Kodi Notification Format | ||
|} | |} | ||
</center> | </center> | ||
Line 217: | Line 221: | ||
== Debugging == | == Debugging == | ||
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH: | If reporting a problem, please also provide a debug log. To do this you need to enable BOTH: | ||
* | * Kodi [[Settings/System#Debugging|logging]] from the main setting menu | ||
* Sonos debug from the Sonos addon settings menu | * Sonos debug from the Sonos addon settings menu | ||
Please do not paste the log into the forum thread, just link to it. | Please do not paste the log into the forum thread, just link to it. | ||
Line 223: | Line 227: | ||
<br /> | <br /> | ||
== Donations == | == Donations == | ||
If you have found the Sonos Addon useful and would like to help support future development and bug fixes, then please feel free to make a small donation. | If you have found the Sonos Addon useful and would like to help support future development and bug fixes, then please feel free to make a small donation. | ||
<br /> | <br /> | ||
<br /> | <br /> | ||
Please use the link on the top of the [http://forum.kodi.tv/showthread.php?tid=183020 Sonos Forum] | |||
<br /> | <br /> | ||
<br /> | <br /> |
Revision as of 17:59, 24 January 2015
Sonos | ||||||||||||||
|
Add-ons | Sonos |
Need help with this add-on? See here. |
Supports simple Sonos Controls and notifications from Kodi. Look at the wiki for more details.
Introduction
The Kodi Sonos addon allows you to control your Sonos system from Kodi. 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 Kodi 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
Controller
|
Automation
Plugin
Notifications
Features
Sonos Controller
The Sonos Controller can be launched in two different ways:
- From Programs -> Sonos
- From the Browser Menu (See below)
There are two different formats of controller. They both offer the same expected features:
- Display Artist Name
- Display Track Name
- Display Album Name
- Display Album Artwork
- Display Track Duration and Current Position
- Volume Display and Operations (Mute, Change Volume)
- Control Operations (Play, Pause, Stop, Next, Previous, Seek)
- Adjustment Operations (Loop, Random, Crossfade)
The standard controller supports just this set of features, and the data is read from the source files that the Sonos system is playing or streaming.
The advanced controllers will also support additional information which is retrieved from the internet. These are available when you enable the option "Display Artist Information" in the settings. These include:
Controller, Slideshow, Biography, Albums by the same artist | |
Controller, Slideshow | |
Slideshow Only (No Controller)
Note: This screen works well if you also have Notifications enabled (with "Do Not Display Notification If Controller Is Showing" unset) so that you also get notified what the artist and title of each track that starts is. | |
Controller, Slideshow, Lyrics
Note: This screen will only show the lyrics when used with Helix (v14) or later (Kodi needs to be restarted after the initial install of the CU LRC Lyrics addon) |
Notifications
The notifications option (if enabled) will display a small popup whenever the track being played by the Sonos system changes. This popup will display the Track Title, Artist and Album Artwork.
Sonos Notification Format | Kodi Notification Format |
Sonos Browser
The Sonos Browser can be launched from "Music -> Add-ons -> Sonos", this will give the folowing options:
Debugging
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
- Kodi 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.
Donations
If you have found the Sonos Addon useful and would like to help support future development and bug fixes, then please feel free to make a small donation.
Please use the link on the top of the Sonos Forum