hybridgroup-firmata 0.2.0

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc
+harness.rb

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in firmata.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 'Mike Breen'
+
+MIT License
+
+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/README.md

@@ -0,0 +1,55 @@
+# Firmata
+
+A Ruby implementation of the [Firmata protocol](http://firmata.org/wiki/V2.2ProtocolDetails).
+
+This library is inspired by the awesome [firmata](http://jgautier.github.com/firmata/) by [jgautier](https://github.com/jgautier).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'firmata'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install firmata
+
+## Prerequisites
+
+1. Download the [Arduio IDE](http://www.arduino.cc/en/Main/Software) for your OS
+2. Plug in your Arduino via USB
+3. Open the Arduino IDE, select: File > Examples > Firmata > StandardFirmata
+4. Click the Upload button
+5. Make note of the serial port: Tools > Serial Port
+
+There have been reports of [issues](https://github.com/jgautier/firmata/issues/8) with Firmata 2.3.
+Try downgrading to [Firmata 2.2](http://at.or.at/hans/pd/Firmata-2.2.zip) if you're having a problem.
+
+## Usage
+
+Here is a simple example using IRB that will turn pin 13 on and off.
+(Replace xxxxx with the USB port from step 5 in Prerequisites)
+
+    1.9.3p194 :001 > require 'firmata'
+    1.9.3p194 :002 > board = Firmata::Board.new('/dev/tty.usbmodemxxxxx')
+    1.9.3p194 :003 > board.connect
+    1.9.3p194 :004 > board.connected?
+     => true
+    1.9.3p194 :005 > board.version
+     => "2.3"
+    1.9.3p194 :006 > board.firmware_name
+     => "StandardFirmata"
+    1.9.3p194 :007 > board.digital_write(13, Firmata::Board::HIGH)
+    1.9.3p194 :008 > board.digital_write(13, Firmata::Board::LOW)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task :default => [:test]

data/examples/blink_led.rb

@@ -0,0 +1,22 @@
+require 'bundler/setup'
+require 'firmata'
+require 'socket'
+
+sp = TCPSocket.open 'localhost', 4567
+#sp = '/dev/tty.usbserial-A700636n'
+board = Firmata::Board.new(sp)
+
+board.connect
+
+pin_number = 3
+rate = 0.5
+
+10.times do
+  board.digital_write pin_number, Firmata::Board::HIGH
+  puts '+'
+  board.delay rate
+
+  board.digital_write pin_number, Firmata::Board::LOW
+  puts '-'
+  board.delay rate
+end

data/firmata.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/firmata/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["'Mike Breen', 'Adrian Zankich'"]
+  gem.email         = ["info@hybridgroup.com"]
+  gem.description   = %q{A lib for working with the Firmata protocol in Ruby.}
+  gem.summary       = %q{}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "hybridgroup-firmata"
+  gem.require_paths = ["lib"]
+  gem.version       = Firmata::VERSION
+
+  gem.add_development_dependency("pry")
+
+  gem.add_runtime_dependency("event_spitter")
+end

data/lib/firmata.rb

@@ -0,0 +1,2 @@
+require 'firmata/version'
+require 'firmata/board'

data/lib/firmata/board.rb

@@ -0,0 +1,403 @@
+require 'stringio'
+require 'event_spitter'
+
+module Firmata
+  class Board
+    include EventSpitter
+
+    # Internal: Data structure representing a pin on Arduino.
+    Pin = Struct.new(:supported_modes, :mode, :value, :analog_channel)
+
+    # Public: Fixnum byte for pin mode input.
+    INPUT = 0x00
+    # Public: Fixnum byte for pin mode output.
+    OUTPUT = 0x01
+    # Public: Fixnum byte for pin mode analog.
+    ANALOG = 0x02
+    # Public: Fixnum byte for pin mode pulse width modulation.
+    PWM = 0x03
+    # Public: Fixnum byte for pin mode servo.
+    SERVO = 0x04
+
+    LOW  = 0
+    HIGH = 1
+
+    # Internal: Fixnum byte command for protocol version
+    REPORT_VERSION = 0xF9
+    # Internal: Fixnum byte command for system reset
+    SYSTEM_RESET = 0xFF
+    # Internal: Fixnum byte command for digital I/O message
+    DIGITAL_MESSAGE = 0x90
+    # Pubilc: Fixnum byte for range for digital pins for digital 2 byte data format
+    DIGITAL_MESSAGE_RANGE = 0x90..0x9F
+    # Internal: Fixnum byte command for an analog I/O message
+    ANALOG_MESSAGE = 0xE0
+    # Internal: Fixnum byte range for analog pins for analog 14-bit data format
+    ANALOG_MESSAGE_RANGE = 0xE0..0xEF
+    # Internal: Fixnum byte command to report analog pin
+    REPORT_ANALOG = 0xC0
+    # Internal: Fixnum byte command to report digital port
+    REPORT_DIGITAL = 0xD0
+    # Internal: Fixnum byte command to set pin mode (I/O)
+    PIN_MODE  = 0xF4
+
+    # Internal: Fixnum byte command for start of Sysex message
+    START_SYSEX = 0xF0
+    # Internal: Fixnum byte command for end of Sysex message
+    END_SYSEX = 0xF7
+    # Internal: Fixnum byte sysex command for capabilities query
+    CAPABILITY_QUERY = 0x6B
+    # Internal: Fixnum byte sysex command for capabilities response
+    CAPABILITY_RESPONSE = 0x6C
+    # Internal: Fixnum byte sysex command for pin state query
+    PIN_STATE_QUERY = 0x6D
+    # Internal: Fixnum byte sysex command for pin state response
+    PIN_STATE_RESPONSE = 0x6E
+    # Internal: Fixnum byte sysex command for analog mapping query
+    ANALOG_MAPPING_QUERY    = 0x69
+    # Internal: Fixnum byte sysex command for analog mapping response
+    ANALOG_MAPPING_RESPONSE = 0x6A
+    # Internal: Fixnum byte sysex command for firmware query and response
+    FIRMWARE_QUERY = 0x79
+
+    # Public: Returns the SerialPort port the Arduino is attached to.
+    attr_reader :serial_port
+    # Public: Returns the Array of pins on Arduino.
+    attr_reader :pins
+    # Public: Returns the Array of analog pins on Arduino.
+    attr_reader :analog_pins
+    # Public: Returns the String firmware name of Arduion.
+    attr_reader :firmware_name
+
+    # Public: Initialize a Board
+    #
+    # port - a String port or an Object that responds to read and write.
+    def initialize(port)
+      if port.is_a?(String)
+        require 'serialport'
+        @serial_port = SerialPort.new(port, 57600, 8, 1, SerialPort::NONE)
+        @serial_port.read_timeout = 2
+      else
+        @serial_port = port
+      end
+
+      @major_version = 0
+      @minor_version = 0
+      @pins = []
+      @analog_pins = []
+      @connected = false
+    rescue LoadError
+      puts "Please 'gem install hybridgroup-serialport' for serial port support."
+    end
+
+    # Pubilc: Check if a connection to Arduino has been made.
+    #
+    # Returns Boolean connected state.
+    def connected?
+      @connected
+    end
+
+    # Public: Make connection to Arduino.
+    #
+    # Returns Firmata::Board board.
+    def connect
+      unless @connected
+        once('report_version', ->() do
+          once('firmware_query', ->() do
+            once('capability_query', ->() do
+              once('analog_mapping_query', ->() do
+
+                2.times { |i| toggle_pin_reporting(i) }
+
+                @connected = true
+                emit('ready')
+              end)
+              query_analog_mapping
+           end)
+            query_capabilities
+          end)
+        end)
+
+         until connected?
+          read_and_process
+          delay(0.5)
+        end
+      end
+
+      self
+    end
+
+    # Internal: Write data to the underlying serial port.
+    #
+    # commands - Zero or more byte commands to be written.
+    #
+    # Examples
+    #
+    #   write(START_SYSEX, CAPABILITY_QUERY, END_SYSEX)
+    #
+    # Returns nothing.
+    def write(*commands)
+      serial_port.write_nonblock(commands.map(&:chr).join)
+    end
+
+    # Internal: Read data from the underlying serial port.
+    #
+    # Returns String data read for serial port.
+    def read
+      serial_port.read_nonblock(4096)
+    rescue EOFError
+    rescue Errno::EAGAIN
+    end
+
+    # Internal: Process a series of bytes.
+    #
+    # data: The String data to process.
+    #
+    # Returns nothing.
+    def process(data)
+      bytes = StringIO.new(String(data)).bytes
+      bytes.each do |byte|
+        case byte
+        when REPORT_VERSION
+          @major_version = bytes.next
+          @minor_version = bytes.next
+
+          emit('report_version')
+
+        when ANALOG_MESSAGE_RANGE
+          least_significant_byte = bytes.next
+          most_significant_byte = bytes.next
+
+          value = least_significant_byte | (most_significant_byte << 7)
+          pin = byte & 0x0F
+
+          if analog_pin = analog_pins[pin]
+            pins[analog_pin].value = value
+
+            emit('analog-read', pin, value)
+            emit("analog-read-#{pin}", value)
+          end
+
+        when DIGITAL_MESSAGE_RANGE
+          port           = byte & 0x0F
+          first_bitmask  = bytes.next
+          second_bitmask = bytes.next
+          port_value     = first_bitmask | (second_bitmask << 7)
+
+          8.times do |i|
+            pin_number = 8 * port + i
+            if pin = pins[pin_number] and pin.mode == INPUT
+              value = (port_value >> (i & 0x07)) & 0x01
+              pin.value = value
+              emit('digital-read', pin_number, value)
+              emit("digital-read-#{pin_number}", value)
+            end
+          end
+
+        when START_SYSEX
+          current_buffer = [byte]
+          begin
+            current_buffer.push(bytes.next)
+          end until current_buffer.last == END_SYSEX
+
+          command = current_buffer[1]
+
+          case command
+          when CAPABILITY_RESPONSE
+            supported_modes = 0
+            n = 0
+
+            current_buffer.slice(2, current_buffer.length - 3).each do |byte|
+              if byte == 127
+                modes = []
+                # the pin modes
+                [ INPUT, OUTPUT, ANALOG, PWM, SERVO ].each do |mode|
+                   modes.push(mode) unless (supported_modes & (1 << mode)).zero?
+                end
+
+                @pins.push(Pin.new(modes, OUTPUT, 0))
+
+                supported_modes = 0
+                n = 0
+                next
+              end
+
+              supported_modes |= (1 << byte) if n.zero?
+
+              n ^= 1
+            end
+
+            emit('capability_query')
+
+          when ANALOG_MAPPING_RESPONSE
+            pin_index = 0
+
+            current_buffer.slice(2, current_buffer.length - 3).each do |byte|
+
+              @pins[pin_index].analog_channel = byte
+
+              @analog_pins.push(pin_index) unless byte == 127
+
+              pin_index += 1
+            end
+
+            emit('analog_mapping_query')
+
+          when PIN_STATE_RESPONSE
+            pin       = pins[current_buffer[2]]
+            pin.mode  = current_buffer[3]
+            pin.value = current_buffer[4]
+
+            pin.value |= (current_buffer[5] << 7) if current_buffer.size > 6
+
+            pin.value |= (current_buffer[6] << 14) if current_buffer.size > 7
+
+          when FIRMWARE_QUERY
+            @firmware_name = current_buffer.slice(4, current_buffer.length - 5).reject { |b| b.zero? }.map(&:chr).join
+            emit('firmware_query')
+
+          else
+            puts 'bad byte'
+          end
+        end
+      end
+    rescue StopIteration
+      # do nadda
+    end
+
+    # Public: Read the serial port and process the results
+    #
+    # Returns nothing.
+    def read_and_process
+      process(read)
+    end
+
+    # Public: Send a SYSTEM_RESET to the Arduino
+    #
+    # Returns nothing.
+    def reset
+      write(SYSTEM_RESET)
+    end
+
+    # Public: Set the mode for a pin.
+    #
+    # pin  - The Integer pin to set.
+    # mode - The Fixnum mode (INPUT, OUTPUT, ANALOG, PWM or SERVO)
+    #
+    # Examples
+    #
+    #   set_pin_mode(13, OUTPUT)
+    #
+    # Returns nothing.
+    def set_pin_mode(pin, mode)
+      pins[pin].mode = mode
+      write(PIN_MODE, pin, mode)
+    end
+
+    # Public: Write a value to a digital pin.
+    #
+    # pin   - The Integer pin to write to.
+    # value - The value to write (HIGH or LOW).
+    #
+    # Returns nothing.
+    def digital_write(pin, value)
+      port = (pin / 8).floor
+      port_value = 0
+
+      @pins[pin].value = value
+
+      8.times do |i|
+        port_value |= (1 << i) unless @pins[8 * port + i].value.zero?
+      end
+
+      write(DIGITAL_MESSAGE | port, port_value & 0x7F, (port_value >> 7) & 0x7F)
+    end
+
+    # Public: Write an analog messege.
+    #
+    # pin   - The Integer pin to write to.
+    # value - The Integer value to write to the pin between 0-255.
+    #
+    # Returns nothing.
+    def analog_write(pin, value)
+      @pins[pin].value = value
+      write(ANALOG_MESSAGE | pin, value & 0x7F, (value >> 7) & 0x7F)
+    end
+
+    # Public: Write to a servo.
+    #
+    # pin     - The Integer pin to write to.
+    # degrees - The Integer degrees to move the servo.
+    #
+    # Returns nothing.
+    alias_method :servo_write, :analog_write
+
+    # Public: Ask the Arduino to sleep for a number of seconds.
+    #
+    # seconds - The Integer seconds to sleep for.
+    #
+    # Returns nothing.
+    def delay(seconds)
+      sleep(seconds)
+    end
+
+    # Public: The major and minor firmware version on the board. Will report as
+    # "0.0" if report_version command has not been run.
+    #
+    # Returns String the firmware version as "minor.major".
+    def version
+      [@major_version, @minor_version].join('.')
+    end
+
+    # Public: Ask the Arduino to report its version.
+    #
+    # Returns nothing.
+    def report_version
+      write(REPORT_VERSION)
+    end
+
+    # Public: Ask the Ardution for its firmware name.
+    #
+    # Returns nothing.
+    def query_firmware
+      write(FIRMWARE_QUERY)
+    end
+
+    # Public: Ask the Arduino for the current configuration of any pin.
+    #
+    # pin - The Integer pin to query on the board.
+    #
+    # Returns nothing.
+    def query_pin_state(pin)
+      write(START_SYSEX, PIN_STATE_QUERY, pin.to_i, END_SYSEX)
+    end
+
+    # Public: Ask the Arduino about its capabilities and current state.
+    #
+    # Returns nothing.
+    def query_capabilities
+      write(START_SYSEX, CAPABILITY_QUERY, END_SYSEX)
+    end
+
+    # Public: Ask the Arduino which pins (used with pin mode message) correspond to the analog channels.
+    #
+    # Returns nothing.
+    def query_analog_mapping
+      write(START_SYSEX, ANALOG_MAPPING_QUERY, END_SYSEX)
+    end
+
+    # Public: Toggle pin reporting on or off.
+    #
+    # pin   - The Integer pin to toggle.
+    # mode  - The Integer mode the pin will report. The valid values are
+    #         REPORT_DIGITAL or REPORT_ANALOG (default: REPORT_DIGITAL).
+    # state - The Integer state to toggle the pin. The valid value are
+    #         HIGH or LOW (default: HIGH)
+    #
+    # Returns nothing.
+    def toggle_pin_reporting(pin, state = HIGH, mode = REPORT_DIGITAL)
+      write(mode | pin, state)
+    end
+
+  end
+end

data/lib/firmata/version.rb

@@ -0,0 +1,3 @@
+module Firmata
+  VERSION = "0.2.0"
+end

data/test/board_test.rb

@@ -0,0 +1,223 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+
+require_relative '../lib/firmata'
+require_relative 'fake_serial_port'
+
+class BoardTest < MiniTest::Unit::TestCase
+
+  def mock_serial_port(*args, &block)
+    mock_port = MiniTest::Mock.new
+    mock_port.expect(:is_a?, false, [nil])
+
+    if block_given?
+      yield mock_port
+    else
+      expected = args.map(&:chr).join
+      mock_port.expect(:write_nonblock, 1, [expected])
+    end
+
+    mock_port
+  end
+
+  def test_writing_report_version
+    mock_sp = mock_serial_port(Firmata::Board::REPORT_VERSION)
+
+    board = Firmata::Board.new(mock_sp)
+    board.report_version
+
+    mock_sp.verify
+  end
+
+  def test_processing_report_version
+    board = Firmata::Board.new(FakeSerialPort.new)
+    board.report_version
+    board.read_and_process
+
+    assert_equal '2.3', board.version
+  end
+
+  def test_writing_capability_query
+    mock_sp = mock_serial_port(Firmata::Board::START_SYSEX, Firmata::Board::CAPABILITY_QUERY, Firmata::Board::END_SYSEX)
+
+    board = Firmata::Board.new(mock_sp)
+    board.query_capabilities
+
+    mock_sp.verify
+  end
+
+  def test_processing_capabilities_query
+    board = Firmata::Board.new(FakeSerialPort.new)
+    board.query_capabilities
+    board.read_and_process
+
+    assert_equal 20, board.pins.size
+  end
+
+  def test_writing_analog_mapping_query
+    mock_sp = mock_serial_port(Firmata::Board::START_SYSEX, Firmata::Board::ANALOG_MAPPING_QUERY, Firmata::Board::END_SYSEX)
+
+    board = Firmata::Board.new(mock_sp)
+    board.query_analog_mapping
+
+    mock_sp.verify
+  end
+
+  def test_processing_analog_mapping_query
+    board = Firmata::Board.new(FakeSerialPort.new)
+    board.query_capabilities
+    board.read_and_process
+
+    board.query_analog_mapping
+    board.read_and_process
+
+    assert_equal 6, board.analog_pins.size
+  end
+
+  def test_processing_digital_message
+    board = Firmata::Board.new(FakeSerialPort.new)
+
+    board.query_capabilities
+    board.read_and_process
+
+    board.query_analog_mapping
+    board.read_and_process
+
+    pin = board.pins[8]
+    pin.mode = Firmata::Board::INPUT
+
+    board.process("\x91\x01\x00")
+
+    assert_equal Firmata::Board::HIGH, pin.value
+  end
+
+  def test_set_pin_mode
+    mock_sp = mock_serial_port(Firmata::Board::PIN_MODE, 13, Firmata::Board::OUTPUT)
+
+    board = Firmata::Board.new(mock_sp)
+    board.pins[13] = Firmata::Board::Pin.new([0, 1, 4], 0, 0, nil)
+
+    board.set_pin_mode(13, Firmata::Board::OUTPUT)
+
+    assert_equal Firmata::Board::OUTPUT, board.pins[13].mode
+    mock_sp.verify
+  end
+
+  def test_write_pin_state_query
+    mock_sp = mock_serial_port(Firmata::Board::START_SYSEX, Firmata::Board::PIN_STATE_QUERY, 13, Firmata::Board::END_SYSEX)
+
+    board = Firmata::Board.new(mock_sp)
+    board.query_pin_state(13)
+
+    mock_sp.verify
+  end
+
+  def test_processing_pin_state_query
+    board = Firmata::Board.new(FakeSerialPort.new)
+    board.query_capabilities
+    board.read_and_process
+
+    board.pins[13].mode = Firmata::Board::INPUT
+
+    board.query_pin_state(13)
+    board.read_and_process
+
+    assert_equal Firmata::Board::OUTPUT, board.pins[13].mode
+  end
+
+
+  def test_toggling_pin_reporting
+    mock_sp = mock_serial_port do |mock|
+      mock.expect(:write_nonblock, 2, [[Firmata::Board::REPORT_DIGITAL | 13, 1].map(&:chr).join])
+    end
+
+    board = Firmata::Board.new(mock_sp)
+
+    board.toggle_pin_reporting(13)
+    mock_sp.verify
+
+    mock_sp.expect(:write_nonblock, 2, [[Firmata::Board::REPORT_DIGITAL | 13, 0].map(&:chr).join])
+    board.toggle_pin_reporting(13, 0)
+    mock_sp.verify
+
+  end
+
+  def test_processing_analog_message
+    fake_port = FakeSerialPort.new
+    board = Firmata::Board.new(fake_port)
+
+    board.query_capabilities
+    board.read_and_process
+
+    board.query_analog_mapping
+    board.read_and_process
+
+    fake_port.buffer = "\xE0\e\u0005\xE1N\u0004\xE2A\u0004\xE3C\u0004\xE4o\u0004\xE5f\u0004\xE0w\u0004\xE1]\u0004\xE2N\u0004\xE3I\u0004\xE4x\u0004\xE5m\u0004\xE0m\u0004\xE1`\u0004\xE2T\u0004\xE3L\u0004\xE4s\u0004\xE5l\u0004\xE0i\u0004\xE1`\u0004\xE2V\u0004\xE3N\u0004\xE4m\u0004\xE5j\u0004\xE0f\u0004\xE1^\u0004\xE2U\u0004\xE3O\u0004\xE4h\u0004\xE5g\u0004\xE0d\u0004\xE1\\\u0004\xE2T\u0004\xE3O\u0004\xE4d\u0004\xE5d\u0004\xE0b\u0004\xE1Z\u0004\xE2S\u0004\xE3N\u0004\xE4`\u0004\xE5a\u0004\xE0_\u0004\xE1X\u0004\xE2Q\u0004\xE3L\u0004\xE4\\\u0004\xE5^\u0004\xE0\\\u0004\xE1T\u0004\xE2N\u0004\xE3J\u0004\xE4X\u0004\xE5Z\u0004\xE0X\u0004\xE1Q\u0004\xE2K\u0004\xE3G\u0004\xE4T\u0004\xE5W\u0004\xE0V\u0004\xE1O\u0004\xE2H\u0004\xE3D\u0004\xE4Q\u0004\xE5T\u0004\xE0S\u0004\xE1L\u0004\xE2F\u0004\xE3B\u0004\xE4N\u0004\xE5Q\u0004\xE0P\u0004\xE1J\u0004\xE2C\u0004\xE3@\u0004\xE4K\u0004\xE5N\u0004\xE0N\u0004\xE1G\u0004\xE2A\u0004\xE3>\u0004\xE4I\u0004\xE5L\u0004\xE0L\u0004\xE1D\u0004\xE2?\u0004\xE3<\u0004\xE4F\u0004\xE5I\u0004\xE0I\u0004\xE1B\u0004\xE2=\u0004\xE39\u0004\xE4C\u0004\xE5F\u0004\xE0F\u0004\xE1?\u0004\xE2:\u0004\xE37\u0004\xE4@\u0004\xE5C\u0004\xE0C\u0004\xE1<\u0004\xE28\u0004\xE34\u0004\xE4>\u0004\xE5A\u0004\xE0A\u0004\xE1:\u0004\xE26\u0004\xE32\u0004\xE4<\u0004\xE5?\u0004\xE0?\u0004\xE19\u0004\xE24\u0004\xE31\u0004\xE4:\u0004\xE5=\u0004\xE0>\u0004\xE17\u0004\xE22\u0004\xE3/\u0004\xE49\u0004\xE5;\u0004\xE0<\u0004\xE15\u0004\xE20\u0004\xE3-\u0004\xE46\u0004\xE59\u0004\xE09\u0004\xE12\u0004\xE2.\u0004\xE3+\u0004\xE44\u0004\xE57\u0004\xE07\u0004\xE10\u0004\xE2,\u0004\xE3)\u0004\xE42\u0004\xE55\u0004\xE05\u0004\xE1.\u0004\xE2*\u0004\xE3'\u0004\xE40\u0004\xE52\u0004\xE03\u0004\xE1-\u0004\xE2(\u0004\xE3&\u0004\xE4/\u0004\xE51\u0004\xE02\u0004\xE1+\u0004\xE2&\u0004\xE3$\u0004\xE4-\u0004\xE50\u0004\xE00\u0004\xE1*\u0004\xE2%\u0004\xE3#\u0004\xE4,\u0004\xE5.\u0004\xE0/\u0004\xE1(\u0004\xE2$\u0004\xE3!\u0004\xE4*\u0004\xE5,\u0004\xE0-\u0004\xE1&\u0004\xE2\"\u0004\xE3\u001F\u0004\xE4(\u0004\xE5*\u0004\xE0+\u0004\xE1$\u0004\xE2 \u0004\xE3\u001D\u0004\xE4&\u0004\xE5(\u0004\xE0)\u0004\xE1\"\u0004\xE2\u001F\u0004\xE3\u001C\u0004\xE4%\u0004\xE5'\u0004\xE0(\u0004\xE1!\u0004\xE2\u001D\u0004\xE3\e\u0004\xE4$\u0004\xE5&\u0004\xE0&\u0004\xE1 \u0004\xE2\u001C\u0004\xE3\u001A\u0004\xE4#\u0004\xE5%\u0004\xE0&\u0004\xE1\u001F\u0004\xE2\e\u0004\xE3\u0019\u0004\xE4\"\u0004\xE5$\u0004\xE0$\u0004\xE1\u001E\u0004\xE2\u0019\u0004\xE3\u0018\u0004\xE4 \u0004\xE5\"\u0004\xE0\"\u0004\xE1\u001C\u0004\xE2\u0018\u0004\xE3\u0016\u0004\xE4\u001F\u0004\xE5 \u0004\xE0!\u0004\xE1\u001A\u0004\xE2\u0017\u0004\xE3\u0014\u0004\xE4\u001D\u0004\xE5\u001E\u0004\xE0\u001F\u0004\xE1\u0019\u0004\xE2\u0015\u0004\xE3\u0013\u0004\xE4\u001C\u0004\xE5\u001D\u0004\xE0\u001E\u0004\xE1\u0018\u0004\xE2\u0013\u0004\xE3\u0012\u0004\xE4\e\u0004\xE5\u001C\u0004\xE0\u001D\u0004\xE1\u0017\u0004\xE2\u0014\u0004\xE3\u0012\u0004\xE4\e\u0004\xE5\u001C\u0004\xE0\u001D\u0004\xE1\u0016\u0004\xE2\u0013\u0004\xE3\u0011\u0004\xE4\u001A\u0004\xE5\e\u0004\xE0\u001C\u0004\xE1\u0015\u0004\xE2\u0011\u0004\xE3\u0010\u0004\xE4\u0018\u0004\xE5\u0019\u0004\xE0\u001A\u0004\xE1\u0014\u0004\xE2\u0010\u0004\xE3\u000E\u0004\xE4\u0017\u0004\xE5\u0018\u0004\xE0\u0018\u0004\xE1\u0012\u0004\xE2\u000E\u0004\xE3\r\u0004\xE4\u0015\u0004\xE5\u0016\u0004\xE0\u0017\u0004\xE1\u0011\u0004\xE2\u000E\u0004\xE3\f\u0004\xE4\u0015\u0004\xE5\u0016\u0004\xE0\u0016\u0004\xE1\u0010\u0004\xE2\f\u0004\xE3\v\u0004\xE4\u0014\u0004\xE5\u0015\u0004\xE0\u0016\u0004\xE1\u000F\u0004\xE2\v\u0004\xE3\n\u0004\xE4\u0013\u0004\xE5\u0014\u0004\xE0\u0015\u0004\xE1\u000F\u0004\xE2\v\u0004\xE3\t\u0004\xE4\u0012\u0004\xE5\u0013\u0004\xE0\u0014\u0004\xE1\u000E\u0004\xE2\n\u0004\xE3\t\u0004\xE4\u0012\u0004\xE5\u0012\u0004\xE0\u0013\u0004\xE1\f\u0004\xE2\t\u0004\xE3\a\u0004\xE4\u0010\u0004\xE5\u0011\u0004\xE0\u0011\u0004\xE1\v\u0004\xE2\b\u0004\xE3\u0006\u0004\xE4\u000F\u0004\xE5\u000F\u0004\xE0\u0010\u0004\xE1\n\u0004\xE2\u0006\u0004\xE3\u0005\u0004\xE4\u000E\u0004\xE5\u000F\u0004\xE0\u000F\u0004\xE1\t\u0004\xE2\u0006\u0004\xE3\u0004\u0004\xE4\r\u0004\xE5\u000E\u0004\xE0\u000F\u0004\xE1\t\u0004\xE2\u0006\u0004\xE3\u0004\u0004\xE4\r\u0004\xE5\u000E\u0004\xE0\u000E\u0004\xE1\b\u0004\xE2\u0004\u0004\xE3\u0003\u0004\xE4\f\u0004\xE5\r\u0004\xE0\u000E\u0004\xE1\a\u0004\xE2\u0004\u0004\xE3\u0003\u0004"
+    board.read_and_process
+
+    board.analog_pins.each do |pin|
+      refute_nil board.pins[pin].analog_channel, "Analog channel not set for pin #{pin}"
+    end
+  end
+
+  def test_reset
+    mock_sp = mock_serial_port(Firmata::Board::SYSTEM_RESET)
+
+    board = Firmata::Board.new(mock_sp)
+    board.reset
+
+    mock_sp.verify
+  end
+
+  def test_write_firmware_query
+    mock_sp = mock_serial_port(Firmata::Board::FIRMWARE_QUERY)
+
+    board = Firmata::Board.new(mock_sp)
+    board.query_firmware
+
+    mock_sp.verify
+  end
+
+  def test_process_firmware_query
+    fake_port = FakeSerialPort.new
+    fake_port.buffer = "\xF0y\u0002\u0003S\u0000t\u0000a\u0000n\u0000d\u0000a\u0000r\u0000d\u0000F\u0000i\u0000r\u0000m\u0000a\u0000t\u0000a\u0000\xF7"
+    board = Firmata::Board.new(fake_port)
+
+    board.read_and_process
+
+    assert_equal 'StandardFirmata', board.firmware_name, 'Firmware Name is incorrect'
+  end
+
+  def test_digital_write
+    mock_sp = mock_serial_port(145, 127, 1)
+    board = Firmata::Board.new(mock_sp)
+
+    8.times do |x|
+      board.pins[x + 8] = Firmata::Board::Pin.new([], 0, 250 + x, nil)
+    end
+
+    board.digital_write(13, 1)
+
+    assert_equal 1, board.pins[13].value, "Pin value not set"
+    mock_sp.verify
+  end
+
+  def test_analog_write
+    mock_sp = mock_serial_port(233, 127, 1)
+    board = Firmata::Board.new(mock_sp)
+
+    8.times do |x|
+      board.pins[x + 8] = Firmata::Board::Pin.new([], 0, 250 + x, nil)
+    end
+
+    board.analog_write(9, 255)
+
+    assert_equal 255, board.pins[9].value
+    mock_sp.verify
+  end
+
+  def test_servo_write
+    board = Firmata::Board.new(FakeSerialPort.new)
+    assert board.respond_to? :servo_write
+  end
+end

data/test/fake_serial_port.rb

@@ -0,0 +1,55 @@
+require 'stringio'
+
+class FakeSerialPort
+  Board = Firmata::Board
+
+  attr_accessor :buffer
+  attr_accessor :read_timeout
+
+  def initialize
+    @buffer = ""
+    @read_timeout = 0
+  end
+
+  def write(command)
+    val = case command.getbyte(0)
+          when Board::SYSTEM_RESET
+            ""
+          when Board::REPORT_VERSION
+            "\xF9\u0002\u0003"
+
+          when Board::REPORT_DIGITAL, Board::REPORT_ANALOG
+            "\xE0\e\u0005\xE1N\u0004\xE2A\u0004\xE3C\u0004\xE4o\u0004\xE5f\u0004\xE0w\u0004\xE1]\u0004\xE2N\u0004\xE3I\u0004\xE4x\u0004\xE5m\u0004\xE0m\u0004\xE1`\u0004\xE2T\u0004\xE3L\u0004\xE4s\u0004\xE5l\u0004\xE0i\u0004\xE1`\u0004\xE2V\u0004\xE3N\u0004\xE4m\u0004\xE5j\u0004\xE0f\u0004\xE1^\u0004\xE2U\u0004\xE3O\u0004\xE4h\u0004\xE5g\u0004\xE0d\u0004\xE1\\\u0004\xE2T\u0004\xE3O\u0004\xE4d\u0004\xE5d\u0004\xE0b\u0004\xE1Z\u0004\xE2S\u0004\xE3N\u0004\xE4`\u0004\xE5a\u0004\xE0_\u0004\xE1X\u0004\xE2Q\u0004\xE3L\u0004\xE4\\\u0004\xE5^\u0004\xE0\\\u0004\xE1T\u0004\xE2N\u0004\xE3J\u0004\xE4X\u0004\xE5Z\u0004\xE0X\u0004\xE1Q\u0004\xE2K\u0004\xE3G\u0004\xE4T\u0004\xE5W\u0004\xE0V\u0004\xE1O\u0004\xE2H\u0004\xE3D\u0004\xE4Q\u0004\xE5T\u0004\xE0S\u0004\xE1L\u0004\xE2F\u0004\xE3B\u0004\xE4N\u0004\xE5Q\u0004\xE0P\u0004\xE1J\u0004\xE2C\u0004\xE3@\u0004\xE4K\u0004\xE5N\u0004\xE0N\u0004\xE1G\u0004\xE2A\u0004\xE3>\u0004\xE4I\u0004\xE5L\u0004\xE0L\u0004\xE1D\u0004\xE2?\u0004\xE3<\u0004\xE4F\u0004\xE5I\u0004\xE0I\u0004\xE1B\u0004\xE2=\u0004\xE39\u0004\xE4C\u0004\xE5F\u0004\xE0F\u0004\xE1?\u0004\xE2:\u0004\xE37\u0004\xE4@\u0004\xE5C\u0004\xE0C\u0004\xE1<\u0004\xE28\u0004\xE34\u0004\xE4>\u0004\xE5A\u0004\xE0A\u0004\xE1:\u0004\xE26\u0004\xE32\u0004\xE4<\u0004\xE5?\u0004\xE0?\u0004\xE19\u0004\xE24\u0004\xE31\u0004\xE4:\u0004\xE5=\u0004\xE0>\u0004\xE17\u0004\xE22\u0004\xE3/\u0004\xE49\u0004\xE5;\u0004\xE0<\u0004\xE15\u0004\xE20\u0004\xE3-\u0004\xE46\u0004\xE59\u0004\xE09\u0004\xE12\u0004\xE2.\u0004\xE3+\u0004\xE44\u0004\xE57\u0004\xE07\u0004\xE10\u0004\xE2,\u0004\xE3)\u0004\xE42\u0004\xE55\u0004\xE05\u0004\xE1.\u0004\xE2*\u0004\xE3'\u0004\xE40\u0004\xE52\u0004\xE03\u0004\xE1-\u0004\xE2(\u0004\xE3&\u0004\xE4/\u0004\xE51\u0004\xE02\u0004\xE1+\u0004\xE2&\u0004\xE3$\u0004\xE4-\u0004\xE50\u0004\xE00\u0004\xE1*\u0004\xE2%\u0004\xE3#\u0004\xE4,\u0004\xE5.\u0004\xE0/\u0004\xE1(\u0004\xE2$\u0004\xE3!\u0004\xE4*\u0004\xE5,\u0004\xE0-\u0004\xE1&\u0004\xE2\"\u0004\xE3\u001F\u0004\xE4(\u0004\xE5*\u0004\xE0+\u0004\xE1$\u0004\xE2 \u0004\xE3\u001D\u0004\xE4&\u0004\xE5(\u0004\xE0)\u0004\xE1\"\u0004\xE2\u001F\u0004\xE3\u001C\u0004\xE4%\u0004\xE5'\u0004\xE0(\u0004\xE1!\u0004\xE2\u001D\u0004\xE3\e\u0004\xE4$\u0004\xE5&\u0004\xE0&\u0004\xE1 \u0004\xE2\u001C\u0004\xE3\u001A\u0004\xE4#\u0004\xE5%\u0004\xE0&\u0004\xE1\u001F\u0004\xE2\e\u0004\xE3\u0019\u0004\xE4\"\u0004\xE5$\u0004\xE0$\u0004\xE1\u001E\u0004\xE2\u0019\u0004\xE3\u0018\u0004\xE4 \u0004\xE5\"\u0004\xE0\"\u0004\xE1\u001C\u0004\xE2\u0018\u0004\xE3\u0016\u0004\xE4\u001F\u0004\xE5 \u0004\xE0!\u0004\xE1\u001A\u0004\xE2\u0017\u0004\xE3\u0014\u0004\xE4\u001D\u0004\xE5\u001E\u0004\xE0\u001F\u0004\xE1\u0019\u0004\xE2\u0015\u0004\xE3\u0013\u0004\xE4\u001C\u0004\xE5\u001D\u0004\xE0\u001E\u0004\xE1\u0018\u0004\xE2\u0013\u0004\xE3\u0012\u0004\xE4\e\u0004\xE5\u001C\u0004\xE0\u001D\u0004\xE1\u0017\u0004\xE2\u0014\u0004\xE3\u0012\u0004\xE4\e\u0004\xE5\u001C\u0004\xE0\u001D\u0004\xE1\u0016\u0004\xE2\u0013\u0004\xE3\u0011\u0004\xE4\u001A\u0004\xE5\e\u0004\xE0\u001C\u0004\xE1\u0015\u0004\xE2\u0011\u0004\xE3\u0010\u0004\xE4\u0018\u0004\xE5\u0019\u0004\xE0\u001A\u0004\xE1\u0014\u0004\xE2\u0010\u0004\xE3\u000E\u0004\xE4\u0017\u0004\xE5\u0018\u0004\xE0\u0018\u0004\xE1\u0012\u0004\xE2\u000E\u0004\xE3\r\u0004\xE4\u0015\u0004\xE5\u0016\u0004\xE0\u0017\u0004\xE1\u0011\u0004\xE2\u000E\u0004\xE3\f\u0004\xE4\u0015\u0004\xE5\u0016\u0004\xE0\u0016\u0004\xE1\u0010\u0004\xE2\f\u0004\xE3\v\u0004\xE4\u0014\u0004\xE5\u0015\u0004\xE0\u0016\u0004\xE1\u000F\u0004\xE2\v\u0004\xE3\n\u0004\xE4\u0013\u0004\xE5\u0014\u0004\xE0\u0015\u0004\xE1\u000F\u0004\xE2\v\u0004\xE3\t\u0004\xE4\u0012\u0004\xE5\u0013\u0004\xE0\u0014\u0004\xE1\u000E\u0004\xE2\n\u0004\xE3\t\u0004\xE4\u0012\u0004\xE5\u0012\u0004\xE0\u0013\u0004\xE1\f\u0004\xE2\t\u0004\xE3\a\u0004\xE4\u0010\u0004\xE5\u0011\u0004\xE0\u0011\u0004\xE1\v\u0004\xE2\b\u0004\xE3\u0006\u0004\xE4\u000F\u0004\xE5\u000F\u0004\xE0\u0010\u0004\xE1\n\u0004\xE2\u0006\u0004\xE3\u0005\u0004\xE4\u000E\u0004\xE5\u000F\u0004\xE0\u000F\u0004\xE1\t\u0004\xE2\u0006\u0004\xE3\u0004\u0004\xE4\r\u0004\xE5\u000E\u0004\xE0\u000F\u0004\xE1\t\u0004\xE2\u0006\u0004\xE3\u0004\u0004\xE4\r\u0004\xE5\u000E\u0004\xE0\u000E\u0004\xE1\b\u0004\xE2\u0004\u0004\xE3\u0003\u0004\xE4\f\u0004\xE5\r\u0004\xE0\u000E\u0004\xE1\a\u0004\xE2\u0004\u0004\xE3\u0003\u0004"
+
+          when Board::FIRMWARE_QUERY
+            "\xF0y\u0002\u0003S\u0000t\u0000a\u0000n\u0000d\u0000a\u0000r\u0000d\u0000F\u0000i\u0000r\u0000m\u0000a\u0000t\u0000a\u0000\xF7"
+
+          when Board::START_SYSEX
+            case command.getbyte(1)
+            when Board::ANALOG_MAPPING_QUERY
+              "\xF0j\u007F\u007F\u007F\u007F\u007F\u007F\u007F\u007F\u007F\u007F\u007F\u007F\u007F\u007F\u0000\u0001\u0002\u0003\u0004\u0005\xF7"
+
+            when Board::CAPABILITY_QUERY
+              "\xF0l\u007F\u007F\u0000\u0001\u0001\u0001\u0004\u000E\u007F\u0000\u0001\u0001\u0001\u0003\b\u0004\u000E\u007F\u0000\u0001\u0001\u0001\u0004\u000E\u007F\u0000\u0001\u0001\u0001\u0003\b\u0004\u000E\u007F\u0000\u0001\u0001\u0001\u0003\b\u0004\u000E\u007F\u0000\u0001\u0001\u0001\u0004\u000E\u007F\u0000\u0001\u0001\u0001\u0004\u000E\u007F\u0000\u0001\u0001\u0001\u0003\b\u0004\u000E\u007F\u0000\u0001\u0001\u0001\u0003\b\u0004\u000E\u007F\u0000\u0001\u0001\u0001\u0003\b\u0004\u000E\u007F\u0000\u0001\u0001\u0001\u0004\u000E\u007F\u0000\u0001\u0001\u0001\u0004\u000E\u007F\u0000\u0001\u0001\u0001\u0002\n\u007F\u0000\u0001\u0001\u0001\u0002\n\u007F\u0000\u0001\u0001\u0001\u0002\n\u007F\u0000\u0001\u0001\u0001\u0002\n\u007F\u0000\u0001\u0001\u0001\u0002\n\u0006\u0001\u007F\u0000\u0001\u0001\u0001\u0002\n\u0006\u0001\u007F\xF7"
+
+            when Board::PIN_STATE_QUERY
+              "\xF0n\r\u0001\u0000\xF7"
+            end
+          end
+
+    @buffer << val
+    val.length
+  end
+  alias_method :write_nonblock, :write
+
+  def bytes
+    bytes = StringIO.new(@buffer).bytes
+    @buffer = ""
+    bytes
+  end
+
+  def read(size)
+    @buffer
+  end
+  alias_method :read_nonblock, :read
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: hybridgroup-firmata
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- ! '''Mike Breen'', ''Adrian Zankich'''
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: event_spitter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A lib for working with the Firmata protocol in Ruby.
+email:
+- info@hybridgroup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- examples/blink_led.rb
+- firmata.gemspec
+- lib/firmata.rb
+- lib/firmata/board.rb
+- lib/firmata/version.rb
+- test/board_test.rb
+- test/fake_serial_port.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: ''
+test_files:
+- test/board_test.rb
+- test/fake_serial_port.rb