artoo 1.0.0.rc3 → 1.0.0.rc4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8dada91f56c875c86f6f1f4a689a27417a65d760
-  data.tar.gz: c66e5a9aa2311d76d7af2648bf6a362a14b8ed48
+  metadata.gz: 093191ca9b5924aab013a277c184b17098df5bc3
+  data.tar.gz: 637f3c2c3238c71af123329f0f4cd630cbf7b739
 SHA512:
-  metadata.gz: 4b6b2c71e48df2bba926db39e2561b9cd23b8ef6ea74852ee996e78b480c5a8f888c6aeae01099e192e5cf2ead9e1c07b6ab84afea4f1c6b40d03091da2796f0
-  data.tar.gz: 2fb9018b0178c87e21f6ae024564f0ea1ee51ee4293b6031bf65bfee2fcfb525e0e3f8be4e77e1d95a42ede9dbc2872330d33d84674b4db7d4cc2429cb2801a4
+  metadata.gz: a832d9d28b6f1775512baedb4ab1310da0232cfba55647830a53f6aee81d518e5b26753a29df6d53a41b2214bfec1b9635fcbcb41d94e60bb61a76e6084917c5
+  data.tar.gz: 985ecb0348dd5597bb744bc8d20fcda398e35e6faf3d3388198671a5e1e43ca2bbc6e9a3dfd7b17d7c2547e176f60ff75ef222dfebd93ce4cbe298fe34a818e3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    artoo (1.0.0.rc3)
+    artoo (1.0.0.rc4)
       celluloid (~> 0.14.1)
       celluloid-io (~> 0.14.1)
       multi_json (~> 1.6)

data/README.md

@@ -1,4 +1,4 @@
-# artoo
+[![Artoo](https://raw.github.com/hybridgroup/artoo/gh-pages/images/artoo-logo.png)](http://artoo.io)
 
 http://artoo.io/
 
@@ -76,21 +76,22 @@ SpheroRobot.work!(robots)
 Ruby versions supported: Ruby 2.0, Ruby 1.9.3, JRuby 1.7.4, and Rubinius 2.0-rc1
 
 
-Artoo is conceptualy influenced by Sinatra (https://github.com/sinatra/sinatra) as well as borrowing some code from it.
+Artoo is conceptualy influenced by [Sinatra](https://github.com/sinatra/sinatra) as well as borrowing some code from it.
 
 Artoo provides a robust actor-based messaging architecture, that can support fully multi-threaded operation and high-concurrency, as long as it is supported by the Ruby version in which it is executing. This means you will need to use JRuby or Rubinius for maximum concurrency. 
 
-To a large extent, this is due to being built on top of Celluloid (https://github.com/celluloid/celluloid), Celluloid::IO (https://github.com/celluloid/celluloid-io), and Reel (https://github.com/celluloid/reel).
+To a large extent, this is due to being built on top of [Celluloid](https://github.com/celluloid/celluloid), [Celluloid::IO](https://github.com/celluloid/celluloid-io), and [Reel](https://github.com/celluloid/reel).
 
 ## Hardware support:
 
 Artoo has a extensible system for connecting to hardware devices. The following robotics and physical computing platforms are currently supported:
 
-  - Arduino (http://www.arduino.cc/) adaptor (https://github.com/hybridgroup/artoo-arduino)
-  - ARDrone (http://ardrone2.parrot.com/) adaptor (https://github.com/hybridgroup/artoo-ardrone)
-  - Pebble (http://getpebble.com/) adaptor (https://github.com/hybridgroup/artoo-pebble)
-  - Roomba (http://www.irobot.com/us/robots/Educators/Create.aspx) adaptor (https://github.com/hybridgroup/artoo-roomba)
-  - Sphero (http://www.gosphero.com/) adaptor (https://github.com/hybridgroup/artoo-sphero)
+  - [Arduino](http://www.arduino.cc/) <=> [Adaptor](https://github.com/hybridgroup/artoo-arduino)
+  - [ARDrone](http://ardrone2.parrot.com/) <=> [Adaptor](https://github.com/hybridgroup/artoo-ardrone)
+  - [Leap Motion](https://www.leapmotion.com/) <=> [Adaptor](https://github.com/hybridgroup/artoo-leapmotion)
+  - [Pebble](http://getpebble.com/) <=> [Adaptor](https://github.com/hybridgroup/artoo-pebble)
+  - [Roomba](http://www.irobot.com/us/robots/Educators/Create.aspx) <=> [Adaptor](https://github.com/hybridgroup/artoo-roomba)
+  - [Sphero](http://www.gosphero.com/) <=> [Adaptor](https://github.com/hybridgroup/artoo-sphero)
 
 More platforms are coming soon!
 
@@ -238,7 +239,7 @@ You can scan your computer for paired Bluetooth devices, bind them to unix ports
 
 ### Console:
 
-Artoo includes Robi, a console based on Pry (http://pryrepl.org/) to allow you to interactively debug and control your robot.
+Artoo includes Robi, a console based on [Pry](http://pryrepl.org/) to allow you to interactively debug and control your robot.
 
 ```
 $ artoo console ./examples/hello.rb 

data/artoo.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |s|
   s.homepage    = "https://github.com/hybridgroup/artoo"
   s.summary     = %q{Ruby-based microframework for robotics}
   s.description = %q{Ruby-based microframework for robotics}
+  s.license     = 'Apache 2.0'
 
   s.rubyforge_project = "artoo"
 

data/lib/artoo/adaptors/adaptor.rb

@@ -9,15 +9,17 @@ module Artoo
     class Adaptor
       include Celluloid::IO
 
-      attr_reader :parent, :port
+      attr_reader :parent, :port, :additional_params
 
       # Initialize an adaptor
       # @param params [hash]
       # @option params [String] :parent
       # @option params [String] :port
+      # @option params [String] :additional_params
       def initialize(params={})
         @parent = params[:parent]
         @port = params[:port]
+        @additional_params = params[:additional_params]
         @connected = false
       end
 

data/lib/artoo/commands/connect.rb

@@ -8,10 +8,17 @@ module Artoo
       include Artoo::Utility
 
       desc "scan", "scan for connected devices"
+      option :type, :default => "bluetooth", :desc => "type of scan [bluetooth, serial]"
       def scan
         case os
         when :linux
-          run("hcitool scan")
+          if options[:type] == 'bluetooth'
+            run("hcitool scan")
+          elsif options[:type] == 'serial'
+            run("ls /dev/tty.*")
+          else
+            say "ERROR: scan type '#{options[:type]}' not supported!"
+          end
         when :macosx
           run("ls /dev/tty.*")          
         else
@@ -25,7 +32,7 @@ module Artoo
       def bind(address, name)
         case os
         when :linux
-          run("rfcomm -i #{options[:radio]} bind /dev/rfcomm#{options[:comm]} #{address} 1")
+          run("sudo rfcomm -i #{options[:radio]} bind /dev/rfcomm#{options[:comm]} #{address} 1")
           run("sudo ln -s /dev/rfcomm#{options[:comm]} /dev/#{name}")
         when :macosx
           say "OSX binds devices on its own volition."

data/lib/artoo/connection.rb

@@ -24,7 +24,7 @@ module Artoo
       @port = Port.new(params[:port])
       @parent = params[:parent]
 
-      require_adaptor(params[:adaptor] || :loopback)
+      require_adaptor(params[:adaptor] || :loopback, params)
     end
 
     # Creates adaptor connection
@@ -92,14 +92,14 @@ module Artoo
 
     private
 
-    def require_adaptor(type)
+    def require_adaptor(type, params)
       if Artoo::Robot.test?
         original_type = type
         type = :test
       end
 
       require "artoo/adaptors/#{type.to_s}"
-      @adaptor = constantize("Artoo::Adaptors::#{classify(type.to_s)}").new(:port => port, :parent => current_instance)
+      @adaptor = constantize("Artoo::Adaptors::#{classify(type.to_s)}").new(:port => port, :parent => current_instance, :additional_params => params)
     end
   end
 end

data/lib/artoo/device.rb

@@ -23,7 +23,7 @@ module Artoo
       @connection = determine_connection(params[:connection]) || default_connection
       @interval = params[:interval] || 0.5
 
-      require_driver(params[:driver] || :passthru)
+      require_driver(params[:driver] || :passthru, params)
     end
 
     # Retrieve connections from parent
@@ -94,14 +94,14 @@ module Artoo
 
     private
 
-    def require_driver(d)
+    def require_driver(d, params)
       if Artoo::Robot.test?
         original_type = d
         d = :test
       end
 
       require "artoo/drivers/#{d.to_s}"
-      @driver = constantize("Artoo::Drivers::#{classify(d.to_s)}").new(:parent => current_instance)
+      @driver = constantize("Artoo::Drivers::#{classify(d.to_s)}").new(:parent => current_instance, :additional_params => params)
     end
   end
 end

data/lib/artoo/drivers/driver.rb

@@ -10,15 +10,17 @@ module Artoo
       include Celluloid
       include Celluloid::Notifications
 
-      attr_reader :parent
+      attr_reader :parent, :additional_params
 
       COMMANDS = [].freeze
 
       # Create new driver
       # @param [Hash] params
       # @option params [Object] :parent
+      # @option params [Object] :additional_params
       def initialize(params={})
         @parent = params[:parent]
+        @additional_params = params[:additional_params]
       end
 
       # @return [Connection] parent connection

data/lib/artoo/generators/adaptor/README.md.tt

@@ -11,3 +11,13 @@ For more information abut Artoo, check out our repo at https://github.com/hybrid
 ```
 gem install artoo-<%= adaptor_name %>
 ```
+
+## Using
+
+```ruby
+# your example code here...
+```
+
+## Connecting
+
+Explain how to connect from the computer to the device here...

data/lib/artoo/generators/adaptor/lib/artoo/adaptors/%adaptor_name%.rb.tt

@@ -11,6 +11,7 @@ module Artoo
       # Closes connection with device if connected
       # @return [Boolean]
       def finalize
+        disconnect if connected?
       end
 
       # Creates a connection with device

data/lib/artoo/port.rb

@@ -6,8 +6,8 @@ module Artoo
 
     # Create new port
     # @param [Object] data
-    def initialize(data)
-      @is_tcp, @is_serial = false
+    def initialize(data=nil)
+      @is_tcp, @is_serial, @is_portless = false
       parse(data)
     end
 
@@ -21,9 +21,16 @@ module Artoo
       @is_tcp == true
     end
 
+    # @return [Boolean] True if does not have real port
+    def is_portless?
+      @is_portless == true
+    end
+
     # @return [String] port
     def to_s
-      if is_serial?
+      if is_portless?
+        "none"
+      elsif is_serial?
         port
       else
         "#{host}:#{port}"
@@ -33,14 +40,20 @@ module Artoo
     private
 
     def parse(data)
+      case
+      # portless
+      when data.nil?
+        @port = "none"
+        @is_portless = true
+
       # is TCP host/port?
-      if m = /(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}):(\d{1,5})/.match(data)
+      when m = /(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}):(\d{1,5})/.match(data)
         @port = m[2]
         @host = m[1]
         @is_tcp = true
 
       # is it a numeric port for localhost tcp?
-      elsif /^[0-9]{1,5}$/.match(data)
+      when /^[0-9]{1,5}$/.match(data)
         @port = data
         @host = "localhost"
         @is_tcp = true

data/lib/artoo/robot_class_methods.rb

@@ -4,21 +4,19 @@ module Artoo
   #
   # This module contains the class-level methods used by Artoo::Robot
   class Robot
-    module ClassMethods
-      attr_accessor :device_types, :working_code,
-                      :use_api, :api_host, :api_port
+    class << self; attr_accessor :connection_types, :device_types; end
 
-      def connection_types
-        @@connection_types ||= []
-      end
+    module ClassMethods
+      attr_accessor :working_code, :use_api, :api_host, :api_port
 
       # Connection to some hardware that has one or more devices via some specific protocol
       # @example connection :arduino, :adaptor => :firmata, :port => '/dev/tty.usbmodemxxxxx'
       # @param [String] name
       # @param [Hash]   params
       def connection(name, params = {})
+        @connection_types ||= []
         Celluloid::Logger.info "Registering connection '#{name}'..."
-        self.connection_types << {:name => name}.merge(params)
+        @connection_types << {:name => name}.merge(params)
       end
 
       # Device that uses a connection to communicate
@@ -26,9 +24,9 @@ module Artoo
       # @param [String] name
       # @param [Hash]   params
       def device(name, params = {})
+        @device_types ||= []
         Celluloid::Logger.info "Registering device '#{name}'..."
-        self.device_types ||= []
-        self.device_types << {:name => name}.merge(params)
+        @device_types << {:name => name}.merge(params)
       end
 
       # The work that needs to be performed

data/lib/artoo/version.rb

@@ -1,5 +1,5 @@
 module Artoo
   unless const_defined?('VERSION')
-    VERSION = "1.0.0.rc3"
+    VERSION = "1.0.0.rc4"
   end
 end

data/test/connection_test.rb

@@ -1,7 +1,7 @@
 require File.expand_path(File.dirname(__FILE__) + "/test_helper")
 
 class ConnectionTestRobot < Artoo::Robot
-  connection :test_connection
+  connection :my_test_connection, :awesomeness => :high, :super_powers => :active
 end
 
 describe Artoo::Connection do
@@ -22,7 +22,11 @@ describe Artoo::Connection do
   end
 
   it 'Artoo::Connection#as_json' do
-    MultiJson.load(@connection.as_json, :symbolize_keys => true)[:name].must_equal "test_connection"
+    MultiJson.load(@connection.as_json, :symbolize_keys => true)[:name].must_equal "my_test_connection"
     MultiJson.load(@connection.as_json, :symbolize_keys => true)[:connected].must_equal false
   end
+
+  it 'Artoo::Connection#additional_params' do
+    @robot.default_connection.adaptor.additional_params[:awesomeness].must_equal :high
+  end
 end

data/test/device_test.rb

@@ -3,7 +3,7 @@ require File.expand_path(File.dirname(__FILE__) + "/test_helper")
 class DeviceTestRobot < Artoo::Robot
   connection :test_connection
   device :test_device_1
-  device :test_device_2
+  device :test_device_2, :cool_factor => 11
 end
 
 class MultipleDeviceConnectionTestRobot < Artoo::Robot
@@ -38,4 +38,9 @@ describe Artoo::Device do
     @device = @robot.devices[:test_device_1]
     MultiJson.load(@device.as_json, :symbolize_keys => true)[:name].must_equal "test_device_1"
   end
+
+  it 'Artoo::Device#additional_params' do
+    @device = @robot.devices[:test_device_2]
+    @device.driver.additional_params[:cool_factor].must_equal 11
+  end
 end

data/test/port_test.rb

@@ -5,29 +5,41 @@ describe Artoo::Port do
     @remote_tcp_port = Artoo::Port.new("192.168.0.1:8080")
     @local_tcp_port = Artoo::Port.new("5678")
     @serial_port = Artoo::Port.new("/dev/tty.usb12345")
+    @portless = Artoo::Port.new
   end
 
   it 'Artoo::Port#port' do
     @remote_tcp_port.port.must_equal "8080"
     @local_tcp_port.port.must_equal "5678"
     @serial_port.port.must_equal "/dev/tty.usb12345"
+    @portless.port.must_equal "none"
   end
 
   it 'Artoo::Port#is_tcp?' do
     @remote_tcp_port.is_tcp?.must_equal true
     @local_tcp_port.is_tcp?.must_equal true
     @serial_port.is_tcp?.must_equal false
+    @portless.is_tcp?.must_equal false
   end
 
   it 'Artoo::Port#is_serial?' do
     @remote_tcp_port.is_serial?.must_equal false
     @local_tcp_port.is_serial?.must_equal false
     @serial_port.is_serial?.must_equal true
+    @portless.is_tcp?.must_equal false
+  end
+
+  it 'Artoo::Port#is_portless?' do
+    @remote_tcp_port.is_portless?.must_equal false
+    @local_tcp_port.is_portless?.must_equal false
+    @serial_port.is_portless?.must_equal false
+    @portless.is_portless?.must_equal true
   end
 
   it 'Artoo::Port#to_s' do
     @remote_tcp_port.to_s.must_equal "192.168.0.1:8080"
     @local_tcp_port.to_s.must_equal "localhost:5678"
     @serial_port.to_s.must_equal "/dev/tty.usb12345"
+    @portless.to_s.must_equal "none"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: artoo
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc3
+  version: 1.0.0.rc4
 platform: ruby
 authors:
 - Ron Evans
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-27 00:00:00.000000000 Z
+date: 2013-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid
@@ -254,7 +254,8 @@ files:
 - test/utility_test.rb
 - test/utility_test_cases.rb
 homepage: https://github.com/hybridgroup/artoo
-licenses: []
+licenses:
+- Apache 2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []