device_input 0.0.3.1 → 0.1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42e1a1dde8d9b9884e97bef833d8890d9aaa3a23
-  data.tar.gz: 5076d4580ee666d8c82a0f9b924ed94c2890b041
+  metadata.gz: 803a063ac3069383c1d2f3cff0dc5ff5c7caf43a
+  data.tar.gz: 97282e042e693fda103f18ccaf10d19eee397308
 SHA512:
-  metadata.gz: 3ae5856b3d005ea2b268e931d5c1ac3c73cc8fd1a31ce0e4264b16adc4f70841b3858e8fd5aa771df47631da111eba823ef0ca1f3089c6a6f602a866eb759f58
-  data.tar.gz: 5f4c0defc1877124d209cc424f312cd099493f84a1feab65f651210b08475f2d56f4fdfd827b172a8b6ce3527f0e4bc5a7e1ba1301f0dcf8158ec59da1d302a6
+  metadata.gz: 970a6aab1d8d674cb3b8db5c2509c313ed195600dca3aefd4ed80ae826cc140ab20d86b7d50e166f10b7b7a5b37136c8ab8fd94b30406768df53892498e5fe50
+  data.tar.gz: a83de5605ceec1982206ab8f9f072e40e65b0fd84eb00e1b28edbfc8a1b2beb8768972839c83dc7ec67783192f4cbaa557a65bc1e368b00e5008524e071a52a9

data/README.md

@@ -28,14 +28,14 @@ To determine the message size, we need to know the data structure.  For a
 long time, it was pretty simple: events are 16 bytes:
 
 * timestamp - 8 bytes
-* type - 1 byte
-* code - 1 byte
-* value - 2 bytes
+* type - 2 bytes
+* code - 2 bytes
+* value - 4 bytes
 
 However, this is only true for 32-bit platforms.  On 64-bit platforms, event
-timestamps became 16 bytes, increasing events from 16 to 24 bytes.  This is
-because a timestamp is defined as two `long`s, and `long`s are bigger on
-64-bit platforms.  It's easy to remember:
+timestamps became 16 bytes, increasing the size of events from 16 to 24 bytes.
+This is because a timestamp is defined (ultimately) as two `long`s, and
+`long`s are bigger on 64-bit platforms.  It's easy to remember:
 
 * 32-bit platform: 32-bit `long` (4 bytes)
 * 64-bit platform: 64-bit `long` (8 bytes)
@@ -50,14 +50,16 @@ executable code to assist in examining kernel input events.
 
 # Installation
 
-Install the gem:
+Requirements: Ruby >= 2.0
+
+Dependencies: none
 
+Install the gem:
 ```
 $ gem install device_input # sudo as necessary
 ```
 
 Or, if using [Bundler](http://bundler.io/), add to your `Gemfile`:
-
 ```
 gem 'device_input', '~> 0.0'
 ```
@@ -71,7 +73,6 @@ $ sudo devsniff /dev/input/event0
 ```
 
 When the `f` key is pressed:
-
 ```
 Misc:ScanCode:33
 Key:F:1
@@ -81,6 +82,9 @@ Sync:Sync:0
 And released:
 ```
 Misc:ScanCode:33
+Key:F:1
+Sync:Sync:0
+Misc:ScanCode:33
 Key:F:0
 Sync:Sync:0
 ```
@@ -90,18 +94,25 @@ Sync:Sync:0
 ```
 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
 end
 ```
 
 An event has:
 
-* `#data` - a Struct of ints (class name Data)
-* `#time` - a Time, accurate to usecs
-* `#type` - a String, possibly UNK-X where X is the integer from `#data`
-* `#code` - a String, possibly UNK-X-Y where X and Y are from `#data`
-* `#value` - a Fixnum (signed)
+* `#data`: Struct of ints (class name Data)
+* `#time`: Time, accurate to usecs
+* `#type`: String label, possibly `UNK-X` where X is the integer from `#data`
+* `#code`: String label, possibly `UNK-X-Y` where X and Y are from `#data`
+* `#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#L111) is very simple and can
+easily be rewritten outside of this project's namespace and adapted for your
+needs.
 
 # Research
 
@@ -116,7 +127,6 @@ about these structs towards the end of this document.
 ## Kernel structs
 
 from https://www.kernel.org/doc/Documentation/input/input.txt
-
 ```
 struct input_event {
        struct timeval time;
@@ -128,7 +138,6 @@ struct input_event {
 
 from
 https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/include/uapi/linux/input.h#n25
-
 ```
 struct input_event {
        struct timeval time;
@@ -139,7 +148,6 @@ struct input_event {
 ```
 
 What's a [`timeval`](https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/include/uapi/linux/time.h#n15)?
-
 ```
 struct timeval {
        __kernel_time_t          tv_sec;      /* seconds */
@@ -148,7 +156,6 @@ struct timeval {
 ```
 
 What's a [`__kernel_time_t`](https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/include/uapi/asm-generic/posix_types.h#n88)?
-
 ```
 typedef long            __kernel_long_t;
 # ...
@@ -160,7 +167,6 @@ typedef __kernel_long_t __kernel_time_t;
 What's a [`__u16`](https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/include/uapi/asm-generic/int-l64.h#n23)?
 We're pretty sure it's an unsigned 16 bit integer.  Likewise `__s32` should
 be a signed 32-bit integer:
-
 ```
 typedef unsigned short __u16;
 
@@ -190,9 +196,9 @@ platform, you get 32 bits (4 bytes).  On a 64-bit platform you get 64 bits
 
 ## Ruby tools
 
-We can use `RbConfig` and `Array#pack`/`String#unpack` to help us read these
-binary structs:
-
+We can use
+[`RbConfig::SIZEOF`](http://idiosyncratic-ruby.com/42-ruby-config.html#rbconfigsizeof)
+and `Array#pack`/`String#unpack` to help us read these binary structs:
 ```
 FIELD      C        RbConfig  Pack
 ---        ---      ---       ---
@@ -206,5 +212,6 @@ value      __s32    int32_t   l
 # Acknowledgments
 
 * Inspired by https://github.com/prullmann/libdevinput (don't use it)
-  - also the source of the [event code labels](lib/device_input/codes.rb)
+  - also the source of an early version of the
+    [event code labels](lib/device_input/codes.rb)
 * Thanks to al2o3-cr from #ruby on Freenode for feedback

data/bin/devsniff

@@ -3,7 +3,22 @@
 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 'pretty', 'raw', 'bytes'
+  # ok
+else
+  raise "unsupported mode: #{mode}"
+end
 
 DeviceInput.read_from(device) { |event|
-  puts event
+  puts event.send(mode)
 }

data/lib/device_input/codes.rb

@@ -3,7 +3,10 @@ module DeviceInput
 
   # type = Sync
   CODES[0] = {
-    0 => 'Sync',
+    0 => ['SYN_REPORT', 'Report'],
+    1 => ['SYN_CONFIG', 'Config'],
+    2 => ['SYN_MT_REPORT', 'Multitouch'],
+    3 => ['SYN_DROPPED', 'Desync'],
   }
 
   # type = Key

data/lib/device_input.rb

@@ -19,17 +19,18 @@ module DeviceInput
 
     # these are just labels, not used internally
     TYPES = {
-      0 => 'Sync',
-      1 => 'Key',
-      2 => 'Relative',
-      3 => 'Absolute',
-      4 => 'Misc',
-      17 => 'LED',
-      18 => 'Sound',
-      20 => 'Repeat',
-      21 => 'ForceFeedback',
-      22 => 'Power',
-      23 => 'ForceFeedbackStatus',
+      0x00 => ['EV_SYN', 'Sync'],
+      0x01 => ['EV_KEY', 'Key'],
+      0x02 => ['EV_REL', 'Relative'],
+      0x03 => ['EV_ABS', 'Absolute'],
+      0x04 => ['EV_MSC', 'Misc'],
+      0x05 => ['EV_SW',  'ToggleSwitch'],
+      0x17 => ['EV_LED', 'LED'],
+      0x18 => ['EV_SND', 'Sound'],
+      0x20 => ['EV_REP', 'Repeat'],
+      0x21 => ['EV_FF',  'ForceFeedback'],
+      0x22 => ['EV_PWR', 'Power'],
+      0x23 => ['EV_FF_STATUS', 'ForceFeedbackStatus'],
     }
 
     # convert Event::Data to a string
@@ -42,14 +43,21 @@ module DeviceInput
       Data.new *binstr.unpack(PACK)
     end
 
-    def self.type_str(type_code)
-      TYPES[type_code] || "UNK-#{type_code}"
+    # return an array from [raw ... pretty]
+    def self.type_labels(type_code)
+      TYPES[type_code] || ["UNK-#{type_code}"]
     end
 
-    def self.code_str(type_code, code_code)
+    # return an array from [raw ... pretty]
+    def self.code_labels(type_code, code_code)
       require 'device_input/codes'
-      DeviceInput::CODES.dig(type_code, code_code) ||
-        "UNK-#{type_code}-#{code_code}"
+      labels = DeviceInput::CODES.dig(type_code, code_code)
+      if labels
+        # not all labels have been converted to arrays yet
+        labels.kind_of?(Enumerable) ? labels : [labels]
+      else
+        ["UNK-#{type_code}-#{code_code}"]
+      end
     end
 
     NULL_DATA = Data.new(0, 0, 0, 0, 0)
@@ -61,8 +69,9 @@ module DeviceInput
     def initialize(data)
       @data = data
       @time = Time.at(data.tv_sec, data.tv_usec)
-      @type = self.class.type_str(data.type)
-      @code = self.class.code_str(data.type, data.code)
+      # take the raw label, closest to the metal
+      @type = self.class.type_labels(data.type).first
+      @code = self.class.code_labels(data.type, data.code).first
     end
 
     def value
@@ -72,8 +81,34 @@ module DeviceInput
     def to_s
       [@type, @code, @data.value].join(':')
     end
+
+    # show timestamp and use the last of the labels
+    def pretty
+      [@time.strftime("%Y-%m-%d %H:%M:%S.%L"),
+       [self.class.type_labels(@data.type).last,
+        self.class.code_labels(@data.type, @data.code).last,
+        @data.value].join(':'),
+      ].join(" ")
+    end
+
+    # don't use any labels
+    def raw
+      [@data.type, @data.code, @data.value].join(':')
+    end
+
+    # display fields in hex
+    def bytes
+      require 'rbconfig/sizeof'
+      DEFINITION.inject('') { |memo, (field, type)|
+        int = @data.send(field)
+        width = RbConfig::SIZEOF.fetch(type)
+        # memo + ("%#0.#{width * 2}x" % int) + " "
+        memo + ("%0.#{width * 2}x" % int) + " "
+      }
+    end
   end
 
+  # never gonna give you up
   def self.read_from(filename)
     File.open(filename, 'r') { |f|
       loop {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: device_input
 version: !ruby/object:Gem::Version
-  version: 0.0.3.1
+  version: 0.1.0.1
 platform: ruby
 authors:
 - Rick Hull