dino 0.10.0 → 0.11.2

data/src/lib/Dino.h

@@ -0,0 +1,85 @@
+/*
+  Library for dino ruby gem.
+*/
+
+#ifndef Dino_h
+#define Dino_h
+
+#include "Arduino.h"
+#include <Servo.h>
+
+// Allocate listener storage based on what board we're running.
+#if defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)
+#  define PIN_COUNT 70
+#  define SERVO_OFFSET 22
+#else
+#  define PIN_COUNT 22
+#  define SERVO_OFFSET 2
+#endif
+
+// Uncomment this line to enable debugging mode.
+// #define debug true
+
+class Dino {
+  public:
+    Dino();
+    void setupWrite(void (*writeCallback)(char *str));
+    void parse(char c);
+    void process();
+    void updateListeners();
+    
+  private:
+    // Manage heartbeat and listeners.
+    long heartRate;
+    long lastUpdate;
+    unsigned int loopCount;
+    unsigned int analogDivider;
+    
+    // Storage for enough analog and digital listeners for UNO or Nano board.
+    // Correspond to raw pin number by array index, and store boolean. false == disabled.
+    boolean analogListeners[PIN_COUNT];
+    boolean digitalListeners[PIN_COUNT];
+    
+    // Keep track of the last read values for digital listeners. Only write responses when changed.
+    byte digitalListenerValues[PIN_COUNT];
+    
+    // Request storage.
+    char request[8];
+    int index;
+    char cmdStr[3];
+    byte cmd;
+    char pinStr[3];
+    byte pin;
+    char valStr[4];
+    int val;
+    
+    // Value and response storage.
+    int rval;
+    char response[8];
+    void (*_writeCallback)(char *str);
+    void writeResponse();
+
+    Servo servos[12];
+
+    // API-accessible functions.
+    void setMode               ();
+    void dWrite                (); 
+    void dRead                 ();
+    void aWrite                ();
+    void aRead                 ();
+    void addDigitalListener    ();
+    void addAnalogListener     ();
+    void removeListener        ();
+    void servoToggle           ();
+    void servoWrite            ();
+    void reset                 ();
+    void setAnalogDivider      ();
+    void setHeartRate          ();
+
+    // Internal functions.
+    long timeSince              (long event);
+    void updateDigitalListeners ();
+    void updateAnalogListeners  ();
+};
+
+#endif

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dino
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-16 00:00:00.000000000 Z
+date: 2013-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: serialport
@@ -31,30 +31,34 @@ description: ! "A utility library for interfacting with an Arduino.\n  Designed
   control, expansion, and with love."
 email:
 - austinbv@gmail.com
-executables: []
+executables:
+- dino
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
 - .rvmrc
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- bin/dino
 - dino.gemspec
 - examples/button/button.png
 - examples/button/button.rb
-- examples/ir_receiver.rb
+- examples/ethernet.rb
+- examples/ir_receiver/ir_receiver.rb
 - examples/led/led.png
 - examples/led/led.rb
-- examples/potentiometer.rb
-- examples/rgb_led.rb
-- examples/sensor.rb
-- examples/servo.rb
+- examples/potentiometer/potentiometer.rb
+- examples/rgb_led/rgb_led.rb
+- examples/sensor/sensor.rb
+- examples/ser2net.rb
+- examples/servo/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
@@ -68,8 +72,9 @@ 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/tx_rx/base.rb
+- lib/dino/tx_rx/serial.rb
+- lib/dino/tx_rx/tcp.rb
 - lib/dino/version.rb
 - spec/lib/board_not_found_spec.rb
 - spec/lib/board_spec.rb
@@ -80,10 +85,13 @@ files:
 - spec/lib/components/sensor_spec.rb
 - spec/lib/components/servo_spec.rb
 - spec/lib/components/stepper_spec.rb
-- spec/lib/tx_rx/telnet_spec.rb
-- spec/lib/tx_rx/usb_serial_spec.rb
+- spec/lib/tx_rx/serial_spec.rb
+- spec/lib/tx_rx/tcp_spec.rb
 - spec/spec_helper.rb
-- src/du.ino
+- src/du/du.ino
+- src/du_ethernet/du_ethernet.ino
+- src/lib/Dino.cpp
+- src/lib/Dino.h
 homepage: https://github.com/austinbv/dino
 licenses: []
 post_install_message: 
@@ -107,7 +115,7 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Control your arduino through a serial port
+summary: Control your Arduino with Ruby.
 test_files:
 - spec/lib/board_not_found_spec.rb
 - spec/lib/board_spec.rb
@@ -118,6 +126,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/telnet_spec.rb
-- spec/lib/tx_rx/usb_serial_spec.rb
+- spec/lib/tx_rx/serial_spec.rb
+- spec/lib/tx_rx/tcp_spec.rb
 - spec/spec_helper.rb

data/examples/servo.rb

@@ -1,13 +0,0 @@
-#
-# This is an example of how to use the servo class
-#
-
-require File.expand_path('../../lib/dino', __FILE__)
-
-board = Dino::Board.new(Dino::TxRx.new)
-servo = Dino::Components::Servo.new(pin: 9, board: board)
-
-loop do
-  servo.position += 9
-  sleep 0.5
-end

data/examples/telnet.rb

@@ -1,28 +0,0 @@
-#
-# 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/tx_rx/telnet.rb

@@ -1,53 +0,0 @@
-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

@@ -1,69 +0,0 @@
-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/spec/lib/tx_rx/telnet_spec.rb

@@ -1,66 +0,0 @@
-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/usb_serial_spec.rb

@@ -1,101 +0,0 @@
-require 'spec_helper'
-
-module Dino
-  describe TxRx::USBSerial do
-    it { should be }
-
-    describe '#initialize' do
-      it 'should set first_write to false' do
-        TxRx::USBSerial.new.instance_variable_get(:@first_write).should == true
-      end
-    end
-
-    describe '#io' do
-      context "on windows" do
-        it 'should instantiate a new SerialPort for each usb tty device found' do
-          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::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
-        end
-      end
-
-      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::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
-      end
-
-      it 'should use the existing io instance if set' do
-        subject.should_not_receive(:tty_devices)
-        SerialPort.stub(:new).and_return(mock_serial = mock)
-
-        subject.io = '/dev/tty1.usb'
-        subject.io.should == mock_serial
-      end
-
-      it 'should raise a BoardNotFound exception if there is no board connected' do
-        SerialPort.stub(:new).and_raise
-        expect { subject.io }.to raise_exception BoardNotFound
-      end
-    end
-
-    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::USBSerial::BAUD).and_return(mock_serial = mock)
-        subject.io = '/dev/tty1.usb'
-        subject.instance_variable_get(:@io).should == mock_serial
-      end
-    end
-
-    describe '#read' do
-      it 'should create a new thread' do
-        Thread.should_receive :new
-        subject.read
-      end
-
-      it 'should get messages from the device' do
-        subject.stub(:io).and_return(mock_serial = mock)
-
-        IO.should_receive(:select).and_return(true)
-        Thread.should_receive(:new).and_yield
-        subject.should_receive(:loop).and_yield
-        mock_serial.should_receive(:gets).and_return("foo::bar\n")
-        subject.should_receive(:changed).and_return(true)
-        subject.should_receive(:notify_observers).with('foo','bar')
-
-        subject.read
-      end
-    end
-
-    describe '#close_read' do
-      it 'should kill the reading thread' do
-        subject.instance_variable_set(:@thread, mock_thread = mock)
-        Thread.should_receive(:kill).with(mock_thread)
-        subject.read
-        subject.close_read
-      end
-    end
-
-    describe '#write' do
-      it 'should write to the device' do
-        IO.should_receive(:select).and_return(true)
-
-        subject.stub(:io).and_return(mock_serial = mock)
-        mock_serial.should_receive(:puts).with('a message')
-        subject.write('a message')
-      end
-    end
-  end
-end