procon_bypass_man 0.1.16 → 0.1.19

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/docs/upgrade_pbm.md

@@ -0,0 +1,56 @@
+# procon_bypass_man のアップグレード方法
+* pbm-cloudを使う方法、pbmenvを使う方法、pbmenvを使わない方法があります
+
+## pbm-cloudを使う方法
+* https://pbm-cloud.herokuapp.com からデバイス詳細画面を開いてください
+* `デバイスの設定` => `PBMのバージョンアップ`を選択して、表示されるモーダルからインストールしたいバージョンを選択し、 `このバージョンでバージョンアップする` をクリックしてください
+  * クリックするとRaspberry Piが再起動するのでしばらく待ってください
+  * 設定ファイルが初期状態に戻っているので適宜復元してください
+* デバイス詳細画面からバージョンが上がっていることを確認してください
+
+## pbmenvを使う方法
+* sshをして、以下の3行を実行してください
+
+```
+sudo gem i pbmenv
+sudo pbmenv install latest
+sudo pbmenv use latest
+```
+
+* `sudo pbmenv use latest` を実行すると、 `/usr/share/pbm/current/` に新しいバージョンのprocon_bypass_manを配備します
+* `/usr/share/pbm/current/setting.yml` が初期状態になっているので適宜変更してください
+  * 前バージョンのsetting.ymlは消していないので残っています
+* 変更後は、プログラムを起動し直してください
+
+## pbmenvを使わない方法
+* rbファイル内にある `gem 'procon_bypass_man', ` の後ろの番号を変更することで、procon_bypass_manのバージョンを変更できます
+  * 最新バージョンは https://rubygems.org/gems/procon_bypass_man を参照してください
+* 変更後は、プログラムを起動し直してください
+* バージョンを変更後、エラーになる場合はサポートするので、discordやissueに報告をお願いします
+
+```ruby
+#!/usr/bin/env ruby
+
+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.1'
+end
+
+ProconBypassMan.configure do |config|
+  config.root = File.expand_path(__dir__)
+  config.logger = Logger.new("#{ProconBypassMan.root}/app.log", 5, 1024 * 1024 * 10)
+  config.logger.level = :debug
+  # config.api_servers = ['https://...']
+  config.enable_critical_error_logging = true
+end
+
+ProconBypassMan.run(setting_path: "/usr/share/pbm/current/setting.yml")
+```
+
+```diff
+-  gem 'procon_bypass_man', '0.1.16.1'
++  gem 'procon_bypass_man', '0.1.17'
+```

data/lib/ext/module.rb

@@ -0,0 +1,16 @@
+# pluginの定数未定義を握りつぶす
+class Module
+  module ExtModule
+    def const_missing(id)
+      if self.name =~ /^ProconBypassMan::Plugin/
+        parent_const = Object.const_get("#{self.name}")
+        parent_const.const_set(id, Module.new)
+        Object.const_get("#{self.name}::#{id}")
+      else
+        super
+      end
+    end
+  end
+
+  prepend ExtModule
+end

data/lib/procon_bypass_man/buttons_setting_configuration/layer.rb

@@ -8,7 +8,7 @@ module ProconBypassMan
         self.flips = {}
         self.macros = {}
         self.remaps = {}
-        self.left_analog_stick_caps = {}
+        self.left_analog_stick_caps = []
         self.disables = []
       end
 
@@ -53,12 +53,18 @@ module ProconBypassMan
         self.flips[button] = hash
       end
 
+      # @param [String, Class] プラグインのclass
       def macro(name, if_pressed: )
-        if name.respond_to?(:name)
-          macro_name = name.name.to_sym
-        else
-          macro_name = name
-        end
+        macro_name = name.to_s.to_sym
+        self.macros[macro_name] = { if_pressed: if_pressed }
+      end
+
+      # 設定ファイルに直接マクロを打ち込める
+      # @param [String, Class] macroの識別子
+      # @paramh[Array<Symbol>] macroの本体. ボタンの配列
+      def open_macro(name, steps: , if_pressed: )
+        macro_name = name || "OpenMacro-#{steps.join}".to_sym
+        ProconBypassMan::Procon::MacroRegistry.install_plugin(macro_name, steps: steps)
         self.macros[macro_name] = { if_pressed: if_pressed }
       end
 
@@ -88,6 +94,10 @@ module ProconBypassMan
           raise "not support value"
         end
 
+        if if_pressed
+          hash[:if_pressed] = if_pressed
+        end
+
         case force_neutral
         when TrueClass
           raise "ボタンを渡してください"
@@ -101,7 +111,7 @@ module ProconBypassMan
           raise "not support value"
         end
 
-        left_analog_stick_caps[if_pressed] = hash
+        left_analog_stick_caps << hash
       end
 
       def disable(button)
@@ -123,6 +133,22 @@ module ProconBypassMan
       def flip_buttons
         flips
       end
+
+      # @return [String]
+      def to_json(*)
+        to_hash.to_json
+      end
+
+      # @return [Hash]
+      def to_hash
+        { mode: mode,
+          flips: flips,
+          macros: macros,
+          remaps: remaps,
+          disables: disables,
+          left_analog_stick_caps: left_analog_stick_caps,
+        }
+      end
     end
   end
 end

data/lib/procon_bypass_man/buttons_setting_configuration/loader.rb

@@ -3,6 +3,7 @@ module ProconBypassMan
     module Loader
       require 'digest/md5'
 
+      # @return [ProconBypassMan::ButtonsSettingConfiguration]
       def self.load(setting_path: )
         ProconBypassMan::ButtonsSettingConfiguration.switch_new_context(:validation) do |new_instance|
           yaml = YAML.load_file(setting_path) or raise "読み込みに失敗しました"
@@ -14,7 +15,9 @@ module ProconBypassMan
             raise ProconBypassMan::CouldNotLoadConfigError, validator.errors
           end
         rescue SyntaxError
-          raise ProconBypassMan::CouldNotLoadConfigError, "Rubyのシンタックスエラーです"
+          raise ProconBypassMan::CouldNotLoadConfigError, "Rubyスクリプトのシンタックスエラーです"
+        rescue NoMethodError
+          raise ProconBypassMan::CouldNotLoadConfigError, "Rubyスクリプトに未定義の定数・変数があります"
         rescue Psych::SyntaxError
           raise ProconBypassMan::CouldNotLoadConfigError, "yamlのシンタックスエラーです"
         end

data/lib/procon_bypass_man/buttons_setting_configuration/validator.rb

@@ -2,6 +2,8 @@ module ProconBypassMan
   class ButtonsSettingConfiguration
     class Validator
       def initialize(config)
+        @macro_plugins = config.macro_plugins
+        @mode_plugins = config.mode_plugins
         @layers = config.layers
         @prefix_keys = config.prefix_keys
       end
@@ -14,6 +16,8 @@ module ProconBypassMan
         validate_config_of_button_lonely
         validate_verify_button_existence
         validate_flip_and_remap_are_hate_each_other
+        validate_verify_mode_plugins
+        validate_verify_macro_plugins
 
         @errors.empty?
       end
@@ -86,6 +90,38 @@ module ProconBypassMan
           end
         end
       end
+
+      def validate_verify_mode_plugins
+        @mode_plugins.each do |key, mode|
+          begin
+            Module.const_get(key.to_s)
+          rescue NameError
+            next
+          end
+
+          if(const = Module.const_get(key.to_s))
+            if not (const.respond_to?(:binaries) && mode.call)
+              @errors[:mode] << "モード #{key}を読み込めませんでした。"
+            end
+          end
+        end
+      end
+
+      def validate_verify_macro_plugins
+        @macro_plugins.each do |key, macro|
+          begin
+            Module.const_get(key.to_s)
+          rescue NameError
+            next
+          end
+
+          if(const = Module.const_get(key.to_s))
+            if not (const.respond_to?(:steps) && macro.call)
+              @errors[:macro] << "マクロ #{key}を読み込めませんでした。"
+            end
+          end
+        end
+      end
     end
   end
 end

data/lib/procon_bypass_man/buttons_setting_configuration.rb

@@ -10,27 +10,33 @@ module ProconBypassMan
       :setting_path,
       :mode_plugins,
       :macro_plugins,
-      :context,
-      :current_context_key,
       :neutral_position
 
     def self.instance
-      @@current_context_key ||= :main
       @@context ||= {}
-      @@context[@@current_context_key] ||= new
+      @@context[current_context_key] ||= new
     end
 
-    def self.switch_new_context(key)
-      @@context[key] = new
-      previous_key = @@current_context_key
+    def self.current_context_key
+      @@current_context_key ||= :main
+    end
+
+    def self.instance=(val)
+      @@context[current_context_key] = val
+    end
+
+    def self.switch_new_context(new_context_key)
+      @@context[new_context_key] = new
+      previous_key = current_context_key
       if block_given?
-        @@current_context_key = key
-        value = yield(@@context[key])
-        @@current_context_key = previous_key
+        @@current_context_key = new_context_key
+        value = yield(@@context[new_context_key])
         return value
       else
-        @@current_context_key = key
+        @@current_context_key = new_context_key
       end
+    ensure
+      @@current_context_key = previous_key
     end
 
     def initialize
@@ -39,19 +45,26 @@ module ProconBypassMan
 
     module ManualMode
       def self.name
-        'manual'
+        :manual
       end
     end
     def layer(direction, mode: ManualMode, &block)
-      mode_name = case mode
-                  when String
-                    mode.to_sym
-                  when Symbol
-                    mode
-                  else
-                    mode.name.to_sym
-                  end
-      unless ([ManualMode.name.to_sym] + ProconBypassMan::Procon::ModeRegistry.plugins.keys).include?(mode_name)
+      if ProconBypassMan::ButtonsSettingConfiguration::ManualMode == mode
+        mode_name = mode.name
+      else
+        mode_name = case mode
+                    when ProconBypassMan::ButtonsSettingConfiguration::ManualMode
+                      mode.name
+                    when String
+                      mode.to_sym
+                    when Symbol
+                      mode
+                    else
+                      mode.to_s.to_sym
+                    end
+      end
+
+      unless ([ManualMode.name] + ProconBypassMan::Procon::ModeRegistry.plugins.keys).include?(mode_name)
         raise("#{mode_name} mode is unknown")
       end
 

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/commands/bypass_command.rb

@@ -40,7 +40,7 @@ class ProconBypassMan::BypassCommand
         monitor1.shutdown
         puts "10秒経過したのでThread1を終了します"
         break
-      rescue Errno::EIO, Errno::ENODEV, Errno::EPROTO, IOError => e
+      rescue Errno::EIO, Errno::ENODEV, Errno::EPROTO, IOError, Errno::ESHUTDOWN => e
         ProconBypassMan::SendErrorCommand.execute(error: "Switchとの切断されました.終了処理を開始します. #{e.full_message}")
         Process.kill "TERM", Process.ppid
       rescue Errno::ETIMEDOUT => e
@@ -62,7 +62,7 @@ class ProconBypassMan::BypassCommand
       rescue EOFError => e
         ProconBypassMan::SendErrorCommand.execute(error: "Proconが切断されました。終了処理を開始します. #{e.full_message}")
         Process.kill "TERM", Process.ppid
-      rescue Errno::EIO, Errno::ENODEV, Errno::EPROTO, IOError => e
+      rescue Errno::EIO, Errno::ENODEV, Errno::EPROTO, IOError, Errno::ESHUTDOWN => e
         ProconBypassMan::SendErrorCommand.execute(error: "Proconが切断されました。終了処理を開始します2. #{e.full_message}")
         Process.kill "TERM", Process.ppid
       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/domains/binary/base.rb

@@ -8,4 +8,18 @@ class ProconBypassMan::Domains::Binary::Base
   def binary
     raise NotImplementedError
   end
+
+  # @return [String]
+  def raw
+    binary
+  end
+
+  def unpack
+    binary.unpack("H*")
+  end
+
+  # @return [ProconBypassMan::ProconReader]
+  def to_procon_reader
+    ProconBypassMan::ProconReader.new(binary: binary)
+  end
 end

data/lib/procon_bypass_man/domains/binary/inbound_procon_binary.rb

@@ -2,20 +2,6 @@
 class ProconBypassMan::Domains::InboundProconBinary < ProconBypassMan::Domains::Binary::Base
   include ProconBypassMan::Domains::HasImmutableBinary
 
-  # @return [String]
-  def raw
-    binary.dup
-  end
-
-  def unpack
-    binary.unpack("H*")
-  end
-
-  # @return [ProconBypassMan::ProconReader]
-  def to_procon_reader
-    ProconBypassMan::ProconReader.new(binary: binary)
-  end
-
   # @return [Boolean]
   def user_operation_data?
     binary[0] == "\x30".b

data/lib/procon_bypass_man/domains/binary/processing_procon_binary.rb

@@ -4,15 +4,6 @@ class ProconBypassMan::Domains::ProcessingProconBinary < ProconBypassMan::Domain
 
   ALL_ZERO_BIT = ["0"].pack("H*").freeze
 
-  # @return [String]
-  def raw
-    binary
-  end
-
-  def unpack
-    binary.unpack("H*")
-  end
-
   def set_no_action!
     binary[3] = ALL_ZERO_BIT
     binary[4] = ALL_ZERO_BIT
@@ -48,7 +39,7 @@ class ProconBypassMan::Domains::ProcessingProconBinary < ProconBypassMan::Domain
     raise "already pressing button(#{button})" if ProconBypassMan::PressButtonAware.new(binary).pressing_button?(button)
 
     button_obj = ProconBypassMan::Procon::Button.new(button)
-    value = binary[button_obj.byte_position].unpack("H*").first.to_i(16) + (2**button_obj.bit_position)
+    value = binary[button_obj.byte_position].unpack("C").first + (2**button_obj.bit_position)
     binary[button_obj.byte_position] = ["%02X" % value.to_s].pack("H*")
   end
 
@@ -57,7 +48,7 @@ class ProconBypassMan::Domains::ProcessingProconBinary < ProconBypassMan::Domain
     raise "not press button(#{button}) yet" if not ProconBypassMan::PressButtonAware.new(binary).pressing_button?(button)
 
     button_obj = ProconBypassMan::Procon::Button.new(button)
-    value = binary[button_obj.byte_position].unpack("H*").first.to_i(16) - (2**button_obj.bit_position)
+    value = binary[button_obj.byte_position].unpack("C").first - (2**button_obj.bit_position)
     binary[button_obj.byte_position] = ["%02X" % value.to_s].pack("H*")
   end
 
@@ -72,9 +63,4 @@ class ProconBypassMan::Domains::ProcessingProconBinary < ProconBypassMan::Domain
     analog_stick_cap = ProconBypassMan::Procon::AnalogStickCap.new(binary)
     binary[6..8] = analog_stick_cap.capped_position(cap_hypotenuse: cap).to_binary
   end
-
-  # @return [ProconBypassMan::ProconReader]
-  def to_procon_reader
-    ProconBypassMan::ProconReader.new(binary: binary)
-  end
 end

data/lib/procon_bypass_man/plugin/splatoon2/macro/fast_return.rb

@@ -3,7 +3,7 @@ module ProconBypassMan
     module Splatoon2
       module Macro
         module FastReturn
-          def self.name
+          def self.display_name
             :fast_return
           end
 

data/lib/procon_bypass_man/plugin/splatoon2/macro/jump_to_left_key.rb

@@ -3,7 +3,7 @@ module ProconBypassMan
     module Splatoon2
       module Macro
         module JumpToLeftKey
-          def self.name
+          def self.display_name
             :jump_to_left_key
           end
 

data/lib/procon_bypass_man/plugin/splatoon2/macro/jump_to_right_key.rb

@@ -3,7 +3,7 @@ module ProconBypassMan
     module Splatoon2
       module Macro
         module JumpToRightKey
-          def self.name
+          def self.display_name
             :jump_to_right_key
           end
 

data/lib/procon_bypass_man/plugin/splatoon2/macro/jump_to_up_key.rb

@@ -3,7 +3,7 @@ module ProconBypassMan
     module Splatoon2
       module Macro
         module JumpToUpKey
-          def self.name
+          def self.display_name
             :jump_to_up_key
           end
 

data/lib/procon_bypass_man/plugin/splatoon2/macro/sokuwari_for_splash_bomb.rb

@@ -0,0 +1,22 @@
+module ProconBypassMan
+  module Plugin
+    module Splatoon2
+      module Macro
+        module SokuwariForSplashBomb
+          def self.display_name
+            :sokuwari_for_splash_bomb
+          end
+
+          # procon_bypass_man: 0.1.18以上が必要
+          def self.steps
+            [ :toggle_r_for_0_2sec,
+              :toggle_thumbr_for_0_14sec,
+              :toggle_thumbr_and_toggle_zr_for_0_34sec,
+              :toggle_r_for_1sec,
+            ].freeze
+          end
+        end
+      end
+    end
+  end
+end

data/lib/procon_bypass_man/plugin/splatoon2/version.rb

@@ -3,7 +3,7 @@
 module ProconBypassMan
   module Plugin
     module Splatoon2
-      VERSION = "0.1.2"
+      VERSION = "0.1.3"
     end
   end
 end

data/lib/procon_bypass_man/plugins.rb

@@ -3,6 +3,7 @@ require_relative "plugin/splatoon2/macro/fast_return"
 require_relative "plugin/splatoon2/macro/jump_to_right_key"
 require_relative "plugin/splatoon2/macro/jump_to_up_key"
 require_relative "plugin/splatoon2/macro/jump_to_left_key"
+require_relative "plugin/splatoon2/macro/sokuwari_for_splash_bomb"
 require_relative "plugin/splatoon2/mode/guruguru"
 
 module ProconBypassMan

data/lib/procon_bypass_man/procon/button.rb

@@ -4,7 +4,7 @@ class ProconBypassMan::Procon::Button
   attr_accessor :byte_position, :bit_position
 
   def initialize(key)
-    b = ProconBypassMan::Procon::ButtonCollection::BUTTONS_MAP[key] or raise(UnknownButtonFoundError, '定義にないボタンです')
+    b = ProconBypassMan::Procon::ButtonCollection::BUTTONS_MAP[key] or raise(UnknownButtonFoundError, "#{key}は定義にないボタンです")
     self.byte_position = b[:byte_position]
     self.bit_position = b[:bit_position]
   end

data/lib/procon_bypass_man/procon/button_collection.rb

@@ -37,4 +37,12 @@ class ProconBypassMan::Procon::ButtonCollection
   BUTTONS = ProconBypassMan::Procon::ButtonCollection::BUTTONS_MAP.keys.freeze
 
   LEFT_ANALOG_STICK = { byte_position: 6..8 }
+
+  # @param [Array<Symbol>] buttons
+  # @return [Array<Symbol>]
+  def self.normalize(buttons)
+    buttons.select { |x|
+      !!ProconBypassMan::Procon::ButtonCollection::BUTTONS_MAP[x]
+    }
+  end
 end