artoo 0.5.0 → 1.0.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15f265e20932268a26b4c208c62b0fa785370f75
-  data.tar.gz: 7a081f9e19623f18218e191bb31a53fe5becdb11
+  metadata.gz: 731043a8242e8887c4cbff414816cdf7eadae2af
+  data.tar.gz: 6b0f65cd67cefd32098bea77d87adefcf7032d60
 SHA512:
-  metadata.gz: a462b43a83b4e6bfb1330aa045f9478a3cf963ba0fbd6d7d51083a18c2667b1a749119b9eb81c25bef5cb3cf209e9d0186547861f3ff0ccb73bc591fbb1f55df
-  data.tar.gz: 6d94a3cdc72f034cb94655deea807858e3ca4283a8a2bff1ea88a8a4fd8cb5a1a5fc485208fcc14a1b47f12480672a5ff2822c645f612b05ebede6eeba1fd861
+  metadata.gz: eddbdcfe51452b114468046a6e2d0fd4e3fd160ec377ab93a903fab4ce01bd60f6081b390db66e72beac6129828c4710a3ff774abef272def8220ac2cb414566
+  data.tar.gz: 6392e99e47cd6eaddcb69d98777afcf3cf4000a721632b42bfceb18242c2965c7fc150b3d32b87cf1d75fa19d39f2909d5f7b604c8694cefa827cdb01e08500d

data/.travis.yml

@@ -2,5 +2,5 @@ language: ruby
 rvm:
   - 2.0.0
   - 1.9.3
-  - jruby-19mode
-  - rbx-19mode
+  - jruby-1.7.4
+  - rbx-19mode

data/.yardopts

@@ -4,7 +4,7 @@
 --hide-void-return
 
 --markup=markdown
---markup-provider=redcarpet
+--markup-provider=kramdown
 
 --exclude lib/artoo/ext
 --plugin yard-sinatra

data/CONTRIBUTORS.md

@@ -0,0 +1,16 @@
+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)
+
+Thank you!
+
+Please join us, we'd love your contribution too!

data/Gemfile

@@ -3,13 +3,6 @@ source "http://rubygems.org"
 # Specify your gem's dependencies in artoo.gemspec
 gemspec
 
-gem "foreman"
-
-# these are for specific hardware, they have to be here for tests
-gem "hybridgroup-firmata", "~> 0.4.0"
-gem "hybridgroup-sphero", "~> 1.3.0"
-gem "hybridgroup-argus", "~> 0.3.0"
-
 # For the front end web application
 gem 'sass'
 gem 'coffee-script'
@@ -22,13 +15,21 @@ gem 'guard-sprockets'
 gem 'guard-compass'
 gem 'rb-inotify', '~> 0.8.8'
 gem 'execjs'
-gem 'therubyracer'
+
+if RUBY_PLATFORM =~ /java/
+  gem 'therubyrhino'
+else
+  gem 'therubyracer'
+end
 
 # For documentation
 gem 'yard'
 gem 'yard-sinatra'
-gem 'redcarpet'
+gem 'kramdown'
 
 # For tests
 gem "minitest", "~> 5.0.1"
 gem "mocha", '~> 0.14.0', :require => false
+
+gem 'json', '~> 1.7.7'
+gem "foreman"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    artoo (0.5.0)
+    artoo (1.0.0.pre)
       celluloid (~> 0.14.0)
       celluloid-io (~> 0.14.0)
       multi_json (~> 1.6)
@@ -12,7 +12,7 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    bootstrap-sass (2.2.2.0)
+    bootstrap-sass (2.3.1.0)
       sass (~> 3.2)
     celluloid (0.14.0)
       timers (>= 1.0.0)
@@ -20,23 +20,22 @@ GEM
       celluloid (>= 0.13.0)
       nio4r (>= 0.4.5)
     certified (0.1.1)
-    chunky_png (1.2.7)
+    chunky_png (1.2.8)
     coderay (1.0.9)
     coffee-script (2.2.0)
       coffee-script-source
       execjs
-    coffee-script-source (1.4.0)
+    coffee-script-source (1.6.2)
     compass (0.12.2)
       chunky_png (~> 1.2)
       fssm (>= 0.2.7)
       sass (~> 3.1)
     dotenv (0.7.0)
-    em-websocket (0.4.0)
+    em-websocket (0.5.0)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0.5.3)
-    event_spitter (0.5.0)
-    eventmachine (1.0.0)
-    eventmachine (1.0.0-java)
+    eventmachine (1.0.3)
+    eventmachine (1.0.3-java)
     execjs (1.4.0)
       multi_json (~> 1.0)
     ffi (1.8.1)
@@ -47,50 +46,50 @@ GEM
     foreman (0.63.0-java)
       dotenv (>= 0.7)
       thor (>= 0.13.6)
+    formatador (0.2.4)
     fssm (0.2.10)
-    guard (1.6.2)
+    guard (1.7.0)
+      formatador (>= 0.2.4)
       listen (>= 0.6.0)
       lumberjack (>= 1.0.2)
       pry (>= 0.9.10)
-      terminal-table (>= 1.4.3)
       thor (>= 0.14.6)
     guard-compass (0.0.6)
       compass (>= 0.10.5)
       guard (>= 0.2.1)
-    guard-livereload (1.1.3)
+    guard-livereload (1.3.0)
       em-websocket (>= 0.2.0)
       guard (>= 1.5.0)
       multi_json (~> 1.0)
-    guard-sprockets (0.4.2)
+    guard-sprockets (0.4.3)
       execjs (~> 1.0)
       guard (>= 1.1.0)
       sprockets (~> 2.0)
-    hike (1.2.1)
+    hike (1.2.2)
     http (0.4.0)
       certified
       http_parser.rb
     http_parser.rb (0.5.3)
     http_parser.rb (0.5.3-java)
-    hybridgroup-argus (0.3.0)
-    hybridgroup-firmata (0.4.0)
-      event_spitter
-    hybridgroup-sphero (1.3.0)
+    json (1.7.7)
+    json (1.7.7-java)
+    kramdown (1.0.2)
     libv8 (3.11.8.17)
-    listen (0.7.2)
-    lumberjack (1.0.2)
+    listen (0.7.3)
+    lumberjack (1.0.3)
     metaclass (0.0.1)
     method_source (0.8.1)
     minitest (5.0.1)
     minitest-happy (1.0.0)
     mocha (0.14.0)
       metaclass (~> 0.0.1)
-    multi_json (1.6.1)
+    multi_json (1.7.3)
     nio4r (0.4.5)
-    pry (0.9.12)
+    pry (0.9.12.2)
       coderay (~> 1.0.5)
       method_source (~> 0.8)
       slop (~> 3.4)
-    pry (0.9.12-java)
+    pry (0.9.12.2-java)
       coderay (~> 1.0.5)
       method_source (~> 0.8)
       slop (~> 3.4)
@@ -99,28 +98,27 @@ GEM
     rake (10.0.4)
     rb-inotify (0.8.8)
       ffi (>= 0.5.0)
-    redcarpet (2.2.2)
     reel (0.4.0.pre)
       celluloid-io (>= 0.8.0)
       http (>= 0.2.0)
       http_parser.rb (>= 0.5.3)
       rack (>= 1.4.0)
       websocket_parser (>= 0.1.2)
-    ref (1.0.4)
-    sass (3.2.5)
-    slop (3.4.3)
-    spoon (0.0.1)
-    sprockets (2.8.2)
+    ref (1.0.5)
+    sass (3.2.9)
+    slop (3.4.5)
+    spoon (0.0.4)
+      ffi
+    sprockets (2.9.3)
       hike (~> 1.2)
       multi_json (~> 1.0)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
-    terminal-table (1.4.5)
     therubyracer (0.11.4)
       libv8 (~> 3.11.8.12)
       ref
-    thor (0.17.0)
-    tilt (1.3.3)
+    thor (0.18.1)
+    tilt (1.4.1)
     timers (1.1.0)
     websocket_parser (0.1.2)
       http
@@ -143,14 +141,12 @@ DEPENDENCIES
   guard-compass
   guard-livereload
   guard-sprockets
-  hybridgroup-argus (~> 0.3.0)
-  hybridgroup-firmata (~> 0.4.0)
-  hybridgroup-sphero (~> 1.3.0)
+  json (~> 1.7.7)
+  kramdown
   minitest (~> 5.0.1)
   minitest-happy
   mocha (~> 0.14.0)
   rb-inotify (~> 0.8.8)
-  redcarpet
   sass
   sprockets
   therubyracer

data/README.md

@@ -12,7 +12,7 @@ Artoo provides a simple, yet powerful domain-specific language (DSL) for robotic
 
 ### Basic
 
-Arduino with an LED and a button, using the Firmata protocol.
+#### Arduino with an LED and a button, using the Firmata protocol.
 
 ```ruby
 require 'artoo'
@@ -26,7 +26,7 @@ work do
 end
 ```
 
-Parrot ARDrone 2.0
+#### Parrot ARDrone 2.0
 
 ```ruby
 require 'artoo'
@@ -45,6 +45,8 @@ end
 
 ### Modular
 
+You can also write more modular class-oriented code, that allows you to control swarms of robots:
+
 ```ruby
 require 'artoo/robot'
 
@@ -71,7 +73,7 @@ SPHEROS.each {|p|
 SpheroRobot.work!(robots)
 ```
 
-Ruby versions supported: Ruby 2.0, Ruby 1.9.3, JRuby 1.7.2, and Rubinius 2.0-rc1
+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.
@@ -80,6 +82,19 @@ Artoo provides a robust actor-based messaging architecture, that can support ful
 
 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)
+  - 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!
+
+Do you have some hardware that is not yet supported by Artoo? We want to help you, help us, help them! Get in touch...
+
 ## API:
 
 Artoo includes a RESTful API to query the status of any robot running within a group, including the connection and device status, and device streaming data via websockets.
@@ -100,38 +115,112 @@ end
 
 Once the robot or group is working, you can view the main API page at the host and port specified.
 
+## Test-Driven Robotics:
+
+Artoo makes it easy to do Test Driven Development (TDD) of your robotic devices using your favorite Ruby test and mocking frameworks.
+
+Here is an example that uses Minitest and Mocha:
+
+```ruby
+describe 'sphero' do
+  let(:robot) { Artoo::MainRobot.new }
+   
+  it 'has work to do every 3 seconds' do
+    robot.work
+     
+    robot.has_work?(:every, 3.seconds).wont_be_nil
+  end
+   
+  it 'must roll every 3 seconds' do
+    robot.sphero.expects(:roll).twice
+     
+    robot.work
+    sleep 6.1
+  end
+   
+  it 'receives collision event' do
+    robot.expects(:contact)
+     
+    robot.work
+    robot.sphero.publish("collision", "clunk")
+    sleep 0.1
+  end
+end
+```
+to describe the following Sphero robot:
+
+```ruby
+require 'artoo'
+
+connection :sphero, :adaptor => :sphero, :port => '127.0.0.1:4560'
+device :sphero, :driver => :sphero
+
+def contact(*args)
+  @contacts ||= 0
+  @contacts += 1
+  puts "Contact #{@contacts}"
+end
+
+work do
+  on sphero, :collision => :contact
+
+  every(3.seconds) do
+    puts "Rolling..."
+    sphero.roll 90, rand(360)
+  end
+end
+```
+
 ## Console:
 
 Artoo includes Robi, a console based on Pry (http://pryrepl.org/) to allow you to interactively debug and control your robot.
 
 ```
-robi ./examples/hello.rb
-I, [2013-03-16T18:14:22.281462 #61513]  INFO -- : Registering connection 'loop'...
-I, [2013-03-16T18:14:22.283027 #61513]  INFO -- : Preparing work...
-[1] pry(main)> start
-I, [2013-03-16T18:14:23.836523 #61513]  INFO -- : Initializing connection loop...
-I, [2013-03-16T18:14:23.842265 #61513]  INFO -- : Starting work...
-I, [2013-03-16T18:14:23.842879 #61513]  INFO -- : Connecting to 'loop' on port '#<Artoo::Port:0xe3c0>'...
-[2] pry(main)> list
-#<Artoo::MainRobot:0xe5e4>
-[3] pry(main)> exit
+$ robi ./examples/hello.rb 
+I, [2013-05-21T18:09:05.179630 #8752]  INFO -- : Registering connection 'loop'...
+I, [2013-05-21T18:09:05.180681 #8752]  INFO -- : Preparing work...
+robi> start
+Starting main robot...
+I, [2013-05-21T18:09:37.086550 #8752]  INFO -- : Initializing connection loop...
+I, [2013-05-21T18:09:37.092231 #8752]  INFO -- : Starting work...
+I, [2013-05-21T18:09:37.092691 #8752]  INFO -- : Connecting to 'loop' on port '#<Artoo::Port:0x104e4>'...
+robi> hello
+hello
+robi> stop
+Stopping robots...
+robi> exit
+D, [2013-05-21T18:09:53.507709 #8752] DEBUG -- : Terminating 7 actors...
+D, [2013-05-21T18:09:53.508622 #8752] DEBUG -- : Shutdown completed cleanly
 ```
 
-## Installing:
+## Getting Started:
+
+### Installation
 
 ```ruby
 gem install artoo
 ```
 
-Then install the gems required by your specific supported hardware:
+Then install the gems required by the hardware you want to use. For example, if you wanted to integrate a Wiiclassic controller connected to an Arduino to fly your ARDrone:
 
 ```ruby
-gem install hybridgroup-firmata
-gem install hybridgroup-argus
-gem install hybridgroup-sphero
+gem install artoo-arduino
+gem install artoo-ardrone
 ```
 
-## Running:
+If you will be using socket to serial commuication (required if you will use JRuby or Rubinius), you are ready to start programming your hardware. 
+
+If you want to connect via serial port directly, and are using MRI, install the hybridgroup-serialport gem:
+
+```ruby
+gem install hybridgroup-serialport
+```
+
+### Writing your robot code:
+
+Now you are ready to write your own code. Take a look at the examples directory for a whole bunch of code you can use to help get started. We recommend using TDR (Test-Driven Robotics) with your preferred test frameworks.
+
+### Running your robot:
 
 ```ruby
 ruby myrobot.rb
@@ -140,3 +229,5 @@ ruby myrobot.rb
 ## Wiki
 
 Check out our [wiki](https://github.com/hybridgroup/artoo/wiki) for more docs
+
+(c) 2012-2013 The Hybrid Group

data/Rakefile

@@ -6,7 +6,6 @@ require 'rake/testtask'
 
 Rake::TestTask.new do |t|
   t.pattern = "test/**/*_test.rb"
-  ENV["ARTOO_TEST"] = 'true'
 end
 
 task :default => :test

data/api/assets/javascripts/artoo/controllers/robot.js.coffee

@@ -1,5 +1,3 @@
-window.driversWithOutput = ["Pinger", "Pinger2", "ardrone_navigation", "wiiclassic"]
-
 @RobotIndexCtrl = ($scope, $http, $location, $route) ->
   $http.get('/robots').success (data)->
     $scope.robots = data
@@ -21,15 +19,14 @@ window.driversWithOutput = ["Pinger", "Pinger2", "ardrone_navigation", "wiiclass
     $http.post('/robots/' + $scope.robot.name + "/devices/" + deviceId + "/commands/" + command, post_params).success (data)->
       true
 
-  $scope.driverHasOutput = (driverId)->
-    true if $.inArray(driverId, window.driversWithOutput) != -1
-
   device = console: ->
-    window.ws.close() if window.ws
+    if window.ws
+      window.ws.onmessage = null
+      window.ws.close()
+      $(".console code").empty()
     wspath = "ws://" + location.host + "/robots/"
     window.ws = new WebSocket(wspath + $scope.robot.name + "/devices/" + $scope.deviceDetail.name + "/events")
-    $(".console code").empty()
-    ws.onmessage = (evt)->
+    window.ws.onmessage = (evt)->
       $(".console code").prepend(evt.data + "\n")
 
   $scope.isConnected = (connection) ->