seriamp 0.1.14 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5687443fb1ef40b23fe59092d92d5421ff5dae7fd5196ddcd682df99d8dd64bd
-  data.tar.gz: 1c0654c533b4939cf5c265bfbab0f4e9ce21ea5a5b5506d1ef224d6f6ca2623d
+  metadata.gz: 9b1f037dbe23a5b8e4137f844d9c72a66e558ea68b17030b8f74def52cd52a2b
+  data.tar.gz: b0f1a36b133b59ac31f780da05104006ee17cdfa499db61cfec44aefe1a199f3
 SHA512:
-  metadata.gz: 7385b186ea20acc6f6ba001de8e0498c20fddc41f12219ca8e81a5490dcdd2c3751b340fe7e0ad2c990bc1c48447a724a6d5d1831746708aa57aadf78a4a3f30
-  data.tar.gz: b0411b2b26c3b8caa035d6286559e2daa98ec86d8d9d328e2ea324971458f1f6754fedf809d6db6f9d50336c9bba1953b2ffa5b36c6fdddc3d0bce85f8bb3e87
+  metadata.gz: 0d53f1ad5da19fb3750168a1e7da77e9e1c0914047e1a63b78ef8c67fbca7530ec40aaa619c5b1d226fca2c1f100519787b83a74a9690053e8cb6c742ecd9abc
+  data.tar.gz: 0a2229dce99ef4f84d2239d9f147740ec24319caf1b71560d2f1caa9cf203eb525d4551bd02041c4b1105d621ee109ffd78763856f36824d7596d3319699d94e

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'faraday', '~> 2.7'
+gem 'sinatra', '~> 3.0'
+gem 'rack-test'
+gem 'byebug'

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    seriamp (0.1.14)
+      serialport (~> 1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.3)
+    diff-lcs (1.5.0)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    mustermann (3.0.0)
+      ruby2_keywords (~> 0.0.1)
+    rack (2.2.4)
+    rack-protection (3.0.5)
+      rack
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    ruby2_keywords (0.0.5)
+    serialport (1.3.2)
+    sinatra (3.0.5)
+      mustermann (~> 3.0)
+      rack (~> 2.2, >= 2.2.4)
+      rack-protection (= 3.0.5)
+      tilt (~> 2.0)
+    tilt (2.0.11)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  byebug
+  faraday (~> 2.7)
+  rack-test
+  rspec-core (~> 3.12)
+  rspec-expectations (~> 3.12)
+  rspec-mocks (~> 3.12)
+  seriamp!
+  sinatra (~> 3.0)
+
+BUNDLED WITH
+   2.3.15

data/README.md

@@ -1,4 +1,4 @@
-# Yamaha Receiver Serial Control Ruby Library
+# Receiver & Amplifier Serial Control Ruby Library
 
 ## Hardware Requirements
 
@@ -70,9 +70,21 @@ Models lower than 1000 level receivers have never had RS-232C to my knowledge.
 - Straight cable required
 - Receiver socket is female
 
-### Integra DTR
+### Integra
 
-- Straight cable required
+Tested with DTR-50.4.
+
+- Straight cable required (if using a USB to serial adapter which already
+contains a serial cable with male end, no additional cable may be needed).
+- Receiver socket is female.
+- Receiver socket has the nuts for fixing the cable connector.
+[This FTDI adapter](https://www.amazon.com/gp/product/B0759HSLP1)
+has screws on the serial end and attaches directly to the receiver.
+[This PL2303 adapter]((https://www.amazon.com/gp/product/B00IDSM6BW)
+has nuts on the serial end and does not attach to the receiver, requiring
+either a straight through female to male serial cable or removing the nuts
+from one of the ends (the USB to serial adapter is the cheaper device,
+I modify the adapters rather than the receivers/amplifiers).
 
 ## Protocol Notes
 
@@ -131,7 +143,7 @@ to open a TTY in Python, buffering must be disabled.
 See [here](https://www.avsforum.com/threads/enhancing-yamaha-avrs-via-rs-232.1066484/)
 for more Yamaha-related software.
 
-## Other Libraries
+## Other Libraries & Tools
 
 Yamaha RS232/serial protocol:
 
@@ -148,6 +160,20 @@ Yamaha YNCA protocol:
 
 - [yamaha_ynca](https://github.com/mvdwetering/yamaha_ynca)
 
+Integra serial control:
+
+- [Many resources](https://www.avforums.com/threads/onkyo-tx-nr-1007-webinterface-programming.1107346/page-14)
+- [onkyoweb-php](https://github.com/guikubivan/onkyoweb-php)
+- [onkyo-eiscp](https://github.com/miracle2k/onkyo-eiscp)
+- [onpc](https://github.com/mkulesh/onpc)
+- [ISCP/eISCP](https://habr.com/en/post/427985/)
+- [Decrypting Onkyo firmware](http://divideoverflow.com/2014/04/decrypting-onkyo-firmware-files/)
+- [Post](https://robotskirts.com/2012/04/28/controlling-onkyo-integra-receivers-via-rs-232/)
+
+Pioneer serial control:
+
+- [Manuals](https://www.pioneerelectronics.com/PUSA/Support/Home-Entertainment-Custom-Install/RS-232+&+IP+Codes/A+V+Receivers)
+
 ## 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/integra

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+begin
+  require 'seriamp/integra/cmd'
+rescue LoadError
+  $: << File.join(File.dirname(__FILE__), '../lib')
+  require 'seriamp/integra/cmd'
+end
+
+Seriamp::Integra::Cmd.new.run

data/bin/sonamp

@@ -7,4 +7,4 @@ rescue LoadError
   require 'seriamp/sonamp/cmd'
 end
 
-Seriamp::Sonamp::Cmd.new(ARGV).run
+Seriamp::Sonamp::Cmd.new.run

data/bin/sonamp-auto-power

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'seriamp/sonamp/auto_power'
+rescue LoadError
+  $: << File.join(File.dirname(__FILE__), '../lib')
+  require 'seriamp/sonamp/auto_power'
+end
+require 'optparse'
+require 'logger'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: sonamp-auto-power [-l log-path] [-D]"
+
+  opts.on("--daemonize", "-D", "Daemonize") do
+    options[:daemonize] = true
+  end
+
+  opts.on("--log=PATH", "-l", "Path to log file") do |path|
+    options[:log_path] = path
+  end
+
+  opts.on("--sonamp-url=URL", "-s", "Path to Sonamp webapp URL") do |v|
+    options[:sonamp_url] = v
+  end
+
+  opts.on("--state=PATH", "-f", "Path to state file") do |path|
+    options[:state_path] = path
+  end
+
+  opts.on("--ttl=TTL", "-t", "Delay in seconds for turning amplifier off after receiver is detected off") do |v|
+    options[:ttl] = Integer(v)
+  end
+
+  opts.on("--yamaha-url=URL", "-y", "Path to Yamaha webapp URL") do |v|
+    options[:yamaha_url] = v
+  end
+
+end.parse!
+
+logger = Logger.new(STDERR)
+
+runner = Seriamp::Sonamp::AutoPower.new(
+  logger: logger,
+  sonamp_url: options[:sonamp_url],
+  state_path: options[:state_path],
+  ttl: options[:ttl],
+  yamaha_url: options[:yamaha_url],
+)
+
+if options[:daemonize]
+  Process.daemonize
+end
+
+runner.run

data/bin/yamaha

@@ -9,4 +9,4 @@ rescue LoadError
   require 'seriamp/yamaha/cmd'
 end
 
-Seriamp::Yamaha::Cmd.new(ARGV).run
+Seriamp::Yamaha::Cmd.new.run

data/lib/seriamp/all.rb

@@ -0,0 +1,4 @@
+require 'seriamp/yamaha/app'
+require 'seriamp/yamaha/cmd'
+require 'seriamp/sonamp/app'
+require 'seriamp/sonamp/cmd'

data/lib/seriamp/backend/serial_port.rb

@@ -27,7 +27,7 @@ module Seriamp
 
         attr_reader :io
 
-        def_delegators :io, :close, :sysread, :syswrite
+        def_delegators :io, :close, :sysread, :syswrite, :read_nonblock
       end
     end
   end

data/lib/seriamp/backend.rb

@@ -0,0 +1,6 @@
+module Seriamp
+  module Backend
+    autoload :FFIBackend, 'seriamp/backend/ffi'
+    autoload :SerialPortBackend, 'seriamp/backend/serial_port'
+  end
+end

data/lib/seriamp/faraday_facade.rb

@@ -0,0 +1,89 @@
+require 'faraday'
+autoload :JSON, 'json'
+
+module Seriamp
+  class FaradayFacade
+    class HttpError < StandardError
+    end
+
+    def initialize(**opts)
+      @options = {}
+      if timeout = opts.delete(:timeout)
+        @options[:timeout] = timeout
+      end
+
+      @conn = Faraday.new(**opts) do |faraday|
+        #faraday.response :logger, nil, { headers: true, bodies: false }
+        #faraday.response :logger
+      end
+
+      @base_url = opts.fetch(:url)
+    end
+
+    attr_reader :options
+    attr_reader :base_url
+
+    def get(uri)
+      conn.get(uri) do |req|
+        configure_request(req)
+      end
+    end
+
+    def get!(url)
+      resp = get(url)
+      if resp.status != 200
+        raise HttpError, "Bad status: #{resp.status} for #{base_url} #{url} with #{options}"
+      end
+      resp.body
+    end
+
+    def get_json(url)
+      resp = get!(url)
+      JSON.parse(resp)
+    end
+
+    def put(uri, body: nil)
+      conn.put(uri) do |req|
+        configure_request(req)
+        if body
+          req.body = body
+        end
+      end
+    end
+
+    def put!(url, **opts)
+      put(url, **opts).tap do |resp|
+        unless resp.success?
+          raise HttpError, "Bad status: #{resp.status} for #{url}"
+        end
+      end
+    end
+
+    def post(uri, body: nil)
+      conn.post(uri) do |req|
+        configure_request(req)
+        if body
+          req.body = body
+        end
+      end
+    end
+
+    def post!(url, **opts)
+      post(url, **opts).tap do |resp|
+        unless resp.success?
+          raise HttpError, "Bad status: #{resp.status} for #{url}"
+        end
+      end
+    end
+
+    private
+
+    attr_reader :conn
+
+    def configure_request(req)
+      req.options.timeout = options[:timeout]
+      req.options.read_timeout = options[:timeout]
+      req.options.open_timeout = options[:timeout]
+    end
+  end
+end

data/lib/seriamp/integra/client.rb

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+
+require 'timeout'
+require 'seriamp/utils'
+require 'seriamp/backend'
+require 'seriamp/integra/protocol/methods'
+
+module Seriamp
+  module Integra
+
+    RS232_TIMEOUT = 0.25
+
+    class Client
+      include Protocol::Methods
+
+      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
+
+        if block_given?
+          begin
+            yield self
+          ensure
+            close
+          end
+        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
+      end
+
+      def get_power
+        boolean_question('PWR')
+      end
+
+      def status
+        {
+          power: get_power,
+        }
+      end
+
+      def with_device(&block)
+        if @io
+          yield @io
+        else
+          open_device(&block)
+        end
+      end
+
+      def with_lock
+        if thread_safe?
+          @lock.synchronize do
+            yield
+          end
+        else
+          yield
+        end
+      end
+
+      private
+
+      include Protocol::Constants
+
+      EOT = ?\x1a
+
+      def open_device
+        if detect_device? && device.nil?
+          logger&.debug("Detecting device")
+          @device = Seriamp.detect_device(Integra, *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
+
+        logger&.debug("Opening #{device}")
+        @io = Backend::SerialPortBackend::Device.new(device, logger: logger)
+
+        Utils.consume_data(@io.io, logger,
+          "Serial device readable after opening - unread previous response?")
+
+        begin
+          yield @io
+        ensure
+          @io.close rescue nil
+          @io = nil
+        end
+      end
+
+      def dispatch(cmd)
+        start = Utils.monotime
+        with_device do
+          @io.syswrite(cmd.encode('ascii'))
+          resp = read_response
+          unless resp =~ /\A!1.+\x1a\z/
+            raise "Malformed response: #{resp}"
+          end
+          resp[2...-1]
+        end.tap do
+          elapsed = Utils.monotime - start
+          logger&.debug("Integra: dispatched #{cmd} in #{'%.2f' % elapsed} s")
+        end
+      end
+
+      def read_response
+        resp = +''
+        deadline = Utils.monotime + 1
+        loop do
+          begin
+            chunk = @io.read_nonblock(1000)
+            if chunk
+              resp += chunk
+              break if chunk[-1] == EOT
+            end
+          rescue IO::WaitReadable
+            budget = deadline - Utils.monotime
+            if budget < 0
+              raise CommunicationTimeout
+            end
+            IO.select([@io.io], nil, nil, budget)
+          end
+        end
+        resp
+      end
+
+      def with_retry
+        try = 1
+        begin
+          yield
+        rescue Seriamp::Error, IOError, SystemCallError => exc
+          if try <= retries
+            logger&.warn("Error during operation: #{exc.class}: #{exc} - will retry")
+            try += 1
+            if detect_device?
+              @device = nil
+            end
+            retry
+          else
+            raise
+          end
+        end
+      end
+
+      def question(cmd)
+        dispatch("!1#{cmd}QSTN\r")
+      end
+
+      def boolean_question(cmd)
+        resp = question(cmd)
+        if resp.start_with?(cmd)
+          case Integer(resp[cmd.length...])
+          when 1
+            true
+          when 0
+            false
+          else
+            raise "Bad response #{resp}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/seriamp/integra/cmd.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'optparse'
+require 'logger'
+require 'pp'
+require 'seriamp/utils'
+require 'seriamp/detect'
+require 'seriamp/integra/client'
+require 'seriamp/integra/executor'
+
+module Seriamp
+  module Integra
+    class Cmd
+      def initialize(args = ARGV, stdin = STDIN)
+        options = {}
+        OptionParser.new do |opts|
+          opts.banner = "Usage: integra [-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 = Integra::Client.new(device: options[:device], logger: @logger)
+
+        @args = args
+        @stdin = stdin
+      end
+
+      attr_reader :args
+      attr_reader :stdin
+      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(Integra, *args, logger: logger)
+          if device
+            puts device
+            exit 0
+          else
+            STDERR.puts("Integra receiver not found")
+            exit 3
+          end
+        else
+          executor.run_command(cmd, *args)
+        end
+      end
+
+      private
+
+      attr_reader :client
+
+      def executor
+        @executor ||= Executor.new(client)
+      end
+    end
+  end
+end

data/lib/seriamp/integra/executor.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Seriamp
+  module Integra
+    class Executor
+      def initialize(client)
+        @client = client
+      end
+
+      attr_reader :client
+
+      def run_command(cmd, *args)
+        cmd = cmd.gsub('_', '-')
+        case cmd
+        when 'detect'
+          device = Seriamp.detect_device(Integra, *args, logger: logger)
+          if device
+            puts device
+            exit 0
+          else
+            STDERR.puts("Integra receiver not found")
+            exit 3
+          end
+        when 'status'
+          pp client.status
+        else
+          raise ArgumentError, "Unknown command: #{cmd}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Seriamp
+  module Integra
+    module Protocol
+      module Constants
+
+        private
+
+      end
+    end
+  end
+end

data/lib/seriamp/integra/protocol/methods.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'seriamp/integra/protocol/constants'
+
+module Seriamp
+  module Integra
+    module Protocol
+      module Methods
+        include Constants
+      end
+    end
+  end
+end

data/lib/seriamp/integra.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'seriamp/integra/client'