yamaha 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0188bdf2202b494dbd4c2891306a12669720b67a682e8a453b09ee83ea8a5429'
-  data.tar.gz: d4eac8f6cb79c9e9e2dffc435d6a01dd5b644b2ffcb10cfb05dc6d1dca20fadc
+  metadata.gz: 292b70dd67f90f6bf205084ab1bd6de2248c93edc5108acfd1daf798fa9cf320
+  data.tar.gz: 14a7cb6c48e62aed373c79c048cc309c09741614f616eb41c43555f8256626b1
 SHA512:
-  metadata.gz: 99bbf9e9df184abeba408745ff4bf965138073f02ee1beb49db937ffd0460415c5c272472275b3cb83cde20341377f653a4c88af1a7e06f2a1b8611b22bd8297
-  data.tar.gz: 217919ae3985b8b746e310cfb017f613a5c26c1fb7f9c2012c8a2093675d4c749bb777d6f64a26fe36a629de3861ae7f29941d08ad961305031b991153b71c6f
+  metadata.gz: d5059e62f80e3cdf8e5a21932696a9d2ffa484d050d03646d1e6719cb76ebd7108e22033946cf551296d5c24a8a5ef579d02099ea8ba67752655fcc397659979
+  data.tar.gz: dd338e1d1fe2220356d0a2e3c0a7f02388294325385954f7b625773d2aa211d3b9f66db9fde28b48357d852ecae80ae8b76c367509cee19cc1a6ae203cd66eb5

data/.gitignore

@@ -0,0 +1,2 @@
+.yardoc
+*.gem

data/README.md

@@ -5,17 +5,18 @@
 ### RX-V1500 Power Values
 
 You might expect the power state to be a bit field, but it isn't - each
-combination appears to have been assigned an independent value:
-
-| Main zone | Zone 2 | Zone 3 | Value | Notes
-| On        | On     | On     | 1     | All on
-| On        | On     | Off    | 4     |
-| On        | Off    | On     | 5     |
-| On        | Off    | Off    | 2     |
-| Off       | On     | On     | 3     |
-| Off       | On     | Off    | 6     |
-| Off       | Off    | On     | 7     |
-| Off       | Off    | Off    | 0     | All off
+combination is assigned an independent value:
+
+| Main zone | Zone 2 | Zone 3 | Value | Notes   |
+| --------- | ------ | ------ | ----- | ------- |
+| On        | On     | On     | 1     | All on  |
+| On        | On     | Off    | 4     |         |
+| On        | Off    | On     | 5     |         |
+| On        | Off    | Off    | 2     |         |
+| Off       | On     | On     | 3     |         |
+| Off       | On     | Off    | 6     |         |
+| Off       | Off    | On     | 7     |         |
+| Off       | Off    | Off    | 0     | All off |
 
 ## Implementation Notes
 
@@ -62,7 +63,7 @@ Yamaha RS232/serial protocol:
 
 - [YRXV1500-MQTT](https://github.com/FireFrei/yrxv1500-mqtt)
 - [YamahaController](https://github.com/mrworf/yamahacontroller)
-- [Homie ESP8266 Yamaha RX-Vxxxx Control]https://github.com/memphi2/homie-yamaha-rs232)
+- [Homie ESP8266 Yamaha RX-Vxxxx Control](https://github.com/memphi2/homie-yamaha-rs232)
 
 Serial port communication in Ruby:
 

data/bin/yamaha

@@ -3,118 +3,10 @@
 # frozen_string_literal: true
 
 begin
-  require 'yamaha'
+  require 'yamaha/cmd'
 rescue LoadError
   $: << File.join(File.dirname(__FILE__), '../lib')
-  require 'yamaha'
+  require 'yamaha/cmd'
 end
-require 'optparse'
-require 'logger'
-require 'pp'
 
-options = {}
-OptionParser.new do |opts|
-  opts.banner = "Usage: yamaha [-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 = Yamaha::Client.new(options[:device], logger: logger)
-
-cmd = ARGV.shift
-unless cmd
-  raise ArgumentError, "No command given"
-end
-
-def parse_on_off(value)
-  case value&.downcase
-  when '1', 'on', 'yes', 'true'
-    true
-  when '0', 'off', 'no', 'value'
-    false
-  else
-    raise ArgumentError, "Invalid on/off value: #{value}"
-  end
-end
-
-case cmd
-when 'detect'
-  device = Yamaha::Client.detect_device(*ARGV, logger: logger)
-  if device
-    puts device
-    exit 0
-  else
-    STDERR.puts("Yamaha receiver not found")
-    exit 3
-  end
-when 'power'
-  which = ARGV.shift&.downcase
-  if %w(main zone2 zone3).include?(which)
-    method = "set_#{which}_power"
-    state = parse_on_off(ARGV.shift)
-  else
-    method = 'set_power'
-    state = parse_on_off(which)
-  end
-  client.public_send(method, state)
-when 'volume'
-  which = ARGV.shift
-  if %w(main zone2 zone3).include?(which)
-    prefix = "set_#{which}"
-    value = ARGV.shift
-  else
-    prefix = 'set_main'
-    value = which
-  end
-  if %w(. -).include?(value)
-    method = "#{prefix}_mute"
-    value = true
-  else
-    method = "#{prefix}_volume_db"
-    if value[0] == ','
-      value = value[1..]
-    end
-    value = Float(value)
-  end
-  client.public_send(method, value)
-  p client.get_main_volume_text
-  p client.get_zone2_volume_text
-  p client.get_zone3_volume_text
-when 'input'
-  which = ARGV.shift&.downcase
-  if %w(main zone2 zone3).include?(which)
-    method = "set_#{which}_input"
-    input = ARGV.shift
-  else
-    method = 'set_main_input'
-    input = which
-  end
-  client.public_send(method, input)
-when 'program'
-  value = ARGV.shift.downcase
-  client.set_program(value)
-when 'pure-direct'
-  state = parse_on_off(ARGV.shift)
-  client.set_pure_direct(state)
-when 'status'
-  pp client.last_status
-when 'status_string'
-  puts client.last_status_string
-when 'test'
-  client.set_power(false)
-  [true, false].each do |main_state|
-    [true, false].each do |zone2_state|
-      [true, false].each do |zone3_state|
-        client.set_main_power(main_state)
-        client.set_zone2_power(zone2_state)
-        client.set_zone3_power(zone3_state)
-        puts "#{main_state ?1:0} #{zone2_state ?1:0} #{zone3_state ?1:0} #{client.status[:power]}"
-      end
-    end
-  end
-else
-  raise ArgumentError, "Unknown command: #{cmd}"
-end
+Yamaha::Cmd.new(ARGV).run

data/lib/yamaha/client.rb

@@ -13,37 +13,45 @@ module Yamaha
   class UnexpectedResponse < Error; end
   class CommunicationTimeout < Error; end
 
-  RS232_TIMEOUT = 9
+  RS232_TIMEOUT = 3
   DEFAULT_DEVICE_GLOB = '/dev/ttyUSB*'
 
-  class Client
-    def self.detect_device(*patterns, logger: nil)
-      if patterns.empty?
-        patterns = [DEFAULT_DEVICE_GLOB]
-      end
-      devices = patterns.map do |pattern|
-        Dir.glob(pattern)
-      end.flatten.uniq
-      found = nil
-      threads = devices.map do |device|
-        Thread.new do
-          Timeout.timeout(RS232_TIMEOUT) do
-            logger&.debug("Trying #{device}")
-            new(device, logger: logger).status
-            logger&.debug("Found receiver at #{device}")
-            found = device
-          end
+  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 * 3) do
+          logger&.debug("Trying #{device}")
+          Client.new(device, logger: logger).last_status
+          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)
-      found
+      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[DEFAULT_DEVICE_GLOB].sort.first
+        device = Yamaha.detect_device(logger: logger)
         if device
           logger&.info("Using #{device} as TTY device")
         end
@@ -89,35 +97,59 @@ module Yamaha
       last_status
     end
 
+    # Turns the receiver on or off.
+    #
+    # @param [ true | false ] state Desired power state.
     def set_power(state)
       remote_command("7A1#{state ? 'D' : 'E'}")
     end
 
+    # Turns main zone power on or off.
+    #
+    # @param [ true | false ] state Desired power state.
     def set_main_power(state)
       remote_command("7E7#{state ? 'E' : 'F'}")
     end
 
+    # Turns zone 2 power on or off.
+    #
+    # @param [ true | false ] state Desired power state.
     def set_zone2_power(state)
       remote_command("7EB#{state ? 'A' : 'B'}")
     end
 
+    # Turns zone 3 power on or off.
+    #
+    # @param [ true | false ] state Desired power state.
     def set_zone3_power(state)
       remote_command("7AE#{state ? 'D' : 'E'}")
     end
 
+    # Sets main zone volume.
+    #
+    # @param [ Integer ] value The raw volume value.
     def set_main_volume(value)
       system_command("30#{'%02x' % value}")
     end
 
+    # Sets main zone volume.
+    #
+    # @param [ Float ] volume The volume in decibels.
     def set_main_volume_db(volume)
       value = Integer((volume + 80) * 2 + 39)
       set_main_volume(value)
     end
 
+    # Sets zone 2 volume.
+    #
+    # @param [ Integer ] value The raw volume value.
     def set_zone2_volume(value)
       system_command("31#{'%02x' % value}")
     end
 
+    # Sets zone 2 volume.
+    #
+    # @param [ Float ] volume The volume in decibels.
     def set_zone2_volume_db(volume)
       value = Integer(volume + 33 + 39)
       set_zone2_volume(value)
@@ -131,6 +163,9 @@ module Yamaha
       remote_command('7ADB')
     end
 
+    # Sets zone 3 volume.
+    #
+    # @param [ Integer ] volume The raw volume value.
     def set_zone3_volume(volume)
       remote_command("234#{'%02x' % value}")
     end
@@ -159,10 +194,35 @@ module Yamaha
       extract_text(system_command("2005"))[3...].strip
     end
 
+    # Turns pure direct mode on or off.
+    #
+    # @param [ true | false ] state Desired state.
     def set_pure_direct(state)
       dispatch("#{STX}07E8#{state ? '0' : '2'}#{ETX}")
     end
 
+    def set_program(value)
+      program_code = PROGRAM_SET.fetch(value.downcase.gsub(/[^a-z]/, '_'))
+      remote_command("7E#{program_code}")
+    end
+
+    def set_main_input(source)
+      source_code = MAIN_INPUTS_SET.fetch(source.downcase.gsub(/[^a-z]/, '_'))
+      remote_command("7A#{source_code}")
+    end
+
+    def set_zone2_input(source)
+      source_code = ZONE2_INPUTS_SET.fetch(source.downcase.gsub(/[^a-z]/, '_'))
+      remote_command("7A#{source_code}")
+    end
+
+    def set_zone3_input(source)
+      source_code = ZONE3_INPUTS_SET.fetch(source.downcase.gsub(/[^a-z]/, '_'))
+      remote_command("7A#{source_code}")
+    end
+
+    private
+
     PROGRAM_SET = {
       'munich' => 'E1',
       'vienna' => 'E5',
@@ -195,11 +255,6 @@ module Yamaha
       'thx_game' => 'C8',
     }.freeze
 
-    def set_program(value)
-      program_code = PROGRAM_SET.fetch(value.downcase.gsub(/[^a-z]/, '_'))
-      remote_command("7E#{program_code}")
-    end
-
     MAIN_INPUTS_SET = {
       'phono' => '14',
       'cd' => '15',
@@ -216,11 +271,6 @@ module Yamaha
       'xm' => 'B4',
     }.freeze
 
-    def set_main_input(source)
-      source_code = MAIN_INPUTS_SET.fetch(source.downcase.gsub(/[^a-z]/, '_'))
-      remote_command("7A#{source_code}")
-    end
-
     ZONE2_INPUTS_SET = {
       'phono' => 'D0',
       'cd' => 'D1',
@@ -236,11 +286,6 @@ module Yamaha
       'xm' => 'B8',
     }.freeze
 
-    def set_zone2_input(source)
-      source_code = ZONE2_INPUTS_SET.fetch(source.downcase.gsub(/[^a-z]/, '_'))
-      remote_command("7A#{source_code}")
-    end
-
     ZONE3_INPUTS_SET = {
       'phono' => 'F1',
       'cd' => 'F2',
@@ -256,72 +301,6 @@ module Yamaha
       'xm' => 'B9',
     }.freeze
 
-    def set_zone3_input(source)
-      source_code = ZONE3_INPUTS_SET.fetch(source.downcase.gsub(/[^a-z]/, '_'))
-      remote_command("7A#{source_code}")
-    end
-
-    private
-
-    def open_device
-      @f = Backend::SerialPortBackend::Device.new(device, logger: logger)
-
-      tries = 0
-      begin
-        do_status
-      rescue CommunicationTimeout
-        tries += 1
-        if tries < 5
-          logger&.warn("Timeout handshaking with the receiver - will retry")
-          retry
-        else
-          raise
-        end
-      end
-
-      yield.tap do
-        @f.close
-      end
-    end
-
-    # ASCII table: https://www.asciitable.com/
-    DC1 = +?\x11
-    DC2 = +?\x12
-    ETX = +?\x03
-    STX = +?\x02
-    DEL = +?\x7f
-
-    STATUS_REQ = -"#{DC1}001#{ETX}"
-
-    ZERO_ORD = '0'.ord
-
-    def dispatch(cmd)
-      open_device do
-        do_dispatch(cmd)
-      end
-    end
-
-    def do_dispatch(cmd)
-      @f.syswrite(cmd.encode('ascii'))
-      read_response
-    end
-
-    def read_response
-      resp = +''
-      Timeout.timeout(2, CommunicationTimeout) do
-        loop do
-          ch = @f.sysread(1)
-          if ch
-            resp << ch
-            break if ch == ETX
-          else
-            sleep 0.1
-          end
-        end
-      end
-      resp
-    end
-
     MAIN_INPUTS_GET = {
       '0' => 'PHONO',
       '1' => 'CD',
@@ -411,10 +390,69 @@ module Yamaha
       '40' => 'Enhancer 2ch Low',
       '41' => 'Enhancer 2ch High',
       '42' => 'Enhancer 7ch Low',
-      '43' => 'Enhancer 7ch Higgh',
+      '43' => 'Enhancer 7ch High',
       '80' => 'Straight',
     }.freeze
 
+    def open_device
+      @f = Backend::SerialPortBackend::Device.new(device, logger: logger)
+
+      tries = 0
+      begin
+        do_status
+      rescue CommunicationTimeout
+        tries += 1
+        if tries < 5
+          logger&.warn("Timeout handshaking with the receiver - will retry")
+          retry
+        else
+          raise
+        end
+      end
+
+      yield.tap do
+        @f.close
+      end
+    end
+
+    # ASCII table: https://www.asciitable.com/
+    DC1 = +?\x11
+    DC2 = +?\x12
+    ETX = +?\x03
+    STX = +?\x02
+    DEL = +?\x7f
+
+    STATUS_REQ = -"#{DC1}001#{ETX}"
+
+    ZERO_ORD = '0'.ord
+
+    def dispatch(cmd)
+      open_device do
+        do_dispatch(cmd)
+      end
+    end
+
+    def do_dispatch(cmd)
+      @f.syswrite(cmd.encode('ascii'))
+      read_response
+    end
+
+    def read_response
+      resp = +''
+      Timeout.timeout(2, CommunicationTimeout) do
+        loop do
+          ch = @f.sysread(1)
+          if ch
+            resp << ch
+            break if ch == ETX
+          else
+            sleep 0.1
+          end
+        end
+      end
+      resp
+    end
+
     def do_status
       resp = nil
       loop do
@@ -494,6 +532,34 @@ module Yamaha
       @status
     end
 
+    %i(
+      model_code firmware_version system_status power main_power zone2_power
+      zone3_power input input_name audio_select audio_select_name
+      main_volume main_volume_db zone2_volume zone2_volume_db
+      zone3_volume zone3_volume_db program program_name sleep night night_name
+      format sample_rate
+    ).each do |meth|
+      define_method(meth) do
+        status.fetch(meth)
+      end
+
+      define_method("last_#{meth}") do
+        last_status.fetch(meth)
+      end
+    end
+
+    %i(
+      multi_ch_input effect pure_direct speaker_a speaker_b
+    ).each do |meth|
+      define_method("#{meth}?") do
+        status.fetch(meth)
+      end
+
+      define_method("last_#{meth}?") do
+        last_status.fetch(meth)
+      end
+    end
+
     def remote_command(cmd)
       dispatch("#{STX}0#{cmd}#{ETX}")
     end

data/lib/yamaha/cmd.rb

@@ -0,0 +1,120 @@
+require 'optparse'
+require 'logger'
+require 'pp'
+require 'yamaha/utils'
+require 'yamaha/client'
+
+module Yamaha
+  class Cmd
+    def initialize(args)
+      options = {}
+      OptionParser.new do |opts|
+        opts.banner = "Usage: yamaha [-d device] command arg..."
+
+        opts.on("-d", "--device DEVICE", "TTY to use (default autodetect)") do |v|
+          options[:device] = v
+        end
+      end.parse!
+
+      @options = options
+
+      @logger = Logger.new(STDERR)
+      @client = Yamaha::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 = Yamaha::Client.detect_device(*args, logger: logger)
+        if device
+          puts device
+          exit 0
+        else
+          STDERR.puts("Yamaha receiver not found")
+          exit 3
+        end
+      when 'power'
+        which = ARGV.shift&.downcase
+        if %w(main zone2 zone3).include?(which)
+          method = "set_#{which}_power"
+          state = parse_on_off(ARGV.shift)
+        else
+          method = 'set_power'
+          state = parse_on_off(which)
+        end
+        client.public_send(method, state)
+      when 'volume'
+        which = ARGV.shift
+        if %w(main zone2 zone3).include?(which)
+          prefix = "set_#{which}"
+          value = ARGV.shift
+        else
+          prefix = 'set_main'
+          value = which
+        end
+        if %w(. -).include?(value)
+          method = "#{prefix}_mute"
+          value = true
+        else
+          method = "#{prefix}_volume_db"
+          if value[0] == ','
+            value = value[1..]
+          end
+          value = Float(value)
+        end
+        client.public_send(method, value)
+        p client.get_main_volume_text
+        p client.get_zone2_volume_text
+        p client.get_zone3_volume_text
+      when 'input'
+        which = ARGV.shift&.downcase
+        if %w(main zone2 zone3).include?(which)
+          method = "set_#{which}_input"
+          input = ARGV.shift
+        else
+          method = 'set_main_input'
+          input = which
+        end
+        client.public_send(method, input)
+      when 'program'
+        value = ARGV.shift.downcase
+        client.set_program(value)
+      when 'pure-direct'
+        state = parse_on_off(ARGV.shift)
+        client.set_pure_direct(state)
+      when 'status'
+        pp client.last_status
+      when 'status_string'
+        puts client.last_status_string
+      when 'test'
+        client.set_power(false)
+        [true, false].each do |main_state|
+          [true, false].each do |zone2_state|
+            [true, false].each do |zone3_state|
+              client.set_main_power(main_state)
+              client.set_zone2_power(zone2_state)
+              client.set_zone3_power(zone3_state)
+              puts "#{main_state ?1:0} #{zone2_state ?1:0} #{zone3_state ?1:0} #{client.status[:power]}"
+            end
+          end
+        end
+      else
+        raise ArgumentError, "Unknown command: #{cmd}"
+      end
+    end
+
+    private
+
+    attr_reader :client
+  end
+end

data/lib/yamaha/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Yamaha
-  VERSION = -'0.0.3'
+  VERSION = -'0.0.4'
 end

data/yamaha.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "yamaha"
-  spec.version       = '0.0.3'
+  spec.version       = '0.0.4'
   spec.authors       = ['Oleg Pudeyev']
   spec.email         = ['code@olegp.name']
   spec.summary       = %q{Yamaha Receiver Serial Control Interface}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yamaha
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Oleg Pudeyev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-02 00:00:00.000000000 Z
+date: 2022-11-16 00:00:00.000000000 Z
 dependencies: []
 description: Library for controlling Yamaha amplifiers via the serial port
 email:
@@ -19,6 +19,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - LICENSE
 - README.md
 - bin/yamaha
@@ -28,6 +29,7 @@ files:
 - lib/yamaha/backend/ffi.rb
 - lib/yamaha/backend/serial_port.rb
 - lib/yamaha/client.rb
+- lib/yamaha/cmd.rb
 - lib/yamaha/utils.rb
 - lib/yamaha/version.rb
 - yamaha.gemspec