pcanusb 0.0.1 → 1.0.0

data/lib/{PCAN_USB.rb → pcanusb.rb}

@@ -6,7 +6,7 @@ require "dl"
 require "dl/import"
 require "dl/struct"
 
-class PCAN_USB
+class PCANUSB
 
   # BAUD rates used by "init"
   BAUD_1M   = 0x0014
@@ -49,6 +49,10 @@ class PCAN_USB
   CAN_ILLPARAMTYPE   = 0x4000  # Parameter is not permitted/applicable here.
   CAN_ILLPARAMVAL    = 0x8000  # Parameter value is invalid.
 
+  # Initialize the PCAN device with a BAUD rate and message type.
+  # Valid message types are
+  # * CAN_INIT_TYPE_ST:: Standard format IDs
+  # * CAN_INIT_TYPE_EX:: Extended IDs
   def self.init(baud_value, message_type = CAN_INIT_TYPE_EX)
     err = Core::cAN_Init(baud_value, message_type)
     
@@ -58,14 +62,18 @@ class PCAN_USB
     return err
   end
 
+  # Close the PCAN device connection.
   def self.close
     return Core::cAN_Close
   end
-  
+
+  # Retrieve the current PCAN status.  
   def self.status
     return Core::cAN_Status
   end
-  
+
+  # Initiates a transmission of a CAN message with a given ID.
+  # the data parameter is expected to be less than 8 bytes.  
   def self.write(id, data, message_type = MSGTYPE_EXTENDED)
     message = Core::TPCANMsg.malloc
     message.id = id
@@ -84,6 +92,8 @@ class PCAN_USB
     return Core::cAN_MsgFilter(fromID, toID, message_type)
   end
   
+  # Read one CAN message from the PCAN FIFO.
+  # Returns the error code, message type, ID and data array.
   def self.read
     message = Core::TPCANMsg.malloc
     
@@ -92,6 +102,8 @@ class PCAN_USB
     return err, message.message_type, message.id, message.data[0..message.length - 1]
   end
 
+  # Read a message with a given ID.
+  # Returns the received data array if the required ID is received within the timeout or false if not.
   def self.read_id(id, timeout=1)
     read_timeout = Time.now + timeout
   
@@ -106,10 +118,12 @@ class PCAN_USB
     return false
   end
   
+  # Reset the PCAN device.
   def self.reset_client
     return Core::cAN_ResetClient
   end
 
+  # Provide information about the PCAN.
   def self.version_info
     info = Core::Version_Info.malloc
     
@@ -118,7 +132,8 @@ class PCAN_USB
     # info.value is an array of characters, convert it to string 
     return info.value.pack("c128")
   end
-  
+
+  # Return the device number associated with the connected PCAN.  
   def self.get_usb_device_number
     number = Core::Device_Number.malloc
     
@@ -126,8 +141,10 @@ class PCAN_USB
     
     return err, number.value
   end
-  
-  module Core
+   
+  #-----
+
+  module Core #:nodoc:all
     extend DL::Importable
     
     dlload File.dirname(__FILE__) + "/Pcan_usb.dll"

data/rakefile

@@ -4,10 +4,11 @@ require 'rubygems'
 require 'rake'
 require 'rake/packagetask'
 require 'rake/gempackagetask'
+require 'rake/rdoctask'
 require 'rake/contrib/rubyforgepublisher'
 
 PKG_NAME    = 'pcanusb'
-PKG_VERSION = '0.0.1'
+PKG_VERSION = '1.0.0'
 
 # Create compressed packages
 dist_dirs = [ 'lib' ]
@@ -23,11 +24,9 @@ It ships with a DLL and documented API.
 This is a Ruby wrapper for that API allowing CAN messages to be sent and received from Ruby.
 EOF
 
-#  s.has_rdoc = true
+  s.has_rdoc = true
   s.requirements << 'none'
 
-#  s.add_dependency('activesupport', '= 1.4.2' + PKG_BUILD)
-
   s.require_path = 'lib'
   s.autorequire = 'rake'
 
@@ -40,7 +39,6 @@ end
 Rake::GemPackageTask.new(spec) do |pkg|
   pkg.gem_spec = spec
   pkg.need_zip = true
-#  pkg.need_tar = true
 end
 
 desc "Publish the release files to RubyForge."
@@ -53,3 +51,8 @@ task :release => [ :package ] do
   rubyforge.login
   rubyforge.add_release(PKG_NAME, PKG_NAME, "REL #{PKG_VERSION}", *packages)
 end
+
+Rake::RDocTask.new do |rd|
+  rd.main = "lib/pcanusb.rb"
+  rd.rdoc_files.include("lib/**/*.rb")
+end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
+rubygems_version: 0.9.4
 specification_version: 1
 name: pcanusb
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
-date: 2008-05-12 00:00:00 -04:00
+  version: 1.0.0
+date: 2008-08-13 00:00:00 -04:00
 summary: PCAN DLL wrapper
 require_paths: 
 - lib
@@ -15,7 +15,7 @@ description: PCAN is a Controller Area Network (CAN) device that connects to a P
 autorequire: rake
 default_executable: 
 bindir: bin
-has_rdoc: false
+has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
   - - ">"
@@ -30,8 +30,8 @@ authors: []
 
 files: 
 - rakefile
+- lib/pcanusb.rb
 - lib/Pcan_usb.dll
-- lib/PCAN_USB.rb
 test_files: []
 
 rdoc_options: []