procon_bypass_man 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b867d9fe101999d57ded64ff71be83610f04fde36c1c1fffa43ca8495902fb0b
-  data.tar.gz: 8eb0b7506c7bdb5d4601fb0e6f33cff79cb71a4975449d0c84bcd6a2c0b6303a
+  metadata.gz: 556a827cf03895e4212aa4c524963ca7efd24499c2ea14edff2d692bc3e1e63f
+  data.tar.gz: bf7cf5a735fffa13e1ff99c259a329a4c6981be755440477884ece0246188f21
 SHA512:
-  metadata.gz: a37867fc758ecb8aa45698fbb79be8b48cc221cd218bf6c29646b04587ae66514846709cd1bf951a651ec1ba737cab5dbae010334cb125bc8dca1644d19aa30e
-  data.tar.gz: d2cf7935350a3085251deb495051586b52b422d388bfd07da7842c09fbc3f50fa0b6090a41652e662d15e367863c76e0b3a2e9e061e87a7e100f3d1e7d9be58e
+  metadata.gz: 7bdfd9d2c5bee033c8f6a1f87acebcf3374e353c0ea4d373c76f86ee33b87b248665b087276998f20dee9f0d1258ab2c7c49906cc55b94b51a5e35d84712da5c
+  data.tar.gz: 176ac515a48935df2953c36fb747e09be71c31f7850b09397e338bc0685b5da25bcd7ff81795d235287f2a5870fcdec3fec5aa9334e12ba90ca26662fe8807e7

data/.circleci/config.yml

@@ -15,7 +15,7 @@ executors:
       BUNDLE_JOBS: 4
     working_directory: ~/app
 
-commands: &commands
+commands:
   bundle_install:
     parameters:
       ruby-version:
@@ -55,6 +55,14 @@ jobs:
       - run: ruby -cw project_template/web.rb
       - run: ruby -ryaml -e 'puts YAML.load_file("./project_template/setting.yml")["setting"]' > /tmp/content_of_setting.rb && ruby -cw /tmp/content_of_setting.rb
 
+  outdated_app_checker:
+    executor:
+      name: ruby
+      tag: 3.0.1
+    steps:
+      - checkout
+      - run: ruby bin/generate_default_app  && git diff --exit-code project_template/app.rb
+
   bundle_install:
     parameters:
       ruby-version:
@@ -101,27 +109,31 @@ jobs:
 
 build_jobs: &build_jobs
   - check_pbm_version
+  - outdated_app_checker
   - syntax_check:
       matrix:
         parameters:
           ruby-version:
+            - "2.5.5"
             - "3.0.1"
             - "3.0.2"
-            - "3.1.1"
+            - "3.1.2"
   - bundle_install:
       matrix:
         parameters:
           ruby-version:
+            - "2.5.5"
             - "3.0.1"
             - "3.0.2"
-            - "3.1.1"
+            - "3.1.2"
   - lint:
       matrix:
         parameters:
           ruby-version:
+            - "2.5.5"
             - "3.0.1"
             - "3.0.2"
-            - "3.1.1"
+            - "3.1.2"
       requires:
         - bundle_install
   - type_check:
@@ -130,16 +142,17 @@ build_jobs: &build_jobs
           ruby-version:
             # - "3.0.1" # たまにSEGVするので
             - "3.0.2"
-            - "3.1.1"
+            - "3.1.2"
       requires:
         - bundle_install
   - rspec:
       matrix:
         parameters:
           ruby-version:
+            - "2.5.5"
             - "3.0.1"
             - "3.0.2"
-            - "3.1.1"
+            - "3.1.2"
       requires:
         - bundle_install
 workflows:

data/.github/workflows/gitleacks.yml

@@ -9,4 +9,4 @@ jobs:
     steps:
     - uses: actions/checkout@v1
     - name: gitleaks-action
-      uses: zricethezav/gitleaks-action@master
+      uses: zricethezav/gitleaks-action@v1.6.0

data/.rubocop.yml

@@ -26,3 +26,7 @@ Lint/ReturnInVoidContext:
     Enabled: false
 Lint/AssignmentInCondition:
     Enabled: false
+Lint/AmbiguousBlockAssociation:
+    Enabled: false
+Security/Eval:
+    Enabled: false

data/.ruby-version

@@ -1 +1 @@
-3.0.2
+3.1.2

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## [0.3.0] - 2022-9-9
+* 表示入力機能を一時的に削除しました #185
+* バイパス処理中の小さなラグがほぼなくなりました #185
+    * バイパス処理をマルチプロセスで行うようにしたのでGCによる停止時間がほぼなくなったため
+
+## [0.2.3] - 2022-8-27
+* プロコンのラグ具合をpbm-cloudに送信し、グラフで見れるようになりました #158
+* 非同期ジョブをmasterプロセス経由で実行するようになりました #191
+* バイパス処理が数秒間固まる現象がおそらく直りました #179
+
+## [0.2.2] - 2022-07-10
+* project_template/app.rbを動的に生成する仕組みを追加しました
+* ドキュメントからpbm_webに関する記述を削除しました
+* 起動スクリプト(app.rb) がたまに意図せず /usr/share/pbm/current を削除してしまう不具合を修正しました
+
 ## [0.2.1] - 2022-05-29
 - 入力表示機能を提供するSwitchProconInputViewerに対応しました
   - https://github.com/splaplapla/switch-procon-input-viewer

data/Gemfile

@@ -10,8 +10,11 @@ gem "rspec"
 gem "pry"
 gem "timecop"
 gem "rubocop", require: false
-gem "steep", require: false
-gem 'typeprof', require: false
-gem 'rbs', require: false
 gem "sinatra", require: false
 gem "webrick", require: false
+
+if Gem::Version.new(RUBY_VERSION) > Gem::Version.new("2.6.0")
+  gem 'typeprof', require: false
+  gem 'rbs', require: false
+  gem "steep", require: false
+end

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    procon_bypass_man (0.2.1)
+    procon_bypass_man (0.3.0)
       action_cable_client
+      blue_green_process
       pbmenv (>= 0.1.9)
       sorted_set
 
@@ -18,6 +19,7 @@ GEM
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
     ast (2.4.2)
+    blue_green_process (0.1.3)
     coderay (1.1.3)
     concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
@@ -36,7 +38,7 @@ GEM
     parallel (1.21.0)
     parser (3.0.3.2)
       ast (~> 2.4.1)
-    pbmenv (0.1.9)
+    pbmenv (0.1.10)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -78,7 +80,7 @@ GEM
       parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
-    set (1.0.2)
+    set (1.0.3)
     sinatra (2.2.0)
       mustermann (~> 1.0)
       rack (~> 2.2)

data/README.md

@@ -3,55 +3,26 @@
 
 [![Ruby](https://github.com/splaplapla/procon_bypass_man/actions/workflows/ruby.yml/badge.svg?branch=master)](https://github.com/splaplapla/procon_bypass_man/actions/workflows/ruby.yml)
 
-* Switchに繋いだプロコンを連射機にしたり、ボタンのリマップをしたり、マクロを実行できる、Raspberry Pi上で動かすツールです
-    * 設定ファイルはrubyスクリプトで記述します
-* 特定のタイトルに特化した振る舞いにしたい時は各プラグインを使ってください
+* Nintendo Switch Proコントローラーを連射機などにするRaspberry Pi上で動かすコンバータです
 * ドキュメントは [getting_started.md](docs/getting_started.md) にまとめています
 * https://pbm-cloud.herokuapp.com を使うと、webだけで運用が可能です
 
 
 <img width="880" alt="スクリーンショット 2022-04-02 9 10 38" src="https://user-images.githubusercontent.com/1664497/161356057-71e4bc2a-0217-4434-9bf1-0002b9fb261a.png">
 
-
-
-<!--
-![image](https://user-images.githubusercontent.com/1664497/123414210-942f6980-d5ee-11eb-8192-955bd9e37e0b.png)
-```
-@startuml
-ProController \-\-> (PBM): ZR押しっぱなし
-Switch <-- (PBM): ZR連打
-@enduml
-```
--->
+https://user-images.githubusercontent.com/1664497/171327108-f12f56a5-fc36-48da-95a5-65e976553a20.mov
 
 ## 使うハードウェア
-* プロコン
+* Nintendo Switch Proコントローラー
 * Switch本体とドック
-* Raspberry Pi4 Model B/4GB(Raspberry Pi OS (32-bit))
+* Raspberry Pi4 (Raspberry Pi OS)
     * 他のシリーズは未確認です
-        * zeroは非対応
 * データ通信が可能なUSBケーブル
 
 ## 使うソフトウェア
-* ruby-3.0.x
-
-## Usage
-* USBガジェットモードで起動するRaspberry Pi4を用意する
-  * https://github.com/splaplapla/procon_bypass_man/blob/master/docs/setup_raspi.md
-* Raspberry Pi4 でprocon_bypass_manを実行するための準備
-  * rubyのインストール
-    * sudo apt-get install rbenv
-    * git clone https://github.com/rbenv/ruby-build.git "$(rbenv root)"/plugins/ruby-build
-    * rbenv install 3.0.1
-  * gem install pbmenv
-  * sudo [pbmenv](https://github.com/splaplapla/pbmenv) install latest
-* Raspberry Pi4 でprocon_bypass_manを実行する
-  * cd /usr/share/pbm/current
-  * sudo /home/pi/.rbenv/versions/3.0.1/bin/ruby app.rb
-  * 動いたのを確認したらserviceとして登録にするなどしてください
-    * [serviceとして登録する方法](https://github.com/splaplapla/procon_bypass_man/tree/master/project_template#systemd%E3%82%92%E4%BD%BF%E3%81%A3%E3%81%A6%E3%82%B5%E3%83%BC%E3%83%93%E3%82%B9%E3%81%AB%E7%99%BB%E9%8C%B2%E3%81%99%E3%82%8B%E6%96%B9%E6%B3%95)
-
-## Plugins
+* ruby 2.5 以上
+
+## プラグイン
 * https://github.com/splaplapla/procon_bypass_man-splatoon2
 
 ## FAQ
@@ -61,9 +32,6 @@ Switch <-- (PBM): ZR連打
     * ケーブルでそれらを接続した状態で、Raspberry Pi4にsshして本プログラムを起動することで使用します
 * ラズベリーパイ4のセットアップ方法は？
     * https://github.com/splaplapla/procon_bypass_man/tree/master/docs/setup_raspi.md
-* モード, マクロの違いは？
-    * modeはProconの入力をそのまま再現するため機能。レイヤーを切り替えるまで繰り返し続けます
-    * マクロは特定のキーを順番に入れていく機能。キーの入力が終わったらマクロは終了します
 * レイヤーとは？
     * 自作キーボードみたいな感じでレイヤー毎に設定内容を記述して切り替えれます
     * レイヤーは4つあって、up, down, left, rightです。十字キーに対応しています
@@ -80,6 +48,13 @@ Switch <-- (PBM): ZR連打
 * sshなしで運用は可能ですか？
     * https://pbm-cloud.herokuapp.com を使えば、sshを使わずに運用が可能です
 
+## 仕様・制約
+* 日を跨ぐ24時ちょうどになった瞬間はLinuxのcronが起動などがするようで、この時間は数秒間バイパスが激しく遅延します
+  * ログファイルのローテションが少なくとも走るはずなので、不要なデーモンを停止するなどで影響を小さくすることはできると思いますが、完全に抑制することは難しいと思います
+* コントローラーから読み取ってSwitchに書き込む時間は、少なくとも0.02秒はかかります
+  * 動かしているRaspberry Piの負荷に依存するこの限りではありません
+
+<!--
 ## TODO
 * レコーディング機能(プロコンの入力をマクロとして登録ができる)
 * ドキュメントを書く(doing)
@@ -103,11 +78,23 @@ sudo kill -USR2 `cat ./pbm_pid`
 * CHANGELOG.md に日付を書く
 * be rake release
 * githubのreleaseを作成する
+-->
 
-## License
+## Raspberry Pi4のセットアップを代行します
+* Raspberry Pi4を開発者である私の家に配送してくれれば、セットアップを代行します。セットアップが終わり次第送り返します
+* 使い方に関しては、https://pbm-cloud.herokuapp.com ですべて完結するので、Linuxの知識は不要です
+* 何か問題が起きた時はリモートログインでサポート可能です
+* 希望者はDiscordの `kawagu#7684` にDMを送ってください
+* お金はかかりません
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+## 開発を支援してくれる人を募集しています
+* https://jiikko.fanbox.cc/
+* procon_bypassの運営・開発・サーバー費用に充てさせていただきます。また、問い合わせに優先して対応します。
 
 ## Links
 * https://discord.gg/bEcRNKf4ep
   * 質問などご意見をdiscordでも受け付けています
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Steepfile

@@ -38,7 +38,6 @@ target :lib do
   check 'lib/procon_bypass_man/support/http_client'
   check 'lib/procon_bypass_man/support/send_device_stats_http_client'
   check 'lib/procon_bypass_man/support/on_memory_cache'
-  check 'lib/procon_bypass_man/support/server_pool'
   check 'lib/procon_bypass_man/support/uptime.rb'
   check 'lib/procon_bypass_man/support/safe_timeout'
   check 'lib/procon_bypass_man/support/update_remote_pbm_action_status_http_client'

data/bin/generate_default_app

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "./project_template/lib/app_generator"
+
+AppGenerator.new(
+  prefix_path: "./project_template",
+  enable_integration_with_pbm_cloud: false,
+).generate
+
+puts "Created project_template/app.rb"

data/docs/getting_started.md

@@ -3,6 +3,7 @@
 * [はじめに](#はじめに)
     * [procon_bypass_manで解決したいこと](#procon_bypass_manで解決したいこと)
     * [procon_bypass_manでできること](#procon_bypass_manでできること)
+* [セットアップを代行できます](#セットアップを代行できます)
 * [セットアップ](#セットアップ)
   * [ラズベリーパイのセットアップ](#ラズベリーパイのセットアップ)
   * [procon_bypass_manのインストール](#procon_bypass_manのインストール)
@@ -10,23 +11,26 @@
       * [pbmenvを使わない方法](#pbmenvを使わない方法)
 * [普段使いをするためのセットアップ](#普段使いをするためのセットアップ)
 * [レイヤー](#レイヤー)
-* モード
 * [マクロ](#マクロ)
 * [左スティックの感度調整](#左スティックの感度調整)
 * [入力表示](#入力表示)
-* 設定ファイルの書き方
+* [設定ファイルの書き方](#設定ファイルの書き方)
 * プラグインの書き方
 * [設定ファイルの書き方がわからない、エラーが起きるとき](#設定ファイルの書き方がわからない、エラーが起きるとき)
 * [procon_bypass_manのアップグレード方法](#procon_bypass_manのアップグレード方法)
 * [procon_bypass_man_cloudについて](#procon_bypass_man_cloudについて)
+* [最適化について](#最適化について)
 
 ## はじめに
 ### procon_bypass_manで解決したいこと
 
-通常、ボタン連射をするには、市販されているサードパーティー製のコントローラーを使う必要があるのですが、ボタンの押した感覚や各種設定方法は各社の独自仕様であるため、それらを手に馴染ませるのがとても大変です。  
-特に「説明書を熟読してコントローラーの設定方法を覚えること、設定されている状態を思い出す」がつらい。
-
-このツールを使うことで、使い慣れたコントローラーを使ってボタン連射ができます。また、設定内容はテキストで管理しているため一目瞭然です。
+サードパーティー製のコントローラーは頑丈で使いやすいですか？  
+  
+通常、ボタンの連射をするには、サードパーティー製のコントローラーを使う必要があるのですが、ボタンの押した感覚や各種設定方法は各社の独自仕様であるため、それらを手に馴染ませるのがとても大変です。  
+特に「説明書を熟読して、コントローラーの設定方法を理解し適用すること、時間が空いてから設定されている状態を思い出す」がつらいと思っています。  
+また、サードパーティー製のコントローラーは非常に壊れやすく、同じ製品が再び購入できるとは限りません。
+  
+本ツールを使うと、使い慣れた純正コントローラーを使って、サードパーティー製のコントローラー以上のことができます。設定内容はテキストで管理しているため一目瞭然です。設定内容のコピーも容易です。
 
 ### procon_bypass_manでできること
 
@@ -35,13 +39,19 @@
   * 連射中は特定のキーの入力を無視したり、複数のキーをトリガーに連射することもできます
 * マクロ
   * [活用例](/docs/setting/splatoon2_macro_sokuwari_bubble.md)
-* 特定の同じ操作の繰り返し(モード)
 * 左スティックの感度調整
   * [設定方法](/docs/setting/left-analogstick-cap.md)
 * WEBから設定状態の閲覧・反映
 * ボタンリマップ
 * 入力表示
-　　* https://github.com/splaplapla/switch-procon-input-viewer
+  * https://github.com/splaplapla/switch-procon-input-viewer
+
+## セットアップを代行できます
+* Raspberry Pi4を開発者である私の家に配送してくれれば、セットアップを代行します。セットアップが終わり次第送り返します
+* 使い方に関しては、https://pbm-cloud.herokuapp.com ですべて完結するので、Linuxの知識は不要です
+* 何か問題が起きた時はリモートログインでサポート可能です
+* 希望者はDiscordの `kawagu#7684` にDMを送ってください
+* お金はかかりません
 
 ## セットアップ
 ### ラズベリーパイのセットアップ
@@ -50,26 +60,66 @@
 
 ### procon_bypass_manのインストール
 
-pbmenvを使うと https://pbm-cloud.herokuapp.com と連携ができるのでおすすめですが、pbmenvを使わなくてもprocon_bypass_manをインストールすることは可能です。
+pbmenvを使うと https://pbm-cloud.herokuapp.com と連携ができるのでおすすめですが、pbmenvを使わなくてもprocon_bypass_manをインストールすることは可能です。  
+次の4つからインストール方法を1つ選んでください。
+
+* pbmenvを使う方法
+  * systemにインストールされているrubyを使う場合(初心者におすすめ)
+  * rbenvでインストールしたrubyを使う場合
+* pbmenvを使わない方法
+  * systemにインストールされているrubyを使う場合(初心者におすすめ)
+  * rbenvでインストールしたrubyを使う場合
 
-#### pbmenvを使う方法
+ちなみに、rbenvを使った方がラグは少ないような気がしますが、明確な体験の違いはそこまでないように思います。
+
+#### 1) pbmenvを使う方法
 
 https://github.com/splaplapla/pbmenv  
-pbmenvはprocon_bypass_manのバージョンマネジャーです。procon_bypass_manはバージョンアップによって起動スクリプトに変更が入ることがあって、バージョンアップするときはpbmenvを使うとエラーが起きることなくインストールができるようになります。また、pbm-cloudと連携してすべての機能を使うには、pbmenvの利用が必須になります。
+pbmenvはprocon_bypass_manのバージョンマネジャーです。  
+procon_bypass_manはバージョンアップによって起動スクリプトに変更が入ることがあって、バージョンアップするときはpbmenvを使うとエラーが起きることなくインストールができるようになります。また、pbm-cloudと連携してすべての機能を使うには、pbmenvの利用が必須になります。
+
+##### 1-1) systemにインストールされているrubyを使う場合(初心者におすすめ)
 
+```bash
+sudo apt-get install ruby ruby-dev
+sudo gem i bundler pbmenv
+sudo pbmenv install latest --use
+cd /usr/share/pbm/current
+sudo ruby app.rb
 ```
-gem install pbmenv
-sudo pbmenv install latest
+
+##### 1-2) rbenvでインストールしたrubyを使う場合
+rbenvはrubyのパッケージマネージャーです。  
+
+```bash
+rbenv install 3.0.1
+sudo gem install pbmenv
+sudo pbmenv install latest --use
 cd /usr/share/pbm/current
 sudo /home/pi/.rbenv/versions/3.0.1/bin/ruby app.rb
 ```
 
-#### pbmenvを使わない方法
+#### 2) pbmenvを使わない方法
+https://github.com/jiikko/procon_bypass_man_sample にある app.rb と setting.yml を Raspberry Pi にダウンロードすれば、起動することができます。  
 
-https://github.com/jiikko/procon_bypass_man_sample にある app.rb と setting.yml を Raspberry Pi にダウンロードし、ruby 3.0.1 をインストールすれば起動することができます。
+##### 2-1) systemにインストールされているrubyを使う場合(初心者におすすめ)
 
+```bash
+sudo apt-get install ruby ruby-dev wget
+wget https://raw.githubusercontent.com/jiikko/procon_bypass_man_sample/master/app.rb
+wget https://raw.githubusercontent.com/jiikko/procon_bypass_man_sample/master/setting.yml
+sudo gem i bundler
+sudo ruby app.rb
 ```
+
+##### 2-2) rbenvでインストールしたrubyを使う場合
+rbenvはrubyのパッケージマネージャーです。  
+
+```bash
 rbenv install 3.0.1
+sudo apt-get install wget
+wget https://raw.githubusercontent.com/jiikko/procon_bypass_man_sample/master/app.rb
+wget https://raw.githubusercontent.com/jiikko/procon_bypass_man_sample/master/setting.yml
 sudo /home/pi/.rbenv/versions/3.0.1/bin/ruby app.rb
 ```
 
@@ -90,12 +140,12 @@ pbmenvを使っていない場合は、 https://github.com/splaplapla/procon_byp
 ゲームをやめたくなったらSwitchはそのままスリープに入って問題ないです。このときにRaspberry Piも一緒に電源が切れてしまいますが故障することはありません。
 
 ## レイヤー
-あらかじめレイヤーごとにキーの配置を設定しておき、用途に応じてレイヤーを切り替えることで違うキーが入力できるという機能です。  
+レイヤーごとにボタンの設定をすることができ、用途に応じてレイヤーを切り替えることで、違う設定を即座に適用できるという機能です。  
 レイヤーは、up, down, left, rightの4つあります。 設定ファイルの書いている `prefix_keys_for_changing_layer` を押しながら、十字キーのup, down, left, rightのどれかを押すと、レイヤーを変更することができます。  
   
-レイヤー毎の定義方法は、 `layer` ブロックで囲って定義します。  
+設定ファイルでのレイヤー毎の定義方法は、 `layer` ブロックで囲って定義します。  
 以下の例は、upレイヤーとleftレイヤーだけに設定が書かれています。ゲーム進行状況によってレイヤーを切り替えてください。  
-初期レイヤーは、 up です。
+procon_bypass_manを起動した直後に有効になっているレイヤーは、 up です。
 
 ```ruby
 layer :up do
@@ -113,15 +163,12 @@ layer :down do
 end
 ```
 
-## モード
-* 後で書きます
-
 ## マクロ
 
 決まった入力を繰り返し実行できる機能を「マクロ」と呼んでいます。  
-スプラトゥーンであれば、バブル即割の操作や、試合中の味方へのスーパージャンプもマクロ経由で入力できます。  
+マクロを使うことで、スプラトゥーンであれば、バブル即割の操作や、試合中の味方へのスーパージャンプもマクロ経由で入力できます。  
   
-マクロの実態はただの文字列で`toggle_r_for_0_2sec` や `toggle_r_for_1sec`といった時間指定もできますし、`[:x, :down, :a, :a]` のような1文字のずつの入力も可能です。  
+設定ファイルに記述するマクロは文字列で定義します。 
 マクロを設定ファイルに定義するには、「プラグイン」か設定ファイルへ直接を記述する「open_macro」のどちらかで行えます。  
   
 「プラグイン」を使用する場合は、マクロの詳細を記述する必要がなく、PBMのバージョンアップとともに改善が入る可能性があります。  
@@ -136,10 +183,13 @@ open_macroは、マクロの詳細を設定ファイルに直書きするため
 y, x, b, a, sl, sr, r, zr, minus, plus, thumbr, thumbl, home, cap, down, up, right, left, l, zl
 ```
 
+<!--
 マクロの形式には、1ボタンずつ入力する「バージョン1」と時間指定のできる「バージョン2」があります。  
 バージョン1は、 `[:x, :y, :up]` と記述すると、x, y, 十字キーの上ボタンを順番に入力します。バージョン1では実行時間を指定することはできません。  
+-->
   
-バージョン2では、 複数のボタンを同時に、時間を指定して「連打」「押しっぱなし」「無操作」ができます。  
+マクロは、複数のボタンを同時に「連打」「押しっぱなし」または「待機」ができます。  
+
 連打はtoggleで、押しっぱなしはpressing, 無操作は、waitというキーワードを使います。  
 複数のボタンを同時押しの場合は、andで繋ぎます。Xボタンを押しっぱなしにして、ZRボタンを連打する場合は `pressing_x_and_toggle_zr` と記述します。  
 これに時間を指定をする場合は、forで繋ぎます。 `pressing_x_and_toggle_zr_for_1sec` となります。  
@@ -154,7 +204,7 @@ y, x, b, a, sl, sr, r, zr, minus, plus, thumbr, thumbl, home, cap, down, up, rig
 * toggle_x_and_toggle_zr_for_0_2sec
   * XボタンとZRボタンを0.2秒間連打
 
-上述したマクロ（ステップ）は、open_macroで記述できます。次は実際の記述例です。
+上述したマクロ（ステップ）は、open_macroという構文でも記述できます。次は実際の記述例です。
 
 ```
 open_macro :sokuwari, steps: [:toggle_r_for_0_2sec, :toggle_thumbr_for_0_14sec, :toggle_thumbr_and_toggle_zr_for_0_34sec, :toggle_r_for_1sec], if_pressed: [:zl, :right]
@@ -166,11 +216,16 @@ open_macro :sokuwari, steps: [:toggle_r_for_0_2sec, :toggle_thumbr_for_0_14sec,
 [左スティックの感度調整](/docs/setting/left-analogstick-cap.md)
 
 ## 入力表示
-* https://github.com/splaplapla/switch-procon-input-viewer
-* 後で書きます
+* 使い方は https://github.com/splaplapla/switch-procon-input-viewer を参照してください。
+* https://zenn.dev/jiikko/articles/2ef0ccbdfe0fe7 に技術的な解説を書きました
 
 ## 設定ファイルの書き方
-* 後で書きます
+設定ファイルは、ymlフォーマットに埋め込まれたRubyスクリプトで記述します。  
+Rubyスクリプトな上に独特な構文に対して、アレンジを加えることは難しいと思ったので、マウス操作をするだけで設定ファイルを生成するツールを作りました。  
+https://splaplapla.github.io/procon_bypass_man_setting_editor/ です。  
+このツールで設定ファイルを生成し、コピペをするだけで大半のことは済みます。  
+  
+TODO 設定ファイルの書き方
 
 ## プラグインの書き方
 * 後で書きます
@@ -191,3 +246,22 @@ procon_bypass_man_cloudとの接続が完了後、Raspberry Piを起動時にpro
 セットアップ方法などでわからないことがあればdiscordで質問してみてください。  
   
 セットアップ方法は https://pbm-cloud.herokuapp.com/faq に書いています。
+
+## 最適化について
+本稿では、Rubyの最適化について書きます。上級者向けです。適用しなくても普通に動きますが、逆に適用したことで何らかのケースで遅くなる場合があるかもしれません。
+
+* jemallocを使う
+  * GCの回数が減る(はずな)ので小さな遅延が減ると考えています。が、違いを測定および体感はできませんでした。
+      * インストール方法と動作確認
+          * sudo apt install libjemalloc-dev
+          * export LD_PRELOAD=/usr/lib/arm-linux-gnueabihf/libjemalloc.so.2
+          * MALLOC_CONF=stats_print:true ruby -e "exit"
+      * 適用方法
+          * `/usr/share/pbm/current/systemd_units/pbm.service` の `ExecStart` 行に `LD_PRELOAD=/usr/lib/arm-linux-gnueabihf/libjemalloc.so.2` を足してください
+          * ex) `ExecStart=/bin/bash -c "LD_PRELOAD=/usr/lib/arm-linux-gnueabihf/libjemalloc.so.2 /home/pi/.rbenv/versions/3.0.1/bin/ruby /usr/share/pbm/current/app.rb"`
+* jitを有効にする
+  * 起動した直後は、コンパイルが走るので遅くなります。しかし、有効にしたところで本プログラムはIOバインドなので効果は薄いようです。
+      * 適用方法
+          * `/usr/share/pbm/current/systemd_units/pbm.service` の `ExecStart` 行に `--jit` を足してください
+          * ex) `ExecStart=/bin/bash -c "/home/pi/.rbenv/versions/3.0.1/bin/ruby --jit /usr/share/pbm/current/app.rb"`
+* ラズベリーパイのGUIをオフにする

data/docs/setup_raspi_by_mitamae.md

@@ -9,12 +9,51 @@
 * wget https://raw.githubusercontent.com/splaplapla/procon_bypass_man/master/docs/setup_raspi.mitamae.rb -O setup_raspi.mitamae.rb
 * sudo ./mitamae-armhf-linux local setup_raspi.mitamae.rb -l debug
 * sudo reboot
-* sudo sh /usr/share/pbm/shared/add_procon_gadget.sh の実行に成功させる
-* /etc/rc.local に sh /usr/share/pbm/shared/add_procon_gadget.sh って書く
+* sudo sh /usr/share/pbm/shared/add_procon_gadget.sh の実行する
+  * 何も表示されなければOK
 * PCとRaspberry Pi4を接続し、プロコンとして認識していることを確認する
 * sudo gem i pbmenv
 * sudo pbmenv install latest
 
+Raspberry Piのセットアップは以上です。  
+次は、SwitchとRaspberry Piとプロコンにケーブルを接続した上で、次のコマンドをshellに入力し、procon_bypass_manの動作確認を行なってください。  
+
+```shell
+cd /usr/share/pbm/current
+sudo /home/pi/.rbenv/versions/3.0.1/bin/ruby app.rb
+```
+
+次のような出力が画面に表示されれば、動作しています。
+
+```
+ ----
+ ProconBypassMan::VERSION: 0.2.2
+ RUBY_VERSION: 3.0.1
+ Pbmenv::VERSION: 0.1.10
+ pid: 574
+ root: /usr/share/pbm/v0.2.0
+ pid_path: /usr/share/pbm/v0.2.0/pbm_pid
+ setting_path: /usr/share/pbm/current/setting.yml
+ uptime from boot: 60 sec
+ use_pbmenv: true
+ session_id: s_c6f36422-c20f-4a04-a446-b4a235c2face
+ device_id: d_8b0c90d8-90*************************
+ ----
+```
+
+<hr>
+  
+procon_bypass_manを手動で起動する場合は、先ほどの2行のコマンドを毎回入力してください。  
+procon_bypass_manを自動起動する方法については `GETTING STARTED` を参照してください。
+
+<hr>
+  
+
+ケーブルの接続方法は、次の写真を参考にしてください。
+
+<img src="https://user-images.githubusercontent.com/1664497/151661582-3a1e8ce9-6c38-4754-8075-7a4453b3109a.jpg" width="500px">
+
+<!--
 ## 上記手順の動作確認方法
 * 使えそうなイメージ
   * navikey/raspbian-bullseye
@@ -48,3 +87,5 @@ sudo ./mitamae-armhf-linux local setup_raspi.mitamae.rb -l debug
 * /etc/modules に指定の文字列があること
 * /boot/config.txt に指定の文字列があること
 * /usr/share/pbm/shared/add_procon_gadget.sh が存在していること
+
+-->

data/lib/procon_bypass_man/background/job_performer.rb

@@ -6,10 +6,9 @@ module ProconBypassMan
         @args = args
       end
 
+      # @raise [any]
       def perform
         @klass.perform(*@args)
-      rescue => e
-        ProconBypassMan::ReportErrorJob.perform(e)
       end
     end
   end