gamepad 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dd64f2dc52c298fd48b2dbdb8dfb759eb5e8d972
+  data.tar.gz: af39e46a5869b99bd0834cad905014a32b78d758
+SHA512:
+  metadata.gz: 80eb5e643ced7cf0f070291c16864eece8819c4ea3900503b30c979946c4d4a3ca0f1d2263787ee4bd6cb2bc805233e1e0717ff11cea63d5160718640f60a0c0
+  data.tar.gz: 0b32781da72d55daefc25527d5cf5e63de7f5ce64e4eccb3fb0e90c2c9c815b138cb4f7ab6aa4d531cc6d1225226a25fb97776cc858c4a37b0df7d2745c19bfc

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+mkmf.log
+gamepad.bundle
+.DS_Store
+
+notes
+xusb*
+log*

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gamepad.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Will Jessop
+
+MIT License
+
+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,59 @@
+# gamepad
+
+Gamepad is a gem I wrote to get the values of my xbox1 controller in a ruby program (to control my Parrot AR drone). I plan to use it for piloting my Parrot AR drone and other robotics stuff. It wasn't designed for use in game libraries, but it might work for you.
+
+This is my first adventure into programming a Ruby c extention, and into c itself, so this lib is probably not safe to use in production, but then who needs to interface with an xbox1 controller in production…
+
+Gamepad is a very early dev release made for me to play around with the xbox gamepad from Ruby, the API will likely change. Pull requests welcome.
+
+## Installation
+
+On a mac:
+
+		brew install libusbx
+
+On another platform YMMV. Add this line to your application's Gemfile:
+
+		gem 'gamepad'
+
+And then execute:
+
+		$ bundle
+
+Or install it yourself as:
+
+		$ gem install gamepad
+
+## Usage
+
+````ruby
+require 'gamepad'
+
+gamepad = GameController::Xbox1.new
+gamepad.on_changed do |values|
+	puts "Changed to #{values.inspect}"
+end
+````
+
+See examples/.
+
+## 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
+
+## TODO
+
+- auto-detect xbox controllers being added/removed
+- Handle more than one controller type
+- display_xbox_status(libusb_device_handle *handle) crashes when the xbox controller is not connected
+- ps1 controller
+- Maybe use the async API of libusbx
+- Signal handling is kind of odd
+
+## Author
+
+* Will Jessop, @will_j, will@willj.net

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rake/extensiontask'
+Rake::ExtensionTask.new('gamepad') do |ext|
+	ext.lib_dir = File.join(*['lib', 'gamepad'])
+end

data/examples/dump_values.rb

@@ -0,0 +1,9 @@
+$:.unshift 'lib'
+require 'gamepad'
+
+gamepad = GameController::Xbox1.new
+gamepad.on_changed do |values|
+	puts "Changed to #{values.inspect}"
+end
+
+puts "Done!"

data/ext/gamepad/extconf.rb

@@ -0,0 +1,41 @@
+ENV['RC_ARCHS'] = '' if RUBY_PLATFORM =~ /darwin/
+
+require 'mkmf'
+
+LIBDIR      = RbConfig::CONFIG['libdir'] + '/gamepad'
+INCLUDEDIR  = RbConfig::CONFIG['includedir']
+# RbConfig::CONFIG['CC'] = '/usr/bin/clang -v'
+
+HEADER_DIRS = [
+	# Then search /usr/local for people that installed from source
+	'/usr/local/include',
+	
+	# Check the ruby install locations
+	INCLUDEDIR,
+	
+	# Finally fall back to /usr
+	'/usr/include'
+]
+
+LIB_DIRS = [
+	# Then search /usr/local for people that installed from source
+	'/usr/local/lib',
+	
+	# Check the ruby install locations
+	LIBDIR,
+	
+	# Finally fall back to /usr
+	'/usr/lib'
+]
+
+dir_config('gamepad', HEADER_DIRS, LIB_DIRS)
+
+unless find_header('libusb-1.0/libusb.h')
+	abort "libusb is missing.  please install libusb"
+end
+
+unless find_library('usb-1.0', 'libusb_init')
+	abort "libusb is missing.  please install libusb"
+end
+
+create_makefile('gamepad/gamepad')

data/ext/gamepad/gamepad.c

@@ -0,0 +1,8 @@
+#include <gamepad.h>
+
+VALUE m_game_controller;
+
+void Init_gamepad() {
+	m_game_controller = rb_define_module("GameController");
+	Init_xbox_1(m_game_controller);
+}

data/ext/gamepad/gamepad.h

@@ -0,0 +1,9 @@
+#ifndef RUBY_HID
+#define RUBY_HID
+
+#include <ruby.h>
+#include <xbox_1.h>
+
+extern VALUE m_game_controller;
+
+#endif

data/ext/gamepad/xbox_1.c

@@ -0,0 +1,175 @@
+#include <xbox_1.h>
+
+int perr(char const *format, ...) {
+	va_list args;
+	int r;
+
+	va_start (args, format);
+	r = vfprintf(stderr, format, args);
+	va_end(args);
+
+	return r;
+}
+
+#define ERR_EXIT(errcode) do { perr("   %s\n", libusb_strerror((enum libusb_error)errcode)); return -1; } while (0)
+#define CALL_CHECK(fcall) do { r=fcall; if (r < 0) ERR_EXIT(r); } while (0);
+#define B(x) (((x)!=0)?1:0)
+#define be_to_int32(buf) (((buf)[0]<<24)|((buf)[1]<<16)|((buf)[2]<<8)|(buf)[3])
+
+#define RETRY_MAX                     5
+#define REQUEST_SENSE_LENGTH          0x12
+#define INQUIRY_LENGTH                0x24
+#define READ_CAPACITY_LENGTH          0x08
+
+// HID Class-Specific Requests values. See section 7.2 of the HID specifications
+#define HID_GET_REPORT                0x01
+#define HID_GET_IDLE                  0x02
+#define HID_GET_PROTOCOL              0x03
+#define HID_SET_REPORT                0x09
+#define HID_SET_IDLE                  0x0A
+#define HID_SET_PROTOCOL              0x0B
+#define HID_REPORT_TYPE_INPUT         0x01
+#define HID_REPORT_TYPE_OUTPUT        0x02
+#define HID_REPORT_TYPE_FEATURE       0x03
+
+
+static int fetch_xbox_status(libusb_device_handle *handle, uint8_t input_report[20]);
+static void loop_over_controller_status();
+
+/*
+
+	Ruby definitions
+
+*/
+
+VALUE method_on_changed(VALUE self);
+
+void Init_xbox_1(VALUE module) {
+	VALUE c_xbox_1;
+	c_xbox_1 = rb_define_class_under(module, "Xbox1", rb_cObject);
+	rb_define_method(c_xbox_1, "on_changed", method_on_changed, 0);
+}
+
+VALUE method_on_changed(VALUE self) {
+	if (!rb_block_given_p())
+		rb_raise(rb_eArgError, "Expected block");
+
+	loop_over_controller_status();
+
+	// Never get here
+	return Qnil;
+}
+
+/*
+
+	Regular c functions
+
+*/
+
+static bool run_usb_loop = true;
+
+void signal_callback_handler(int signum) {
+	run_usb_loop = false;
+}
+
+/*
+	
+	Yield a hash with the following data:
+
+	D-pad
+	Start
+	Back
+	Left Stick Press
+	Right Stick Press
+	A
+	B
+	X
+	Y
+	Black
+	White
+	Left Trigger
+	Right Trigger
+	Left Analog X
+	Left Analog Y
+	Right Analog X
+	Right Analog Y
+
+*/
+
+static void loop_over_controller_status() {
+	// The default context is OK, we're not going to use more than one context: http://libusb.sourceforge.net/api-1.0/contexts.html
+	int ret = libusb_init(NULL);
+	if (ret != LIBUSB_SUCCESS) {
+		fprintf(stderr, "libusb_init returned %d\n", ret);
+		exit(1);
+	}
+	
+	// libusb_set_debug(NULL, LIBUSB_LOG_LEVEL_DEBUG);
+
+	libusb_device_handle* handle = libusb_open_device_with_vid_pid(NULL, 0x045e, 0x0289);
+	
+	int INPUT_REPORT_SIZE = 20;
+	int SIZEOF_ARRAY = INPUT_REPORT_SIZE * sizeof(uint8_t);
+
+	uint8_t input_report[INPUT_REPORT_SIZE];
+	uint8_t old_input_report[INPUT_REPORT_SIZE];
+
+	memset(input_report, 0, SIZEOF_ARRAY);
+	memset(old_input_report, 0, SIZEOF_ARRAY);
+
+	signal(SIGINT, signal_callback_handler);
+
+	while (run_usb_loop) {
+		fetch_xbox_status(handle, input_report);
+
+		// Compare the old and new values, we only want to yield if the values change
+		if (memcmp(input_report, old_input_report, SIZEOF_ARRAY) != 0) {
+
+			// Store the new values for comparison next time round
+			memcpy(old_input_report, input_report, SIZEOF_ARRAY);
+
+			VALUE values = rb_hash_new();
+			rb_hash_aset(values, ID2SYM(rb_intern("D-pad")), INT2NUM(input_report[2]&0x0F));
+			rb_hash_aset(values, ID2SYM(rb_intern("Start")), INT2NUM(B(input_report[2]&0x10)));
+			rb_hash_aset(values, ID2SYM(rb_intern("Back")), INT2NUM(B(input_report[2]&0x20)));
+			rb_hash_aset(values, ID2SYM(rb_intern("Left Stick Press")), INT2NUM(B(input_report[2]&0x40)));
+			rb_hash_aset(values, ID2SYM(rb_intern("Right Stick Press")), INT2NUM(B(input_report[2]&0x80)));
+
+			// Presure sensitive, values from 0 to 255
+			rb_hash_aset(values, ID2SYM(rb_intern("A")), INT2NUM(input_report[4]));
+			rb_hash_aset(values, ID2SYM(rb_intern("B")), INT2NUM(input_report[5]));
+			rb_hash_aset(values, ID2SYM(rb_intern("X")), INT2NUM(input_report[6]));
+			rb_hash_aset(values, ID2SYM(rb_intern("Y")), INT2NUM(input_report[7]));
+			rb_hash_aset(values, ID2SYM(rb_intern("Black")), INT2NUM(input_report[8]));
+			rb_hash_aset(values, ID2SYM(rb_intern("White")), INT2NUM(input_report[9]));
+
+			// Triggers are also pressure sensitive
+			rb_hash_aset(values, ID2SYM(rb_intern("Left Trigger")), INT2NUM(input_report[10]));
+			rb_hash_aset(values, ID2SYM(rb_intern("Right Trigger")), INT2NUM(input_report[11]));
+
+			// Left Analog stick x/y
+			rb_hash_aset(values, ID2SYM(rb_intern("Left Analog X")), INT2NUM((int16_t)((input_report[13]<<8)|input_report[12])));
+			rb_hash_aset(values, ID2SYM(rb_intern("Left Analog Y")), INT2NUM((int16_t)((input_report[15]<<8)|input_report[14])));
+
+			// Right Analog stick x/y
+			rb_hash_aset(values, ID2SYM(rb_intern("Right Analog X")), INT2NUM((int16_t)((input_report[17]<<8)|input_report[16])));
+			rb_hash_aset(values, ID2SYM(rb_intern("Right Analog Y")), INT2NUM((int16_t)((input_report[19]<<8)|input_report[18])));
+			rb_yield(values);
+		}
+
+		// Sleep for a while
+		struct timeval tv;
+		tv.tv_sec = 0;
+		tv.tv_usec = 100000;
+		select(0, NULL, NULL, NULL, &tv);
+	}
+	
+	libusb_close(handle);
+	libusb_exit(NULL);
+}
+
+static int fetch_xbox_status(libusb_device_handle *handle, uint8_t input_report[20]) {
+	int r;
+	CALL_CHECK(libusb_control_transfer(handle, LIBUSB_ENDPOINT_IN|LIBUSB_REQUEST_TYPE_CLASS|LIBUSB_RECIPIENT_INTERFACE,HID_GET_REPORT, (HID_REPORT_TYPE_INPUT<<8)|0x00, 0, input_report, 20, 1000));
+	return 0;
+}

data/ext/gamepad/xbox_1.h

@@ -0,0 +1,6 @@
+#include <ruby.h>
+#include <libusb-1.0/libusb.h>
+#include <signal.h>
+#include <stdbool.h>
+
+void Init_xbox_1(VALUE module);

data/gamepad.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gamepad/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = "gamepad"
+	spec.version       = Gamepad::VERSION
+	spec.authors       = ["Will Jessop"]
+	spec.email         = ["will@willj.net"]
+	spec.description   = %q{Get values from an xbox1 gamepad}
+	spec.summary       = %q{Get values from an xbox1 gamepad}
+	spec.homepage      = ""
+	spec.license       = "MIT"
+
+	spec.files         = `git ls-files`.split($/)
+	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+	spec.require_paths = ["lib"]
+
+	spec.add_development_dependency "bundler", "~> 1.3"
+	spec.add_development_dependency "rake"
+	spec.add_development_dependency "rake-compiler"
+end

data/lib/gamepad/version.rb

@@ -0,0 +1,3 @@
+module Gamepad
+	VERSION = "0.0.1"
+end

data/lib/gamepad.rb

@@ -0,0 +1,2 @@
+require 'gamepad/version'
+require 'gamepad/gamepad'

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: gamepad
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Will Jessop
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rake-compiler
+  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: Get values from an xbox1 gamepad
+email:
+- will@willj.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/dump_values.rb
+- ext/gamepad/extconf.rb
+- ext/gamepad/gamepad.c
+- ext/gamepad/gamepad.h
+- ext/gamepad/xbox_1.c
+- ext/gamepad/xbox_1.h
+- gamepad.gemspec
+- lib/gamepad.rb
+- lib/gamepad/version.rb
+homepage: ''
+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.0.5
+signing_key: 
+specification_version: 4
+summary: Get values from an xbox1 gamepad
+test_files: []