procon_bypass_man 0.3.6 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f19608c134a980243f4e45da1a1685367dd4bffc114482682b5d8d6bef03a90
-  data.tar.gz: c0ce801d735e63e5d6a385854ad83abb08fe044342bda63b5d70d2d50b3589f4
+  metadata.gz: 1933db5fe8c39267f980712a5477a457277cdd3ce9148a81966c1e1d818805e8
+  data.tar.gz: 404ce5c7ada74a92afb5abf2b2f583c3fe1c87bbc4d3ae2372e0ff3f961d9245
 SHA512:
-  metadata.gz: 11e84f9b7fa368adc1cbbb8593aca61d2a1a362453a13c5b226912d490c82933d476072f11ecb36226657107aa68b08be734ac19ec8901b56a00deb980d218b9
-  data.tar.gz: 642a6813619dccbb9d28f634bb7bb866ec92a2ed34fac254336562ed462512b1e9eb6ec2672dae17727e9c6790651f4e481e24a9a919dbd87381e4a457c62796
+  metadata.gz: eeeb32ff42fc02d2b40b19be2a1eba55a9fc5ffc6a3f08af47b4ed86bb67edba60dc7ef409f892ba9ef21953a349abda01a28d04f4a4f99f0032382a68c2f904
+  data.tar.gz: 811f537dd6ea2659678911678022c02734a2a21ef099d7ed140067a56e88edf0fabc4aec8264c052e8e8e9759c54085a17ab7a72c668a338560250b880395e2f

data/.circleci/config.yml

@@ -119,6 +119,7 @@ build_jobs: &build_jobs
             - "3.0.1"
             - "3.0.2"
             - "3.1.2"
+            - "3.2.2"
   - bundle_install:
       matrix:
         parameters:
@@ -127,6 +128,7 @@ build_jobs: &build_jobs
             - "3.0.1"
             - "3.0.2"
             - "3.1.2"
+            - "3.2.2"
   - lint:
       matrix:
         parameters:
@@ -135,6 +137,7 @@ build_jobs: &build_jobs
             - "3.0.1"
             - "3.0.2"
             - "3.1.2"
+            - "3.2.2"
       requires:
         - bundle_install
   - type_check:
@@ -154,6 +157,7 @@ build_jobs: &build_jobs
             - "3.0.1"
             - "3.0.2"
             - "3.1.2"
+            - "3.2.2"
       requires:
         - bundle_install
 workflows:

data/.github/workflows/gitleacks.yml

@@ -7,6 +7,6 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 5
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v3
     - name: gitleaks-action
       uses: zricethezav/gitleaks-action@v1.6.0

data/.github/workflows/release.yml

@@ -11,7 +11,7 @@ jobs:
       contents: write
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         token: ${{ secrets.GITHUB_TOKEN }}
     - name: Set up Ruby 3.0.1

data/.github/workflows/ruby.yml

@@ -16,10 +16,10 @@ jobs:
     timeout-minutes: 5
     strategy:
       matrix:
-        ruby-version: ['3.0.1', '3.1.1']
+        ruby-version: ['3.0', '3.1', '3.2']
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Ruby
     # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
     # change this to (see https://github.com/ruby/setup-ruby#versioning):

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## [0.3.8] 2023-05-03
+* TCP/IP経由でPBMに入力ができるようになりました
+* 多重起動ができないようにしました
+* pbm-cloudとの連携時に、pbmenvを使っているかの判定を修正しました
+* actioncable(websocket)serverのURLをpbm-cloudから取得するようにしました
+
+## [0.3.7] 2023-04-06
+* PBM-Cloudと連携しているかをbootメッセージに表示ようになりました
+* シリアルポート経由でPBMに入力ができるようになりました
+
 ## [0.3.6] 2023-03-12
 - プロコンの入力状態をpbm-cloudサーバに送信できるようになりました
 

data/Gemfile

@@ -13,6 +13,7 @@ gem "rubocop", require: false
 gem "sinatra", require: false
 gem "webrick", require: false
 gem "stackprof", require: false
+gem "serialport" # シリアル通信をする時に必要。通常はいらない
 
 if Gem::Version.new(RUBY_VERSION) > Gem::Version.new("2.6.0")
   gem 'typeprof', require: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    procon_bypass_man (0.3.6)
+    procon_bypass_man (0.3.8)
       action_cable_client
       blue_green_process (= 0.1.4.2)
       pbmenv (>= 0.1.11)
@@ -38,7 +38,7 @@ GEM
     parallel (1.21.0)
     parser (3.0.3.2)
       ast (~> 2.4.1)
-    pbmenv (0.1.11)
+    pbmenv (0.1.12)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -80,6 +80,7 @@ GEM
       parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
+    serialport (1.3.2)
     set (1.0.3)
     sinatra (2.2.0)
       mustermann (~> 1.0)
@@ -134,6 +135,7 @@ DEPENDENCIES
   rbs
   rspec
   rubocop
+  serialport
   sinatra
   stackprof
   steep

data/README.md

@@ -11,7 +11,7 @@
 
 https://user-images.githubusercontent.com/1664497/171327108-f12f56a5-fc36-48da-95a5-65e976553a20.mov
 
-## 使うハードウェア
+## 必要なハードウェア
 * Nintendo Switch Proコントローラー
 * Switch本体とドック
 * Raspberry Pi4 (Raspberry Pi OS)
@@ -38,7 +38,7 @@ https://user-images.githubusercontent.com/1664497/171327108-f12f56a5-fc36-48da-9
 * レイヤーを切り替える方法は？
     * 設定ファイルに記述している `prefix_keys_for_changing_layer`の後ろにあるキーを同時押しながら、十字キーのどれかを押すことで任意のレイヤーに切り替わります
 * このツールでできることは？
-    * キーリマップ, 連射, マクロ
+    * キーリマップ, 連射, マクロ, 外部ツールからの入力
         * リマップは1つのキーを別のキーに割り当てます
     * 連射中には特定のキーの入力を無視したり、複数のキーをトリガーに連射することができます
 * どうしてsudoが必要なの？

data/bin/validate_external_input

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+# Usage:
+#   NOTE: JSON形式の文字列がどういう形で読み込まれるかを確認できます
+#   $ echo '{"hex":"hogehoge", "buttons": ["a","b", "zr"]}' | bin/validate_external_input
+#   => 読み取った値: {:hex=>"hogehoge", :buttons=>["a", "b", "zr"]}
+
+require "bundler/setup"
+require "json"
+require "procon_bypass_man"
+require "procon_bypass_man/external_input"
+
+begin
+  json_str = ARGF.read
+  external_data = ProconBypassMan::ExternalInput::ExternalData.parse!(json_str)
+  puts("読み取った値: #{{ hex: external_data.hex, buttons: external_data.buttons }}")
+rescue JSON::ParserError => e
+  puts "failed to parse JSON: #{e.message}"
+end

data/docs/getting_started.md

@@ -18,6 +18,8 @@
 * [設定ファイルの書き方がわからない、エラーが起きるとき](#設定ファイルの書き方がわからない、エラーが起きるとき)
 * [procon_bypass_manのアップグレード方法](#procon_bypass_manのアップグレード方法)
 * [procon_bypass_man_cloudについて](#procon_bypass_man_cloudについて)
+* [シリアルポート連携](#シリアルポート連携)
+* [TCPIP連携](#TCPIP連携)
 * [最適化について](#最適化について)
 
 ## はじめに
@@ -251,6 +253,32 @@ procon_bypass_man_cloudとの接続が完了後、Raspberry Piを起動時にpro
   
 セットアップ方法は https://pbm-cloud.jiikko.com/faq に書いています。
 
+## シリアルポート連携
+* [ラズベリーパイのシリアルポート(GPIO)へ書き込んでPBM経由してSwitchへ入力をする方法](/docs/setting/integration_external_input_serial_port.md)
+* [ラズベリーパイのシリアルポート(GPIO)に書き込むフォーマットについて](/docs/setting/integration_external_input_serial_port_format.md)
+
+## TCPIP連携
+procon_bypass_man: 0.3.8 からTCP/IP経由で入力ができるようになりました。  
+書き込みフォーマットはJSONのみに対応しています。JSONの詳細な仕様については  [ラズベリーパイのシリアルポート(GPIO)に書き込むフォーマットについて](/docs/setting/integration_external_input_serial_port_format.md) を参照してください。  
+
+次は、PBM側の設定方法についてです。app.rbに以下の行を追加すると、連携するためのTCPサーバを起動するようになります。
+
+```diff
++ config.external_input_channels = [
++   ProconBypassMan::ExternalInput::Channels::TCPIPChannel.new(port: 9000),
++ ]
+```
+
+クライアント側のサンプル実装は次の通りです。これを実行するとAボタンを入力します。
+
+```ruby
+socket = TCPSocket.new('ras1.local', 9000)
+json = { buttons: [:a] }.to_json
+message = "#{json}\r\n"
+socket.write(message)
+puts socket.gets
+```
+
 ## 最適化について
 本稿では、Rubyの最適化について書きます。上級者向けです。適用しなくても普通に動きますが、逆に適用したことで何らかのケースで遅くなる場合があるかもしれません。
 

data/docs/setting/integration_external_input_serial_port.md

@@ -0,0 +1,56 @@
+# ラズベリーパイのシリアルポート(GPIO)へ書き込んでPBM経由してSwitchへ入力をする方法
+* procon_bypass_man: 0.3.7以上が必要です
+* GPIOからSwitchへ入力できます。本テキストでは設定方法を記載します
+
+## 1. シリアルポートへ書き込みができるようにラズベリーパイのセットアップする
+https://toki-blog.com/pi-serial/ の「汎用シリアルとして使う」 を実施してください
+
+## 2. GPIOへケーブルを挿す
+対応しているケーブルをGPIOとPCに接続してください。
+
+## 3. PBMのapp.rbを編集し、シリアルポートから読み出せるようにPBMのapp.rbを編集する
+`gemの追加`と`デバイスファイルを指す修正` の2つ必要です。
+
+* 1) シリアルポートから読み出すために追加でgemが必要です。 `app.rb` に `gem "serialport"` を追加してください。
+
+```diff
+  gemfile do
+    source 'https://rubygems.org'
+    git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+    gem 'procon_bypass_man', '0.3.7'
++   gem "serialport"
+  end
+```
+
+* 2) 以下を参考にして`config.external_input_channels`の行を追加してください。
+
+```diff
+ProconBypassMan.configure do |config|
+  config.root = File.expand_path(__dir__)
+  config.logger = Logger.new("#{ProconBypassMan.root}/app.log", 1, 1024 * 1024 * 1)
+  config.logger.level = :debug
+
+  # バイパスするログを全部app.logに流すか
+  config.verbose_bypass_log = false
+
+  # webからProconBypassManを操作できるwebサービスと連携します
+  # 連携中はエラーログ、パフォーマンスに関するメトリクスを送信します
+  # config.api_servers = 'https://pbm-cloud.jiikko.com'
+
+  # エラーが起きたらerror.logに書き込みます
+  config.enable_critical_error_logging = true
+
+  # pbm-cloudで使う場合はnever_exitにtrueをセットしてください. trueがセットされている場合、不慮の事故が発生してもプロセスが終了しなくなります
+  config.never_exit_accidentally = true
+
+  # 接続に成功したらコントローラーのHOME LEDを光らせるか
+  config.enable_home_led_on_connect = true
+
++ config.external_input_channels = [
++   ProconBypassMan::ExternalInput::Channels::SerialPortChannel.new(device_path: '/dev/serial0', baud_rate: 9600),
++ ]
+end
+```
+
+以上で設定は完了です。PBMを起動し、連携ツールからGPIOへ書き込んでください。  
+書き込みフォーマットについては [ラズベリーパイのシリアルポート(GPIO)に書き込むフォーマットについて](/docs/setting/integration_external_input_serial_port_format.md) を参照してください。

data/docs/setting/integration_external_input_serial_port_format.md

@@ -0,0 +1,36 @@
+# ラズベリーパイのシリアルポート(GPIO)に書き込むフォーマットについて
+* procon_bypass_man: 0.3.7からGPIOを経由してSwitchへ入力できるようになりました。本テキストではPBMが読み取れるフォーマットについて記載します
+
+## フォーマット
+JSON形式, plain textに対応しています
+
+* JSON形式
+    * 受付可能なカラム
+      * hex
+        * 16進数でエンコードした`INPUT 0x30` を書いてください。スティック操作を除くボタン部分のみが読み込まれます
+        * https://github.com/dekuNukem/Nintendo_Switch_Reverse_Engineering/blob/ac8093c84194b3232acb675ac1accce9bcb456a3/bluetooth_hid_notes.md#input-0x30
+        * ex: '30f28100800078c77448287509550274ff131029001b0022005a0271ff191028001e00210064027cff1410280020002100000000000000000000000000000000'
+      * buttons
+        * 「入力したいボタン」「入力したくないボタン」を配列で渡してください
+        * 「入力したいボタン」
+             * `"y", "x", "b", "a", "sl", "sr", "r", "zr", "minus", "plus", "thumbr", "thumbl", "home", "cap", "down", "up", "right", "left", "l", "zl"`
+        * 「入力したくないボタン」
+             * `"uny", "unx", "unb", "una", "unsl", "unsr", "unr", "unzr", "unminus", "unplus", "unthumbr", "unthumbl", "unhome", "uncap", "undown", "unup", "unright", "unleft", "unl", "unzl"`
+        * ex: `['a', 'b']`
+    * 仕様
+       * JSONにhex, buttonsの両方が含まれている場合、hexを優先し、buttonsは無視します
+    * JSONの例
+      * `'{"hex":"30f28100800078c77448287509550274ff131029001b0022005a0271ff191028001e00210064027cff1410280020002100000000000000000000000000000000", "buttons": ["a"] }'`
+* plain text
+  * コロンで囲ったボタンを1つの入力として解釈します
+  * `:a::b::uny:` を入力した場合には、a, b, uny を読み込みます
+
+## 正しいJSONかを検証する
+本リポジトリにJSONを検証する `bin/validate_external_input` を同梱しています。実行例を以下に示します。
+
+```shell
+$ echo '{"hex":"30f28100800078c77448287509550274ff131029001b0022005a0271ff191028001e00210064027cff1410280020002100000000000000000000000000000000", "buttons": ["a"] }' | bin/validate_external_input
+読み取った値: {:hex=>"30f28100800078c77448287509550274ff131029001b0022005a0271ff191028001e00210064027cff1410280020002100000000000000000000000000000000", :buttons=>[:a]}
+```
+
+以上。

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

@@ -21,6 +21,7 @@ class ProconBypassMan::ReportProconPerformanceMeasurementsJob < ProconBypassMan:
       time_taken_p50: metric.time_taken_p50,
       time_taken_p95: metric.time_taken_p95,
       time_taken_p99: metric.time_taken_p99,
+      external_input_time_max: metric.external_input_time_max,
       read_error_count: metric.read_error_count,
       write_error_count: metric.write_error_count,
       gc_count: metric.gc_count,

data/lib/procon_bypass_man/bypass/procon_to_switch.rb

@@ -50,14 +50,29 @@ class ProconBypassMan::Bypass::ProconToSwitch
         # 後続処理で入力値を取得できるように詰めておく
         ProconBypassMan::ProconDisplay::Status.instance.current = bypass_value.binary.to_procon_reader.to_hash
 
+        # NOTE: 外部からの入力を受け取る
+        external_input_data = nil
+        measurement.record_external_input_time do
+          # TODO: シリアルぽーとから読み取ると252.chrみたいなゴミデータを受け取ってEncoding::UndefinedConversionErrorが発生する可能性がある. 発生したら上限までretryした方がいいかも
+          if(data = ProconBypassMan::ExternalInput.read)
+            begin
+              external_input_data = ProconBypassMan::ExternalInput::ExternalData.parse!(data)
+              ProconBypassMan.logger.debug { "[ExternalInput] 読み取った値: { hex: #{external_input_data.hex}, raw_data: '#{external_input_data.raw_data}', buttons: #{external_input_data.buttons} }" }
+            rescue ProconBypassMan::ExternalInput::ParseError => e
+              ProconBypassMan.logger.error "[ExternalInput][#{e}] #{data.force_encoding('UTF-8').scrub}, #{data.force_encoding('ASCII-8BIT').codepoints} をparseできませんでした"
+            end
+          end
+        end
+
         result = measurement.record_write_time do
           begin
             ProconBypassMan::Retryable.retryable(tries: 5, on_no_retry: [Errno::EIO, Errno::ENODEV, Errno::EPROTO, IOError, Errno::ESHUTDOWN, Errno::ETIMEDOUT]) do
               begin
                 # 終了処理を希望されているのでブロックを無視してメソッドを抜けてOK
                 return(false) if will_terminate? # rubocop:disable Lint/NoReturnInBeginEndBlocks
+
                 binary = ::ProconBypassMan::Procon::Rumbler.monitor do
-                  ProconBypassMan::Processor.new(bypass_value.binary).process
+                  ProconBypassMan::Processor.new(bypass_value.binary).process(external_input_data: external_input_data)
                 end
                 self.gadget.write_nonblock(binary)
 

data/lib/procon_bypass_man/commands/print_boot_message_command.rb

@@ -10,7 +10,7 @@ class ProconBypassMan::PrintBootMessageCommand
       @table[:pid_path] = ProconBypassMan.pid_path
       @table[:setting_path] = ProconBypassMan::ButtonsSettingConfiguration.instance.setting_path
       @table[:uptime_from_boot] = ProconBypassMan::Uptime.from_boot
-      @table[:use_pbmenv] = !(!!`which pbmenv`.empty?)
+      @table[:use_pbmenv] = ProconBypassMan.root.start_with?(Pbmenv::PBM_DIR)
       @table[:session_id] = ProconBypassMan.session_id
       @table[:device_id] = ProconBypassMan.device_id
       @table[:never_exit_accidentally] = ProconBypassMan.config.never_exit_accidentally
@@ -34,6 +34,8 @@ class ProconBypassMan::PrintBootMessageCommand
       ProconBypassMan::VERSION: #{@table[:pbm_version]}
       RUBY_VERSION: #{@table[:ruby_version]}
       Pbmenv::VERSION: #{@table[:pbmenv_version]}
+      PBM-Cloud Integration: #{ProconBypassMan::WebConnectivityChecker.new(ProconBypassMan.config.api_server, ProconBypassMan.config.current_ws_server_url)}
+      ExternalInput Integration: #{ProconBypassMan::ExternalInput::BootMessage.new(channels: ProconBypassMan::ExternalInput.channels)}
       pid: #{@table[:pid]}
       root: #{@table[:root_path]}
       pid_path: #{@table[:pid_path]}
@@ -56,6 +58,7 @@ class ProconBypassMan::PrintBootMessageCommand
   def self.execute
     message = BootMessage.new
     ProconBypassMan::ReportBootJob.perform_async(message.to_hash)
+    ProconBypassMan.logger.info message.to_s
     puts message.to_s
   end
 end

data/lib/procon_bypass_man/configuration.rb

@@ -19,9 +19,11 @@ class ProconBypassMan::Configuration
       @@pid_path ||= File.expand_path("#{root}/pbm_pid", __dir__).freeze
     end
 
-    # @return [Integer]
+    # @return [Integer, nil]
     def pid
       File.read(pid_path).to_i
+    rescue Errno::ENOENT
+      nil
     end
 
     def digest_path
@@ -54,6 +56,7 @@ class ProconBypassMan::Configuration
 
   attr_accessor :enable_critical_error_logging
   attr_writer :verbose_bypass_log, :raw_setting, :never_exit_accidentally, :enable_home_led_on_connect
+  attr_writer :external_input_channels
   # 削除予定
   attr_writer :enable_reporting_pressed_buttons
 
@@ -69,6 +72,7 @@ class ProconBypassMan::Configuration
     if defined?(@root)
       @root
     else
+      ProconBypassMan.logger.warn 'root pathが未設定です'
       File.expand_path('..', __dir__ || ".").freeze
     end
   end
@@ -125,22 +129,30 @@ class ProconBypassMan::Configuration
   end
 
   # @return [String, NilClass]
-  def current_ws_server
-    if (uri = URI.parse(api_server))
-      if uri.port == 443
-        return "ws://#{uri.host}"
+  def current_ws_server_url
+    return @current_ws_server_url if defined?(@current_ws_server_url)
+    return unless api_server
+
+    response_json = ProconBypassMan::HttpClient.new(server: api_server, path: '/api/v1/configuration').get
+    ws_server_url = response_json&.fetch("ws_server_url", nil)
+
+    begin
+      uri = URI.parse(ws_server_url)
+      if uri.scheme == 'ws'
+        @current_ws_server_url = uri.to_s
+        return @current_ws_server_url
+      elsif uri.scheme == 'wss' # NOTE:  SSL_CTX_use_certificate: ee key too small (OpenSSL::SSL::SSLError) が起きるので
+        uri.scheme = 'ws'
+        @current_ws_server_url = uri.to_s
+        return @current_ws_server_url
       else
-        return "ws://#{uri.host}:#{uri.port}"
+        ProconBypassMan.logger.warn { "#{ws_server_url} is invalid." }
+        return nil
       end
+    rescue URI::InvalidURIError => e
+      ProconBypassMan.logger.warn { "#{ws_server_url} is invalid. #{e}" }
+      nil
     end
-  rescue URI::InvalidURIError
-    nil
-  end
-
-  # @return [String, NilClass]
-  def current_ws_server_url
-    return unless current_ws_server
-    "#{current_ws_server}/websocket/"
   end
 
   # @return [Boolean]
@@ -193,4 +205,9 @@ class ProconBypassMan::Configuration
       true
     end
   end
+
+  # @return [Array<ProconBypassMan::ExternalInput::Channel::TCPIP, ProconBypassMan::ExternalInput::Channel::SerialPort>]
+  def external_input_channels
+    @external_input_channels || []
+  end
 end

data/lib/procon_bypass_man/external_input/boot_message.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ProconBypassMan
+  module ExternalInput
+    class BootMessage
+      # @return [ProconBypassMan::ExternalInput::Channels::Base]
+      def initialize(channels: )
+        @channels = channels
+      end
+
+      # @return [String]
+      def to_s
+        if @channels.nil? or @channels.empty?
+          return 'DISABLE'
+        end
+
+        @channels.map(&:display_name_for_boot_message).join(', ')
+      end
+    end
+  end
+end

data/lib/procon_bypass_man/external_input/channels/base.rb

@@ -0,0 +1,22 @@
+module ProconBypassMan
+  module ExternalInput
+    module Channels
+      class Base
+        # @return [String, NilClass]
+        def read
+          raise NotImplementedError
+        end
+
+        # @return [void]
+        def shutdown
+          raise NotImplementedError
+        end
+
+        # @return [String]
+        def display_name_for_boot_message
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/procon_bypass_man/external_input/channels/serial_port_channel.rb

@@ -0,0 +1,56 @@
+module ProconBypassMan
+  module ExternalInput
+    module Channels
+      class SerialPortChannel < Base
+        attr_reader :serial_port
+
+        # @param [String] device_path
+        # @param [Integer] baud_rate
+        def initialize(device_path: , baud_rate: 9600)
+          require 'serialport'
+
+          super()
+          # data_bitsあたりは必要があれば設定ができるようにしたいがよくわからないのでとりあえずnilを入れる
+          data_bits = 8
+          stop_bits = 1
+          parity = SerialPort::NONE
+          @serial_port = SerialPort.new(device_path, baud_rate, data_bits, stop_bits, parity)
+        end
+
+        # @return [String, NilClass]
+        # NOTE: この実装では、::IO::EAGAINWaitReadableを実質的な終端として扱っているので、高速に書き込みがされると取りこぼす可能性がある.
+        # NOTE: read_nonblockでバッファから読み出すとき、バッファが空になるまでは::IO::EAGAINWaitReadableが起きない前提で実装している.
+        # NOTE: 取りこぼししないよう精度を上げるには、終端文字が来るまで1文字ずつ読む必要があるがパフォーマンスが犠牲になってしまう. この対策をするには、bypass処理の開始で非同期に1文字ずつ読み込むことをすると多少マシになるはず
+        def read
+          buffer = ''
+          loop do
+            begin
+              buffer += @serial_port.read_nonblock(1024) || ''
+            rescue ::IO::EAGAINWaitReadable
+              break
+            end
+          end
+
+          return nil if buffer.empty?
+
+          # NOTE: 高速に書き込まれた場合、複数のチャンクを含む可能性があるので、最初だけを切り取る
+          chunks = buffer.split("\n")
+          if(chunks.size > 1)
+            ProconBypassMan::SendErrorCommand.execute(
+              error: "[ExternalInput] シリアルポートから読み込んだchunkが複数あります. 高い書き込み頻度に耐えられていないので実装を見直してください。 (chunks.size: #{chunks.size})"
+            )
+          end
+          chunks.first
+        end
+
+        def shutdown
+          # no-op
+        end
+
+        def display_name_for_boot_message
+          'SerialPort'
+        end
+      end
+    end
+  end
+end