minilab 2.0.0-x86-mingw32 → 2.0.1-x86-mingw32

data/.gitignore

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

data/.yardopts

@@ -0,0 +1 @@
+lib/**/*.rb --no-private -r README.rdoc - CHANGES LICENSE

data/CHANGES

@@ -1,11 +1,15 @@
+== 2.0.1
+* converted a significant amount of documentation to yardoc format
+* some of Minilab's instance methods now return [true] instead of [whatever]
+
 == 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
+  * 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

data/README.rdoc

@@ -62,8 +62,8 @@ See the end of this document for an outline of how a miniLAB and DB37 connector
 * 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>
+* Matt Fletcher (mailto:fletcher@atomicobject.com)
+* Atomic Object (http://atomicobject.com)
 
 == Appendix
 === DB37 pin to port mapping
@@ -73,7 +73,7 @@ Pin:: Port
 26-29:: :portcl
 22-25:: :portch
 
-=== System test setup
+=== Acceptance test setup
 
 On top of the miniLAB:
 CH0 IN:: D/A OUT 1

data/Rakefile

@@ -1,4 +1,3 @@
-require "rake/rdoctask"
 require "rspec/core/rake_task"
 
 desc "Run the unit specs"
@@ -16,10 +15,3 @@ namespace :spec do
   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/lib/minilab/analog_io.rb

@@ -1,5 +1,5 @@
 module Minilab
-  class AnalogIo #:nodoc:
+  class AnalogIo #@private
     constructor :minilab_wrapper
 
     def read_analog(channel)

data/lib/minilab/connection_state.rb

@@ -1,5 +1,5 @@
 module Minilab
-  class ConnectionState
+  class ConnectionState #@private
     def initialize
       @connected = false
     end

data/lib/minilab/digital_auxport_io.rb

@@ -1,5 +1,5 @@
 module Minilab
-  class DigitalAuxportIo #:nodoc:
+  class DigitalAuxportIo #@private
     constructor :minilab_wrapper
     include MinilabConstants
 

data/lib/minilab/digital_configuration.rb

@@ -1,5 +1,5 @@
 module Minilab
-  class DigitalConfiguration #:nodoc:
+  class DigitalConfiguration #@private
     include MinilabConstants
     constructor :minilab_wrapper
 

data/lib/minilab/digital_port_io.rb

@@ -1,5 +1,5 @@
 module Minilab
-  class DigitalPortIo #:nodoc:
+  class DigitalPortIo #@private
     constructor :minilab_wrapper, :digital_configuration, :library_translator
 
     def configure_input_port(port)

data/lib/minilab/library_translator.rb

@@ -1,5 +1,5 @@
 module Minilab
-  class LibraryTranslator #:nodoc:
+  class LibraryTranslator #@private
     include MinilabConstants
 
     def get_port_for_pin(pin)

data/lib/minilab/minilab.rb

@@ -1,14 +1,17 @@
+# @author Matt Fletcher (fletcher@atomicobject.com)
 module Minilab
-  # Use this method to construct Minilab objects. The object will not yet
-  # be connected to the device.
+  # Constructs Minilab objects.
+  # @return [Minilab] an unconnected Minilab object. Use {Minilab#connect}
+  #  to connect it to the physical 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.
+  # 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.
+  # @author Matt Fletcher (fletcher@atomicobject.com)
   class Minilab
     include MinilabConstants
     constructor :minilab_wrapper, :analog_io, :digital_auxport_io, :digital_port_io, :connection_state
@@ -17,18 +20,22 @@ module Minilab
     # * 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.
+    # @return [true]
     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) }
+      true
     end
 
-    # Read from one of the eight analog channels (0 - 7) on top of the device.
+    # Read from one of the eight analog channels 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.
+    # @param [Fixnum] channel the analog channel (0 - 7)
+    # @return [Float] the voltage
+    # @raise [RuntimeError] the channel number is invalid
     def read_analog(channel)
       ensure_connected_to_device
       @analog_io.read_analog(channel)
@@ -39,8 +46,10 @@ module Minilab
     #
     # 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.
+    # @param [Fixnum] channel the analog channel (0 or 1)
+    # @param [Float] volts the voltage (0.0 - 5.0)
+    # @raise [RuntimeError] the channel number is invalid
+    # @raise [RuntimeError] the voltage is out of range
     def write_analog(channel, volts)
       ensure_connected_to_device
       @analog_io.write_analog(channel, volts)
@@ -48,9 +57,10 @@ module Minilab
 
     # 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.
+    # @param [Symbol] port the port. Valid ports are
+    #   :porta, :portb, :portcl, and :portch.
+    # @return [true]
+    # @raise [RuntimeError] the port is invalid
     def configure_input_port(port)
       ensure_connected_to_device
       @digital_port_io.configure_input_port(port)
@@ -58,44 +68,42 @@ module Minilab
 
     # 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.
+    # @param (see #configure_input_port)
+    # @return [true]
+    # @raise (see #configure_input_port)
     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.
+    # Read a single bit from one of the auxport pins (on the top of the
+    # device) or from a DB37 pin. Ensure the pin has been configured for
+    # input (see {#configure_input_port}) before using this method.
+    # auxport pins do not need to be configured.
     #
-    # 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.
+    # @param [String, Fixnum] pin a String name of the auxport (e.g. "DIO1")
+    #   or a Fixnum DB37 pin number (e.g. 13)
+    # @return [Fixnum] the bit value
+    # @raise [RuntimeError] the given pin doesn't exist
+    # @raise [RuntimeError] the DB37 pin has not been configured for input
     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)).
+    # Write a single bit to one of the auxport pins (on the top of the
+    # device) or to a DB37 pin. Ensure the pin has been configured for
+    # output (see {#configure_output_port}) before using this method.
+    # auxport pins do not need to be configured.
     #
-    # 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.
+    # @param [String, Fixnum] pin a String name of the auxport (e.g. "DIO1")
+    #   or a Fixnum DB37 pin number (e.g. 13)
+    # @param [Fixnum] value the value (0 or 1) to write. values above 1 are
+    #   interpreted as 1.
+    # @return [true]
+    # @raise [RuntimeError] the given pin doesn't exist
+    # @raise [RuntimeError] the DB37 pin has not been configured for input
+    # @raise [RuntimeError] a negative value is given
     def write_digital(pin, value)
       ensure_connected_to_device
       perform_digital_op(pin, :write, pin, value)
@@ -103,10 +111,9 @@ module Minilab
 
     # 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.
+    # @param (see #configure_input_port)
+    # @return [Fixnum] the byte value
+    # @raise (see #configure_input_port)
     def read_digital_byte(port)
       ensure_connected_to_device
       @digital_port_io.read_port(port)

data/lib/minilab/minilab_constants.rb

@@ -1,7 +1,8 @@
-# Lifted from cbw.h. Let's hope these don't change often.
-# Using revision number 5.90.
 module Minilab
-  module MinilabConstants
+  module MinilabConstants #@private
+    # Lifted from cbw.h. Let's hope these don't change often.
+    # Using revision number 5.90.
+
     CURRENTREVNUM = 5.90
 
     BOARDNUM = 0

data/lib/minilab/minilab_context.rb

@@ -3,7 +3,7 @@ require "yaml"
 require "pathname"
 
 module Minilab
-  class MinilabContext #:nodoc:
+  class MinilabContext #@private
     OBJECT_DEFINITION = Pathname.new(__FILE__).dirname + "objects.yml"
 
     def build

data/lib/minilab/minilab_hardware.rb

@@ -2,7 +2,7 @@ require "ffi"
 require "pathname"
 
 module Minilab
-  class MinilabHardware
+  class MinilabHardware #@private
     include MinilabConstants
 
     def setup_error_handling(reporting, handling)

data/lib/minilab/minilab_wrapper.rb

@@ -1,5 +1,5 @@
 module Minilab
-  class MinilabWrapper #:nodoc:
+  class MinilabWrapper #@private
     constructor :minilab_hardware
 
     def method_missing(method, *argz)

data/lib/minilab/version.rb

@@ -1,3 +1,3 @@
 module Minilab
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

data/spec/unit/minilab_spec.rb

@@ -19,7 +19,7 @@ describe Minilab::Minilab do
       @digital_port_io.configure_input_port(port)
     end
 
-    subject.connect
+    assert subject.connect
   end
 
   it "bomb out if trying to use a method but haven't connected yet" do
@@ -58,7 +58,7 @@ describe Minilab::Minilab do
     @connection_state.connected?.returns true
     @digital_auxport_io.write_digital('DIO3', 0).returns(true)
 
-    subject.write_digital('DIO3', 0)
+    assert subject.write_digital('DIO3', 0)
   end
 
   it "use the digital port object when the pin is a numbered pin for read_digital" do

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 2
   - 0
-  - 0
-  version: 2.0.0
+  - 1
+  version: 2.0.1
 platform: x86-mingw32
 authors: 
 - Matt Fletcher
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-02 00:00:00 -05:00
+date: 2011-01-04 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -99,8 +99,8 @@ extra_rdoc_files:
 - CHANGES
 - LICENSE
 files: 
-- .document
 - .gitignore
+- .yardopts
 - CHANGES
 - Gemfile
 - LICENSE

data/.document

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