onkyo_eiscp_ruby 0.0.2 → 2.1.1

data/test/tc_parser.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative '../lib/eiscp/parser'
+require_relative '../lib/eiscp/message'
+require 'minitest/autorun'
+
+class TestParser < MiniTest::Test
+  DISCOVERY_PACKET = EISCP::Message.new(command: 'ECN', value: 'QSTN', terminator: "\r\n", unit_type: 'x', start: '!')
+  DISCOVERY_STRING = DISCOVERY_PACKET.to_eiscp
+
+  def test_parse_discovery_iscp_message
+    assert_equal(EISCP::Parser.parse('!xECNQSTN').to_iscp, '!xECNQSTN')
+  end
+
+  def test_parse_iscp_messages
+    assert_equal(EISCP::Parser.parse('PWR 01').to_iscp, '!1PWR01')
+    assert_equal(EISCP::Parser.parse('PWR01').to_iscp, '!1PWR01')
+    assert_equal(EISCP::Parser.parse('!1PWR01').to_iscp, '!1PWR01')
+    assert_equal(EISCP::Parser.parse('!1PWR 01').to_iscp, '!1PWR01')
+  end
+
+  def test_parse_discovery_packet_string
+    assert_equal(EISCP::Parser.parse(DISCOVERY_STRING).to_eiscp, DISCOVERY_PACKET.to_eiscp)
+  end
+
+  def test_parse_human_readable
+    assert_equal(EISCP::Parser.parse('system-power on'), EISCP::Message.new(command: 'PWR', value: '01'))
+    assert_equal(EISCP::Parser.parse('main system-power on'), EISCP::Message.new(command: 'PWR', value: '01'))
+  end
+
+  def test_return_nil_for_fake_human_readable
+    assert_equal(EISCP::Parser.parse('fake-command value'), nil)
+  end
+end

data/test/tc_receiver.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative '../lib/eiscp/receiver'
+require 'minitest/autorun'
+
+class TestEISCP
+end

metadata

@@ -1,69 +1,74 @@
 --- !ruby/object:Gem::Specification
 name: onkyo_eiscp_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 2.1.1
 platform: ruby
 authors:
 - Michael Rodrigues
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-02 00:00:00.000000000 Z
+date: 2021-03-21 00:00:00.000000000 Z
 dependencies: []
-description: ! "\n    Use the provided binary script or require the library for use
-  in your scripts.\n  "
+description: "\n    Control Onkyo receivers over the network.Use the provided binary
+  or\n    require the library for use in your scripts.\n  "
 email: mikebrodrigues@gmail.com
 executables:
 - onkyo.rb
-- onkyo-server.rb
+- onkyo_server.rb
 extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- bin/onkyo-server.rb
+- README.md
+- VERSION
+- bin/mock_receiver.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
+- bin/onkyo_server.rb
+- eiscp-commands.yaml
 - lib/eiscp.rb
-- test/tc_command.rb
-- test/tc_iscp_message.rb
-- test/tc_eiscp.rb
-- test/tc_eiscp_packet.rb
-- VERSION
+- lib/eiscp/dictionary.rb
+- lib/eiscp/dictionary/dictionary_generators.rb
+- lib/eiscp/dictionary/dictionary_helpers.rb
+- lib/eiscp/message.rb
+- lib/eiscp/parser.rb
+- lib/eiscp/parser/dynamic_value_parser.rb
+- lib/eiscp/parser/eiscp_parser.rb
+- lib/eiscp/parser/human_readable_parser.rb
+- lib/eiscp/parser/iscp_parser.rb
+- lib/eiscp/receiver.rb
+- lib/eiscp/receiver/command_methods.rb
+- lib/eiscp/receiver/discovery.rb
 - onkyo_eiscp_ruby.gemspec
-- eiscp-commands.yaml
-- README.md
+- test/tc_dictionary.rb
+- test/tc_message.rb
+- test/tc_parser.rb
+- test/tc_receiver.rb
 homepage: https://github.com/mikerodrigues/onkyo_eiscp_ruby
-licenses: []
+licenses:
+- MIT
+metadata: {}
 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
+rubygems_version: 3.2.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 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: 
+- test/tc_dictionary.rb
+- test/tc_message.rb
+- test/tc_parser.rb
+- test/tc_receiver.rb

data/bin/onkyo-server.rb

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

data/lib/eiscp/command.rb

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

@@ -1,125 +0,0 @@
-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
-
-  # 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 = []
-    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
-  
-  # 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
-    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
-  
-  # Sends a packet string on the network
-
-  def send(eiscp_packet)
-    sock = TCPSocket.new @host, ONKYO_PORT
-    sock.puts eiscp_packet
-    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
-    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

@@ -1,51 +0,0 @@
-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"
-  HEADER_SIZE = 16
-  VERSION = "\x01"
-  RESERVED = "\x00\x00\x00"
-
-  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])
-    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/eiscp_server.rb

@@ -1,21 +0,0 @@
-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/iscp_message.rb

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