procon_bypass_man 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f5d2c0b9137168508351ca8a1492470cd1f03c31d7eb920010a32f08f92122e
-  data.tar.gz: c7f42dd711cb3d8932a8fd6d99ee0735084618411e6cd723eeee8860ca96cd8c
+  metadata.gz: 5e4ad788ed57ca3bac1d4d17b1648285c8bc8d89d23a3c0a4ca4d5aaa58e4dfd
+  data.tar.gz: 512a1f754cf255c6692ab597c7997d6bad3f3004c2f1203a1ce6adaec603e655
 SHA512:
-  metadata.gz: 71a45ddf739c64355197e1a0610d2441eb6445eb6d77eef8fd9cf711265d0a9fc23dfcf2d75075115bf1e546141fec7eab0e20c6469feff6b7dea238d4916951
-  data.tar.gz: 1bb4bc56c9310d94d682454b33c3d28ebc0a45753ee292c98cdee47bc94b3400c50ddbbb9c1f08b17ade330829760b4dbc1eef85ea22faf1aa8f9271e1b53e0f
+  metadata.gz: 7a059a91051aee0fa59beb62aa7bd952b1c8db15a75d66c47a66fdbda96a60cd9285094524e1d3c619ec215fa47dc5f9ee44e4dd7524f6c2bd60a4d0dfcf25e3
+  data.tar.gz: 9748ad5293f1e3cc902d9b74bbb40997d0c9588e43e78ab4299eb4ddbb9bfd030a7f3bf717d58a3207ac51e348cc090b1a726d7f63780d705807e04db7d9201d

data/.circleci/config.yml

@@ -32,15 +32,16 @@ jobs:
       - run: bundle install --jobs 4
       - run: bundle exec rubocop
       - run: bundle exec rspec
+      - run: bundle exec steep check
 
 build_jobs: &build_jobs
   - rspec:
       matrix:
         parameters:
           version:
-            - "2.5"
             - "2.7"
-            - "3.0"
+            - "3.0.1"
+            - "3.0.2"
 workflows:
   version: 2
   build:

data/.github/workflows/ruby.yml

@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.5', '2.7', '3.0']
+        ruby-version: ['2.7', '3.0.1']
 
     steps:
     - uses: actions/checkout@v2
@@ -24,10 +24,11 @@ jobs:
     # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
     # change this to (see https://github.com/ruby/setup-ruby#versioning):
     # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
     - name: Run tests
-      run: bundle exec rubocop
-      run: bundle exec rake
+      run: |-
+        bundle exec rake
+        bundle exec steep check

data/.ruby-version

@@ -1 +1 @@
-3.0.1
+3.0.2

data/CHANGELOG.md

@@ -1,5 +1,11 @@
+## [0.1.9] - 2021-10-20
+- 左スティックを傾けた時に設定した最大値内に丸めることができるようになりました
+    - 関連メソッド: set_neutral_position, left_analog_stick_cap
+- 数時間に一度起きる、数秒間入力が通らなくなる問題の改善
+
 ## [0.1.8] - 2021-09-19
--  使える場合、GC.auto_compactを有効にする
+- 使える場合、GC.auto_compactを有効にしました
+- 起動ログにuptimeからの経過時間を表示しました
 
 ## [0.1.7] - 2021-09-11
 - Support pbmenv

data/Gemfile

@@ -10,3 +10,7 @@ gem "rspec"
 gem "pry"
 gem "timecop"
 gem "rubocop", require: false
+gem "steep", require: false
+gem 'rbs', require: false
+gem "sinatra", require: false
+gem "webrick", require: false

data/Gemfile.lock

@@ -1,23 +1,47 @@
 PATH
   remote: .
   specs:
-    procon_bypass_man (0.1.8)
+    procon_bypass_man (0.1.9)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     ast (2.4.2)
     coderay (1.1.3)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
+    ffi (1.15.4)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    language_server-protocol (3.16.0.3)
+    listen (3.7.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
     method_source (1.0.0)
+    minitest (5.14.4)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
     parallel (1.20.1)
     parser (3.0.2.0)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    rack (2.2.3)
+    rack-protection (2.1.0)
+      rack
     rainbow (3.0.0)
     rake (13.0.6)
+    rb-fsevent (0.11.0)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rbs (1.6.2)
     regexp_parser (2.1.1)
     rexml (3.2.5)
     rspec (3.10.0)
@@ -45,8 +69,30 @@ GEM
     rubocop-ast (1.11.0)
       parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    sinatra (2.1.0)
+      mustermann (~> 1.0)
+      rack (~> 2.2)
+      rack-protection (= 2.1.0)
+      tilt (~> 2.0)
+    steep (0.46.0)
+      activesupport (>= 5.1)
+      language_server-protocol (>= 3.15, < 4.0)
+      listen (~> 3.0)
+      parallel (>= 1.0.0)
+      parser (>= 3.0)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (>= 1.2.0)
+      terminal-table (>= 2, < 4)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    tilt (2.0.10)
     timecop (0.9.4)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.0.0)
+    webrick (1.7.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   arm-linux
@@ -58,9 +104,13 @@ DEPENDENCIES
   procon_bypass_man!
   pry
   rake (~> 13.0)
+  rbs
   rspec
   rubocop
+  sinatra
+  steep
   timecop
+  webrick
 
 BUNDLED WITH
-   2.2.15
+   2.2.22

data/README.md

@@ -1,4 +1,6 @@
 # ProconBypassMan
+[![Ruby](https://github.com/splaplapla/procon_bypass_man/actions/workflows/ruby.yml/badge.svg?branch=master)](https://github.com/splaplapla/procon_bypass_man/actions/workflows/ruby.yml)
+
 * Switchに繋いだプロコンを連射機にしたり、キーのリマップをしたり、マクロを実行できるツールです
     * 設定ファイルはrubyスクリプトで記述します
 * 特定のタイトルに特化した振る舞いにしたい時は各プラグインを使ってください
@@ -70,6 +72,15 @@ end
 sudo kill -USR2 `cat ./pbm_pid`
 ```
 
+### 起動ログをサーバに送信する
+* `ProconBypassMan.api_server = "http://.."` を設定すると、 `POST /api/reports` に対して起動ログを送信するようになります
+
+### 開発環境でログの送信を確認する方法
+* `bundle exec bin/report_receive_server.rb`
+* `bin/console`
+  * `ProconBypassMan.api_server = "http://localhost:4567"`
+  * `message = ProconBypassMan::BootMessage.new; ProconBypassMan::Reporter.report(body: message.to_hash)"`
+
 ### リリース手順
 * project_template/app.rb, lib/procon_bypass_man/version.rb のバージョンをあげる
 * be rake release

data/Steepfile

@@ -0,0 +1,39 @@
+# D = Steep::Diagnostic
+#
+# target :lib do
+#   signature "sig"
+#
+#   check "lib"                       # Directory name
+#   check "Gemfile"                   # File name
+#   check "app/models/**/*.rb"        # Glob
+#   # ignore "lib/templates/*.rb"
+#
+#   # library "pathname", "set"       # Standard libraries
+#   # library "strong_json"           # Gems
+#
+#   # configure_code_diagnostics(D::Ruby.strict)       # `strict` diagnostics setting
+#   # configure_code_diagnostics(D::Ruby.lenient)      # `lenient` diagnostics setting
+#   # configure_code_diagnostics do |hash|             # You can setup everything yourself
+#   #   hash[D::Ruby::NoMethod] = :information
+#   # end
+# end
+
+# target :test do
+#   signature "sig", "sig-private"
+#
+#   check "test"
+#
+#   # library "pathname", "set"       # Standard libraries
+# end
+
+target :lib do
+  check "lib/procon_bypass_man/timer.rb"
+  check "lib/procon_bypass_man/uptime.rb"
+  check "lib/procon_bypass_man/configuration.rb"
+
+  signature "sig"
+
+  library "time"
+  library "logger"
+  library "monitor"
+end

data/bin/report_receive_server.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "sinatra"
+require "webrick"
+require "pry"
+
+post '/api/reports' do
+  puts JSON.parse(request.body.read)
+  status 200
+  body ''
+end

data/docs/setup_raspi.mitamae.rb

@@ -41,6 +41,18 @@ 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
+  not_if "rbenv versions | grep 3.0.1"
+  command "rbenv install 3.0.1"
+end
+
 run_command 'sudo systemctl disable triggerhappy.socket'
 run_command 'sudo systemctl disable triggerhappy.service'
 run_command 'sudo systemctl disable bluetooth'

data/lib/procon_bypass_man/analog_stick_position.rb

@@ -0,0 +1,14 @@
+class AnalogStickPosition
+  def initialize(x: , y: )
+    @x = x
+    @y = y
+  end
+
+  def y
+    @y
+  end
+
+  def x
+    @x
+  end
+end

data/lib/procon_bypass_man/boot_message.rb

@@ -0,0 +1,40 @@
+class ProconBypassMan::BootMessage
+  def initialize
+    @table = {}
+    @table[:ruby_version] = RUBY_VERSION
+    @table[:pbm_version] = ProconBypassMan::VERSION
+    @table[:pid] = $$
+    @table[:root_path] = ProconBypassMan.root
+    @table[:pid_path] = ProconBypassMan.pid_path
+    @table[:setting_path] = ProconBypassMan::Configuration.instance.setting_path
+    @table[:uptime_from_boot] = ProconBypassMan::Uptime.from_boot
+
+    build_version = `git rev-parse --short HEAD`.chomp
+    if build_version.empty?
+      @table[:build_version] = 'release version'
+    else
+      @table[:build_version] = build_version
+    end
+  end
+
+  # @return [String]
+  def to_s
+    booted_message = <<~EOF
+      ----
+      RUBY_VERSION: #{@table[:ruby_version]}
+      ProconBypassMan: #{@table[:pbm_version]}
+      pid: #{@table[:pid]}
+      root: #{@table[:root_path]}
+      pid_path: #{@table[:pid_path]}
+      setting_path: #{@table[:setting_path]}
+      uptime from boot: #{@table[:uptime_from_boot]} sec
+      build version: #{@table[:build_version]}
+      ----
+    EOF
+  end
+
+  # @return [Hash]
+  def to_hash
+    @table
+  end
+end

data/lib/procon_bypass_man/bypass.rb

@@ -1,5 +1,6 @@
 class ProconBypassMan::Bypass
   attr_accessor :gadget, :procon, :monitor
+
   def initialize(gadget: , procon: , monitor: )
     self.gadget = gadget
     self.procon = procon
@@ -11,12 +12,13 @@ class ProconBypassMan::Bypass
     monitor.record(:start_function)
     input = nil
     begin
-      sleep($will_interval_1_6)
-      input = self.gadget.read_nonblock(128)
+      return if $will_terminate_token
+      # TODO blocking readにしたい
+      input = self.gadget.read_nonblock(64)
       ProconBypassMan.logger.debug { ">>> #{input.unpack("H*")}" }
     rescue IO::EAGAINWaitReadable
       monitor.record(:eagain_wait_readable_on_read)
-      return if $will_terminate_token
+      sleep(0.001)
       retry
     end
 
@@ -26,23 +28,34 @@ class ProconBypassMan::Bypass
       monitor.record(:eagain_wait_readable_on_write)
       return
     end
+
     monitor.record(:end_function)
   end
 
   def send_procon_to_gadget!
     monitor.record(:start_function)
     output = nil
+
     begin
-      sleep($will_interval_0_0_0_5)
-      output = self.procon.read_nonblock(128)
-      ProconBypassMan.logger.debug { "<<< #{output.unpack("H*")}" }
+      return if $will_terminate_token
+      Timeout.timeout(1) do
+        output = self.procon.read(64)
+        ProconBypassMan.logger.debug { "<<< #{output.unpack("H*")}" }
+      end
+    rescue Timeout::Error
+      ProconBypassMan.logger.debug { "read timeout! do sleep. by send_procon_to_gadget!" }
+      ProconBypassMan.error_logger.error { "read timeout! do sleep. by send_procon_to_gadget!" }
+      monitor.record(:eagain_wait_readable_on_read)
+      retry
     rescue IO::EAGAINWaitReadable
+      ProconBypassMan.logger.debug { "EAGAINWaitReadable" }
       monitor.record(:eagain_wait_readable_on_read)
-      return if $will_terminate_token
+      sleep(0.005)
       retry
     end
 
     begin
+      # ProconBypassMan::Procon::DebugDumper.new(binary: output).dump_analog_sticks
       self.gadget.write_nonblock(ProconBypassMan::Processor.new(output).process)
     rescue IO::EAGAINWaitReadable
       monitor.record(:eagain_wait_readable_on_write)

data/lib/procon_bypass_man/configuration/layer.rb

@@ -1,13 +1,14 @@
 module ProconBypassMan
   class Configuration
     class Layer
-      attr_accessor :mode, :flips, :macros, :remaps
+      attr_accessor :mode, :flips, :macros, :remaps, :left_analog_stick_caps
 
-      def initialize(mode: :manual, &block)
+      def initialize(mode: :manual)
         self.mode = mode
         self.flips = {}
         self.macros = {}
         self.remaps = {}
+        self.left_analog_stick_caps = {}
         instance_eval(&block) if block_given?
       end
 
@@ -50,7 +51,6 @@ module ProconBypassMan
         end
       end
 
-      PRESET_MACROS = [:fast_return]
       def macro(name, if_pressed: )
         if name.respond_to?(:name)
           macro_name = name.name.to_sym
@@ -72,6 +72,36 @@ module ProconBypassMan
         end
       end
 
+      def left_analog_stick_cap(cap: , if_pressed: nil, force_neutral: nil)
+        hash = { cap: cap }
+
+        case if_pressed
+        when TrueClass
+          raise "not support class"
+        when Symbol, String
+          if_pressed = [if_pressed]
+        when Array, FalseClass
+          # sono mama
+        when NilClass
+          if_pressed = nil
+        else
+          raise "not support if_pressed"
+        end
+
+        if 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
+
+        left_analog_stick_caps[if_pressed] = hash
+      end
+
       # @return [Array]
       def flip_buttons
         flips

data/lib/procon_bypass_man/configuration.rb

@@ -4,13 +4,13 @@ require "procon_bypass_man/configuration/layer"
 
 module ProconBypassMan
   class Configuration
-
     attr_accessor :layers,
       :setting_path,
       :mode_plugins,
       :macro_plugins,
       :context,
-      :current_context_key
+      :current_context_key,
+      :neutral_position
 
     def self.instance
       @@current_context_key ||= :main
@@ -35,13 +35,21 @@ module ProconBypassMan
       reset!
     end
 
-    MODES = [:manual]
-    def layer(direction, mode: :manual, &block)
-      if mode.respond_to?(:name)
-        mode_name = mode.name.to_sym
-      else
-        mode_name = mode
+    module ManualMode
+      def self.name
+        'manual'
       end
+    end
+    MODES = [:manual]
+    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 (MODES + ProconBypassMan::Procon::ModeRegistry.plugins.keys).include?(mode_name)
         raise("#{mode_name} mode is unknown")
       end
@@ -67,6 +75,11 @@ module ProconBypassMan
       self
     end
 
+    def set_neutral_position(x, y)
+      self.neutral_position = AnalogStickPosition.new(x: x, y: y)
+      self
+    end
+
     def prefix_keys
       @prefix_keys_for_changing_layer
     end
@@ -81,6 +94,7 @@ module ProconBypassMan
         left: Layer.new,
         right: Layer.new,
       }
+      @neutral_position = AnalogStickPosition.new(x: 2124, y: 1808)
     end
   end
 end

data/lib/procon_bypass_man/device_connector.rb

@@ -12,23 +12,6 @@ class ProconBypassMan::DeviceConnector
   PROCON_PATH = "/dev/hidraw0"
   PROCON2_PATH = "/dev/hidraw1"
 
-  # 画面で再接続ができたが状況は変わらない
-  def self.reset_connection!
-    s = new
-    s.add([
-      ["0000"],
-      ["0000"],
-      ["8005"],
-      ["0000"],
-      ["8001"],
-    ], read_from: :switch)
-    s.drain_all
-    s.read_procon
-    s.write_switch("213c910080005db7723d48720a800300000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000")
-    sleep(10) # いらないかも
-    s
-  end
-
   def self.connect
     s = new(throw_error_if_timeout: true, enable_at_exit: false)
     s.add([
@@ -75,7 +58,7 @@ class ProconBypassMan::DeviceConnector
         timer = ProconBypassMan::Timer.new
         begin
           timer.throw_if_timeout!
-          data = from_device(item).read_nonblock(128)
+          data = from_device(item).read_nonblock(64)
         rescue IO::EAGAINWaitReadable
           retry
         end
@@ -128,7 +111,7 @@ class ProconBypassMan::DeviceConnector
     timer = ProconBypassMan::Timer.new
     begin
       timer.throw_if_timeout!
-      data = switch.read_nonblock(128)
+      data = switch.read_nonblock(64)
       ProconBypassMan.logger.debug { " >>> #{data.unpack("H*")})" }
     rescue IO::EAGAINWaitReadable
       retry
@@ -163,7 +146,7 @@ class ProconBypassMan::DeviceConnector
     timer = ProconBypassMan::Timer.new
     begin
       timer.throw_if_timeout!
-      data = procon.read_nonblock(128)
+      data = procon.read_nonblock(64)
       ProconBypassMan.logger.error " <<< #{data.unpack("H*")})"
     rescue IO::EAGAINWaitReadable
       retry
@@ -184,7 +167,7 @@ class ProconBypassMan::DeviceConnector
     timer = ProconBypassMan::Timer.new
     begin
       timer.throw_if_timeout!
-      data = procon.read_nonblock(128)
+      data = procon.read_nonblock(64)
       ProconBypassMan.logger.debug { " <<< #{data.unpack("H*")})" }
     rescue IO::EAGAINWaitReadable
       retry
@@ -217,7 +200,7 @@ class ProconBypassMan::DeviceConnector
     timer = ProconBypassMan::Timer.new
     begin
       timer.throw_if_timeout!
-      data = switch.read_nonblock(128)
+      data = switch.read_nonblock(64)
       ProconBypassMan.logger.debug { " >>> #{data.unpack("H*")})" }
     rescue IO::EAGAINWaitReadable
       retry
@@ -281,7 +264,7 @@ class ProconBypassMan::DeviceConnector
 
     file = File.open(path, "w+")
     begin
-      file.read_nonblock(128)
+      file.read_nonblock(64)
     rescue EOFError
       file.close
       return false
@@ -303,12 +286,12 @@ class ProconBypassMan::DeviceConnector
     case
     when is_available_device?(PROCON_PATH)
       ProconBypassMan.logger.info "proconのデバイスファイルは#{PROCON_PATH}を使います"
-      @procon = File.open(PROCON_PATH, "w+")
-      @gadget = File.open('/dev/hidg0', "w+")
+      @procon = File.open(PROCON_PATH, "w+b")
+      @gadget = File.open('/dev/hidg0', "w+b")
     when is_available_device?(PROCON2_PATH)
       ProconBypassMan.logger.info "proconのデバイスファイルは#{PROCON2_PATH}を使います"
-      @procon = File.open(PROCON2_PATH, "w+")
-      @gadget = File.open('/dev/hidg0', "w+")
+      @procon = File.open(PROCON2_PATH, "w+b")
+      @gadget = File.open('/dev/hidg0', "w+b")
     else
       raise "/dev/hidraw0, /dev/hidraw1の両方見つかりませんでした"
     end

data/lib/procon_bypass_man/error_reporter.rb

@@ -0,0 +1,44 @@
+require "net/http"
+require "json"
+
+class ProconBypassMan::ErrorReporter
+  PATH = "/api/error_reports" # POST
+
+  class Client
+    def initialize
+      @server = ProconBypassMan.api_server
+      @hostname = `hostname`.chomp
+    end
+
+    def post(body: )
+      # TODO ここでvalidationする
+      if @server.nil?
+        ProconBypassMan.logger.info('送信先が未設定なのでスキップしました')
+        return
+      end
+
+      uri = URI.parse("#{@server}#{PATH}")
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme === "https"
+      response = http.post(
+        uri.path,
+        { report: body.full_message.to_json, hostname: @hostname }.to_json,
+        { "Content-Type" => "application/json" },
+      )
+      unless response.code == /^20/
+        ProconBypassMan.logger.error(response.body)
+      end
+    rescue => e
+      puts e
+      ProconBypassMan.logger.error(e)
+    end
+  end
+
+  def self.report(body: )
+    ProconBypassMan.logger.error(body)
+    Client.new.post(body: body)
+  rescue => e
+    ProconBypassMan.logger.error(e)
+  end
+end
+

data/lib/procon_bypass_man/io_monitor.rb

@@ -62,10 +62,13 @@ module ProconBypassMan
           }.join(", ")
           max_output_length = line.length
           sleep 0.7
-          print "\r"
-          print " " * max_output_length
-          print "\r"
-          print line
+
+          if ENV["PBM_FOREGROUND"]
+            print "\r"
+            print " " * max_output_length
+            print "\r"
+            print line
+          end
           ProconBypassMan.logger.debug { line }
           break if $will_terminate_token
         end