onkyo_eiscp_ruby 2.1.1 → 2.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4b06cd590c97b2221cbb2aea133003a16d59c0ad917c48e3cba7ee0758e9c88
-  data.tar.gz: a0eae4abe4ec00ea74db045b4218b6e7adc86f4aefa839e9faa53eee0d135598
+  metadata.gz: d3dd4eba4824a8b6f5698a427829515653a327f7e7a9a3439b0c66be8ed71ce1
+  data.tar.gz: 5e747f4b17191a38c76067df0461f9a59b7e0e116a78f34c6d8507e1ff06b2f2
 SHA512:
-  metadata.gz: 7b2274ea6e68eb2405c32aa4db290621a49bddfdb4b8550d76da52013981691c783b9b03088e6fde4f845ab18a5d858a3bf145cf4a7d60e2ae4531bb4fcecfa4
-  data.tar.gz: bd9fa98a349f0eee2dfb80f7c46c8f8ae5ba0a624f6563bd43983cc2d9cf531f0a57095f2db0eb5d7b68232b97bdbda25f1585930b858c4177af0c5a3d2a96f0
+  metadata.gz: c0053cc9c49574d835e967190edeea8519dd99ef25f3c397046274fb3da3d319292719cc5c002f0a839d69d8da271ad274cf4f449cfbab695c8c00acdeb0df42
+  data.tar.gz: 60476141723946c9741f957fea30e3b0709c13907155619e559cd403f6d2abf5c88bd693153cf33a35d47f9f3b07d3444ef14880f641b91d8628e83d9232f812

data/README.md

@@ -3,21 +3,24 @@ onkyo_eiscp_ruby
 [![Gem Version](https://badge.fury.io/rb/onkyo_eiscp_ruby.png)](http://badge.fury.io/rb/onkyo_eiscp_ruby)
 [![GitHub version](https://badge.fury.io/gh/mikerodrigues%2Fonkyo_eiscp_ruby.png)](http://badge.fury.io/gh/mikerodrigues%2Fonkyo_eiscp_ruby)
 
-*A Ruby implementation of eISCP for controlling Onkyo receivers.*
+*A Ruby implementation of eISCP (ethernet Integra Serial Control Protocol) for controlling Onkyo receivers.*
 
-**This code is not really still under development and using it might still make you sick.**
+**I'm still sort of updating this code. Please feel free to reach out if there's something you need that it doesn't do, I may be willing to help.**
 
 **The python version linked below sees much more activity.**
 
-Automatically discover receivers in the broadcast domain
 
-Send commands to receivers and parse returned messages
+Features
+---------------
+* Automatically discover receivers in the broadcast domain
+
+* Send commands to receivers and parse returned messages
 
-Open a TCP socket to receive solicited and non-solicited status updates.
+* Open a TCP socket to receive solicited and non-solicited status updates.
 
-Mock reciever (currently only responds to discovery)
+* Mock reciever (currently only responds to discovery)
 
-Human-readable commands
+* Human-readable commands
 
 **Inspired by https://github.com/miracle2k/onkyo-eiscp
 
@@ -40,7 +43,11 @@ What's missing?
 
 Using the Library
 -----------------
-* require the library
+* Install the library
+		
+		gem install onkyo_eiscp_ruby
+
+* Require the library
 
 		require 'eiscp'
 
@@ -49,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:
@@ -75,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
@@ -97,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
@@ -162,6 +170,11 @@ Using the Library
 
 		# Set the master volume to 45
 		receiver.master_volume "45"
+		
+		# Change the input to TV/CD
+		# Note: when a command value has more than one name (an array in the YAML file)
+		#       we default to using the first entry. So for `['cd', 'tv', 'cd']` you get:
+		receiver.input_selector "cd"
 ```
 
 * Parse ISCP and human readable strings:

data/VERSION

@@ -1 +1 @@
-2.1.1
+2.1.6

data/bin/mock_receiver.rb

@@ -11,7 +11,8 @@ 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('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")
 
     # Create/start the server object.
 

data/bin/onkyo.rb

@@ -95,7 +95,7 @@ class Options
           puts "\n"
           command_hash[:values].each do |_value, attr_hash|
             if modelsets.include? attr_hash[:models]
-              puts "      '#{attr_hash[:name]}' - "\
+              puts "      '#{EISCP::Dictionary.command_value_to_value_name(command, _value)}' - "\
                 " #{attr_hash[:description]}"
             end
           end
@@ -115,8 +115,8 @@ class Options
           puts '    Value - Description>'
           puts "\n"
           command_hash[:values].each do |_value, attr_hash|
-            puts "      '#{attr_hash[:name]}' - "\
-              " #{attr_hash[:description]}"
+            puts "      '#{EISCP::Dictionary.command_value_to_value_name(command, _value)}' - "\
+                " #{attr_hash[:description]}"
           end
           puts "\n"
         end

data/lib/eiscp/dictionary/dictionary_generators.rb

@@ -37,8 +37,8 @@ module EISCP
           tmp.merge!((value[0] + v.to_s) =>
             {
               name: value[0].downcase + v,
-              description: @commands[zone][command][:values][value[0] + '{xx}'][:description].gsub(/\(.*[\]|\)]$/, v),
-              models: @commands[zone][command][:values][value[0] + '{xx}'][:models]
+              description: @commands[zone][command][:values]["#{value[0]}{xx}"][:description].gsub(/\(.*[\]|)]$/, v),
+              models: @commands[zone][command][:values]["#{value[0]}{xx}"][:models]
             })
         end
         tmp
@@ -52,7 +52,7 @@ module EISCP
           tmp.merge!(v.to_s =>
             {
               name: v.downcase,
-              description: @commands[zone][command][:values]['{xx}'][:description].gsub(/\(.*[\]|\)]$/, v),
+              description: @commands[zone][command][:values]['{xx}'][:description].gsub(/\(.*[\]|)]$/, v),
               models: @commands[zone][command][:values]['{xx}'][:models]
             })
         end

data/lib/eiscp/dictionary/dictionary_helpers.rb

@@ -51,7 +51,12 @@ module EISCP
       # Return a value name from a command and a value
       def command_value_to_value_name(command, value)
         zone = zone_from_command(command)
-        @commands[zone][command][:values][value][:name]
+        command_value = @commands[zone][command][:values][value][:name]
+        if command_value.instance_of?(String)
+          command_value
+        elsif command_value.instance_of?(Array)
+          command_value.first
+        end
       rescue StandardError
         nil
       end
@@ -60,13 +65,13 @@ module EISCP
       def command_value_name_to_value(command, value_name)
         zone = zone_from_command(command)
         @commands[zone][command][:values].each_pair do |k, v|
-          if v[:name].class == String
+          if v[:name].instance_of?(String)
             return k if v[:name] == value_name.to_s
-          elsif v[:name].class == Array
+          elsif v[:name].instance_of?(Array)
             return k if v[:name].first == value_name.to_s
           end
         end
-        return nil
+        nil
       rescue StandardError
         nil
       end

data/lib/eiscp/dictionary.rb

@@ -14,14 +14,12 @@ module EISCP
     extend DictionaryHelpers
 
     class << self
-      attr_reader :zones
-      attr_reader :modelsets
-      attr_reader :commands
+      attr_reader :zones, :modelsets, :commands
     end
 
     DEFAULT_ZONE = 'main'
     @yaml_file_path = File.join(__dir__, '../../eiscp-commands.yaml')
-    @commands = YAML.load(File.read(@yaml_file_path))
+    @commands = YAML.safe_load(File.read(@yaml_file_path), permitted_classes: [Symbol])
     @modelsets = @commands[:modelsets]
     @commands.delete(:modelsets)
     @zones = @commands.map { |k, _| k }
@@ -32,11 +30,12 @@ module EISCP
         command = command[0]
         @commands[zone][command][:values].each do |value|
           value = value[0]
-          if value.is_a? Array
+          case value
+          when Array
             @additions << [zone, command, value, create_range_commands(zone, command, value)]
-          elsif value.match(/^(B|T){xx}$/)
+          when /^(B|T){xx}$/
             @additions << [zone, command, value, create_treble_bass_commands(zone, command, value)]
-          elsif value.match(/^{xx}$/)
+          when /^{xx}$/
             @additions << [zone, command, value, create_balance_commands(zone, command, value)]
           else
             next

data/lib/eiscp/message.rb

@@ -15,6 +15,7 @@ module EISCP
   class Message
     # EISCP header
     attr_accessor :header
+
     # ISCP "magic" indicates the start of an eISCP message.
     MAGIC = 'ISCP'
     # eISCP header size, fixed length.
@@ -53,13 +54,11 @@ 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: nil, terminator: "\r\n", unit_type: '1', start: '!')
+    def initialize(command: nil, value: '', terminator: "\r\n", unit_type: '1', start: '!')
       unless Dictionary.known_command?(command)
         # STDERR.puts "Unknown command #{command}"
       end
 
-      raise 'No value specified.' if value.nil?
-
       @command = command
       @value = value
       @terminator = terminator

data/lib/eiscp/parser/eiscp_parser.rb

@@ -17,14 +17,18 @@ module EISCP
           unit_type: msg.unit_type,
           start: msg.start
         )
-        packet.header = {
+        packet.header = create_header(array)
+        packet
+      end
+
+      def self.create_header(array)
+        {
           magic: array[0],
           header_size: array[1],
           data_size: array[2],
           version: array[3],
           reserved: array[4]
         }
-        packet
       end
 
       def self.validate(packet)

data/lib/eiscp/parser/iscp_parser.rb

@@ -6,7 +6,7 @@ module EISCP
     #
     module ISCPParser
       # Regexp for parsing ISCP messages
-      REGEX = /(?<start>!)?(?<unit_type>(\d|x))?(?<command>[A-Z]{3})\s?(?<value>.*?)(?<terminator>[[:cntrl:]]*$)/.freeze
+      REGEX = /(?<start>!)?(?<unit_type>(?:\d|x))?(?<command>[A-Z]{3})\s?(?<value>.*?)(?<terminator>[[:cntrl:]]*$)/
       def self.parse(string)
         match = string.match(REGEX)
 
@@ -17,9 +17,7 @@ module EISCP
         hash.delete_if { |_, v| v.nil? || v == '' }
 
         # Convert keys to symbols
-        hash = hash.each_with_object({}) do |(k, v), memo|
-          memo[k.to_sym] = v
-        end
+        hash = hash.transform_keys(&:to_sym)
 
         Message.new(**hash)
       end

data/lib/eiscp/receiver/command_methods.rb

@@ -16,7 +16,7 @@ module EISCP
           Dictionary.commands[zone].each do |command, _values|
             command_name = Dictionary.command_to_name(command).to_s.gsub(/-/, '_')
             define_method(command_name) do |v|
-              instance_exec Parser.parse(command_name.gsub(/_/, '-') + ' ' + v), &block
+              instance_exec Parser.parse("#{command_name.gsub(/_/, '-')} #{v}"), &block
             end
           rescue StandardError => e
             puts e

data/lib/eiscp/receiver/discovery.rb

@@ -28,21 +28,23 @@ module EISCP
       # Returns an array of discovered Receiver objects.
       #
       def discover(discovery_port = Receiver::ONKYO_PORT)
-        sock = UDPSocket.new
-        sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_BROADCAST, true)
-        sock.send(ONKYO_MAGIC, 0, '<broadcast>', discovery_port)
         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
+        Socket.ip_address_list.each do | addr |
+          if addr.ipv4?
+            sock = UDPSocket.new
+            sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_BROADCAST, true)
+            sock.bind(addr.ip_address, discovery_port)
+            sock.send(ONKYO_MAGIC, 0, '<broadcast>', discovery_port)
+            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)
+              break if io.nil?
+            end
           end
         end
+        return data
       end
     end
   end

data/lib/eiscp/receiver.rb

@@ -133,9 +133,11 @@ module EISCP
     # Sends an EISCP::Message object or string on the network
     #
     def send(eiscp)
-      if eiscp.is_a? EISCP::Message
+      connect if @socket.nil? || @socket.closed?
+      case eiscp
+      when EISCP::Message
         @socket.puts(eiscp.to_eiscp)
-      elsif eiscp.is_a? String
+      when String
         @socket.puts eiscp
       end
     end
@@ -143,10 +145,9 @@ module EISCP
     # Reads the socket and returns and EISCP::Message
     #
     def recv
-      data = ''
+      data = String.new
       data << @socket.gets until data.match(/\r\n$/)
-      message = Parser.parse(data)
-      message
+      Parser.parse(data)
     end
 
     # Sends an EISCP::Message object or string on the network and returns recieved data string.
@@ -171,7 +172,7 @@ module EISCP
     #
     def human_readable_state
       hash = {}
-      @state.each do |c, v|
+      @state.dup.each do |c, v|
         hash[Dictionary.command_to_name(c).to_s] = (Dictionary.command_value_to_value_name(c, v) || v.to_s).to_s
       end
       hash
@@ -187,13 +188,7 @@ module EISCP
             info[:values].each do |value, _|
               next unless value == 'QSTN'
 
-              send(Parser.parse(command + 'QSTN'))
-              # If we send any faster we risk making the stereo drop replies.
-              # A dropped reply is not necessarily indicative of the
-              # receiver's failure to receive the command and change state
-              # accordingly. In this case, we're only making queries, so we do
-              # want to capture every reply.
-              sleep DEFAULT_TIMEOUT
+              send_recv(Parser.parse("#{command}QSTN"))
             end
           end
         end

data/lib/eiscp.rb

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

data/test/tc_dictionary.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../lib/eiscp/dictionary.rb'
+require_relative '../lib/eiscp/dictionary'
 require 'minitest/autorun'
 
 class TestDictionary < MiniTest::Test

data/test/tc_message.rb

@@ -8,7 +8,10 @@ class TestMessage <  MiniTest::Test
   DISCOVERY_STRING = DISCOVERY_PACKET.to_eiscp
 
   def test_create_discovery_iscp_message
-    assert_equal(EISCP::Message.new(command: 'ECN', value: 'QSTN', terminator: "\r\n", unit_type: 'x', start: '!').to_iscp, '!xECNQSTN')
+    assert_equal(
+      EISCP::Message.new(command: 'ECN', value: 'QSTN', terminator: "\r\n", unit_type: 'x',
+                         start: '!').to_iscp, '!xECNQSTN'
+    )
   end
 
   def test_create_messages

data/test/tc_parser.rb

@@ -29,6 +29,6 @@ class TestParser < MiniTest::Test
   end
 
   def test_return_nil_for_fake_human_readable
-    assert_equal(EISCP::Parser.parse('fake-command value'), nil)
+    assert_nil(EISCP::Parser.parse('fake-command value'))
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onkyo_eiscp_ruby
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.1.6
 platform: ruby
 authors:
 - Michael Rodrigues
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-21 00:00:00.000000000 Z
+date: 2021-11-18 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  "