device_input 0.2.1.1 → 0.3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef70d561e40df5e3bd0df134ede59a38b11b8b78
-  data.tar.gz: 5c902897dcd290b0cac172629833e12851dd04e2
+  metadata.gz: 00eb69decfeb19916bef79e450c1971bf73876a6
+  data.tar.gz: 101794e4db2d8cb6e3550c1f515e92a54b8fd526
 SHA512:
-  metadata.gz: '00688046ffe558c9d16b321eb33e121acfacd88ff61ab6eddc2a3abe076a71662fc4224b1c7cbc9e6457c16c88b1f58ae566784852dcffba3e0edb873cd53915'
-  data.tar.gz: d547249fbaf0dd1872910a7b55b61512e27054a0169489a8c81ed5672bb521fa0d62570a0b53c1de95ed77c121cc86bc46f58e5f95ac39747097a483afe8c571
+  metadata.gz: ed04d353a1879d3a3cde29514efd6f97b15411b0f114c9638a7d56facd99cbc1213bcb3c75f014377d1971748258231b71364c6f3b831e343a7265b72d369aa6
+  data.tar.gz: 8675d1bb76626cd90924aa62abb017b7779ce114effa82619bd24235044e3d478f971b9c0c163f51b42f28eb2a5d36c102844eaac64a26f67c12081ac71e18f3

data/README.md

@@ -66,7 +66,7 @@ $ gem install device_input # sudo as necessary
 
 Or, if using [Bundler](http://bundler.io/), add to your `Gemfile`:
 ```ruby
-gem 'device_input', '~> 0.1'
+gem 'device_input', '~> 0.3'
 ```
 
 # Usage
@@ -74,7 +74,7 @@ gem 'device_input', '~> 0.1'
 ## Executable
 
 ```shell
-$ sudo devsniff /dev/input/event0
+$ evdump /dev/input/event0 # sudo as necessary
 ```
 
 When the `f` key is pressed:
@@ -96,7 +96,7 @@ EV_SYN:SYN_REPORT:0
 
 How about pretty mode?
 ```shell
-$ sudo devsniff /dev/input/event0 pretty
+$ sudo cat /dev/input/event0 | evdump --print pretty
 
 # f
 
@@ -110,7 +110,7 @@ $ sudo devsniff /dev/input/event0 pretty
 
 We can pull off the labels and go raw:
 ```shell
-$ sudo devsniff /dev/input/event0 raw
+$ sudo cat /dev/input/event0 | evdump --print raw
 
 # f
 
@@ -124,7 +124,7 @@ $ sudo devsniff /dev/input/event0 raw
 
 Fulfill your hacker-matrix fantasies:
 ```shell
-$ sudo devsniff /dev/input/event0 hex
+$ sudo cat /dev/input/event0 | evdump --print hex
 
 # f
 
@@ -141,10 +141,12 @@ $ sudo devsniff /dev/input/event0 hex
 ```ruby
 require 'device_input'
 
-# this loops forever and blocks waiting for input
-DeviceInput.read_from('/dev/input/event0') do |event|
-  puts event
-  # break if event.time > start + 30
+File.open('/dev/input/event0', 'r') do |dev|
+  # this loops forever and blocks waiting for input
+  DeviceInput.read_loop(dev) do |event|
+    puts event
+    # break if event.time > start + 30
+  end
 end
 ```
 
@@ -157,11 +159,11 @@ An event has:
 * `#value`: Fixnum (signed) from `#data`
 
 You will probably want to write your own read loop for your own project.
-[`DeviceInput.read_from`](lib/device_input.rb#L100) is very simple and can
+[`DeviceInput.read_loop`](lib/device_input.rb#L102) is very simple and can
 easily be rewritten outside of this project's namespace and adapted for your
 needs.
 
-# Research
+# Background
 
 ## Kernel docs
 
@@ -206,7 +208,7 @@ What's a [`__kernel_time_t`](https://git.kernel.org/cgit/linux/kernel/git/torval
 ```
 typedef long            __kernel_long_t;
 # ...
-typedef __kernel_long_t         __kernel_suseconds_t;
+typedef __kernel_long_t __kernel_suseconds_t;
 # ...
 typedef __kernel_long_t __kernel_time_t;
 ```

data/VERSION

@@ -1 +1 @@
-0.2.1.1
+0.3.0.2

data/bin/evdump

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+
+require 'device_input'
+require 'slop'
+
+opts = Slop.parse do |o|
+  o.banner = "evdump [OPTIONS] [DEVICE]"
+  o.string '-p', '--print', 'pretty|raw|hex'
+  o.on '-h', '--help' do
+    puts o
+    exit
+  end
+end
+
+def opts.error(msg = nil)
+  puts self
+  puts "ERROR: #{msg}" if msg
+  exit 1
+end
+
+case opts[:print]
+when 'pretty', 'raw', 'hex'
+  print_meth = opts[:print]
+else
+  print_meth = 'to_s'
+end
+
+if $stdin.tty?
+  device = opts.arguments.shift
+  opts.error "Please specify an input device file" unless device
+  opts.error "#{device} is not a character device" unless File.chardev? device
+  opts.error "#{device} is not readable" unless File.readable? device
+  device = File.new(device, 'r')
+else
+  device = $stdin
+end
+
+DeviceInput.read_loop(device) { |event|
+  puts event.send(print_meth)
+}

data/lib/device_input.rb

@@ -99,14 +99,12 @@ module DeviceInput
     alias_method :hex, RUBY23 ? :ruby23_hex : :to_s
   end
 
-  # never gonna give you up
-  def self.read_from(filename)
-    File.open(filename, 'r') { |f|
-      loop {
-        bytes = f.read(Event::BYTE_LENGTH)
-        data = Event.decode(bytes)
-        yield Event.new(data)
-      }
+  def self.read_loop(io)
+    loop {
+      bytes = io.read(Event::BYTE_LENGTH)
+      break unless (bytes and bytes.length == Event::BYTE_LENGTH)
+      data = Event.decode(bytes)
+      yield Event.new(data)
     }
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: device_input
 version: !ruby/object:Gem::Version
-  version: 0.2.1.1
+  version: 0.3.0.2
 platform: ruby
 authors:
 - Rick Hull
@@ -29,13 +29,13 @@ description: |
   No dependencies.  Ruby 2+ required
 email: 
 executables:
-- devsniff
+- evdump
 extensions: []
 extra_rdoc_files: []
 files:
 - README.md
 - VERSION
-- bin/devsniff
+- bin/evdump
 - lib/device_input.rb
 - lib/device_input/compat.rb
 - lib/device_input/labels.rb

data/bin/devsniff

@@ -1,26 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'device_input'
-
-device = ARGV.shift || '/dev/input/event0'
-mode = (ARGV.shift || 'normal').downcase
-
-if !File.readable?(device)
-  puts "#{device} cannot be read.  Perhaps you need to sudo?"
-  exit 1
-end
-
-case mode
-when 'normal'
-  mode = 'to_s'
-when 'bytes'     # legacy
-  mode = 'hex'
-when 'pretty', 'raw', 'hex'
-  # ok
-else
-  raise "unsupported mode: #{mode}"
-end
-
-DeviceInput.read_from(device) { |event|
-  puts event.send(mode)
-}