procon_bypass_man 0.1.2 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4e92960c4a8756b58054f9ed64d27ac2a59917371781b4299a88e9a26502075
-  data.tar.gz: 34e839eb78c1c1d0674291112c2c7c4a5d9be5ae026df60e3ac66395d52927a1
+  metadata.gz: 21149148015d5d8194ba9b0dc35fc1699ba1fe4eff6aaf1dd0956e0b35856e14
+  data.tar.gz: 6af893ef0a8ff0fdad56b53d9bd117f6cbd39ec7bdb5c216d44cf2d773b9974f
 SHA512:
-  metadata.gz: 6c16bde4afb251d833d7bf411c8521566027d4109fcd654992b004c336735b1c8f4c6f97441cf99f728d06808cdd9b6d43f73bc527081b9c8d9059fd89893fa3
-  data.tar.gz: bd1ef2643d015a4e80d233a2493d1dcc80c871a958b9551b3691b31cdddefbbfef64e5a61b2fff3737186e064ce39cfe0cce310085c4cbb96c51fcf85be7b761
+  metadata.gz: 7185d5bf2246b3c1e2ae00eb08e170db017e78b7ed43fecde3757f2fc99bf1132f01b4e541ba669b9fc2ef39ee17e035368eabe7d4b973728c8ae49fd2873a0a
+  data.tar.gz: 6c3152904d3f4af9e3e3e4f519d4fbe3391cf7d727c3ee42966d9492672bb9ead227ce451e8b97088d8b5e27176e9427939009ff59873fac507cbdabeb7fa61a

data/.circleci/config.yml

@@ -0,0 +1,23 @@
+version: 2.1
+orbs:
+  ruby: circleci/ruby@0.1.2 
+
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:3.0.1
+    executor: ruby/default
+    steps:
+      - checkout
+      - run:
+          name: install bundler
+          command: gem install bundler:2.2.20
+      - run:
+          name: bundle install
+          command: bundle install --jobs 4
+      - run:
+          name: rubocop
+          command: bundle exec rubocop
+      - run:
+          name: run test
+          command: bundle exec rspec

data/.rubocop.yml

@@ -0,0 +1,24 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  Include:
+    - 'lib/**/*.rb'
+    - 'spec/**/*.rb'
+Style:
+  Enabled: false
+
+Metrics:
+  Enabled: false
+    
+Layout:
+  Enabled: false
+
+Naming:
+  Enabled: false
+
+Lint/ConstantDefinitionInBlock:
+    Enabled: false
+Lint/UselessAssignment:
+    Enabled: false
+Lint/EmptyBlock:
+    Enabled: false

data/CHANGELOG.md

@@ -1,12 +1,31 @@
-## [0.1.2]
-- features
-  - 設定ファイルのライブリロードができるようになった
-  - 設定ファイルのバリデーションエラーとシンタックスエラーを投げるようになった
-  - key remap
-- breking changes
-    - 設定情報をyamlで書くようになった
+## [0.1.6] - 2021-08-19
+- 設定ファイルを読み込むと内容のmd5を `pbm_root_dir/.setting_yaml_digest` へ出力するようにしました
 
-## [0.1.1]
+## [0.1.5] - 2021-07-29
+- siwtch, proコンが電源OFF時にCPU使いまくるのを修正した
+- 連打中に無視するボタンを複数登録できるようにした
+- キーのリマップ先に複数ボタンを登録できるようにした
+- 1つのボタンへ連打とリマップをできないようにしました
+    - NG ex)
+        - flip :zr, if_pressed: [:y]
+        - remap :zr, to: [:x]
+
+## [0.1.4] - 2021-07-11
+- ProconBypassMan.rootの定義を、gem rootからproject rootへ変更した
+- 連打の頻度を変更できるようにした
+- シグナルで設定ファイルを読み直すとpid_pathが消滅する不具合を修正した
+
+## [0.1.3] - 2021-07-03
+- 接続のしやすさ向上
+
+## [0.1.2] - 2021-06-25
+- 設定ファイルのライブリロードができるようになった
+  - tmp/pidにUSR2シグナルを送信すると設定を再読み込みする
+- 設定ファイルのバリデーションエラーとシンタックスエラーを投げるようになった
+- Support key remap
+- 設定情報をyamlで書くようになった
+
+## [0.1.1] - 2021-06-19
 - プロコンの出力をLoggerに書き出す
 - コマンドの標準出力にstatsを出す
 - graceful shutdown

data/Gemfile

@@ -8,3 +8,5 @@ gemspec
 gem "rake", "~> 13.0"
 gem "rspec"
 gem "pry"
+gem "timecop"
+gem "rubocop", require: false

data/Gemfile.lock

@@ -1,18 +1,25 @@
 PATH
   remote: .
   specs:
-    procon_bypass_man (0.1.2)
+    procon_bypass_man (0.1.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.2)
     coderay (1.1.3)
     diff-lcs (1.4.4)
     method_source (1.0.0)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    rainbow (3.0.0)
     rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -26,6 +33,20 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
+    rubocop (1.18.4)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.8.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.8.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    timecop (0.9.4)
+    unicode-display_width (2.0.0)
 
 PLATFORMS
   arm-linux
@@ -37,6 +58,8 @@ DEPENDENCIES
   pry
   rake (~> 13.0)
   rspec
+  rubocop
+  timecop
 
 BUNDLED WITH
    2.2.20

data/README.md

@@ -1,12 +1,21 @@
 # ProconBypassMan
-* プロコンを連射機にしたり、マクロを実行できるツールです
+* Switchに繋いだプロコンを連射機にしたり、キーのリマップをしたり、マクロを実行できるツールです
     * 設定ファイルはrubyスクリプトで記述します
 * 特定のタイトルに特化した振る舞いにしたい時は各プラグインを使ってください
 
+![image](https://user-images.githubusercontent.com/1664497/123414210-942f6980-d5ee-11eb-8192-955bd9e37e0b.png)
+
+```
+@startuml
+ProController --> (PBM): ZR押しっぱなし
+Switch <-- (PBM): ZR連打
+@enduml
+```
+
 ## 使うハードウェア
 * プロコン
 * Switch本体とドック
-* Raspberry Pi4
+* Raspberry Pi4 Model B/4GB(Raspberry Pi OS (32-bit))
     * 他のシリーズは未確認です
 * データ通信が可能なUSBケーブル
 
@@ -15,143 +24,53 @@
   * ruby-3.0.x
 
 ## Usage
-* 以下のファイルを用意して`sudo`をつけて実行してください
-    * ex) `sudo bin/run.rb`
-
-```ruby
-# bundler inline
-require 'bundler/inline'
-
-gemfile do
-  gem 'procon_bypass_man', github: 'splaspla-hacker/procon_bypass_man', branch: "0.1.1"
-end
-
-ProconBypassMan.run(setting_path: "./setting.yml")
-```
-
-setting.yml
-
-```yml
-version: 1.0
-setting: |-
-  prefix_keys_for_changing_layer [:zr, :r, :zl, :l]
-  layer :up do
-    flip :zr, if_pressed: :zr
-    flip :zl, if_pressed: [:y, :b, :zl]
-    flip :down, if_pressed: true
-  end
-  layer :right do
-  end
-  layer :left
-  layer :down do
-    flip :zl, if_pressed: true
-    remap :l, to: :zr
-  end
-```
-
-### プラグインを使った設定例
-```ruby
-#!/usr/bin/env ruby
-
-require 'bundler/inline'
-
-gemfile do
-  gem 'procon_bypass_man', github: 'splaspla-hacker/procon_bypass_man', branch: "0.1.1"
-  gem 'procon_bypass_man-splatoon2', github: 'splaspla-hacker/procon_bypass_man-splatoon2', branch: "0.1.0"
-end
-
-ProconBypassMan.run(setting_path: "./setting.yml")
-```
-setting.yml
-
-```yml
-version: 1.0
-setting: |-
-  fast_return = ProconBypassMan::Splatoon2::Macro::FastReturn
-  guruguru = ProconBypassMan::Splatoon2::Mode::Guruguru
-
-  install_macro_plugin fast_return
-  install_mode_plugin guruguru
-
-  prefix_keys_for_changing_layer [:zr, :r, :zl, :l]
-
-  layer :up, mode: :manual do
-    flip :zr, if_pressed: :zr, force_neutral: :zl
-    flip :zl, if_pressed: [:y, :b, :zl]
-    flip :down, if_pressed: :down
-    macro fast_return.name, if_pressed: [:y, :b, :down]
-  end
-  layer :right, mode: guruguru.name
-  layer :left do
-    # no-op
-  end
-  layer :down do
-    flip :zl
-  end
-```
-
-* 設定ファイルの例
-  * https://github.com/jiikko/procon_bypass_man_sample
+* 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したほうが早いです
 
 ## Plugins
-* https://github.com/splaspla-hacker/procon_bypass_man-splatoon2
-
-## プラグインの作り方
-https://github.com/splaspla-hacker/procon_bypass_man-splatoon2 を見てみてください
-
-### モード
-* name, binariesの持つオブジェクトを定義してください
-* binariesには、Proconが出力するバイナリに対して16進数化した文字列を配列で定義してください
-
-### マクロ
-* name, stepsの持つメソッドをオブジェクトを定義してください
-* stepsには、プロコンで入力ができるキーを配列で定義してください
-  * 現在はintervalは設定できません
+* https://github.com/splaplapla/procon_bypass_man-splatoon2
 
 ## FAQ
-### ソフトウェアについて
 * どうやって動かすの?
     * このツールはRaspberry Pi4をUSBガジェットモードで起動して有線でプロコンとSwitchに接続して使います
 * どうやって使うの？
     * ケーブルでそれらを接続した状態で、Raspberry Pi4にsshして本プログラムを起動することで使用します
 * ラズベリーパイ4のセットアップ方法は？
-    * https://github.com/splaspla-hacker/procon_bypass_man/tree/master/docs/setup_raspi.md
+    * https://github.com/splaplapla/procon_bypass_man/tree/master/docs/setup_raspi.md
 * モード, マクロの違いは？
     * modeはProconの入力をそのまま再現するため機能。レイヤーを切り替えるまで繰り返し続ける
     * マクロは特定のキーを順番に入れていく機能。キーの入力が終わったらマクロは終了する
 * レイヤーとは？
     * 自作キーボードみたいな感じでレイヤー毎に設定内容を記述して切り替えれる
+* このツールでできることは？
+    * キーリマップ, 連射, マクロ, 特定の同じ操作の繰り返し(mode)
+        * リマップは1つのキーを別のキーに割り当てます
+    * 連射中には特定のキーの入力を無視したり、複数のキーをトリガーに連射することができます
+* どうしてsudoが必要なの？
+    * 操作するdeviceファイルの所有者がrootだから
 
 ## TODO
-* ログをfluentdへ送信
-* 設定ファイルをwebから反映できる
-* ケーブルの抜き差しなし再接続(厳しい)
-    * 接続確立後、プロセスを強制停止し、接続したままプロセスを再起動すると、USBの経由での接続ができなくなる
-        * ケーブルを抜いてからリトライすると改善する
-        * ケーブルで繋がっているけどswitchとプロコンがBluetoothで繋がっている状態かつ非充電状態だとバイパスができない、ということがわかった
-    * ラズパイとプロコン間でBluetooth接続できれば解決するかもしれない
-        * ジャイロの入力を取る方法がまだ発見できていないらしく厳しいことがわかった
-            * https://github.com/dekuNukem/Nintendo_Switch_Reverse_Engineering/issues/7
-        * それとSwitchOS 12からペアリングの仕様に変更があって類似ツールが動かなくっている
 * ラズパイのプロビジョニングを楽にしたい
 * レコーディング機能(プロコンの入力をマクロとして登録ができる)
-* swtichとの接続完了はIOを見て判断する
-* webページから設定ファイルを変更できるようにする(sshしたくない)
-    * webサーバのデーモンとPBMはプロセスを分ける(NOTE)
-* プロセスを停止するときにtmp/pidを削除する
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/procon_bypass_man. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/procon_bypass_man/blob/master/CODE_OF_CONDUCT.md).
+* マクロにdelayを入れれるようにする
+* 設定ファイル マクロの引数に、ボタンを取れるようにする
 
-### ロギング
-```
+## 開発系
+```ruby
 ProconBypassMan.tap do |pbm|
-  pbm.logger = STDOUT
+  pbm.root = File.expand_path(__dir__)
+  pbm.logger = Logger.new("#{ProconBypassMan.root}/app.log", 5, 1024 * 1024 * 10)
   pbm.logger.level = :debug
 end
 ```
 
+### プロコンとの接続を維持したまま、現在の設定ファイルをPBMに反映する
+```shell
+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).

data/docs/setup_raspi.md

@@ -1,5 +1,5 @@
 # Raspberry Pi4のセットアップ手順
-* SDカードに焼く
+* SDカードにRaspberry Pi OS (32-bit)を焼く
 * SDカードをRaspberry Pi4本体に挿して起動する
 * ラズパイGUI
   * 無線LANに接続する
@@ -36,3 +36,6 @@
 * cd ~ && mkdir -p src && cd ~/src && git clone https://github.com/jiikko/procon_bypass_man_sample && cd procon_bypass_man && sudo bundle install
 
 おわり. 起動する時は都度sudo ruby app.rb を実行する
+
+## 参考
+* https://mtosak-tech.hatenablog.jp/entry/2020/08/22/114622

data/examples/pbm.service

@@ -0,0 +1,27 @@
+# sudo ln -s /home/pi/src/procon_bypass_man/examples/pbm.service /etc/systemd/system/pbm.service
+# Usage:
+#   systemctl daemon-reload
+#   systemctl enable pbm.service
+#   systemctl start pbm.service
+#   systemctl status pbm.service
+#   systemctl restart pbm.service
+# Debug:
+#   journalctl -xe -f
+# TODO:
+#   do not make PIDFILE
+
+[Unit]
+Description=PBM
+# After=network-online.target
+After=network.target
+
+[Service]
+Type=simple
+# PIDFile=/home/pi/src/procon_bypass_man/pbm_pid
+# WatchdogSec=60
+WorkingDirectory=/home/pi/src/procon_bypass_man
+ExecStart=/home/pi/.rbenv/versions/3.0.1/bin/ruby examples/practical/app.rb
+Restart=always
+
+[Install]
+WantedBy=multi-user.target

data/examples/practical/app.rb

@@ -1,16 +1,21 @@
 #!/usr/bin/env ruby
 
+# sudo ln -s /home/pi/src/procon_bypass_man/examples/practical/setting.yml /home/pi/src/procon_bypass_man/setting.yml
+# cd src/procon_bypass_man
+# sudo ruby examples/practical/app.rb
+
 require 'bundler/inline'
 
 gemfile do
   source 'https://rubygems.org'
-  gem 'procon_bypass_man', github: 'splaspla-hacker/procon_bypass_man', branch: "edge"
-  gem 'procon_bypass_man-splatoon2', github: 'splaspla-hacker/procon_bypass_man-splatoon2', branch: "0.1.0"
+  gem 'procon_bypass_man', github: 'splaplapla/procon_bypass_man', branch: "edge"
+  gem 'procon_bypass_man-splatoon2', github: 'splaplapla/procon_bypass_man-splatoon2', branch: "0.1.0"
 end
 
 ProconBypassMan.tap do |pbm|
-  pbm.logger = "./app.log"
+  pbm.logger = Logger.new("#{ProconBypassMan.root}/app.log", 5, 1024 * 1024 * 10) # 5世代まで残して, 10MBでローテーション
   pbm.logger.level = :debug
+  pbm.root = File.expand_path(__dir__)
 end
 
 ProconBypassMan.run(setting_path: "./setting.yml")

data/examples/practical/setting.yml

@@ -9,7 +9,7 @@ setting: |-
   prefix_keys_for_changing_layer [:zr, :r, :zl, :l]
 
   layer :up, mode: :manual do
-    flip :zr, if_pressed: :zr, force_neutral: :zl
+    flip :zr, if_pressed: :zr, force_neutral: :zl, flip_interval: "8F"
     flip :zl, if_pressed: [:y, :b, :zl]
     flip :down, if_pressed: :down
     macro fast_return.name, if_pressed: [:y, :b, :down]

data/lib/procon_bypass_man.rb

@@ -1,12 +1,13 @@
 require "logger"
 require 'yaml'
+require "fileutils"
 
 require_relative "procon_bypass_man/version"
-require_relative "procon_bypass_man/device_registry"
+require_relative "procon_bypass_man/timer"
 require_relative "procon_bypass_man/bypass"
+require_relative "procon_bypass_man/device_connector"
 require_relative "procon_bypass_man/runner"
 require_relative "procon_bypass_man/processor"
-require_relative "procon_bypass_man/procon/data"
 require_relative "procon_bypass_man/configuration"
 require_relative "procon_bypass_man/procon"
 
@@ -16,7 +17,8 @@ Thread.abort_on_exception = true
 module ProconBypassMan
   class ProConRejected < StandardError; end
   class CouldNotLoadConfigError < StandardError; end
-  class CouldNotConnectDeviceError < StandardError; end
+  class FirstConnectionError < StandardError; end
+  class EternalConnectionError < StandardError; end
 
   def self.configure(setting_path: nil, &block)
     unless setting_path
@@ -32,20 +34,26 @@ module ProconBypassMan
 
   def self.run(setting_path: nil, &block)
     configure(setting_path: setting_path, &block)
-    registry = ProconBypassMan::DeviceRegistry.new
-    Runner.new(gadget: registry.gadget, procon: registry.procon).run
+    File.write(pid_path, $$)
+    Runner.new.run
   rescue CouldNotLoadConfigError
     ProconBypassMan.logger.error "設定ファイルが不正です。設定ファイルの読み込みに失敗しました"
     puts "設定ファイルが不正です。設定ファイルの読み込みに失敗しました"
+    FileUtils.rm_rf(ProconBypassMan.pid_path)
+    FileUtils.rm_rf(ProconBypassMan.digest_path)
     exit 1
-  rescue CouldNotConnectDeviceError
-    ProconBypassMan.logger.error "デバイスと接続中です"
-    puts "デバイスと接続中です"
+  rescue EternalConnectionError
+    ProconBypassMan.logger.error "接続の見込みがないのでsleepしまくります"
+    puts "接続の見込みがないのでsleepしまくります"
+    FileUtils.rm_rf(ProconBypassMan.pid_path)
+    sleep(999999999)
+  rescue FirstConnectionError
+    puts "接続を確立できませんでした。やりなおします。"
     retry
   end
 
-  def self.logger=(dev)
-    @@logger = Logger.new(dev, 5, 1024 * 1024 * 10) # 5世代まで残して, 10MBでローテーション
+  def self.logger=(logger)
+    @@logger = logger
   end
 
   def self.logger
@@ -56,6 +64,10 @@ module ProconBypassMan
     end
   end
 
+  def self.pid_path
+    @@pid_path ||= File.expand_path("#{root}/pbm_pid", __dir__).freeze
+  end
+
   def self.reset!
     ProconBypassMan::Procon::MacroRegistry.reset!
     ProconBypassMan::Procon::ModeRegistry.reset!
@@ -63,4 +75,20 @@ module ProconBypassMan
     ProconBypassMan::Configuration.instance.reset!
     ProconBypassMan::IOMonitor.reset!
   end
+
+  def self.root
+    if defined?(@@root)
+      @@root
+    else
+      File.expand_path('..', __dir__).freeze
+    end
+  end
+
+  def self.root=(path)
+    @@root = path
+  end
+
+  def self.digest_path
+    "#{root}/.setting_yaml_digest"
+  end
 end