minilab 2.0.0-x86-mingw32

data/spec/unit/digital_configuration_spec.rb

@@ -0,0 +1,96 @@
+require_relative "../spec_helper"
+
+describe Minilab::DigitalConfiguration do
+  before { @mox = create_mocks(:minilab_wrapper) }
+  subject { described_class.new(@mox) }
+
+  it "configure known ports for input" do
+    good_ports.each do |port|
+      expected_configuration = { :direction => DIGITALIN, :port => port_to_library_port_mapping[port] }
+      @minilab_wrapper.configure_port(expected_configuration).returns "you"
+    end
+
+    good_ports.each do |port|
+      assert_equal true, subject.configure_port_for_input(port)
+    end
+  end
+  
+  it "configure known ports for output" do
+    good_ports.each do |port|
+      expected_configuration = { :direction => DIGITALOUT, :port => port_to_library_port_mapping[port] }
+      @minilab_wrapper.configure_port(expected_configuration).returns "boo"
+    end
+
+    good_ports.each do |port|
+      assert_equal true, subject.configure_port_for_output(port)
+    end
+  end
+  
+  it "raise an error for an invalid input port" do
+    check_error_for_all_bad_ports(:configure_port_for_input)
+  end
+
+  it "raise an error for an invalid output port" do
+    check_error_for_all_bad_ports(:configure_port_for_output)
+  end
+
+  it "return false when each of the ports has not been configured for input yet and a client asks if it has" do
+    good_ports.each do |port|
+      assert_equal false, subject.is_port_configured_for_input?(port)
+    end
+  end
+
+  it "return false when each of the ports has not been configured for output yet and a client asks if it has" do
+    good_ports.each do |port|
+      assert_equal false, subject.is_port_configured_for_output?(port)
+    end
+  end
+
+  it "return the input configuration status of a port when asked" do
+    expected_configuration = { :direction => DIGITALIN, :port => port_to_library_port_mapping[:porta] }
+    @minilab_wrapper.configure_port(expected_configuration).returns true
+
+    subject.configure_port_for_input(:porta)
+    assert_equal true, subject.is_port_configured_for_input?(:porta)
+  end
+  
+  it "return the output configuration status of a port when asked" do
+    expected_configuration = { :direction => DIGITALOUT, :port => port_to_library_port_mapping[:portb] }
+    @minilab_wrapper.configure_port(expected_configuration).returns true
+
+    subject.configure_port_for_output(:portb)
+    assert_equal true, subject.is_port_configured_for_output?(:portb)
+  end
+  
+  it "raise an error if you pass is_port_configured_for_input? an invalid port" do
+    check_error_for_all_bad_ports(:is_port_configured_for_input?)
+  end
+  
+  it "raise an error if you pass is_port_configured_for_output? an invalid port" do
+    check_error_for_all_bad_ports(:is_port_configured_for_output?)
+  end
+
+  private
+  def good_ports
+    [:porta, :portb, :portcl, :portch]
+  end
+
+  def bad_ports
+    [nil, :portd, :portttt, "ibm"]
+  end
+
+  def port_to_library_port_mapping
+    {
+      :porta => FIRSTPORTA,
+      :portb => FIRSTPORTB,
+      :portcl => FIRSTPORTCL,
+      :portch => FIRSTPORTCH
+    }
+  end
+
+  def check_error_for_all_bad_ports(method_to_test)
+    bad_ports.each do |bad_port|
+      -> { subject.send(method_to_test, bad_port) }.should raise_error
+    end
+  end
+end

data/spec/unit/digital_port_io_spec.rb

@@ -0,0 +1,65 @@
+require_relative "../spec_helper"
+
+describe Minilab::DigitalPortIo do
+  before { @mox =create_mocks(:minilab_wrapper, :digital_configuration, :library_translator) }
+  subject { described_class.new(@mox) }
+
+  # configuration tests
+  it "use the digital configuration object to configure a port for input" do
+    @digital_configuration.configure_port_for_input(:portch).returns(true)
+    assert subject.configure_input_port(:portch)
+  end
+
+  it "use the digital configuration object to configure a port for output" do
+    @digital_configuration.configure_port_for_output(:portcl).returns(true)
+    assert subject.configure_output_port(:portcl)
+  end
+
+  # read tests
+  it "read digital input from the digital pins" do
+    @library_translator.get_port_for_pin(1).returns(:porta)
+    @digital_configuration.is_port_configured_for_input?(:porta).returns(true)
+    @library_translator.get_library_pin_number(1).returns(21)
+    @minilab_wrapper.read_digital_pin(21).returns "woohoo"
+
+    assert_equal "woohoo", subject.read_digital(1)
+  end
+
+  it "read digital input from a digital port" do
+    @digital_configuration.is_port_configured_for_input?(:portb).returns(true)
+    @library_translator.get_library_port(:portb).returns("some port")
+    @minilab_wrapper.read_port("some port").returns 0x34
+
+    assert_equal 0x34, subject.read_port(:portb)
+  end
+
+  it "raise an error when the configuration object says the port isn't configured for input when reading a pin" do
+    @library_translator.get_port_for_pin(20).returns(:portc)
+    @digital_configuration.is_port_configured_for_input?(:portc).returns(false)
+
+    assert_raise (RuntimeError) { subject.read_digital(20) }
+  end
+
+  it "raise an error when the configuration objects says the port isn't configured for input when reading a port" do
+    @digital_configuration.is_port_configured_for_input?(:porta).returns(false)
+
+    assert_raise (RuntimeError) { subject.read_port(:porta) }
+  end
+
+  # output tests
+  it "write digital output to a digital pin" do
+    @library_translator.get_port_for_pin(2).returns(:portcl)
+    @digital_configuration.is_port_configured_for_output?(:portcl).returns(true)
+    @library_translator.get_library_pin_number(2).returns(7)
+    @minilab_wrapper.write_digital_pin(7, 0).returns "ibm"
+
+    assert_equal true, subject.write_digital(2, 0)
+  end
+  
+  it "raise an error when the configuration object says the port is not configured for output (for write_digital)" do
+    @library_translator.get_port_for_pin(1).returns(:portd)
+    @digital_configuration.is_port_configured_for_output?(:portd).returns(false)
+
+    assert_raise (RuntimeError) { subject.write_digital(1, 1) }
+  end
+end

data/spec/unit/library_translator_spec.rb

@@ -0,0 +1,86 @@
+require_relative "../spec_helper"
+
+describe Minilab::LibraryTranslator do
+  def check_pins_and_ports(low, high, port)
+    low.upto(high) do |pin|
+      assert_equal port, subject.get_port_for_pin(pin), "Didn't get #{port} for pin #{pin}"
+    end
+  end
+
+  it "provide :porta when asked about numbered pins on the hardware's FIRSTPORTA" do
+    check_pins_and_ports(30, 37, :porta)
+  end
+
+  it "provide :portb when asked about numbered pins on the hardware's FIRSTPORTB" do
+    check_pins_and_ports(3, 10, :portb)
+  end
+
+  it "provide :portcl when asked about numbered pins on the hardware's FIRSTPORTCL" do
+    check_pins_and_ports(26, 29, :portcl)
+  end
+
+  it "provide :portch when asked about numbered pins on the hardware's FIRSTPORTCH" do
+    check_pins_and_ports(22, 25, :portch)
+  end
+
+  it "raise an error when asked about a pin number that does not map to a port (such as the pins for ground, 5v +ve, DIO1..3, etc)" do
+    [ 1, 2, "DIO0", "DIO2", nil, :thedude, 832].each do |bad_pin|
+      -> { subject.get_port_for_pin(bad_pin) }.should raise_error(RuntimeError)
+    end
+  end
+
+  it "get the number the library uses for the pin when asked to translate from the numbers on the board (port a pins)" do
+    assert_equal 7, subject.get_library_pin_number(30)
+    assert_equal 6, subject.get_library_pin_number(31)
+    assert_equal 5, subject.get_library_pin_number(32)
+    assert_equal 4, subject.get_library_pin_number(33)
+    assert_equal 3, subject.get_library_pin_number(34)
+    assert_equal 2, subject.get_library_pin_number(35)
+    assert_equal 1, subject.get_library_pin_number(36)
+    assert_equal 0, subject.get_library_pin_number(37)
+  end
+
+  it "get the number the library uses for the pin when asked to translate from the numbers on the board (port b pins)" do
+    assert_equal 15, subject.get_library_pin_number(3)
+    assert_equal 14, subject.get_library_pin_number(4)
+    assert_equal 13, subject.get_library_pin_number(5)
+    assert_equal 12, subject.get_library_pin_number(6)
+    assert_equal 11, subject.get_library_pin_number(7)
+    assert_equal 10, subject.get_library_pin_number(8)
+    assert_equal 9, subject.get_library_pin_number(9)
+    assert_equal 8, subject.get_library_pin_number(10)
+  end
+  
+  it "get the number the library uses for the pin when asked to translate from the numbers on the board (port cl pins)" do
+    assert_equal 19, subject.get_library_pin_number(26)
+    assert_equal 18, subject.get_library_pin_number(27)
+    assert_equal 17, subject.get_library_pin_number(28)
+    assert_equal 16, subject.get_library_pin_number(29)
+  end
+  
+  it "get the number the library uses for the pin when asked to translate from the numbers on the board (port ch pins)" do
+    assert_equal 23, subject.get_library_pin_number(22)
+    assert_equal 22, subject.get_library_pin_number(23)
+    assert_equal 21, subject.get_library_pin_number(24)
+    assert_equal 20, subject.get_library_pin_number(25)
+  end
+
+  it "raise an error if the pin passed in to get_library_pin_number is invalid" do
+    [20, 21, nil, 12, :heynow, "uba"].each do |bad_pin|
+      -> { subject.get_library_pin_number(bad_pin) }.should raise_error(RuntimeError)
+    end
+  end
+
+  it "know the mapping between symbolic ports and ports in the library" do
+    assert_equal FIRSTPORTA, subject.get_library_port(:porta), "wrong port"
+    assert_equal FIRSTPORTB, subject.get_library_port(:portb), "wrong port"
+    assert_equal FIRSTPORTCL, subject.get_library_port(:portcl), "wrong port"
+    assert_equal FIRSTPORTCH, subject.get_library_port(:portch), "wrong port"
+  end
+
+  it "raise an error if asked about the library port that does not exist" do
+    [:portd, :portci, "cigarette butt", nil].each do |bad_port|
+      -> { subject.get_library_port(bad_port) }.should raise_error(RuntimeError)
+    end
+  end 
+end

data/spec/unit/minilab_context_spec.rb

@@ -0,0 +1,17 @@
+require_relative "../spec_helper"
+
+describe Minilab::MinilabContext do
+  it "build minilab context" do
+    context = nil
+    -> { context = subject.build }.should_not raise_error
+    assert_not_nil context, "should have gotten a context"
+
+    minilab = context[:minilab]
+    assert_not_nil minilab, "should have a minilab object in the context"
+    assert_kind_of Minilab::Minilab, minilab, "should have gotten a Minilab object"
+  end
+
+  it "give the same context when built more than once" do
+    assert_same subject.build, subject.build, "not the same context object"
+  end
+end

data/spec/unit/minilab_hardware_spec.rb

@@ -0,0 +1,17 @@
+require_relative "../spec_helper"
+
+# Not many tests for this class, since there isn't much behavior outside of
+# calling into the minilab library. I could probably figure out another way
+# to unit test those calls, but I don't believe there would be much value
+# in brittle tests for code that is already covered by system tests.
+describe Minilab::MinilabHardware do
+  it "raise an error if auxport configuration isn't given the correct hash parameters" do
+    -> { subject.configure_auxport(:pin => 3) }.should raise_error(":direction is a required parameter")
+    -> { subject.configure_auxport(:direction => DIGITALIN) }.should raise_error(":pin is a required parameter")
+  end
+
+  it "raise an error if port configuration isn't given the correct hash parameters" do
+    -> { subject.configure_port(:port => FIRSTPORTA) }.should raise_error(":direction is a required parameter")
+    -> { subject.configure_port(:direction => DIGITALOUT) }.should raise_error(":port is a required parameter")
+  end
+end

data/spec/unit/minilab_spec.rb

@@ -0,0 +1,104 @@
+require_relative "../spec_helper"
+
+describe Minilab::Minilab do
+  before { @mox = create_mocks(:minilab_wrapper, :analog_io, :digital_auxport_io, :digital_port_io, :connection_state) }
+  subject { described_class.new(@mox) }
+
+  it "allow the user to easily build the minilab object and its dependences" do
+    assert_not_nil Minilab.build
+    assert_kind_of Minilab::Minilab, Minilab.build
+  end
+
+  it "connect to the hardware, setup the error handling, declare the library revision, and setup the db37 ports for input" do
+    @minilab_wrapper.setup_error_handling(DONTPRINT, STOPALL)
+    @minilab_wrapper.declare_revision(CURRENTREVNUM)
+    @connection_state.connected=(true)
+
+    Minilab::DigitalConfiguration::PORTS.each do |port|
+      @connection_state.connected?.returns true
+      @digital_port_io.configure_input_port(port)
+    end
+
+    subject.connect
+  end
+
+  it "bomb out if trying to use a method but haven't connected yet" do
+    assert_not_connected_error { subject.read_analog(0) }
+    assert_not_connected_error { subject.write_analog(0, 2.2) }
+    assert_not_connected_error { subject.read_digital(6) }
+    assert_not_connected_error { subject.write_digital(6, 1) }
+    assert_not_connected_error { subject.read_digital_byte(:porta) }
+    assert_not_connected_error { subject.configure_input_port(:portcl) }
+    assert_not_connected_error { subject.configure_output_port(:portb) }
+  end
+
+  # IO tests
+  it "read analog input" do
+    @connection_state.connected?.returns true
+    @analog_io.read_analog(4).returns(1.1)
+
+    assert_equal 1.1, subject.read_analog(4)
+  end
+  
+  it "write analog output" do
+    @connection_state.connected?.returns true
+    @analog_io.write_analog(1, 5.9).returns(true)
+
+    subject.write_analog(1, 5.9)
+  end
+
+  it "read digital input from the DIO auxport terminals" do
+    @connection_state.connected?.returns true
+    @digital_auxport_io.read_digital('DIO1').returns(1)
+
+    assert_equal 1, subject.read_digital('DIO1')
+  end
+
+  it "write digital output to the DIO auxport terminals" do
+    @connection_state.connected?.returns true
+    @digital_auxport_io.write_digital('DIO3', 0).returns(true)
+
+    subject.write_digital('DIO3', 0)
+  end
+
+  it "use the digital port object when the pin is a numbered pin for read_digital" do
+    @connection_state.connected?.returns true
+    @digital_port_io.read_digital(7).returns(1)
+
+    assert_equal 1, subject.read_digital(7)
+  end
+
+  it "use the digital port object when the pin is a numbered pin for write_digital" do
+    @connection_state.connected?.returns true
+    @digital_port_io.write_digital(2, 1).returns(:yourmom)
+
+    assert_equal :yourmom, subject.write_digital(2, 1)
+  end
+
+  it "use the digital port object to read a byte from a digital port" do
+    @connection_state.connected?.returns true
+    @digital_port_io.read_port(:porta).returns(0x22)
+    assert_equal 0x22, subject.read_digital_byte(:porta)
+  end
+
+  # Configuration tests
+  it "use the digital port object for configuring a port for input" do
+    @connection_state.connected?.returns true
+    @digital_port_io.configure_input_port(:portch).returns(true)
+
+    assert subject.configure_input_port(:portch)
+  end
+  
+  it "use the digital port object for configuring a port for output" do
+    @connection_state.connected?.returns true
+    @digital_port_io.configure_output_port(:porta).returns(true)
+
+    assert subject.configure_output_port(:porta)
+  end
+
+  private
+  def assert_not_connected_error
+    @connection_state.connected?.returns false
+    -> { yield }.should raise_error("Cannot use any minilab methods without calling 'connect' first.")
+  end
+end

data/spec/unit/minilab_wrapper_spec.rb

@@ -0,0 +1,20 @@
+require_relative "../spec_helper"
+
+describe Minilab::MinilabWrapper do
+  before { @mox = create_mocks(:minilab_hardware) }
+  subject { described_class.new(@mox) }
+
+  it "forwards methods to the hardware and gives the result" do
+    @minilab_hardware.razzle(1, 2, "three").returns({ :value => 5 })
+    assert_equal 5, subject.razzle(1, 2, "three")
+
+    @minilab_hardware.dazzle.returns({ :value => :whatever })
+    assert_equal :whatever, subject.dazzle
+  end
+
+  it "raise an error when there is a hardware error" do
+    @minilab_hardware.bang(1, 2).returns({ :error => 4 })
+    @minilab_hardware.get_error_string(4).returns "Righteous error"
+    -> { subject.bang(1,2) }.should raise_error("Command [bang([1, 2])] caused a hardware error: Righteous error")
+  end
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification 
+name: minilab
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 2
+  - 0
+  - 0
+  version: 2.0.0
+platform: x86-mingw32
+authors: 
+- Matt Fletcher
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-02 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: constructor
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: diy
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        version: "1.1"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: ffi
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: steak
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rr
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :development
+  version_requirements: *id005
+description: "Ruby interface to Measurement Computing's miniLAB 1008 "
+email: 
+- fletcher@atomicobject.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- CHANGES
+- LICENSE
+files: 
+- .document
+- .gitignore
+- CHANGES
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- doc/UniLib.chm
+- doc/minilab-1008.pdf
+- doc/minilab_systest_setup.txt
+- doc/port_mapping.txt
+- lib/minilab.rb
+- lib/minilab/analog_io.rb
+- lib/minilab/connection_state.rb
+- lib/minilab/digital_auxport_io.rb
+- lib/minilab/digital_configuration.rb
+- lib/minilab/digital_port_io.rb
+- lib/minilab/library_translator.rb
+- lib/minilab/minilab.rb
+- lib/minilab/minilab_constants.rb
+- lib/minilab/minilab_context.rb
+- lib/minilab/minilab_hardware.rb
+- lib/minilab/minilab_wrapper.rb
+- lib/minilab/objects.yml
+- lib/minilab/version.rb
+- minilab.gemspec
+- spec/acceptance/analog_spec.rb
+- spec/acceptance/digital_port_spec.rb
+- spec/acceptance/digital_screw_terminal_spec.rb
+- spec/spec_helper.rb
+- spec/unit/analog_io_spec.rb
+- spec/unit/connection_state_spec.rb
+- spec/unit/digital_auxport_io_spec.rb
+- spec/unit/digital_configuration_spec.rb
+- spec/unit/digital_port_io_spec.rb
+- spec/unit/library_translator_spec.rb
+- spec/unit/minilab_context_spec.rb
+- spec/unit/minilab_hardware_spec.rb
+- spec/unit/minilab_spec.rb
+- spec/unit/minilab_wrapper_spec.rb
+- vendor/mcc/cbw32.dll
+has_rdoc: true
+homepage: http://atomicobject.github.com/minilab
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --title
+- minilab
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: minilab
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby interface to Measurement Computing's miniLAB 1008
+test_files: 
+- spec/acceptance/analog_spec.rb
+- spec/acceptance/digital_port_spec.rb
+- spec/acceptance/digital_screw_terminal_spec.rb
+- spec/spec_helper.rb
+- spec/unit/analog_io_spec.rb
+- spec/unit/connection_state_spec.rb
+- spec/unit/digital_auxport_io_spec.rb
+- spec/unit/digital_configuration_spec.rb
+- spec/unit/digital_port_io_spec.rb
+- spec/unit/library_translator_spec.rb
+- spec/unit/minilab_context_spec.rb
+- spec/unit/minilab_hardware_spec.rb
+- spec/unit/minilab_spec.rb
+- spec/unit/minilab_wrapper_spec.rb