procon_bypass_man 0.1.16 → 0.1.16.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ece30577af00d56afa2e2e0be7e09d8328c9d7f8cc96c2e49d207a2bb423b867
-  data.tar.gz: faf86731651a110fd63ce977f65b76f46c31fe6215a2512d4c3a1ba545fd4f81
+  metadata.gz: 5af6fb77bbbd2aca55c93c8af1bb9c72ede43a043f069001b30201bf8352e7de
+  data.tar.gz: 5607eb2f41d4a09de6e7e04cb8afcf998c09d790931ed105dbe5136c7160698a
 SHA512:
-  metadata.gz: 313d36b543a7c539effaabb6fca121a5112b4076a196ad52386924f3e043ad25e52c5c880a710c1d8aafc66d4a647b3387cebe0b82391eb4ccffa10dd1f4af65
-  data.tar.gz: 55e7a87c35f972e8537654b86a1f5e1815ed22144a4097e1993ad986666f1111972ce8ce1a744e56196c16957a56c328ba510b6b19af4ff8961ac989d216af20
+  metadata.gz: f21c116b2d69b79a2c896cd8c1298a1e80d82c2c879e0e0db328b64f9abb19901da93edd0a88d64314413092bfafead55a9ab359f9e09a2546794812178701e1
+  data.tar.gz: 89d32cbe122d38ad19d55481539a05cfad959695d46c29d2dc6db8ac34eb251a2f2f49d7ab36f5d514e191751ba19f747dd13e5a21fd4cde4ae435a93ce117de

data/CHANGELOG.md

@@ -1,4 +1,7 @@
-## [0.1.16] - 202
+## [0.1.16.1] - 2022-01-22
+- 初期状態ではinternal api(pbm-web)の通信を無効にしました
+
+## [0.1.16] - 2021-12-26
 - websocket経由で外部サーバからの命令を受け取れるようになりました
 
 ## [0.1.15] - 2021-12-08

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    procon_bypass_man (0.1.16)
+    procon_bypass_man (0.1.16.1)
       action_cable_client
       pbmenv
       sorted_set
@@ -36,7 +36,7 @@ GEM
     parallel (1.21.0)
     parser (3.0.3.2)
       ast (~> 2.4.1)
-    pbmenv (0.1.6)
+    pbmenv (0.1.7)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)

data/README.md

@@ -28,8 +28,18 @@ Switch <-- (PBM): ZR連打
 ## Usage
 * USBガジェットモードで起動するRaspberry Pi4を用意する
   * https://github.com/splaplapla/procon_bypass_man/blob/master/docs/setup_raspi.md
-* Raspberry Pi4 で sudo pbmenv install latest && cd /usr/share/pbm/current && sudo ruby app.rb
+* 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
+  * sudo 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
 * https://github.com/splaplapla/procon_bypass_man-splatoon2
@@ -54,6 +64,8 @@ Switch <-- (PBM): ZR連打
     * マクロは特定のキーを順番に入れていく機能。キーの入力が終わったらマクロは終了する
 * レイヤーとは？
     * 自作キーボードみたいな感じでレイヤー毎に設定内容を記述して切り替えれる
+* レイヤーを切り替える方法は？
+    * 設定ファイルに記述している `prefix_keys_for_changing_layer`の後ろにあるキーを同時押しながら、十字キーのどれかを押すことで任意のレイヤーに切り替わります
 * このツールでできることは？
     * キーリマップ, 連射, マクロ, 特定の同じ操作の繰り返し(mode)
         * リマップは1つのキーを別のキーに割り当てます
@@ -62,6 +74,10 @@ Switch <-- (PBM): ZR連打
     * 操作するdeviceファイルの所有者がrootだから
 * 市販されているサードパーティ製連射機との違いは？
     * サードパーティ製のコントローラーは、設定方法や形状が特殊で買い換えるたびに学習・設定コストが発生します。本ツールを使えば、設定内容はテキストで管理することができ、使い慣れたプロコンで同等のことができます。
+* sshなしで運用は可能ですか？
+    * 後述するWEBアプリケーションを使えば、sshを使わずに運用が可能です
+        * https://github.com/splaplapla/procon_bypass_man_cloud
+    * 機能開発中ですが、使ってくれる人を探しているのでdiscordからお問合せください
 
 ## TODO
 * レコーディング機能(プロコンの入力をマクロとして登録ができる)
@@ -91,6 +107,6 @@ sudo kill -USR2 `cat ./pbm_pid`
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-
 ## Links
 * https://discord.gg/bEcRNKf4ep
+  * 質問などご意見をdiscordでも受け付けています

data/docs/setup_raspi.md

@@ -1,3 +1,5 @@
+https://github.com/splaplapla/procon_bypass_man/blob/master/docs/setup_raspi_by_mitamae.md に半自動化した手順があります
+
 # Raspberry Pi4のセットアップ手順
 * SDカードにRaspberry Pi OS (32-bit)を焼く
 * SDカードをRaspberry Pi4本体に挿して起動する

data/docs/setup_raspi.mitamae.rb

@@ -1,6 +1,6 @@
 run_command "apt-get update"
 
-package 'ruby' do
+package 'rbenv' do
   action :install
 end
 
@@ -41,16 +41,15 @@ execute "Initialize PBM" do
  SHELL
 end
 
-# rbenv
-execute "Install rbenv" do
-  not_if "which rbenv"
-  command "git clone https://github.com/rbenv/ruby-build.git "$(rbenv root)"/plugins/ruby-build"
-end
-
 # ruby
 execute "Install ruby" do
+  user "pi"
   not_if "rbenv versions | grep 3.0.1"
-  command "rbenv install 3.0.1"
+  command <<~EOH
+    mkdir -p "$(rbenv root)"/plugins
+    git clone https://github.com/rbenv/ruby-build.git --depth 1 "$(rbenv root)"/plugins/ruby-build
+    rbenv install 3.0.1
+  EOH
 end
 
 run_command 'sudo systemctl disable triggerhappy.socket'

data/docs/setup_raspi_by_mitamae.md

@@ -1,9 +1,11 @@
+セットアップ手順を半自動化にしました
+
 # Raspberry Pi4のセットアップ手順 With mitamae
 * SDカードにRaspberry Pi OS lite (32-bit)を焼く
     * sshをできる状態で焼いておく
 * SDカードをRaspberry Pi4本体に挿して起動する
 * sshする
-* curl -L https://github.com/itamae-kitchen/mitamae/releases/latest/download/mitamae-armhf-linux.tar.gz | tar xvz
+* wget -O - "https://github.com/itamae-kitchen/mitamae/releases/latest/download/mitamae-armhf-linux.tar.gz" | tar xvz
 * 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
@@ -12,3 +14,37 @@
 * PCとRaspberry Pi4を接続し、プロコンとして認識していることを確認する
 * sudo gem i pbmenv
 * sudo pbmenv install latest
+
+## 上記手順の動作確認方法
+* 使えそうなイメージ
+  * navikey/raspbian-bullseye
+  * balenalib/raspberry-pi
+
+```shell
+docker run -it --rm --name my-running-app2 navikey/raspbian-bullseye bash
+```
+
+### 準備
+* docker runするとrootなのでpiでログインする
+
+```shell
+useradd -m --uid 1000 --groups sudo pi
+echo pi:pi | chpasswd
+su pi
+cd ~ && sudo ls
+```
+
+### mitamaeスクリプトを実行する
+
+```
+wget -O - "https://github.com/itamae-kitchen/mitamae/releases/latest/download/mitamae-armhf-linux.tar.gz" | tar xvz
+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
+```
+
+実行に成功したら以下を確認する
+
+* /home/pi/.rbenv/verions に ruby3.0.1がインストールしていること
+* /etc/modules に指定の文字列があること
+* /boot/config.txt に指定の文字列があること
+* /usr/share/pbm/shared/add_procon_gadget.sh が存在していること

data/lib/procon_bypass_man/bypass/usb_hid_logger.rb

@@ -28,10 +28,12 @@ class ProconBypassMan::Bypass
         end
       end
 
-      ProconBypassMan.cache.fetch key: 'pressed_buttons_reporter', expires_in: 5 do
-        ProconBypassMan::ReportPressedButtonsJob.perform_async(
-          bypass_value.binary.to_procon_reader.to_hash
-        )
+      if ProconBypassMan.config.enable_reporting_pressed_buttons
+        ProconBypassMan.cache.fetch key: 'pressed_buttons_reporter', expires_in: 5 do
+          ProconBypassMan::ReportPressedButtonsJob.perform_async(
+            bypass_value.binary.to_procon_reader.to_hash
+          )
+        end
       end
     end
   end

data/lib/procon_bypass_man/configuration.rb

@@ -41,7 +41,7 @@ class ProconBypassMan::Configuration
   end
 
   attr_accessor :enable_critical_error_logging
-  attr_writer :verbose_bypass_log, :raw_setting
+  attr_writer :verbose_bypass_log, :raw_setting, :enable_reporting_pressed_buttons
 
   def root=(path)
     @root = path
@@ -154,4 +154,8 @@ class ProconBypassMan::Configuration
   def raw_setting
     @raw_setting ||= {}
   end
+
+  def enable_reporting_pressed_buttons
+    @enable_reporting_pressed_buttons ||= false
+  end
 end

data/lib/procon_bypass_man/version.rb

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

data/project_template/README.md

@@ -1,11 +1,16 @@
 # Project Template
-これらは https://github.com/splaplapla/pbmenv がinstallするときに配備するファイルです
+* これらは https://github.com/splaplapla/pbmenv がinstallするときに配備するファイルです
+* pbm_webはオプショナルです
 
 ## systemdを使ってサービスに登録する方法
-* sudo ln -s /usr/share/pbm/current/systemd_units/pbm.service /etc/systemd/system/pbm.service
-* sudo ln -s /usr/share/pbm/current/systemd_units/pbm_web.service /etc/systemd/system/pbm_web.service
-* sudo systemctl enable pbm.service
-* sudo systemctl enable pbm_web.service
+systemctl enableした後は、次回のOS起動時にserviceも自動起動します
+
+* pbm
+  * sudo systemctl link /usr/share/pbm/current/systemd_units/pbm.service
+  * sudo systemctl enable pbm.service
+* pbm_web
+  * sudo systemctl link /usr/share/pbm/current/systemd_units/pbm_web.service
+  * sudo systemctl enable pbm_web.service
 
 ## systemdを使ってサービスから解除する方法
 * sudo systemctl disable pbm.service

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.16'
+  gem 'procon_bypass_man', '0.1.16.1'
 end
 
 ProconBypassMan.configure do |config|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: procon_bypass_man
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 0.1.16.1
 platform: ruby
 authors:
 - jiikko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-26 00:00:00.000000000 Z
+date: 2022-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pbmenv