procon_bypass_man 0.1.19.1 → 0.1.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51f609e2bfb3366e10ae0cf76380ad969416040b73e0a4d0db91f6df783f0264
-  data.tar.gz: ea030a8b78a102b9ef8e6c12fab196b7aab2d2b91519f57e0dc63327ca57f4b1
+  metadata.gz: 1ce5a36623cb9c5ec02d78df78f1c50d8b6f23f54cedf4297bfe76d122def428
+  data.tar.gz: 6d459721f4dcbf4bde02c62e1ffb0aba296a39718e95d7cb5bbbbc6d27c845a3
 SHA512:
-  metadata.gz: 074f5f69ce22021c0a1393883d0a7cc5c20437ba77206968d1041d18ace23938e586b760aa480a4deca8f8e85904cc36d728890affc669e793911575a3fd7f36
-  data.tar.gz: f6240a68720f29e76a214a34015062f6c78ae3bb1c6691d6c3f39e70ae3c3b87823ec50412efb6fe84ad9611f005b3cf82d470bc8b87238c6213af031c5642aa
+  metadata.gz: 3a15285db88ece865db72a73d94f8f5dceff3958bc1fccd6422e5b63441e9c9f6238d080883220b934b14bd5d7a25ce0509cce00ca2995e7385dce90c8297584
+  data.tar.gz: f4cbd2665d0733016eb2311b95578360a6f111f847f32bf79a798b215d0e0a59d914fe743b4fd9c3fdeedb8e2d4fefdd3fc442de4c9c285fad7cf56f6a708b5a

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [0.1.20] - 2022-02-13
+- pbm-cloudから再起動・設定ファイルの適用指示があったときにackイベントを返すようになりました
+- 起動オプションにnever_exit_accidentallyを追加しました。これを有効にすると想定外のエラーが起きたときにプロセスが停止しなくなります。デフォルトで無効です。
+- pbm-cloudから設定ファイルの適用に失敗したときにファイルへの書き込みをしないようになりました
+- まだadd_procon_gadget.shを実行していないときに、接続処理をする前に処理を停止するようにしました
+- ラズパイの複数のUSBデバイスが刺さっていてもプロコンのデバイスを選択できるようにしました
+- Switchからプロコンへ送信するバイパスを動かし続けるようにしました（切断対策）
+
 ## [0.1.19.1] - 2022-02-09
 - 設定ファイルをpbm-cloudから復元するときに設定ファイルの改行コードが消える不具合を修正しました
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    procon_bypass_man (0.1.19.1)
+    procon_bypass_man (0.1.20)
       action_cable_client
       pbmenv
       sorted_set

data/README.md

@@ -7,6 +7,7 @@
     * 設定ファイルはrubyスクリプトで記述します
 * 特定のタイトルに特化した振る舞いにしたい時は各プラグインを使ってください
 * ドキュメントは [getting_started.md](docs/getting_started.md) にまとめています
+* https://pbm-cloud.herokuapp.com を使うと、webだけで運用が可能です
 
 ![image](https://user-images.githubusercontent.com/1664497/123414210-942f6980-d5ee-11eb-8192-955bd9e37e0b.png)
 
@@ -50,17 +51,6 @@ Switch <-- (PBM): ZR連打
 ## Plugins
 * https://github.com/splaplapla/procon_bypass_man-splatoon2
 
-## 関連ソフトウェア
-* procon_bypass_man_cloud
-  * webアプリケーション
-  * https://github.com/splaplapla/procon_bypass_man_cloud
-  * このwebアプリからOS自体の再起動、設定ファイルのバックアップ・変更、PBMのバージョンアップができます
-  * ご自身でホストティングもできますが、 私がホスティングをしている https://pbm-cloud.herokuapp.com を使うことができます
-      * [使い方](https://pbm-cloud.herokuapp.com/faq)
-* pbmenv
-  * procon_bypass_manのバージョンマネージャー
-  * https://github.com/splaplapla/pbmenv
-
 ## FAQ
 * どうやって動かすの?
     * このツールはRaspberry Pi4をUSBガジェットモードで起動して有線でプロコンとSwitchに接続して使います

data/docs/getting_started.md

@@ -4,11 +4,10 @@
     * [procon_bypass_manで解決したいこと](#procon_bypass_manで解決したいこと)
     * [procon_bypass_manでできること](#procon_bypass_manでできること)
 * [セットアップ](#セットアップ)
-  * ラズベリーパイのセットアップ
-  * procon_bypass_manのインストール
-      * pbmenvを使う方法
-      * pbmenvを使わない方法
-  * とりあえず動かす方法
+  * [ラズベリーパイのセットアップ](#ラズベリーパイのセットアップ)
+  * [procon_bypass_manのインストール](#procon_bypass_manのインストール)
+      * [pbmenvを使う方法](#pbmenvを使う方法)
+      * [pbmenvを使わない方法](#pbmenvを使わない方法)
 * [普段使いをするためのセットアップ](#普段使いをするためのセットアップ)
 * レイヤー
 * モード
@@ -18,6 +17,7 @@
   * layer
 * プラグインの書き方
 * 設定ファイルの書き方がわからない、エラーが起きるとき
+* procon_bypass_manのアップグレード方法
 * procon_bypass_man_cloudについて
 
 ## はじめに
@@ -29,6 +29,7 @@
 このツールを使うことで、使い慣れたコントローラーを使ってボタン連射ができます。また、設定内容はテキストで管理しているため一目瞭然です。
 
 ### procon_bypass_manでできること
+
 * 設定内容を即時に入れ替え（レイヤー管理)
 * 連射
   * 連射中は特定のキーの入力を無視したり、複数のキーをトリガーに連射することもできます
@@ -41,8 +42,35 @@
 * ボタンリマップ
 
 ## セットアップ
+### ラズベリーパイのセットアップ
+
 * 後で書きます
 
+### procon_bypass_manのインストール
+
+pbmenvを使うと https://pbm-cloud.herokuapp.com と連携ができるのでおすすめですが、pbmenvを使わなくてもprocon_bypass_manをインストールすることは可能です。
+
+#### pbmenvを使う方法
+
+https://github.com/splaplapla/pbmenv  
+pbmenvはprocon_bypass_manのバージョンマネジャーです。procon_bypass_manはバージョンアップによって起動スクリプトに変更が入ることがあって、バージョンアップするときはpbmenvを使うとエラーが起きることなくインストールができるようになります。また、pbm-cloudと連携してすべての機能を使うには、pbmenvの利用が必須になります。
+
+```
+gem install pbmenv
+sudo pbmenv install latest
+cd /usr/share/pbm/current
+sudo /home/pi/.rbenv/versions/3.0.1/bin/ruby app.rb
+```
+
+#### pbmenvを使わない方法
+
+https://github.com/jiikko/procon_bypass_man_sample にある app.rb と setting.yml を Raspberry Pi にダウンロードし、ruby 3.0.1 をインストールすれば起動することができます。
+
+```
+rbenv install 3.0.1
+sudo /home/pi/.rbenv/versions/3.0.1/bin/ruby app.rb
+```
+
 ## 普段使いをするためのセットアップ
 
 procon_bypass_manを起動するだけでプロコンと接続ができるようになったら、Raspberry Piを起動したときにprocon_bypass_manも自動起動するように設定しましょう。  

data/docs/setting/splatoon2_recommended_setting.md

@@ -1,16 +1,21 @@
 # スプラトゥーン2: おすすめの設定
-## 全般
-### 簡単スニーキング
+## 1 全般
+### 1.1 デスしてから最速スパジャンのためのAボタン連打
+
+`flip :a, if_pressed: [:a]`  
+Aボタンを連打にします。復帰してから最速で前線復帰ができます
+
+### 1.2 簡単スニーキング
 
 ボタンを押している間は、水飛沫のたたないスニーキングの感度まで調整することができます。  
 [設定方法](/docs/setting/left-analogstick-cap.md)
 
-### ナイス玉連打
+### 1.3 ナイス玉連打
 
 `flip :down, if_pressed: :down`  
 十字キーの下ボタンは常に連打にしておくとナイス玉が来たときに楽です。
 
-### マクロでスーパージャンプ
+### 1.4 最速スーパージャンプ
 
 ```
 install_macro_plugin ProconBypassMan::Plugin::Splatoon2::Macro::FastReturn
@@ -18,7 +23,7 @@ install_macro_plugin ProconBypassMan::Plugin::Splatoon2::Macro::JumpToUpKey
 install_macro_plugin ProconBypassMan::Plugin::Splatoon2::Macro::JumpToRightKey
 install_macro_plugin ProconBypassMan::Plugin::Splatoon2::Macro::JumpToLeftKey
 
-layer :up, mode: :manual do
+layer :up do
   macro ProconBypassMan::Plugin::Splatoon2::Macro::FastReturn, if_pressed: [:y, :b, :down]
   macro ProconBypassMan::Plugin::Splatoon2::Macro::JumpToUpKey, if_pressed: [:y, :b, :up]
   macro ProconBypassMan::Plugin::Splatoon2::Macro::JumpToRightKey, if_pressed: [:y, :b, :right]
@@ -26,15 +31,97 @@ layer :up, mode: :manual do
 end
 ```
 
-リスポーンや味方にスーパージャンプするマクロがあります。トリガーは自由に設定できます。
+マップを開かずにジャンプができます。トリガーは自由に設定できます。
 
-## 武器に特化した設定
-### パブロ向け
+## 2 武器に特化した設定
+### 2.1 パブロ向け
 
 `flip :zr, if_pressed: :zr, force_neutral: :zl`  
 zrを連打にします。`force_neutral: :zl` というオプションをつけることで、ZRを押している間はZLを押しても無視されるようになります。パブロでは意味がありませんが、シューターだと煽りのような動作を抑制することができます。
 
-### ボトルガイザー(フォイル)向け
+### 2.2 ボトルガイザー(フォイル)向け
 
 バブル即割のマクロがあります。
 [設定方法](/docs/setting/splatoon2_macro_sokuwari_bubble.md)
+
+## 3 設定例
+### 3.1 シンプルなパブロ向け
+
+* ZRボタン, ZLボタン, Lボタンを同時押しながら十字キーを押すとレイヤーを切り替える
+* ナイス玉が来たときにゲージを貯めるために十字キーの下を連打
+* 復帰から最速ジャンプのためにAボタンを連打
+* 筆を振るためにZRボタンを連打
+* 筆ダッシュをするためにLボタンをZRボタンに変更
+
+```yaml
+version: 1.0
+setting: |-
+  prefix_keys_for_changing_layer [:zr, :zl, :l]
+
+  layer :up do
+    flip :zr, if_pressed: :zr, force_neutral: :zl
+    flip :a, if_pressed: [:a]
+    flip :down, if_pressed: :down
+    remap :l, to: :zr
+  end
+
+  layer :right do
+  end
+
+  layer :left do
+  end
+
+  layer :down do
+  end
+```
+
+### 3.2 全部盛り
+
+* ZRボタン, ZLボタン, Lボタンを同時押しながら十字キーを押すとレイヤーを切り替える
+* ナイス玉が来たときにゲージを貯めるために十字キーの下を連打
+* 筆を振るためにZRボタンを連打
+* 復帰から最速ジャンプのためにAボタンを連打
+* YボタンとBボタンと十字キーの上を同時に押したときに、マップ開いた時の↑に設定されている味方にスーパージャンプ
+* YボタンとBボタンと十字キーの左を同時に押したときに、マップ開いた時の←に設定されている味方にスーパージャンプ
+* YボタンとBボタンと十字キーの右を同時に押したときに、マップ開いた時の→に設定されている味方にスーパージャンプ
+* YボタンとBボタンと十字キーの下を同時に押したときに、リスポーンにスーパージャンプ
+* ZLボタンと十字キーの右ボタンを同時に、バブル即割を発動
+* 筆ダッシュをするためにLボタンをZRボタンに変更
+* ZLボタンとAボタンを同時に押したときに移動するとスニーキング
+
+```yaml
+version: 1.0
+setting: |-
+  install_macro_plugin ProconBypassMan::Plugin::Splatoon2::Macro::FastReturn
+  install_macro_plugin ProconBypassMan::Plugin::Splatoon2::Macro::JumpToUpKey
+  install_macro_plugin ProconBypassMan::Plugin::Splatoon2::Macro::JumpToRightKey
+  install_macro_plugin ProconBypassMan::Plugin::Splatoon2::Macro::JumpToLeftKey
+  install_macro_plugin ProconBypassMan::Plugin::Splatoon2::Macro::SokuwariForSplashBomb
+
+  prefix_keys_for_changing_layer [:zr, :zl, :l]
+  set_neutral_position 2100, 2000
+
+  layer :up do
+    flip :zr, if_pressed: :zr, force_neutral: :zl
+    flip :a, if_pressed: [:a]
+    flip :down, if_pressed: :down
+
+    macro ProconBypassMan::Plugin::Splatoon2::Macro::FastReturn, if_pressed: [:y, :b, :down]
+    macro ProconBypassMan::Plugin::Splatoon2::Macro::JumpToUpKey, if_pressed: [:y, :b, :up]
+    macro ProconBypassMan::Plugin::Splatoon2::Macro::JumpToRightKey, if_pressed: [:y, :b, :right]
+    macro ProconBypassMan::Plugin::Splatoon2::Macro::JumpToLeftKey, if_pressed: [:y, :b, :left]
+    macro ProconBypassMan::Plugin::Splatoon2::Macro::SokuwariForSplashBomb, if_pressed: [:zl, :right]
+
+    remap :l, to: :zr
+    left_analog_stick_cap cap: 1100, if_pressed: [:zl, :a], force_neutral: :a
+  end
+
+  layer :right do
+  end
+
+  layer :left do
+  end
+
+  layer :down do
+  end
+```

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

@@ -0,0 +1,11 @@
+class ProconBypassMan::ReportErrorReloadConfigJob < ProconBypassMan::ReportEventBaseJob
+  extend ProconBypassMan::HasExternalApiSetting
+
+  # @param [String] body
+  def self.perform(body)
+    ProconBypassMan::ReportHttpClient.new(
+      path: path,
+      server_pool: server_pool,
+    ).post(body: body, event_type: :error_reload_config)
+  end
+end

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

@@ -0,0 +1,10 @@
+class ProconBypassMan::ReportStartRebootJob < ProconBypassMan::ReportEventBaseJob
+  extend ProconBypassMan::HasExternalApiSetting
+
+  def self.perform
+    ProconBypassMan::ReportHttpClient.new(
+      path: path,
+      server_pool: server_pool,
+    ).post(body: nil, event_type: :start_reboot)
+  end
+end

data/lib/procon_bypass_man/background.rb

@@ -6,7 +6,9 @@ require "procon_bypass_man/background/job_performer"
 require "procon_bypass_man/background/jobs/base_job"
 require "procon_bypass_man/background/jobs/report_event_base_job"
 require "procon_bypass_man/background/jobs/report_boot_job"
+require "procon_bypass_man/background/jobs/report_start_reboot_job"
 require "procon_bypass_man/background/jobs/report_reload_config_job"
+require "procon_bypass_man/background/jobs/report_error_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_pressed_buttons_job"

data/lib/procon_bypass_man/buttons_setting_configuration/loader.rb

@@ -5,6 +5,8 @@ module ProconBypassMan
 
       # @return [ProconBypassMan::ButtonsSettingConfiguration]
       def self.load(setting_path: )
+        ProconBypassMan::ButtonsSettingConfiguration.instance.setting_path = setting_path
+
         ProconBypassMan::ButtonsSettingConfiguration.switch_new_context(:validation) do |new_instance|
           yaml = YAML.load_file(setting_path) or raise "読み込みに失敗しました"
           new_instance.instance_eval(yaml["setting"])
@@ -12,17 +14,19 @@ module ProconBypassMan
           if validator.valid?
             next
           else
-            raise ProconBypassMan::CouldNotLoadConfigError, validator.errors
+            raise ProconBypassMan::CouldNotLoadConfigError, validator.errors_to_s
           end
         rescue SyntaxError
+          fallback_setting_if_has_backup(current_setting_path: setting_path)
           raise ProconBypassMan::CouldNotLoadConfigError, "Rubyスクリプトのシンタックスエラーです"
         rescue NoMethodError
+          fallback_setting_if_has_backup(current_setting_path: setting_path)
           raise ProconBypassMan::CouldNotLoadConfigError, "Rubyスクリプトに未定義の定数・変数があります"
         rescue Psych::SyntaxError
+          fallback_setting_if_has_backup(current_setting_path: setting_path)
           raise ProconBypassMan::CouldNotLoadConfigError, "yamlのシンタックスエラーです"
         end
 
-        ProconBypassMan::ButtonsSettingConfiguration.instance.setting_path = setting_path
         ProconBypassMan::ButtonsSettingConfiguration.instance.reset!
         ProconBypassMan.reset!
 
@@ -38,12 +42,27 @@ module ProconBypassMan
 
         File.write(ProconBypassMan.digest_path, Digest::MD5.hexdigest(yaml["setting"]))
 
+        if File.exist?(ProconBypassMan.fallback_setting_path)
+          FileUtils.rm_rf(ProconBypassMan.fallback_setting_path)
+        end
+
         ProconBypassMan::ButtonsSettingConfiguration.instance
       end
 
       def self.reload_setting
         self.load(setting_path: ProconBypassMan::ButtonsSettingConfiguration.instance.setting_path)
       end
+
+      def self.fallback_setting_if_has_backup(current_setting_path: )
+        return unless File.exist?(ProconBypassMan.fallback_setting_path)
+        return if current_setting_path.nil?
+
+        FileUtils.copy(
+          ProconBypassMan.fallback_setting_path,
+          current_setting_path,
+        )
+        FileUtils.rm_rf(ProconBypassMan.fallback_setting_path)
+      end
     end
   end
 end

data/lib/procon_bypass_man/buttons_setting_configuration/validator.rb

@@ -32,6 +32,16 @@ module ProconBypassMan
         @errors ||= Hash.new {|h,k| h[k] = [] }
       end
 
+      # @return [Array<String>]
+      def errors_to_s
+        errors.map { |_x, message|
+          value = <<~EOH
+            #{message.map { |m| "layer #{m}" }.join("\n")}
+          EOH
+          value.chomp
+        }.join("\n")
+      end
+
       private
 
       def validate_config_of_button_lonely

data/lib/procon_bypass_man/buttons_setting_configuration.rb

@@ -101,6 +101,8 @@ module ProconBypassMan
     def reset!
       @prefix_keys_for_changing_layer = []
       self.mode_plugins = {}
+      # プロセスを一度起動するとsetting_pathは変わらない、という想定なので適当に扱う. resetでは初期化しない
+      # self.setting_path = nil
       self.macro_plugins = {}
       self.layers = {
         up: Layer.new,

data/lib/procon_bypass_man/bypass.rb

@@ -5,6 +5,7 @@ class ProconBypassMan::Bypass
 
   class BypassValue < Struct.new(:binary, :sent)
     def to_text
+      return unless binary
       "#{binary.unpack.first} #{'x' unless sent}"
     end
   end
@@ -31,16 +32,16 @@ class ProconBypassMan::Bypass
         self.bypass_value.binary = ProconBypassMan::Domains::InboundProconBinary.new(binary: input)
       rescue IO::EAGAINWaitReadable
         monitor.record(:eagain_wait_readable_on_read)
-        sleep(0.001)
-        retry
       end
 
-      begin
-        self.procon.write_nonblock(input)
-        self.bypass_value.sent = true
-      rescue IO::EAGAINWaitReadable
-        monitor.record(:eagain_wait_readable_on_write)
-        break
+      if input
+        begin
+          self.procon.write_nonblock(input)
+          self.bypass_value.sent = true
+        rescue IO::EAGAINWaitReadable
+          monitor.record(:eagain_wait_readable_on_write)
+          break
+        end
       end
     end
 

data/lib/procon_bypass_man/commands/bypass_command.rb

@@ -28,18 +28,11 @@ class ProconBypassMan::BypassCommand
     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
+        sleep(0.02)
       rescue Errno::EIO, Errno::ENODEV, Errno::EPROTO, IOError, Errno::ESHUTDOWN => e
         ProconBypassMan::SendErrorCommand.execute(error: "Switchとの切断されました.終了処理を開始します. #{e.full_message}")
         Process.kill "TERM", Process.ppid
@@ -80,7 +73,7 @@ class ProconBypassMan::BypassCommand
       [t1, t2].each(&:join)
       @gadget&.close
       @procon&.close
-      exit 1
+      exit 1 # child processなのでexitしていい
     end
   end
 end

data/lib/procon_bypass_man/commands/connect_device_command.rb

@@ -1,16 +1,28 @@
 class ProconBypassMan::ConnectDeviceCommand
+  class NotFoundProconError < StandardError; end
+
   # @return [void]
   def self.execute!
-    gadget, procon = ProconBypassMan::DeviceConnector.connect
-  rescue ProconBypassMan::DeviceConnector::NotFoundProconError => e
-    ProconBypassMan.logger.error e
-    gadget&.close
-    procon&.close
-    raise ProconBypassMan::NotFoundProconError
-  rescue ProconBypassMan::SafeTimeout::Timeout
-    ProconBypassMan.logger.error "デバイスとの通信でタイムアウトが起きて接続ができませんでした。"
-    gadget&.close
-    procon&.close
-    raise ::ProconBypassMan::EternalConnectionError
+    unless has_required_files?
+      raise ProconBypassMan::NotFoundRequiredFilesError, "there is not /sys/kernel/config/usb_gadget/procon"
+    end
+
+    begin
+      gadget, procon = ProconBypassMan::DeviceConnector.connect
+    rescue ProconBypassMan::DeviceConnector::NotFoundProconError => e
+      ProconBypassMan.logger.error e
+      gadget&.close
+      procon&.close
+      raise ProconBypassMan::ConnectDeviceCommand::NotFoundProconError
+    rescue ProconBypassMan::SafeTimeout::Timeout
+      ProconBypassMan.logger.error "デバイスとの通信でタイムアウトが起きて接続ができませんでした。"
+      gadget&.close
+      procon&.close
+      raise ProconBypassMan::EternalConnectionError
+    end
+  end
+
+  def self.has_required_files?
+    Dir.exist?("/sys/kernel/config/usb_gadget/procon")
   end
 end

data/lib/procon_bypass_man/configuration.rb

@@ -38,10 +38,19 @@ class ProconBypassMan::Configuration
     def device_id
       ENV["DEBUG_DEVICE_ID"] || ProconBypassMan::WriteDeviceIdCommand.execute
     end
+
+    # @return [Boolean]
+    def never_exit_accidentally
+      config.never_exit_accidentally
+    end
+
+    def fallback_setting_path
+      "/tmp/procon_bypass_man_fallback_setting.yaml"
+    end
   end
 
   attr_accessor :enable_critical_error_logging
-  attr_writer :verbose_bypass_log, :raw_setting, :enable_reporting_pressed_buttons
+  attr_writer :verbose_bypass_log, :raw_setting, :enable_reporting_pressed_buttons, :never_exit_accidentally
 
   def root=(path)
     @root = path
@@ -158,4 +167,9 @@ class ProconBypassMan::Configuration
   def enable_reporting_pressed_buttons
     @enable_reporting_pressed_buttons ||= false
   end
+
+  # @return [Boolean]
+  def never_exit_accidentally
+    @never_exit_accidentally || false
+  end
 end

data/lib/procon_bypass_man/device_connector.rb

@@ -263,46 +263,19 @@ class ProconBypassMan::DeviceConnector
     @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(64)
-    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+b")
-      @gadget = File.open('/dev/hidg0', "w+b")
-    when is_available_device?(PROCON2_PATH)
-      ProconBypassMan.logger.info "proconのデバイスファイルは#{PROCON2_PATH}を使います"
-      @procon = File.open(PROCON2_PATH, "w+b")
-      @gadget = File.open('/dev/hidg0', "w+b")
+    if path = ProconBypassMan::DeviceProconFinder.find
+      @procon = File.open(path, "w+b")
+      ProconBypassMan.logger.info "proconのデバイスファイルは#{path}を使います"
     else
-      raise NotFoundProconError, "/dev/hidraw0, /dev/hidraw1の両方見つかりませんでした"
+      raise(ProconBypassMan::DeviceConnector::NotFoundProconError)
     end
+    @gadget = File.open('/dev/hidg0', "w+b")
+
     system('echo > /sys/kernel/config/usb_gadget/procon/UDC')
     system('ls /sys/class/udc > /sys/kernel/config/usb_gadget/procon/UDC')
     sleep 0.5

data/lib/procon_bypass_man/device_procon_finder.rb

@@ -0,0 +1,65 @@
+class ProconBypassMan::DeviceProconFinder
+  HID_NAME = "Nintendo Co., Ltd. Pro Controller"
+
+  def self.find
+    new.find
+  end
+
+  # @return [String, NilClass]
+  def find
+    find_device_path
+  end
+
+  private
+
+  # @return [String , NilClass]
+  def find_device_path
+    if(line = device_from_shell) && (hidraw_name = line.match(/(hidraw\d+)\s+/)[1])
+      "/dev/#{hidraw_name}"
+    end
+  end
+
+  # @return [String , NilClass]
+  def device_from_shell
+    shell_output.split("\n").detect { |o| o.include?(HID_NAME) }
+  end
+
+  # @return [String]
+  def shell_output
+    `bash -c '#{get_list_shell}'`
+  end
+
+  def get_list_shell
+    <<~SHELL
+      #!/bin/bash
+
+      FILES=/dev/hidraw*
+      for f in $FILES
+      do
+        FILE=${f##*/}
+        DEVICE="$(cat /sys/class/hidraw/${FILE}/device/uevent | grep HID_NAME | cut -d '=' -f2)"
+        printf "%s   %s\n" $FILE "$DEVICE"
+      done
+    SHELL
+  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(64)
+    rescue EOFError
+      file.close
+      return false
+    rescue IO::EAGAINWaitReadable
+      file.close
+      return true
+    end
+  end
+end

data/lib/procon_bypass_man/never_exit_accidentally.rb

@@ -0,0 +1,12 @@
+module ProconBypassMan
+  module NeverExitAccidentally
+    def exit_if_allow(status)
+      if ProconBypassMan.never_exit_accidentally
+        eternal_sleep
+      else
+        yield if block_given?
+        exit(status)
+      end
+    end
+  end
+end

data/lib/procon_bypass_man/remote_pbm_action/reboot_os_action.rb

@@ -10,6 +10,7 @@ module ProconBypassMan
       private
 
       def before_action_callback
+        ProconBypassMan::ReportStartRebootJob.perform
         be_processed
       end
 

data/lib/procon_bypass_man/remote_pbm_action/restore_pbm_setting.rb

@@ -6,6 +6,13 @@ module ProconBypassMan
         require "pbmenv"
         ProconBypassMan.logger.info "execute RestorePbmSettingAction!"
         setting = args.dig("setting") or raise(ProconBypassMan::RemotePbmAction::NeedPbmVersionError, "settingが必要です, #{args.inspect}")
+
+        # 復元に失敗したら戻せるように退避する
+        FileUtils.copy(
+          ProconBypassMan::ButtonsSettingConfiguration.instance.setting_path,
+          ProconBypassMan.fallback_setting_path,
+        )
+
         ProconBypassMan::YamlWriter.write(
           path: ProconBypassMan::ButtonsSettingConfiguration.instance.setting_path,
           content: setting,

data/lib/procon_bypass_man/runner.rb

@@ -27,7 +27,7 @@ class ProconBypassMan::Runner
     loop do
       $will_terminate_token = false
       # NOTE メインプロセスではThreadをいくつか起動しているので念のためパフォーマンスを優先するためにforkしていく
-      main_loop_pid = Kernel.fork { ProconBypassMan::BypassCommand.new(gadget: @gadget, procon: @procon).execute }
+      child_pid = Kernel.fork { ProconBypassMan::BypassCommand.new(gadget: @gadget, procon: @procon).execute }
 
       begin
         # TODO 小プロセスが消滅した時に、メインプロセスは生き続けてしまい、何もできなくなる問題がある
@@ -37,25 +37,25 @@ class ProconBypassMan::Runner
         end
       rescue InterruptForRestart
         $will_terminate_token = true
-        Process.kill("TERM", main_loop_pid)
+        Process.kill("TERM", child_pid)
         Process.wait
         ProconBypassMan::PrintMessageCommand.execute(text: "Reloading config file")
         begin
           ProconBypassMan::ButtonsSettingConfiguration::Loader.reload_setting
           ProconBypassMan::SendReloadConfigEventCommand.execute
-        rescue ProconBypassMan::CouldNotLoadConfigError
+        rescue ProconBypassMan::CouldNotLoadConfigError => error
           ProconBypassMan::SendErrorCommand.execute(error: "設定ファイルが不正です。再読み込みができませんでした")
+          ProconBypassMan::ReportErrorReloadConfigJob.perform_async(error.message)
         end
         ProconBypassMan::PrintMessageCommand.execute(text: "バイパス処理を再開します")
       rescue Interrupt
         $will_terminate_token = true
-        Process.kill("TERM", main_loop_pid)
+        Process.kill("TERM", child_pid)
         Process.wait
+        ProconBypassMan::PrintMessageCommand.execute(text: "処理を終了します")
         @gadget&.close
         @procon&.close
-        FileUtils.rm_rf(ProconBypassMan.pid_path)
-        FileUtils.rm_rf(ProconBypassMan.digest_path)
-        exit 1
+        break
       end
     end
   end

data/lib/procon_bypass_man/version.rb

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

data/lib/procon_bypass_man.rb

@@ -27,7 +27,9 @@ require_relative "procon_bypass_man/background"
 require_relative "procon_bypass_man/commands"
 require_relative "procon_bypass_man/bypass"
 require_relative "procon_bypass_man/domains"
+require_relative "procon_bypass_man/never_exit_accidentally"
 require_relative "procon_bypass_man/device_connector"
+require_relative "procon_bypass_man/device_procon_finder"
 require_relative "procon_bypass_man/device_status"
 require_relative "procon_bypass_man/runner"
 require_relative "procon_bypass_man/processor"
@@ -48,10 +50,11 @@ Thread.abort_on_exception = true
 
 module ProconBypassMan
   extend ProconBypassMan::Configuration::ClassMethods
+  extend ProconBypassMan::NeverExitAccidentally
 
   class CouldNotLoadConfigError < StandardError; end
-  class NotFoundProconError < StandardError; end
   class ConnectionError < StandardError; end
+  class NotFoundRequiredFilesError < StandardError; end
   class FirstConnectionError < ConnectionError; end
   class EternalConnectionError < ConnectionError; end
 
@@ -62,22 +65,31 @@ module ProconBypassMan
     ProconBypassMan::Websocket::PbmJobClient.start!
 
     ProconBypassMan::PrintMessageCommand.execute(text: "PBMを起動しています")
-    ProconBypassMan::ButtonsSettingConfiguration::Loader.load(setting_path: setting_path)
     initialize_pbm
+    ProconBypassMan::ButtonsSettingConfiguration::Loader.load(setting_path: setting_path)
     gadget, procon = ProconBypassMan::ConnectDeviceCommand.execute!
-    Runner.new(gadget: gadget, procon: procon).run
-  rescue ProconBypassMan::CouldNotLoadConfigError
-    ProconBypassMan::SendErrorCommand.execute(error: "設定ファイルが不正です。設定ファイルの読み込みに失敗しました")
-    ProconBypassMan::DeviceStatus.change_to_setting_syntax_error_and_shutdown!
+    Runner.new(gadget: gadget, procon: procon).run # ここでblockingする
     FileUtils.rm_rf(ProconBypassMan.pid_path)
     FileUtils.rm_rf(ProconBypassMan.digest_path)
-    exit 1
-  rescue ProconBypassMan::NotFoundProconError
-    ProconBypassMan::SendErrorCommand.execute(error: "プロコンが見つかりませんでした。終了します。")
-    ProconBypassMan::DeviceStatus.change_to_procon_not_found_error!
+  rescue ProconBypassMan::NotFoundRequiredFilesError
+    ProconBypassMan::SendErrorCommand.execute(error: "/sys/kernel/config/usb_gadget/proconディレクトリがありませんでした。処理を終了します。")
     FileUtils.rm_rf(ProconBypassMan.pid_path)
     FileUtils.rm_rf(ProconBypassMan.digest_path)
-    exit 1
+    exit 1 # 前提条件を満たしていないので絶対に落とす
+  rescue ProconBypassMan::CouldNotLoadConfigError
+    ProconBypassMan::SendErrorCommand.execute(error: "設定ファイルが不正です。設定ファイルの読み込みに失敗しました")
+    ProconBypassMan::DeviceStatus.change_to_setting_syntax_error_and_shutdown!
+    ProconBypassMan.exit_if_allow(1) do
+      FileUtils.rm_rf(ProconBypassMan.pid_path)
+      FileUtils.rm_rf(ProconBypassMan.digest_path)
+    end
+  rescue ProconBypassMan::ConnectDeviceCommand::NotFoundProconError
+    ProconBypassMan::SendErrorCommand.execute(error: "プロコンが見つかりませんでした。")
+    ProconBypassMan::DeviceStatus.change_to_procon_not_found_error!
+    ProconBypassMan.exit_if_allow(1) do
+      FileUtils.rm_rf(ProconBypassMan.pid_path)
+      FileUtils.rm_rf(ProconBypassMan.digest_path)
+    end
   rescue ProconBypassMan::ConnectionError
     begin
       raise

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.19.1'
+  gem 'procon_bypass_man', '0.1.20'
 end
 
 ProconBypassMan.configure do |config|
@@ -15,6 +15,8 @@ ProconBypassMan.configure do |config|
   # webからProconBypassManを操作できるwebサービス
   # config.api_servers = ['https://pbm-cloud.herokuapp.com']
   config.enable_critical_error_logging = true
+  # pbm-cloudで使う場合はnever_exitにtrueをセットしてください. trueがセットされている場合、不慮の事故が発生してもプロセスが終了しなくなります
+  config.never_exit_accidentally = true
 end
 
 ProconBypassMan.run(setting_path: "/usr/share/pbm/current/setting.yml")

data/project_template/setting.yml

@@ -1,28 +1,19 @@
 version: 1.0
 setting: |-
-  install_macro_plugin ProconBypassMan::Plugin::Splatoon2::Macro::FastReturn
-  install_macro_plugin ProconBypassMan::Plugin::Splatoon2::Macro::JumpToUpKey
-  install_macro_plugin ProconBypassMan::Plugin::Splatoon2::Macro::JumpToRightKey
-  install_macro_plugin ProconBypassMan::Plugin::Splatoon2::Macro::JumpToLeftKey
-  install_mode_plugin ProconBypassMan::Plugin::Splatoon2::Mode::Guruguru
-
   prefix_keys_for_changing_layer [:zr, :zl, :l]
 
-  layer :up, mode: :manual do
+  layer :up do
     flip :zr, if_pressed: :zr, force_neutral: :zl
-    flip :zl, if_pressed: [:y, :b, :zl]
     flip :a, if_pressed: [:a]
     flip :down, if_pressed: :down
-    macro ProconBypassMan::Plugin::Splatoon2::Macro::FastReturn, if_pressed: [:y, :b, :down]
-    macro ProconBypassMan::Plugin::Splatoon2::Macro::JumpToUpKey, if_pressed: [:y, :b, :up]
-    macro ProconBypassMan::Plugin::Splatoon2::Macro::JumpToRightKey, if_pressed: [:y, :b, :right]
-    macro ProconBypassMan::Plugin::Splatoon2::Macro::JumpToLeftKey, if_pressed: [:y, :b, :left]
     remap :l, to: :zr
   end
-  layer :right, mode: ProconBypassMan::Plugin::Splatoon2::Mode::Guruguru
+
+  layer :right do
+  end
+
   layer :left do
-    remap :l, to: :zr
   end
+
   layer :down do
-    remap :l, to: :zr
   end

data/sig/main.rbs

@@ -185,10 +185,13 @@ class ProconBypassMan::Configuration
     def cache: () -> ProconBypassMan::OnMemoryCache
 
     def config: () -> ProconBypassMan::Configuration
+
+    def never_exit_accidentally: () -> bool
   end
 
   attr_reader api_server: untyped
   attr_reader api_servers: untyped
+  attr_writer never_exit_accidentally: bool
 
   attr_accessor enable_critical_error_logging: bool
 
@@ -226,6 +229,8 @@ class ProconBypassMan::Configuration
   def raw_setting: () -> untyped
 
   def verbose_bypass_log: () -> bool
+
+  def never_exit_accidentally: () -> bool
 end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: procon_bypass_man
 version: !ruby/object:Gem::Version
-  version: 0.1.19.1
+  version: 0.1.20
 platform: ruby
 authors:
 - jiikko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-02-09 00:00:00.000000000 Z
+date: 2022-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pbmenv
@@ -97,10 +97,12 @@ files:
 - lib/procon_bypass_man/background/jobs/concerns/job_runnable.rb
 - lib/procon_bypass_man/background/jobs/report_boot_job.rb
 - lib/procon_bypass_man/background/jobs/report_error_job.rb
+- lib/procon_bypass_man/background/jobs/report_error_reload_config_job.rb
 - lib/procon_bypass_man/background/jobs/report_event_base_job.rb
 - lib/procon_bypass_man/background/jobs/report_load_config_job.rb
 - lib/procon_bypass_man/background/jobs/report_pressed_buttons_job.rb
 - lib/procon_bypass_man/background/jobs/report_reload_config_job.rb
+- lib/procon_bypass_man/background/jobs/report_start_reboot_job.rb
 - lib/procon_bypass_man/background/jobs/sync_device_stats_job.rb
 - lib/procon_bypass_man/buttons_setting_configuration.rb
 - lib/procon_bypass_man/buttons_setting_configuration/layer.rb
@@ -120,6 +122,7 @@ files:
 - lib/procon_bypass_man/commands/write_session_id_command.rb
 - lib/procon_bypass_man/configuration.rb
 - lib/procon_bypass_man/device_connector.rb
+- lib/procon_bypass_man/device_procon_finder.rb
 - lib/procon_bypass_man/device_status.rb
 - lib/procon_bypass_man/domains.rb
 - lib/procon_bypass_man/domains/binary/base.rb
@@ -128,6 +131,7 @@ files:
 - lib/procon_bypass_man/domains/binary/inbound_procon_binary.rb
 - lib/procon_bypass_man/domains/binary/processing_procon_binary.rb
 - lib/procon_bypass_man/io_monitor.rb
+- lib/procon_bypass_man/never_exit_accidentally.rb
 - lib/procon_bypass_man/plugin/splatoon2/macro/fast_return.rb
 - lib/procon_bypass_man/plugin/splatoon2/macro/jump_to_left_key.rb
 - lib/procon_bypass_man/plugin/splatoon2/macro/jump_to_right_key.rb