minilab 2.0.0-x86-mingw32

data/.document

@@ -0,0 +1,2 @@
+README.rdoc
+lib/minilab.rb

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+minilab*.gem

data/CHANGES

@@ -0,0 +1,22 @@
+== 2.0.0
+* minilab now requires Ruby 1.9 to run and is built for the RubyInstaller package.
+  minilab's public interface has not changed.
+* Now using the latest and greatest bundler techniques for gem development.
+* Two libraries minilab used for testing (hardmock and systir) do not run on Ruby 1.9. Therefore, minilab now uses:
+** RSpec as a test harness
+** steak as an acceptance test harness
+** rr for mocking in unit tests
+
+== 1.1.1
+* Lots of little things changed as part of the Rubyforge -> Gemcutter/GitHub/rdoc.info migration
+  minilab's public interface has not changed.
+* Using bundler to package what gems.
+
+== 1.1.0
+* Conversion from native extension to FFI
+* Upgraded diy, constructor, and hardmock to their latest versions
+* Internal implementation changes. minilab's public interface is unchanged
+* Integration tests removed, as the value they provide did not outweigh the maintenance burden
+
+== 1.0.0
+First release

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2007-2011 Atomic Object LLC
+
+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.rdoc

@@ -0,0 +1,101 @@
+== About
+
+minilab is a Ruby library for Measurement Computing's miniLAB 1008 device. The minilab library provides a simple interface to several of the miniLAB 1008's analog and digital IO functions. I've used the miniLAB to control the input and examine the output from our embedded devices; the minilab library allowed us to use automated system testing tools for Ruby.
+
+minilab does not work with other Measurement Computing devices, but could be extended to do so.
+
+=== Ruby 1.9
+The minilab gem now requires Ruby 1.9 to run. The gem is built to run on the RubyInstaller package. minilab's public interface has not changed as part of the Ruby 1.9 migration.
+
+If you're looking for Ruby 1.8 support, try using the 1.1.0 version of the gem. The code is available in the git repository via the v1.1.0 tag.
+
+== Installation
+
+1. Install the minilab gem onto your system or unpack it into a local directory in your project. Install Measurement Computing's Universal Library and InstaCal software; both come on CDs with the device.
+
+1. Plug in the device and then fire up the InstaCal software. Go to Install -> Configure in the menus and the Custom Serial Number to 253, No. of Channels to 8 Single Ended, and Trigger Source to DIO0. Use the Flash LED button to ensure that InstaCal can communicate with the device (I've never had a problem with this). Although I don't think the Custom Serial Number and Trigger Source make much difference to my library, the No. of Channels is important (see Known limitations below).
+
+1. That should be it---you should now be able to require 'minilab', create a minilab object, and connect to it. If you can't, please contact me! I've only installed this on a limited number of computers, so I'd like to hear about problems with the library installation, gem installation, LOAD_PATH, etc.
+
+== Usage
+=== Build and connect
+
+First you'll need to build the Minilab object; use the +Minilab.build+ method to do this. The method is important to use instead of +new+, since it takes care of a lot of behind-the-scenes object construction for you.
+
+After building the object, use the +connect+ method. This will establish the connection to the library. None of the other methods will work until you connect.
+
+Example:
+
+  minilab = Minilab.build
+  minilab.connect
+
+=== Reading and writing data
+
+I've created methods for reading and writing both digital and analog data from the device. Analog data goes through the read and write pins on the top of the device; no configuration is needed for the analog methods.
+
+Digital data goes through either the DIO pins on the top of the device or the digital ports on the DB37 port. If you're using the DIO pins, then you don't need to do any configuration. If you're using the DB37 pins, then you'll need to configure the appropriate port for input and output. You can find a mapping of DB37 pin numbers to ports either in Measurement Computing's miniLAB 1008 data sheet or at the end of this README.
+
+Check out the read and write analog and read, write, and configure digital methods in the Minilab document for more information.
+
+Example:
+
+  minilab.configure_input_port(:portb)
+  value = minilab.read_digital_byte(:portb)
+  assert_equal 12, value, "wrong value read for system time"
+
+The adventurous may also want to look at the included acceptance tests for the device, since they are examples of how to use the device and are not contrived.
+
+== Tests
+
+The minilab library comes with unit and acceptance tests. The unit tests stress individual units and can run without any hardware plugged in. The acceptance tests represent real use cases for the software when plugged into hardware.
+
+See the end of this document for an outline of how a miniLAB and DB37 connector should be set up in order to run the system tests.
+
+== Known limitations
+
+* Ruby 1.8 is no longer supported.
+
+* The minilab library only supports one device plugged in at a time. I could add support for multiple devices, but since I only have one, I haven't bothered adding support for more than one.
+
+* I never got around to writing out an entire digital byte because I never needed it.
+
+* Reading analog values only supports single-ended mode. As you can probably guess, I didn't need differential mode, so I didn't add support for it.
+
+== Contact information
+* Matt Fletcher <fletcher@atomicobject.com>
+* Atomic Object <http://atomicobject.com>
+
+== Appendix
+=== DB37 pin to port mapping
+Pin:: Port
+30-37:: :porta
+3-10:: :portb
+26-29:: :portcl
+22-25:: :portch
+
+=== System test setup
+
+On top of the miniLAB:
+CH0 IN:: D/A OUT 1
+CH1 IN:: GND
+CH2 IN:: DIO0
+CH4 IN:: PC 5V
+CH6 IN:: D/A OUT 0
+DIO0:: DIO3
+DIO1:: PC 5V
+DIO2:: GND
+
+On the DB37 pins:
+3:: 11
+4:: 11
+5:: 28
+6:: 11
+7:: 36
+8:: 11
+9:: 11
+10:: 20
+22:: 27
+23:: 21
+24:: 34
+25:: 21
+30:: 21

data/Rakefile

@@ -0,0 +1,25 @@
+require "rake/rdoctask"
+require "rspec/core/rake_task"
+
+desc "Run the unit specs"
+task :default => "spec:unit"
+
+namespace :spec do
+  RSpec::Core::RakeTask.new(:unit) do |t|
+    t.pattern = "spec/unit/**/*_spec.rb"
+  end
+
+  RSpec::Core::RakeTask.new(:acceptance) do |t|
+    t.pattern = "spec/acceptance/**/*_spec.rb"
+  end
+
+  desc "all tests"
+  task :all => %w[ spec:unit spec:acceptance ]
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "minilab: Ruby library for the miniLAB 1008"
+  rdoc.options = %w[ --main README.rdoc --title minilab ]
+  rdoc.rdoc_files.include("lib/minilab.rb", "README.rdoc", "CHANGES", "LICENSE")
+end

data/doc/minilab_systest_setup.txt

@@ -0,0 +1,38 @@
+Setting up new Minilab hardware:
+1) Get it out of the packaging.
+2) Install the Minilab software (InstaCal, universal library are most important).
+3) Plug in the Minilab
+4) Fire up the InstaCal software. Configure the board:
+   - Custom Serial No.  253
+   - No. Of Channels    8 Single Ended
+   - Trigger Source     DIO0
+   This configuration should work with the config file I have in the minilab driver
+   directories.
+5) Wire up the minilab. Use the below wiring:
+
+On top of the minilab:
+CH0 IN  <--->  D/A OUT 1
+CH1 IN  <--->  GND
+CH2 IN  <--->  DIO0
+CH4 IN  <--->  PC +5V
+CH6 IN  <--->  D/A OUT 0
+DIO0    <--->  DIO3
+DIO1    <--->  PC +5V
+DIO2    <--->  GND
+
+On the external digital IO pins:
+3  <---> 11
+4  <---> 11
+5  <---> 28
+6  <---> 11
+7  <---> 36
+8  <---> 11
+9  <---> 11
+10 <---> 20
+22 <---> 27
+23 <---> 21
+24 <---> 34
+25 <---> 21
+30 <---> 21
+
+6) Getrdone.

data/doc/port_mapping.txt

@@ -0,0 +1,2 @@
+    printf ("|     FIRSTPORTA       |       FIRSTPORTB      |FIRSTPORTCL|FIRSTPORTCH|\n ");
+    printf ("0  1  2  3  4  5  6  7  8  9 10 11 12 13 14 15 16 17 18 19 20 21 22 23\n");

data/lib/minilab/analog_io.rb

@@ -0,0 +1,25 @@
+module Minilab
+  class AnalogIo #:nodoc:
+    constructor :minilab_wrapper
+
+    def read_analog(channel)
+      check_channel_range(channel, 0, 7)
+      @minilab_wrapper.read_analog(channel)
+    end
+
+    def write_analog(channel, volts)
+      check_channel_range(channel, 0, 1)
+
+      unless (0.0 .. 5.0) === volts
+        raise "#{volts} volts is out of range for this device; Only voltage between 0.0 and 5.0 is supported."
+      end
+
+      @minilab_wrapper.write_analog(channel, volts)
+    end
+    
+    private
+    def check_channel_range(channel, low, high)
+      raise "Channel #{channel} is out of range." unless (low..high) === channel
+    end
+  end
+end

data/lib/minilab/connection_state.rb

@@ -0,0 +1,15 @@
+module Minilab
+  class ConnectionState
+    def initialize
+      @connected = false
+    end
+
+    def connected?
+      @connected
+    end
+
+    def connected=(value)
+      @connected = value
+    end
+  end
+end

data/lib/minilab/digital_auxport_io.rb

@@ -0,0 +1,36 @@
+module Minilab
+  class DigitalAuxportIo #:nodoc:
+    constructor :minilab_wrapper
+    include MinilabConstants
+
+    VALID_PINS = %w[ DIO0 DIO1 DIO2 DIO3 ]
+
+    def read_digital(pin)
+      validate_pin(pin)
+      configuration = {:direction => DIGITALIN, :pin => get_pin_number(pin)}
+
+      @minilab_wrapper.configure_auxport(configuration)
+      @minilab_wrapper.read_auxport(get_pin_number(pin))
+    end
+
+    def write_digital(pin, value)
+      raise "#{value} is not a valid digital output." if (value < 0)
+      value = 1 if (value > 0)
+
+      validate_pin(pin)
+      configuration = { :direction => DIGITALOUT, :pin => get_pin_number(pin)}
+
+      @minilab_wrapper.configure_auxport(configuration)
+      @minilab_wrapper.write_auxport(get_pin_number(pin), value)
+    end
+
+    private
+    def validate_pin(pin)
+      raise "#{pin} is not a valid digital IO pin" unless VALID_PINS.include?(pin.to_s.upcase)
+    end
+
+    def get_pin_number(pin)
+      pin.match(/(\d)$/)[0].to_i
+    end
+  end
+end

data/lib/minilab/digital_configuration.rb

@@ -0,0 +1,55 @@
+module Minilab
+  class DigitalConfiguration #:nodoc:
+    include MinilabConstants
+    constructor :minilab_wrapper
+
+    PORTS = [:porta, :portb, :portcl, :portch]
+    LIBRARY_PORT_NAMES = {
+      :porta => FIRSTPORTA,
+      :portb => FIRSTPORTB,
+      :portcl => FIRSTPORTCL,
+      :portch => FIRSTPORTCH
+    }
+
+    def setup
+      @port_status = PORTS.inject({}) do |port_status, port|
+        port_status[port] = :not_configured
+        port_status
+      end
+    end
+
+    def configure_port_for_input(port)
+      configure_port(port, DIGITALIN)
+    end
+
+    def configure_port_for_output(port)
+      configure_port(port, DIGITALOUT)
+    end
+
+    def is_port_configured_for_input?(port)
+      check_port_status(port, DIGITALIN)
+    end
+
+    def is_port_configured_for_output?(port)
+      check_port_status(port, DIGITALOUT)
+    end
+    
+    private
+    def is_port_recognized?(port)
+      raise "Port #{port} is not valid." unless PORTS.include?(port)
+    end
+
+    def configure_port(port, direction)
+      is_port_recognized?(port)
+
+      @minilab_wrapper.configure_port(:direction => direction, :port => LIBRARY_PORT_NAMES[port])
+      @port_status[port] = direction
+      true
+    end
+
+    def check_port_status(port, status)
+      is_port_recognized?(port)
+      @port_status[port] == status ? true : false
+    end
+  end
+end

data/lib/minilab/digital_port_io.rb

@@ -0,0 +1,41 @@
+module Minilab
+  class DigitalPortIo #:nodoc:
+    constructor :minilab_wrapper, :digital_configuration, :library_translator
+
+    def configure_input_port(port)
+      @digital_configuration.configure_port_for_input(port)
+    end
+    
+    def configure_output_port(port)
+      @digital_configuration.configure_port_for_output(port)
+    end
+
+    def read_digital(pin)
+      check_pin_configuration(pin, :input)
+      @minilab_wrapper.read_digital_pin(get_library_pin_number(pin))
+    end
+
+    def write_digital(pin, value)
+      check_pin_configuration(pin, :output)
+      @minilab_wrapper.write_digital_pin(get_library_pin_number(pin), value)
+      true
+    end
+
+    def read_port(port)
+      raise "Digital port #{port} is not configured for input." unless @digital_configuration.is_port_configured_for_input?(port)
+      @minilab_wrapper.read_port(@library_translator.get_library_port(port))
+    end
+
+    private
+    def get_library_pin_number(pin)
+      @library_translator.get_library_pin_number(pin)
+    end
+
+    def check_pin_configuration(pin, type)
+      port = @library_translator.get_port_for_pin(pin)
+      unless @digital_configuration.send("is_port_configured_for_#{type}?", port)
+        raise "Digital port #{port} for pin #{pin} is not configured for #{type}."
+      end
+    end
+  end
+end

data/lib/minilab/library_translator.rb

@@ -0,0 +1,48 @@
+module Minilab
+  class LibraryTranslator #:nodoc:
+    include MinilabConstants
+
+    def get_port_for_pin(pin)
+      case pin
+      when 30..37
+        :porta
+      when 3..10
+        :portb
+      when 26..29
+        :portcl
+      when 22..25
+        :portch
+      else
+        raise "Pin #{pin} does not map to a known minilab DB37 port."
+      end
+    end
+
+    def get_library_pin_number(pin)
+      case pin
+      when 30..37  # port a pins
+        7 - (pin - 30)
+      when 3..10   # port b pins
+        15 - (pin - 3)
+      when 26..29  # port cl pins
+        19 - (pin - 26)
+      when 22..25  # port ch pins
+        23 - (pin - 22)
+      else
+        raise "Pin #{pin} does not map to a minilab library pin number."
+      end
+    end
+    
+    def get_library_port(port)
+      port_to_library_port_mapping = {
+        :porta => FIRSTPORTA,
+        :portb => FIRSTPORTB,
+        :portcl => FIRSTPORTCL,
+        :portch => FIRSTPORTCH
+      }
+
+      library_port = port_to_library_port_mapping[port]
+      return library_port unless library_port.nil?
+      raise "Port #{port} is not a valid port."
+    end
+  end
+end

data/lib/minilab/minilab.rb

@@ -0,0 +1,130 @@
+module Minilab
+  # Use this method to construct Minilab objects. The object will not yet
+  # be connected to the device.
+  def self.build
+    MinilabContext.new.build[:minilab]
+  end
+
+  # The main interface to the minilab library. Create one of these objects
+  # using the +Minilab.build+ method. After you've created a minilab object,
+  # use the +connect+ method to establish the connection to the device.
+  # Minilab objects are not usable until they've been connected.
+  class Minilab
+    include MinilabConstants
+    constructor :minilab_wrapper, :analog_io, :digital_auxport_io, :digital_port_io, :connection_state
+
+    # Connect to the device. There are two side effects of connecting.
+    # * Error reporting from MCC's universal library is set to print
+    #   errors to standard out instead of popping up a Windows dialog.
+    # * Each of the DB37 digital ports is setup for input.
+    def connect
+      @minilab_wrapper.setup_error_handling(DONTPRINT, STOPALL)
+      @minilab_wrapper.declare_revision(CURRENTREVNUM)
+      @connection_state.connected = true
+      DigitalConfiguration::PORTS.each { |port| configure_input_port(port) }
+    end
+
+    # Read from one of the eight analog channels (0 - 7) on top of the device.
+    #
+    # Single-ended mode is the only analog mode supported.
+    #
+    # An error is raised if an invalid channel number is given.
+    def read_analog(channel)
+      ensure_connected_to_device
+      @analog_io.read_analog(channel)
+    end
+
+    # Output a voltage on one of the eight analog channels. The output voltage
+    # must be in the range of 0.0 - 5.0 volts.
+    #
+    # Single-ended mode is the only analog mode supported.
+    #
+    # An error is raised if an invalid channel number or an out-of-range
+    # voltage is given.
+    def write_analog(channel, volts)
+      ensure_connected_to_device
+      @analog_io.write_analog(channel, volts)
+    end
+
+    # Configure one of the DB37 ports for input.
+    #
+    # Specify _port_ as a symbol. The available ports are <tt>:porta</tt>,
+    # <tt>:portb</tt>, <tt>:portcl</tt>, and <tt>:portch</tt>. An error is 
+    # raised if an invalid port is given.
+    def configure_input_port(port)
+      ensure_connected_to_device
+      @digital_port_io.configure_input_port(port)
+    end
+
+    # Configure one of the DB37 ports for output.
+    #
+    # Specify _port_ as a symbol. The available ports are <tt>:porta</tt>,
+    # <tt>:portb</tt>, <tt>:portcl</tt>, and <tt>:portch</tt>. An error is
+    # raised if an invalid port is given.
+    def configure_output_port(port)
+      ensure_connected_to_device
+      @digital_port_io.configure_output_port(port)
+    end
+
+    # Read a single bit from one of the digital pins.
+    #
+    # If you'd like to read from one of the pins on the top of the device (the
+    # auxport pins), then specify the pin as a string with its label (e.g. 
+    # read_digital("DIO1")). Alternatively, if you'd like to read from one of
+    # the DB37 pins, specify the pin as the number it's labeled with (e.g.
+    # read_digital(13)).
+    #
+    # An error is raised if you specify a pin that doesn't exist or if you
+    # try to read from a DB37 pin on a port that is not configured for input.
+    # The digital pins on the top of the device do not need to be configured.
+    def read_digital(pin)
+      ensure_connected_to_device
+      perform_digital_op(pin, :read, pin)
+    end
+    
+    # Write a single bit to one of the digital pins. _value_ must be an integer
+    # 1 or 0.
+    #
+    # If you'd like to write to one of the pins on the top of the device (the
+    # auxport pins), then specify the pin as a string with its label (e.g. 
+    # write_digital("DIO2", 0)). Alternatively, if you'd like to write to one
+    # of the DB37 pins, specify the pin as the number it's labeled with (e.g. 
+    # write_digital(17, 1)).
+    #
+    # An error is raised if you specify a pin that doesn't exist or if you
+    # try to write to a DB37 pin on a port that is not configured for output.
+    # The digital pins on the top of the device do not need to be configured.
+    #
+    # Values above 1 are interpreted as 1; negative values raise an error.
+    def write_digital(pin, value)
+      ensure_connected_to_device
+      perform_digital_op(pin, :write, pin, value)
+    end
+
+    # Read a byte from one of the DB37 ports.
+    #
+    # Specify _port_ as a symbol. The available ports are <tt>:porta</tt>,
+    # <tt>:portb</tt>, <tt>:portcl</tt>, and <tt>:portch</tt>.
+    #
+    # An error is raised if an invalid port is given.
+    def read_digital_byte(port)
+      ensure_connected_to_device
+      @digital_port_io.read_port(port)
+    end
+
+    private
+    def perform_digital_op(pin, op, *args)
+      method = "#{op.to_s}_digital"
+      case pin
+      when String
+        @digital_auxport_io.send(method,*args)
+      when Fixnum
+        @digital_port_io.send(method,*args)
+      end
+    end
+
+    def ensure_connected_to_device
+      raise "Cannot use any minilab methods without calling 'connect' first." unless @connection_state.connected?
+    end
+  end
+end

data/lib/minilab/minilab_constants.rb

@@ -0,0 +1,22 @@
+# Lifted from cbw.h. Let's hope these don't change often.
+# Using revision number 5.90.
+module Minilab
+  module MinilabConstants
+    CURRENTREVNUM = 5.90
+
+    BOARDNUM = 0
+    DONTPRINT = 0
+    STOPALL = 2
+    ERRSTRLEN = 256
+    BIP10VOLTS = 1
+    UNI5VOLTS = 101
+
+    AUXPORT = 1
+    DIGITALOUT = 1
+    DIGITALIN = 2
+    FIRSTPORTA = 10
+    FIRSTPORTB = 11
+    FIRSTPORTCL = 12
+    FIRSTPORTCH = 13
+  end
+end

data/lib/minilab/minilab_context.rb

@@ -0,0 +1,18 @@
+require "diy"
+require "yaml"
+require "pathname"
+
+module Minilab
+  class MinilabContext #:nodoc:
+    OBJECT_DEFINITION = Pathname.new(__FILE__).dirname + "objects.yml"
+
+    def build
+      if not @context
+        DIY::Context.auto_require = false
+        @context = DIY::Context.new(YAML.load_file(OBJECT_DEFINITION))
+        @context.build_everything
+      end
+      @context
+    end
+  end
+end