tallakt-picopc 0.1.0

data/lib/picopc/picopc.rb

@@ -0,0 +1,113 @@
+#!/usr/bin/env ruby
+
+# http://www.ruby-forum.com/topic/61294
+
+require 'win32ole'
+require File.dirname(__FILE__) + "/olegen_opc_automation"
+
+module PicOpc
+  class PicOpcException < StandardError
+    attr_reader :cause
+
+    def initialize cause
+      @cause = cause
+    end
+
+    def self.[](e)
+      raise e if e.class == PicOpcException
+      e2 = new(e)
+      raise e2, "OPC/OLE Exception: #{e.message}", e.backtrace
+    end
+  end
+
+  def PicOpc.connect(opc_server_name, options = {})
+    po = Client.new opc_server_name, options
+    begin
+      yield po
+    ensure
+      po.cleanup
+    end
+  end
+
+  class Client
+
+    def initialize(opc_server_name, options = {}) 
+      begin
+        @opc_automation = OPC_Automation_1.new
+        @opc_automation.Connect opc_server_name, 'localhost'
+        @groups = @opc_automation.OPCGroups
+        @group = @groups.add 'picopc_group'
+        @opc_items = @group.OPCItems
+        @items = {}
+        @handle = 1
+        if options[:cache]
+          @source = OPCDataSource::OPCCache
+        else
+          @source = OPCDataSource::OPCDevice
+        end
+      rescue Exception => e
+        PicOpcException[e] # wrap all exceptions in this type
+      end
+    end
+
+    def cleanup
+      begin
+        @groups.RemoveAll
+        @opc_automation.Disconnect
+      rescue Exception => e
+        PicOpcException[e] # wrap all exceptions in this type
+      end
+    end
+
+    def add_item(name)
+      if not @items.key? name
+        @items[name] = @opc_items.AddItem(name, @handle)
+        @handle += 1
+      end
+      @items[name]
+    end
+
+
+    def read(name)
+      begin
+        item = add_item name
+        return_value = WIN32OLE_VARIANT.new 0, WIN32OLE::VARIANT::VT_VARIANT|WIN32OLE::VARIANT::VT_BYREF
+        item.read @source, return_value
+        return_value.value
+      rescue Exception => e
+        PicOpcException[e] # wrap all exceptions in this type
+      end
+    end
+
+
+    def write(name, value)
+      begin
+        item = add_item name
+        item.write value
+      rescue Exception => e
+        PicOpcException[e] # wrap all exceptions in this type
+      end
+    end
+
+    def [](name)
+      read name
+    end
+
+    def []=(name, value)
+      write name, value
+    end
+
+    def tag(name, reference) 
+      # Get a handle to the singleton class of obj
+      metaclass = class << self; self; end
+
+      metaclass.send :define_method, name do
+        read reference
+      end
+
+      metaclass.send :define_method, (name.to_s + '=').to_sym do |value|
+        write reference, value
+      end
+    end
+  end
+end

data/spec/picopc_spec.rb

@@ -0,0 +1,59 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+MATRIKON = 'Matrikon.OPC.Simulation'
+
+describe PicOpc do
+  it 'Should be able to read a tag from Matrikon.OPC.Simulator' do
+    po = PicOpc::Client.new MATRIKON
+    po.read('Random.Int1').should_not be_nil
+    po['Random.Int1'].should_not be_nil
+  end
+  it 'Should be able to write a tag from Matrikon.OPC.Simulator' do
+    tag = 'Bucket Brigade.String'
+    po = PicOpc::Client.new MATRIKON
+    po.write(tag, 'Hello')
+    po[tag].should == 'Hello'
+    po.write(tag, 'There')
+    po[tag].should == 'There'
+    po[tag] = 'Folks'
+    po[tag].should == 'Folks'
+  end
+
+  it 'Should let through exceptions when passing block' do
+    lambda {
+      PicOpc.connect MATRIKON do |matrikon|
+        raise 'ok'
+      end
+    }.should raise_exception(RuntimeError) {|ex| ex.message.should == 'ok' }
+  end
+
+  it 'Should should return types of the correct type' do
+    PicOpc.connect MATRIKON do |m|
+      [true, false].should be_member m['Random.Boolean']
+      m['Random.Int1'].should be_a_kind_of(Fixnum)
+      m['Random.Real8'].should be_a_kind_of(Float)
+      m['Random.String'].should be_a_kind_of(String)
+      m['Random.String'].should be_a_kind_of(String)
+      tmp = m['Random.ArrayOfString']
+      tmp.should be_a_kind_of(Array)
+      tmp.first.should be_a_kind_of(String)
+    end
+  end
+
+  it 'Should support reading tags created with the tag function' do
+    PicOpc.connect MATRIKON do |m|
+      m.tag :int, 'Random.Int1'
+      m.int.should be_a_kind_of(Fixnum)
+    end
+  end
+
+  it 'Should support writing tags created with the tag function' do
+    PicOpc.connect MATRIKON do |m|
+      m.tag :int, 'Bucket Brigade.Int1'
+      m.int = 5
+      m.int.should == 5
+      m.int = 6
+      m.int.should == 6
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'picopc'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

data/tallakt-picopc.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{tallakt-picopc}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tallak Tveide"]
+  s.date = %q{2010-02-17}
+  s.description = %q{A simple DCOM OPC library for ruby that allows simple access to OPC servers but with poor efficiency}
+  s.email = %q{tallak@tveide.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/picopc.rb",
+     "lib/picopc/olegen_opc_automation.rb",
+     "lib/picopc/picopc.rb",
+     "spec/picopc_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "tallakt-picopc.gemspec"
+  ]
+  s.homepage = %q{http://github.com/tallakt/picopc}
+  s.rdoc_options = ["--charset=UTF-8", "--title", "PicOpc -- Tiny Ruby OPC", "--main", "README", "--line-numbers"]
+  s.require_paths = ["lib"]
+  s.required_ruby_version = Gem::Requirement.new(">= 1.9.0")
+  s.requirements = ["To run tests, you must install Matrikon OPC Simulator", "PicOpc will only run on Windows systems due to DCOM dependency"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Pico OPC: very tiny OPc implementation for Ruby}
+  s.test_files = [
+    "spec/picopc_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: tallakt-picopc
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tallak Tveide
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-17 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: A simple DCOM OPC library for ruby that allows simple access to OPC servers but with poor efficiency
+email: tallak@tveide.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/picopc.rb
+- lib/picopc/olegen_opc_automation.rb
+- lib/picopc/picopc.rb
+- spec/picopc_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tallakt-picopc.gemspec
+has_rdoc: true
+homepage: http://github.com/tallakt/picopc
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+- --title
+- PicOpc -- Tiny Ruby OPC
+- --main
+- README
+- --line-numbers
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.9.0
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: 
+- To run tests, you must install Matrikon OPC Simulator
+- PicOpc will only run on Windows systems due to DCOM dependency
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: "Pico OPC: very tiny OPc implementation for Ruby"
+test_files: 
+- spec/picopc_spec.rb
+- spec/spec_helper.rb