artoo-leapmotion 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aedf45038f5032ebcb7bc5b37f4c9b6dc187c21c
+  data.tar.gz: 274954450e8dac24847a4cfd3343491ec0882fa4
+SHA512:
+  metadata.gz: 2db5410b5f963a0b0b2a08a722dbf69c2bce39d1441e10bb7b3affa3ea8e1790e06c736df116a5d1a43ffcf659f4a7fadf1469b8d54d62180d4aa2c36c703eab
+  data.tar.gz: 1db64734a6e116c20b30c403dad080b27c591a26843b8d623160e600d8aae3643aa80574c96e8e0c6f2450db0d77e84452bf5bacf330a0d48163d24fb584c3ea

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in artoo-leapmotion.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    artoo-leapmotion (0.1.1)
+      artoo (~> 1.0.0.rc2)
+      hybridgroup-celluloid-websocket-client
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    artoo (1.0.0.rc3)
+      celluloid (~> 0.14.1)
+      celluloid-io (~> 0.14.1)
+      multi_json (~> 1.6)
+      pry (~> 0.9)
+      rake (~> 10.0)
+      reel (~> 0.4.0.pre)
+      thor (~> 0.18.1)
+    celluloid (0.14.1)
+      timers (>= 1.0.0)
+    celluloid-io (0.14.1)
+      celluloid (>= 0.14.1)
+      nio4r (>= 0.4.5)
+    certified (0.1.1)
+    coderay (1.0.9)
+    http (0.4.0)
+      certified
+      http_parser.rb
+    http_parser.rb (0.5.3)
+    hybridgroup-celluloid-websocket-client (0.0.3)
+      celluloid-io
+      websocket-driver
+    metaclass (0.0.1)
+    method_source (0.8.2)
+    minitest (5.0.6)
+    minitest-happy (1.0.0)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.7.7)
+    nio4r (0.4.6)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rake (10.1.0)
+    reel (0.4.0.pre)
+      celluloid-io (>= 0.8.0)
+      http (>= 0.2.0)
+      http_parser.rb (>= 0.5.3)
+      rack (>= 1.4.0)
+      websocket_parser (>= 0.1.2)
+    slop (3.4.6)
+    thor (0.18.1)
+    timers (1.1.0)
+    websocket-driver (0.2.1)
+    websocket_parser (0.1.4)
+      http
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  artoo-leapmotion!
+  minitest (~> 5.0)
+  minitest-happy
+  mocha (~> 0.14.0)

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2013 The Hybrid Group
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,78 @@
+# Artoo Adaptor For Leap Motion
+
+This repository contains the Artoo (http://artoo.io/) adaptor for the Leap Motion controller (https://www.leapmotion.com/). 
+
+It borrows code from https://github.com/glejeune/ruby-leap-motion-ws, thanks @glejeune
+
+Artoo is a open source micro-framework for robotics using Ruby.
+
+For more information abut Artoo, check out our repo at https://github.com/hybridgroup/artoo
+
+[![Code Climate](https://codeclimate.com/github/hybridgroup/artoo-leapmotion.png)](https://codeclimate.com/github/hybridgroup/artoo-leapmotion) [![Build Status](https://travis-ci.org/hybridgroup/artoo-leapmotion.png?branch=master)](https://travis-ci.org/hybridgroup/artoo-leapmotion)
+
+## Installing
+
+```
+gem install artoo-leapmotion --pre
+```
+
+## Using
+
+```ruby
+require 'artoo'
+
+connection :leapmotion, :adaptor => :leapmotion, :port => '127.0.0.1:6437'
+device :leapmotion, :driver => :leapmotion
+  
+work do
+  on leapmotion, :open => :on_open
+  on leapmotion, :frame => :on_frame
+  on leapmotion, :close => :on_close
+end
+
+def on_open(*args)
+  puts args
+end
+
+def on_frame(*args)
+  frame = args[1]
+  puts frame
+  puts frame.hands
+  puts frame.gestures
+  puts frame.pointables
+end
+
+def on_close(*args)
+  puts args
+end
+```
+
+## Connecting to Leap Motion
+
+### OSX
+
+The normal OSX download of the Leap Motion software from https://www.leapmotion.com/setup should work with Artoo.
+
+More instructions need to go here...
+
+### Ubuntu
+
+The Linux download of the Leap Motion software can be obtained from https://developer.leapmotion.com/downloads (requires free signup)
+
+The main steps are:
+- Connect your computer and the Leap Motion controller
+- Connect to the device via Artoo
+
+You will need to run the `leapd` daemon in order to connect your Artoo code to your Leap Motion controller.
+
+```
+$ leapd
+```
+
+Once your computer is communcating with the Leap Motion controller, the `leapd` program exposes a websocket-based interface to receive data.
+
+### Windows
+
+The normal Windows download of the Leap Motion software from https://www.leapmotion.com/setup should work with Artoo.
+
+More instructions need to go here...

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/**/*_test.rb"
+end
+
+task :default => :test

data/artoo-leapmotion.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "artoo-leapmotion/version"
+
+Gem::Specification.new do |s|
+  s.name        = "artoo-leapmotion"
+  s.version     = Artoo::Leapmotion::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ron Evans"]
+  s.email       = ["artoo@hybridgroup.com"]
+  s.homepage    = "https://github.com/hybridgroup/artoo-"
+  s.summary     = %q{Artoo adaptor and driver for Leap Motion}
+  s.description = %q{Artoo adaptor and driver for Leap Motion}
+
+  s.rubyforge_project = "artoo-leapmotion"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency 'artoo', '~> 1.0.0.rc2'
+  s.add_runtime_dependency 'hybridgroup-celluloid-websocket-client'
+  s.add_development_dependency 'minitest', '~> 5.0'
+  s.add_development_dependency 'minitest-happy'
+  s.add_development_dependency 'mocha', '~> 0.14.0'
+end

data/examples/leap.rb

@@ -0,0 +1,26 @@
+require 'artoo'
+
+connection :leapmotion, :adaptor => :leapmotion, :port => '127.0.0.1:6437'
+device :leapmotion, :driver => :leapmotion
+  
+work do
+  on leapmotion, :open => :on_open
+  on leapmotion, :frame => :on_frame
+  on leapmotion, :close => :on_close
+end
+
+def on_open(*args)
+  puts args
+end
+
+def on_frame(*args)
+  frame = args[1]
+  puts frame
+  puts frame.hands
+  puts frame.gestures
+  puts frame.pointables
+end
+
+def on_close(*args)
+  puts args
+end

data/examples/leap_gesture.rb

@@ -0,0 +1,22 @@
+require 'artoo'
+
+connection :leapmotion, :adaptor => :leapmotion, :port => '127.0.0.1:6437'
+device :leapmotion, :driver => :leapmotion
+  
+work do
+  on leapmotion, :open => :on_open
+  on leapmotion, :gesture => :on_gesture
+  on leapmotion, :close => :on_close
+end
+
+def on_open(*args)
+  puts args
+end
+
+def on_gesture(*args)
+  puts args[1]
+end
+
+def on_close(*args)
+  puts args
+end

data/lib/artoo-leapmotion.rb

@@ -0,0 +1,3 @@
+require 'lib/artoo/adaptors/leapmotion'
+require 'lib/artoo/drivers/leapmotion'
+require 'lib/artoo-leapmotion/version'

data/lib/artoo-leapmotion/version.rb

@@ -0,0 +1,5 @@
+module Artoo
+  module Leapmotion
+    VERSION = '0.1.1'
+  end
+end

data/lib/artoo/adaptors/leapmotion.rb

@@ -0,0 +1,41 @@
+require 'artoo/adaptors/adaptor'
+require 'celluloid/websocket/client'
+
+module Artoo
+  module Adaptors
+    # Connect to a leapmotion device
+    # @see device documentation for more information
+    class Leapmotion < Adaptor
+      finalizer :finalize
+      attr_reader :leap
+
+      # Closes connection with device if connected
+      # @return [Boolean]
+      def finalize
+        disconnect if connected?
+      end
+
+      # Creates a connection with device
+      # @return [Boolean]
+      def connect
+        @leap = Celluloid::WebSocket::Client.new("ws://#{port.host}:#{port.port}/v3.json")
+
+        super
+      end
+
+      # Closes connection with device
+      # @return [Boolean]
+      def disconnect
+        leap.close
+
+        super
+      end
+
+      # Uses method missing to call device actions
+      # @see device documentation
+      def method_missing(method_name, *arguments, &block)
+        leap.send(method_name, *arguments, &block)
+      end
+    end
+  end
+end

data/lib/artoo/drivers/leapmotion.rb

@@ -0,0 +1,49 @@
+require 'artoo/drivers/driver'
+require 'artoo/drivers/leapmotion/frame'
+require 'json'
+
+module Artoo
+  module Drivers
+    # The leapmotion driver behaviors
+    class Leapmotion < Driver
+
+      # Start driver and any required connections
+      def start_driver
+        begin
+          connection.handler = current_actor
+          connection.start
+
+          super
+        rescue Exception => e
+          Logger.error "Error starting Leapmotion driver!"
+          Logger.error e.message
+          Logger.error e.backtrace.inspect
+        end
+      end
+
+      def on_open
+        publish(event_topic_name("open"))
+        data = JSON.dump("enableGestures" => true)
+        connection.text(data)
+      end
+
+      def on_message(data)
+        message = JSON.parse(data)
+        if message.key?("id") and message.key?("timestamp")
+          frame = Artoo::Drivers::Leapmotion::Frame.new(message)
+          publish(event_topic_name("frame"), frame)
+
+          frame.gestures.each {|g| publish(event_topic_name("gesture"), g)}
+        else
+          publish(event_topic_name("error"), data)
+        end
+      rescue Exception => e
+        publish(event_topic_name("error"), data)
+      end
+
+      def on_close(code, reason)
+        publish(event_topic_name("close"), code, reason)
+      end
+    end
+  end
+end

data/lib/artoo/drivers/leapmotion/frame.rb

@@ -0,0 +1,24 @@
+require 'artoo/drivers/leapmotion/gesture'
+require 'artoo/drivers/leapmotion/pointable'
+require 'artoo/drivers/leapmotion/hand'
+
+module Artoo
+  module Drivers
+    # The leapmotion driver behaviors
+    class Leapmotion < Driver
+      class Frame
+        attr_reader :gestures, :pointables, :hands, :id, :timestamp, :r, :s, :t
+        def initialize(data)
+          @hands = Artoo::Drivers::Leapmotion::Hand.list(data)
+          @gestures = Artoo::Drivers::Leapmotion::Gesture.list(data)
+          @pointables = Artoo::Drivers::Leapmotion::Pointable.list(data)
+          @id = data["id"]
+          @timestamp = data["timestamp"]
+          @r = data["r"]
+          @s = data["s"]
+          @t = data["t"]
+        end
+      end
+    end
+  end
+end

data/lib/artoo/drivers/leapmotion/gesture.rb

@@ -0,0 +1,67 @@
+module Artoo
+  module Drivers
+    # The leapmotion driver behaviors
+    class Leapmotion < Driver
+      # Recognized movement by the user
+      #
+      # There is 4 Gesture subclasses :
+      #
+      #   Circle - A circular movement by a finger.
+      #   Swipe - A straight line movement by the hand with fingers extended.
+      #   KeyTap -  A downward tapping movement by a finger.
+      #   ScreenTap - A forward tapping movement by a finger.
+      class Gesture
+        class Error < StandardError; end
+
+        def self.list(data)
+          gestures = []
+          if data["gestures"]
+            data["gestures"].each do |gesture|
+              gestures << make_gesture(gesture)
+            end
+          end
+          return gestures
+        end
+
+        def self.make_gesture(data)
+          unless data.has_key? "type"
+            raise Error, "gesture type unknown"
+          end
+          name = data["type"][0].upcase << data["type"][1..-1]
+          unless class_exists?(name)
+            raise Error, "gesture class `#{self}::#{name}' invalid"
+          end
+          const_get(name).new(data)
+        end
+
+        private
+
+        def self.class_exists?(class_name)
+          klass = const_get(class_name)
+          return klass.is_a?(Class)
+        rescue NameError
+          return false
+        end
+
+        def self.define_gesture *names
+          names.each do |n|
+            name = n.to_s
+            unless class_exists?(name)
+              c = Class.new(self) do
+                def initialize(data)
+                  data.each do |k, v|
+                    instance_variable_set("@#{k}", v)
+                    self.class.send(:define_method, k.to_sym, lambda { instance_variable_get("@#{k}") })
+                  end
+                end
+              end
+              const_set name, c
+            end
+          end
+        end
+
+        define_gesture :Circle, :KeyTap, :ScreenTap, :Swipe
+      end
+    end
+  end
+end

data/lib/artoo/drivers/leapmotion/hand.rb

@@ -0,0 +1,25 @@
+module Artoo
+  module Drivers
+    # The leapmotion driver behaviors
+    class Leapmotion < Driver
+      class Hand
+        def self.list(data)
+          hands = []
+          if data["hands"]
+            data["hands"].each do |hand|
+              hands << Artoo::Drivers::Leapmotion::Hand.new(hand)
+            end
+          end
+          return hands
+        end
+
+        def initialize(data)
+          data.each do |k, v|
+            instance_variable_set("@#{k}", v)
+            self.class.send(:define_method, k.to_sym, lambda { instance_variable_get("@#{k}") })
+          end
+        end
+      end
+    end
+  end
+end

data/lib/artoo/drivers/leapmotion/pointable.rb

@@ -0,0 +1,25 @@
+module Artoo
+  module Drivers
+    # The leapmotion driver behaviors
+    class Leapmotion < Driver
+      class Pointable
+        def self.list(data)
+          pointables = []
+          if data["pointables"]
+            data["pointables"].each do |pointable|
+              pointables << Artoo::Drivers::Leapmotion::Pointable.new(pointable)
+            end
+          end
+          return pointables
+        end
+
+        def initialize(data)
+          data.each do |k, v|
+            instance_variable_set("@#{k}", v)
+            self.class.send(:define_method, k.to_sym, lambda { instance_variable_get("@#{k}") })
+          end
+        end
+      end
+    end
+  end
+end

data/test/adaptors/leapmotion_adaptor_test.rb

@@ -0,0 +1,6 @@
+require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
+require 'artoo/adaptors/leapmotion'
+
+describe Artoo::Adaptors::Leapmotion do
+  it "must do something"
+end

data/test/drivers/leapmotion_driver_test.rb

@@ -0,0 +1,50 @@
+require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
+require 'artoo/drivers/leapmotion'
+
+def valid_frame
+  {
+    id: '123',
+    timestamp: '123456789'
+  }
+end
+
+describe Artoo::Drivers::Leapmotion do
+  before do
+    @device = mock('device')
+    @driver = Artoo::Drivers::Leapmotion.new(:parent => @device)
+    @connection = mock('connection')
+    @device.stubs(:connection).returns(@connection)
+    @frame = mock('frame')
+    @frame.stubs(:gestures).returns([])
+    Artoo::Drivers::Leapmotion::Frame.stubs(:new).returns(@frame)
+  end
+
+  it 'Leapmotion#on_open' do
+    @device.expects(:event_topic_name).with("open").returns("hi_open")
+    @connection.expects(:text)
+    @driver.on_open
+  end
+
+  it 'Leapmotion#on_message with a frame but no gesture' do
+    @device.expects(:event_topic_name).with("frame")
+    @device.expects(:event_topic_name).with("gesture").never
+    @driver.on_message(JSON.dump(valid_frame))
+  end
+
+  it 'Leapmotion#on_message with a gesture' do
+    @device.expects(:event_topic_name).with("frame")
+    @device.expects(:event_topic_name).with("gesture")
+    @frame.stubs(:gestures).returns(['123'])
+    @driver.on_message(JSON.dump(valid_frame))
+  end
+
+  it 'Leapmotion#error' do
+    @device.expects(:event_topic_name).with("error")
+    @driver.on_message("no good")
+  end
+
+  it 'Leapmotion#on_close' do
+    @device.expects(:event_topic_name).with("close").returns("hi_bye")
+    @driver.on_close(2, "huh")
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'artoo/robot'
+
+require 'minitest/autorun'
+require 'mocha/setup'
+
+Celluloid.logger = nil

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: artoo-leapmotion
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Ron Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: artoo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc2
+- !ruby/object:Gem::Dependency
+  name: hybridgroup-celluloid-websocket-client
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-happy
+  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: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+description: Artoo adaptor and driver for Leap Motion
+email:
+- artoo@hybridgroup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- artoo-leapmotion.gemspec
+- examples/leap.rb
+- examples/leap_gesture.rb
+- lib/artoo-leapmotion.rb
+- lib/artoo-leapmotion/version.rb
+- lib/artoo/adaptors/leapmotion.rb
+- lib/artoo/drivers/leapmotion.rb
+- lib/artoo/drivers/leapmotion/frame.rb
+- lib/artoo/drivers/leapmotion/gesture.rb
+- lib/artoo/drivers/leapmotion/hand.rb
+- lib/artoo/drivers/leapmotion/pointable.rb
+- test/adaptors/leapmotion_adaptor_test.rb
+- test/drivers/leapmotion_driver_test.rb
+- test/test_helper.rb
+homepage: https://github.com/hybridgroup/artoo-
+licenses: []
+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: artoo-leapmotion
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Artoo adaptor and driver for Leap Motion
+test_files: []