artoo-arduino 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e99b8d72a5ef6f50399e41d98bdb430ac6c389e
-  data.tar.gz: 70b8875c3af5a261715c2e407d4c2ace7f498740
+  metadata.gz: ef22f258fe9188bda778e5d12dc5fed59304a739
+  data.tar.gz: 3cd46e7b4f6f46f6c0587f1c1f12b37c30eeafd4
 SHA512:
-  metadata.gz: 8809c09890418839551d643e735b2ad89397357712b8ba0310cda7e3ec76e5def5facd9179c731afc5a461305d620a768296ae4450a7297472b855472361c142
-  data.tar.gz: 0ae662eeeb16b7bc0a51d7855c750a5eb5985435bdab553b9882905ba0624f913590cc62486d12492db63416ffa42e69dc5440c18e798e87d3501f87665772d0
+  metadata.gz: 3d45b5612b574ac27c67ee28168d9930ea0fca8c89a3b4cab3fc2e0baa682d8f0abfa4b57f4a32a60b6a2b6615885d79526cae61f923b17d5d86a3dd3f2d4f0e
+  data.tar.gz: c56c99b937db47126b573e1901da2415ca430e531ba49a3c5072bf58f13b7348f07ba65457fdd60d628db9474f50794fcd8fb9f0a684b1d8762e8e8e8358b23c

data/Gemfile.lock

@@ -1,58 +1,56 @@
 PATH
   remote: .
   specs:
-    artoo-arduino (1.1.0)
-      artoo (~> 1.1.0)
+    artoo-arduino (1.2.0)
+      artoo (~> 1.2.0)
+      artoo-gpio
+      artoo-i2c
       hybridgroup-firmata (~> 0.4.5)
-      littlewire (~> 0.9.7)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    artoo (1.1.0)
+    artoo (1.2.1)
       celluloid (~> 0.15.0)
       celluloid-io (~> 0.15.0)
       multi_json (~> 1.6)
       pry (~> 0.9)
       rake (~> 10.0)
-      reel (~> 0.4.0.pre)
+      reel (~> 0.4.0)
       thor (~> 0.18.1)
+    artoo-gpio (0.2.0)
+      artoo (~> 1.2.0)
+    artoo-i2c (0.2.0)
+      artoo (~> 1.2.0)
     celluloid (0.15.1)
       timers (~> 1.1.0)
     celluloid-io (0.15.0)
       celluloid (>= 0.15.0)
       nio4r (>= 0.5.0)
     coderay (1.0.9)
-    colorist (0.0.2)
     event_emitter (0.2.5)
-    ffi (1.9.0)
-    http (0.5.0.pre)
+    http (0.5.0)
       http_parser.rb
     http_parser.rb (0.6.0.beta.2)
     hybridgroup-firmata (0.4.5)
       event_emitter
-    libusb (0.3.4)
-      ffi (>= 1.0)
-    littlewire (0.9.7)
-      colorist (>= 0.0.2)
-      libusb (>= 0.2.0)
     metaclass (0.0.1)
     method_source (0.8.2)
     minitest (5.0.1)
     minitest-happy (1.0.0)
     mocha (0.14.0)
       metaclass (~> 0.0.1)
-    multi_json (1.7.9)
+    multi_json (1.8.0)
     nio4r (0.5.0)
     pry (0.9.12.2)
       coderay (~> 1.0.5)
       method_source (~> 0.8)
       slop (~> 3.4)
     rake (10.1.0)
-    reel (0.4.0.pre4)
-      celluloid (>= 0.15.0)
+    reel (0.4.0)
+      celluloid (>= 0.15.1)
       celluloid-io (>= 0.15.0)
-      http (>= 0.5.0.pre)
+      http (>= 0.5.0)
       http_parser.rb (>= 0.6.0.beta.2)
       websocket_parser (>= 0.1.4)
     slop (3.4.6)

data/README.md

@@ -1,6 +1,6 @@
 # Artoo Adaptor For Arduino
 
-This repository contains the Artoo (http://artoo.io/) adaptor and drivers for Arduino and Arduino-compatible microcontrollers (http://arduino.cc/) using either the Firmata protocol (http://firmata.org) or the Little Wire protocol (http://littlewire.cc).
+This repository contains the Artoo (http://artoo.io/) adaptor and drivers for Arduino and Arduino-compatible microcontrollers (http://arduino.cc/) using the Firmata protocol (http://firmata.org).
 
 Artoo is a open source micro-framework for robotics using Ruby.
 
@@ -10,8 +10,6 @@ For more information abut Artoo, check out our repo at https://github.com/hybrid
 
 This gem makes extensive use of the hybridgroup fork of the firmata gem (https://github.com/hybridgroup/firmata) thanks to [@hardbap](https://github.com/hardbap) with code borrrowed from the arduino_firmata gem (https://github.com/shokai/arduino_firmata) thanks to [@shokai](https://github.com/shokai)
 
-It also makes extensive use of the littlewire.rb gem (https://github.com/Bluebie/littlewire.rb) thanks to [@Bluebie](https://github.com/Bluebie)
-
 ## Installing
 
 ```
@@ -24,7 +22,7 @@ gem install artoo-arduino
 require 'artoo'
 
 connection :arduino, :adaptor => :firmata, :port => '127.0.0.1:8023'
-device :board
+device :board, :driver => :device_info
 device :led, :driver => :led, :pin => 13
 
 work do
@@ -38,14 +36,17 @@ end
 
 ## Devices supported
 
-The following hardware devices have driver support:
+The following hardware devices have driver support via the artoo-gpio gem:
 - Button
 - LED
 - Maxbotix ultrasonic range finder
+- Analog sensor
 - Motor (DC)
 - Servo
-- Wiichuck controller (via i2c)
-- Wiiclassic controller (via i2c)
+
+The following hardware devices have driver support via the artoo-i2c gem:
+- Wiichuck controller
+- Wiiclassic controller
 
 ## Connecting to Arduino
 
@@ -96,62 +97,6 @@ artoo connect serial ttyACM0 4567
 
 Someone please fill in the blanks here...
 
-## Connecting to Digispark
-
-You can use Artoo with a Digispark (http://www.kickstarter.com/projects/digistump/digispark-the-tiny-arduino-enabled-usb-dev-board) ATTiny-based USB development board, that has the Little Wire (http://littlewire.cc/) protocol firmware installed. For instructions on how to install Little Wire on a Digispark check out http://digistump.com/board/index.php/topic,160.0.html
-
-### OSX
-
-The main steps are:
-- Plug in the Digispark to the USB port
-- Connect to the device via Artoo
-
-First plug the Digispark into your computer via the USB port. Then... (directions go here)
-
-### Ubuntu
-
-The main steps are:
-- Add a udev rule to allow access to the Digispark device
-- Plug in the Digispark to the USB port
-- Connect to the device via Artoo
-
-First, you must add a udev rule, so that Artoo can communicate with the USB device. Ubuntu and other modern Linux distibutions use udev to manage device files when USB devices are added and removed. By default, udev will create a device with read-only permission which will not allow to you download code. You must place the udev rules below into a file named /etc/udev/rules.d/49-micronucleus.rules.
-
-```
-# UDEV Rules for Micronucleus boards including the Digispark.
-# This file must be placed at:
-#
-# /etc/udev/rules.d/49-micronucleus.rules    (preferred location)
-#   or
-# /lib/udev/rules.d/49-micronucleus.rules    (req'd on some broken systems)
-#
-# After this file is copied, physically unplug and reconnect the board.
-#
-SUBSYSTEMS=="usb", ATTRS{idVendor}=="1781", ATTRS{idProduct}=="0c9f", MODE:="0666"
-KERNEL=="ttyACM*", ATTRS{idVendor}=="1781", ATTRS{idProduct}=="0c9f", MODE:="0666", ENV{ID_MM_DEVICE_IGNORE}="1"
-#
-# If you share your linux system with other users, or just don't like the
-# idea of write permission for everybody, you can replace MODE:="0666" with
-# OWNER:="yourusername" to create the device owned by you, or with
-# GROUP:="somegroupname" and mange access using standard unix groups.
-```
-
-Thanks to [@bluebie](https://github.com/Bluebie) for these instructions! (https://github.com/Bluebie/micronucleus-t85/wiki/Ubuntu-Linux)
-
-Now plug the Digispark into your computer via the USB port.
-
-Once plugged in, use the `artoo connect scan` command with the  `-t usb` option to verify your connection info:
-
-```
-$ artoo connect scan -t usb
-```
-
-Now use the `ID` info returned to find the `product` and `vendor` ID's for the connection info Digispark in your Artoo code.
-
-### Windows
-
-Someone please fill in the blanks here...
-
 ## Contributing
 
 1. Fork it

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", "Rafael Magaña"]
+  s.authors     = ["Ron Evans", "Adrian Zankich", "Rafael Magaña", "Edgar Silva"]
   s.email       = ["artoo@hybridgroup.com"]
   s.homepage    = "https://github.com/hybridgroup/artoo-arduino"
   s.summary     = %q{Artoo adaptor and driver for Arduino}
@@ -20,9 +20,10 @@ 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.1.0'
+  s.add_runtime_dependency 'artoo', '~> 1.2.0'
+  s.add_runtime_dependency 'artoo-gpio'
+  s.add_runtime_dependency 'artoo-i2c'
   s.add_runtime_dependency 'hybridgroup-firmata', '~> 0.4.5'
-  s.add_runtime_dependency 'littlewire', '~> 0.9.7'
   s.add_development_dependency 'minitest', '~> 5.0'
   s.add_development_dependency 'minitest-happy'
   s.add_development_dependency 'mocha', '~> 0.14.0'

data/examples/analog_sensor.rb

@@ -0,0 +1,31 @@
+require 'artoo'
+
+# Substitute the button with an analog sensor like a photoresistor and 
+# change to the correct analog input, in this case pin A0.
+# 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'
+
+# Analog inputs are based from 0 to 5 on the Arduino UNO, may vary on other arduino boards
+device :sensor, driver: :analog_sensor, pin: 0, interval: 0.25, upper: 900, lower: 200
+device :led, :driver => :led, :pin => 8
+
+work do
+  puts
+  puts "Reading sensor in analog pin #{ sensor.pin }"
+  puts "Reading intervals every => #{ sensor.interval }"
+  puts "Initial sensor value => #{ sensor.analog_read(0) }"
+  puts "Sensor upper trigger set at value => #{ sensor.upper }"
+  puts "Sensor lower trigger set at value => #{ sensor.lower }"
+
+  on sensor, :upper => proc {
+    puts "UPPER LIMIT REACHED!"
+    led.off
+  }
+
+  on sensor, :lower => proc {
+    puts "LOWER SENSOR LIMIT REACHED!"
+    led.on
+  }
+end

data/examples/{firmata_blink_led.rb → blink_led.rb}

@@ -4,7 +4,7 @@ require 'artoo'
 
 #connection :firmata, :adaptor => :firmata, :port => '/dev/tty*'
 connection :firmata, :adaptor => :firmata, :port => '127.0.0.1:4567'
-device :board, :driver => :board
+device :board, :driver => :device_info
 device :led, :driver => :led, :pin => 13
 
 work do

data/examples/{firmata_blink_led_with_toggle.rb → blink_led_with_toggle.rb}

@@ -4,7 +4,7 @@ require 'artoo'
 
 #connection :firmata, :adaptor => :firmata, :port => '/dev/tty*'
 connection :firmata, :adaptor => :firmata, :port => '127.0.0.1:8023'
-device :board, :driver => :board
+device :board, :driver => :device_info
 device :led, :driver => :led, :pin => 13
 
 work do

data/examples/{firmata_dc_motor_speed.rb → dc_motor_speed.rb}

@@ -4,7 +4,7 @@ require 'artoo'
 
 #connection :firmata, :adaptor => :firmata, :port => '/dev/tty*'
 connection :firmata, :adaptor => :firmata, :port => '127.0.0.1:4567'
-device :board, :driver => :board
+device :board, :driver => :device_info
 device :motor, :driver => :motor, :speed_pin => 3 # Use a PWM pin
 
 work do

data/examples/{firmata_dc_motor_speed_h-bridge_2_pins.rb → dc_motor_speed_h-bridge_2_pins.rb}

@@ -5,7 +5,7 @@ require 'artoo'
 
 #connection :firmata, :adaptor => :firmata, :port => '/dev/tty*'
 connection :firmata, :adaptor => :firmata, :port => '127.0.0.1:8023'
-device :board, :driver => :board
+device :board, :driver => :device_info
 device :motor, :driver => :motor, 
                :forward_pin  => 4, # Digital or PWM pin
                :backward_pin => 2, # Digital or PWM pin

data/examples/{firmata_dc_motor_switch.rb → dc_motor_switch.rb}

@@ -4,7 +4,7 @@ require 'artoo'
 
 #connection :firmata, :adaptor => :firmata, :port => '/dev/tty*'
 connection :firmata, :adaptor => :firmata, :port => '127.0.0.1:8023'
-device :board, :driver => :board
+device :board, :driver => :device_info
 device :motor, :driver => :motor, :switch_pin => 3 # Use a digital or PWM pin
 
 work do

data/examples/{firmata_dc_motor_switch_h-bridge_2_pins.rb → dc_motor_switch_h-bridge_2_pins.rb}

@@ -6,7 +6,7 @@ require 'artoo'
 
 #connection :firmata, :adaptor => :firmata, :port => '/dev/tty*'
 connection :firmata, :adaptor => :firmata, :port => '127.0.0.1:8023'
-device :board, :driver => :board
+device :board, :driver => :device_info
 device :motor, :driver => :motor, :forward_pin => 4, :backward_pin => 2
 
 work do

data/examples/{firmata_led_brightness.rb → led_brightness.rb}

@@ -4,7 +4,7 @@ require 'artoo'
 
 #connection :firmata, :adaptor => :firmata, :port => '/dev/tty*'
 connection :firmata, :adaptor => :firmata, :port => '127.0.0.1:8023'
-device :board, :driver => :board
+device :board, :driver => :device_info
 device :led, :driver => :led, :pin => 3
 
 brightness = 0

data/examples/led_brightness_with_analog_input.rb

@@ -0,0 +1,29 @@
+require 'artoo'
+
+# For LED brightness:
+# Circuit and schematic here: http://arduino.cc/en/Tutorial/Fade
+#
+# For Analog Input:
+# Substitute the button with an analog sensor like a photoresistor and 
+# change to the correct analog input, in this case pin A0.
+# 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 :sensor, driver: :analog_sensor, pin: 0, interval: 0
+device :led, :driver => :led, :pin => 3
+
+ai_pin = 0
+
+work do
+  puts "Reading sensor in analog pin #{ sensor.pin }"
+  puts "Reading analog sensor intervals every => #{ sensor.interval }"
+
+  every(0.25) do
+    analog_read = sensor.analog_read(ai_pin)
+    brightness_val = analog_read.to_pwm_reverse
+    puts "Analog Read => #{ analog_read }"
+    puts "brightness val => #{ brightness_val }"
+    led.brightness(brightness_val)
+  end
+end

data/examples/{firmata_led_with_button_toggle.rb → led_with_button_toggle.rb}

@@ -4,7 +4,7 @@ require 'artoo'
 
 #connection :firmata, :adaptor => :firmata, :port => '/dev/tty*'
 connection :firmata, :adaptor => :firmata, :port => '127.0.0.1:8023'
-device :led, :driver => :led, :pin => 13
+device :led, :driver => :device_info, :pin => 13
 device :button, :driver => :button, :pin => 2, :interval => 0.01
 
 work do

data/examples/{firmata_maxbotix.rb → maxbotix.rb}

@@ -4,8 +4,8 @@ require 'artoo'
 
 #connection :firmata, :adaptor => :firmata, :port => '/dev/ttyACM0'
 connection :firmata, :adaptor => :firmata, :port => '127.0.0.1:4567'
-device :sonar, :driver => :maxbotix, :pin => 14, :interval => 0.5
-device :board, :driver => :board
+device :sonar, :driver => :maxbotix, :pin => 0, :interval => 0.5
+device :board, :driver => :device_info
 
 work do
   on sonar, :range => :sonar_reading

data/examples/{firmata_motor.rb → motor.rb}

@@ -9,7 +9,7 @@ forward = true
 
 #connection :firmata, :adaptor => :firmata, :port => '/dev/tty*'
 connection :firmata, :adaptor => :firmata, :port => '127.0.0.1:8023'
-device :board, :driver => :board
+device :board, :driver => :device_info
 device :motor, :driver => :motor, :pin => [leg1_pin, leg2_pin, speed_pin]
 
 work do

data/examples/motor_speed_with_analog_input.rb

@@ -0,0 +1,30 @@
+require 'artoo'
+# For motor speed output:
+# Circuit's breadboard layout here: http://learn.adafruit.com/adafruit-arduino-lesson-13-dc-motors/breadboard-layout
+#
+# For the analog input:
+# Substitute the button with an analog sensor like a photoresistor and 
+# change to the correct analog input, in this case pin A0.
+# 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 :sensor, driver: :analog_sensor, pin: 0, interval: 0
+device :motor, :driver => :motor, :speed_pin => 3 # Use a PWM pin
+
+ai_pin = 0
+
+work do
+
+  puts "Reading sensor in analog pin #{ sensor.pin }"
+  puts "Reading intervals every => #{ sensor.interval }"
+
+  every(0.25) do
+    analog_read = sensor.analog_read(ai_pin)
+    motor_speed = analog_read.to_pwm
+    puts "Analog Read => #{ analog_read }"
+    puts "Motor Speed => #{ motor_speed }"
+    motor.speed(motor_speed)
+  end
+
+end 

data/examples/{firmata_servo.rb → servo.rb}

@@ -4,7 +4,7 @@ require 'artoo'
 
 #connection :firmata, :adaptor => :firmata, :port => '/dev/tty*'
 connection :firmata, :adaptor => :firmata, :port => '127.0.0.1:8023'
-device :board, :driver => :board
+device :board, :driver => :device_info
 device :servo, :driver => :servo, :pin => 3 # pin must be a PWM pin
 
 work do

data/lib/artoo-arduino/version.rb

@@ -1,5 +1,5 @@
 module Artoo
   module Arduino
-    VERSION = '1.1.0'
+    VERSION = '1.2.0'
   end
 end

data/lib/artoo/adaptors/firmata.rb

@@ -5,7 +5,7 @@ module Artoo
     # 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
+      attr_reader :firmata, :i2c_address
 
       # Creates connection with firmata board
       # @return [Boolean]
@@ -24,6 +24,16 @@ module Artoo
         super
       end
 
+      # device info interface
+      def firmware_name
+        firmata.firmware_name
+      end
+
+      def version
+        firmata.version
+      end
+
+      # GPIO - digital
       def digital_write(pin, level)
         firmata.set_pin_mode(pin, ::Firmata::PinModes::OUTPUT)
         firmata.digital_write(pin, convert_level(level))
@@ -41,34 +51,66 @@ module Artoo
         end
         value
       end
+      
+      # GPIO - analog
+      # NOTE pins are numbered A0-A5, which translate to digital pins 14-19
+      def analog_read(pin)
+        firmata.set_pin_mode(digital_pin(pin), ::Firmata::PinModes::ANALOG)
+        firmata.toggle_pin_reporting(digital_pin(pin))
+        firmata.read_and_process
+
+        value = 0
+        while i = find_event("analog_read_#{pin}") do
+          event = events.slice!(i)
+          value = event.data.first if !event.nil?
+        end
+        value
+      end
 
+      def digital_pin(pin = 0)
+        pin + 14
+      end
+
+      # GPIO - PWM
       def pwm_write(pin, level)
         firmata.set_pin_mode(pin, ::Firmata::PinModes::PWM)
         firmata.analog_write(pin, level)
       end
 
+      # GPIO - servo
       def servo_write(pin, angle)
         firmata.set_pin_mode(pin, ::Firmata::PinModes::SERVO)
         firmata.analog_write(pin, angle)
       end
 
-      def analog_read(pin)
-        firmata.set_pin_mode(pin, ::Firmata::PinModes::ANALOG)
-        firmata.toggle_pin_reporting(pin)
+      # i2c interface
+      def i2c_start(address)
+        @i2c_address = address
+
+        firmata.i2c_config(0)
+      end
+
+      def i2c_end
+        
+      end
+
+      def i2c_read(size)
+        firmata.i2c_read_request(i2c_address, size)
         firmata.read_and_process
 
-        value = 0
-        while i = find_event("analog_read_#{to_analog_pin(pin)}") do
+        value = []
+        while i = find_event(:i2c_reply) do
           event = events.slice!(i)
-          value = event.data.first if !event.nil?
+          value = event.data.first[:data] if !event.nil?
         end
         value
       end
 
-      def to_analog_pin(pin)
-        pin - 14
+      def i2c_write(*data)
+        firmata.i2c_write_request(i2c_address, *data)
       end
 
+      # helpers
       def find_event(name)
         events.index {|e| e.name == name.to_sym }
       end