onkyo_eiscp_ruby 0.0.1 → 0.0.2

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/bin/onkyo-server.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'eiscp/eiscp_server'
+
+puts "Starting server on 60128..."
+
+EISCPServer.new

data/lib/eiscp/eiscp.rb

@@ -6,10 +6,13 @@ class EISCP
   ONKYO_PORT = 60128
   ONKYO_MAGIC = EISCPPacket.new("ECN", "QSTN", "x").to_s
 
+  # Create a new EISCP object to communicate with a receiver.
+
   def initialize(host)
     @host = host
   end
 
+  # Internal method for receiving data with a timeout
 
   def self.recv(sock, timeout = 0.5)
     data = []
@@ -34,6 +37,9 @@ class EISCP
 
     end
   end
+  
+  # Returns an array of arrays consisting of a discovery response packet string
+  # and the source ip address of the reciever.
 
   def self.discover
     sock = UDPSocket.new
@@ -62,6 +68,8 @@ class EISCP
 
     end
   end
+  
+  # Sends a packet string on the network
 
   def send(eiscp_packet)
     sock = TCPSocket.new @host, ONKYO_PORT
@@ -69,12 +77,16 @@ class EISCP
     sock.close
   end
 
+  # Send a packet string and return recieved data string.
+  
   def send_recv(eiscp_packet)
     sock = TCPSocket.new @host, ONKYO_PORT
     sock.puts eiscp_packet
     puts EISCP.recv(sock, 0.5)
   end
 
+  # Open a TCP connection to the host and print all received messages until
+  # killed.
 
   def connect(&block)
     sock = TCPSocket.new @host, ONKYO_PORT

data/lib/eiscp/eiscp_packet.rb

@@ -1,5 +1,9 @@
 require 'eiscp/iscp_message'
 
+# Public: Encapsulates ISCP Messages in eISCP packets to send on the network.
+# You can alsoe use the class method 'parse' to create objects from strings
+# captured from the network using the EISCP class.
+
 class EISCPPacket
   
   MAGIC = "ISCP"
@@ -10,15 +14,24 @@ class EISCPPacket
   attr_accessor :header
   attr_reader :iscp_message
 
+  # Create a new EISCPPacket object with a given command and parameter
+  # -+command+ - an ISCP command like "PWR" for "system-power"
+  # -+parameter+ - an ISCP command parameter like "01" for "on" for 
+  # "system-power"
+  
   def initialize(command, parameter, unit_type = "1", start = "!")
     @iscp_message = ISCPMessage.new(command, parameter, unit_type, start)
     @header = { :magic => MAGIC, :header_size => HEADER_SIZE, :data_size => @iscp_message.to_s.length, :version => VERSION, :reserved => RESERVED }
   end
 
+  # Returns a raw packet string for sending on the network using EISCP object.
+
   def to_s
     return [ @header[:magic], @header[:header_size], @header[:data_size], @header[:version], @header[:reserved], @iscp_message.to_s ].pack("A4NNAa3A*")
   end
 
+  # Returns an EISCPPacket from a raw packet string
+
   def self.parse(eiscp_message_string)
     array = eiscp_message_string.unpack("A4NNAa3A*")
     iscp_message = ISCPMessage.parse(array[5])

data/lib/eiscp/eiscp_server.rb

@@ -0,0 +1,21 @@
+require 'socket'
+require 'eiscp/eiscp_packet'
+require 'eiscp/eiscp'
+
+# Mock server that only responds to ECNQSTN.
+
+class EISCPServer
+
+  ONKYO_DISCOVERY_RESPONSE =  EISCPPacket.new("ECN", "TX-NR609/60128/DX/001122334455")
+
+  # Create/start the server object.
+
+  def initialize
+    Socket.udp_server_loop("255.255.255.255", EISCP::ONKYO_PORT) do |msg, msg_src|
+      msg_src.reply ONKYO_DISCOVERY_RESPONSE.to_s
+      puts msg
+    end
+  end
+
+end
+

data/lib/eiscp.rb

@@ -1,6 +1,7 @@
-# Public: Create and send EISCP messages to control Onkyo receivers.
+# Create and send EISCP messages to control Onkyo receivers.
+
 class EISCP
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end
 
 require 'eiscp/eiscp'

data/onkyo_eiscp_ruby.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
   s.test_files = Dir[ 'test/tc*.rb' ]
   s.executables = %w(
     onkyo.rb
+    onkyo-server.rb
   )
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onkyo_eiscp_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,26 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-01 00:00:00.000000000 Z
+date: 2014-01-02 00:00:00.000000000 Z
 dependencies: []
 description: ! "\n    Use the provided binary script or require the library for use
   in your scripts.\n  "
 email: mikebrodrigues@gmail.com
 executables:
 - onkyo.rb
+- onkyo-server.rb
 extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- bin/onkyo-server.rb
 - bin/onkyo.rb
+- lib/eiscp/eiscp_server.rb
 - lib/eiscp/eiscp.rb
 - lib/eiscp/eiscp_packet.rb
 - lib/eiscp/command.rb
 - lib/eiscp/iscp_message.rb
 - lib/eiscp.rb
-- lib/server.rb
 - test/tc_command.rb
 - test/tc_iscp_message.rb
 - test/tc_eiscp.rb

data/lib/server.rb

@@ -1,15 +0,0 @@
-require 'socket'
-
-class EISCPServer
-
-  ONKYO_DISCOVERY_RESPONSE = "ISCP\u0000\u0000\u0000\u0010\u0000\u0000\u0000&\u0001\u0000\u0000\u0000!1ECNTX-MR909/60128/DX/0009B0C727FE\u0019\r\n\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000"
-  def initialize
-    Socket.udp_server_loop("255.255.255.255", 60128) do |msg, msg_src|
-      msg_src.reply ONKYO_DISCOVERY_RESPONSE
-      puts msg
-    end
-  end
-end
-
-EISCPServer.new
-