onkyo_eiscp_ruby 0.0.1

data/lib/eiscp/command.rb

@@ -0,0 +1,80 @@
+require 'yaml'
+require 'eiscp/eiscp'
+require 'ostruct'
+
+module Command
+
+  @@yaml_file_path = File.join(File.expand_path(File.dirname(__FILE__)), '../../eiscp-commands.yaml')
+  @@yaml_object = YAML.load(File.read(@@yaml_file_path))
+  @@modelsets = @@yaml_object["modelsets"]
+  @@yaml_object.delete("modelsets")
+  @@zones = @@yaml_object.map{|k, v| k}
+  @@zones.each {|zone| class_variable_set("@@#{zone}", nil) }
+  @@main = @@yaml_object['main']
+  
+
+  @@zones.each do |zone|
+    Command.class_variable_set("@@#{zone}", "[]")
+  end
+
+
+
+  def self.command_to_name(command)
+    return @@main[command]['name']
+  end
+
+  def self.name_to_command(name)
+    @@main.each_pair do |command, attrs|
+      if attrs['name'] == name
+        return command
+      end
+    end
+  end
+
+  def self.command_value_to_value_name(command, value)
+    return @@main[command]['values'][value]['name'] 
+  end
+
+  def self.command_value_name_to_value(command, name)
+    @@main[command]['values'].each do |k, v|
+      if v['name'] == name.to_s
+        return k
+      end
+    end
+  end
+
+
+  def self.description_from_name(name)
+    @@main.each_pair do |command, attrs|
+      if attrs['name'] == name
+        return command['description']
+      end
+    end
+  end
+
+  def self.description_from_command(command)
+    return @@main[command]['description']
+  end
+
+  def self.description_from_command_value(command, value)
+    return @@main[command]['values'].select do |k, v| 
+      if k == value
+        return v['description']
+      end
+    end
+  end
+
+  def self.list_all_commands
+    @@main.each_pair do |command, attrs|
+      puts "#{command} - #{attrs['name']}: #{attrs['description']}"
+      attrs['values'].each_pair do |k, v|
+        puts "--#{k}:#{v}"
+      end
+    end
+  end
+
+  def self.list_compatible_commands
+
+  end
+end
+

data/lib/eiscp/eiscp.rb

@@ -0,0 +1,113 @@
+require 'socket'
+require 'eiscp/eiscp_packet.rb'
+require 'eiscp/iscp_message.rb'
+
+class EISCP
+  ONKYO_PORT = 60128
+  ONKYO_MAGIC = EISCPPacket.new("ECN", "QSTN", "x").to_s
+
+  def initialize(host)
+    @host = host
+  end
+
+
+  def self.recv(sock, timeout = 0.5)
+    data = []
+    while true
+      ready = IO.select([sock], nil, nil, timeout)
+      if ready != nil
+        then readable = ready[0]
+      else
+        return data
+      end
+
+
+      readable.each do |socket|
+        begin
+          if socket == sock
+            data << sock.recv_nonblock(1024).chomp
+          end
+        rescue IO::WaitReadable
+          retry
+        end
+      end
+
+    end
+  end
+
+  def self.discover
+    sock = UDPSocket.new
+    sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_BROADCAST, true)
+    sock.send(ONKYO_MAGIC, 0, '<broadcast>', ONKYO_PORT)
+    data = []
+    while true
+      ready = IO.select([sock], nil, nil, 0.5)
+      if ready != nil
+        then readable = ready[0]
+      else
+        return data
+      end
+
+
+      readable.each do |socket|
+        begin
+          if socket == sock
+            msg, addr = sock.recvfrom_nonblock(1024)
+            data << [msg, addr[2]]
+          end
+        rescue IO::WaitReadable
+          retry
+        end
+      end
+
+    end
+  end
+
+  def send(eiscp_packet)
+    sock = TCPSocket.new @host, ONKYO_PORT
+    sock.puts eiscp_packet
+    sock.close
+  end
+
+  def send_recv(eiscp_packet)
+    sock = TCPSocket.new @host, ONKYO_PORT
+    sock.puts eiscp_packet
+    puts EISCP.recv(sock, 0.5)
+  end
+
+
+  def connect(&block)
+    sock = TCPSocket.new @host, ONKYO_PORT
+    while true
+      ready = IO.select([sock], nil, nil, nil)
+      if ready != nil
+        then readable = ready[0]
+      else
+        return
+      end
+
+      readable.each do |socket|
+        begin
+          if socket == sock
+            data = sock.recv_nonblock(1024).chomp
+            if block_given?
+              yield data
+            else
+              puts data
+            end
+          end
+        rescue IO::WaitReadable
+          retry
+        end
+      end
+
+    end
+  end
+
+end
+
+
+
+
+
+

data/lib/eiscp/eiscp_packet.rb

@@ -0,0 +1,38 @@
+require 'eiscp/iscp_message'
+
+class EISCPPacket
+  
+  MAGIC = "ISCP"
+  HEADER_SIZE = 16
+  VERSION = "\x01"
+  RESERVED = "\x00\x00\x00"
+
+  attr_accessor :header
+  attr_reader :iscp_message
+
+  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
+
+  def to_s
+    return [ @header[:magic], @header[:header_size], @header[:data_size], @header[:version], @header[:reserved], @iscp_message.to_s ].pack("A4NNAa3A*")
+  end
+
+  def self.parse(eiscp_message_string)
+    array = eiscp_message_string.unpack("A4NNAa3A*")
+    iscp_message = ISCPMessage.parse(array[5])
+    packet = EISCPPacket.new(iscp_message.command, iscp_message.parameter, iscp_message.unit_type, iscp_message.start)
+    packet.header = {
+      :magic => array[0],
+      :header_size => array[1],
+      :data_size => array[2],
+      :version => array[3],
+      :reserved => array[4]
+    }
+    return packet
+  end
+
+end
+
+

data/lib/eiscp/iscp_message.rb

@@ -0,0 +1,24 @@
+class ISCPMessage
+
+  attr_accessor :start
+  attr_accessor :unit_type
+  attr_accessor :command
+  attr_accessor :parameter
+
+  def initialize(command, parameter, unit_type = "1", start = "!")
+    @unit_type = unit_type
+    @start = start
+    @command = command
+    @parameter = parameter
+  end
+
+  def self.parse(msg_string)
+    match = msg_string.match(/(?<start>!)(?<unit_type>\w)(?<command>[A-Z]{3})(?<parameter>\S+)/)
+    ISCPMessage.new(match[:command], match[:parameter], match[:unit_type], match[:start])
+  end
+
+  def to_s
+    return "#{@start + @unit_type + @command + @parameter}\r"
+  end
+
+end

data/lib/eiscp.rb

@@ -0,0 +1,9 @@
+# Public: Create and send EISCP messages to control Onkyo receivers.
+class EISCP
+  VERSION = '0.0.1'
+end
+
+require 'eiscp/eiscp'
+require 'eiscp/eiscp_packet'
+require 'eiscp/iscp_message'
+require 'eiscp/command'

data/lib/server.rb

@@ -0,0 +1,15 @@
+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
+

data/onkyo_eiscp_ruby.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name         = 'onkyo_eiscp_ruby'
+  s.version      = File.read(File.expand_path('VERSION', File.dirname(__FILE__))).strip
+  s.platform     = Gem::Platform::RUBY
+  s.summary      = 'Manipulate Onkyo stereos with the eISCP protocol'
+  s.files        = Dir.glob('{bin,config,lib,test,doc}/**/*') +
+    ["VERSION", "onkyo_eiscp_ruby.gemspec", "eiscp-commands.yaml"]
+  s.extra_rdoc_files = ["README.md"]
+  s.require_path = 'lib'
+
+  s.homepage     = "https://github.com/mikerodrigues/onkyo_eiscp_ruby"
+
+  s.description  = %q(
+    Use the provided binary script or require the library for use in your scripts.
+  )
+
+  s.author       = "Michael Rodrigues"
+  s.email        = "mikebrodrigues@gmail.com"
+
+  s.test_files = Dir[ 'test/tc*.rb' ]
+  s.executables = %w(
+    onkyo.rb
+  )
+
+end

data/test/tc_command.rb

@@ -0,0 +1,30 @@
+require_relative "../lib/eiscp/command.rb"
+require "test/unit"
+
+class TestCommand < Test::Unit::TestCase
+
+  def test_command_to_name
+    assert_equal(Command.command_to_name("PWR"), "system-power")
+  end
+
+  def test_name_to_command
+    assert_equal(Command.name_to_command("system-power"), "PWR")
+  end
+
+  def test_command_value_to_value_name
+    assert_equal(Command.command_value_to_value_name("PWR", "01"), "on")
+  end
+
+  def test_command_value_name_to_value
+    assert_equal(Command.command_value_name_to_value("PWR", "on"), "01")
+  end
+
+  def test_description_from_name
+    assert_equal(Command.description_from_name("system-power"), "System Power Command")
+  end
+
+  def test_description_from_command
+    assert_equal(Command.description_from_command("PWR"), "System Power Command")
+  end
+
+end

data/test/tc_eiscp.rb

@@ -0,0 +1,6 @@
+require_relative "../lib/eiscp/eiscp.rb"
+require "test/unit"
+
+class TestEISCP
+
+end

data/test/tc_eiscp_packet.rb

@@ -0,0 +1,17 @@
+require_relative "../lib/eiscp/eiscp_packet.rb"
+require "test/unit"
+
+class TestEISCPPacket < Test::Unit::TestCase
+
+  DISCOVERY_STRING = "ISCP\x00\x00\x00\x10\x00\x00\x00\n\x01\x00\x00\x00!xECNQSTN\r"
+  DISCOVERY_PACKET = EISCPPacket.new('ECN', 'QSTN', 'x', '!')
+
+  def test_create_discovery_packet_string
+    assert_equal(DISCOVERY_PACKET.to_s, DISCOVERY_STRING)
+  end
+
+  def test_parse_discovery_packet_string
+    assert_equal(EISCPPacket.parse(DISCOVERY_STRING).to_s, DISCOVERY_PACKET.to_s)
+  end
+
+end

data/test/tc_iscp_message.rb

@@ -0,0 +1,14 @@
+require_relative "../lib/eiscp/iscp_message.rb"
+require "test/unit"
+
+class TestISCPMessage <  Test::Unit::TestCase
+
+  def test_create_discovery_iscp_message
+    assert_equal(ISCPMessage.new("ECN", "QSTN", "x", "!").to_s, "!xECNQSTN\r")
+  end
+
+  def test_parse_discovery_iscp_message
+    assert_equal(ISCPMessage.parse("!xECNQSTN\r").to_s, "!xECNQSTN\r")
+  end
+
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: onkyo_eiscp_ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Michael Rodrigues
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-01 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
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- bin/onkyo.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
+- test/tc_eiscp_packet.rb
+- VERSION
+- onkyo_eiscp_ruby.gemspec
+- eiscp-commands.yaml
+- README.md
+homepage: https://github.com/mikerodrigues/onkyo_eiscp_ruby
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Manipulate Onkyo stereos with the eISCP protocol
+test_files:
+- test/tc_command.rb
+- test/tc_iscp_message.rb
+- test/tc_eiscp.rb
+- test/tc_eiscp_packet.rb
+has_rdoc: