procon_bypass_man 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '019476402097b5b57976cd88c61d41b23c9eb7e6195a0f49240d4d89db9622a6'
-  data.tar.gz: '0590db283b885d28994ab318393876c2fc1acc3082960dbe7adaaec5c7080d21'
+  metadata.gz: d4ffa6c5a0eca5298143505c133f6895f7bb33b6061a36e6123c27e19a0ffcbb
+  data.tar.gz: 74e77a823d913769a75b2dd698991bb1fed6a62a1da9a65928e00b86773e90df
 SHA512:
-  metadata.gz: e0e858601e6a4d98c5e7cd6eafafccf3e123c3ea956f70398d3382c6239aef888b84210a028b18b763cf8865b4b645181fa9c5f3d9f29047cd639a706979b0eb
-  data.tar.gz: 455638d194448fa0a535915e585519486b423828251de66f345e3888269b15f34c459cb55266ec08f271aa114a92f927195b1ef0e9621422695cfea356548a35
+  metadata.gz: 90cbb299a402bbab3fae219fc17b359155b48c67cf34761ad69c63ee5ba72ed7cf356d5829ee003d19558c7418f07444d7f35619d82bebc124975ab1c40cb85f
+  data.tar.gz: f03f39550078285114b0a7ac209938dee7b335c99689cba48ed4d4f4d62e659b0fb1fcea51bd800acfe61839cc92c235f5112e3adc5a3896e033f5dbfa224373

data/CHANGELOG.md

@@ -1,6 +1,12 @@
+## [0.3.5] - 2022-2-9
+* 設定ファイルに起動な必要なPBMのバージョンを表記できるようになりました
+  * https://github.com/splaplapla/procon_bypass_man/pull/238
+* レイヤー変更ボタン(prefix_keys_for_changing_layer)が空欄の時に設定ファイルをエラーにしないようになりました
+* PBM-CloudからPBMをアップグレードするときに、古いバージョンを削除するようにしました
+
 ## [0.3.4] - 2022-12-26
 * 左スティックを1回転するマクロを追加しました
-    * 詳しい設定方法については docs/setting/splatoon3_rotation_forward_stick.md を参照してください
+    * 詳しい設定方法については docs/setting/splatoon3_rotation_left_stick.md を参照してください
 * プログラムの停止時・再読み込み時に時間がかかってた不具合を修正しました
 
 ## [0.3.3.1] - 2022-11-13

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    procon_bypass_man (0.3.4)
+    procon_bypass_man (0.3.5)
       action_cable_client
       blue_green_process (= 0.1.4.2)
-      pbmenv (>= 0.1.9)
+      pbmenv (>= 0.1.11)
       sorted_set
 
 GEM
@@ -38,7 +38,7 @@ GEM
     parallel (1.21.0)
     parser (3.0.3.2)
       ast (~> 2.4.1)
-    pbmenv (0.1.10)
+    pbmenv (0.1.11)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)

data/README.md

@@ -38,7 +38,7 @@ https://user-images.githubusercontent.com/1664497/171327108-f12f56a5-fc36-48da-9
 * レイヤーを切り替える方法は？
     * 設定ファイルに記述している `prefix_keys_for_changing_layer`の後ろにあるキーを同時押しながら、十字キーのどれかを押すことで任意のレイヤーに切り替わります
 * このツールでできることは？
-    * キーリマップ, 連射, マクロ, 特定の同じ操作の繰り返し(mode)
+    * キーリマップ, 連射, マクロ
         * リマップは1つのキーを別のキーに割り当てます
     * 連射中には特定のキーの入力を無視したり、複数のキーをトリガーに連射することができます
 * どうしてsudoが必要なの？
@@ -80,13 +80,6 @@ sudo kill -USR2 `cat ./pbm_pid`
 * githubのreleaseを作成する
 -->
 
-## Raspberry Pi4のセットアップを代行します
-* Raspberry Pi4を開発者である私の家に配送してくれれば、セットアップを代行します。セットアップが終わり次第送り返します
-* 使い方に関しては、https://pbm-cloud.jiikko.com ですべて完結するので、Linuxの知識は不要です
-* 何か問題が起きた時はリモートログインでサポート可能です
-* 希望者はDiscordの `kawagu#7684` にDMを送ってください
-* お金はかかりません
-
 ## 開発を支援してくれる人を募集しています
 * https://jiikko.fanbox.cc/
 * procon_bypassの運営・開発・サーバー費用に充てさせていただきます。また、問い合わせに優先して対応します。

data/docs/getting_started.md

@@ -3,17 +3,16 @@
 * [はじめに](#はじめに)
     * [procon_bypass_manで解決したいこと](#procon_bypass_manで解決したいこと)
     * [procon_bypass_manでできること](#procon_bypass_manでできること)
-* [セットアップを代行できます](#セットアップを代行できます)
 * [セットアップ](#セットアップ)
   * [ラズベリーパイのセットアップ](#ラズベリーパイのセットアップ)
   * [procon_bypass_manのインストール](#procon_bypass_manのインストール)
       * [pbmenvを使う方法](#pbmenvを使う方法)
       * [pbmenvを使わない方法](#pbmenvを使わない方法)
+* [RaspberryPiの給電について](#RaspberryPiの給電について)
 * [普段使いをするためのセットアップ](#普段使いをするためのセットアップ)
 * [レイヤー](#レイヤー)
 * [マクロ](#マクロ)
 * [左スティックの感度調整](#左スティックの感度調整)
-* [入力表示](#入力表示)
 * [設定ファイルの書き方](#設定ファイルの書き方)
 * プラグインの書き方
 * [設定ファイルの書き方がわからない、エラーが起きるとき](#設定ファイルの書き方がわからない、エラーが起きるとき)
@@ -43,15 +42,10 @@
   * [設定方法](/docs/setting/left-analogstick-cap.md)
 * WEBから設定状態の閲覧・反映
 * ボタンリマップ
+<!--
 * 入力表示
   * https://github.com/splaplapla/switch-procon-input-viewer
-
-## セットアップを代行できます
-* Raspberry Pi4を開発者である私の家に配送してくれれば、セットアップを代行します。セットアップが終わり次第送り返します
-* 使い方に関しては、https://pbm-cloud.jiikko.com ですべて完結するので、Linuxの知識は不要です
-* 何か問題が起きた時はリモートログインでサポート可能です
-* 希望者はDiscordの `kawagu#7684` にDMを送ってください
-* お金はかかりません
+-->
 
 ## セットアップ
 ### ラズベリーパイのセットアップ
@@ -123,6 +117,14 @@ wget https://raw.githubusercontent.com/jiikko/procon_bypass_man_sample/master/se
 sudo /home/pi/.rbenv/versions/3.0.1/bin/ruby app.rb
 ```
 
+## RaspberryPiの給電について
+Raspberry Piの状態によっては、Switchと接続しているときに、Raspberry Piが電力不足になるようで動作が不安定になることがあります。  
+不安定になるようであれば、Switch以外からも給電してみてください。詳細には言及しませんが、主な給電方法には、以下があります。
+
+* GPIO端子
+* セルフパワーUSBハブ
+* PoE
+
 ## 普段使いをするためのセットアップ
 
 procon_bypass_manを起動するだけでプロコンと接続ができるようになったら、Raspberry Piを起動したときにprocon_bypass_manも自動起動するように設定しましょう。  
@@ -215,9 +217,11 @@ open_macro :sokuwari, steps: [:toggle_r_for_0_2sec, :toggle_thumbr_for_0_14sec,
 ## 左スティックの感度調整
 [左スティックの感度調整](/docs/setting/left-analogstick-cap.md)
 
+<!--
 ## 入力表示
 * 使い方は https://github.com/splaplapla/switch-procon-input-viewer を参照してください。
 * https://zenn.dev/jiikko/articles/2ef0ccbdfe0fe7 に技術的な解説を書きました
+-->
 
 ## 設定ファイルの書き方
 設定ファイルは、ymlフォーマットに埋め込まれたRubyスクリプトで記述します。  

data/docs/setting/splatoon3_macro_dasei_cancel.md

@@ -3,6 +3,13 @@
 * 本マクロは実験段階で、オプション名などの仕様が変更される可能性が高いです
 * procon_bypass_man: 0.3.3以上が必要です
 
+
+
+https://user-images.githubusercontent.com/1664497/210229394-493a7ad4-b4cf-4dfd-87da-2398494e00fd.mp4
+
+
+
+
 ## 1. install_macro_pluginでマクロを有効化します
 * `setting.yml` に`install_macro_plugin ProconBypassMan::Plugin::Splatoon3::Macro::DaseiCancel` と書きます
 * これを記述することで、layer内でmacroを呼び出せるようになります

data/docs/setting/{splatoon3_rotation_forward_stick.md → splatoon3_rotation_left_stick.md}

@@ -12,7 +12,7 @@ https://user-images.githubusercontent.com/1664497/205416889-d458668e-ab46-4867-8
 version: 1.0
 setting: |-
   prefix_keys_for_changing_layer [:zr, :zl, :l]
-  install_macro_plugin(ProconBypassMan::Plugin::Splatoon2::Macro::RotationLeftStick)
+  install_macro_plugin(ProconBypassMan::Plugin::Splatoon3::Macro::RotationLeftStick)
 
   layer :up do
     macro ProconBypassMan::Plugin::Splatoon3::Macro::RotationLeftStick, if_pressed: [:left]

data/lib/procon_bypass_man/background/jobs/report_warning_job.rb

@@ -0,0 +1,11 @@
+class ProconBypassMan::ReportWarningJob < ProconBypassMan::ReportEventBaseJob
+  extend ProconBypassMan::HasExternalApiSetting
+
+  # @param [String] body
+  def self.perform(body)
+    ProconBypassMan::ReportHttpClient.new(
+      path: path,
+      server: api_server,
+    ).post(body: body, event_type: :warn)
+  end
+end

data/lib/procon_bypass_man/background.rb

@@ -9,6 +9,7 @@ require "procon_bypass_man/background/jobs/report_reload_config_job"
 require "procon_bypass_man/background/jobs/report_error_reload_config_job"
 require "procon_bypass_man/background/jobs/report_load_config_job"
 require "procon_bypass_man/background/jobs/report_error_job"
+require "procon_bypass_man/background/jobs/report_warning_job"
 require "procon_bypass_man/background/jobs/report_completed_upgrade_pbm_job"
 require "procon_bypass_man/background/jobs/report_procon_performance_measurements_job"
 require "procon_bypass_man/background/jobs/sync_device_stats_job"

data/lib/procon_bypass_man/buttons_setting_configuration/loader.rb

@@ -1,4 +1,5 @@
 require "procon_bypass_man/buttons_setting_configuration/param_normalizer"
+require "procon_bypass_man/buttons_setting_configuration/metadata_loader"
 
 module ProconBypassMan
   class ButtonsSettingConfiguration
@@ -9,6 +10,11 @@ module ProconBypassMan
       def self.load(setting_path: )
         ProconBypassMan::ButtonsSettingConfiguration.instance.setting_path = setting_path
 
+        metadata_loader = ProconBypassMan::ButtonsSettingConfiguration::MetadataLoader.load(setting_path: setting_path)
+        if(Gem::Version.new(metadata_loader.required_pbm_version) >= Gem::Version.new(ProconBypassMan::VERSION))
+          ProconBypassMan::SendErrorCommand.execute(error: '起動中のPBMが設定ファイルのバージョンを満たしていません。設定ファイルが意図した通り動かない可能性があります。PBMのバージョンをあげてください。')
+        end
+
         ProconBypassMan::ButtonsSettingConfiguration.switch_new_context(:validation) do |new_instance|
           yaml = YAML.load_file(setting_path) or raise "読み込みに失敗しました"
           new_instance.instance_eval(yaml["setting"])

data/lib/procon_bypass_man/buttons_setting_configuration/metadata_loader.rb

@@ -0,0 +1,27 @@
+module ProconBypassMan
+  class ButtonsSettingConfiguration
+    class MetadataLoader
+      EMPTY_VERSION = '0.0.0'
+
+      # @param [String] setting_path
+      # @return [MetadataLoader]
+      def self.load(setting_path: )
+        self.new(setting_path)
+      end
+
+      # @param [String] setting_path
+      def initialize(setting_path)
+        content = File.read(setting_path)
+        if(matched = content.match(/metadata-required_pbm_version: ([\d.]+)/))
+          @required_pbm_version = matched[1]
+        end
+      end
+
+      # @return [String]
+      def required_pbm_version
+        return EMPTY_VERSION unless defined?(@required_pbm_version)
+        return @required_pbm_version if @required_pbm_version
+      end
+    end
+  end
+end

data/lib/procon_bypass_man/buttons_setting_configuration/validator.rb

@@ -12,7 +12,7 @@ module ProconBypassMan
       def valid?
         @errors = Hash.new {|h,k| h[k] = [] }
 
-        validate_require_prefix_keys
+        warn_blank_prefix_keys
         validate_config_of_button_lonely
         validate_verify_button_existence
         validate_flip_and_remap_are_hate_each_other
@@ -56,10 +56,10 @@ module ProconBypassMan
         end
       end
 
-      def validate_require_prefix_keys
+      # @return [void]
+      def warn_blank_prefix_keys
         if @prefix_keys.empty?
-          @errors[:prefix_keys] ||= []
-          @errors[:prefix_keys] << "prefix_keys_for_changing_layerに値が入っていません。"
+          ProconBypassMan.logger.warn "prefix_keys_for_changing_layerに値が入っていません。"
         end
       end
 

data/lib/procon_bypass_man/bypass/bypass_command.rb

@@ -65,8 +65,8 @@ class ProconBypassMan::BypassCommand
         process.work
 
         process_switching_time_before_work = BlueGreenProcess.performance.process_switching_time_before_work
-        if process_switching_time_before_work > 0.1
-          ProconBypassMan::PrintMessageCommand.execute(text: "slow process_switching_time_before_work: #{process_switching_time_before_work}")
+        if process_switching_time_before_work > 0.2
+          ProconBypassMan::SendWarningCommand.execute(warning: "[PERFORMANCE] BlueGreenProcess.performance.process_switching_time_before_work: #{process_switching_time_before_work}", stdout: false)
         end
 
       rescue EOFError => e

data/lib/procon_bypass_man/commands/send_warning_command.rb

@@ -0,0 +1,18 @@
+class ProconBypassMan::SendWarningCommand
+  # @param [String, Hash, Exception] warning
+  # @return [void]
+  def self.execute(warning: , stdout: true)
+    body =
+      case warning
+      when String, Hash
+        warning
+      else
+        warning.full_message
+      end
+
+    ProconBypassMan.logger.warn body
+    puts body if stdout
+
+    ProconBypassMan::ReportWarningJob.perform(warning)
+  end
+end

data/lib/procon_bypass_man/commands.rb

@@ -4,3 +4,4 @@ require "procon_bypass_man/commands/write_session_id_command"
 require "procon_bypass_man/commands/write_device_id_command"
 require "procon_bypass_man/commands/send_reload_config_event_command"
 require "procon_bypass_man/commands/send_error_command"
+require "procon_bypass_man/commands/send_warning_command"

data/lib/procon_bypass_man/remote_pbm_action/change_pbm_version_action.rb

@@ -9,6 +9,7 @@ module ProconBypassMan
         Pbmenv.uninstall(pbm_version) # 途中でシャットダウンしてしまった、とか状態が途中の状態かもしれないので一旦消す
         Pbmenv.install(pbm_version, enable_pbm_cloud: true)
         Pbmenv.use(pbm_version)
+        Pbmenv.clean(10)
         ProconBypassMan.logger.info "#{pbm_version}へアップグレードしました"
         ProconBypassMan::ReportCompletedUpgradePbmJob.perform
         `reboot` # symlinkの参照先が変わるのでrebootする必要がある

data/lib/procon_bypass_man/version.rb

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

data/procon_bypass_man.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  spec.add_dependency "pbmenv", ">= 0.1.9" # enable_pbm_cloud連携機能でPbmenv.installを使っている.
+  spec.add_dependency "pbmenv", ">= 0.1.11" # enable_pbm_cloud連携機能でPbmenv.install, .cleanを使っている.
   spec.add_dependency "action_cable_client"
   spec.add_dependency "sorted_set"
   spec.add_dependency "blue_green_process", '0.1.4.2'

data/project_template/app.rb

@@ -12,7 +12,7 @@ begin
   gemfile do
     source 'https://rubygems.org'
     git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-    gem 'procon_bypass_man', '0.3.4'
+    gem 'procon_bypass_man', '0.3.5'
   end
 rescue Bundler::Source::Git::GitCommandError => e
   retry_count_on_git_command_error = retry_count_on_git_command_error + 1

data/project_template/app.rb.erb

@@ -12,7 +12,7 @@ begin
   gemfile do
     source 'https://rubygems.org'
     git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-    gem 'procon_bypass_man', '0.3.4'
+    gem 'procon_bypass_man', '0.3.5'
   end
 rescue Bundler::Source::Git::GitCommandError => e
   retry_count_on_git_command_error = retry_count_on_git_command_error + 1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: procon_bypass_man
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - jiikko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-26 00:00:00.000000000 Z
+date: 2023-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pbmenv
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.9
+        version: 0.1.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.9
+        version: 0.1.11
 - !ruby/object:Gem::Dependency
   name: action_cable_client
   requirement: !ruby/object:Gem::Requirement
@@ -106,7 +106,7 @@ files:
 - docs/setting/splatoon3_macro_dasei_cancel.md
 - docs/setting/splatoon3_macro_forward_ikarole.md
 - docs/setting/splatoon3_recommended_setting.md
-- docs/setting/splatoon3_rotation_forward_stick.md
+- docs/setting/splatoon3_rotation_left_stick.md
 - docs/setup_raspi.md
 - docs/setup_raspi.mitamae.rb
 - docs/setup_raspi_by_mitamae.md
@@ -129,10 +129,12 @@ files:
 - lib/procon_bypass_man/background/jobs/report_procon_performance_measurements_job.rb
 - lib/procon_bypass_man/background/jobs/report_reload_config_job.rb
 - lib/procon_bypass_man/background/jobs/report_start_reboot_job.rb
+- lib/procon_bypass_man/background/jobs/report_warning_job.rb
 - lib/procon_bypass_man/background/jobs/sync_device_stats_job.rb
 - lib/procon_bypass_man/buttons_setting_configuration.rb
 - lib/procon_bypass_man/buttons_setting_configuration/layer.rb
 - lib/procon_bypass_man/buttons_setting_configuration/loader.rb
+- lib/procon_bypass_man/buttons_setting_configuration/metadata_loader.rb
 - lib/procon_bypass_man/buttons_setting_configuration/param_normalizer.rb
 - lib/procon_bypass_man/buttons_setting_configuration/param_normalizer/button.rb
 - lib/procon_bypass_man/buttons_setting_configuration/param_normalizer/button_list.rb
@@ -153,6 +155,7 @@ files:
 - lib/procon_bypass_man/commands/print_message_command.rb
 - lib/procon_bypass_man/commands/send_error_command.rb
 - lib/procon_bypass_man/commands/send_reload_config_event_command.rb
+- lib/procon_bypass_man/commands/send_warning_command.rb
 - lib/procon_bypass_man/commands/write_device_id_command.rb
 - lib/procon_bypass_man/commands/write_session_id_command.rb
 - lib/procon_bypass_man/configuration.rb