[Sonos] [Media Players] [S1 & S2] Version [6.0]

Introduction & Manufacturer Profile

Sonos is a leading audio technology company that revolutionizes how people listen and connect to sound.

Since inventing wireless multi-room audio, we've continued innovating, creating wireless speakers, home cinema systems, headphones, architectural components, and whole home audio solutions that have defined categories, pushed the boundaries of what's possible, and delighted listeners all around the world.

Version History

Version 6.0

Completely New Driver (You can’t upgrade previous versions to this version).

Improved installation flow: OAuth authorization and Sonos system discovery can now be performed directly from Integration Designer

Highly optimized driver.

S2 Systems can be fully discovered offsite.

S1 Systems require being onsite for full discovery.

Players can be manually added offsite, but will require discovering once onsite.

Highly improved reliability, several guards in place for disconnections etc.

Improved several icons.

System Requirements & Prerequisites

RTI System Requirements

Integration Designer: 11.15 or later.

XP FW: 22.3.31 or later.

Driver Information

This driver provides network control of Sonos Media Players.

The Volume Control option is for controlling a non Sonos devices volume (Such as an AVR or Amp) when using the Sonos App.

The Volume Monitoring option is to allow any non Sonos devices level variable (Such as something like a Lutron keypads Raise/Lower) to control the volume of the Sonos, and in turn the AVR you have configured in the Volume Control option.

Authentication

The driver requires the end user to give the driver permission to access their account.

Once the driver has been added to the project, go to the driver properties.

You should see the Authorize link in the left menu.

Click on Authorize if you want to enter the login information yourself.

Click on Copy Customer Link and send it to the end user, So the end user can sign in with their credentials and grant permission to the driver.

Once the authorization has been completed, after a few moments, the driver will report that authorization was successful and that the driver will now download the config from Sonos.

If you have multiple Sonos households, you will be prompted to select which one to use

Driver Configuration

The driver imports all players from the Sonos cloud.

Be aware, just like the Sonos app, it can only import players if they are currently online.

Once the players have been imported, they will appear in the driver config.

You need to add any players you want to control from the Add Workspace Item\Drivers\Add from Existing Driver Section.

If you don’t add the players to the project, there won’t be any controls available for the players.

Player

Name: The player’s name.

Model: The player’s model (Do Not Edit).

Serial Number: The player’s serial number (Do Not Edit).

Enable Volume Control: Select to enable control of another devices volume from the Sonos App. (Only works with Drivers that have a set volume command).

Enable Scaling: Select if the driver you want to control works with something other than 0 – 100 volumes.

Minimum: Set the other driver’s Minimum volume (Only shows if Enable Scaling is enabled).

Maximum: Set the other driver’s Maximum volume (Only shows if Enable Scaling is enabled).

Command to Use: select the 3 dots on the right to choose the Set Volume command of the driver you want to use

Enable Volume Monitoring: Select to enable control of the Sonos volume from another non Sonos devices level variable.

Enable Scaling: Select if the driver you want to control works with something other than 0 – 100 volumes.

Minimum: Set the other driver’s Minimum volume (Only shows if Enable Scaling is enabled).

Maximum: Set the other driver’s Maximum volume (Only shows if Enable Scaling is enabled).

Volume Variable to monitor: select the dropdown arrow on the right to choose the variable of the driver you want to use.

Driver Settings

Favorites Options

Favorites include Source: If checked, this appends the name of the streaming service that provided the media..

Search Options

Show Service Nicknames: If checked (and a nickname is set), the nickname will be displayed in brackets to the right of the service name. This is useful if you have multiple accounts for the same service..

Recently Played Options

Include Source: If checked, this appends the name of the streaming service that provided the media.

Recently Played Refresh Interval: How often to refresh the Recently Played list from Sonos (0 = disabled, default is every 15 minutes)

Template Page Names:

Default: Sonos

Secondary: Music Player

Works with Sonos

Version 6.0 of the driver has undergone certification by Sonos.

This means Sonos have tested the driver on RTI hardware to ensure it meets their requirements for both functionally and reliability.

Identifying Players

The driver doesn't need any network information, feel free to keep the system using DHCP.

A subwoofer does not need to be added to the configuration as it will never need to be sent commands on its own.

Surrounds don't need to be configured either if they are always surrounds.

The driver can adjust to surround speakers going back and forth from being surrounds to individual speakers to stereo pairs but this does increase the amount of processing power the driver uses so if they will always be surrounds feel free to leave them out of the configuration.

The names in the configuration will show when programming in ID.

When the system is running there are two 'Name' variables to choose from.

You can either use the name for the player given in the configuration or the current name of the player in the system itself.

Stereo Pairs

When two players are to be connected in a stereo pair you have to be cautious.

You cannot do this in the driver, it has to be done in the app but the order in which you perform the steps is important.

Stereo pairs are created in the Settings menu in the app.

You select one of the players and go to the selection called Create Stereo Pair.

There you will select the device to be the other half of the pair.

Once you've done that it will ask you to select which one of the two will be the left speaker in the pair.

This seems very obvious and innocent but has some important ramifications.

The device selected as the left speaker also becomes the coordinator, or master of the pair and all the commands must go to it.

The other speaker is considered 'invisible' in the system and cannot respond to any commands.

The driver can only send commands to devices in its configuration so if you create a stereo pair, you only have to have one of them in the configuration, but it MUST BE the master (or left speaker) of the pair.

This may not be the player that remains in the app.

If both players are left in the configuration the driver will automatically send commands to the correct player.

The following functionality applies to both S1 and S2 devices

Audio Player Control

The driver gives you all the audio controls for up to 32 players, including a 'selected' player: Transport, volume, play mode (shuffle, repeat) etc.

The default Volume, Volume Up, Volume Down and Mute tags are associated with the Group Volume commands.

If a player is not in a group with other players, these commands will just act as the standard player volumes.

If a player is in a group with other players, these commands act as the group commands, so the volume commands will adjust all players in the groups volume relatively.

There is also a Player Volumes Popup command/variables that can be used to display a popup that you can use to show the individual players volume controls.

Favorites/Playlists

The driver keeps a copy of the Sonos Favorites and Playlists.

The main interface to this list is through the Favorites List and Playlist variables.

Selecting an item in the Favorites list using the Select Favorite from List command plays the chosen favorite on the Sonos player.

On S2 devices, Using the Select Playlist from List command will show the contents of the playlist.

Selecting Play will start the playlist playing from the beginning on the Sonos player.

Selecting Shuffle will start the playlist playing in shuffle mode on the Sonos player.

Selecting a track will load the playlist and start playing from the selected track on the Sonos player.

On S1 devices, Using the Select Playlist from List command plays the chosen playlist from the beginning on the Sonos player.

Line Input Selection

Commands exist to have any player play the Line Input of any other device.

TV Input Selection

Commands exist to switch a player to the TV Input (HDMI or Optical).

This requires the device to be in Home Theater Mode.

Groups

Any player can be synced to any other.

When a player is following another its ‘is a follower’ variable will be set, when it is a Group Master its Group Master variable will be set.

There are also boolean variables that will tell which players are following a given player (or the selected player).

A separate command exists for removing that player from the group.

Transport Control

Visibility variables accompany each of the transport commands.

Using the variables allow you to display only the buttons for currently relevant commands.

For instance, the Show Previous Command will be false when a Pandora station is playing.

If you use that as visibility on a Skip Back button it will disappear when a Pandora Station is playing.

In addition, a similar variable is available for Repeat and Shuffle; using that variable will allow your repeat buttons to only appear when they are relevant.

Music Service Provider Logos

The driver provides music service provider logos.

This allows you to display the current streaming source (Spotify, Apple Music etc).

The following functionality is ONLY available on S2 devices.

Playlists

Using the Select Playlist will then show the contents of the playlist, along with Play and Shuffle options.

Selecting Play loads the chosen playlist on the Sonos player and starts playing it from the beginning.

Selecting Shuffle loads the chosen playlist on the Sonos player and starts playing it in Shuffle mode.

Selecting a track loads the chosen playlist on the Sonos player and starts playing it from the selected track.

Recently Played

Recently Played is only available if the option has been enabled in the Sonos App.

If you are not using Recently Played, then you need to set the driver configuration setting - Recently Played Refresh Rate to Never.

Otherwise set it to how often you want the recently played to be updated.

Be cautious as to how frequently it is updated as it can get to be quite a large amount of data to process.

To enable recently played in the Sonos App, go to Account/Privacy & Security/Personalization Services and enable Use Personalization Services.

Search

The driver uses the cloud API to search using user entered strings (via a virtual keyboard).

Search results are limited to a maximum of 5 items of each type.

For example, if you search for an artist, you may get results showing 5 albums, 5 individual tracks, 5 radio stations, 5 podcasts etc. related to the search string.

For a more in-depth search, you need to use the native Sonos apps.

Not all streaming services are searchable.

This is dictated by the license which Sonos has with each individual service.

The driver has no influence over this.

The following services are searchable so far –

Personal

80er-Radio harmony

80s80s - REAL 80s Radio

90s90s Radio

Absolute Radio

AccuRadio

Aldi life Musik

Amazon Music (unlimited tier for album content).

ANTENNE BAYERN

Art Radio - RadioArt.com

Atmosphere by Kollekt.fm

Audacy

Audible

Bandcamp

BBC Sounds

BOB! Deutschlands Rockradio

CBC Radio & Music

Claro Música

Classical Archives

Community Radio Plus

Convoy Network

Deezer

DR LYD

Familystream

FIT Radio Workout Music

focus@will

Gaana

Global Player

Hit Network

HIT RADIO FFH

Hype Machine

I Love Music

iBroadcast

iChill Music Service

IDAGIO

iHeartRadio

JazzGroove.org

Juuqo

KISS

KKBOX

Libby by OverDrive

LivePhish+

Lyden av Norge

Mixcloud

Mofibo

Murfie

myTuner Radio

Napster

NhacCuaTui

NRK Radio

NTS Radio

nugs

Pandora

Piraten.FM

planet radio

Plex

Pocket Casts

PowerApp

Qobuz

QQ

Radio France

Radio Javan

Radio Paradise

RadioApp

RadioPlay

Radioplayer

radioPup

Radioshop

RauteMusik.FM

Rayo

Relisten

rova

Saavn

SiriusXM

SomaFM Radio

Sonos Radio

SoundCloud

Storytel

Sveriges Radio

Talk

talkSPORT

TELMORE Musik

TIDAL

Times Radio

Triple M

TuneIn (New)

Tunify for Business

Yogi Tunes

Commercial

YouSee Musik

YouTube Music (premium)

Commercial:

Backgrounds Premium

Harmony

Jukeboxy Music for Business

LiveOne

Music Source

Pandora CloudCover

POSmusic

Qsic Prod Clone Staging

Soundtrack

storePlay

Tribe of Noise

Driver Events

Driver events will be triggered on a change in the players transport status.

Events are available for Pause, Play and Buffering.

An additional event is available for a change in song title.

A driver event will also be triggered every time a player is sent a mute command.

Limitations

If adding a player manually, you must:

Give the player a name.

Give the player a serial number (Which needs to be entered exactly as it appears in the Help -> About menu of the desktop app. For example: 38-42-0B-22-A9-E1:E)

Enter the correct IP Address of the player.

Without this information a player cannot be added manually.

After a Sonos software update, the driver should reconnect to the updated players, this will take the same amount of time as it takes the Sonos app to display the players.

System Testing

Integration Designer 11.15:

XP Processor Model: XP-8v

XP Processor Firmware: 24.3.29

Device Model(s): Port, Amp, Play 1, Era100

Support Contact

RTI Control

+ 1.952.253.3137

support@rticontrol.com