fusuma-plugin-thumbsense 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d52fd9c01f2bd94ab5ec05ba4c4d6abc1c7d38c6f33d136cf4aa34df71355c4e
+  data.tar.gz: fd096d77f2d0b1e9fa839004f2ea8d57f8724a324682a8bf98141abaef6d04d2
+SHA512:
+  metadata.gz: 06e6df1b845c55b9383cbdf179e978dfbe71767905df558db409f936262c0bab95282d9eacd6565fb0320df76f99be969fb693f55c245e1e58a9f10dcf8cc986
+  data.tar.gz: dfa00e0a3ff211ee5526be0c6047f05c8d75436c1b042ef7f30cc9ce2b3202a77df0d2d9321afc7d9a9240a811e52866d3e60b088711a6e8ac02074a627c92a5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 iberianpig
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+# Fusuma::Plugin::Thumbsense [![Gem Version](https://badge.fury.io/rb/fusuma-plugin-thumbsense.svg)](https://badge.fury.io/rb/fusuma-plugin-thumbsense) [![Build Status](https://github.com/iberianpig/fusuma-plugin-thumbsense/actions/workflows/ubuntu.yml/badge.svg)](https://github.com/iberianpig/fusuma-plugin-thumbsense/actions/workflows/ubuntu.yml)
+
+**THIS PLUGIN IS EXPERIMENTAL.**
+
+ThumbSense plugin for [Fusuma](https://github.com/iberianpig/fusuma)
+
+ThumbSense is a tool that lets you control a laptop's touchpad using the keyboard. It assigns certain keyboard keys as mouse buttons and switches between acting as mouse buttons or normal keyboard keys based on whether the user's thumb is touching the touchpad. ThumbSense aims to make it easier to use the touchpad without moving your hand away from the keyboard.
+
+[ThumbSense](https://www2.sonycsl.co.jp/person/rekimoto/tsense/soft/index.html)
+
+## Installation
+
+Run the following code in your terminal.
+
+### Install fusuma-plugin-thumbsense
+
+This plugin requires [fusuma](https://github.com/iberianpig/fusuma#update) 2.0 or later and [fusuma-plugin-keypress](https://github.com/iberianpig/fusuma-plugin-keypress) 0.5 or later.
+
+```sh
+$ sudo gem install fusuma-plugin-thumbsense
+```
+
+### Add show-keycodes option
+
+Open `~/.config/fusuma/config.yml` and add the following code at the bottom.
+
+```yaml
+plugin:
+  inputs:
+    libinput_command_input:
+      show-keycodes: true
+```
+
+**NOTE: fusuma can read your keyboard inputs if show-keycodes option is true**
+
+## Properties
+
+### Thumbsense
+
+First, add the `thumbsense` context to `~/.config/fusuma/config.yml`.
+The context is separated by `---` and specified by `context: thumbsense`.
+
+## Example
+
+Set the following code in `~/.config/fusuma/config.yml`.
+
+```yaml
+---
+context: thumbsense
+
+remap:
+  J: BTN_LEFT
+  K: BTN_RIGHT
+```
+
+### TODO
+
+- Using the fusuma-plugin-sendkey to emulate mouse buttons
+- Creating a simple key remapper using evdev and uinput to prevent the pressing of J/K keys on the physical keyboard from being sent.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/iberianpig/fusuma-plugin-thumbsense. 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Fusuma::Plugin::Thumbsense project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/iberianpig/fusuma-plugin-thumbsense/blob/master/CODE_OF_CONDUCT.md).

data/bin/console

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "fusuma/plugin/manager"
+Fusuma::Plugin::Manager.require_base_plugins
+require "fusuma/plugin/remap"
+require "fusuma/plugin/thumbsense"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fusuma-plugin-thumbsense.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "fusuma/plugin/thumbsense/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "fusuma-plugin-thumbsense"
+  spec.version = Fusuma::Plugin::Thumbsense::VERSION
+  spec.authors = ["iberianpig"]
+  spec.email = ["yhkyky@gmail.com"]
+
+  spec.summary = "Thumbsense plugin for Fusuma "
+  spec.description = "fusuma-plugin-thumbsense is Fusuma plugin for thumbsense."
+  spec.homepage = "https://github.com/iberianpig/fusuma-plugin-thumbsense"
+  spec.license = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  spec.files = Dir["{bin,lib,exe}/**/*", "LICENSE*", "README*", "*.gemspec"]
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.5.1" # https://packages.ubuntu.com/search?keywords=ruby&searchon=names&exact=1&suite=all&section=main
+  # support bionic (18.04LTS) 2.5.1
+  spec.add_dependency "fusuma", "~> 2.0"
+  spec.add_dependency "fusuma-plugin-keypress", ">= 0.5"
+  spec.add_dependency "fusuma-plugin-remap"
+  spec.metadata = {
+    "rubygems_mfa_required" => "true"
+  }
+end

data/lib/fusuma/plugin/buffers/thumbsense_buffer.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Fusuma
+  module Plugin
+    module Buffers
+      # manage events and generate command
+      class ThumbsenseBuffer < Buffer
+        DEFAULT_SOURCE = "thumbsense_parser"
+
+        def config_param_types
+          {
+            source: [String]
+          }
+        end
+
+        # clear old events
+        def clear_expired(*)
+          return if @events.empty?
+
+          # skip palm/begin record
+          return if !ended?(@events.last)
+
+          released_finger = @events.last.record.finger
+          @events.delete_if { |e| e.record.finger == released_finger }
+        end
+
+        # @param event [Event]
+        # @return [NilClass, ThumbsenseBuffer]
+        def buffer(event)
+          return if event&.tag != source
+
+          @events.push(event)
+          self
+        end
+
+        # return [Integer]
+        def finger
+          @events.map { |e| e.record.finger }.max
+        end
+
+        def empty?
+          @events.empty?
+        end
+
+        def present?
+          !empty?
+        end
+
+        def select_by_events(&block)
+          return enum_for(:select) unless block
+
+          events = @events.select(&block)
+          self.class.new events
+        end
+
+        def ended?(event)
+          event.record.status == "end"
+        end
+
+        def begin?(event)
+          event.record.status == "begin"
+        end
+      end
+    end
+  end
+end

data/lib/fusuma/plugin/detectors/thumbsense_detector.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require "fusuma/plugin/detectors/detector"
+
+require "fusuma/plugin/remap/layer_manager"
+
+module Fusuma
+  module Plugin
+    module Detectors
+      # Detect Thumbsense context and change remap layer of fusuma-plugin-remap
+      class ThumbsenseDetector < Detector
+        SOURCES = %w[thumbsense gesture keypress].freeze
+        BUFFER_TYPE = "thumbsense"
+
+        MODIFIER_KEYS = Set.new(%w[
+          CAPSLOCK
+          LEFTALT
+          LEFTCTRL
+          LEFTMETA
+          LEFTSHIFT
+          RIGHTALT
+          RIGHTCTRL
+          RIGHTSHIFT
+          RIGHTMETA
+        ])
+
+        # @param buffers [Array<Buffer>]
+        # @return [Event] if event is detected
+        # @return [NilClass] if event is NOT detected
+        def detect(buffers)
+          thumbsense_buffer = buffers.find { |b| b.type == BUFFER_TYPE }
+
+          return if thumbsense_buffer.empty?
+
+          MultiLogger.debug("thumbsense_buffer: #{thumbsense_buffer.events.map(&:record).map { |r| "#{r.finger} #{r.gesture} #{r.status}" }}")
+
+          layer_manager = Fusuma::Plugin::Remap::LayerManager.instance
+          layer = {thumbsense: true}
+
+          if touch_released?(thumbsense_buffer)
+            layer_manager.send_layer(layer: layer, remove: true)
+            return
+          end
+
+          keypress_buffer = buffers.find { |b| b.type == "keypress" }
+          if pressed_codes(keypress_buffer).all? { |code| MODIFIER_KEYS.include?(code) }
+
+            # Even if the palm is detected, keep the thumbsense layer until `:end` event
+            if palm_detected?(thumbsense_buffer)
+              hold_events = fetch_hold_events(buffers)
+              MultiLogger.debug "hold_events: #{hold_events.map(&:record).map { |r| "#{r.finger} #{r.gesture} #{r.status}" }}"
+              if hold_events.empty? || hold_events.last.record.status != "begin"
+                layer_manager.send_layer(layer: layer, remove: true)
+                return
+              end
+            end
+
+            layer_manager.send_layer(layer: layer)
+            record = Events::Records::ContextRecord.new(
+              name: "thumbsense",
+              value: true
+            )
+            return create_event(record: record)
+          end
+          nil
+        end
+
+        # Change remap layer of fusuma-plugin-remap
+        # @param context [Hash]
+        def add_layer
+          Fusuma::Plugin::Remap::Layer.add({thumbsense: true})
+        end
+
+        # Remove remap layer of fusuma-plugin-remap
+        # @param context [Hash]
+        def remove_layer
+          Fusuma::Plugin::Remap::Layer.remove({thumbsense: true})
+        end
+
+        private
+
+        def fetch_hold_events(buffers)
+          buffers.find { |b| b.type == "gesture" }
+            .select_from_last_begin
+            .select_by_events { |e| e.record.gesture == "hold" }.events
+        end
+
+        def pressed_codes(keypress_buffer)
+          records = keypress_buffer.events.map(&:record)
+          codes = []
+          records.each do |r|
+            if r.status == "pressed"
+              codes << r.code
+            else
+              codes.delete_if { |code| code == r.code }
+            end
+          end
+          codes
+        end
+
+        def touching?(thumbsense_buffer)
+          !touch_released?(thumbsense_buffer)
+        end
+
+        # @return [TrueClass, FalseClass]
+        def touch_released?(thumbsense_buffer)
+          thumbsense_events = thumbsense_buffer.events
+          touch_num = thumbsense_events.count { |e| (e.record.status == "begin") }
+          release_num = thumbsense_events.count { |e| e.record.status == "end" }
+
+          touch_num <= release_num
+        end
+
+        def palm_detected?(thumbsense_buffer)
+          thumbsense_buffer.events.any? { |e| (e.record.status == "palm") }
+        end
+
+        def palm_count(thumbsense_buffer)
+          thumbsense_buffer.events.count { |e| (e.record.status == "palm") }
+        end
+
+        def thumbsense_keys
+        end
+      end
+    end
+  end
+end

data/lib/fusuma/plugin/filters/thumbsense_filter.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "fusuma/device"
+
+module Fusuma
+  module Plugin
+    module Filters
+      # Filter keyboard events from libinput_command_input
+      class ThumbsenseFilter < Filter
+        DEFAULT_SOURCE = "libinput_command_input"
+
+        # @return [TrueClass] when keeping it
+        # @return [FalseClass] when discarding it
+        def keep?(record)
+          case record.to_s
+          when %r{\sevent\d+\s+-\sbutton state: touch (?<finger>[[:digit:]])}
+            true
+          when %r{\sevent\d+\s+-\spalm: touch (?<finger>[[:digit:]])}
+            true
+          else
+            false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fusuma/plugin/parsers/thumbsense_parser.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# require 'fusuma/plugin/parsers/parser.rb'
+# require 'fusuma/plugin/events/event.rb'
+
+module Fusuma
+  module Plugin
+    module Parsers
+      # parse libinput and generate event
+      class ThumbsenseParser < Parser
+        DEFAULT_SOURCE = "libinput_command_input"
+
+        #    ... event7  - button state: touch 3 from BUTTON_STATE_AREA    event BUTTON_EVENT_UP          to BUTTON_STATE_NONE
+        # 10766: event7  - button state: touch 1 from BUTTON_STATE_AREA    event BUTTON_EVENT_UP          to BUTTON_STATE_NONE
+        # 10768: event7  - button state: touch 0 from BUTTON_STATE_AREA    event BUTTON_EVENT_UP          to BUTTON_STATE_NONE
+
+        # @param record [String]
+        # @return [Records::Gesture, nil]
+        def parse_record(record)
+          gesture = "touch"
+
+          case record.to_s
+
+          # touched
+          when %r{\sevent\d+\s+-\sbutton state: touch (?<finger>[[:digit:]]) from BUTTON_STATE_NONE}
+            status = "begin"
+            finger = $~[:finger].to_i + 1
+          # released
+          when %r{\sevent\d+\s+-\sbutton state: touch (?<finger>[[:digit:]]) .* to BUTTON_STATE_NONE}
+            status = "end"
+            finger = $~[:finger].to_i + 1
+
+          # palm
+          when %r{\sevent\d+\s+-\spalm: touch (?<finger>[[:digit:]]) .*}
+            status = "palm"
+            finger = $~[:finger].to_i + 1
+          else
+            return
+          end
+
+          Events::Records::GestureRecord.new(status: status, gesture: gesture, finger: finger, delta: nil)
+        end
+
+        def tag
+          "thumbsense_parser"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Fusuma
+  module Plugin
+    module Thumbsense
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/fusuma/plugin/thumbsense.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "thumbsense/version"
+
+module Fusuma
+  module Plugin
+    module Thumbsense
+    end
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: fusuma-plugin-thumbsense
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- iberianpig
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fusuma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: fusuma-plugin-keypress
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: fusuma-plugin-remap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: fusuma-plugin-thumbsense is Fusuma plugin for thumbsense.
+email:
+- yhkyky@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/console
+- bin/setup
+- fusuma-plugin-thumbsense.gemspec
+- lib/fusuma/plugin/buffers/thumbsense_buffer.rb
+- lib/fusuma/plugin/detectors/thumbsense_detector.rb
+- lib/fusuma/plugin/filters/thumbsense_filter.rb
+- lib/fusuma/plugin/parsers/thumbsense_parser.rb
+- lib/fusuma/plugin/thumbsense.rb
+- lib/fusuma/plugin/thumbsense/version.rb
+homepage: https://github.com/iberianpig/fusuma-plugin-thumbsense
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key: 
+specification_version: 4
+summary: Thumbsense plugin for Fusuma
+test_files: []