[[Image(Sonos-Dashboard.png, right, title="Dashboard Display", width=30%)]]

= The Sonos Wireless !HiFi Music Systems plugin for Vera =
This plugin permits control of your Sonos via Vera scenes.

Development Status

Tested features:

 * Supported Models: ZP80, ZP100, Sonos3, Sonos5, Sonos Connect, Sonos Connect AMP tested
 * Functionality:
   * Sonos:
     * Mute
     * !UnMute
     * !SetVolume
     * !SetFileToPlay (Places chosen audio file into queue)
   * !MediaNavigation:
     * !ChapterDown(Not implemented)
     * !ChapterUp (Not implemented)
     * !DiskDown (Not implemented)
     * !DiskUp (Not implemented)
     * !FastForward (Not implemented yet)
     * Pause
     * Play
     * !QuickSkip (Not implemented)
     * Rewind
     * !SkipDown(implemented as 'Next' on Sonos)
     * !SkipUp (implemented as 'Previous' on Sonos)
     * Slow (Not implemented)
     * Stop
   * Volume:
     * Down (by 3 out of 100)
     * Mute (a toggle mute function - currently a poor mans version)
     * Up (by 3 out of 100)

To do list:

 * Autodiscovery of Zones
 * Autonaming of zone names

== Installation == #Installation
=== What you need === #Whatyouneed
 * Vera with UI4, and UI5 has been tested.
 * A Sonos Zone
 * The plugin files: use the Zip Archive link at the bottom of this page: http://code.mios.com/trac/mios_sonos-wireless-music-systems/browser/trunk#

=== How To === #HowTo
 * Upload the plugin files:
   * In the '''Toolbox''' section open '''MiOS Developers''' >> '''Luup Files''' and upload all the files you downloaded (except the file D_Sonos1_UI4.json and the services subdirectory). check the '''Restart Luup after upload''' checkbox and click '''GO'''.
 * Create the Sonos device:
   * Open '''Create Device'''.
   * In the '''!UpnpDevFilename''' input box enter ''D_Sonos1.xml''.
   * In the '''Description''' input box enter a name for the panel device, e.g. ''Sonos Living Room''.
   * Click '''Create device'''.
 * Close this window and Save.

=== Configuration === #Configuration
 * In the Sonos device advanced control tab specify the IP Address of your Sonos Zone
 * Now actions are available in scenes

== User Interface ==
[[Image(Sonos-Dialog-Control.png, title="Dialog Control Tab", width=50%)]]
[[Image(Sonos-Dialog-Player.png, title="Dialog Player Tab", width=50%)]]

== Scenes ==
=== Creating a Sonos scene under UI5 ===
[[Image(SonosUI5AdvancedScene.jpg, right, title="UI5 Scene Example", width=50%)]]
To use the Sonos device under UI5, follow the steps outlined below.
 * Create New Scene
 * Give the scene a name, such as ''Play Sonos''
 * Select the [Advanced] option/tab
 * Select the ''Sonos device''
 * Click (Add)
 * Then from the drop down options list created below, Choose ''!SetFileToPlay'' and enter the full location of the NAS file[[br]]e.g. ''//192.168.1.10/media/Music/Mp3s/Changes.mp3''

Now you have selected the file, you need to tell the Sonos to play it

 * Select the ''Sonos device'' again
 * Click (Add)
 * Then from the drop down option list created below,  Choose 'Play'
 * Confirm Changes & (Save)

Now you should have a scene that, once run, will play the track you've selected.

Notes:
* The above bypasses the Sonos queue and will just play the selected track only.
* If you know the length of the track being played you can set a delay to occur[[br]]e.g 3.45mins and set another file to play.

== Reference ==
 * Main discussion area - http://forum.micasaverde.com/index.php/board,47.0.html
 * Example [http://forum.micasaverde.com/index.php/topic,8505.msg75764.html#msg75764 UI5 scene post] from @parkerc