extra vegetables sonos 2 way driver 5.0.4

147 Revelstoke Road

Southfields

London SW18 5NN

United Kingdom

UK Tel: +44 (0)20 8144 9354

US Tel: +1 (801) 285 9354

www.extravegetables.com

Extra Vegetables Ltd

Registered in England 7104729 VAT Reg. No. GB 984 4268 77

Registered Office: 147 Revelstoke Road London SW18 5NN

Sonos Music System – 2 Way Control

Contents

Introduction ........................................................................................................... 3 The problem this driver solves ...................................................................................................... 3

Don’t like reading; prefer to watch TV?..................................................................... 3 The Sonos System.................................................................................................. 4 Test before you install............................................................................................. 4 What this driver doesn’t do...................................................................................... 4 The Experience....................................................................................................... 4

Limitations................................................................................................................................. 5

Using a Sonos ZP90 as a source .............................................................................. 6 Instructions............................................................................................................ 8

Setting Up the Sonos System....................................................................................................... 8

Add the driver to your project ...................................................................................................... 8

IP Addresses, DHCP and MAC Addresses .................................................................................... 10

Make Your Connections ............................................................................................................ 10 Amplifier Connections ................................................................................................................................. 10

Tuner Connections ...................................................................................................................................... 11

Line In Connections ..................................................................................................................................... 12

Identifying the ZonePlayers ........................................................................................................ 13 Windows Helper Program............................................................................................................................. 13

Finding MAC addresses using Sonos Desktop Controller ................................................................................ 14

Manually Finding the MAC addresses............................................................................................................ 14

Entering the MAC addresses ........................................................................................................................ 15

Checking and Hiding Devices ..................................................................................................... 15 Radio.......................................................................................................................................................... 16

Music ......................................................................................................................................................... 17

Listen ......................................................................................................................................................... 17

Radio Setup ......................................................................................................... 18 Line In Advanced Set Up ........................................................................................................... 20

Sonos Internet Music Services ............................................................................... 20 Pandora .................................................................................................................................. 20

Setting up Music Services on Sonos ............................................................................................................. 20

Setting Up Music Services on Control4........................................................................................ 22 Pandora...................................................................................................................................................... 22

Napster ................................................................................................................................... 23

Last.fm ................................................................................................................................... 23

SiriusXM Internet Radio............................................................................................................. 23

i heart radio ............................................................................................................................. 23

Rhapsody ................................................................................................................................ 23

Spotify.................................................................................................................................... 23

Using Music Services with Keypads and Wake Up Calls ............................................ 24 Sonos Internet Radio (Radiotime) ................................................................................................ 24

Pandora Radio.......................................................................................................................... 24

i heart radio ............................................................................................................................ 24

SiriusXM ................................................................................................................................. 24

Rhapsody/Napster/Spotify ......................................................................................................... 24

Using the Sonos iPod Dock.................................................................................... 24

Extra Vegetables Sonos Driver of 45

Music Synchronization .......................................................................................... 25 Listing order on Interfaces ..................................................................................... 25 Programming........................................................................................................ 26

Selecting Playlists from Keypad Buttons ...................................................................................... 26

Selecting Radio Stations from Keypad Buttons ............................................................................. 27

Selecting Pandora Stations from Keypads .................................................................................... 28

Using Sonos in a Wakeup Call .................................................................................................... 28 Sonos Radio/Pandora/SiriusXM..................................................................................................................... 28

Driver Options ...................................................................................................... 29 Home Theaters..................................................................................................... 29 The Driver in Action.............................................................................................. 31

Now Playing Track and Progress Timer ........................................................................................ 39

Radio Stations.......................................................................................................................... 40

Pandonos............................................................................................................. 41 Troubleshooting.................................................................................................... 42 Activating the Driver ............................................................................................. 43

Activating a demo license.......................................................................................................... 43

Purchasing a permanent license.................................................................................................. 43

Version 5.0.4 November 2011

© Extra Vegetables 2011 All rights reserved Control4 is a registered trademark of Control4 Corporation

Sonos is a registered trademark of Sonos Inc

Extra Vegetables and the Extra Vegetables Logo are registered trademarks of Extra Vegetables Ltd


Introduction This driver enables the marriage of one of the world’s most popular network music systems with a fully fledged home control system. The driver will enable you to include an entire Sonos music network within a Control4 project. The Sonos system is not modified in any way and can still be controlled from the Sonos controllers and from the Sonos iPhone application. However, in addition to these controllers you will now be able to select and play music from any of the Control4 interfaces including the touch screens, remote controls and on-screen navigator. If you select music using a Control4 device the Sonos controllers will automatically update with the new playing music. Similarly if music is selected using a Sonos controller the Control4 interfaces will update a few seconds later.

The problem this driver solves

Sonos is a very popular network music system. The brand is recognized by the public and often they will ask for it by name. Its strengths lie in its simplicity of use and its reliability. Many home owners have successfully installed a system themselves as an introduction to the world of whole house entertainment and home control. The problem custom installers face with the product is that it is a closed system, and not one that is necessarily available with high dealer margins. If a home owner has already installed a Sonos system it has not previously been possible to add a ‘proper’ home control system on top of it. These problems are now solved with this driver. You can now easily upgrade an existing Sonos system to Control4 and add on the essential control of their Home Theater and other home entertainment equipment. Similarly, if you or your client prefers the Sonos music system to that built into Control4, you now have the choice to use this as the starting point for a networked music system.

Don’t like reading; prefer to watch TV? If you don’t like reading then you can view our step-by-step guides on how to set up a Sonos system on You Tube. You may still need to read sections of this manual. Setting up using ZP90s and a Multi-channel Amp

http://youtu.be/Btldwb_HIE8 Setting up using ZP120s or other amplified Sonos Zone Players

http://youtu.be/A0a6XqpA1JI Setting up Sonos Internet Radio Stations as Control4 favorite radio station http://youtu.be/arThcs3f8z4 Setting up a Pandora Radio Station as a Control4 favorite radio staion http://youtu.be/AqUG9LXJzAc Using the Pandonos 4Store App for better Pandora Control http://youtu.be/QOb1EctQc1U


The Sonos System The Sonos system consists of ZonePlayers and controllers. The ZonePlayers come in three varieties. There is an amplified player for use with external speakers, an unamplified player for use with an external amplifier like a Home Theater Receiver and a standalone unit which contains both an amplifier and speakers. All of these units can be combined together to produce a music system with as many zones as required (up to the Sonos maximum of 32). At least one of the ZonePlayers must be directly connected to the home network. The others can be connected through the Sonos wireless network system. This is a mesh network where one Sonos unit talks to all others in range. We would recommend that you always test the wireless coverage in a property before relying on this as a solution. Our advice is that if you can add wire, do so. Creating a wired data network for the system will always be more reliable. If you have not installed a Sonos system before you should ensure that you feel qualified to do so. We cannot provide any support on the set up of the Sonos system. It is important to note that no physical changes are made to the Sonos, no new software is loaded onto the Sonos and it is not ‘hacked’ in any way. Using this driver has no adverse effect on the Sonos warranty. However please do not call Sonos regarding any problems you have with the interface with Control4 as they do not provide support for this.

Test before you install You must test deploy using this driver with Control4 in your office or shop before you attempt to install on site. We strongly recommend that you follow the examples presented here in a demo environment to gain confidence with the system. We will have little or no sympathy for anyone attempting to install this on a client’s site without having tested it offsite first. We provide support during US East Coast and UK office hours: 9am to 5pm Monday to Friday. Please see the head of this document for our telephone numbers. We will attempt to answer any queries via email within 24 working hours. Please create a support ticket on our website.

What this driver doesn’t do The purpose of this driver is to provide two way control of a Sonos music system network from within Control4. It does not allow you to use the native Sonos controllers to select music to play either from the audio outputs on the Control4 controllers, or stream music directly to Control4 Speaker Points. Any subscription or internet services that are subscribed to on the Sonos system are only available to play via the Sonos ZonePlayers. Again these cannot be played from the audio outputs on controllers or directly streamed to Speaker Points. This ensures that any license agreements with regard to these services are not breached in any way.


The Experience If your customer is already used to using a Sonos system then they will be quickly at home with the integration with Control4. All of the music selection choices that are available on the Sonos controllers are now available on the Control4 touchscreens, remotes and on screen navigator. If your customer has used Control4's Digital Music interface they will notice a difference; in particular Album browsing does not include cover art.

Limitations

1. Cover Art Cover Art is displayed on the Now Playing screen on native Control4 devices only. It is not available in the Album selection browsing view.

2. Internet Services All of the major music services are supported. Some of the smaller ones are also supported, but many are not. It is our intention to support these at a later date as they are required.

3. Zones Sonos and Control4 have separate concepts of Zones. The only scenario in which you can join zones together is if you are using ZP80s/90s/CONNECT all of which are then connected to the multi-channel amp in your project.

4. Volume Control Our driver solves many of the problems of ‘double volume’ control with Sonos. In a regular Sonos zone you can use either the Control4 controller or the Sonos controller to change the volume. In a home theater the Sonos ZonePlayer should be set to fixed volume control. Volume control is then only possible from the Control4 interfaces but not the Sonos controllers.

5. Alarm Clock The Sonos Alarm clock feature is not currently implemented on the Control4 interfaces. However you can recall a Sonos Playlist or Sonos radio station as part of a Control4 wakeup event.


Using a Sonos ZP90 as a source With our support of more online music services many dealers will find it attractive to specify Sonos as a source in a system. Here’s how… In this scenario you would specify ZP90/CONNECT un-amplified Zone Players and these you would install at the head end rack. All set up with fixed volume outputs – as the Multi-channel amp will control volume.

We think the best way to think of these as are personal music streaming devices for each member of the family. So rather than naming them Lounge, Kitchen etc name them for each person. This means they can go into any room in the home and select their own personal audio stream. This could be music from the music collection, Internet radio or a music streaming device such as Pandora or Napster. Naming the Sonos devices like this avoids any conflicts or arguments amongst the family. If Dad wants to now start listening to his music stream in the Garden as well as the Garage he can use the Zones function on a Control4 touchpanel or remote to simply add the Garden Zone to the Garage Zone playing his music. The trick is to stop thinking of the Sonos ZonePlayers as having anything to do with Zones! If using the Sonos players in this way there are a few important points to bear in mind:

Michael’s Music

Mom’s Music

Dad’s Music

Maria’s Music

Multi-channel Amp

To Rooms


1. Set the ZonePlayer Volume Control to Fixed

Because the volume is being controlled by the multi-channel amp set up the Sonos ZonePlayers with fixed volume control.

2. Do not use Sonos CR200 or Sonos iPhone App These devices don’t really work too well in this set up. Because Sonos always thinks of the ZonePlayers as belonging to Zones. Yes you can still use these to select music on a player – but you cannot control the volume (as this is fixed) and you have no control over switching a Control4 zone on or off. Also the Sonos concept of joining Zones together really doesn’t work when you are using the ZonePlayers as sources.

3. Do use the Control4 iPhone or iPad App To provide your customer with iPhone or iPad control of the system you should use the Control4 app. This will allow them to select music to play on each of the streams. Control the volume and of course control the rest of their home that’s connected to the Control4 system.

4. Do use all other Control4 interfaces The music streams can also be controlled from Control4 remotes, touch panels and the on-TV navigator.

Installed in this way you can provide your customers with a multi-purpose digital music streaming device – they don’t even need to know it’s a Sonos!


Instructions

Setting Up the Sonos System

Before installing our driver it is important that you have set up and tested your Sonos system. If the Sonos system doesn’t work correctly before our driver is installed it won’t work correctly after it has been installed. You need to follow the Sonos instructions for setting up your music library and ensure that it has scanned correctly. There are no settings regarding the music library to make within Control4. Our driver simply lists the music that the Sonos system is set up for on the Control4 interfaces.

Add the driver to your project

There are three drivers that need to be added to your drivers folder. Copy all the .c4i files from the zip package to the My Documents – Control4 - Drivers folder. Open Composer Please read these next instructions carefully as it is

important that you bring the drivers into the project in the

correct order in order to save you time and trouble.

One of the features of the Sonos and our driver is that it supports Internet Radio. Control4 does not currently have a ‘cloud’ for this like it does for AM or FM radio. We have therefore used the Voom network cloud. Rename it Sonos Radio. We have also used the Star Network for I Heart Radio. The Sirius network is used for Sirius Internet radio. If you already have a Sirius tuner in your network you should bring in another copy and name it Sirius Internet radio. This is because the channel numbers on Sirius Satellite Radio and Sirius Internet Radio are not necessarily the same. An XM radio cloud will also come into the project. You should rename this Pandora. Control4 doesn’t have many broadcast ‘clouds’ so we need to use this. This doesn’t prevent you having an XM tuner in the project. Just make sure your XM tuner connects to the real XM cloud and the Sonos to this cloud. If you are using ZP120s/CONNECT:AMP in your project you may want to use the Line In feature. This works in a similar way to the Line In on a Control4 SpeakerPoint. Any audio device connected here is digitized and can be selected and played back on any other Sonos ZonePlayer. Although this


is a similar feature to the Control4 line in digitization we need to keep them separate in the Control4 project as you cannot digitize a source using a Sonos ZonePlayer to play on a SpeakerPoint or vice versa. A Sonos system can contain up to 32 ZonePlayers. Therefore potentially you can create a digital audio matrix with 32 Line In inputs to 32 ZonePlayer outputs. In order to do this we have created a driver called the ‘Sonos Virtual Matrix. From the search panel select device type A/V Switch and manufacturer Extra Vegetables, you will then see the Sonos Virtual matrix listed. Add this to wherever you are collating your central equipment in your project. If you only intend to use the input on a Sonos ZonePlayer as a local input then you do not need to add this driver to the project. An example of this situation is where you are connecting the audio output from a TV to a Sonos ZonePlayer in the room. In these cases you should use a special version of the Sonos ZonePlayer driver as described later in this document. The next elements to add in are the ZonePlayers. These consist of four parts an iPod part (for the digital music), a Tuner part (for the Sonos Radio) an Amplifier part (for Volume control) and an A/V switch part for the Line In. You will find these listed under iPod, Manufacturer Sonos. There are two drivers listed. Unless you are intending to use the Line In on the Sonos player as a locally available input only, select the ZonePlayer driver. If you want to use the line in on the ZonePlayer as a locally available input only then select the Local Line in Only version of the driver. These drivers work for both the amplified and un-amplified Sonos ZonePlayers.


IP Addresses, DHCP and MAC Addresses

All devices on a computer network are assigned an IP address. With most devices such as the Control4 equipment you can choose which IP address is allocated to the device. This is known as a Static IP Address. It is also possible for devices to obtain their IP address automatically from a DHCP server such as the router on the network. The problem with DHCP allocated IP addresses is that they can change. If the router and/or the device is switched off and on it may receive a different IP address. This is potentially a problem for our driver as we need to know whereabouts on the network each Sonos ZonePlayer is. However we have solved this problem using MAC addresses. Every single piece of networked equipment in the world has a unique number called a MAC address. The Sonos players have this number printed on the back of them as part of the serial number. You will need this number in order to identify the players on the system. We also have a helper Windows program which will list all of the Sonos ZonePlayers on the network as their ‘friendly names’ and MAC addresses. Our driver will periodically check that each ZonePlayer is still on the same IP address and update itself if it has changed. However you should be aware that if the router or a ZonePlayer is power cycled there may be a short delay before the ZonePlayer is available again within the Control4 system.

Make Your Connections

Amplifier Connections

You now need to make your connections to the Sonos ZonePlayers. You will notice that there are no visible connections on the iPod part of the driver. This is correct as it is automatically connected to the amplifier part ‘behind the scenes’ in our driver. Most of the connections are made on the amplifier part of the driver.

To keep things simple we have just produced one driver to cover all of the ZonePlayers available. If you have an unamplified ZonePlayer you should not make any connections to the Speaker output as these are physically not present on the device. Similarly some earlier players do not have the digital audio output.


We will cove the connection for the Audio Line In later. You must also make connections for the Audio End Points under Room Control if using an amplified ZonePlayer. This instructs Control4 to use the ZonePlayer as the audio device in the room and that it should be used to control the volume. A sample completed set of connections for the home theater is shown below. We’ve chosen to use the digital optical output here, but you could also use the analog stereo output.

No Room control connections are made here because the Cinema Receiver, not the Sonos unit is the end point in this room. For the Living Room the connections are as follows:

Here the end points are connected because the Sonos is the audio end point in the room.

Tuner Connections

The tuner should automatically connect to the Sonos Radio cloud that you imported at the beginning. Check each Tuner connection looks as follows:


If not connect the Sonos Radio input to the Sonos Radio (Voom) Network cloud.

Line In Connections

The Sonos Line In A/V Switch part is where you make any connections associated with the Line In on the Sonos ZonePlayers. In our example project we have a CD player in the Living Room which is physically connected to the ZonePlayer here. So we have connected to the Line In on the Living Room ZonePlayer to the CD as follows.

This completes all the connections necessary for this ZonePlayer. Repeat this process for all the other ZonePlayers in the project.


FROM THIS POINT ONWARDS YOU WILL NEED TO HAVE PURCHASED AND

ACTIVATED THE DRIVER IN ORDER TO CONTROL THE SONOS. YOU CAN HOWEVER

CONTINUE THE PROGRAMMING AS AN EXERCISE BEFORE YOU PURCHASE.

DETAILS OF ACTIVATING THE DRIVER CAN BE FOUND AT THE END OF THIS

DOCUMENT!

Identifying the ZonePlayers

The next stage in the process is to identify the Sonos players on the home network. As they are not Control4 devices they don’t have handy little buttons on them!

Windows Helper Program

You will need the MAC addresses of each of the players in order to identify them and finding these on each device could be time consuming. We have therefore provided a helper program that will discover all the Sonos players on the network and list them for you. Please note this is a Windows only program. Please ensure that you either temporarily disable or allow this program access through any firewall you have on your computer. It is unlikely the program will work on a Mac using Parallels, however it might work if the Mac runs Windows via Bootcamp. However we cannot guarantee or support the use of this program on a Mac. Install the program by running ‘Setup’ in the folder from the zip file you downloaded. This will warn you that the publisher is unknown and as long as you allow the install to proceed it will install the program on your PC. The program will install and you will find a program in your Start menu under Extra Vegetables called Find Sonos MAC. Start this program and the following window will appear on the screen. Click on the large button to search for the ZonePlayers. Almost immediately the list of players will appear; If not this might be caused by your firewall. In which case you can either adjust or temporarily disable the firewall or use one of the other methods described below to find the MAC addresses.


The image on the right shows the results of a search. Three ZonePlayers have been found and their MAC address have been listed. You can copy these MAC addresses and paste them into Composer in the drivers for the correct zones.

Finding MAC addresses using Sonos Desktop Controller

If you cannot run the helper program you can also find the MAC addresses using the Sonos Desktop Controller. Open Desktop Controller and select Help- About Desktop Controller from the main menu. This will pop up a window like the one shown below:

The MAC address is the same as the serial number but without the last letter. So in the example shown the Serial number 00-0E-58-51-0E-68:F means the MAC address is 000E58510E68. Remember the 0 are zeros not the letter O.

Manually Finding the MAC addresses

If you cannot run the helper program or do not have access to Sonos Desktop Controller you will find the MAC addresses on all of the

ZonePlayers as part of the serial number. The serial number is of the form ZPxxxx 00-0E-58-##-##-##-x. The MAC address is the "00-0E-58-##-##-##" part and consists of 12 characters. You can enter these into the driver in upper or lower case with or without the dashes.


Entering the MAC addresses

Open up the properties tab for one of the players under System Design.

In the Sonos ZP MAC Address box type the MAC address for this particular Sonos ZonePlayer and click the Set button. The Message Searching for ZonePlayer will appear in the Driver Information box once the driver has been activated. As soon as the ZonePlayer has been found this box will change to show the name of the ZonePlayer.

Check that the name of the ZonePlayer is what you would expect for that room. If it is then you have correctly identified the Sonos ZonePlayer for the room. Continue identifying all of the other ZonePlayers in the installation.

Checking and Hiding Devices

Because the driver comes in multiple parts there are some elements of it you should hide under different Navigator views. Select the Room Name under System Design, for this example we have chosen the Living Room.


This lists all of the available Audio Sources and below it the Available Video Sources in the room. Check that all the sources you expect to be available are listed. Now select the Navigator tab. We suggest hiding various elements under each heading as follows:

Radio

Hide everything apart from Sonos Radio. The actual controls on the standard Control4 tuner page will not function for this device so this should be hidden too.


Music

Hide all of the Sonos elements apart from Sonos Living and the CD player which is connected into the Line In input.

Listen

Hide all of the Sonos elements apart from the Sonos Living, Sonos Radio and the CD which was connected to the Line In.


Radio Setup We support the Sonos internet radio favorites. You cannot search through all of the radio stations or add new stations to the favorites using the Control4 interfaces. Therefore these favorite radio stations must initially be set up on one of the Sonos controllers. The Sonos desktop controller is probably the easiest to use. You only need to do this once per Sonos system. In the instructions above we hid the Tuner element in the driver in the rooms. This is because the buttons on the regular Control4 tuner screens won’t work. What you need to do is set up the favorite radio stations you have selected on the Sonos within the Media section of Control4. Under Media you will find the Voom network that we renamed to Sonos Radio earlier on. Here we need to add the same favorite stations that you have set up on the Sonos. The examples are based on the following list of favorite radio stations.

Click on New.. and the form for a new radio station will appear as shown overleaf:


This you fill in as you would for a radio station on a regular tuner. There is one important

difference

The channel number needs to contain the same text as shown on the Sonos favorite station list. So if the Sonos shows the station name as “BBC Radio 4 93.5 (News)” you should enter “BBC Radio 4 93.5” as the Channel. You need to enter the full name of the station up to the “(“ but not any text within the brackets. If the radio station name contains a | character you will find this on your keypad as the shifted character above the \ The driver works by searching for whatever you type into the Channel box in the list of favorite stations set up on the Sonos. If what you type is incorrect then it will not select correctly on the Sonos. You must check each of these favorites carefully before leaving the client’s home.

You should also be aware that if the client adds a new favorite radio station to their list it will not appear on the Control4 screen. If they delete a favorite radio station from the Sonos the Control4 shortcut will no longer work. Also if the radio station changes its name the shortcut will also stop working. If your client’s have ComposerME then they can maintain these favorites within Control4 – if you trust them to get it right! For station logos from around the world we suggest looking at www.lyngsat-logo.com which has a huge selection of Radio and TV logos. Once you refresh the navigators the radio stations will appear under Radio on the Control4 interfaces.


Line In Advanced Set Up

We described earlier how to use the line in features of the Sonos. This has always been a useful feature of the system but somewhat hampered by the fact that you had no control over whatever was connected to the Line In. Now with Control4 connected you can connect whatever device you like to the Line In and if connected to a Control4 IR output have control over it as well. This makes the Line Ins much more useful. One point to remember is that like the Control4 SpeakerPoints the digitization takes time and if you were to connect the audio from a DVD player to the Line In and then the video to a screen the audio would be out of synchronization. You can make it stay in sync by setting the Line In on the Desktop Controller to uncompressed. This option can be found under File->Preferences->Advanced->Line-in Encoding. Please note there may still be a slight delay as the audio travels across the network and that by using uncompressed audio you will be adding significantly to network traffic.

Sonos Internet Music Services Depending on which part of the world you live in Sonos offers you a variety of online music services. Our driver now supports the following services: Pandora, Napster, Sirius Internet Radio and Last.FM. All but Last.FM require the Control4 system to be running OS 2.x. Last.FM, Sirius Internet Radio and i heart radio are supported on Control4 1,7, 1.8 and 2.x Pandora and Napster are only supported on Control4 2.x When talking to your customers it is important to remember that we will NEVER be able to support Pandora and Napster on systems running Control4 1.7 or 1.8. Not all services are available in all countries.

Pandora

Pandora is a US based subscription music streaming service. It allows you to choose a particular artist or style and will then play a continual stream of similar music. In order to use this service your customer will need a Pandora account the details of which need to be entered in both the Sonos and Control4 systems. Please note that you will need to know your customer’s password. Due to the way in which we have had to implement our support of Pandora this is transmitted in plain text. Please ensure that the password your customer uses for this service is not one that is used on sensitive services such as online banking!

Setting up Music Services on Sonos

The first thing you need to is set up the Pandora music service on the Sonos system. To do this open up your Sonos Desktop Controller software.


Then from the Music heading on the menu select Set Up Services.. Then from the page that appears select the Add button. Now select Pandora from the list of services that appears.

Then on the next page enter your customer’s Pandora username and password. Press Next again and these will be validated.

Once complete use one of the Sonos interfaces to select some music from Pandora to ensure that the service is working correctly.


Setting Up Music Services on Control4

Pandora

Having successfully set up Pandora on Sonos system you now need to activate it within Control4. This is really simple. All you need to do is to enter the appropriate usernames and passwords in the boxes provided on the properties page and press ‘Set’. REMEMBER this must be the same username and password as the one you have entered on the Sonos system. If you change the username on the Sonos system it must also be changed here. If you want to be able to select a Pandora station in a wake up call or from a keypad button you need to set up these stations as Control4 favorites under Media. Only stations set up in this way can be selected. If your customer has access to iheart radio or Sirius Internet radio set these drop down boxes to True. You only have to set up these services on the Sonos system.


Napster

Napster is a music streaming service that is similar to Rhapsody. Customers can instantly listen to albums from a huge range of artists. You can also select Playlists of music of a similar type. One of the main advantages of Napster is that it is legally available outside of the US – in particular the UK where we are unable to access Rhapsody. To enable Napster follow the process above for Pandora but add the Napster account details to both the Sonos and Control4 applications.

Last.fm

Last.fm is a music streaming service. You select either and artist or a music type and then it provides you with a never-ending stream of similar music to listen to. You cannot use Last.fm to play particular albums or tracks. When you select to play music by a particular artist it will play music by them and similar artists. All of these services are free. Since it’s free, we recommend anyone that is unfamiliar with Last.fm to sign up for an account on their website and discover how it works. The address is www.last.fm

SiriusXM Internet Radio

You can also enable Sirius internet radio on the Sonos system if your customer has an account. You need to enter their details on the Sonos system. Within Composer you simply need to enable the service. You can set up favorite radio stations within Media under Sirius in the normal way. Simply add the stations you require with their channel numbers. These should be taken from the Sirius Internet Radio website or from the numbers displayed on the Sonos desktop controller software. The internet channel numbers are often different from the Satellite Radio channel numbers.

i heart radio

This is a US only Internet radio streaming service. This adds radio stations that are not available from Sonos Internet Radio (which uses Radiotime as its provider). If you want to use this service simply enable it within Sonos and on the Composer properties screen. You can set up presets for this service as well. When a station is selected its channel number is printed in the Lua window of the driver so you can note it down and use it as a favorite. These channel numbers are also displayed on the Sonos desktop controller software when a station is selected.

Rhapsody

Although Control4 supports Rhapsody with a rich interface we have also provided support for this service via Sonos. This enables you to offer your customer this service alongside the other music services in a consistent format. However if you customer’s main requirement is for Rhapsody we would suggest you provide this via the native Control4 interface.

Spotify

This European music service (soon to be launched in North America) offers you the ability to play tracks and albums from a large catalogue. The driver only allows you to play


items that have already been ‘starred’. There is no listing, browsing or searching available.

Using Music Services with Keypads and Wake Up Calls It is possible to use some of the music services with wake up calls or directly select them from keypad buttons. In order to do this you need to set up stations using Control4’s media section of Composer. Any station defined here can then easily be programmed to a keypad button just like a regular radio station.

Sonos Internet Radio (Radiotime)

As noted earlier in this document you set these up using the name of the radio station – not the channel number. Refer back if you need more information.

Pandora Radio

Pandora Radio Stations are also set up using the station name as the channel number. For example Pandora’s Green Day Radio would be represented as shown right. You can type your own description, Genre. Copy and paste suitable icon art. Note we have type the name Green Day Radio EXACTLY as it is on Pandora. Make sure you include any capitalization or punctuation marks! You will now find Green Day radio as one of your media choices under the programming choices for the room.

i heart radio

The channel number for these stations is printed on the Lua window of the driver whenever they are selected. Copy this number and use it as the channel number for the station.

SiriusXM

These use their standard INTERNET channel numbers. Simply program you favorite stations using these.

Rhapsody/Napster/Spotify

You cannot directly select a stream or track from these services


Using the Sonos iPod Dock The driver supports the Sonos WD100 wireless iPod dock. There is no particular set up required on the Control4 driver in order to use this once it has been identified as part of the Sonos system. We recommend that if you have multiple Sonos iPod docks in a property that you give them different names. You can do this by using the Sonos Desktop software. These names will appear when a dock. You should probably name them with the room in which they are situated. Please note the Sonos iPod dock does not retrieve Cover Art from the iPod. So no cover

art is displayed either on the Sonos controllers or the Control4 interfaces.

Music Synchronization With the Sonos driver there are no music synchronization considerations within Control4. The Sonos system is set up to synchronize with the music database as per the instructions provided with the Sonos system. This means there is no requirement for your client to use Composer ME in order to keep their music listings on the Control4 system up to date. We have also provided a button on the Control4 interfaces to instruct the Sonos system to resynchronize its music database. This instructs Sonos to scan its known locations for new music. To add new music locations to Sonos use the Sonos Desktop Controller program.

Listing order on Interfaces You can determine which Sonos services appear on the Control4 interfaces and in which order by using the Menu Display Order property. By default this is set to LSPQRAM. Each letter stands for a particular service so by re-arranging or removing the letters you can determine what is shown on the interface. So if you don’t want to show the music library you can simply leave out the L. The letters represent the following items L – Music Library S – Music Services P – Saved Playlists Q – Music Queue R – Radio Stations A – Default Action M – Management So if you are using the Sonos purely for Radio Stations and Pandora you could just type S in the box and only Music Services will be listed as an option.


Programming

Selecting Playlists from Keypad Buttons

One of the most requested features we have had is to be able to start playing a playlist from a button on a keypad. Here’s how you do it. In our example program we’ve added a 6 Button Keypad in the Master Bedroom. The idea is that if you press button 1 on the keypad ‘Dad’s Playlist’ starts playing. The first thing you need to do is create Dad’s Playlist. This needs to be a Sonos Playlist – it cannot be an imported .mu3 playlist or a playlist you create within Composer. These you can set up on the Sonos devices – or most likely using the Sonos Desktop Software. Make a careful note of the name of the playlist. Type this wrong and it won’t work. As these are not Control4 playlists they will never show up in the Control4 playlist section of Media. Now on the right hand side of the programming screen find the Sonos Amplifier for the Master Bedroom If you scroll down the Actions you will find the Device Specific Command. There’s only one which is called Start Playlist. Select this and the Playlist Name field becomes available for entry. You must now type in the exact name of the Sonos Playlist you want to start. Using our example we would type ‘Dad’s Playlist’ here. Remember that ‘Dads Playlist’ without the apostrophe would not work! If you do any of this programming you must check it carefully.


Once you’ve entered the Sonos Playlist name double click on the Green Arrow to add the instruction to the script pane.

The script should look like that shown above. Click the Execute button to check it!

Selecting Radio Stations from Keypad Buttons

As the Sonos favorite radio stations are defined within Control4’s media lists you can select these just as you would for any other media within the Control4 system. Select a keypad button as above. Now on the right hand side select the Room Name.


Now click the radio button next to Select Media then the … button. This produces the Control4 media list. Under Broadcast Audio you will find all your Sonos Favorite radio stations. Remember that although Playlists are shown on this screen you will not find the Sonos Playlists under this heading as they are not defined within Composer.

Selecting Pandora Stations from Keypads

Follow the instructions as above but select your desired Pandora station from the favorites you set up on the Pandora radio cloud.

Using Sonos in a Wakeup Call

The Sonos system has its own Alarm Clock feature. At this time we are unable to integrate directly with this through our driver. However you can use Control4’s Wakeup Agent to select a playlist or Radio Station to wake up to. Create a wakeup call in the normal manner within Control4. This allows you to make setting for lights and temperature. The rest of the programming depends on whether you want to wake up to a radio station on Sonos or a Playlist.

Sonos Radio/Pandora/SiriusXM

To select a radio station, simply choose the media as you usually would for a wakeup scene. The selection process is the same as for selecting a radio station from a keypad as described above.

Sonos Playlist Because the Sonos Playlists are not defined within Composer they do not appear as a selectable Media type like the radio stations do. However with a little extra programming they can be used. You can program Control4 to react to when a Wakeup call executes and then perform another action. There is one important thing to remember about this method is that as you will be hard coding which room the playlist will play in you will need to create separate Wakeup Events for each room. So you may need a ‘Master Wakeup Call’, ‘John’s Wakeup Call’ and ‘Jane’s Wakeup Call’. Otherwise your music may play in the wrong room. As you are reading this you are probably thinking that radio stations are easier and we would agree that they are! On the left hand side of the Programming screen select Wakeup and then the wakeup call you want to program. We’ve selected the Master Wakeup Call. Then on the right hand side of the screen select in this case the Master Bedroom Sonos Amplifier. Then follow the instructions on the keypad programming to select the correct Playlist.


As an example here we’ve selected a playlist called ‘Master Bed Morning Music’. Repeat this for your other rooms.

Driver Options There are some options on the Properties page of the driver that you can use to set different preferences.

The ‘On Power Off’ property determines what happens to the currently playing music when the room turns off. The options are to Pause the music, Stop the music but keep the current music queue (setting the position in the queue back to the start), or to stop the music and Clear the Queue. Set this to your preference.

Home Theaters In a Home Theater you will most likely use one of the unamplified Sonos controllers and connect this to your home theater receiver. In this case you should select that this Sonos ZonePlayer has a fixed volume line out. This means that volume control is exclusively determined by the home theater receiver which will be under control of Control4.


This means that in Home Theaters the best method of selecting and controlling the Sonos system is via a Control4 device such as a touch screen. This will ensure that your client can both select music and control volume from the same device. You can still use the Sonos controllers or iPhone app to select music, but you cannot control the volume from these devices.


The Driver in Action On a Control4 7” touchscreen the driver works as follows: From the home screen select Listen. If you have hidden the elements suggested earlier you will see the icons below. Stations will contain the radio stations you have set up for the various radio services. The Sonos icon will lead you to the music library and music streaming.

Sonos will then appear with the name you gave it in Composer with an iPod icon. Select this and the Sonos will appear as below. This is also the screen which appears when you press Music Library.


The buttons on the left allow access to the Music Library, Music Service, Sonos Playlists, Music Services, Music Queue and Radio. The More… button leads to a second page which will be described later. Selecting Artists for example will produce the following screen.

You can use the scroll bar to scroll down the list. If selecting music using the remote control the numeric keys allow quick access to any letter in the alphabet. This shows all the Albums we have on the Sonos system by the Beach Boys. The ‘All’ option at the top of the list would allow us to select from all the music we have by the Beach Boys. So if there were six albums here it would show the tracks from all six albums.


You can also select an individual album from the list in which case the following screen is shown.

This lists all of the tracks available on the album. The Complete Album option at the top of the list will allow you to play all of the tracks in the album. Alternatively you can select an individual track. By default when you select an item to play you will be presented with the following screen:


This provides the same options as with the Sonos controllers to either: Play Now, Play Next, Add to the End of Queue or to Play Now and Replace Queue. We have also provided the option to set a default action rather than present this list of options. This is covered later in the documentation. Music Services are described under each Music Service heading earlier in this document.

Selecting one of these services allows you to navigate them in order to select music. Napster for example…


Pandora would looks like this… The first time you access this you need to press Update Pandora station list. You also need to do this whenever you add new stations to your Pandora radio.

The Music Queue button allows you skip to any position in the current music queue.

The ‘Clear Queue’ option at the top of the queue allows you to clear the current music queue. This will also stop music currently playing on this ZonePlayer. The ‘Save Queue’ option will save the current music queue with a name in the format ‘Date Time’ as we cannot provide a keyboard for you to type a name. This playlist can then be renamed using the Sonos Desktop Controller software.


The image above shows the Sonos Playlists. One named Party Music through the Sonos Desktop Controller software and one which was a music queue saved using the Control4 Save Queue feature. It is named at with the date and time it was saved. Under iPod Docks you will first see the driver search for any iPods docked. After a few seconds the name of the docked iPod will appear together with the dock name in brackets.


When you select a dock you have two options. Play from the iPod allows you to playback anything that you have manually queued up on the iPod. This allows you to amplify and playback music that’s not directly stored on the iPod such as another streaming service. The Browse button allows you to select music from the iPod.


This brings up the standard browsing options. Simply drill down these to select the music you require. If you press the More… button you will be presented with more choices as follows:

The Radio Stations choice will show you the list of favorite radio stations on the Sonos system – although you are more likely to choose these from the Control4 radio section.


The Default Action button allows you to choose the default action when a track or album is selected to play as follows:

The initial Default Action is ‘Ask’ as shown above and identified by the ‘(Set)’ after the choice. This displays the ‘Play Now’, ‘Play Next’ and so on list every time music is selected. Alternatively you can select a different action that takes place each time you select a track. The selected item is always shown with ‘(Set)’ after the option name. The other option on this second screen is Management. This allows you to update the music index. This instructs the Sonos system to rescan its music library. The Sonos system undertakes this scan itself; therefore it does not affect the performance of the Control4 system.

Now Playing Track and Progress Timer

Due to the limitations of the Control4 architecture we need to ask the Sonos player what the currently playing track is and what the position in the track is. The Control4 system will request this information every 5 seconds. This means that the progress timer only updates every 5 seconds. If a new track is selected using one of the Sonos controllers the Now Playing information on the Control4 interfaces will update when Control4 next requests the Now Playing information. It may therefore take up to 5 seconds for the interfaces to update – however on average it will be 2.5 seconds.


The Now Playing screen shows the Track, Artist and Album details along with the progress timer, which is updated every 5 seconds. The Cover Art is shown on Control4 OS 2.x if a cover has been associated with the track.


Radio Stations

Radio stations can also be more logically selected using the Control4 ‘Radio’ option from the main menu. If you have replicated the Sonos favorite radio stations within the Control4 media section as described earlier in this document they can be displayed and selected as regular radio stations.

You can set up any of the Sonos Favorite Radio Stations, iheart radio stations, Pandora Radio stations or Sirius Internet radio stations to be displayed in this list.


Pandonos Pandonos is a separate add on 4Store app for the Sonos driver and must be purchased separately from the 4Store once the Sonos driver is installed. Pandonos gives you more control over Pandora on your system. Specifically it allows you to add new Pandora stations from your Control4 system by typing in the name of the Artist or Track to create a station from. Like all 4Store apps it only runs on flash enabled Navigators such as Control4 touchpanels and OSD. It does not run on the iOS or Android apps.

For more details on Pandonos please visit our website.


Troubleshooting If the driver does not appear to be working…

1. Check music plays on the Sonos system using a Sonos controller If music does not play using a Sonos controller then it is a problem with the Sonos system. The Control4 system cannot select or play music unless the Sonos system is working correctly.

2. Check the Ethernet connection to the Sonos and your network. Is the Sonos connected to your network? If not check all your network connections.

3. If the Sonos checks out OK open Composer and connect to the Director. Highlight the Sonos in your project under System Design. On the Properties page check that the Activation Status reads Activated. If not re-enter your Activation Key and press Set. The Activation Status should now show Activated.

4. Check the MAC address on the Network tab for the Sonos in the Connections view. This must be the same as the IP address of the Sonos system.

5. Has the router been changed or restarted? If so the Sonos system may now have a conflicting MAC address or Control4 may not yet have picked up on the new IP address. Restart all of the Sonos ZonePlayers and allow Control4 2 minutes to discover this new MAC address.

6. Check on the Properties tab for the Sonos. Is there a message in the Driver Information box? This will report if there is a problem with the connection between the Sonos and Control4

7. If the problem is with a music service through Control4, please press the 'Re-build Music Services' option at the bottom of the Music Services list.

8. If not… Then contact us for support either by phone or via a support ticket on our website.

If you are not seeing one of either the Amplifier or iPod parts of the driver in a particular room then you have a problem in the Composer Connections.


Activating the Driver Drivers will not work until they are activated. In order to activate a driver you must have a dealer account with us. You can register at www.extravegetables.com/user/register The controller on which you want to activate the driver must be connected to the Internet. Activation is not possible unless the controller has an Internet connection.

Activating a demo license

All drivers can be activated for a FREE 14 day trial. You can demo the driver on as many systems as you like, but you can only demo it once on each system. Demo activations are not extendable or repeatable.

To activate the driver in demo mode type the word Demo followed by a – and then your extravegetables.com username. So as per the example above you would replace the XXXXX with your username. You will then see the Activation Status change to ACTIVATED.

On your dealer login under licenses you will now see that the demo has been initiated for this driver – and the date at which the demo will expire.

Purchasing a permanent license

To purchase a permanent license login to your dealer account and make your purchase through our website. Remember you no longer need to specify the MAC address of the controller in advance. You will automatically receive your license key within a few minutes of purchase 24/7. Your license key will also appear in your dealer account as ‘Available for activation’.

Carefully copy and paste the License key into the Activation Key field and press Set. The driver will then verify the code via the Internet and show Activated. On your dealer login you will also see the license is active and in use, together with the system details.