sonos 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2500064f1c4f07a8064c691be658195d7245c15f
-  data.tar.gz: 30d941094b116b5c4998c8f6f2cbdf8862de11b9
+  metadata.gz: 0b7916243ad3a1b97d2b2480654b8a9413fdb36f
+  data.tar.gz: 327c59e209b9bb9193f799c7aded77d7f15fc697
 SHA512:
-  metadata.gz: ae738d359b88707fbb0913d26f8760690ba497d3c7d1d9bc8cc4675e637e4e6c9f9617e2906c1aef23b407f710c15761746372d299445c8209f34116cbcb1df7
-  data.tar.gz: 438b11f8ffa8033572c44e99bfe91540a3e634558030a248540ec130f1e73b606dc53025fd641371de1e4a8aad151b943b071f09cdf2a4d07c4b1e167e862693
+  metadata.gz: afbc45559d030536fd2a4c9e465ce1402a3f6dbae3a77f1893806b9e419e6589fbfe4f3b790b745ee6ecd0e76e150956fe83d414f748fead7f9f9f0eacb0b215
+  data.tar.gz: 7d81b054264e7bd0884b423c2cc2c034e02c0d94a53c055cdcc8a41be317656f0ae8168466173ad3d3ed70574eb79bf6375e3480579649c28be7bc2080beb269

data/Changelog.markdown

@@ -1,4 +1,43 @@
-### Version 0.3.0 — February 2, 2012
+### Version 0.3.6 — August 20, 2014
+
+* Unbreak clearing the queue
+* Add voiceover
+* Improve playlist handling
+* Add support to queue Rdio tracks/albums
+* Add setting a sleep timer
+* Allow to queue items at arbitrary positions in the playlist
+* Make party mode initialization more robust
+* Add support to create stereo pair
+
+### Version 0.3.5 — February 4, 2014
+
+* Allow to queue Spotify tracks/albums/playlists/top lists/starred
+* Add basic line in support
+* Allow toggling status light
+
+### Version 0.3.4 — November 1, 2013
+
+* Rework UPNP subscription / unsubscriptino process
+* Add shuffle, repeat and crossfade
+* Add alarms
+* Add support for ZP120, Play:1 devices
+
+### Version 0.3.3 — June 29, 2013
+
+* Add party mode to CLI
+* Add support for Sub and Soundbar devices
+
+### Version 0.3.1 — June 28, 2013
+
+* Allow to specify a non-nil default IP
+* Add CLI command to list groups
+* Add ability to detect if speaker has music
+* Add more information to `now_playing` output
+* Support add/remove to queue
+* Add support for ZP80 devices
+* Add party mode
+
+### Version 0.3.0 — February 2, 2013
 
 * System owns groups that reflect the topology
 * Group and ungroup speakers

data/Readme.markdown

@@ -59,6 +59,7 @@ speaker.add_to_queue 'http://assets.samsoff.es/music/Airports.mp3'
 speaker.remove_from_queue(speaker.queue[:items].last[:queue_id])
 speaker.save_queue 'Jams'
 speaker.clear_queue
+speaker.set_sleep_timer '00:13:00'
 ```
 
 Or go into what the official control from Sonos, Inc. calls "Party
@@ -75,6 +76,38 @@ system.party_over
 
 All of this is based off of the raw `Sonos.system.topology`.
 
+### Services
+
+Currently there is support to queue items from the following services, provided
+the service accounts are set up:
+
+- Spotify
+  - tracks
+  - albums
+  - playlists
+  - top lists
+  - starred
+- Rdio
+  - tracks
+  - albums
+
+The way to add items differs per service at moment:
+
+For Spotify only the 'Spotify URI' is required:
+
+``` ruby
+speaker.add_spotify_to_queue('2CwulIyrmEYwbUWzcEVIhR')
+```
+
+Whereas for Rdio more information needs to be provided:
+
+``` ruby
+speaker.add_rdio_to_queue({
+  :track => '42083055',
+  :album => '3944937',
+  :username => 'RDIO_USERNAME_HERE' })
+```
+
 ### CLI
 
 There is a very limited CLI right now. You can run `sonos devices` to get the IP of all of your devices.
@@ -91,6 +124,7 @@ You can also run `sonos pause_all` to pause all your Sonos groups.
 * Detect stereo pair
 * CLI client for everything
 * Nonblocking calls with Celluloid::IO
+* Unified method of adding items from music services
 
 ### Features
 
@@ -98,14 +132,10 @@ You can also run `sonos pause_all` to pause all your Sonos groups.
 * Pause all (there is no play all in the controller, we could loop through and do it though)
 * Party Mode
 * Line-in
-* Toggle cross fade
-* Toggle shuffle
-* Set repeat mode
 * Search music library
 * Browse music library
 * Skip to song in queue
 * Alarm clock
-* Sleep timer
 * Pandora doesn't use the Queue. I bet things are all jacked up.
 * CONNECT (and possibly PLAY:5) line in settings
     * Source name
@@ -118,7 +148,6 @@ You can also run `sonos pause_all` to pause all your Sonos groups.
 If we are implementing everything the official Sonos Controller does, here's some more stuff:
 
 * Set zone name and icon
-* Create stero pair
 * Support for SUB
 * Support for DOCK
 * Support for CONNECT:AMP (not sure if this is any different from CONNECT)

data/lib/sonos.rb

@@ -3,6 +3,7 @@ require 'sonos/system'
 require 'sonos/discovery'
 require 'sonos/device'
 require 'sonos/group'
+require 'sonos/features'
 
 module Sonos
   PORT = 1400

data/lib/sonos/device/speaker.rb

@@ -1,5 +1,6 @@
 require 'savon'
 require 'sonos/endpoint'
+require 'sonos/features'
 
 module Sonos::Device
 
@@ -11,6 +12,7 @@ module Sonos::Device
     include Sonos::Endpoint::ContentDirectory
     include Sonos::Endpoint::Upnp
     include Sonos::Endpoint::Alarm
+    include Sonos::Features::Voiceover
 
     MODELS = {
       :'S1'    => 'PLAY:1',     # Released Oct 2013

data/lib/sonos/endpoint/a_v_transport.rb

@@ -48,6 +48,12 @@ module Sonos::Endpoint::AVTransport
     }
   end
 
+  # Returns true if the player is not in a paused or stopped state
+  def is_playing?
+    state = get_player_state[:state]
+    !['PAUSED_PLAYBACK', 'STOPPED'].include?(state)
+  end
+
   # Pause the currently playing track.
   def pause
     parse_response send_transport_message('Pause')
@@ -77,7 +83,7 @@ module Sonos::Endpoint::AVTransport
   def previous
     parse_response send_transport_message('Previous')
   end
-  
+
   def line_in(speaker)
     set_av_transport_uri('x-rincon-stream:' + speaker.uid.sub('uuid:', ''))
   end
@@ -90,9 +96,14 @@ module Sonos::Endpoint::AVTransport
     parse_response send_transport_message('Seek', "<Unit>REL_TIME</Unit><Target>#{timestamp}</Target>")
   end
 
+  # Seeks the playlist selection to the provided index
+  def select_track(index)
+    parse_response send_transport_message('Seek', "<Unit>TRACK_NR</Unit><Target>#{index}</Target>")
+  end
+
   # Clear the queue
   def clear_queue
-    parse_response parse_response send_transport_message('RemoveAllTracksFromQueue')
+    parse_response send_transport_message('RemoveAllTracksFromQueue')
   end
 
   # Save queue
@@ -103,9 +114,10 @@ module Sonos::Endpoint::AVTransport
   # Adds a track to the queue
   # @param[String] uri Uri of track
   # @param[String] didl Stanza of DIDL-Lite metadata (generally created by #add_spotify_to_queue)
+  # @param[Integer] position Optional queue insertion position. Leaving this blank inserts at the end.
   # @return[Integer] Queue position of the added track
-  def add_to_queue(uri, didl = '')
-    response = send_transport_message('AddURIToQueue', "<EnqueuedURI>#{uri}</EnqueuedURI><EnqueuedURIMetaData>#{didl}</EnqueuedURIMetaData><DesiredFirstTrackNumberEnqueued>0</DesiredFirstTrackNumberEnqueued><EnqueueAsNext>1</EnqueueAsNext>")
+  def add_to_queue(uri, didl = '', position = 0)
+    response = send_transport_message('AddURIToQueue', "<EnqueuedURI>#{uri}</EnqueuedURI><EnqueuedURIMetaData>#{didl}</EnqueuedURIMetaData><DesiredFirstTrackNumberEnqueued>#{position}</DesiredFirstTrackNumberEnqueued><EnqueueAsNext>1</EnqueueAsNext>")
     # TODO yeah, this error handling is a bit soft. For consistency's sake :)
     pos = response.xpath('.//FirstTrackNumberEnqueued').text
     if pos.length != 0
@@ -115,8 +127,9 @@ module Sonos::Endpoint::AVTransport
 
   # Adds a Spotify track to the queue along with extra data for better metadata retrieval
   # @param[Hash] opts Various options (id, user, region and type)
+  # @param[Integer] position Optional queue insertion position. Leaving this blank inserts at the end.
   # @return[Integer] Queue position of the added track(s)
-  def add_spotify_to_queue(opts = {})
+  def add_spotify_to_queue(opts = {}, position = 0)
     opts = {
       :id     => '',
       :user   => nil,
@@ -153,7 +166,46 @@ module Sonos::Endpoint::AVTransport
       return nil
     end
 
-    add_to_queue(uri, didl_metadata)
+    add_to_queue(uri, didl_metadata, position)
+   end
+
+   # Add an Rdio object to the queue (album or track), anything else can only
+   # be streamed (play now).
+   # @param[Hash] opts Various options (album/track keys, username and type)
+   # @param[Integer] position Optional queue insertion position. Leaving this blank inserts at the end.
+   # @return[Integer] Queue position of the added track(s)
+   def add_rdio_to_queue(opts = {}, position = 0)
+     opts = {
+       :username => nil,
+       :album    => nil,
+       :track    => nil,
+       :type     => 'track',
+       :format   => 'mp3' # can be changed, but only 'mp3' is valid.
+     }.merge(opts)
+
+     return nil if opts[:username].nil?
+
+     # Both tracks and albums require the album key. And tracks need a track
+     # key of course.
+     return nil if opts[:album].nil?
+     return nil if opts[:type] == 'track' and opts[:track].nil?
+
+     # In order for valid DIDL we'll pass an empty :track for albums.
+     opts[:track] = '' if opts[:type] == 'album'
+
+     didl_metadata = "&lt;DIDL-Lite xmlns:dc=&quot;http://purl.org/dc/elements/1.1/&quot; xmlns:upnp=&quot;urn:schemas-upnp-org:metadata-1-0/upnp/&quot; xmlns:r=&quot;urn:schemas-rinconnetworks-com:metadata-1-0/&quot; xmlns=&quot;urn:schemas-upnp-org:metadata-1-0/DIDL-Lite/&quot;&gt;&lt;item id=&quot;00030020_t%3a%3a#{opts[:track]}%3a%3aa%3a%3a#{opts[:album]}&quot; parentID=&quot;0004006c_a%3a%3a#{opts[:album]}&quot; restricted=&quot;true&quot;&gt;&lt;dc:title&gt;&lt;/dc:title&gt;&lt;upnp:class&gt;object.item.audioItem.musicTrack&lt;/upnp:class&gt;&lt;desc id=&quot;cdudn&quot; nameSpace=&quot;urn:schemas-rinconnetworks-com:metadata-1-0/&quot;&gt;SA_RINCON2823_#{opts[:username]}&lt;/desc&gt;&lt;/item&gt;&lt;/DIDL-Lite&gt;"
+
+     case opts[:type]
+     when /track/
+       uri = "x-sonos-http:_t%3a%3a#{opts[:track]}%3a%3aa%3a%3a#{opts[:album]}.#{opts[:format]}?sid=11&amp;flags=32"
+     when /album/
+       type_id = '0004006c_a'
+       uri = "x-rincon-cpcontainer:#{type_id}%3a%3a#{opts[:album]}"
+     else
+       return nil
+     end
+
+     add_to_queue(uri, didl_metadata, position)
    end
 
   # Removes a track from the queue
@@ -180,6 +232,19 @@ module Sonos::Endpoint::AVTransport
     parse_response send_transport_message('BecomeCoordinatorOfStandaloneGroup')
   end
 
+  # Set a sleep timer up to 23:59:59
+  # E.g. '00:11:00' for 11 minutes.
+  # @param duration [String] Duration of timer or nil to clear.
+  def set_sleep_timer(duration)
+    if duration.nil?
+      duration = ''
+    elsif duration.gsub(':', '').to_i > 235959
+      duration = '23:59:59'
+    end
+
+    parse_response send_transport_message('ConfigureSleepTimer', "<NewSleepTimerDuration>#{duration}</NewSleepTimerDuration>")
+  end
+
   private
 
   # Play a stream.

data/lib/sonos/endpoint/device.rb

@@ -16,6 +16,22 @@ module Sonos::Endpoint::Device
     parse_response send_device_message('SetLEDState', enabled ? 'On' : 'Off')
   end
 
+  # Create a stereo pair of two speakers.
+  # This does not take into account which type of players support bonding.
+  # Currently only S1/S3 (play:1/play:3) support this but future players may
+  # gain this abbility too. The speaker on which this method is called is
+  # assumed to be the left speaker of the pair.
+  # @param right [Sonos::Device::Speaker] Right speaker
+  def create_pair_with(right)
+    left = self.uid.sub!('uuid:', '')
+    right = right.uid.sub!('uuid:', '')
+    parse_response = send_bonding_message('AddBondedZones', "#{left}:LF,LF;#{right}:RF,RF")
+  end
+
+  def separate_pair
+    parse_response = send_bonding_message('RemoveBondedZones', '')
+  end
+
 private
 
   def device_client
@@ -28,4 +44,10 @@ private
     message = %Q{<u:#{name} xmlns:u="#{DEVICE_XMLNS}"><Desired#{attribute}>#{value}</Desired#{attribute}>}
     device_client.call(name, soap_action: action, message: message)
   end
+
+  def send_bonding_message(name, value)
+    action = "#{DEVICE_XMLNS}##{name}"
+    message = %Q{<u:#{name} xmlns:u="#{DEVICE_XMLNS}"><ChannelMapSet>#{value}</ChannelMapSet></u:#{name}>}
+    device_client.call(name, soap_action: action, message: message)
+  end
 end

data/lib/sonos/features.rb

@@ -0,0 +1,6 @@
+module Sonos
+  module Features
+  end
+end
+
+require 'sonos/features/voiceover'

data/lib/sonos/features/voiceover.rb

@@ -0,0 +1,56 @@
+module Sonos::Features::Voiceover
+
+  # Interrupts the speaker and plays the provided URI. When finished, returns the play head
+  # and state to their original position. Useful for doorbell sounds, announcements, etc.
+  def voiceover!(uri, vol = nil)
+    start_time = Time.now
+
+    result = group_master.with_isolated_state do
+      self.volume = vol if vol
+      group_master.play_blocking(uri)
+    end
+
+    result.merge({duration: (Time.now - start_time )})
+  end
+
+  protected
+
+  def with_isolated_state
+    pause if was_playing = is_playing?
+    unmute if was_muted = muted?
+    previous_volume = volume
+    previous = now_playing
+
+    yield
+
+    # the sonos app does this. I think it tells the player to think of the master queue as active again
+    play uid.gsub('uuid', 'x-rincon-queue') + '#0'
+
+    if previous
+      select_track previous[:queue_position]
+      seek Time.parse("1/1/1970 #{previous[:current_position]} -0000" ).to_i
+
+      self.volume = previous_volume
+      mute if was_muted
+    end
+
+    play if was_playing
+
+    {
+      original_volume: previous_volume,
+      original_state: (was_playing ? 'playing' : 'paused')
+    }
+  end
+
+  def play_blocking(uri)
+    # queue up the track
+    play uri
+
+    # play it
+    play
+
+    # pause the thread until the track is done
+    sleep(0.1) while is_playing?
+  end
+
+end

data/lib/sonos/system.rb

@@ -47,9 +47,12 @@ module Sonos
 
     def find_party_master
       # 1: If there are any pre-existing groups playing something, use
-      # the lowest-numbered group's master
+      # the lowest-numbered group's master. But ensure to only check a
+      # master_speaker that is actually a speaker, and not an Accessory.
       groups.each do |group|
-        return group.master_speaker if group.master_speaker.has_music?
+        if group.master_speaker.speaker? and group.master_speaker.has_music?
+          return group.master_speaker
+        end
       end
 
       # 2: Lowest-number speaker that's playing something
@@ -60,18 +63,18 @@ module Sonos
       # 3: lowest-numbered speaker
       speakers[0]
     end
-    
+
     # Party's over :(
     def party_over
       groups.each { |g| g.disband }
       rescan @topology
     end
-    
+
     def rescan(topology = Discovery.new.topology)
       @topology = topology
       @groups = []
       @devices = @topology.collect(&:device)
-      
+
       construct_groups
 
       speakers.each do |speaker|
@@ -102,6 +105,9 @@ module Sonos
           master = node if node.coordinator == "true"
         end
 
+        # Skip this group if there is no master
+        next if master.nil?
+
         # register other nodes in groups as slave nodes
         nodes = []
         @topology.each do |node|
@@ -110,9 +116,6 @@ module Sonos
           nodes << node unless node.uuid == master.uuid
         end
 
-        # Skip this group if there is no master
-        next if master.nil?
-
         # Add the group
         @groups << Group.new(master.device, nodes.collect(&:device))
       end

data/lib/sonos/version.rb

@@ -1,3 +1,3 @@
 module Sonos
-  VERSION = '0.3.5'
+  VERSION = '0.3.6'
 end

data/sonos.gemspec

@@ -6,8 +6,8 @@ require 'sonos/version'
 Gem::Specification.new do |gem|
   gem.name          = 'sonos'
   gem.version       = Sonos::VERSION
-  gem.authors       = ['Sam Soffes', 'Aaron Gotwalt']
-  gem.email         = ['sam@soff.es', 'gotwalt@gmail.com']
+  gem.authors       = ['Sam Soffes', 'Aaron Gotwalt', 'Jasper Lievisse Adriaanse']
+  gem.email         = ['sam@soff.es', 'gotwalt@gmail.com', 'jasper@humppa.nl']
   gem.description   = 'Control Sonos speakers with Ruby'
   gem.summary       = gem.description
   gem.homepage      = 'https://github.com/soffes/sonos'

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: sonos
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - Sam Soffes
 - Aaron Gotwalt
+- Jasper Lievisse Adriaanse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-04 00:00:00.000000000 Z
+date: 2014-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -71,6 +72,7 @@ description: Control Sonos speakers with Ruby
 email:
 - sam@soff.es
 - gotwalt@gmail.com
+- jasper@humppa.nl
 executables:
 - sonos
 extensions: []
@@ -98,6 +100,8 @@ files:
 - lib/sonos/endpoint/device.rb
 - lib/sonos/endpoint/rendering.rb
 - lib/sonos/endpoint/upnp.rb
+- lib/sonos/features.rb
+- lib/sonos/features/voiceover.rb
 - lib/sonos/group.rb
 - lib/sonos/system.rb
 - lib/sonos/topology_node.rb