procon_bypass_man 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b4e92960c4a8756b58054f9ed64d27ac2a59917371781b4299a88e9a26502075
+  data.tar.gz: 34e839eb78c1c1d0674291112c2c7c4a5d9be5ae026df60e3ac66395d52927a1
+SHA512:
+  metadata.gz: 6c16bde4afb251d833d7bf411c8521566027d4109fcd654992b004c336735b1c8f4c6f97441cf99f728d06808cdd9b6d43f73bc527081b9c8d9059fd89893fa3
+  data.tar.gz: bd1ef2643d015a4e80d233a2493d1dcc80c871a958b9551b3691b31cdddefbbfef64e5a61b2fff3737186e064ce39cfe0cce310085c4cbb96c51fcf85be7b761

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+vendor
+todo.local.md

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+3.0.1

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+## [0.1.2]
+- features
+  - 設定ファイルのライブリロードができるようになった
+  - 設定ファイルのバリデーションエラーとシンタックスエラーを投げるようになった
+  - key remap
+- breking changes
+    - 設定情報をyamlで書くようになった
+
+## [0.1.1]
+- プロコンの出力をLoggerに書き出す
+- コマンドの標準出力にstatsを出す
+- graceful shutdown
+- たまに数秒ハングアップする問題の修正
+- 内蔵していたマクロとモードをプラグインに切り出した
+
+## [0.1] - 2021-06-17
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at n905i.1214@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in procon_bypass_man.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec"
+gem "pry"

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    procon_bypass_man (0.1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    method_source (1.0.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  arm-linux
+  arm64-darwin-20
+  armv7l-linux
+
+DEPENDENCIES
+  procon_bypass_man!
+  pry
+  rake (~> 13.0)
+  rspec
+
+BUNDLED WITH
+   2.2.20

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 jiikko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,157 @@
+# ProconBypassMan
+* プロコンを連射機にしたり、マクロを実行できるツールです
+    * 設定ファイルはrubyスクリプトで記述します
+* 特定のタイトルに特化した振る舞いにしたい時は各プラグインを使ってください
+
+## 使うハードウェア
+* プロコン
+* Switch本体とドック
+* Raspberry Pi4
+    * 他のシリーズは未確認です
+* データ通信が可能なUSBケーブル
+
+## 使うソフトウェア
+* 必須
+  * 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
+
+## 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は設定できません
+
+## FAQ
+### ソフトウェアについて
+* どうやって動かすの?
+    * このツールはRaspberry Pi4をUSBガジェットモードで起動して有線でプロコンとSwitchに接続して使います
+* どうやって使うの？
+    * ケーブルでそれらを接続した状態で、Raspberry Pi4にsshして本プログラムを起動することで使用します
+* ラズベリーパイ4のセットアップ方法は？
+    * https://github.com/splaspla-hacker/procon_bypass_man/tree/master/docs/setup_raspi.md
+* モード, マクロの違いは？
+    * modeはProconの入力をそのまま再現するため機能。レイヤーを切り替えるまで繰り返し続ける
+    * マクロは特定のキーを順番に入れていく機能。キーの入力が終わったらマクロは終了する
+* レイヤーとは？
+    * 自作キーボードみたいな感じでレイヤー毎に設定内容を記述して切り替えれる
+
+## 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).
+
+### ロギング
+```
+ProconBypassMan.tap do |pbm|
+  pbm.logger = STDOUT
+  pbm.logger.level = :debug
+end
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "procon_bypass_man"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docs/how_to_connect_procon.md

@@ -0,0 +1,23 @@
+# Raspberry Pi4とプロコンの接続方法
+## USB経由
+* ケーブルに接続するだけ
+
+## Bluetooth経由
+* Switch本体の電源を落とす
+* $ bluetoothctl
+    * -> scan on
+* プロコンのリセットボタンを長押しする
+  * `[NEW] Device 98:B6:E9:XX:XX:XX Pro Controller` という出力が出る
+* 長押ししながら、pair, trust, connect を入力していく
+* Connection successfulが出力されて、プロコンのLEDランプが点滅し続ければ成功
+
+```
+[bluetooth]# pair 98:B6:E9:XX:XX:XX
+Attempting to pair with 98:B6:E9:XX:XX:XX
+[bluetooth]# trust 98:B6:E9:XX:XX:XX
+[bluetooth]# connect 98:B6:E9:XX:XX:XX
+Attempting to connect to 98:B6:E9:XX:XX:XX
+Changing 98:B6:E9:XX:XX:XX trust succeeded
+Pairing successful
+Connection successful
+```

data/docs/setup_raspi.md

@@ -0,0 +1,38 @@
+# Raspberry Pi4のセットアップ手順
+* SDカードに焼く
+* SDカードをRaspberry Pi4本体に挿して起動する
+* ラズパイGUI
+  * 無線LANに接続する
+  * sshdを許可する
+* macからsshする
+  * sudo apt-get dist-upgrade
+  * hostnameを変える
+      * sudo hostnamectl set-hostname raspizero
+      * /etc/hosts に追記する
+  * 仮想メモリを増やす(optional)
+      * /etc/dphys-swapfile を CONF_SWAPSIZE=1024 にする
+      * sudo /etc/init.d/dphys-swapfile restart && swapon -s
+  * tailscale をインストールする(optional)
+  * sudo apt-get install vim rbenv
+  * rbenvでrubyを入れる
+      * git clone https://github.com/rbenv/ruby-build.git "$(rbenv root)"/plugins/ruby-build
+      * rbenv install 3.0.1
+      * rbenv local 3.0.1
+      * gem i bundler
+* sshkeyを作成する
+* github に鍵を登録する
+* ~/.ssh/authorized_keys に鍵を登録する
+* sudo pip3 install fluent-logger pytz
+* ガジェットモードで起動する
+  * /boot/config.txtに、dtoverlay=dwc2を追記
+　* echo "dwc2" | sudo tee -a /etc/modules
+　* echo "libcomposite" | sudo tee -a /etc/modules
+　* sudo cat /etc/modules
+  * cd ~ && wget https://gist.githubusercontent.com/jiikko/3f9fb3194c0cc7685e31fbfcb5b5f9ff/raw/23ddee29d94350be80b79d290ac3c8ce8400bd88/add_procon_gadget.sh
+  * chmod 755 ~/add_procon_gadget.sh
+  * sudo reboot
+  * sudo sh ~/add_procon_gadget.sh の実行に成功させる
+  *  /etc/rc.local に sh /home/pi/add_procon_gadget.sh って書く
+* 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 を実行する