procon_bypass_man 0.1.4 → 0.1.8

data/lib/procon_bypass_man/device_connector.rb

@@ -0,0 +1,336 @@
+class ProconBypassMan::DeviceConnector
+  class BytesMismatchError < StandardError; end
+
+  class Value
+    attr_accessor :read_from, :values
+    def initialize(values: , read_from: )
+      @values = values
+      @read_from = read_from
+    end
+  end
+
+  PROCON_PATH = "/dev/hidraw0"
+  PROCON2_PATH = "/dev/hidraw1"
+
+  # 画面で再接続ができたが状況は変わらない
+  def self.reset_connection!
+    s = new
+    s.add([
+      ["0000"],
+      ["0000"],
+      ["8005"],
+      ["0000"],
+      ["8001"],
+    ], read_from: :switch)
+    s.drain_all
+    s.read_procon
+    s.write_switch("213c910080005db7723d48720a800300000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000")
+    sleep(10) # いらないかも
+    s
+  end
+
+  def self.connect
+    s = new(throw_error_if_timeout: true, enable_at_exit: false)
+    s.add([
+      ["0000"],
+      ["0000"],
+      ["8005"],
+      ["0010"],
+    ], read_from: :switch)
+    # 1. Sends current connection status, and if the Joy-Con are connected,
+    s.add([["8001"]], read_from: :switch)
+    s.add([/^8101/], read_from: :procon) # <<< 81010003176d96e7a5480000000, macaddressとコントローラー番号を返す
+    # 2. Sends handshaking packets over UART to the Joy-Con or Pro Controller Broadcom chip. This command can only be called once per session.
+    s.add([["8002"]], read_from: :switch)
+    s.add([/^8102/], read_from: :procon)
+    # 3
+    s.add([/^0100/], read_from: :switch)
+    s.add([/^21/], read_from: :procon)
+    # 4. Forces the Joy-Con or Pro Controller to only talk over USB HID without any timeouts. This is required for the Pro Controller to not time out and revert to Bluetooth.
+    s.add([["8004"]], read_from: :switch)
+    s.drain_all
+    return [s.switch, s.procon]
+  end
+
+  def initialize(throw_error_if_timeout: false, throw_error_if_mismatch: false , enable_at_exit: true)
+    @stack = []
+    @initialized_devices = false
+    @throw_error_if_timeout = throw_error_if_timeout
+    @throw_error_if_mismatch = throw_error_if_mismatch
+    @enable_at_exit = enable_at_exit
+  end
+
+  def add(values, read_from: )
+    @stack << Value.new(values: values, read_from: read_from)
+  end
+
+  def drain_all
+    unless @initialized_devices
+      init_devices
+    end
+
+    while(item = @stack.shift)
+      item.values.each do |value|
+        data = nil
+        timer = ProconBypassMan::Timer.new
+        begin
+          timer.throw_if_timeout!
+          data = from_device(item).read_nonblock(128)
+        rescue IO::EAGAINWaitReadable
+          retry
+        end
+
+        result =
+          case value
+          when String, Array
+            value == data.unpack("H*")
+          when Regexp
+            value =~ data.unpack("H*").first
+          else
+            raise "#{value}は知りません"
+          end
+        if result
+          ProconBypassMan.logger.info "OK(expected: #{value}, got: #{data.unpack("H*")})"
+        else
+          ProconBypassMan.logger.info "NG(expected: #{value}, got: #{data.unpack("H*")})"
+          raise BytesMismatchError if @throw_error_if_mismatch
+        end
+        to_device(item).write_nonblock(data)
+      end
+    end
+  rescue ProconBypassMan::Timer::Timeout
+    ProconBypassMan.logger.error "timeoutになりました"
+    raise if @throw_error_if_timeout
+  end
+
+  # switchに任意の命令を入力して、switchから読み取る
+  def write_switch(data, only_write: false)
+    if data.encoding.name == "UTF-8"
+      data = [data].pack("H*")
+    end
+    unless @initialized_devices
+      init_devices
+    end
+
+    timer = ProconBypassMan::Timer.new
+    data = nil
+    begin
+      timer.throw_if_timeout!
+      switch.write_nonblock(data)
+    rescue IO::EAGAINWaitReadable
+      retry
+    rescue ProconBypassMan::Timer::Timeout
+      ProconBypassMan.logger.error "writeでtimeoutになりました"
+      raise
+    end
+    return(data.unpack("H*")) if only_write
+
+    timer = ProconBypassMan::Timer.new
+    begin
+      timer.throw_if_timeout!
+      data = switch.read_nonblock(128)
+      ProconBypassMan.logger.debug { " >>> #{data.unpack("H*")})" }
+    rescue IO::EAGAINWaitReadable
+      retry
+    rescue ProconBypassMan::Timer::Timeout
+      ProconBypassMan.logger.error "readでtimeoutになりました"
+      raise
+    end
+  rescue ProconBypassMan::Timer::Timeout
+    raise if @throw_error_if_timeout
+  end
+
+  def write_procon(data, only_write: false)
+    if data.encoding.name == "UTF-8"
+      data = [data].pack("H*")
+    end
+    unless @initialized_devices
+      init_devices
+    end
+
+    timer = ProconBypassMan::Timer.new
+    begin
+      timer.throw_if_timeout!
+      procon.write_nonblock(data)
+    rescue IO::EAGAINWaitReadable
+      retry
+    rescue ProconBypassMan::Timer::Timeout
+      ProconBypassMan.logger.error "writeでtimeoutになりました"
+      raise
+    end
+    return(data.unpack("H*")) if only_write
+
+    timer = ProconBypassMan::Timer.new
+    begin
+      timer.throw_if_timeout!
+      data = procon.read_nonblock(128)
+      ProconBypassMan.logger.error " <<< #{data.unpack("H*")})"
+    rescue IO::EAGAINWaitReadable
+      retry
+    rescue ProconBypassMan::Timer::Timeout
+      ProconBypassMan.logger.error "readでtimeoutになりました"
+      raise
+    end
+  rescue ProconBypassMan::Timer::Timeout
+    raise if @throw_error_if_timeout
+  end
+
+  def read_procon(only_read: false)
+    unless @initialized_devices
+      init_devices
+    end
+
+    data = nil
+    timer = ProconBypassMan::Timer.new
+    begin
+      timer.throw_if_timeout!
+      data = procon.read_nonblock(128)
+      ProconBypassMan.logger.debug { " <<< #{data.unpack("H*")})" }
+    rescue IO::EAGAINWaitReadable
+      retry
+    rescue ProconBypassMan::Timer::Timeout
+      ProconBypassMan.logger.error "readでtimeoutになりました"
+      raise
+    end
+    return(data.unpack("H*")) if only_read
+
+    timer = ProconBypassMan::Timer.new
+    begin
+      timer.throw_if_timeout!
+      switch.write_nonblock(data)
+    rescue IO::EAGAINWaitReadable
+      retry
+    rescue ProconBypassMan::Timer::Timeout
+      ProconBypassMan.logger.error "writeでtimeoutになりました"
+      raise
+    end
+  rescue ProconBypassMan::Timer::Timeout
+    raise if @throw_error_if_timeout
+  end
+
+  def read_switch(only_read: false)
+    unless @initialized_devices
+      init_devices
+    end
+
+    data = nil
+    timer = ProconBypassMan::Timer.new
+    begin
+      timer.throw_if_timeout!
+      data = switch.read_nonblock(128)
+      ProconBypassMan.logger.debug { " >>> #{data.unpack("H*")})" }
+    rescue IO::EAGAINWaitReadable
+      retry
+    rescue ProconBypassMan::Timer::Timeout
+      ProconBypassMan.logger.error "readでtimeoutになりました"
+      raise
+    end
+    return(data.unpack("H*")) if only_read
+
+    timer = ProconBypassMan::Timer.new
+    begin
+      timer.throw_if_timeout!
+      procon.write_nonblock(data)
+    rescue IO::EAGAINWaitReadable
+      retry
+    rescue ProconBypassMan::Timer::Timeout
+      ProconBypassMan.logger.error "writeでtimeoutになりました"
+      raise
+    end
+  rescue ProconBypassMan::Timer::Timeout
+    raise if @throw_error_if_timeout
+  end
+
+  def from_device(item)
+    case item.read_from
+    when :switch
+      switch
+    when :procon
+      procon
+    else
+      raise
+    end
+  end
+
+  # fromの対になる
+  def to_device(item)
+    case item.read_from
+    when :switch
+      procon
+    when :procon
+      switch
+    else
+      raise
+    end
+  end
+
+  def switch
+    @gadget
+  end
+
+  def procon
+    @procon
+  end
+
+  def is_available_device?(path)
+    return false if !File.exist?(path)
+
+    system('echo > /sys/kernel/config/usb_gadget/procon/UDC')
+    system('ls /sys/class/udc > /sys/kernel/config/usb_gadget/procon/UDC')
+    sleep 0.5
+
+    file = File.open(path, "w+")
+    begin
+      file.read_nonblock(128)
+    rescue EOFError
+      file.close
+      return false
+    rescue IO::EAGAINWaitReadable
+      file.close
+      return true
+    end
+  end
+
+  def to_bin(string)
+    string.unpack "H*"
+  end
+
+  def init_devices
+    if @initialized_devices
+      return
+    end
+
+    case
+    when is_available_device?(PROCON_PATH)
+      ProconBypassMan.logger.info "proconのデバイスファイルは#{PROCON_PATH}を使います"
+      @procon = File.open(PROCON_PATH, "w+")
+      @gadget = File.open('/dev/hidg0', "w+")
+    when is_available_device?(PROCON2_PATH)
+      ProconBypassMan.logger.info "proconのデバイスファイルは#{PROCON2_PATH}を使います"
+      @procon = File.open(PROCON2_PATH, "w+")
+      @gadget = File.open('/dev/hidg0', "w+")
+    else
+      raise "/dev/hidraw0, /dev/hidraw1の両方見つかりませんでした"
+    end
+    system('echo > /sys/kernel/config/usb_gadget/procon/UDC')
+    system('ls /sys/class/udc > /sys/kernel/config/usb_gadget/procon/UDC')
+    sleep 0.5
+
+    @initialized_devices = true
+
+    if @enable_at_exit
+      at_exit do
+        @procon&.close
+        @gadget&.close
+      end
+    end
+  rescue Errno::ENXIO => e
+    # /dev/hidg0 をopenできないときがある
+    ProconBypassMan.logger.error "Errno::ENXIO (No such device or address @ rb_sysopen - /dev/hidg0)が起きました。resetします"
+    ProconBypassMan.logger.error e
+    system('echo > /sys/kernel/config/usb_gadget/procon/UDC')
+    system('ls /sys/class/udc > /sys/kernel/config/usb_gadget/procon/UDC')
+    sleep 2
+    retry
+  end
+end

data/lib/procon_bypass_man/procon/button_collection.rb

@@ -24,7 +24,7 @@ class ProconBypassMan::Procon::ButtonCollection
     3 => [:zr, :r, :sr, :sl, :a, :b, :x, :y],
     4 => [:grip, :_undefined_key, :cap, :home, :thumbl, :thumbr, :plus, :minus],
     5 => [:zl, :l, :sl, :sr, :left, :right, :up, :down],
-  }
+  }.freeze
 
   BUTTONS_MAP = BYTES_MAP.reduce({}) { |acc, value|
     next acc if value[1].nil?
@@ -32,7 +32,8 @@ class ProconBypassMan::Procon::ButtonCollection
       acc[button] = { byte_position: value[0], bit_position: index }
     end
     acc
-  }
+  }.freeze
+  BUTTONS = ProconBypassMan::Procon::ButtonCollection::BUTTONS_MAP.keys.freeze
 
   def self.load(button_key)
     Button.new(button_key)

data/lib/procon_bypass_man/procon/pressed_button_helper.rb

@@ -13,7 +13,7 @@ module ProconBypassMan::Procon::PushedButtonHelper
     @@compiled = false
     def compile_if_not_compile_yet!
       unless @@compiled
-        ::ProconBypassMan::Procon::ButtonCollection::BUTTONS_MAP.each do |button, value|
+        ::ProconBypassMan::Procon::ButtonCollection::BUTTONS_MAP.each do |button, _value|
           define_method "pressed_#{button}?" do
             pressed_button?(button)
           end

data/lib/procon_bypass_man/procon.rb

@@ -1,4 +1,5 @@
 class ProconBypassMan::Procon
+  require "procon_bypass_man/procon/data"
   require "procon_bypass_man/procon/mode_registry"
   require "procon_bypass_man/procon/macro_registry"
   require "procon_bypass_man/procon/layer_changeable"
@@ -9,7 +10,7 @@ class ProconBypassMan::Procon
 
   attr_accessor :user_operation
 
-  def self.reset_cvar!
+  def self.reset!
     @@status = {
       buttons: {},
       current_layer_key: :up,
@@ -17,7 +18,6 @@ class ProconBypassMan::Procon
       ongoing_mode: ModeRegistry.load(:manual),
     }
   end
-  def self.reset!; reset_cvar!; end
   reset!
 
   def initialize(binary)
@@ -106,18 +106,20 @@ class ProconBypassMan::Procon
         if !status[button]
           user_operation.unpress_button(button)
         end
-        if options[:force_neutral] && user_operation.pressed_button?(options[:force_neutral])
-          button = options[:force_neutral]
-          user_operation.unpress_button(button)
+
+        options[:force_neutral]&.each do |force_neutral_button|
+          user_operation.pressed_button?(force_neutral_button) && user_operation.unpress_button(force_neutral_button)
         end
       end
     end
 
-    current_layer.remaps.each do |from_button, to_button|
+    current_layer.remaps.each do |from_button, to_buttons|
       if user_operation.pressed_button?(from_button)
         user_operation.unpress_button(from_button)
         # TODO 2重でpressしないようにしたい
-        user_operation.press_button(to_button) unless user_operation.pressed_button?(to_button)
+        to_buttons[:to].each do |to_button|
+          user_operation.press_button(to_button) unless user_operation.pressed_button?(to_button)
+        end
       end
     end
 

data/lib/procon_bypass_man/runner.rb

@@ -1,12 +1,10 @@
 require_relative "io_monitor"
+require_relative "uptime"
 
 class ProconBypassMan::Runner
   class InterruptForRestart < StandardError; end
 
-  def initialize(gadget: , procon: )
-    @gadget = gadget
-    @procon = procon
-
+  def initialize
     $will_interval_0_0_0_5 = 0
     $will_interval_1_6 = 0
   end
@@ -31,7 +29,7 @@ class ProconBypassMan::Runner
       main_loop_pid = fork { main_loop }
 
       begin
-        while readable_io = IO.select([self_read])
+        while(readable_io = IO.select([self_read]))
           signal = readable_io.first[0].gets.strip
           handle_signal(signal)
         end
@@ -54,6 +52,7 @@ class ProconBypassMan::Runner
         @gadget&.close
         @procon&.close
         FileUtils.rm_rf(ProconBypassMan.pid_path)
+        FileUtils.rm_rf(ProconBypassMan.digest_path)
         exit 1
       end
     end
@@ -98,8 +97,11 @@ class ProconBypassMan::Runner
         loop do
           break if $will_terminate_token
           bypass.send_procon_to_gadget!
+        rescue EOFError => e
+          ProconBypassMan.logger.error "Proconと通信ができませんでした.終了処理を開始します"
+          Process.kill "TERM", Process.ppid
         rescue Errno::EIO, Errno::ENODEV, Errno::EPROTO, IOError => e
-          ProconBypassMan.logger.error "Proconが切断されました.終了処理を開始します"
+          ProconBypassMan.logger.error "Proconが切断されました。終了処理を開始します"
           Process.kill "TERM", Process.ppid
         end
         ProconBypassMan.logger.info "Thread2を終了します"
@@ -119,7 +121,7 @@ class ProconBypassMan::Runner
 
     ProconBypassMan.logger.info "子プロセスでgraceful shutdownの準備ができました"
     begin
-      while readable_io = IO.select([self_read])
+      while(readable_io = IO.select([self_read]))
         signal = readable_io.first[0].gets.strip
         handle_signal(signal)
       end
@@ -133,38 +135,12 @@ class ProconBypassMan::Runner
   end
 
   def first_negotiation
-    loop do
-      begin
-        input = @gadget.read_nonblock(128)
-        ProconBypassMan.logger.debug { ">>> #{input.unpack("H*")}" }
-        @procon.write_nonblock(input)
-        if input[0] == "\x80".b && input[1] == "\x01".b
-          ProconBypassMan.logger.info("first negotiation is over")
-          break
-        end
-        break if $will_terminate_token
-      rescue IO::EAGAINWaitReadable
-      end
-    end
-
-    # ...
-    #   switch) 8001
-    #   procon) 8101
-    #   switch) 8002
-    # が返ってくるプロトコルがあって、これができていないならやり直す
-    loop do
-      begin
-        data = @procon.read_nonblock(128)
-        if data[0] == "\x81".b && data[1] == "\x01".b
-          ProconBypassMan.logger.debug { "接続を確認しました" }
-          @gadget.write_nonblock(data)
-          break
-        else
-          raise ::ProconBypassMan::FirstConnectionError
-        end
-      rescue IO::EAGAINWaitReadable
-      end
-    end
+    @gadget, @procon = ProconBypassMan::DeviceConnector.connect
+  rescue ProconBypassMan::Timer::Timeout
+    ::ProconBypassMan.logger.error "デバイスとの通信でタイムアウトが起きて接続ができませんでした。"
+    @gadget&.close
+    @procon&.close
+    raise ::ProconBypassMan::EternalConnectionError
   end
 
   def handle_signal(sig)
@@ -187,6 +163,7 @@ class ProconBypassMan::Runner
       root: #{ProconBypassMan.root}
       pid_path: #{ProconBypassMan.pid_path}
       setting_path: #{ProconBypassMan::Configuration.instance.setting_path}
+      uptime from boot: #{ProconBypassMan::Uptime.from_boot} sec
       ----
     EOF
     ProconBypassMan.logger.info(booted_message)

data/lib/procon_bypass_man/timer.rb

@@ -0,0 +1,14 @@
+module ProconBypassMan
+  class Timer
+    class Timeout < StandardError; end
+
+    # 5秒後がタイムアウト
+    def initialize(timeout: Time.now + 5)
+      @timeout = timeout
+    end
+
+    def throw_if_timeout!
+      raise Timeout if @timeout < Time.now
+    end
+  end
+end

data/lib/procon_bypass_man/uptime.rb

@@ -0,0 +1,13 @@
+require "time"
+
+module ProconBypassMan
+  class Uptime
+    def self.from_boot
+      boot_time = Time.parse(`uptime -s`.chomp).to_i
+      return Time.now.to_i - boot_time.to_i
+    rescue => e
+      ProconBypassMan.logger.error(e)
+      return "error!"
+    end
+  end
+end

data/lib/procon_bypass_man/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ProconBypassMan
-  VERSION = "0.1.4"
+  VERSION = "0.1.8"
 end

data/lib/procon_bypass_man.rb

@@ -3,21 +3,27 @@ require 'yaml'
 require "fileutils"
 
 require_relative "procon_bypass_man/version"
-require_relative "procon_bypass_man/device_registry"
+require_relative "procon_bypass_man/timer"
 require_relative "procon_bypass_man/bypass"
+require_relative "procon_bypass_man/device_connector"
 require_relative "procon_bypass_man/runner"
 require_relative "procon_bypass_man/processor"
-require_relative "procon_bypass_man/procon/data"
 require_relative "procon_bypass_man/configuration"
 require_relative "procon_bypass_man/procon"
 
 STDOUT.sync = true
 Thread.abort_on_exception = true
 
+# new feature from ruby3.0's
+if GC.respond_to?(:auto_compact)
+  GC.auto_compact = true
+end
+
 module ProconBypassMan
   class ProConRejected < StandardError; end
   class CouldNotLoadConfigError < StandardError; end
   class FirstConnectionError < StandardError; end
+  class EternalConnectionError < StandardError; end
 
   def self.configure(setting_path: nil, &block)
     unless setting_path
@@ -34,13 +40,18 @@ module ProconBypassMan
   def self.run(setting_path: nil, &block)
     configure(setting_path: setting_path, &block)
     File.write(pid_path, $$)
-    registry = ProconBypassMan::DeviceRegistry.new
-    Runner.new(gadget: registry.gadget, procon: registry.procon).run
+    Runner.new.run
   rescue CouldNotLoadConfigError
     ProconBypassMan.logger.error "設定ファイルが不正です。設定ファイルの読み込みに失敗しました"
     puts "設定ファイルが不正です。設定ファイルの読み込みに失敗しました"
     FileUtils.rm_rf(ProconBypassMan.pid_path)
+    FileUtils.rm_rf(ProconBypassMan.digest_path)
     exit 1
+  rescue EternalConnectionError
+    ProconBypassMan.logger.error "接続の見込みがないのでsleepしまくります"
+    puts "接続の見込みがないのでsleepしまくります"
+    FileUtils.rm_rf(ProconBypassMan.pid_path)
+    sleep(999999999)
   rescue FirstConnectionError
     puts "接続を確立できませんでした。やりなおします。"
     retry
@@ -81,4 +92,8 @@ module ProconBypassMan
   def self.root=(path)
     @@root = path
   end
+
+  def self.digest_path
+    "#{root}/.setting_yaml_digest"
+  end
 end

data/procon_bypass_man.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = "extension for Nintendo Switch Pro Controller"
   spec.description   = spec.summary
-  spec.homepage      = "https://github.com/splaspla-hacker/procon_bypass_man"
+  spec.homepage      = "https://github.com/splaplapla/procon_bypass_man"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
 

data/project_template/README.md

@@ -0,0 +1,17 @@
+# Project Template
+https://github.com/splaplapla/pbmenv で使っているファイルです
+
+## systemd
+* sudo ln -s /usr/share/pbm/current/systemd_units/pbm.service /etc/systemd/system/pbm.service
+* commands
+  * systemctl daemon-reload
+  * systemctl enable pbm.service
+  * systemctl disable pbm.service
+  * systemctl start pbm.service
+  * systemctl status pbm.service
+  * systemctl restart pbm.service
+  * systemctl list-unit-files --type=service
+
+### ログ
+* journalctl -xe -f
+

data/project_template/app.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+  git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+  gem 'procon_bypass_man', '0.1.8'
+  gem 'procon_bypass_man-splatoon2', github: 'splaplapla/procon_bypass_man-splatoon2', tag: "0.1.1"
+end
+
+ProconBypassMan.tap do |pbm|
+  pbm.root = File.expand_path(__dir__)
+  pbm.logger = Logger.new("#{ProconBypassMan.root}/app.log", 5, 1024 * 1024 * 10)
+  pbm.logger.level = :debug
+end
+
+ProconBypassMan.run(setting_path: "/usr/share/pbm/current/setting.yml")