fusuma-plugin-sendkey 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23d68a2efd5f41fe72149b824d2ccb15d9153b70e177e0c6547c6fdc531d7015
-  data.tar.gz: 206d32b21db53813a0213aa6efa7f4005132332ad06f5d360bb57aed291bd61c
+  metadata.gz: e1f133065105c5e8bcdc9dd04873d6245cb3b6357a1a9f45a437cd0150b5a959
+  data.tar.gz: c6f759e41f007688902c837f1fedc65e00d70ee3a41bb8bc9baf28de48e3c8ed
 SHA512:
-  metadata.gz: d8565fdb87ae1ed53a903587c45fc529b780983e845be2f81601e72160244de3852fdc63d8d1f9960cb20c30b82e86713a4c56c393064cf67e04548f1c187323
-  data.tar.gz: 84f81cc005e1cfe105844f0108241a8e4c2c99f454a2ae5dbfa52023c4c094efb534f87f7c6f6705647b5f4fd556387c8d3ef6def58a6141c39cc94faa6dd6a2
+  metadata.gz: 6390589b886bc137bed6e4bbd4cab68b890d7660fbf09462aa471557c8c7533cff11f73cec2f25ce3875489ef3abd44e82999af2f400dbe619470f29e4d2e17b
+  data.tar.gz: 4f80040d29ff16b5184e2f2f51485e39e178a029da0aec8e2c647da9428bd08ab54f5814c49194eeccdfac012091e4235392768d02de71191fff8af3b9bf4f4f

data/.rubocop.yml

@@ -11,3 +11,10 @@ Metrics/LineLength:
   Max: 100
   Exclude:
     - "fusuma-plugin-*.gemspec"
+
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true

data/README.md

@@ -2,8 +2,8 @@
 
 [Fusuma](https://github.com/iberianpig/fusuma) plugin to send keyboard events
 
-* Emulate keyboard events with evdev
-* This plugin is wayland compatible and alternative to xdotool
+* Low-latency key event emulation with evdev
+* Alternative to xdotool available for X11 and Wayland
 
 ## Installation
 
@@ -11,8 +11,9 @@ Run the following code in your terminal.
 
 ### Install dependencies
 
+**NOTE: If you have installed ruby by apt, you must install ruby-dev.**
 ```sh
-$ sudo apt-get install libevdev-dev
+$ sudo apt-get install libevdev-dev ruby-dev
 ```
 
 ### Install fusuma-plugin-sendkey
@@ -27,18 +28,28 @@ $ sudo gem install fusuma-plugin-sendkey
 ```sh
 $ fusuma-sendkey -l
 ```
+If you want to look up a specific key, like the next song or the previous song, the `grep -i` refinement search is useful.
+
+```sh
+$ fusuma-sendkey -l | grep -i song
+NEXTSONG
+PREVIOUSSONG
+```
 
 ## Run fusuma-sendkey on Terminal
 
 * `fusuma-sendkey` command is available on your terminal
-* `fusuma-sendkey` can send multiple key events
-* Combine keys for pressing the same time with `+` 
+* `fusuma-sendkey` supports modifier keys and multiple key presses.
+Combine keys for pressing the same time with `+` 
 
 
 ```sh
 $ fusuma-sendkey LEFTCTRL+T # press ctrl key + t key
 ```
 
+Some of the keys found with `fusuma-sendkey -l` may actually be invalid keys.
+So test it once with `fusuma-sendkey <KEYCODE>` and then add it to config.yml.
+
 
 ## Add sendkey properties to config.yml
 
@@ -59,6 +70,26 @@ swipe:
       sendkey: "LEFTCTRL+W" # close tab
 ```
 
+
+### Specify keyboard by device name
+
+If you got following error message, try to set your keyboard name to `plugin.executors.sendkey_executor.device_name` on config.yml
+
+```shell
+$ fusuma-sendkey -l
+sendkey: Keyboard: /keyboard|Keyboard|KEYBOARD/ is not found
+```
+
+Set the following options to recognize keyboard only for the specified keyboard device.
+Open `~/.config/fusuma/config.yml` and add the following code at the bottom.
+
+```yaml
+plugin:
+  executors:
+    sendkey_executor:
+      device_name: 'YOUR KEYBOARD NAME'
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/iberianpig/fusuma-plugin-sendkey. 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/sendkey/device.rb

@@ -10,7 +10,7 @@ module Fusuma
         end
 
         def path
-          raise 'Keyboard is not found' if @evdev.nil?
+          raise 'Device path is not found' if @evdev.nil?
 
           @path ||= @evdev.file.path
         end

data/lib/fusuma/plugin/sendkey/keyboard.rb

@@ -10,19 +10,18 @@ module Fusuma
     module Sendkey
       # Emulate Keyboard
       class Keyboard
-        def initialize(name_pattern: nil)
-          name_pattern ||= 'keyboard'
+        def initialize(name_pattern: 'keyboard|Keyboard|KEYBOARD')
           device = find_device(name_pattern: name_pattern)
 
           if device.nil?
-            warn "sendkey: Keyboard /#{name_pattern}/ is not found"
+            warn "sendkey: Keyboard: /#{name_pattern}/ is not found"
             exit(1)
           end
 
           @device = Device.new(path: "/dev/input/#{device.id}")
         end
 
-        attr_writer :device
+        attr_reader :device
 
         # @param param [String]
         def type(param:)

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

@@ -3,7 +3,7 @@
 module Fusuma
   module Plugin
     module Sendkey
-      VERSION = '0.4.0'
+      VERSION = '0.5.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fusuma-plugin-sendkey
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - iberianpig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-25 00:00:00.000000000 Z
+date: 2020-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fusuma