wall_e 0.0.3 → 0.0.4

data/README.md

@@ -1,6 +1,23 @@
-# WallE
+# Wall·E
 
-TODO: Write a gem description
+Ruby powered robots.
+
+## Shout-outs
+
+Wall·E would not have been possible if not for the awesome goings on in
+the Node community. Big props to:
+
+* [Rick Waldron](https://github.com/rwldrn) creator of [johnny-five](https://github.com/rwldrn/johnny-five)
+* [Chris Williams](https://github.com/voodootikigod) creator of [node-serialport](https://github.com/voodootikigod/node-serialport)
+* [Julian Gautier](https://github.com/jgautier) creator [firmata](https://github.com/jgautier/firmata)
+
+## Prerequisites
+
+1. Download and install the [Arduio IDE](http://www.arduino.cc/en/Main/Software) for your OS
+2. Download and unzip [Firmata 2.2](http://at.or.at/hans/pd/Firmata-2.2.zip)
+3. Plug in your Arduino via USB
+4. Open the Arduino IDE, select: File > Open > [Path from step 2] > examples > StandardFirmata
+5. Click the Upload button
 
 ## Installation
 
@@ -18,7 +35,19 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+    require 'wall_e'
+
+    WallE::Assembler.build do
+
+      led = Led(3)
+      rate = 0.75
+
+      repeat do
+        led.toggle
+        delay rate
+      end
+
+    end
 
 ## Contributing
 
@@ -27,3 +56,4 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+

data/cookbook/Button/toggle_led.rb

@@ -0,0 +1,11 @@
+require 'bundler/setup'
+require 'wall_e'
+
+WallE::Assembler.build do
+
+  button = Button(7)
+  led = Led(13) # use the onboard LED on pin 13
+
+  button.pressed { led.toggle }
+
+end

data/cookbook/Servo/sweep.rb

@@ -9,7 +9,7 @@ WallE::Assembler.build do
   # YMMV especially if you are using a different servo.
   #
   # The Hitec HS-322 (http://amzn.com/B0006O3XEA) has a range of 2..180.
-  servo = Servo(9, range: 15..170)
+  servo = Servo(9, range: 2..180)
   servo.min
 
   repeat do

data/lib/wall_e.rb

@@ -8,10 +8,10 @@ require 'wall_e/components/led'
 require 'wall_e/components/servo'
 require 'wall_e/components/piezo'
 require 'wall_e/components/claw'
+require 'wall_e/components/button'
 
 module WallE
   class Assembler
-
     attr_reader :board
 
     def self.build(&block)
@@ -51,23 +51,49 @@ module WallE
     # TODO some metaprogramming sauce to reduce the component helper code.
     def Led(pin_number)
       pin = Pin.new(pin_number, @board)
-      Led.new(pin)
+      (leds << Led.new(pin)).last
     end
 
     def Servo(pin_number, options = {})
       pin = Pin.new(pin_number, @board)
-      Servo.new(pin, options)
+      (servos << Servo.new(pin, options)).last
     end
 
     def Piezo(pin_number)
       pin = Pin.new(pin_number, @board)
-      Piezo.new(pin)
+      (piezos << Piezo.new(pin)).last
     end
 
     def Claw(claw_pin_number, pan_pin_number)
       claw_servo = Servo(claw_pin_number, range: 60..144)
       pan_servo  = Servo(pan_pin_number)
-      Claw.new(claw_servo, pan_servo)
+      (claws << Claw.new(claw_servo, pan_servo)).last
+    end
+
+    def Button(pin_number)
+      pin = Pin.new(pin_number, @board)
+      (buttons << Button.new(pin)).last
+    end
+
+    # TODO wrap up these collections in some metaprogramming sauce too.
+    def leds
+      @leds ||= []
+    end
+
+    def servos
+      @servos ||= []
+    end
+
+    def piezos
+      @piezos ||= []
+    end
+
+    def claws
+      @claws ||= []
+    end
+
+    def buttons
+      @buttons ||= []
     end
 
     def delay(seconds)
@@ -79,11 +105,11 @@ module WallE
     end
 
     def resume
-      @running = true
       @group.list.each(&:wakeup)
+      @running = true
     end
 
-    def turn_off
+    def shut_down
       @group.list.each(&:kill)
     end
 

data/lib/wall_e/components/button.rb

@@ -0,0 +1,61 @@
+module WallE
+  class Button
+
+    # Public: Initialize a Button.
+    #
+    # pin       - the Pin the Button is attached to.
+    # hold_time - the Integer seconds to indicate that the button is being held (default: 0.07).
+    def initialize(pin, hold_time = 0.7)
+      @pin = pin
+      @pin.set_mode(Pin::INPUT)
+      @pin.start_reporting
+      @hold_time = hold_time
+      @pin.on("digital-read-#{@pin.number}", method(:handler))
+    end
+
+    # Public: What to do when the button is pressed.
+    #
+    # block - the block that will run when the button is pressed.
+    #
+    # Returns nothing.
+    def pressed(&block)
+      @down_callback = block
+    end
+
+    # Public: What to do when the button is released.
+    #
+    # block - the block that will run when the button is released.
+    #
+    # Returns nothing.
+    def released(&block)
+      @up_callback = block
+    end
+
+    # Public: What to do when the button is held.
+    #
+    # block - the block that will be run when the button is held.
+    #
+    # Returns nothing.
+    def held(&block)
+      @hold_callback = block
+    end
+
+    # Internal: The handler for the Pin's read event.
+    #
+    # value - the Integer returned from the read event.
+    #
+    # Returns nothing.
+    def handler(value)
+      if value.zero?
+        @up_callback.call if @up_callback
+      else
+        @last_press = Time.now
+        @down_callback.call if @down_callback
+      end
+
+      if value.zero? && (Time.now - @last_press) > @hold_time
+        @hold_callback.call if @hold_callback
+      end
+    end
+  end
+end

data/lib/wall_e/pin.rb

@@ -1,5 +1,8 @@
+require 'forwardable'
+
 module WallE
   class Pin
+    extend Forwardable
     class UnsupportedModeError < StandardError; end
 
     # Internal: Fixnum byte for pin mode input.
@@ -19,6 +22,8 @@ module WallE
     # Public: Returns the Integer pin number.
     attr_reader :number
 
+    def_delegators :@board, :on, :off, :once
+
     # Public: Initialize a Pin
     #
     # number - the Integer pin number on the board.
@@ -80,5 +85,9 @@ module WallE
     def value
       @onboard_pin.value
     end
+
+    def start_reporting
+      @board.start_pin_reporting
+    end
   end
 end

data/lib/wall_e/version.rb

@@ -1,3 +1,3 @@
 module WallE
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/test/button_test.rb

@@ -0,0 +1,65 @@
+require_relative 'test_helper'
+require_relative '../lib/wall_e/components/button'
+
+class ButtonTest < MiniTest::Unit::TestCase
+  DummyPin = Class.new do
+    def set_mode(mode); end
+    def start_reporting; end
+    def number; 7; end
+    def on(*args); end
+  end
+
+  def test_sets_up_pin
+    pin = MiniTest::Mock.new
+    pin.expect(:set_mode, 1, [WallE::Pin::INPUT])
+    pin.expect(:start_reporting, 1)
+    pin.expect(:number, 7)
+    pin.expect(:on, 1, ['digital-read-7', Method])
+
+    WallE::Button.new(pin)
+
+    pin.verify
+  end
+
+  def test_pressed
+    blk = MiniTest::Mock.new
+    blk.expect(:run, nil)
+
+    button = WallE::Button.new(DummyPin.new)
+    button.pressed { blk.run }
+
+    button.handler(1)
+
+    blk.verify
+  end
+
+  def test_released
+    blk = MiniTest::Mock.new
+    blk.expect(:run, nil)
+
+    button = WallE::Button.new(DummyPin.new)
+    button.released { blk.run }
+
+    button.pressed {  }
+    button.handler(1)
+
+    button.handler(0)
+
+    blk.verify
+  end
+
+  def test_held
+    blk = MiniTest::Mock.new
+    blk.expect(:run, nil)
+
+    button = WallE::Button.new(DummyPin.new, 0.2)
+    button.held { blk.run }
+    button.released { }
+    button.pressed { }
+    button.handler(1)
+    sleep 0.2
+    button.handler(0)
+
+    blk.verify
+  end
+end

data/wall_e.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
 
 
   gem.add_development_dependency("minitest", "~> 3.3.0")
-  gem.add_runtime_dependency("firmata", "~> 0.0.6")
+  gem.add_runtime_dependency("firmata", "~> 0.0.7")
   gem.add_runtime_dependency("event_spitter", "~> 0.5.0")
   gem.add_runtime_dependency("pry", "~> 0.9.10")
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wall_e
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-17 00:00:00.000000000 Z
+date: 2012-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.6
+        version: 0.0.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.6
+        version: 0.0.7
 - !ruby/object:Gem::Dependency
   name: event_spitter
   requirement: !ruby/object:Gem::Requirement
@@ -87,6 +87,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- cookbook/Button/toggle_led.rb
 - cookbook/Led/blink.rb
 - cookbook/Led/fade_in.rb
 - cookbook/Led/fade_out.rb
@@ -94,6 +95,7 @@ files:
 - cookbook/Piezo/morse_code.rb
 - cookbook/Servo/sweep.rb
 - lib/wall_e.rb
+- lib/wall_e/components/button.rb
 - lib/wall_e/components/claw.rb
 - lib/wall_e/components/led.rb
 - lib/wall_e/components/piezo.rb
@@ -102,6 +104,7 @@ files:
 - lib/wall_e/pin.rb
 - lib/wall_e/serial_snoop.rb
 - lib/wall_e/version.rb
+- test/button_test.rb
 - test/claw_test.rb
 - test/led_test.rb
 - test/piezo_test.rb
@@ -135,6 +138,7 @@ signing_key:
 specification_version: 3
 summary: ''
 test_files:
+- test/button_test.rb
 - test/claw_test.rb
 - test/led_test.rb
 - test/piezo_test.rb