seriamp 0.1.10 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50636555b1276e60e52ddf26c28f42fd1e7b1d27a89fac22f37fefce236c8f88
-  data.tar.gz: aac82da48b0ac8887a507671af5d3d4e16fd9857bb70a635c145be12939fda70
+  metadata.gz: 3a8c5974a39756c641ab5fb6e600d0d67095e4e9f18c872225ffb580cea4e70c
+  data.tar.gz: ba47852332bdb66070cf4105c4929ed691fce8eca8dd7f47aaefbeb4effab932
 SHA512:
-  metadata.gz: 0c86e471aa614ce5048b168874f6c7ecacf956cf078fb0f327df230a588138e7c65f3fdc272ceaaa0f95775bdf2e9d104bbf47c7fcfa470565a83bb03d12e607
-  data.tar.gz: dd5f494621dcd63117ce276ac97d4240dc38ec84b7dcb0775851e8b7602e45d8e2789118cbbe10b7efbc74d2a4a7429e5d2be4ee6d469fcbed9185b41da2d6a9
+  metadata.gz: 185e56b171c6db9ed0822f57de19ac2fea395d075bc615cddf0795c82c2f044b5212e9eb210b90b3dbc4aa603ce6b1553a610924c9ce8b9f02ae860c1f0c873c
+  data.tar.gz: 277dc1f126ca440e3a8539491e1548511f1abfb66e6a21c615ab4ab8bfce67c76c2499b6c6a2ec9efe20050cd1ac732f70cd3870cff98aec927ae57f6f46e1e4

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/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,17 +10,37 @@ module Seriamp
     RS232_TIMEOUT = 3
 
     class Client
-      def initialize(device: nil, glob: nil, logger: nil)
+      def initialize(device: nil, glob: nil, logger: nil, retries: true, thread_safe: false)
         @logger = logger
 
         @device = device
         @detect_device = device.nil?
         @glob = glob
+        @retries = case retries
+          when nil, false
+            0
+          when true
+            1
+          when Integer
+            retries
+          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
       attr_reader :glob
       attr_reader :logger
+      attr_reader :retries
+
+      def thread_safe?
+        @thread_safe
+      end
 
       def detect_device?
         @detect_device
@@ -134,7 +154,7 @@ module Seriamp
       end
 
       def get_voltage_trigger_input(zone = nil)
-        get_zone_state('VTI', zone)
+        get_zone_state('VTI', zone, include_all: true)
       end
 
       def get_firmware_version
@@ -148,7 +168,7 @@ module Seriamp
       def status
         # Reusing the opened device file makes :VTIG? fail even with a delay
         # in front.
-        #open_device do
+        with_device do
           {
             firmware_version: get_firmware_version,
             temperature: get_temperature,
@@ -165,13 +185,34 @@ module Seriamp
             voltage_trigger_input: get_voltage_trigger_input,
             channel_front_panel_level: get_channel_front_panel_level,
           }
-        #end
+        end
       end
 
       private
 
+      def with_device(&block)
+        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
+          yield
+        end
+      end
+
       def open_device
         if detect_device? && device.nil?
+          logger&.debug("Detecting device")
           @device = Seriamp.detect_device(Sonamp, *glob, logger: logger)
           if @device
             logger&.info("Using #{device} as TTY device")
@@ -180,31 +221,58 @@ module Seriamp
           end
         end
 
-        if @f
+        logger&.debug("Opening #{device}")
+        @io = Backend::SerialPortBackend::Device.new(device, logger: logger)
+
+        begin
+          yield @io
+        ensure
+          @io.close rescue nil
+          @io = nil
+        end
+      end
+
+      def with_retry
+        try = 1
+        begin
           yield
-        else
-          rv = nil
-          Backend::SerialPortBackend::Device.new(device) do |f|
-            @f = f
-            rv = yield
-            @f = nil
+        rescue Seriamp::Error => exc
+          if try <= retries
+            logger&.warn("Error during operation: #{exc.class}: #{exc} - will retry")
+            try += 1
+            @device = nil
+            retry
+          else
+            raise
           end
-          rv
         end
       end
 
-      def dispatch(cmd, resp_lines_count = 1)
-        open_device do
-          with_timeout do
-            @f.syswrite("#{cmd}\x0d")
-          end
-          resp = 1.upto(resp_lines_count).map do
-            read_line(@f, cmd)
-          end
-          if resp_lines_count == 1
-            resp.first
-          else
-            resp
+      def dispatch(cmd, resp_lines_range_or_count = 1)
+        resp_lines_range = if Range === resp_lines_range_or_count || Array === resp_lines_range_or_count
+          resp_lines_range_or_count
+        else
+          1..resp_lines_range_or_count
+        end
+
+        with_retry do
+          with_device do
+            with_timeout do
+              @io.syswrite("#{cmd}\x0d")
+            end
+            resp = resp_lines_range.map do
+              read_line(@io, cmd)
+            end
+
+            if @io && IO.select([@io.io], nil, nil, 0)
+              logger&.warn("Serial device readable after completely reading status response - concurrent access?")
+            end
+
+            if resp_lines_range_or_count == 1
+              resp.first
+            else
+              resp
+            end
           end
         end
       end
@@ -266,7 +334,7 @@ module Seriamp
         dispatch_assert(cmd, expected)
       end
 
-      def get_zone_value(cmd_prefix, zone, boolize: false)
+      def get_zone_value(cmd_prefix, zone, boolize: false, include_all: false)
         if zone
           if zone < 1 || zone > 4
             raise ArgumentError, "Zone must be between 1 and 4: #{zone}"
@@ -274,22 +342,23 @@ module Seriamp
           resp = dispatch(":#{cmd_prefix}#{zone}?")
           typecast_value(resp[cmd_prefix.length + 1..], boolize)
         else
-          hashize_query_result(dispatch(":#{cmd_prefix}G?", 4), cmd_prefix, boolize)
+          range = include_all ? [1, 2, 3, 4, 'A'] : (1..4).to_a
+          hashize_query_result(dispatch(":#{cmd_prefix}G?", range), cmd_prefix, boolize, range)
         end
       end
 
-      def hashize_query_result(resp_lines, cmd_prefix, boolize)
+      def hashize_query_result(resp_lines, cmd_prefix, boolize, range)
         index = 1
         Hash[resp_lines.map do |resp|
-          value = typecast_value(extract_suffix(resp, "#{cmd_prefix}#{index}"), boolize)
+          value = typecast_value(extract_suffix(resp, "#{cmd_prefix}#{range.to_a[index-1]}"), 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)
+      def get_zone_state(cmd_prefix, zone, include_all: false)
+        get_zone_value(cmd_prefix, zone, boolize: true, include_all: include_all)
       end
 
       def set_channel_value(cmd_prefix, channel, value)
@@ -309,7 +378,7 @@ module Seriamp
           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)
+          hashize_query_result(dispatch(":#{cmd_prefix}G?", 8), cmd_prefix, boolize, 1..8)
         end
       end
 

data/lib/seriamp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Seriamp
-  VERSION = '0.1.10'
+  VERSION = '0.1.12'
 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
 
@@ -265,9 +297,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 +311,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 +323,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 +354,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
 

data/seriamp.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "seriamp"
-  spec.version       = '0.1.10'
+  spec.version       = '0.1.12'
   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.10
+  version: 0.1.12
 platform: ruby
 authors:
 - Oleg Pudeyev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-15 00:00:00.000000000 Z
+date: 2023-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: serialport