dozen 1.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Rob Fletcher
+
+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,63 @@
+# dozen
+A tool to pair your Sixaxis controller with an arbitrary Bluetooth device. A more readable and more usable Ruby port of [`sixpair.c`](http://www.pabr.org/sixlinux/sixpair.c)
+
+This was written by Rob Fletcher, but I looked at sixpair to figure out the USB stuff.
+
+## What does it do?
+
+All this tool will do is tell your Sixaxis controller who it's Bluetooth master is. This is often called *pairing*. This should work with stock Ruby that comes with all OS X installations.
+
+### I'm confused if this is what I need!
+
+With USB devices, you can just plug it in, and it will send data. It knows where to go, just follow the wire. With Bluetooth, you need to jump through a few hoops in order for the device to know where to send data. Most devices make this easy... you can scan for Bluetooth devices, find the one you want, and you're good. The PS3 didn't really have to, since the Sixaxis controller came with a Mini-USB port, so you could just plug it into your PS3, it would pair itself silently, and when you unplugged it would remember where to send the data.
+
+If you want a PS3 controller to send data to something ELSE (like a phone or a tablet) it can be bit more awkward. If you have a device without a USB port, it's entirely awkward.
+
+That's what this will do. I have a Nexus 4 and it has a very useless USB port, but I wanted to pair my Sixaxis with it. The tools for Linux and OS X linked to from [Dancing Pixel Studios](http://www.dancingpixelstudios.com/sixaxiscontroller/tool.html) weren't the greatest. I can't even remember why I gave up trying to build the tool, but I think it was the super-old version of libusb that was required.
+
+But if you just plug your PS3 controller into your computer (I've only tested this on OS X) and run this, you can tell it to pair with any Bluetooth device address you want. I put in my phone's Bluetooth address (helpfully listed right from the [Sixaxis](https://play.google.com/store/apps/details?id=com.dancingpixelstudios.sixaxiscontroller&hl=en) app or if you dig into your settings. I suspect that's what most people will use this for.
+
+### What doesn't this do
+
+All this does is pair the controller with something. It's not a driver. The thing you're pairing your controller with has to know what to do with the device. So if you're using this for an Android device, that probably means you need to root your phone and buy the super handy [Sixaxis](https://play.google.com/store/apps/details?id=com.dancingpixelstudios.sixaxiscontroller&hl=en).
+
+I don't know what it takes to get a Sixaxis controller paired via Bluetooth to be recognized by whatever OS you've got, but this won't do it.
+
+## Getting started
+
+**TODO: Install the gem... that should do it once that's done**
+
+## Basic Usage
+So, you know your phone's Bluetooth address. Let's say that it is `aa:bb:cc:dd:ee:ff`.
+This will be your usecase 99% of the time.
+
+1. Plug in your Sixaxis controller via USB
+2. `ruby -Ilib bin/dozen pair aa:bb:cc:dd:ee:ff` (lol I didn't set it up as a gem yet)
+3. Done! That controller is now paired with your phone. Fire up sixaxis and you're all done
+
+## Advanced Features
+
+### Pair multiple controllers at once!
+So now you have 3 sixaxis controllers and want to use them all on your phone at once. Hopefully you also have an HDMI dongle, but that is beyond the scope of this document.
+
+You could do the usage step 3 times, but ol' flubby was thoughtful enough to add an `--all` flag!
+
+1. Plug in ALL THREE of your Sixaxis controllers at once
+2. `ruby -Ilib bin/dozen pair --all aa:bb:cc:dd:ee:ff`
+3. Go play Snood or something!
+
+### Sniper usage
+
+All right then fancy pants. Now you have ... 18 Sixaxis controllers and you only want to pair one them with your phone.
+
+1. Buy a quality series of USB hubs
+2. Plug in all 18 Sixaxis controllers
+3. `ruby -Ilib bin/dozen list`
+4. Work out which of the 18 nearly-identical entires is the controller you want (it's #4)
+5. `ruby -Ilib bin/dozen pair aa:bb:cc:dd:ee:ff --index 4` (yeah yeah, gemspec something...)
+
+
+# TO DO
+
+* Test coverage
+* Make it a proper gem

data/bin/dozen

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'commander/import'
+require 'dozen'
+
+program :name, 'dozen'
+program :version, Dozen.VERSION
+program :description, 'Tool to pair your Sixaxis PS3 controller to an abritary ' +
+                      'Bluetooth master. Based on sixpair\'s source.'
+program :help_formatter, Commander::HelpFormatter::Terminal
+
+command :list do |c|
+  c.syntax = 'dozen list'
+  c.description = 'Lists all Sixaxis controllers connected via USB and their masters.'
+  c.action do |args, options|
+    Dozen.show_header
+    dozen = Dozen.new
+    dozen.list_controllers
+  end
+end
+
+command :pair do |c|
+  c.syntax = 'dozen pair ADDRESS '
+  c.description = 'Pairs the first controller on the `dozen list` with the Bluetooth address.'
+  c.option '--index NUMBER', Integer, 'Specify which controller on `dozen list` to pair.'
+  c.option '--all', 'Pair every connected Sixaxis controller with the specified address.'
+
+  c.action do |args, options|
+    Dozen.show_header
+
+    options.default :index => 0
+
+    if args.empty?
+      puts "You must specify a Bluetooth device address."
+      next
+    end
+
+    desiredMaster = Dozen.parse_bluetooth_address(args[0])
+
+    if desiredMaster == false
+      puts "Invalid input for Bluetooth device address. Please use six, colon-delimited hexadecimal pairs (00:10:60:AA:36:F8)."
+      next
+    end
+
+    dozen = Dozen.new
+
+    if options.all
+      dozen.assign_address_to_all(desiredMaster)
+    else
+      dozen.assign_address_to_controller(desiredMaster, options.index)
+    end
+  end
+end
+
+default_command :list

data/lib/dozen.rb

@@ -0,0 +1,93 @@
+require 'libusb'
+
+class Dozen
+
+  def initialize
+    @usb = LIBUSB::Context.new
+    @devices = query_usb_for_sixaxis_devices
+    if @devices.length == 0
+      puts "No Sixaxis controllers connected via USB."
+    end
+  end
+
+  def list_controllers
+    @devices.each_with_index do |device, index|
+      device.open do |handle|
+        master = get_device_master_from_handle(handle)
+        puts "Controller ##{index} is paired with #{master.each_byte.map { |b| b.to_s(16) }.join(':')}"
+      end
+    end
+  end
+
+  def assign_address_to_controller(address, controller_index)
+    if @devices[controller_index].nil?
+      puts "No device available at index #{controller_index}"
+      return
+    end
+
+    @devices[controller_index].open do |handle|
+      puts "Assigning address #{formatAddress(address)} to controller ##{controller_index}"
+      assign_master_to_handle(address, handle)
+    end
+  end
+
+  def assign_address_to_all(address)
+    @devices.each_with_index do |device, index|
+      device.open do |handle|
+        puts "Assigning address #{formatAddress(address)} to controller ##{index}"
+        assign_master_to_handle(address, handle)
+      end
+    end
+  end
+
+  def self.parse_bluetooth_address(raw_address)
+    begin
+      preparedAddress = raw_address.split(':').map{ |x| Integer("0x" + x)}
+    rescue
+      return false
+    end
+    return false if preparedAddress.length != 6
+    return false if preparedAddress.any? {|x| x < 0 || x > 0xFF}
+    preparedAddress
+  end
+
+  def self.show_header
+    puts "Dozen v#{Dozen.VERSION}"
+    puts
+  end
+
+  def self.VERSION
+    '1.1.0'
+  end
+
+  private
+
+  def formatAddress(address)
+    address.map{|x| x.to_s(16)}.join(':')
+  end
+
+  def query_usb_for_sixaxis_devices
+    @usb.devices(:idVendor => 0x054c, :idProduct => 0x0268)
+  end
+
+  def get_device_master_from_handle(handle)
+    handle.control_transfer(
+      :bmRequestType => LIBUSB::REQUEST_TYPE_CLASS | LIBUSB::ENDPOINT_IN | LIBUSB::RECIPIENT_INTERFACE,
+      :bRequest => 0x01,
+      :wValue => 0x03f5,
+      :wIndex => 0x0000,
+      :dataIn => 8,
+      :timeout => 5000)[2,6]
+  end
+
+  def assign_master_to_handle(address, handle)
+    msg = ([0x01, 0x00] + address).pack('c*')
+    handle.control_transfer(
+      :bmRequestType => LIBUSB::REQUEST_TYPE_CLASS | LIBUSB::ENDPOINT_OUT | LIBUSB::RECIPIENT_INTERFACE,
+      :bRequest => 0x09,
+      :wValue => 0x03f5,
+      :wIndex => 0x0000,
+      :dataOut => msg,
+      :timeout => 5000)
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: dozen
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 0
+  version: 1.1.0
+platform: ruby
+authors: 
+- Rob Fletcher
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-09-13 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: commander
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 4
+        - 1
+        - 3
+        version: 4.1.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: libusb
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 4
+        version: 0.3.4
+  type: :runtime
+  version_requirements: *id002
+description: A simple tool to pair your Sixaxis controller with any Bluetooth device. Derived from the sixpair.c source.
+email: 
+- rob@terraflubb.com
+executables: 
+- dozen
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/dozen.rb
+- bin/dozen
+- LICENSE
+- README.md
+has_rdoc: true
+homepage: https://github.com/terraflubb/dozen
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A simple tool to pair your Sixaxis controller with any Bluetooth device
+test_files: []
+