Changes between Version 46 and Version 47 of WikiStart

Timestamp:: 2014-10-18 13:02:14 (10 years ago)
Author:: lolodomo
Comment:: --

Legend:

: Unmodified
: Added
: Removed
: Modified

WikiStart

-                      v46
+                      v47
 == Installation == #Installation
 === What you need === #Whatyouneed
  * Vera with UI4, and UI5 has been tested.
+ * Vera with UI4, UI5 and UI7 has been tested.
  * At least one Sonos Zone
  * The UPnP event proxy plugin: http://code.mios.com/trac/mios_upnp-event-proxy# If this plugin is installed in parallel of the Sonos plugin, the Sonos plugin will work in a more efficient way (highly recommended)
 …
 === How To (installation from the MiOS Marketplace) === #HowTo
 It is the recommended method for installing the plugin.
 The plugin version available in the MiOS Marketplace is for UI5 only.
+The plugin version available in the MiOS Marketplace is for UI5, UI6 and UI7; you need at least version 1.1 for UI6 and UI7.
 For UI4, please read the chapter "How To (manual installation)".
 …
  * Install the Sonos plugin from the MiOS Marketplace.
  * When installation is done, refresh your Web browser cache (Ctrl+F5 in most of the browsers)
+ * When installation is done (after the creation of a new device and a reload of the lua engine), refresh your Web browser cache (Ctrl+F5 in most of the browsers) before starting the setup step
 === How To (manual installation) === #HowToManual
 …
  * (recommended) Install the UPnP event proxy plugin from the MiOS Marketplace.
  * Download the plugin files using the Zip Archive link at the bottom of this page: http://code.mios.com/trac/mios_sonos-wireless-music-systems/browser/tags/1.0
+ * Download the plugin files using the Zip Archive link at the bottom of this page: http://code.mios.com/trac/mios_sonos-wireless-music-systems/browser/tags/1.2
  * Upload the Sonos plugin files:
 …
  * When reload is done, refresh your Web browser cache (Ctrl+F5 in most of the browsers)
+If you installed the plugin from the Marketplace and you are running UI7, an easier way to create an additional device is the following:
+ * Open '''Apps''' menu; open '''My apps''' sub-menu.
+ * Push the '''Details''' button in front of your Sonos plugin.
+ * Push the '''Create another''' button.
+ * Wait for the automatic reload, then refresh your Web browser cache (Ctrl+F5 in most of the browsers)
 === Select your Sonos === #SelectSonos
 This step will allow to link a Vera device to a physical Sonos unit. It is required for the device automatically created when installing the plugin from the Marketplace or for the additional devices you created without specifying a IP address.
 …
  * Wait for few seconds for a complete initialiazation
+Automatic discovery (UPnP discovery) could require an additional setup of your Vera Lite. Please read the explanations in this message if it does not work directly: http://forum.micasaverde.com/index.php/topic,16905.msg132502.html#msg132502
+Automatic discovery (UPnP discovery) could require an additional network setup of your Vera Lite, consisting in an update of the routing table of your Vera. Do it only if necessary. You can install and uninstall this patch using the plugin UI:
+ * Find your new device in the UI,
+ * Click on its wrench button,
+ * Open the '''Settings''' tab,
+ * Push the '''Install''' button to install the patch or '''Uninstall''' button to uninstall the patch.
+ * Wait for the automatic reload.
+For technical explanation of what is done by this patch, please read this message: http://forum.micasaverde.com/index.php/topic,16905.msg132502.html#msg132502
 == User Interface (outdated) ==
 …
  * SR:`id` - Play the Sirius radio station having "id" as id
  * FR:`radio` - Play the favorite radio station having "radio" as name
+ * SF:`title` - Play the Sonos favorite having "title" as title
  * SQ:`name` - Play the Sonos playlist having "name" as name
  * GZ:`name` - Group the Sonos to Sonos with name "name"
 …
 == Service Variables (outdated) ==
+== Service Variables ==
 `urn:micasaverde-com:serviceId:Sonos1`
  * `CurrentService` - name of the current service, for example "!TuneIn"
+ * `CheckStateRate` - number of minutes between each automatic online check, "0" to disable the automatic check
+ * `DebugLogs` - "1" when the debug logs are enabled or "0" when disabled
+ * `DefaultLanguageTTS` - default language for TTS, for example "en"
+ * `DefaultEngineTTS` - default engine for TTS, either "GOOGLE" or "OSX_TTS_SERVER"
+ * `DiscoveryResult` - for plugin internal usage
+ * `FetchQueue` - "1" when the Sonos queue is read by the plugin or "0" when not
  * `GroupCoordinator` - UUID of the group coordinator
+ * `ProxyUsed` - "proxy is used" or "proxy is not used" to indicate if the UPnP event proxy is used
+ * `OSXTTSServerURL` - URL of the TTS server
+ * `ProxyUsed` - "proxy is in use" or "proxy is not in use" to indicate if the UPnP event proxy is in use
  * `RouterIp` - router/firewall IP when the Sonos unit can access the Vera only with a port forwarding rule
  * `RouterPort` - router/firewall port when the Sonos unit can access the Vera only with a port forwarding rule
+ * `SonosModel` - for plugin internal usage (icon management)
  * `SonosModelName` - model of the Sonos unit, for example "Sonos PLAY:5" or "Sonos CONNECT:AMP"
  * `SonosOnline` - "1" when the Sonos is online or "0" when it is offline
 …
 `urn:upnp-org:serviceId:ContentDirectory`
+ * `FavoritesRadios` - XML data describing all the favorites radio stations
+ * `Queue` - XML data describing the content of the Sonos queue
+ * `SavedQueues` - XML data describing all the Sonos playlists
+ * `Favorites` - data describing all the Sonos favorites (used by plugin UI)
+ * `FavoritesRadios` - data describing all the favorites radio stations (used by plugin UI)
+ * `Queue` - data describing the content of the Sonos queue (used by plugin UI)
+ * `SavedQueues` - data describing all the Sonos playlists (used by plugin UI)
 `urn:upnp-org:serviceId:RenderingControl`