rs232-sigmakoki 0.1.3 → 0.1.4

data/README

@@ -1,39 +1,40 @@
-##
- #  
- #                      RS232-SigmaKoki
- #    
- #  Ruby interface to Windows Serial Port API
- #  
- #  author      hugo benichi
- #  email       hugo.benichi@m4x.org
- #  copyright   2012 hugo benichi  
- #  version     0.1.3
- #
- ##
- 
-  installation:  
- 
-    run in the root directory
-      rake gem_install
-    
-    it will compile the gem library and produce a .gem package for ruby
-    it will then install the .gem automatically
-    
-  usage: 
-  
+
+
+                      RS232-SigmaKoki
+
+  Ruby interface to Windows Serial Port API
+
+  author      hugo benichi
+  email       hugo[dot]benichi[at]m4x[dot]org
+  copyright   2012,2013 hugo benichi
+  version     0.1.4
+
+
+  Installation:
+
+    run in the gem root directory:
+    $ rake gem_install
+
+    It will compile the gem library and produce a .gem package for ruby, and
+    automatically install it
+
+  Usage:
+
     cf test/test_rs232-sigmakoki.rb
-    
+
     the list of commands is
-      
-      home                # brings back both state to mechanical origin
+
+      home                # brings back both rotating plates to mechanical origin
       stop                # stop with deceleration
       stop!               # emergency stop
-      status              # current state status
+      status              # current plate driver status
       rom                 # internal rom version
-      ready?
-      busy?               # is the stage ready to accept the next command
+      ready?              # is the stage ready to accept the next command
+      busy?               # is the stage currently executing some command
       jog '++'|'++'|'+-'  # slowly moves both stages in + or - direction
-      move a, b           # move stage 1 of a steps, and stage 2 of b steps (b optional)  
-      move! a, b          # same as move, but wait until the stages are ready             
+      move a [,b]         # move stage 1 of a steps, and stage 2 of b steps
+      move! a [,b]        # same as move, but wait until the stages are ready
+      amove a [,b]        # move stage 1 to position ax, and stage 2 to b
+      amove! a [,b]       # same as amove, but wait until the stages are ready
       position            # return the position of both stages
       position_of i       # return the position of stage i (1,2)

data/lib/rs232-sigmakoki.rb

@@ -2,6 +2,7 @@ class SigmaKoki
 
   require 'rs232'
   
+  # programatically define commands
   [
     [:home,     'H:W--'],
     [:stop,     'L:W'],
@@ -9,44 +10,53 @@ class SigmaKoki
     [:go,       'G'],
   ].each{ |meth,c| define_method(meth){ @comm.write c} }
   
+  # programatically define queries
   [
     [:status,   'Q:'],
     [:rom,      '?:V'],
     [:busy,     '!:'],
   ].each{ |meth,c| define_method(meth){ @comm.query c} }
 
-  
+  # checks if the device is idle 
   def ready?
     'R' == self.busy[0] #gsub(' ','').split(',')[-1]
   end
   
+  # checks if the device is currently bury rotating 
   def busy?
     'B' == self.busy[0] #gsub(' ','').split(',')[-1]
   end  
 
-	def wait
+  # blocking wait until the device is free to execute command again
+  def wait
     sleep 0.2 while busy?
   end
-  
+ 
+  # initiates a continuous and slow rotation 
   def jog *args
     @comm.write "J:W%s%s" % args[0..1]
     go
   end
 
-      #main command to rotate the plates
+  # main command to rotate the plates (non-blocking)
+  # step1 and step2 are the number of angle units to move (relative move)
   def move step1, step2 = 0
-	  step1 = 0 if step1.nil?
+    step1 = 0 if step1.nil?
     s1, s2 = step1 > 0 ? "+" : "-", step2 > 0 ? "+" : "-"
     command = "M:W%sP%i%sP%i" % [s1,step1.abs,s2,step2.abs]
     @comm.write command
     go
   end  
-  
+ 
+  # main command to rotate the plates (blocking)
+  # step1 and step2 are the number of angle units to move (relative move)
   def move! step1, step2 = 0
     move step1, step2
     wait
   end
   
+  # main command to rotate the plates (non-blocking)
+  # step1 and step2 are the final angular position (absolute move)
   def amove *step_args
     move *self.position.map { |x|
       y = step_args.shift
@@ -54,20 +64,25 @@ class SigmaKoki
     }
   end
 
+  # main command to rotate the plates (blocking)
+  # step1 and step2 are the final angular position (absolute move)
   def amove! *step_args
     amove *step_args
     wait
   end
-  
+ 
+  # pulls back the rotating plates to mechanical origin (blocking) 
   def home!
     home
     wait
   end
-  
+ 
+  # gets current position of plates (length 2 array) 
   def position
     self.status.gsub(' ','').split(',').map{|x| x.to_i}[0..1]
   end  
-  
+ 
+  # gets current position of plate 1 or 2 
   def position_of chan
     self.status.gsub(' ','').split(',')[chan-1].to_i
   end

data/rakefile.rb

@@ -1,10 +1,20 @@
-task :test_global do ruby "test/test_rs232-sigmakoki.rb" end
-task :test_local  do ruby "-Ilib test/test_rs232-sigmakoki.rb" end
+task :test_global do                            # if testing after gem install
+  ruby "test/test_rs232-sigmakoki.rb"
+end
+
+task :test_local  do                            # if testing from gem root dir
+  ruby "-Ilib test/test_rs232-sigmakoki.rb"
+end
+
+task :gem_build   do
+  sh "gem build rs232-sigmakoki.gemspec"
+end
 
-task :gem_build   do sh "gem build rs232-sigmakoki.gemspec" end
 task :gem_install => :gem_build do 
-  gemfile = Dir.new("./").entries.select{ |f| f =~ /rs232-sigmakoki-[\d]+\.[\d]+\.[\d]+.gem/ }.sort[-1]
+  gemfile = Dir.new("./").entries.select{ |f| 
+    f =~ /rs232-sigmakoki-[\d]+\.[\d]+\.[\d]+.gem/  # auto-get find current vers 
+  }.sort[-1]
   sh "gem install --local %s" % gemfile
 end
 
-task :default => :test_local
+task :default => :test_local

data/test/test_rs232-sigmakoki.rb

@@ -1,5 +1,10 @@
 require 'rs232-sigmakoki'
 
+# A simple test program to confirm the good communication with the 
+# plate rotator over serial port.
+#
+# By default the port name used is 'COM1'
+
 plate = SigmaKoki.new 'COM1'
 
 plate.home
@@ -24,4 +29,4 @@ plate.move! 20000
 plate.home
 
 
-puts "ok"
+puts "ok"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rs232-sigmakoki
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-24 00:00:00.000000000 Z
+date: 2013-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rs232
-  requirement: &19211500 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19211500
-description: Allows to script usage of the SigmaKoki step motor controllers with simple
-  commands and without serial port troubles
-email: hugo.benichi@m4x.org
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Allows to script the control of SigmaKoki step motor controllers with
+  simple command without directly dealing with the serial port
+email: hugo[dot]benichi[at]m4x[dot]org
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -53,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Ruby interface to SigmaKoki step motor controllers over the serial interface