touchscreen-taps 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cd4ca10f5439c6236d2e179e46f19d63531fd59d7b89ad94d421817952b0a0c6
+  data.tar.gz: 91ac28937e62700d68e407384a62dba6b4adcd344345b083d7cbcef9f4a09238
+SHA512:
+  metadata.gz: 286e7df3bf4c5c21a17adb9e912ff2ffc3c648094b6eb83bfd5646952e9edd3b83dc41bbcd7a300c22990c40ff4227f53973d6de114afd3b9559447f0655dd27
+  data.tar.gz: 2beede4c0d9a0e9eafef326fada7d799ad069ee76e3c5d7ff7d3d42ba539d1c3df79a2013a6da832260708522d1cb293f4bd4d70a01c9c1aa09ea43a05ec2c01

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# Changelog
+
+## [v0.1.0](https://github.com/antonsokolskyy/touchscreen-taps/tree/v0.1.0) (2020-02-21)

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in touchscreen-taps.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Anton Sokolskyi
+
+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,49 @@
+# TouchscreenTaps
+
+TouchscreenTaps is a touchscreen taps recognizer. It allows "tap and hold" gesture to be recognized and assign a command to it.
+
+# Instalation
+
+```bash
+sudo gpasswd -a $USER input
+sudo apt install libinput-tools
+sudo apt install xdotool
+sudo apt install ruby
+sudo gem install touchscreen-taps
+```
+
+# Usage
+```bash
+touchscreen-taps
+```
+Pass custom config 
+```bash
+touchscreen-taps /home/user/custom_config.yml
+```
+
+# Config example
+```yaml
+---
+tap_and_hold: # event name
+  1: # fingers count
+    command: 'xdotool click 3'
+    acceptance_delay: '0.5' # seconds
+```
+# Run as daemon
+```bash
+touchscreen-taps &
+```
+
+# Autostart
+```bash
+echo 'touchscreen-taps &' | sudo tee /etc/profile.d/start-touchscreen-taps.sh
+```
+
+# Tested on:
+Surface Pro 3 (i5/8gb/256gb)
+Ubuntu 18.04 LTS (linux 5.5, Gnome, Xorg)
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'touchscreen_taps'
+
+# 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/exe/touchscreen-taps

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/touchscreen_taps'
+
+TouchscreenTaps::Runner.new(ARGV[0]).process_events

data/lib/touchscreen_taps.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'touchscreen_taps/libinput'
+require_relative 'touchscreen_taps/touchscreen_device'
+require_relative 'touchscreen_taps/gesture_buffer'
+require_relative 'touchscreen_taps/config'
+require_relative 'touchscreen_taps/event'
+require_relative 'touchscreen_taps/event_filter'
+require_relative 'touchscreen_taps/event_parser'
+require_relative 'touchscreen_taps/tap_and_hold_detector'
+require_relative 'touchscreen_taps/executor'
+
+module TouchscreenTaps
+  # Main runner
+  class Runner
+    def initialize(config_path)
+      config       = Config.new(config_path)
+      @buffer      = config.buffer
+      @touchscreen = config.touchscreen
+      @detector    = TapAndHoldDetector.new(config)
+      @executor    = Executor.new(config)
+    end
+
+    def process_events
+      Libinput.events(@touchscreen) do |event|
+        event = EventFilter.call(event)
+        next unless event
+
+        event = EventParser.call(event)
+        @buffer.push(event)
+        command = @detector.process(@buffer)
+        @executor.run(command)
+      end
+    end
+  end
+end

data/lib/touchscreen_taps/config.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module TouchscreenTaps
+  # Holds main configurations
+  class Config
+    require 'yaml'
+
+    attr_reader :buffer
+    attr_reader :touchscreen
+
+    def initialize(path = nil)
+      @buffer      = fetch_buffer
+      @touchscreen = fetch_touchscreen
+      @config      = fetch_config(path)
+    end
+
+    def by_keys(keys)
+      @config.dig(*keys)
+    end
+
+    private
+
+    def fetch_buffer
+      GestureBuffer.new
+    end
+
+    def fetch_touchscreen
+      devices = Libinput.devices
+      touchscreens = TouchscreenDevice.select_from(devices)
+      # touchscreen can be nil
+      # in that case events from all touch-capable devices will be processed
+      touchscreens.count == 1 ? touchscreens.first : nil
+    end
+
+    def fetch_config(path)
+      YAML.load_file(path || default_config_path)
+    end
+
+    def default_config_path
+      "#{__dir__}/default_config.yml"
+    end
+  end
+end

data/lib/touchscreen_taps/default_config.yml

@@ -0,0 +1,5 @@
+---
+tap_and_hold: # event name
+  1: # fingers count
+    command: 'xdotool click 3'
+    acceptance_delay: '0.5' # seconds

data/lib/touchscreen_taps/event.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module TouchscreenTaps
+  # Parsed Event object
+  class Event
+    attr_reader :timestamp
+    attr_reader :type
+    attr_reader :finger
+    attr_reader :move_x
+    attr_reader :move_y
+
+    def initialize(type, finger, move_x = nil, move_y = nil)
+      @type = type
+      @finger = finger
+      @move_x = move_x
+      @move_y = move_y
+      @timestamp = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    end
+  end
+end

data/lib/touchscreen_taps/event_filter.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TouchscreenTaps
+  # Allows only necessary events
+  class EventFilter
+    class << self
+      def call(event)
+        return unless event =~ /TOUCH_UP|TOUCH_DOWN|TOUCH_MOTION/
+
+        event
+      end
+    end
+  end
+end

data/lib/touchscreen_taps/event_parser.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module TouchscreenTaps
+  # Parses a raw line and creates an event object
+  class EventParser
+    class << self
+      def call(event)
+        _device, event_name, _time, text = event.strip.split(nil, 4)
+        Event.new(type(event_name), finger(text), *direction(text))
+      end
+
+      private
+
+      def direction(text)
+        return if text.nil?
+
+        _finger, _finger2, x, y = text.tr('/|(|)', ' ').split
+        [x, y]
+      end
+
+      def type(text)
+        text.split('_').last
+      end
+
+      def finger(text)
+        return if text.nil?
+
+        count, = text.split(nil, 3)
+        count.to_i + 1
+      end
+    end
+  end
+end

data/lib/touchscreen_taps/executor.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module TouchscreenTaps
+  # Executes commands from config file
+  class Executor
+    def initialize(config)
+      @config = config
+    end
+
+    def run(cmd)
+      return if cmd.nil?
+
+      command = @config.by_keys(command_to_keys(cmd)).fetch('command')
+      execute(command) if command
+    end
+
+    private
+
+    def execute(command)
+      puts "Executing '#{command}'"
+      fork do
+        Process.daemon(true)
+        exec(command)
+      end
+    end
+
+    def command_to_keys(cmd)
+      [cmd[:name], cmd[:fingers]]
+    end
+  end
+end

data/lib/touchscreen_taps/gesture_buffer.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module TouchscreenTaps
+  # Buffer for all events related to a single gesture
+  # Gesture is considered started when first finger touches the screen
+  # Gesture is considired ended when last finger leaves the screen
+  # Between start and end points at least one finger
+  # should be touching the screen
+  class GestureBuffer
+    TIME_TO_KEEP = 3 # seconds
+    UP_TYPE = 'UP'
+    DOWN_TYPE = 'DOWN'
+    MOTION_TYPE = 'MOTION'
+    attr_reader :events
+
+    def initialize
+      @events = []
+    end
+
+    def push(event)
+      delete_old_events
+      clear unless gesture_in_progress?
+      remove_previous_events(event) if repeating_touch?(event)
+
+      @events.push(event)
+    end
+
+    def empty?
+      @events.empty?
+    end
+
+    def gesture_in_progress?
+      down_touches.count > up_touches.count
+    end
+
+    def down_touches
+      events_by_type(DOWN_TYPE)
+    end
+
+    def up_touches
+      events_by_type(UP_TYPE)
+    end
+
+    def motion_touches
+      events_by_type(MOTION_TYPE)
+    end
+
+    private
+
+    def delete_old_events
+      @events.each do |event|
+        next if (current_time - event.timestamp) < TIME_TO_KEEP
+
+        @events.delete(event)
+      end
+    end
+
+    def clear
+      @events.clear
+    end
+
+    def current_time
+      Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    end
+
+    def repeating_touch?(event)
+      return false unless event.type == DOWN_TYPE
+
+      !@events.find { |e| e.finger == event.finger }.nil?
+    end
+
+    def remove_previous_events(event)
+      @events.select { |e| e.finger == event.finger }.each do |e|
+        @events.delete(e)
+      end
+      @events.delete(@events.find { |e| e.type == UP_TYPE })
+    end
+
+    def events_by_type(type)
+      @events.select { |e| e.type == type }
+    end
+  end
+end

data/lib/touchscreen_taps/libinput.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module TouchscreenTaps
+  # libinput wrapper
+  # makes debug_events available in ruby
+  class Libinput
+    require 'open3'
+
+    class << self
+      def events(device = nil)
+        Open3.popen3(debug_events_cmd(device)) do |_in, out, _err, _wait_thr|
+          out.each do |event|
+            yield(event.chomp)
+          end
+        end
+      end
+
+      def devices
+        Open3.popen3(list_devices_cmd) do |_in, out, _err, _wait_thr|
+          out.read.split("\n\n").map { |d| d.split("\n") }
+        end
+      end
+
+      private
+
+      def debug_events_cmd(device)
+        'stdbuf -oL -- libinput debug-events' \
+        "#{' --device=' + device.kernel unless device.nil?}"
+      end
+
+      def list_devices_cmd
+        'libinput list-devices'
+      end
+    end
+  end
+end

data/lib/touchscreen_taps/tap_and_hold_detector.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module TouchscreenTaps
+  # Detects tap-and-hold gesture
+  class TapAndHoldDetector
+    COMMAND_TYPE = 'tap_and_hold'
+
+    def initialize(config)
+      @config = config
+    end
+
+    def process(buffer)
+      return if return_conditions_met?(buffer)
+
+      down_touches = buffer.down_touches
+      up_touches   = buffer.up_touches
+
+      last_down_touch = down_touches.max_by(&:timestamp)
+      last_up_touch   = up_touches.max_by(&:timestamp)
+
+      if hold_enough?(last_up_touch, last_down_touch)
+        return { name: COMMAND_TYPE, fingers: down_touches.count }
+      end
+
+      nil
+    end
+
+    private
+
+    def hold_enough?(up_touch, down_touch)
+      return false if up_touch.nil? || down_touch.nil?
+
+      required_delay = acceptance_delay(down_touch)
+      return false if required_delay.nil?
+
+      up_touch.timestamp - down_touch.timestamp > required_delay.to_f
+    end
+
+    def return_conditions_met?(buffer)
+      buffer.empty? ||
+        buffer.gesture_in_progress? ||
+        buffer.motion_touches.any?
+    end
+
+    def acceptance_delay(down_touch)
+      @config.by_keys([COMMAND_TYPE, down_touch.finger])
+             &.fetch('acceptance_delay')
+    end
+  end
+end

data/lib/touchscreen_taps/touchscreen_device.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module TouchscreenTaps
+  # represents a physical input device (e.g touchscreen)
+  class TouchscreenDevice
+    REQUIRED_CAPABILITY = 'touch'
+    attr_reader :kernel
+
+    def initialize(kernel)
+      @kernel = kernel
+    end
+
+    class << self
+      def select_from(devices)
+        devices.map do |device|
+          next unless capable?(device)
+
+          kernel = kernel_path(device)
+          new(kernel) unless kernel.nil?
+        end.compact
+      end
+
+      private
+
+      def capable?(device)
+        device.find { |f| f =~ /^Capabilities:/ }
+              .include?(REQUIRED_CAPABILITY)
+      end
+
+      def kernel_path(device)
+        device.find { |f| f =~ /^Kernel:/ }.split(' ').last
+      end
+    end
+  end
+end

data/lib/touchscreen_taps/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TouchscreenTaps
+  VERSION = '0.1.1'
+end

data/touchscreen-taps.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'lib/touchscreen_taps/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'touchscreen-taps'
+  spec.version       = TouchscreenTaps::VERSION
+  spec.authors       = ['Anton Sokolskyi']
+  spec.email         = ['antonsokolskyi@gmail.com']
+
+  spec.summary       = 'Touchscreen taps recognizer'
+  spec.description   = 'Allows to recognize tap-and-hold gesture'
+  spec.homepage      = 'https://github.com/antonsokolskyy/touchscreen-taps'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/antonsokolskyy/touchscreen-taps'
+  spec.metadata['changelog_uri'] = 'https://github.com/antonsokolskyy/touchscreen-taps/blob/master/CHANGELOG.md'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: touchscreen-taps
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Anton Sokolskyi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-21 00:00:00.000000000 Z
+dependencies: []
+description: Allows to recognize tap-and-hold gesture
+email:
+- antonsokolskyi@gmail.com
+executables:
+- touchscreen-taps
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/touchscreen-taps
+- lib/touchscreen_taps.rb
+- lib/touchscreen_taps/config.rb
+- lib/touchscreen_taps/default_config.yml
+- lib/touchscreen_taps/event.rb
+- lib/touchscreen_taps/event_filter.rb
+- lib/touchscreen_taps/event_parser.rb
+- lib/touchscreen_taps/executor.rb
+- lib/touchscreen_taps/gesture_buffer.rb
+- lib/touchscreen_taps/libinput.rb
+- lib/touchscreen_taps/tap_and_hold_detector.rb
+- lib/touchscreen_taps/touchscreen_device.rb
+- lib/touchscreen_taps/version.rb
+- touchscreen-taps.gemspec
+homepage: https://github.com/antonsokolskyy/touchscreen-taps
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/antonsokolskyy/touchscreen-taps
+  source_code_uri: https://github.com/antonsokolskyy/touchscreen-taps
+  changelog_uri: https://github.com/antonsokolskyy/touchscreen-taps/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Touchscreen taps recognizer
+test_files: []