artoo-arduino 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6cab89e35158f2d7be237a7b0a2cee159953f573
-  data.tar.gz: dcedc720fa195da509d2865bf47bd6b0040ae3a4
+  metadata.gz: 665324f8bb8bec3f5156fe6355b23553fb12a20b
+  data.tar.gz: 65b647f2653f2959f0a0aa2aee8fad3ccbab3816
 SHA512:
-  metadata.gz: db12d34801fe73ea8af6aad96c6eb225bce96917d1550236ce76fc8f9a3c4788e1eb95854e9a7baa312483dfdddbbccf9686ed9b5a4961eef5c1fbbe07a10213
-  data.tar.gz: 9f338021acab661e86751a82524042a81665fca35b62d50f83c04aed1b4108a22c604450a6a98cfd56c353bfa421bafef805d5f07d7ba2d4723ecfa4de5d4956
+  metadata.gz: 3724ae43dd73311c9c0e2371d74bb2e52833d91ca7dd79b6ac0fcbad1ee4c919bdff4e5290c5f58f7f22e1638332b040e1b7d34981b02c70fcdefc8221012a43
+  data.tar.gz: e274f06285b6c4be343ddbf684519e636d8c7acfbd66bb32e1bc9737de74792e0fbfb0cb69faf5b18db3948c89fc993f75d9e020f5bf3ad0cc31e28dd3d00d2a

data/Gemfile

@@ -1,4 +1,5 @@
 source "http://rubygems.org"
 
-# Specify your gem's dependencies in artoo-sphero.gemspec
+# Specify your gem's dependencies in artoo-arduino.gemspec
 gemspec
+#gem 'hybridgroup-firmata', path: '/path/to/hybridgroup-firmata'

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    artoo-arduino (1.0.1)
-      artoo (~> 1.0.0.rc3)
-      hybridgroup-firmata (~> 0.4.2)
+    artoo-arduino (1.0.2)
+      artoo (~> 1.0.0)
+      hybridgroup-firmata (~> 0.4.3)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    artoo (1.0.0.rc3)
+    artoo (1.0.0)
       celluloid (~> 0.14.1)
       celluloid-io (~> 0.14.1)
       multi_json (~> 1.6)
@@ -23,13 +23,13 @@ GEM
       nio4r (>= 0.4.5)
     certified (0.1.1)
     coderay (1.0.9)
-    event_spitter (0.5.0)
+    event_emitter (0.2.5)
     http (0.4.0)
       certified
       http_parser.rb
     http_parser.rb (0.5.3)
-    hybridgroup-firmata (0.4.2)
-      event_spitter
+    hybridgroup-firmata (0.4.3)
+      event_emitter
     metaclass (0.0.1)
     method_source (0.8.2)
     minitest (5.0.1)

data/artoo-arduino.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.name        = "artoo-arduino"
   s.version     = Artoo::Arduino::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Ron Evans", "Adrian Zankich"]
+  s.authors     = ["Ron Evans", "Adrian Zankich", "Rafael Magaña"]
   s.email       = ["artoo@hybridgroup.com"]
   s.homepage    = "https://github.com/hybridgroup/artoo-arduino"
   s.summary     = %q{Artoo adaptor and driver for Arduino}
@@ -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.0.0.rc3'
-  s.add_runtime_dependency 'hybridgroup-firmata', '~> 0.4.2'
+  s.add_runtime_dependency 'artoo', '~> 1.0.0'
+  s.add_runtime_dependency 'hybridgroup-firmata', '~> 0.4.3'
   s.add_development_dependency 'minitest', '~> 5.0'
   s.add_development_dependency 'minitest-happy'
   s.add_development_dependency 'mocha', '~> 0.14.0'

data/examples/firmata_blink_led.rb

@@ -0,0 +1,17 @@
+require 'artoo'
+
+# Circuit and schematic here: http://arduino.cc/en/Tutorial/Blink
+
+#connection :firmata, :adaptor => :firmata, :port => '/dev/tty*'
+connection :firmata, :adaptor => :firmata, :port => '127.0.0.1:8023'
+device :board
+device :led, :driver => :led, :pin => 13
+
+work do
+  puts "Firmware name: #{board.firmware_name}"
+  puts "Firmata version: #{board.version}"
+
+  every 1.second do
+    led.on? ? led.off : led.on
+  end
+end

data/examples/firmata_blink_led_with_toggle.rb

@@ -0,0 +1,18 @@
+require 'artoo'
+
+# Circuit and schematic here: http://arduino.cc/en/Tutorial/Blink
+
+#connection :firmata, :adaptor => :firmata, :port => '/dev/tty*'
+connection :firmata, :adaptor => :firmata, :port => '127.0.0.1:8023'
+device :board 
+device :led, :driver => :led, :pin => 13
+
+work do
+  puts "Firmware name: #{board.firmware_name}"
+  puts "Firmata version: #{board.version}"
+
+  every 1.second do
+    led.toggle
+  end
+end
+

data/examples/firmata_button_and_led.rb

@@ -0,0 +1,16 @@
+require 'artoo'
+
+# Circuit and schematic here: http://arduino.cc/en/tutorial/button
+
+#connection :firmata, :adaptor => :firmata, :port => '/dev/tty*'
+connection :firmata, :adaptor => :firmata, :port => '127.0.0.1:8023'
+device :led, :driver => :led, :pin => 13
+device :button, :driver => :button, :pin => 2, :interval => 0.01
+
+work do
+  puts
+  puts "Press the button connected on pin #{button.pin}..."
+
+  on button, :push    => proc { led.on }
+  on button, :release => proc { led.off }
+end

data/examples/firmata_led_brightness.rb

@@ -0,0 +1,29 @@
+require 'artoo'
+
+# Circuit and schematic here: http://arduino.cc/en/Tutorial/Fade
+
+#connection :firmata, :adaptor => :firmata, :port => '/dev/tty*'
+connection :firmata, :adaptor => :firmata, :port => '127.0.0.1:8023'
+device :board
+device :led, :driver => :led, :pin => 3
+
+brightness = 0
+fade_amount = 5
+
+
+work do
+
+  puts "Firmware name: #{board.firmware_name}"
+  puts "Firmata version: #{board.version}"
+
+  led.on
+
+  every(0.05) do
+    led.brightness(brightness)
+    brightness = brightness + fade_amount
+    if brightness == 0 or brightness == 255
+      fade_amount = -fade_amount
+    end
+  end
+
+end

data/examples/firmata_motor.rb

@@ -0,0 +1,28 @@
+require 'artoo'
+
+leg1_pin = 7  # digital pin
+leg2_pin = 4  # digital pin
+speed_pin = 3 # PWM pin
+
+speed = 0
+forward = true
+
+#connection :firmata, :adaptor => :firmata, :port => '/dev/tty*'
+connection :firmata, :adaptor => :firmata, :port => '127.0.0.1:8023'
+device :board
+device :motor, :driver => :motor, :pin => [leg1_pin, leg2_pin, speed_pin]
+
+work do
+  puts "Firmware name: #{board.firmware_name}"
+  puts "Firmata version: #{board.version}"
+
+  every(0.1)do
+    forward ? motor.forward(speed) : motor.backward(speed)
+    speed += 10
+    if speed >= 255
+      speed = 0
+      forward = (not forward)
+      sleep 1 # give the motor some time to stop inertia
+    end
+  end
+end

data/examples/firmata_servo.rb

@@ -0,0 +1,21 @@
+require 'artoo'
+
+# Circuit and schematic here: http://arduino.cc/en/Tutorial/Sweep
+
+#connection :firmata, :adaptor => :firmata, :port => '/dev/tty*'
+connection :firmata, :adaptor => :firmata, :port => '127.0.0.1:8023'
+device :board
+device :servo, :driver => :servo, :pin => 3 # pin must be a PWM pin
+
+work do
+  puts "Firmware name: #{board.firmware_name}"
+  puts "Firmata version: #{board.version}"
+
+  every(2) do
+    case servo.current_angle
+    when 90 then servo.max
+    when 0 then servo.center
+    when 180 then servo.min
+    end
+  end
+end

data/examples/firmata_wiichuck.rb

@@ -0,0 +1,13 @@
+require 'artoo'
+
+connection :arduino, :adaptor => :firmata, :port => "127.0.0.1:8023"
+device :wiichuck, :driver => :wiichuck, :connection => :arduino, :interval => 0.1
+
+work do
+  on wiichuck, :c_button => proc { puts "c button pressed!" }
+  on wiichuck, :z_button => proc { puts "z button pressed!" }
+  on wiichuck, :joystick => proc { |*value|
+    puts "joystick x: #{value[1][:x]}, y: #{value[1][:y]}"
+  }
+end
+

data/lib/artoo/adaptors/firmata.rb

@@ -10,7 +10,8 @@ module Artoo
       # Creates connection with firmata board
       # @return [Boolean]
       def connect
-        require 'firmata' unless defined?(::Firmata)
+        require 'firmata' unless defined?(::Firmata::Board)
+        
         @firmata = ::Firmata::Board.new(connect_to)
         @firmata.connect
         super

data/lib/artoo/drivers/button.rb

@@ -17,7 +17,7 @@ module Artoo
       # Sets values to read and write from button
       # and starts driver
       def start_driver
-        connection.set_pin_mode(pin, Firmata::Board::INPUT)
+        connection.set_pin_mode(pin, Firmata::PinModes::INPUT)
         connection.toggle_pin_reporting(pin)
 
         every(interval) do
@@ -29,14 +29,14 @@ module Artoo
       end
 
       def handle_events
-        while i = find_event("digital-read-#{pin}") do
+        while i = find_event("digital_read_#{pin}") do
           event = events.slice!(i)
           update(event.data.first) if !event.nil?
         end
       end
 
       def find_event(name)
-        events.index {|e| e.name == name}
+        events.index {|e| e.name == name.to_sym}
       end
 
       def events

data/lib/artoo/drivers/led.rb

@@ -5,44 +5,57 @@ module Artoo
     # The LED driver behaviors
     class Led < Driver
 
-      COMMANDS = [:firmware_name, :version, :on, :off, :toggle, :brightness].freeze
+      COMMANDS = [:firmware_name, :version,
+                  :on, :off, :toggle, 
+                  :brightness, 
+                  :on?, :off?].freeze
 
+      def initialize(params = {})
+        @is_on = false
+        super
+      end
       # @return [Boolean] True if on
-      def is_on?
-        (@is_on ||= false) == true
+      def on?
+        @is_on
       end
 
       # @return [Boolean] True if off
-      def is_off?
-        (@is_on ||= false) == false
+      def off?
+        (not on?)
       end
 
-      # Sets led to on status
+      # Sets led to level HIGH
       def on
+        change_state(pin, Firmata::PinLevels::HIGH)
         @is_on = true
-        connection.set_pin_mode(pin, Firmata::Board::OUTPUT)
-        connection.digital_write(pin, Firmata::Board::HIGH)
+        true
       end
 
-      # Sets led to off status
+      # Sets led to level LOW
       def off
+        change_state(pin, Firmata::PinLevels::LOW)
         @is_on = false
-        connection.set_pin_mode(pin, Firmata::Board::OUTPUT)
-        connection.digital_write(pin, Firmata::Board::LOW)
+        true
       end
 
       # Toggle status
       # @example on > off, off > on
       def toggle
-        is_off? ? on : off
+        on? ? off : on
       end
 
       # Change brightness level
       # @param [Integer] level
       def brightness(level=0)
-        connection.set_pin_mode(pin, Firmata::Board::PWM)
+        connection.set_pin_mode(pin, Firmata::PinModes::PWM)
         connection.analog_write(pin, level)
       end
+
+      private
+      def change_state(pin, level)
+        connection.set_pin_mode(pin, Firmata::PinModes::OUTPUT)
+        connection.digital_write(pin, level)
+      end
     end
   end
 end

data/lib/artoo/drivers/motor.rb

@@ -31,14 +31,14 @@ module Artoo
       # Sets movement forward
       # @param [Integer] s speed
       def forward(s)
-        set_legs(Firmata::Board::LOW, Firmata::Board::HIGH)
+        set_legs(Firmata::PinLevels::LOW, Firmata::PinLevels::HIGH)
         speed(s)
       end
 
       # Sets movement backward
       # @param [Integer] s speed
       def backward(s)
-        set_legs(Firmata::Board::HIGH, Firmata::Board::LOW)
+        set_legs(Firmata::PinLevels::HIGH, Firmata::PinLevels::LOW)
         speed(s)
       end
 
@@ -52,16 +52,16 @@ module Artoo
       def speed(s)
         raise "Motor speed must be an integer between 0-255" unless (s.is_a?(Numeric) && s >= 0 && s <= 255)
         @current_speed = s
-        connection.set_pin_mode(speed_pin, Firmata::Board::PWM)
+        connection.set_pin_mode(speed_pin, Firmata::PinModes::PWM)
         connection.analog_write(speed_pin, s)
       end
 
       private
 
       def set_legs(l1, l2)
-        connection.set_pin_mode(leg1_pin, Firmata::Board::OUTPUT)
+        connection.set_pin_mode(leg1_pin, Firmata::PinModes::OUTPUT)
         connection.digital_write(leg1_pin, l1)
-        connection.set_pin_mode(leg2_pin, Firmata::Board::OUTPUT)
+        connection.set_pin_mode(leg2_pin, Firmata::PinModes::OUTPUT)
         connection.digital_write(leg2_pin, l2)
       end
     end

data/lib/artoo/drivers/servo.rb

@@ -4,7 +4,7 @@ module Artoo
   module Drivers
     # Servo behaviors for Firmata
     class Servo < Driver
-      COMMANDS = [:move, :min, :center, :max].freeze
+      COMMANDS = [:move, :min, :center, :max, :current_angle].freeze
 
       attr_reader :current_angle
 
@@ -30,7 +30,7 @@ module Artoo
         raise "Servo angle must be an integer between 0-180" unless (angle.is_a?(Numeric) && angle >= 0 && angle <= 180)
 
         @current_angle = angle
-        connection.set_pin_mode(pin, Firmata::Board::SERVO)
+        connection.set_pin_mode(pin, Firmata::PinModes::SERVO)
         connection.analog_write(pin, angle_to_span(angle))
       end
 

data/lib/artoo/drivers/wiidriver.rb

@@ -47,7 +47,7 @@ module Artoo
       end
 
       def handle_events
-        while i = find_event("i2c_reply") do
+        while i = find_event(:i2c_reply) do
           event = events.slice!(i)
           update(event.data.first) if !event.nil?
         end

data/lib/artoo-arduino/version.rb

@@ -1,5 +1,5 @@
 module Artoo
   module Arduino
-    VERSION = '1.0.1'
+    VERSION = '1.0.2'
   end
 end

data/test/drivers/led_test.rb

@@ -11,46 +11,90 @@ describe Artoo::Drivers::Led do
     @device.stubs(:connection).returns(@connection)
   end
 
-  it 'Led#is_on? default' do
-    @led.is_on?.must_equal false
-  end
+  describe 'state switching' do
 
-  it 'Led#is_off? default' do
-    @led.is_off?.must_equal true
-  end
+    before do
+      @connection.expects(:set_pin_mode).with(@pin, Firmata::PinModes::OUTPUT)
+    end
 
-  it 'Led#on' do
-    @connection.expects(:set_pin_mode).with(@pin, Firmata::Board::OUTPUT)
-    @connection.expects(:digital_write).with(@pin, Firmata::Board::HIGH)
-    @led.on
-    @led.is_on?.must_equal true
+    describe '#on' do
+      it 'must turn the led on' do
+        @connection.expects(:digital_write).with(@pin, Firmata::PinLevels::HIGH)
+        @led.on
+      end
+    end
+
+    describe '#off' do
+      it 'must turn the led off' do
+        @connection.expects(:digital_write).with(@pin, Firmata::PinLevels::LOW)
+        @led.off
+      end
+    end
   end
 
-  it 'Led#off' do
-    @connection.expects(:set_pin_mode).with(@pin, Firmata::Board::OUTPUT)
-    @connection.expects(:digital_write).with(@pin, Firmata::Board::LOW)
-    @led.off
-    @led.is_off?.must_equal true
+  describe 'state checking' do
+
+    before do
+      @led.stubs(:change_state)
+    end
+
+    describe '#on?' do
+      it 'must return true if led is on' do
+        @led.on
+        @led.on?.must_equal true
+      end
+
+      it 'must return false if led is off' do
+        @led.off
+        @led.on?.must_equal false
+      end
+    end
+
+    describe '#off?' do
+      it 'must return true if led is off' do
+        @led.off
+        @led.off?.must_equal true
+      end
+
+      it 'must return false if led is on' do
+        @led.on
+        @led.off?.must_equal false
+      end
+    end
   end
 
-  it 'Led#toggle' do
-    @connection.stubs(:set_pin_mode)
-    @connection.stubs(:digital_write)
-    @led.is_off?.must_equal true
-    @led.toggle
-    @led.is_on?.must_equal true
-    @led.toggle
-    @led.is_off?.must_equal true
+  describe '#toggle' do
+    it 'must toggle the state of the led' do
+      @led.stubs(:pin_state_on_board).returns(false)
+      @connection.stubs(:set_pin_mode)
+      @connection.stubs(:digital_write)
+      @led.off?.must_equal true
+      @led.toggle
+      @led.on?.must_equal true
+      @led.toggle
+      @led.off?.must_equal true
+    end
   end
 
-  it 'Led#brightness' do
-    val = 100
-    @connection.expects(:set_pin_mode).with(@pin, Firmata::Board::PWM)
-    @connection.expects(:analog_write).with(@pin, val)
-    @led.brightness(val)
+  describe '#brightness' do
+    it 'must change the brightness of the led' do
+      val = 100
+      @connection.expects(:set_pin_mode).with(@pin, Firmata::PinModes::PWM)
+      @connection.expects(:analog_write).with(@pin, val)
+      @led.brightness(val)
+    end
   end
 
-  it 'Led#commands' do
-    @led.commands.must_include :toggle
+  describe '#commands' do
+    it 'must contain all the necessary commands' do
+      @led.commands.must_include :firmware_name
+      @led.commands.must_include :version
+      @led.commands.must_include :on
+      @led.commands.must_include :off
+      @led.commands.must_include :toggle
+      @led.commands.must_include :brightness
+      @led.commands.must_include :on?
+      @led.commands.must_include :off?
+    end
   end
 end

data/test/test_helper.rb

@@ -1,6 +1,6 @@
 require 'minitest/autorun'
 require 'mocha/setup'
-
+require 'firmata'
 require 'artoo/robot'
 
 Celluloid.logger = nil

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: artoo-arduino
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Ron Evans
 - Adrian Zankich
+- Rafael Magaña
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-15 00:00:00.000000000 Z
+date: 2013-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: artoo
@@ -17,28 +18,28 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc3
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc3
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: hybridgroup-firmata
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.4.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.4.3
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -97,8 +98,13 @@ files:
 - README.md
 - Rakefile
 - artoo-arduino.gemspec
-- examples/button_and_led.rb
-- examples/firmata.rb
+- examples/firmata_blink_led.rb
+- examples/firmata_blink_led_with_toggle.rb
+- examples/firmata_button_and_led.rb
+- examples/firmata_led_brightness.rb
+- examples/firmata_motor.rb
+- examples/firmata_servo.rb
+- examples/firmata_wiichuck.rb
 - lib/artoo-arduino.rb
 - lib/artoo-arduino/version.rb
 - lib/artoo/adaptors/firmata.rb

data/examples/button_and_led.rb

@@ -1,9 +0,0 @@
-require 'artoo'
-
-connection :arduino, :adaptor => :firmata, :port => '127.0.0.1:8023'
-device :led, :driver => :led, :pin => 13
-device :button, :driver => :button, :pin => 2
-
-work do
-  on button, :push => proc {led.toggle}
-end

data/examples/firmata.rb

@@ -1,13 +0,0 @@
-require 'artoo'
-
-connection :arduino, :adaptor => :firmata, :port => '127.0.0.1:8023'
-device :board
-device :led, :driver => :led, :pin => 13
-
-work do
-  puts "Firmware name #{board.firmware_name}"
-  puts "Firmata version #{board.version}"
-  every 1.second do
-    led.toggle
-  end
-end