seriamp 0.1.11 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9a46cb5fe16a4b24f54a6552e98db18e6e97281f7d12ce76c78f1ca5d18d8b8
-  data.tar.gz: '082c51ad737e37e237248acca21d9ee6d0b74bca0be135cf99f52fbf26679c31'
+  metadata.gz: 608c49104ee16a8740439f09911464a51539d1a52907752bc7f0bf31fa0da85c
+  data.tar.gz: dc11ec89924b2c7b06a7a1a44be13e64c832de805c0c039f4a7bf3d66964a876
 SHA512:
-  metadata.gz: 2b450a12d445a5b9199212eee5dba2eac298a9aa19e0e826df2fd322cd1d86d78a05815d39b3f75e417afa357720edb5ead5d1c9bfff1efefc171cb0b7e73f6e
-  data.tar.gz: 9461488acf8478e6f7d52ea4f824042eede1a13a99f357092f37f55afddee6608e70a0306f23844a12a594e4658c5f87a40b1b2e090539a910f6ef963acd52ae
+  metadata.gz: 98879e190d39e69030155b492c72d3543e1db219f5315721705909b3cc177c1c150b6b5c3d5b0d3cb58ffccc59ea8d0610a064d95d5159ed11a91c7289a2ba27
+  data.tar.gz: 8f766224a06c19e14a71d5aa290d4c035031fd89a6abe1be1bd962a6fa36306d720e2032ac1ab804425cb40dcdbb6b84c050a15ebc77d8bec3b51673b8428cb5

data/README.md

@@ -32,6 +32,39 @@ necessary.
 - Null-modem cable required
 - Receiver socket is male
 
+The following table shows which Yamaha receivers have RS-232 connector
+and which do not:
+
+| Family   | RS-232C Present              | RS-232C Absent |
+| -------- | ---------------------------- | -------------- |
+| RX-Vx000 | RX-V3000, RX-V1000           |                |
+|          |                              | HTR-5280       |
+| RX-Vx200 | RX-V2200                     | RX-V1200       |
+|          |                              | HTR-5490       |
+| RX-Vx300 | RX-V2300                     | RX-V1300       |
+|          |                              | HTR-5590       |
+|          |                              | HTR-5660       |
+| RX-Vx400 | RX-V2400                     | RX-V1400       |
+|          |                              | HTR-5790       |
+| RX-Vx500 | RX-V2500, RX-V1500           |                |
+|          | HTR-5890                     | HTR-5860       |
+| RX-Vx600 | RX-V2600, RX-V1600           |                |
+|          | HTR-5990                     | HTR-5960       |
+| RX-Vx700 | RX-V2700, RX-V1700           |                |
+|          |                              | HTR-6090       |
+| RX-Vx800 | RX-V3800, RX-V1800           |                |
+|          | HTR-6190                     | HTR-6180       |
+| RX-Vx900 | RX-V3900, RX-V1900           |                |
+|          |                              | HTR-6290       |
+| RX-Vx67  | RX-V3067, RX-V2067, RX-V1067 | RX-V867        |
+
+RX-V2700, RX-V3800 and RX-V3900 have an Ethernet port in addition to
+RS-232C and should be controllable via the Yamaha YNCA protocol via the
+Ethernet port. Over time Yamaha has been adding networking functionality
+to lower tier models, for example it is present in RX-V867, RX-V671 and RX-V475.
+
+Models lower than 1000 level receivers have never had RS-232C to my knowledge.
+
 ### Denon AVR-2308CI
 
 - Straight cable required
@@ -111,6 +144,10 @@ Serial port communication in Ruby:
 - [rubyserial](https://github.com/hybridgroup/rubyserial)
 - [Ruby/SerialPort](https://github.com/hparra/ruby-serialport)
 
+Yamaha YNCA protocol:
+
+- [yamaha_ynca](https://github.com/mvdwetering/yamaha_ynca)
+
 ## Helpful Links
 
 - [Serial port programming in Ruby](https://www.thegeekdiary.com/serial-port-programming-reading-writing-status-of-control-lines-dtr-rts-cts-dsr/)

data/bin/sonamp-web

@@ -23,9 +23,10 @@ end.parse!
 
 logger = Logger.new(STDERR)
 
-#Sonamp::App.set :device, options[:device]
-#Sonamp::App.set :logger, logger
-Seriamp::Sonamp::App.set :client, Seriamp::Sonamp::Client.new(device: options[:device], logger: logger)
+#Seriamp::Sonamp::App.set :device, options[:device]
+#Seriamp::Sonamp::App.set :logger, logger
+Seriamp::Sonamp::App.set :client, Seriamp::Sonamp::Client.new(
+  device: options[:device], logger: logger, thread_safe: true)
 
 options = Rack::Server::Options.new.parse!(ARGV)
 Rack::Server.start(options.merge(app: Seriamp::Sonamp::App))

data/bin/yamaha-web

@@ -23,9 +23,10 @@ end.parse!
 
 logger = Logger.new(STDERR)
 
-#Yamaha::App.set :device, options[:device]
-#Yamaha::App.set :logger, logger
-Seriamp::Yamaha::App.set :client, Seriamp::Yamaha::Client.new(device: options[:device], logger: logger)
+#Seriamp::Yamaha::App.set :device, options[:device]
+#Seriamp::Yamaha::App.set :logger, logger
+Seriamp::Yamaha::App.set :client, Seriamp::Yamaha::Client.new(
+  device: options[:device], logger: logger, thread_safe: true)
 
 options = Rack::Server::Options.new.parse!(ARGV)
 Rack::Server.start(options.merge(app: Seriamp::Yamaha::App))

data/lib/seriamp/detect.rb

@@ -21,7 +21,7 @@ module Seriamp
       Thread.new do
         Timeout.timeout(timeout * 2, CommunicationTimeout) do
           logger&.debug("Trying #{device}")
-          client_cls.new(device: device, logger: logger).present?
+          client_cls.new(device: device, logger: logger, retries: false).present?
           logger&.debug("Found #{mod} device at #{device}")
           queue << device
         end

data/lib/seriamp/sonamp/app.rb

@@ -12,6 +12,7 @@ module Seriamp
       set :device, nil
       set :logger, nil
       set :client, nil
+      set :retries, true
 
       get '/' do
         render_json(client.status)
@@ -75,7 +76,8 @@ module Seriamp
 
       def client
         settings.client || begin
-          @client ||= Sonamp::Client.new(settings.device, logger: settings.logger)
+          @client ||= Sonamp::Client.new(settings.device,
+            logger: settings.logger, retries: settings.retries, thread_safe: true)
         end
       end
 

data/lib/seriamp/sonamp/client.rb

@@ -10,7 +10,7 @@ module Seriamp
     RS232_TIMEOUT = 3
 
     class Client
-      def initialize(device: nil, glob: nil, logger: nil, retries: true)
+      def initialize(device: nil, glob: nil, logger: nil, retries: true, thread_safe: false)
         @logger = logger
 
         @device = device
@@ -26,6 +26,11 @@ module Seriamp
           else
             raise ArgumentError, "retries must be an integer, true, false or nil: #{retries}"
           end
+        @thread_safe = !!thread_safe
+
+        if thread_safe?
+          @lock = Mutex.new
+        end
       end
 
       attr_reader :device
@@ -33,6 +38,10 @@ module Seriamp
       attr_reader :logger
       attr_reader :retries
 
+      def thread_safe?
+        @thread_safe
+      end
+
       def detect_device?
         @detect_device
       end
@@ -182,10 +191,22 @@ module Seriamp
       private
 
       def with_device(&block)
-        if @io
-          yield @io
+        with_lock do
+          if @io
+            yield @io
+          else
+            open_device(&block)
+          end
+        end
+      end
+
+      def with_lock
+        if thread_safe?
+          @lock.synchronize do
+            yield
+          end
         else
-          open_device(&block)
+          yield
         end
       end
 
@@ -203,6 +224,15 @@ module Seriamp
         logger&.debug("Opening #{device}")
         @io = Backend::SerialPortBackend::Device.new(device, logger: logger)
 
+        warned = false
+        while IO.select([@io.io], nil, nil, 0)
+          unless warned
+            logger&.warn("Serial device readable after opening - unread previous response?")
+            warned = true
+          end
+          IO.read(1)
+        end
+
         begin
           yield @io
         ensure
@@ -219,7 +249,9 @@ module Seriamp
           if try <= retries
             logger&.warn("Error during operation: #{exc.class}: #{exc} - will retry")
             try += 1
-            @device = nil
+            if detect_device?
+              @device = nil
+            end
             retry
           else
             raise

data/lib/seriamp/version.rb

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

data/lib/seriamp/yamaha/app.rb

@@ -13,6 +13,7 @@ module Seriamp
       set :device, nil
       set :logger, nil
       set :client, nil
+      set :retries, true
 
       get '/' do
         clear_cache
@@ -153,7 +154,8 @@ module Seriamp
 
       def client
         settings.client || begin
-          @client ||= Yamaha::Client.new(settings.device, logger: settings.logger)
+          @client ||= Yamaha::Client.new(settings.device,
+            logger: settings.logger, retries: settings.retries, thread_safe: true)
         end
       end
 

data/lib/seriamp/yamaha/client.rb

@@ -14,7 +14,7 @@ module Seriamp
     class Client
       include Protocol::Methods
 
-      def initialize(device: nil, glob: nil, logger: nil, retries: true)
+      def initialize(device: nil, glob: nil, logger: nil, retries: true, thread_safe: false)
         @logger = logger
 
         @device = device
@@ -30,6 +30,11 @@ module Seriamp
           else
             raise ArgumentError, "retries must be an integer, true, false or nil: #{retries}"
           end
+        @thread_safe = !!thread_safe
+
+        if thread_safe?
+          @lock = Mutex.new
+        end
 
         if block_given?
           begin
@@ -45,6 +50,10 @@ module Seriamp
       attr_reader :logger
       attr_reader :retries
 
+      def thread_safe?
+        @thread_safe
+      end
+
       def detect_device?
         @detect_device
       end
@@ -56,18 +65,29 @@ module Seriamp
 
       def last_status
         unless @status
-          with_device do
-            unless @status
-              do_status
+          with_lock do
+            with_retry do
+              with_device do
+                unless @status
+                  do_status
+                end
+              end
             end
           end
         end
+        if @status.nil?
+          raise "This should not happen"
+        end
         @status.dup
       end
 
       def last_status_string
         unless @status_string
-          with_device do
+          with_lock do
+            with_retry do
+              with_device do
+              end
+            end
           end
         end
         @status_string.dup
@@ -121,6 +141,16 @@ module Seriamp
         end
       end
 
+      def with_lock
+        if thread_safe?
+          @lock.synchronize do
+            yield
+          end
+        else
+          yield
+        end
+      end
+
       # Shows a message via the on-screen display. The message must be 16
       # characters or fewer. The message is NOT displayed on the front panel,
       # it is shown only on the connected TV's OSD.
@@ -134,13 +164,15 @@ module Seriamp
           raise ArgumentError, "Message must be no more than 16 characters, #{msg.length} given"
         end
 
-        with_retry do
-          with_device do
-            @io.syswrite("#{STX}21000#{ETX}".encode('ascii'))
-            @io.syswrite("#{STX}3#{msg[0..3]}#{ETX}".encode('ascii'))
-            @io.syswrite("#{STX}3#{msg[4..7]}#{ETX}".encode('ascii'))
-            @io.syswrite("#{STX}3#{msg[8..11]}#{ETX}".encode('ascii'))
-            @io.syswrite("#{STX}3#{msg[12..15]}#{ETX}".encode('ascii'))
+        with_lock do
+          with_retry do
+            with_device do
+              @io.syswrite("#{STX}21000#{ETX}".encode('ascii'))
+              @io.syswrite("#{STX}3#{msg[0..3]}#{ETX}".encode('ascii'))
+              @io.syswrite("#{STX}3#{msg[4..7]}#{ETX}".encode('ascii'))
+              @io.syswrite("#{STX}3#{msg[8..11]}#{ETX}".encode('ascii'))
+              @io.syswrite("#{STX}3#{msg[12..15]}#{ETX}".encode('ascii'))
+            end
           end
         end
 
@@ -165,6 +197,15 @@ module Seriamp
         logger&.debug("Opening #{device}")
         @io = Backend::SerialPortBackend::Device.new(device, logger: logger)
 
+        warned = false
+        while IO.select([@io.io], nil, nil, 0)
+          unless warned
+            logger&.warn("Serial device readable after opening - unread previous response?")
+            warned = true
+          end
+          IO.read(1)
+        end
+
         begin
           tries = 0
           begin
@@ -265,9 +306,12 @@ module Seriamp
             end
             break unless again
           end
+          if resp.length < 10
+            raise HandshakeFailure, "Broken status response: expected at least 10 bytes, got #{resp.length} bytes; concurrent operation on device?"
+          end
           payload = resp[1...-1]
-          @model_code = payload[0..4]
-          @version = payload[5]
+          model_code = payload[0..4]
+          version = payload[5]
           length = payload[6..7].to_i(16)
           data = payload[8...-2]
           if data.length != length
@@ -276,11 +320,11 @@ module Seriamp
           unless data.start_with?('@E01900')
             raise HandshakeFailure, "Broken status response: expected to start with @E01900, actual #{data[0..6]}"
           end
-          @status_string = data
-          @status = {
-            model_code: @model_code,
-            model_name: MODEL_NAMES[@model_code],
-            firmware_version: @version,
+          status_string = data
+          status = {
+            model_code: model_code,
+            model_name: MODEL_NAMES[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),
@@ -288,7 +332,7 @@ module Seriamp
             zone3_power: [1, 5, 3, 7].include?(power),
           }
           if data.length > 9
-            @status.update(
+            status.update(
               input: input = data[9],
               input_name: MAIN_INPUTS_GET.fetch(input),
               multi_ch_input: data[10] == '1',
@@ -319,34 +363,41 @@ module Seriamp
               sleep: SLEEP_GET.fetch(data[24]),
               night: night = data[27],
               night_name: NIGHT_GET.fetch(night),
-              pure_direct: data[PURE_DIRECT_FIELD.fetch(@model_code)] == '1',
+              pure_direct: data[PURE_DIRECT_FIELD.fetch(model_code)] == '1',
               speaker_a: data[29] == '1',
               speaker_b: data[30] == '1',
               # 2 positions on RX-Vx700
               #format: data[31..32],
               #sampling: data[33..34],
             )
-            if @model_code == 'R0178'
-              @status.update(
+            if model_code == 'R0178'
+              status.update(
                 input_mode: INPUT_MODE_R0178.fetch(data[11]),
                 sampling: data[32],
                 sample_rate: SAMPLE_RATE_R0178.fetch(data[32]),
               )
             end
           end
-          @status
+
+          @model_code, @version, @status_string =
+            model_code, version, status_string
+          @status = status
         end
       end
 
       def remote_command(cmd)
-        with_retry do
-          dispatch("#{STX}0#{cmd}#{ETX}")
+        with_lock do
+          with_retry do
+            dispatch("#{STX}0#{cmd}#{ETX}")
+          end
         end
       end
 
       def system_command(cmd)
-        with_retry do
-          dispatch("#{STX}2#{cmd}#{ETX}")
+        with_lock do
+          with_retry do
+            dispatch("#{STX}2#{cmd}#{ETX}")
+          end
         end
       end
 
@@ -379,7 +430,9 @@ module Seriamp
           if try <= retries
             logger&.warn("Error during operation: #{exc.class}: #{exc} - will retry")
             try += 1
-            @device = nil
+            if detect_device?
+              @device = nil
+            end
             retry
           else
             raise

data/seriamp.gemspec

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seriamp
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.13
 platform: ruby
 authors:
 - Oleg Pudeyev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-23 00:00:00.000000000 Z
+date: 2023-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: serialport