dino 0.9.1 → 0.10.0

data/README.md

@@ -1,19 +1,41 @@
 # Welcome to Dino
 [![Build Status](https://secure.travis-ci.org/austinbv/dino.png)](http://travis-ci.org/austinbv/dino)
 
-## Get started in no time
+## Get Started In No Time
+
 Dino was designed to help you start working with your Arduino in minutes.
 
-> * `gem install dino`
-> * Burn the file `src/du.ino` to your Arduino
-> ** You can do this in the [Arduino IDE](http://www.arduino.cc/en/Main/software)
-> * Plug in your Arduino and wire the led like in `examples/led/led.png`
-> * Run `ruby example/led/led.rb`
+#### Install the Gem
+
+```
+gem install dino
+```
+
+#### Upload the Bootstrapper
+
+* Open [the normal Arduino IDE](http://arduino.cc/en/Main/Software)
+* Download the bootstrapper [src/du.ino](https://raw.github.com/austinbv/dino/master/src/du.ino)
+* Open the file in the Arduino IDE
+* Plug in your Arduino via USB
+* Click the upload button (an arrow)
+
+#### Verify Install
+
+* Build the sample circuit [examples/led/led.png](https://raw.github.com/austinbv/dino/master/examples/led/led.png)
+* From your terminal, execute `ruby example/led/led.rb`
+* Observe your LED blinking continuously
 
-By now you should be blinking away
+## Examples and Tutorials
 
+### Circuits and Programs
 
-Take a look in the example directory for more information
+* Take a look in [the example directory](https://github.com/austinbv/dino/tree/master/examples) for small component examples
+* Try [Getting Started with Arduino and Dino](http://tutorials.jumpstartlab.com/projects/arduino/introducing_arduino.html) from [Jumpstart Lab](http://jumpstartlab.com), building a number-guessing game and a simple nightlight
+* An example [rails app using Dino and Pusher](https://github.com/austinbv/dino_rails_example)
+* For a Sinatra example look at the [site used to shoot the cannon at RubyConf2012](https://github.com/austinbv/dino_cannon)
 
+### Explanatory Talks
 
-I gave a [talk on this library at RubyConf](http://confreaks.com/videos/1294-rubyconf2012-arduino-the-ruby-way), you can see the slides here: [Arudino The Ruby Way](https://speakerdeck.com/austinbv/arduino-the-ruby-way)
+* "Arduino the Ruby Way" at RubyConf 2012
+  * [Video by ConFreaks](http://confreaks.com/videos/1294-rubyconf2012-arduino-the-ruby-way)
+  * [Slides on SpeakerDeck](https://speakerdeck.com/austinbv/arduino-the-ruby-way)

data/examples/button/button.rb

@@ -9,15 +9,12 @@ require File.expand_path('../../../lib/dino', __FILE__)
 board = Dino::Board.new(Dino::TxRx.new)
 button = Dino::Components::Button.new(pin: 13, board: board)
 
-button_down = Proc.new do
+button.down do
   puts "button down"
 end
 
-button_up = Proc.new do
+button.up do
   puts "button up"
 end
 
-button.down(button_down)
-button.up(button_up)
-
 sleep

data/examples/servo.rb

@@ -1,8 +1,5 @@
 #
-# This is an example of how to use the button class
-# You must register helpers and have the main thread
-# sleep or in someway keep running or your program
-# will exit before any callbacks can be called
+# This is an example of how to use the servo class
 #
 
 require File.expand_path('../../lib/dino', __FILE__)

data/examples/telnet.rb

@@ -0,0 +1,28 @@
+#
+# Example showing how to access an Arduino over a telnet connection.
+# Running ser2net on the machine that the Arduino is connected to will serve up the serial interface over telnet.
+# You can then communicate with that Arduino over your local network or the Internet.
+# 
+# Example ser2net command for an Arduino UNO on Mac:
+# ser2net -u -C "9000:raw:0:/dev/cu.usbmodem621:115200"
+# 
+# Replace 9000 with the port number you want to use and /dev/cu.usbmodem621 with your Arduino device.
+# Arduino UNOs are usually /dev/ACM0 under Linux.
+#
+# ser2net is preinstalled on many Linuxes. Install ser2net on Mac with:
+# brew install ser2net
+#
+# http://sourceforge.net/projects/ser2net/ for more info on configuring ser2net.
+#
+
+require File.expand_path('../../lib/dino', __FILE__)
+
+# The host and port for the telnet connection must be passed in as arguments.
+connection = Dino::TxRx::Telnet.new("localhost", 9000)
+board = Dino::Board.new(connection)
+led = Dino::Components::Led.new(pin: 13, board: board)
+
+[:on, :off].cycle do |switch|
+  led.send(switch)
+  sleep 0.5
+end

data/lib/dino/components/button.rb

@@ -11,11 +11,11 @@ module Dino
         self.board.start_read
       end
 
-      def down(callback)
+      def down(&callback)
         @down_callbacks << callback
       end
 
-      def up(callback)
+      def up(&callback)
         @up_callbacks << callback
       end
 

data/lib/dino/tx_rx.rb

@@ -1,67 +1,10 @@
-require 'serialport'
-require 'observer'
-
 module Dino
-  class TxRx
-    include Observable
-
-    BAUD = 115200
-
-    def initialize
-      @first_write = true
-    end
-
-    def io
-      raise BoardNotFound unless @io ||= find_arduino
-      @io
-    end
-
-    def io=(device)
-      @io = SerialPort.new(device, BAUD)
-    end
-
-    def read
-      @thread ||= Thread.new do
-        loop do
-          if IO.select([io], nil, nil, 0.005)
-            pin, message = *io.gets.chop.split(/::/)
-            pin && message && changed && notify_observers(pin, message)
-          end
-          sleep 0.004
-        end
-      end
-    end
-
-    def close_read
-      return nil if @thread.nil?
-      Thread.kill(@thread)
-      @thread = nil
-    end
-
-    def write(message)
-      IO.select(nil, [io], nil)
-      io.puts(message)
-    end
-
-    private
-
-    def tty_devices
-      if RUBY_PLATFORM.include?("mswin") || RUBY_PLATFORM.include?("mingw")
-        ["COM1", "COM2", "COM3", "COM4"]
-      else
-        `ls /dev`.split("\n").grep(/usb|ACM/).map{|d| "/dev/#{d}"}
-      end
-    end
+  module TxRx
+    require 'dino/tx_rx/usb_serial'
+    require 'dino/tx_rx/telnet'
 
-    def find_arduino
-      tty_devices.map do |device|
-        next if device.match /^cu/
-        begin
-          SerialPort.new(device, BAUD)
-        rescue
-          nil
-        end
-      end.compact.first
+    def self.new
+      self::USBSerial.new
     end
   end
-end
+end

data/lib/dino/tx_rx/telnet.rb

@@ -0,0 +1,53 @@
+require 'net/telnet'
+require 'observer'
+
+module Dino
+  module TxRx
+    class Telnet
+      include Observable
+
+      def initialize(host, port)
+        @host, @port = host, port
+        @read_buffer = ""
+      end
+
+      def io
+        @io ||= connect
+      end
+
+      def read
+        @thread ||= Thread.new do
+          loop do
+            io.waitfor("\n") do |text|
+              @read_buffer += text
+              while line = @read_buffer.slice!(/^.*\n/) do
+                pin, message = line.chop.split(/::/)
+                pin && message && changed && notify_observers(pin, message)
+              end
+            end
+            sleep 0.004
+          end
+        end
+      end
+
+      def close_read
+        return nil if @thread.nil?
+        Thread.kill(@thread)
+        @read_buffer = ""
+        @thread = nil
+      end
+
+      def write(message)
+        io.puts(message)
+      end
+
+    private
+    
+      def connect
+        Net::Telnet.new("Host" => @host, "Port" => @port)
+      rescue
+        raise BoardNotFound
+      end
+    end
+  end
+end

data/lib/dino/tx_rx/usb_serial.rb

@@ -0,0 +1,69 @@
+require 'serialport'
+require 'observer'
+
+module Dino
+  module TxRx
+    class USBSerial
+      include Observable
+
+      BAUD = 115200
+
+      def initialize
+        @first_write = true
+      end
+
+      def io
+        raise BoardNotFound unless @io ||= find_arduino
+        @io
+      end
+
+      def io=(device)
+        @io = SerialPort.new(device, BAUD)
+      end
+
+      def read
+        @thread ||= Thread.new do
+          loop do
+            if IO.select([io], nil, nil, 0.005)
+              pin, message = *io.gets.chop.split(/::/)
+              pin && message && changed && notify_observers(pin, message)
+            end
+            sleep 0.004
+          end
+        end
+      end
+
+      def close_read
+        return nil if @thread.nil?
+        Thread.kill(@thread)
+        @thread = nil
+      end
+
+      def write(message)
+        IO.select(nil, [io], nil)
+        io.puts(message)
+      end
+
+      private
+
+      def tty_devices
+        if RUBY_PLATFORM.include?("mswin") || RUBY_PLATFORM.include?("mingw")
+          ["COM1", "COM2", "COM3", "COM4"]
+        else
+          `ls /dev`.split("\n").grep(/usb|ACM/).map{|d| "/dev/#{d}"}
+        end
+      end
+
+      def find_arduino
+        tty_devices.map do |device|
+          next if device.match /^cu/
+          begin
+            SerialPort.new(device, BAUD)
+          rescue
+            nil
+          end
+        end.compact.first
+      end
+    end
+  end
+end

data/lib/dino/version.rb

@@ -1,3 +1,3 @@
 module Dino
-  VERSION = "0.9.1"
+  VERSION = "0.10.0"
 end

data/spec/lib/components/button_spec.rb

@@ -29,52 +29,88 @@ module Dino
         let(:button) {Button.new(board: board, pin: mock)}
         describe '#down' do
           it 'should add a callback to the down_callbacks array' do
-            button.down(callback_mock = mock)
-            button.instance_variable_get(:@down_callbacks).should include callback_mock
+            callback = mock
+            button.down do 
+              callback.called
+            end
+            down_callbacks = button.instance_variable_get(:@down_callbacks)
+            down_callbacks.size.should == 1
+            callback.should_receive(:called)
+            down_callbacks.first.call
           end
         end
 
         describe '#up' do
           it 'should add a callback to the up_callbacks array' do
-            button.up(callback_mock = mock)
-            button.instance_variable_get(:@up_callbacks).should include callback_mock
+            callback = mock
+            button.up do 
+              callback.called
+            end
+            up_callbacks = button.instance_variable_get(:@up_callbacks)
+            up_callbacks.size.should == 1
+            callback.should_receive(:called)
+            up_callbacks.first.call
           end
         end
 
         describe '#update' do
           it 'should call the down callbacks' do
-            button.down(callback_mock1 = mock)
-            button.down(callback_mock2 = mock)
-            callback_mock1.should_receive(:call)
-            callback_mock2.should_receive(:call)
+            callback_1 = mock
+            button.down do 
+              callback_1.called
+            end
+            
+            callback_2 = mock
+            button.down do 
+              callback_2.called
+            end
+            callback_1.should_receive(:called)
+            callback_2.should_receive(:called)
             button.update(Button::DOWN)
           end
 
           it 'should call the up callbacks' do
-            button.up(callback_mock1 = mock)
-            button.up(callback_mock2 = mock)
+            callback_1 = mock
+            button.up do 
+              callback_1.called
+            end
+            
+            callback_2 = mock
+            button.up do 
+              callback_2.called
+            end
 
             button.instance_variable_set(:@state, Button::DOWN)
 
-            callback_mock1.should_receive(:call)
-            callback_mock2.should_receive(:call)
+            callback_1.should_receive(:called)
+            callback_2.should_receive(:called)
             button.update(Button::UP)
           end
 
           it 'should not call the callbacks if the state has not changed' do
-            button.up(callback_mock = mock)
+            callback = mock
+            button.up do
+              callback.called
+            end
 
-            callback_mock.should_not_receive(:call)
+            callback.should_not_receive(:called)
             button.update(Button::UP)
             button.update(Button::UP)
           end
 
           it 'should not call the callbacks if the data is not UP or DOWN' do
-            button.up(callback_mock1 = mock)
-            button.down(callback_mock2 = mock)
+            callback_1 = mock
+            button.up do 
+              callback_1.called
+            end
 
-            callback_mock1.should_not_receive(:call)
-            callback_mock2.should_not_receive(:call)
+            callback_2 = mock
+            button.down do 
+              callback_2.called
+            end
+
+            callback_1.should_not_receive(:called)
+            callback_2.should_not_receive(:called)
             button.update('foobarred')
           end
         end

data/spec/lib/tx_rx/telnet_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+module Dino
+  describe TxRx::Telnet do
+
+    before :each do
+      @mock_telnet = mock
+      Net::Telnet.stub(:new) { @mock_telnet }
+      @instance = TxRx::Telnet.new("127.0.0.1", 3001)
+    end 
+
+    describe '#connect' do
+      it 'should raise a BoardNotFound exception if it cannot connect to the server' do
+        Net::Telnet.stub(:new).and_raise
+        @instance = TxRx::Telnet.new("0.0.0.0", 999999)
+        expect { @instance.io }.to raise_exception BoardNotFound
+      end
+    end
+
+    describe '#io' do
+      it 'should set io to a new telnet connection with the specified host and port' do
+        Net::Telnet.should_receive(:new).with("Host" => "127.0.0.1", "Port" => 3001)
+        @instance.io
+      end
+
+      it 'should use the existing io instance if set' do
+        Net::Telnet.should_receive(:new).exactly(1).times.with("Host" => "127.0.0.1", "Port" => 3001)
+        2.times { @instance.io }
+      end
+    end
+
+    describe '#read' do
+      it 'should create a new thread' do
+        Thread.should_receive :new
+        @instance.read
+      end
+
+      it 'should get messages from the device' do
+        Thread.should_receive(:new).and_yield
+        @instance.should_receive(:loop).and_yield
+        @instance.io.should_receive(:waitfor).with("\n").and_yield("foo::bar\n")
+        @instance.should_receive(:changed).and_return(true)
+        @instance.should_receive(:notify_observers).with('foo','bar')
+
+        @instance.read
+      end
+    end
+
+    describe '#close_read' do
+      it 'should kill the reading thread' do
+        @instance.instance_variable_set(:@thread, mock_thread = mock)
+        Thread.should_receive(:kill).with(mock_thread)
+        @instance.read
+        @instance.close_read
+      end
+    end
+
+    describe '#write' do
+      it 'should write to the device' do
+        @mock_telnet.should_receive(:puts).with("foo::bar")
+        @instance.write("foo::bar")
+      end
+    end
+
+  end
+end

data/spec/lib/{tx_rx_spec.rb → tx_rx/usb_serial_spec.rb}

@@ -1,12 +1,12 @@
 require 'spec_helper'
 
 module Dino
-  describe TxRx do
+  describe TxRx::USBSerial do
     it { should be }
 
     describe '#initialize' do
       it 'should set first_write to false' do
-        TxRx.new.instance_variable_get(:@first_write).should == true
+        TxRx::USBSerial.new.instance_variable_get(:@first_write).should == true
       end
     end
 
@@ -16,10 +16,10 @@ module Dino
           original_platform = RUBY_PLATFORM
           RUBY_PLATFORM = "mswin"
           subject.should_receive(:tty_devices).and_return(["COM1", "COM2", "COM3", "COM4"])
-          SerialPort.should_receive(:new).with('COM1', TxRx::BAUD).and_return(mock_serial = mock)
-          SerialPort.should_receive(:new).with('COM2', TxRx::BAUD).and_return(mock)
-          SerialPort.should_receive(:new).with('COM3', TxRx::BAUD).and_return(mock)
-          SerialPort.should_receive(:new).with('COM4', TxRx::BAUD).and_return(mock)
+          SerialPort.should_receive(:new).with('COM1', TxRx::USBSerial::BAUD).and_return(mock_serial = mock)
+          SerialPort.should_receive(:new).with('COM2', TxRx::USBSerial::BAUD).and_return(mock)
+          SerialPort.should_receive(:new).with('COM3', TxRx::USBSerial::BAUD).and_return(mock)
+          SerialPort.should_receive(:new).with('COM4', TxRx::USBSerial::BAUD).and_return(mock)
 
           subject.io.should == mock_serial
           RUBY_PLATFORM = original_platform
@@ -29,9 +29,9 @@ module Dino
       context "on unix" do
         it 'should instantiate a new SerialPort for each usb tty device found' do
           subject.should_receive(:tty_devices).and_return(['/dev/tty1.usb', '/dev/tty1.usb', '/dev/tty.ACM0'])
-          SerialPort.should_receive(:new).with('/dev/tty1.usb', TxRx::BAUD).and_return(mock_serial = mock)
-          SerialPort.should_receive(:new).with('/dev/tty1.usb', TxRx::BAUD).and_return(mock)
-          SerialPort.should_receive(:new).with('/dev/tty.ACM0', TxRx::BAUD).and_return(mock)
+          SerialPort.should_receive(:new).with('/dev/tty1.usb', TxRx::USBSerial::BAUD).and_return(mock_serial = mock)
+          SerialPort.should_receive(:new).with('/dev/tty1.usb', TxRx::USBSerial::BAUD).and_return(mock)
+          SerialPort.should_receive(:new).with('/dev/tty.ACM0', TxRx::USBSerial::BAUD).and_return(mock)
 
           subject.io.should == mock_serial
         end
@@ -53,7 +53,7 @@ module Dino
 
     describe '#io=' do
       it 'should set io to a new serial port with the specified device' do
-        SerialPort.should_receive(:new).with('/dev/tty1.usb', TxRx::BAUD).and_return(mock_serial = mock)
+        SerialPort.should_receive(:new).with('/dev/tty1.usb', TxRx::USBSerial::BAUD).and_return(mock_serial = mock)
         subject.io = '/dev/tty1.usb'
         subject.instance_variable_get(:@io).should == mock_serial
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dino
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-20 00:00:00.000000000 Z
+date: 2013-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: serialport
@@ -54,6 +54,7 @@ files:
 - examples/servo.rb
 - examples/stepper/stepper.png
 - examples/stepper/stepper.rb
+- examples/telnet.rb
 - lib/dino.rb
 - lib/dino/board.rb
 - lib/dino/board_not_found.rb
@@ -67,6 +68,8 @@ files:
 - lib/dino/components/servo.rb
 - lib/dino/components/stepper.rb
 - lib/dino/tx_rx.rb
+- lib/dino/tx_rx/telnet.rb
+- lib/dino/tx_rx/usb_serial.rb
 - lib/dino/version.rb
 - spec/lib/board_not_found_spec.rb
 - spec/lib/board_spec.rb
@@ -77,7 +80,8 @@ files:
 - spec/lib/components/sensor_spec.rb
 - spec/lib/components/servo_spec.rb
 - spec/lib/components/stepper_spec.rb
-- spec/lib/tx_rx_spec.rb
+- spec/lib/tx_rx/telnet_spec.rb
+- spec/lib/tx_rx/usb_serial_spec.rb
 - spec/spec_helper.rb
 - src/du.ino
 homepage: https://github.com/austinbv/dino
@@ -114,5 +118,6 @@ test_files:
 - spec/lib/components/sensor_spec.rb
 - spec/lib/components/servo_spec.rb
 - spec/lib/components/stepper_spec.rb
-- spec/lib/tx_rx_spec.rb
+- spec/lib/tx_rx/telnet_spec.rb
+- spec/lib/tx_rx/usb_serial_spec.rb
 - spec/spec_helper.rb