artoo-joystick 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b0c85eb882b2e9308a8d8f3cdb26205510be784e
+  data.tar.gz: 58c51740b9f39ce8c228871298a02b6ad7550375
+SHA512:
+  metadata.gz: c8056e13185651b0d77f120b137146687eada40a9a5af15b70bb3fef25fa1abf9c4e25baf3f85aeb791dcb7d97780ea9b3b6ac64eeac9b994976639d70a416aa
+  data.tar.gz: 275aafc357b7bf5b7159d3622019aee166e5cd025d66bdfd8353424601499b53b600a9deba37a54ab11d18bd5eab032d26d5fcc3a000a6061bd56c235c3594f2

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    artoo-joystick (0.2.0)
+      artoo (>= 1.3.0)
+      hybridgroup-ruby-sdl-ffi
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    artoo (1.3.0)
+      celluloid (~> 0.15.0)
+      celluloid-io (~> 0.15.0)
+      multi_json (~> 1.6)
+      pry (~> 0.9)
+      rake
+      reel (~> 0.4.0)
+      thor (~> 0.18.1)
+    celluloid (0.15.1)
+      timers (~> 1.1.0)
+    celluloid-io (0.15.0)
+      celluloid (>= 0.15.0)
+      nio4r (>= 0.5.0)
+    coderay (1.0.9)
+    ffi (1.9.0)
+    http (0.5.0)
+      http_parser.rb
+    http_parser.rb (0.6.0.beta.2)
+    hybridgroup-ruby-sdl-ffi (0.4.1)
+      nice-ffi (>= 0.2)
+    metaclass (0.0.1)
+    method_source (0.8.2)
+    minitest (5.0.8)
+    minitest-happy (1.0.0)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.8.0)
+    nice-ffi (0.4)
+      ffi (>= 0.5.0)
+    nio4r (0.5.0)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.1.0)
+    reel (0.4.0)
+      celluloid (>= 0.15.1)
+      celluloid-io (>= 0.15.0)
+      http (>= 0.5.0)
+      http_parser.rb (>= 0.6.0.beta.2)
+      websocket_parser (>= 0.1.4)
+    slop (3.4.6)
+    thor (0.18.1)
+    timers (1.1.0)
+    websocket_parser (0.1.4)
+      http
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  artoo-joystick!
+  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,56 @@
+# Artoo Adaptor For Joysticks & Game Controllers
+
+This repository contains the Artoo (http://artoo.io/) adaptor for the PS3 game controller, XBox360 game controller, or any other joysticks and game controllers that are compatible with Simple DirectMedia Layer (SDL) (http://www.libsdl.org/). 
+
+Artoo is a open source micro-framework for robotics using Ruby.
+
+For more information about Artoo, check out our repo at https://github.com/hybridgroup/artoo
+
+The artoo-joystick adaptor uses the rubysdl gem (http://www.kmc.gr.jp/~ohai/rubysdl.en.html).
+
+[![Code Climate](https://codeclimate.com/github/hybridgroup/artoo-joystick.png)](https://codeclimate.com/github/hybridgroup/artoo-joystick) [![Build Status](https://travis-ci.org/hybridgroup/artoo-joystick.png?branch=master)](https://travis-ci.org/hybridgroup/artoo-joystick)
+
+## Installing
+
+```
+gem install artoo-joystick
+```
+
+## Using
+
+```ruby
+require 'artoo'
+
+connection :joystick, :adaptor => :joystick
+device :controller, :driver => :xbox360, :connection => :joystick, :interval => 0.1
+
+work do
+  on controller, :joystick => proc { |*value|
+    puts "joystick #{value[1][:s]} x:#{value[1][:x]} y:#{value[1][:y]}"
+  }
+  on controller, :button_a => proc { |*value|
+    puts "ayyyy!"
+  }
+  on controller, :button_b => proc { |*value|
+    puts "bee!"
+  }
+  on controller, :button_x => proc { |*value|
+    puts "exxx!"
+  }
+  on controller, :button_y => proc { |*value|
+    puts "why!"
+  }
+end
+```
+
+## Connecting to USB Joysticks and Game Controllers
+
+Plus your USB joystick or game controller into your USB port. If your device is supported by SDL, you are now ready.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

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-joystick.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "artoo-joystick/version"
+
+Gem::Specification.new do |s|
+  s.name        = "artoo-joystick"
+  s.version     = Artoo::Joystick::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ron Evans"]
+  s.email       = ["artoo@hybridgroup.com"]
+  s.homepage    = "https://github.com/hybridgroup/artoo-joystick"
+  s.summary     = %q{Artoo adaptor and driver for SDL joysticks and game controllers}
+  s.description = %q{Artoo adaptor and driver for SDL joysticks and game controllers}
+  s.license     = 'Apache 2.0'
+
+  s.rubyforge_project = "artoo-joystick"
+
+  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.3.0'
+  s.add_runtime_dependency 'hybridgroup-ruby-sdl-ffi'
+  s.add_development_dependency 'minitest', '>= 5.0'
+  s.add_development_dependency 'minitest-happy'
+  s.add_development_dependency 'mocha', '>= 0.14.0'
+end

data/examples/controller.rb

@@ -0,0 +1,13 @@
+require 'artoo'
+
+connection :joystick, :adaptor => :joystick
+device :controller, :driver => :joystick, :connection => :joystick, :interval => 0.1
+
+work do
+  on controller, :joystick => proc { |*value|
+    puts "joystick #{value[1][:s]} x:#{value[1][:x]} y:#{value[1][:y]}"
+  }
+  on controller, :button => proc { |*value|
+    puts "button #{value[1]}"
+  }
+end

data/examples/ps3_controller.rb

@@ -0,0 +1,16 @@
+require 'artoo'
+
+connection :joystick, :adaptor => :joystick
+device :controller, :driver => :ps3, :connection => :joystick, :interval => 0.1
+
+work do
+  on controller, :joystick => proc { |*value|
+    puts "joystick #{value[1][:s]} x:#{value[1][:x]} y:#{value[1][:y]}"
+  }
+  on controller, :button => proc { |*value|
+    puts "button #{value[1]}"
+  }
+  on controller, :button_square => proc { |*value|
+    puts "l7 weenie!"
+  }
+end

data/examples/xbox_360_controller.rb

@@ -0,0 +1,22 @@
+require 'artoo'
+
+connection :joystick, :adaptor => :joystick
+device :controller, :driver => :xbox360, :connection => :joystick, :interval => 0.1
+
+work do
+  on controller, :joystick => proc { |*value|
+    puts "joystick #{value[1][:s]} x:#{value[1][:x]} y:#{value[1][:y]}"
+  }
+  on controller, :button_a => proc { |*value|
+    puts "ayyyy!"
+  }
+  on controller, :button_b => proc { |*value|
+    puts "bee!"
+  }
+  on controller, :button_x => proc { |*value|
+    puts "exxx!"
+  }
+  on controller, :button_y => proc { |*value|
+    puts "why!"
+  }
+end

data/lib/artoo/adaptors/joystick.rb

@@ -0,0 +1,91 @@
+require 'artoo/adaptors/adaptor'
+
+module Artoo
+  module Adaptors
+    # Connect to a joystick device
+    # @see device documentation for more information
+    class Joystick < Adaptor
+      finalizer :finalize
+      attr_reader :joystick
+
+      # Closes connection with device if connected
+      # @return [Boolean]
+      def finalize
+        disconnect if connected?
+      end
+
+      # Creates a connection with device
+      # @return [Boolean]
+      def connect
+        require 'ruby-sdl-ffi' unless defined?(::SDL)
+
+        ::SDL.Init( ::SDL::INIT_JOYSTICK )
+
+        raise "No SDL joystick available" if num_joysticks == 0
+        
+        @joystick = ::SDL.JoystickOpen(0) # TODO: allow user to choose which joystick
+
+        super
+      end
+
+      # Closes connection with device
+      # @return [Boolean]
+      def disconnect
+        ::SDL.JoystickClose(joystick)
+        super
+      end
+
+      # Name of device
+      # @return [String]
+      def firmware_name
+        ::SDL.JoystickName(0)
+      end
+
+      # Version of device
+      # @return [String]
+      def version
+        Artoo::Joystick::VERSION
+      end
+
+      def poll
+        ::SDL.JoystickUpdate
+      end
+
+      def num_joysticks
+        ::SDL.NumJoysticks
+      end
+
+      def num_axes
+        ::SDL.JoystickNumAxes(joystick)
+      end
+
+      def axis(n)
+        ::SDL.JoystickGetAxis(joystick, n)
+      end
+
+      def num_balls
+        ::SDL.JoystickNumBalls(joystick)
+      end
+
+      def ball(n)
+        ::SDL.JoystickGetBall(joystick, n)
+      end
+
+      def num_hats
+        ::SDL.JoystickNumHats(joystick)
+      end
+
+      def hat(n)
+        ::SDL.JoystickGetHat(joystick, n)
+      end
+
+      def num_buttons
+        ::SDL.JoystickNumButtons(joystick)
+      end
+
+      def button(n)
+        ::SDL.JoystickGetButton(joystick, n)
+      end
+    end
+  end
+end

data/lib/artoo/drivers/joystick.rb

@@ -0,0 +1,78 @@
+require 'artoo/drivers/driver'
+
+module Artoo
+  module Drivers
+    # The sdl-joystick driver behaviors
+    class Joystick < Driver
+      attr_reader :button_values
+
+      # Start driver and any required connections
+      def start_driver
+        @button_values = {}
+
+        begin
+          every(interval) do
+            handle_message_events
+          end
+
+          super
+        rescue Exception => e
+          Logger.error "Error starting SdlJoystick driver!"
+          Logger.error e.message
+          Logger.error e.backtrace.inspect
+        end
+      end
+
+      def handle_message_events
+        connection.poll
+        handle_joystick
+        # TODO: handle_trackball
+        # TODO: handle_hats
+        handle_buttons
+      end
+
+      def handle_joystick
+        number_sticks = connection.num_axes / 2
+        number_sticks.times {|s|
+          x = connection.axis(s * 2)
+          y = connection.axis(s * 2 + 1)
+        
+          publish_joystick(s, x, y)
+        }
+      end
+
+      def handle_trackball
+        if connection.num_balls == 1
+          x, y = connection.ball(0)
+        
+          publish(event_topic_name("update"), "trackball", {:x => x, :y => y})
+          publish(event_topic_name("trackball"), {:x => x, :y => y})
+        end
+      end
+
+      def handle_buttons
+        connection.num_buttons.times {|b|
+          currently_pressed = connection.button(b)
+          if button_values[b] != currently_pressed
+            button_values[b] = currently_pressed
+            if currently_pressed == 1
+              publish_button(b)
+            end
+          end
+        }
+      end
+
+      def publish_joystick(s, x, y)
+        publish(event_topic_name("update"), "joystick", {:x => x, :y => y, :s => s})
+        publish(event_topic_name("joystick"), {:x => x, :y => y, :s => s})
+        publish(event_topic_name("joystick_#{s}"), {:x => x, :y => y})
+      end
+
+      def publish_button(b)
+        publish(event_topic_name("update"), "button", b)
+        publish(event_topic_name("button"), b)
+        publish(event_topic_name("button_#{b}"))
+      end
+    end
+  end
+end

data/lib/artoo/drivers/ps3.rb

@@ -0,0 +1,43 @@
+require 'artoo/drivers/joystick'
+
+module Artoo
+  module Drivers
+    # The Ps3 controller driver behaviors
+    class Ps3 < Artoo::Drivers::Joystick
+      BUTTON_MAP = {
+        0 => 'square',
+        1 => 'x',
+        2 => 'circle',
+        3 => 'triangle',
+        4 => 'l1',
+        5 => 'r1',
+        6 => 'l2',
+        7 => 'r2',
+        8 => 'select',
+        9 => 'start',
+        10 => 'left_joystick',
+        11 => 'right_joystick',
+        12 => 'home'
+      }
+
+      def handle_joystick
+        x0 = connection.axis(0)
+        y0 = connection.axis(1)
+        publish_joystick(0, x0, y0)
+
+        x1 = connection.axis(2)
+        y1 = connection.axis(3)
+        publish_joystick(1, x1, y1)        
+      end
+
+      def publish_button(b)
+        publish(event_topic_name("button_#{button_letter(b)}"))
+        super
+      end
+
+      def button_letter(b)
+        BUTTON_MAP[b]
+      end
+    end
+  end
+end

data/lib/artoo/drivers/xbox360.rb

@@ -0,0 +1,38 @@
+require 'artoo/drivers/joystick'
+
+module Artoo
+  module Drivers
+    # The Xbox360 controller driver behaviors
+    class Xbox360 < Artoo::Drivers::Joystick
+      BUTTON_MAP = {
+        0 => 'a',
+        1 => 'b',
+        2 => 'x',
+        3 => 'y',
+        4 => 'lb',
+        5 => 'rb',
+        6 => 'back',
+        7 => 'start'
+      }
+
+      def handle_joystick
+        x0 = connection.axis(0)
+        y0 = connection.axis(1)
+        publish_joystick(0, x0, y0)
+
+        x1 = connection.axis(3)
+        y1 = connection.axis(4)
+        publish_joystick(1, x1, y1)        
+      end
+
+      def publish_button(b)
+        publish(event_topic_name("button_#{button_letter(b)}"))
+        super
+      end
+
+      def button_letter(b)
+        BUTTON_MAP[b]
+      end
+    end
+  end
+end

data/lib/artoo-joystick/version.rb

@@ -0,0 +1,5 @@
+module Artoo
+  module Joystick
+    VERSION = '0.2.0'
+  end
+end

data/lib/artoo-joystick.rb

@@ -0,0 +1,5 @@
+require 'lib/artoo/adaptors/joystick'
+require 'lib/artoo/drivers/joystick'
+require 'lib/artoo/drivers/xbox360'
+require 'lib/artoo/drivers/ps3'
+require 'lib/artoo-joystick/version'

data/test/adaptors/joystick_adaptor_test.rb

@@ -0,0 +1,87 @@
+require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
+require 'artoo/adaptors/joystick'
+require 'ruby-sdl-ffi'
+
+describe Artoo::Adaptors::Joystick do
+  before do
+    @adaptor = Artoo::Adaptors::Joystick.new
+    @adaptor.stubs(:joystick).returns("joy")
+  end
+
+  it 'must #connect' do
+    ::SDL.expects(:Init).with(::SDL::INIT_JOYSTICK)
+    @adaptor.expects(:num_joysticks).returns(1)
+    ::SDL.expects(:JoystickOpen).with(0)
+
+    @adaptor.connect
+  end
+
+  it 'must #disconnect' do
+    ::SDL.expects(:JoystickClose).with("joy")
+
+    @adaptor.disconnect
+  end
+
+  describe "device info interface" do
+    it "#firmware_name" do
+      ::SDL.expects(:JoystickName).with(0).returns("somuchjoy")
+      @adaptor.firmware_name.must_equal "somuchjoy"
+    end
+
+    it "#version" do
+      @adaptor.version.must_equal Artoo::Joystick::VERSION
+    end
+  end
+
+  describe "SDL interface" do
+    it "#poll" do
+      ::SDL.expects(:JoystickUpdate)
+      @adaptor.poll
+    end
+
+    it "#num_joysticks" do
+      ::SDL.expects(:NumJoysticks).returns(1)
+      @adaptor.num_joysticks.must_equal 1
+    end
+
+    it "#num_axes" do
+      ::SDL.expects(:JoystickNumAxes).with("joy").returns(2)
+      @adaptor.num_axes.must_equal 2
+    end
+
+    it "#axis" do
+      ::SDL.expects(:JoystickGetAxis).with("joy", 0).returns(101)
+      @adaptor.axis(0).must_equal 101
+    end
+
+    it "#num_balls" do
+      ::SDL.expects(:JoystickNumBalls).with("joy").returns(2)
+      @adaptor.num_balls.must_equal 2
+    end
+
+    it "#ball" do
+      ::SDL.expects(:JoystickGetBall).with("joy", 0).returns(102)
+      @adaptor.ball(0).must_equal 102
+    end
+
+    it "#num_hats" do
+      ::SDL.expects(:JoystickNumHats).with("joy").returns(3)
+      @adaptor.num_hats.must_equal 3
+    end
+
+    it "#hat" do
+      ::SDL.expects(:JoystickGetHat).with("joy", 0).returns(103)
+      @adaptor.hat(0).must_equal 103
+    end
+
+    it "#num_buttons" do
+      ::SDL.expects(:JoystickNumButtons).with("joy").returns(5)
+      @adaptor.num_buttons.must_equal 5
+    end
+
+    it "#button" do
+      ::SDL.expects(:JoystickGetButton).with("joy", 0).returns(true)
+      @adaptor.button(0).must_equal true
+    end
+  end
+end

data/test/drivers/joystick_driver_test.rb

@@ -0,0 +1,4 @@
+require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
+require 'artoo/drivers/joystick'
+
+# TODO: test for your driver goes here...

data/test/drivers/ps3_test.rb

@@ -0,0 +1,4 @@
+require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
+require 'artoo/drivers/ps3'
+
+# TODO: test for your driver goes here...

data/test/drivers/xbox360_test.rb

@@ -0,0 +1,4 @@
+require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
+require 'artoo/drivers/xbox360'
+
+# TODO: test for your driver goes here...

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'minitest/autorun'
+require 'mocha/setup'
+require 'artoo/robot'
+
+Celluloid.logger = nil
+
+MiniTest::Spec.before do
+  Celluloid.shutdown
+  Celluloid.boot
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: artoo-joystick
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Ron Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: artoo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: hybridgroup-ruby-sdl-ffi
+  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 SDL joysticks and game controllers
+email:
+- artoo@hybridgroup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- artoo-joystick.gemspec
+- examples/controller.rb
+- examples/ps3_controller.rb
+- examples/xbox_360_controller.rb
+- lib/artoo-joystick.rb
+- lib/artoo-joystick/version.rb
+- lib/artoo/adaptors/joystick.rb
+- lib/artoo/drivers/joystick.rb
+- lib/artoo/drivers/ps3.rb
+- lib/artoo/drivers/xbox360.rb
+- test/adaptors/joystick_adaptor_test.rb
+- test/drivers/joystick_driver_test.rb
+- test/drivers/ps3_test.rb
+- test/drivers/xbox360_test.rb
+- test/test_helper.rb
+homepage: https://github.com/hybridgroup/artoo-joystick
+licenses:
+- Apache 2.0
+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-joystick
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Artoo adaptor and driver for SDL joysticks and game controllers
+test_files: []