procon_bypass_man 0.1.8 → 0.1.9

data/lib/procon_bypass_man/on_memory_cache.rb

@@ -0,0 +1,34 @@
+class ProconBypassMan::OnMemoryCache
+  class CacheValue
+    attr_accessor :expired_at, :value
+
+    def initialize(expired_at: , value: )
+      self.expired_at = expired_at
+      self.value = value
+    end
+  end
+
+  def initialize
+    @table = {}
+  end
+
+  # @param [Integer] expires_in 秒数
+  # @param [String] key
+  def fetch(key: , expires_in: , &block)
+    now = Time.now
+    if @table[key].nil?
+      value = block.call
+      value_object = CacheValue.new(expired_at: now + expires_in, value: value)
+      @table[key] = value_object
+      return value
+    end
+
+    if @table[key].expired_at < now
+      value = block.call
+      @table[key] = CacheValue.new(expired_at: now + expires_in, value: value)
+      return value
+    else
+      return @table[key].value
+    end
+  end
+end

data/lib/procon_bypass_man/procon/analog_stick_cap.rb

@@ -0,0 +1,88 @@
+class ProconBypassMan::Procon::AnalogStickCap
+  class Position
+    attr_accessor :x, :y
+
+    def initialize(x:, y:)
+      @x = x.to_i
+      @y = y.to_i
+    end
+
+    def to_binary
+      analog_stick_data = [
+        (@x & "0xff".to_i(16)),
+        ((@y << 4) & "0xf0".to_i(16)) | ((@x >> 8) & "0x0f".to_i(16)),
+        (@y >> 4) & "0xff".to_i(16),
+      ]
+      hex = analog_stick_data.map{ |x| x.to_s(16).rjust(2, "0") }.join
+      [hex].pack("H*")
+    end
+  end
+
+  attr_accessor :bin_x, :bin_y
+  attr_accessor :neutral_position
+
+  def initialize(binary)
+    @neutral_position = ProconBypassMan::Configuration.instance.neutral_position
+    @binary = binary
+
+    byte6 = binary[6].unpack("H*").first.to_i(16).to_s(2).rjust(8, "0")
+    byte7 = binary[7].unpack("H*").first.to_i(16).to_s(2).rjust(8, "0")
+    byte8 = binary[8].unpack("H*").first.to_i(16).to_s(2).rjust(8, "0")
+
+    self.bin_x = "#{byte7[4..7]}#{byte6}"
+    self.bin_y = "#{byte8}#{byte7[0..3]}"
+  end
+
+  # @return [ProconBypassMan::Procon::AnalogStickCap::Position]
+  def capped_position(cap_hypotenuse: )
+    if hypotenuse > cap_hypotenuse
+      relative_capped_x = cap_hypotenuse * Math.cos(rad * Math::PI / 180).abs
+      relative_capped_y = cap_hypotenuse * Math.sin(rad * Math::PI / 180).abs
+      relative_capped_x = -(relative_capped_x.abs) if relative_x.negative?
+      relative_capped_y = -(relative_capped_y.abs) if relative_y.negative?
+      return Position.new(
+        x: relative_capped_x + neutral_position.x,
+        y: relative_capped_y + neutral_position.y,
+      )
+    else
+      return position
+    end
+  end
+
+  # @return [ProconBypassMan::Procon::AnalogStickCap::Position]
+  def position
+    Position.new(x: abs_x, y: abs_y)
+  end
+
+  # 0, 0からのx
+  def abs_x
+    bin_x.to_i(2)
+  end
+
+  # 0, 0からのy
+  def abs_y
+    bin_y.to_i(2)
+  end
+
+  def relative_x
+    bin_x.to_i(2) - neutral_position.x
+  end
+
+  def relative_y
+    bin_y.to_i(2) - neutral_position.y
+  end
+
+  # @deprecated
+  def x; relative_x; end
+  def y; relative_y; end
+
+  def rad
+    (
+      Math.atan(y / x.to_f) * 180 / Math::PI
+    ).floor(6)
+  end
+
+  def hypotenuse
+    Math.sqrt(x**2 + y**2).floor(6)
+  end
+end

data/lib/procon_bypass_man/procon/button_collection.rb

@@ -8,15 +8,20 @@ class ProconBypassMan::Procon::ButtonCollection
     end
   end
 
+  # https://github.com/dekuNukem/Nintendo_Switch_Reverse_Engineering/blob/ac8093c84194b3232acb675ac1accce9bcb456a3/bluetooth_hid_notes.md
+  #0) Input report ID
+  #1) Timer. Increments very fast. Can be used to estimate excess Bluetooth latency.
+  #2 high nibble) Battery level. 8=full, 6=medium, 4=low, 2=critical, 0=empty. LSB=Charging.
+  #2 low nibble) Connection info. (con_info >> 1) & 3 - 3=JC, 0=Pro/ChrGrip. con_info & 1 - 1=Switch/USB powered.
   #3)  ZR	R	SR(right)	SL(right)	A	B	X	Y
   #4)  Grip	(none)	Cap	Home	ThumbL	ThumbR	+	-
   #5)  ZL	L	SL(left)	SR(left)	Left	Right	Up	Down
-  #6)  analog[0]
-  #7)  analog[1]
-  #8)  analog[2]
-  #9)  analog[3]
-  #a)  analog[4]
-  #b)  analog[5]
+  #6)  analog[0] Left analog stick data
+  #7)  analog[1] Left analog stick data
+  #8)  analog[2] Left analog stick data
+  #9)  analog[3] Right analog stick data
+  #a)  analog[4] Right analog stick data
+  #b)  analog[5] Right analog stick data
   BYTES_MAP = {
     0 => nil,
     1 => nil,
@@ -24,6 +29,9 @@ 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],
+    6 => [],
+    7 => [],
+    8 => [],
   }.freeze
 
   BUTTONS_MAP = BYTES_MAP.reduce({}) { |acc, value|

data/lib/procon_bypass_man/procon/debug_dumper.rb

@@ -0,0 +1,17 @@
+class ProconBypassMan::Procon::DebugDumper
+  def initialize(binary: )
+    @binary = binary
+    # ProconBypassMan.logger.debug { "<<< patched #{@binary.unpack("H*")}" }
+  end
+
+  def dump_analog_sticks
+    byte6 = @binary[6].unpack("H*").first.to_i(16).to_s(2).rjust(8, "0")
+    byte7 = @binary[7].unpack("H*").first.to_i(16).to_s(2).rjust(8, "0")
+    byte8 = @binary[8].unpack("H*").first.to_i(16).to_s(2).rjust(8, "0")
+
+    x = "#{byte7[4..7]}#{byte6}"
+    y = "#{byte8}#{byte7[0..3]}"
+    ProconBypassMan.logger.debug "x: #{x}, val: #{x.to_i(2)}"
+    ProconBypassMan.logger.debug "y: #{y}, val: #{y.to_i(2)}"
+  end
+end

data/lib/procon_bypass_man/procon/mode_registry.rb

@@ -23,10 +23,10 @@ class ProconBypassMan::Procon::ModeRegistry
   }
 
   def self.install_plugin(klass)
-    if plugins[klass.name]
+    if plugins[klass.name.to_sym]
       raise "すでに登録済みです"
     end
-    plugins[klass.name] = klass.binaries
+    plugins[klass.name.to_sym] = klass.binaries
   end
 
   def self.load(name)

data/lib/procon_bypass_man/procon/press_button_aware.rb

@@ -0,0 +1,13 @@
+class ProconBypassMan::PpressButtonAware
+  def initialize(binary)
+    @binary = binary
+  end
+
+  def pressed_button?(button)
+    @binary[
+      ::ProconBypassMan::Procon::ButtonCollection.load(button).byte_position
+    ].unpack("H*").first.to_i(16).to_s(2).reverse[
+      ::ProconBypassMan::Procon::ButtonCollection.load(button).bit_position
+    ] == '1'
+  end
+end

data/lib/procon_bypass_man/procon/pressed_button_helper.rb

@@ -1,14 +1,4 @@
 module ProconBypassMan::Procon::PushedButtonHelper
-  module Static
-    def pressed_button?(button)
-      binary[
-        ::ProconBypassMan::Procon::ButtonCollection.load(button).byte_position
-      ].unpack("H*").first.to_i(16).to_s(2).reverse[
-        ::ProconBypassMan::Procon::ButtonCollection.load(button).bit_position
-      ] == '1'
-    end
-  end
-
   module Dynamic
     @@compiled = false
     def compile_if_not_compile_yet!

data/lib/procon_bypass_man/procon/user_operation.rb

@@ -1,7 +1,6 @@
 class ProconBypassMan::Procon
   class UserOperation
     include LayerChangeable
-    include PushedButtonHelper::Static
     extend PushedButtonHelper::Dynamic
 
     attr_reader :binary
@@ -33,13 +32,17 @@ class ProconBypassMan::Procon
 
     def unpress_button(button)
       byte_position = ButtonCollection.load(button).byte_position
-      value = binary[byte_position].unpack("H*").first.to_i(16) - 2**ButtonCollection.load(button).bit_position
+      value = binary[byte_position].unpack("H*").first.to_i(16) - (2**ButtonCollection.load(button).bit_position)
       binary[byte_position] = ["%02X" % value.to_s].pack("H*")
     end
 
+    def apply_left_analog_stick_cap(cap: )
+      binary[6..8] = ProconBypassMan::Procon::AnalogStickCap.new(binary).capped_position(cap_hypotenuse: cap).to_binary
+    end
+
     def press_button(button)
       byte_position = ButtonCollection.load(button).byte_position
-      value = binary[byte_position].unpack("H*").first.to_i(16) + 2**ButtonCollection.load(button).bit_position
+      value = binary[byte_position].unpack("H*").first.to_i(16) + (2**ButtonCollection.load(button).bit_position)
       binary[byte_position] = ["%02X" % value.to_s].pack("H*")
     end
 
@@ -68,5 +71,9 @@ class ProconBypassMan::Procon
       binary[11] = tb[11]
       self.binary
     end
+
+    def pressed_button?(button)
+      ProconBypassMan::PpressButtonAware.new(binary).pressed_button?(button)
+    end
   end
 end

data/lib/procon_bypass_man/procon.rb

@@ -7,6 +7,7 @@ class ProconBypassMan::Procon
   require "procon_bypass_man/procon/pressed_button_helper"
   require "procon_bypass_man/procon/user_operation"
   require "procon_bypass_man/procon/flip_cache"
+  require "procon_bypass_man/procon/press_button_aware"
 
   attr_accessor :user_operation
 
@@ -94,6 +95,15 @@ class ProconBypassMan::Procon
       return user_operation.binary
     end
 
+    current_layer.left_analog_stick_caps.each do |button, options|
+      if button.nil? || button.all? { |b| user_operation.pressed_button?(b) }
+        options[:force_neutral]&.each do |force_neutral_button|
+          user_operation.pressed_button?(force_neutral_button) && user_operation.unpress_button(force_neutral_button)
+        end
+        user_operation.apply_left_analog_stick_cap(cap: options[:cap])
+      end
+    end
+
     current_layer.flip_buttons.each do |button, options|
       # 何もしないで常に連打
       if !options[:if_pressed] && status[button]
@@ -123,7 +133,11 @@ class ProconBypassMan::Procon
       end
     end
 
-    user_operation.binary
+    b = user_operation.binary
+    ProconBypassMan.cache.fetch key: 'user_operation.binary', expires_in: 60 do
+      ProconBypassMan::Procon::DebugDumper.new(binary: b).dump_analog_sticks
+    end
+    b
   end
 
   private

data/lib/procon_bypass_man/reporter.rb

@@ -0,0 +1,42 @@
+require "net/http"
+require "json"
+
+class ProconBypassMan::Reporter
+  PATH = "/api/reports" # POST
+
+  class Client
+    def initialize
+      @server = ProconBypassMan.api_server
+      @hostname = `hostname`.chomp
+    end
+
+    def post(body: )
+      # TODO ここでvalidationする
+      if @server.nil?
+        ProconBypassMan.logger.info('送信先が未設定なのでスキップしました')
+        return
+      end
+
+      uri = URI.parse("#{@server}#{PATH}")
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme === "https"
+      response = http.post(
+        uri.path,
+        { report: body.to_json, hostname: @hostname }.to_json,
+        { "Content-Type" => "application/json" },
+      )
+      unless response.code == /^20/
+        ProconBypassMan.logger.error(response.body)
+      end
+    rescue => e
+      puts e
+      ProconBypassMan.logger.error(e)
+    end
+  end
+
+  def self.report(body: )
+    Client.new.post(body: body)
+  rescue => e
+    ProconBypassMan.logger.error(e)
+  end
+end

data/lib/procon_bypass_man/runner.rb

@@ -1,14 +1,10 @@
 require_relative "io_monitor"
 require_relative "uptime"
+require_relative "boot_message"
 
 class ProconBypassMan::Runner
   class InterruptForRestart < StandardError; end
 
-  def initialize
-    $will_interval_0_0_0_5 = 0
-    $will_interval_1_6 = 0
-  end
-
   def run
     first_negotiation
     print_booted_message
@@ -61,13 +57,6 @@ class ProconBypassMan::Runner
   private
 
   def main_loop
-    # TODO 接続確立完了をswitchを読み取るようにして、この暫定で接続完了sleepを消す
-    Thread.new do
-      sleep(5)
-      $will_interval_0_0_0_5 = 0.005
-      $will_interval_1_6 = 1.6
-    end
-
     ProconBypassMan::IOMonitor.start!
     # gadget => procon
     # 遅くていい
@@ -75,17 +64,27 @@ class ProconBypassMan::Runner
     monitor2 = ProconBypassMan::IOMonitor.new(label: "procon -> switch")
     ProconBypassMan.logger.info "Thread1を起動します"
     t1 = Thread.new do
+      timer = ProconBypassMan::Timer.new(timeout: Time.now + 10)
       bypass = ProconBypassMan::Bypass.new(gadget: @gadget, procon: @procon, monitor: monitor1)
-      begin
-        loop do
-          break if $will_terminate_token
-          bypass.send_gadget_to_procon!
-        rescue Errno::EIO, Errno::ENODEV, Errno::EPROTO, IOError => e
-          ProconBypassMan.logger.error "Proconが切断されました.終了処理を開始します"
-          Process.kill "TERM", Process.ppid
-        end
-        ProconBypassMan.logger.info "Thread1を終了します"
+      loop do
+        break if $will_terminate_token
+        timer.throw_if_timeout!
+        bypass.send_gadget_to_procon!
+        sleep(0.005)
+      rescue ProconBypassMan::Timer::Timeout
+        ProconBypassMan.logger.info "10秒経過したのでThread1を終了します"
+        puts "10秒経過したのでThread1を終了します"
+        break
+      rescue Errno::EIO, Errno::ENODEV, Errno::EPROTO, IOError => e
+        ProconBypassMan.logger.error "Proconが切断されました.終了処理を開始します"
+        Process.kill "TERM", Process.ppid
+      rescue Errno::ETIMEDOUT => e
+        # TODO まれにこれが発生する. 再接続したい
+        ProconBypassMan::ErrorReporter.report(body: e)
+        ProconBypassMan.logger.error "Switchとの切断されました.終了処理を開始します"
+        Process.kill "TERM", Process.ppid
       end
+      ProconBypassMan.logger.info "Thread1を終了します"
     end
 
     # procon => gadget
@@ -93,19 +92,17 @@ class ProconBypassMan::Runner
     ProconBypassMan.logger.info "Thread2を起動します"
     t2 = Thread.new do
       bypass = ProconBypassMan::Bypass.new(gadget: @gadget, procon: @procon, monitor: monitor2)
-      begin
-        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が切断されました。終了処理を開始します"
-          Process.kill "TERM", Process.ppid
-        end
-        ProconBypassMan.logger.info "Thread2を終了します"
+      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が切断されました。終了処理を開始します"
+        Process.kill "TERM", Process.ppid
       end
+      ProconBypassMan.logger.info "Thread2を終了します"
     end
 
     self_read, self_write = IO.pipe
@@ -155,18 +152,9 @@ class ProconBypassMan::Runner
 
   # @return [void]
   def print_booted_message
-    booted_message = <<~EOF
-      ----
-      RUBY_VERSION: #{RUBY_VERSION}
-      ProconBypassMan: #{ProconBypassMan::VERSION}
-      pid: #{$$}
-      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)
-    puts booted_message
+    message = ProconBypassMan::BootMessage.new
+    ProconBypassMan.logger.info(message.to_s)
+    Thread.new { ProconBypassMan::Reporter.report(body: message.to_hash) }
+    puts message.to_s
   end
 end

data/lib/procon_bypass_man/uptime.rb

@@ -7,7 +7,7 @@ module ProconBypassMan
       return Time.now.to_i - boot_time.to_i
     rescue => e
       ProconBypassMan.logger.error(e)
-      return "error!"
+      return -1
     end
   end
 end

data/lib/procon_bypass_man/version.rb

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

data/lib/procon_bypass_man.rb

@@ -3,6 +3,7 @@ require 'yaml'
 require "fileutils"
 
 require_relative "procon_bypass_man/version"
+require_relative "procon_bypass_man/analog_stick_position"
 require_relative "procon_bypass_man/timer"
 require_relative "procon_bypass_man/bypass"
 require_relative "procon_bypass_man/device_connector"
@@ -10,11 +11,16 @@ require_relative "procon_bypass_man/runner"
 require_relative "procon_bypass_man/processor"
 require_relative "procon_bypass_man/configuration"
 require_relative "procon_bypass_man/procon"
+require_relative "procon_bypass_man/procon/debug_dumper"
+require_relative "procon_bypass_man/procon/analog_stick_cap"
+require_relative "procon_bypass_man/reporter"
+require_relative "procon_bypass_man/error_reporter"
+require_relative "procon_bypass_man/on_memory_cache"
 
 STDOUT.sync = true
 Thread.abort_on_exception = true
 
-# new feature from ruby3.0's
+# new feature from ruby3.0
 if GC.respond_to?(:auto_compact)
   GC.auto_compact = true
 end
@@ -38,6 +44,8 @@ module ProconBypassMan
   end
 
   def self.run(setting_path: nil, &block)
+    ProconBypassMan.logger.info "PBMを起動しています"
+    puts "PBMを起動しています"
     configure(setting_path: setting_path, &block)
     File.write(pid_path, $$)
     Runner.new.run
@@ -61,14 +69,31 @@ module ProconBypassMan
     @@logger = logger
   end
 
+  # @return [Logger]
   def self.logger
-    if defined?(@@logger)
+    if ENV["PBM_ENV"] == 'test'
+      return Logger.new($stdout)
+    end
+
+    if defined?(@@logger) && @@logger.is_a?(Logger)
       @@logger
     else
       Logger.new(nil)
     end
   end
 
+  def self.enable_critical_error_logging!
+    @@enable_critical_error_logging = true
+  end
+
+  def self.error_logger
+    if defined?(@@enable_critical_error_logging)
+      @@error_logger ||= Logger.new("#{ProconBypassMan.root}/error.log", 5, 1024 * 1024 * 10)
+    else
+      Logger.new(nil)
+    end
+  end
+
   def self.pid_path
     @@pid_path ||= File.expand_path("#{root}/pbm_pid", __dir__).freeze
   end
@@ -93,6 +118,22 @@ module ProconBypassMan
     @@root = path
   end
 
+  def self.api_server=(api_server)
+    @@api_server = api_server
+  end
+
+  def self.api_server
+    if defined?(@@api_server)
+      @@api_server
+    else
+      nil
+    end
+  end
+
+  def self.cache
+    @@cache_table ||= ProconBypassMan::OnMemoryCache.new
+  end
+
   def self.digest_path
     "#{root}/.setting_yaml_digest"
   end

data/project_template/app.rb

@@ -5,7 +5,7 @@ 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', '0.1.9'
   gem 'procon_bypass_man-splatoon2', github: 'splaplapla/procon_bypass_man-splatoon2', tag: "0.1.1"
 end
 
@@ -13,6 +13,8 @@ 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
+  # pbm.api_server = 'https://...'
+  pbm.enable_critical_error_logging!
 end
 
 ProconBypassMan.run(setting_path: "/usr/share/pbm/current/setting.yml")

data/sig/README.rb

@@ -0,0 +1,4 @@
+# SIG
+```
+bundle exec rbs prototype rb lib/**/*.rb > sig/main.rbs
+```