artoo-sphero 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e73a37bcec5b30a8ca3683e92523237e7bd0fd86
-  data.tar.gz: 5c6eae27a54d587fd233dcb2b33e5a710d1b4319
+  metadata.gz: dd4ee78dc0212685f59e294a8e0d251a3829fe24
+  data.tar.gz: 4f7d8f33dcf7046f5eea874e3d059c36bab252ea
 SHA512:
-  metadata.gz: 67f50d1cf5c9105877e8a5e06bfc7cecfbb50dfbd8e6157c470010028687f5f4443e9f4f6a138fb5d3387ec67c1585d305a11f78dc9b99a24acf581cfbd35dd7
-  data.tar.gz: 36a066ea1516cd11283df95d61974a7445f4976b46db623c468e0979995b91edf299f0c7410f160f17f582041365a398c82f0221a0fabf1c9188572112dac3f7
+  metadata.gz: 43a82c9001d6e5ec14eb2d8ceb25328ef1e9304e0eae0b14edb81203b82b985e53da0d377b1d1e034f2befba1246a0488546941a361cfb73b6cbc3a6611bbdc8
+  data.tar.gz: a903b5eae8a65898e88340533eaa312b1dcbae953d056060055630d4deb6f441452179f000ed780cf53cd6a968269a4515f33bc800462c386f10ce35310dde59

data/.ruby-version

@@ -1 +1 @@
-rbx-2.0.0-rc1
+ruby-2.1.0

data/.travis.yml

@@ -3,4 +3,4 @@ rvm:
   - 2.0.0
   - 1.9.3
   - jruby-19mode
-  - rbx-19mode
+  - rbx-2.1.1

data/Gemfile.lock

@@ -1,55 +1,56 @@
 PATH
   remote: .
   specs:
-    artoo-sphero (1.2.0)
-      artoo (>= 1.4.0)
-      sphero (>= 1.4.1)
+    artoo-sphero (1.3.0)
+      artoo (>= 1.6.0)
+      sphero (>= 1.5.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    artoo (1.4.1)
+    artoo (1.6.0)
       celluloid (~> 0.15.0)
       celluloid-io (~> 0.15.0)
       multi_json (~> 1.6)
       pry (~> 0.9)
       rake
       reel (~> 0.4.0)
+      robeaux (~> 0.0.3)
       thor (~> 0.18.1)
     celluloid (0.15.2)
       timers (~> 1.1.0)
     celluloid-io (0.15.0)
       celluloid (>= 0.15.0)
       nio4r (>= 0.5.0)
-    coderay (1.0.9)
+    coderay (1.1.0)
     http (0.5.0)
       http_parser.rb
-    http_parser.rb (0.6.0.beta.2)
+    http_parser.rb (0.6.0)
     metaclass (0.0.1)
     method_source (0.8.2)
     minitest (5.0.6)
     minitest-happy (1.0.0)
     mocha (0.14.0)
       metaclass (~> 0.0.1)
-    multi_json (1.8.2)
-    nio4r (0.5.0)
-    pry (0.9.12.2)
-      coderay (~> 1.0.5)
+    multi_json (1.8.4)
+    nio4r (1.0.0)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
       method_source (~> 0.8)
       slop (~> 3.4)
-    rake (10.1.0)
+    rake (10.1.1)
     reel (0.4.0)
       celluloid (>= 0.15.1)
       celluloid-io (>= 0.15.0)
       http (>= 0.5.0)
       http_parser.rb (>= 0.6.0.beta.2)
       websocket_parser (>= 0.1.4)
-    slop (3.4.6)
-    sphero (1.4.1)
+    robeaux (0.0.3)
+    slop (3.4.7)
+    sphero (1.5.0)
     thor (0.18.1)
     timers (1.1.0)
-    websocket_parser (0.1.4)
-      http
+    websocket_parser (0.1.6)
 
 PLATFORMS
   ruby

data/README.md

@@ -14,6 +14,12 @@ For more information abut Artoo, check out our repo at https://github.com/hybrid
 gem install artoo-sphero
 ```
 
+Afterwards you need to install `socat` - for this please run the following command (works on both OSX and Linux):
+
+```
+artoo install socat
+```
+
 ## Using
 
 ```ruby

data/artoo-sphero.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.name        = "artoo-sphero"
   s.version     = Artoo::Sphero::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Ron Evans", "Adrian Zankich", "Mike Ford"]
+  s.authors     = ["Ron Evans", "Adrian Zankich", "Mike Ford", "Tobias Pfeiffer", "Edgar Silva"]
   s.email       = ["artoo@hybridgroup.com"]
   s.homepage    = "https://github.com/hybridgroup/artoo-sphero"
   s.summary     = %q{Artoo adaptor and driver for Sphero robot}
@@ -19,8 +19,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 'artoo', '>= 1.4.0'
-  s.add_runtime_dependency 'sphero', '>= 1.4.1'
+  s.add_runtime_dependency 'artoo', '>= 1.6.0'
+  s.add_runtime_dependency 'sphero', '>= 1.5.0'
   s.add_development_dependency 'minitest', '>= 5.0'
   s.add_development_dependency 'minitest-happy'
   s.add_development_dependency 'mocha', '>= 0.14.0'

data/docs/commands.md

@@ -0,0 +1,67 @@
+# Commands
+
+## roll(speed, direction) 
+
+Starts the sphero rolling at the provided speed (value between `0` and `255`) and direction (value between `0` and `360`).
+
+##### Params
+
+- **speed** - params
+- **direction** - params
+
+##### Returns
+
+`true or nil`
+
+## stop 
+
+Stops the sphero.
+
+##### Returns
+
+`true or nil`
+
+## detect_collissions 
+
+Sets the sphero to detect collisions and report them.
+
+##### Returns
+
+`true or nil`
+
+## messages → [sphero_event]
+
+Returns an array of sphero events, the messages reported by the sphero.
+
+##### Returns
+
+`sphero_event`
+
+## color(:color_symbol | [red, green, blue]) → [red_int, green_int, blue_int]
+
+You can pass a color as a symbol or an array containing RGB colors from 0 to 255 `([255, 0, 0] == red)`, if passed a symbol returns the array of RGB corresponding to the color, if passed an array of colors it returns the same array (used when setting colors to the sphero).
+
+##### Params
+
+- **color_symbol** - params
+- **red** - params
+- **green** - params
+- **blue** - params
+
+##### Returns
+
+`[red_int, green_int, blue_int]`
+
+## set_color([red, green, blue]) → true | nil
+
+REVISION PENDING: You can either use it in tandem with color to set the color of the sphero or just pass an array containing RGB colors on the range `0` to `255` `([255, 0, 0] == red)`.
+
+##### Params
+
+- **red** - params
+- **green** - params
+- **blue** - params
+
+##### Returns
+
+`true or nil`

data/docs/events.md

@@ -0,0 +1,29 @@
+# Events
+
+## start_driver
+
+Starts the driver.
+
+## handle_collision_detected(data)
+
+Gets triggered when the Sphero has data to send to the user, related to "collision".
+
+##### Data
+
+- **data**- The returned data
+
+## handle_power_notification(data)
+
+Gets triggered when the Sphero has data to send to the user, related to "power".
+
+##### Data
+
+- **data**- The returned data
+
+## handle_sensor_data(data)
+
+Gets triggered when the Sphero has data to send to the user, related to "sensor".
+
+##### Data
+
+- **data**- The returned data

data/lib/artoo-sphero/version.rb

@@ -1,5 +1,5 @@
 module Artoo
   module Sphero
-    VERSION = '1.2.0'
+    VERSION = '1.3.0'
   end
 end

data/lib/artoo/drivers/sphero.rb

@@ -14,6 +14,10 @@ module Artoo
       COMMANDS = [:roll, :stop, :detect_collisions, :messages, :set_color, :color].freeze
 
       # Starts drives and required connections
+
+      # Public: Starts the driver.
+      #
+      # Returns null.
       def start_driver
         begin
           detect_collisions
@@ -30,6 +34,9 @@ module Artoo
         end
       end
 
+      # Public: Handles different message events.
+      #
+      # Returns sphero_event.
       def handle_message_events         
         while not connection.messages.empty? do        
           evt = connection.messages.pop
@@ -46,18 +53,43 @@ module Artoo
 
       # Detects collisions
       # @param [Hash] params
+
+      # Public: Sets the sphero to detect collisions and report them.
+      #
+      # Returns true | nil.
       def detect_collisions(params={})
         connection.configure_collision_detection 0x01, 0x20, 0x20, 0x20, 0x20, 0x50
       end
 
       # Set color
       # @param [Collection] colors
+
+      # Public: You can either use it in tandem with color to set the color of the 
+      # sphero or just pass an array containing RGB colors on the range 0 to 255 
+      # ([255, 0, 0] == red).
+      #
+      # red - params
+      # green - params
+      # blue -params
+      #
+      # Returns true | nil.
       def set_color(*colors)
         connection.rgb(*color(*colors))
       end
 
       # Retrieves color
       # @param [Collection] colors
+
+      # Public: You can pass a color as a symbol or an array containing RGB colors from 0 to 255 
+      # ([255, 0, 0] == red), if passed a symbol returns the array of RGB corresponding to the 
+      # color, if passed an array of colors it returns the same array (used when setting colors to the sphero).
+      #
+      # :color_symbol - color
+      # red - params
+      # green - params
+      # blue -params
+      #
+      # Returns true | nil.
       def color(*colors)
         case colors.first
         when :red    then RED
@@ -72,16 +104,34 @@ module Artoo
       private
 
       # Publish collision events
+
+      # Public: Handles collision message events.
+      #
+      # data - params
+      #
+      # Returns nil.
       def handle_collision_detected(data)
         publish(event_topic_name("collision"), data)
       end
 
       # Publish collision events
+
+      # Public: Handles power message events.
+      #
+      # data - params
+      #
+      # Returns nil.
       def handle_power_notification(data)
         publish(event_topic_name("power"), data)
       end
 
       # Publish collision events
+
+      # Public: Handles sensor message events.
+      #
+      # data - params
+      #
+      # Returns nil.
       def handle_sensor_data(data)
         publish(event_topic_name("sensor"), data)
       end

metadata

@@ -1,85 +1,87 @@
 --- !ruby/object:Gem::Specification
 name: artoo-sphero
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Ron Evans
 - Adrian Zankich
 - Mike Ford
+- Tobias Pfeiffer
+- Edgar Silva
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-18 00:00:00.000000000 Z
+date: 2014-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: artoo
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: sphero
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
   name: minitest-happy
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.14.0
 description: Artoo adaptor and driver for Sphero robot
@@ -89,17 +91,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .ruby-gemset
-- .ruby-version
-- .rvmrc.example
-- .travis.yml
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".rvmrc.example"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - artoo-sphero.gemspec
+- docs/commands.md
+- docs/events.md
 - examples/sphero.rb
 - examples/sphero2.rb
 - examples/sphero_color.rb
@@ -122,17 +126,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: artoo-sphero
-rubygems_version: 2.0.3
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Artoo adaptor and driver for Sphero robot