arduino_firmata 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+*#*
+*~
+pkg/*

data/Gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+
+gem 'hoe'
+gem 'newgem'
+gem 'serialport'

data/Gemfile.lock

@@ -0,0 +1,26 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    RedCloth (4.2.9)
+    activesupport (2.3.14)
+    hoe (3.1.0)
+      rake (~> 0.8)
+    newgem (1.5.3)
+      RedCloth (>= 4.1.1)
+      activesupport (~> 2.3.4)
+      hoe (>= 2.4.0)
+      rubigen (>= 1.5.3)
+      syntax (>= 1.0.0)
+    rake (0.9.2.2)
+    rubigen (1.5.8)
+      activesupport (>= 2.3.5, < 3.2.0)
+    serialport (1.1.0)
+    syntax (1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  hoe
+  newgem
+  serialport

data/History.txt

@@ -0,0 +1,3 @@
+=== 0.0.1 2012-10-24
+
+* digital/analog read/write

data/Manifest.txt

@@ -0,0 +1,20 @@
+.gitignore
+Gemfile
+Gemfile.lock
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/arduino_firmata.rb
+lib/arduino_firmata/const.rb
+lib/arduino_firmata/main.rb
+samples/analog_read_write.rb
+samples/digital_read.rb
+samples/led_blink.rb
+samples/led_fade.rb
+samples/tweet_temperature.rb
+script/console
+script/destroy
+script/generate
+test/test_arduino_firmata.rb
+test/test_helper.rb

data/README.rdoc

@@ -0,0 +1,83 @@
+= arduino_firmata
+
+* http://github.com/shokai/arduino-firmata-ruby
+
+== INSTALL:
+
+* gem install arduino_firmata
+
+== DESCRIPTION:
+
+Arduino Firmata protocol (http://firmata.org) implementation on Ruby.
+
+== SYNOPSIS:
+
+  arduino = ArduinoFirmata::Arduino.new
+
+or
+
+  arduino = ArduinoFirmata::Arduino.new '/dev/tty.usb-device-name'
+
+Board Version
+
+  puts "firmata version #{arduino.version}"
+
+
+Digital Write
+
+  arduino.digital_write 13, true
+  arduino.digital_write 13, false
+
+
+Digital Read
+
+  arduino.pin_mode 7, ArduinoFirmata::INPUT
+  puts arduino.digital_read 7  # => true/false
+
+
+Analog Write (PWM)
+
+  0.upto(255) do |i|
+    arduino.analog_write 11, i
+    sleep 0.01
+  end
+
+Analog Read
+
+  puts arduino.analog_read 0  # => 0 ~ 1023
+
+see samples https://github.com/shokai/arduino-firmata-ruby/tree/gem/samples
+
+== REQUIREMENTS:
+
+* Arduino Standard Firmata v2.2
+Arduino IDE -> [File] -> [Examples] -> [Firmata] -> [StandardFirmata]
+
+* Ruby 1.8.7+
+* Ruby 1.9.2+
+
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2012 Sho Hashimoto
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/arduino_firmata'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'arduino_firmata' do
+  self.developer 'Sho Hashimoto', 'hashimoto@shokai.org'
+  #self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  self.rubyforge_name       = self.name # TODO this is default value
+  self.extra_deps         = [['serialport','>= 1.1.0', '< 2.0.0']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/lib/arduino_firmata.rb

@@ -0,0 +1,9 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'arduino_firmata/const'
+require 'arduino_firmata/main'
+
+module ArduinoFirmata
+  VERSION = '0.0.1'
+end

data/lib/arduino_firmata/const.rb

@@ -0,0 +1,28 @@
+module ArduinoFirmata
+
+  def self.list
+    Dir.entries('/dev').grep(/tty\.usb/).map{|fname| "/dev/#{fname}"}
+  end
+
+  INPUT  = 0
+  OUTPUT = 1
+  ANALOG = 2
+  PWM    = 3
+  SERVO  = 4
+  SHIFT  = 5
+  I2C    = 6
+  LOW    = 0
+  HIGH   = 1
+
+  MAX_DATA_BYTES  = 32
+  DIGITAL_MESSAGE = 0x90 # send data for a digital port
+  ANALOG_MESSAGE  = 0xE0 # send data for an analog pin (or PWM)
+  REPORT_ANALOG   = 0xC0 # enable analog input by pin
+  REPORT_DIGITAL  = 0xD0 # enable digital input by port
+  SET_PIN_MODE    = 0xF4 # set a pin to INPUT/OUTPUT/PWM/etc
+  REPORT_VERSION  = 0xF9 # report firmware version
+  SYSTEM_RESET    = 0xFF # reset from MIDI
+  START_SYSEX     = 0xF0 # start a MIDI SysEx message
+  END_SYSEX       = 0xF7 # end a MIDI SysEx message
+
+end

data/lib/arduino_firmata/main.rb

@@ -0,0 +1,130 @@
+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
+
+      @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
+
+    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/samples/analog_read_write.rb

@@ -0,0 +1,13 @@
+#usr/bin/env ruby
+require 'rubygems'
+$:.unshift File.expand_path '../lib', File.dirname(__FILE__)
+require 'arduino_firmata'
+
+arduino = ArduinoFirmata::Arduino.new ARGV.shift
+
+loop do
+  an = arduino.analog_read 0
+  puts an
+  arduino.analog_write 9, an/4
+  sleep 0.1
+end

data/samples/digital_read.rb

@@ -0,0 +1,19 @@
+#usr/bin/env ruby
+require 'rubygems'
+$:.unshift File.expand_path '../lib', File.dirname(__FILE__)
+require 'arduino_firmata'
+
+arduino = ArduinoFirmata::Arduino.new ARGV.shift
+
+arduino.pin_mode 7, ArduinoFirmata::INPUT
+
+loop do
+  if arduino.digital_read 7
+    puts "on"
+    arduino.digital_write 13, true
+  else
+    puts "off"
+    arduino.digital_write 13, false
+  end
+  sleep 0.1
+end

data/samples/led_blink.rb

@@ -0,0 +1,16 @@
+#usr/bin/env ruby
+require 'rubygems'
+$:.unshift File.expand_path '../lib', File.dirname(__FILE__)
+require 'arduino_firmata'
+
+arduino = ArduinoFirmata::Arduino.new ARGV.shift
+puts "firmata version #{arduino.version}"
+
+stat = true
+loop do
+  puts stat
+  arduino.digital_write 13, stat
+  stat = !stat
+  sleep 0.1
+end
+

data/samples/led_fade.rb

@@ -0,0 +1,21 @@
+#usr/bin/env ruby
+require 'rubygems'
+$:.unshift File.expand_path '../lib', File.dirname(__FILE__)
+require 'arduino_firmata'
+
+arduino = ArduinoFirmata::Arduino.new ARGV.shift
+pin_num = 9
+
+loop do
+  puts "0 -> 255"
+  0.upto(255) do |i|
+    arduino.analog_write pin_num, i
+    sleep 0.01
+  end
+  
+  puts "255 -> 0"
+  255.downto(0) do |i|
+    arduino.analog_write pin_num, i
+    sleep 0.01
+  end
+end

data/samples/tweet_temperature.rb

@@ -0,0 +1,15 @@
+# -*- coding: utf-8 -*-
+#usr/bin/env ruby
+require 'rubygems'
+$:.unshift File.expand_path '../lib', File.dirname(__FILE__)
+require 'arduino_firmata'
+require 'tw'
+
+arduino = ArduinoFirmata::Arduino.new
+sleep 3
+
+##  LM35DZ -> Analog 0 PIN
+puts temp = arduino.analog_read(0)*100*5/1024
+client = Tw::Client.new
+client.auth
+client.tweet "現在の温度 #{temp}度"

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/arduino_firmata.rb'}"
+puts "Loading arduino_firmata gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_arduino_firmata.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestArduinoFirmata < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/arduino_firmata'

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: arduino_firmata
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sho Hashimoto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: serialport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !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:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !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
+        version: 1.5.3
+  type: :development
+  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
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Arduino Firmata protocol (http://firmata.org) implementation on Ruby.
+email:
+- hashimoto@shokai.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.txt
+- Manifest.txt
+- README.rdoc
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/arduino_firmata.rb
+- lib/arduino_firmata/const.rb
+- lib/arduino_firmata/main.rb
+- samples/analog_read_write.rb
+- samples/digital_read.rb
+- samples/led_blink.rb
+- samples/led_fade.rb
+- samples/tweet_temperature.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_arduino_firmata.rb
+- test/test_helper.rb
+- .gemtest
+homepage: http://github.com/shokai/arduino-firmata-ruby
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -658418046029011194
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      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/test_arduino_firmata.rb
+- test/test_helper.rb