fusuma-plugin-remap 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf0c73f3292a88f1488fc06d1c45c5bca19250df7e257063dcc78dbd74a78fb6
-  data.tar.gz: a78d663ef4cf53629c6b0d9dec965b1494e782814691564f5ce917bb02262e6e
+  metadata.gz: eb8fcbe6eb272ae081100e9faa67846308cc7a9adb4cfbff7af5b693ffbcbd3e
+  data.tar.gz: 310ff2f96642be97fda21211d8ca7ed87aa2b8682a2cf70797882c9168e4df0b
 SHA512:
-  metadata.gz: 9c79bdd354f1188569afd8fe45d7b4e42b5d2463307c8ef26ed74191113d8b38a639ab7c846223a6d30821cc012bb82a1a3b17eeb5d61e8198eb8abe76b785c4
-  data.tar.gz: 3c915a96eb1f285c294e368f25390864534c3ed0ba792a42722083f9796cb3717042e45a8adea477363aa805e38a66996c49820f5aa88636659e72cf6a6485ba
+  metadata.gz: 97b927263c174f2ffc7edf3648510a77c34433523b58373aa4e533a21fe2c2198c181922352c1044717fabdc02d3a093b0a8e091ab0b3e6ba003970151395d67
+  data.tar.gz: 8adf8cb9f59083639f0439a5107a0c8afd7f386aaef572db8f6bb85589585aad8aa939f12613120ced49f100a67646379227b728bed9ee80ad12d171039cd460

data/README.md

@@ -65,12 +65,26 @@ remap:
   SPACE: BTN_LEFT
 ```
 
-## Emergency stop keybind for virtual keyboard
+## Emergency Stop Keybind for Virtual Keyboard
 
-This is a special keybind for emergency stop. 
-If you press following keybind, physical keyboard will be ungrabbed and Fusuma process will be terminated.
+This plugin includes a special keybind for emergency stop. Pressing this key combination will ungrab the physical keyboard and terminate the Fusuma process. This feature is particularly useful in situations where the plugin or system becomes unresponsive.
 
-<kbd>RIGHTCTRL</kbd> → <kbd>LEFTCTRL</kbd>
+### How to Use
+To execute the emergency stop, press the following key combination(default):
+- <kbd>RIGHTCTRL</kbd> → <kbd>LEFTCTRL</kbd>
+
+### Configuration Example
+You can configure the emergency stop key in your Fusuma configuration file (`~/.config/fusuma/config.yml`) as follows:
+
+```yaml
+plugin:
+  inputs:
+    remap_keyboard_input:
+      emergency_ungrab_keys: RIGHTCTRL+LEFTCTRL # keybind
+```
+
+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.
 
 ## Contributing
 

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

@@ -13,6 +13,7 @@ module Fusuma
 
         def config_param_types
           {
+            emergency_ungrab_keys: [String],
             keyboard_name_patterns: [Array, String],
             touchpad_name_patterns: [Array, String]
           }
@@ -47,7 +48,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)
           }

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

@@ -2,6 +2,7 @@ plugin:
   inputs:
     remap_keyboard_input:
       keyboard_name_patterns: ["keyboard", "Keyboard", "KEYBOARD"]
+      emergency_ungrab_keys: RIGHTCTRL+LEFTCTRL
   buffers:
     keypress_buffer:
       source: remap_keyboard_input

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

@@ -103,9 +103,7 @@ module Fusuma
           MultiLogger.info("Reload keyboards: #{source_keyboards.map(&:device_name)}")
 
           set_trap(source_keyboards)
-          # TODO: Extract to a configuration file or make it optional
-          #       it should stop other remappers
-          set_emergency_ungrab_keybinds("RIGHTCTRL", "LEFTCTRL")
+          set_emergency_ungrab_keys(@config[:emergency_ungrab_keys])
           grab_keyboards(source_keyboards)
         rescue => e
           MultiLogger.error "Failed to reload keyboards: #{e.message}"
@@ -174,9 +172,9 @@ module Fusuma
             wait_release_all_keys(keyboard)
             begin
               keyboard.grab
-              MultiLogger.info "Grabbed #{keyboard.device_name}"
+              MultiLogger.info "Grabbed keyboard: #{keyboard.device_name}"
             rescue Errno::EBUSY
-              MultiLogger.error "Failed to grab #{keyboard.device_name}"
+              MultiLogger.error "Failed to grab keyboard: #{keyboard.device_name}"
             end
           end
         end
@@ -205,14 +203,31 @@ module Fusuma
         end
 
         # Emergency stop keybind for virtual keyboard
-        def set_emergency_ungrab_keybinds(first_key, second_key)
-          first_keycode = find_code_from_key(first_key)
-          second_keycode = find_code_from_key(second_key)
-          MultiLogger.info "Emergency ungrab keybind: #{first_key} + #{second_key}"
+        def set_emergency_ungrab_keys(keybind_string)
+          keybinds = keybind_string&.split("+")
+          # TODO: Extract to a configuration file or make it optional
+          #       it should stop other remappers
+          if keybinds&.size != 2
+            MultiLogger.error "Invalid emergency ungrab keybinds: #{keybinds}"
+            MultiLogger.error "Please set two keys separated by '+'"
+            MultiLogger.error <<~YAML
+              plugin:
+                inputs:
+                  remap_keyboard_input:
+                    emergency_ungrab_keys: RIGHTCTRL+LEFTCTRL
+            YAML
+
+            exit 1
+          end
+
+          MultiLogger.info "Emergency ungrab keybind: #{keybinds[0]}+#{keybinds[1]}"
+
+          first_keycode = find_code_from_key(keybinds[0])
+          second_keycode = find_code_from_key(keybinds[1])
 
           @emergency_stop = lambda do |prev, current|
             if (prev&.code == first_keycode && prev.value != 0) && (current.code == second_keycode && current.value != 0)
-              MultiLogger.info "Emergency ungrab keybind: #{first_key} + #{second_key}"
+              MultiLogger.info "Emergency ungrab keybind is pressed: #{keybinds[0]}+#{keybinds[1]}"
               @destroy.call
             end
           end
@@ -278,7 +293,7 @@ module Fusuma
         def released_all_keys?(device)
           # key status if all bytes are 0, the key is not pressed
           bytes = device.read_ioctl_with(Revdev::EVIOCGKEY)
-          bytes.unpack("C*").all? { |byte| byte == 0 }
+          bytes.unpack("C*").all?(0)
         end
 
         def wait_release_all_keys(device, &block)

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

@@ -3,7 +3,7 @@
 module Fusuma
   module Plugin
     module Remap
-      VERSION = "0.5.0"
+      VERSION = "0.6.0"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fusuma-plugin-remap
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - iberianpig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-09-02 00:00:00.000000000 Z
+date: 2024-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fusuma