bravtroller 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68dcd827b96c8dddcbf6723c1cfbc91f513b92c9
-  data.tar.gz: 675598aee283db134b67f3244133043379680341
+  metadata.gz: 1e5a2d9ff7a5bd2ea66e36a38c24a53a03d93cd9
+  data.tar.gz: c8ee0410e7171bb40b079c6b9bdc4ebe537bddf6
 SHA512:
-  metadata.gz: a39d66e9beaa1e7473078c9019472a7b869be43febbc88e08fae52c16e9c6498bad99bbf4a09a1101d6a8238f9a85cad19b651a9c27bacac16c413d05e7d8cf1
-  data.tar.gz: 83de2af313aec84fb0dafe33d53b23e986a22957e1d2acad2f9835683382b1eaa0a452048c8d62f4fd67426071d412a772448afde1bcbfd26ebf91781be8634f
+  metadata.gz: bfcd5c7408e4adfe6dfb24c6bc917f5646c7830749c36498c6c8aa1b5bc2886ff64691e57476f06873dc164b4bf554d6e94741b074690e6921997d84e4814235
+  data.tar.gz: dca6881a1a3060ba680e3b888c948955e771224f3187f44084951917ea8193e307bb40793c5df2759228d954f9a4b6608cf23114e89668b8d6e9cbdb76fb7819

data/README.md

@@ -0,0 +1,83 @@
+# bravtroller
+Controller for Sony Bravia KDL-50W700.
+
+## Installing
+
+bravtroller is available on [Rubygems](https://rubygems.org). You can install it with:
+
+```
+$ gem install bravtroller
+```
+
+You can also add it to your Gemfile:
+
+```
+gem 'bravtroller'
+```
+
+## What is it?
+
+My Sony TV (a KDL-50W700) has an API. It's a weird combination of custom Sony JSON-over-HTTP and UPnP/SOAP. I wanted a Ruby library to control it, so I created this. I wouldn't be very surprised if other network-enabled Sony devices supported roughly the same interface.
+
+## Authentication
+
+#### Summary
+
+My TV requires that a device authenticate with it before controlling it remotely. You can use `Bravtroller::Authenticator` to do that. This is what happens:
+
+1. `Bravtroller::Authenticator` initiates an authentication request
+2. The TV displays a 4 digit security code
+3. A user-provided block is called to supply the security code (I just used `gets`)
+4. The security code is submitted to the TV, and `Bravtroller` will then be authenticated
+
+#### Example 
+
+```ruby
+require 'bravtroller/client'
+require 'bravtroller/authenticator'
+
+auth = Bravtroller::Authenticator.new( Bravtroller::Client.new(BRAVIA_IP_ADDRESS) )
+
+a.authorized?
+# => false
+
+# This will initiate the procedure described above. The string returned is a cookie used by the SOAP client
+a.authorize { gets.strip }
+# > 3
+# => "auth=xxxxxxx"
+
+a.authorized?
+# => true
+```
+
+## Example usage
+
+The below example assumes Bravtroller has already been authenticated:
+
+#### Remote emulator 
+
+```ruby
+require 'bravtroller/client'
+require 'bravtroller/remote'
+
+remote = Bravtroller::Remote.create( Bravtroller::Client.new(BRAVIA_IP_ADDRESS) )
+
+remote.buttons
+# => ["PowerOff", "Input", "GGuide", "EPG", "Favorites", "Display", "Home", "Options", "Return", "Up", "Down", "Right", "Left", "Confirm", "Red", "Green", "Yellow", "Blue", "Num1", "Num2", "Num3", "Num4", "Num5", "Num6", "Num7", "Num8", "Num9", "Num0", "Num11", "Num12", "VolumeUp", "VolumeDown", "Mute", "ChannelUp", "ChannelDown", "SubTitle", "ClosedCaption", "Enter", "DOT", "Analog", "Teletext", "Exit", "Analog2", "*AD", "Digital", "Analog?", "BS", "CS", "BSCS", "Ddata", "PicOff", "Tv_Radio", "Theater", "SEN", "InternetWidgets", "InternetVideo", "Netflix", "SceneSelect", "Mode3D", "iManual", "Audio", "Wide", "Jump", "PAP", "MyEPG", "ProgramDescription", "WriteChapter", "TrackID", "TenKey", "AppliCast", "acTVila", "DeleteVideo", "PhotoFrame", "TvPause", "KeyPad", "Media", "SyncMenu", "Forward", "Play", "Rewind", "Prev", "Stop", "Next", "Rec", "Pause", "Eject", "FlashPlus", "FlashMinus", "TopMenu", "PopUpMenu", "RakurakuStart", "OneTouchTimeRec", "OneTouchView", "OneTouchRec", "OneTouchStop", "DUX", "FootballMode", "Social"]
+
+remote.press_button('VolumeUp')
+```
+
+#### Wake on LAN
+
+You can also use `Bravtroller` to turn on the TV. Mine responds to the standard WOL magic packet, which is what the below method is doing. Assuming the same setup as above:
+
+```ruby
+remote.power_on
+# => true
+```
+
+The caveat is that `remote` must be constructed while the TV is powered on. This is because:
+
+1. It needs to communicate with the TV to construct the SOAP client. This is an artificial limitation. It could cache the service definition.
+2. It need to determine the hardware address of the TV (necessary to construct the WOL packet). It does this by shelling out and calling `arp`. If the TV isn't in the ARP cache, it won't be able to determine the hardware address. Again -- an artificial limitation.

data/lib/bravtroller/client.rb

@@ -7,6 +7,26 @@ module Bravtroller
       @bravia_address = bravia_address
     end
 
+    def hw_addr
+      arp = `which arp`.strip
+
+      raise RuntimeError.new "Couldn't find arp binary" if arp.empty?
+
+      result = `#{arp} #{@bravia_address}`
+      hw_addr_match = result.match(/((?:[a-f0-9]{1,2}:?){6})/i)
+      if hw_addr_match.nil?
+        nil
+      else
+        # On my mac, octets with the most significant nibble = 0 show as "0" instead of "00"
+        hw_addr_match
+            .captures
+            .first
+            .split(':')
+            .map { |x| "#{x.length == 1 ? '0' : ''}#{x}" }
+            .join(':')
+      end
+    end
+
     def post_request(path, params = {}, headers = {})
       json = JSON.generate(params)
       uri = URI("http://#{@bravia_address}#{path}")

data/lib/bravtroller/remote.rb

@@ -40,8 +40,18 @@ module Bravtroller
       @bravia_client = bravia_client
     end
 
+    def power_on
+      addr = ['<broadcast>', 9]
+      sock = UDPSocket.new
+      sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_BROADCAST, true)
+      packet_data = (([255] * 6) + (@bravia_client.hw_addr.split(':').map(&:hex) * 16)).pack('C*')
+      sock.send(packet_data, 0, addr[0], addr[1])
+
+      true
+    end
+
     def press_button(button_key)
-      raise RuntimeError.new "Undefined buton: #{button_key}" if ircc_codes[button_key].nil?
+      raise RuntimeError.new "Undefined button: #{button_key}" if ircc_codes[button_key].nil?
 
       @ircc_client.X_SendIRCC IRCCCode: ircc_codes[button_key]
     end

data/lib/bravtroller/version.rb

@@ -1,3 +1,3 @@
 module Bravtroller
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bravtroller
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Christopher Mullins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-10 00:00:00.000000000 Z
+date: 2015-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: easy_upnp
@@ -62,6 +62,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE
+- README.md
 - Rakefile
 - bravtroller.gemspec
 - lib/bravtroller.rb