libftdi-ruby 0.0.1

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/
+.yardoc/
+doc/
+

data/.yardopts

@@ -0,0 +1,10 @@
+--markup markdown
+--markup-provider redcarpet
+--charset utf-8
+--no-private
+--readme README.md
+--title "libftdi-ruby Documentation"
+-
+README.md
+LICENSE
+

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in libftdi-ruby.gemspec
+gemspec
+
+gem "ripper", :group => :development, :platforms => :ruby_18
+

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2010-2011 Akzhan Abdulin and contributors
+
+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 OR COPYRIGHT HOLDERS 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.md

@@ -0,0 +1,2 @@
+Ruby bindings for [libftdi](http://www.intra2net.com/en/developer/libftdi/index.php) - an open source library to talk to [FTDI](http://www.ftdichip.com/) chips.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+require "yard"
+
+YARD::Rake::YardocTask.new
+

data/lib/ftdi.rb

@@ -0,0 +1,203 @@
+require 'ffi'
+require "ftdi/version"
+
+module Ftdi
+  extend FFI::Library
+
+  ffi_lib "libftdi"
+
+  # FTDI chip type.
+  ChipType = enum(:type_am, :type_bm, :type_2232c, :type_r, :type_2232h, :type_4232h, :type_232h)
+
+  # Automatic loading / unloading of kernel modules
+  ModuleDetachMode = enum(:auto_detach_sio_module, :dont_detach_sio_module)
+
+  # Number of bits for {Ftdi::Context.set_line_property}
+  BitsType = enum(
+    :bits_7, 7,
+    :bits_8, 8
+  )
+
+  # Number of stop bits for {Ftdi::Context.set_line_property}
+  StopbitsType = enum(
+    :stop_bit_1, 0,
+    :stop_bit_15, 1,
+    :stop_bit_2, 2
+  )
+
+  # Parity mode for {Ftdi::Context.set_line_property}
+  ParityType = enum(:none, :odd, :even, :mark, :space)
+
+  # Break type for {Ftdi::Context.set_line_property2}
+  BreakType = enum(:break_off, :break_on)
+
+  SIO_DISABLE_FLOW_CTRL = 0x0
+
+  # Base error of libftdi.
+  class Error < RuntimeError; end
+
+  # Initialization error of libftdi.
+  class CannotInitializeContextError < Error; end
+
+  # Error of libftdi with its status code.
+  class StatusCodeError < Error
+    attr_accessor :status_code
+
+    def initialize(status_code, message)
+      super(message)
+      self.status_code = status_code
+    end
+
+    def to_s
+      "#{status_code}: #{super}"
+    end
+  end
+
+  # libftdi context
+  class Context < FFI::Struct
+    layout(
+      # USB specific
+      # libusb's context
+      :usb_ctx, :pointer,
+      # libusb's usb_dev_handle
+      :usb_dev, :pointer,
+      # usb read timeout
+      :usb_read_timeout, :int,
+      # usb write timeout
+      :usb_write_timeout, :int,
+
+      # FTDI specific
+      # FTDI chip type
+      :type, Ftdi::ChipType,
+      # baudrate
+      :baudrate, :int,
+      # bitbang mode state
+      :bitbang_enabled, :uint8,
+      # pointer to read buffer for ftdi_read_data
+      :readbuffer, :pointer,
+      # read buffer offset
+      :readbuffer_offset, :uint,
+      # number of remaining data in internal read buffer
+      :readbuffer_remaining, :uint,
+      # read buffer chunk size
+      :readbuffer_chunksize, :uint,
+      # write buffer chunk size
+      :writebuffer_chunksize, :uint,
+      # maximum packet size. Needed for filtering modem status bytes every n packets.
+      :max_packet_size, :uint,
+
+      # FTDI FT2232C requirements
+      # FT2232C interface number: 0 or 1
+      :interface, :int, # 0 or 1
+      # FT2232C index number: 1 or 2
+      :index, :int, # 1 or 2
+      # Endpoints
+      # FT2232C end points: 1 or 2
+      :in_ep, :int,
+      :out_ep, :int, # 1 or 2
+
+      # Bitbang mode. 1: (default) Normal bitbang mode, 2: FT2232C SPI bitbang mode
+      :bitbang_mode, :uint8,
+
+      # Decoded eeprom structure
+      :eeprom, :pointer,
+
+      # String representation of last error
+      :error_str, :string,
+
+      # Defines behavior in case a kernel module is already attached to the device
+      :module_detach_mode, Ftdi::ModuleDetachMode
+    )
+
+    def initialize
+      ptr = Ftdi.ftdi_new
+      raise CannotInitializeContextError.new  if ptr.nil?
+      super(ptr)
+    end
+
+    # Deinitialize and free an ftdi context.
+    def dispose
+      Ftdi.ftdi_free(ctx)
+      nil
+    end
+
+    alias :close :dispose
+
+    def error_string
+      self[:error_str]
+    end
+
+    # Opens the first device with a given vendor and product ids.
+    def usb_open(vendor, product)
+      raise ArgumentError.new('vendor should be Fixnum')  unless vendor.kind_of?(Fixnum)
+      raise ArgumentError.new('product should be Fixnum')  unless product.kind_of?(Fixnum)
+      check_result(Ftdi.ftdi_usb_open(ctx, vendor, product))
+    end
+
+    # Closes the ftdi device.
+    def usb_close
+      Ftdi.ftdi_usb_close(ctx)
+      nil
+    end
+
+    # Gets the chip baud rate.
+    def baudrate
+      self[:baudrate]
+    end
+
+    # Sets the chip baud rate.
+    def baudrate=(new_baudrate)
+      raise ArgumentError.new('baudrate should be Fixnum')  unless new_baudrate.kind_of?(Fixnum)
+      check_result(Ftdi.ftdi_set_baudrate(ctx, new_baudrate))
+    end
+
+    # Set (RS232) line characteristics.
+    # The break type can only be set via {#set_line_property2} and defaults to "off".
+    def set_line_property(bits, stopbits,  parity)
+      check_result(Ftdi.ftdi_set_line_property(ctx, bits, stopbits, parity))
+    end
+
+    # Set (RS232) line characteristics.
+    def set_line_property2(bits, stopbits,  parity, _break)
+      check_result(Ftdi.ftdi_set_line_property2(ctx, bits, stopbits, parity, _break))
+    end
+
+    # Set flowcontrol for ftdi chip.
+    def flowctrl=(new_flowctrl)
+      check_result(Ftdi.ftdi_setflowctrl(ctx, new_flowctrl))
+    end
+
+    def write_data(bytes)
+      bytes = bytes.pack('c*')  if bytes.respond_to?(:pack)
+      size = bytes.respond_to?(:bytesize) ? bytes.bytesize : bytes.size
+      mem_buf = FFI::MemoryPointer.new(:char, size)
+      mem_buf.put_bytes(0, bytes)
+      r = Ftdi.ftdi_write_data(ctx, mem_buf, size)
+      check_result(r)
+      r
+    end
+
+  private
+    def ctx
+      self.to_ptr
+    end
+
+    def check_result(status_code)
+      if status_code < 0
+        raise StatusCodeError.new(status_code, error_string)
+      end
+      nil
+    end
+  end
+
+  attach_function :ftdi_new, [ ], :pointer
+  attach_function :ftdi_free, [ :pointer ], :void
+  attach_function :ftdi_usb_open, [ :pointer, :int, :int ], :int
+  attach_function :ftdi_usb_close, [ :pointer ], :void
+  attach_function :ftdi_set_baudrate, [ :pointer, :int ], :int
+  attach_function :ftdi_set_line_property, [ :pointer, BitsType, StopbitsType, ParityType ], :int
+  attach_function :ftdi_set_line_property2, [ :pointer, BitsType, StopbitsType, ParityType, BreakType ], :int
+  attach_function :ftdi_setflowctrl, [ :pointer, :int ], :int
+  attach_function :ftdi_write_data, [ :pointer, :pointer, :int ], :int
+end
+

data/lib/ftdi/version.rb

@@ -0,0 +1,6 @@
+# libftdi ruby bindings.
+module Ftdi
+  # Gem version.
+  VERSION = "0.0.1".freeze
+end
+

data/libftdi-ruby.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ftdi/version"
+
+Gem::Specification.new do |s|
+  s.name        = "libftdi-ruby"
+  s.version     = Ftdi::VERSION.dup
+  s.authors     = ["Akzhan Abdulin"]
+  s.email       = ["akzhan.abdulin@gmail.com"]
+  s.homepage    = "http://github.com/akzhan/libftdi-ruby"
+  s.summary     = %q{libftdi library binding}
+  s.description = %q{libftdi library binding to talk to FTDI chips}
+
+  s.rubyforge_project = "libftdi-ruby"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "ffi", "~> 1.0"
+  s.add_development_dependency "yard", "~> 0.7.5"
+end
+

data/test.rb

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'bundler/setup'
+
+$LOAD_PATH.unshift(File.expand_path('lib', File.dirname(__FILE__)))
+
+require 'ftdi'
+
+DMX_BREAK = 110. / 1000   # Break 88 uS or more
+DMX_MAB   = 160. / 1000   # Mark After Break 8 uS or more
+BAUD_RATE = 250000
+
+ctx = Ftdi::Context.new
+
+def dmx_break(ctx)
+  ctx.set_line_property2(:bits_8, :stop_bit_2, :none, :break_on)
+  sleep DMX_BREAK
+  ctx.set_line_property2(:bits_8, :stop_bit_2, :none, :break_off)
+  sleep DMX_MAB
+end
+
+def dmx_write(ctx, bytes)
+  dmx_break(ctx)
+  ctx.write_data(bytes)
+end
+
+begin
+  ctx.usb_open(0x0403, 0x6001)
+  begin
+    ctx.baudrate = BAUD_RATE
+    ctx.set_line_property(:bits_8, :stop_bit_2, :none)
+    ctx.flowctrl = Ftdi::SIO_DISABLE_FLOW_CTRL
+
+    arr = [ 0 ]
+    512.times { arr << 1 }
+    dmx_write(ctx, arr)
+
+    sleep 1
+
+    arr = [ 0 ]
+    512.times { arr << 0 }
+    dmx_write(ctx, arr)
+
+    puts "Context is:"
+    ctx.members.each { |k| puts "#{k} = #{ctx[k]}" }
+
+  ensure
+    ctx.usb_close
+  end
+rescue Ftdi::Error => e
+  $stderr.puts e.to_s
+end
+
+ctx.dispose
+

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: libftdi-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Akzhan Abdulin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: &2153142340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153142340
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2153157740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.5
+  type: :development
+  prerelease: false
+  version_requirements: *2153157740
+description: libftdi library binding to talk to FTDI chips
+email:
+- akzhan.abdulin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .yardopts
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/ftdi.rb
+- lib/ftdi/version.rb
+- libftdi-ruby.gemspec
+- test.rb
+homepage: http://github.com/akzhan/libftdi-ruby
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: libftdi-ruby
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: libftdi library binding
+test_files: []
+has_rdoc: