procon_bypass_man 0.1.20.2 → 0.1.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b74bbbe94f6c14a8e8cfbabb306e7229cab042ea9d5fae34ddfe134df0911528
-  data.tar.gz: b42ea9a421add0181270f5c957c9d10079598871634f5f20da8e7101349c981e
+  metadata.gz: f0250a1a8546982fa0d1924606cfeb65b0376b1f0bbd2849a8c6faba39551c1a
+  data.tar.gz: 94301f2c9540d370e55479f9ae818de0b0e64ece99b7ad7b44698f8828e241d4
 SHA512:
-  metadata.gz: df4ce5c1fc721fe5aa06236a0909c143f49b3616b4c02ca4202f0de7519206a22f5de864e58e50390e47dfe631475cdf1a04c3b4e99ed492913825cf0315039f
-  data.tar.gz: 8fed8f7f1181bfb51b6b214984af09b0bc1d8b83573174fa276e97e857a0569affb14148aeabf52f0ba3b90cc30083548c191346649e8c534832fcba3b6aee25
+  metadata.gz: 8819eed593368519dde453cdb44168c4d05066ec6a52d22b8ca61f57a4f67d59307b41d4cb814a9b89dc2590cab17036ab2c2acf6c460213193cecf3380f8cb7
+  data.tar.gz: 5ba74b2733493a2efb74fd9f73ffa5d6a9103acb5e1bd2d050e5c14146e739da4b48e25e84431cab1655e3d9a48a5f8249974f66da5ecc55f8efb4a66c3e86e7

data/.circleci/config.yml

@@ -34,6 +34,14 @@ commands: &commands
             - vendor/bundle
 
 jobs:
+  check_pbm_version:
+    executor:
+      name: ruby
+      tag: 3.0.1
+    steps:
+      - checkout
+      - run: GEM_VERSION=$(grep -o -E '[0-9.]+' lib/procon_bypass_man/version.rb) && GEM_VERSION_IN_BUNDER=$(grep procon_bypass_man project_template/app.rb | grep "gem 'procon_bypass_man'" | grep -o -E '[0-9.]+') && test "$GEM_VERSION" = "$GEM_VERSION_IN_BUNDER"
+
   syntax_check:
     parameters:
       ruby-version:
@@ -92,11 +100,11 @@ jobs:
       - run: bundle exec rspec
 
 build_jobs: &build_jobs
+  - check_pbm_version
   - syntax_check:
       matrix:
         parameters:
           ruby-version:
-            - "2.7"
             - "3.0.1"
             - "3.0.2"
             - "3.1.1"
@@ -104,7 +112,6 @@ build_jobs: &build_jobs
       matrix:
         parameters:
           ruby-version:
-            - "2.7"
             - "3.0.1"
             - "3.0.2"
             - "3.1.1"
@@ -112,7 +119,6 @@ build_jobs: &build_jobs
       matrix:
         parameters:
           ruby-version:
-            - "2.7"
             - "3.0.1"
             - "3.0.2"
             - "3.1.1"
@@ -122,7 +128,6 @@ build_jobs: &build_jobs
       matrix:
         parameters:
           ruby-version:
-            - "2.7"
             # - "3.0.1" # たまにSEGVするので
             - "3.0.2"
             - "3.1.1"
@@ -132,7 +137,6 @@ build_jobs: &build_jobs
       matrix:
         parameters:
           ruby-version:
-            - "2.7"
             - "3.0.1"
             - "3.0.2"
             - "3.1.1"

data/.github/workflows/ruby.yml

@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.7', '3.0.1']
+        ruby-version: ['3.0.1', '3.1.1']
 
     steps:
     - uses: actions/checkout@v2

data/.gitignore

@@ -13,3 +13,4 @@ todo.local.md
 pbm_pid
 setting.yml
 device_id
+/procon

data/.rspec

@@ -1 +1,2 @@
 --require spec_helper
+-f d

data/CHANGELOG.md

@@ -1,4 +1,33 @@
-## [0.1.20.2] - 2022-2-18
+## [0.1.23] - 2022-05-04
+- プロセスを停止するとプロコンがBluetooth経由でSwitchと接続するようになりました
+- 起動時に表示するdevice_idを一部のみ表示するようになりました
+- ライブリロードが不安定になっていたのを修正しました
+- コントローラのバイブレーションを無効にしました
+- プロセスを停止後、再接続しやすくなりました
+
+## [0.1.22] - 2022-04-09
+* スティックを左右に入れるマクロが使えるようになりました
+  * スプラトゥーン2でのタンサンボムのチャージに使えます
+  * 例: `open_macro :shake, steps: [:shake_left_stick_and_toggle_b_for_0_1sec], if_pressed: [:b, :r], force_neutral: [:b]`
+* pbm-cloudからmacroを発火させる機能に対応しました
+* 設定ファイルで不備があったときに警告が表示されるようになりました
+
+## [0.1.21] - 2022-03-03
+- install_macro_pluginしていないマクロをlayer内で使うとクラッシュしていた問題を修正しました
+- 数十時間起動しっぱなしだとpbm-cloudとのwebsocketの接続が切断される問題を修正しました
+- 誤発動を防ぐために、マクロを無効にする設定ができるようになりました
+  - すべてのマクロを無効にする
+    - disable_macro :all
+    - disable_macro :all, if_pressed: [:a]
+  - 特定のマクロを無効にする
+    - disable_macro TheMacro
+    - disable_macro TheMacro, if_pressed: [:a]
+- スティックを傾けたタイミングでマクロを発動するオプションを実装しました
+  - これによってスプラトゥーン2の惰性キャンセルができるようになります
+      - ただし、精度がイマイチなので今後改善していきます
+  - 詳しくは `スプラトゥーン2: 惰性キャンセル マクロの設定方法` を参照してください
+
+## [0.1.20.2] - 2022-02-18
 - 起動時にreniceするようにしました
 - 起動時にusb gadgetモードを有効にするようにしました
 - pbm-cloudからprocon_bypass_manをアップグレードできるようになりました

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    procon_bypass_man (0.1.20.2)
+    procon_bypass_man (0.1.23)
       action_cable_client
       pbmenv (>= 0.1.9)
       sorted_set
@@ -41,7 +41,7 @@ GEM
       coderay (~> 1.1)
       method_source (~> 1.0)
     rack (2.2.3)
-    rack-protection (2.1.0)
+    rack-protection (2.2.0)
       rack
     rainbow (3.0.0)
     rake (13.0.6)
@@ -79,10 +79,10 @@ GEM
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
     set (1.0.2)
-    sinatra (2.1.0)
+    sinatra (2.2.0)
       mustermann (~> 1.0)
       rack (~> 2.2)
-      rack-protection (= 2.1.0)
+      rack-protection (= 2.2.0)
       tilt (~> 2.0)
     sorted_set (1.0.3)
       rbtree

data/README.md

@@ -9,10 +9,13 @@
 * ドキュメントは [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)
+
+<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押しっぱなし

data/docs/getting_started.md

@@ -9,15 +9,15 @@
       * [pbmenvを使う方法](#pbmenvを使う方法)
       * [pbmenvを使わない方法](#pbmenvを使わない方法)
 * [普段使いをするためのセットアップ](#普段使いをするためのセットアップ)
-* レイヤー
+* [レイヤー](#レイヤー)
 * モード
-* マクロ
-* 左スティックの感度調整
+* [マクロ](#マクロ)
+* [左スティックの感度調整](#左スティックの感度調整)
 * 設定ファイルの書き方
 * プラグインの書き方
-* 設定ファイルの書き方がわからない、エラーが起きるとき
+* [設定ファイルの書き方がわからない、エラーが起きるとき](#設定ファイルの書き方がわからない、エラーが起きるとき)
 * [procon_bypass_manのアップグレード方法](#procon_bypass_manのアップグレード方法)
-* procon_bypass_man_cloudについて
+* [procon_bypass_man_cloudについて](#procon_bypass_man_cloudについて)
 
 ## はじめに
 ### procon_bypass_manで解決したいこと
@@ -87,16 +87,80 @@ 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` ブロックで囲って定義します。  
+以下の例は、upレイヤーとleftレイヤーだけに設定が書かれています。ゲーム進行状況によってレイヤーを切り替えてください。  
+初期レイヤーは、 up です。
+
+```ruby
+layer :up do
+  flip :a, if_pressed: [:a]
+end
+
+layer :right do
+end
+
+layer :left do
+  flip :zr, if_pressed: :zr, force_neutral: :zl
+end
+
+layer :down do
+end
+```
 
 ## モード
 * 後で書きます
 
 ## マクロ
-* 後で書きます
+
+決まった入力を繰り返し実行できる機能を「マクロ」と呼んでいます。  
+スプラトゥーンであれば、バブル即割の操作や、試合中の味方へのスーパージャンプもマクロ経由で入力できます。  
+  
+マクロの実態はただの文字列で`toggle_r_for_0_2sec` や `toggle_r_for_1sec`といった時間指定もできますし、`[:x, :down, :a, :a]` のような1文字のずつの入力も可能です。  
+マクロを設定ファイルに定義するには、「プラグイン」か設定ファイルへ直接を記述する「open_macro」のどちらかで行えます。  
+  
+「プラグイン」を使用する場合は、マクロの詳細を記述する必要がなく、PBMのバージョンアップとともに改善が入る可能性があります。  
+open_macroは、マクロの詳細を設定ファイルに直書きするため、設定ファイルが複雑になる可能性がある反面、柔軟なマクロを定義することができます。  
+プラグインで提供されているマクロがあれば、それを使うことをお勧めします。  
+プラグインの詳細な設定方法については、 [バブル即割マクロの設定方法](/docs/setting/splatoon2_macro_sokuwari_bubble.md) を参考にしてください。  
+  
+次はマクロの入力に使えるコマンド（ステップ）の紹介をします。  
+マクロに使えるボタンは以下の通りです。  
+
+```
+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` となります。  
+時間指定には1秒未満も設定することができ、`wait_for_0_65sec` と記述すると、0.65秒間無操作となります。次はいくつか実例を紹介します。  
+
+* toggle_r_for_0_2sec
+  * 0.2秒間Rボタンを連打
+* wait_for_0_65sec
+  * 0.65秒間無操作
+* pressing_x_and_pressing_zr_for_0_2sec
+  * XボタンとZRボタンを0.2秒間押しっぱなし
+* toggle_x_and_toggle_zr_for_0_2sec
+  * XボタンとZRボタンを0.2秒間連打
+
+上述したマクロ（ステップ）は、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]
+```
+
+わからないことがあればdiscordで何でも質問してください。
 
 ## 左スティックの感度調整
-* 後で書きます
+[左スティックの感度調整](/docs/setting/left-analogstick-cap.md)
 
 ## 設定ファイルの書き方
 * 後で書きます
@@ -106,11 +170,17 @@ pbmenvを使っていない場合は、 https://github.com/splaplapla/procon_byp
 
 ## 設定ファイルの書き方がわからない、エラーが起きるとき
 
-設定部分は、Rubyスクリプトになっているので構文エラーが起きることがあります。  
+設定ファイル(setting.yaml)は、内部がRubyスクリプトになっているので構文エラーが起きることがあります。  
 discordで質問してみてください。
 
 ## procon_bypass_manのアップグレード方法
-[/docs/upgrade_pbm.md](/docs/upgrade_pbm.md)
+[procon_bypass_manのアップグレード方法](/docs/upgrade_pbm.md)
 
 ## procon_bypass_man_cloudについて
-* 後で書きます
+https://pbm-cloud.herokuapp.com/  
+procon_bypass_man_cloudの運用をWEBで完結できるようになる無料のWEBサービスです。  
+  
+procon_bypass_man_cloudとの接続が完了後、Raspberry Piを起動時にprocon_bypass_manが自動で立ち上がるように設定すれば、Raspberry Piへのログインが不要で設定ファイルの変更やprocon_bypass_man自体のアップグレードができます。  
+セットアップ方法などでわからないことがあればdiscordで質問してみてください。  
+  
+セットアップ方法は https://pbm-cloud.herokuapp.com/faq に書いています。

data/docs/setting/left-analogstick-cap.md

@@ -38,7 +38,7 @@ https://user-images.githubusercontent.com/1664497/150636857-f3d40900-2713-41b8-8
   * setting.ymlのシンタックスが正しければ、switchとの接続が継続したままsetting.ymlの内容を読み込んでいるはずです
 
 ```shell
-sudo kill -USR2 `cat ./pbm_pid` 
+sudo kill -USR2 `cat ./pbm_pid`
 ```
 
 ## まとめ

data/docs/setting/splatoon2_macro_dasei_cancel.md

@@ -0,0 +1,77 @@
+# スプラトゥーン2: 惰性キャンセル マクロの設定方法
+
+* 本マクロは実験段階で、オプション名などの仕様が変更される可能性が高いです
+* procon_bypass_man: 0.1.21以上が必要です
+
+## 1. install_macro_pluginでマクロを有効化します
+* `setting.yml` に`install_macro_plugin ProconBypassMan::Plugin::Splatoon2::Macro::DaseiCancel` と書きます
+* これを記述することで、layer内でmacroを呼び出せるようになります
+
+```ruby
+install_macro_plugin ProconBypassMan::Plugin::Splatoon2::Macro::DaseiCancel
+```
+
+## 2. どのlayerで発動するかを宣言します
+* `setting.yml` のlayer内に`macro ProconBypassMan::Plugin::Splatoon2::Macro::DaseiCancel, if_pressed: [:zl]` と書きます
+  * `if_pressed` がどのボタンを押したときにこのマクロが発動するかの設定です
+      * 惰性キャンセルなのでイカ状態になるためにzlを押します
+  * `if_tilted_left_stick` がスティックを倒した時に発動するオプションで、trueを渡すと有効になります
+      * また、傾けた時の閾値を変更することができて、trueの代わりに `{ threshold: 500 }` と書くことができます
+      * デフォルトが500で、ここの数値を上げると、スティックを倒した判定がより厳しくなります。最大1400くらいです。
+* 連打中に、マクロの発動を無効にしたい場合は `disable_macro` で無効にできます
+
+```ruby
+layer :up do
+  macro ProconBypassMan::Plugin::Splatoon2::Macro::DaseiCancel, if_tilted_left_stick: true, if_pressed: [:zl]
+end
+```
+```ruby
+layer :up do
+  macro ProconBypassMan::Plugin::Splatoon2::Macro::DaseiCancel, if_tilted_left_stick: { threshold: 500 }, if_pressed: [:zl]
+end
+```
+```ruby
+layer :up do
+  disable_macro :all, if_pressed: :a
+  disable_macro :all, if_pressed: :zr
+  macro ProconBypassMan::Plugin::Splatoon2::Macro::DaseiCancel, if_tilted_left_stick: true, if_pressed: [:zl]
+end
+```
+
+## 3. 設定を反映させる
+* 上記の記述を加えたsetting.ymlを起動中のprocon_bypass_manプロセスで読み込むには、プロセスにその旨を伝える必要があります
+    * ラズベリーパイを再起動して、プロセスを立ち上げ直す、でも目的は達成できますが、もっと簡単にsetting.ymlを再読み込みする必要があります
+* 書き換えたsetting.ymlを、起動中のprocon_bypass_manプロセスへ即時反映するには、procon_bypass_manプロセスを動かしたまま、別のshellから 以下をを実行してください
+    * setting.ymlのシンタックスが正しければ、switchとの接続が継続したままsetting.ymlの内容を読み込んでいるはずです
+
+```shell
+sudo kill -USR2 `cat ./pbm_pid`
+```
+
+## 設定例1
+```yaml
+version: 1.0
+setting: |-
+  prefix_keys_for_changing_layer [:zr, :zl, :l]
+  install_macro_plugin ProconBypassMan::Plugin::Splatoon2::Macro::DaseiCancel
+
+  layer :up do
+    disable_macro :all, if_pressed: :a
+    disable_macro :all, if_pressed: :zr
+    macro ProconBypassMan::Plugin::Splatoon2::Macro::DaseiCancel, if_tilted_left_stick: true, if_pressed: [:zl]
+  end
+```
+
+## 設定例2
+* `open_macro` キーワードを使っても同じことが実行可能です。
+* この場合は、 `install_macro_plugin` が不要です。
+
+```yaml
+version: 1.0
+setting: |-
+  prefix_keys_for_changing_layer [:zr, :zl, :l]
+
+  layer :up do
+    open_macro :dacan, steps: [:pressing_r_for_0_03sec, :pressing_r_and_pressing_zl_for_0_2sec], if_tilted_left_stick: true, if_pressed: [:zl]
+  end
+```

data/docs/setting/splatoon2_macro_sokuwari_bubble.md

@@ -20,6 +20,10 @@ https://user-images.githubusercontent.com/1664497/152633205-ab44896b-9fa4-402c-b
 * 書き換えたsetting.ymlを、起動中のprocon_bypass_manプロセスへ即時反映するには、procon_bypass_manプロセスを動かしたまま、別のshellから 以下をを実行してください
     * setting.ymlのシンタックスが正しければ、switchとの接続が継続したままsetting.ymlの内容を読み込んでいるはずです
 
+```shell
+sudo kill -USR2 `cat ./pbm_pid`
+```
+
 ## まとめ
 *  次の2行の追加が必要です。
     * `install_macro_plugin ProconBypassMan::Plugin::Splatoon2::Macro::SokuwariForSplashBomb`

data/docs/setting/splatoon2_shake_tansan.md

@@ -0,0 +1,47 @@
+# スプラトゥーン2: タンサンボムを貯めるマクロの設定方法
+
+https://user-images.githubusercontent.com/1664497/160649435-52b084ed-05b0-4c58-88ba-667b5f256405.mp4
+
+* procon_bypass_man: 0.1.22以上が必要です
+* このマクロは、スティックの左右に入れつつ、Bボタンを連打します
+* タンサンボムを貯めるのに使います
+
+## 1. layer内にopen_macroを記述します
+* `setting.yml` のlayer内に`open_macro :shake, steps: [:shake_left_stick_and_toggle_b_for_0_1sec], if_pressed: [:b, :r], force_neutral: [:b]` と書きます
+  * タンサンボムは、スティックの動きとBボタンでもチャージすることができるので、RボタンとBボタンを同時押ししたときに、発動するようにしています。
+
+## 2. 設定を反映させる
+* 上記の記述を加えたsetting.ymlを起動中のprocon_bypass_manプロセスで読み込むには、プロセスにその旨を伝える必要があります
+    * ラズベリーパイを再起動して、プロセスを立ち上げ直す、でも目的は達成できますが、もっと簡単にsetting.ymlを再読み込みする必要があります
+* 書き換えたsetting.ymlを、起動中のprocon_bypass_manプロセスへ即時反映するには、procon_bypass_manプロセスを動かしたまま、別のshellから 以下をを実行してください
+    * setting.ymlのシンタックスが正しければ、switchとの接続が継続したままsetting.ymlの内容を読み込んでいるはずです
+
+```shell
+sudo kill -USR2 `cat ./pbm_pid`
+```
+
+## 設定例1
+```yaml
+version: 1.0
+setting: |-
+  prefix_keys_for_changing_layer [:zr, :zl, :l]
+
+  layer :up do
+    open_macro :shake, steps: [:shake_left_stick_and_toggle_b_for_0_1sec], if_pressed: [:b, :r], force_neutral: [:b]
+  end
+```
+
+## 設定例2
+pluginとして登録してあるので、 `macro` を使っても同じことができます。
+
+```yaml
+version: 1.0
+setting: |-
+  prefix_keys_for_changing_layer [:zr, :zl, :l]
+
+  install_macro_plugin(ProconBypassMan::Plugin::Splatoon2::Macro::ChargeTansanBomb)
+
+  layer :up do
+    macro ProconBypassMan::Plugin::Splatoon2::Macro::ChargeTansanBomb, if_pressed: [:b, :r], force_neutral: [:b]
+  end
+```

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

@@ -0,0 +1,17 @@
+class ProconBypassMan::PostCompletedRemoteMacroJob < ProconBypassMan::BaseJob
+  extend ProconBypassMan::HasExternalApiSetting
+
+  # @param [Symbol] status
+  def self.perform(job_id)
+    ProconBypassMan::RemoteMacroHttpClient.new(
+      path: path,
+      server_pool: server_pool,
+    ).post(job_id: job_id)
+  end
+
+  def self.path
+    device_id = ProconBypassMan.device_id
+    "/api/devices/#{ProconBypassMan.device_id}/completed_pbm_remote_macro_jobs"
+  end
+end
+

data/lib/procon_bypass_man/background.rb

@@ -14,3 +14,4 @@ require "procon_bypass_man/background/jobs/report_error_job"
 require "procon_bypass_man/background/jobs/report_pressed_buttons_job"
 require "procon_bypass_man/background/jobs/report_completed_upgrade_pbm_job"
 require "procon_bypass_man/background/jobs/sync_device_stats_job"
+require "procon_bypass_man/background/jobs/post_completed_remote_macro_job"