rb_scope 2.0.2

data/README.txt

@@ -0,0 +1,26 @@
+##
+ #              ni_scope
+ #
+ #     ( C2Ruby wrapper to NI-Scope drivers )
+ #    
+ #  version     2.0.1
+ #  author      hugo benichi
+ #  email       hugo.benichi@m4x.org
+ #  copyright   2012 hugo benichi
+ #  
+ #  reproduction 
+ #  
+ #    You can use this code without restriction if you mention my name in your project.
+ #    Other than that, you can redistribute and/or modify without restriction.
+ #  
+ #  description 
+ #  
+ #    A Ruby layer wrapping around C calls to the NI-Scope drivers.
+ #    Most C data manipulation and C calls are done through the FFI gems.
+ #	  In addition a few C methods are provided for improved efficiency when handling data
+ #
+ #  installation
+ #
+ #    gem install ni_scope-x.y.z.gem
+ #
+ ##

data/compile_cl.bat

@@ -0,0 +1,17 @@
+
+::  Bat script for compilation of the rb_scope.dll using MSVS cl and link.
+::  This script has been automatically generated by rake from the template in rakefile.rb.
+::
+::  author      hugo benichi
+::  email       hugo.benichi@gmail.com
+::  copyright   2012 hugo benichi
+
+  call "C:\Program Files (x86)\MVS10.0\VC\vcvarsall.bat"
+
+  call ruby -Ilib ext\ni_scope\wrapper_generator.rb > ext\ni_scope\wrapper.c
+
+  call cl -c .\ext\ni_scope\wrapper.c -I"C:\Program Files (x86)\IVI Foundation\VISA\WinNT\include"  
+
+  call link /DLL /OUT:ext\ni_scope\rb_scope.dll wrapper.obj "C:\Program Files (x86)\IVI Foundation\VISA\WinNT\Lib\msc\niScope.lib" 
+  
+  

data/ext/rb_scope/example.rb

@@ -0,0 +1,68 @@
+require 'rb_scope'
+
+# old
+settings = {
+	  rate:                   1000E6, 
+	  bandwidth:              300E6, 
+	  size:                   2000, 
+	  packet:                 1000, 
+    shot:                   10000,
+	  tomo:                   100000,	
+	  tomo_ohp:               100000,
+	  tomo_full:              100000,
+    byte:                   1,
+    trig_ref:               62,
+  }
+
+    pxi = Scope::start :pxi5152 do 
+    self[:timeout]        = -1 #= infinity
+    return_self           false 
+	  config                1
+    trigger_edge    
+	  vertical              "0", 0.2, settings[:bandwidth], 11
+    vertical              "1", 1.0, settings[:bandwidth], 11  
+	  horizontal            settings[:rate], settings[:size], settings[:shot], settings[:trig_ref]
+    set_buffer            settings[:packet], settings[:byte]
+	end
+ 
+#new change this to
+
+  settings = {
+      rate:                   1000E6, 
+      bandwidth:              300E6, 
+      size:                   1000, 
+      trig_ref:               62,
+      trig_voltage:           1.0, 
+      
+    }
+  
+  parameters = {
+  rate:           1000000,
+  frame_size      500,
+  frame_total     1000000,
+  channel: [
+    {chan_impedance: 50, range: 0.4 },
+    {chan_impedance: 50, range: 0.2 }
+  ],
+  
+}
+
+session = RbScope.new.configure parameters
+  
+#old  
+      pxi[:chan0] = sender[name][:quad]
+      pxi[:chan1] = sender[name][:phase]
+      pxi.set_num_record settings[name]
+  
+      pxi.acquire
+      trigger :on 
+      pxi.fetch
+      trigger :off
+
+#new: change this to 
+      pxi.run conf( records: 10000, chunk: 1000, frame: 500, timeout: 500, chan0: foo, chan1: bar) { trigger :on} 
+      trigger :off      
+      # assume foo and bar are object with two 
+      # methods, :context and :call with return 
+      # a struct pointer and a function pointer
+

data/ext/rb_scope/fetching/fetch.c

@@ -0,0 +1,76 @@
+
+#include  <stdio.h>
+#include  <stdlib.h>
+#include  "fetch.h"
+#include 	"niScope.h" 
+
+#define   prompt(MSG, ...)    printf("RbScope::Fetching::fetch.c >> " MSG, __VA_ARGS__)
+
+  typedef   
+    struct niScope_wfmInfo 
+    wfm_info;
+    
+  
+DLL int fetch(
+    fetch_hlp* parameters
+  )
+{
+    
+  unsigned int    session   = parameters-> session;
+  char*           address   = parameters-> address;
+  int             frm_siz   = parameters-> frm_siz;
+  int             frm_tot   = parameters-> frm_tot;
+  int             frm_chk   = parameters-> frm_chk;
+  double          timeout   = parameters-> timeout;
+  
+  char*           buff0     = NULL;
+  char*           buff1     = NULL;
+  buffer_address  buf_chan0 = parameters-> chan0;
+  buffer_address  buf_chan1 = parameters-> chan1;
+  void*           context0  = parameters-> chan0_context;
+  void*           context1  = parameters-> chan1_context;
+  error_handler   err_clbck = parameters-> err_clbck;
+   
+  wfm_info  frm_inf;
+  wfm_info *frm_inf_p = &frm_inf;
+ 
+  int i, rez, records_done;  
+
+  rez = niScope_SetAttributeViBoolean(session, VI_NULL, NISCOPE_ATTR_ALLOW_MORE_RECORDS_THAN_MEMORY, 1); // maybe have to move this before horizontal configuration
+  if( rez < 0) err_clbck(rez);
+  rez = niScope_SetAttributeViInt32(session, VI_NULL, NISCOPE_ATTR_HORZ_RECORD_LENGTH,  frm_siz);
+  if( rez < 0) err_clbck(rez);
+  rez = niScope_SetAttributeViInt32(session, VI_NULL, NISCOPE_ATTR_HORZ_NUM_RECORDS,    frm_tot);
+  if( rez < 0) err_clbck(rez);
+  rez = niScope_SetAttributeViInt32(session, VI_NULL, NISCOPE_ATTR_FETCH_NUM_RECORDS,   frm_chk);
+  if( rez < 0) err_clbck(rez);
+
+  prompt("starting fetching on %s\n", address);  
+  for (i = 0; i < frm_tot; i += frm_chk) 
+  {
+    
+    rez = niScope_SetAttributeViInt32(session, VI_NULL, NISCOPE_ATTR_FETCH_RECORD_NUMBER, i);    
+    
+    if( rez < 0) err_clbck(rez);
+    if (buf_chan0 && (buff0 = buf_chan0(context0)) )   /* this call can block ! */
+      rez = niScope_FetchBinary8(session, "0", timeout, frm_siz, buff0, frm_inf_p);  
+      
+    if( rez < 0) err_clbck(rez);
+    if (buf_chan1 && (buff1 = buf_chan1(context1)) )    /* this call can block ! */
+      rez = niScope_FetchBinary8(session, "1", timeout, frm_siz, buff1, frm_inf_p);      
+           
+    if( rez < 0) err_clbck(rez);
+    
+    rez = niScope_GetAttributeViInt32(session, VI_NULL, NISCOPE_ATTR_RECORDS_DONE, &records_done);    
+    if( rez < 0) err_clbck(rez);
+    prompt("%s, frames fetched #%i  |  measured #%i  |  left %i\n", address, i, records_done, records_done - i);
+  }
+
+  rez = niScope_GetAttributeViInt32(session, VI_NULL, NISCOPE_ATTR_RECORDS_DONE, &records_done);
+  if( rez < 0) err_clbck(rez);
+  
+  prompt("%s, total frames measured per channel: %i\n", address, records_done);
+  
+  return records_done;
+  
+}

data/ext/rb_scope/fetching/fetch.h

@@ -0,0 +1,38 @@
+
+
+#ifndef   RB_SCOPE_FETCHING_HEADER
+  #define   RB_SCOPE_FETCHING_HEADER
+
+  #define 	DLL     extern __declspec(dllexport)
+    
+  typedef   
+    struct fetch_helper
+    fetch_hlp;
+    
+  typedef
+    char*     (*buffer_address)(void*);
+    
+  typedef
+    void      (*error_handler)(int);
+  
+  struct 
+    fetch_helper
+    {
+	    char*				      address;        // physical address of the device
+      error_handler     err_clbck;      // ruby callback to manage errors
+      buffer_address    chan0;          // return the address of the next 
+      buffer_address    chan1;          //   output buffer for chan0/1
+      void*             chan0_context;  // context for the buffer_address functions
+      void*             chan1_context;  // one per buffer
+      double            timeout;        // in sec; -1 = infinite     
+      int               frm_siz;        // numbr of data points per one frame
+      int               frm_tot;        // total number of frm to fetch, per channels all chans one acq
+      int               frm_chk;        // numbr of frames to read in one packet (set by the buffer size)  
+	    unsigned int	    session;        // (ViSession pointer id used by the niScope API)
+    };
+  
+  DLL   int  fetch (fetch_hlp* parameters);
+
+#endif
+
+

data/ext/rb_scope/generators/extract_all.sh

@@ -0,0 +1,24 @@
+#!/bin/bash
+#  
+# This script takes into input the path to the ivi and niScope headers
+# on the local machine, and use them to generate a text file of pairs
+# name / values.
+#
+# This script is meant to be used in a Unix environment 
+# (for example cygwin on windows)
+#
+
+path_to_headers=$1
+
+ext/rb_scope/generators/extract_names.rb $path_to_headers/niScope.h   >  ni_scope_names.h
+ext/rb_scope/generators/extract_names.rb $path_to_headers/ivi.h       >> ni_scope_names.h
+ext/rb_scope/generators/extract_names.rb $path_to_headers/IviScope.h  >> ni_scope_names.h
+
+#gcc -E ni_scope_names.h -I$path_to_headers > ni_scope_preprocessed
+#ext/rb_scope/generators/extract_pairs.rb ni_scope_preprocessed > lib/rb_scope/api/niScope_pairs
+
+gcc -E ni_scope_names.h -I$path_to_headers > ni_scope_preprocessed
+ext/rb_scope/generators/extract_pairs.rb ni_scope_preprocessed > lib/rb_scope/api/niScope_pairs
+
+rm ni_scope_names.h ni_scope_preprocessed
+

data/ext/rb_scope/generators/extract_names.rb

@@ -0,0 +1,26 @@
+#!/usr/local/bin/ruby
+#
+# This script will extract the #define NAME VALUE pairs from 
+# a header file specified in ARGV[0] and write them into ARGV[1]
+# if ARGV[1] is not specified, output to stdin
+#
+# call with extract.rb scope.h filtered_scope.
+#
+
+  output = ARGV[1] ? File.open(ARGV[1], "w") : $stdout
+
+  output.puts '#include "niScope.h"'
+
+  File.open(ARGV[0],'r').readlines.select{ |line|
+    line =~ /^#define[\s]+[\w]+[\s]+\S[\s\S]+/
+  }.each{ |line| 
+    #name, val = line.match(/^#define[\s]+([\w]+)[\s]+(\S[\s\S]+)/)[1..2]
+    match = line.match(/^#define[\s]+([\w]+)[\s]+(\S[\s\S]+)/)
+    name = match[1]
+    val  = match[2]  #
+    #output.puts "%s\n    %s" % [name, val.gsub( %r|[\s]*/\*[\s\w]*\*/[\s]*|, '')]
+    #output.puts "%s\n    %s" % [name, val.gsub( %r|[\s]*/\*[\s\S]*?\*/[\s]*|, '')]
+    output.puts '"%s"; %s;' % [name, name]
+  }
+
+  output.close unless output == $stdin

data/ext/rb_scope/generators/extract_pairs.rb

@@ -0,0 +1,18 @@
+#!/usr/local/bin/ruby
+
+# This script will extract the NAME VALUE pairs file generated by extract_names.rb 
+# extract_names.rb and the gcc preprocessor and sligthly reformats the pairs in 
+# order for ruby to be able to process them as eval strings.
+#
+# call with extract.rb scope.h filtered_scope.
+#
+
+  output = ARGV[1] ? File.open(ARGV[1], "w") : $stdout
+
+  File.open(ARGV[0],'r').readlines.select{ |line|
+    line =~ /^"[\w]+";/
+  }.each{ |line| 
+    output.puts line.gsub("L)",")").gsub(/(\d)L/,"\\1").sub(/^"([\w]+)"; /, "\\1\n") [0..-3]
+  }
+
+  output.close unless output == $stdin

data/ext/rb_scope/generators/wrapper_generator.rb

@@ -0,0 +1,51 @@
+module RbScope
+
+  module API
+  
+    
+    module Wrapper
+    
+      require 'rb_scope/api/template'
+      
+      def self.build file_name=nil
+        output = file_name ? File.open(file_name, 'w') : $stdout        
+        [          
+          "/*", 
+          " *   This file has been automatically generated",
+          " *   by rb_scope/ext/rb_scope/#{File.basename __FILE__}",
+          " *",
+          " *   software: rb_scope gem",
+          " *   author: hugo benichi",
+          " *   contact: hugo.benichi@m4x.org",
+          " *",
+          " */",
+          "",
+          '#include "niScope.h"',
+          "",
+          "#define DLL extern __declspec(dllexport)",
+          "",        
+        ].each{|line| output.puts line}          
+        RbScope::API::Template.each do |sig|           
+          i = 0
+          args_chain_decla, args_chain_invoc = *sig[1].map{ |type|
+            ctype = RbScope::API::Types[:c][type] || type.to_s
+            arg   = "arg#{i+=1}"
+            [ "%s %s" % [ctype, arg], arg ]           
+          }.transpose.map{ |chain| chain.join ", "}
+          ext_name = sig[0].to_s.sub "niScope", "rbScope"   #do not hardcode this
+          int_name = sig[0].to_s
+          ret_type = RbScope::API::Types[:c][sig[2]] || sig[2].to_s
+          substitu = [ret_type, ext_name, args_chain_decla, int_name, args_chain_invoc]  
+          template = "DLL %s %s(%s)\n{\n  return %s(%s);\n}\n\n"        
+          output.puts template % substitu              
+        end            
+        output.close unless output == $stdout    
+      end
+    
+    end
+    
+  end
+  
+end
+
+RbScope::API::Wrapper.build ARGV[0]  #argv[0] is the path to the output file || stdout if nul

data/ext/rb_scope/wrapper.c

@@ -0,0 +1,154 @@
+/*
+ *   This file has been automatically generated
+ *   by ni_scope/api/builder.rb
+ *
+ *   software: ni_scope gem
+ *   author: hugo benichi
+ *   contact: hugo.benichi@m4x.org
+ *
+ */
+
+#include "niScope.h"
+
+#define DLL extern __declspec(dllexport)
+
+DLL int rbScope_init(char* arg1, unsigned short arg2, unsigned short arg3, ViUInt32* arg4)
+{
+  return niScope_init(arg1, arg2, arg3, arg4);
+}
+
+DLL int rbScope_close(unsigned int arg1)
+{
+  return niScope_close(arg1);
+}
+
+DLL int rbScope_CalSelfCalibrate(unsigned int arg1, char* arg2, int arg3)
+{
+  return niScope_CalSelfCalibrate(arg1, arg2, arg3);
+}
+
+DLL int rbScope_ConfigureAcquisition(unsigned int arg1, int arg2)
+{
+  return niScope_ConfigureAcquisition(arg1, arg2);
+}
+
+DLL int rbScope_ConfigureTriggerDigital(unsigned int arg1, char* arg2, int arg3, double arg4, double arg5)
+{
+  return niScope_ConfigureTriggerDigital(arg1, arg2, arg3, arg4, arg5);
+}
+
+DLL int rbScope_ConfigureTriggerEdge(unsigned int arg1, char* arg2, double arg3, int arg4, int arg5, double arg6, double arg7)
+{
+  return niScope_ConfigureTriggerEdge(arg1, arg2, arg3, arg4, arg5, arg6, arg7);
+}
+
+DLL int rbScope_ConfigureTriggerImmediate(unsigned int arg1)
+{
+  return niScope_ConfigureTriggerImmediate(arg1);
+}
+
+DLL int rbScope_ConfigureChanCharacteristics(unsigned int arg1, char* arg2, double arg3, double arg4)
+{
+  return niScope_ConfigureChanCharacteristics(arg1, arg2, arg3, arg4);
+}
+
+DLL int rbScope_ConfigureVertical(unsigned int arg1, char* arg2, double arg3, double arg4, int arg5, double arg6, unsigned short arg7)
+{
+  return niScope_ConfigureVertical(arg1, arg2, arg3, arg4, arg5, arg6, arg7);
+}
+
+DLL int rbScope_ConfigureHorizontalTiming(unsigned int arg1, double arg2, int arg3, double arg4, int arg5, unsigned short arg6)
+{
+  return niScope_ConfigureHorizontalTiming(arg1, arg2, arg3, arg4, arg5, arg6);
+}
+
+DLL int rbScope_ActualRecordLength(unsigned int arg1, ViInt32* arg2)
+{
+  return niScope_ActualRecordLength(arg1, arg2);
+}
+
+DLL int rbScope_ActualNumWfms(unsigned int arg1, char* arg2, ViInt32* arg3)
+{
+  return niScope_ActualNumWfms(arg1, arg2, arg3);
+}
+
+DLL int rbScope_GetAttributeViBoolean(unsigned int arg1, char* arg2, unsigned int arg3, unsigned short* arg4)
+{
+  return niScope_GetAttributeViBoolean(arg1, arg2, arg3, arg4);
+}
+
+DLL int rbScope_GetAttributeViInt32(unsigned int arg1, char* arg2, unsigned int arg3, ViInt32* arg4)
+{
+  return niScope_GetAttributeViInt32(arg1, arg2, arg3, arg4);
+}
+
+DLL int rbScope_GetAttributeViReal64(unsigned int arg1, char* arg2, unsigned int arg3, double* arg4)
+{
+  return niScope_GetAttributeViReal64(arg1, arg2, arg3, arg4);
+}
+
+DLL int rbScope_GetAttributeViString(unsigned int arg1, char* arg2, unsigned int arg3, int arg4, char* arg5)
+{
+  return niScope_GetAttributeViString(arg1, arg2, arg3, arg4, arg5);
+}
+
+DLL int rbScope_SetAttributeViBoolean(unsigned int arg1, char* arg2, unsigned int arg3, unsigned short arg4)
+{
+  return niScope_SetAttributeViBoolean(arg1, arg2, arg3, arg4);
+}
+
+DLL int rbScope_SetAttributeViInt32(unsigned int arg1, char* arg2, unsigned int arg3, int arg4)
+{
+  return niScope_SetAttributeViInt32(arg1, arg2, arg3, arg4);
+}
+
+DLL int rbScope_SetAttributeViReal64(unsigned int arg1, char* arg2, unsigned int arg3, double arg4)
+{
+  return niScope_SetAttributeViReal64(arg1, arg2, arg3, arg4);
+}
+
+DLL int rbScope_SetAttributeViString(unsigned int arg1, char* arg2, unsigned int arg3, char* arg4)
+{
+  return niScope_SetAttributeViString(arg1, arg2, arg3, arg4);
+}
+
+DLL int rbScope_errorHandler(unsigned int arg1, int arg2, char* arg3, char* arg4)
+{
+  return niScope_errorHandler(arg1, arg2, arg3, arg4);
+}
+
+DLL int rbScope_GetError(unsigned int arg1, ViInt32* arg2, int arg3, char* arg4)
+{
+  return niScope_GetError(arg1, arg2, arg3, arg4);
+}
+
+DLL int rbScope_GetErrorMessage(unsigned int arg1, int arg2, int arg3, char* arg4)
+{
+  return niScope_GetErrorMessage(arg1, arg2, arg3, arg4);
+}
+
+DLL int rbScope_InitiateAcquisition(unsigned int arg1)
+{
+  return niScope_InitiateAcquisition(arg1);
+}
+
+DLL int rbScope_AcquisitionStatus(unsigned int arg1, ViInt32* arg2)
+{
+  return niScope_AcquisitionStatus(arg1, arg2);
+}
+
+DLL int rbScope_FetchBinary8(unsigned int arg1, char* arg2, double arg3, int arg4, char* arg5, void* arg6)
+{
+  return niScope_FetchBinary8(arg1, arg2, arg3, arg4, arg5, arg6);
+}
+
+DLL int rbScope_FetchBinary16(unsigned int arg1, char* arg2, double arg3, int arg4, short* arg5, void* arg6)
+{
+  return niScope_FetchBinary16(arg1, arg2, arg3, arg4, arg5, arg6);
+}
+
+DLL int rbScope_Abort(unsigned int arg1)
+{
+  return niScope_Abort(arg1);
+}
+

data/lib/rb_scope/api/niScope_api.rb

@@ -0,0 +1,31 @@
+module RbScope
+
+  # This module acts as the Ruby interface to the C API.
+  # It loads the niScope dll library and links itself to the dll functions.
+  # It also loads all the macro constants defined in niScope.h for easier
+  # scripting of the digitizer devices from Ruby.
+  module API
+
+    require 'ffi'
+    require 'rb_scope/api/niScope_template'
+    require 'rb_scope/api/niScope_values'
+    
+    extend FFI::Library
+    
+    #begin
+      ffi_lib $LOAD_PATH.map{ |path| path+"/rb_scope/rb_scope.dll"}    
+      Template.each{ |sig| 
+      puts sig
+        attach_function(  
+          sig[0].to_s.sub("niScope", "rbScope").to_sym, 
+          sig[1].map{|t| Types[:ruby][t] || t }, 
+          sig[2] 
+        )     
+      }
+    #rescue
+    #  RbScope::prompt "could not load rb_scope.dll library"
+    #end
+
+  end
+  
+end