tg-can-controls-gateway 0.1.0

data/.gitignore

@@ -0,0 +1,7 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+*.gemspec
+log/*

data/Capfile

@@ -0,0 +1,8 @@
+load 'deploy' if respond_to?(:namespace) # cap2 differentiator
+Dir['vendor/plugins/*/recipes/*.rb'].each { |plugin| load(plugin) }
+
+# Standard cap deploy recipe
+load 'config/deploy'
+
+# Add your own recipes in files placed in lib/recipes ending in .rb,
+Dir['lib/recipes/**/*.rb'].each { |recipe| load recipe }

data/README

@@ -0,0 +1,243 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create 
+database-backed web applications according to the Model-View-Control pattern. 
+
+This pattern splits the view (also called the presentation) into "dumb" templates
+that are primarily responsible for inserting pre-built data in between HTML tags.
+The model contains the "smart" domain objects (such as Account, Product, Person,
+Post) that holds all the business logic and knows how to persist themselves to
+a database. The controller handles the incoming requests (such as Save New Account,
+Update Product, Show Post) by manipulating the model and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails.  You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, start a new Rails application using the <tt>rails</tt> command
+   and your application name. Ex: rails myapp
+2. Change directory into myapp and start the web server: <tt>script/server</tt> (run with --help for options)
+3. Go to http://localhost:3000/ and get "Welcome aboard: You're riding the Rails!"
+4. Follow the guidelines to start developing your application
+
+
+== Web Servers
+
+By default, Rails will try to use Mongrel if it's are installed when started with script/server, otherwise Rails will use WEBrick, the webserver that ships with Ruby. But you can also use Rails
+with a variety of other web servers.
+
+Mongrel is a Ruby-based webserver with a C component (which requires compilation) that is
+suitable for development and deployment of Rails applications. If you have Ruby Gems installed,
+getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>.
+More info at: http://mongrel.rubyforge.org
+
+Say other Ruby web servers like Thin and Ebb or regular web servers like Apache or LiteSpeed or
+Lighttpd or IIS. The Ruby web servers are run through Rack and the latter can either be setup to use
+FCGI or proxy to a pack of Mongrels/Thin/Ebb servers.
+
+== Apache .htaccess example for FCGI/CGI
+
+# General Apache options
+AddHandler fastcgi-script .fcgi
+AddHandler cgi-script .cgi
+Options +FollowSymLinks +ExecCGI
+
+# If you don't want Rails to look in certain directories,
+# use the following rewrite rules so that Apache won't rewrite certain requests
+# 
+# Example:
+#   RewriteCond %{REQUEST_URI} ^/notrails.*
+#   RewriteRule .* - [L]
+
+# Redirect all requests not available on the filesystem to Rails
+# By default the cgi dispatcher is used which is very slow
+# 
+# For better performance replace the dispatcher with the fastcgi one
+#
+# Example:
+#   RewriteRule ^(.*)$ dispatch.fcgi [QSA,L]
+RewriteEngine On
+
+# If your Rails application is accessed via an Alias directive,
+# then you MUST also set the RewriteBase in this htaccess file.
+#
+# Example:
+#   Alias /myrailsapp /path/to/myrailsapp/public
+#   RewriteBase /myrailsapp
+
+RewriteRule ^$ index.html [QSA]
+RewriteRule ^([^.]+)$ $1.html [QSA]
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteRule ^(.*)$ dispatch.cgi [QSA,L]
+
+# In case Rails experiences terminal errors
+# Instead of displaying this message you can supply a file here which will be rendered instead
+# 
+# Example:
+#   ErrorDocument 500 /500.html
+
+ErrorDocument 500 "<h2>Application error</h2>Rails application failed to start properly"
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong.  Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files.  Have "tail -f" commands running
+on the server.log and development.log. Rails will automatically display debugging
+and runtime information to these files. Debugging info will also be shown in the
+browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code using
+the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now.iso8601} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/ including:
+
+* The Learning Ruby (Pickaxe) Book: http://www.ruby-doc.org/docs/ProgrammingRuby/
+* Learn to Program: http://pine.fm/LearnToProgram/  (a beginners guide)
+
+These two online (and free) books will bring you up to speed on the Ruby language
+and also on programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your Mongrel or
+Webrick server with --debugger. This means that you can break out of execution at any point
+in the code, investigate and change the model, AND then resume execution! 
+You need to install ruby-debug to run the server in debugging mode. With gems, use 'gem install ruby-debug'
+Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.find(:all)
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>,
+       #<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better is that you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you enter "cont"
+
+
+== Console
+
+You can interact with the domain model by starting the console through <tt>script/console</tt>.
+Here you'll have all parts of the application configured, just like it is when the
+application is running. You can inspect domain models, change values, and save to the
+database. Starting the script without arguments will launch it in the development environment.
+Passing an argument will specify a different environment, like <tt>script/console production</tt>.
+
+To reload your controllers and models after launching the console run <tt>reload!</tt>
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>script/dbconsole</tt>.
+You would be connected to the database with the credentials defined in database.yml.
+Starting the script without arguments will connect you to the development database. Passing an
+argument will connect you to a different database, like <tt>script/dbconsole production</tt>.
+Currently works for mysql, postgresql and sqlite.
+
+== Description of Contents
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from ApplicationController
+  which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb.
+  Most models will descend from ActiveRecord::Base.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use eRuby
+  syntax.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the common
+  header/footer method of wrapping views. In your views, define a layout using the
+  <tt>layout :default</tt> and create a file named default.html.erb. Inside default.html.erb,
+  call <% yield %> to render the view using this layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are generated
+  for you automatically when using script/generate for controllers. Helpers can be used to
+  wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database, and other dependencies.
+
+db
+  Contains the database schema in schema.rb.  db/migrate contains all
+  the sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when generated
+  using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that doesn't
+  belong under controllers, models, or helpers. This directory is in the load path.
+
+public
+  The directory available for the web server. Contains subdirectories for images, stylesheets,
+  and javascripts. Also contains the dispatchers and the default HTML files. This should be
+  set as the DOCUMENT_ROOT of your web server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the script/generate scripts, template
+  test files will be generated for you and placed in this directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins subdirectory.
+  If the app has frozen rails, those gems also go here, under vendor/rails/.
+  This directory is in the load path.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "tg-can-controls-gateway"
+    gem.summary = %Q{mapping CC gesture events to RCA}
+    gem.description = <<-TXT.strip.gsub(/\s+/, ' ')
+      to be written
+    TXT
+    gem.email = "entwicklung.t-gallery@artcom.de"
+    gem.homepage = "http://artcom.de/"
+    gem.authors = ["art+com/andreas marr"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+
+    gem.add_development_dependency "rspec"
+    gem.add_runtime_dependency "applix"
+    gem.add_runtime_dependency "gom-script"
+    gem.add_runtime_dependency "eventmachine", ">=0.12.10"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tg-can-controls-gateway #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/app/controllers/application_controller.rb

@@ -0,0 +1,10 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+  protect_from_forgery # See ActionController::RequestForgeryProtection for details
+
+  # Scrub sensitive parameters from your log
+  # filter_parameter_logging :password
+end

data/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end

data/bin/can_controls_gateway

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'applix'
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'can-controls-gateway'
+
+$stderr.sync = true
+$stdout.sync = true
+
+Defaults = { 
+}
+
+def main argv
+  options = Defaults.merge(Hash.from_argv argv)
+
+  puts " -- starting #{File.basename __FILE__} at #{Time.now}"
+  args = (options.delete :args)
+  #debugger if (defined? debugger)
+  service_url = (args.shift || 'http://gom/services/ccg/home')
+  puts " .. #{service_url}"
+  service = nil
+  daemon = Gom::Remote::Daemon.new(service_url, options) do |daemon, path|
+    service = CcgRunner.new(path, options)
+    daemon.check_in 
+  end
+  daemon.background_loop(5) { service.run }
+  daemon.actor_loop { |daemon| puts " -- gom refresh: #{Time.now}" }
+
+rescue => e
+  puts " ## #{e}\n -> #{e.backtrace.join "\n    "}"
+end
+
+main ARGV
+# vim: syntax=ruby

data/doc/README_FOR_APP

@@ -0,0 +1,3 @@
+Use this README file to introduce your application and point to useful places
+in the API for learning more.  Run "rake doc:app" to generate API documentation
+for your models, controllers, helpers, and libraries.

data/doc/recognition-message-example.xml

@@ -0,0 +1,69 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- we propose adding a timestamp -->
+<!-- seems redundant since we already agreed upon TCP as a transport layer protocol -->
+<!-- transport layer protocol changed to UDP. added station ID in order for the receiver
+to be able to identify the originating station in a broadcast situation -->
+<!-- As of 2009/09/04 a sequence attribute has been added. The sequence attribute holds 
+an ever increasing counter value while the timestamp attribute now holds the system time
+of the sending machine in ms since system start -->
+<trackingdata ts="" sequence="" station_id="">
+
+  <!-- for every continuously tracked person a unique id is attached to the
+  <person> element. -->
+  <person id="1">
+
+    <!-- every person has arms which a identified as 'right' or 'left' -->
+    <arm side="right">
+
+      <!-- a recognized hand is always part of an arm and has a destinct shape.
+      The list of knows shapes is: 
+        - thumbLeft
+        - TODO: list of known shapes
+      -->
+      <hand shape="thumbLeft">
+
+        <!-- positions elements have to be of type 'vec3f' and have to contain
+        a comma separated list of 3 floating point values. whitespace is
+        optional, e.g. "1.0,2,3.0" and "1 , 2, 3" are equally valid. 
+
+        coordinate_system for this element must be 'world'. 
+        -->
+        <position type="vec3f" coordinate_system="world">
+          1.0, 2.0, 3.0
+        </position>
+        
+        <!-- <finger> elements are part of the hand and have name which is one
+          of: 'index', 'small', 'thumb', 'ring', 'middle'.  TODO: confirm
+          proper english vocabulary here!  -->
+        <finger name="index">
+
+          <!-- every <finger> position is given as a 'vev3f' value and defines
+            the 3D position vector of the tip of the finger. (TODO: is that
+            correct?)
+
+            usually the fingers position corrdinate system is same as the one
+            of the hand and therefor can be ommitted here -->
+          <position type="vec3f" coordinate_system="world">
+            3.0, 2.0, 1.0
+          </position>
+        </finger>
+      </hand>
+    </arm>
+  </person>
+
+  <!-- <event> elements are totally optional as when there is no event, they
+    are not send at all.
+  
+    when <event> elements are send they must contain an 'type' attributes.
+    known events are: 'mouseDown', 'mouseUp'. TODO: discuss list of supported
+    events.
+    -->
+  <event type="mouseDown">
+
+    <!-- 'mouseDown' and 'mouseUp' event are defined by their <position>
+      element. The <position> element is defined as above. -->
+    <position type="vec3f" coordinate_system="plane">
+      3.0, 2.0, 1.0
+    </position>
+  </event>
+</trackingdata>

data/etc/init-script_debian

@@ -0,0 +1,56 @@
+#!/bin/sh
+# init script for the CanControlsGateway. Goes into /etc/init.d/
+
+name="can_controls_gateway"
+executable="/home/webs/CanControlsGateway/current/bin/can_controls_gateway"
+rubypath="/usr/bin/env ruby"
+pidfile="/var/run/$name.pid"
+user=webs
+
+stop_can_controls_gateway() {
+    echo "stopping $name ..."
+    start-stop-daemon --stop --pidfile $pidfile -v
+    rm -f $pidfile
+}
+
+start_can_controls_gateway() {
+    echo "starting $name ..."
+    start-stop-daemon -c $user --start --background --make-pidfile -v --pidfile $pidfile --exec $executable
+}
+
+running() {
+    if [ -f $pidfile ]
+    then
+        return 0
+    else
+        return 1
+    fi
+}
+
+if [ ! -x $executable ]
+then
+    echo "Cannot find $name executable. Aborting."
+    exit 0
+fi
+
+case "$1" in
+    start)
+        if running
+        then
+            echo "$name already running or stale pidfile. Aborting."
+            exit 0
+        fi
+        start_can_controls_gateway
+        ;;
+    stop)
+        stop_can_controls_gateway
+        ;;
+    restart)
+        stop_can_controls_gateway
+        start_can_controls_gateway
+        ;;
+    *)
+        echo "Usage: $0 {start|stop|restart}" >&2
+        exit 3
+        ;;
+esac

data/lib/can-controls-gateway.rb

@@ -0,0 +1,4 @@
+require 'gom/remote'
+require 'ccg_logger'
+require 'runner'
+require 'rca_command'

data/lib/ccg_logger.rb

@@ -0,0 +1,6 @@
+require 'logger'
+require 'time'
+
+module CcgLogger
+  LOGGER = Logger.new(File.join(File.dirname(__FILE__), '..', 'log/ccg.log'))
+end

data/lib/cursor_vector.rb

@@ -0,0 +1,60 @@
+require 'rexml/document'
+require 'rexml/xpath'
+
+module CanControlsGateway
+
+  class CursorVector
+  
+    attr_reader :x, :y
+  
+    def initialize xml_node
+      @xml_node = REXML::Document.new(xml_node.to_s)
+      @x = nil
+      @y = nil
+    
+      parse_xml
+    end
+  
+    def is_valid?
+      if (@y && @x)
+        true
+      else
+        false
+      end
+    end
+  
+    def dimensions
+      if is_valid?
+        2
+      else
+        0
+      end
+    end
+  
+    def to_s
+      if is_valid?
+        "#{x},#{y}"
+      else
+        ""
+      end
+    end
+  
+    private
+  
+    def parse_xml
+      my_vector_data = REXML::XPath.first(@xml_node, "/position").text
+      my_vector_data.to_s.strip!
+      my_vector_data = my_vector_data.split(",")
+      if my_vector_data.size > 1
+        @x = Float(my_vector_data[0].to_s.strip)
+        @y = Float(my_vector_data[1].to_s.strip.to_f)
+      else
+        @x, @y = nil
+      end
+      rescue
+        @x, @y = nil
+    end
+  
+  end
+
+end

data/lib/dispatcher.rb

@@ -0,0 +1,85 @@
+require 'rexml/document'
+require 'rexml/xpath'
+
+## require 'osc_package'
+require 'rca_command'
+require 'raw_event'
+
+module CanControlsGateway
+
+  class Dispatcher
+
+    attr_reader :raw_data, :events, :station_id
+
+    def initialize data
+      # TODO remove REXML usage - REXML is horribly slow
+      @raw_data   = REXML::Document.new("#{data}")
+      @events     = get_raw_events
+      @station_id = REXML::XPath.first(@raw_data, "/trackingdata/attribute::station_id")
+      @station_id = @station_id.value if @station_id
+    end
+  
+    def dispatch_rca
+      my_station = STATIONS[@station_id]
+    
+      # Do we know this station?
+      if my_station
+      
+        @events.each do |event|
+          ##
+          #CcgLogger::LOGGER.info "#{Time.now.iso8601} | Dispatcher: rca dispatching: event_type: #{event.event_type}"
+          ##
+        
+          # If it is a RCA mappable event send it as RCA command...
+          if EVENTS[event.event_type]
+            if my_station['rci_uri']
+              my_args = { 'action' => EVENTS[event.event_type] }
+              CcgLogger::LOGGER.info "#{Time.now.iso8601} |  >> Dispatcher: sending command : rci_uri: #{my_station['rci_uri']}, target: #{my_station['target']}, args: #{my_args.inspect}"
+              my_command = CanControlsGateway::RcaCommand.new my_station['rci_uri'],
+                                          my_station['target'],
+                                          my_args
+              CcgLogger::LOGGER.info "#{Time.now.iso8601} #{my_command.send_command}"
+            else
+              CcgLogger::LOGGER.info "#{Time.now.iso8601} | Device '#{my_station['device']}' not properly initialized in gom? (sender: station #{station})"
+            end
+          else
+            ##
+            #CcgLogger::LOGGER.info "#{Time.now.iso8601} | event '#{event.event_type}' not mappable to RCA command..."
+            ##
+          end
+        end
+      
+      else
+        #CcgLogger::LOGGER.info "#{Time.now.iso8601} | unknown station_id '#{@station_id.inspect}'"
+      end
+    
+      rescue => e
+        "ERROR: #{e.backtrace.join "\n\t"}"
+    end
+  
+    #def dispatch_osc
+    #  @events.each do |event|
+    #    if event.event_type && @station_id
+    #      ##
+    #      #CcgLogger::LOGGER.info "#{Time.now.iso8601} | Dispatcher: osc dispatching: event_type: #{event.event_type} - vector: #{event.vector}"
+    #      ##
+    #      my_osc_package = CanControlsGateway::OscPackage.new event, @station_id
+    #      my_ret         = my_osc_package.broadcast
+    #      nil
+    #    end
+    #  end
+    #end
+  
+    private
+  
+      def get_raw_events
+        my_events = []
+        my_event_nodes = REXML::XPath.each(@raw_data, "/trackingdata/event") { |event|
+          my_events << CanControlsGateway::RawEvent.new(event)
+        }
+        my_events
+      end
+    
+  end
+
+end