arduino_firmata 0.0.3 → 0.0.4

data/History.txt

@@ -1,3 +1,7 @@
+=== 0.0.4 2012-10-24
+
+* use ArduinoFirmata.connect
+
 === 0.0.3 2012-10-24
 
 * get ArduinoFirmata::list on ubuntu

data/Manifest.txt

@@ -6,6 +6,7 @@ Manifest.txt
 README.rdoc
 Rakefile
 lib/arduino_firmata.rb
+lib/arduino_firmata/arduino.rb
 lib/arduino_firmata/const.rb
 lib/arduino_firmata/main.rb
 samples/README.md

data/README.rdoc

@@ -1,6 +1,6 @@
 = arduino_firmata
 
-* http://github.com/shokai/arduino-firmata-ruby
+* http://github.com/shokai/arduino_firmata
 
 == INSTALL:
 
@@ -12,11 +12,11 @@ Arduino Firmata protocol (http://firmata.org) implementation on Ruby.
 
 == SYNOPSIS:
 
-  arduino = ArduinoFirmata::Arduino.new
+  arduino = ArduinoFirmata.connect
 
 or
 
-  arduino = ArduinoFirmata::Arduino.new '/dev/tty.usb-device-name'
+  arduino = ArduinoFirmata.connect '/dev/tty.usb-device-name'
 
 Board Version
 
@@ -46,7 +46,7 @@ Analog Read
 
   puts arduino.analog_read 0  # => 0 ~ 1023
 
-see samples https://github.com/shokai/arduino-firmata-ruby/tree/gem/samples
+see samples https://github.com/shokai/arduino_firmata/tree/gem/samples
 
 == REQUIREMENTS:
 

data/lib/arduino_firmata.rb

@@ -1,9 +1,12 @@
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
-require 'arduino_firmata/const'
+require 'serialport'
+require 'stringio'
 require 'arduino_firmata/main'
+require 'arduino_firmata/const'
+require 'arduino_firmata/arduino'
 
 module ArduinoFirmata
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/lib/arduino_firmata/arduino.rb

@@ -0,0 +1,132 @@
+module ArduinoFirmata
+
+  class Arduino
+
+    attr_reader :version
+
+    def initialize(serial_name, params)
+      @wait_for_data = 0
+      @execute_multi_byte_command = 0
+      @multi_byte_channel = 0
+      @stored_input_data = []
+      @parsing_sysex = false
+      @sysex_bytes_read
+
+      @digital_output_data = Array.new(16, 0)
+      @digital_input_data = Array.new(16, 0)
+      @analog_input_data = Array.new(16, 0)
+
+      @version = nil
+
+      @serial = SerialPort.new(serial_name, params[:bps], params[:bit], params[:stopbit], params[:parity])
+      sleep 3
+
+      Thread.new{
+        loop do
+          process_input
+          sleep 0.1
+        end
+      }.run
+
+      (0...6).each do |i|
+        write(REPORT_ANALOG | i)
+        write 1
+      end
+      (0...2).each do |i|
+        write(REPORT_DIGITAL | i)
+        write 1
+      end
+
+      loop do
+        break if @version
+        sleep 0.3
+      end
+      sleep 0.5
+
+    end
+
+    def digital_read(pin)
+      (@digital_input_data[pin >> 3] >> (pin & 0x07)) & 0x01 > 0
+    end
+
+    def analog_read(pin)
+      @analog_input_data[pin]
+    end
+
+    def pin_mode(pin, mode)
+      write SET_PIN_MODE
+      write pin
+      write mode
+    end
+
+    def digital_write(pin, value)
+      port_num = (pin >> 3) & 0x0F
+      if value == 0 or value == true
+        @digital_output_data[port_num] &= ~(1 << (pin & 0x07))
+      else
+        @digital_output_data[port_num] |= (1 << (pin & 0x07))
+      end
+
+      write(DIGITAL_MESSAGE | port_num)
+      write(@digital_output_data[port_num] & 0x7F)
+      write(@digital_output_data[port_num] >> 7)
+    end
+
+    def analog_write(pin, value)
+      pin_mode pin, PWM
+      write(ANALOG_MESSAGE | (pin & 0x0F))
+      write(value & 0x7F)
+      write(value >> 7)
+    end
+
+    private
+    def write(cmd)
+      @serial.write_nonblock cmd.chr
+    end
+
+    def read
+      @serial.read_nonblock 9600 rescue EOFError
+    end
+
+    def process_input
+      StringIO.new(String read).bytes.each do |input_data|
+        command = nil
+
+        if @parsing_sysex
+          if input_data == END_SYSEX
+            @parsing_sysex = FALSE
+          else
+            @stored_input_data[@sysex_bytes_read] = input_data
+            @sysex_bytes_read += 1
+          end
+        elsif @wait_for_data > 0 and input_data < 128
+          @wait_for_data -= 1
+          @stored_input_data[@wait_for_data] = input_data
+          if @execute_multi_byte_command != 0 and @wait_for_data == 0
+            case @execute_multi_byte_command
+            when DIGITAL_MESSAGE
+              @digital_input_data[@multi_byte_channel] = (@stored_input_data[0] << 7) + @stored_input_data[1]
+            when ANALOG_MESSAGE
+              @analog_input_data[@multi_byte_channel] = (@stored_input_data[0] << 7) + @stored_input_data[1]
+            when REPORT_VERSION
+              @version = "#{@stored_input_data[1]}.#{@stored_input_data[0]}"
+            end
+          end
+        else
+          if input_data < 0xF0
+            command = input_data & 0xF0
+            @multi_byte_channel = input_data & 0x0F
+          else
+            command = input_data
+          end
+          if [DIGITAL_MESSAGE, ANALOG_MESSAGE, REPORT_VERSION].include? command
+            @wait_for_data = 2
+            @execute_multi_byte_command = command
+          end
+        end
+      end
+    end
+    
+  end
+  
+end

data/lib/arduino_firmata/const.rb

@@ -1,7 +1,14 @@
 module ArduinoFirmata
 
-  def self.list
-    Dir.entries('/dev').grep(/tty\.?usb/i).map{|fname| "/dev/#{fname}"}
+  class Params
+    def self.default
+      {
+        :bps => 57600,
+        :bit => 8,
+        :parity => 0,
+        :stopbit => 1
+      }
+    end
   end
 
   INPUT  = 0

data/lib/arduino_firmata/main.rb

@@ -1,136 +1,17 @@
-require 'serialport'
-require 'stringio'
-
 module ArduinoFirmata
 
-  class Arduino
-
-    attr_reader :version
-
-    def initialize(serial_name=nil, bps=57600)
-      serial_name = ArduinoFirmata.list[0] unless serial_name
-      @wait_for_data = 0
-      @execute_multi_byte_command = 0
-      @multi_byte_channel = 0
-      @stored_input_data = []
-      @parsing_sysex = false
-      @sysex_bytes_read
-
-      @digital_output_data = Array.new(16, 0)
-      @digital_input_data = Array.new(16, 0)
-      @analog_input_data = Array.new(16, 0)
-
-      @version = nil
-
-      @serial = SerialPort.new(serial_name, bps, 8, 1, 0)
-      sleep 3
-
-      Thread.new{
-        loop do
-          process_input
-          sleep 0.1
-        end
-      }.run
-
-      (0...6).each do |i|
-        write(REPORT_ANALOG | i)
-        write 1
-      end
-      (0...2).each do |i|
-        write(REPORT_DIGITAL | i)
-        write 1
-      end
-
-      loop do
-        break if @version
-        sleep 0.3
-      end
-      sleep 0.5
-
-    end
-
-    def digital_read(pin)
-      (@digital_input_data[pin >> 3] >> (pin & 0x07)) & 0x01 > 0
-    end
-
-    def analog_read(pin)
-      @analog_input_data[pin]
-    end
-
-    def pin_mode(pin, mode)
-      write SET_PIN_MODE
-      write pin
-      write mode
-    end
-
-    def digital_write(pin, value)
-      port_num = (pin >> 3) & 0x0F
-      if value == 0 or value == true
-        @digital_output_data[port_num] &= ~(1 << (pin & 0x07))
-      else
-        @digital_output_data[port_num] |= (1 << (pin & 0x07))
-      end
-
-      write(DIGITAL_MESSAGE | port_num)
-      write(@digital_output_data[port_num] & 0x7F)
-      write(@digital_output_data[port_num] >> 7)
-    end
-
-    def analog_write(pin, value)
-      pin_mode pin, PWM
-      write(ANALOG_MESSAGE | (pin & 0x0F))
-      write(value & 0x7F)
-      write(value >> 7)
-    end
+  def self.list
+    Dir.entries('/dev').grep(/tty\.?usb/i).map{|fname| "/dev/#{fname}"}
+  end
 
-    private
-    def write(cmd)
-      @serial.write_nonblock cmd.chr
-    end
+  def self.connect(serial_name=nil, params={})
+    serial_name = self.list[0] unless serial_name
 
-    def read
-      @serial.read_nonblock 9600 rescue EOFError
+    Params.default.each do |k,v|
+      params[k] = v unless params[k]
     end
 
-    def process_input
-      StringIO.new(String read).bytes.each do |input_data|
-        command = nil
-
-        if @parsing_sysex
-          if input_data == END_SYSEX
-            @parsing_sysex = FALSE
-          else
-            @stored_input_data[@sysex_bytes_read] = input_data
-            @sysex_bytes_read += 1
-          end
-        elsif @wait_for_data > 0 and input_data < 128
-          @wait_for_data -= 1
-          @stored_input_data[@wait_for_data] = input_data
-          if @execute_multi_byte_command != 0 and @wait_for_data == 0
-            case @execute_multi_byte_command
-            when DIGITAL_MESSAGE
-              @digital_input_data[@multi_byte_channel] = (@stored_input_data[0] << 7) + @stored_input_data[1]
-            when ANALOG_MESSAGE
-              @analog_input_data[@multi_byte_channel] = (@stored_input_data[0] << 7) + @stored_input_data[1]
-            when REPORT_VERSION
-              @version = "#{@stored_input_data[1]}.#{@stored_input_data[0]}"
-            end
-          end
-        else
-          if input_data < 0xF0
-            command = input_data & 0xF0
-            @multi_byte_channel = input_data & 0x0F
-          else
-            command = input_data
-          end
-          if [DIGITAL_MESSAGE, ANALOG_MESSAGE, REPORT_VERSION].include? command
-            @wait_for_data = 2
-            @execute_multi_byte_command = command
-          end
-        end
-      end
-    end
-    
+    Arduino.new serial_name, params
   end
-  
+
 end

data/samples/README.md

@@ -1 +1,16 @@
-# arduino firmata samples
+# Arduino Firmata Samples
+
+Digital/Analog IO
+-----------------
+- analog_read_write.rb
+- digital_read.rb
+- led_blink.rb
+- led_fade.rb
+
+
+Tweet Temperature
+-----------------
+
+    % gem install tw
+    % tw --user:add
+    % ruby tweet_temperature.rb

data/samples/analog_read_write.rb

@@ -3,11 +3,11 @@ require 'rubygems'
 $:.unshift File.expand_path '../lib', File.dirname(__FILE__)
 require 'arduino_firmata'
 
-arduino = ArduinoFirmata::Arduino.new ARGV.shift
+arduino = ArduinoFirmata.connect ARGV.shift
 
 loop do
   an = arduino.analog_read 0
   puts an
-  arduino.analog_write 9, an/4
+  arduino.analog_write 11, an/4
   sleep 0.1
 end

data/samples/digital_read.rb

@@ -3,7 +3,7 @@ require 'rubygems'
 $:.unshift File.expand_path '../lib', File.dirname(__FILE__)
 require 'arduino_firmata'
 
-arduino = ArduinoFirmata::Arduino.new ARGV.shift
+arduino = ArduinoFirmata.connect ARGV.shift
 
 arduino.pin_mode 7, ArduinoFirmata::INPUT
 

data/samples/led_blink.rb

@@ -3,7 +3,7 @@ require 'rubygems'
 $:.unshift File.expand_path '../lib', File.dirname(__FILE__)
 require 'arduino_firmata'
 
-arduino = ArduinoFirmata::Arduino.new ARGV.shift
+arduino = ArduinoFirmata.connect ARGV.shift
 puts "firmata version #{arduino.version}"
 
 stat = true

data/samples/led_fade.rb

@@ -3,18 +3,20 @@ require 'rubygems'
 $:.unshift File.expand_path '../lib', File.dirname(__FILE__)
 require 'arduino_firmata'
 
-arduino = ArduinoFirmata::Arduino.new ARGV.shift
-pin_num = 9
+arduino = ArduinoFirmata.connect ARGV.shift
+pin_num = 11
 
 loop do
-  puts "0 -> 255"
+  puts "-"*10
   0.upto(255) do |i|
+    puts i
     arduino.analog_write pin_num, i
     sleep 0.01
   end
-  
-  puts "255 -> 0"
+
+  puts "-"*10
   255.downto(0) do |i|
+    puts i
     arduino.analog_write pin_num, i
     sleep 0.01
   end

data/samples/tweet_temperature.rb

@@ -5,7 +5,7 @@ $:.unshift File.expand_path '../lib', File.dirname(__FILE__)
 require 'arduino_firmata'
 require 'tw'
 
-arduino = ArduinoFirmata::Arduino.new
+arduino = ArduinoFirmata.connect
 
 ##  LM35DZ -> Analog 1 PIN
 puts temp = arduino.analog_read(1)*100*5/1024

metadata

@@ -1,96 +1,104 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: arduino_firmata
-version: !ruby/object:Gem::Version
-  version: 0.0.3
+version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 4
+  version: 0.0.4
 platform: ruby
-authors:
+authors: 
 - Sho Hashimoto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-24 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: serialport
-  requirement: !ruby/object:Gem::Requirement
+
+date: 2012-10-24 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 1
+        - 0
         version: 1.1.0
     - - <
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
         version: 2.0.0
   type: :runtime
+  name: serialport
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.1.0
-    - - <
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.10'
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 3
+        - 10
+        version: "3.10"
   type: :development
+  name: rdoc
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.10'
-- !ruby/object:Gem::Dependency
-  name: newgem
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 5
+        - 3
         version: 1.5.3
   type: :development
+  name: newgem
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.5.3
-- !ruby/object:Gem::Dependency
-  name: hoe
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.1'
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 3
+        - 1
+        version: "3.1"
   type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.1'
+  name: hoe
+  version_requirements: *id004
 description: Arduino Firmata protocol (http://firmata.org) implementation on Ruby.
-email:
+email: 
 - hashimoto@shokai.org
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - History.txt
 - Manifest.txt
 - README.rdoc
-files:
+files: 
 - .gitignore
 - Gemfile
 - Gemfile.lock
@@ -99,6 +107,7 @@ files:
 - README.rdoc
 - Rakefile
 - lib/arduino_firmata.rb
+- lib/arduino_firmata/arduino.rb
 - lib/arduino_firmata/const.rb
 - lib/arduino_firmata/main.rb
 - samples/README.md
@@ -113,35 +122,40 @@ files:
 - test/test_arduino_firmata.rb
 - test/test_helper.rb
 - .gemtest
-homepage: http://github.com/shokai/arduino-firmata-ruby
+homepage: http://github.com/shokai/arduino_firmata
 licenses: []
+
 post_install_message: 
-rdoc_options:
+rdoc_options: 
 - --main
 - README.rdoc
-require_paths:
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: -3581276081025473849
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: arduino_firmata
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Arduino Firmata protocol (http://firmata.org) implementation on Ruby.
-test_files:
+test_files: 
 - test/test_arduino_firmata.rb
 - test/test_helper.rb