procon_bypass_man 0.1.12 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42551d494786247ae06f81c416f522360001fb0a78ffdd67311520aafb56587a
-  data.tar.gz: 92da20f533512ec4e1fdebe93f2c064f5ae1513fd6f26d3c4f34f2a0d488dffd
+  metadata.gz: 62fab79bffee3adf43af06325d7ef6bce2060f844d8caaa824968ff77219e5de
+  data.tar.gz: c15ab8b50da926169727b9af5ff097585cd35c7e24fdf2ce75d2ca7d4fe5f07e
 SHA512:
-  metadata.gz: b52fde78831c29dc1b56b56217a604e421b6c0cdf5859b997732b36d94b9b7dc9d02f3906835d41df5f7168a2b694c2c457d3f96fd235903fc4827f42e74422b
-  data.tar.gz: 50defecca29919fca30680469deddc5adc5c41d0c4f02f084c0a73f9633aa8e11101a5f07e863ea4e0b6481178d4f11e0d466a4bf2d9954f08cb5407d3cb10dd
+  metadata.gz: c94bc5e37b89c54a31fe165e53f84ac32c1b4d10fc617cc1397e0347baf1a39206fd50aff3a65626b8546545d00f33ac0e44a90da5ff25c02778d27e60aafe0f
+  data.tar.gz: 7ad56ef9e17bb8a26d840003faf8fa7d065ba878182dcd23d66118b43053c2827221814f37bb4098174cdfbcc449486d895bf6431520f60ce295a4e7382c39e7

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## [0.1.13] - 2021-11-24
+- 起動を早くするために、procon_bypass_man-splatoon2を同梱しました
+
 ## [0.1.12] - 2021-11-18
 - 起動ログなどを設定した外部サーバに送信できるようにしました
 

data/Gemfile

@@ -5,7 +5,7 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in procon_bypass_man.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
+gem "rake"
 gem "rspec"
 gem "pry"
 gem "timecop"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    procon_bypass_man (0.1.12)
+    procon_bypass_man (0.1.13)
 
 GEM
   remote: https://rubygems.org/
@@ -17,7 +17,7 @@ GEM
     concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
     ffi (1.15.4)
-    i18n (1.8.10)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
     language_server-protocol (3.16.0.3)
     listen (3.7.0)
@@ -27,7 +27,7 @@ GEM
     minitest (5.14.4)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
-    parallel (1.20.1)
+    parallel (1.21.0)
     parser (3.0.2.0)
       ast (~> 2.4.1)
     pry (0.14.1)
@@ -41,7 +41,7 @@ GEM
     rb-fsevent (0.11.0)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (1.6.2)
+    rbs (1.7.1)
     regexp_parser (2.1.1)
     rexml (3.2.5)
     rspec (3.10.0)
@@ -56,17 +56,17 @@ GEM
     rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.20.0)
+    rspec-support (3.10.3)
+    rubocop (1.23.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.9.1, < 2.0)
+      rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.11.0)
+    rubocop-ast (1.13.0)
       parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
@@ -90,9 +90,9 @@ GEM
     timecop (0.9.4)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.0.0)
+    unicode-display_width (2.1.0)
     webrick (1.7.0)
-    zeitwerk (2.4.2)
+    zeitwerk (2.5.1)
 
 PLATFORMS
   arm-linux
@@ -104,7 +104,7 @@ PLATFORMS
 DEPENDENCIES
   procon_bypass_man!
   pry
-  rake (~> 13.0)
+  rake
   rbs
   rspec
   rubocop

data/README.md

@@ -28,8 +28,8 @@ Switch <-- (PBM): ZR連打
 ## Usage
 * USBガジェットモードで起動するRaspberry Pi4を用意する
   * https://github.com/splaplapla/procon_bypass_man/blob/master/docs/setup_raspi.md
-* Raspberry Pi4で https://github.com/jiikko/procon_bypass_man_sample をclone して実行ファイルを動かす
-  * 実行ファイルと設定ファイルについては https://github.com/splaplapla/procon_bypass_man/wiki に詳細を書いていますが、まず動かすためにはcloneしたほうが早いです
+* Raspberry Pi4 で sudo pbmenv install latest && cd /usr/share/pbm/current && sudo ruby app.rb
+  * 動いたのを確認したらserviceとして登録にするなどしてください
 
 ## Plugins
 * https://github.com/splaplapla/procon_bypass_man-splatoon2
@@ -52,6 +52,8 @@ Switch <-- (PBM): ZR連打
     * 連射中には特定のキーの入力を無視したり、複数のキーをトリガーに連射することができます
 * どうしてsudoが必要なの？
     * 操作するdeviceファイルの所有者がrootだから
+* 市販されているサードパーティ製連射機との違いは？
+    * サードパーティ製のコントローラーは、設定方法や形状が特殊で買い換えるたびに学習・設定コストが発生します。本ツールを使えば、設定内容はテキストで管理することができ、使い慣れたプロコンで同等のことができます。
 
 ## TODO
 * レコーディング機能(プロコンの入力をマクロとして登録ができる)
@@ -59,8 +61,6 @@ Switch <-- (PBM): ZR連打
 * 設定ファイル マクロの引数に、ボタンを取れるようにする
 
 ## 開発系
-* pbmenvで生成するapp.rbに開発用ブランチを参照してください
-
 ### プロコンとの接続を維持したまま、現在の設定ファイルをPBMに反映する
 ```shell
 sudo kill -USR2 `cat ./pbm_pid`
@@ -71,9 +71,8 @@ sudo kill -USR2 `cat ./pbm_pid`
 
 ### 開発環境でログの送信を確認する方法
 * `bundle exec bin/dev_api_server.rb`
-* `INTERNAL_API_SERVER=http://localhost:4567 bin/console`
-* `API_SERVER=http://localhost:4567 bin/console`
-  * `message = ProconBypassMan::BootMessage.new; ProconBypassMan::ReportBootJob.report(body: message.to_hash)`
+* `API_SERVER=http://localhost:4567 INTERNAL_API_SERVER=http://localhost:4567 bin/console`
+  * `message = ProconBypassMan::BootMessage.new; ProconBypassMan::ReportBootJob.perform(body: message.to_hash)`
 
 ### リリース手順
 * project_template/web.rb, project_template/app.rb, lib/procon_bypass_man/version.rb のバージョンをあげる
@@ -83,3 +82,7 @@ sudo kill -USR2 `cat ./pbm_pid`
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+
+## Links
+* https://discord.gg/bEcRNKf4ep

data/lib/procon_bypass_man/background/http_client.rb

@@ -2,7 +2,7 @@ module ProconBypassMan
   module Background
     class HttpClient
       class HttpRequest
-        def self.request!(uri: , hostname: , body: , device_id: , session_id: nil, event_type: )
+        def self.request!(uri: , hostname: , params: , device_id: , session_id: nil, event_type: )
           @uri = uri
           @http = Net::HTTP.new(uri.host, uri.port)
           @http.use_ssl = uri.scheme === "https"
@@ -11,7 +11,7 @@ module ProconBypassMan
             event_type: event_type,
             session_id: session_id,
             device_id: device_id,
-          }.merge(body)
+          }.merge(params)
           @http.post(
             @uri.path,
             @params.to_json,
@@ -32,11 +32,8 @@ module ProconBypassMan
           ProconBypassMan.logger.info('送信先が未設定なのでスキップしました')
           return
         end
-        if body.is_a?(Hash)
-          body = { body: body, event_type: event_type }
-        else
-          body = { body: { value: body, event_type: event_type } }
-        end
+
+        params = { body: body.to_json }
         session_id = ProconBypassMan.session_id
         device_id = ProconBypassMan.device_id
 
@@ -45,7 +42,7 @@ module ProconBypassMan
           hostname: @hostname,
           device_id: device_id,
           session_id: session_id,
-          body: body,
+          params: params,
           event_type: event_type,
         )
         case response.code

data/lib/procon_bypass_man/background/job_runner.rb

@@ -8,14 +8,14 @@ module ProconBypassMan
       end
 
       # for test
-      def self.stop!
-        return unless defined?(@@thread)
-        @@thread.kill
+      def stop!
+        return unless defined?(@thread)
+        @thread.kill
       end
 
       def start!
-        return if defined?(@@thread)
-        @@thread = Thread.new do
+        return if defined?(@thread)
+        @thread = Thread.new do
           while(item = self.class.queue.pop)
             begin
               JobPerformer.new(klass: item[:reporter_class], args: item[:args]).perform
@@ -25,6 +25,7 @@ module ProconBypassMan
             end
           end
         end
+        self
       end
 
       def self.queue

data/lib/procon_bypass_man/background/jobs/report_load_config_job.rb

@@ -0,0 +1,10 @@
+class ProconBypassMan::ReportLoadConfigJob <  ProconBypassMan::BaseJob
+  # @param [String] body
+  def self.perform(body)
+    ProconBypassMan::Background::HttpClient.new(
+      path: path,
+      pool_server: pool_server,
+      retry_on_connection_error: false,
+    ).post(body: body, event_type: :load_config)
+  end
+end

data/lib/procon_bypass_man/background.rb

@@ -1,10 +1,12 @@
 require "procon_bypass_man/background/job_runnable"
+require "procon_bypass_man/background/job_runner"
 require "procon_bypass_man/background/job_performer"
 require "procon_bypass_man/background/has_server_pool"
 require "procon_bypass_man/background/http_client"
 require "procon_bypass_man/background/jobs/base_job"
 require "procon_bypass_man/background/jobs/report_boot_job"
 require "procon_bypass_man/background/jobs/report_reload_config_job"
+require "procon_bypass_man/background/jobs/report_load_config_job"
 require "procon_bypass_man/background/jobs/report_error_job"
 require "procon_bypass_man/background/jobs/report_heartbeat_job"
 require "procon_bypass_man/background/jobs/report_pressed_buttons_job"

data/lib/procon_bypass_man/boot_message.rb

@@ -8,6 +8,7 @@ class ProconBypassMan::BootMessage
     @table[:pid_path] = ProconBypassMan.pid_path
     @table[:setting_path] = ProconBypassMan::ButtonsSettingConfiguration.instance.setting_path
     @table[:uptime_from_boot] = ProconBypassMan::Uptime.from_boot
+    @table[:use_pbmenv] = !(!!`which pbmenv`.empty?)
 
     # 開発中のHEADを取りたかったけど、Gem::Specification経由から取得する必要がありそう
     # build_version = `git rev-parse --short HEAD`.chomp
@@ -25,12 +26,13 @@ class ProconBypassMan::BootMessage
     booted_message = <<~EOF
       ----
       RUBY_VERSION: #{@table[:ruby_version]}
-      ProconBypassMan: #{@table[:pbm_version]}
+      ProconBypassMan::VERSION: #{@table[:pbm_version]}
       pid: #{@table[:pid]}
       root: #{@table[:root_path]}
       pid_path: #{@table[:pid_path]}
       setting_path: #{@table[:setting_path]}
       uptime from boot: #{@table[:uptime_from_boot]} sec
+      use_pbmenv: #{@table[:use_pbmenv]}
       ----
     EOF
   end

data/lib/procon_bypass_man/buttons_setting_configuration/layer.rb

@@ -20,21 +20,26 @@ module ProconBypassMan
           if_pressed = [button]
         when Symbol, String
           if_pressed = [if_pressed]
-        when Array, FalseClass
-          # sono mama
+        when Array
+          # if_pressed = if_pressed
+        when FalseClass, NilClass
+          # no-op
         else
           raise "not support class"
         end
+
         hash = { if_pressed: if_pressed }
-        if force_neutral
-          case force_neutral
-          when TrueClass, FalseClass
-            raise "ボタンを渡してください"
-          when Symbol, String
-            hash[:force_neutral] = [force_neutral]
-          when Array
-            hash[:force_neutral] = force_neutral
-          end
+        case force_neutral
+        when TrueClass
+          raise "ボタンを渡してください"
+        when Symbol, String
+          hash[:force_neutral] = [force_neutral]
+        when Array
+          hash[:force_neutral] = force_neutral
+        when FalseClass, NilClass
+          # no-op
+        else
+          raise "not support value"
         end
 
         if flip_interval
@@ -63,7 +68,7 @@ module ProconBypassMan
 
       def remap(button, to: )
         case to
-        when TrueClass, FalseClass
+        when TrueClass, FalseClass, NilClass
           raise "ボタンを渡してください"
         when Symbol, String
           self.remaps[button] = { to: [to] }
@@ -77,27 +82,27 @@ module ProconBypassMan
         hash = { cap: cap }
 
         case if_pressed
-        when TrueClass
-          raise "not support class"
+        when TrueClass, FalseClass
+          raise "ボタンを渡してください"
         when Symbol, String
           if_pressed = [if_pressed]
-        when Array, FalseClass
-          # sono mama
-        when NilClass
-          if_pressed = nil
+        when Array, NilClass
+          # no-op
         else
-          raise "not support if_pressed"
+          raise "not support value"
         end
 
-        if force_neutral
-          case force_neutral
-          when TrueClass, FalseClass
-            raise "ボタンを渡してください"
-          when Symbol, String
-            hash[:force_neutral] = [force_neutral]
-          when Array
-            hash[:force_neutral] = force_neutral
-          end
+        case force_neutral
+        when TrueClass
+          raise "ボタンを渡してください"
+        when Symbol, String
+          hash[:force_neutral] = [force_neutral]
+        when Array
+          hash[:force_neutral] = force_neutral
+        when FalseClass, NilClass
+          # no-op
+        else
+          raise "not support value"
         end
 
         left_analog_stick_caps[if_pressed] = hash
@@ -114,7 +119,7 @@ module ProconBypassMan
         when Array
           button.each { |b| disables << b }
         else
-          raise "unknown"
+          raise "not support value"
         end
       end
 

data/lib/procon_bypass_man/buttons_setting_configuration.rb

@@ -77,7 +77,7 @@ module ProconBypassMan
     end
 
     def set_neutral_position(x, y)
-      self.neutral_position = AnalogStickPosition.new(x, y)
+      self.neutral_position = AnalogStickPosition.new(x, y).freeze
       self
     end
 
@@ -95,7 +95,7 @@ module ProconBypassMan
         left: Layer.new,
         right: Layer.new,
       }
-      @neutral_position = AnalogStickPosition.new(2124, 1808)
+      @neutral_position = AnalogStickPosition.new(2124, 1808).freeze
     end
   end
 end

data/lib/procon_bypass_man/bypass/usb_hid_logger.rb

@@ -10,7 +10,13 @@ class ProconBypassMan::Bypass
     set_callback :send_procon_to_gadget, :after, :log_procon_to_gadget
 
     def log_send_gadget_to_procon
-      ProconBypassMan.logger.debug { ">>> #{bypass_value.to_text}" }
+      if ProconBypassMan.config.verbose_bypass_log
+        ProconBypassMan.logger.debug { ">>> #{bypass_value.to_text}" }
+      else
+        ProconBypassMan.cache.fetch key: 'bypass_log', expires_in: 1 do
+          ProconBypassMan.logger.debug { ">>> #{bypass_value.to_text}" }
+        end
+      end
     end
 
     def log_procon_to_gadget

data/lib/procon_bypass_man/commands/bypass_command.rb

@@ -0,0 +1,86 @@
+class ProconBypassMan::BypassCommand
+  include ProconBypassMan::SignalHandler
+
+  def initialize(gadget:, procon:)
+    @gadget = gadget
+    @procon = procon
+
+    ProconBypassMan::IOMonitor.start!
+    ProconBypassMan::Background::JobRunner.queue.clear # forkしたときに残留物も移ってしまうため
+    ProconBypassMan::Background::JobRunner.start!
+  end
+
+  def execute
+    self_read, self_write = IO.pipe
+    %w(TERM INT).each do |sig|
+      begin
+        trap sig do
+          self_write.puts(sig)
+        end
+      rescue ArgumentError
+        puts "プロセスでSignal #{sig} not supported"
+      end
+    end
+
+    # gadget => procon
+    # 遅くていい
+    monitor1 = ProconBypassMan::IOMonitor.new(label: "switch -> procon")
+    monitor2 = ProconBypassMan::IOMonitor.new(label: "procon -> switch")
+    ProconBypassMan.logger.info "Thread1を起動します"
+    t1 = Thread.new do
+      timer = ProconBypassMan::SafeTimeout.new(timeout: Time.now + 10)
+      bypass = ProconBypassMan::Bypass.new(gadget: @gadget, procon: @procon, monitor: monitor1)
+      loop do
+        break if $will_terminate_token
+        timer.throw_if_timeout!
+        bypass.send_gadget_to_procon!
+        sleep(0.005)
+      rescue ProconBypassMan::SafeTimeout::Timeout
+        ProconBypassMan.logger.info "10秒経過したのでThread1を終了します"
+        monitor1.shutdown
+        puts "10秒経過したのでThread1を終了します"
+        break
+      rescue Errno::EIO, Errno::ENODEV, Errno::EPROTO, IOError => e
+        ProconBypassMan::SendErrorCommand.execute(error: "Switchとの切断されました.終了処理を開始します. #{e.full_message}")
+        Process.kill "TERM", Process.ppid
+      rescue Errno::ETIMEDOUT => e
+        # TODO まれにこれが発生する. 再接続したい
+        ProconBypassMan::SendErrorCommand.execute(error: "Switchと意図せず切断されました.終了処理を開始します. #{e.full_message}")
+        Process.kill "TERM", Process.ppid
+      end
+      ProconBypassMan.logger.info "Thread1を終了します"
+    end
+
+    # procon => gadget
+    # シビア
+    ProconBypassMan.logger.info "Thread2を起動します"
+    t2 = Thread.new do
+      bypass = ProconBypassMan::Bypass.new(gadget: @gadget, procon: @procon, monitor: monitor2)
+      loop do
+        break if $will_terminate_token
+        bypass.send_procon_to_gadget!
+      rescue EOFError => e
+        ProconBypassMan::SendErrorCommand.execute(error: "Proconが切断されました。終了処理を開始します. #{e.full_message}")
+        Process.kill "TERM", Process.ppid
+      rescue Errno::EIO, Errno::ENODEV, Errno::EPROTO, IOError => e
+        ProconBypassMan::SendErrorCommand.execute(error: "Proconが切断されました。終了処理を開始します2. #{e.full_message}")
+        Process.kill "TERM", Process.ppid
+      end
+      ProconBypassMan.logger.info "Thread2を終了します"
+    end
+
+    ProconBypassMan.logger.info "子プロセスでgraceful shutdownの準備ができました"
+    begin
+      while(readable_io = IO.select([self_read]))
+        signal = readable_io.first[0].gets.strip
+        handle_signal(signal)
+      end
+    rescue Interrupt
+      $will_terminate_token = true
+      [t1, t2].each(&:join)
+      @gadget&.close
+      @procon&.close
+      exit 1
+    end
+  end
+end

data/lib/procon_bypass_man/commands/connect_device_command.rb

@@ -2,7 +2,7 @@ class ProconBypassMan::ConnectDeviceCommand
   # @return [void]
   def self.execute!
     gadget, procon = ProconBypassMan::DeviceConnector.connect
-  rescue ProconBypassMan::Timer::Timeout
+  rescue ProconBypassMan::SafeTimeout::Timeout
     ::ProconBypassMan.logger.error "デバイスとの通信でタイムアウトが起きて接続ができませんでした。"
     gadget&.close
     procon&.close

data/lib/procon_bypass_man/commands/print_boot_message_command.rb

@@ -3,7 +3,7 @@ class ProconBypassMan::PrintBootMessageCommand
   def self.execute
     message = ProconBypassMan::BootMessage.new
     ProconBypassMan::ReportBootJob.perform_async(message.to_hash)
-    ProconBypassMan::ReportBootJob.perform_async(ProconBypassMan.config.raw_setting)
+    ProconBypassMan::ReportLoadConfigJob.perform_async(ProconBypassMan.config.raw_setting)
     puts message.to_s
   end
 end

data/lib/procon_bypass_man/commands/send_error_command.rb

@@ -11,6 +11,7 @@ class ProconBypassMan::SendErrorCommand
       end
 
     ProconBypassMan.logger.error body
+    ProconBypassMan.error_logger.error body
     puts body
 
     ProconBypassMan::ReportErrorJob.perform_async(error)

data/lib/procon_bypass_man/commands/send_reload_config_event_command.rb

@@ -1,4 +1,5 @@
 class ProconBypassMan::SendReloadConfigEventCommand
+  # @return [void]
   def self.execute
     puts "設定ファイルの再読み込みができました"
     ProconBypassMan.logger.info "設定ファイルの再読み込みができました"

data/lib/procon_bypass_man/commands/write_device_id_command.rb

@@ -1,4 +1,5 @@
 class ProconBypassMan::WriteDeviceIdCommand
+  # @return [String]
   def self.execute
     path = "#{ProconBypassMan.root}/device_id"
     if(sid = File.read(path))

data/lib/procon_bypass_man/commands.rb

@@ -4,3 +4,4 @@ require "procon_bypass_man/commands/write_device_id_command"
 require "procon_bypass_man/commands/send_reload_config_event_command"
 require "procon_bypass_man/commands/send_error_command"
 require "procon_bypass_man/commands/connect_device_command"
+require "procon_bypass_man/commands/bypass_command"

data/lib/procon_bypass_man/configuration.rb

@@ -35,8 +35,8 @@ class ProconBypassMan::Configuration
     end
   end
 
-  attr_accessor :enable_critical_error_logging, :raw_setting
-  attr_writer :verbose_bypass_log
+  attr_accessor :enable_critical_error_logging
+  attr_writer :verbose_bypass_log, :raw_setting
 
   def root=(path)
     @root = path
@@ -75,11 +75,10 @@ class ProconBypassMan::Configuration
 
   def error_logger
     if enable_critical_error_logging
-      @@error_logger ||= Logger.new("#{ProconBypassMan.root}/error.log", 5, 1024 * 1024 * 10)
+      @error_logger ||= Logger.new("#{ProconBypassMan.root}/error.log", 5, 1024 * 1024 * 10)
     else
       Logger.new(File.open("/dev/null"))
     end
-    self
   end
 
   def digest_path
@@ -108,4 +107,8 @@ class ProconBypassMan::Configuration
   def verbose_bypass_log
     @verbose_bypass_log || !!ENV["VERBOSE_BYPASS_LOG"]
   end
+
+  def raw_setting
+    @raw_setting ||= {}
+  end
 end