fusuma-plugin-remap 0.9.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71eb89bd5884a491b87dc36ad65728e1069c9073ad9b1971ae989ed3cfad2e3f
-  data.tar.gz: 43dcf898d9ef9775e0d42b037f1e87daa0d1d36b7a367bcabb7211ce05300e5f
+  metadata.gz: b55e5ef616cbf48bc0a8c3a4c0b9b91dbed01c3b4dc87f53f09fa51ab6c34227
+  data.tar.gz: 1e34c8882e52d3191092576ab5d056d74c1ea0d130963a37304ce2a8bc6b0fdf
 SHA512:
-  metadata.gz: 8c5dd2a0bb627288f3ab2ba47f838f57022feb9786e0e99818a17201c57a7ca35a536b852200e44a7e700a86482cc17daf71594432cc89c6f22d7c90563301b8
-  data.tar.gz: 3631827a2d5eb1924adfee909f5d1cc721554089f4c2350e33cb063a83dcafb1d282a1b635c5945a2b2e7c525e16692c39c105fc76b47700b3f714162c06b07b
+  metadata.gz: bb30877c6629814e6aff80127aa63045e4901d416a568d1a6f0e7f268254509903df5df8d90382a7d739ea3b2a6b666a461f57d9af0ce00941152d2296953efd
+  data.tar.gz: f11178d8bf7c553a1568b67e1a62b4cb747d51c0b67008330b98b17228b82a5d41cecd5b4de2f259d2d572f539e4f55daaa75f79fdd7c3a2608ac4013a2473f7

data/README.md

@@ -86,6 +86,76 @@ plugin:
 This configuration allows you to specify which keys will trigger the emergency stop functionality.
 It is important to verify this keybind to ensure a swift response during unexpected situations.
 
+### Input Device Detection
+
+#### Keyboard
+
+configure `plugin.inputs.remap_keyboard_input` in `~/.config/fusuma/config.yml` to specify which physical keyboard to remap.
+
+If your external or built-in keyboard is not detected, run `libinput list-devices` to find its name and add a matching pattern under `keyboard_name_patterns`.
+
+```yaml
+plugin:
+  inputs:
+    remap_keyboard_input:
+      # By default, Fusuma will detect physical keyboards matching these patterns.
+      # You can specify multiple regular‐expression strings in an array.
+      keyboard_name_patterns:
+        # Default value
+        - keyboard|Keyboard|KEYBOARD
+
+      # Emergency stop key combination.
+      # Specify exactly two keys joined by '+'.
+      emergency_ungrab_keys: RIGHTCTRL+LEFTCTRL
+```
+
+You can customize `keyboard_name_patterns` like this:
+
+```yaml
+plugin:
+  inputs:
+    remap_keyboard_input:
+      keyboard_name_patterns:
+        - xremap                     # Virtual keyboard created by another remapper
+        - PFU Limited HHKB-Hybrid    # External keyboard
+        - keyboard|Keyboard|KEYBOARD # Default pattern
+```
+
+If your keyboard isn’t detected, run:
+
+```sh
+libinput list-devices
+```
+
+and add a suitable name pattern.
+
+#### Touchpad
+
+To specify touchpad name, configure `plugin.inputs.remap_touchpad_input`:
+
+```yaml
+plugin:
+  inputs:
+    remap_touchpad_input:
+      # By default, Fusuma will detect physical touchpads matching these patterns.
+      touchpad_name_patterns:
+        # Default values
+        - touchpad|Touchpad|TOUCHPAD
+        - trackpad|Trackpad|TRACKPAD
+```
+
+You can customize `touchpad_name_patterns` like this:
+
+```yaml
+plugin:
+  inputs:
+    remap_touchpad_input:
+      touchpad_name_patterns:
+        - Apple Inc. Magic Trackpad   # External Trackpad
+        - your touchpad device name   # Any other touchpad
+        - Touchpad|Trackpad           # match to "Touchpad" or "Trackpad"
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/iberianpig/fusuma-plugin-remap. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/lib/fusuma/plugin/inputs/remap_keyboard_input.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "fusuma/device"
 require_relative "../remap/keyboard_remapper"
 require_relative "../remap/layer_manager"
 
@@ -14,8 +13,7 @@ module Fusuma
         def config_param_types
           {
             emergency_ungrab_keys: [String],
-            keyboard_name_patterns: [Array, String],
-            touchpad_name_patterns: [Array, String]
+            keyboard_name_patterns: [Array, String]
           }
         end
 
@@ -49,8 +47,7 @@ module Fusuma
         def setup_remapper
           config = {
             emergency_ungrab_keys: config_params(:emergency_ungrab_keys),
-            keyboard_name_patterns: config_params(:keyboard_name_patterns),
-            touchpad_name_patterns: config_params(:touchpad_name_patterns)
+            keyboard_name_patterns: config_params(:keyboard_name_patterns)
           }
 
           layer_manager = Remap::LayerManager.instance

data/lib/fusuma/plugin/inputs/remap_keyboard_input.yml

@@ -1,7 +1,8 @@
 plugin:
   inputs:
     remap_keyboard_input:
-      keyboard_name_patterns: ["keyboard", "Keyboard", "KEYBOARD"]
+      keyboard_name_patterns: 
+        - keyboard|Keyboard|KEYBOARD
       emergency_ungrab_keys: RIGHTCTRL+LEFTCTRL
   buffers:
     keypress_buffer:

data/lib/fusuma/plugin/inputs/remap_touchpad_input.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-require "fusuma/device"
 require_relative "../remap/touchpad_remapper"
-# require_relative "../remap/layer_manager"
 
 module Fusuma
   module Plugin
@@ -36,22 +34,7 @@ module Fusuma
 
           gesture = "touch"
           finger = data["finger"]
-
-          # @touch_state ||= {}
-          # @mt_slot ||= 0
-          # @touch_state[@mt_slot] ||= {
-          #   MT_TRACKING_ID: nil,
-          #   X: nil,
-          #   Y: nil,
-          #   valid_touch_point: false
-          # }
-          # TODO: implement update touch_state
-          status =
-            if data["touch_state"].any? { |_, v| v["valid_touch_point"] }
-              "begin"
-            else
-              "end"
-            end
+          status = data["status"]
 
           Events::Records::GestureRecord.new(gesture: gesture, status: status, finger: finger, delta: nil)
         rescue EOFError => e
@@ -63,14 +46,14 @@ module Fusuma
         private
 
         def setup_remapper
-          internal_touchpad = TouchpadSelector.new(config_params(:touchpad_name_patterns)).select.first
-          if internal_touchpad.nil?
+          source_touchpads = TouchpadSelector.new(config_params(:touchpad_name_patterns)).select
+          if source_touchpads.empty?
             MultiLogger.error("No touchpad found: #{config_params(:touchpad_name_patterns)}")
             exit
           end
 
           MultiLogger.info("set up remapper")
-          MultiLogger.info("internal_touchpad: #{internal_touchpad.device_name}")
+          MultiLogger.info("touchpad: #{source_touchpads}")
 
           # layer_manager = Remap::LayerManager.instance
 
@@ -83,7 +66,7 @@ module Fusuma
             remapper = Remap::TouchpadRemapper.new(
               # layer_manager: layer_manager,
               fusuma_writer: fusuma_writer,
-              source_touchpad: internal_touchpad
+              source_touchpads: source_touchpads
             )
             remapper.run
           end

data/lib/fusuma/plugin/inputs/remap_touchpad_input.yml

@@ -1,4 +1,6 @@
 plugin:
   inputs:
     remap_touchpad_input:
-      touchpad_name_patterns: ["touchpad", "Touchpad", "TOUCHPAD"]
+      touchpad_name_patterns: 
+        - touchpad|Touchpad|TOUCHPAD
+        - trackpad|Trackpad|TRACKPAD

data/lib/fusuma/plugin/remap/keyboard_remapper.rb

@@ -3,6 +3,7 @@ require "msgpack"
 require "set"
 require_relative "layer_manager"
 require_relative "uinput_keyboard"
+require "fusuma/device"
 
 module Fusuma
   module Plugin
@@ -181,7 +182,7 @@ module Fusuma
 
         # @param [Array<Revdev::EventDevice>] keyboards
         def set_trap(keyboards)
-          @destroy = lambda do
+          @destroy = lambda do |status = 0|
             keyboards.each do |kbd|
               kbd.ungrab
             rescue Errno::EINVAL
@@ -195,11 +196,11 @@ module Fusuma
               # already destroyed
             end
 
-            exit 0
+            exit status
           end
 
           Signal.trap(:INT) { @destroy.call }
-          Signal.trap(:TERM) { @destroy.call }
+          Signal.trap(:TERM) { @destroy.call(1) }
         end
 
         # Emergency stop keybind for virtual keyboard
@@ -309,7 +310,7 @@ module Fusuma
 
         # Devices to detect key presses and releases
         class KeyboardSelector
-          def initialize(names = ["keyboard", "Keyboard", "KEYBOARD"])
+          def initialize(names)
             @names = names
           end
 

data/lib/fusuma/plugin/remap/touchpad_remapper.rb

@@ -13,11 +13,14 @@ module Fusuma
         VIRTUAL_TOUCHPAD_NAME = "fusuma_virtual_touchpad"
 
         # @param fusuma_writer [IO]
-        # @param source_touchpad [Revdev::Device]
-        def initialize(fusuma_writer:, source_touchpad:)
-          @source_touchpad = source_touchpad # original touchpad
+        # @param source_touchpads [Revdev::Device]
+        def initialize(fusuma_writer:, source_touchpads:)
+          @source_touchpads = source_touchpads # original touchpad
           @fusuma_writer = fusuma_writer # write event to fusuma_input
-          @palm_detector ||= PalmDetection.new(source_touchpad)
+
+          @palm_detectors = @source_touchpads.each_with_object({}) do |source_touchpad, palm_detectors|
+            palm_detectors[source_touchpad] = PalmDetection.new(source_touchpad)
+          end
 
           set_trap
         end
@@ -30,8 +33,14 @@ module Fusuma
           touch_state = {}
           mt_slot = 0
           finger_state = nil
+
+          prev_valid_touch = false
+          prev_status = nil
           loop do
-            IO.select([@source_touchpad.file]) # , @layer_manager.reader])
+            ios = IO.select(@source_touchpads.map(&:file)) # , @layer_manager.reader])
+            io = ios&.first&.first
+
+            touchpad = @source_touchpads.find { |t| t.file == io }
 
             ## example of input_event
             # Event: time 1698456258.380027, type 3 (EV_ABS), code 57 (ABS_MT_TRACKING_ID), value 43679
@@ -51,7 +60,7 @@ module Fusuma
             # Event: time 1698456258.382693, type 1 (EV_KEY), code 333 (BTN_TOOL_DOUBLETAP), value 1
             # Event: time 1698456258.382693, type 4 (EV_MSC), code 5 (MSC_TIMESTAMP), value 7100
             # Event: time 1698456258.382693, -------------- SYN_REPORT ------------
-            input_event = @source_touchpad.read_input_event
+            input_event = touchpad.read_input_event
 
             touch_state[mt_slot] ||= {MT_TRACKING_ID: nil, X: nil, Y: nil, valid_touch_point: false}
             syn_report = nil
@@ -71,14 +80,16 @@ module Fusuma
                 touch_state[mt_slot][:X] = input_event.value
               when Revdev::ABS_MT_POSITION_Y
                 touch_state[mt_slot][:Y] = input_event.value
-              when Revdev::ABS_X, Revdev::ABS_Y
-                # ignore
-              when Revdev::ABS_MT_PRESSURE
-                # ignore
-              when Revdev::ABS_MT_TOOL_TYPE
+              when Revdev::ABS_X, Revdev::ABS_Y,
+                Revdev::ABS_MT_PRESSURE,
+                Revdev::ABS_MT_TOOL_TYPE,
+                Revdev::ABS_MT_TOUCH_MAJOR,
+                Revdev::ABS_MT_TOUCH_MINOR,
+                Revdev::ABS_MT_ORIENTATION,
+                Revdev::ABS_PRESSURE
                 # ignore
               else
-                raise "unhandled event"
+                MultiLogger.warn "unhandled event: #{input_event.hr_type}, #{input_event.hr_code}, #{input_event.value}"
               end
             when Revdev::EV_KEY
               case input_event.code
@@ -108,23 +119,43 @@ module Fusuma
               when Revdev::SYN_DROPPED
                 MultiLogger.error "Dropped: #{input_event.value}"
               else
-                raise "unhandled event", "#{input_event.hr_type}, #{input_event.hr_code}, #{input_event.value}"
+                raise "unhandled event: #{input_event.hr_type}, #{input_event.hr_code}, #{input_event.value}"
               end
             else
-              raise "unhandled event", "#{input_event.hr_type}, #{input_event.hr_code}, #{input_event.value}"
+              raise "unhandled event: #{input_event.hr_type}, #{input_event.hr_code}, #{input_event.value}"
             end
 
             # TODO:
             # Remember the most recent valid touch position and exclude it if it is close to that position
             # For example, when dragging, it is possible to touch around the edge of the touchpad again after reaching the edge of the touchpad, so in that case, you do not want to execute palm detection
             if touch_state[mt_slot][:valid_touch_point] != true
-              touch_state[mt_slot][:valid_touch_point] = @palm_detector.palm?(touch_state[mt_slot])
+              touch_state[mt_slot][:valid_touch_point] = @palm_detectors[touchpad].palm?(touch_state[mt_slot])
             end
 
             if syn_report
+              # Whether any slot is valid (touching)
+              valid_touch = touch_state.any? { |_, st| st[:valid_touch_point] }
+
+              status =
+                if valid_touch
+                  prev_valid_touch ? "update" : "begin"
+                else
+                  prev_valid_touch ? "end" : "cancelled"
+                end
+
+              if status == prev_status
+                next
+              end
+
               # TODO: define format as fusuma_input
-              data = {finger: finger_state, touch_state: touch_state}
+              # TODO: Add data to identify multiple touchpads
+              data = {
+                finger: finger_state,
+                status: status
+              }
               @fusuma_writer.write(data.to_msgpack)
+              prev_status = status
+              prev_valid_touch = valid_touch
             end
           end
         rescue => e
@@ -141,7 +172,8 @@ module Fusuma
 
         def create_virtual_touchpad
           MultiLogger.info "Create virtual touchpad: #{VIRTUAL_TOUCHPAD_NAME}"
-          uinput.create_from_device(name: VIRTUAL_TOUCHPAD_NAME, device: @source_touchpad)
+          # NOTE: Use uinput to create a virtual touchpad that copies from first touchpad
+          uinput.create_from_device(name: VIRTUAL_TOUCHPAD_NAME, device: @source_touchpads.first)
         end
 
         def set_trap

data/lib/fusuma/plugin/remap/version.rb

@@ -3,7 +3,7 @@
 module Fusuma
   module Plugin
     module Remap
-      VERSION = "0.9.0"
+      VERSION = "0.11.0"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fusuma-plugin-remap
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.11.0
 platform: ruby
 authors:
 - iberianpig
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-19 00:00:00.000000000 Z
+date: 2025-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fusuma