evdev 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6db3c1910ac57b43eba5481021d04ff0035eb694
+  data.tar.gz: b2ba03ea15a327dba67f96d3bec5faa706dd5f68
+SHA512:
+  metadata.gz: 4687f24d2dfa42270ff8c9406d8dc084cf94bc9787ddd6b1b38dd525f8e908839affb9e2b530de94a958f8fafd88d355872bc04d3e41580080f7b59b36bb1202
+  data.tar.gz: ac2701a0dfca11d5fd9f0066dcd1f7a66f0b920887e6a741cbfdccddf9d10fd7b9961182725ad53a9a07e1ebf9ee562800e395e1de6a33920d9eb2949ee2f686

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rakeTasks

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Settings><!--This file was automatically generated by Ruby plugin.
+You are allowed to: 
+1. Remove rake task
+2. Add existing rake tasks
+To add existing rake tasks automatically delete this file and reload the project.
+--><RakeGroup description="" fullCmd="" taksId="rake"><RakeTask description="Build evdev-0.1.0.gem into the pkg directory" fullCmd="build" taksId="build" /><RakeTask description="Build and install evdev-0.1.0.gem into system gems" fullCmd="install" taksId="install" /><RakeTask description="Create tag v0.1.0 and build and push evdev-0.1.0.gem to Rubygems" fullCmd="release" taksId="release" /><RakeGroup description="" fullCmd="" taksId="release"><RakeTask description="" fullCmd="release:guard_clean" taksId="guard_clean" /><RakeTask description="" fullCmd="release:rubygem_push" taksId="rubygem_push" /><RakeTask description="" fullCmd="release:source_control_push" taksId="source_control_push" /></RakeGroup></RakeGroup></Settings>

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper.rb

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Christopher Aue
+
+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,81 @@
+# Evdev
+
+A ruby wrapper around [Libevdev](https://github.com/christopheraue/ruby-libevdev)
+for a nice and easy access to linux's event devices like keyboards and mice.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'evdev'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install evdev
+
+## Usage
+
+Let's have a look at my keyboard:
+
+### Initializing a device
+
+```ruby
+require 'evdev'
+keyboard = Evdev.new('/dev/input/event0')
+```
+
+### Querying the device
+
+```ruby
+keyboard.name                       # => "Logitech USB Receiver"
+keyboard.phys                       # => "usb-0000:00:1d.2-1/input0"
+keyboard.uniq                       # => ""
+keyboard.vendor_id                  # => 1133
+keyboard.product_id                 # => 50473
+keyboard.bustype                    # => :USB
+keyboard.version                    # => 273
+keyboard.driver_version             # => 65537
+keyboard.has_property? :pointer     # => false
+```
+
+### Grabbing a device
+
+```ruby
+keyboard.grab                       # => true if successful, else false
+keyboard.ungrab                     # => true if successful, else false
+```
+
+### Event handling
+
+Evdev lumps event type and code together. You just need to give it the name of
+the code and it derives the implied type from it internally.
+
+```ruby
+keyboard.supports_event? :KEY_A     # => true
+keyboard.supports_event? :ABS_X     # => false
+
+key_a_handler = keyboard.on(:KEY_A) do |value|
+    puts "key 'a' #{%w(up down repeat)[value]}"
+end
+
+loop do
+    Kernel.select([keyboard.event_channel])
+    keyboard.handle_event
+    # => puts "key 'a' down" and "key 'a' up" on a single KEY_A stroke
+end
+```
+
+Removing the handler:
+
+```ruby
+keyboard.off(:KEY_A, key_a_handler)
+```
+
+Evdev includes the [CallbacksAttachable](https://github.com/christopheraue/ruby-callbacks_attachable)
+mixin to attach and detach callbacks. Have a look at its API in its own documentation.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/evdev.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'evdev/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "evdev"
+  spec.version       = Evdev::VERSION
+  spec.authors       = ["Christopher Aue"]
+  spec.email         = ["mail@christopheraue.net"]
+
+  spec.summary       = %q{A ruby object wrapper around libevdev bindings.}
+  spec.homepage      = "https://github.com/christopheraue/ruby-evdev"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "libevdev", "~> 1.0"
+  spec.add_runtime_dependency "callbacks_attachable", "~> 0.1"
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2.0"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "rspec-mocks-matchers-send_message"
+end

data/lib/evdev.rb

@@ -0,0 +1,111 @@
+require "bundler/setup"
+require "callbacks_attachable"
+require "libevdev"
+require "evdev/version"
+require "evdev/converter"
+require "evdev/abs_axis"
+
+class Evdev
+  include CallbacksAttachable
+
+  class << self
+    def finalize(device)
+      proc { Libevdev.free(device) }
+    end
+
+    def all(file_paths = '/dev/input/event*')
+      Dir[file_paths].map{ |file_path| new(file_path) }
+    end
+  end
+
+  def initialize(file_path)
+    @file = File.open(file_path)
+    device_ptr = FFI::MemoryPointer.new :pointer
+    Libevdev.new_from_fd(@file.fileno, device_ptr)
+    @device = device_ptr.read_pointer
+
+    ObjectSpace.define_finalizer(self, self.class.finalize(@device))
+  end
+
+  attr_reader :file
+  alias_method :event_channel, :file
+
+  def name
+    Libevdev.get_name(@device)
+  end
+
+  def phys
+    Libevdev.get_phys(@device)
+  end
+
+  def uniq
+    Libevdev.get_uniq(@device)
+  end
+
+  def vendor_id
+    Libevdev.get_id_vendor(@device)
+  end
+
+  def product_id
+    Libevdev.get_id_product(@device)
+  end
+
+  def bustype
+    Libevdev.get_id_bustype(@device)
+  end
+
+  def version
+    Libevdev.get_id_version(@device)
+  end
+
+  def driver_version
+    Libevdev.get_driver_version(@device)
+  end
+
+  def has_property?(property)
+    1 == Libevdev.has_property(@device, Converter.property_to_int(property))
+  end
+
+  def abs_axis(code)
+    AbsAxis.new(@device, Converter.code_to_int(code))
+  end
+
+  def grab
+    0 == Libevdev.grab(@device, Libevdev::GRAB)
+  end
+
+  def ungrab
+    0 == Libevdev.grab(@device, Libevdev::UNGRAB)
+  end
+
+  def supports_event?(event)
+    type = Converter.code_to_type(event)
+    handles_event_type?(type) and handles_event_code?(type, event)
+  end
+
+  def handle_event(mode = :blocking)
+    event = LinuxInput::InputEvent.new
+    Libevdev.next_event(@device, Libevdev.const_get(:"READ_FLAG_#{mode.upcase}"), event.pointer)
+    trigger(Converter.int_to_name(event[:type], event[:code]), event[:value])
+  end
+
+  def events_pending?
+    1 == Libevdev.has_event_pending(@device)
+  end
+
+  def event_value(event)
+    return unless supports_event?(event)
+    type = Converter.code_to_type(event)
+    Libevdev.get_event_value(@device, Converter.type_to_int(type), Converter.code_to_int(event))
+  end
+
+  private
+
+  def handles_event_type?(type)
+    1 == Libevdev.has_event_type(@device, Converter.type_to_int(type))
+  end
+
+  def handles_event_code?(type, code)
+    1 == Libevdev.has_event_code(@device, Converter.type_to_int(type), Converter.code_to_int(code))
+  end
+end

data/lib/evdev/abs_axis.rb

@@ -0,0 +1,28 @@
+class Evdev
+  class AbsAxis
+    def initialize(device, code)
+      @device = device
+      @code = code
+    end
+
+    def maximum
+      Libevdev.get_abs_maximum(@device, @code)
+    end
+
+    def minimum
+      Libevdev.get_abs_minimum(@device, @code)
+    end
+
+    def fuzz
+      Libevdev.get_abs_fuzz(@device, @code)
+    end
+
+    def flat
+      Libevdev.get_abs_flat(@device, @code)
+    end
+
+    def resolution
+      Libevdev.get_abs_resolution(@device, @code)
+    end
+  end
+end

data/lib/evdev/converter.rb

@@ -0,0 +1,39 @@
+class Evdev
+  module Converter; end
+  class << Converter
+    def code_to_type(code)
+      :"EV_#{code.to_s.split('_').first}"
+    end
+
+    def property_to_int(property)
+      LinuxInput.const_get(:"INPUT_PROP_#{property.upcase}")
+    end
+
+    def type_to_int(type)
+      LinuxInput.const_get(type.upcase)
+    end
+
+    def code_to_int(code)
+      LinuxInput.const_get(code.upcase)
+    end
+
+    def int_to_name(type_int, code_int)
+      @event_names ||= {}
+      @event_names[type_int] ||= consts_starting_with("#{int_to_type(type_int)}_")
+      @event_names[type_int][code_int]
+    end
+
+    private
+
+    def int_to_type(int)
+      @event_types ||= consts_starting_with('EV_')
+      @event_types[int][3..-1]
+    end
+
+    def consts_starting_with(prefix)
+      LinuxInput.constants(false).map do |const|
+        [LinuxInput.const_get(const), const] if const.to_s.start_with? prefix
+      end.compact.to_h
+    end
+  end
+end

data/lib/evdev/version.rb

@@ -0,0 +1,3 @@
+class Evdev
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: evdev
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christopher Aue
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: libevdev
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: callbacks_attachable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks-matchers-send_message
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- mail@christopheraue.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rakeTasks"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- evdev.gemspec
+- lib/evdev.rb
+- lib/evdev/abs_axis.rb
+- lib/evdev/converter.rb
+- lib/evdev/version.rb
+homepage: https://github.com/christopheraue/ruby-evdev
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A ruby object wrapper around libevdev bindings.
+test_files: []