artoo 1.0.0 → 1.1.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bae9e5316f0fe5c4c375c0979e889dd883eafb2d
-  data.tar.gz: a74c558ddd46c16f03004c5dcb88691902fba5c9
+  metadata.gz: f305a1606ec83852aff4b8334d5a736c69819da0
+  data.tar.gz: 82916bb9719f1aaa4409ea1cbb4be3ee65708bc2
 SHA512:
-  metadata.gz: 3b70a1c4a482fcb49af327b45b2680ae57e1fe0497c3a8e059b8164da73d6653c6538f5749f06fea62299956b054f867bef5441b9bdcb4f8246e1301958b1253
-  data.tar.gz: 059c80f607413fed6bd8d8d41eca45565ee49714a942a2f5285eb83b1b4d29886041b60adc25fab08789ef064dfdbc9a0db01abf0d0ff26b25017002f7644e42
+  metadata.gz: 8a214bb8e9fcdacf46d28a15421c0e546baa764924a55baa9385d9c2d4242eaac98b5ae6753e400dbce8bcc93db7d90563a6828d641c7677c38119efddc2f093
+  data.tar.gz: 203a70fbc509da52603629cfe8d2e9318e83d1c57776f622be3e68148be99c2fba0cdce721572f1e604bc256d933ea0dfc760f5c76dc20da918546335077c99c

data/CONTRIBUTORS.md

@@ -1,15 +1,19 @@
+# Contributors
+
 Artoo exists thanks to the work of these wonderful individuals:
 
-- Adrian Zankich (@adzankich)
-- Andrew Stewart (@stewart)
-- Ari Lerner (@auser)
-- Daniel Fischer (@dfischer)
-- Jake Good (@whoisjake)
-- Javier Cervantes (@solojavier)
-- Kurtis Rainbolt-Greene (@krainboltgreene)
-- Mario "Kuroir" Ricalde (@MarioRicalde)
-- Mike Ford (@mikejford)
-- Ron Evans (@deadprogram)
+- Adrian Zankich ([@adzankich](https://github.com/adzankich))
+- Andrew Stewart ([@stewart](https://github.com/stewart))
+- Ari Lerner ([@auser](https://github.com/auser))
+- Daniel Fischer ([@dfischer](https://github.com/dfischer))
+- Jake Good ([@whoisjake](https://github.com/whoisjake))
+- Javier Cervantes ([@solojavier](https://github.com/solojavier))
+- Kurtis Rainbolt-Greene([@krainboltgreene] (https://github.com/krainboltgreene))
+- Mario "Kuroir" Ricalde([@MarioRicalde] (https://github.com/MarioRicalde))
+- Mike Ford ([@mikejford](https://github.com/mikejford))
+- Rafael Magana ([@rafmagana](https://github.com/rafmagana))
+- Ron Evans ([@deadprogram](https://github.com/deadprogram))
+- Tim Uruski ([@timuruski](https://github.com/timuruski))
 
 Thank you!
 

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    artoo (1.0.0)
-      celluloid (~> 0.14.1)
-      celluloid-io (~> 0.14.1)
+    artoo (1.1.0.pre)
+      celluloid (~> 0.15.0.pre2)
+      celluloid-io (~> 0.15.0.pre2)
       multi_json (~> 1.6)
       pry (~> 0.9)
       rake (~> 10.0)
@@ -15,11 +15,11 @@ GEM
   specs:
     bootstrap-sass (2.3.2.1)
       sass (~> 3.2)
-    celluloid (0.14.1)
+    celluloid (0.15.0.pre2)
       timers (>= 1.0.0)
-    celluloid-io (0.14.1)
-      celluloid (>= 0.14.1)
-      nio4r (>= 0.4.5)
+    celluloid-io (0.15.0.pre2)
+      celluloid (>= 0.15.0.pre)
+      nio4r (>= 0.5.0)
     certified (0.1.1)
     chunky_png (1.2.8)
     coderay (1.0.9)
@@ -75,7 +75,7 @@ GEM
     mocha (0.14.0)
       metaclass (~> 0.0.1)
     multi_json (1.7.7)
-    nio4r (0.4.6)
+    nio4r (0.5.0)
     pry (0.9.12.2)
       coderay (~> 1.0.5)
       method_source (~> 0.8)

data/README.md

@@ -229,11 +229,11 @@ Artoo makes it a lot easier to connect TCP Socket to Bluetooth and serial port d
 
 ```
 $ artoo connect
-Commands:
-  artoo connect bind            # bind [ADDRESS] [NAME] binds a device to some connected hardware
-  artoo connect help [COMMAND]  # Describe subcommands or one specific subcommand
-  artoo connect scan            # scan for connected devices
-  artoo connect socat           # socat [PORT] [NAME] use socat to connect a socket to a serial device by name
+connect commands:
+  artoo connect bind [ADDRESS] [NAME]  # Binds a Bluetooth device to some connected hardware
+  artoo connect help [COMMAND]         # Describe subcommands or one specific subcommand
+  artoo connect scan                   # Scan for connected devices
+  artoo connect serial [NAME] [PORT]   # Connect a serial device to a TCP socket using socat
 ```
 
 You can scan your computer for paired Bluetooth devices, bind them to unix ports, and connect socket to serial interfaces, easily from the command line!
@@ -266,7 +266,27 @@ D, [2013-07-03T17:12:04.414300 #5527] DEBUG -- : Shutdown completed cleanly
 
 ### Generator
 
-Want to integrate a new kind of hardware devices for which there is not an Artoo adaptor yet? You can easily generate a new skeleton Artoo adaptor to help you get started! Simply run the 'artoo generate adaptor' command, and the generator will create a new directory with all of the files in place for your new adaptor gem.
+Want to integrate a hardware device we don't have Artoo support for yet? There's a generator for that! You can easily generate a new skeleton Artoo adaptor to help you get started. Simply run the 'artoo generate adaptor' command, and the generator will create a new directory with all of the files in place for your new adaptor gem.
+
+```
+$ artoo generate adaptor awesome_device
+Creating artoo-awesome_device adaptor...
+      create  artoo-awesome_device
+       exist  artoo-awesome_device
+      create  artoo-awesome_device/Gemfile
+      create  artoo-awesome_device/LICENSE
+      create  artoo-awesome_device/README.md
+      create  artoo-awesome_device/Rakefile
+      create  artoo-awesome_device/artoo-awesome_device.gemspec
+      create  artoo-awesome_device/lib/artoo-awesome_device.rb
+      create  artoo-awesome_device/lib/artoo-awesome_device/version.rb
+      create  artoo-awesome_device/lib/artoo/adaptors/awesome_device.rb
+      create  artoo-awesome_device/lib/artoo/drivers/awesome_device.rb
+      create  artoo-awesome_device/test/adaptors/awesome_device_adaptor_test.rb
+      create  artoo-awesome_device/test/drivers/awesome_device_driver_test.rb
+      create  artoo-awesome_device/test/test_helper.rb
+Done!
+```
 
 ## Wiki
 

data/artoo.gemspec

@@ -20,8 +20,8 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency 'celluloid', '~> 0.14.1'
-  s.add_runtime_dependency 'celluloid-io', '~> 0.14.1'
+  s.add_runtime_dependency 'celluloid', '~> 0.15.0.pre2'
+  s.add_runtime_dependency 'celluloid-io', '~> 0.15.0.pre2'
   s.add_runtime_dependency 'reel', '~> 0.4.0.pre'
   s.add_runtime_dependency 'multi_json', '~> 1.6'
   s.add_runtime_dependency 'rake', '~> 10.0'

data/bin/artoo

@@ -3,6 +3,7 @@ require 'rubygems'
 require 'thor'
 require 'thor/group'
 require 'artoo/robot'
+require 'artoo/commands/commands'
 require 'artoo/commands/generate'
 require 'artoo/commands/connect'
 require 'artoo/commands/install'

data/lib/artoo/adaptors/adaptor.rb

@@ -74,7 +74,7 @@ module Artoo
       # @param stop_bits [int]
       # @param parity
       # @return [SerialPort] new connection
-      def connect_to_serial(speed=57600, data_bits=8, stop_bits=1, parity=::SerialPort::NONE)
+      def connect_to_serial(speed=57600, data_bits=8, stop_bits=1, parity=nil)
         require 'serialport'
         parity = ::SerialPort::NONE unless parity
         @sp = ::SerialPort.new(port.port, speed, data_bits, stop_bits, parity)

data/lib/artoo/commands/commands.rb

@@ -0,0 +1,15 @@
+require 'thor'
+require 'thor/group'
+
+module Artoo
+  module Commands
+    class Commands < Thor
+      include Thor::Actions
+      include Artoo::Utility
+
+      def self.banner(command, namespace = nil, subcommand = false)
+        "#{basename} #{@package_name} #{command.usage}"
+      end
+    end
+  end
+end

data/lib/artoo/commands/connect.rb

@@ -3,32 +3,31 @@ require 'thor/group'
 
 module Artoo
   module Commands
-    class Connect < Thor
-      include Thor::Actions
-      include Artoo::Utility
+    class Connect < Commands
+      package_name "connect"
 
-      desc "scan", "scan for connected devices"
-      option :type, :default => "bluetooth", :desc => "type of scan [bluetooth, serial]"
+      desc "scan", "Scan for connected devices"
+      option :type, :aliases => "-t", :default => "bluetooth", :desc => "type of scan [bluetooth, serial]"
       def scan
         case os
         when :linux
           if options[:type] == 'bluetooth'
             run("hcitool scan")
           elsif options[:type] == 'serial'
-            run("ls /dev/tty.*")
+            run("ls /dev/tty*")
           else
             say "ERROR: scan type '#{options[:type]}' not supported!"
           end
         when :macosx
-          run("ls /dev/tty.*")          
+          run("ls /dev/tty*")          
         else
           say "OS not yet supported..."
         end
       end
 
-      desc "bind", "bind [ADDRESS] [NAME] binds a device to some connected hardware"
-      option :comm, :default => 0, :desc => "Comm number"
-      option :radio, :default => "hci0", :desc => "Bluetooth radio address"
+      desc "bind [ADDRESS] [NAME]", "Binds a Bluetooth device to some connected hardware"
+      option :comm, :aliases => "-c", :default => 0, :desc => "Comm number"
+      option :radio, :aliases => "-r", :default => "hci0", :desc => "Bluetooth radio address"
       def bind(address, name)
         case os
         when :linux
@@ -41,9 +40,10 @@ module Artoo
         end
       end
 
-      desc "socat", "socat [PORT] [NAME] use socat to connect a socket to a serial device by name"
-      option :retries, :default => 0, :desc => "Number of times to retry connecting on failure"
-      def socat(port, name)
+      desc "serial [NAME] [PORT]", "Connect a serial device to a TCP socket using socat"
+      option :retries, :aliases => "-r", :default => 0, :desc => "Number of times to retry connecting on failure"
+      option :baudrate, :aliases => "-b", :default => 57600, :desc => "Baud rate to use to connect to the serial device"
+      def serial(name, port)
         attempts = 1 + options[:retries].to_i
         
         case os
@@ -51,14 +51,14 @@ module Artoo
           run("sudo chmod a+rw /dev/#{name}")
           
           while(attempts > 0) do
-            run("socat -d -d FILE:/dev/#{name},nonblock,raw,b115200,echo=0 TCP-LISTEN:#{port},fork")
+            run("socat -d -d FILE:/dev/#{name},nonblock,raw,b#{options[:baudrate]},echo=0 TCP-LISTEN:#{port},fork")
             break unless $? == 1
             attempts -= 1
           end
 
         when :macosx
           while(attempts > 0) do
-            run("socat -d -d FILE:/dev/#{name},nonblock,raw,echo=0 TCP-LISTEN:#{port},fork")
+            run("socat -d -d -b#{options[:baudrate]} FILE:/dev/#{name},nonblock,raw,echo=0 TCP-LISTEN:#{port},fork")
             break unless $? == 1
             attempts -= 1
           end

data/lib/artoo/commands/install.rb

@@ -3,11 +3,10 @@ require 'thor/group'
 
 module Artoo
   module Commands
-    class Install < Thor
-      include Thor::Actions
-      include Artoo::Utility
+    class Install < Commands
+      package_name "install"
       
-      desc "socat", "install socat utility program"
+      desc "socat", "Install the socat serial to socket utility program"
       def socat
         case os 
         when :linux

data/lib/artoo/robot.rb

@@ -7,7 +7,9 @@ require 'artoo/ext/actor'
 require 'artoo/robot_class_methods'
 require 'artoo/basic'
 require 'artoo/connection'
+require 'artoo/adaptors/adaptor'
 require 'artoo/device'
+require 'artoo/drivers/driver'
 require 'artoo/events'
 require 'artoo/api/api'
 require 'artoo/master'

data/lib/artoo/version.rb

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

data/test/adaptors/adaptor_test.rb

@@ -1,5 +1,4 @@
 require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
-require 'artoo/adaptors/adaptor'
 
 describe Artoo::Adaptors::Adaptor do
   before do
@@ -15,4 +14,4 @@ describe Artoo::Adaptors::Adaptor do
     @adaptor.disconnect
     @adaptor.connected?.must_equal false
   end
-end
+end

data/test/drivers/driver_test.rb

@@ -1,5 +1,4 @@
 require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
-require 'artoo/drivers/driver'
 
 class Awesome < Artoo::Drivers::Driver
   COMMANDS = [:awesome].freeze
@@ -33,4 +32,4 @@ describe Artoo::Drivers::Driver do
     @awesome_driver.known_command?(:awesome).must_equal true
     @awesome_driver.known_command?(:crazy).must_equal false
   end
-end
+end

data/test/test_helper.rb

@@ -4,3 +4,8 @@ require 'mocha/setup'
 require 'artoo/robot'
 
 Celluloid.logger = nil
+
+MiniTest::Spec.before do
+  Celluloid.shutdown
+  Celluloid.boot
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: artoo
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0.pre
 platform: ruby
 authors:
 - Ron Evans
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-19 00:00:00.000000000 Z
+date: 2013-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid
@@ -20,28 +20,28 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: 0.15.0.pre2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: 0.15.0.pre2
 - !ruby/object:Gem::Dependency
   name: celluloid-io
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: 0.15.0.pre2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: 0.15.0.pre2
 - !ruby/object:Gem::Dependency
   name: reel
   requirement: !ruby/object:Gem::Requirement
@@ -204,6 +204,7 @@ files:
 - lib/artoo/api/device_event_client.rb
 - lib/artoo/api/route_helpers.rb
 - lib/artoo/basic.rb
+- lib/artoo/commands/commands.rb
 - lib/artoo/commands/connect.rb
 - lib/artoo/commands/generate.rb
 - lib/artoo/commands/install.rb
@@ -268,9 +269,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: artoo
 rubygems_version: 2.0.3