artoo 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18102ca867dce3a87d0d7a37e9a3815b7b3be8a2
-  data.tar.gz: 5410f7319fbee6fa07c76808e0cb766b7883cd84
+  metadata.gz: cca65df971ac15acb591d811d8664703046390a6
+  data.tar.gz: 78ce7b30d92c1ec9b111cfe23550e5067a8ea525
 SHA512:
-  metadata.gz: 26e56150e35df75a79560888fa419f4e768b9e8634e7824f2c60e1df6bd2c7f3c136599f893547b23cb090ebab7c5f07c37665b0aca23353e10d1a13b8727a4e
-  data.tar.gz: 3b22a157db5e7826021dc74872b7bab951e32c9c1e0204476e5809d7639347d2bc3ef37c64739ec6bc269b8ae46e5992aa26d43df3f471b9caa760c7253bbd4d
+  metadata.gz: 34a0ecc46495423973c52b345acb4fe7d99984c06bfc0b10b6741a35f4615caa4e89d5225b7119d3db504209e57a36245810f5052e61a5d21e9fe48cf5b00195
+  data.tar.gz: e2f70290fd6c9d2162a3bed8430f5741399f557c3c4b372c232313052da006e6e526f08c359afa80bf9a6d6a2e044e58967cbc6f81a54de519b8a46c3c5f0a7b

data/.travis.yml

@@ -2,5 +2,5 @@ language: ruby
 rvm:
   - 2.0.0
   - 1.9.3
-  #- jruby-19mode # JRuby in 1.9 mode commented until JRuby/Celluloid issues corrected
+  - jruby-19mode
   - rbx-19mode

data/.yardopts

@@ -0,0 +1,10 @@
+-M github-markup
+
+--no-private
+--hide-void-return
+
+--markup=markdown
+--markup-provider=redcarpet
+
+--exclude lib/artoo/ext
+--plugin yard-sinatra

data/Gemfile

@@ -18,3 +18,12 @@ gem 'guard'
 gem 'guard-livereload'
 gem 'guard-sprockets'
 gem 'guard-compass'
+
+# For documentation
+gem 'yard'
+gem 'yard-sinatra'
+gem 'redcarpet'
+
+# For tests
+gem 'minitest'
+gem 'mocha'

data/Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: .
   specs:
-    artoo (0.4.0)
-      active_support (~> 3.0)
+    artoo (0.4.1)
       celluloid (~> 0.14.0)
       celluloid-io (~> 0.14.0)
       multi_json (~> 1.6)
@@ -13,9 +12,6 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    active_support (3.0.0)
-      activesupport (= 3.0.0)
-    activesupport (3.0.0)
     bootstrap-sass (2.2.2.0)
       sass (~> 3.2)
     celluloid (0.14.0)
@@ -90,6 +86,7 @@ GEM
       spoon (~> 0.0)
     rack (1.5.2)
     rake (10.0.4)
+    redcarpet (2.2.2)
     reel (0.4.0.pre)
       celluloid-io (>= 0.8.0)
       http (>= 0.2.0)
@@ -110,6 +107,9 @@ GEM
     timers (1.1.0)
     websocket_parser (0.1.2)
       http
+    yard (0.8.6.1)
+    yard-sinatra (1.0.0)
+      yard (~> 0.7)
 
 PLATFORMS
   java
@@ -127,7 +127,10 @@ DEPENDENCIES
   hybridgroup-argus
   hybridgroup-firmata
   hybridgroup-sphero
-  minitest (~> 4.6)
-  mocha (~> 0.13)
+  minitest
+  mocha
+  redcarpet
   sass
   sprockets
+  yard
+  yard-sinatra

data/README.md

@@ -100,9 +100,9 @@ end
 
 Once the robot or group is working, you can view the main API page at the host and port specified.
 
-## CLI:
+## Console:
 
-Artoo includes Robi, a Command Line Interface (CLI) based on Pry (http://pryrepl.org/) to allow you to interactively control your robot.
+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

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

@@ -20,7 +20,8 @@ window.driversWithOutput = ["Pinger", "Pinger2", "ardrone_navigation", "wiiclass
 
   device = console: ->
     window.ws.close() if window.ws
-    window.ws = new WebSocket("ws://localhost:4321/robots/" + $scope.robot.name + "/devices/" + $scope.deviceDetail.name + "/events")
+    wspath = "ws://" + location.host + "/robots/"
+    window.ws = new WebSocket(wspath + $scope.robot.name + "/devices/" + $scope.deviceDetail.name + "/events")
     $(".console code").empty()
     ws.onmessage = (evt)->
       $(".console code").prepend(evt.data + "\n")

data/api/public/core.js

@@ -241,10 +241,12 @@ ngChange:rd,required:dc,ngRequired:dc,ngValue:ud}).directive(lb).directive(ec);a
     };
     device = {
       console: function() {
+        var wspath;
         if (window.ws) {
           window.ws.close();
         }
-        window.ws = new WebSocket("ws://localhost:4321/robots/" + $scope.robot.name + "/devices/" + $scope.deviceDetail.name + "/events");
+        wspath = "ws://" + location.host + "/robots/";
+        window.ws = new WebSocket(wspath + $scope.robot.name + "/devices/" + $scope.deviceDetail.name + "/events");
         $(".console code").empty();
         return ws.onmessage = function(evt) {
           return $(".console code").prepend(evt.data + "\n");

data/artoo.gemspec

@@ -23,7 +23,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'celluloid-io', '~> 0.14.0'
   s.add_runtime_dependency 'reel', '~> 0.4.pre'
   s.add_runtime_dependency 'multi_json', '~> 1.6'
-  s.add_runtime_dependency 'active_support', '~> 3.0'
   s.add_runtime_dependency 'rake', '~> 10.0'
   s.add_runtime_dependency 'pry', '~> 0.9'
   s.add_development_dependency 'minitest', '~> 4.6'

data/lib/artoo/adaptors/adaptor.rb

@@ -1,39 +1,53 @@
 module Artoo
   module Adaptors
-    # The Adaptor class is the base class used to  
-    # connect to a specific group of hardware devices. Examples 
-    # would be an Arduino, a Sphero, or an ARDrone.
+    # The Adaptor class is the base class used to connect to a specific group
+    # of hardware devices. Examples would be an Arduino, a Sphero, or an ARDrone.
     #
     # Derive a class from this class, in order to implement communication
     # with a new type of hardware device.
+    # @see https://github.com/celluloid/celluloid-io Celluloid::IO Documentation
     class Adaptor
       include Celluloid::IO
 
       attr_reader :parent, :port
 
+      # Initialize an adaptor
+      # @param params [hash]
+      # @option params [String] :parent
+      # @option params [String] :port
       def initialize(params={})
         @parent = params[:parent]
         @port = params[:port]
         @connected = false
       end
 
+      # Makes connected flag true
+      # @return [Boolean]
       def connect
         @connected = true
       end
 
+      # Makes connected flag false
+      # @return [Boolean]
       def disconnect
         @connected = false
         true
       end
 
+      # Makes connected flag true
+      # @return [Boolean] true unless connected
       def reconnect
         connect unless connected?
       end
 
+      # @return [Boolean] connected flag status
       def connected?
         @connected == true
       end
 
+      # Connects to configured port
+      # @return [TCPSocket] tcp socket of tcp port
+      # @return [String] port configured
       def connect_to
         if port.is_tcp?
           connect_to_tcp
@@ -42,15 +56,22 @@ module Artoo
         end
       end
 
+      # @return [TCPSocket] TCP socket connection
       def connect_to_tcp
         @socket ||= TCPSocket.new(port.host, port.port)
       end
-
+      # @return [UDPSocket] UDP socket connection
       def connect_to_udp
         @udp_socket ||= UDPSocket.new
       end
 
-      def connect_to_serial(speed=57600, data_bits=8, stop_bits=1, parity=nil)
+      # Creates serial connection
+      # @param speed [int]
+      # @param data_bits [int]
+      # @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)
         require 'serialport'
         parity = ::SerialPort::NONE unless parity
         @sp = ::SerialPort.new(port.port, speed, data_bits, stop_bits, parity)
@@ -59,4 +80,4 @@ module Artoo
       end
     end
   end
-end
+end

data/lib/artoo/adaptors/ardrone.rb

@@ -2,11 +2,13 @@ require 'artoo/adaptors/adaptor'
 
 module Artoo
   module Adaptors
-    # Connect to a ARDrone 2.0 (http://ardrone2.parrot.com/)
+    # This class connects to a ARDrone 2.0
+    # @see http://rubydoc.info/gems/hybridgroup-argus/0.2.0/Argus/Drone Argus Drone Documentation
     class Ardrone < Adaptor
       finalizer :finalize
       attr_reader :ardrone
 
+      # Finalizes connection with ARDrone by landing and stopping the device
       def finalize
         if connected?
           ardrone.land
@@ -14,20 +16,26 @@ module Artoo
         end
       end
 
+      # Creates Argus Drone connection with device
+      # @return [Boolean]
       def connect
         require 'argus' unless defined?(::Argus)
         @ardrone = Argus::Drone.new(connect_to_udp, port.host, port.port)
         super
       end
 
+      # Disconnects device by stopping it and ending connection
+      # @return [Boolean]
       def disconnect
         ardrone.stop
         super
       end
 
+      # Calls ardrone actions using method missing
+      # @see https://github.com/hybridgroup/argus/blob/master/lib/argus/drone.rb hybridgroup-argus Drone
       def method_missing(method_name, *arguments, &block)
         ardrone.send(method_name, *arguments, &block)
       end
     end
   end
-end
+end

data/lib/artoo/adaptors/ardrone_navigation.rb

@@ -2,10 +2,13 @@ require 'artoo/adaptors/adaptor'
 
 module Artoo
   module Adaptors
-    # Connect to a ARDrone 2.0 (http://ardrone2.parrot.com/) navigation data stream
+    # Connect to a ARDrone 2.0 navigation data stream
+    # @see http://rubydoc.info/gems/hybridgroup-argus/0.2.0/Argus/NavStreamer Argus NavStremer Documentation
     class ArdroneNavigation < Adaptor
       attr_reader :ardrone
 
+      # Creates connection with Argus NavStreamer and starts ardrone device
+      # @return [Boolean]
       def connect
         require 'argus' unless defined?(::Argus)
         @ardrone = Argus::NavStreamer.new(connect_to_udp, port.host, port.port.to_i)
@@ -13,14 +16,18 @@ module Artoo
         super
       end
 
+      # Closes connection with ardrone device
+      # @return [Boolean]
       def disconnect
         ardrone.close
         super
       end
 
+      # Calls ardrone actions using method missing
+      # @see http://rubydoc.info/gems/hybridgroup-argus/0.2.0/Argus/Drone Argus Drone Documentation
       def method_missing(method_name, *arguments, &block)
         ardrone.send(method_name, *arguments, &block)
       end
     end
   end
-end
+end

data/lib/artoo/adaptors/ardrone_video.rb

@@ -2,26 +2,34 @@ require 'artoo/adaptors/adaptor'
 
 module Artoo
   module Adaptors
-    # Connect to a ARDrone 2.0 (http://ardrone2.parrot.com/) video data stream
+    # Connect to a ARDrone 2.0  video data stream
+    # @see http://rubydoc.info/gems/hybridgroup-argus/0.2.0/Argus/TcpVideoStreamer TCP Video Streamer Documentation
+    # @see http://rubydoc.info/gems/hybridgroup-argus/0.2.0/Argus/PaVEParser PaVEParser Documentation
     class ArdroneVideo < Adaptor
       attr_reader :ardrone, :video_parser
 
+      # Creates connection to Argus TCP Video Streamer and
+      # Argus PaVE Parser starting a stream with ardrone device
+      # @return [Boolean]
       def connect
         require 'argus' unless defined?(::Argus)
-        @ardrone = Argus::TcpVideoStreamer.new(connect_to_tcp, port.host, port.port)
-        @video_parser = Argus::PaVEParser.new(@ardrone)
-        @ardrone.start_stream(connect_to_udp)
+        @ardrone = Argus::VideoStreamer.new(connect_to_tcp, port.host, port.port)
+        @ardrone.start(connect_to_udp)
         super
       end
 
+      # Closes ardrone connection
+      # @return [Boolean]
       def disconnect
         ardrone.close
         super
       end
 
+      # Calls ardrone actions using method missing
+      # @see https://github.com/hybridgroup/argus/blob/master/lib/argus/drone.rb hybridgroup-argus Drone
       def method_missing(method_name, *arguments, &block)
         ardrone.send(method_name, *arguments, &block)
       end
     end
   end
-end
+end

data/lib/artoo/adaptors/firmata.rb

@@ -2,9 +2,13 @@ require 'artoo/adaptors/adaptor'
 
 module Artoo
   module Adaptors
+    # Connect to Arduino using Firmata
+    # @see http://rubydoc.info/gems/hybridgroup-firmata/0.3.0/Firmata/Board HybridGroup Firmata Documentation
     class Firmata < Adaptor
       attr_reader :firmata
 
+      # Creates connection with firmata board
+      # @return [Boolean]
       def connect
         require 'firmata' unless defined?(::Firmata)
         @firmata = ::Firmata::Board.new(connect_to)
@@ -13,13 +17,17 @@ module Artoo
         return true
       end
 
+      # Closes connection with firmata board
+      # @return [Boolean]
       def disconnect
         super
-      end     
+      end
 
+      # Uses method missing to call Firmata Board methods
+      # @see http://rubydoc.info/gems/hybridgroup-firmata/0.3.0/Firmata/Board Firmata Board Documentation
       def method_missing(method_name, *arguments, &block)
         firmata.send(method_name, *arguments, &block)
       end
-   end
+    end
   end
 end

data/lib/artoo/adaptors/loopback.rb

@@ -2,7 +2,8 @@ require 'artoo/adaptors/adaptor'
 
 module Artoo
   module Adaptors
+    # This class is used for testing
     class Loopback < Adaptor
     end
   end
-end
+end

data/lib/artoo/adaptors/roomba.rb

@@ -2,17 +2,22 @@ require 'artoo/adaptors/adaptor'
 
 module Artoo
   module Adaptors
-    # Connect to a Roomba (http://www.irobot.com/en/us/robots/Educators/Create.aspx)
+    # Connect to a Roomba
+    # @see http://www.irobot.com/en/us/robots/Educators/Create.aspx Roomba information
     class Roomba < Adaptor
       finalizer :finalize
       attr_reader :sp
 
+      # Closes connection if already connected
+      # @return [Boolean]
       def finalize
         if connected?
           @sp.close
         end
       end
 
+      # Creates serial or tcp connection
+      # @return [Boolean]
       def connect
         if port.is_serial?
           @sp = connect_to_serial
@@ -23,7 +28,8 @@ module Artoo
         end
         super
       end
-      
+
+      # Send bytes to device
       def send_bytes(bytes)
         bytes = [bytes] unless bytes.respond_to?(:map)
         bytes.map!(&:chr)
@@ -33,11 +39,13 @@ module Artoo
         Logger.debug "returned: #{res.inspect}"
       end
 
+      # Closes connection to device
+      # @return [Boolean]
       def disconnect
         @sp.close
         super
       end
-      
+
     end
   end
-end
+end

data/lib/artoo/adaptors/sphero.rb

@@ -2,18 +2,26 @@ require 'artoo/adaptors/adaptor'
 
 module Artoo
   module Adaptors
-    # Connect to a Sphero (http://gosphero.com)
+    # Connect to a Sphero device
+    # @see http://gosphero.com Sphero information
+    # @see http://rubydoc.info/gems/hybridgroup-sphero HybridGroup Sphero Documentation
     class Sphero < Adaptor
       finalizer :finalize
-      RETRY_COUNT = 5
       attr_reader :sphero
 
+      # Number of retries when connecting
+      RETRY_COUNT = 5
+
+      # Closes connection with device if connected
+      # @return [Boolean]
       def finalize
         if connected?
           sphero.close
         end
       end
 
+      # Creates a connection with Sphero object with retries
+      # @return [Boolean]
       def connect
         @retries_left = RETRY_COUNT
         require 'sphero' unless defined?(::Sphero)
@@ -33,14 +41,18 @@ module Artoo
         end
       end
 
+      # Closes connection with device
+      # @return [Boolean]
       def disconnect
         sphero.close
         super
       end
 
+      # Uses method missing to call sphero actions
+      # @see http://rubydoc.info/gems/hybridgroup-sphero/Sphero Sphero documentation
       def method_missing(method_name, *arguments, &block)
         sphero.send(method_name, *arguments, &block)
       end
     end
   end
-end
+end