Changes between Version 38 and Version 39 of WikiStart

Timestamp:

2014-02-17 23:39:24 (11 years ago)

Author:

lolodomo

Comment:

--

WikiStart

@@ -155 +155 @@
 
 
-=== Making a Sonos "Say" something (outdated) ===
+=== Making a Sonos "Say" something ===
 The Sonos plugin exposes Text to Speech capability through Google's service.  The functionality is exposed declaratively through the ''Say'' action under Advanced Scenes.
-The functionality is also exposed programmatically via Lua code:
-{{{
-luup.call_action("urn:micasaverde-com:serviceId:Sonos1", "Say",
-                 {Text="Welcome Home", Language="en", Volume=50, GroupDevices="667,668"},
-                 666)
-}}}
-
+The functionality is also exposed programmatically via Lua code.
+
+Suppose you have 4 Sonos zones named Bedroom, Bathroom, Living-room and Kitchen. Your bedroom Sonos is linked to device 666 in your Vera.
+
+To play a message only in the bedroom, use this lua code:
+{{{
+luup.call_action("urn:micasaverde-com:serviceId:Sonos1", "Say",
+                 {Text="The sun shines outside", Language="en"},
+                 666)
+}}}
 This action will pause the current playback, say the text, and then the playback will be resumed.
-
-By using the !GroupDevices parameter, it is even possible to activate the Text To Speech on several Sonos zones at the same time. This parameter represents a CSV list of deviceId's of other Sonos units that should be included during the save-say-restore model of the Say command.
-
-Notes:
- * This service may be removed at any time, as can happen with Google services.
- * Parameters not specified will default internally. (''Language=en'', ''!GroupDevices=""'', ''Volume=nil'') By default, the volume is not set.
+Language is a string of 2 characters, like en, fr ...
+
+To play a message in the bedroom setting the volume for the message at level 60:
+{{{
+luup.call_action("urn:micasaverde-com:serviceId:Sonos1", "Say",
+                 {Text="The sun shines outside", Language="en", Volume=50},
+                 666)
+}}}
+The volume will be adjusted to play the message, and finally restored to its previous level.
+When the Volume parameter is not used, the volume is not adjusted and the message is played with the current volume.
+
+To play a synchronized message in the bedroom, the bathroom and the kitchen:
+{{{
+luup.call_action("urn:micasaverde-com:serviceId:Sonos1", "Say",
+                 {Text="The sun shines outside", Language="en", GroupZones="Bathroom,Kitchen"},
+                 666)
+}}}
+After the text is said, the playback will be resumed on the 3 zones.
+
+To play a synchronized message in all rooms setting the volume for the message at level 60 in all rooms:
+{{{
+luup.call_action("urn:micasaverde-com:serviceId:Sonos1", "Say",
+                 {Text="The sun shines outside", Language="en", GroupZones="ALL",
+                  Volume=60, SameVolumeForAll="true"},
+                 666)
+}}}
+When the parameter !SameVolumeForAll is set to false or not set, the volume is adjusted only on the main zone, that is the bedroom in our example.
+
+To play a message in the bedroom using your personal OSX TTS server rather than using Google Internet service:
+{{{
+luup.call_action("urn:micasaverde-com:serviceId:Sonos1", "Say",
+                 {Text="The sun shines outside", Language="en", Engine="OSX_TTS_SERVER"},
+                 666)
+}}}
+Two accepted values for the engine: "GOOGLE" for the Google Internet service and "OSX_TTS_SERVER" for a personal OSX TTS server.
+
+Notes:
+ * Google service may be removed at any time
+ * For !GroupZones, you have to use room names (zone names defined with your Sonos application), not the name of your Vera device
+ * It is possible to use the parameter named !GroupDevices in place of !GroupZones. In this case, you must have a device in the Vera for all the Sonos zones you want to address. The value is a CSV list of device ids. For example, if your living-room and kitchen Sonos are linked respectively to devices 667 and 668 in your Vera, you will use !GroupDevices="667,668". The !GroupDevices has been kept for compatibility reasons with old versions but the use of !GroupZones is now recommended.
+ * Parameters not specified will default internally. (''Language=en'', ''Engine=GOOGLE'', ''!GroupDevices=""'', ''!GroupZones=""'', ''Volume=nil'', ''!SameVolumeForAll=false'')