akshayrawat-rmotion 0.0.1

data/README

@@ -0,0 +1,6 @@
+Ruby bindings to the Unimotion library. Reads output from the Apple Sudden Motion Sensors.
+
+X is left/right tilt, Y is forward/back, and Z is the change in G force.
+iBook/Powerbook 1G = ~50, positive force = left, towards you, down
+High-res Powerbook 1G = ~50, positive force = right, away from you, up
+MacBook [Pro] 1G = ~250, positive force = left, towards you, down

data/examples/lib/examples_init.rb

@@ -0,0 +1,17 @@
+######################################################################
+
+# Copyright 2008 by Akshay Rawat (projectsatakshaydotcc).
+# All rights reserved.
+
+# Permission is granted for use, copying, modification, distribution,
+# and distribution of modified versions of this work as long as the
+# above copyright notice is included.
+
+######################################################################
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + "/rubyturtles")
+
+require File.dirname(__FILE__) + "/../../lib/rmotion"
+require 'tkturtle'
+require 'turtle'
+require 'turtle_patch'

data/examples/lib/rubyturtles/tkturtle.rb

@@ -0,0 +1,108 @@
+#!/usr/bin/env ruby
+# -*- ruby -*-
+
+# Copyright 2001 by Jim Weirich (jweirich@one.net).
+# All rights reserved.
+
+# Permission is granted for use, copying, modification, distribution,
+# and distribution of modified versions of this work as long as the
+# above copyright notice is included.
+
+require 'tk'
+require 'turtle'
+require 'singleton'
+
+######################################################################
+# Main module for implementing turtle graphics.
+#
+# This file adds a TK based canvas and world for TK turtle graphics.
+#
+module TurtleGraphics
+
+  ######################################################################
+  # Canvas used to adapt a turtle to a TK Canvas Object.
+  #
+  class TkTurtleCanvas
+    
+    def initialize(tkcanvas)
+      @canvas = tkcanvas
+    end
+    
+    ## Draw a line from the start point to the end point.  Return an ID
+    # used to reference the line later.
+    def draw_line(p1, p2)
+      x1, y1 = transform(p1)
+      x2, y2 = transform(p2)
+      TkcLine.new(@canvas, x1, y1, x2, y2)
+    end
+    
+    ## Erase the line represented by _id_.
+    def erase_line(id)
+      id.destroy
+    end
+
+    IconShape = [[5,0],[-5,0],[0,15]]
+    
+    ## Display the turtle icon.  Return an icon ID used to reference
+    # the ID later.
+    def show_icon(heading, position)
+      tx, ty = transform(position)
+      angle =  heading * Math::PI/180
+      points = IconShape.map { |x,y|
+	[ tx + x * Math.cos(angle) + y * Math.sin(angle),
+	  ty + x * Math.sin(angle) - y * Math.cos(angle)
+	]
+      }
+      (0...3).collect { |i| 
+	TkcLine.new(@canvas,
+		    points[i][0],       points[i][1],
+		    points[(i+1)%3][0], points[(i+1)%3][1])
+      }
+    end
+    
+    ## Hide the icon represented by _id_.
+    def hide_icon(icon)
+      icon.each { |widget| widget.destroy }
+    end
+    
+    private # --------------------------------------------------------
+    
+    ## Transform a point in turtle graphics to a TK canvas point.
+    def transform(point)
+      [point[0]+250, 250-point[1]]
+    end
+  end
+  
+  
+  ######################################################################
+  # A TK based turtle world.
+  #
+  class TkWorld < TurtleGraphics::TurtleWorld
+    include Singleton
+
+    ## The canvas to be used for TK graphics.  We will auto create the
+    #  canvas if it is not already defined.
+    def canvas
+      @canvas ||= create_canvas
+    end
+
+    private
+
+    ## Create a TK canvas object.
+    def create_canvas
+      root = TkRoot.new { title "TK Turtle World" }
+      c = TkCanvas.new(root) {
+	height 500
+	width 500
+      }
+      c.pack
+      @canvas = TkTurtleCanvas.new(c)
+      @thread = Thread.new { Tk.mainloop }
+      @canvas
+    end
+
+  end
+end
+  
+## Use the TK world object by default.
+Turtle.world = TurtleGraphics::TkWorld.instance

data/examples/lib/rubyturtles/turtle.rb

@@ -0,0 +1,328 @@
+#!/usr/bin/env ruby
+# -*- ruby -*-
+
+# Copyright 2001 by Jim Weirich (jweirich@one.net).
+# All rights reserved.
+
+# Permission is granted for use, copying, modification, distribution,
+# and distribution of modified versions of this work as long as the
+# above copyright notice is included.
+
+######################################################################
+# Main module for implementing turtle graphics.
+#
+module TurtleGraphics
+
+  include Math
+
+  ######################################################################
+  # Abbreviated commands for interactive turtles.  This makes using
+  # turtles in IRB a little easier.
+  #
+  module TurtleAbbreviations
+    def fd(n=10); forward(n); end
+    def bk(n=10); back(n); end
+    def t(a); turn(a); end
+    def rt; right; end
+    def lt; left; end
+    def hd; hide; end
+    def sh; show; end
+    def pu; penup; end
+    def pd; pendown; end
+    def hm; home; end
+  end
+  
+  
+  ######################################################################
+  # Universal canvas object that does absolutely nothing.  We use this
+  # canvas by default if a real graphical canvas hasn't been defined.
+  #
+  class DefaultCanvas
+
+    ## Draw a line from the start point to the end point.  Return an ID
+    # used to reference the line later.
+    def draw_line(start_point, end_point); nil; end
+
+    ## Erase the line represented by _id_.
+    def erase_line(id); end
+
+    ## Display the turtle icon.  Return an icon ID used to reference
+    # the ID later.
+    def show_icon(heading, position); nil; end
+
+    ## Hide the icon represented by _id_.
+    def hide_icon(id); end
+  end
+  
+
+  ######################################################################
+  # Turtle objects.  Turtle objects respond to relative movement
+  # commands (e.g. forward, backward, turn), as well as a few commands
+  # to control the pen.  
+  #
+  class Turtle
+
+    include TurtleAbbreviations
+    attr_reader :heading
+    
+    DEG2RAD = Math::PI/180
+    
+    # Class Methods --------------------------------------------------
+
+    class << self
+      ## The world to use for newly created turtles.
+      def world
+	@world ||= TurtleWorld.new
+      end
+
+      ## Set the world.
+      def world=(new_world)
+	@world = new_world
+      end
+    end
+    
+    # Creation ---------------------------------------------------------
+    
+    def initialize
+      @canvas = self.class.world.canvas
+      @position = [0,0]
+      @penup = true
+      @hidden = true
+      @lines = []
+      self.heading = 0
+      Turtle.world.add(self)
+      show
+    end
+    
+    # Queries ----------------------------------------------------------
+    
+    ## Is the turtle hidden?
+    def hidden?
+      @hidden
+    end
+    
+    ## Is the pen up?
+    def penup?
+      @penup
+    end
+    
+    ## Array containing the X/Y position of the turtle.
+    def position
+      @position.dup
+    end
+    
+    # Basic Movement ---------------------------------------------------
+    
+    ## Set the position of turtle.
+    def position=(new_position)
+      old_position = @position
+      move_turtle {
+	@position = new_position
+	if not penup?
+	  @lines << @canvas.draw_line(old_position, position)
+	end
+      }
+      @position
+    end
+    
+    ## Set the heading of the turtle.  Zero is straight up.
+    def heading=(value)
+      while value < 0
+	value += 360
+      end
+      move_turtle { @heading = (value % 360) }
+      value
+    end
+    
+    # Movement ---------------------------------------------------------
+    
+    ## Send the turtle home.
+    def home
+      self.position = [0,0]
+      self.heading  = 0
+    end
+    
+    ## Move the turtle forward.
+    def forward(amount)
+      dx = amount * Math.sin(@heading*DEG2RAD)
+      dy = amount * Math.cos(@heading*DEG2RAD)
+      self.position = [@position[0]+dx, @position[1]+dy]
+    end
+    
+    ## Move the turtle backwards.
+    def backward(amount)
+      forward(-amount)
+    end
+
+    ## Turn the turtle.  Positive degrees turns to the right.
+    def turn(degrees)
+      self.heading = @heading + degrees
+    end
+    
+    ## Turn 90 degrees to the left.
+    def left
+      turn(-90)
+    end
+    
+    ## Turn 90 degrees to the right.
+    def right
+      turn(90)
+    end
+    
+    # Drawing ----------------------------------------------------------
+    
+    ## Hide the turtle icon.
+    def hide
+      move_turtle { @hidden = true }
+      nil
+    end
+    
+    ## Show the turtle icon.
+    def show
+      move_turtle { @hidden = false }
+      nil
+    end
+    
+    ## Left the pen off the drawing surface.
+    def penup
+      @penup = true
+      nil
+    end
+    
+    ## Set the pen down on the drawing surface.
+    def pendown
+    @penup = false
+      nil
+    end
+    
+    ## Erase all the lines drawn by this turtle.
+    def clear
+      @lines.each { |lineid| @canvas.erase_line(lineid) }
+      @lines = []
+    end
+
+    # Other ------------------------------------------------------------
+    
+    def inspect
+      "Turtle(#{@heading},[#{@position.join(',')}])"
+    end
+    
+    private # ----------------------------------------------------------
+
+    ## Move the turtle.  Make sure the icon is hidden before the turtle
+    # is moved.
+    def move_turtle
+      @canvas.hide_icon(@icon) if ! hidden?
+      yield
+      @icon = @canvas.show_icon(heading, position) if ! hidden?
+    end
+  end
+  
+  
+  ######################################################################
+  # A composite of many turtles.  A composite turtle controls a number
+  # of other turtles.  Turtle commands are sent to each of its
+  # sub-turtles.
+  #
+  class CompositeTurtle < Turtle
+    include TurtleAbbreviations
+    include Enumerable
+    
+    attr_reader :turtles
+    
+    def initialize(turtles=nil)
+      @turtles = turtles
+      @turtles ||= Array.new
+    end
+    
+    def add(turtle)
+      @turtles << turtle
+    end
+    
+    def each(&block)
+      @turtles.each(&block)
+    end
+
+    def [](index)
+      @turtles[index]
+    end
+
+    def size
+      @turtles.size
+    end
+
+    # Turtle Protocol ------------------------------------------------
+
+    def forward(n)
+      @turtles.each { |t| t.forward(n) }
+    end
+    
+    def backward(n)
+      @turtles.each { |t| t.backward(n) }
+    end
+    
+    def turn(a)
+      @turtles.each { |t| t.turn(a) }
+    end
+    
+    def right
+      @turtles.each { |t| t.right }
+    end
+    
+    def left
+      @turtles.each { |t| t.left }
+    end
+    
+    def hide
+      @turtles.each { |t| t.hide }
+    end
+    
+    def show
+      @turtles.each { |t| t.show }
+    end
+    
+    def penup
+      @turtles.each { |t| t.penup }
+    end
+    
+    def pendown
+      @turtles.each { |t| t.pendown }
+    end
+    
+    def home
+      @turtles.each { |t| t.home }
+    end
+  end
+  
+  
+  ######################################################################
+  # World in which turtles can move and exist.  A turtle world defines
+  # the environment where turtles move.  The world sets up the drawing
+  # canvas used to display the turtles.  A composite turtle
+  # representing all the turtles defined in the world is also
+  # available.
+  #
+  class TurtleWorld
+    attr_reader :all
+    attr_writer :canvas
+
+    def initialize
+      @all = CompositeTurtle.new
+    end
+    
+    ## Add a turtle to the world.
+    def add(turtle)
+      @all.add(turtle)
+    end
+
+    ## Canvas used for drawing.  Lazy initialization is recommended.
+    def canvas
+      @canvas ||= DefaultCanvas.new
+    end
+
+  end
+end
+
+# Export only the Turtle Class
+
+Turtle = TurtleGraphics::Turtle

data/examples/lib/rubyturtles/turtle_patch.rb

@@ -0,0 +1,26 @@
+######################################################################
+
+# Copyright 2008 by Akshay Rawat (projectsatakshaydotcc).
+# All rights reserved.
+
+# Permission is granted for use, copying, modification, distribution,
+# and distribution of modified versions of this work as long as the
+# above copyright notice is included.
+
+######################################################################
+
+module TurtleGraphics
+
+  class TkTurtleCanvas
+    def update_title(title)
+      @canvas.root.title=title
+    end
+  end
+
+  class Turtle
+    def say(text)
+      @canvas.update_title(text)
+    end
+
+  end
+end

data/examples/readings.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + "/../lib/rmotion"
+require 'test/unit'
+
+class Readings < Test::Unit::TestCase
+
+  include RMotion
+
+  def test_should_detect_coordinates_and_sms_type
+    sms_type = detect_sms()
+    coordinates = read_sms_raw(sms_type[:code])
+
+    assert_equal(sms_type, {:code=> 4, :description=> :MacBookPro})
+    assert_equal(coordinates.size,3)
+
+    printf("Apple Motion Sensor Type: %s \n", sms_type[:description]) 
+    
+    loop do
+      coordinates = read_sms_raw(sms_type[:code])
+      printf("Coordinates: X: %d Y: %d Z: %d \n", coordinates[0], coordinates[1], coordinates[2])
+    end
+  end
+
+end

data/examples/turtlebeach.rb

@@ -0,0 +1,31 @@
+######################################################################
+
+# Copyright 2008 by Akshay Rawat (projectsatakshaydotcc).
+# All rights reserved.
+
+# Permission is granted for use, copying, modification, distribution,
+# and distribution of modified versions of this work as long as the
+# above copyright notice is included.
+
+######################################################################
+
+require File.dirname(__FILE__) + "/lib/examples_init"
+
+class TurtleBeach
+  include RMotion, TurtleGraphics
+
+  def initialize
+    @turtle = TurtleGraphics::Turtle.new()
+    @type = detect_sms()
+    loop { move() }
+  end
+
+  def move()
+    r = read_sms(@type[:code])
+    @turtle.say("X: #{r[0]}, Y:#{r[1]}, G:#{r[2]}")
+    @turtle.position= r
+  end
+
+end
+
+TurtleBeach.new

data/lib/rmotion.rb

@@ -0,0 +1,75 @@
+######################################################################
+
+# Copyright 2008 by Akshay Rawat (projectsatakshaydotcc).
+# All rights reserved.
+
+# Permission is granted for use, copying, modification, distribution,
+# and distribution of modified versions of this work as long as the
+# above copyright notice is included.
+
+######################################################################
+
+require 'dl/import'
+
+module RMotion extend DL::Importable
+  LIBUNIMOTION = DL.dlopen(File.dirname(__FILE__) + "/libUniMotion.dylib")
+  SYM = {
+    :detect_sms => LIBUNIMOTION['detect_sms','I'],
+    :read_sms_raw => LIBUNIMOTION['read_sms_raw','IIiii'],
+    :read_sms_real => LIBUNIMOTION['read_sms_real', 'IIddd'],
+    :read_sms => LIBUNIMOTION['read_sms', 'IIiii'],
+    :read_sms_scaled => LIBUNIMOTION['read_sms_scaled', 'IIiii']
+  }
+
+  SMS_TYPES = {
+    0=> :unknown,
+    1=> :PowerBook,
+    2=> :IBook,
+    3=> :highrespb,
+    4=> :MacBookPro
+  }
+
+  def detect_sms()
+    sms_type = SYM[:detect_sms].call()
+    {:code=> sms_type.first, :description=> SMS_TYPES[sms_type.first]}
+  end
+
+  # raw, unmodified values
+  def read_sms_raw(type=nil)
+    type = detect_sms() if type.nil?
+    result = SYM[:read_sms_raw].call(type,1,1,1)
+    coordinates(result)
+  end
+
+  # real (1.0 = 1G) values (requires calibration data)
+  # note that this is the preferred API as it need not change with new machines
+  # if no "scale" calibration data exists defaults will be used based on the
+  # machine type
+  def read_sms_real(type=nil)
+    type = detect_sms() if type.nil?
+    result = SYM[:read_sms_real].call(type,1.0,1.0,1.0)
+    coordinates(result)
+  end
+
+  # calibrated" values (same as raw if no calibration data exists)
+  def read_sms(type=nil)
+    type = detect_sms() if type.nil?
+    result = SYM[:read_sms].call(type,1.0,1.0,1.0)
+    coordinates(result)
+  end
+
+  # scaled values, like real but easier to handle
+  # this reverses the backwards polarity of x and increases the range of the
+  # older machines to match the MacBook [Pro] sensor
+  def read_sms_scaled(type=nil)
+    type = detect_sms() if type.nil?
+    result = SYM[:read_sms_scaled].call(type,1.0,1.0,1.0)
+    coordinates(result)
+  end
+
+  private
+  def coordinates(result)
+    result[1][1..3]
+  end
+
+end

data/rmotion.gemspec

@@ -0,0 +1,12 @@
+Gem::Specification.new do |s|
+  s.name = "rmotion"
+  s.version = "0.0.1"
+  s.date = "2008-04-26"
+  s.summary = "RMotion is a ruby library which allows you to read the output of Sudden Motion Sensors on your Apple laptop"
+  s.email = "project@akshay.cc"
+  s.homepage = "http://github.com/akshayrawat/rmotion"
+  s.description = "RMotion is a ruby library which allows you to read the output of Sudden Motion Sensors on your Apple laptop"
+  s.has_rdoc = false
+  s.authors = ["Akshay Rawat"]
+  s.files = ["README", "rmotion.gemspec", "lib/rmotion.rb", "lib/libUniMotion.dylib", "examples/readings.rb", "examples/turtlebeach.rb", "examples/lib/examples_init.rb", "examples/lib/rubyturtles/tkturtle.rb", "examples/lib/rubyturtles/turtle.rb", "examples/lib/rubyturtles/turtle_patch.rb"]
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: akshayrawat-rmotion
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Akshay Rawat
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-04-26 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: RMotion is a ruby library which allows you to read the output of Sudden Motion Sensors on your Apple laptop
+email: project@akshay.cc
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- rmotion.gemspec
+- lib/rmotion.rb
+- lib/libUniMotion.dylib
+- examples/readings.rb
+- examples/turtlebeach.rb
+- examples/lib/examples_init.rb
+- examples/lib/rubyturtles/tkturtle.rb
+- examples/lib/rubyturtles/turtle.rb
+- examples/lib/rubyturtles/turtle_patch.rb
+has_rdoc: false
+homepage: http://github.com/akshayrawat/rmotion
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: RMotion is a ruby library which allows you to read the output of Sudden Motion Sensors on your Apple laptop
+test_files: []
+