procon_bypass_man 0.1.3 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0ba281c9129f770b6cf905d9221bc39de1957f33d0091e2a5217c1fb4547be8
-  data.tar.gz: ca0fbffd26fb3a7ad928803ea912a1fe6412a4b8d10a65acefbc21d0fe2f0b49
+  metadata.gz: 59fe04b1f616674f3f4a500fbc0abf1dce166482b2e7c880e94d0247a7162877
+  data.tar.gz: 55217706d204a06777fb9c9bfe87a64113dc2bdcfd0efa1079e79afc266690ce
 SHA512:
-  metadata.gz: 0425a0610a7ec5d583724a167f45eaf8f352d552f4158901d02138dbfe89a5b66972f7767c72eab7ed30c6b199af25db10a1c9ef1fb826c188fc30255e81ea98
-  data.tar.gz: 271542b52dce9d7b0980fb5f97c4fbab80b8fa9f03fc726dbf5034899d8a4f7a7cbdc10456a6016bcc81c038d8f0f3463a732d4a4cf7f4940b2ab652d0125d58
+  metadata.gz: 1c57e7ca180ec142258a4725197e928cf073358743c8e98a78cbd87c4419b05f47859d97428f86dabcaee68f7856596a697a9f211b1f928efd3bb88b9a840c2a
+  data.tar.gz: fa60bd01934dc80f811bd8871ba256c2cc70fb6cc6cbaa33fd180922fdde5bc70476234d00ce28303acb37229cace8137de540e29483af9d7dce926cd7e75fc6

data/.circleci/config.yml

@@ -2,19 +2,46 @@ version: 2.1
 orbs:
   ruby: circleci/ruby@0.1.2 
 
-jobs:
-  build:
+executors:
+  ruby:
+    parameters:
+      tag:
+        type: string
+        default: "latest"
     docker:
-      - image: circleci/ruby:3.0.1
-    executor: ruby/default
+      - image: ruby:<< parameters.tag >>
+    environment:
+      BUNDLE_PATH: vendor/bundle
+      BUNDLE_JOBS: 4
+    working_directory: ~/app
+
+jobs:
+  rspec:
+    parameters:
+      version:
+        type: string
+    executor:
+      name: ruby
+      tag: << parameters.version >>
     steps:
       - checkout
-      - run:
-          name: install bundler
-          command: gem install bundler:2.2.20
-      - run:
-          name: bundle install
-          command: bundle install --jobs 4
-      - run:
-          name: run test
-          command: bundle exec rspec
+      - run: ruby --version
+      - run: bundle --version
+      - run: gem --version
+      - run: gem install bundler
+      - run: bundle install --jobs 4
+      - run: bundle exec rubocop
+      - run: bundle exec rspec
+
+build_jobs: &build_jobs
+  - rspec:
+      matrix:
+        parameters:
+          version:
+            - "2.5"
+            - "2.7"
+            - "3.0"
+workflows:
+  version: 2
+  build:
+    jobs: *build_jobs

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,3 +1,23 @@
+## [0.1.7] - 2021-09-11
+- Support pbmenv
+
+## [0.1.6] - 2021-08-19
+- 設定ファイルを読み込むと内容のmd5を `pbm_root_dir/.setting_yaml_digest` へ出力するようにしました
+
+## [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
 - 接続のしやすさ向上
 

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.3)
+    procon_bypass_man (0.1.7)
 
 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)
-    rake (13.0.3)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    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.20.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.11.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
+   2.2.15

data/README.md

@@ -17,20 +17,20 @@ Switch <-- (PBM): ZR連打
 * Switch本体とドック
 * Raspberry Pi4 Model B/4GB(Raspberry Pi OS (32-bit))
     * 他のシリーズは未確認です
+        * zeroは非対応
 * データ通信が可能なUSBケーブル
 
 ## 使うソフトウェア
-* 必須
-  * ruby-3.0.x
+* ruby-3.0.x
 
 ## Usage
 * USBガジェットモードで起動するRaspberry Pi4を用意する
-  * https://github.com/splaspla-hacker/procon_bypass_man/blob/master/docs/setup_raspi.md
+  * 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/splaspla-hacker/procon_bypass_man/wiki に詳細を書いていますが、まず動かすためにはcloneしたほうが早いです
+  * 実行ファイルと設定ファイルについては https://github.com/splaplapla/procon_bypass_man/wiki に詳細を書いていますが、まず動かすためにはcloneしたほうが早いです
 
 ## Plugins
-* https://github.com/splaspla-hacker/procon_bypass_man-splatoon2
+* https://github.com/splaplapla/procon_bypass_man-splatoon2
 
 ## FAQ
 * どうやって動かすの?
@@ -38,7 +38,7 @@ Switch <-- (PBM): ZR連打
 * どうやって使うの？
     * ケーブルでそれらを接続した状態で、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の入力をそのまま再現するため機能。レイヤーを切り替えるまで繰り返し続ける
     * マクロは特定のキーを順番に入れていく機能。キーの入力が終わったらマクロは終了する
@@ -52,15 +52,14 @@ Switch <-- (PBM): ZR連打
     * 操作するdeviceファイルの所有者がrootだから
 
 ## TODO
-* 設定ファイルをwebから反映できる
-* ラズパイのプロビジョニングを楽にしたい
 * レコーディング機能(プロコンの入力をマクロとして登録ができる)
-* webページから設定ファイルを変更できるようにする(sshしたくない)
-    * webサーバのデーモンとPBMはプロセスを分ける(NOTE)
+* マクロにdelayを入れれるようにする
+* 設定ファイル マクロの引数に、ボタンを取れるようにする
 
 ## 開発系
 ```ruby
 ProconBypassMan.tap do |pbm|
+  pbm.root = File.expand_path(__dir__)
   pbm.logger = Logger.new("#{ProconBypassMan.root}/app.log", 5, 1024 * 1024 * 10)
   pbm.logger.level = :debug
 end
@@ -71,6 +70,10 @@ end
 sudo kill -USR2 `cat ./pbm_pid`
 ```
 
+### リリース手順
+* project_template/app.rb, lib/procon_bypass_man/version.rb のバージョンをあげる
+* be rake release
+
 ## 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

@@ -13,7 +13,7 @@
       * /etc/dphys-swapfile を CONF_SWAPSIZE=1024 にする
       * sudo /etc/init.d/dphys-swapfile restart && swapon -s
   * tailscale をインストールする(optional)
-  * sudo apt-get install vim rbenv
+  * sudo apt-get install vim rbenv git -y
   * rbenvでrubyを入れる
       * git clone https://github.com/rbenv/ruby-build.git "$(rbenv root)"/plugins/ruby-build
       * rbenv install 3.0.1
@@ -22,20 +22,25 @@
 * 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
+  * 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
+* cd ~ && mkdir -p src && cd ~/src && git clone https://github.com/jiikko/procon_bypass_man_sample && cd procon_bypass_man_sample
 
-おわり. 起動する時は都度sudo ruby app.rb を実行する
+おわり. 起動する時は都度 sudo ruby app.rb を実行する
 
 ## 参考
 * https://mtosak-tech.hatenablog.jp/entry/2020/08/22/114622
+
+# TIPS
+* SDカードにイメージを焼くときは、ImagerのAdvanced Optionsを使うとセットアップが楽になる
+* raspios_liteにした方が起動が早くなりそう
+    * https://qiita.com/Liesegang/items/dcdc669f80d1bf721c21
+    * http://ftp.jaist.ac.jp/pub/raspberrypi/raspios_lite_armhf

data/docs/setup_raspi.mitamae.rb

@@ -0,0 +1,45 @@
+run_command "apt-get update"
+
+package 'ruby' do
+  action :install
+end
+
+package 'vim' do
+  action :install
+end
+
+package 'git' do
+  action :install
+end
+
+gem_package 'bundler' do
+  action :install
+end
+
+# OTG
+execute "append dtoverlay=dwc2 to /boot/config.txt" do
+  not_if "grep dtoverlay=dwc2 /boot/config.txt"
+  command "echo 'dtoverlay=dwc2' >> /boot/config.txt"
+end
+
+execute "append dwc2 to /etc/modules" do
+  not_if "grep dwc2 /etc/modules"
+  command "echo dwc2 >> /etc/modules"
+end
+
+execute "append libcomposite to /etc/modules" do
+  not_if "grep libcomposite /etc/modules"
+  command "echo libcomposite >> /etc/modules"
+end
+
+# PBM
+execute "Initialize PBM" do
+  command <<~SHELL
+    sudo mkdir -p /usr/share/pbm/shared
+    wget https://gist.githubusercontent.com/jiikko/3f9fb3194c0cc7685e31fbfcb5b5f9ff/raw/23ddee29d94350be80b79d290ac3c8ce8400bd88/add_procon_gadget.sh -O /usr/share/pbm/shared/add_procon_gadget.sh
+    chmod +x /usr/share/pbm/shared/add_procon_gadget.sh
+ SHELL
+end
+
+run_command 'systemctl disable triggerhappy'
+run_command 'systemctl disable bluetooth'

data/docs/setup_raspi_by_mitamae.md

@@ -0,0 +1,13 @@
+# 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 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 って書く
+* PCとRaspberry Pi4を接続し、プロコンとして認識していることを確認する
+* TOOD install pbmenv

data/examples/practical/app.rb

@@ -8,13 +8,14 @@ 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 = 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/configuration/layer.rb

@@ -12,11 +12,11 @@ module ProconBypassMan
       end
 
       # @param [Symbol] button
-      def flip(button, if_pressed: false, channel: nil, force_neutral: nil)
+      def flip(button, if_pressed: false, force_neutral: nil, flip_interval: nil)
         case if_pressed
         when TrueClass
           if_pressed = [button]
-        when Symbol
+        when Symbol, String
           if_pressed = [if_pressed]
         when Array, FalseClass
           # sono mama
@@ -24,23 +24,52 @@ module ProconBypassMan
           raise "not support class"
         end
         hash = { if_pressed: if_pressed }
-        if channel
-          hash[:channel] = channel
-        end
         if force_neutral
-          hash[:force_neutral] = force_neutral
+          case force_neutral
+          when TrueClass, FalseClass
+            raise "ボタンを渡してください"
+          when Symbol, String
+            hash[:force_neutral] = [force_neutral]
+          when Array
+            hash[:force_neutral] = force_neutral
+          end
+        end
+
+        if flip_interval
+          if /\A(\d+)F\z/i =~ flip_interval
+            interval =  ((frame = $1.to_i) / 60.0).floor(2)
+          else
+            raise "8F みたいなフォーマットで入力してください"
+          end
+          hash[:flip_interval] = interval
+        end
+        if self.flips[button]
+          raise "#{button}への設定をすでに割り当て済みです"
+        else
+          self.flips[button] = hash
         end
-        self.flips[button] = hash
       end
 
       PRESET_MACROS = [:fast_return]
       def macro(name, if_pressed: )
-        self.macros[name] = { if_pressed: if_pressed }
+        if name.respond_to?(:name)
+          macro_name = name.name.to_sym
+        else
+          macro_name = name
+        end
+        self.macros[macro_name] = { if_pressed: if_pressed }
       end
 
       def remap(button, to: )
-        raise "シンボル以外は設定できません" unless to.is_a?(Symbol)
-        self.remaps[button] = to
+        case to
+        when TrueClass, FalseClass
+          raise "ボタンを渡してください"
+        when Symbol, String
+          self.remaps[button] = { to: [to] }
+        when Array
+          raise "ボタンを渡してください" if to.size.zero?
+          self.remaps[button] = { to: to }
+        end
       end
 
       # @return [Array]