Project

frisky

0.0
No commit activity in last 3 years
No release in over 3 years
frisky provides the tools you need to build an app that runs in a UPnP environment.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Runtime

 Project Readme

Frisky

A Ruby implementation of an SSDP (UPnP) client.

Build Status Coverage Status

Description

Originally forked from playful, this gem reduces the scope to just being an SSDP client, reducing dependencies considerably and making it easier to declare this stable and ready to use.

If you have a device that implements UPnP, you can most likely discover it programmatically with frisky.

SSDP Searches

An SSDP search simply sends the M-SEARCH command out to the multicast group and listens for responses for a given (or default of 5 seconds) amount of time. The return from this depends on if you're running it within an EventMachine reactor or not. If not, it returns an Array of responses as Hashes, where keys are the header names, values are the header values. Take a look at the SSDP.search docs for more on the options here.

require 'frisky/ssdp'

# Search for all devices (do an M-SEARCH with the ST header set to 'ssdp:all')
all_devices = Frisky::SSDP.search                         # this is default
all_devices = Frisky::SSDP.search 'ssdp:all'              # or be explicit
all_devices = Frisky::SSDP.search :all                    # or use short-hand

# Search for root devices (do an M-SEARCH with ST header set to 'upnp:rootdevices')
root_devices = Frisky::SSDP.search 'upnp:rootdevices'
root_devices = Frisky::SSDP.search :root                  # or use short-hand

# Search for a device with a specific UUID
my_device = Frisky::SSDP.search 'uuid:3c202906-992d-3f0f-b94c-90e1902a136d'

# Search for devices of a specific type
my_media_server = Frisky::SSDP.search 'urn:schemas-upnp-org:device:MediaServer:1'

# All of these searches will return something that looks like
# => [
#      {
#         :control => "max-age=1200",
#         :date => "Sun, 23 Sep 2012 20:31:48 GMT",
#         :location => "http://192.168.10.3:5001/description/fetch",
#         :server => "Linux-i386-2.6.38-15-generic-pae, UPnP/1.0, PMS/1.50.0",
#         :st => "upnp:rootdevice",
#         :ext => "",
#         :usn => "uuid:3c202906-992d-3f0f-b94c-90e1902a136d::upnp:rootdevice",
#         :length => "0"
#       }
#     ]

If you do the search inside of an EventMachine reactor, as the Frisky::SSDP::Searcher receives and parses responses, it adds them to the accessor #discovery_responses, which is an EventMachine::Channel. This lets you subscribe to the responses and do what you want with them as you receive them.

require 'frisky/ssdp'

EM.run do
  searcher = Frisky::SSDP.search 'uuid:3c202906-992d-3f0f-b94c-90e1902a136d'

  # Create a deferrable object that can be notified when the device we want
  # has been found and created.
  device_controller = EventMachine::DefaultDeferrable.new

  # This callback will get called when the device_creator callback is called
  # (which is called after the device has been created).
  device_controller.callback do |device|
    p device.service_list.first.service_type          # "urn:schemas-upnp-org:service:ContentDirectory:1"

    # SOAP actions are converted to Ruby methods--show those
    p device.service_list.first.singleton_methods     # [:GetSystemUpdateID, :Search, :GetSearchCapabilities, :GetSortCapabilities, :Browse]

    # Call a SOAP method defined in the service.  The response is extracted from the
    # XML SOAP response and the value is converted from the UPnP dataType to
    # the related Ruby type.  Reponses are always contained in a Hash, so as
    # to maintain the relation defined in the service.
    p device.service_list.first.GetSystemUpdateID     # { :Id => 1 }
  end

  # Note that you don't have to check for items in the Channel or for when the
  # Channel is empty: EventMachine will pop objects off the Channel as soon as
  # they're put there and stop when there are none left.
  searcher.discovery_responses.pop do |notification|
    # Do stuff here.
  end
end

Requirements

  • Rubies (tested)
    • 1.9.3
    • 2.0.0
    • 2.1.0
  • Gems
    • eventmachine
    • em-http-request
    • em-synchrony
    • nori
    • log_switch
    • savon

Install

$ gem install frisky

Copyright

Copyright (c) 2015-2016 Jon Frisby Copyright (c) 2012-2014 Steve Loveless

See LICENSE for details.