onkyo_eiscp_ruby 2.1.5 → 2.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d35b01beb072ac7058ef54920b734aff8d4d098ecc702eb9edd21ee818ad7ca0
-  data.tar.gz: f1112ac834d03f1dea2e50aeed301ac8f0e802b55b00b0f317d7802515ffa84e
+  metadata.gz: c4be1b779f00fb4a2ae5f1a843278634349980f925917a0ce17d0ac509504966
+  data.tar.gz: 020f9f4e070d878463ac3a7b804b249e8f47817727503b77799688b170acb181
 SHA512:
-  metadata.gz: f3a50446a0df21efd8dc6b2397daeb0cf791a997e7f0c27bb9d01c98b9e08fdc99cd68176b464882b29acc64a5f9cbe0748da690da51269f10f8f41f3d75dfc7
-  data.tar.gz: 65bafa48d392b8578435f006de9b27b8e58b9f16d7ccd7e2d527b38f23c0e2db187204c79f9c2dfe121021907735b51f73b82cef8fb82789ac362b5c3fec228f
+  metadata.gz: 448f13a6a6f94e0f8808744d04236b484955b4e85f677177c4011710968320e4c258ae979865f14a8dfc118cdfe720227e7018a1b85403cda772701c10665908
+  data.tar.gz: e87725e4498d36c7ae383bb88f2b76273a4336ab504176fe9a2e64ad694a3d921891b6e0af034c301aaf49cac63c859f7f581b5a275d76b7173fb55a790ba371

data/README.md

@@ -56,7 +56,7 @@ Using the Library
   `VERSION`)
 
 * You can do most everything through the `Receiver` and `Message` objects. If you
-  want to accept user input you will probably want to use the Parser module. Be
+  want to accept user input you will probably want to use the `Parser` module. Be
   sure to check out the RDocs or dig through the source code. I try to keep it
   well commented/documented, and there's more functionality to the library than
   is shown here:
@@ -82,7 +82,7 @@ Using the Library
 		EISCP::Receiver.discover
 ```
 
-* Create `Receiver` object from first discovered Receiver on the LAN
+* Create `Receiver` object from first discovered receiver on the LAN
 
 ```ruby		
 		receiver = EISCP::Receiver.new
@@ -104,8 +104,9 @@ Using the Library
 		end
 ```
 
-* Receivers created without a block will not connect automatically. You can use
-  the `connect` method to create a socket and connect to the receiver.
+* `Receivers` created without a block will not connect automatically. If you try
+  to send a command it will connect transparently, otherwise you can use the
+`connect` method to explicitly open a socket to the receiver.
 
 ```ruby
 		receiver.connect

data/VERSION

@@ -1 +1 @@
-2.1.5
+2.1.7

data/bin/mock_receiver.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 require 'socket'
-require_relative './receiver'
-require_relative './message'
+require_relative '../lib/eiscp/receiver'
+require_relative '../lib/eiscp/message'
 
 # Mock server that only responds to ECNQSTN.
 
@@ -11,14 +11,39 @@ module EISCP
   #
   class MockReceiver
     DISCOVERY_IP = '255.255.255.255'
-    ONKYO_DISCOVERY_RESPONSE = Message.new('ECN',
-                                           "TX-NR609/60128/DX/14DAE9E967C8\x19\r\n\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00")
+    ONKYO_DISCOVERY_RESPONSE = Message.new(command: 'ECN', value:
+                                           "TX-NR609/60128/DX/14DAE9E967C8\x19"\
+    "\r\n\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"\
+    "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"\
+    "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"\
+    "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"\
+    "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"\
+    "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"\
+    "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"\
+    "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"\
+    "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"\
+    "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"\
+    "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"\
+    "\x00\x00\x00\x00")
 
     # Create/start the server object.
 
     def initialize
       Socket.udp_server_loop(DISCOVERY_IP, Receiver::ONKYO_PORT) do |msg, src|
-        src.reply "ISCP\x00\x00\x00\x10\x00\x00\x00&\x01\x00\x00\x00!1ECNTX-NR609/60128/DX/14DAE9E967C8\x19\r\n\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
+        src.reply "ISCP\x00\x00\x00\x10\x00\x00\x00&\x01\x00\x00\x00"\
+        "!1ECNTX-NR609/60128/DX/14DAE9E967C8\x19\r\n\x00\x00\x00\x00\x00\x00"\
+        "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"\
+        "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"\
+        "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"\
+        "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"\
+        "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"\
+        "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"\
+        "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"\
+        "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"\
+        "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"\
+        "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"\
+        "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"\
+        "\x00\x00\x00\x00\x00\x00\x00\x00"
         puts msg
       end
     end

data/bin/onkyo.rb

@@ -40,6 +40,10 @@ class Options
       opts.on '-m', '--monitor', 'Connect to the first discovered reciever and monitor updates' do |m|
         @options.monitor = m
       end
+
+      opts.on '-V', '--version', 'Returns the version number of the onkyo-eiscp-ruby gem this binary belongs to.' do |v|
+        @options.version = v
+      end
     end
 
     options.parse!(args)
@@ -51,6 +55,11 @@ class Options
       exit 0
     end
 
+    if @options.version
+      puts EISCP::VERSION
+      exit 0
+    end
+
     if @options.help
       puts options
       exit 0
@@ -60,9 +69,9 @@ class Options
       begin
         rec = EISCP::Receiver.new do |reply|
           puts "#{Time.now} #{rec.host} "\
-               "#{reply.zone}: "\
-               "#{reply.command_description || reply.command} "\
-               "-> #{reply.value_description || reply.value}"
+            "#{reply.zone}: "\
+            "#{reply.command_description || reply.command} "\
+            "-> #{reply.value_description || reply.value}"
         end
         rec.thread.join
       rescue Interrupt
@@ -93,9 +102,9 @@ class Options
           puts "\n"
           puts '    Value - Description>'
           puts "\n"
-          command_hash[:values].each do |_value, attr_hash|
+          command_hash[:values].each do |value, attr_hash|
             if modelsets.include? attr_hash[:models]
-              puts "      '#{EISCP::Dictionary.command_value_to_value_name(command, _value)}' - "\
+              puts "      '#{EISCP::Dictionary.command_value_to_value_name(command, value)}' - "\
                 " #{attr_hash[:description]}"
             end
           end
@@ -114,9 +123,9 @@ class Options
           puts "\n"
           puts '    Value - Description>'
           puts "\n"
-          command_hash[:values].each do |_value, attr_hash|
-            puts "      '#{EISCP::Dictionary.command_value_to_value_name(command, _value)}' - "\
-                " #{attr_hash[:description]}"
+          command_hash[:values].each do |value, attr_hash|
+            puts "      '#{EISCP::Dictionary.command_value_to_value_name(command, value)}' - "\
+              " #{attr_hash[:description]}"
           end
           puts "\n"
         end
@@ -131,8 +140,6 @@ class Options
   end
 end
 
-include EISCP
-
 @options = Options.parse(ARGV)
 
 receiver = EISCP::Receiver.discover[0]
@@ -143,4 +150,5 @@ rescue StandardError
   raise "Couldn't parse command"
 end
 reply = receiver.send_recv(command)
-puts "#{Time.now}: Response from #{receiver.host}: #{reply.zone.capitalize}   #{reply.command_description || reply.command} -> #{reply.value_description || reply.value}"
+puts "#{Time.now}: Response from #{receiver.host}: #{reply.zone.capitalize}  "\
+  "#{reply.command_description || reply.command} -> #{reply.value_description || reply.value}"

data/bin/onkyo_server.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'eiscp/mock_receiver'
+require_relative './mock_receiver'
 
 puts 'Starting server on 60128...'
 

data/lib/eiscp/dictionary/dictionary_helpers.rb

@@ -36,14 +36,12 @@ module EISCP
               return command if attrs[:name] == name
             end
           end
-          nil
 
         else
 
           @commands[command_zone].each_pair do |command, attrs|
             return command if attrs[:name] == name
           end
-          nil
 
         end
       end
@@ -71,7 +69,6 @@ module EISCP
             return k if v[:name].first == value_name.to_s
           end
         end
-        nil
       rescue StandardError
         nil
       end

data/lib/eiscp/message.rb

@@ -54,7 +54,9 @@ module EISCP
     # @param [String] value variable length ISCP command value
     # @param [String] unit_type_character override default unit type character, optional
     # @param [String] start_character override default start character, optional
-    def initialize(command: nil, value: '', terminator: "\r\n", unit_type: '1', start: '!')
+    def initialize(command:, value:, terminator: "\r\n", unit_type: '1', start: '!')
+      raise "All messages require a value, command is #{command} with value: #{value.class}" unless value
+
       unless Dictionary.known_command?(command)
         # STDERR.puts "Unknown command #{command}"
       end
@@ -66,7 +68,7 @@ module EISCP
       @start = start
       @header = { magic: MAGIC,
                   header_size: HEADER_SIZE,
-                  data_size: to_iscp.length,
+                  data_size: to_iscp.length + terminator.length,
                   version: ISCP_VERSION,
                   reserved: RESERVED }
       begin

data/lib/eiscp/parser/dynamic_value_parser.rb

@@ -2,6 +2,7 @@
 
 module EISCP
   module Parser
+    # Parses commands with dynamic values
     module DynamicValueParser
       # Still trying to sort this out.
     end

data/lib/eiscp/parser/eiscp_parser.rb

@@ -34,7 +34,6 @@ module EISCP
       def self.validate(packet)
         packet.header.header_size.size == packet.command.size
       end
-        
     end
 
     class EISCPParserException < RuntimeError; end

data/lib/eiscp/receiver/discovery.rb

@@ -28,21 +28,39 @@ module EISCP
       # Returns an array of discovered Receiver objects.
       #
       def discover(discovery_port = Receiver::ONKYO_PORT)
+        data = []
+        Socket.ip_address_list.each do |addr|
+          next unless addr.ipv4?
+
+          sock = setup_socket(addr.ip_address, discovery_port)
+          send_broadcast(sock, discovery_port)
+          data.concat(receive_data(sock))
+        end
+        data
+      end
+
+      def setup_socket(ip_address, discovery_port)
         sock = UDPSocket.new
         sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_BROADCAST, true)
+        sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_REUSEADDR, true)
+        sock.bind(ip_address, discovery_port)
+        sock
+      end
+
+      def send_broadcast(sock, discovery_port)
         sock.send(ONKYO_MAGIC, 0, '<broadcast>', discovery_port)
+      end
+
+      def receive_data(sock)
         data = []
         loop do
           msg, addr = sock.recvfrom_nonblock(1024)
           data << Receiver.new(addr[2], ecn_string_to_ecn_array(msg))
         rescue IO::WaitReadable
           io = IO.select([sock], nil, nil, 0.5)
-          if io.nil?
-            return data
-          else
-            retry
-          end
+          break if io.nil?
         end
+        data
       end
     end
   end

data/lib/eiscp/receiver.rb

@@ -37,7 +37,7 @@ module EISCP
     attr_reader :thread
 
     # Default connection timeout value in seconds
-    DEFAULT_TIMEOUT = 0.5
+    DEFAULT_TIMEOUT = 0.75
 
     # Default Onkyo eISCP port
     ONKYO_PORT = 60_128
@@ -146,7 +146,7 @@ module EISCP
     #
     def recv
       data = String.new
-      data << @socket.gets until data.match(/\r\n$/)
+      data << @socket.gets until data.match(/\x1A/)
       Parser.parse(data)
     end
 
@@ -156,7 +156,7 @@ module EISCP
       eiscp = Parser.parse(eiscp) if eiscp.is_a? String
       send eiscp
       sleep DEFAULT_TIMEOUT
-      Parser.parse("#{eiscp.command}#{@state[eiscp.command]}")
+      Message.new(command: eiscp.command, value: @state[eiscp.command], terminator: "\x1A\r\n")
     end
 
     # Return ECN hash with model, port, area, and MAC address

data/lib/eiscp.rb

@@ -3,7 +3,7 @@
 # Library for controlling Onkyo receivers over TCP/IP.
 #
 module EISCP
-  VERSION = '2.1.5'
+  VERSION = '2.1.7'
 end
 
 require_relative './eiscp/receiver'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onkyo_eiscp_ruby
 version: !ruby/object:Gem::Version
-  version: 2.1.5
+  version: 2.1.7
 platform: ruby
 authors:
 - Michael Rodrigues
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-30 00:00:00.000000000 Z
+date: 2024-12-04 00:00:00.000000000 Z
 dependencies: []
 description: "\n    Control Onkyo receivers over the network.Use the provided binary
   or\n    require the library for use in your scripts.\n  "