ffi-k8055 0.5.0

data/Changelog

@@ -0,0 +1,3 @@
+
+2011-06-06 Jérémy Zurcher <jeremy@asynk.ch>
+	* Project creation

data/MIT-LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2011 Jérémy Zurcher
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+  
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+   
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,69 @@
+ffi-k8055
+    by Jérémy Zurcher
+    http://asynk.ch
+
+== DESCRIPTION:
+
+A ruby-ffi binding to libk8055, an open source library to access Velleman's k8055 USB board.
+This is part of k8055[https://github.com/jeremyz/k8055]
+
+== FEATURES/PROBLEMS:
+
+    # TODO
+
+== SYNOPSIS:
+
+    require 'k8055'
+    puts "K8055 version : #{K8055.version}"
+    @k = K8055::K8055.new
+    @k.open_device 0
+    @k.write_analog_channel 1, 128
+    @k.k8055_set_analog_channel 2
+    @k.close_device
+
+For more examples you may look at:
+
+* the spec/[https://github.com/jeremyz/k8055/tree/master/ruby/ffi-k8055/spec] folder
+
+== REQUIREMENTS:
+
+* You need to first install libk8055[https://github.com/jeremyz/k8055]
+
+== DOWNLOAD/INSTALL:
+
+From rubygems:
+
+  [sudo] gem install ffi-k8055
+
+or from the git repository on github:
+
+  git clone git://github.com/jeremyz/k8055.git
+  cd k8055/ruby/ffi-k8055
+  rake gem:install
+
+== RESOURCES:
+
+You can find this project in a few places:
+
+Online repositories:
+
+* https://github.com/jeremyz/k8055
+* http://cgit.asynk.ch/cgi-bin/cgit/k8055
+* https://gitorious.org/k8055
+
+Gem:
+
+* https://rubygems.org/gems/ffi-k8055
+
+== CREDITS:
+
+Special thanks to:
+
+* Sven Lindberg
+* Pjetur G. Hjaltason
+* Martin Pischky
+* Etienne Mouragnon
+
+== LICENSE:
+
+See MIT-LICENSE file.

data/Rakefile

@@ -0,0 +1,62 @@
+# -*- coding: UTF-8 -*-
+#
+load './tasks/setup.rb'
+#
+# Project general information
+PROJ.name = 'ffi-k8055'
+PROJ.authors = 'Jérémy Zurcher'
+PROJ.email = 'jeremy@asynk.ch'
+PROJ.url = 'https://github.com/jeremyz/k8055'
+major = minor = patch = nil
+File.open('../../CMakeLists.txt').each do |l|
+    major = $1 if l=~/VERSION_MAJOR\s+\"(\d+)\"/
+    minor = $1 if l=~/VERSION_MINOR\s+\"(\d+)\"/
+    patch = $1 if l=~/VERSION_PATCH\s+\"(\d+)\"/
+end
+PROJ.version = "#{major}.#{minor}.#{patch}"
+PROJ.rubyforge.name = 'none'
+PROJ.readme_file = 'README.rdoc'
+#
+# Annoucement
+PROJ.ann.paragraphs << 'FEATURES' << 'SYNOPSIS' << 'REQUIREMENTS' << 'DOWNLOAD/INSTALL' << 'CREDITS' << 'LICENSE'
+PROJ.ann.email[:from] = 'jeremy@asynk.ch'
+PROJ.ann.email[:to] = ['FIXME']
+PROJ.ann.email[:server] = 'localhost'
+PROJ.ann.email[:tls] = false
+# Gem specifications
+PROJ.gem.need_tar = false
+PROJ.gem.files = %w(Changelog MIT-LICENSE README.rdoc Rakefile) + Dir.glob("{ext,lib,spec,tasks}/**/*[^~]").reject { |fn| test ?d, fn }
+PROJ.gem.platform = Gem::Platform::RUBY
+PROJ.gem.required_ruby_version = ">= 1.9.2"
+#
+# Override Mr. Bones autogenerated extensions and force ours in
+#PROJ.gem.extras['extensions'] = %w(ext/extconf.rb)
+#PROJ.gem.extras['required_ruby_version'] = ">= 1.9.2"
+#
+# RDoc
+PROJ.rdoc.exclude << '^ext\/'
+PROJ.rdoc.opts << '-x' << 'ext'
+#
+# Ruby
+PROJ.ruby_opts = []
+PROJ.ruby_opts << '-I' << 'lib'
+#
+# RSpec
+PROJ.spec.files.exclude /rbx/
+PROJ.spec.opts << '--color'
+#
+# Rcov
+PROJ.rcov.opts << '-I lib'
+#
+# Dependencies
+depend_on 'ffi', '>=1.0.2'
+#
+task :default  => [:spec]
+#
+desc "Build all packages"
+task :package => 'gem:package'
+#
+desc "Install the gem locally"
+task :install => 'gem:install'
+#
+# EOF

data/lib/k8055.rb

@@ -0,0 +1,141 @@
+#! /usr/bin/env ruby
+# -*- coding: UTF-8 -*-
+#
+require 'ffi'
+#
+module K8055
+    #
+    module Native
+        class K8055Struct < FFI::Struct
+            layout  :dev_no,        :int,
+                    :usb_ctx,       :pointer,
+                    :usb_handle,    :pointer,
+                    :data_in,       :pointer,
+                    :data_out,      :pointer,
+        end
+        #
+        extend FFI::Library
+        #
+        ffi_lib 'k8055'
+        #
+        typedef :pointer, :k8055_dev
+        #
+        [
+            [ :k8055_alloc, [], :k8055_dev],
+            [ :k8055_free, [:k8055_dev], :void],
+            [ :k8055_read, [:k8055_dev], :int],
+            [ :k8055_write, [:k8055_dev], :int],
+            [ :k8055_digital_outputs, [:k8055_dev], :int],
+            [ :k8055_digital_output_1, [:k8055_dev], :int],
+            [ :k8055_digital_output_2, [:k8055_dev], :int],
+            [ :k8055_digital_output_3, [:k8055_dev], :int],
+            [ :k8055_digital_output_4, [:k8055_dev], :int],
+            [ :k8055_digital_output_5, [:k8055_dev], :int],
+            [ :k8055_analog_output_1, [:k8055_dev], :int],
+            [ :k8055_analog_output_2, [:k8055_dev], :int],
+            [ :k8055_digital_input_1, [:k8055_dev], :int],
+            [ :k8055_digital_input_2, [:k8055_dev], :int],
+            [ :k8055_digital_input_3, [:k8055_dev], :int],
+            [ :k8055_digital_input_4, [:k8055_dev], :int],
+            [ :k8055_digital_input_5, [:k8055_dev], :int],
+            [ :k8055_analog_input_1, [:k8055_dev], :int],
+            [ :k8055_analog_input_2, [:k8055_dev], :int],
+            [ :k8055_counter_1, [:k8055_dev], :int],
+            [ :k8055_counter_2, [:k8055_dev], :int],
+            [ :k8055_version, [], :string],
+            [ :k8055_set_debug, [:int], :int],
+            [ :k8055_get_debug, [], :int],
+            [ :k8055_search_devices, [], :int],
+            [ :k8055_open_device, [:k8055_dev,:int], :int],
+            [ :k8055_close_device, [:k8055_dev], :int],
+            [ :k8055_set_analog_channel, [:k8055_dev,:int], :int],
+            [ :k8055_clear_analog_channel, [:k8055_dev,:int], :int],
+            [ :k8055_read_analog_channel, [:k8055_dev,:int], :int],
+            [ :k8055_write_analog_channel, [:k8055_dev,:int,:int], :int],
+            [ :k8055_set_all_analog, [:k8055_dev], :int],
+            [ :k8055_clear_all_analog, [:k8055_dev], :int],
+            [ :k8055_read_all_analog, [:k8055_dev,:pointer,:pointer], :int],
+            [ :k8055_write_all_analog, [:k8055_dev,:int,:int], :int],
+            [ :k8055_set_digital_channel, [:k8055_dev,:int], :int],
+            [ :k8055_clear_digital_channel, [:k8055_dev,:int], :int],
+            [ :k8055_read_digital_channel, [:k8055_dev,:int], :int],
+            [ :k8055_set_all_digital, [:k8055_dev], :int],
+            [ :k8055_clear_all_digital, [:k8055_dev], :int],
+            [ :k8055_read_all_digital, [:k8055_dev], :int],
+            [ :k8055_write_all_digital, [:k8055_dev,:int], :int],
+            [ :k8055_write_all_outputs, [:k8055_dev,:int,:int,:int], :int],
+            [ :k8055_read_all_inputs, [:k8055_dev,:pointer,:pointer,:pointer,:pointer,:pointer], :int],
+            [ :k8055_reset_counter, [:k8055_dev,:int], :int],
+            [ :k8055_read_counter, [:k8055_dev,:int], :int],
+        ].each do |func|
+            begin
+                attach_function(*func)
+            rescue Object => e
+                puts "Could not attach #{func} #{e.message}"
+            end
+        end
+        #
+    end
+    #
+    def self.version
+        Native.k8055_version
+    end
+    #
+    def self.search_devices
+        Native.k8055_search_devices
+    end
+    #
+    class K8055
+        def initialize n=nil
+            @dev = FFI::AutoPointer.new Native.k8055_alloc, K8055.method(:release)
+            open n unless n.nil?
+        end
+        def self.release p
+            Native.k8055_free p unless p.nil?
+        end
+        def free
+            Native.k8055_close_device @dev
+            @dev.autorelease=false if not @dev.nil?
+            K8055.release @dev
+            @dev=nil
+        end
+        def self.version
+            Native.k8055_version
+        end
+        def k8055_read_all_analog
+            a1 = FFI::MemoryPointer.new :int
+            a2 = FFI::MemoryPointer.new :int
+            Native.k8055_read_all_analog @dev, a1, a2
+            [ a1.read_int, a2.read_int ]
+        end
+        alias :read_all_analog :k8055_read_all_analog
+        def k8055_read_all_values
+            a1 = FFI::MemoryPointer.new :int
+            a2 = FFI::MemoryPointer.new :int
+            Native.k8055_read_all_analog @dev, a1, a2
+            [ a1.read_int, a2.read_int ]
+        end
+        alias :read_all_values :k8055_read_all_values
+        def method_missing m, *args, &block
+            m_s = m.to_s
+            meth = (
+                if Native.respond_to? m_s
+                    m_s
+                elsif Native.respond_to? 'k8055_'+m_s
+                    'k8055_'+m_s
+                else
+                    nil
+                end
+            )
+            if not meth.nil?
+#                self.class.class_eval "def #{m} *args, &block; r=Native.#{meth}(@dev,*args); yield r if block_given?; r; end"
+                self.class.class_eval "def #{m} *args, &block; Native.#{meth}(@dev,*args); end"
+                return self.send m, *args, &block
+            end
+            Kernel.raise NameError.new "#{self.class.name} is unable to resolve #{m}"
+        end
+    end
+    #
+end
+#
+# EOF

data/spec/k8055_spec.rb

@@ -0,0 +1,147 @@
+#! /usr/bin/env ruby
+# -*- coding: UTF-8 -*-
+#
+require 'k8055'
+#
+describe K8055 do
+    #
+    it "version should work" do
+        K8055::K8055.version.should == K8055.version
+    end
+    #
+    it "search_devices should find one" do
+        K8055.search_devices.should > 0
+    end
+    #
+    describe K8055 do
+        #
+        before(:all) { 
+            @k = K8055::K8055.new
+            @k.open_device 0
+        }
+        after(:all) {
+            @k.close_device
+            @k.free
+        }
+        #
+        it "analog output 1" do
+            @k.k8055_set_analog_channel 1
+            @k.k8055_analog_output_1.should == 255
+            @k.k8055_write_analog_channel 1, 10
+            @k.k8055_analog_output_1.should == 10
+            @k.k8055_write_analog_channel 1, 250
+            @k.k8055_analog_output_1.should == 250
+            @k.k8055_clear_analog_channel 1
+            @k.k8055_analog_output_1.should == 0
+            @k.set_analog_channel 1
+            @k.analog_output_1.should == 255
+            @k.write_analog_channel 1, 10
+            @k.analog_output_1.should == 10
+            @k.write_analog_channel 1, 250
+            @k.analog_output_1.should == 250
+            @k.clear_analog_channel 1
+            @k.analog_output_1.should == 0
+        end
+        it "analog output 2" do
+            @k.k8055_set_analog_channel 2
+            @k.k8055_analog_output_2.should == 255
+            @k.k8055_write_analog_channel 2, 10
+            @k.k8055_analog_output_2.should == 10
+            @k.k8055_write_analog_channel 2, 250
+            @k.k8055_analog_output_2.should == 250
+            @k.k8055_clear_analog_channel 2
+            @k.k8055_analog_output_2.should == 0
+            @k.set_analog_channel 2
+            @k.analog_output_2.should == 255
+            @k.write_analog_channel 2, 10
+            @k.analog_output_2.should == 10
+            @k.write_analog_channel 2, 250
+            @k.analog_output_2.should == 250
+            @k.clear_analog_channel 2
+            @k.analog_output_2.should == 0
+        end
+        #
+        it "digital output 1" do
+            @k.set_all_digital
+            @k.digital_output_1.should == 1
+            @k.clear_digital_channel 1
+            @k.digital_output_1.should == 0
+            @k.set_digital_channel 1
+            @k.digital_output_1.should == 1
+            @k.clear_all_digital
+            @k.digital_output_1.should == 0
+        end
+        #
+        it "digital output 2" do
+            @k.set_all_digital
+            @k.digital_output_2.should == 1
+            @k.clear_digital_channel 2
+            @k.digital_output_2.should == 0
+            @k.set_digital_channel 2
+            @k.digital_output_2.should == 1
+            @k.clear_all_digital
+            @k.digital_output_2.should == 0
+        end
+        #
+        it "digital output 3" do
+            @k.set_all_digital
+            @k.digital_output_3.should == 1
+            @k.clear_digital_channel 3
+            @k.digital_output_3.should == 0
+            @k.set_digital_channel 3
+            @k.digital_output_3.should == 1
+            @k.clear_all_digital
+            @k.digital_output_3.should == 0
+        end
+        #
+        it "digital output 4" do
+            @k.set_all_digital
+            @k.digital_output_4.should == 1
+            @k.clear_digital_channel 4
+            @k.digital_output_4.should == 0
+            @k.set_digital_channel 4
+            @k.digital_output_4.should == 1
+            @k.clear_all_digital
+            @k.digital_output_4.should == 0
+        end
+        #
+        it "digital output 5" do
+            @k.set_all_digital
+            @k.digital_output_5.should == 1
+            @k.clear_digital_channel 5
+            @k.digital_output_5.should == 0
+            @k.set_digital_channel 5
+            @k.digital_output_5.should == 1
+            @k.clear_all_digital
+            @k.digital_output_5.should == 0
+        end
+        #
+        it "outputs test loop" do
+            @k.set_all_digital
+            @k.set_all_analog
+            @k.digital_outputs.should == 255
+            @k.digital_output_1.should == 1
+            @k.digital_output_2.should == 1
+            @k.digital_output_3.should == 1
+            @k.digital_output_4.should == 1
+            @k.digital_output_5.should == 1
+            @k.analog_output_1.should == 255
+            @k.analog_output_2.should == 255
+            (0..255).each do |n|
+                @k.write_all_digital n
+                @k.write_all_analog n, n
+                @k.digital_outputs.should == n
+            end
+            @k.clear_all_digital
+            @k.clear_all_analog
+            @k.digital_outputs.should == 0
+            @k.digital_output_1.should == 0
+            @k.digital_output_2.should == 0
+            @k.digital_output_3.should == 0
+            @k.digital_output_4.should == 0
+            @k.digital_output_5.should == 0
+            @k.analog_output_1.should == 0
+            @k.analog_output_2.should == 0
+        end
+    end
+end

data/tasks/ann.rake

@@ -0,0 +1,83 @@
+# -*- coding: UTF-8 -*-
+#
+begin
+    require 'bones/smtp_tls'
+rescue LoadError
+    require 'net/smtp'
+end
+require 'time'
+
+namespace :ann do
+
+    # A prerequisites task that all other tasks depend upon
+    task :prereqs
+    file PROJ.ann.file do
+        ann = PROJ.ann
+        puts "Generating #{ann.file}"
+        File.open(ann.file,'w') do |fd|
+            fd.puts("#{PROJ.name} version #{PROJ.version}")
+            fd.puts("    by #{Array(PROJ.authors).first}") if PROJ.authors
+            fd.puts("    #{PROJ.url}") if PROJ.url.valid?
+            fd.puts("    (the \"#{PROJ.release_name}\" release)") if PROJ.release_name
+            fd.puts
+            fd.puts("== DESCRIPTION")
+            fd.puts
+            fd.puts(PROJ.description)
+            fd.puts
+            fd.puts(PROJ.changes.sub(%r/^.*$/, '== CHANGES'))
+            fd.puts
+            ann.paragraphs.each do |p|
+                fd.puts "== #{p.upcase}"
+                fd.puts
+                fd.puts paragraphs_of(PROJ.readme_file, p).join("\n\n")
+                fd.puts
+            end
+            fd.puts ann.text if ann.text
+        end
+    end
+
+    desc "Create an announcement file"
+    task :announcement => ['ann:prereqs', PROJ.ann.file]
+
+    desc "Send an email announcement"
+    task :email => ['ann:prereqs', PROJ.ann.file] do
+        ann = PROJ.ann
+        from = ann.email[:from] || Array(PROJ.authors).first || PROJ.email
+        to   = Array(ann.email[:to])
+
+        ### build a mail header for RFC 822
+        rfc822msg =  "From: #{from}\n"
+        rfc822msg << "To: #{to.join(',')}\n"
+        rfc822msg << "Subject: [ANN] #{PROJ.name} #{PROJ.version}"
+        rfc822msg << " (#{PROJ.release_name})" if PROJ.release_name
+        rfc822msg << "\n"
+        rfc822msg << "Date: #{Time.new.rfc822}\n"
+        rfc822msg << "Message-Id: "
+        rfc822msg << "<#{"%.8f" % Time.now.to_f}@#{ann.email[:domain]}>\n\n"
+        rfc822msg << File.read(ann.file)
+
+        params = [:server, :port, :domain, :acct, :passwd, :authtype].map do |key|
+            ann.email[key]
+        end
+
+        params[3] = (PROJ.ann.email[:from] || PROJ.email) if params[3].nil?
+
+#        if ann.email[:tls] and params[4].nil?
+        if params[4].nil?
+            STDOUT.write "Please enter your e-mail password (#{params[3]}): "
+            params[4] = STDIN.gets.chomp
+        end
+#        params = params.shift 2 if not ann.email[:tls]
+
+        ### send email
+        # TODO find a way to bypass /var/lib/gems/1.9/gems/bones-3.6.5/lib/bones/smtp_tls.rb which forces starttls usage
+        Net::SMTP.start(*params) {|smtp| smtp.sendmail(rfc822msg, from, to)}
+    end
+end  # namespace :ann
+
+desc 'Alias to ann:announcement'
+task :ann => 'ann:announcement'
+
+CLOBBER << PROJ.ann.file
+
+# EOF