seriamp 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 987bf9939c33251dcb4b509a4a793d4b2b832f45fa2089e924f1960271eb7a70
-  data.tar.gz: 6e19b0e1a0ba95fed263f12668830e3b3b58b0e744d2031f2920d4eb63b63f0b
+  metadata.gz: bdacf1b53664adff670eaa918cdc44aa60ba20660249456b916a26c30f69ae08
+  data.tar.gz: 7f2cebc5518a380c4db21155735666481eef942d75f9ece04952ee1fac45c6e8
 SHA512:
-  metadata.gz: 4ad4de970b57453c39b57c37407579214196ecdd9db3f86be4a7c189d0a7aae697bd0d98c0866cc045ad915e611e9c520bcbfd8f5c10dea322086c35f6c13537
-  data.tar.gz: 3fef6d4e749ee56b1b590cd7c0044f2e15042129de38ae6d7a9600730029a57573246af2432c981dc1d1f9355a01677afcbb1ab3b2cc5f2442bdc68466f34165
+  metadata.gz: 301d7fb20466d009da6f9f9038da12b07e6d20491ada5d8b99ea03c96d09f1fc83c5c50d4d96ba900f98fd0b0da74a1c29da5f7afbe4d5c08c50832b06f05a8f
+  data.tar.gz: 6595c0244d77380aa768c41227d8f521ee4107a28d08fb55165500a0bc3abc6447db61afe0565472c14fc09a3795b0e8036f33b499a2b9a7cba794c857b15697

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    seriamp (0.2.1)
+    seriamp (0.2.2)
       serialport (~> 1.3)
 
 GEM

data/README.md

@@ -20,17 +20,76 @@ that requires a straight cable and has a female terminal (such as the
 Denon AVR-2308CI). For other receivers a gender changer or a cable is
 necessary.
 
+### Serial Adapter & Cable Considerations
+
+The adapters and cables have either screws or nuts on them to secure
+the connections together. Ideally one side of the connection should
+have a screw and the other a nut. If both sides have screws, the
+connection would work but would be loose. If both sides have nuts,
+the connection won't work as the connectors will physically not able to
+meet.
+
+Cables and adapters come with a variety of combinations of male/female
+connectors and nuts/screws, therefore this is a good area
+to pay attention to when purchasing the hardware.
+
+USB to serial adapters:
+
+- [Male connector with nuts](https://www.amazon.com/gp/product/B00IDSM6BW)
+- [Male connector with screws](https://www.amazon.com/gp/product/B0759HSLP1),
+  also [this](https://www.amazon.com/gp/product/B017D51ZRQ) and
+  [this](https://www.amazon.com/gp/product/B00ZHP2NN0)
+
+Serial cables:
+
+- [Male/screw to female/screw, null modem](https://www.amazon.com/gp/product/B00CEMGMMM)
+- [Male/screw to male/screw, null modem](https://www.amazon.com/gp/product/B00006B8BJ)
+
+Mini adapters / gender changers:
+
+- [Null modem male/screw to male/nut](https://www.ebay.com/itm/225083094726)
+- [Null modem male/screw to female/nut](https://www.ebay.com/itm/123731343721)
+- [Null modem male/screw to female/screw](https://www.ebay.com/itm/255420011438)
+- [Null modem female/screw to female/nut](https://www.ebay.com/itm/123732427356)
+- [Null modem female/screw to female/screw](https://www.ebay.com/itm/333767424713)
+- [Straight female/screw to female/screw](https://www.ebay.com/itm/313578863735)
+
+The mini adapters/gender changers are generally cheaper than serial cables,
+but cables can be sourced for quite cheap as well. For example, as of
+this writing, the adapters are sold on eBay for about $3.50 and cables can
+be bought on Amazon for about $5.50. When using adapters instead of or
+in addition to cables, keep in mind that the adapters, being rigidly attached
+to the device, will protrude backwards and in particular if a receiver or
+amplifier is already positioned close to a wall (or the rear wall of a cabinet),
+adding an adapter to the receiver/amplifier may require moving the device
+further away from the wall in order to fit the adapter and the serial
+cable connector.
+
 ### Sonance Sonamp 875D / 875D MK II
 
 - 3-pin cable should be sufficient according to manual
 - Null-modem cable required
-- Receiver socket is female
+- Receiver socket is female with nuts
+
+Connection options:
+
+- PC with serial port (male) <-> null-modem cable female to male <->
+  receiver
+- USB-serial adapter (male) <-> null-modem male to female adapter <->
+  receiver
 
 ### Yamaha RX-V**00
 
 - 5-pin cable required (with RTS pin connected)
 - Null-modem cable required
-- Receiver socket is male
+- Receiver socket is male with nuts
+
+Connection options:
+
+- PC with serial port (male) <-> null-modem cable female to female <->
+  receiver
+- USB-serial adapter (male) <-> null-modem female to female adapter <->
+  receiver
 
 The following table shows which Yamaha receivers have RS-232 connector
 and which do not:
@@ -86,6 +145,12 @@ either a straight through female to male serial cable or removing the nuts
 from one of the ends (the USB to serial adapter is the cheaper device,
 I modify the adapters rather than the receivers/amplifiers).
 
+Connection options:
+
+- PC with serial port (male) <-> straight cable female to male <->
+  receiver
+- USB-serial adapter (male) <-> receiver
+
 ## Protocol Notes
 
 ### RX-V1500 Power Values

data/lib/seriamp/detect.rb

@@ -7,7 +7,7 @@ module Seriamp
 
   DEFAULT_DEVICE_GLOB = '/dev/ttyUSB*'
 
-  module_function def detect_device(mod, *patterns, logger: nil)
+  module_function def detect_device(mod, *patterns, logger: nil, timeout: nil)
     if patterns.empty?
       patterns = [DEFAULT_DEVICE_GLOB]
     end
@@ -15,13 +15,13 @@ module Seriamp
       Dir.glob(pattern)
     end.flatten.uniq
     queue = Queue.new
-    timeout = mod.const_get(:RS232_TIMEOUT)
+    timeout ||= mod.const_get(:DEFAULT_RS232_TIMEOUT)
     client_cls = mod.const_get(:Client)
     threads = devices.map do |device|
       Thread.new do
         Timeout.timeout(timeout * 2, CommunicationTimeout) do
           logger&.debug("Trying #{device}")
-          client_cls.new(device: device, logger: logger, retries: false).present?
+          client_cls.new(device: device, logger: logger, retries: false, timeout: timeout).present?
           logger&.debug("Found #{mod} device at #{device}")
           queue << device
         end

data/lib/seriamp/error.rb

@@ -7,4 +7,6 @@ module Seriamp
   class UnexpectedResponse < Error; end
   class HandshakeFailure < UnexpectedResponse; end
   class CommunicationTimeout < Error; end
+
+  class InvalidOnOffValue < ArgumentError; end
 end

data/lib/seriamp/integra/client.rb

@@ -8,12 +8,14 @@ require 'seriamp/integra/protocol/methods'
 module Seriamp
   module Integra
 
-    RS232_TIMEOUT = 0.25
+    DEFAULT_RS232_TIMEOUT = 0.25
 
     class Client
       include Protocol::Methods
 
-      def initialize(device: nil, glob: nil, logger: nil, retries: true, thread_safe: false)
+      def initialize(device: nil, glob: nil, logger: nil, retries: true,
+        timeout: nil, thread_safe: false
+      )
         @logger = logger
 
         @device = device
@@ -29,6 +31,7 @@ module Seriamp
           else
             raise ArgumentError, "retries must be an integer, true, false or nil: #{retries}"
           end
+        @timeout = timeout || DEFAULT_RS232_TIMEOUT
         @thread_safe = !!thread_safe
 
         if thread_safe?
@@ -48,6 +51,7 @@ module Seriamp
       attr_reader :glob
       attr_reader :logger
       attr_reader :retries
+      attr_reader :timeout
 
       def thread_safe?
         @thread_safe
@@ -94,7 +98,7 @@ module Seriamp
       def open_device
         if detect_device? && device.nil?
           logger&.debug("Detecting device")
-          @device = Seriamp.detect_device(Integra, *glob, logger: logger)
+          @device = Seriamp.detect_device(Integra, *glob, logger: logger, timeout: timeout)
           if @device
             logger&.info("Using #{device} as TTY device")
           else
@@ -133,7 +137,7 @@ module Seriamp
 
       def read_response
         resp = +''
-        deadline = Utils.monotime + 1
+        deadline = Utils.monotime + timeout
         loop do
           begin
             chunk = @io.read_nonblock(1000)

data/lib/seriamp/integra/cmd.rb

@@ -14,17 +14,22 @@ module Seriamp
       def initialize(args = ARGV, stdin = STDIN)
         options = {}
         OptionParser.new do |opts|
-          opts.banner = "Usage: integra [-d device] command arg..."
+          opts.banner = "Usage: integra [options] command arg..."
 
           opts.on("-d", "--device DEVICE", "TTY to use (default autodetect)") do |v|
             options[:device] = v
           end
+
+          opts.on('-T', '--timeout TIMEOUT', 'Timeout to use') do |v|
+            options[:timeout] = Float(v)
+          end
         end.parse!
 
         @options = options
 
         @logger = Logger.new(STDERR)
-        @client = Integra::Client.new(device: options[:device], logger: @logger)
+        @client = Integra::Client.new(device: options[:device],
+          logger: @logger, timeout: options[:timeout])
 
         @args = args
         @stdin = stdin
@@ -33,6 +38,7 @@ module Seriamp
       attr_reader :args
       attr_reader :stdin
       attr_reader :logger
+      attr_reader :options
 
       def run
         if args.any?
@@ -74,7 +80,7 @@ module Seriamp
       attr_reader :client
 
       def executor
-        @executor ||= Executor.new(client)
+        @executor ||= Executor.new(client, timeout: options[:timeout])
       end
     end
   end

data/lib/seriamp/integra/executor.rb

@@ -3,17 +3,19 @@
 module Seriamp
   module Integra
     class Executor
-      def initialize(client)
+      def initialize(client, **opts)
         @client = client
+        @options = opts.dup.freeze
       end
 
       attr_reader :client
+      attr_reader :options
 
       def run_command(cmd, *args)
         cmd = cmd.gsub('_', '-')
         case cmd
         when 'detect'
-          device = Seriamp.detect_device(Integra, *args, logger: logger)
+          device = Seriamp.detect_device(Integra, *args, logger: logger, timeout: options[:timeout])
           if device
             puts device
             exit 0

data/lib/seriamp/sonamp/app.rb

@@ -46,6 +46,7 @@ module Seriamp
       put '/zone/:zone/power' do |zone|
         state = Utils.parse_on_off(request.body.read)
         client.set_zone_power(Integer(zone), state)
+        empty_response
       end
 
       get '/zone/:zone/volume' do |zone|
@@ -98,6 +99,15 @@ module Seriamp
         headers['content-type'] = 'application/json'
         data.to_json
       end
+
+      def empty_response
+        [204, '']
+      end
+
+      error InvalidOnOffValue do |e|
+        headers['content-type'] = 'text/plain'
+        [422, "Error: #{e.class}: #{e}"]
+      end
     end
   end
 end

data/lib/seriamp/sonamp/client.rb

@@ -7,10 +7,12 @@ require 'seriamp/backend'
 module Seriamp
   module Sonamp
 
-    RS232_TIMEOUT = 3
+    DEFAULT_RS232_TIMEOUT = 3
 
     class Client
-      def initialize(device: nil, glob: nil, logger: nil, retries: true, thread_safe: false)
+      def initialize(device: nil, glob: nil, logger: nil, retries: true,
+        timeout: nil, thread_safe: false
+      )
         @logger = logger
 
         @device = device
@@ -26,6 +28,7 @@ module Seriamp
           else
             raise ArgumentError, "retries must be an integer, true, false or nil: #{retries}"
           end
+        @timeout = timeout || DEFAULT_RS232_TIMEOUT
         @thread_safe = !!thread_safe
 
         if thread_safe?
@@ -37,6 +40,7 @@ module Seriamp
       attr_reader :glob
       attr_reader :logger
       attr_reader :retries
+      attr_reader :timeout
 
       def thread_safe?
         @thread_safe
@@ -213,7 +217,7 @@ module Seriamp
       def open_device
         if detect_device? && device.nil?
           logger&.debug("Detecting device")
-          @device = Seriamp.detect_device(Sonamp, *glob, logger: logger)
+          @device = Seriamp.detect_device(Sonamp, *glob, logger: logger, timeout: timeout)
           if @device
             logger&.info("Using #{device} as TTY device")
           else
@@ -305,13 +309,13 @@ module Seriamp
       end
 
       def with_timeout(&block)
-        Timeout.timeout(RS232_TIMEOUT, CommunicationTimeout, &block)
+        Timeout.timeout(timeout, CommunicationTimeout, &block)
       end
 
       def read_line(f, cmd)
         with_timeout do
           resp = +''
-          deadline = Utils.monotime + 1
+          deadline = Utils.monotime + timeout
           loop do
             begin
               buf = f.read_nonblock(1024)
@@ -351,8 +355,12 @@ module Seriamp
           if zone < 1 || zone > 4
             raise ArgumentError, "Zone must be between 1 and 4: #{zone}"
           end
-          resp = dispatch(":#{cmd_prefix}#{zone}?")
-          typecast_value(resp[cmd_prefix.length + 1..], boolize)
+          sent_prefix = "#{cmd_prefix}#{zone}"
+          resp = dispatch(":#{sent_prefix}?")
+          unless resp.start_with?(sent_prefix)
+            raise UnexpectedResponse, "Expected #{sent_prefix}..., received #{resp}"
+          end
+          typecast_value(resp[sent_prefix.length..], boolize)
         else
           range = include_all ? [1, 2, 3, 4, 'A'] : (1..4).to_a
           hashize_query_result(dispatch(":#{cmd_prefix}G?", range), cmd_prefix, boolize, range)

data/lib/seriamp/sonamp/cmd.rb

@@ -15,17 +15,22 @@ module Seriamp
 
         options = {}
         OptionParser.new do |opts|
-          opts.banner = "Usage: sonamp [-d device] command arg..."
+          opts.banner = "Usage: sonamp [options] command arg..."
 
           opts.on("-d", "--device DEVICE", "TTY to use (default autodetect)") do |v|
             options[:device] = v
           end
+
+          opts.on('-T', '--timeout TIMEOUT', 'Timeout to use') do |v|
+            options[:timeout] = Float(v)
+          end
         end.parse!(args)
 
         @options = options
 
         @logger = Logger.new(STDERR)
-        @client = Sonamp::Client.new(device: options[:device], logger: @logger)
+        @client = Sonamp::Client.new(device: options[:device],
+          logger: @logger, timeout: options[:timeout])
 
         @args = args
         @stdin = stdin
@@ -34,6 +39,7 @@ module Seriamp
       attr_reader :args
       attr_reader :stdin
       attr_reader :logger
+      attr_reader :options
 
       def run
         if args.any?

data/lib/seriamp/sonamp/executor.rb

@@ -3,16 +3,18 @@
 module Seriamp
   module Sonamp
     class Executor
-      def initialize(client)
+      def initialize(client, **opts)
         @client = client
+        @options = opts.dup.freeze
       end
 
       attr_reader :client
+      attr_reader :options
 
       def run_command(cmd, *args)
         case cmd
         when 'detect'
-          device = Seriamp.detect_device(Sonamp, *args, logger: logger)
+          device = Seriamp.detect_device(Sonamp, *args, logger: logger, timeout: options[:timeout])
           if device
             puts device
             exit 0

data/lib/seriamp/utils.rb

@@ -10,7 +10,7 @@ module Seriamp
       when '0', 'off', 'no', 'false'
         false
       else
-        raise ArgumentError, "Invalid on/off value: #{value}"
+        raise InvalidOnOffValue, "Invalid on/off value: #{value}"
       end
     end
 
@@ -20,19 +20,20 @@ module Seriamp
 
     module_function def consume_data(io, logger, msg)
       warned = false
-      read_bytes = 0
+      buf = +''
       while IO.select([io], nil, nil, 0)
         unless warned
           logger&.warn(msg)
           warned = true
         end
-        buf = io.read_nonblock(1024)
-        read_bytes += buf.length
+        buf += io.read_nonblock(1024)
       end
-      if read_bytes > 0
-        logger&.warn("Consumed #{read_bytes} bytes")
+      if buf.empty?
+        nil
+      else
+        logger&.warn("Consumed #{buf.length} bytes")
+        buf
       end
-      nil
     end
   end
 end

data/lib/seriamp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Seriamp
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

data/lib/seriamp/yamaha/client.rb

@@ -9,12 +9,14 @@ module Seriamp
   module Yamaha
 
     # The manual says response should be received in 500 ms.
-    RS232_TIMEOUT = 0.75
+    DEFAULT_RS232_TIMEOUT = 0.75
 
     class Client
       include Protocol::Methods
 
-      def initialize(device: nil, glob: nil, logger: nil, retries: true, thread_safe: false)
+      def initialize(device: nil, glob: nil, logger: nil, retries: true,
+        timeout: nil, thread_safe: false
+      )
         @logger = logger
 
         @device = device
@@ -30,6 +32,7 @@ module Seriamp
           else
             raise ArgumentError, "retries must be an integer, true, false or nil: #{retries}"
           end
+        @timeout = timeout || DEFAULT_RS232_TIMEOUT
         @thread_safe = !!thread_safe
 
         if thread_safe?
@@ -49,6 +52,7 @@ module Seriamp
       attr_reader :glob
       attr_reader :logger
       attr_reader :retries
+      attr_reader :timeout
 
       def thread_safe?
         @thread_safe
@@ -186,7 +190,7 @@ module Seriamp
       def open_device
         if detect_device? && device.nil?
           logger&.debug("Detecting device")
-          @device = Seriamp.detect_device(Yamaha, *glob, logger: logger)
+          @device = Seriamp.detect_device(Yamaha, *glob, logger: logger, timeout: timeout)
           if @device
             logger&.info("Using #{device} as TTY device")
           else
@@ -197,13 +201,14 @@ module Seriamp
         logger&.debug("Opening #{device}")
         @io = Backend::SerialPortBackend::Device.new(device, logger: logger)
 
-        Utils.consume_data(@io.io, logger,
+        buf = Utils.consume_data(@io.io, logger,
           "Serial device readable after opening - unread previous response?")
+        report_unread_response(buf)
 
         begin
           tries = 0
           begin
-            do_status
+            #do_status
           rescue CommunicationTimeout
             tries += 1
             if tries < 5
@@ -245,7 +250,7 @@ module Seriamp
 
       def read_response
         resp = +''
-        deadline = Utils.monotime + 1
+        deadline = Utils.monotime + timeout
         loop do
           begin
             chunk = @io.read_nonblock(1000)
@@ -261,12 +266,18 @@ module Seriamp
             IO.select([@io.io], nil, nil, budget)
           end
         end
+
+        if resp.count(ETX) > 1
+          logger&.warn("Multiple responses received: #{resp}")
+        end
+
         resp
       end
 
       MODEL_NAMES = {
         'R0177' => 'RX-V1500',
         'R0178' => 'RX-V2500',
+        'R0226' => 'RX-V1800',
       }.freeze
 
       PURE_DIRECT_FIELD = {
@@ -296,8 +307,9 @@ module Seriamp
         with_retry do
           resp = nil
           resp = dispatch(STATUS_REQ)
-          Utils.consume_data(@io.io, logger,
+          buf = Utils.consume_data(@io.io, logger,
             "Serial device readable after completely reading status response - concurrent access?")
+          report_unread_response(buf)
           if resp.length < 10
             raise HandshakeFailure, "Broken status response: expected at least 10 bytes, got #{resp.length} bytes; concurrent operation on device?"
           end
@@ -431,6 +443,28 @@ module Seriamp
           end
         end
       end
+
+      def report_unread_response(buf)
+        return if buf.nil?
+
+        if buf.count(ETX) > 1
+          logger&.warn("Multiple unread responses: #{buf}")
+
+          buf.split(ETX).each do |resp|
+            report_unread_response(resp + ETX)
+          end
+          return
+        end
+
+        case buf[0]
+        when DC2
+          logger&.warn("Status response, #{buf.length} bytes")
+        when STX
+          logger&.warn("Command response: #{buf}")
+        else
+          logger&.warn("Unknown unread response: #{buf}")
+        end
+      end
     end
   end
 end

data/lib/seriamp/yamaha/cmd.rb

@@ -14,17 +14,22 @@ module Seriamp
       def initialize(args = ARGV, stdin = STDIN)
         options = {}
         OptionParser.new do |opts|
-          opts.banner = "Usage: yamaha [-d device] command arg..."
+          opts.banner = "Usage: yamaha [options] command arg..."
 
           opts.on("-d", "--device DEVICE", "TTY to use (default autodetect)") do |v|
             options[:device] = v
           end
+
+          opts.on('-T', '--timeout TIMEOUT', 'Timeout to use') do |v|
+            options[:timeout] = Float(v)
+          end
         end.parse!
 
         @options = options
 
         @logger = Logger.new(STDERR)
-        @client = Yamaha::Client.new(device: options[:device], logger: @logger)
+        @client = Yamaha::Client.new(device: options[:device],
+          logger: @logger, timeout: options[:timeout])
 
         @args = args
         @stdin = stdin
@@ -33,6 +38,7 @@ module Seriamp
       attr_reader :args
       attr_reader :stdin
       attr_reader :logger
+      attr_reader :options
 
       def run
         if args.any?
@@ -74,7 +80,7 @@ module Seriamp
       attr_reader :client
 
       def executor
-        @executor ||= Executor.new(client)
+        @executor ||= Executor.new(client, timeout: options[:timeout])
       end
     end
   end

data/lib/seriamp/yamaha/executor.rb

@@ -3,17 +3,19 @@
 module Seriamp
   module Yamaha
     class Executor
-      def initialize(client)
+      def initialize(client, **opts)
         @client = client
+        @options = opts.dup.freeze
       end
 
       attr_reader :client
+      attr_reader :options
 
       def run_command(cmd, *args)
         cmd = cmd.gsub('_', '-')
         case cmd
         when 'detect'
-          device = Seriamp.detect_device(Yamaha, *args, logger: logger)
+          device = Seriamp.detect_device(Yamaha, *args, logger: logger, timeout: options[:timeout])
           if device
             puts device
             exit 0

data/seriamp.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "seriamp"
-  spec.version       = '0.2.1'
+  spec.version       = '0.2.2'
   spec.authors       = ['Oleg Pudeyev']
   spec.email         = ['code@olegp.name']
   spec.summary       = %q{Serial control for amplifiers & A/V receivers}

data/spec/sonamp/app_spec.rb

@@ -39,4 +39,26 @@ describe Seriamp::Sonamp::App do
       JSON.parse(last_response.body).should == final_state
     end
   end
+
+  describe '/zone/:zone/power' do
+    it 'works' do
+      client.should_receive(:set_zone_power).with(2, true)
+
+      put '/zone/2/power', 'true'
+
+      last_response.status.should == 204
+      p last_response.body.should == ''
+    end
+
+    context 'when value is invalid' do
+      it 'returns 422' do
+        client.should_not receive(:set_zone_power)
+
+        put '/zone/2/power', 'bogus'
+
+        last_response.status.should == 422
+        last_response.body.should =~ /\AError: .* bogus/
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seriamp
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Oleg Pudeyev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-14 00:00:00.000000000 Z
+date: 2023-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: serialport