minilab 1.1.0-x86-mswin32-60

data/CHANGES

@@ -0,0 +1,8 @@
+== 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/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2007-2009 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

@@ -0,0 +1,105 @@
+== 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 is not guaranteed to work with other Measurement Computing devices, but could be extended to do so.
+
+== 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 'lib/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.
+
+=== FFI
+The minilab gem now uses FFI to communicate with the native MCC library. The previous release of this gem required a native extension, but FFI has alleviated the need for this.
+
+== Usage
+=== Build and connect
+
+First you'll need to build the Minilab object; use the Minilab.build class method to do this. The class 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:
+
+<tt>minilab = Minilab.build</tt>
+
+<tt>minilab.connect</tt>
+
+=== 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:
+
+<tt> minilab.configure_input_port(:portb) </tt>
+
+<tt> value = minilab.read_digital_byte(:portb) </tt>
+
+<tt> assert_equal 12, value, "wrong value read for system time" </tt>
+
+The adventurous may also want to look at the included system 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 system tests. The unit tests stress individual units and can run without any hardware plugged in. The system tests represent real use cases for the software when plugged into hardware.
+
+See the end of the document 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
+
+* 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
+
+Developer
+
+Atomic Object LLC
+
+fletcher@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,83 @@
+require File.expand_path(File.dirname(__FILE__) + "/config/environment")
+require "rake/testtask"
+require "rake/rdoctask"
+require "rubygems/package_task"
+
+namespace :test do
+  desc "Run the unit tests (doesn't require hardware)"
+  Rake::TestTask.new(:units) do |t|
+    t.pattern = 'test/unit/**/*_test.rb'
+    t.verbose = true
+  end
+
+  desc "Run the system tests (requires hardware)"
+  task :system do
+    $LOAD_PATH << "#{APP_ROOT}/vendor/systir"
+    SYSTEST_ROOT = APP_ROOT + "/test/system"
+    require "systir"
+    require "#{APP_ROOT}/test/system/minilab_driver.rb"
+    result = Systir::Launcher.new.find_and_run_all_tests(MinilabDriver, SYSTEST_ROOT)
+    raise "SYSTEM TESTS FAILED" unless result.passed?
+  end
+
+  desc "Run every suite of tests"
+  task :all => [:units, :system]
+end
+
+desc "Run the unit tests"
+task :default => %w[ test:units ]
+
+def rdoc_options
+  %w[ --line-numbers --inline-source --main README --title minilab ]
+end
+
+gem_spec = Gem::Specification.new do |spec|
+  spec.name = "minilab"
+  spec.version = "1.1.0"
+  spec.author = "Matt Fletcher - Atomic Object"
+  spec.email = "fletcher@atomicobject.com"
+  spec.homepage = "http://minilab.rubyforge.org"
+  spec.rubyforge_project = "minilab"
+  spec.platform = Gem::Platform::CURRENT
+  spec.files = FileList["{lib,test,config,vendor}/**/*"].exclude("rdoc").to_a
+  spec.files += %w[ Rakefile README LICENSE CHANGES ] 
+  spec.test_files = FileList["test/unit/*"]
+  spec.has_rdoc = true
+  spec.extra_rdoc_files = %w[ README CHANGES LICENSE ]
+  spec.rdoc_options = rdoc_options
+
+  # Yup, that's right, I'm consciously bypassing the warning mechanisms
+  # for summary and description. Why? Because there's nothing else that
+  # needs to be said beyond this one line.
+  spec.summary = "Ruby interface to Measurement Computing's miniLAB 1008"
+  spec.description = "#{spec.summary} "
+end 
+  
+Gem::PackageTask.new(gem_spec) do |pkg|
+  pkg.need_tar = true
+  pkg.need_zip = true
+end
+
+desc "Clean the project of build artifacts"
+task :clean => :clobber_package
+
+namespace :doc do
+  desc "Generate RDoc documentation"
+  Rake::RDocTask.new do |rdoc|
+    rdoc.rdoc_dir = "rdoc"
+    rdoc.title = "minilab: Ruby library for the miniLAB 1008"
+    rdoc.options = rdoc_options
+    rdoc.rdoc_files.include("lib/minilab.rb", "README", "CHANGES", "LICENSE")
+  end
+end
+
+namespace :release do
+  desc "Upload rdoc and homepage to Rubyforge"
+  task :upload_doc => 'doc:rerdoc' do
+    destination = "rubyforge.org:/var/www/gforge-projects/minilab/"
+    %w[ index.html minilab.jpg ].each do |file|
+      sh "scp homepage/#{file} #{destination}"
+    end
+    sh "scp -r rdoc #{destination}"
+  end
+end

data/config/environment.rb

@@ -0,0 +1,23 @@
+unless $environment_already_defined
+  $environment_already_defined = true
+
+  APP_ROOT = File.expand_path(File.dirname(__FILE__) + "/..")
+
+  %w[ ffi-0.4.0-x86-mswin32 diy-1.1.1 constructor-1.0.2 ].each do |dir|
+    $LOAD_PATH << "#{APP_ROOT}/vendor/#{dir}/lib"
+  end
+
+  %w[ ffi constructor diy ].each do |lib|
+    require lib
+  end
+
+  $LOAD_PATH << "#{APP_ROOT}/vendor/mcc"
+  $LOAD_PATH << "#{APP_ROOT}/lib"
+  require "minilab_constants"
+
+  Dir["#{APP_ROOT}/lib/*.rb"].reject do |file|
+    file =~ /minilab_constants/
+  end.each do |file|
+    require file
+  end
+end

data/config/objects.yml

@@ -0,0 +1,23 @@
+minilab:
+  compose: minilab_wrapper, analog_io, digital_auxport_io, digital_port_io, connection_state
+
+connection_state:
+
+minilab_wrapper:
+  compose: minilab_hardware
+
+minilab_hardware:
+
+analog_io:
+  compose: minilab_wrapper
+
+digital_auxport_io:
+  compose: minilab_wrapper
+
+digital_port_io:
+  compose: minilab_wrapper, digital_configuration, library_translator
+
+library_translator:
+
+digital_configuration:
+  compose: minilab_wrapper

data/lib/analog_io.rb

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

data/lib/connection_state.rb

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

data/lib/digital_auxport_io.rb

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

data/lib/digital_configuration.rb

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

data/lib/digital_port_io.rb

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

data/lib/library_translator.rb

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