Sonos S2 Automation Controller

This Quick App lets you seamlessly integrate your Sonos S2 speakers with your FIBARO / Yubii System, enabling advanced features without third-party tools or extra hardware.

Preface

Please note that this Quick App is only compatible with Sonos S2 devices.

Capabilities

1. Play a favorite on a specific speaker;
2. Create and remove a speaker group;
3. Play a TTS (Text-to-Speech) audio clip;
4. Control playback;
5. Adjust volume levels;
6. Adjust volume levels by percentage;
7. Save and restore playback status;
8. Save and restore playback state with automatically pausing all players;
9. Set a sleep timer.

Updates

Version 2.5.1:

• Fixed grouping for Sonos S2 system update 82.2-59204.

Version 2.5.0:

• Add button to show players and favorites in the HC3 log;
• Add button to refresh favorites;
• Add playTTS function to use self generated text with scenes in the HC3.

Installation and usage

Download and install the Quick App on your HC3. Then simply set the Quick App variable sonosIP to the IP address of a Sonos speaker on your network, and you’re all set.

For the best performance, I recommend using the IP address of a player that’s connected via a network cable, if available.

Quick Start

The examples provided below are just a small subset of the commands available with the Sonos Automation Controller Quick App. For a complete list of commands and detailed usage instructions, refer to the full documentation on my website.

Playback Controls:

• Play, pause, and control volume for individual speakers or groups.
• Example command:
  hub.call(123, "play", "Livingroom") hub.call(123, "setPlayerVolume", "Kitchen", 20)

Speaker Grouping:

• Dynamically group or ungroup speakers for synchronized playback.
• Example command:
  hub.call(123, "createGroup", {"Livingroom", "Kitchen"})

Play Favorites:

• Quickly play your favorite playlists or stations.
• Example command:
  hub.call(123, "playFavorite", "Top Hits", "Bedroom", 15, "queue=replace", "playmode=shuffle")

Text-to-Speech (TTS):

• Play announcements with self generated text.
• Example command:
  hub.call(123, "playTTS", "Office", 5, "nl", "Hi it's me, Joep!")
• Play announcements using pre-generated audio clips.
• Example command:
  hub.call(123, "loadAudioClip", "Office", 5, "https://your-audio-link.mp3")

Save & Restore Playback:

• Save the current playback state and resume later.
• Example command:
  hub.call(123, "savePlaybackStatusAndPause") hub.call(123, "restorePlaybackStatus")

Sleep Timer:

• Set a timer to stop playback after a specified duration.
• Example command:
  hub.call(123, "setSleepTimer", "Bedroom", "00:30")

For a complete overview of the app’s functionality and setup, visit the full documentation on my website where you'll find detailed instructions, step-by-step examples, and tips to make the most of your Sonos integration with FIBARO Home Center 3.

https://docs.joepverhaeg.nl/sonos-tts/

General note

The Quick App is not a player and does not create child devices for individual speakers. Instead, it functions as a controller to be used within scenes, allowing you to automate your Sonos system with the HC3. The Quick App has been built with a focus on optimizing HC3 resource usage, and minimizing API calls to your Sonos speakers, ensuring smooth and fast operation without overloading your Wi-Fi/LAN network.