artoo-gpio 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6f15ece9258413771b48373fe84031ede8e4b10
-  data.tar.gz: e204b8b578f211085ce1fe2401270f97b4308c9a
+  metadata.gz: 6ddb4de7935782db58aa0534bc5af242e42ff778
+  data.tar.gz: fe10fef77bc40ee9c51feef00ca9db38e91086fc
 SHA512:
-  metadata.gz: 5d26bd20c70395d7d47379e49b0dbac407f8a405dabd8363bb92931e50d7afff07ede23287d4b0ec53ea24c35717fd353f584050ca0296befd608b0c544b5f8d
-  data.tar.gz: 1fc798dbca26e354e06a8bdb2c02200f81a7593e5758f78d39c7498ff1906b796c7a2c314a66e5d1f2ef370b24e230e5cb87cbd1a55aa79b889d8983b17f2220
+  metadata.gz: 212993e748a5f316c3ad7171aa78456b9ce01cd6c4c8f5d9ab07ef5052edf243d3a16c0b220f6f6d4d20640acfed90f7e351e99b03e096446d0c818a8b853e72
+  data.tar.gz: da012ef5b062b3309a4c44dca277bdd2373b5ed0b2b4222fa796ee91095d52cadc6617bd37f106d725709f68344b83197f053cde46e18a0941792789ec1b3256

data/.travis.yml

@@ -1,6 +1,10 @@
 language: ruby
 rvm:
+  - 2.1.0
   - 2.0.0
   - 1.9.3
-  - jruby-19mode
-  - rbx-19mode
+  - jruby-1.7.9
+  - rbx-2.1.1
+matrix:
+  allow_failures:
+    - rvm: jruby-1.7.9

data/Gemfile.lock

@@ -1,53 +1,54 @@
 PATH
   remote: .
   specs:
-    artoo-gpio (0.3.0)
-      artoo (>= 1.4.0)
+    artoo-gpio (0.4.0)
+      artoo (>= 1.6.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.7)
     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)
+    robeaux (0.0.3)
+    slop (3.4.7)
     thor (0.18.1)
     timers (1.1.0)
-    websocket_parser (0.1.4)
-      http
+    websocket_parser (0.1.6)
 
 PLATFORMS
   ruby

data/README.md

@@ -51,18 +51,28 @@ end
 ## Devices supported
 
 The following GPIO hardware devices have Artoo driver support:
+- Analog sensor
 - Button
+- Continuous Servo
 - LED
+- MakeyButton (high-resistance switch influenced by the MakeyMakey ([http://makeymakey.com](http://makeymakey.com)))
 - Maxbotix ultrasonic range finder
-- Analog sensor
 - Motor (DC)
 - Servo
 
-
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+* All patches must be provided under the Apache 2.0 License
+* Please use the -s option in git to "sign off" that the commit is your work and you are providing it under the Apache 2.0 License
+* Submit a Github Pull Request to the appropriate branch and ideally discuss the changes with us in IRC.
+* We will look at the patch, test it out, and give you feedback.
+* Avoid doing minor whitespace changes, renamings, etc. along with merged content. These will be done by the maintainers from time to time but they can complicate merges and should be done seperately.
+* Take care to maintain the existing coding style.
+* Add unit tests for any new or changed functionality.
+* All pull requests should be "fast forward"
+  * If there are commits after yours use “git rebase -i <new_head_branch>”
+  * If you have local changes you may need to use “git stash”
+  * For git help see [progit](http://git-scm.com/book) which is an awesome (and free) book on git
+
+
+(c) 2012-2014 The Hybrid Group

data/artoo-gpio.gemspec

@@ -20,7 +20,7 @@ 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 'artoo', '>= 1.6.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_analog_sensor.md

@@ -0,0 +1,49 @@
+# Commands
+
+## pin 
+
+Returns the pin number set up when creating the sensor.
+
+##### Params
+
+`no params`
+
+##### Returns
+
+`integer`
+
+## upper 
+
+Returns the upper limit set up when creating the sensor.
+
+##### Params
+
+`no params`
+
+##### Returns
+
+`integer`
+
+## lower 
+
+Returns the lower limit set up when creating the sensor.
+
+##### Params
+
+`no params`
+
+##### Returns
+
+`integer`
+
+## analog_read(pin_number) 
+
+Returns an integer value that represents the analog read from the sensor, the value goes from `0` to `1027`.
+
+##### Params
+
+- **pin_number** -  params, the pin value
+
+##### Returns
+
+`integer (from 0 to 1027)`

data/docs/commands_button.md

@@ -0,0 +1,13 @@
+# Commands
+
+## is_pressed? 
+
+Returns true or false matching state of the button.
+
+##### Params
+
+`no params`
+
+##### Returns
+
+`true or false`

data/docs/commands_continuous_servo.md

@@ -0,0 +1,37 @@
+# Commands
+
+## clockwise
+
+Turns the servo to go clockwise, if the driver is continuous.
+
+##### Params
+
+`no params`
+
+##### Returns
+
+`nil`
+
+## counter_clockwise
+
+Turns the servo to go counter clockwise, if the driver is continuous.
+
+##### Params
+
+`no params`
+
+##### Returns
+
+`nil`
+
+## stop
+
+Stops the driver.
+
+##### Params
+
+`no params`
+
+##### Returns
+
+`nil`

data/docs/commands_led.md

@@ -0,0 +1,73 @@
+# Commands
+
+## on 
+
+Turns LED on.
+
+##### Params
+
+`no params`
+
+##### Returns
+
+`true or nil`
+
+## off 
+
+Turns LED off.
+
+##### Params
+
+`no params`
+
+##### Returns
+
+`true or nil`
+
+## on? 
+
+Returns true if LED is on, otherwise returns false.
+
+##### Params
+
+`no params`
+
+##### Returns
+
+`true or false`
+
+## off? 
+
+Returns true if LED is off, otherwise returns false.
+
+##### Params
+
+`no params`
+
+##### Returns
+
+`true or false`
+
+## toggle 
+
+Turns the LED on, or off, depending on if it is already off, or on, respectively.
+
+##### Params
+
+`no params`
+
+##### Returns
+
+`true or nil`
+
+## brightness(brightness_int)
+
+Sets brightness of the led to the specified brightness value passed to brightness(brightness_int) using PWM, brightness can be any integer value between `0` and `255`.
+
+##### Params
+
+- **brightness_int** - params , the brightness value
+
+##### Returns
+
+`true or nil`

data/docs/commands_makey_button.md

@@ -0,0 +1,13 @@
+# Commands
+
+## is_pressed? 
+
+Returns true or false matching state of the button.
+
+##### Params
+
+`no params`
+
+##### Returns
+
+`Returns true or false`

data/docs/commands_maxbotix.md

@@ -0,0 +1,25 @@
+# Commands
+
+## range 
+
+Returns the distance measured by the sonar in inches.
+
+##### Params
+
+`no params`
+
+##### Returns
+
+`distance_in_inches(float)`
+
+## range_cm 
+
+Returns the distance measured by the sonar in cm.
+
+##### Params
+
+`no params`
+
+##### Returns
+
+`distance_in_cm(float)`

data/docs/commands_motor.md

@@ -0,0 +1,157 @@
+# Commands
+
+## stop 
+
+Stops the motor.
+
+##### Params
+
+`no params`
+
+##### Returns
+
+`true or nil`
+
+## start 
+
+Starts the motor.
+
+##### Params
+
+`no params`
+
+##### Returns
+
+`true or nil`
+
+## on?
+
+Returns true if the motor is on, otherwise returns false.
+
+##### Params
+
+`no params`
+
+##### Returns
+
+`true or false`
+
+## off? 
+
+Returns true if the motor is off, otherwise returns false.
+
+##### Params
+
+`no params`
+
+##### Returns
+
+`true or false`
+
+## toggle 
+
+Sets the state of the motor to the oposite of the current state, if motor is on then sets it to off.
+
+##### Params
+
+`no params`
+
+##### Returns
+
+`true or nil`
+
+## speed(speed_value)
+
+Sets the speed of the motor to the value provided in the speed param, speed value must be an integer between `0` and `255`.
+
+##### Params
+
+- **speed_value** - params, the speed value
+
+##### Returns
+
+`true or nil`
+
+## min 
+
+Stops the motor, sets the speed to `0`.
+
+##### Params
+
+`no params`
+
+##### Returns
+
+`true or nil`
+
+## max 
+
+Starts the motor at max speed, sets the speed to `255`.
+
+##### Params
+
+`no params`
+
+##### Returns
+
+`true or nil`
+
+## forward(speed) 
+
+Starts the motor in forward direction at the provided speed.
+
+##### Params
+
+- **speed** - params, the speed value
+
+##### Returns
+
+`true or nil`
+
+## backward(speed)
+
+Starts the motor in backward direction at the provided speed.
+
+##### Params
+
+- **speed** - params, the speed value
+
+##### Returns
+
+`true or nil`
+
+## forward? 
+
+Returns true if the motor is direction is set to forward, otherwise false.
+
+##### Params
+
+`no params`
+
+##### Returns
+
+`true or false`
+
+## backward? 
+
+Returns true if the motor is direction is set to backward, otherwise false.
+
+##### Params
+
+`no params`
+
+##### Returns
+
+`true or false`
+
+## current_speed 
+
+Returns the current speed of the motor as an integer between `0` and `255`.
+
+##### Params
+
+`no params`
+
+##### Returns
+
+`speed`

data/docs/commands_servo.md

@@ -0,0 +1,61 @@
+# Commands
+
+## move(angle)
+
+Moves the servo to the specified angle, angle must be an integer value between `0` and `180`.
+
+##### Params
+
+- ** angle ** - params
+
+##### Returns
+
+`true or nil`
+
+## min
+
+Moves the servo to the angle = `0` position.
+
+##### Params
+
+`no params`
+
+##### Returns
+
+`nil`
+
+## max
+
+Moves the servo to the angle = `180` position.
+
+##### Params
+
+`no params`
+
+##### Returns
+
+`nil`
+
+## center
+
+Moves the servo to the angle = `90` position.
+
+##### Params
+
+`no params`
+
+##### Returns
+
+`nil`
+
+## current_angle 
+
+Returns the current angle of the servo, an integer value between `0` and `180`.
+
+##### Params
+
+`no params`
+
+##### Returns
+
+`integer (0 - 180)`

data/docs/events_analog_sensor.md

@@ -0,0 +1,15 @@
+# Events
+
+The limits that trigger the events are setup when creating the sensor (see above in the section titled "How to stablish a connection and driver" ), there are `:upper` and `:lower` limits, as well as an `:interval` param that defines how often the sensor should be read; when the specified amount of time passes the sensor is read, if one of the limits stablished is reached the corresponging event will be triggered.
+
+## start_driver
+
+Starts the driver.
+
+## :upper
+
+Gets triggered if the value read by the sensor is greater or equal to `:upper` (value passed when setting up the sensor).
+
+## :lower
+
+Gets triggered if the value read by the sensor is less or equal to `:lower` (value passed when setting up the sensor).

data/docs/events_button.md

@@ -0,0 +1,14 @@
+# Events
+
+## start_driver
+
+Starts the driver.
+
+## :push
+
+This event gets triggered when the button changes state from released to pushed.
+
+## :release
+
+This event gets triggered when the button changes state from pushed to released.
+

data/docs/events_makey_button.md

@@ -0,0 +1,14 @@
+# Events
+
+## start_driver
+
+Starts the driver.
+
+## :push
+
+This event gets triggered when the button changes state from released to pushed.
+
+## :release
+
+This event gets triggered when the button changes state from pushed to released.
+

data/docs/events_maxbotix.md

@@ -0,0 +1,11 @@
+# Events
+
+The events will be triggered when the amount of time specified by the param `:interval`, when setting up the driver, passes.
+
+## start_driver
+
+Starts the driver.
+
+## :range
+
+Gets triggered after `:interval` amount of time passes, everytime the range will be read and the event triggered.

data/lib/artoo/drivers/continuous_servo.rb

@@ -0,0 +1,30 @@
+require 'artoo/drivers/driver'
+
+module Artoo
+  module Drivers
+    # ContinuousServo behaviors for Firmata
+    class ContinuousServo < Driver
+      COMMANDS = [:clockwise, :counter_clockwise, :stop].freeze
+
+      # Create new ContinuousServo
+      def initialize(params={})
+        super
+      end
+      
+      # Stops the driver
+      def stop
+        connection.servo_write(pin, 90)
+      end
+
+      # Turns the servo clockwise
+      def clockwise
+        connection.servo_write(pin, 180)
+      end
+
+      # Turns the servo counter clockwise
+      def counter_clockwise
+        connection.servo_write(pin, 89)
+      end
+    end
+  end
+end

data/lib/artoo/drivers/makey_button.rb

@@ -0,0 +1,59 @@
+require 'artoo/drivers/driver'
+
+module Artoo
+  module Drivers
+    # MakeyButton driver behaviors
+    class MakeyButton < Driver
+      COMMANDS = [:is_pressed?].freeze
+
+      DOWN = 1
+      UP = 0
+
+      attr_accessor :data
+
+      def initialize(params={})
+        super
+
+        @data = []
+      end
+
+      # @return [Boolean] True if pressed
+      def is_pressed?
+        (@pressed_val == 1) ? true : false
+      end
+
+      def start_driver
+        @pressed_val = 0
+
+        every(100) do
+          new_value = connection.digital_read(pin)
+          @data << new_value
+          @data.shift
+          update(new_value) if !new_value.nil? && new_value != is_pressed?
+        end
+
+        super
+      end
+
+      private
+      # Publishes events according to the button feedback
+      def update
+        if average_data > 0.5 and not is_pressed?
+          @pressed_val = 1
+          publish(event_topic_name("update"), "push", new_val)
+          publish(event_topic_name("push"), new_val)
+        elsif average_data <= 0.5 and is_pressed?
+          @pressed_val = 0
+          publish(event_topic_name("update"), "release", new_val)
+          publish(event_topic_name("release"), new_val)
+        end
+      end
+      
+      #Averages data received
+      def average_data
+        return 0 unless @data.any?
+        @data.inject(:+) / @data.size.to_f
+      end
+    end
+  end
+end

data/lib/artoo-gpio/version.rb

@@ -1,5 +1,5 @@
 module Artoo
   module Gpio
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
   end
 end

data/test/drivers/continuous_servo_test.rb

@@ -0,0 +1,34 @@
+require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
+require 'artoo/drivers/continuous_servo'
+
+describe Artoo::Drivers::ContinuousServo do
+  before do
+    @device = mock('device')
+    @device.stubs(:pin).returns(3)
+    @servo = Artoo::Drivers::ContinuousServo.new(:parent => @device)
+
+    @connection = mock('connection')
+    @device.stubs(:connection).returns(@connection)
+  end
+
+  describe 'ContinuousServo#stop' do
+    it 'stops the driver' do
+      @connection.expects(:servo_write).with(3, 90)
+      @servo.stop
+    end
+  end
+
+  describe 'ContinuousServo#clockwise' do
+    it 'turns the servo clockwise' do
+      @connection.expects(:servo_write).with(3, 180)
+      @servo.clockwise
+    end
+  end
+
+  describe 'ContinuousServo#counter_clockwise' do
+    it 'turns the servo counter clockwise' do
+      @connection.expects(:servo_write).with(3, 89)
+      @servo.counter_clockwise
+    end
+  end
+end

data/test/drivers/makey_button_test.rb

@@ -0,0 +1,55 @@
+require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
+require 'artoo/drivers/makey_button'
+
+describe Artoo::Drivers::MakeyButton do
+  before do
+    @device = mock('device')
+    @pin = 0
+    @device.stubs(:pin).returns(@pin)
+    @makey = Artoo::Drivers::MakeyButton.new(:parent => @device)
+    @connection = mock('connection')
+    @device.stubs(:connection).returns(@connection)
+  end
+
+  describe 'MakeyButton#is_pressed?' do
+    it 'should return true when pressed' do
+      @makey.instance_variable_set(:@pressed_val, 1)
+      @makey.is_pressed?.must_equal true
+    end
+
+    it 'should return false when not pressed' do
+      @makey.instance_variable_set(:@pressed_val, 0)
+      @makey.is_pressed?.must_equal false
+    end
+  end
+
+  describe 'MakeyButton#average_data' do
+    it 'returns 0 if no data' do
+      @makey.instance_variable_set(:@data, [])
+      @makey.send(:average_data).must_equal 0
+    end
+
+    it 'returns average if data present' do
+      @makey.instance_variable_set(:@data, [1,2,3])
+      @makey.send(:average_data).must_equal 2.0
+    end
+  end
+
+  describe 'MakeyButton#update' do
+    it 'publishes a push when pushed' do
+      @makey.stubs(:average_data).returns(0.6)
+      @makey.stubs(:is_pressed?).returns(false)
+      @device.expects(:event_topic_name).with('update')
+      @device.expects(:event_topic_name).with('push')
+      @makey.send(:update)
+    end
+
+    it 'publishes a release when released' do
+      @makey.stubs(:average_data).returns(0.4)
+      @makey.stubs(:is_pressed?).returns(true)
+      @device.expects(:event_topic_name).with('update')
+      @device.expects(:event_topic_name).with('release')
+      @makey.send(:update)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: artoo-gpio
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ron Evans
@@ -11,7 +11,7 @@ authors:
 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
@@ -19,14 +19,14 @@ dependencies:
     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: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -77,7 +77,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .rvmrc
 - .travis.yml
 - Gemfile
 - Gemfile.lock
@@ -85,15 +84,31 @@ files:
 - README.md
 - Rakefile
 - artoo-gpio.gemspec
+- docs/commands_analog_sensor.md
+- docs/commands_button.md
+- docs/commands_continuous_servo.md
+- docs/commands_led.md
+- docs/commands_makey_button.md
+- docs/commands_maxbotix.md
+- docs/commands_motor.md
+- docs/commands_servo.md
+- docs/events_analog_sensor.md
+- docs/events_button.md
+- docs/events_makey_button.md
+- docs/events_maxbotix.md
 - lib/artoo-gpio.rb
 - lib/artoo-gpio/version.rb
 - lib/artoo/drivers/analog_sensor.rb
 - lib/artoo/drivers/button.rb
+- lib/artoo/drivers/continuous_servo.rb
 - lib/artoo/drivers/led.rb
+- lib/artoo/drivers/makey_button.rb
 - lib/artoo/drivers/maxbotix.rb
 - lib/artoo/drivers/motor.rb
 - lib/artoo/drivers/servo.rb
+- test/drivers/continuous_servo_test.rb
 - test/drivers/led_test.rb
+- test/drivers/makey_button_test.rb
 - test/drivers/maxbotix_test.rb
 - test/drivers/motor_test.rb
 - test/drivers/servo_test.rb
@@ -118,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: artoo-gpio
-rubygems_version: 2.0.3
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Artoo standard drivers for GPIO devices

data/.rvmrc

@@ -1 +0,0 @@
-rvm use 1.9.3@artoo-gpio --create