firmata 0.0.3 → 0.0.4

data/.gitignore

@@ -15,4 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-.rvmrc
+.rvmrc
+harness.rb

data/README.md

@@ -26,6 +26,9 @@ Or install it yourself as:
 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.

data/firmata.gemspec

@@ -15,6 +15,8 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Firmata::VERSION
 
+  gem.add_development_dependency("pry")
+
   gem.add_runtime_dependency("serialport", ["~> 1.1.0"])
   gem.add_runtime_dependency("event_spitter")
 end

data/lib/firmata/board.rb

@@ -69,6 +69,9 @@ module Firmata
     # 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)
       @serial_port = port.is_a?(String) ? SerialPort.new(port, 57600, 8, 1, SerialPort::NONE) : port
       @serial_port.read_timeout = 2
@@ -79,10 +82,16 @@ module Firmata
       @connected = false
     end
 
+    # Pubilc: Check if a connection to Arduino has been made.
+    #
+    # Returns Boolean connected state.
     def connected?
       @connected
     end
 
+    # Public: Make connection to Arduio.
+    #
+    # Returns Firmata::Board board.
     def connect
       unless @connected
         once('report_version', ->() do
@@ -117,22 +126,24 @@ module Firmata
     #
     # Returns nothing.
     def write(*commands)
-      serial_port.write(commands.map(&:chr).join)
+      serial_port.write_nonblock(commands.map(&:chr).join)
     end
 
     # Internal: Read data from the underlying serial port.
     #
-    # Returns Enumerator of bytes.
+    # Returns String data read for serial port.
     def read
-      serial_port.bytes
+      serial_port.read_nonblock(4096)
+    rescue EOFError
     end
 
     # Internal: Process a series of bytes.
     #
-    # bytes: An Enumerator of bytes
+    # data: The String data to process.
     #
     # Returns nothing.
-    def process(bytes)
+    def process(data)
+      bytes = StringIO.new(String(data)).bytes
       bytes.each do |byte|
         case byte
         when REPORT_VERSION
@@ -152,6 +163,21 @@ module Firmata
             pins[analog_pin].value = 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)
+            end
+          end
+
         when START_SYSEX
           current_buffer = [byte]
           begin
@@ -215,7 +241,7 @@ module Firmata
             emit('firmware_query')
 
           else
-            # TODO decide what to do with unknown message
+            puts 'bad byte'
           end
         end
       end
@@ -244,10 +270,10 @@ module Firmata
     #
     # Examples
     #
-    #   pin_mode(13, OUTPUT)
+    #   set_pin_mode(13, OUTPUT)
     #
     # Returns nothing.
-    def pin_mode(pin, mode)
+    def set_pin_mode(pin, mode)
       pins[pin].mode = mode
       write(PIN_MODE, pin, mode)
     end
@@ -325,6 +351,7 @@ module Firmata
       write(START_SYSEX, ANALOG_MAPPING_QUERY, END_SYSEX)
     end
 
+
     # Internal: Toggle the pin analog and digtal reporting off and on.
     #
     # state - The Integer to turn the pin on (1) or off (0).
@@ -340,14 +367,14 @@ module Firmata
     # Public: Turn pin analog and digital reporting on.
     #
     # Returns nothing.
-    def turn_pin_reporting_on
+    def start_pin_reporting
       toggle_pin_reporting(1)
     end
 
     # Public: Turn pin analog and digital reporting off.
     #
     # Returns nothing.
-    def turn_pin_reporting_off
+    def stop_pin_reporting
       toggle_pin_reporting(0)
     end
   end

data/lib/firmata/version.rb

@@ -1,3 +1,3 @@
 module Firmata
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/test/board_test.rb

@@ -15,7 +15,7 @@ class BoardTest < MiniTest::Unit::TestCase
       yield mock_port
     else
       expected = args.map(&:chr).join
-      mock_port.expect(:write, 1, [expected])
+      mock_port.expect(:write_nonblock, 1, [expected])
     end
 
     mock_port
@@ -75,15 +75,33 @@ class BoardTest < MiniTest::Unit::TestCase
     assert_equal 6, board.analog_pins.size
   end
 
-  def test_write_pin_mode
+  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.pin_mode(13, Firmata::Board::OUTPUT)
+    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
@@ -108,30 +126,30 @@ class BoardTest < MiniTest::Unit::TestCase
     assert_equal Firmata::Board::OUTPUT, board.pins[13].mode
   end
 
-  def test_write_turn_pin_reporting_on
+  def test_start_pin_reporting
     mock_sp = mock_serial_port do |mock|
       16.times do |i|
-        mock.expect(:write, 2, [[Firmata::Board::REPORT_DIGITAL | i, 1].map(&:chr).join])
-        mock.expect(:write, 2, [[(Firmata::Board::REPORT_ANALOG | i), 1].map(&:chr).join])
+        mock.expect(:write_nonblock, 2, [[Firmata::Board::REPORT_DIGITAL | i, 1].map(&:chr).join])
+        mock.expect(:write_nonblock, 2, [[(Firmata::Board::REPORT_ANALOG | i), 1].map(&:chr).join])
       end
     end
 
     board = Firmata::Board.new(mock_sp)
-    board.turn_pin_reporting_on
+    board.start_pin_reporting
 
     mock_sp.verify
   end
 
-  def test_turn_pin_reporting_off
+  def test_stop_pin_reporting
     mock_sp = mock_serial_port do |mock|
       16.times do |i|
-        mock.expect(:write, 2, [[Firmata::Board::REPORT_DIGITAL | i, 0].map(&:chr).join])
-        mock.expect(:write, 2, [[(Firmata::Board::REPORT_ANALOG | i), 0].map(&:chr).join])
+        mock.expect(:write_nonblock, 2, [[Firmata::Board::REPORT_DIGITAL | i, 0].map(&:chr).join])
+        mock.expect(:write_nonblock, 2, [[(Firmata::Board::REPORT_ANALOG | i), 0].map(&:chr).join])
       end
     end
 
     board = Firmata::Board.new(mock_sp)
-    board.turn_pin_reporting_off
+    board.stop_pin_reporting
 
     mock_sp.verify
   end

data/test/fake_serial_port.rb

@@ -40,6 +40,7 @@ class FakeSerialPort
     @buffer << val
     val.length
   end
+  alias_method :write_nonblock, :write
 
   def bytes
     bytes = StringIO.new(@buffer).bytes
@@ -47,7 +48,8 @@ class FakeSerialPort
     bytes
   end
 
-  def read
-    @buffer.read
+  def read(size)
+    @buffer
   end
+  alias_method :read_nonblock, :read
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: firmata
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-18 00:00:00.000000000 Z
+date: 2012-08-20 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: serialport
   requirement: !ruby/object:Gem::Requirement