sonamp 0.0.4 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b63474ec681132cd0674f5f2772e59494a585188e20b241af83fe865461adcd
-  data.tar.gz: 0d066e5ef22315e64ae704ddba85735fa996c8c6e7f818ed9f41e38b645a1aaa
+  metadata.gz: caf6fd82a4c7c254e7c132a7b6865094f6c311bd634a92db6a842ab1c3417624
+  data.tar.gz: 31e699f752afaef597a2f328f1a9d3eaceae3f0de2e898a75b8ca4af00ac7737
 SHA512:
-  metadata.gz: 3903c43f129e3a48f74e4a610f9cf3fd5b2e38d176508126c201370e6f171cbe929185f8bd6cc179bdff8d5188334aa157273127fa06df7fb50558ade4fa4a22
-  data.tar.gz: b8d88a7775bca97209ebdda191939ee4b4e1bc0de2f3a5629665051506e2f083a3c3fa0ec4a9a734da113969166de9e65b5f7ccef44721ee04285c5edd44eb22
+  metadata.gz: 0f1a00b0586c04eaece4df0fc7b0af818a827d9b4767862b7b4a12d840fbe3abe1f12f065197fee3f6b734d24fccceb7701aa8b8dc2ed5847d58dd6858ea06b8
+  data.tar.gz: 736d03293482038f5b8a592d1f9c6bbc47f526159baeec9ca704290995ed7c1f3b7cc04d29fae178dd82992894f81dbcb269a41f520b2e38b3ac699fe82abda2

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2022 Oleg Pudeyev
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/bin/sonamp

@@ -1,49 +1,10 @@
 #!/usr/bin/env ruby
 
 begin
-  require 'sonamp'
+  require 'sonamp/cmd'
 rescue LoadError
   $: << File.join(File.dirname(__FILE__), '../lib')
-  require 'sonamp'
+  require 'sonamp/cmd'
 end
-require 'optparse'
-require 'logger'
-require 'sonamp/utils'
 
-options = {}
-OptionParser.new do |opts|
-  opts.banner = "Usage: sonamp [-d device] command arg..."
-
-  opts.on("-d", "--device DEVICE", "TTY to use (default autodetect)") do |v|
-    options[:device] = v
-  end
-end.parse!
-
-logger = Logger.new(STDERR)
-client = Sonamp::Client.new(options[:device], logger: logger)
-
-cmd = ARGV.shift
-unless cmd
-  raise ArgumentError, "No command given"
-end
-
-include Sonamp::Utils
-
-case cmd
-when 'power'
-  zone = ARGV.shift.to_i
-  state = parse_on_off(ARGV.shift)
-  client.set_zone_power(zone, state)
-when 'zvol'
-  zone = ARGV.shift.to_i
-  volume = ARGV.shift.to_i
-  client.set_zone_volume(zone, volume)
-when 'cvol'
-  channel = ARGV.shift.to_i
-  volume = ARGV.shift.to_i
-  client.set_channel_volume(channel, volume)
-when 'status'
-  client.status
-else
-  raise ArgumentError, "Unknown command: #{cmd}"
-end
+Sonamp::Cmd.new(ARGV).run

data/lib/sonamp/client.rb

@@ -1,15 +1,51 @@
+require 'timeout'
+
 module Sonamp
   class Error < StandardError; end
   class InvalidCommand < Error; end
   class NotApplicable < Error; end
   class UnexpectedResponse < Error; end
+  class CommunicationTimeout < Error; end
+
+  RS232_TIMEOUT = 3
+  DEFAULT_DEVICE_GLOB = '/dev/ttyUSB*'
+
+  module_function def detect_device(*patterns, logger: nil)
+    if patterns.empty?
+      patterns = [DEFAULT_DEVICE_GLOB]
+    end
+    devices = patterns.map do |pattern|
+      Dir.glob(pattern)
+    end.flatten.uniq
+    queue = Queue.new
+    threads = devices.map do |device|
+      Thread.new do
+        Timeout.timeout(RS232_TIMEOUT * 2) do
+          logger&.debug("Trying #{device}")
+          Client.new(device, logger: logger).get_zone_power
+          logger&.debug("Found receiver at #{device}")
+          queue << device
+        end
+      rescue CommunicationTimeout, IOError, SystemCallError => exc
+        logger&.debug("Failed on #{device}: #{exc.class}: #{exc}")
+      end
+    end
+    wait_thread = Thread.new do
+      threads.map(&:join)
+      queue << nil
+    end
+    queue.shift.tap do
+      threads.map(&:kill)
+      wait_thread.kill
+    end
+  end
 
   class Client
     def initialize(device = nil, logger: nil)
       @logger = logger
 
       if device.nil?
-        device = Dir['/dev/ttyUSB*'].sort.first
+        device = Sonamp.detect_device(logger: logger)
         if device
           logger&.info("Using #{device} as TTY device")
         end
@@ -39,29 +75,22 @@ module Sonamp
     end
 
     def get_zone_volume(zone = nil)
-      if zone
-        if zone < 1 || zone > 4
-          raise ArgumentError, "Zone must be between 1 and 4: #{zone}"
-        end
-        resp = dispatch(":V#{zone}?")
-        resp[2...].to_i
-      else
-        dispatch(":VG?", 4).map do |resp|
-          resp[2...].to_i
-        end
-      end
+      get_zone_value('V', zone)
     end
 
     def set_zone_volume(zone, volume)
-      if zone < 1 || zone > 4
-        raise ArgumentError, "Zone must be between 1 and 4: #{zone}"
-      end
       if volume < 0 || volume > 100
         raise ArgumentError, "Volume must be between 0 and 100: #{volume}"
       end
-      cmd = ":V#{zone}#{volume}"
-      expected = cmd[1...cmd.length]
-      dispatch_assert(cmd, expected)
+      set_zone_value('V', zone, volume)
+    end
+
+    def set_zone_mute(zone, state)
+      set_zone_value('M', zone, state ? 1 : 0)
+    end
+
+    def get_channel_volume(channel = nil)
+      get_channel_value('VC', channel)
     end
 
     def set_channel_volume(channel, volume)
@@ -76,10 +105,26 @@ module Sonamp
       dispatch_assert(cmd, expected)
     end
 
+    def set_channel_mute(channel, state)
+      set_channel_value('MC', channel, state ? 1 : 0)
+    end
+
     def get_zone_mute(zone = nil)
       get_zone_state('M', zone)
     end
 
+    def get_channel_mute(channel = nil)
+      get_channel_state('MC', channel)
+    end
+
+    def get_channel_front_panel_level(channel = nil)
+      get_channel_value('TVL', channel)
+    end
+
+    def get_zone_fault(zone = nil)
+      get_zone_state('FP', zone)
+    end
+
     def get_bbe(zone = nil)
       get_zone_state('BP', zone)
     end
@@ -100,25 +145,34 @@ module Sonamp
       get_zone_state('VTI', zone)
     end
 
+    def get_firmware_version
+      global_query('VER')
+    end
+
+    def get_temperature
+      Integer(global_query('TP'))
+    end
+
     def status
       # Reusing the opened device file makes :VTIG? fail even with a delay
       # in front.
       #open_device do
-        p dispatch(':VER?')
-        p dispatch(':TP?')
-        p get_power
-        p dispatch(':FPG?', 4)
-        p get_zone_volume
-        p dispatch(':VCG?', 8)
-        p get_auto_trigger_input
-        sleep 0.1
-        p get_voltage_trigger_input
-        p dispatch(':TVLG?', 8)
-        p get_zone_mute
-        p dispatch(':MCG?', 8)
-        p get_bbe
-        p get_bbe_high_boost
-        p get_bbe_low_boost
+        {
+          firmware_version: get_firmware_version,
+          temperature: get_temperature,
+          zone_power: get_zone_power,
+          zone_fault: get_zone_fault,
+          zone_volume: get_zone_volume,
+          channel_volume: get_channel_volume,
+          zone_mute: get_zone_mute,
+          channel_mute: get_channel_mute,
+          bbe: get_bbe,
+          bbe_high_boost: get_bbe_high_boost,
+          bbe_low_boost: get_bbe_low_boost,
+          auto_trigger_input: get_auto_trigger_input,
+          voltage_trigger_input: get_voltage_trigger_input,
+          channel_front_panel_level: get_channel_front_panel_level,
+        }
       #end
     end
 
@@ -128,7 +182,7 @@ module Sonamp
       if @f
         yield
       else
-        File.open(device, 'r+') do |f|
+        File.open(device, 'r+b') do |f|
           @f = f
           yield.tap do
             @f = nil
@@ -139,7 +193,9 @@ module Sonamp
 
     def dispatch(cmd, resp_lines_count = 1)
       open_device do
-        @f << "#{cmd}\x0d"
+        with_timeout do
+          @f.syswrite("#{cmd}\x0d")
+        end
         resp = 1.upto(resp_lines_count).map do
           read_line(@f, cmd)
         end
@@ -158,28 +214,105 @@ module Sonamp
       end
     end
 
+    def extract_suffix(resp, expected_prefix)
+      unless resp[0..expected_prefix.length-1] == expected_prefix
+        raise UnexpectedResponse, "Unexpected response: expected #{expected_prefix}..., actual #{resp}"
+      end
+      resp[expected_prefix.length..]
+    end
+
+    def dispatch_extract_suffix(cmd, expected_prefix)
+      resp = dispatch(cmd)
+      extract_suffix(resp, expected_prefix)
+    end
+
+    def global_query(cmd)
+      dispatch_extract_suffix(":#{cmd}?", cmd)
+    end
+
+    def with_timeout(&block)
+      Timeout.timeout(RS232_TIMEOUT, CommunicationTimeout, &block)
+    end
+
     def read_line(f, cmd)
-      f.readline.strip.tap do |resp|
-        if resp == 'ERR'
-          raise InvalidCommand, "Invalid command: #{cmd}"
-        elsif resp == 'N/A'
-          raise NotApplicable, "Command was recognized but could not be executed - is serial control enabled on the amplifier?"
+      with_timeout do
+        f.readline.strip.tap do |resp|
+          if resp == 'ERR'
+            raise InvalidCommand, "Invalid command: #{cmd}"
+          elsif resp == 'N/A'
+            raise NotApplicable, "Command was recognized but could not be executed - is serial control enabled on the amplifier?"
+          end
         end
       end
     end
 
-    def get_zone_state(cmd_prefix, zone)
+    def set_zone_value(cmd_prefix, zone, value)
+      if zone < 1 || zone > 4
+        raise ArgumentError, "Zone must be between 1 and 4: #{zone}"
+      end
+      cmd = ":#{cmd_prefix}#{zone}#{value}"
+      expected = cmd[1...cmd.length]
+      dispatch_assert(cmd, expected)
+    end
+
+    def get_zone_value(cmd_prefix, zone, boolize: false)
       if zone
         if zone < 1 || zone > 4
           raise ArgumentError, "Zone must be between 1 and 4: #{zone}"
         end
         resp = dispatch(":#{cmd_prefix}#{zone}?")
-        resp[cmd_prefix.length + 1] == '1' ? true : false
+        typecast_value(resp[cmd_prefix.length + 1..], boolize)
       else
-        dispatch(":#{cmd_prefix}G?", 4).map do |resp|
-          resp[cmd_prefix.length + 1] == '1' ? true : false
+        index = 1
+        hashize_query_result(dispatch(":#{cmd_prefix}G?", 4), cmd_prefix, boolize)
+      end
+    end
+
+    def hashize_query_result(resp_lines, cmd_prefix, boolize)
+      index = 1
+      Hash[resp_lines.map do |resp|
+        value = typecast_value(extract_suffix(resp, "#{cmd_prefix}#{index}"), boolize)
+        [index, value].tap do
+          index += 1
         end
+      end]
+    end
+
+    def get_zone_state(cmd_prefix, zone)
+      get_zone_value(cmd_prefix, zone, boolize: true)
+    end
+
+    def set_channel_value(cmd_prefix, channel, value)
+      if channel < 1 || channel > 8
+        raise ArgumentError, "Channel must be between 1 and 8: #{channel}"
+      end
+      cmd = ":#{cmd_prefix}#{channel}#{value}"
+      expected = cmd[1...cmd.length]
+      dispatch_assert(cmd, expected)
+    end
+
+    def get_channel_value(cmd_prefix, channel, boolize: false)
+      if channel
+        if channel < 1 || channel > 8
+          raise ArgumentError, "Channel must be between 1 and 8: #{channel}"
+        end
+        typecast_value(dispatch_extract_suffix(":#{cmd_prefix}#{channel}?", "#{cmd_prefix}#{channel}"), boolize)
+      else
+        index = 1
+        hashize_query_result(dispatch(":#{cmd_prefix}G?", 8), cmd_prefix, boolize)
+      end
+    end
+
+    def get_channel_state(cmd_prefix, channel)
+      get_channel_value(cmd_prefix, channel, boolize: true)
+    end
+
+    def typecast_value(value, boolize)
+      value = Integer(value)
+      if boolize
+        value = value == 1
       end
+      value
     end
   end
 end

data/lib/sonamp/cmd.rb

@@ -0,0 +1,81 @@
+require 'optparse'
+require 'logger'
+require 'sonamp/utils'
+require 'sonamp/client'
+
+module Sonamp
+  class Cmd
+    def initialize(args)
+      options = {}
+      OptionParser.new do |opts|
+        opts.banner = "Usage: sonamp [-d device] command arg..."
+
+        opts.on("-d", "--device DEVICE", "TTY to use (default autodetect)") do |v|
+          options[:device] = v
+        end
+      end.parse!(args)
+
+      @options = options
+
+      @logger = Logger.new(STDERR)
+      @client = Sonamp::Client.new(options[:device], logger: @logger)
+
+      @args = args
+    end
+
+    attr_reader :args
+    attr_reader :logger
+
+    def run
+      cmd = args.shift
+      unless cmd
+        raise ArgumentError, "No command given"
+      end
+
+      case cmd
+      when 'detect'
+        device = Sonamp.detect_device(*args, logger: logger)
+        if device
+          puts device
+          exit 0
+        else
+          STDERR.puts("Sonamp amplifier not found")
+          exit 3
+        end
+      when 'off'
+        client.set_zone_power(1, false)
+        client.set_zone_power(2, false)
+        client.set_zone_power(3, false)
+        client.set_zone_power(4, false)
+      when 'power'
+        zone = args.shift.to_i
+        state = Utils.parse_on_off(ARGV.shift)
+        client.set_zone_power(zone, state)
+      when 'zvol'
+        zone = args.shift.to_i
+        volume = ARGV.shift.to_i
+        client.set_zone_volume(zone, volume)
+      when 'cvol'
+        channel = args.shift.to_i
+        volume = args.shift.to_i
+        client.set_channel_volume(channel, volume)
+      when 'zmute'
+        zone = args.shift.to_i
+        mute = ARGV.shift.to_i
+        client.set_zone_mute(zone, mute)
+      when 'cmute'
+        channel = args.shift.to_i
+        mute = args.shift.to_i
+        client.set_channel_mute(channel, mute)
+      when 'status'
+        pp client.status
+      else
+        raise ArgumentError, "Unknown command: #{cmd}"
+      end
+    end
+
+    private
+
+    attr_reader :client
+  end
+end

data/lib/sonamp/utils.rb

@@ -5,7 +5,7 @@ module Sonamp
       case value&.downcase
       when '1', 'on', 'yes', 'true'
         true
-      when '0', 'off', 'no', 'value'
+      when '0', 'off', 'no', 'false'
         false
       else
         raise ArgumentError, "Invalid on/off value: #{value}"

data/lib/sonamp/version.rb

@@ -1,3 +1,3 @@
 module Sonamp
-  VERSION = '0.0.4'.freeze
+  VERSION = '0.0.7'.freeze
 end

data/sonamp.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "sonamp"
-  spec.version       = '0.0.4'
+  spec.version       = '0.0.7'
   spec.authors       = ['Oleg Pudeyev']
   spec.email         = ['code@olegp.name']
   spec.summary       = %q{Sonance Sonamp Amplifier Serial Control Interface}
-  spec.description   = %q{Library for controlling Sonance Sonamp 875D & 875D MkII amplifiers via the serial port}
+  spec.description   = %q{Library for controlling Sonance Sonamp 875D SE & 875D MkII amplifiers via the serial port}
   spec.homepage      = "https://github.com/p/sonamp-ruby"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0")
+  spec.files         = `git ls-files -z`.split("\x0").reject { |path| path.start_with?('docs/') }
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: sonamp
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.7
 platform: ruby
 authors:
 - Oleg Pudeyev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-26 00:00:00.000000000 Z
+date: 2022-11-07 00:00:00.000000000 Z
 dependencies: []
-description: Library for controlling Sonance Sonamp 875D & 875D MkII amplifiers via
-  the serial port
+description: Library for controlling Sonance Sonamp 875D SE & 875D MkII amplifiers
+  via the serial port
 email:
 - code@olegp.name
 executables:
@@ -21,11 +21,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- LICENSE
 - bin/sonamp
 - bin/sonamp-web
 - lib/sonamp.rb
 - lib/sonamp/app.rb
 - lib/sonamp/client.rb
+- lib/sonamp/cmd.rb
 - lib/sonamp/utils.rb
 - lib/sonamp/version.rb
 - sonamp.gemspec