seriamp 0.1.2

data/lib/seriamp/yamaha/client.rb

@@ -0,0 +1,279 @@
+# frozen_string_literal: true
+
+require 'timeout'
+require 'seriamp/backend/serial_port'
+require 'seriamp/yamaha/protocol/constants'
+require 'seriamp/yamaha/protocol/methods'
+
+module Seriamp
+  module Yamaha
+
+    RS232_TIMEOUT = 3
+
+    class Client
+      include Protocol::Methods
+
+      def initialize(device: nil, glob: nil, logger: nil)
+        @logger = logger
+
+        @device = device
+        @detect_device = device.nil?
+        @glob = glob
+
+        if block_given?
+          begin
+            yield self
+          ensure
+            close
+          end
+        end
+      end
+
+      attr_reader :device
+      attr_reader :glob
+      attr_reader :logger
+
+      def detect_device?
+        @detect_device
+      end
+
+      def present?
+        last_status
+        true
+      end
+
+      def last_status
+        unless @status
+          with_device do
+          end
+        end
+        @status.dup
+      end
+
+      def last_status_string
+        unless @status_string
+          with_device do
+          end
+        end
+        @status_string.dup
+      end
+
+      def status
+        do_status
+        last_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
+
+      private
+
+      include Protocol::Constants
+
+      def open_device
+        if detect_device? && device.nil?
+          @device = Seriamp.detect_device(Yamaha, *glob, logger: logger)
+          if @device
+            logger&.info("Using #{device} as TTY device")
+          else
+            raise NoDevice, "No device specified and device could not be detected automatically"
+          end
+        end
+
+        @io = Backend::SerialPortBackend::Device.new(device, logger: logger)
+
+        begin
+          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 @io
+        ensure
+          @io.close rescue nil
+          @io = nil
+        end
+      end
+
+      def with_device(&block)
+        if @io
+          yield @io
+        else
+          open_device(&block)
+        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)
+        with_device do
+          @io.syswrite(cmd.encode('ascii'))
+          read_response
+        end
+      end
+
+      def read_response
+        resp = +''
+        Timeout.timeout(2, CommunicationTimeout) do
+          loop do
+            ch = @io.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
+          resp = dispatch(STATUS_REQ)
+          again = false
+          while @io && IO.select([@io.io], nil, nil, 0)
+            logger&.warn("Serial device readable after completely reading status response - concurrent access?")
+            read_response
+            again = true
+          end
+          break unless again
+        end
+        payload = resp[1...-1]
+        @model_code = payload[0..4]
+        @version = payload[5]
+        length = payload[6..7].to_i(16)
+        data = payload[8...-2]
+        if data.length != length
+          raise BadStatus, "Broken status response: expected #{length} bytes, got #{data.length} bytes; concurrent operation on device?"
+        end
+        unless data.start_with?('@E01900')
+          raise BadStatus, "Broken status response: expected to start with @E01900, actual #{data[0..6]}"
+        end
+        @status_string = data
+        @status = {
+          # RX-V1500: model R0177
+          model_code: @model_code,
+          firmware_version: @version,
+          system_status: data[7].ord - ZERO_ORD,
+          power: power = data[8].ord - ZERO_ORD,
+          main_power: [1, 4, 5, 2].include?(power),
+          zone2_power: [1, 4, 3, 6].include?(power),
+          zone3_power: [1, 5, 3, 7].include?(power),
+        }
+        if data.length > 9
+          @status.update(
+            input: input = data[9],
+            input_name: MAIN_INPUTS_GET.fetch(input),
+            multi_ch_input: data[10] == '1',
+            audio_select: audio_select = data[11],
+            audio_select_name: AUDIO_SELECT_GET.fetch(audio_select),
+            mute: data[12] == '1',
+            # Volume values (0.5 dB increment):
+            # mute: 0
+            # -80.0 dB (min): 39
+            # 0 dB: 199
+            # +14.5 dB (max): 228
+            # Zone2 volume values (1 dB increment):
+            # mute: 0
+            # -33 dB (min): 39
+            # 0 dB (max): 72
+            main_volume: volume = data[15..16].to_i(16),
+            main_volume_db: int_to_half_db(volume),
+            zone2_volume: zone2_volume = data[17..18].to_i(16),
+            zone2_volume_db: int_to_full_db(zone2_volume),
+            zone3_volume: zone3_volume = data[129..130].to_i(16),
+            zone3_volume_db: int_to_full_db(zone3_volume),
+            program: program = data[19..20],
+            program_name: PROGRAM_GET.fetch(program),
+            # true: straight; false: effect
+            effect: data[21] == '1',
+            #extended_surround: data[22],
+            #short_message: data[23],
+            sleep: SLEEP_GET.fetch(data[24]),
+            night: night = data[27],
+            night_name: NIGHT_GET.fetch(night),
+            pure_direct: data[28] == '1',
+            speaker_a: data[29] == '1',
+            speaker_b: data[30] == '1',
+            format: data[31..32],
+            sample_rate: data[33..34],
+          )
+        end
+        @status
+      end
+
+      def remote_command(cmd)
+        dispatch("#{STX}0#{cmd}#{ETX}")
+      end
+
+      def system_command(cmd)
+        dispatch("#{STX}2#{cmd}#{ETX}")
+      end
+
+      def extract_text(resp)
+        # TODO: assert resp[0] == DC1, resp[-1] == ETX
+        resp[0...-1]
+      end
+
+      def int_to_half_db(value)
+        if value == 0
+          :mute
+        else
+          (value - 39) / 2.0 - 80
+        end
+      end
+
+      def int_to_full_db(value)
+        if value == 0
+          :mute
+        else
+          (value - 39) - 33
+        end
+      end
+    end
+  end
+end

data/lib/seriamp/yamaha/cmd.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require 'optparse'
+require 'logger'
+require 'pp'
+require 'seriamp/utils'
+require 'seriamp/detect'
+require 'seriamp/yamaha/client'
+
+module Seriamp
+  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(device: options[:device], logger: @logger)
+
+        @args = args
+      end
+
+      attr_reader :args
+      attr_reader :logger
+
+      def run
+        if args.any?
+          run_command(args)
+        else
+          STDIN.each_line do |line|
+            line.strip!
+            line.sub!(/#.*/, '')
+            next if line.empty?
+
+            run_command(line.strip.split(%r,\s+,))
+          end
+        end
+      end
+
+      def run_command(args)
+        cmd = args.shift
+        unless cmd
+          raise ArgumentError, "No command given"
+        end
+
+        case cmd
+        when 'detect'
+          device = Seriamp.detect_device(Yamaha, *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 = Utils.parse_on_off(ARGV.shift)
+          else
+            method = 'set_power'
+            state = Utils.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 = Utils.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
+end

data/lib/seriamp/yamaha/protocol/constants.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+module Seriamp
+  module Yamaha
+    module Protocol
+      module Constants
+
+        private
+
+        PROGRAM_SET = {
+          'munich' => 'E1',
+          'vienna' => 'E5',
+          'amsterdam' => 'E6',
+          'freiburg' => 'E8',
+          'chamber' => 'AF',
+          'village_vanguard' => 'EB',
+          'warehouse_loft' => 'EE',
+          'cellar_club' => 'CD',
+          'the_bottom_line' => 'EC',
+          'the_roxy_theatre' => 'ED',
+          'disco' => 'F0',
+          'game' => 'F2',
+          '7ch_stereo' => 'FF',
+          '2ch_stereo' => 'C0',
+          'sports' => 'F8',
+          'action_game' => 'F2',
+          'roleplaying_game' => 'CE',
+          'music_video' => 'F3',
+          'recital_opera' => 'F5',
+          'standard' => 'FE',
+          'spectacle' => 'F9',
+          'sci-fi' => 'FA',
+          'adventure' => 'FB',
+          'drama' => 'FC',
+          'mono_movie' => 'F7',
+          'surround_decode' => 'FD',
+          'thx_cinema' => 'C2',
+          'thx_music' => 'C3',
+          'thx_game' => 'C8',
+        }.freeze
+
+        MAIN_INPUTS_SET = {
+          'phono' => '14',
+          'cd' => '15',
+          'tuner' => '16',
+          'cd_r' => '19',
+          'md_tape' => '18',
+          'dvd' => 'C1',
+          'dtv' => '54',
+          'cbl_sat' => 'C0',
+          'vcr1' => '0F',
+          'dvr_vcr2' => '13',
+          'v_aux_dock' => '55',
+          'multi_ch' => '87',
+          'xm' => 'B4',
+        }.freeze
+
+        ZONE2_INPUTS_SET = {
+          'phono' => 'D0',
+          'cd' => 'D1',
+          'tuner' => 'D2',
+          'cd_r' => 'D4',
+          'md_tape' => 'D3',
+          'dvd' => 'CD',
+          'dtv' => 'D9',
+          'cbl_sat' => 'CC',
+          'vcr1' => 'D6',
+          'dvr_vcr2' => 'D7',
+          'v_aux_dock' => 'D8',
+          'xm' => 'B8',
+        }.freeze
+
+        ZONE3_INPUTS_SET = {
+          'phono' => 'F1',
+          'cd' => 'F2',
+          'tuner' => 'F3',
+          'cd_r' => 'F5',
+          'md_tape' => 'F4',
+          'dvd' => 'FC',
+          'dtv' => 'F6',
+          'cbl_sat' => 'F7',
+          'vcr1' => 'F9',
+          'dvr_vcr2' => 'FA',
+          'v_aux_dock' => 'F0',
+          'xm' => 'B9',
+        }.freeze
+
+        MAIN_INPUTS_GET = {
+          '0' => 'PHONO',
+          '1' => 'CD',
+          '2' => 'TUNER',
+          '3' => 'CD-R',
+          '4' => 'MD/TAPE',
+          '5' => 'DVD',
+          '6' => 'DTV',
+          '7' => 'CBL/SAT',
+          '8' => 'SAT',
+          '9' => 'VCR1',
+          'A' => 'DVR/VCR2',
+          'B' => 'VCR3/DVR',
+          'C' => 'V-AUX/DOCK',
+          'D' => 'NET/USB',
+          'E' => 'XM',
+        }.freeze
+
+        AUDIO_SELECT_GET = {
+          '0' => 'Auto', # Confirmed RX-V1500
+          '2' => 'DTS', # Confirmed RX-V1500
+          '3' => 'Coax / Opt', # Unconfirmed
+          '4' => 'Analog', # Confirmed RX-V1500
+          '5' => 'Analog Only', # Unconfirmed
+          '8' => 'HDMI', # Unconfirmed
+        }.freeze
+
+        NIGHT_GET = {
+          '0' => 'Off',
+          '1' => 'Cinema',
+          '2' => 'Music',
+        }.freeze
+
+        SLEEP_GET = {
+          '0' => 120,
+          '1' => 90,
+          '2' => 60,
+          '3' => 30,
+          '4' => nil,
+        }.freeze
+
+        PROGRAM_GET = {
+          '00' => 'Munich',
+          '01' => 'Hall B',
+          '02' => 'Hall C',
+          '04' => 'Hall D',
+          '05' => 'Vienna',
+          '06' => 'Live Concert',
+          '07' => 'Hall in Amsterdam',
+          '08' => 'Tokyo',
+          '09' => 'Freiburg',
+          '0A' => 'Royaumont',
+          '0B' => 'Chamber',
+          '0C' => 'Village Gate',
+          '0D' => 'Village Vanguard',
+          '0E' => 'The Bottom Line',
+          '0F' => 'Cellar Club',
+          '10' => 'The Roxy Theater',
+          '11' => 'Warehouse Loft',
+          '12' => 'Arena',
+          '14' => 'Disco',
+          '15' => 'Party',
+          '17' => '7ch Stereo',
+          '18' => 'Music Video',
+          '19' => 'DJ',
+          '1C' => 'Recital/Opera',
+          '1D' => 'Pavilion',
+          '1E' => 'Action Gamae',
+          '1F' => 'Role Playing Game',
+          '20' => 'Mono Movie',
+          '21' => 'Sports',
+          '24' => 'Spectacle',
+          '25' => 'Sci-Fi',
+          '28' => 'Adventure',
+          '29' => 'Drama',
+          '2C' => 'Surround Decode',
+          '2D' => 'Standard',
+          '30' => 'PLII Movie',
+          '31' => 'PLII Music',
+          '32' => 'Neo:6 Movie',
+          '33' => 'Neo:6 Music',
+          '34' => '2ch Stereo',
+          '35' => 'Direct Stereo',
+          '36' => 'THX Cinema',
+          '37' => 'THX Music',
+          '3C' => 'THX Game',
+          '40' => 'Enhancer 2ch Low',
+          '41' => 'Enhancer 2ch High',
+          '42' => 'Enhancer 7ch Low',
+          '43' => 'Enhancer 7ch High',
+          '80' => 'Straight',
+        }.freeze
+      end
+    end
+  end
+end